Getting started
1. Create a workspace
Section titled “1. Create a workspace”Sign up at brig.run. Your account becomes the first admin of a fresh workspace; everything else is scoped to that workspace.
2. Add a node
Section titled “2. Add a node”Open Nodes → Add node in the dashboard. You’ll get a one-line install command to paste into a fresh VPS:
curl -fsSL https://cp.brig.run/install/agent.sh | sudo bash -s -- --token 'brig_join_xxx'The script installs Docker if needed, downloads the brig-agent binary,
and registers the node with your workspace. The new node shows up in the
dashboard within a few seconds.
Hardware suggestions
- 1 vCPU / 1 GiB RAM is enough to run the agent itself plus a couple of small workloads.
- Linux with systemd. We test against Ubuntu 22.04, 24.04, and Debian 12.
3. Install the CLI
Section titled “3. Install the CLI”# macOSbrew install brig/tap/brig
# Linuxcurl -fsSL https://get.brig.run/cli | shThen brig login opens the dashboard in your browser to authorize the
CLI. After it returns you’re ready to deploy.
4. Deploy something
Section titled “4. Deploy something”Write a workload TOML:
name = "whoami"image = "traefik/whoami:latest"instances = 2cpu = "100m"memory = "32Mi"Then:
brig deploy whoami.brig.tomlbrig psbrig ps shows the placement on the nodes. Refresh the Workloads page
in the dashboard to see the same data.
5. Next steps
Section titled “5. Next steps”- Workloads — full TOML spec, scaling, rollouts, autoscaling.
- Networking & the mesh — service discovery and edge TLS.
- Custom domains — serve a workload under your own hostname.
- Snapshots — persist volumes to S3.
- CLI — full command reference and TOML grammar.