Installation
From packages
1. Add the package repository
Follow the instructions at opensource.byjg.com/docs/packages to add the APT or DNF repository.
2. Install the API server
On the control plane machine:
- APT (Debian/Ubuntu)
- DNF (Fedora/RHEL)
sudo apt install nimbus-api
sudo dnf install nimbus-api
The API server starts automatically on :8443 with auto-generated TLS certificates.
3. Install the CLI
On your workstation (or the same machine):
- APT (Debian/Ubuntu)
- DNF (Fedora/RHEL)
sudo apt install nimbus
sudo dnf install nimbus
Supported platforms
| Binary | amd64 | arm64 | armhf (ARMv7) | macOS amd64 | macOS arm64 |
|---|---|---|---|---|---|
nimbus-api | ✅ | ✅ | ✅ | — | — |
nimbus-agent | ✅ | ✅ | ✅ | — | — |
nimbus (CLI) | ✅ | ✅ | ✅ | ✅ | ✅ |
nimbus-gui | ✅ | ✅ | ✅ | — | — |
armhf
armhf targets ARMv7 hard-float (e.g. Tinker Board S, Raspberry Pi 2/3 running 32-bit OS).
Building nimbus-api for armhf requires gcc-arm-linux-gnueabihf for CGO/SQLite.
From source
make build # Build for current platform
make build-cross # Cross-compile for all platforms (linux/amd64, arm64, armhf, darwin/*)
This produces four binaries in bin/:
nimbus-api— the control plane servernimbus-agent— the node agent (also built intobin/dist/for all arches)nimbus— the CLInimbus-gui— the GUI server (with embedded UI)
See Local Development Setup for a complete development walkthrough.