nixpkgs/nixos/modules/services/networking/netbird/server.md
2024-04-18 15:33:18 +02:00

1.2 KiB

Netbird server

NetBird is a VPN built on top of WireGuard® making it easy to create secure private networks for your organization or home.

Quickstart

To fully setup Netbird as a self-hosted server, we need both a Coturn server and an identity provider, the list of supported SSOs and their setup are available on Netbird's documentation.

There are quite a few settings that need to be passed to Netbird for it to function, and a minimal config looks like :

services.netbird.server = {
  enable = true;

  domain = "netbird.example.selfhosted";

  enableNginx = true;

  coturn = {
    enable = true;

    passwordFile = "/path/to/a/secret/password";
  };

  management = {
    oidcConfigEndpoint = "https://sso.example.selfhosted/oauth2/openid/netbird/.well-known/openid-configuration";

    settings = {
      TURNConfig = {
        Turns = [
          {
            Proto = "udp";
            URI = "turn:netbird.example.selfhosted:3478";
            Username = "netbird";
            Password._secret = "/path/to/a/secret/password";
          }
        ];
      };
    };
  };
};