# NetBird Dashboard

NetBird Dashboard is a web dashboard for a self-hosted NetBird mesh virtual private network, letting administrators manage peers, networks, access policies, and users. It is open source and self-hosted, installable on Proxmox, Docker Hub, Kubernetes (Helm) and Unraid.

Canonical page: https://ourlocalhost.com/app/737/netbird-dashboard

## Description

NetBird Dashboard is a web dashboard for a self-hosted NetBird mesh virtual private network, letting administrators manage peers, networks, access policies, and users.

## Platform availability

Available on 3 of 9 platforms: Unraid, Proxmox, Helm.

## Health score

72/100 (Good), based on 4 of 4 factors.
- Maintained: 100 (last commit 15 days ago)
- Popular: 56 (645 GitHub stars)
- Easy to install: 45 (2 install platforms, install notes, Docker image)
- Light to run: 60 (2 GB minimum RAM, runs on ARM)

## Links

- GitHub: https://github.com/netbirdio/dashboard
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=add-netbird-lxc
- Docker Hub: https://hub.docker.com/r/netbirdio/dashboard
- Official website: https://app.netbird.io
- Kubernetes (Helm): https://artifacthub.io/packages/helm/jaconi/netbird-dashboard
- Unraid: https://ca.unraid.net/apps/netbird-dashboard-0ebsbv904jmr29?q=NetBird-Dashboard

## Common questions

### Which Auth0 environment variables are required to run NetBird Dashboard?

Set AUTH0_DOMAIN, AUTH0_CLIENT_ID, and AUTH0_AUDIENCE. You obtain these by following the Auth0 React SDK guide up to Configure Allowed Web Origins. Auth0 is the only third-party dependency that cannot be self-hosted.

### What endpoint must the dashboard be configured to contact?

Set NETBIRD_MGMT_API_ENDPOINT to the NetBird Management Service HTTP API. When the Management API is on the same server, it is usually the local endpoint on port 33071.

### What ports does the Docker run example expose for the dashboard?

The example command exposes ports 80 and 443. This provides the HTTP and HTTPS entry points for the container.

### Why can I not manage users, setup keys, or devices after a self-hosted first run?

Create the owner account in the first-run setup with a real email and a password of at least 8 characters. Without that owner account, the instance is unfinished.

### How should a new device join the NetBird account?

Copy the setup key after creating it and use it when connecting the device, for example with netbird up --setup-key. Without the setup key, the device has no credential to join securely.

### How can I restrict a peer to a single service port?

Use the dashboard to create an access policy that lets devices reach a peer on a specific port, such as port 2283 for an Immich service. The service can then be reached through NetBird's DNS name or peer IP.

## 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/737/netbird-dashboard), the self-hosted and open-source app directory.