NetBird-Client
NetBird-Client
Docker app from jimrummy101's Repository
Overview
NetBird is an open-source VPN management platform built on top of WireGuard® making it easy to create secure private networks for your organization or home.
The NetBird Client application (or agent) is a software that is installed on your machines. It is an entry point to you private network that makes it possible for machines to communicate with each other. Once installed and registered, a machine becomes a peer in the network and can be managed from a self-hosted or cloud daashboard.
Note: This is not neccessary to install if you just want the server stack.
Runtime arguments
- Network
host- Shell
bash- Privileged
- false
- Extra Params
--cap-add=NET_ADMIN
Template configuration
Setup KeyVariable
Setup key obtained from the Management Service Dashboard (used to register peer).
- Target
- NB_SETUP_KEY
Management URLVariable
Management Service URL [http|https]://[host]:[port]
- Target
- NB_MANAGEMENT_URL
- Default
- https://api.netbird.io
- Value
- https://api.netbird.io:443
AppdataPathrw
Volume storage for Netbird configuration state and credentials
- Target
- /var/lib/netbird
- Value
- /mnt/user/appdata/netbird
Log FileVariable
- Target
- NB_LOG_FILE
- Value
- console
Log LevelVariable
- Target
- NB_LOG_LEVEL
- Value
- info
Admin Portal URLVariable
Admin Panel URL [http|https]://[host]:[port]
- Target
- NB_ADMIN_URL
- Default
- https://app.netbird.io
- Value
- https://app.netbird.io
Wireguard PreSharedKeyVariable
Sets Wireguard PreSharedKey property. If set, then only peers that have the same key can communicate.
- Target
- NB_PRESHARED_KEY
Download Statistics
2,553,625
Total Downloads
336,322
This Month
213,524
Avg / Month
Total Downloads Over Time
Loading chart...
Details
Repository
netbirdio/netbirdLast Updated2026-04-29
First Seen2023-01-05
Run NetBird-Client on Unraid.
NetBird-Client is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.