commit 21bd30ea2f77c40df3d20537b4d5f42d87f83d33 · pyrox.dev/nixpkgs

nixos/doc/manual/release-notes/rl-2405.section.md

···

       137
       137
        
       

     

       138
       138
        
       - [Suwayomi Server](https://github.com/Suwayomi/Suwayomi-Server), a free and open source manga reader server that runs extensions built for [Tachiyomi](https://tachiyomi.org). Available as [services.suwayomi-server](#opt-services.suwayomi-server.enable).

     

       139
       139
        
       

     

       140
       140
       +
       - A self-hosted management server for the [Netbird](https://netbird.io). Available as [services.netbird.server](#opt-services.netbird.server.enable).

     

       141
       141
       +
       

     

       140
       142
        
       - [ping_exporter](https://github.com/czerwonk/ping_exporter), a Prometheus exporter for ICMP echo requests. Available as [services.prometheus.exporters.ping](#opt-services.prometheus.exporters.ping.enable).

     

       141
       143
        
       

     

       142
       144
        
       - [Prometheus DNSSEC Exporter](https://github.com/chrj/prometheus-dnssec-exporter), check for validity and expiration in DNSSEC signatures and expose metrics for Prometheus. Available as [services.prometheus.exporters.dnssec](#opt-services.prometheus.exporters.dnssec.enable).

nixos/modules/module-list.nix

···

       1070
       1070
        
         ./services/networking/ndppd.nix

     

       1071
       1071
        
         ./services/networking/nebula.nix

     

       1072
       1072
        
         ./services/networking/netbird.nix

     

       1073
       1073
       +
         ./services/networking/netbird/server.nix

     

       1073
       1074
        
         ./services/networking/netclient.nix

     

       1074
       1075
        
         ./services/networking/networkd-dispatcher.nix

     

       1075
       1076
        
         ./services/networking/networkmanager.nix

+160

nixos/modules/services/networking/netbird/coturn.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       

     

       8
       8
       +
       let

     

       9
       9
       +
         inherit (lib)

     

       10
       10
       +
           getExe

     

       11
       11
       +
           literalExpression

     

       12
       12
       +
           mkAfter

     

       13
       13
       +
           mkEnableOption

     

       14
       14
       +
           mkIf

     

       15
       15
       +
           mkMerge

     

       16
       16
       +
           mkOption

     

       17
       17
       +
           optionalAttrs

     

       18
       18
       +
           optionalString

     

       19
       19
       +
           ;

     

       20
       20
       +
       

     

       21
       21
       +
         inherit (lib.types)

     

       22
       22
       +
           bool

     

       23
       23
       +
           listOf

     

       24
       24
       +
           nullOr

     

       25
       25
       +
           path

     

       26
       26
       +
           port

     

       27
       27
       +
           str

     

       28
       28
       +
           ;

     

       29
       29
       +
       

     

       30
       30
       +
         cfg = config.services.netbird.server.coturn;

     

       31
       31
       +
       in

     

       32
       32
       +
       

     

       33
       33
       +
       {

     

       34
       34
       +
         options.services.netbird.server.coturn = {

     

       35
       35
       +
           enable = mkEnableOption "a Coturn server for Netbird, will also open the firewall on the configured range";

     

       36
       36
       +
       

     

       37
       37
       +
           useAcmeCertificates = mkOption {

     

       38
       38
       +
             type = bool;

     

       39
       39
       +
             default = false;

     

       40
       40
       +
             description = ''

     

       41
       41
       +
               Whether to use ACME certificates corresponding to the given domain for the server.

     

       42
       42
       +
             '';

     

       43
       43
       +
           };

     

       44
       44
       +
       

     

       45
       45
       +
           domain = mkOption {

     

       46
       46
       +
             type = str;

     

       47
       47
       +
             description = "The domain under which the coturn server runs.";

     

       48
       48
       +
           };

     

       49
       49
       +
       

     

       50
       50
       +
           user = mkOption {

     

       51
       51
       +
             type = str;

     

       52
       52
       +
             default = "netbird";

     

       53
       53
       +
             description = ''

     

       54
       54
       +
               The username used by netbird to connect to the coturn server.

     

       55
       55
       +
             '';

     

       56
       56
       +
           };

     

       57
       57
       +
       

     

       58
       58
       +
           password = mkOption {

     

       59
       59
       +
             type = nullOr str;

     

       60
       60
       +
             default = null;

     

       61
       61
       +
             description = ''

     

       62
       62
       +
               The password of the user used by netbird to connect to the coturn server.

     

       63
       63
       +
             '';

     

       64
       64
       +
           };

     

       65
       65
       +
       

     

       66
       66
       +
           passwordFile = mkOption {

     

       67
       67
       +
             type = nullOr path;

     

       68
       68
       +
             default = null;

     

       69
       69
       +
             description = ''

     

       70
       70
       +
               The path to a file containing the password of the user used by netbird to connect to the coturn server.

     

       71
       71
       +
             '';

     

       72
       72
       +
           };

     

       73
       73
       +
       

     

       74
       74
       +
           openPorts = mkOption {

     

       75
       75
       +
             type = listOf port;

     

       76
       76
       +
             default = with config.services.coturn; [

     

       77
       77
       +
               listening-port

     

       78
       78
       +
               alt-listening-port

     

       79
       79
       +
               tls-listening-port

     

       80
       80
       +
               alt-tls-listening-port

     

       81
       81
       +
             ];

     

       82
       82
       +
             defaultText = literalExpression ''

     

       83
       83
       +
               with config.services.coturn; [

     

       84
       84
       +
                 listening-port

     

       85
       85
       +
                 alt-listening-port

     

       86
       86
       +
                 tls-listening-port

     

       87
       87
       +
                 alt-tls-listening-port

     

       88
       88
       +
               ];

     

       89
       89
       +
             '';

     

       90
       90
       +
       

     

       91
       91
       +
             description = ''

     

       92
       92
       +
               The list of ports used by coturn for listening to open in the firewall.

     

       93
       93
       +
             '';

     

       94
       94
       +
           };

     

       95
       95
       +
         };

     

       96
       96
       +
       

     

       97
       97
       +
         config = mkIf cfg.enable (mkMerge [

     

       98
       98
       +
           {

     

       99
       99
       +
             assertions = [

     

       100
       100
       +
               {

     

       101
       101
       +
                 assertion = (cfg.password == null) != (cfg.passwordFile == null);

     

       102
       102
       +
                 message = "Exactly one of `password` or `passwordFile` must be given for the coturn setup.";

     

       103
       103
       +
               }

     

       104
       104
       +
             ];

     

       105
       105
       +
       

     

       106
       106
       +
             services.coturn =

     

       107
       107
       +
               {

     

       108
       108
       +
                 enable = true;

     

       109
       109
       +
       

     

       110
       110
       +
                 realm = cfg.domain;

     

       111
       111
       +
                 lt-cred-mech = true;

     

       112
       112
       +
                 no-cli = true;

     

       113
       113
       +
       

     

       114
       114
       +
                 extraConfig = ''

     

       115
       115
       +
                   fingerprint

     

       116
       116
       +
                   user=${cfg.user}:${if cfg.password != null then cfg.password else "@password@"}

     

       117
       117
       +
                   no-software-attribute

     

       118
       118
       +
                 '';

     

       119
       119
       +
               }

     

       120
       120
       +
               // (optionalAttrs cfg.useAcmeCertificates {

     

       121
       121
       +
                 cert = "@cert@";

     

       122
       122
       +
                 pkey = "@pkey@";

     

       123
       123
       +
               });

     

       124
       124
       +
       

     

       125
       125
       +
             systemd.services.coturn =

     

       126
       126
       +
               let

     

       127
       127
       +
                 dir = config.security.acme.certs.${cfg.domain}.directory;

     

       128
       128
       +
                 preStart' =

     

       129
       129
       +
                   (optionalString (cfg.passwordFile != null) ''

     

       130
       130
       +
                     ${getExe pkgs.replace-secret} @password@ ${cfg.passwordFile} /run/coturn/turnserver.cfg

     

       131
       131
       +
                   '')

     

       132
       132
       +
                   + (optionalString cfg.useAcmeCertificates ''

     

       133
       133
       +
                     ${getExe pkgs.replace-secret} @cert@ "$CREDENTIALS_DIRECTORY/cert.pem" /run/coturn/turnserver.cfg

     

       134
       134
       +
                     ${getExe pkgs.replace-secret} @pkey@ "$CREDENTIALS_DIRECTORY/pkey.pem" /run/coturn/turnserver.cfg

     

       135
       135
       +
                   '');

     

       136
       136
       +
               in

     

       137
       137
       +
               (optionalAttrs (preStart' != "") { preStart = mkAfter preStart'; })

     

       138
       138
       +
               // (optionalAttrs cfg.useAcmeCertificates {

     

       139
       139
       +
                 serviceConfig.LoadCredential = [

     

       140
       140
       +
                   "cert.pem:${dir}/fullchain.pem"

     

       141
       141
       +
                   "pkey.pem:${dir}/key.pem"

     

       142
       142
       +
                 ];

     

       143
       143
       +
               });

     

       144
       144
       +
       

     

       145
       145
       +
             security.acme.certs.${cfg.domain}.postRun = optionalString cfg.useAcmeCertificates "systemctl restart coturn.service";

     

       146
       146
       +
       

     

       147
       147
       +
             networking.firewall = {

     

       148
       148
       +
               allowedUDPPorts = cfg.openPorts;

     

       149
       149
       +
               allowedTCPPorts = cfg.openPorts;

     

       150
       150
       +
       

     

       151
       151
       +
               allowedUDPPortRanges = [

     

       152
       152
       +
                 {

     

       153
       153
       +
                   from = cfg.minPort;

     

       154
       154
       +
                   to = cfg.maxPort;

     

       155
       155
       +
                 }

     

       156
       156
       +
               ];

     

       157
       157
       +
             };

     

       158
       158
       +
           }

     

       159
       159
       +
         ]);

     

       160
       160
       +
       }

+186

nixos/modules/services/networking/netbird/dashboard.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       

     

       8
       8
       +
       let

     

       9
       9
       +
         inherit (lib)

     

       10
       10
       +
           boolToString

     

       11
       11
       +
           concatStringsSep

     

       12
       12
       +
           hasAttr

     

       13
       13
       +
           isBool

     

       14
       14
       +
           mapAttrs

     

       15
       15
       +
           mkDefault

     

       16
       16
       +
           mkEnableOption

     

       17
       17
       +
           mkIf

     

       18
       18
       +
           mkOption

     

       19
       19
       +
           mkPackageOption

     

       20
       20
       +
           ;

     

       21
       21
       +
       

     

       22
       22
       +
         inherit (lib.types)

     

       23
       23
       +
           attrsOf

     

       24
       24
       +
           bool

     

       25
       25
       +
           either

     

       26
       26
       +
           package

     

       27
       27
       +
           str

     

       28
       28
       +
           submodule

     

       29
       29
       +
           ;

     

       30
       30
       +
       

     

       31
       31
       +
         toStringEnv = value: if isBool value then boolToString value else toString value;

     

       32
       32
       +
       

     

       33
       33
       +
         cfg = config.services.netbird.server.dashboard;

     

       34
       34
       +
       in

     

       35
       35
       +
       

     

       36
       36
       +
       {

     

       37
       37
       +
         options.services.netbird.server.dashboard = {

     

       38
       38
       +
           enable = mkEnableOption "the static netbird dashboard frontend";

     

       39
       39
       +
       

     

       40
       40
       +
           package = mkPackageOption pkgs "netbird-dashboard" { };

     

       41
       41
       +
       

     

       42
       42
       +
           enableNginx = mkEnableOption "Nginx reverse-proxy to serve the dashboard.";

     

       43
       43
       +
       

     

       44
       44
       +
           domain = mkOption {

     

       45
       45
       +
             type = str;

     

       46
       46
       +
             default = "localhost";

     

       47
       47
       +
             description = "The domain under which the dashboard runs.";

     

       48
       48
       +
           };

     

       49
       49
       +
       

     

       50
       50
       +
           managementServer = mkOption {

     

       51
       51
       +
             type = str;

     

       52
       52
       +
             description = "The address of the management server, used for the API endpoints.";

     

       53
       53
       +
           };

     

       54
       54
       +
       

     

       55
       55
       +
           settings = mkOption {

     

       56
       56
       +
             type = submodule { freeformType = attrsOf (either str bool); };

     

       57
       57
       +
       

     

       58
       58
       +
             defaultText = ''

     

       59
       59
       +
               {

     

       60
       60
       +
                 AUTH_AUDIENCE = "netbird";

     

       61
       61
       +
                 AUTH_CLIENT_ID = "netbird";

     

       62
       62
       +
                 AUTH_SUPPORTED_SCOPES = "openid profile email";

     

       63
       63
       +
                 NETBIRD_TOKEN_SOURCE = "idToken";

     

       64
       64
       +
                 USE_AUTH0 = false;

     

       65
       65
       +
               }

     

       66
       66
       +
             '';

     

       67
       67
       +
       

     

       68
       68
       +
             description = ''

     

       69
       69
       +
               An attribute set that will be used to substitute variables when building the dashboard.

     

       70
       70
       +
               Any values set here will be templated into the frontend and be public for anyone that can reach your website.

     

       71
       71
       +
               The exact values sadly aren't documented anywhere.

     

       72
       72
       +
               A starting point when searching for valid values is this [script](https://github.com/netbirdio/dashboard/blob/main/docker/init_react_envs.sh)

     

       73
       73
       +
               The only mandatory value is 'AUTH_AUTHORITY' as we cannot set a default value here.

     

       74
       74
       +
             '';

     

       75
       75
       +
           };

     

       76
       76
       +
       

     

       77
       77
       +
           finalDrv = mkOption {

     

       78
       78
       +
             readOnly = true;

     

       79
       79
       +
             type = package;

     

       80
       80
       +
             description = ''

     

       81
       81
       +
               The derivation containing the final templated dashboard.

     

       82
       82
       +
             '';

     

       83
       83
       +
           };

     

       84
       84
       +
         };

     

       85
       85
       +
       

     

       86
       86
       +
         config = mkIf cfg.enable {

     

       87
       87
       +
           assertions = [

     

       88
       88
       +
             {

     

       89
       89
       +
               assertion = hasAttr "AUTH_AUTHORITY" cfg.settings;

     

       90
       90
       +
               message = "The setting AUTH_AUTHORITY is required for the dasboard to function.";

     

       91
       91
       +
             }

     

       92
       92
       +
           ];

     

       93
       93
       +
       

     

       94
       94
       +
           services.netbird.server.dashboard = {

     

       95
       95
       +
             settings =

     

       96
       96
       +
               {

     

       97
       97
       +
                 # Due to how the backend and frontend work this secret will be templated into the backend

     

       98
       98
       +
                 # and then served statically from your website

     

       99
       99
       +
                 # This enables you to login without the normally needed indirection through the backend

     

       100
       100
       +
                 # but this also means anyone that can reach your website can

     

       101
       101
       +
                 # fetch this secret, which is why there is no real need to put it into

     

       102
       102
       +
                 # special options as its public anyway

     

       103
       103
       +
                 # As far as I know leaking this secret is just

     

       104
       104
       +
                 # an information leak as one can fetch some basic app

     

       105
       105
       +
                 # informations from the IDP

     

       106
       106
       +
                 # To actually do something one still needs to have login

     

       107
       107
       +
                 # data and this secret so this being public will not

     

       108
       108
       +
                 # suffice for anything just decreasing security

     

       109
       109
       +
                 AUTH_CLIENT_SECRET = "";

     

       110
       110
       +
       

     

       111
       111
       +
                 NETBIRD_MGMT_API_ENDPOINT = cfg.managementServer;

     

       112
       112
       +
                 NETBIRD_MGMT_GRPC_API_ENDPOINT = cfg.managementServer;

     

       113
       113
       +
               }

     

       114
       114
       +
               // (mapAttrs (_: mkDefault) {

     

       115
       115
       +
                 # Those values have to be easily overridable

     

       116
       116
       +
                 AUTH_AUDIENCE = "netbird"; # must be set for your devices to be able to log in

     

       117
       117
       +
                 AUTH_CLIENT_ID = "netbird";

     

       118
       118
       +
                 AUTH_SUPPORTED_SCOPES = "openid profile email";

     

       119
       119
       +
                 NETBIRD_TOKEN_SOURCE = "idToken";

     

       120
       120
       +
                 USE_AUTH0 = false;

     

       121
       121
       +
               });

     

       122
       122
       +
       

     

       123
       123
       +
             # The derivation containing the templated dashboard

     

       124
       124
       +
             finalDrv =

     

       125
       125
       +
               pkgs.runCommand "netbird-dashboard"

     

       126
       126
       +
                 {

     

       127
       127
       +
                   nativeBuildInputs = [ pkgs.gettext ];

     

       128
       128
       +
                   env = {

     

       129
       129
       +
                     ENV_STR = concatStringsSep " " [

     

       130
       130
       +
                       "$AUTH_AUDIENCE"

     

       131
       131
       +
                       "$AUTH_AUTHORITY"

     

       132
       132
       +
                       "$AUTH_CLIENT_ID"

     

       133
       133
       +
                       "$AUTH_CLIENT_SECRET"

     

       134
       134
       +
                       "$AUTH_REDIRECT_URI"

     

       135
       135
       +
                       "$AUTH_SILENT_REDIRECT_URI"

     

       136
       136
       +
                       "$AUTH_SUPPORTED_SCOPES"

     

       137
       137
       +
                       "$NETBIRD_DRAG_QUERY_PARAMS"

     

       138
       138
       +
                       "$NETBIRD_GOOGLE_ANALYTICS_ID"

     

       139
       139
       +
                       "$NETBIRD_HOTJAR_TRACK_ID"

     

       140
       140
       +
                       "$NETBIRD_MGMT_API_ENDPOINT"

     

       141
       141
       +
                       "$NETBIRD_MGMT_GRPC_API_ENDPOINT"

     

       142
       142
       +
                       "$NETBIRD_TOKEN_SOURCE"

     

       143
       143
       +
                       "$USE_AUTH0"

     

       144
       144
       +
                     ];

     

       145
       145
       +
                   } // (mapAttrs (_: toStringEnv) cfg.settings);

     

       146
       146
       +
                 }

     

       147
       147
       +
                 ''

     

       148
       148
       +
                   cp -R ${cfg.package} build

     

       149
       149
       +
       

     

       150
       150
       +
                   find build -type d -exec chmod 755 {} \;

     

       151
       151
       +
                   OIDC_TRUSTED_DOMAINS="build/OidcTrustedDomains.js"

     

       152
       152
       +
       

     

       153
       153
       +
                   envsubst "$ENV_STR" < "$OIDC_TRUSTED_DOMAINS.tmpl" > "$OIDC_TRUSTED_DOMAINS"

     

       154
       154
       +
       

     

       155
       155
       +
                   for f in $(grep -R -l AUTH_SUPPORTED_SCOPES build/); do

     

       156
       156
       +
                     mv "$f" "$f.copy"

     

       157
       157
       +
                     envsubst "$ENV_STR" < "$f.copy" > "$f"

     

       158
       158
       +
                     rm "$f.copy"

     

       159
       159
       +
                   done

     

       160
       160
       +
       

     

       161
       161
       +
                   cp -R build $out

     

       162
       162
       +
                 '';

     

       163
       163
       +
           };

     

       164
       164
       +
       

     

       165
       165
       +
           services.nginx = mkIf cfg.enableNginx {

     

       166
       166
       +
             enable = true;

     

       167
       167
       +
       

     

       168
       168
       +
             virtualHosts.${cfg.domain} = {

     

       169
       169
       +
               locations = {

     

       170
       170
       +
                 "/" = {

     

       171
       171
       +
                   root = cfg.finalDrv;

     

       172
       172
       +
                   tryFiles = "$uri $uri.html $uri/ =404";

     

       173
       173
       +
                 };

     

       174
       174
       +
       

     

       175
       175
       +
                 "/404.html".extraConfig = ''

     

       176
       176
       +
                   internal;

     

       177
       177
       +
                 '';

     

       178
       178
       +
               };

     

       179
       179
       +
       

     

       180
       180
       +
               extraConfig = ''

     

       181
       181
       +
                 error_page 404 /404.html;

     

       182
       182
       +
               '';

     

       183
       183
       +
             };

     

       184
       184
       +
           };

     

       185
       185
       +
         };

     

       186
       186
       +
       }

+460

nixos/modules/services/networking/netbird/management.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         utils,

     

       6
       6
       +
         ...

     

       7
       7
       +
       }:

     

       8
       8
       +
       

     

       9
       9
       +
       let

     

       10
       10
       +
         inherit (lib)

     

       11
       11
       +
           any

     

       12
       12
       +
           concatMap

     

       13
       13
       +
           getExe'

     

       14
       14
       +
           literalExpression

     

       15
       15
       +
           mkEnableOption

     

       16
       16
       +
           mkIf

     

       17
       17
       +
           mkOption

     

       18
       18
       +
           mkPackageOption

     

       19
       19
       +
           optional

     

       20
       20
       +
           recursiveUpdate

     

       21
       21
       +
           ;

     

       22
       22
       +
       

     

       23
       23
       +
         inherit (lib.types)

     

       24
       24
       +
           bool

     

       25
       25
       +
           enum

     

       26
       26
       +
           listOf

     

       27
       27
       +
           port

     

       28
       28
       +
           str

     

       29
       29
       +
           ;

     

       30
       30
       +
       

     

       31
       31
       +
         inherit (utils) escapeSystemdExecArgs genJqSecretsReplacementSnippet;

     

       32
       32
       +
       

     

       33
       33
       +
         stateDir = "/var/lib/netbird-mgmt";

     

       34
       34
       +
       

     

       35
       35
       +
         settingsFormat = pkgs.formats.json { };

     

       36
       36
       +
       

     

       37
       37
       +
         defaultSettings = {

     

       38
       38
       +
           Stuns = [

     

       39
       39
       +
             {

     

       40
       40
       +
               Proto = "udp";

     

       41
       41
       +
               URI = "stun:${cfg.turnDomain}:3478";

     

       42
       42
       +
               Username = "";

     

       43
       43
       +
               Password = null;

     

       44
       44
       +
             }

     

       45
       45
       +
           ];

     

       46
       46
       +
       

     

       47
       47
       +
           TURNConfig = {

     

       48
       48
       +
             Turns = [

     

       49
       49
       +
               {

     

       50
       50
       +
                 Proto = "udp";

     

       51
       51
       +
                 URI = "turn:${cfg.turnDomain}:${builtins.toString cfg.turnPort}";

     

       52
       52
       +
                 Username = "netbird";

     

       53
       53
       +
                 Password = "netbird";

     

       54
       54
       +
               }

     

       55
       55
       +
             ];

     

       56
       56
       +
       

     

       57
       57
       +
             CredentialsTTL = "12h";

     

       58
       58
       +
             Secret = "not-secure-secret";

     

       59
       59
       +
             TimeBasedCredentials = false;

     

       60
       60
       +
           };

     

       61
       61
       +
       

     

       62
       62
       +
           Signal = {

     

       63
       63
       +
             Proto = "https";

     

       64
       64
       +
             URI = "${cfg.domain}:443";

     

       65
       65
       +
             Username = "";

     

       66
       66
       +
             Password = null;

     

       67
       67
       +
           };

     

       68
       68
       +
       

     

       69
       69
       +
           ReverseProxy = {

     

       70
       70
       +
             TrustedHTTPProxies = [ ];

     

       71
       71
       +
             TrustedHTTPProxiesCount = 0;

     

       72
       72
       +
             TrustedPeers = [ "0.0.0.0/0" ];

     

       73
       73
       +
           };

     

       74
       74
       +
       

     

       75
       75
       +
           Datadir = "${stateDir}/data";

     

       76
       76
       +
           DataStoreEncryptionKey = "very-insecure-key";

     

       77
       77
       +
           StoreConfig = {

     

       78
       78
       +
             Engine = "sqlite";

     

       79
       79
       +
           };

     

       80
       80
       +
       

     

       81
       81
       +
           HttpConfig = {

     

       82
       82
       +
             Address = "127.0.0.1:${builtins.toString cfg.port}";

     

       83
       83
       +
             IdpSignKeyRefreshEnabled = true;

     

       84
       84
       +
             OIDCConfigEndpoint = cfg.oidcConfigEndpoint;

     

       85
       85
       +
           };

     

       86
       86
       +
       

     

       87
       87
       +
           IdpManagerConfig = {

     

       88
       88
       +
             ManagerType = "none";

     

       89
       89
       +
             ClientConfig = {

     

       90
       90
       +
               Issuer = "";

     

       91
       91
       +
               TokenEndpoint = "";

     

       92
       92
       +
               ClientID = "netbird";

     

       93
       93
       +
               ClientSecret = "";

     

       94
       94
       +
               GrantType = "client_credentials";

     

       95
       95
       +
             };

     

       96
       96
       +
       

     

       97
       97
       +
             ExtraConfig = { };

     

       98
       98
       +
             Auth0ClientCredentials = null;

     

       99
       99
       +
             AzureClientCredentials = null;

     

       100
       100
       +
             KeycloakClientCredentials = null;

     

       101
       101
       +
             ZitadelClientCredentials = null;

     

       102
       102
       +
           };

     

       103
       103
       +
       

     

       104
       104
       +
           DeviceAuthorizationFlow = {

     

       105
       105
       +
             Provider = "none";

     

       106
       106
       +
             ProviderConfig = {

     

       107
       107
       +
               Audience = "netbird";

     

       108
       108
       +
               Domain = null;

     

       109
       109
       +
               ClientID = "netbird";

     

       110
       110
       +
               TokenEndpoint = null;

     

       111
       111
       +
               DeviceAuthEndpoint = "";

     

       112
       112
       +
               Scope = "openid profile email";

     

       113
       113
       +
               UseIDToken = false;

     

       114
       114
       +
             };

     

       115
       115
       +
           };

     

       116
       116
       +
       

     

       117
       117
       +
           PKCEAuthorizationFlow = {

     

       118
       118
       +
             ProviderConfig = {

     

       119
       119
       +
               Audience = "netbird";

     

       120
       120
       +
               ClientID = "netbird";

     

       121
       121
       +
               ClientSecret = "";

     

       122
       122
       +
               AuthorizationEndpoint = "";

     

       123
       123
       +
               TokenEndpoint = "";

     

       124
       124
       +
               Scope = "openid profile email";

     

       125
       125
       +
               RedirectURLs = [ "http://localhost:53000" ];

     

       126
       126
       +
               UseIDToken = false;

     

       127
       127
       +
             };

     

       128
       128
       +
           };

     

       129
       129
       +
         };

     

       130
       130
       +
       

     

       131
       131
       +
         managementConfig = recursiveUpdate defaultSettings cfg.settings;

     

       132
       132
       +
       

     

       133
       133
       +
         managementFile = settingsFormat.generate "config.json" managementConfig;

     

       134
       134
       +
       

     

       135
       135
       +
         cfg = config.services.netbird.server.management;

     

       136
       136
       +
       in

     

       137
       137
       +
       

     

       138
       138
       +
       {

     

       139
       139
       +
         options.services.netbird.server.management = {

     

       140
       140
       +
           enable = mkEnableOption "Netbird Management Service.";

     

       141
       141
       +
       

     

       142
       142
       +
           package = mkPackageOption pkgs "netbird" { };

     

       143
       143
       +
       

     

       144
       144
       +
           domain = mkOption {

     

       145
       145
       +
             type = str;

     

       146
       146
       +
             description = "The domain under which the management API runs.";

     

       147
       147
       +
           };

     

       148
       148
       +
       

     

       149
       149
       +
           turnDomain = mkOption {

     

       150
       150
       +
             type = str;

     

       151
       151
       +
             description = "The domain of the TURN server to use.";

     

       152
       152
       +
           };

     

       153
       153
       +
       

     

       154
       154
       +
           turnPort = mkOption {

     

       155
       155
       +
             type = port;

     

       156
       156
       +
             default = 3478;

     

       157
       157
       +
             description = ''

     

       158
       158
       +
               The port of the TURN server to use.

     

       159
       159
       +
             '';

     

       160
       160
       +
           };

     

       161
       161
       +
       

     

       162
       162
       +
           dnsDomain = mkOption {

     

       163
       163
       +
             type = str;

     

       164
       164
       +
             default = "netbird.selfhosted";

     

       165
       165
       +
             description = "Domain used for peer resolution.";

     

       166
       166
       +
           };

     

       167
       167
       +
       

     

       168
       168
       +
           singleAccountModeDomain = mkOption {

     

       169
       169
       +
             type = str;

     

       170
       170
       +
             default = "netbird.selfhosted";

     

       171
       171
       +
             description = ''

     

       172
       172
       +
               Enables single account mode.

     

       173
       173
       +
               This means that all the users will be under the same account grouped by the specified domain.

     

       174
       174
       +
               If the installation has more than one account, the property is ineffective.

     

       175
       175
       +
             '';

     

       176
       176
       +
           };

     

       177
       177
       +
       

     

       178
       178
       +
           disableAnonymousMetrics = mkOption {

     

       179
       179
       +
             type = bool;

     

       180
       180
       +
             default = true;

     

       181
       181
       +
             description = "Disables push of anonymous usage metrics to NetBird.";

     

       182
       182
       +
           };

     

       183
       183
       +
       

     

       184
       184
       +
           disableSingleAccountMode = mkOption {

     

       185
       185
       +
             type = bool;

     

       186
       186
       +
             default = false;

     

       187
       187
       +
             description = ''

     

       188
       188
       +
               If set to true, disables single account mode.

     

       189
       189
       +
               The `singleAccountModeDomain` property will be ignored and every new user will have a separate NetBird account.

     

       190
       190
       +
             '';

     

       191
       191
       +
           };

     

       192
       192
       +
       

     

       193
       193
       +
           port = mkOption {

     

       194
       194
       +
             type = port;

     

       195
       195
       +
             default = 8011;

     

       196
       196
       +
             description = "Internal port of the management server.";

     

       197
       197
       +
           };

     

       198
       198
       +
       

     

       199
       199
       +
           extraOptions = mkOption {

     

       200
       200
       +
             type = listOf str;

     

       201
       201
       +
             default = [ ];

     

       202
       202
       +
             description = ''

     

       203
       203
       +
               Additional options given to netbird-mgmt as commandline arguments.

     

       204
       204
       +
             '';

     

       205
       205
       +
           };

     

       206
       206
       +
       

     

       207
       207
       +
           oidcConfigEndpoint = mkOption {

     

       208
       208
       +
             type = str;

     

       209
       209
       +
             description = "The oidc discovery endpoint.";

     

       210
       210
       +
             example = "https://example.eu.auth0.com/.well-known/openid-configuration";

     

       211
       211
       +
           };

     

       212
       212
       +
       

     

       213
       213
       +
           settings = mkOption {

     

       214
       214
       +
             inherit (settingsFormat) type;

     

       215
       215
       +
       

     

       216
       216
       +
             defaultText = literalExpression ''

     

       217
       217
       +
               defaultSettings = {

     

       218
       218
       +
                 Stuns = [

     

       219
       219
       +
                   {

     

       220
       220
       +
                     Proto = "udp";

     

       221
       221
       +
                     URI = "stun:''${cfg.turnDomain}:3478";

     

       222
       222
       +
                     Username = "";

     

       223
       223
       +
                     Password = null;

     

       224
       224
       +
                   }

     

       225
       225
       +
                 ];

     

       226
       226
       +
       

     

       227
       227
       +
                 TURNConfig = {

     

       228
       228
       +
                   Turns = [

     

       229
       229
       +
                     {

     

       230
       230
       +
                       Proto = "udp";

     

       231
       231
       +
                       URI = "turn:''${cfg.turnDomain}:3478";

     

       232
       232
       +
                       Username = "netbird";

     

       233
       233
       +
                       Password = "netbird";

     

       234
       234
       +
                     }

     

       235
       235
       +
                   ];

     

       236
       236
       +
       

     

       237
       237
       +
                   CredentialsTTL = "12h";

     

       238
       238
       +
                   Secret = "not-secure-secret";

     

       239
       239
       +
                   TimeBasedCredentials = false;

     

       240
       240
       +
                 };

     

       241
       241
       +
       

     

       242
       242
       +
                 Signal = {

     

       243
       243
       +
                   Proto = "https";

     

       244
       244
       +
                   URI = "''${cfg.domain}:443";

     

       245
       245
       +
                   Username = "";

     

       246
       246
       +
                   Password = null;

     

       247
       247
       +
                 };

     

       248
       248
       +
       

     

       249
       249
       +
                 ReverseProxy = {

     

       250
       250
       +
                   TrustedHTTPProxies = [ ];

     

       251
       251
       +
                   TrustedHTTPProxiesCount = 0;

     

       252
       252
       +
                   TrustedPeers = [ "0.0.0.0/0" ];

     

       253
       253
       +
                 };

     

       254
       254
       +
       

     

       255
       255
       +
                 Datadir = "''${stateDir}/data";

     

       256
       256
       +
                 DataStoreEncryptionKey = "genEVP6j/Yp2EeVujm0zgqXrRos29dQkpvX0hHdEUlQ=";

     

       257
       257
       +
                 StoreConfig = { Engine = "sqlite"; };

     

       258
       258
       +
       

     

       259
       259
       +
                 HttpConfig = {

     

       260
       260
       +
                   Address = "127.0.0.1:''${builtins.toString cfg.port}";

     

       261
       261
       +
                   IdpSignKeyRefreshEnabled = true;

     

       262
       262
       +
                   OIDCConfigEndpoint = cfg.oidcConfigEndpoint;

     

       263
       263
       +
                 };

     

       264
       264
       +
       

     

       265
       265
       +
                 IdpManagerConfig = {

     

       266
       266
       +
                   ManagerType = "none";

     

       267
       267
       +
                   ClientConfig = {

     

       268
       268
       +
                     Issuer = "";

     

       269
       269
       +
                     TokenEndpoint = "";

     

       270
       270
       +
                     ClientID = "netbird";

     

       271
       271
       +
                     ClientSecret = "";

     

       272
       272
       +
                     GrantType = "client_credentials";

     

       273
       273
       +
                   };

     

       274
       274
       +
       

     

       275
       275
       +
                   ExtraConfig = { };

     

       276
       276
       +
                   Auth0ClientCredentials = null;

     

       277
       277
       +
                   AzureClientCredentials = null;

     

       278
       278
       +
                   KeycloakClientCredentials = null;

     

       279
       279
       +
                   ZitadelClientCredentials = null;

     

       280
       280
       +
                 };

     

       281
       281
       +
       

     

       282
       282
       +
                 DeviceAuthorizationFlow = {

     

       283
       283
       +
                   Provider = "none";

     

       284
       284
       +
                   ProviderConfig = {

     

       285
       285
       +
                     Audience = "netbird";

     

       286
       286
       +
                     Domain = null;

     

       287
       287
       +
                     ClientID = "netbird";

     

       288
       288
       +
                     TokenEndpoint = null;

     

       289
       289
       +
                     DeviceAuthEndpoint = "";

     

       290
       290
       +
                     Scope = "openid profile email offline_access api";

     

       291
       291
       +
                     UseIDToken = false;

     

       292
       292
       +
                   };

     

       293
       293
       +
                 };

     

       294
       294
       +
       

     

       295
       295
       +
                 PKCEAuthorizationFlow = {

     

       296
       296
       +
                   ProviderConfig = {

     

       297
       297
       +
                     Audience = "netbird";

     

       298
       298
       +
                     ClientID = "netbird";

     

       299
       299
       +
                     ClientSecret = "";

     

       300
       300
       +
                     AuthorizationEndpoint = "";

     

       301
       301
       +
                     TokenEndpoint = "";

     

       302
       302
       +
                     Scope = "openid profile email offline_access api";

     

       303
       303
       +
                     RedirectURLs = "http://localhost:53000";

     

       304
       304
       +
                     UseIDToken = false;

     

       305
       305
       +
                   };

     

       306
       306
       +
                 };

     

       307
       307
       +
               };

     

       308
       308
       +
             '';

     

       309
       309
       +
       

     

       310
       310
       +
             default = { };

     

       311
       311
       +
       

     

       312
       312
       +
             description = ''

     

       313
       313
       +
               Configuration of the netbird management server.

     

       314
       314
       +
               Options containing secret data should be set to an attribute set containing the attribute _secret

     

       315
       315
       +
               - a string pointing to a file containing the value the option should be set to.

     

       316
       316
       +
               See the example to get a better picture of this: in the resulting management.json file,

     

       317
       317
       +
               the `DataStoreEncryptionKey` key will be set to the contents of the /run/agenix/netbird_mgmt-data_store_encryption_key file.

     

       318
       318
       +
             '';

     

       319
       319
       +
       

     

       320
       320
       +
             example = {

     

       321
       321
       +
               DataStoreEncryptionKey = {

     

       322
       322
       +
                 _secret = "/run/agenix/netbird_mgmt-data_store_encryption_key";

     

       323
       323
       +
               };

     

       324
       324
       +
             };

     

       325
       325
       +
           };

     

       326
       326
       +
       

     

       327
       327
       +
           logLevel = mkOption {

     

       328
       328
       +
             type = enum [

     

       329
       329
       +
               "ERROR"

     

       330
       330
       +
               "WARN"

     

       331
       331
       +
               "INFO"

     

       332
       332
       +
               "DEBUG"

     

       333
       333
       +
             ];

     

       334
       334
       +
             default = "INFO";

     

       335
       335
       +
             description = "Log level of the netbird services.";

     

       336
       336
       +
           };

     

       337
       337
       +
       

     

       338
       338
       +
           enableNginx = mkEnableOption "Nginx reverse-proxy for the netbird management service.";

     

       339
       339
       +
         };

     

       340
       340
       +
       

     

       341
       341
       +
         config = mkIf cfg.enable {

     

       342
       342
       +
           warnings =

     

       343
       343
       +
             concatMap

     

       344
       344
       +
               (

     

       345
       345
       +
                 { check, name }:

     

       346
       346
       +
                 optional check "${name} is world-readable in the Nix Store, you should provide it as a _secret."

     

       347
       347
       +
               )

     

       348
       348
       +
               [

     

       349
       349
       +
                 {

     

       350
       350
       +
                   check = builtins.isString managementConfig.TURNConfig.Secret;

     

       351
       351
       +
                   name = "The TURNConfig.secret";

     

       352
       352
       +
                 }

     

       353
       353
       +
                 {

     

       354
       354
       +
                   check = builtins.isString managementConfig.DataStoreEncryptionKey;

     

       355
       355
       +
                   name = "The DataStoreEncryptionKey";

     

       356
       356
       +
                 }

     

       357
       357
       +
                 {

     

       358
       358
       +
                   check = any (T: (T ? Password) && builtins.isString T.Password) managementConfig.TURNConfig.Turns;

     

       359
       359
       +
                   name = "A Turn configuration's password";

     

       360
       360
       +
                 }

     

       361
       361
       +
               ];

     

       362
       362
       +
       

     

       363
       363
       +
           systemd.services.netbird-management = {

     

       364
       364
       +
             description = "The management server for Netbird, a wireguard VPN";

     

       365
       365
       +
             documentation = [ "https://netbird.io/docs/" ];

     

       366
       366
       +
       

     

       367
       367
       +
             after = [ "network.target" ];

     

       368
       368
       +
             wantedBy = [ "multi-user.target" ];

     

       369
       369
       +
             restartTriggers = [ managementFile ];

     

       370
       370
       +
       

     

       371
       371
       +
             preStart = genJqSecretsReplacementSnippet managementConfig "${stateDir}/management.json";

     

       372
       372
       +
       

     

       373
       373
       +
             serviceConfig = {

     

       374
       374
       +
               ExecStart = escapeSystemdExecArgs (

     

       375
       375
       +
                 [

     

       376
       376
       +
                   (getExe' cfg.package "netbird-mgmt")

     

       377
       377
       +
                   "management"

     

       378
       378
       +
                   # Config file

     

       379
       379
       +
                   "--config"

     

       380
       380
       +
                   "${stateDir}/management.json"

     

       381
       381
       +
                   # Data directory

     

       382
       382
       +
                   "--datadir"

     

       383
       383
       +
                   "${stateDir}/data"

     

       384
       384
       +
                   # DNS domain

     

       385
       385
       +
                   "--dns-domain"

     

       386
       386
       +
                   cfg.dnsDomain

     

       387
       387
       +
                   # Port to listen on

     

       388
       388
       +
                   "--port"

     

       389
       389
       +
                   cfg.port

     

       390
       390
       +
                   # Log to stdout

     

       391
       391
       +
                   "--log-file"

     

       392
       392
       +
                   "console"

     

       393
       393
       +
                   # Log level

     

       394
       394
       +
                   "--log-level"

     

       395
       395
       +
                   cfg.logLevel

     

       396
       396
       +
                   #

     

       397
       397
       +
                   "--idp-sign-key-refresh-enabled"

     

       398
       398
       +
                   # Domain for internal resolution

     

       399
       399
       +
                   "--single-account-mode-domain"

     

       400
       400
       +
                   cfg.singleAccountModeDomain

     

       401
       401
       +
                 ]

     

       402
       402
       +
                 ++ (optional cfg.disableAnonymousMetrics "--disable-anonymous-metrics")

     

       403
       403
       +
                 ++ (optional cfg.disableSingleAccountMode "--disable-single-account-mode")

     

       404
       404
       +
                 ++ cfg.extraOptions

     

       405
       405
       +
               );

     

       406
       406
       +
               Restart = "always";

     

       407
       407
       +
               RuntimeDirectory = "netbird-mgmt";

     

       408
       408
       +
               StateDirectory = [

     

       409
       409
       +
                 "netbird-mgmt"

     

       410
       410
       +
                 "netbird-mgmt/data"

     

       411
       411
       +
               ];

     

       412
       412
       +
               WorkingDirectory = stateDir;

     

       413
       413
       +
       

     

       414
       414
       +
               # hardening

     

       415
       415
       +
               LockPersonality = true;

     

       416
       416
       +
               MemoryDenyWriteExecute = true;

     

       417
       417
       +
               NoNewPrivileges = true;

     

       418
       418
       +
               PrivateMounts = true;

     

       419
       419
       +
               PrivateTmp = true;

     

       420
       420
       +
               ProtectClock = true;

     

       421
       421
       +
               ProtectControlGroups = true;

     

       422
       422
       +
               ProtectHome = true;

     

       423
       423
       +
               ProtectHostname = true;

     

       424
       424
       +
               ProtectKernelLogs = true;

     

       425
       425
       +
               ProtectKernelModules = true;

     

       426
       426
       +
               ProtectKernelTunables = true;

     

       427
       427
       +
               ProtectSystem = true;

     

       428
       428
       +
               RemoveIPC = true;

     

       429
       429
       +
               RestrictNamespaces = true;

     

       430
       430
       +
               RestrictRealtime = true;

     

       431
       431
       +
               RestrictSUIDSGID = true;

     

       432
       432
       +
             };

     

       433
       433
       +
       

     

       434
       434
       +
             stopIfChanged = false;

     

       435
       435
       +
           };

     

       436
       436
       +
       

     

       437
       437
       +
           services.nginx = mkIf cfg.enableNginx {

     

       438
       438
       +
             enable = true;

     

       439
       439
       +
       

     

       440
       440
       +
             virtualHosts.${cfg.domain} = {

     

       441
       441
       +
               locations = {

     

       442
       442
       +
                 "/api".proxyPass = "http://localhost:${builtins.toString cfg.port}";

     

       443
       443
       +
       

     

       444
       444
       +
                 "/management.ManagementService/".extraConfig = ''

     

       445
       445
       +
                   # This is necessary so that grpc connections do not get closed early

     

       446
       446
       +
                   # see https://stackoverflow.com/a/67805465

     

       447
       447
       +
                   client_body_timeout 1d;

     

       448
       448
       +
       

     

       449
       449
       +
                   grpc_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

     

       450
       450
       +
       

     

       451
       451
       +
                   grpc_pass grpc://localhost:${builtins.toString cfg.port};

     

       452
       452
       +
                   grpc_read_timeout 1d;

     

       453
       453
       +
                   grpc_send_timeout 1d;

     

       454
       454
       +
                   grpc_socket_keepalive on;

     

       455
       455
       +
                 '';

     

       456
       456
       +
               };

     

       457
       457
       +
             };

     

       458
       458
       +
           };

     

       459
       459
       +
         };

     

       460
       460
       +
       }

+42

nixos/modules/services/networking/netbird/server.md

···

       1
       1
       +
       # Netbird server {#module-services-netbird-server}

     

       2
       2
       +
       

     

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

     

       4
       4
       +
       

     

       5
       5
       +
       ## Quickstart {#module-services-netbird-server-quickstart}

     

       6
       6
       +
       

     

       7
       7
       +
       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](https://docs.netbird.io/selfhosted/selfhosted-guide#step-3-configure-identity-provider-idp).

     

       8
       8
       +
       

     

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

     

       10
       10
       +
       

     

       11
       11
       +
       ```nix

     

       12
       12
       +
       services.netbird.server = {

     

       13
       13
       +
         enable = true;

     

       14
       14
       +
       

     

       15
       15
       +
         domain = "netbird.example.selfhosted";

     

       16
       16
       +
       

     

       17
       17
       +
         enableNginx = true;

     

       18
       18
       +
       

     

       19
       19
       +
         coturn = {

     

       20
       20
       +
           enable = true;

     

       21
       21
       +
       

     

       22
       22
       +
           passwordFile = "/path/to/a/secret/password";

     

       23
       23
       +
         };

     

       24
       24
       +
       

     

       25
       25
       +
         management = {

     

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

     

       27
       27
       +
       

     

       28
       28
       +
           settings = {

     

       29
       29
       +
             TURNConfig = {

     

       30
       30
       +
               Turns = [

     

       31
       31
       +
                 {

     

       32
       32
       +
                   Proto = "udp";

     

       33
       33
       +
                   URI = "turn:netbird.example.selfhosted:3478";

     

       34
       34
       +
                   Username = "netbird";

     

       35
       35
       +
                   Password._secret = "/path/to/a/secret/password";

     

       36
       36
       +
                 }

     

       37
       37
       +
               ];

     

       38
       38
       +
             };

     

       39
       39
       +
           };

     

       40
       40
       +
         };

     

       41
       41
       +
       };

     

       42
       42
       +
       ```

+67

nixos/modules/services/networking/netbird/server.nix

···

       1
       1
       +
       { config, lib, ... }:

     

       2
       2
       +
       

     

       3
       3
       +
       let

     

       4
       4
       +
         inherit (lib)

     

       5
       5
       +
           mkEnableOption

     

       6
       6
       +
           mkIf

     

       7
       7
       +
           mkOption

     

       8
       8
       +
           optionalAttrs

     

       9
       9
       +
           ;

     

       10
       10
       +
       

     

       11
       11
       +
         inherit (lib.types) str;

     

       12
       12
       +
       

     

       13
       13
       +
         cfg = config.services.netbird.server;

     

       14
       14
       +
       in

     

       15
       15
       +
       

     

       16
       16
       +
       {

     

       17
       17
       +
         meta = {

     

       18
       18
       +
           maintainers = with lib.maintainers; [ thubrecht ];

     

       19
       19
       +
           doc = ./server.md;

     

       20
       20
       +
         };

     

       21
       21
       +
       

     

       22
       22
       +
         # Import the separate components

     

       23
       23
       +
         imports = [

     

       24
       24
       +
           ./coturn.nix

     

       25
       25
       +
           ./dashboard.nix

     

       26
       26
       +
           ./management.nix

     

       27
       27
       +
           ./signal.nix

     

       28
       28
       +
         ];

     

       29
       29
       +
       

     

       30
       30
       +
         options.services.netbird.server = {

     

       31
       31
       +
           enable = mkEnableOption "Netbird Server stack, comprising the dashboard, management API and signal service";

     

       32
       32
       +
       

     

       33
       33
       +
           enableNginx = mkEnableOption "Nginx reverse-proxy for the netbird server services.";

     

       34
       34
       +
       

     

       35
       35
       +
           domain = mkOption {

     

       36
       36
       +
             type = str;

     

       37
       37
       +
             description = "The domain under which the netbird server runs.";

     

       38
       38
       +
           };

     

       39
       39
       +
         };

     

       40
       40
       +
       

     

       41
       41
       +
         config = mkIf cfg.enable {

     

       42
       42
       +
           services.netbird.server = {

     

       43
       43
       +
             dashboard = {

     

       44
       44
       +
               inherit (cfg) enable domain enableNginx;

     

       45
       45
       +
       

     

       46
       46
       +
               managementServer = "https://${cfg.domain}";

     

       47
       47
       +
             };

     

       48
       48
       +
       

     

       49
       49
       +
             management =

     

       50
       50
       +
               {

     

       51
       51
       +
                 inherit (cfg) enable domain enableNginx;

     

       52
       52
       +
               }

     

       53
       53
       +
               // (optionalAttrs cfg.coturn.enable {

     

       54
       54
       +
                 turnDomain = cfg.domain;

     

       55
       55
       +
                 turnPort = config.services.coturn.tls-listening-port;

     

       56
       56
       +
               });

     

       57
       57
       +
       

     

       58
       58
       +
             signal = {

     

       59
       59
       +
               inherit (cfg) enable domain enableNginx;

     

       60
       60
       +
             };

     

       61
       61
       +
       

     

       62
       62
       +
             coturn = {

     

       63
       63
       +
               inherit (cfg) domain;

     

       64
       64
       +
             };

     

       65
       65
       +
           };

     

       66
       66
       +
         };

     

       67
       67
       +
       }

+123

nixos/modules/services/networking/netbird/signal.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         utils,

     

       6
       6
       +
         ...

     

       7
       7
       +
       }:

     

       8
       8
       +
       

     

       9
       9
       +
       let

     

       10
       10
       +
         inherit (lib)

     

       11
       11
       +
           getExe'

     

       12
       12
       +
           mkEnableOption

     

       13
       13
       +
           mkIf

     

       14
       14
       +
           mkPackageOption

     

       15
       15
       +
           mkOption

     

       16
       16
       +
           ;

     

       17
       17
       +
       

     

       18
       18
       +
         inherit (lib.types) enum port str;

     

       19
       19
       +
       

     

       20
       20
       +
         inherit (utils) escapeSystemdExecArgs;

     

       21
       21
       +
       

     

       22
       22
       +
         cfg = config.services.netbird.server.signal;

     

       23
       23
       +
       in

     

       24
       24
       +
       

     

       25
       25
       +
       {

     

       26
       26
       +
         options.services.netbird.server.signal = {

     

       27
       27
       +
           enable = mkEnableOption "Netbird's Signal Service";

     

       28
       28
       +
       

     

       29
       29
       +
           package = mkPackageOption pkgs "netbird" { };

     

       30
       30
       +
       

     

       31
       31
       +
           enableNginx = mkEnableOption "Nginx reverse-proxy for the netbird signal service.";

     

       32
       32
       +
       

     

       33
       33
       +
           domain = mkOption {

     

       34
       34
       +
             type = str;

     

       35
       35
       +
             description = "The domain name for the signal service.";

     

       36
       36
       +
           };

     

       37
       37
       +
       

     

       38
       38
       +
           port = mkOption {

     

       39
       39
       +
             type = port;

     

       40
       40
       +
             default = 8012;

     

       41
       41
       +
             description = "Internal port of the signal server.";

     

       42
       42
       +
           };

     

       43
       43
       +
       

     

       44
       44
       +
           logLevel = mkOption {

     

       45
       45
       +
             type = enum [

     

       46
       46
       +
               "ERROR"

     

       47
       47
       +
               "WARN"

     

       48
       48
       +
               "INFO"

     

       49
       49
       +
               "DEBUG"

     

       50
       50
       +
             ];

     

       51
       51
       +
             default = "INFO";

     

       52
       52
       +
             description = "Log level of the netbird signal service.";

     

       53
       53
       +
           };

     

       54
       54
       +
         };

     

       55
       55
       +
       

     

       56
       56
       +
         config = mkIf cfg.enable {

     

       57
       57
       +
           systemd.services.netbird-signal = {

     

       58
       58
       +
             after = [ "network.target" ];

     

       59
       59
       +
             wantedBy = [ "multi-user.target" ];

     

       60
       60
       +
       

     

       61
       61
       +
             serviceConfig = {

     

       62
       62
       +
               ExecStart = escapeSystemdExecArgs [

     

       63
       63
       +
                 (getExe' cfg.package "netbird-signal")

     

       64
       64
       +
                 "run"

     

       65
       65
       +
                 # Port to listen on

     

       66
       66
       +
                 "--port"

     

       67
       67
       +
                 cfg.port

     

       68
       68
       +
                 # Log to stdout

     

       69
       69
       +
                 "--log-file"

     

       70
       70
       +
                 "console"

     

       71
       71
       +
                 # Log level

     

       72
       72
       +
                 "--log-level"

     

       73
       73
       +
                 cfg.logLevel

     

       74
       74
       +
               ];

     

       75
       75
       +
       

     

       76
       76
       +
               Restart = "always";

     

       77
       77
       +
               RuntimeDirectory = "netbird-mgmt";

     

       78
       78
       +
               StateDirectory = "netbird-mgmt";

     

       79
       79
       +
               WorkingDirectory = "/var/lib/netbird-mgmt";

     

       80
       80
       +
       

     

       81
       81
       +
               # hardening

     

       82
       82
       +
               LockPersonality = true;

     

       83
       83
       +
               MemoryDenyWriteExecute = true;

     

       84
       84
       +
               NoNewPrivileges = true;

     

       85
       85
       +
               PrivateMounts = true;

     

       86
       86
       +
               PrivateTmp = true;

     

       87
       87
       +
               ProtectClock = true;

     

       88
       88
       +
               ProtectControlGroups = true;

     

       89
       89
       +
               ProtectHome = true;

     

       90
       90
       +
               ProtectHostname = true;

     

       91
       91
       +
               ProtectKernelLogs = true;

     

       92
       92
       +
               ProtectKernelModules = true;

     

       93
       93
       +
               ProtectKernelTunables = true;

     

       94
       94
       +
               ProtectSystem = true;

     

       95
       95
       +
               RemoveIPC = true;

     

       96
       96
       +
               RestrictNamespaces = true;

     

       97
       97
       +
               RestrictRealtime = true;

     

       98
       98
       +
               RestrictSUIDSGID = true;

     

       99
       99
       +
             };

     

       100
       100
       +
       

     

       101
       101
       +
             stopIfChanged = false;

     

       102
       102
       +
           };

     

       103
       103
       +
       

     

       104
       104
       +
           services.nginx = mkIf cfg.enableNginx {

     

       105
       105
       +
             enable = true;

     

       106
       106
       +
       

     

       107
       107
       +
             virtualHosts.${cfg.domain} = {

     

       108
       108
       +
               locations."/signalexchange.SignalExchange/".extraConfig = ''

     

       109
       109
       +
                 # This is necessary so that grpc connections do not get closed early

     

       110
       110
       +
                 # see https://stackoverflow.com/a/67805465

     

       111
       111
       +
                 client_body_timeout 1d;

     

       112
       112
       +
       

     

       113
       113
       +
                 grpc_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

     

       114
       114
       +
       

     

       115
       115
       +
                 grpc_pass grpc://localhost:${builtins.toString cfg.port};

     

       116
       116
       +
                 grpc_read_timeout 1d;

     

       117
       117
       +
                 grpc_send_timeout 1d;

     

       118
       118
       +
                 grpc_socket_keepalive on;

     

       119
       119
       +
               '';

     

       120
       120
       +
             };

     

       121
       121
       +
           };

     

       122
       122
       +
         };

     

       123
       123
       +
       }

+35

pkgs/by-name/ne/netbird-dashboard/package.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         buildNpmPackage,

     

       4
       4
       +
         fetchFromGitHub,

     

       5
       5
       +
       }:

     

       6
       6
       +
       

     

       7
       7
       +
       buildNpmPackage rec {

     

       8
       8
       +
         pname = "netbird-dashboard";

     

       9
       9
       +
         version = "2.3.0";

     

       10
       10
       +
       

     

       11
       11
       +
         src = fetchFromGitHub {

     

       12
       12
       +
           owner = "netbirdio";

     

       13
       13
       +
           repo = "dashboard";

     

       14
       14
       +
           rev = "v${version}";

     

       15
       15
       +
           hash = "sha256-4aZ7WGLhjpTHOggJ+sRdln0YOG3jf7TKT9/bH/n3LmQ=";

     

       16
       16
       +
         };

     

       17
       17
       +
       

     

       18
       18
       +
         npmDepsHash = "sha256-ts3UuThIMf+wwSr3DpZ+k1i9RnHi/ltvhD/7lomVxQk=";

     

       19
       19
       +
         npmFlags = [ "--legacy-peer-deps" ];

     

       20
       20
       +
       

     

       21
       21
       +
         installPhase = ''

     

       22
       22
       +
           cp -R out $out

     

       23
       23
       +
         '';

     

       24
       24
       +
       

     

       25
       25
       +
         env = {

     

       26
       26
       +
           CYPRESS_INSTALL_BINARY = 0;

     

       27
       27
       +
         };

     

       28
       28
       +
       

     

       29
       29
       +
         meta = with lib; {

     

       30
       30
       +
           description = "NetBird Management Service Web UI Panel";

     

       31
       31
       +
           homepage = "https://github.com/netbirdio/dashboard";

     

       32
       32
       +
           license = licenses.bsd3;

     

       33
       33
       +
           maintainers = with maintainers; [ thubrecht ];

     

       34
       34
       +
         };

     

       35
       35
       +
       }