You are here: start » handbook » runbooks » netbird

NetBird

Quick Notes

Management portal: https://netbird.starcatsys.net
Client - Management URL: https://netbird.starcatsys.net:33073 (set this in the settings of your NetBird client)

Install on Linux with Setup Key

Follow these steps to install and connect the NetBird VPN connection on a Linux box.

Generate a setup key at https://netbird.starcatsys.net/setup-keys. Make sure to save the key somewhere safe, as you can only see it once.

Add the NetBird repository:

sudo apt-get update
sudo apt install ca-certificates curl gnupg -y
curl -sSL https://pkgs.netbird.io/debian/public.key | sudo gpg --dearmor --output /usr/share/keyrings/netbird-archive-keyring.gpg
echo 'deb [signed-by=/usr/share/keyrings/netbird-archive-keyring.gpg] https://pkgs.netbird.io/debian stable main' | sudo tee /etc/apt/sources.list.d/netbird.list

Install the NetBird CLI:

sudo apt-get update
sudo apt-get install netbird

Run and connect NetBird:

netbird up --management-url https://netbird.starcatsys.net:33073 --setup-key <your setup key>