MyNixOS website logo
MyNixOS website logo
Flakes
Categories
Options
Packages
option

services.netbird.clients

Attribute set of NetBird client daemons, by default each one will:

  1. be manageable using dedicated tooling:
  • netbird-<name> script,
  • NetBird - netbird-<name> graphical interface when appropriate (see ui.enable),
  1. run as a netbird-<name>.service,
  2. listen for incoming remote connections on the port 51820 (openFirewall by default),
  3. manage the netbird-<name> wireguard interface,
  4. use the /var/lib/netbird-<name>/config.json configuration file,
  5. override /var/lib/netbird-<name>/config.json with values from /etc/netbird-<name>/config.d/*.json,
  6. (hardened) be locally manageable by netbird-<name> system group,

With following caveats:

  • multiple daemons will interfere with each other's DNS resolution of netbird.cloud, but should remain fully operational otherwise. Setting up custom (non-conflicting) DNS zone is currently possible only when self-hosting.
Declarations
nixos/modules/services/networking/netbird.nix
Type
attribute set of (submodule)
Default
{ }
Example
{
  services.netbird.clients.wt0.port = 51820;
  services.netbird.clients.personal.port = 51821;
  services.netbird.clients.work1.port = 51822;
}