···1212 backups. It consists of a series of retention periodes to interval
1313 associations:
14141515- <literal>
1515+ ```
1616 retA=>intA,retB=>intB,...
1717- </literal>
1717+ ```
18181919 Both intervals and retention periods are expressed in standard units
2020 of time or multiples of them. You can use both the full name or a
2121 shortcut according to the following listing:
22222323- <literal>
2323+ ```
2424 second|sec|s, minute|min, hour|h, day|d, week|w, month|mon|m, year|y
2525- </literal>
2525+ ```
26262727- See <citerefentry><refentrytitle>znapzendzetup</refentrytitle><manvolnum>1</manvolnum></citerefentry> for more info.
2727+ See {manpage}`znapzendzetup(1)` for more info.
2828 '';
2929 planExample = "1h=>10min,1d=>1h,1w=>1d,1m=>1w,1y=>1m";
3030···57575858 plan = mkOption {
5959 type = str;
6060- description = planDescription;
6060+ description = lib.mdDoc planDescription;
6161 example = planExample;
6262 };
6363···209209210210 plan = mkOption {
211211 type = str;
212212- description = planDescription;
212212+ description = lib.mdDoc planDescription;
213213 example = planExample;
214214 };
215215
+3-3
nixos/modules/services/development/zammad.nix
···137137 {
138138 }
139139 '';
140140- description = ''
141141- The <filename>database.yml</filename> configuration file as key value set.
142142- See <link xlink:href="TODO"/>
140140+ description = lib.mdDoc ''
141141+ The {file}`database.yml` configuration file as key value set.
142142+ See \<TODO\>
143143 for list of configuration parameters.
144144 '';
145145 };
+2-2
nixos/modules/services/games/teeworlds.nix
···8080 extraOptions = mkOption {
8181 type = types.listOf types.str;
8282 default = [];
8383- description = ''
8484- Extra configuration lines for the <filename>teeworlds.cfg</filename>. See <link xlink:href="https://www.teeworlds.com/?page=docs&wiki=server_settings">Teeworlds Documentation</link>.
8383+ description = lib.mdDoc ''
8484+ Extra configuration lines for the {file}`teeworlds.cfg`. See [Teeworlds Documentation](https://www.teeworlds.com/?page=docs&wiki=server_settings).
8585 '';
8686 example = [ "sv_map dm1" "sv_gametype dm" ];
8787 };
+2-2
nixos/modules/services/mail/pfix-srsd.nix
···2222 };
23232424 secretsFile = mkOption {
2525- description = ''
2525+ description = lib.mdDoc ''
2626 The secret data used to encode the SRS address.
2727 to generate, use a command like:
2828- <literal>for n in $(seq 5); do dd if=/dev/urandom count=1 bs=1024 status=none | sha256sum | sed 's/ -$//' | sed 's/^/ /'; done</literal>
2828+ `for n in $(seq 5); do dd if=/dev/urandom count=1 bs=1024 status=none | sha256sum | sed 's/ -$//' | sed 's/^/ /'; done`
2929 '';
3030 type = types.path;
3131 default = "/var/lib/pfix-srsd/secrets";
+12-9
nixos/modules/services/mail/spamassassin.nix
···22222323 config = mkOption {
2424 type = types.lines;
2525- description = ''
2525+ description = lib.mdDoc ''
2626 The SpamAssassin local.cf config
27272828 If you are using this configuration:
2929- add_header all Status _YESNO_, score=_SCORE_ required=_REQD_ tests=_TESTS_ autolearn=_AUTOLEARN_ version=_VERSION_
2929+3030+ add_header all Status _YESNO_, score=_SCORE_ required=_REQD_ tests=_TESTS_ autolearn=_AUTOLEARN_ version=_VERSION_
30313132 Then you can Use this sieve filter:
3232- require ["fileinto", "reject", "envelope"];
3333+3434+ require ["fileinto", "reject", "envelope"];
33353434- if header :contains "X-Spam-Flag" "YES" {
3535- fileinto "spam";
3636- }
3636+ if header :contains "X-Spam-Flag" "YES" {
3737+ fileinto "spam";
3838+ }
37393840 Or this procmail filter:
3939- :0:
4040- * ^X-Spam-Flag: YES
4141- /var/vpopmail/domains/lastlog.de/js/.maildir/.spam/new
4141+4242+ :0:
4343+ * ^X-Spam-Flag: YES
4444+ /var/vpopmail/domains/lastlog.de/js/.maildir/.spam/new
42454346 To filter your messages based on the additional mail headers added by spamassassin.
4447 '';
+4-4
nixos/modules/services/misc/autorandr.nix
···149149 };
150150 };
151151 });
152152- description = ''
152152+ description = lib.mdDoc ''
153153 Output scale configuration.
154154155155 Either configure by pixels or a scaling factor. When using pixel method the
156156- <citerefentry><refentrytitle>xrandr</refentrytitle><manvolnum>1</manvolnum></citerefentry>
156156+ {manpage}`xrandr(1)`
157157 option
158158- <parameter class="command">--scale-from</parameter>
158158+ `--scale-from`
159159 will be used; when using factor method the option
160160- <parameter class="command">--scale</parameter>
160160+ `--scale`
161161 will be used.
162162163163 This option is a shortcut version of the transform option and they are mutually
+6-6
nixos/modules/services/misc/gitea.nix
···322322 };
323323324324 service = {
325325- DISABLE_REGISTRATION = mkEnableOption "the registration lock" // {
326326- description = ''
327327- By default any user can create an account on this <literal>gitea</literal> instance.
325325+ DISABLE_REGISTRATION = mkEnableOption (lib.mdDoc "the registration lock") // {
326326+ description = lib.mdDoc ''
327327+ By default any user can create an account on this `gitea` instance.
328328 This can be disabled by using this option.
329329330330- <emphasis>Note:</emphasis> please keep in mind that this should be added after the initial
331331- deploy unless <link linkend="opt-services.gitea.useWizard">services.gitea.useWizard</link>
332332- is <literal>true</literal> as the first registered user will be the administrator if
330330+ *Note:* please keep in mind that this should be added after the initial
331331+ deploy unless [](#opt-services.gitea.useWizard)
332332+ is `true` as the first registered user will be the administrator if
333333 no install wizard is used.
334334 '';
335335 };
+3-3
nixos/modules/services/misc/gitit.nix
···211211 templatesDir = mkOption {
212212 type = types.path;
213213 default = gititShared + "/data/templates";
214214- description = ''
214214+ description = lib.mdDoc ''
215215 Specifies the path of the directory containing page templates. If it
216216 does not exist, gitit will create it with default templates. Users
217217 may wish to edit the templates to customize the appearance of their
···490490 absoluteUrls = mkOption {
491491 type = types.bool;
492492 default = false;
493493- description = ''
493493+ description = lib.mdDoc ''
494494 Make wikilinks absolute with respect to the base-url. So, for
495495 example, in a wiki served at the base URL '/wiki', on a page
496496- Sub/Page, the wikilink '[Cactus]()' will produce a link to
496496+ Sub/Page, the wikilink `[Cactus]()` will produce a link to
497497 '/wiki/Cactus' if absoluteUrls is true, and a relative link to
498498 'Cactus' (referring to '/wiki/Sub/Cactus') if absolute-urls is 'no'.
499499 '';
+6-6
nixos/modules/services/misc/nix-daemon.nix
···628628 sandbox-paths = { "/bin/sh" = "''${pkgs.busybox-sandbox-shell.out}/bin/busybox"; };
629629 }
630630 '';
631631- description = ''
631631+ description = lib.mdDoc ''
632632 Configuration for Nix, see
633633- <link xlink:href="https://nixos.org/manual/nix/stable/#sec-conf-file"/> or
634634- <citerefentry><refentrytitle>nix.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> for avalaible options.
633633+ <https://nixos.org/manual/nix/stable/#sec-conf-file> or
634634+ {manpage}`nix.conf(5)` for avalaible options.
635635 The value declared here will be translated directly to the key-value pairs Nix expects.
636636637637- You can use <command>nix-instantiate --eval --strict '<nixpkgs/nixos>' -A config.nix.settings</command>
637637+ You can use {command}`nix-instantiate --eval --strict '<nixpkgs/nixos>' -A config.nix.settings`
638638 to view the current value. By default it is empty.
639639640640- Nix configurations defined under <option>nix.*</option> will be translated and applied to this
641641- option. In addition, configuration specified in <option>nix.extraOptions</option> which will be appended
640640+ Nix configurations defined under {option}`nix.*` will be translated and applied to this
641641+ option. In addition, configuration specified in {option}`nix.extraOptions` which will be appended
642642 verbatim to the resulting config file.
643643 '';
644644 };
+6-6
nixos/modules/services/misc/persistent-evdev.nix
···1616 devices = lib.mkOption {
1717 default = {};
1818 type = with lib.types; attrsOf str;
1919- description = ''
1919+ description = lib.mdDoc ''
2020 A set of virtual proxy device labels with backing physical device ids.
21212222- Physical devices should already exist in <filename class="devicefile">/dev/input/by-id/</filename>.
2323- Proxy devices will be automatically given a <literal>uinput-</literal> prefix.
2222+ Physical devices should already exist in {file}`/dev/input/by-id/`.
2323+ Proxy devices will be automatically given a `uinput-` prefix.
24242525- See the <link xlink:href="https://github.com/aiberia/persistent-evdev#example-usage-with-libvirt">project page</link>
2525+ See the [project page](https://github.com/aiberia/persistent-evdev#example-usage-with-libvirt)
2626 for example configuration of virtual devices with libvirt
2727- and remember to add <literal>uinput-*</literal> devices to the qemu
2828- <literal>cgroup_device_acl</literal> list (see <xref linkend="opt-virtualisation.libvirtd.qemu.verbatimConfig"/>).
2727+ and remember to add `uinput-*` devices to the qemu
2828+ `cgroup_device_acl` list (see [](#opt-virtualisation.libvirtd.qemu.verbatimConfig)).
2929 '';
3030 example = lib.literalExpression ''
3131 {
···115115 example = literalExpression ''
116116 "-i eth0 -p tcp -m tcp --dport ${toString port}"
117117 '';
118118- description = ''
118118+ description = lib.mdDoc ''
119119 Specify a filter for iptables to use when
120120- <option>services.prometheus.exporters.${name}.openFirewall</option>
121121- is true. It is used as `ip46tables -I nixos-fw <option>firewallFilter</option> -j nixos-fw-accept`.
120120+ {option}`services.prometheus.exporters.${name}.openFirewall`
121121+ is true. It is used as `ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept`.
122122 '';
123123 };
124124 user = mkOption {
+2-2
nixos/modules/services/monitoring/smartd.nix
···135135 default = "root";
136136 example = "example@domain.tld";
137137 type = types.str;
138138- description = ''
138138+ description = lib.mdDoc ''
139139 Sender of the notification messages.
140140- Acts as the value of <literal>email</literal> in the emails' <literal>From: ... </literal> field.
140140+ Acts as the value of `email` in the emails' `From: ...` field.
141141 '';
142142 };
143143
+2-2
nixos/modules/services/networking/3proxy.nix
···155155 type = types.listOf types.str;
156156 default = [ ];
157157 example = [ "127.0.0.1" "192.168.1.0/24" ];
158158- description = ''
158158+ description = lib.mdDoc ''
159159 List of target IP ranges, use empty list for any.
160160 May also contain host names instead of addresses.
161161- It's possible to use wildmask in the begginning and in the the end of hostname, e.g. *badsite.com or *badcontent*.
161161+ It's possible to use wildmask in the begginning and in the the end of hostname, e.g. `*badsite.com` or `*badcontent*`.
162162 Hostname is only checked if hostname presents in request.
163163 '';
164164 };
···327327 type = mkOption {
328328 type = types.enum (attrNames dispatcherTypesSubdirMap);
329329 default = "basic";
330330- description = ''
330330+ description = lib.mdDoc ''
331331 Dispatcher hook type. Look up the hooks described at
332332- <link xlink:href="https://developer.gnome.org/NetworkManager/stable/NetworkManager.html">https://developer.gnome.org/NetworkManager/stable/NetworkManager.html</link>
332332+ [https://developer.gnome.org/NetworkManager/stable/NetworkManager.html](https://developer.gnome.org/NetworkManager/stable/NetworkManager.html)
333333 and choose the type depending on the output folder.
334334 You should then filter the event type (e.g., "up"/"down") from within your script.
335335 '';
+13-12
nixos/modules/services/networking/wireguard.nix
···194194 default = null;
195195 example = "demo.wireguard.io:12913";
196196 type = with types; nullOr str;
197197- description = ''Endpoint IP or hostname of the peer, followed by a colon,
198198- and then a port number of the peer.
197197+ description = lib.mdDoc ''
198198+ Endpoint IP or hostname of the peer, followed by a colon,
199199+ and then a port number of the peer.
199200200200- Warning for endpoints with changing IPs:
201201- The WireGuard kernel side cannot perform DNS resolution.
202202- Thus DNS resolution is done once by the <literal>wg</literal> userspace
203203- utility, when setting up WireGuard. Consequently, if the IP address
204204- behind the name changes, WireGuard will not notice.
205205- This is especially common for dynamic-DNS setups, but also applies to
206206- any other DNS-based setup.
207207- If you do not use IP endpoints, you likely want to set
208208- <option>networking.wireguard.dynamicEndpointRefreshSeconds</option>
209209- to refresh the IPs periodically.
201201+ Warning for endpoints with changing IPs:
202202+ The WireGuard kernel side cannot perform DNS resolution.
203203+ Thus DNS resolution is done once by the `wg` userspace
204204+ utility, when setting up WireGuard. Consequently, if the IP address
205205+ behind the name changes, WireGuard will not notice.
206206+ This is especially common for dynamic-DNS setups, but also applies to
207207+ any other DNS-based setup.
208208+ If you do not use IP endpoints, you likely want to set
209209+ {option}`networking.wireguard.dynamicEndpointRefreshSeconds`
210210+ to refresh the IPs periodically.
210211 '';
211212 };
212213
+8-8
nixos/modules/services/networking/znc/default.nix
···149149 };
150150 }
151151 '';
152152- description = ''
152152+ description = lib.mdDoc ''
153153 Configuration for ZNC, see
154154- <link xlink:href="https://wiki.znc.in/Configuration"/> for details. The
154154+ <https://wiki.znc.in/Configuration> for details. The
155155 Nix value declared here will be translated directly to the xml-like
156156 format ZNC expects. This is much more flexible than the legacy options
157157- under <option>services.znc.confOptions.*</option>, but also can't do
157157+ under {option}`services.znc.confOptions.*`, but also can't do
158158 any type checking.
159159160160- You can use <command>nix-instantiate --eval --strict '<nixpkgs/nixos>' -A config.services.znc.config</command>
160160+ You can use {command}`nix-instantiate --eval --strict '<nixpkgs/nixos>' -A config.services.znc.config`
161161 to view the current value. By default it contains a listener for port
162162 5000 with SSL enabled.
163163164164- Nix attributes called <literal>extraConfig</literal> will be inserted
164164+ Nix attributes called `extraConfig` will be inserted
165165 verbatim into the resulting config file.
166166167167- If <option>services.znc.useLegacyConfig</option> is turned on, the
168168- option values in <option>services.znc.confOptions.*</option> will be
167167+ If {option}`services.znc.useLegacyConfig` is turned on, the
168168+ option values in {option}`services.znc.confOptions.*` will be
169169 gracefully be applied to this option.
170170171171 If you intend to update the configuration through this option, be sure
172172- to enable <option>services.znc.mutable</option>, otherwise none of the
172172+ to enable {option}`services.znc.mutable`, otherwise none of the
173173 changes here will be applied after the initial deploy.
174174 '';
175175 };
+8-8
nixos/modules/services/networking/znc/options.nix
···9797 useLegacyConfig = mkOption {
9898 default = true;
9999 type = types.bool;
100100- description = ''
100100+ description = lib.mdDoc ''
101101 Whether to propagate the legacy options under
102102- <option>services.znc.confOptions.*</option> to the znc config. If this
102102+ {option}`services.znc.confOptions.*` to the znc config. If this
103103 is turned on, the znc config will contain a user with the default name
104104 "znc", global modules "webadmin" and "adminlog" will be enabled by
105105 default, and more, all controlled through the
106106- <option>services.znc.confOptions.*</option> options.
107107- You can use <command>nix-instantiate --eval --strict '<nixpkgs/nixos>' -A config.services.znc.config</command>
106106+ {option}`services.znc.confOptions.*` options.
107107+ You can use {command}`nix-instantiate --eval --strict '<nixpkgs/nixos>' -A config.services.znc.config`
108108 to view the current value of the config.
109109110110 In any case, if you need more flexibility,
111111- <option>services.znc.config</option> can be used to override/add to
111111+ {option}`services.znc.config` can be used to override/add to
112112 all of the legacy options.
113113 '';
114114 };
···177177 </Pass>
178178 '';
179179 type = types.str;
180180- description = ''
181181- Generate with <command>nix-shell -p znc --command "znc --makepass"</command>.
180180+ description = lib.mdDoc ''
181181+ Generate with {command}`nix-shell -p znc --command "znc --makepass"`.
182182 This is the password used to log in to the ZNC web admin interface.
183183 You can also set this through
184184- <option>services.znc.config.User.<username>.Pass.Method</option>
184184+ {option}`services.znc.config.User.<username>.Pass.Method`
185185 and co.
186186 '';
187187 };
+5-5
nixos/modules/services/security/tor.nix
···288288 };
289289290290 relay = {
291291- enable = mkEnableOption "tor relaying" // {
292292- description = ''
291291+ enable = mkEnableOption (lib.mdDoc "tor relaying") // {
292292+ description = lib.mdDoc ''
293293 Whether to enable relaying of Tor traffic for others.
294294295295- See <link xlink:href="https://www.torproject.org/docs/tor-doc-relay"/>
295295+ See <https://www.torproject.org/docs/tor-doc-relay>
296296 for details.
297297298298 Setting this to true requires setting
299299- <option>services.tor.relay.role</option>
299299+ {option}`services.tor.relay.role`
300300 and
301301- <option>services.tor.settings.ORPort</option>
301301+ {option}`services.tor.settings.ORPort`
302302 options.
303303 '';
304304 };
···9797 SMTP_FROM_NAME = "example.com Bitwarden server";
9898 }
9999 '';
100100- description = ''
100100+ description = lib.mdDoc ''
101101 The configuration of vaultwarden is done through environment variables,
102102- therefore it is recommended to use upper snake case (e.g. <envar>DISABLE_2FA_REMEMBER</envar>).
102102+ therefore it is recommended to use upper snake case (e.g. {env}`DISABLE_2FA_REMEMBER`).
103103104104- However, camel case (e.g. <literal>disable2FARemember</literal>) is also supported:
104104+ However, camel case (e.g. `disable2FARemember`) is also supported:
105105 The NixOS module will convert it automatically to
106106- upper case snake case (e.g. <envar>DISABLE_2FA_REMEMBER</envar>).
106106+ upper case snake case (e.g. {env}`DISABLE_2FA_REMEMBER`).
107107 In this conversion digits (0-9) are handled just like upper case characters,
108108- so <literal>foo2</literal> would be converted to <envar>FOO_2</envar>.
109109- Names already in this format remain unchanged, so <literal>FOO2</literal> remains <literal>FOO2</literal> if passed as such,
110110- even though <literal>foo2</literal> would have been converted to <envar>FOO_2</envar>.
108108+ so `foo2` would be converted to {env}`FOO_2`.
109109+ Names already in this format remain unchanged, so `FOO2` remains `FOO2` if passed as such,
110110+ even though `foo2` would have been converted to {env}`FOO_2`.
111111 This allows working around any potential future conflicting naming conventions.
112112113113 Based on the attributes passed to this config option an environment file will be generated
114114 that is passed to vaultwarden's systemd service.
115115116116 The available configuration options can be found in
117117- <link xlink:href="https://github.com/dani-garcia/vaultwarden/blob/${vaultwarden.version}/.env.template">the environment template file</link>.
117117+ [the environment template file](https://github.com/dani-garcia/vaultwarden/blob/${vaultwarden.version}/.env.template).
118118119119- See <xref linkend="opt-services.vaultwarden.environmentFile"/> for how
119119+ See ()[#opt-services.vaultwarden.environmentFile) for how
120120 to set up access to the Admin UI to invite initial users.
121121 '';
122122 };
+6-6
nixos/modules/services/torrent/transmission.nix
···2424 ];
2525 options = {
2626 services.transmission = {
2727- enable = mkEnableOption "transmission" // {
2828- description = ''
2727+ enable = mkEnableOption (lib.mdDoc "transmission") // {
2828+ description = lib.mdDoc ''
2929 Whether to enable the headless Transmission BitTorrent daemon.
30303131 Transmission daemon can be controlled via the RPC interface using
3232 transmission-remote, the WebUI (http://127.0.0.1:9091/ by default),
3333 or other clients like stig or tremc.
34343535- Torrents are downloaded to <xref linkend="opt-services.transmission.home"/>/${downloadsDir} by default and are
3535+ Torrents are downloaded to [](#opt-services.transmission.home)/${downloadsDir} by default and are
3636 accessible to users in the "transmission" group.
3737 '';
3838 };
···237237238238 openRPCPort = mkEnableOption (lib.mdDoc "opening of the RPC port in the firewall");
239239240240- performanceNetParameters = mkEnableOption "performance tweaks" // {
241241- description = ''
240240+ performanceNetParameters = mkEnableOption (lib.mdDoc "performance tweaks") // {
241241+ description = lib.mdDoc ''
242242 Whether to enable tweaking of kernel parameters
243243 to open many more connections at the same time.
244244245245 Note that you may also want to increase
246246- <literal>peer-limit-global"</literal>.
246246+ `peer-limit-global`.
247247 And be aware that these settings are quite aggressive
248248 and might not suite your regular desktop use.
249249 For instance, SSH sessions may time out more easily.
+9-4
nixos/modules/services/web-apps/dokuwiki.nix
···137137 usersFile = mkOption {
138138 type = with types; nullOr str;
139139 default = if config.aclUse then "/var/lib/dokuwiki/${name}/users.auth.php" else null;
140140- description = ''
140140+ description = lib.mdDoc ''
141141 Location of the dokuwiki users file. List of users. Format:
142142- login:passwordhash:Real Name:email:groups,comma,separated
143143- Create passwordHash easily by using:$ mkpasswd -5 password `pwgen 8 1`
144144- Example: <link xlink:href="https://github.com/splitbrain/dokuwiki/blob/master/conf/users.auth.php.dist"/>
142142+143143+ login:passwordhash:Real Name:email:groups,comma,separated
144144+145145+ Create passwordHash easily by using:
146146+147147+ mkpasswd -5 password `pwgen 8 1`
148148+149149+ Example: <https://github.com/splitbrain/dokuwiki/blob/master/conf/users.auth.php.dist>
145150 '';
146151 example = "/var/lib/dokuwiki/${name}/users.auth.php";
147152 };
+6-6
nixos/modules/services/web-apps/jirafeau.nix
···4545 $cfg['style'] = 'courgette';
4646 $cfg['organisation'] = 'ACME';
4747 '';
4848- description = let
4848+ description = let
4949 documentationLink =
5050 "https://gitlab.com/mojo42/Jirafeau/-/blob/${cfg.package.version}/lib/config.original.php";
5151 in
5252- ''
5353- Jirefeau configuration. Refer to <link xlink:href="${documentationLink}"/> for supported
5252+ lib.mdDoc ''
5353+ Jirefeau configuration. Refer to <${documentationLink}> for supported
5454 values.
5555 '';
5656 };
···7373 description = let
7474 nginxCoreDocumentation = "http://nginx.org/en/docs/http/ngx_http_core_module.html";
7575 in
7676- ''
7676+ lib.mdDoc ''
7777 Timeout for reading client request bodies and headers. Refer to
7878- <link xlink:href="${nginxCoreDocumentation}#client_body_timeout"/> and
7979- <link xlink:href="${nginxCoreDocumentation}#client_header_timeout"/> for accepted values.
7878+ <${nginxCoreDocumentation}#client_body_timeout> and
7979+ <${nginxCoreDocumentation}#client_header_timeout> for accepted values.
8080 '';
8181 };
8282
+6-6
nixos/modules/services/web-apps/mastodon.nix
···107107 enable = lib.mkEnableOption (lib.mdDoc "Mastodon, a federated social network server");
108108109109 configureNginx = lib.mkOption {
110110- description = ''
110110+ description = lib.mdDoc ''
111111 Configure nginx as a reverse proxy for mastodon.
112112 Note that this makes some assumptions on your setup, and sets settings that will
113113 affect other virtualHosts running on your nginx instance, if any.
114114 Alternatively you can configure a reverse-proxy of your choice to serve these paths:
115115116116- <literal>/ -> $(nix-instantiate --eval '<nixpkgs>' -A mastodon.outPath)/public</literal>
116116+ `/ -> $(nix-instantiate --eval '<nixpkgs>' -A mastodon.outPath)/public`
117117118118- <literal>/ -> 127.0.0.1:{{ webPort }} </literal>(If there was no file in the directory above.)
118118+ `/ -> 127.0.0.1:{{ webPort }} `(If there was no file in the directory above.)
119119120120- <literal>/system/ -> /var/lib/mastodon/public-system/</literal>
120120+ `/system/ -> /var/lib/mastodon/public-system/`
121121122122- <literal>/api/v1/streaming/ -> 127.0.0.1:{{ streamingPort }}</literal>
122122+ `/api/v1/streaming/ -> 127.0.0.1:{{ streamingPort }}`
123123124124 Make sure that websockets are forwarded properly. You might want to set up caching
125125 of some requests. Take a look at mastodon's provided nginx configuration at
126126- <literal>https://github.com/mastodon/mastodon/blob/master/dist/nginx.conf</literal>.
126126+ `https://github.com/mastodon/mastodon/blob/master/dist/nginx.conf`.
127127 '';
128128 type = lib.types.bool;
129129 default = false;
+3-3
nixos/modules/services/web-apps/matomo.nix
···5353 type = types.nullOr types.str;
5454 default = null;
5555 example = "lighttpd";
5656- description = ''
5757- Name of the web server user that forwards requests to <option>services.phpfpm.pools.<name>.socket</option> the fastcgi socket for Matomo if the nginx
5656+ description = lib.mdDoc ''
5757+ Name of the web server user that forwards requests to {option}`services.phpfpm.pools.<name>.socket` the fastcgi socket for Matomo if the nginx
5858 option is not used. Either this option or the nginx option is mandatory.
5959 If you want to use another webserver than nginx, you need to set this to that server's user
6060- and pass fastcgi requests to <literal>index.php</literal>, <literal>matomo.php</literal> and <literal>piwik.php</literal> (legacy name) to this socket.
6060+ and pass fastcgi requests to `index.php`, `matomo.php` and `piwik.php` (legacy name) to this socket.
6161 '';
6262 };
6363
···116116 useACMEHost = mkOption {
117117 type = types.nullOr types.str;
118118 default = null;
119119- description = ''
119119+ description = lib.mdDoc ''
120120 A host of an existing Let's Encrypt certificate to use.
121121 This is useful if you have many subdomains and want to avoid hitting the
122122- <link xlink:href="https://letsencrypt.org/docs/rate-limits/">rate limit</link>.
123123- Alternately, you can generate a certificate through <option>enableACME</option>.
124124- <emphasis>Note that this option does not create any certificates, nor it does add subdomains to existing ones – you will need to create them manually using <xref linkend="opt-security.acme.certs"/>.</emphasis>
122122+ [rate limit](https://letsencrypt.org/docs/rate-limits).
123123+ Alternately, you can generate a certificate through {option}`enableACME`.
124124+ *Note that this option does not create any certificates, nor it does add subdomains to existing ones – you will need to create them manually using [](#opt-security.acme.certs).*
125125 '';
126126 };
127127
···3636 frontend = mkOption {
3737 type = types.either types.str (types.listOf types.str);
3838 default = "[127.0.0.1]:443";
3939- description = ''
3939+ description = lib.mdDoc ''
4040 The port and interface of the listen endpoint in the
4141-+ form [HOST]:PORT[+CERT].
4141+ form [HOST]:PORT[+CERT].
4242 '';
4343 apply = toList;
4444 };
···7575 useACMEHost = mkOption {
7676 type = types.nullOr types.str;
7777 default = null;
7878- description = ''
7878+ description = lib.mdDoc ''
7979 A host of an existing Let's Encrypt certificate to use.
8080 This is useful if you have many subdomains and want to avoid hitting the
8181- <link xlink:href="https://letsencrypt.org/docs/rate-limits/">rate limit</link>.
8282- Alternately, you can generate a certificate through <option>enableACME</option>.
8383- <emphasis>Note that this option does not create any certificates, nor it does add subdomains to existing ones – you will need to create them manually using <xref linkend="opt-security.acme.certs"/>.</emphasis>
8181+ [rate limit](https://letsencrypt.org/docs/rate-limits).
8282+ Alternately, you can generate a certificate through {option}`enableACME`.
8383+ *Note that this option does not create any certificates, nor it does add subdomains to existing ones – you will need to create them manually using [](#opt-security.acme.certs).*
8484 '';
8585 };
8686
···8888 supportsDryActivation = mkOption
8989 { type = types.bool;
9090 default = false;
9191- description = ''
9191+ description = lib.mdDoc ''
9292 Whether this activation script supports being dry-activated.
9393 These activation scripts will also be executed on dry-activate
9494 activations with the environment variable
9595- <literal>NIXOS_ACTION</literal> being set to <literal>dry-activate</literal>.
9595+ `NIXOS_ACTION` being set to `dry-activate`.
9696 it's important that these activation scripts don't
9797 modify anything about the system when the variable is set.
9898 '';
+2-2
nixos/modules/system/boot/systemd/initrd.nix
···132132133133in {
134134 options.boot.initrd.systemd = {
135135- enable = mkEnableOption "systemd in initrd" // {
136136- description = ''
135135+ enable = mkEnableOption (lib.mdDoc "systemd in initrd") // {
136136+ description = lib.mdDoc ''
137137 Whether to enable systemd in initrd.
138138139139 Note: This is in very early development and is highly
+3-3
nixos/modules/virtualisation/kvmgt.nix
···1717in {
1818 options = {
1919 virtualisation.kvmgt = {
2020- enable = mkEnableOption ''
2020+ enable = mkEnableOption (lib.mdDoc ''
2121 KVMGT (iGVT-g) VGPU support. Allows Qemu/KVM guests to share host's Intel integrated graphics card.
2222 Currently only one graphical device can be shared. To allow users to access the device without root add them
2323- to the kvm group: <literal>users.extraUsers.<yourusername>.extraGroups = [ "kvm" ];</literal>
2424- '';
2323+ to the kvm group: `users.extraUsers.<yourusername>.extraGroups = [ "kvm" ];`
2424+ '');
2525 # multi GPU support is under the question
2626 device = mkOption {
2727 type = types.str;