NetBird Guide

NetBird is installed by the official quickstart script and then tracked back into this repository.

Source Of TruthCopy Anchor Link

• Active Swarm service: swarm/stacks/services/netbird/netbird.yml (service-netbird)

• Active dashboard panel: swarm/stacks/panels/netbird-dashboard.yml (panel)

• Active launcher: swarm/scripts/services/netbird.{sh,bat}

• Active compose: runtime/stacks/infrastructure/netbird/docker-compose.yml

• Active config: runtime/stacks/infrastructure/netbird/config.yaml

• VPS env: runtime/environments/vps/infrastructure/netbird/.env

• VPS placeholder: runtime/environments/vps/infrastructure/netbird/netbird.env

• Dev template: runtime/environments/dev/infrastructure/netbird/netbird.dev.env

• Launcher: runtime/scripts/infrastructure/netbird.{sh,bat}

• Helper files:

  • runtime/stacks/infrastructure/netbird/TABBY-EXECUTION-SEQUENCE.md
  • runtime/stacks/infrastructure/netbird/firewall-transition.md
  • operations/migrations/netbird-db-port-cutover.sh

Initial InstallCopy Anchor Link

sudo mkdir -p /opt/netbird
cd /opt/netbird
curl -fsSL https://github.com/netbirdio/netbird/releases/latest/download/getting-started.sh -o getting-started.sh
chmod +x getting-started.sh
sudo ./getting-started.sh

Installer answers:

1. Domain: netbird.perspective-v.com
2. Reverse proxy: 1 for Existing Traefik
3. Auth mode: embedded IdP quickstart
4. Proxy service: disabled

Sync Back Into The RepoCopy Anchor Link

sudo cp /opt/netbird/docker-compose.yml /opt/docs/runtime/stacks/infrastructure/netbird/docker-compose.yml
sudo cp /opt/netbird/config.yaml /opt/docs/runtime/stacks/infrastructure/netbird/config.yaml

Then align the tracked env placeholder and the live local .env under runtime/environments/vps/infrastructure/netbird.

Recreate From The Tracked RuntimeCopy Anchor Link

./runtime/scripts/infrastructure/netbird.sh up

ValidateCopy Anchor Link

./runtime/scripts/infrastructure/netbird.sh ps
curl -Ik https://netbird.perspective-v.com/api/instance

Important RulesCopy Anchor Link

• Keep AUTH_CLIENT_SECRET empty for the embedded IdP dashboard flow.
• Do not remove public DB allows until NetBird client access is validated.
• Record the active NetBird interface and IP before DB firewall cutover.