netbirdio/netbird Installation Guide
How to install netbirdio/netbird. Official project installation instructions and setup guide.
Automated Install (Recommended)
Quick installation instructions for netbirdio/netbird. This is the fastest way to complete project installation and setup.
Install via curl
curl -fsSL https://hexmos.com/ipm-install | bash &&
ipm i netbirdio/netbirdInstall via npx
npx @hexmos/ipm i netbirdio/netbirdPrerequisites
Linux
system_toolVersion: any version (supported by the project's infrastructure) is sufficient for installation and running NetBird. However, a recent Linux distribution with updated security patches is recommended.
Docker
build_toolVersion: any version (supported by the project's infrastructure) is sufficient for installation and running NetBird. However, a recent Docker version is recommended to ensure compatibility with the latest features.
Python 3.8 or later
languageVersion: 3.8.0 or higher (recommended for development and testing)
curl
system_toolVersion: 7.64.0 or later (for downloading the NetBird installer script)
jq
system_toolVersion: 1.6 or later (for parsing JSON data from the NetBird installer script)
Manual Installation Methods
Manual installation instructions. How to install from GitHub source.
Quickstart with NetBird Cloud (Cloud)
curl -fsSL https://github.com/netbirdio/netbird/releases/latest/download/getting-started-with-zitadel.sh | bashQuickstart with self-hosted NetBird (Self-Hosted)
export NETBIRD_DOMAIN=netbird.example.com; curl -fsSL https://github.com/netbirdio/netbird/releases/latest/download/getting-started-with-zitadel.sh | bashQuickstart with NetBird (Source)
curl -sSL https://github.com/netbirdio/netbird/releases/latest/download/getting-started-with-zitadel.sh | bashPost Installation Steps
- Start the NetBird server using the command: `netbird-server`.
- Access the NetBird dashboard at `http://localhost:8080/`. You can use your browser to navigate to this address.
