···7171 ))
7272 '';
7373 example = ["en_US.UTF-8/UTF-8" "nl_NL.UTF-8/UTF-8" "nl_NL/ISO-8859-1"];
7474- description = ''
7474+ description = lib.mdDoc ''
7575 List of locales that the system should support. The value
7676- <literal>"all"</literal> means that all locales supported by
7676+ `"all"` means that all locales supported by
7777 Glibc will be installed. A full list of supported locales
7878- can be found at <link xlink:href="https://sourceware.org/git/?p=glibc.git;a=blob;f=localedata/SUPPORTED"/>.
7878+ can be found at <https://sourceware.org/git/?p=glibc.git;a=blob;f=localedata/SUPPORTED>.
7979 '';
8080 };
8181
+3-3
nixos/modules/config/resolvconf.nix
···8383 dnsExtensionMechanism = mkOption {
8484 type = types.bool;
8585 default = true;
8686- description = ''
8787- Enable the <literal>edns0</literal> option in <filename>resolv.conf</filename>. With
8888- that option set, <literal>glibc</literal> supports use of the extension mechanisms for
8686+ description = lib.mdDoc ''
8787+ Enable the `edns0` option in {file}`resolv.conf`. With
8888+ that option set, `glibc` supports use of the extension mechanisms for
8989 DNS (EDNS) specified in RFC 2671. The most popular user of that feature is DNSSEC,
9090 which does not work without it.
9191 '';
+2-2
nixos/modules/config/shells-environment.nix
···109109110110 environment.shellAliases = mkOption {
111111 example = { l = null; ll = "ls -l"; };
112112- description = ''
112112+ description = lib.mdDoc ''
113113 An attribute set that maps aliases (the top level attribute names in
114114 this option) to command strings or directly to build outputs. The
115115 aliases are added to all users' shells.
116116- Aliases mapped to <literal>null</literal> are ignored.
116116+ Aliases mapped to `null` are ignored.
117117 '';
118118 type = with types; attrsOf (nullOr (either str path));
119119 };
+4-4
nixos/modules/config/system-environment.nix
···16161717 environment.sessionVariables = mkOption {
1818 default = {};
1919- description = ''
1919+ description = lib.mdDoc ''
2020 A set of environment variables used in the global environment.
2121 These variables will be set by PAM early in the login process.
2222···2525 colon characters.
26262727 Note, due to limitations in the PAM format values may not
2828- contain the <literal>"</literal> character.
2828+ contain the `"` character.
29293030 Also, these variables are merged into
3131- <xref linkend="opt-environment.variables"/> and it is
3131+ [](#opt-environment.variables) and it is
3232 therefore not possible to use PAM style variables such as
3333- <literal>@{HOME}</literal>.
3333+ `@{HOME}`.
3434 '';
3535 type = with types; attrsOf (either str (listOf str));
3636 apply = mapAttrs (n: v: if isList v then concatStringsSep ":" v else v);
+19-19
nixos/modules/config/users-groups.nix
···100100 isNormalUser = mkOption {
101101 type = types.bool;
102102 default = false;
103103- description = ''
103103+ description = lib.mdDoc ''
104104 Indicates whether this is an account for a “real” user. This
105105- automatically sets <option>group</option> to
106106- <literal>users</literal>, <option>createHome</option> to
107107- <literal>true</literal>, <option>home</option> to
108108- <filename>/home/«username»</filename>,
109109- <option>useDefaultShell</option> to <literal>true</literal>,
110110- and <option>isSystemUser</option> to
111111- <literal>false</literal>.
112112- Exactly one of <literal>isNormalUser</literal> and
113113- <literal>isSystemUser</literal> must be true.
105105+ automatically sets {option}`group` to
106106+ `users`, {option}`createHome` to
107107+ `true`, {option}`home` to
108108+ {file}`/home/«username»`,
109109+ {option}`useDefaultShell` to `true`,
110110+ and {option}`isSystemUser` to
111111+ `false`.
112112+ Exactly one of `isNormalUser` and
113113+ `isSystemUser` must be true.
114114 '';
115115 };
116116···151151 pamMount = mkOption {
152152 type = with types; attrsOf str;
153153 default = {};
154154- description = ''
154154+ description = lib.mdDoc ''
155155 Attributes for user's entry in
156156- <filename>pam_mount.conf.xml</filename>.
157157- Useful attributes might include <literal>path</literal>,
158158- <literal>options</literal>, <literal>fstype</literal>, and <literal>server</literal>.
159159- See <link xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html"/>
156156+ {file}`pam_mount.conf.xml`.
157157+ Useful attributes might include `path`,
158158+ `options`, `fstype`, and `server`.
159159+ See <http://pam-mount.sourceforge.net/pam_mount.conf.5.html>
160160 for more information.
161161 '';
162162 };
···166166 default = pkgs.shadow;
167167 defaultText = literalExpression "pkgs.shadow";
168168 example = literalExpression "pkgs.bashInteractive";
169169- description = ''
169169+ description = lib.mdDoc ''
170170 The path to the user's shell. Can use shell derivations,
171171- like <literal>pkgs.bashInteractive</literal>. Don’t
171171+ like `pkgs.bashInteractive`. Don’t
172172 forget to enable your shell in
173173- <literal>programs</literal> if necessary,
174174- like <literal>programs.zsh.enable = true;</literal>.
173173+ `programs` if necessary,
174174+ like `programs.zsh.enable = true;`.
175175 '';
176176 };
177177
+1-1
nixos/modules/hardware/logitech.nix
···3232 devices = mkOption {
3333 type = types.listOf types.str;
3434 default = [ "0a07" "c222" "c225" "c227" "c251" ];
3535- description = ''
3535+ description = lib.mdDoc ''
3636 List of USB device ids supported by g15daemon.
37373838 You most likely do not need to change this.
+6-6
nixos/modules/hardware/video/uvcvideo/default.nix
···3434 packages = mkOption {
3535 type = types.listOf types.path;
3636 example = literalExpression "[ pkgs.tiscamera ]";
3737- description = ''
3838- List of packages containing <command>uvcvideo</command> dynamic controls
3737+ description = lib.mdDoc ''
3838+ List of packages containing {command}`uvcvideo` dynamic controls
3939 rules. All files found in
4040- <filename>«pkg»/share/uvcdynctrl/data</filename>
4040+ {file}`«pkg»/share/uvcdynctrl/data`
4141 will be included.
42424343- Note that these will serve as input to the <command>libwebcam</command>
4444- package which through its own <command>udev</command> rule will register
4545- the dynamic controls from specified packages to the <command>uvcvideo</command>
4343+ Note that these will serve as input to the {command}`libwebcam`
4444+ package which through its own {command}`udev` rule will register
4545+ the dynamic controls from specified packages to the {command}`uvcvideo`
4646 driver.
4747 '';
4848 apply = map getBin;
+2-2
nixos/modules/programs/adb.nix
···1111 enable = mkOption {
1212 default = false;
1313 type = types.bool;
1414- description = ''
1414+ description = lib.mdDoc ''
1515 Whether to configure system to use Android Debug Bridge (adb).
1616 To grant access to a user, it must be part of adbusers group:
1717- <literal>users.users.alice.extraGroups = ["adbusers"];</literal>
1717+ `users.users.alice.extraGroups = ["adbusers"];`
1818 '';
1919 };
2020 };
+2-2
nixos/modules/programs/firejail.nix
···6969 };
7070 }
7171 '';
7272- description = ''
7272+ description = lib.mdDoc ''
7373 Wrap the binaries in firejail and place them in the global path.
74747575 You will get file collisions if you put the actual application binary in
7676 the global environment (such as by adding the application package to
7777- <literal>environment.systemPackages</literal>), and applications started via
7777+ `environment.systemPackages`), and applications started via
7878 .desktop files are not wrapped if they specify the absolute path to the
7979 binary.
8080 '';
+2-2
nixos/modules/programs/gphoto2.nix
···1111 enable = mkOption {
1212 default = false;
1313 type = types.bool;
1414- description = ''
1414+ description = lib.mdDoc ''
1515 Whether to configure system to use gphoto2.
1616 To grant digital camera access to a user, the user must
1717 be part of the camera group:
1818- <literal>users.users.alice.extraGroups = ["camera"];</literal>
1818+ `users.users.alice.extraGroups = ["camera"];`
1919 '';
2020 };
2121 };
+2-2
nixos/modules/programs/neovim.nix
···7272 };
7373 }
7474 '';
7575- description = ''
7575+ description = lib.mdDoc ''
7676 Generate your init file from your list of plugins and custom commands.
7777- Neovim will then be wrapped to load <command>nvim -u /nix/store/«hash»-vimrc</command>
7777+ Neovim will then be wrapped to load {command}`nvim -u /nix/store/«hash»-vimrc`
7878 '';
7979 };
8080
+9-9
nixos/modules/programs/nncp.nix
···3333 secrets = mkOption {
3434 type = with types; listOf str;
3535 example = [ "/run/keys/nncp.hjson" ];
3636- description = ''
3636+ description = lib.mdDoc ''
3737 A list of paths to NNCP configuration files that should not be
3838 in the Nix store. These files are layered on top of the values at
3939- <xref linkend="opt-programs.nncp.settings"/>.
3939+ [](#opt-programs.nncp.settings).
4040 '';
4141 };
42424343 settings = mkOption {
4444 type = settingsFormat.type;
4545- description = ''
4545+ description = lib.mdDoc ''
4646 NNCP configuration, see
4747- <link xlink:href="http://www.nncpgo.org/Configuration.html"/>.
4747+ <http://www.nncpgo.org/Configuration.html>.
4848 At runtime these settings will be overlayed by the contents of
4949- <xref linkend="opt-programs.nncp.secrets"/> into the file
5050- <literal>${nncpCfgFile}</literal>. Node keypairs go in
5151- <literal>secrets</literal>, do not specify them in
5252- <literal>settings</literal> as they will be leaked into
5353- <literal>/nix/store</literal>!
4949+ [](#opt-programs.nncp.secrets) into the file
5050+ `${nncpCfgFile}`. Node keypairs go in
5151+ `secrets`, do not specify them in
5252+ `settings` as they will be leaked into
5353+ `/nix/store`!
5454 '';
5555 default = { };
5656 };
+3-3
nixos/modules/programs/turbovnc.nix
···1515 ensureHeadlessSoftwareOpenGL = mkOption {
1616 type = types.bool;
1717 default = false;
1818- description = ''
1818+ description = lib.mdDoc ''
1919 Whether to set up NixOS such that TurboVNC's built-in software OpenGL
2020 implementation works.
21212222- This will enable <option>hardware.opengl.enable</option> so that OpenGL
2222+ This will enable {option}`hardware.opengl.enable` so that OpenGL
2323 programs can find Mesa's llvmpipe drivers.
24242525- Setting this option to <literal>false</literal> does not mean that software
2525+ Setting this option to `false` does not mean that software
2626 OpenGL won't work; it may still work depending on your system
2727 configuration.
2828
+2-2
nixos/modules/security/acme/default.nix
···504504 reloadServices = mkOption {
505505 type = types.listOf types.str;
506506 inherit (defaultAndText "reloadServices" []) default defaultText;
507507- description = ''
508508- The list of systemd services to call <literal>systemctl try-reload-or-restart</literal>
507507+ description = lib.mdDoc ''
508508+ The list of systemd services to call `systemctl try-reload-or-restart`
509509 on.
510510 '';
511511 };
+30-30
nixos/modules/security/doas.nix
···6262 wheelNeedsPassword = mkOption {
6363 type = with types; bool;
6464 default = true;
6565- description = ''
6666- Whether users of the <literal>wheel</literal> group must provide a password to
6767- run commands as super user via <command>doas</command>.
6565+ description = lib.mdDoc ''
6666+ Whether users of the `wheel` group must provide a password to
6767+ run commands as super user via {command}`doas`.
6868 '';
6969 };
70707171 extraRules = mkOption {
7272 default = [];
7373- description = ''
7373+ description = lib.mdDoc ''
7474 Define specific rules to be set in the
7575- <filename>/etc/doas.conf</filename> file. More specific rules should
7575+ {file}`/etc/doas.conf` file. More specific rules should
7676 come after more general ones in order to yield the expected behavior.
7777- You can use <literal>mkBefore</literal> and/or <literal>mkAfter</literal> to ensure
7777+ You can use `mkBefore` and/or `mkAfter` to ensure
7878 this is the case when configuration options are merged.
7979 '';
8080 example = literalExpression ''
···113113 noPass = mkOption {
114114 type = with types; bool;
115115 default = false;
116116- description = ''
117117- If <literal>true</literal>, the user is not required to enter a
116116+ description = lib.mdDoc ''
117117+ If `true`, the user is not required to enter a
118118 password.
119119 '';
120120 };
···122122 noLog = mkOption {
123123 type = with types; bool;
124124 default = false;
125125- description = ''
126126- If <literal>true</literal>, successful executions will not be logged
125125+ description = lib.mdDoc ''
126126+ If `true`, successful executions will not be logged
127127 to
128128- <citerefentry><refentrytitle>syslogd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
128128+ {manpage}`syslogd(8)`.
129129 '';
130130 };
131131132132 persist = mkOption {
133133 type = with types; bool;
134134 default = false;
135135- description = ''
136136- If <literal>true</literal>, do not ask for a password again for some
135135+ description = lib.mdDoc ''
136136+ If `true`, do not ask for a password again for some
137137 time after the user successfully authenticates.
138138 '';
139139 };
···141141 keepEnv = mkOption {
142142 type = with types; bool;
143143 default = false;
144144- description = ''
145145- If <literal>true</literal>, environment variables other than those
144144+ description = lib.mdDoc ''
145145+ If `true`, environment variables other than those
146146 listed in
147147- <citerefentry><refentrytitle>doas</refentrytitle><manvolnum>1</manvolnum></citerefentry>
147147+ {manpage}`doas(1)`
148148 are kept when creating the environment for the new process.
149149 '';
150150 };
···152152 setEnv = mkOption {
153153 type = with types; listOf str;
154154 default = [];
155155- description = ''
155155+ description = lib.mdDoc ''
156156 Keep or set the specified variables. Variables may also be
157157 removed with a leading '-' or set using
158158- <literal>variable=value</literal>. If the first character of
159159- <literal>value</literal> is a '$', the value to be set is taken from
158158+ `variable=value`. If the first character of
159159+ `value` is a '$', the value to be set is taken from
160160 the existing environment variable of the indicated name. This
161161 option is processed after the default environment has been
162162 created.
163163164164- NOTE: All rules have <literal>setenv { SSH_AUTH_SOCK }</literal> by
165165- default. To prevent <literal>SSH_AUTH_SOCK</literal> from being
166166- inherited, add <literal>"-SSH_AUTH_SOCK"</literal> anywhere in this
164164+ NOTE: All rules have `setenv { SSH_AUTH_SOCK }` by
165165+ default. To prevent `SSH_AUTH_SOCK` from being
166166+ inherited, add `"-SSH_AUTH_SOCK"` anywhere in this
167167 list.
168168 '';
169169 };
···183183 runAs = mkOption {
184184 type = with types; nullOr str;
185185 default = null;
186186- description = ''
186186+ description = lib.mdDoc ''
187187 Which user or group the specified command is allowed to run as.
188188- When set to <literal>null</literal> (the default), all users are
188188+ When set to `null` (the default), all users are
189189 allowed.
190190191191 A user can be specified using just the username:
192192- <literal>"foo"</literal>. It is also possible to only allow running as
193193- a specific group with <literal>":bar"</literal>.
192192+ `"foo"`. It is also possible to only allow running as
193193+ a specific group with `":bar"`.
194194 '';
195195 };
196196197197 cmd = mkOption {
198198 type = with types; nullOr str;
199199 default = null;
200200- description = ''
200200+ description = lib.mdDoc ''
201201 The command the user is allowed to run. When set to
202202- <literal>null</literal> (the default), all commands are allowed.
202202+ `null` (the default), all commands are allowed.
203203204204 NOTE: It is best practice to specify absolute paths. If a
205205 relative path is specified, only a restricted PATH will be
···210210 args = mkOption {
211211 type = with types; nullOr (listOf str);
212212 default = null;
213213- description = ''
213213+ description = lib.mdDoc ''
214214 Arguments that must be provided to the command. When set to
215215- <literal>[]</literal>, the command must be run without any arguments.
215215+ `[]`, the command must be run without any arguments.
216216 '';
217217 };
218218 };
+2-2
nixos/modules/security/misc.nix
···5252 security.allowSimultaneousMultithreading = mkOption {
5353 type = types.bool;
5454 default = true;
5555- description = ''
5555+ description = lib.mdDoc ''
5656 Whether to allow SMT/hyperthreading. Disabling SMT means that only
5757 physical CPU cores will be usable at runtime, potentially at
5858 significant performance cost.
···6262 e.g., shared caches). This attack vector is unproven.
63636464 Disabling SMT is a supplement to the L1 data cache flushing mitigation
6565- (see <xref linkend="opt-security.virtualisation.flushL1DataCache"/>)
6565+ (see [](#opt-security.virtualisation.flushL1DataCache))
6666 versus malicious VM guests (SMT could "bring back" previously flushed
6767 data).
6868 '';
+50-50
nixos/modules/security/pam.nix
···807807 default = config.krb5.enable;
808808 defaultText = literalExpression "config.krb5.enable";
809809 type = types.bool;
810810- description = ''
811811- Enables Kerberos PAM modules (<literal>pam-krb5</literal>,
812812- <literal>pam-ccreds</literal>).
810810+ description = lib.mdDoc ''
811811+ Enables Kerberos PAM modules (`pam-krb5`,
812812+ `pam-ccreds`).
813813814814 If set, users can authenticate with their Kerberos password.
815815 This requires a valid Kerberos configuration
816816- (<literal>config.krb5.enable</literal> should be set to
817817- <literal>true</literal>).
816816+ (`config.krb5.enable` should be set to
817817+ `true`).
818818819819 Note that the Kerberos PAM modules are not necessary when using SSS
820820 to handle Kerberos authentication.
···826826 enable = mkOption {
827827 default = false;
828828 type = types.bool;
829829- description = ''
830830- Enables P11 PAM (<literal>pam_p11</literal>) module.
829829+ description = lib.mdDoc ''
830830+ Enables P11 PAM (`pam_p11`) module.
831831832832 If set, users can log in with SSH keys and PKCS#11 tokens.
833833834834- More information can be found <link xlink:href="https://github.com/OpenSC/pam_p11">here</link>.
834834+ More information can be found [here](https://github.com/OpenSC/pam_p11).
835835 '';
836836 };
837837···858858 enable = mkOption {
859859 default = false;
860860 type = types.bool;
861861- description = ''
862862- Enables U2F PAM (<literal>pam-u2f</literal>) module.
861861+ description = lib.mdDoc ''
862862+ Enables U2F PAM (`pam-u2f`) module.
863863864864 If set, users listed in
865865- <filename>$XDG_CONFIG_HOME/Yubico/u2f_keys</filename> (or
866866- <filename>$HOME/.config/Yubico/u2f_keys</filename> if XDG variable is
865865+ {file}`$XDG_CONFIG_HOME/Yubico/u2f_keys` (or
866866+ {file}`$HOME/.config/Yubico/u2f_keys` if XDG variable is
867867 not set) are able to log in with the associated U2F key. The path can
868868- be changed using <option>security.pam.u2f.authFile</option> option.
868868+ be changed using {option}`security.pam.u2f.authFile` option.
869869870870 File format is:
871871- <literal>username:first_keyHandle,first_public_key: second_keyHandle,second_public_key</literal>
872872- This file can be generated using <command>pamu2fcfg</command> command.
871871+ `username:first_keyHandle,first_public_key: second_keyHandle,second_public_key`
872872+ This file can be generated using {command}`pamu2fcfg` command.
873873874874- More information can be found <link xlink:href="https://developers.yubico.com/pam-u2f/">here</link>.
874874+ More information can be found [here](https://developers.yubico.com/pam-u2f/).
875875 '';
876876 };
877877878878 authFile = mkOption {
879879 default = null;
880880 type = with types; nullOr path;
881881- description = ''
882882- By default <literal>pam-u2f</literal> module reads the keys from
883883- <filename>$XDG_CONFIG_HOME/Yubico/u2f_keys</filename> (or
884884- <filename>$HOME/.config/Yubico/u2f_keys</filename> if XDG variable is
881881+ description = lib.mdDoc ''
882882+ By default `pam-u2f` module reads the keys from
883883+ {file}`$XDG_CONFIG_HOME/Yubico/u2f_keys` (or
884884+ {file}`$HOME/.config/Yubico/u2f_keys` if XDG variable is
885885 not set).
886886887887 If you want to change auth file locations or centralize database (for
888888- example use <filename>/etc/u2f-mappings</filename>) you can set this
888888+ example use {file}`/etc/u2f-mappings`) you can set this
889889 option.
890890891891 File format is:
892892- <literal>username:first_keyHandle,first_public_key: second_keyHandle,second_public_key</literal>
893893- This file can be generated using <command>pamu2fcfg</command> command.
892892+ `username:first_keyHandle,first_public_key: second_keyHandle,second_public_key`
893893+ This file can be generated using {command}`pamu2fcfg` command.
894894895895- More information can be found <link xlink:href="https://developers.yubico.com/pam-u2f/">here</link>.
895895+ More information can be found [here](https://developers.yubico.com/pam-u2f/).
896896 '';
897897 };
898898899899 appId = mkOption {
900900 default = null;
901901 type = with types; nullOr str;
902902- description = ''
903903- By default <literal>pam-u2f</literal> module sets the application
904904- ID to <literal>pam://$HOSTNAME</literal>.
902902+ description = lib.mdDoc ''
903903+ By default `pam-u2f` module sets the application
904904+ ID to `pam://$HOSTNAME`.
905905906906- When using <command>pamu2fcfg</command>, you can specify your
907907- application ID with the <literal>-i</literal> flag.
906906+ When using {command}`pamu2fcfg`, you can specify your
907907+ application ID with the `-i` flag.
908908909909- More information can be found <link xlink:href="https://developers.yubico.com/pam-u2f/Manuals/pam_u2f.8.html">here</link>
909909+ More information can be found [here](https://developers.yubico.com/pam-u2f/Manuals/pam_u2f.8.html)
910910 '';
911911 };
912912913913 origin = mkOption {
914914 default = null;
915915 type = with types; nullOr str;
916916- description = ''
917917- By default <literal>pam-u2f</literal> module sets the origin
918918- to <literal>pam://$HOSTNAME</literal>.
916916+ description = lib.mdDoc ''
917917+ By default `pam-u2f` module sets the origin
918918+ to `pam://$HOSTNAME`.
919919 Setting origin to an host independent value will allow you to
920920 reuse credentials across machines
921921922922- When using <command>pamu2fcfg</command>, you can specify your
923923- application ID with the <literal>-o</literal> flag.
922922+ When using {command}`pamu2fcfg`, you can specify your
923923+ application ID with the `-o` flag.
924924925925- More information can be found <link xlink:href="https://developers.yubico.com/pam-u2f/Manuals/pam_u2f.8.html">here</link>
925925+ More information can be found [here](https://developers.yubico.com/pam-u2f/Manuals/pam_u2f.8.html)
926926 '';
927927 };
928928···978978 enable = mkOption {
979979 default = false;
980980 type = types.bool;
981981- description = ''
982982- Enables Uber's USSH PAM (<literal>pam-ussh</literal>) module.
981981+ description = lib.mdDoc ''
982982+ Enables Uber's USSH PAM (`pam-ussh`) module.
983983984984- This is similar to <literal>pam-ssh-agent</literal>, except that
984984+ This is similar to `pam-ssh-agent`, except that
985985 the presence of a CA-signed SSH key with a valid principal is checked
986986 instead.
987987988988 Note that this module must both be enabled using this option and on a
989989- per-PAM-service level as well (using <literal>usshAuth</literal>).
989989+ per-PAM-service level as well (using `usshAuth`).
990990991991- More information can be found <link xlink:href="https://github.com/uber/pam-ussh">here</link>.
991991+ More information can be found [here](https://github.com/uber/pam-ussh).
992992 '';
993993 };
994994···10671067 enable = mkOption {
10681068 default = false;
10691069 type = types.bool;
10701070- description = ''
10711071- Enables Yubico PAM (<literal>yubico-pam</literal>) module.
10701070+ description = lib.mdDoc ''
10711071+ Enables Yubico PAM (`yubico-pam`) module.
1072107210731073 If set, users listed in
10741074- <filename>~/.yubico/authorized_yubikeys</filename>
10741074+ {file}`~/.yubico/authorized_yubikeys`
10751075 are able to log in with the associated Yubikey tokens.
1076107610771077 The file must have only one line:
10781078- <literal>username:yubikey_token_id1:yubikey_token_id2</literal>
10791079- More information can be found <link xlink:href="https://developers.yubico.com/yubico-pam/">here</link>.
10781078+ `username:yubikey_token_id1:yubikey_token_id2`
10791079+ More information can be found [here](https://developers.yubico.com/yubico-pam/).
10801080 '';
10811081 };
10821082 control = mkOption {
···11111111 mode = mkOption {
11121112 default = "client";
11131113 type = types.enum [ "client" "challenge-response" ];
11141114- description = ''
11141114+ description = lib.mdDoc ''
11151115 Mode of operation.
1116111611171117 Use "client" for online validation with a YubiKey validation service such as
···11211121 Challenge-Response configurations. See the man-page ykpamcfg(1) for further
11221122 details on how to configure offline Challenge-Response validation.
1123112311241124- More information can be found <link xlink:href="https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html">here</link>.
11241124+ More information can be found [here](https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html).
11251125 '';
11261126 };
11271127 challengeResponsePath = mkOption {
11281128 default = null;
11291129 type = types.nullOr types.path;
11301130- description = ''
11301130+ description = lib.mdDoc ''
11311131 If not null, set the path used by yubico pam module where the challenge expected response is stored.
1132113211331133- More information can be found <link xlink:href="https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html">here</link>.
11331133+ More information can be found [here](https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html).
11341134 '';
11351135 };
11361136 };
+6-6
nixos/modules/security/pam_mount.nix
···3131 extraVolumes = mkOption {
3232 type = types.listOf types.str;
3333 default = [];
3434- description = ''
3434+ description = lib.mdDoc ''
3535 List of volume definitions for pam_mount.
3636- For more information, visit <link xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html"/>.
3636+ For more information, visit <http://pam-mount.sourceforge.net/pam_mount.conf.5.html>.
3737 '';
3838 };
3939···6363 type = types.int;
6464 default = 0;
6565 example = 1;
6666- description = ''
6666+ description = lib.mdDoc ''
6767 Sets the Debug-Level. 0 disables debugging, 1 enables pam_mount tracing,
6868 and 2 additionally enables tracing in mount.crypt. The default is 0.
6969- For more information, visit <link xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html"/>.
6969+ For more information, visit <http://pam-mount.sourceforge.net/pam_mount.conf.5.html>.
7070 '';
7171 };
72727373 logoutWait = mkOption {
7474 type = types.int;
7575 default = 0;
7676- description = ''
7676+ description = lib.mdDoc ''
7777 Amount of microseconds to wait until killing remaining processes after
7878 final logout.
7979- For more information, visit <link xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html"/>.
7979+ For more information, visit <http://pam-mount.sourceforge.net/pam_mount.conf.5.html>.
8080 '';
8181 };
8282
+2-2
nixos/modules/security/pam_usb.nix
···1717 enable = mkOption {
1818 type = types.bool;
1919 default = false;
2020- description = ''
2020+ description = lib.mdDoc ''
2121 Enable USB login for all login systems that support it. For
2222- more information, visit <link xlink:href="https://github.com/aluzzardi/pam_usb/wiki/Getting-Started#setting-up-devices-and-users"/>.
2222+ more information, visit <https://github.com/aluzzardi/pam_usb/wiki/Getting-Started#setting-up-devices-and-users>.
2323 '';
2424 };
2525
+10-10
nixos/modules/security/sudo.nix
···5555 type = types.bool;
5656 default = true;
5757 description =
5858- ''
5959- Whether users of the <literal>wheel</literal> group must
6060- provide a password to run commands as super user via <command>sudo</command>.
5858+ lib.mdDoc ''
5959+ Whether users of the `wheel` group must
6060+ provide a password to run commands as super user via {command}`sudo`.
6161 '';
6262 };
63636464 security.sudo.execWheelOnly = mkOption {
6565 type = types.bool;
6666 default = false;
6767- description = ''
6868- Only allow members of the <literal>wheel</literal> group to execute sudo by
6767+ description = lib.mdDoc ''
6868+ Only allow members of the `wheel` group to execute sudo by
6969 setting the executable's permissions accordingly.
7070- This prevents users that are not members of <literal>wheel</literal> from
7070+ This prevents users that are not members of `wheel` from
7171 exploiting vulnerabilities in sudo such as CVE-2021-3156.
7272 '';
7373 };
···139139 runAs = mkOption {
140140 type = with types; str;
141141 default = "ALL:ALL";
142142- description = ''
142142+ description = lib.mdDoc ''
143143 Under which user/group the specified command is allowed to run.
144144145145- A user can be specified using just the username: <literal>"foo"</literal>.
146146- It is also possible to specify a user/group combination using <literal>"foo:bar"</literal>
147147- or to only allow running as a specific group with <literal>":bar"</literal>.
145145+ A user can be specified using just the username: `"foo"`.
146146+ It is also possible to specify a user/group combination using `"foo:bar"`
147147+ or to only allow running as a specific group with `":bar"`.
148148 '';
149149 };
150150
···113113 configFile = mkOption {
114114 type = types.nullOr types.path;
115115 default = null;
116116- description = ''
116116+ description = lib.mdDoc ''
117117 Configuration file for gitlab-runner.
118118119119- <option>configFile</option> takes precedence over <option>services</option>.
120120- <option>checkInterval</option> and <option>concurrent</option> will be ignored too.
119119+ {option}`configFile` takes precedence over {option}`services`.
120120+ {option}`checkInterval` and {option}`concurrent` will be ignored too.
121121122122- This option is deprecated, please use <option>services</option> instead.
123123- You can use <option>registrationConfigFile</option> and
124124- <option>registrationFlags</option>
122122+ This option is deprecated, please use {option}`services` instead.
123123+ You can use {option}`registrationConfigFile` and
124124+ {option}`registrationFlags`
125125 for settings not covered by this module.
126126 '';
127127 };
···130130 freeformType = (pkgs.formats.json { }).type;
131131 };
132132 default = { };
133133- description = ''
133133+ description = lib.mdDoc ''
134134 Global gitlab-runner configuration. See
135135- <link xlink:href="https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-global-section"/>
135135+ <https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-global-section>
136136 for supported values.
137137 '';
138138 };
139139 gracefulTermination = mkOption {
140140 type = types.bool;
141141 default = false;
142142- description = ''
142142+ description = lib.mdDoc ''
143143 Finish all remaining jobs before stopping.
144144 If not set gitlab-runner will stop immediatly without waiting
145145 for jobs to finish, which will lead to failed builds.
···149149 type = types.str;
150150 default = "infinity";
151151 example = "5min 20s";
152152- description = ''
152152+ description = lib.mdDoc ''
153153 Time to wait until a graceful shutdown is turned into a forceful one.
154154 '';
155155 };
···158158 default = pkgs.gitlab-runner;
159159 defaultText = literalExpression "pkgs.gitlab-runner";
160160 example = literalExpression "pkgs.gitlab-runner_1_11";
161161- description = "Gitlab Runner package to use.";
161161+ description = lib.mdDoc "Gitlab Runner package to use.";
162162 };
163163 extraPackages = mkOption {
164164 type = types.listOf types.package;
165165 default = [ ];
166166- description = ''
166166+ description = lib.mdDoc ''
167167 Extra packages to add to PATH for the gitlab-runner process.
168168 '';
169169 };
170170 services = mkOption {
171171- description = "GitLab Runner services.";
171171+ description = lib.mdDoc "GitLab Runner services.";
172172 default = { };
173173 example = literalExpression ''
174174 {
···250250 options = {
251251 registrationConfigFile = mkOption {
252252 type = types.path;
253253- description = ''
253253+ description = lib.mdDoc ''
254254 Absolute path to a file with environment variables
255255 used for gitlab-runner registration.
256256 A list of all supported environment variables can be found in
257257- <literal>gitlab-runner register --help</literal>.
257257+ `gitlab-runner register --help`.
258258259259 Ones that you probably want to set is
260260261261- <literal>CI_SERVER_URL=<CI server URL></literal>
261261+ `CI_SERVER_URL=<CI server URL>`
262262263263- <literal>REGISTRATION_TOKEN=<registration secret></literal>
263263+ `REGISTRATION_TOKEN=<registration secret>`
264264265265 WARNING: make sure to use quoted absolute path,
266266 or it is going to be copied to Nix Store.
···270270 type = types.listOf types.str;
271271 default = [ ];
272272 example = [ "--docker-helper-image my/gitlab-runner-helper" ];
273273- description = ''
273273+ description = lib.mdDoc ''
274274 Extra command-line flags passed to
275275- <literal>gitlab-runner register</literal>.
276276- Execute <literal>gitlab-runner register --help</literal>
275275+ `gitlab-runner register`.
276276+ Execute `gitlab-runner register --help`
277277 for a list of supported flags.
278278 '';
279279 };
···281281 type = types.attrsOf types.str;
282282 default = { };
283283 example = { NAME = "value"; };
284284- description = ''
284284+ description = lib.mdDoc ''
285285 Custom environment variables injected to build environment.
286286- For secrets you can use <option>registrationConfigFile</option>
287287- with <literal>RUNNER_ENV</literal> variable set.
286286+ For secrets you can use {option}`registrationConfigFile`
287287+ with `RUNNER_ENV` variable set.
288288 '';
289289 };
290290 description = mkOption {
291291 type = types.nullOr types.str;
292292 default = null;
293293- description = ''
293293+ description = lib.mdDoc ''
294294 Name/description of the runner.
295295 '';
296296 };
297297 executor = mkOption {
298298 type = types.str;
299299 default = "docker";
300300- description = ''
300300+ description = lib.mdDoc ''
301301 Select executor, eg. shell, docker, etc.
302302- See <link xlink:href="https://docs.gitlab.com/runner/executors/README.html">runner documentation</link> for more information.
302302+ See [runner documentation](https://docs.gitlab.com/runner/executors/README.html) for more information.
303303 '';
304304 };
305305 buildsDir = mkOption {
306306 type = types.nullOr types.path;
307307 default = null;
308308 example = "/var/lib/gitlab-runner/builds";
309309- description = ''
309309+ description = lib.mdDoc ''
310310 Absolute path to a directory where builds will be stored
311311 in context of selected executor (Locally, Docker, SSH).
312312 '';
···315315 type = types.nullOr types.str;
316316 default = null;
317317 example = "http://gitlab.example.local";
318318- description = ''
318318+ description = lib.mdDoc ''
319319 Overwrite the URL for the GitLab instance. Used if the Runner can’t connect to GitLab on the URL GitLab exposes itself.
320320 '';
321321 };
322322 dockerImage = mkOption {
323323 type = types.nullOr types.str;
324324 default = null;
325325- description = ''
325325+ description = lib.mdDoc ''
326326 Docker image to be used.
327327 '';
328328 };
···330330 type = types.listOf types.str;
331331 default = [ ];
332332 example = [ "/var/run/docker.sock:/var/run/docker.sock" ];
333333- description = ''
333333+ description = lib.mdDoc ''
334334 Bind-mount a volume and create it
335335 if it doesn't exist prior to mounting.
336336 '';
···338338 dockerDisableCache = mkOption {
339339 type = types.bool;
340340 default = false;
341341- description = ''
341341+ description = lib.mdDoc ''
342342 Disable all container caching.
343343 '';
344344 };
345345 dockerPrivileged = mkOption {
346346 type = types.bool;
347347 default = false;
348348- description = ''
348348+ description = lib.mdDoc ''
349349 Give extended privileges to container.
350350 '';
351351 };
···353353 type = types.listOf types.str;
354354 default = [ ];
355355 example = [ "other-host:127.0.0.1" ];
356356- description = ''
356356+ description = lib.mdDoc ''
357357 Add a custom host-to-IP mapping.
358358 '';
359359 };
···361361 type = types.listOf types.str;
362362 default = [ ];
363363 example = [ "ruby:*" "python:*" "php:*" "my.registry.tld:5000/*:*" ];
364364- description = ''
364364+ description = lib.mdDoc ''
365365 Whitelist allowed images.
366366 '';
367367 };
···369369 type = types.listOf types.str;
370370 default = [ ];
371371 example = [ "postgres:9" "redis:*" "mysql:*" ];
372372- description = ''
372372+ description = lib.mdDoc ''
373373 Whitelist allowed services.
374374 '';
375375 };
376376 preCloneScript = mkOption {
377377 type = types.nullOr types.path;
378378 default = null;
379379- description = ''
379379+ description = lib.mdDoc ''
380380 Runner-specific command script executed before code is pulled.
381381 '';
382382 };
383383 preBuildScript = mkOption {
384384 type = types.nullOr types.path;
385385 default = null;
386386- description = ''
386386+ description = lib.mdDoc ''
387387 Runner-specific command script executed after code is pulled,
388388 just before build executes.
389389 '';
···391391 postBuildScript = mkOption {
392392 type = types.nullOr types.path;
393393 default = null;
394394- description = ''
394394+ description = lib.mdDoc ''
395395 Runner-specific command script executed after code is pulled
396396 and just after build executes.
397397 '';
···399399 tagList = mkOption {
400400 type = types.listOf types.str;
401401 default = [ ];
402402- description = ''
402402+ description = lib.mdDoc ''
403403 Tag list.
404404 '';
405405 };
406406 runUntagged = mkOption {
407407 type = types.bool;
408408 default = false;
409409- description = ''
409409+ description = lib.mdDoc ''
410410 Register to run untagged builds; defaults to
411411- <literal>true</literal> when <option>tagList</option> is empty.
411411+ `true` when {option}`tagList` is empty.
412412 '';
413413 };
414414 limit = mkOption {
415415 type = types.int;
416416 default = 0;
417417- description = ''
417417+ description = lib.mdDoc ''
418418 Limit how many jobs can be handled concurrently by this service.
419419 0 (default) simply means don't limit.
420420 '';
···422422 requestConcurrency = mkOption {
423423 type = types.int;
424424 default = 0;
425425- description = ''
425425+ description = lib.mdDoc ''
426426 Limit number of concurrent requests for new jobs from GitLab.
427427 '';
428428 };
429429 maximumTimeout = mkOption {
430430 type = types.int;
431431 default = 0;
432432- description = ''
432432+ description = lib.mdDoc ''
433433 What is the maximum timeout (in seconds) that will be set for
434434 job when using this Runner. 0 (default) simply means don't limit.
435435 '';
···437437 protected = mkOption {
438438 type = types.bool;
439439 default = false;
440440- description = ''
440440+ description = lib.mdDoc ''
441441 When set to true Runner will only run on pipelines
442442 triggered on protected branches.
443443 '';
···445445 debugTraceDisabled = mkOption {
446446 type = types.bool;
447447 default = false;
448448- description = ''
448448+ description = lib.mdDoc ''
449449 When set to true Runner will disable the possibility of
450450- using the <literal>CI_DEBUG_TRACE</literal> feature.
450450+ using the `CI_DEBUG_TRACE` feature.
451451 '';
452452 };
453453 };
+3-3
nixos/modules/services/databases/firebird.nix
···4747 defaultText = literalExpression "pkgs.firebird";
4848 type = types.package;
4949 example = literalExpression "pkgs.firebird_3";
5050- description = ''
5151- Which Firebird package to be installed: <literal>pkgs.firebird_3</literal>
5252- For SuperServer use override: <literal>pkgs.firebird_3.override { superServer = true; };</literal>
5050+ description = lib.mdDoc ''
5151+ Which Firebird package to be installed: `pkgs.firebird_3`
5252+ For SuperServer use override: `pkgs.firebird_3.override { superServer = true; };`
5353 '';
5454 };
5555
+3-3
nixos/modules/services/databases/mysql.nix
···201201 ensurePermissions = mkOption {
202202 type = types.attrsOf types.str;
203203 default = {};
204204- description = ''
204204+ description = lib.mdDoc ''
205205 Permissions to ensure for the user, specified as attribute set.
206206 The attribute names specify the database and tables to grant the permissions for,
207207 separated by a dot. You may use wildcards here.
···210210211211 For more information on how to specify the target
212212 and on which privileges exist, see the
213213- <link xlink:href="https://mariadb.com/kb/en/library/grant/">GRANT syntax</link>.
214214- The attributes are used as <literal>GRANT ''${attrName} ON ''${attrValue}</literal>.
213213+ [GRANT syntax](https://mariadb.com/kb/en/library/grant/).
214214+ The attributes are used as `GRANT ''${attrName} ON ''${attrValue}`.
215215 '';
216216 example = literalExpression ''
217217 {
+43-43
nixos/modules/services/databases/neo4j.nix
···139139 constrainLoadCsv = mkOption {
140140 type = types.bool;
141141 default = true;
142142- description = ''
142142+ description = lib.mdDoc ''
143143 Sets the root directory for file URLs used with the Cypher
144144- <literal>LOAD CSV</literal> clause to be that defined by
145145- <option>directories.imports</option>. It restricts
144144+ `LOAD CSV` clause to be that defined by
145145+ {option}`directories.imports`. It restricts
146146 access to only those files within that directory and its
147147 subdirectories.
148148149149- Setting this option to <literal>false</literal> introduces
149149+ Setting this option to `false` introduces
150150 possible security problems.
151151 '';
152152 };
···154154 defaultListenAddress = mkOption {
155155 type = types.str;
156156 default = "127.0.0.1";
157157- description = ''
157157+ description = lib.mdDoc ''
158158 Default network interface to listen for incoming connections. To
159159 listen for connections on all interfaces, use "0.0.0.0".
160160161161 Specifies the default IP address and address part of connector
162162- specific <option>listenAddress</option> options. To bind specific
162162+ specific {option}`listenAddress` options. To bind specific
163163 connectors to a specific network interfaces, specify the entire
164164- <option>listenAddress</option> option for that connector.
164164+ {option}`listenAddress` option for that connector.
165165 '';
166166 };
167167···225225 sslPolicy = mkOption {
226226 type = types.str;
227227 default = "legacy";
228228- description = ''
228228+ description = lib.mdDoc ''
229229 Neo4j SSL policy for BOLT traffic.
230230231231 The legacy policy is a special policy which is not defined in
232232 the policy configuration section, but rather derives from
233233- <option>directories.certificates</option> and
234234- associated files (by default: <filename>neo4j.key</filename> and
235235- <filename>neo4j.cert</filename>). Its use will be deprecated.
233233+ {option}`directories.certificates` and
234234+ associated files (by default: {file}`neo4j.key` and
235235+ {file}`neo4j.cert`). Its use will be deprecated.
236236237237 Note: This connector must be configured to support/require
238238 SSL/TLS for the legacy policy to actually be utilized. See
239239- <option>bolt.tlsLevel</option>.
239239+ {option}`bolt.tlsLevel`.
240240 '';
241241 };
242242···254254 type = types.path;
255255 default = "${cfg.directories.home}/certificates";
256256 defaultText = literalExpression ''"''${config.${opt.directories.home}}/certificates"'';
257257- description = ''
257257+ description = lib.mdDoc ''
258258 Directory for storing certificates to be used by Neo4j for
259259 TLS connections.
260260261261 When setting this directory to something other than its default,
262262 ensure the directory's existence, and that read/write permissions are
263263- given to the Neo4j daemon user <literal>neo4j</literal>.
263263+ given to the Neo4j daemon user `neo4j`.
264264265265 Note that changing this directory from its default will prevent
266266 the directory structure required for each SSL policy from being
267267 automatically generated. A policy's directory structure as defined by
268268- its <option>baseDirectory</option>,<option>revokedDir</option> and
269269- <option>trustedDir</option> must then be setup manually. The
268268+ its {option}`baseDirectory`,{option}`revokedDir` and
269269+ {option}`trustedDir` must then be setup manually. The
270270 existence of these directories is mandatory, as well as the presence
271271 of the certificate file and the private key. Ensure the correct
272272 permissions are set on these directories and files.
···277277 type = types.path;
278278 default = "${cfg.directories.home}/data";
279279 defaultText = literalExpression ''"''${config.${opt.directories.home}}/data"'';
280280- description = ''
280280+ description = lib.mdDoc ''
281281 Path of the data directory. You must not configure more than one
282282 Neo4j installation to use the same data directory.
283283284284 When setting this directory to something other than its default,
285285 ensure the directory's existence, and that read/write permissions are
286286- given to the Neo4j daemon user <literal>neo4j</literal>.
286286+ given to the Neo4j daemon user `neo4j`.
287287 '';
288288 };
289289···302302 type = types.path;
303303 default = "${cfg.directories.home}/import";
304304 defaultText = literalExpression ''"''${config.${opt.directories.home}}/import"'';
305305- description = ''
305305+ description = lib.mdDoc ''
306306 The root directory for file URLs used with the Cypher
307307- <literal>LOAD CSV</literal> clause. Only meaningful when
308308- <option>constrainLoadCvs</option> is set to
309309- <literal>true</literal>.
307307+ `LOAD CSV` clause. Only meaningful when
308308+ {option}`constrainLoadCvs` is set to
309309+ `true`.
310310311311 When setting this directory to something other than its default,
312312 ensure the directory's existence, and that read permission is
313313- given to the Neo4j daemon user <literal>neo4j</literal>.
313313+ given to the Neo4j daemon user `neo4j`.
314314 '';
315315 };
316316···318318 type = types.path;
319319 default = "${cfg.directories.home}/plugins";
320320 defaultText = literalExpression ''"''${config.${opt.directories.home}}/plugins"'';
321321- description = ''
321321+ description = lib.mdDoc ''
322322 Path of the database plugin directory. Compiled Java JAR files that
323323 contain database procedures will be loaded if they are placed in
324324 this directory.
325325326326 When setting this directory to something other than its default,
327327 ensure the directory's existence, and that read permission is
328328- given to the Neo4j daemon user <literal>neo4j</literal>.
328328+ given to the Neo4j daemon user `neo4j`.
329329 '';
330330 };
331331 };
···377377 sslPolicy = mkOption {
378378 type = types.str;
379379 default = "legacy";
380380- description = ''
380380+ description = lib.mdDoc ''
381381 Neo4j SSL policy for HTTPS traffic.
382382383383 The legacy policy is a special policy which is not defined in the
384384 policy configuration section, but rather derives from
385385- <option>directories.certificates</option> and
386386- associated files (by default: <filename>neo4j.key</filename> and
387387- <filename>neo4j.cert</filename>). Its use will be deprecated.
385385+ {option}`directories.certificates` and
386386+ associated files (by default: {file}`neo4j.key` and
387387+ {file}`neo4j.cert`). Its use will be deprecated.
388388 '';
389389 };
390390 };
···407407 allowKeyGeneration = mkOption {
408408 type = types.bool;
409409 default = false;
410410- description = ''
410410+ description = lib.mdDoc ''
411411 Allows the generation of a private key and associated self-signed
412412 certificate. Only performed when both objects cannot be found for
413413 this policy. It is recommended to turn this off again after keys
···415415416416 The public certificate is required to be duplicated to the
417417 directory holding trusted certificates as defined by the
418418- <option>trustedDir</option> option.
418418+ {option}`trustedDir` option.
419419420420 Keys should in general be generated and distributed offline by a
421421 trusted certificate authority and not by utilizing this mode.
···426426 type = types.path;
427427 default = "${cfg.directories.certificates}/${name}";
428428 defaultText = literalExpression ''"''${config.${opt.directories.certificates}}/''${name}"'';
429429- description = ''
429429+ description = lib.mdDoc ''
430430 The mandatory base directory for cryptographic objects of this
431431 policy. This path is only automatically generated when this
432432- option as well as <option>directories.certificates</option> are
432432+ option as well as {option}`directories.certificates` are
433433 left at their default. Ensure read/write permissions are given
434434- to the Neo4j daemon user <literal>neo4j</literal>.
434434+ to the Neo4j daemon user `neo4j`.
435435436436 It is also possible to override each individual
437437 configuration with absolute paths. See the
438438- <option>privateKey</option> and <option>publicCertificate</option>
438438+ {option}`privateKey` and {option}`publicCertificate`
439439 policy options.
440440 '';
441441 };
···470470 publicCertificate = mkOption {
471471 type = types.str;
472472 default = "public.crt";
473473- description = ''
473473+ description = lib.mdDoc ''
474474 The name of public X.509 certificate (chain) file in PEM format
475475- for this policy to be found in the <option>baseDirectory</option>,
475475+ for this policy to be found in the {option}`baseDirectory`,
476476 or the absolute path to the certificate file. It is mandatory
477477 that a certificate can be found or generated.
478478479479 The public certificate is required to be duplicated to the
480480 directory holding trusted certificates as defined by the
481481- <option>trustedDir</option> option.
481481+ {option}`trustedDir` option.
482482 '';
483483 };
484484···522522 type = types.path;
523523 default = "${config.baseDirectory}/trusted";
524524 defaultText = literalExpression ''"''${config.${options.baseDirectory}}/trusted"'';
525525- description = ''
525525+ description = lib.mdDoc ''
526526 Path to directory of X.509 certificates in PEM format for
527527 trusted parties. Must be an absolute path. The existence of this
528528 directory is mandatory and will need to be created manually when:
529529 setting this option to something other than its default; setting
530530- either this policy's <option>baseDirectory</option> or
531531- <option>directories.certificates</option> to something other than
530530+ either this policy's {option}`baseDirectory` or
531531+ {option}`directories.certificates` to something other than
532532 their default. Ensure read/write permissions are given to the
533533- Neo4j daemon user <literal>neo4j</literal>.
533533+ Neo4j daemon user `neo4j`.
534534535535 The public certificate as defined by
536536- <option>publicCertificate</option> is required to be duplicated
536536+ {option}`publicCertificate` is required to be duplicated
537537 to this directory.
538538 '';
539539 };
+5-5
nixos/modules/services/databases/openldap.nix
···8888 enable = mkOption {
8989 type = types.bool;
9090 default = false;
9191- description = "Whether to enable the ldap server.";
9191+ description = lib.mdDoc "Whether to enable the ldap server.";
9292 };
93939494 package = mkOption {
···173173 configDir = mkOption {
174174 type = types.nullOr types.path;
175175 default = null;
176176- description = ''
176176+ description = lib.mdDoc ''
177177 Use this config directory instead of generating one from the
178178- <literal>settings</literal> option. Overrides all NixOS settings.
178178+ `settings` option. Overrides all NixOS settings.
179179 '';
180180 example = "/var/lib/openldap/slapd.d";
181181 };
···183183 mutableConfig = mkOption {
184184 type = types.bool;
185185 default = false;
186186- description = ''
186186+ description = lib.mdDoc ''
187187 Whether to allow writable on-line configuration. If
188188- <literal>true</literal>, the NixOS settings will only be used to
188188+ `true`, the NixOS settings will only be used to
189189 initialize the OpenLDAP configuration if it does not exist, and are
190190 subsequently ignored.
191191 '';
+2-2
nixos/modules/services/databases/pgmanage.nix
···6262 nuc-server = "hostaddr=192.168.0.100 port=5432 dbname=postgres";
6363 mini-server = "hostaddr=127.0.0.1 port=5432 dbname=postgres sslmode=require";
6464 };
6565- description = ''
6565+ description = lib.mdDoc ''
6666 pgmanage requires at least one PostgreSQL server be defined.
67676868 Detailed information about PostgreSQL connection strings is available at:
6969- <link xlink:href="http://www.postgresql.org/docs/current/static/libpq-connect.html"/>
6969+ <http://www.postgresql.org/docs/current/static/libpq-connect.html>
70707171 Note that you should not specify your user name or password. That
7272 information will be entered on the login screen. If you specify a
+3-3
nixos/modules/services/databases/postgresql.nix
···149149 ensurePermissions = mkOption {
150150 type = types.attrsOf types.str;
151151 default = {};
152152- description = ''
152152+ description = lib.mdDoc ''
153153 Permissions to ensure for the user, specified as an attribute set.
154154 The attribute names specify the database and tables to grant the permissions for.
155155 The attribute values specify the permissions to grant. You may specify one or
···157157158158 For more information on how to specify the target
159159 and on which privileges exist, see the
160160- <link xlink:href="https://www.postgresql.org/docs/current/sql-grant.html">GRANT syntax</link>.
161161- The attributes are used as <literal>GRANT ''${attrValue} ON ''${attrName}</literal>.
160160+ [GRANT syntax](https://www.postgresql.org/docs/current/sql-grant.html).
161161+ The attributes are used as `GRANT ''${attrValue} ON ''${attrName}`.
162162 '';
163163 example = literalExpression ''
164164 {
···2828 extraOptions = mkOption {
2929 type = types.listOf types.str;
3030 default = [];
3131- description = ''
3131+ description = lib.mdDoc ''
3232 Extra options to pass to VictoriaMetrics. See the README:
3333- <link xlink:href="https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/README.md"/>
3434- or <command>victoriametrics -help</command> for more
3333+ <https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/README.md>
3434+ or {command}`victoriametrics -help` for more
3535 information.
3636 '';
3737 };
+2-2
nixos/modules/services/games/asf.nix
···136136 };
137137 settings = mkOption {
138138 type = types.attrs;
139139- description = ''
140140- Additional settings that are documented <link xlink:href="https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#bot-config">here</link>.
139139+ description = lib.mdDoc ''
140140+ Additional settings that are documented [here](https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#bot-config).
141141 '';
142142 default = { };
143143 };
+7-7
nixos/modules/services/hardware/kanata.nix
···1010 device = mkOption {
1111 type = types.str;
1212 example = "/dev/input/by-id/usb-0000_0000-event-kbd";
1313- description = "Path to the keyboard device.";
1313+ description = lib.mdDoc "Path to the keyboard device.";
1414 };
1515 config = mkOption {
1616 type = types.lines;
···3333 ;; tap within 100ms for capslk, hold more than 100ms for lctl
3434 cap (tap-hold 100 100 caps lctl))
3535 '';
3636- description = ''
3636+ description = lib.mdDoc ''
3737 Configuration other than defcfg.
3838- See <link xlink:href="https://github.com/jtroo/kanata"/> for more information.
3838+ See <https://github.com/jtroo/kanata> for more information.
3939 '';
4040 };
4141 extraDefCfg = mkOption {
4242 type = types.lines;
4343 default = "";
4444 example = "danger-enable-cmd yes";
4545- description = ''
4545+ description = lib.mdDoc ''
4646 Configuration of defcfg other than linux-dev.
4747- See <link xlink:href="https://github.com/jtroo/kanata"/> for more information.
4747+ See <https://github.com/jtroo/kanata> for more information.
4848 '';
4949 };
5050 };
···131131 default = pkgs.kanata;
132132 defaultText = lib.literalExpression "pkgs.kanata";
133133 example = lib.literalExpression "pkgs.kanata-with-cmd";
134134- description = ''
134134+ description = lib.mdDoc ''
135135 kanata package to use.
136136 If you enable danger-enable-cmd, pkgs.kanata-with-cmd should be used.
137137 '';
···139139 keyboards = mkOption {
140140 type = types.attrsOf (types.submodule keyboard);
141141 default = { };
142142- description = "Keyboard configurations.";
142142+ description = lib.mdDoc "Keyboard configurations.";
143143 };
144144 };
145145
+8-8
nixos/modules/services/hardware/udev.nix
···209209 packages = mkOption {
210210 type = types.listOf types.path;
211211 default = [];
212212- description = ''
213213- List of packages containing <command>udev</command> rules.
212212+ description = lib.mdDoc ''
213213+ List of packages containing {command}`udev` rules.
214214 All files found in
215215- <filename>«pkg»/etc/udev/rules.d</filename> and
216216- <filename>«pkg»/lib/udev/rules.d</filename>
215215+ {file}`«pkg»/etc/udev/rules.d` and
216216+ {file}`«pkg»/lib/udev/rules.d`
217217 will be included.
218218 '';
219219 apply = map getBin;
···281281 networking.usePredictableInterfaceNames = mkOption {
282282 default = true;
283283 type = types.bool;
284284- description = ''
285285- Whether to assign <link xlink:href="http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames">predictable names to network interfaces</link>.
284284+ description = lib.mdDoc ''
285285+ Whether to assign [predictable names to network interfaces](http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames).
286286 If enabled, interfaces
287287 are assigned names that contain topology information
288288- (e.g. <literal>wlp3s0</literal>) and thus should be stable
288288+ (e.g. `wlp3s0`) and thus should be stable
289289 across reboots. If disabled, names depend on the order in
290290 which interfaces are discovered by the kernel, which may
291291 change randomly across reboots; for instance, you may find
292292- <literal>eth0</literal> and <literal>eth1</literal> flipping
292292+ `eth0` and `eth1` flipping
293293 unpredictably.
294294 '';
295295 };
+10-10
nixos/modules/services/logging/filebeat.nix
···3131 };
32323333 inputs = mkOption {
3434- description = ''
3434+ description = lib.mdDoc ''
3535 Inputs specify how Filebeat locates and processes input data.
36363737- This is like <literal>services.filebeat.settings.filebeat.inputs</literal>,
3737+ This is like `services.filebeat.settings.filebeat.inputs`,
3838 but structured as an attribute set. This has the benefit
3939 that multiple NixOS modules can contribute settings to a
4040 single filebeat input.
41414242 An input type can be specified multiple times by choosing a
4343- different <literal><name></literal> for each, but setting
4444- <xref linkend="opt-services.filebeat.inputs._name_.type"/>
4343+ different `<name>` for each, but setting
4444+ [](#opt-services.filebeat.inputs._name_.type)
4545 to the same value.
46464747- See <link xlink:href="https://www.elastic.co/guide/en/beats/filebeat/current/configuration-filebeat-options.html"/>.
4747+ See <https://www.elastic.co/guide/en/beats/filebeat/current/configuration-filebeat-options.html>.
4848 '';
4949 default = {};
5050 type = types.attrsOf (types.submodule ({ name, ... }: {
···7777 };
78787979 modules = mkOption {
8080- description = ''
8080+ description = lib.mdDoc ''
8181 Filebeat modules provide a quick way to get started
8282 processing common log formats. They contain default
8383 configurations, Elasticsearch ingest pipeline definitions,
8484 and Kibana dashboards to help you implement and deploy a log
8585 monitoring solution.
86868787- This is like <literal>services.filebeat.settings.filebeat.modules</literal>,
8787+ This is like `services.filebeat.settings.filebeat.modules`,
8888 but structured as an attribute set. This has the benefit
8989 that multiple NixOS modules can contribute settings to a
9090 single filebeat module.
91919292 A module can be specified multiple times by choosing a
9393- different <literal><name></literal> for each, but setting
9494- <xref linkend="opt-services.filebeat.modules._name_.module"/>
9393+ different `<name>` for each, but setting
9494+ [](#opt-services.filebeat.modules._name_.module)
9595 to the same value.
96969797- See <link xlink:href="https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-modules.html"/>.
9797+ See <https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-modules.html>.
9898 '';
9999 default = {};
100100 type = types.attrsOf (types.submodule ({ name, ... }: {
+5-5
nixos/modules/services/logging/logrotate.nix
···276276 defaultText = ''
277277 A configuration file automatically generated by NixOS.
278278 '';
279279- description = ''
279279+ description = lib.mdDoc ''
280280 Override the configuration file used by MySQL. By default,
281281- NixOS generates one automatically from <xref linkend="opt-services.logrotate.settings"/>.
281281+ NixOS generates one automatically from [](#opt-services.logrotate.settings).
282282 '';
283283 example = literalExpression ''
284284 pkgs.writeText "logrotate.conf" '''
···346346 extraConfig = mkOption {
347347 default = "";
348348 type = types.lines;
349349- description = ''
349349+ description = lib.mdDoc ''
350350 Extra contents to append to the logrotate configuration file. Refer to
351351- <link xlink:href="https://linux.die.net/man/8/logrotate"/> for details.
351351+ <https://linux.die.net/man/8/logrotate> for details.
352352 This setting has been deprecated in favor of
353353- <link linkend="opt-services.logrotate.settings">logrotate settings</link>.
353353+ [logrotate settings](#opt-services.logrotate.settings).
354354 '';
355355 };
356356 };
+2-2
nixos/modules/services/mail/mailman.nix
···112112 bindPasswordFile = mkOption {
113113 type = types.str;
114114 example = "/run/secrets/ldap-bind";
115115- description = ''
115115+ description = lib.mdDoc ''
116116 Path to the file containing the bind password of the servie account
117117- defined by <xref linkend="opt-services.mailman.ldap.bindDn"/>.
117117+ defined by [](#opt-services.mailman.ldap.bindDn).
118118 '';
119119 };
120120 superUserGroup = mkOption {
+6-6
nixos/modules/services/mail/nullmailer.nix
···3838 remotesFile = mkOption {
3939 type = types.nullOr types.str;
4040 default = null;
4141- description = ''
4242- Path to the <literal>remotes</literal> control file. This file contains a
4141+ description = lib.mdDoc ''
4242+ Path to the `remotes` control file. This file contains a
4343 list of remote servers to which to send each message.
44444545- See <literal>man 8 nullmailer-send</literal> for syntax and available
4545+ See `man 8 nullmailer-send` for syntax and available
4646 options.
4747 '';
4848 };
···153153 remotes = mkOption {
154154 type = types.nullOr types.str;
155155 default = null;
156156- description = ''
156156+ description = lib.mdDoc ''
157157 A list of remote servers to which to send each message. Each line
158158 contains a remote host name or address followed by an optional
159159 protocol string, separated by white space.
160160161161- See <literal>man 8 nullmailer-send</literal> for syntax and available
161161+ See `man 8 nullmailer-send` for syntax and available
162162 options.
163163164164 WARNING: This is stored world-readable in the nix store. If you need
165165 to specify any secret credentials here, consider using the
166166- <literal>remotesFile</literal> option instead.
166166+ `remotesFile` option instead.
167167 '';
168168 };
169169
+3-3
nixos/modules/services/mail/postfixadmin.nix
···1313 enable = mkOption {
1414 type = types.bool;
1515 default = false;
1616- description = ''
1616+ description = lib.mdDoc ''
1717 Whether to enable postfixadmin.
18181919 Also enables nginx virtual host management.
2020- Further nginx configuration can be done by adapting <literal>services.nginx.virtualHosts.<name></literal>.
2121- See <xref linkend="opt-services.nginx.virtualHosts"/> for further information.
2020+ Further nginx configuration can be done by adapting `services.nginx.virtualHosts.<name>`.
2121+ See [](#opt-services.nginx.virtualHosts) for further information.
2222 '';
2323 };
2424
+5-5
nixos/modules/services/mail/public-inbox.nix
···2323 port = mkOption {
2424 type = with types; nullOr (either str port);
2525 default = defaultPort;
2626- description = ''
2626+ description = lib.mdDoc ''
2727 Listening port.
2828 Beware that public-inbox uses well-known ports number to decide whether to enable TLS or not.
2929- Set to null and use <literal>systemd.sockets.public-inbox-${proto}d.listenStreams</literal>
2929+ Set to null and use `systemd.sockets.public-inbox-${proto}d.listenStreams`
3030 if you need a more advanced listening.
3131 '';
3232 };
···239239 type = with types; nullOr (either str port);
240240 default = 80;
241241 example = "/run/public-inbox-httpd.sock";
242242- description = ''
242242+ description = lib.mdDoc ''
243243 Listening port or systemd's ListenStream= entry
244244 to be used as a reverse proxy, eg. in nginx:
245245- <literal>locations."/inbox".proxyPass = "http://unix:''${config.services.public-inbox.http.port}:/inbox";</literal>
246246- Set to null and use <literal>systemd.sockets.public-inbox-httpd.listenStreams</literal>
245245+ `locations."/inbox".proxyPass = "http://unix:''${config.services.public-inbox.http.port}:/inbox";`
246246+ Set to null and use `systemd.sockets.public-inbox-httpd.listenStreams`
247247 if you need a more advanced listening.
248248 '';
249249 };
+5-5
nixos/modules/services/mail/roundcube.nix
···1414 enable = mkOption {
1515 type = types.bool;
1616 default = false;
1717- description = ''
1717+ description = lib.mdDoc ''
1818 Whether to enable roundcube.
19192020 Also enables nginx virtual host management.
2121- Further nginx configuration can be done by adapting <literal>services.nginx.virtualHosts.<name></literal>.
2222- See <xref linkend="opt-services.nginx.virtualHosts"/> for further information.
2121+ Further nginx configuration can be done by adapting `services.nginx.virtualHosts.<name>`.
2222+ See [](#opt-services.nginx.virtualHosts) for further information.
2323 '';
2424 };
2525···9999 maxAttachmentSize = mkOption {
100100 type = types.int;
101101 default = 18;
102102- description = ''
102102+ description = lib.mdDoc ''
103103 The maximum attachment size in MB.
104104105105 Note: Since roundcube only uses 70% of max upload values configured in php
106106- 30% is added automatically to <xref linkend="opt-services.roundcube.maxAttachmentSize"/>.
106106+ 30% is added automatically to [](#opt-services.roundcube.maxAttachmentSize).
107107 '';
108108 apply = configuredMaxAttachmentSize: "${toString (configuredMaxAttachmentSize * 1.3)}M";
109109 };
+8-8
nixos/modules/services/mail/sympa.nix
···8686 type = str;
8787 default = "en_US";
8888 example = "cs";
8989- description = ''
8989+ description = lib.mdDoc ''
9090 Default Sympa language.
9191- See <link xlink:href="https://github.com/sympa-community/sympa/tree/sympa-6.2/po/sympa"/>
9191+ See <https://github.com/sympa-community/sympa/tree/sympa-6.2/po/sympa>
9292 for available options.
9393 '';
9494 };
···136136 example = {
137137 default_max_list_members = 3;
138138 };
139139- description = ''
140140- The <filename>robot.conf</filename> configuration file as key value set.
141141- See <link xlink:href="https://sympa-community.github.io/gpldoc/man/sympa.conf.5.html"/>
139139+ description = lib.mdDoc ''
140140+ The {file}`robot.conf` configuration file as key value set.
141141+ See <https://sympa-community.github.io/gpldoc/man/sympa.conf.5.html>
142142 for list of configuration parameters.
143143 '';
144144 };
···285285 viewlogs_page_size = 50;
286286 }
287287 '';
288288- description = ''
289289- The <filename>sympa.conf</filename> configuration file as key value set.
290290- See <link xlink:href="https://sympa-community.github.io/gpldoc/man/sympa.conf.5.html"/>
288288+ description = lib.mdDoc ''
289289+ The {file}`sympa.conf` configuration file as key value set.
290290+ See <https://sympa-community.github.io/gpldoc/man/sympa.conf.5.html>
291291 for list of configuration parameters.
292292 '';
293293 };
···4040 };
4141 }
4242 '';
4343- description = ''
4444- <filename>config.yaml</filename> configuration as a Nix attribute set.
4343+ description = lib.mdDoc ''
4444+ {file}`config.yaml` configuration as a Nix attribute set.
45454646 Configuration options should match those described in
4747- <link xlink:href="https://github.com/Half-Shot/matrix-appservice-discord/blob/master/config/config.sample.yaml">config.sample.yaml</link>.
4747+ [config.sample.yaml](https://github.com/Half-Shot/matrix-appservice-discord/blob/master/config/config.sample.yaml).
48484949- <option>config.bridge.domain</option> and <option>config.bridge.homeserverUrl</option>
4949+ {option}`config.bridge.domain` and {option}`config.bridge.homeserverUrl`
5050 should be set to match the public host name of the Matrix homeserver for webhooks and avatars to work.
51515252- Secret tokens should be specified using <option>environmentFile</option>
5252+ Secret tokens should be specified using {option}`environmentFile`
5353 instead of this world-readable attribute set.
5454 '';
5555 };
···7575 };
7676 }
7777 '';
7878- description = ''
7979- <filename>config.yaml</filename> configuration as a Nix attribute set.
7878+ description = lib.mdDoc ''
7979+ {file}`config.yaml` configuration as a Nix attribute set.
8080 Configuration options should match those described in
8181- <link xlink:href="https://github.com/mautrix/facebook/blob/master/mautrix_facebook/example-config.yaml">example-config.yaml</link>.
8181+ [example-config.yaml](https://github.com/mautrix/facebook/blob/master/mautrix_facebook/example-config.yaml).
82828383- Secret tokens should be specified using <option>environmentFile</option>
8383+ Secret tokens should be specified using {option}`environmentFile`
8484 instead of this world-readable attribute set.
8585 '';
8686 };
···7878 };
7979 }
8080 '';
8181- description = ''
8282- <filename>config.yaml</filename> configuration as a Nix attribute set.
8181+ description = lib.mdDoc ''
8282+ {file}`config.yaml` configuration as a Nix attribute set.
8383 Configuration options should match those described in
8484- <link xlink:href="https://github.com/tulir/mautrix-telegram/blob/master/example-config.yaml">example-config.yaml</link>.
8484+ [example-config.yaml](https://github.com/tulir/mautrix-telegram/blob/master/example-config.yaml).
85858686- Secret tokens should be specified using <option>environmentFile</option>
8686+ Secret tokens should be specified using {option}`environmentFile`
8787 instead of this world-readable attribute set.
8888 '';
8989 };
+2-2
nixos/modules/services/misc/autorandr.nix
···2727 options = {
2828 fingerprint = mkOption {
2929 type = types.attrsOf types.str;
3030- description = ''
3030+ description = lib.mdDoc ''
3131 Output name to EDID mapping.
3232- Use <literal>autorandr --fingerprint</literal> to get current setup values.
3232+ Use `autorandr --fingerprint` to get current setup values.
3333 '';
3434 default = { };
3535 };
+2-2
nixos/modules/services/misc/bees.nix
···1111 fsOptions = with types; {
1212 options.spec = mkOption {
1313 type = str;
1414- description = ''
1414+ description = lib.mdDoc ''
1515 Description of how to identify the filesystem to be duplicated by this
1616 instance of bees. Note that deduplication crosses subvolumes; one must
1717 not configure multiple instances for subvolumes of the same filesystem
···2828 options.hashTableSizeMB = mkOption {
2929 type = types.addCheck types.int (n: mod n 16 == 0);
3030 default = 1024; # 1GB; default from upstream beesd script
3131- description = ''
3131+ description = lib.mdDoc ''
3232 Hash table size in MB; must be a multiple of 16.
33333434 A larger ratio of index size to storage size means smaller blocks of
···7171 };
72727373 firmwares = mkOption {
7474- description = "Firmwares klipper should manage";
7474+ description = lib.mdDoc "Firmwares klipper should manage";
7575 default = { };
7676 type = with types; attrsOf
7777 (submodule {
+1-1
nixos/modules/services/misc/sssd.nix
···4242 kcm = mkOption {
4343 type = types.bool;
4444 default = false;
4545- description = ''
4545+ description = lib.mdDoc ''
4646 Whether to use SSS as a Kerberos Cache Manager (KCM).
4747 Kerberos will be configured to cache credentials in SSS.
4848 '';
+7-7
nixos/modules/services/monitoring/cadvisor.nix
···66666767 storageDriverPasswordFile = mkOption {
6868 type = types.str;
6969- description = ''
6969+ description = lib.mdDoc ''
7070 File that contains the cadvisor storage driver password.
71717272- <option>storageDriverPasswordFile</option> takes precedence over <option>storageDriverPassword</option>
7272+ {option}`storageDriverPasswordFile` takes precedence over {option}`storageDriverPassword`
73737474- Warning: when <option>storageDriverPassword</option> is non-empty this defaults to a file in the
7575- world-readable Nix store that contains the value of <option>storageDriverPassword</option>.
7474+ Warning: when {option}`storageDriverPassword` is non-empty this defaults to a file in the
7575+ world-readable Nix store that contains the value of {option}`storageDriverPassword`.
76767777 It's recommended to override this with a path not in the Nix store.
7878- Tip: use <link xlink:href="https://nixos.org/nixops/manual/#idm140737318306400">nixops key management</link>
7878+ Tip: use [nixops key management](https://nixos.org/nixops/manual/#idm140737318306400)
7979 '';
8080 };
8181···8888 extraOptions = mkOption {
8989 type = types.listOf types.str;
9090 default = [];
9191- description = ''
9191+ description = lib.mdDoc ''
9292 Additional cadvisor options.
93939494- See <link xlink:href="https://github.com/google/cadvisor/blob/master/docs/runtime_options.md"/> for available options.
9494+ See <https://github.com/google/cadvisor/blob/master/docs/runtime_options.md> for available options.
9595 '';
9696 };
9797 };
+2-2
nixos/modules/services/monitoring/graphite.nix
···251251252252 extraConfig = mkOption {
253253 default = {};
254254- description = ''
254254+ description = lib.mdDoc ''
255255 Extra seyren configuration. See
256256- <link xlink:href="https://github.com/scobal/seyren#config"/>
256256+ <https://github.com/scobal/seyren#config>
257257 '';
258258 type = types.attrsOf types.str;
259259 example = literalExpression ''
+5-5
nixos/modules/services/monitoring/metricbeat.nix
···3232 };
33333434 modules = mkOption {
3535- description = ''
3535+ description = lib.mdDoc ''
3636 Metricbeat modules are responsible for reading metrics from the various sources.
37373838- This is like <literal>services.metricbeat.settings.metricbeat.modules</literal>,
3838+ This is like `services.metricbeat.settings.metricbeat.modules`,
3939 but structured as an attribute set. This has the benefit that multiple
4040 NixOS modules can contribute settings to a single metricbeat module.
41414242- A module can be specified multiple times by choosing a different <literal><name></literal>
4343- for each, but setting <xref linkend="opt-services.metricbeat.modules._name_.module"/> to the same value.
4242+ A module can be specified multiple times by choosing a different `<name>`
4343+ for each, but setting [](#opt-services.metricbeat.modules._name_.module) to the same value.
44444545- See <link xlink:href="https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-modules.html"/>.
4545+ See <https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-modules.html>.
4646 '';
4747 default = {};
4848 type = types.attrsOf (types.submodule ({ name, ... }: {
+14-14
nixos/modules/services/monitoring/munin.nix
···138138 enable = mkOption {
139139 default = false;
140140 type = types.bool;
141141- description = ''
141141+ description = lib.mdDoc ''
142142 Enable Munin Node agent. Munin node listens on 0.0.0.0 and
143143 by default accepts connections only from 127.0.0.1 for security reasons.
144144145145- See <link xlink:href="http://guide.munin-monitoring.org/en/latest/architecture/index.html"/>.
145145+ See <http://guide.munin-monitoring.org/en/latest/architecture/index.html>.
146146 '';
147147 };
148148149149 extraConfig = mkOption {
150150 default = "";
151151 type = types.lines;
152152- description = ''
153153- <filename>munin-node.conf</filename> extra configuration. See
154154- <link xlink:href="http://guide.munin-monitoring.org/en/latest/reference/munin-node.conf.html"/>
152152+ description = lib.mdDoc ''
153153+ {file}`munin-node.conf` extra configuration. See
154154+ <http://guide.munin-monitoring.org/en/latest/reference/munin-node.conf.html>
155155 '';
156156 };
157157158158 extraPluginConfig = mkOption {
159159 default = "";
160160 type = types.lines;
161161- description = ''
162162- <filename>plugin-conf.d</filename> extra plugin configuration. See
163163- <link xlink:href="http://guide.munin-monitoring.org/en/latest/plugin/use.html"/>
161161+ description = lib.mdDoc ''
162162+ {file}`plugin-conf.d` extra plugin configuration. See
163163+ <http://guide.munin-monitoring.org/en/latest/plugin/use.html>
164164 '';
165165 example = ''
166166 [fail2ban_*]
···266266 extraGlobalConfig = mkOption {
267267 default = "";
268268 type = types.lines;
269269- description = ''
270270- <filename>munin.conf</filename> extra global configuration.
271271- See <link xlink:href="http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html"/>.
269269+ description = lib.mdDoc ''
270270+ {file}`munin.conf` extra global configuration.
271271+ See <http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html>.
272272 Useful to setup notifications, see
273273- <link xlink:href="http://guide.munin-monitoring.org/en/latest/tutorial/alert.html"/>
273273+ <http://guide.munin-monitoring.org/en/latest/tutorial/alert.html>
274274 '';
275275 example = ''
276276 contact.email.command mail -s "Munin notification for ''${var:host}" someone@example.com
···280280 hosts = mkOption {
281281 default = "";
282282 type = types.lines;
283283- description = ''
283283+ description = lib.mdDoc ''
284284 Definitions of hosts of nodes to collect data from. Needs at least one
285285 host for cron to succeed. See
286286- <link xlink:href="http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html"/>
286286+ <http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html>
287287 '';
288288 example = literalExpression ''
289289 '''
+2-2
nixos/modules/services/monitoring/netdata.nix
···114114 example = literalExpression ''
115115 [ "/path/to/plugins.d" ]
116116 '';
117117- description = ''
117117+ description = lib.mdDoc ''
118118 Extra paths to add to the netdata global "plugins directory"
119119 option. Useful for when you want to include your own
120120 collection scripts.
121121122122 Details about writing a custom netdata plugin are available at:
123123- <link xlink:href="https://docs.netdata.cloud/collectors/plugins.d/"/>
123123+ <https://docs.netdata.cloud/collectors/plugins.d/>
124124125125 Cannot be combined with configText.
126126 '';
+17-17
nixos/modules/services/monitoring/parsedmarc.nix
···2929 enable = lib.mkOption {
3030 type = lib.types.bool;
3131 default = false;
3232- description = ''
3232+ description = lib.mdDoc ''
3333 Whether Postfix and Dovecot should be set up to receive
3434 mail locally. parsedmarc will be configured to watch the
3535 local inbox as the automatically created user specified in
3636- <xref linkend="opt-services.parsedmarc.provision.localMail.recipientName" />
3636+ [](#opt-services.parsedmarc.provision.localMail.recipientName)
3737 '';
3838 };
3939···6868 geoIp = lib.mkOption {
6969 type = lib.types.bool;
7070 default = true;
7171- description = ''
7272- Whether to enable and configure the <link linkend="opt-services.geoipupdate.enable">geoipupdate</link>
7171+ description = lib.mdDoc ''
7272+ Whether to enable and configure the [geoipupdate](#opt-services.geoipupdate.enable)
7373 service to automatically fetch GeoIP databases. Not crucial,
7474 but recommended for full functionality.
75757676- To finish the setup, you need to manually set the <xref linkend="opt-services.geoipupdate.settings.AccountID"/> and
7777- <xref linkend="opt-services.geoipupdate.settings.LicenseKey"/>
7676+ To finish the setup, you need to manually set the [](#opt-services.geoipupdate.settings.AccountID) and
7777+ [](#opt-services.geoipupdate.settings.LicenseKey)
7878 options.
7979 '';
8080 };
···9595 config.${opt.provision.elasticsearch} && config.${options.services.grafana.enable}
9696 '';
9797 apply = x: x && cfg.provision.elasticsearch;
9898- description = ''
9898+ description = lib.mdDoc ''
9999 Whether the automatically provisioned Elasticsearch
100100 instance should be added as a grafana datasource. Has no
101101 effect unless
102102- <xref linkend="opt-services.parsedmarc.provision.elasticsearch"/>
102102+ [](#opt-services.parsedmarc.provision.elasticsearch)
103103 is also enabled.
104104 '';
105105 };
···206206 password = lib.mkOption {
207207 type = with lib.types; nullOr (either path (attrsOf path));
208208 default = null;
209209- description = ''
209209+ description = lib.mdDoc ''
210210 The IMAP server password.
211211212212 Always handled as a secret whether the value is
213213- wrapped in a <literal>{ _secret = ...; }</literal>
214214- attrset or not (refer to <xref linkend="opt-services.parsedmarc.settings"/> for
213213+ wrapped in a `{ _secret = ...; }`
214214+ attrset or not (refer to [](#opt-services.parsedmarc.settings) for
215215 details).
216216 '';
217217 apply = x: if isAttrs x || x == null then x else { _secret = x; };
···270270 password = lib.mkOption {
271271 type = with lib.types; nullOr (either path (attrsOf path));
272272 default = null;
273273- description = ''
273273+ description = lib.mdDoc ''
274274 The SMTP server password.
275275276276 Always handled as a secret whether the value is
277277- wrapped in a <literal>{ _secret = ...; }</literal>
278278- attrset or not (refer to <xref linkend="opt-services.parsedmarc.settings"/> for
277277+ wrapped in a `{ _secret = ...; }`
278278+ attrset or not (refer to [](#opt-services.parsedmarc.settings) for
279279 details).
280280 '';
281281 apply = x: if isAttrs x || x == null then x else { _secret = x; };
···322322 password = lib.mkOption {
323323 type = with lib.types; nullOr (either path (attrsOf path));
324324 default = null;
325325- description = ''
325325+ description = lib.mdDoc ''
326326 The password to use when connecting to Elasticsearch,
327327 if required.
328328329329 Always handled as a secret whether the value is
330330- wrapped in a <literal>{ _secret = ...; }</literal>
331331- attrset or not (refer to <xref linkend="opt-services.parsedmarc.settings"/> for
330330+ wrapped in a `{ _secret = ...; }`
331331+ attrset or not (refer to [](#opt-services.parsedmarc.settings) for
332332 details).
333333 '';
334334 apply = x: if isAttrs x || x == null then x else { _secret = x; };
+5-5
nixos/modules/services/networking/biboumi.nix
···8383 };
8484 options.password = mkOption {
8585 type = with types; nullOr str;
8686- description = ''
8686+ description = lib.mdDoc ''
8787 The password used to authenticate the XMPP component to your XMPP server.
8888 This password must be configured in the XMPP server,
8989 associated with the external component on
9090- <link linkend="opt-services.biboumi.settings.hostname">hostname</link>.
9090+ [hostname](#opt-services.biboumi.settings.hostname).
91919292- Set it to null and use <link linkend="opt-services.biboumi.credentialsFile">credentialsFile</link>
9292+ Set it to null and use [credentialsFile](#opt-services.biboumi.credentialsFile)
9393 if you do not want this password to go into the Nix store.
9494 '';
9595 };
···155155156156 credentialsFile = mkOption {
157157 type = types.path;
158158- description = ''
158158+ description = lib.mdDoc ''
159159 Path to a configuration file to be merged with the settings.
160160 Beware not to surround "=" with spaces when setting biboumi's options in this file.
161161 Useful to merge a file which is better kept out of the Nix store
162162 because it contains sensible data like
163163- <link linkend="opt-services.biboumi.settings.password">password</link>.
163163+ [password](#opt-services.biboumi.settings.password).
164164 '';
165165 default = "/dev/null";
166166 example = "/run/keys/biboumi.cfg";
···1313 enable = mkEnableOption "BIRD Internet Routing Daemon";
1414 config = mkOption {
1515 type = types.lines;
1616- description = ''
1616+ description = lib.mdDoc ''
1717 BIRD Internet Routing Daemon configuration file.
1818- <link xlink:href="http://bird.network.cz/"/>
1818+ <http://bird.network.cz/>
1919 '';
2020 };
2121 checkConfig = mkOption {
2222 type = types.bool;
2323 default = true;
2424- description = ''
2424+ description = lib.mdDoc ''
2525 Whether the config should be checked at build time.
2626 When the config can't be checked during build time, for example when it includes
2727- other files, either disable this option or use <literal>preCheckConfig</literal> to create
2727+ other files, either disable this option or use `preCheckConfig` to create
2828 the included files before checking.
2929 '';
3030 };
···3434 example = ''
3535 echo "cost 100;" > include.conf
3636 '';
3737- description = ''
3737+ description = lib.mdDoc ''
3838 Commands to execute before the config file check. The file to be checked will be
3939- available as <literal>bird2.conf</literal> in the current directory.
3939+ available as `bird2.conf` in the current directory.
40404141 Files created with this option will not be available at service runtime, only during
4242 build time checking.
+2-2
nixos/modules/services/networking/coredns.nix
···1717 }
1818 '';
1919 type = types.lines;
2020- description = ''
2020+ description = lib.mdDoc ''
2121 Verbatim Corefile to use.
2222- See <link xlink:href="https://coredns.io/manual/toc/#configuration"/> for details.
2222+ See <https://coredns.io/manual/toc/#configuration> for details.
2323 '';
2424 };
2525
+7-7
nixos/modules/services/networking/ghostunnel.nix
···4949 };
50505151 cert = mkOption {
5252- description = ''
5252+ description = lib.mdDoc ''
5353 Path to certificate (PEM with certificate chain).
54545555- Not required if <literal>keystore</literal> is set.
5555+ Not required if `keystore` is set.
5656 '';
5757 type = types.nullOr types.str;
5858 default = null;
5959 };
60606161 key = mkOption {
6262- description = ''
6262+ description = lib.mdDoc ''
6363 Path to certificate private key (PEM with private key).
64646565- Not required if <literal>keystore</literal> is set.
6565+ Not required if `keystore` is set.
6666 '';
6767 type = types.nullOr types.str;
6868 default = null;
6969 };
70707171 cacert = mkOption {
7272- description = ''
7373- Path to CA bundle file (PEM/X509). Uses system trust store if <literal>null</literal>.
7272+ description = lib.mdDoc ''
7373+ Path to CA bundle file (PEM/X509). Uses system trust store if `null`.
7474 '';
7575 type = types.nullOr types.str;
7676 };
···124124 };
125125126126 extraArguments = mkOption {
127127- description = "Extra arguments to pass to <literal>ghostunnel server</literal>";
127127+ description = lib.mdDoc "Extra arguments to pass to `ghostunnel server`";
128128 type = types.separatedString " ";
129129 default = "";
130130 };
+2-2
nixos/modules/services/networking/hans.nix
···1919 services.hans = {
2020 clients = mkOption {
2121 default = {};
2222- description = ''
2222+ description = lib.mdDoc ''
2323 Each attribute of this option defines a systemd service that
2424 runs hans. Many or none may be defined.
2525 The name of each service is
2626- <literal>hans-«name»</literal>
2626+ `hans-«name»`
2727 where «name» is the name of the
2828 corresponding attribute name.
2929 '';
+2-2
nixos/modules/services/networking/iodine.nix
···2828 services.iodine = {
2929 clients = mkOption {
3030 default = {};
3131- description = ''
3131+ description = lib.mdDoc ''
3232 Each attribute of this option defines a systemd service that
3333 runs iodine. Many or none may be defined.
3434 The name of each service is
3535- <literal>iodine-«name»</literal>
3535+ `iodine-«name»`
3636 where «name» is the name of the
3737 corresponding attribute name.
3838 '';
+16-16
nixos/modules/services/networking/kea.nix
···5454 configFile = mkOption {
5555 type = nullOr path;
5656 default = null;
5757- description = ''
5858- Kea Control Agent configuration as a path, see <link xlink:href="https://kea.readthedocs.io/en/kea-${package.version}/arm/agent.html"/>.
5757+ description = lib.mdDoc ''
5858+ Kea Control Agent configuration as a path, see <https://kea.readthedocs.io/en/kea-${package.version}/arm/agent.html>.
59596060- Takes preference over <link linkend="opt-services.kea.ctrl-agent.settings">settings</link>.
6161- Most users should prefer using <link linkend="opt-services.kea.ctrl-agent.settings">settings</link> instead.
6060+ Takes preference over [settings](#opt-services.kea.ctrl-agent.settings).
6161+ Most users should prefer using [settings](#opt-services.kea.ctrl-agent.settings) instead.
6262 '';
6363 };
6464···9393 configFile = mkOption {
9494 type = nullOr path;
9595 default = null;
9696- description = ''
9797- Kea DHCP4 configuration as a path, see <link xlink:href="https://kea.readthedocs.io/en/kea-${package.version}/arm/dhcp4-srv.html"/>.
9696+ description = lib.mdDoc ''
9797+ Kea DHCP4 configuration as a path, see <https://kea.readthedocs.io/en/kea-${package.version}/arm/dhcp4-srv.html>.
98989999- Takes preference over <link linkend="opt-services.kea.dhcp4.settings">settings</link>.
100100- Most users should prefer using <link linkend="opt-services.kea.dhcp4.settings">settings</link> instead.
9999+ Takes preference over [settings](#opt-services.kea.dhcp4.settings).
100100+ Most users should prefer using [settings](#opt-services.kea.dhcp4.settings) instead.
101101 '';
102102 };
103103···153153 configFile = mkOption {
154154 type = nullOr path;
155155 default = null;
156156- description = ''
157157- Kea DHCP6 configuration as a path, see <link xlink:href="https://kea.readthedocs.io/en/kea-${package.version}/arm/dhcp6-srv.html"/>.
156156+ description = lib.mdDoc ''
157157+ Kea DHCP6 configuration as a path, see <https://kea.readthedocs.io/en/kea-${package.version}/arm/dhcp6-srv.html>.
158158159159- Takes preference over <link linkend="opt-services.kea.dhcp6.settings">settings</link>.
160160- Most users should prefer using <link linkend="opt-services.kea.dhcp6.settings">settings</link> instead.
159159+ Takes preference over [settings](#opt-services.kea.dhcp6.settings).
160160+ Most users should prefer using [settings](#opt-services.kea.dhcp6.settings) instead.
161161 '';
162162 };
163163···214214 configFile = mkOption {
215215 type = nullOr path;
216216 default = null;
217217- description = ''
218218- Kea DHCP-DDNS configuration as a path, see <link xlink:href="https://kea.readthedocs.io/en/kea-${package.version}/arm/ddns.html"/>.
217217+ description = lib.mdDoc ''
218218+ Kea DHCP-DDNS configuration as a path, see <https://kea.readthedocs.io/en/kea-${package.version}/arm/ddns.html>.
219219220220- Takes preference over <link linkend="opt-services.kea.dhcp-ddns.settings">settings</link>.
221221- Most users should prefer using <link linkend="opt-services.kea.dhcp-ddns.settings">settings</link> instead.
220220+ Takes preference over [settings](#opt-services.kea.dhcp-ddns.settings).
221221+ Most users should prefer using [settings](#opt-services.kea.dhcp-ddns.settings) instead.
222222 '';
223223 };
224224
+2-2
nixos/modules/services/networking/ncdns.nix
···176176 certstore.nssdbdir = "../../home/alice/.pki/nssdb";
177177 }
178178 '';
179179- description = ''
179179+ description = lib.mdDoc ''
180180 ncdns settings. Use this option to configure ncds
181181 settings not exposed in a NixOS option or to bypass one.
182182- See the example ncdns.conf file at <link xlink:href="https://github.com/namecoin/ncdns/blob/master/_doc/ncdns.conf.example"/>
182182+ See the example ncdns.conf file at <https://github.com/namecoin/ncdns/blob/master/_doc/ncdns.conf.example>
183183 for the available options.
184184 '';
185185 };
···387387 enableStrongSwan = mkOption {
388388 type = types.bool;
389389 default = false;
390390- description = ''
390390+ description = lib.mdDoc ''
391391 Enable the StrongSwan plugin.
392392393393 If you enable this option the
394394- <literal>networkmanager_strongswan</literal> plugin will be added to
395395- the <option>networking.networkmanager.plugins</option> option
394394+ `networkmanager_strongswan` plugin will be added to
395395+ the {option}`networking.networkmanager.plugins` option
396396 so you don't need to to that yourself.
397397 '';
398398 };
···4040 enable = mkOption {
4141 type = types.bool;
4242 default = false;
4343- description = ''
4343+ description = lib.mdDoc ''
4444 Whether to synchronise your machine's time using ntpd, as a peer in
4545 the NTP network.
46464747- Disables <literal>systemd.timesyncd</literal> if enabled.
4747+ Disables `systemd.timesyncd` if enabled.
4848 '';
4949 };
50505151 restrictDefault = mkOption {
5252 type = types.listOf types.str;
5353- description = ''
5353+ description = lib.mdDoc ''
5454 The restriction flags to be set by default.
55555656 The default flags prevent external hosts from using ntpd as a DDoS
···63636464 restrictSource = mkOption {
6565 type = types.listOf types.str;
6666- description = ''
6666+ description = lib.mdDoc ''
6767 The restriction flags to be set on source.
68686969 The default flags allow peers to be added by ntpd from configured
+7-7
nixos/modules/services/networking/openconnect.nix
···3838 # set an authentication cookie, because they have to be requested
3939 # for every new connection and would only work once.
4040 passwordFile = mkOption {
4141- description = ''
4141+ description = lib.mdDoc ''
4242 File containing the password to authenticate with. This
4343- is passed to <literal>openconnect</literal> via the
4444- <literal>--passwd-on-stdin</literal> option.
4343+ is passed to `openconnect` via the
4444+ `--passwd-on-stdin` option.
4545 '';
4646 default = null;
4747 example = "/var/lib/secrets/openconnect-passwd";
···6363 };
64646565 extraOptions = mkOption {
6666- description = ''
6666+ description = lib.mdDoc ''
6767 Extra config to be appended to the interface config. It should
6868 contain long-format options as would be accepted on the command
6969- line by <literal>openconnect</literal>
6969+ line by `openconnect`
7070 (see https://www.infradead.org/openconnect/manual.html).
7171- Non-key-value options like <literal>deflate</literal> can be used by
7272- declaring them as booleans, i. e. <literal>deflate = true;</literal>.
7171+ Non-key-value options like `deflate` can be used by
7272+ declaring them as booleans, i. e. `deflate = true;`.
7373 '';
7474 default = { };
7575 example = {
+2-2
nixos/modules/services/networking/openvpn.nix
···115115 }
116116 '';
117117118118- description = ''
118118+ description = lib.mdDoc ''
119119 Each attribute of this option defines a systemd service that
120120 runs an OpenVPN instance. These can be OpenVPN servers or
121121 clients. The name of each systemd service is
122122- <literal>openvpn-«name».service</literal>,
122122+ `openvpn-«name».service`,
123123 where «name» is the corresponding
124124 attribute name.
125125 '';
+4-4
nixos/modules/services/networking/pleroma.nix
···34343535 configs = mkOption {
3636 type = with types; listOf str;
3737- description = ''
3737+ description = lib.mdDoc ''
3838 Pleroma public configuration.
39394040 This list gets appended from left to
···4242 configuration imperatively, meaning you can override a
4343 setting by appending a new str to this NixOS option list.
44444545- <emphasis>DO NOT STORE ANY PLEROMA SECRET
4646- HERE</emphasis>, use
4747- <link linkend="opt-services.pleroma.secretConfigFile">services.pleroma.secretConfigFile</link>
4545+ *DO NOT STORE ANY PLEROMA SECRET
4646+ HERE*, use
4747+ [services.pleroma.secretConfigFile](#opt-services.pleroma.secretConfigFile)
4848 instead.
49495050 This setting is going to be stored in a file part of
+12-12
nixos/modules/services/networking/ssh/sshd.nix
···257257 authorizedKeysFiles = mkOption {
258258 type = types.listOf types.str;
259259 default = [];
260260- description = ''
260260+ description = lib.mdDoc ''
261261 Specify the rules for which files to read on the host.
262262263263 This is an advanced option. If you're looking to configure user
264264- keys, you can generally use <xref linkend="opt-users.users._name_.openssh.authorizedKeys.keys"/>
265265- or <xref linkend="opt-users.users._name_.openssh.authorizedKeys.keyFiles"/>.
264264+ keys, you can generally use [](#opt-users.users._name_.openssh.authorizedKeys.keys)
265265+ or [](#opt-users.users._name_.openssh.authorizedKeys.keyFiles).
266266267267 These are paths relative to the host root file system or home
268268 directories and they are subject to certain token expansion rules.
···298298 "curve25519-sha256@libssh.org"
299299 "diffie-hellman-group-exchange-sha256"
300300 ];
301301- description = ''
301301+ description = lib.mdDoc ''
302302 Allowed key exchange algorithms
303303304304 Uses the lower bound recommended in both
305305- <link xlink:href="https://stribika.github.io/2015/01/04/secure-secure-shell.html"/>
305305+ <https://stribika.github.io/2015/01/04/secure-secure-shell.html>
306306 and
307307- <link xlink:href="https://infosec.mozilla.org/guidelines/openssh#modern-openssh-67"/>
307307+ <https://infosec.mozilla.org/guidelines/openssh#modern-openssh-67>
308308 '';
309309 };
310310···318318 "aes192-ctr"
319319 "aes128-ctr"
320320 ];
321321- description = ''
321321+ description = lib.mdDoc ''
322322 Allowed ciphers
323323324324 Defaults to recommended settings from both
325325- <link xlink:href="https://stribika.github.io/2015/01/04/secure-secure-shell.html"/>
325325+ <https://stribika.github.io/2015/01/04/secure-secure-shell.html>
326326 and
327327- <link xlink:href="https://infosec.mozilla.org/guidelines/openssh#modern-openssh-67"/>
327327+ <https://infosec.mozilla.org/guidelines/openssh#modern-openssh-67>
328328 '';
329329 };
330330···338338 "hmac-sha2-256"
339339 "umac-128@openssh.com"
340340 ];
341341- description = ''
341341+ description = lib.mdDoc ''
342342 Allowed MACs
343343344344 Defaults to recommended settings from both
345345- <link xlink:href="https://stribika.github.io/2015/01/04/secure-secure-shell.html"/>
345345+ <https://stribika.github.io/2015/01/04/secure-secure-shell.html>
346346 and
347347- <link xlink:href="https://infosec.mozilla.org/guidelines/openssh#modern-openssh-67"/>
347347+ <https://infosec.mozilla.org/guidelines/openssh#modern-openssh-67>
348348 '';
349349 };
350350
+8-8
nixos/modules/services/networking/wireguard.nix
···118118 default = null;
119119 type = with types; nullOr str;
120120 example = "container";
121121- description = ''The pre-existing network namespace in which the
121121+ description = lib.mdDoc ''The pre-existing network namespace in which the
122122 WireGuard interface is created, and which retains the socket even if the
123123- interface is moved via <option>interfaceNamespace</option>. When
124124- <literal>null</literal>, the interface is created in the init namespace.
125125- See <link xlink:href="https://www.wireguard.com/netns/">documentation</link>.
123123+ interface is moved via {option}`interfaceNamespace`. When
124124+ `null`, the interface is created in the init namespace.
125125+ See [documentation](https://www.wireguard.com/netns/).
126126 '';
127127 };
128128···130130 default = null;
131131 type = with types; nullOr str;
132132 example = "init";
133133- description = ''The pre-existing network namespace the WireGuard
134134- interface is moved to. The special value <literal>init</literal> means
135135- the init namespace. When <literal>null</literal>, the interface is not
133133+ description = lib.mdDoc ''The pre-existing network namespace the WireGuard
134134+ interface is moved to. The special value `init` means
135135+ the init namespace. When `null`, the interface is not
136136 moved.
137137- See <link xlink:href="https://www.wireguard.com/netns/">documentation</link>.
137137+ See [documentation](https://www.wireguard.com/netns/).
138138 '';
139139 };
140140 };
+6-6
nixos/modules/services/networking/yggdrasil.nix
···6464 type = types.nullOr types.str;
6565 default = null;
6666 example = "wheel";
6767- description = "Group to grant access to the Yggdrasil control socket. If <literal>null</literal>, only root can access the socket.";
6767+ description = lib.mdDoc "Group to grant access to the Yggdrasil control socket. If `null`, only root can access the socket.";
6868 };
69697070 openMulticastPort = mkOption {
7171 type = bool;
7272 default = false;
7373- description = ''
7373+ description = lib.mdDoc ''
7474 Whether to open the UDP port used for multicast peer
7575 discovery. The NixOS firewall blocks link-local
7676 communication, so in order to make local peering work you
7777- will also need to set <literal>LinkLocalTCPPort</literal> in your
7878- yggdrasil configuration (<option>config</option> or
7979- <option>configFile</option>) to a port number other than 0,
7777+ will also need to set `LinkLocalTCPPort` in your
7878+ yggdrasil configuration ({option}`config` or
7979+ {option}`configFile`) to a port number other than 0,
8080 and then add that port to
8181- <option>networking.firewall.allowedTCPPorts</option>.
8181+ {option}`networking.firewall.allowedTCPPorts`.
8282 '';
8383 };
8484
···476476 };
477477 clientNames = mkOption {
478478 type = with types; nonEmptyListOf (strMatching "[A-Za-z0-9+-_]+");
479479- description = ''
479479+ description = lib.mdDoc ''
480480 Only clients that are listed here are authorized to access the hidden service.
481481- Generated authorization data can be found in <filename>${stateDir}/onion/$name/hostname</filename>.
481481+ Generated authorization data can be found in {file}`${stateDir}/onion/$name/hostname`.
482482 Clients need to put this authorization data in their configuration file using
483483- <xref linkend="opt-services.tor.settings.HidServAuth"/>.
483483+ [](#opt-services.tor.settings.HidServAuth).
484484 '';
485485 };
486486 };
+2-2
nixos/modules/services/security/vault.nix
···116116 storageConfig = mkOption {
117117 type = types.nullOr types.lines;
118118 default = null;
119119- description = ''
119119+ description = lib.mdDoc ''
120120 HCL configuration to insert in the storageBackend section.
121121122122 Confidential values should not be specified here because this option's
123123 value is written to the Nix store, which is publicly readable.
124124 Provide credentials and such in a separate file using
125125- <xref linkend="opt-services.vault.extraSettingsPaths"/>.
125125+ [](#opt-services.vault.extraSettingsPaths).
126126 '';
127127 };
128128
+7-7
nixos/modules/services/system/dbus.nix
···3838 packages = mkOption {
3939 type = types.listOf types.path;
4040 default = [ ];
4141- description = ''
4141+ description = lib.mdDoc ''
4242 Packages whose D-Bus configuration files should be included in
4343 the configuration of the D-Bus system-wide or session-wide
4444 message bus. Specifically, files in the following directories
4545 will be included into their respective DBus configuration paths:
4646- <filename>«pkg»/etc/dbus-1/system.d</filename>
4747- <filename>«pkg»/share/dbus-1/system.d</filename>
4848- <filename>«pkg»/share/dbus-1/system-services</filename>
4949- <filename>«pkg»/etc/dbus-1/session.d</filename>
5050- <filename>«pkg»/share/dbus-1/session.d</filename>
5151- <filename>«pkg»/share/dbus-1/services</filename>
4646+ {file}`«pkg»/etc/dbus-1/system.d`
4747+ {file}`«pkg»/share/dbus-1/system.d`
4848+ {file}`«pkg»/share/dbus-1/system-services`
4949+ {file}`«pkg»/etc/dbus-1/session.d`
5050+ {file}`«pkg»/share/dbus-1/session.d`
5151+ {file}`«pkg»/share/dbus-1/services`
5252 '';
5353 };
5454
+8-8
nixos/modules/services/system/earlyoom.nix
···3232 freeMemKillThreshold = mkOption {
3333 type = types.nullOr (types.ints.between 1 100);
3434 default = null;
3535- description = ''
3535+ description = lib.mdDoc ''
3636 Minimum available memory (in percent) before sending SIGKILL.
3737- If unset, this defaults to half of <option>freeMemThreshold</option>.
3737+ If unset, this defaults to half of {option}`freeMemThreshold`.
38383939- See the description of <xref linkend="opt-services.earlyoom.freeMemThreshold"/>.
3939+ See the description of [](#opt-services.earlyoom.freeMemThreshold).
4040 '';
4141 };
42424343 freeSwapThreshold = mkOption {
4444 type = types.ints.between 1 100;
4545 default = 10;
4646- description = ''
4646+ description = lib.mdDoc ''
4747 Minimum free swap space (in percent) before sending SIGTERM.
48484949- See the description of <xref linkend="opt-services.earlyoom.freeMemThreshold"/>.
4949+ See the description of [](#opt-services.earlyoom.freeMemThreshold).
5050 '';
5151 };
52525353 freeSwapKillThreshold = mkOption {
5454 type = types.nullOr (types.ints.between 1 100);
5555 default = null;
5656- description = ''
5656+ description = lib.mdDoc ''
5757 Minimum free swap space (in percent) before sending SIGKILL.
5858- If unset, this defaults to half of <option>freeSwapThreshold</option>.
5858+ If unset, this defaults to half of {option}`freeSwapThreshold`.
59596060- See the description of <xref linkend="opt-services.earlyoom.freeMemThreshold"/>.
6060+ See the description of [](#opt-services.earlyoom.freeMemThreshold).
6161 '';
6262 };
6363
+28-28
nixos/modules/services/torrent/transmission.nix
···5555 type = types.path;
5656 default = "${cfg.home}/${incompleteDir}";
5757 defaultText = literalExpression ''"''${config.${opt.home}}/${incompleteDir}"'';
5858- description = ''
5858+ description = lib.mdDoc ''
5959 When enabled with
6060 services.transmission.home
6161- <xref linkend="opt-services.transmission.settings.incomplete-dir-enabled"/>,
6161+ [](#opt-services.transmission.settings.incomplete-dir-enabled),
6262 new torrents will download the files to this directory.
6363 When complete, the files will be moved to download-dir
6464- <xref linkend="opt-services.transmission.settings.download-dir"/>.
6464+ [](#opt-services.transmission.settings.download-dir).
6565 '';
6666 };
6767 options.incomplete-dir-enabled = mkOption {
···8282 options.peer-port-random-high = mkOption {
8383 type = types.port;
8484 default = 65535;
8585- description = ''
8585+ description = lib.mdDoc ''
8686 The maximum peer port to listen to for incoming connections
8787- when <xref linkend="opt-services.transmission.settings.peer-port-random-on-start"/> is enabled.
8787+ when [](#opt-services.transmission.settings.peer-port-random-on-start) is enabled.
8888 '';
8989 };
9090 options.peer-port-random-low = mkOption {
9191 type = types.port;
9292 default = 65535;
9393- description = ''
9393+ description = lib.mdDoc ''
9494 The minimal peer port to listen to for incoming connections
9595- when <xref linkend="opt-services.transmission.settings.peer-port-random-on-start"/> is enabled.
9595+ when [](#opt-services.transmission.settings.peer-port-random-on-start) is enabled.
9696 '';
9797 };
9898 options.peer-port-random-on-start = mkOption {
···117117 options.script-torrent-done-enabled = mkOption {
118118 type = types.bool;
119119 default = false;
120120- description = ''
120120+ description = lib.mdDoc ''
121121 Whether to run
122122- <xref linkend="opt-services.transmission.settings.script-torrent-done-filename"/>
122122+ [](#opt-services.transmission.settings.script-torrent-done-filename)
123123 at torrent completion.
124124 '';
125125 };
···156156 options.watch-dir-enabled = mkOption {
157157 type = types.bool;
158158 default = false;
159159- description = ''Whether to enable the
160160- <xref linkend="opt-services.transmission.settings.watch-dir"/>.
159159+ description = lib.mdDoc ''Whether to enable the
160160+ [](#opt-services.transmission.settings.watch-dir).
161161 '';
162162 };
163163 options.trash-original-torrent-files = mkOption {
164164 type = types.bool;
165165 default = false;
166166- description = ''Whether to delete torrents added from the
167167- <xref linkend="opt-services.transmission.settings.watch-dir"/>.
166166+ description = lib.mdDoc ''Whether to delete torrents added from the
167167+ [](#opt-services.transmission.settings.watch-dir).
168168 '';
169169 };
170170 };
···174174 type = with types; nullOr str;
175175 default = null;
176176 example = "770";
177177- description = ''
178178- If not <literal>null</literal>, is used as the permissions
179179- set by <literal>systemd.activationScripts.transmission-daemon</literal>
180180- on the directories <xref linkend="opt-services.transmission.settings.download-dir"/>,
181181- <xref linkend="opt-services.transmission.settings.incomplete-dir"/>.
182182- and <xref linkend="opt-services.transmission.settings.watch-dir"/>.
177177+ description = lib.mdDoc ''
178178+ If not `null`, is used as the permissions
179179+ set by `systemd.activationScripts.transmission-daemon`
180180+ on the directories [](#opt-services.transmission.settings.download-dir),
181181+ [](#opt-services.transmission.settings.incomplete-dir).
182182+ and [](#opt-services.transmission.settings.watch-dir).
183183 Note that you may also want to change
184184- <xref linkend="opt-services.transmission.settings.umask"/>.
184184+ [](#opt-services.transmission.settings.umask).
185185 '';
186186 };
187187188188 home = mkOption {
189189 type = types.path;
190190 default = "/var/lib/transmission";
191191- description = ''
192192- The directory where Transmission will create <literal>${settingsDir}</literal>.
193193- as well as <literal>${downloadsDir}/</literal> unless
194194- <xref linkend="opt-services.transmission.settings.download-dir"/> is changed,
195195- and <literal>${incompleteDir}/</literal> unless
196196- <xref linkend="opt-services.transmission.settings.incomplete-dir"/> is changed.
191191+ description = lib.mdDoc ''
192192+ The directory where Transmission will create `${settingsDir}`.
193193+ as well as `${downloadsDir}/` unless
194194+ [](#opt-services.transmission.settings.download-dir) is changed,
195195+ and `${incompleteDir}/` unless
196196+ [](#opt-services.transmission.settings.incomplete-dir) is changed.
197197 '';
198198 };
199199···211211212212 credentialsFile = mkOption {
213213 type = types.path;
214214- description = ''
214214+ description = lib.mdDoc ''
215215 Path to a JSON file to be merged with the settings.
216216 Useful to merge a file which is better kept out of the Nix store
217217- to set secret config parameters like <literal>rpc-password</literal>.
217217+ to set secret config parameters like `rpc-password`.
218218 '';
219219 default = "/dev/null";
220220 example = "/var/lib/secrets/transmission/settings.json";
+5-5
nixos/modules/services/web-apps/dokuwiki.nix
···260260 webserver = mkOption {
261261 type = types.enum [ "nginx" "caddy" ];
262262 default = "nginx";
263263- description = ''
263263+ description = lib.mdDoc ''
264264 Whether to use nginx or caddy for virtual host management.
265265266266- Further nginx configuration can be done by adapting <literal>services.nginx.virtualHosts.<name></literal>.
267267- See <xref linkend="opt-services.nginx.virtualHosts"/> for further information.
266266+ Further nginx configuration can be done by adapting `services.nginx.virtualHosts.<name>`.
267267+ See [](#opt-services.nginx.virtualHosts) for further information.
268268269269- Further apache2 configuration can be done by adapting <literal>services.httpd.virtualHosts.<name></literal>.
270270- See <xref linkend="opt-services.httpd.virtualHosts"/> for further information.
269269+ Further apache2 configuration can be done by adapting `services.httpd.virtualHosts.<name>`.
270270+ See [](#opt-services.httpd.virtualHosts) for further information.
271271 '';
272272 };
273273
+2-2
nixos/modules/services/web-apps/hedgedoc.nix
···150150 addDefaults = true;
151151 }
152152 '';
153153- description = ''
153153+ description = lib.mdDoc ''
154154 Specify the Content Security Policy which is passed to Helmet.
155155- For configuration details see <link xlink:href="https://helmetjs.github.io/docs/csp/"/>.
155155+ For configuration details see <https://helmetjs.github.io/docs/csp/>.
156156 '';
157157 };
158158 protocolUseSSL = mkOption {
+13-13
nixos/modules/services/web-apps/keycloak.nix
···210210 name = mkOption {
211211 type = str;
212212 default = "keycloak";
213213- description = ''
213213+ description = lib.mdDoc ''
214214 Database name to use when connecting to an external or
215215 manually provisioned database; has no effect when a local
216216 database is automatically provisioned.
217217218218- To use this with a local database, set <xref linkend="opt-services.keycloak.database.createLocally"/> to
219219- <literal>false</literal> and create the database and user
218218+ To use this with a local database, set [](#opt-services.keycloak.database.createLocally) to
219219+ `false` and create the database and user
220220 manually.
221221 '';
222222 };
···224224 username = mkOption {
225225 type = str;
226226 default = "keycloak";
227227- description = ''
227227+ description = lib.mdDoc ''
228228 Username to use when connecting to an external or manually
229229 provisioned database; has no effect when a local database is
230230 automatically provisioned.
231231232232- To use this with a local database, set <xref linkend="opt-services.keycloak.database.createLocally"/> to
233233- <literal>false</literal> and create the database and user
232232+ To use this with a local database, set [](#opt-services.keycloak.database.createLocally) to
233233+ `false` and create the database and user
234234 manually.
235235 '';
236236 };
···415415 }
416416 '';
417417418418- description = ''
418418+ description = lib.mdDoc ''
419419 Configuration options corresponding to parameters set in
420420- <filename>conf/keycloak.conf</filename>.
420420+ {file}`conf/keycloak.conf`.
421421422422- Most available options are documented at <link xlink:href="https://www.keycloak.org/server/all-config"/>.
422422+ Most available options are documented at <https://www.keycloak.org/server/all-config>.
423423424424 Options containing secret data should be set to an attribute
425425- set containing the attribute <literal>_secret</literal> - a
425425+ set containing the attribute `_secret` - a
426426 string pointing to a file containing the value the option
427427 should be set to. See the example to get a better picture of
428428 this: in the resulting
429429- <filename>conf/keycloak.conf</filename> file, the
430430- <literal>https-key-store-password</literal> key will be set
429429+ {file}`conf/keycloak.conf` file, the
430430+ `https-key-store-password` key will be set
431431 to the contents of the
432432- <filename>/run/keys/store_password</filename> file.
432432+ {file}`/run/keys/store_password` file.
433433 '';
434434 };
435435 };
+9-9
nixos/modules/services/web-apps/mastodon.nix
···197197 };
198198199199 vapidPublicKeyFile = lib.mkOption {
200200- description = ''
200200+ description = lib.mdDoc ''
201201 Path to file containing the public key used for Web Push
202202 Voluntary Application Server Identification. A new keypair can
203203 be generated by running:
204204205205- <literal>nix build -f '<nixpkgs>' mastodon; cd result; bin/rake webpush:generate_keys</literal>
205205+ `nix build -f '<nixpkgs>' mastodon; cd result; bin/rake webpush:generate_keys`
206206207207- If <option>mastodon.vapidPrivateKeyFile</option>does not
207207+ If {option}`mastodon.vapidPrivateKeyFile`does not
208208 exist, it and this file will be created with a new keypair.
209209 '';
210210 default = "/var/lib/mastodon/secrets/vapid-public-key";
···218218 };
219219220220 secretKeyBaseFile = lib.mkOption {
221221- description = ''
221221+ description = lib.mdDoc ''
222222 Path to file containing the secret key base.
223223 A new secret key base can be generated by running:
224224225225- <literal>nix build -f '<nixpkgs>' mastodon; cd result; bin/rake secret</literal>
225225+ `nix build -f '<nixpkgs>' mastodon; cd result; bin/rake secret`
226226227227 If this file does not exist, it will be created with a new secret key base.
228228 '';
···231231 };
232232233233 otpSecretFile = lib.mkOption {
234234- description = ''
234234+ description = lib.mdDoc ''
235235 Path to file containing the OTP secret.
236236 A new OTP secret can be generated by running:
237237238238- <literal>nix build -f '<nixpkgs>' mastodon; cd result; bin/rake secret</literal>
238238+ `nix build -f '<nixpkgs>' mastodon; cd result; bin/rake secret`
239239240240 If this file does not exist, it will be created with a new OTP secret.
241241 '';
···244244 };
245245246246 vapidPrivateKeyFile = lib.mkOption {
247247- description = ''
247247+ description = lib.mdDoc ''
248248 Path to file containing the private key used for Web Push
249249 Voluntary Application Server Identification. A new keypair can
250250 be generated by running:
251251252252- <literal>nix build -f '<nixpkgs>' mastodon; cd result; bin/rake webpush:generate_keys</literal>
252252+ `nix build -f '<nixpkgs>' mastodon; cd result; bin/rake webpush:generate_keys`
253253254254 If this file does not exist, it will be created with a new
255255 private key.
+12-12
nixos/modules/services/web-apps/nextcloud.nix
···9393 type = types.str;
9494 default = config.services.nextcloud.home;
9595 defaultText = literalExpression "config.services.nextcloud.home";
9696- description = ''
9797- Data storage path of nextcloud. Will be <xref linkend="opt-services.nextcloud.home"/> by default.
9696+ description = lib.mdDoc ''
9797+ Data storage path of nextcloud. Will be [](#opt-services.nextcloud.home) by default.
9898 This folder will be populated with a config.php and data folder which contains the state of the instance (excl the database).";
9999 '';
100100 example = "/mnt/nextcloud-file";
···102102 extraApps = mkOption {
103103 type = types.attrsOf types.package;
104104 default = { };
105105- description = ''
105105+ description = lib.mdDoc ''
106106 Extra apps to install. Should be an attrSet of appid to packages generated by fetchNextcloudApp.
107107 The appid must be identical to the "id" value in the apps appinfo/info.xml.
108108- Using this will disable the appstore to prevent Nextcloud from updating these apps (see <xref linkend="opt-services.nextcloud.appstoreEnable"/>).
108108+ Using this will disable the appstore to prevent Nextcloud from updating these apps (see [](#opt-services.nextcloud.appstoreEnable)).
109109 '';
110110 example = literalExpression ''
111111 {
···127127 extraAppsEnable = mkOption {
128128 type = types.bool;
129129 default = true;
130130- description = ''
131131- Automatically enable the apps in <xref linkend="opt-services.nextcloud.extraApps"/> every time nextcloud starts.
130130+ description = lib.mdDoc ''
131131+ Automatically enable the apps in [](#opt-services.nextcloud.extraApps) every time nextcloud starts.
132132 If set to false, apps need to be enabled in the Nextcloud user interface or with nextcloud-occ app:enable.
133133 '';
134134 };
···136136 type = types.nullOr types.bool;
137137 default = null;
138138 example = true;
139139- description = ''
139139+ description = lib.mdDoc ''
140140 Allow the installation of apps and app updates from the store.
141141- Enabled by default unless there are packages in <xref linkend="opt-services.nextcloud.extraApps"/>.
142142- Set to true to force enable the store even if <xref linkend="opt-services.nextcloud.extraApps"/> is used.
141141+ Enabled by default unless there are packages in [](#opt-services.nextcloud.extraApps).
142142+ Set to true to force enable the store even if [](#opt-services.nextcloud.extraApps) is used.
143143 Set to false to disable the installation of apps from the global appstore. App management is always enabled regardless of this setting.
144144 '';
145145 };
···585585 hstsMaxAge = mkOption {
586586 type = types.ints.positive;
587587 default = 15552000;
588588- description = ''
589589- Value for the <literal>max-age</literal> directive of the HTTP
590590- <literal>Strict-Transport-Security</literal> header.
588588+ description = lib.mdDoc ''
589589+ Value for the `max-age` directive of the HTTP
590590+ `Strict-Transport-Security` header.
591591592592 See section 6.1.1 of IETF RFC 6797 for detailed information on this
593593 directive and header.
+2-2
nixos/modules/services/web-apps/node-red.nix
···4747 type = types.path;
4848 default = "${cfg.package}/lib/node_modules/node-red/settings.js";
4949 defaultText = literalExpression ''"''${package}/lib/node_modules/node-red/settings.js"'';
5050- description = ''
5050+ description = lib.mdDoc ''
5151 Path to the JavaScript configuration file.
5252- See <link xlink:href="https://github.com/node-red/node-red/blob/master/packages/node_modules/node-red/settings.js"/>
5252+ See <https://github.com/node-red/node-red/blob/master/packages/node_modules/node-red/settings.js>
5353 for a configuration example.
5454 '';
5555 };
+1-1
nixos/modules/services/web-apps/trilium.nix
···5353 noAuthentication = mkOption {
5454 type = types.bool;
5555 default = false;
5656- description = ''
5656+ description = lib.mdDoc ''
5757 If set to true, no password is required to access the web frontend.
5858 '';
5959 };
···170170 supportDDC = mkOption {
171171 type = types.bool;
172172 default = false;
173173- description = ''
173173+ description = lib.mdDoc ''
174174 Support setting monitor brightness via DDC.
175175176176 This is not needed for controlling brightness of the internal monitor
···5555 enable = mkOption {
5656 type = types.bool;
5757 default = false;
5858- description = ''
5858+ description = lib.mdDoc ''
5959 Whether to enable lightdm-mini-greeter as the lightdm greeter.
60606161 Note that this greeter starts only the default X session.
6262 You can configure the default X session using
6363- <xref linkend="opt-services.xserver.displayManager.defaultSession"/>.
6363+ [](#opt-services.xserver.displayManager.defaultSession).
6464 '';
6565 };
6666
···1717 enable = mkOption {
1818 type = types.bool;
1919 default = false;
2020- description = ''
2020+ description = lib.mdDoc ''
2121 Whether to enable lightdm-tiny-greeter as the lightdm greeter.
22222323 Note that this greeter starts only the default X session.
2424 You can configure the default X session using
2525- <xref linkend="opt-services.xserver.displayManager.defaultSession"/>.
2525+ [](#opt-services.xserver.displayManager.defaultSession).
2626 '';
2727 };
2828
···2424 gestures = mkOption {
2525 default = false;
2626 type = types.bool;
2727- description = "Whether or not to enable libstroke for gesture support";
2727+ description = lib.mdDoc "Whether or not to enable libstroke for gesture support";
2828 };
2929 };
3030 };
+5-5
nixos/modules/system/boot/initrd-network.nix
···5050 boot.initrd.network.enable = mkOption {
5151 type = types.bool;
5252 default = false;
5353- description = ''
5353+ description = lib.mdDoc ''
5454 Add network connectivity support to initrd. The network may be
5555- configured using the <literal>ip</literal> kernel parameter,
5656- as described in <link xlink:href="https://www.kernel.org/doc/Documentation/filesystems/nfs/nfsroot.txt">the kernel documentation</link>.
5555+ configured using the `ip` kernel parameter,
5656+ as described in [the kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/nfs/nfsroot.txt).
5757 Otherwise, if
5858- <option>networking.useDHCP</option> is enabled, an IP address
5858+ {option}`networking.useDHCP` is enabled, an IP address
5959 is acquired using DHCP.
60606161 You should add the module(s) required for your network card to
6262 boot.initrd.availableKernelModules.
6363- <literal>lspci -v | grep -iA8 'network\|ethernet'</literal>
6363+ `lspci -v | grep -iA8 'network\|ethernet'`
6464 will tell you which.
6565 '';
6666 };
+2-2
nixos/modules/system/boot/luksroot.nix
···548548 boot.initrd.luks.devices = mkOption {
549549 default = { };
550550 example = { luksroot.device = "/dev/disk/by-uuid/430e9eff-d852-4f68-aa3b-2fa3599ebe08"; };
551551- description = ''
551551+ description = lib.mdDoc ''
552552 The encrypted disk that should be opened before the root
553553 filesystem is mounted. Both LVM-over-LUKS and LUKS-over-LVM
554554 setups are supported. The unencrypted devices can be accessed as
555555- <filename>/dev/mapper/«name»</filename>.
555555+ {file}`/dev/mapper/«name»`.
556556 '';
557557558558 type = with types; attrsOf (submodule (
+3-3
nixos/modules/system/boot/networkd.nix
···19041904 };
1905190519061906 extraArgs = mkOption {
19071907- description = ''
19071907+ description = lib.mdDoc ''
19081908 Extra command-line arguments to pass to systemd-networkd-wait-online.
19091909- These also affect per-interface <literal>systemd-network-wait-online@</literal> services.
19091909+ These also affect per-interface `systemd-network-wait-online@` services.
1910191019111911- See <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd-networkd-wait-online.service.html"><citerefentry><refentrytitle>systemd-networkd-wait-online.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></link> for all available options.
19111911+ See [{manpage}`systemd-networkd-wait-online.service(8)`](https://www.freedesktop.org/software/systemd/man/systemd-networkd-wait-online.service.html) for all available options.
19121912 '';
19131913 type = with types; listOf str;
19141914 default = [];
+3-3
nixos/modules/system/boot/systemd/logind.nix
···2626 services.logind.killUserProcesses = mkOption {
2727 default = false;
2828 type = types.bool;
2929- description = ''
2929+ description = lib.mdDoc ''
3030 Specifies whether the processes of a user should be killed
3131 when the user logs out. If true, the scope unit corresponding
3232 to the session and all processes inside that scope will be
3333 terminated. If false, the scope is "abandoned" (see
3434- <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.scope.html#">systemd.scope(5)</link>), and processes are not killed.
3434+ [systemd.scope(5)](https://www.freedesktop.org/software/systemd/man/systemd.scope.html#)), and processes are not killed.
35353636- See <link xlink:href="https://www.freedesktop.org/software/systemd/man/logind.conf.html#KillUserProcesses=">logind.conf(5)</link>
3636+ See [logind.conf(5)](https://www.freedesktop.org/software/systemd/man/logind.conf.html#KillUserProcesses=)
3737 for more details.
3838 '';
3939 };
+5-5
nixos/modules/system/boot/systemd/tmpfiles.nix
···2525 default = [];
2626 example = literalExpression "[ pkgs.lvm2 ]";
2727 apply = map getLib;
2828- description = ''
2929- List of packages containing <command>systemd-tmpfiles</command> rules.
2828+ description = lib.mdDoc ''
2929+ List of packages containing {command}`systemd-tmpfiles` rules.
30303131 All files ending in .conf found in
3232- <filename>«pkg»/lib/tmpfiles.d</filename>
3232+ {file}`«pkg»/lib/tmpfiles.d`
3333 will be included.
3434 If this folder does not exist or does not contain any files an error will be returned instead.
35353636- If a <filename>lib</filename> output is available, rules are searched there and only there.
3737- If there is no <filename>lib</filename> output it will fall back to <filename>out</filename>
3636+ If a {file}`lib` output is available, rules are searched there and only there.
3737+ If there is no {file}`lib` output it will fall back to {file}`out`
3838 and if that does not exist either, the default output will be used.
3939 '';
4040 };
+3-3
nixos/modules/tasks/auto-upgrade.nix
···2525 type = types.enum ["switch" "boot"];
2626 default = "switch";
2727 example = "boot";
2828- description = ''
2828+ description = lib.mdDoc ''
2929 Whether to run
3030- <literal>nixos-rebuild switch --upgrade</literal> or run
3131- <literal>nixos-rebuild boot --upgrade</literal>
3030+ `nixos-rebuild switch --upgrade` or run
3131+ `nixos-rebuild boot --upgrade`
3232 '';
3333 };
3434
···2525 powerManagement.scsiLinkPolicy = mkOption {
2626 default = null;
2727 type = types.nullOr (types.enum allowedValues);
2828- description = ''
2828+ description = lib.mdDoc ''
2929 SCSI link power management policy. The kernel default is
3030 "max_performance".
3131
+6-6
nixos/modules/virtualisation/nixos-containers.nix
···579579 privateNetwork = mkOption {
580580 type = types.bool;
581581 default = false;
582582- description = ''
582582+ description = lib.mdDoc ''
583583 Whether to give the container its own private virtual
584584 Ethernet interface. The interface is called
585585- <literal>eth0</literal>, and is hooked up to the interface
586586- <literal>ve-«container-name»</literal>
585585+ `eth0`, and is hooked up to the interface
586586+ `ve-«container-name»`
587587 on the host. If this option is not set, then the
588588 container shares the network interfaces of the host,
589589 and can bind to any port on any interface.
···728728 };
729729 }
730730 '';
731731- description = ''
731731+ description = lib.mdDoc ''
732732 A set of NixOS system configurations to be run as lightweight
733733 containers. Each container appears as a service
734734- <literal>container-«name»</literal>
734734+ `container-«name»`
735735 on the host system, allowing it to be started and stopped via
736736- <command>systemctl</command>.
736736+ {command}`systemctl`.
737737 '';
738738 };
739739