# NetBird Server

NetBird Server is a self-hosted network services app. Combined NetBird server — management, signal, relay, and STUN in a single container for self-hosted VPN mesh networking. It is open source and self-hosted, installable on ZimaOS, Docker Hub, Kubernetes (Helm), Proxmox, TrueNAS and Unraid.

Canonical page: https://ourlocalhost.com/app/855/netbird-server

## Description

Combined NetBird server — management, signal, relay, and STUN in a single container for self-hosted VPN mesh networking. Requires a config.yaml and a reverse proxy for TLS.

## Platform availability

Available on 5 of 9 platforms: Unraid, TrueNAS, ZimaOS, Proxmox, Helm.

## Health score

63/100 (Good), based on 2 of 4 factors.
- Easy to install: 65 (4 install platforms, install notes, Docker image)
- Light to run: 60 (2 GB minimum RAM, runs on ARM)

## Links

- GitHub: https://github.com/netbirdio/netbird
- ZimaOS: https://github.com/IceWhaleTech/CasaOS-AppStore/tree/main/Apps/NetBird
- Docker Hub: https://hub.docker.com/r/netbirdio/netbird-server
- Official website: https://netbird.io
- Kubernetes (Helm): https://artifacthub.io/packages/helm/jaconi/netbird
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=netbird
- TrueNAS: https://apps.truenas.com/catalog/netbird-server/
- Unraid: https://ca.unraid.net/apps/netbird-server-09037ru0k37qla?q=NetBird-Server

## Common questions

### What must I configure if I put NetBird behind my own reverse proxy?

Set NETBIRD_TRUSTED_PEERS to your proxy's address. Without it, the NetBird server trusts forwarded client IP headers from any source, not only from your proxy.

### What do I need in setup.env before starting the server?

Put your public domain and a Let's Encrypt email in setup.env. These set the URL and where to request the HTTPS certificate so web login does not fail on missing certificate errors.

### How do I create the first admin account on a fresh NetBird server?

Check /api/instance until it says setup is required, then create the owner account with an email and password. If you skip this, you will not have an admin login to manage the server or add devices.

### How do I add a Windows machine to a self-hosted NetBird?

Create a setup key on the server and pass it to clients, for example netbird up --setup-key <KEY>. Without it new computers cannot connect automatically.

## Alternatives

- Fossorial Pangolin: Open-source identity-based remote access platform using WireGuard, offering unified management, tunneled connections, granular access contr…
- Headscale: Headscale is an open-source, self-hosted implementation of the Tailscale control server.
- LogMeIn Hamachi: Seamlessly connects devices and networks, extending LAN-like connectivity to mobile users and teams with a secure, hosted VPN service.
- OpenVPN Connect: OpenVPN Connect provides flexible VPN solutions to secure your data communications, whether it's for Internet privacy, remote access for em…
- Outline VPN: Journalists need safe access to information to research issues, communicate with sources, and report the news.
- Rayfish: A peer-to-peer mesh VPN with zero infrastructure.
- Remote.it: Remote.it is a tool that lets you securely access your home or office computer from anywhere.
- Serveo: Serveo exposes local servers to the internet using SSH tunneling.
- SoftEther VPN: SoftEther VPN (&quot;SoftEther&quot; means &quot;Software Ethernet&quot;) is one of the world's most powerful and easy-to-use multi-protoco…
- Tailscale: Private networks made easy.
- Twingate-Connector
- ZeroTier: ZeroTier is an open-source, cross-platform virtual LAN/VPN service that connects your devices and servers into one private network, so you…

---
Source: Our Local Host (https://ourlocalhost.com/app/855/netbird-server), the self-hosted and open-source app directory.
