NetBird
NetBird is an open-source, WireGuard-based network overlay that connects servers and devices into a peer-to-peer private network. It does not require opening inbound ports or configuring firewall rules. All connections are initiated outbound. This image ships the NetBird client pre-installed, ready to join your network.
Software included
Section titled “Software included”| Component | Version |
|---|---|
| NetBird | 0.71.4 |
| Ubuntu | 24.04 LTS |
Getting started
Section titled “Getting started”1. Connect to your VM
Section titled “1. Connect to your VM”ssh ubuntu@<your-vm-ip>2. Join your NetBird network
Section titled “2. Join your NetBird network”You will need a setup key from your NetBird management console. Setup keys are created under Setup Keys in the NetBird dashboard.
With NetBird Cloud (app.netbird.io):
sudo netbird up --setup-key <your-setup-key>With a self-hosted management server:
sudo netbird up \ --management-url https://<your-management-server> \ --setup-key <your-setup-key>3. Verify the connection
Section titled “3. Verify the connection”netbird statusYou should see the VM listed with its NetBird IP. Other peers in the same network will appear in the status output.
Managing NetBird
Section titled “Managing NetBird”# Check connection statusnetbird status
# Disconnectsudo netbird down
# Reconnectsudo netbird up
# View logssudo journalctl -u netbird -fSecurity
Section titled “Security”NetBird uses WireGuard for encrypted peer-to-peer tunnels. All traffic between peers is encrypted end-to-end. UFW is enabled and allows SSH (port 22) only. No additional ports need to be opened for NetBird traffic.
Access control between peers is managed via policies in the NetBird management console.