# NetBird Client NetBird Client is the open-source NetBird agent that installs on machines to join a WireGuard-based private network for secure remote and peer-to-peer access, with management via a self-hosted or cloud dashboard. It is open source and self-hosted, installable on Docker Hub, Umbrel, TrueNAS, ZimaOS and Unraid. Canonical page: https://ourlocalhost.com/app/642/netbird-client ## Description NetBird Client is the open-source NetBird agent that installs on machines to join a WireGuard-based private network for secure remote and peer-to-peer access, with management via a self-hosted or cloud dashboard. ## Platform availability Available on 6 of 9 platforms: Unraid, TrueNAS, Umbrel, ZimaOS, Mac, Windows. ## Desktop and other devices Mac, Windows. ## Health score 88/100 (Excellent), based on 4 of 4 factors. - Maintained: 100 (last commit 7 days ago) - Popular: 90 (30,009 GitHub stars) - Easy to install: 85 (6 install platforms, install notes, Docker image) - Light to run: 60 (2 GB minimum RAM, runs on ARM) ## Links - desktop: https://github.com/netbirdio/netbird/releases/latest - Docker Hub: https://hub.docker.com/r/netbirdio/netbird/ - Umbrel: https://apps.umbrel.com/app/netbird - TrueNAS: https://apps.truenas.com/catalog/netbird-client/ - ZimaOS: https://github.com/IceWhaleTech/CasaOS-AppStore/tree/main/Apps/NetBird - Unraid: https://ca.unraid.net/apps/netbird-client-0wik9xe1takjue?q=NetBird-Client - Official website: https://netbird.io - GitHub: https://github.com/netbirdio/netbird ## Common questions ### How do I register a computer with my self-hosted NetBird server? Pass the admin-provided setup key when installing the NetBird background service. For example, run netbird service install --setup-key. Without a valid key the client cannot register or connect. ### What must be set in setup.env before starting a self-hosted NetBird server? Put your real NetBird domain and a valid Let's Encrypt email in the file. Missing or wrong values can break HTTPS and make the setup page or login inaccessible. ### Why can't I create setup keys on a fresh self-hosted NetBird instance? You must first create the owner account with an email and password during initial setup. Until that account exists, the instance will not let you manage devices or create setup keys. ### Can NetBird use an external identity provider for login and MFA? Yes, NetBird supports session-based SSO and MFA with providers such as Okta, Microsoft, and Google. It can apply the provider's MFA settings and periodic re-authentication. ### Where should I report self-hosted NetBird setup or maintenance problems? Use the Community Support forum self-hosted category to report installation problems and share logs. That is the place for help from the community and team. ## 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 ("SoftEther" means "Software Ethernet") 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/642/netbird-client), the self-hosted and open-source app directory.