Nix Podman Stacks

Appearance

netbird-client ​

NetBird client for connecting this host to a management server

Example ​

nix
{config, ...}: {
  nps.stacks.netbird-client = {
    enable = true;
    setupKeyFile = config.sops.secrets."netbird/setup_key".path;
  };
}

managementUrl defaults to the enabled netbird-management stack or NetBird Cloud.

Set mode = "rootless" to use the rootless image with host networking. This allows the client to reach services through the host IP and published ports; it does not join the Traefik network.

Stack Options ​

nps.stacks.netbird-client.enable ​

Whether to enable netbird-client.

Type
plaintext
boolean
Default
nix
false
Example
nix
true
Declaration
<nps/modules/netbird-client>

nps.stacks.netbird-client.managementUrl ​

Management service URL. Defaults to the enabled netbird-management stack or NetBird Cloud.

Type
plaintext
string
Default
nix
if config.nps.stacks.netbird-management.enable
then config.nps.stacks.netbird-management.containers.netbird-management-server.traefik.serviceUrl
else "https://api.netbird.io:443"
Declaration
<nps/modules/netbird-client>

nps.stacks.netbird-client.mode ​

Client mode. Rootless mode uses host networking and the rootless image.

Type
plaintext
one of "standard", "rootless"
Default
nix
"standard"
Declaration
<nps/modules/netbird-client>

nps.stacks.netbird-client.peerName ​

Name this peer uses in the management service.

Type
plaintext
string
Default
nix
"netbird-client"
Declaration
<nps/modules/netbird-client>

nps.stacks.netbird-client.setupKeyFile ​

File containing the setup key used to enroll this peer.

Type
plaintext
absolute path
Declaration
<nps/modules/netbird-client>

Container Aliases ​

nps.stacks.netbird-client.containers.netbird-client ​

Alias of {option}services.podman.containers.netbird-client.

Type
plaintext
submodule
Declaration
<nps/modules/netbird-client>