Get started

Install

Sirius ships as a single static binary and a Compose stack: the API, the console, Postgres, and a message broker. You do not need a local Go or Node toolchain — images build those inside Docker.

One command

./install/install.sh            # Linux / macOS
.\install\install.ps1           # Windows PowerShell

Per-OS bootstrappers that install Docker for you live in install/packages/.

The installer will ask:

  • Which ports to publish (Enter keeps the defaults).
  • The first admin username and password.
  • Whether to use RabbitMQ instead of the default NATS JetStream broker.
  • Which host folder to share (mounted at /data for file connectors and the Studio terminal).

When it finishes, open the printed Console URL and sign in.

What starts

ServiceDefaultRole
Consolehttp://localhost:8088The product UI
APIhttp://localhost:8080REST, WebSocket, and health probes
Postgreslocalhost:5433Durable product record
NATS (default)localhost:4222Work bus

Production notes

The local stack is meant for development and evaluation. For production, use the Compose production overlay or the Helm chart, federate identity to your IdP, and turn on the fail-closed environment flags so the process refuses to start without Postgres, a secret store, and tenant isolation.

See Deploy for Kubernetes, air-gapped packages, and upgrade/rollback.