Self-hosting quickstart guide (5 min)

NetBird is open-source and can be self-hosted on your servers.

It relies on components developed by NetBird Authors Management Service, Management UI Dashboard, Signal Service, a 3rd party open-source STUN/TURN service Coturn, and an identity provider (available options will be listed later in this guide).

If you would like to learn more about the architecture please refer to the Architecture section.

Quick self-hosting with Zitadel IdP

In this guide, we will guide you through deploying NetBird with Zitadel as the identity provider for user management using a single-line setup script and docker containers.


Infrastructure requirements:

  • A Linux VM with at least 1CPU and 2GB of memory.
  • The VM should be publicly accessible on TCP ports 80 and 443 and UDP ports: 3478, 49152-65535.
  • Public domain name pointing to the VM.

Software requirements:

  • Docker installed on the VM with the docker compose plugin (Docker installation guide) or docker with docker-compose in version 2 or higher.
  • jq installed. In most distributions Usually available in the official repositories and can be installed with sudo apt install jq or sudo yum install jq
  • curl installed. Usually available in the official repositories and can be installed with sudo apt install curl or sudo yum install curl

Download and run the script

Download and run the installation script in a single line:

export; curl -fsSL | bash

If you want to check the script before running it, you can download it and run it locally:

curl -sSLO
# check the script
# run the script

Once the script execution is complete, you can access your netbird instance via the URL using the credentials displayed in your terminal.

Creating users

If you want to add additional users, you can access Zitadel's management console via the URL with the same credentials. Follow the Users guide from Zitadel to add additional local users or integrate Zitadel with your existing identity provider by following the guide Configure identity providers.