Services And Ports¶
This page summarizes the default local services shipped in the repository.
Default local ports¶
| Service | Default port | Notes |
|---|---|---|
| Dashboard | 5174 | Run separately with pnpm --filter @xrxp/dashboard dev |
| REST API | 8080 | Historical data, auth, admin, controller actions |
| WebSocket ingestion | 8081 | Live telemetry, subscriptions, exchange, device link |
| PostgreSQL | 5432 | Main persistent data store |
| Redis | 6379 | Queueing, cache, live pub/sub |
Service responsibilities¶
Dashboard¶
- account setup and sign-in
- user approval and token management
- experiments, sessions, and event review
- controller and exchange operations
REST API¶
- serves historical data from PostgreSQL
- exposes auth and admin workflows
- creates and tracks control instructions
WebSocket ingestion¶
- receives Unity telemetry
- publishes real-time updates to dashboards
- relays exchange controls and device connectivity
PostgreSQL¶
- durable store for experiments, sessions, events, users, devices, and snapshots
Redis¶
- pending message queue
- failed message queue
- exchange state cache
- pub/sub for live broadcasting
Local startup split¶
The repository ships Docker Compose for infrastructure plus backend services, but the dashboard currently runs outside the compose file during development.
docker compose -f docker-compose.dev.yml up -d db redis api websocket
pnpm --filter @xrxp/dashboard dev