Skip to content

Reference Documentation

Quick reference materials for RustChat.

Documentation Sections

API Reference

  • REST API endpoints (coming soon)
  • WebSocket event types (coming soon)
  • Error codes and meanings (coming soon)

Compatibility

Configuration Reference

API Versions

  • /api/v1/* - Native RustChat API
  • /api/v4/* - Mattermost-compatible API

WebSocket Endpoints

  • /api/v1/ws - Native WebSocket (internal clients)
  • /api/v4/websocket - Mattermost-compatible WebSocket

Default Ports

PortService
3000Backend API
8080Nginx proxy (web UI + API)
5432PostgreSQL
6379Redis
9000S3 API (RustFS)

For detailed configuration: See Admin Guide.

RustChat Documentation