From c55a801cfe025a57bd120fff8f40f97689fde5d8 Mon Sep 17 00:00:00 2001 From: "Krzysztof Nazarewski (kdn)" Date: Fri, 8 Aug 2025 11:13:41 +0200 Subject: [PATCH] nixos/netbird: clarify routing features & brand adjustments --- nixos/modules/services/networking/netbird.nix | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/nixos/modules/services/networking/netbird.nix b/nixos/modules/services/networking/netbird.nix index a5a89296621d..84a59b3bf624 100644 --- a/nixos/modules/services/networking/netbird.nix +++ b/nixos/modules/services/networking/netbird.nix @@ -84,7 +84,7 @@ in type = bool; default = false; description = '' - Enables backwards compatible Netbird client service. + Enables backward-compatible NetBird client service. This is strictly equivalent to: @@ -123,7 +123,7 @@ in default = "none"; example = "server"; description = '' - Enables settings required for Netbird's routing features like subnet routers and exit nodes. + Enables settings required for NetBird's routing features: Network Resources, Network Routes & Exit Nodes. When set to `client` or `both`, reverse path filtering will be set to loose instead of strict. When set to `server` or `both`, IP forwarding will be enabled. @@ -143,7 +143,7 @@ in type = port; example = literalExpression "51820"; description = '' - Port the Netbird client listens on. + Port the NetBird client listens on. ''; }; @@ -164,9 +164,9 @@ in default = null; example = "127.0.0.123"; description = '' - An explicit address that Netbird will serve `*.netbird.cloud.` (usually) entries on. + An explicit address that NetBird will serve `*.netbird.cloud.` (usually) entries on. - Netbird serves DNS on it's own (dynamic) client address by default. + NetBird serves DNS on it's own (dynamic) client address by default. ''; }; @@ -218,7 +218,7 @@ in description = '' Start the service with the system. - As of 2024-02-13 it is not possible to start a Netbird client daemon without immediately + As of 2024-02-13 it is not possible to start a NetBird client daemon without immediately connecting to the network, but it is [planned for a near future](https://github.com/netbirdio/netbird/projects/2#card-91718018). ''; }; @@ -227,7 +227,7 @@ in type = bool; default = true; description = '' - Opens up firewall `port` for communication between Netbird peers directly over LAN or public IP, + Opens up firewall `port` for communication between NetBird peers directly over LAN or public IP, without using (internet-hosted) TURN servers as intermediaries. ''; }; @@ -265,7 +265,7 @@ in "trace" ]; default = "info"; - description = "Log level of the Netbird daemon."; + description = "Log level of the NetBird daemon."; }; ui.enable = mkOption { @@ -273,7 +273,7 @@ in default = nixosConfig.services.netbird.ui.enable; defaultText = literalExpression ''client.ui.enable''; description = '' - Controls presence of `netbird-ui` wrapper for this Netbird client. + Controls presence of `netbird-ui` wrapper for this NetBird client. ''; }; @@ -310,7 +310,7 @@ in mkdir -p "$out/share/applications" substitute ${cfg.ui.package}/share/applications/netbird.desktop \ "$out/share/applications/${mkBin "netbird"}.desktop" \ - --replace-fail 'Name=Netbird' "Name=Netbird @ ${client.service.name}" \ + --replace-fail 'Name=NetBird' "Name=NetBird @ ${client.service.name}" \ --replace-fail '${lib.getExe cfg.ui.package}' "$out/bin/${mkBin "netbird-ui"}" '') ]; @@ -366,14 +366,14 @@ in type = path; default = "/var/lib/${client.dir.baseName}"; description = '' - A state directory used by Netbird client to store `config.json`, `state.json` & `resolv.conf`. + A state directory used by NetBird client to store `config.json`, `state.json` & `resolv.conf`. ''; }; dir.runtime = mkOption { type = path; default = "/var/run/${client.dir.baseName}"; description = '' - A runtime directory used by Netbird client. + A runtime directory used by NetBird client. ''; }; service.name = mkOption { @@ -433,11 +433,11 @@ in ); default = { }; description = '' - Attribute set of Netbird client daemons, by default each one will: + Attribute set of NetBird client daemons, by default each one will: 1. be manageable using dedicated tooling: - `netbird-` script, - - `Netbird - netbird-` graphical interface when appropriate (see `ui.enable`), + - `NetBird - netbird-` graphical interface when appropriate (see `ui.enable`), 2. run as a `netbird-.service`, 3. listen for incoming remote connections on the port `51820` (`openFirewall` by default), 4. manage the `netbird-` wireguard interface, @@ -630,7 +630,7 @@ in # see https://github.com/systemd/systemd/blob/17f3e91e8107b2b29fe25755651b230bbc81a514/src/resolve/org.freedesktop.resolve1.policy#L43-L43 # see all actions used at https://github.com/netbirdio/netbird/blob/13e7198046a0d73a9cd91bf8e063fafb3d41885c/client/internal/dns/systemd_linux.go#L29-L32 security.polkit.extraConfig = mkIf config.services.resolved.enable '' - // systemd-resolved access for Netbird clients + // systemd-resolved access for NetBird clients polkit.addRule(function(action, subject) { var actions = [ "org.freedesktop.resolve1.revert",