diff --git a/nixos/modules/config/resolvconf.nix b/nixos/modules/config/resolvconf.nix index cdc40d2c810b..ef291ce5aaf1 100644 --- a/nixos/modules/config/resolvconf.nix +++ b/nixos/modules/config/resolvconf.nix @@ -84,8 +84,8 @@ in type = types.bool; default = true; description = '' - Enable the edns0 option in resolv.conf. With - that option set, glibc supports use of the extension mechanisms for + Enable the edns0 option in resolv.conf. With + that option set, glibc supports use of the extension mechanisms for DNS (EDNS) specified in RFC 2671. The most popular user of that feature is DNSSEC, which does not work without it. ''; diff --git a/nixos/modules/config/shells-environment.nix b/nixos/modules/config/shells-environment.nix index 660b2e1fa4bf..3dc202327c2d 100644 --- a/nixos/modules/config/shells-environment.nix +++ b/nixos/modules/config/shells-environment.nix @@ -113,7 +113,7 @@ in An attribute set that maps aliases (the top level attribute names in this option) to command strings or directly to build outputs. The aliases are added to all users' shells. - Aliases mapped to null are ignored. + Aliases mapped to null are ignored. ''; type = with types; attrsOf (nullOr (either str path)); }; diff --git a/nixos/modules/config/system-environment.nix b/nixos/modules/config/system-environment.nix index d2a66b8d932d..a299fdceaf1c 100644 --- a/nixos/modules/config/system-environment.nix +++ b/nixos/modules/config/system-environment.nix @@ -30,7 +30,7 @@ in Also, these variables are merged into and it is therefore not possible to use PAM style variables such as - @{HOME}. + @{HOME}. ''; type = with types; attrsOf (either str (listOf str)); apply = mapAttrs (n: v: if isList v then concatStringsSep ":" v else v); @@ -58,7 +58,7 @@ in Also, these variables are merged into and it is therefore not possible to use PAM style variables such as - @{HOME}. + @{HOME}. ''; }; diff --git a/nixos/modules/config/users-groups.nix b/nixos/modules/config/users-groups.nix index 466e3f6138a5..1b63dc52d6ef 100644 --- a/nixos/modules/config/users-groups.nix +++ b/nixos/modules/config/users-groups.nix @@ -154,8 +154,8 @@ let description = '' Attributes for user's entry in pam_mount.conf.xml. - Useful attributes might include path, - options, fstype, and server. + Useful attributes might include path, + options, fstype, and server. See for more information. @@ -172,7 +172,7 @@ let like pkgs.bashInteractive. Don’t forget to enable your shell in programs if necessary, - like programs.zsh.enable = true;. + like programs.zsh.enable = true;. ''; }; diff --git a/nixos/modules/misc/nixpkgs.nix b/nixos/modules/misc/nixpkgs.nix index e991ff42028d..bb21e31ec979 100644 --- a/nixos/modules/misc/nixpkgs.nix +++ b/nixos/modules/misc/nixpkgs.nix @@ -119,11 +119,11 @@ in example = literalExpression "import {}"; description = '' If set, the pkgs argument to all NixOS modules is the value of - this option, extended with nixpkgs.overlays, if - that is also set. Either nixpkgs.crossSystem or - nixpkgs.localSystem will be used in an assertion + this option, extended with nixpkgs.overlays, if + that is also set. Either nixpkgs.crossSystem or + nixpkgs.localSystem will be used in an assertion to check that the NixOS and Nixpkgs architectures match. Any - other options in nixpkgs.*, notably config, + other options in nixpkgs.*, notably config, will be ignored. If unset, the pkgs argument to all NixOS modules is determined @@ -132,18 +132,18 @@ in The default value imports the Nixpkgs source files relative to the location of this NixOS module, because NixOS and Nixpkgs are distributed together for consistency, - so the nixos in the default value is in fact a - relative path. The config, overlays, - localSystem, and crossSystem come + so the nixos in the default value is in fact a + relative path. The config, overlays, + localSystem, and crossSystem come from this option's siblings. This option can be used by applications like NixOps to increase the performance of evaluation, or to create packages that depend on a container that should be built with the exact same evaluation of Nixpkgs, for example. Applications like this should set - their default value using lib.mkDefault, so + their default value using lib.mkDefault, so user-provided configuration can override it without using - lib. + lib. Note that using a distinct version of Nixpkgs with NixOS may be an unexpected source of problems. Use this option with care. @@ -162,7 +162,7 @@ in details, see the Nixpkgs documentation.) It allows you to set package configuration options. - Ignored when nixpkgs.pkgs is set. + Ignored when nixpkgs.pkgs is set. ''; }; @@ -188,9 +188,9 @@ in The first argument should be used for finding dependencies, and the second should be used for overriding recipes. - If nixpkgs.pkgs is set, overlays specified here + If nixpkgs.pkgs is set, overlays specified here will be applied after the overlays that were already present - in nixpkgs.pkgs. + in nixpkgs.pkgs. ''; }; @@ -205,9 +205,9 @@ in description = '' Specifies the platform where the NixOS configuration will run. - To cross-compile, set also nixpkgs.buildPlatform. + To cross-compile, set also nixpkgs.buildPlatform. - Ignored when nixpkgs.pkgs is set. + Ignored when nixpkgs.pkgs is set. ''; }; @@ -230,7 +230,7 @@ in or if you're building machines, you can set this to match your development system and/or build farm. - Ignored when nixpkgs.pkgs is set. + Ignored when nixpkgs.pkgs is set. ''; }; @@ -253,7 +253,7 @@ in use the old options. Specifies the platform on which NixOS should be built. When - nixpkgs.crossSystem is unset, it also specifies + nixpkgs.crossSystem is unset, it also specifies the platform for which NixOS should be built. If this option is unset, it defaults to the platform type of the machine where evaluation happens. Specifying this @@ -261,7 +261,7 @@ in deployment, or when building virtual machines. See its description in the Nixpkgs manual for more details. - Ignored when nixpkgs.pkgs or hostPlatform is set. + Ignored when nixpkgs.pkgs or hostPlatform is set. ''; }; @@ -279,13 +279,13 @@ in Specifies the platform for which NixOS should be built. Specify this only if it is different from - nixpkgs.localSystem, the platform + nixpkgs.localSystem, the platform on which NixOS should be built. In other words, specify this to cross-compile NixOS. Otherwise it should be set as null, the default. See its description in the Nixpkgs manual for more details. - Ignored when nixpkgs.pkgs or hostPlatform is set. + Ignored when nixpkgs.pkgs or hostPlatform is set. ''; }; @@ -316,7 +316,7 @@ in with a recently generated hardware-configuration.nix. Specifies the Nix platform type on which NixOS should be built. - It is better to specify nixpkgs.localSystem instead. + It is better to specify nixpkgs.localSystem instead. { nixpkgs.system = ..; @@ -328,9 +328,9 @@ in nixpkgs.localSystem.system = ..; } - See nixpkgs.localSystem for more information. + See nixpkgs.localSystem for more information. - Ignored when nixpkgs.pkgs, nixpkgs.localSystem or nixpkgs.hostPlatform is set. + Ignored when nixpkgs.pkgs, nixpkgs.localSystem or nixpkgs.hostPlatform is set. ''; }; }; diff --git a/nixos/modules/programs/adb.nix b/nixos/modules/programs/adb.nix index 9e9e37f92a87..634031939207 100644 --- a/nixos/modules/programs/adb.nix +++ b/nixos/modules/programs/adb.nix @@ -14,7 +14,7 @@ with lib; description = '' Whether to configure system to use Android Debug Bridge (adb). To grant access to a user, it must be part of adbusers group: - users.users.alice.extraGroups = ["adbusers"]; + users.users.alice.extraGroups = ["adbusers"]; ''; }; }; diff --git a/nixos/modules/programs/firejail.nix b/nixos/modules/programs/firejail.nix index e014aea626c7..b9a0f9a69113 100644 --- a/nixos/modules/programs/firejail.nix +++ b/nixos/modules/programs/firejail.nix @@ -74,7 +74,7 @@ in { You will get file collisions if you put the actual application binary in the global environment (such as by adding the application package to - environment.systemPackages), and applications started via + environment.systemPackages), and applications started via .desktop files are not wrapped if they specify the absolute path to the binary. ''; diff --git a/nixos/modules/programs/gphoto2.nix b/nixos/modules/programs/gphoto2.nix index 93923ff3133c..373b53495f75 100644 --- a/nixos/modules/programs/gphoto2.nix +++ b/nixos/modules/programs/gphoto2.nix @@ -15,7 +15,7 @@ with lib; Whether to configure system to use gphoto2. To grant digital camera access to a user, the user must be part of the camera group: - users.users.alice.extraGroups = ["camera"]; + users.users.alice.extraGroups = ["camera"]; ''; }; }; diff --git a/nixos/modules/programs/kdeconnect.nix b/nixos/modules/programs/kdeconnect.nix index aa4302404ad4..1f326c9e9219 100644 --- a/nixos/modules/programs/kdeconnect.nix +++ b/nixos/modules/programs/kdeconnect.nix @@ -8,7 +8,7 @@ with lib; Note that it will open the TCP and UDP port from 1714 to 1764 as they are needed for it to function properly. You can use the to use - gnomeExtensions.gsconnect as an alternative + gnomeExtensions.gsconnect as an alternative implementation if you use Gnome. ''; package = mkOption { diff --git a/nixos/modules/programs/ssh.nix b/nixos/modules/programs/ssh.nix index e0da6ef3b3ad..9c4a95ef22c6 100644 --- a/nixos/modules/programs/ssh.nix +++ b/nixos/modules/programs/ssh.nix @@ -95,7 +95,7 @@ in default = ""; description = '' Extra configuration text prepended to ssh_config. Other generated - options will be added after a Host * pattern. + options will be added after a Host * pattern. See ssh_config5 for help. ''; diff --git a/nixos/modules/programs/turbovnc.nix b/nixos/modules/programs/turbovnc.nix index e6f8836aa367..eb09c554290f 100644 --- a/nixos/modules/programs/turbovnc.nix +++ b/nixos/modules/programs/turbovnc.nix @@ -22,7 +22,7 @@ in This will enable so that OpenGL programs can find Mesa's llvmpipe drivers. - Setting this option to false does not mean that software + Setting this option to false does not mean that software OpenGL won't work; it may still work depending on your system configuration. diff --git a/nixos/modules/security/acme/default.nix b/nixos/modules/security/acme/default.nix index 54b44dcab62b..5f4344d451c8 100644 --- a/nixos/modules/security/acme/default.nix +++ b/nixos/modules/security/acme/default.nix @@ -505,7 +505,7 @@ let type = types.listOf types.str; inherit (defaultAndText "reloadServices" []) default defaultText; description = '' - The list of systemd services to call systemctl try-reload-or-restart + The list of systemd services to call systemctl try-reload-or-restart on. ''; }; diff --git a/nixos/modules/security/doas.nix b/nixos/modules/security/doas.nix index d4b51b406e28..2641548221a9 100644 --- a/nixos/modules/security/doas.nix +++ b/nixos/modules/security/doas.nix @@ -63,7 +63,7 @@ in type = with types; bool; default = true; description = '' - Whether users of the wheel group must provide a password to + Whether users of the wheel group must provide a password to run commands as super user via doas. ''; }; @@ -74,7 +74,7 @@ in Define specific rules to be set in the /etc/doas.conf file. More specific rules should come after more general ones in order to yield the expected behavior. - You can use mkBefore and/or mkAfter to ensure + You can use mkBefore and/or mkAfter to ensure this is the case when configuration options are merged. ''; example = literalExpression '' @@ -114,7 +114,7 @@ in type = with types; bool; default = false; description = '' - If true, the user is not required to enter a + If true, the user is not required to enter a password. ''; }; @@ -123,7 +123,7 @@ in type = with types; bool; default = false; description = '' - If true, successful executions will not be logged + If true, successful executions will not be logged to syslogd8. ''; @@ -133,7 +133,7 @@ in type = with types; bool; default = false; description = '' - If true, do not ask for a password again for some + If true, do not ask for a password again for some time after the user successfully authenticates. ''; }; @@ -142,7 +142,7 @@ in type = with types; bool; default = false; description = '' - If true, environment variables other than those + If true, environment variables other than those listed in doas1 are kept when creating the environment for the new process. @@ -155,15 +155,15 @@ in description = '' Keep or set the specified variables. Variables may also be removed with a leading '-' or set using - variable=value. If the first character of - value is a '$', the value to be set is taken from + variable=value. If the first character of + value is a '$', the value to be set is taken from the existing environment variable of the indicated name. This option is processed after the default environment has been created. - NOTE: All rules have setenv { SSH_AUTH_SOCK } by - default. To prevent SSH_AUTH_SOCK from being - inherited, add "-SSH_AUTH_SOCK" anywhere in this + NOTE: All rules have setenv { SSH_AUTH_SOCK } by + default. To prevent SSH_AUTH_SOCK from being + inherited, add "-SSH_AUTH_SOCK" anywhere in this list. ''; }; @@ -185,12 +185,12 @@ in default = null; description = '' Which user or group the specified command is allowed to run as. - When set to null (the default), all users are + When set to null (the default), all users are allowed. A user can be specified using just the username: - "foo". It is also possible to only allow running as - a specific group with ":bar". + "foo". It is also possible to only allow running as + a specific group with ":bar". ''; }; @@ -199,7 +199,7 @@ in default = null; description = '' The command the user is allowed to run. When set to - null (the default), all commands are allowed. + null (the default), all commands are allowed. NOTE: It is best practice to specify absolute paths. If a relative path is specified, only a restricted PATH will be @@ -212,7 +212,7 @@ in default = null; description = '' Arguments that must be provided to the command. When set to - [], the command must be run without any arguments. + [], the command must be run without any arguments. ''; }; }; diff --git a/nixos/modules/security/sudo.nix b/nixos/modules/security/sudo.nix index 2e30a8915d86..c1a69aedde45 100644 --- a/nixos/modules/security/sudo.nix +++ b/nixos/modules/security/sudo.nix @@ -56,7 +56,7 @@ in default = true; description = '' - Whether users of the wheel group must + Whether users of the wheel group must provide a password to run commands as super user via sudo. ''; }; @@ -65,9 +65,9 @@ in type = types.bool; default = false; description = '' - Only allow members of the wheel group to execute sudo by + Only allow members of the wheel group to execute sudo by setting the executable's permissions accordingly. - This prevents users that are not members of wheel from + This prevents users that are not members of wheel from exploiting vulnerabilities in sudo such as CVE-2021-3156. ''; }; @@ -142,9 +142,9 @@ in description = '' Under which user/group the specified command is allowed to run. - A user can be specified using just the username: "foo". - It is also possible to specify a user/group combination using "foo:bar" - or to only allow running as a specific group with ":bar". + A user can be specified using just the username: "foo". + It is also possible to specify a user/group combination using "foo:bar" + or to only allow running as a specific group with ":bar". ''; }; @@ -159,7 +159,7 @@ in type = with types; str; description = '' A command being either just a path to a binary to allow any arguments, - the full command with arguments pre-set or with "" used as the argument, + the full command with arguments pre-set or with "" used as the argument, not allowing arguments to the command at all. ''; }; diff --git a/nixos/modules/services/databases/firebird.nix b/nixos/modules/services/databases/firebird.nix index 3a7ebd6bbd09..a26f1ff8258f 100644 --- a/nixos/modules/services/databases/firebird.nix +++ b/nixos/modules/services/databases/firebird.nix @@ -48,8 +48,8 @@ in type = types.package; example = literalExpression "pkgs.firebird_3"; description = '' - Which Firebird package to be installed: pkgs.firebird_3 - For SuperServer use override: pkgs.firebird_3.override { superServer = true; }; + Which Firebird package to be installed: pkgs.firebird_3 + For SuperServer use override: pkgs.firebird_3.override { superServer = true; }; ''; }; diff --git a/nixos/modules/services/databases/mysql.nix b/nixos/modules/services/databases/mysql.nix index b7a55900c122..1e6a6b844a37 100644 --- a/nixos/modules/services/databases/mysql.nix +++ b/nixos/modules/services/databases/mysql.nix @@ -211,7 +211,7 @@ in For more information on how to specify the target and on which privileges exist, see the GRANT syntax. - The attributes are used as GRANT ''${attrName} ON ''${attrValue}. + The attributes are used as GRANT ''${attrName} ON ''${attrValue}. ''; example = literalExpression '' { diff --git a/nixos/modules/services/databases/postgresql.nix b/nixos/modules/services/databases/postgresql.nix index e27f4518dfad..a054a6d7a12f 100644 --- a/nixos/modules/services/databases/postgresql.nix +++ b/nixos/modules/services/databases/postgresql.nix @@ -159,7 +159,7 @@ in For more information on how to specify the target and on which privileges exist, see the GRANT syntax. - The attributes are used as GRANT ''${attrValue} ON ''${attrName}. + The attributes are used as GRANT ''${attrValue} ON ''${attrName}. ''; example = literalExpression '' { diff --git a/nixos/modules/services/mail/nullmailer.nix b/nixos/modules/services/mail/nullmailer.nix index 59329667f7ad..c37001e35bfa 100644 --- a/nixos/modules/services/mail/nullmailer.nix +++ b/nixos/modules/services/mail/nullmailer.nix @@ -39,10 +39,10 @@ with lib; type = types.nullOr types.str; default = null; description = '' - Path to the remotes control file. This file contains a + Path to the remotes control file. This file contains a list of remote servers to which to send each message. - See man 8 nullmailer-send for syntax and available + See man 8 nullmailer-send for syntax and available options. ''; }; @@ -158,12 +158,12 @@ with lib; contains a remote host name or address followed by an optional protocol string, separated by white space. - See man 8 nullmailer-send for syntax and available + See man 8 nullmailer-send for syntax and available options. WARNING: This is stored world-readable in the nix store. If you need to specify any secret credentials here, consider using the - remotesFile option instead. + remotesFile option instead. ''; }; diff --git a/nixos/modules/services/mail/public-inbox.nix b/nixos/modules/services/mail/public-inbox.nix index bb835881ba0a..6f33283b548b 100644 --- a/nixos/modules/services/mail/public-inbox.nix +++ b/nixos/modules/services/mail/public-inbox.nix @@ -26,7 +26,7 @@ let description = '' Listening port. Beware that public-inbox uses well-known ports number to decide whether to enable TLS or not. - Set to null and use systemd.sockets.public-inbox-${proto}d.listenStreams + Set to null and use systemd.sockets.public-inbox-${proto}d.listenStreams if you need a more advanced listening. ''; }; @@ -242,8 +242,8 @@ in description = '' Listening port or systemd's ListenStream= entry to be used as a reverse proxy, eg. in nginx: - locations."/inbox".proxyPass = "http://unix:''${config.services.public-inbox.http.port}:/inbox"; - Set to null and use systemd.sockets.public-inbox-httpd.listenStreams + locations."/inbox".proxyPass = "http://unix:''${config.services.public-inbox.http.port}:/inbox"; + Set to null and use systemd.sockets.public-inbox-httpd.listenStreams if you need a more advanced listening. ''; }; diff --git a/nixos/modules/services/misc/autorandr.nix b/nixos/modules/services/misc/autorandr.nix index 9a0530866b58..a77535cca49e 100644 --- a/nixos/modules/services/misc/autorandr.nix +++ b/nixos/modules/services/misc/autorandr.nix @@ -29,7 +29,7 @@ let type = types.attrsOf types.str; description = '' Output name to EDID mapping. - Use autorandr --fingerprint to get current setup values. + Use autorandr --fingerprint to get current setup values. ''; default = { }; }; diff --git a/nixos/modules/services/misc/sourcehut/default.nix b/nixos/modules/services/misc/sourcehut/default.nix index 3ff2837900ec..de04797a800c 100644 --- a/nixos/modules/services/misc/sourcehut/default.nix +++ b/nixos/modules/services/misc/sourcehut/default.nix @@ -180,7 +180,7 @@ in network-key = mkOption { description = '' An absolute file path (which should be outside the Nix-store) - to a secret key to encrypt internal messages with. Use srht-keygen network to + to a secret key to encrypt internal messages with. Use srht-keygen network to generate this key. It must be consistent between all services and nodes. ''; type = types.path; @@ -209,7 +209,7 @@ in service-key = mkOption { description = '' An absolute file path (which should be outside the Nix-store) - to a key used for encrypting session cookies. Use srht-keygen service to + to a key used for encrypting session cookies. Use srht-keygen service to generate the service key. This must be shared between each node of the same service (e.g. git1.sr.ht and git2.sr.ht), but different services may use different keys. If you configure all of your services with the same @@ -252,8 +252,8 @@ in Your PGP key information (DO NOT mix up pub and priv here) You must remove the password from your secret key, if present. - You can do this with gpg --edit-key [key-id], - then use the passwd command and do not enter a new password. + You can do this with gpg --edit-key [key-id], + then use the passwd command and do not enter a new password. ''; }; pgp-pubkey = mkOption { @@ -294,7 +294,7 @@ in This should be consistent for all *.sr.ht sites, as this key will be used to verify signatures from other sites in your network. - Use the srht-keygen webhook command to generate a key. + Use the srht-keygen webhook command to generate a key. ''; type = types.path; apply = s: "<" + toString s; diff --git a/nixos/modules/services/networking/bird.nix b/nixos/modules/services/networking/bird.nix index d409f0602289..b166209fa969 100644 --- a/nixos/modules/services/networking/bird.nix +++ b/nixos/modules/services/networking/bird.nix @@ -24,7 +24,7 @@ in description = '' Whether the config should be checked at build time. When the config can't be checked during build time, for example when it includes - other files, either disable this option or use preCheckConfig to create + other files, either disable this option or use preCheckConfig to create the included files before checking. ''; }; @@ -36,7 +36,7 @@ in ''; description = '' Commands to execute before the config file check. The file to be checked will be - available as bird2.conf in the current directory. + available as bird2.conf in the current directory. Files created with this option will not be available at service runtime, only during build time checking. diff --git a/nixos/modules/services/networking/ghostunnel.nix b/nixos/modules/services/networking/ghostunnel.nix index 6cac6a69b067..ce5d386edc35 100644 --- a/nixos/modules/services/networking/ghostunnel.nix +++ b/nixos/modules/services/networking/ghostunnel.nix @@ -40,9 +40,9 @@ let description = '' Path to keystore (combined PEM with cert/key, or PKCS12 keystore). - NB: storepass is not supported because it would expose credentials via /proc/*/cmdline. + NB: storepass is not supported because it would expose credentials via /proc/*/cmdline. - Specify this or cert and key. + Specify this or cert and key. ''; type = types.nullOr types.str; default = null; @@ -52,7 +52,7 @@ let description = '' Path to certificate (PEM with certificate chain). - Not required if keystore is set. + Not required if keystore is set. ''; type = types.nullOr types.str; default = null; @@ -62,7 +62,7 @@ let description = '' Path to certificate private key (PEM with private key). - Not required if keystore is set. + Not required if keystore is set. ''; type = types.nullOr types.str; default = null; @@ -70,7 +70,7 @@ let cacert = mkOption { description = '' - Path to CA bundle file (PEM/X509). Uses system trust store if null. + Path to CA bundle file (PEM/X509). Uses system trust store if null. ''; type = types.nullOr types.str; }; @@ -124,7 +124,7 @@ let }; extraArguments = mkOption { - description = "Extra arguments to pass to ghostunnel server"; + description = "Extra arguments to pass to ghostunnel server"; type = types.separatedString " "; default = ""; }; diff --git a/nixos/modules/services/networking/nntp-proxy.nix b/nixos/modules/services/networking/nntp-proxy.nix index 618ed0a93f1d..1a776aae617b 100644 --- a/nixos/modules/services/networking/nntp-proxy.nix +++ b/nixos/modules/services/networking/nntp-proxy.nix @@ -169,7 +169,7 @@ in example = "$6$GtzE7FrpE$wwuVgFYU.TZH4Rz.Snjxk9XGua89IeVwPQ/fEUD8eujr40q5Y021yhn0aNcsQ2Ifw.BLclyzvzgegopgKcneL0"; description = '' SHA-512 password hash (can be generated by - mkpasswd -m sha-512 <password>) + mkpasswd -m sha-512 <password>) ''; }; diff --git a/nixos/modules/services/networking/nsd.nix b/nixos/modules/services/networking/nsd.nix index 1102fc85d40a..a372d3b207c4 100644 --- a/nixos/modules/services/networking/nsd.nix +++ b/nixos/modules/services/networking/nsd.nix @@ -393,7 +393,7 @@ let type = types.listOf types.str; default = []; description = '' - Format: [AXFR|UDP] <ip-address> <key-name | NOKEY> + Format: [AXFR|UDP] <ip-address> <key-name | NOKEY> ''; }; diff --git a/nixos/modules/services/networking/openconnect.nix b/nixos/modules/services/networking/openconnect.nix index c5313bb305a2..c72941459750 100644 --- a/nixos/modules/services/networking/openconnect.nix +++ b/nixos/modules/services/networking/openconnect.nix @@ -40,8 +40,8 @@ let passwordFile = mkOption { description = '' File containing the password to authenticate with. This - is passed to openconnect via the - --passwd-on-stdin option. + is passed to openconnect via the + --passwd-on-stdin option. ''; default = null; example = "/var/lib/secrets/openconnect-passwd"; @@ -66,10 +66,10 @@ let description = '' Extra config to be appended to the interface config. It should contain long-format options as would be accepted on the command - line by openconnect + line by openconnect (see https://www.infradead.org/openconnect/manual.html). - Non-key-value options like deflate can be used by - declaring them as booleans, i. e. deflate = true;. + Non-key-value options like deflate can be used by + declaring them as booleans, i. e. deflate = true;. ''; default = { }; example = { diff --git a/nixos/modules/services/networking/yggdrasil.nix b/nixos/modules/services/networking/yggdrasil.nix index 07b2e2a2daf2..e99f31b0eaa4 100644 --- a/nixos/modules/services/networking/yggdrasil.nix +++ b/nixos/modules/services/networking/yggdrasil.nix @@ -44,8 +44,8 @@ in { are supplied, they will be combined, with values from taking precedence. - You can use the command nix-shell -p yggdrasil --run - "yggdrasil -genconf" to generate default + You can use the command nix-shell -p yggdrasil --run + "yggdrasil -genconf" to generate default configuration values with documentation. ''; }; @@ -64,7 +64,7 @@ in { type = types.nullOr types.str; default = null; example = "wheel"; - description = "Group to grant access to the Yggdrasil control socket. If null, only root can access the socket."; + description = "Group to grant access to the Yggdrasil control socket. If null, only root can access the socket."; }; openMulticastPort = mkOption { @@ -74,7 +74,7 @@ in { Whether to open the UDP port used for multicast peer discovery. The NixOS firewall blocks link-local communication, so in order to make local peering work you - will also need to set LinkLocalTCPPort in your + will also need to set LinkLocalTCPPort in your yggdrasil configuration ( or ) to a port number other than 0, and then add that port to diff --git a/nixos/modules/services/torrent/transmission.nix b/nixos/modules/services/torrent/transmission.nix index 9777964386c9..1641f1ad184e 100644 --- a/nixos/modules/services/torrent/transmission.nix +++ b/nixos/modules/services/torrent/transmission.nix @@ -175,7 +175,7 @@ in default = null; example = "770"; description = '' - If not null, is used as the permissions + If not null, is used as the permissions set by systemd.activationScripts.transmission-daemon on the directories , . @@ -214,7 +214,7 @@ in description = '' Path to a JSON file to be merged with the settings. Useful to merge a file which is better kept out of the Nix store - to set secret config parameters like rpc-password. + to set secret config parameters like rpc-password. ''; default = "/dev/null"; example = "/var/lib/secrets/transmission/settings.json"; @@ -237,7 +237,7 @@ in to open many more connections at the same time. Note that you may also want to increase - peer-limit-global". + peer-limit-global". And be aware that these settings are quite aggressive and might not suite your regular desktop use. For instance, SSH sessions may time out more easily''; diff --git a/nixos/modules/services/web-apps/bookstack.nix b/nixos/modules/services/web-apps/bookstack.nix index 64a2767fab6e..5d22a3b9a8d6 100644 --- a/nixos/modules/services/web-apps/bookstack.nix +++ b/nixos/modules/services/web-apps/bookstack.nix @@ -52,7 +52,7 @@ in { description = '' A file containing the Laravel APP_KEY - a 32 character long, base64 encoded key used for encryption where needed. Can be - generated with head -c 32 /dev/urandom | base64. + generated with head -c 32 /dev/urandom | base64. ''; example = "/run/keys/bookstack-appkey"; type = types.path; @@ -74,7 +74,7 @@ in { appURL = mkOption { description = '' The root URL that you want to host BookStack on. All URLs in BookStack will be generated using this value. - If you change this in the future you may need to run a command to update stored URLs in the database. Command example: php artisan bookstack:update-url https://old.example.com https://new.example.com + If you change this in the future you may need to run a command to update stored URLs in the database. Command example: php artisan bookstack:update-url https://old.example.com https://new.example.com ''; default = "http${lib.optionalString tlsEnabled "s"}://${cfg.hostname}"; defaultText = ''http''${lib.optionalString tlsEnabled "s"}://''${cfg.hostname}''; diff --git a/nixos/modules/services/web-apps/mastodon.nix b/nixos/modules/services/web-apps/mastodon.nix index f3f0fb7cb534..00c30d73bb6f 100644 --- a/nixos/modules/services/web-apps/mastodon.nix +++ b/nixos/modules/services/web-apps/mastodon.nix @@ -113,17 +113,17 @@ in { affect other virtualHosts running on your nginx instance, if any. Alternatively you can configure a reverse-proxy of your choice to serve these paths: - / -> $(nix-instantiate --eval '<nixpkgs>' -A mastodon.outPath)/public + / -> $(nix-instantiate --eval '<nixpkgs>' -A mastodon.outPath)/public - / -> 127.0.0.1:{{ webPort }} (If there was no file in the directory above.) + / -> 127.0.0.1:{{ webPort }} (If there was no file in the directory above.) - /system/ -> /var/lib/mastodon/public-system/ + /system/ -> /var/lib/mastodon/public-system/ - /api/v1/streaming/ -> 127.0.0.1:{{ streamingPort }} + /api/v1/streaming/ -> 127.0.0.1:{{ streamingPort }} Make sure that websockets are forwarded properly. You might want to set up caching of some requests. Take a look at mastodon's provided nginx configuration at - https://github.com/mastodon/mastodon/blob/master/dist/nginx.conf. + https://github.com/mastodon/mastodon/blob/master/dist/nginx.conf. ''; type = lib.types.bool; default = false; @@ -135,13 +135,13 @@ in { that user will be created, otherwise it should be set to the name of a user created elsewhere. In both cases, mastodon and a package containing only - the shell script mastodon-env will be added to + the shell script mastodon-env will be added to the user's package set. To run a command from - mastodon such as tootctl + mastodon such as tootctl with the environment configured by this module use - mastodon-env, as in: + mastodon-env, as in: - mastodon-env tootctl accounts create newuser --email newuser@example.com + mastodon-env tootctl accounts create newuser --email newuser@example.com ''; type = lib.types.str; default = "mastodon"; @@ -202,7 +202,7 @@ in { Voluntary Application Server Identification. A new keypair can be generated by running: - nix build -f '<nixpkgs>' mastodon; cd result; bin/rake webpush:generate_keys + nix build -f '<nixpkgs>' mastodon; cd result; bin/rake webpush:generate_keys If does not exist, it and this file will be created with a new keypair. @@ -222,7 +222,7 @@ in { Path to file containing the secret key base. A new secret key base can be generated by running: - nix build -f '<nixpkgs>' mastodon; cd result; bin/rake secret + nix build -f '<nixpkgs>' mastodon; cd result; bin/rake secret If this file does not exist, it will be created with a new secret key base. ''; @@ -235,7 +235,7 @@ in { Path to file containing the OTP secret. A new OTP secret can be generated by running: - nix build -f '<nixpkgs>' mastodon; cd result; bin/rake secret + nix build -f '<nixpkgs>' mastodon; cd result; bin/rake secret If this file does not exist, it will be created with a new OTP secret. ''; @@ -249,7 +249,7 @@ in { Voluntary Application Server Identification. A new keypair can be generated by running: - nix build -f '<nixpkgs>' mastodon; cd result; bin/rake webpush:generate_keys + nix build -f '<nixpkgs>' mastodon; cd result; bin/rake webpush:generate_keys If this file does not exist, it will be created with a new private key. diff --git a/nixos/modules/services/web-apps/nextcloud.nix b/nixos/modules/services/web-apps/nextcloud.nix index 618ad85b8605..08083b7a443f 100644 --- a/nixos/modules/services/web-apps/nextcloud.nix +++ b/nixos/modules/services/web-apps/nextcloud.nix @@ -586,8 +586,8 @@ in { type = types.ints.positive; default = 15552000; description = '' - Value for the max-age directive of the HTTP - Strict-Transport-Security header. + Value for the max-age directive of the HTTP + Strict-Transport-Security header. See section 6.1.1 of IETF RFC 6797 for detailed information on this directive and header. diff --git a/nixos/modules/services/web-apps/snipe-it.nix b/nixos/modules/services/web-apps/snipe-it.nix index 842e0715c025..3059e67cb43b 100644 --- a/nixos/modules/services/web-apps/snipe-it.nix +++ b/nixos/modules/services/web-apps/snipe-it.nix @@ -46,7 +46,7 @@ in { description = '' A file containing the Laravel APP_KEY - a 32 character long, base64 encoded key used for encryption where needed. Can be - generated with head -c 32 /dev/urandom | base64. + generated with head -c 32 /dev/urandom | base64. ''; example = "/run/keys/snipe-it/appkey"; type = types.path; @@ -69,7 +69,7 @@ in { description = '' The root URL that you want to host Snipe-IT on. All URLs in Snipe-IT will be generated using this value. If you change this in the future you may need to run a command to update stored URLs in the database. - Command example: snipe-it snipe-it:update-url https://old.example.com https://new.example.com + Command example: snipe-it snipe-it:update-url https://old.example.com https://new.example.com ''; default = "http${lib.optionalString tlsEnabled "s"}://${cfg.hostName}"; defaultText = '' diff --git a/nixos/modules/virtualisation/podman/default.nix b/nixos/modules/virtualisation/podman/default.nix index 361caeff70be..1e2f8a7fae64 100644 --- a/nixos/modules/virtualisation/podman/default.nix +++ b/nixos/modules/virtualisation/podman/default.nix @@ -74,7 +74,7 @@ in Podman implements the Docker API. - Users must be in the podman group in order to connect. As + Users must be in the podman group in order to connect. As with Docker, members of this group can gain root access. ''; }; diff --git a/nixos/modules/virtualisation/podman/network-socket.nix b/nixos/modules/virtualisation/podman/network-socket.nix index 94d8da9d2b61..5f6ce493558b 100644 --- a/nixos/modules/virtualisation/podman/network-socket.nix +++ b/nixos/modules/virtualisation/podman/network-socket.nix @@ -22,7 +22,7 @@ in with TLS client certificate authentication. This allows Docker clients to connect with the equivalents of the Docker - CLI -H and --tls* family of options. + CLI -H and --tls* family of options. For certificate setup, see https://docs.docker.com/engine/security/protect-access/