Skip to content

realtime

WebSocket server with presence, typing indicators, rooms, and channels. Pro plugin.

Requires: Basic license tier or higher. nself license set nself_pro_...

Terminal window
nself license set nself_pro_xxxxx...
nself plugin install realtime

Adds a production-grade WebSocket server to your ɳSelf stack. Clients connect and subscribe to named channels or rooms. The server broadcasts presence events (who’s online), typing indicators, and custom events. Redis pub/sub handles fan-out across multiple server instances. Use it to add real-time features to any application without building WebSocket infrastructure.

Requires Redis (REDIS_ENABLED=true).

Env VarDefaultDescription
REALTIME_PORT3109Realtime service port
REALTIME_MAX_CONNECTIONS10000Max concurrent WebSocket connections
REALTIME_PING_INTERVAL30sWebSocket ping interval
REALTIME_PRESENCE_TTL60Presence expiry in seconds
PortPurpose
3109Realtime WebSocket server

6 tables added to your Postgres database:

  • np_realtime_rooms: room definitions
  • np_realtime_channels: channel definitions
  • np_realtime_presence: current presence state
  • np_realtime_subscriptions: active subscriptions
  • np_realtime_events: event log
  • np_realtime_connections: connection audit log
RouteTarget
/realtime/Realtime REST API
/realtime/wsWebSocket endpoint