steedos-server-websocket

Provides Socket.IO-based bidirectional communication for Steverman Server applications with tenant-scoped rooms and Moleculer event propagation.

1.6k|413|Updated Mar 4, 2019
One-click install
npx skills add https://github.com/steedos/steedos-platform --skill steedos-server-websocket
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: steedos-server-websocket
Source: https://github.com/steedos/steedos-platform/tree/main/skills/steedos-server-websocket
Command: npx skills add https://github.com/steedos/steedos-platform --skill steedos-server-websocket

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Steedos Server requires a reliable, scalable mechanism to push real-time updates to clients, coordinate multi-tenant access, and broadcast metadata and record changes as events.

Core Features & Use Cases

  • Real-time communication via Socket.IO built on a NestJS WebSocket gateway.
  • Tenant-scoped rooms and per-user subscriptions for secure, granular event delivery.
  • Moleculer integration for cross-service event propagation and system-wide broadcasting.
  • Use cases include live order updates, notifications, and metadata change streams across the platform.

Quick Start

Connect a client to the gateway at /socket.io/ to establish a WebSocket session and start receiving events.

Frequently Asked Questions about steedos-server-websocket

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up multi-tenant WebSocket authentication in a NestJS application?▼

Multi-tenant WebSocket authentication in a NestJS application is handled via cookie-based authentication to verify user sessions before establishing Socket.IO gateway connections. It secures event delivery by validating tenant access.

How does Moleculer propagate WebSocket events across microservices?▼

Moleculer propagates WebSocket events across microservices by broadcasting metadata and record changes system-wide. This cross-service event propagation ensures connected clients receive real-time updates regardless of the originating service.

Can I use Socket.IO room subscriptions for per-user real-time notifications?▼

Yes, you can use Socket.IO room subscriptions for per-user real-time notifications. The gateway supports tenant-scoped rooms and granular per-user subscriptions to securely deliver targeted updates and live event streams.

What is the best way to broadcast record changes to clients in a Steedos Server application?▼

The best way to broadcast record changes in a Steedos Server application is using a Socket.IO gateway with Moleculer integration. It handles room management and event broadcasting to push real-time updates to connected clients.

How do I connect a client to receive real-time WebSocket events?▼

To receive real-time WebSocket events, connect a client to the gateway at the /socket.io/ endpoint. This establishes a bidirectional WebSocket session for receiving live metadata and record change broadcasts.

Does the Steedos WebSocket gateway include error handling for real-time communication?▼

Yes, the Steedos WebSocket gateway includes robust error handling and guardrails for real-time communication. These mechanisms ensure reliable event delivery and manage connection failures within multi-tenant environments.