Chat

The Chat module provides real-time messaging capabilities via WebSockets.
Features
- Chat Rooms - Create and manage conversation spaces
- Real-time Messages - Instant message delivery via WebSockets
- Message Status - Track read/unread status
- Message Editing - Allow users to edit sent messages
- Message Deletion - Allow users to delete messages
Dependencies
| Module | Required | Purpose |
|---|---|---|
| Authentication | Yes | User identity |
Minimum Configuration
All features enabled by default. Optional configuration available.
Environment Variables
| Name | Required | Description | Example |
|---|---|---|---|
CONDUIT_SERVER | Yes | Conduit Core address | 0.0.0.0:55152 |
SERVICE_URL | No | Service address | 0.0.0.0:56154 |
GRPC_PORT | No | gRPC server port | 56154 |
GRPC_KEY | No | gRPC signed request protection | someSecret |
Quick Start
# Create a chat room (as authenticated user)
curl -X POST 'http://localhost:3000/chat/rooms' \
-H 'Authorization: Bearer USER_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"roomName": "General",
"users": ["user2Id", "user3Id"]
}'
Next Steps
- Configuration - Configure chat settings
- API Reference - All available endpoints
- Getting Started Tutorial - Build real-time chat