Skip to content

plugin chat

github-actions[bot] edited this page Apr 26, 2026 · 3 revisions

Chat Plugin

Real-time chat with rooms, direct messages, reactions, and moderation. Pro plugin.

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

Install

nself license set nself_pro_xxxxx...
nself plugin install chat

What It Does

Adds a complete real-time chat backend to your ɳSelf stack. Supports group rooms, direct messages between users, message reactions, thread replies, and built-in moderation tools. Powers the ɳSelf Chat open-source client app. Exposes a REST API and WebSocket connections for real-time message delivery.

Configuration

Env Var Default Description
CHAT_PORT 3401 Chat service port
CHAT_MAX_MESSAGE_LENGTH 4096 Max characters per message
CHAT_FILE_UPLOAD_ENABLED true Allow file attachments
CHAT_MODERATION_ENABLED true Enable content moderation
CHAT_HISTORY_RETENTION_DAYS 365 Days to retain messages

Ports

Port Purpose
3401 Chat REST API and WebSocket

Database Tables

6 tables added to your Postgres database:

  • np_chat_rooms, room definitions and settings
  • np_chat_participants, room membership
  • np_chat_messages, message content and metadata
  • np_chat_reactions, message reactions
  • np_chat_threads, threaded reply chains
  • np_chat_moderation, moderation actions and bans

Nginx Routes

Route Target
/chat/ Chat REST API
/chat/ws WebSocket endpoint

Home


Getting Started


Commands


Features


Configuration


Plugins (87 + 10 monitoring)

Free (25)
Pro (62)
Planned (26)
  • plugin-audit
  • plugin-blog
  • plugin-checkout
  • plugin-commerce
  • plugin-drm
  • plugin-export
  • plugin-flow
  • plugin-import
  • plugin-ldap
  • plugin-mailgun
  • plugin-media
  • plugin-oauth-providers
  • plugin-pages
  • plugin-postmark
  • plugin-rate-limit
  • plugin-reports
  • plugin-saml
  • plugin-scheduler
  • plugin-sendgrid
  • plugin-sso
  • plugin-subscription
  • plugin-thumb
  • plugin-transcoder
  • plugin-twilio
  • plugin-waf
  • plugin-watermark

Guides


Architecture


Reference


Licensing


Security


Brand


Operations


Contributing


Changelog

Clone this wiki locally