Quickstart

1. Prerequisites

  • Go 1.25+
  • MySQL or PostgreSQL, Redis
  • RabbitMQ or NATS JetStream (cluster deployments only)

2. Build

make build-basic        # Basic edition
# or make build-full    # Full edition (AI + enterprise ops)

The binary lands in bin/basic/websocket (other editions in their own directories).

3. Configure

cp config/app.yaml.example config/app.yaml

At minimum, set the database connection and the Redis address. A single-node trial does not need RabbitMQ / NATS.

Default ports: HTTP 8080 (WebSocket embedded on the same port at /acc), gRPC 9001. With standalone_websocket_enabled turned on, WebSocket listens separately on 8089.

4. Initialize the database

Apply the SQL migrations in order, following migrations/README.md.

5. Run and verify

./bin/basic/websocket

In another terminal, open a WebSocket with a JWT:

npx wscat -c "ws://localhost:8080/acc?token=<JWT>"

Once connected, send the login and message commands from the Client Integration Guide. In production, proxy /acc to the WebSocket port via Nginx.