Setup guide

Everything runs on your own infrastructure via Docker Compose. This page covers the released, pre-built deployment (no source access needed).

Stack

• Control plane: Python/FastAPI + PostgreSQL + gRPC (mTLS) for agent communication
• Agent: single Go binary per node (bare-metal or Proxmox VE)
• Frontend: Angular dashboard
• Deployment: Docker Compose + Caddy (reverse proxy / automatic TLS)

1. Download and start

wget https://github.com/cikubo/nexum/releases/latest/download/nexum-release.tar.gz
tar xzf nexum-release.tar.gz && cd nexum
cp docker/.env.example docker/.env   # set DB password, JWT secret, SMTP, public hostname
docker compose -f docker/docker-compose.yml up -d

Caddy provisions TLS automatically once NEXUM_PUBLIC_HOSTNAME in .env is a real domain pointing at your server.

2. Create the first admin

There's no public self-registration — the platform is invite-only. Open https://<your-hostname>/ in a browser: since no admin exists yet, nexum shows a setup wizard right there — fill in your email, name, and password to create the first account.

3. Add a node

Dashboard → Nodes → + Add node. You'll get a one-time curl | sudo bash command with an embedded enrollment token — run it on the Linux node you want to manage. It installs the agent, sets up the systemd service, and completes enrollment automatically.

Next steps

See the architecture overview for how the pieces fit together, or the admin guide for creating Environments and approving users.