diff options
Diffstat (limited to 'nixos/modules')
61 files changed, 140 insertions, 189 deletions
diff --git a/nixos/modules/config/i18n.nix b/nixos/modules/config/i18n.nix index 80ef515fbfe20..dad06c1b44cd8 100644 --- a/nixos/modules/config/i18n.nix +++ b/nixos/modules/config/i18n.nix @@ -75,8 +75,7 @@ with lib; List of locales that the system should support. The value <literal>"all"</literal> means that all locales supported by Glibc will be installed. A full list of supported locales - can be found at <link - xlink:href="https://sourceware.org/git/?p=glibc.git;a=blob;f=localedata/SUPPORTED"/>. + can be found at <link xlink:href="https://sourceware.org/git/?p=glibc.git;a=blob;f=localedata/SUPPORTED"/>. ''; }; diff --git a/nixos/modules/config/users-groups.nix b/nixos/modules/config/users-groups.nix index 446cc3698bef4..2e5984b55cc1f 100644 --- a/nixos/modules/config/users-groups.nix +++ b/nixos/modules/config/users-groups.nix @@ -156,8 +156,7 @@ let <filename>pam_mount.conf.xml</filename>. Useful attributes might include <literal>path</literal>, <literal>options</literal>, <literal>fstype</literal>, and <literal>server</literal>. - See <link - xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html" /> + See <link xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html"/> for more information. ''; }; diff --git a/nixos/modules/config/xdg/portal.nix b/nixos/modules/config/xdg/portal.nix index 1e6ddd7c4a26b..689abf267f090 100644 --- a/nixos/modules/config/xdg/portal.nix +++ b/nixos/modules/config/xdg/portal.nix @@ -33,7 +33,7 @@ in options.xdg.portal = { enable = - mkEnableOption "<link xlink:href='https://github.com/flatpak/xdg-desktop-portal'>xdg desktop integration</link>" // { + mkEnableOption ''<link xlink:href="https://github.com/flatpak/xdg-desktop-portal">xdg desktop integration</link>'' // { default = false; }; diff --git a/nixos/modules/hardware/tuxedo-keyboard.nix b/nixos/modules/hardware/tuxedo-keyboard.nix index 97af7c61f3c9a..7bcabde48900c 100644 --- a/nixos/modules/hardware/tuxedo-keyboard.nix +++ b/nixos/modules/hardware/tuxedo-keyboard.nix @@ -13,7 +13,7 @@ in To configure the driver, pass the options to the <option>boot.kernelParams</option> configuration. There are several parameters you can change. It's best to check at the source code description which options are supported. - You can find all the supported parameters at: <link xlink:href="https://github.com/tuxedocomputers/tuxedo-keyboard#kernelparam" /> + You can find all the supported parameters at: <link xlink:href="https://github.com/tuxedocomputers/tuxedo-keyboard#kernelparam"/> In order to use the <literal>custom</literal> lighting with the maximumg brightness and a color of <literal>0xff0a0a</literal> one would put pass <option>boot.kernelParams</option> like this: diff --git a/nixos/modules/programs/sway.nix b/nixos/modules/programs/sway.nix index decae1b4d2da2..af2b261d3c5f9 100644 --- a/nixos/modules/programs/sway.nix +++ b/nixos/modules/programs/sway.nix @@ -39,7 +39,7 @@ in { Sway, the i3-compatible tiling Wayland compositor. You can manually launch Sway by executing "exec sway" on a TTY. Copy /etc/sway/config to ~/.config/sway/config to modify the default configuration. See - <link xlink:href="https://github.com/swaywm/sway/wiki" /> and + <link xlink:href="https://github.com/swaywm/sway/wiki"/> and "man 5 sway" for more information''; wrapperFeatures = mkOption { diff --git a/nixos/modules/security/acme/default.nix b/nixos/modules/security/acme/default.nix index 5f4344d451c88..4bc3d8e743d39 100644 --- a/nixos/modules/security/acme/default.nix +++ b/nixos/modules/security/acme/default.nix @@ -581,8 +581,8 @@ let Turns on the OCSP Must-Staple TLS extension. Make sure you know what you're doing! See: <itemizedlist> - <listitem><para><link xlink:href="https://blog.apnic.net/2019/01/15/is-the-web-ready-for-ocsp-must-staple/" /></para></listitem> - <listitem><para><link xlink:href="https://blog.hboeck.de/archives/886-The-Problem-with-OCSP-Stapling-and-Must-Staple-and-why-Certificate-Revocation-is-still-broken.html" /></para></listitem> + <listitem><para><link xlink:href="https://blog.apnic.net/2019/01/15/is-the-web-ready-for-ocsp-must-staple/"/></para></listitem> + <listitem><para><link xlink:href="https://blog.hboeck.de/archives/886-The-Problem-with-OCSP-Stapling-and-Must-Staple-and-why-Certificate-Revocation-is-still-broken.html"/></para></listitem> </itemizedlist> ''; }; diff --git a/nixos/modules/security/pam.nix b/nixos/modules/security/pam.nix index 7903d333411bd..8a70e5f3adbd4 100644 --- a/nixos/modules/security/pam.nix +++ b/nixos/modules/security/pam.nix @@ -831,8 +831,7 @@ in If set, users can log in with SSH keys and PKCS#11 tokens. - More information can be found <link - xlink:href="https://github.com/OpenSC/pam_p11">here</link>. + More information can be found <link xlink:href="https://github.com/OpenSC/pam_p11">here</link>. ''; }; @@ -872,8 +871,7 @@ in <literal>username:first_keyHandle,first_public_key: second_keyHandle,second_public_key</literal> This file can be generated using <command>pamu2fcfg</command> command. - More information can be found <link - xlink:href="https://developers.yubico.com/pam-u2f/">here</link>. + More information can be found <link xlink:href="https://developers.yubico.com/pam-u2f/">here</link>. ''; }; @@ -894,8 +892,7 @@ in <literal>username:first_keyHandle,first_public_key: second_keyHandle,second_public_key</literal> This file can be generated using <command>pamu2fcfg</command> command. - More information can be found <link - xlink:href="https://developers.yubico.com/pam-u2f/">here</link>. + More information can be found <link xlink:href="https://developers.yubico.com/pam-u2f/">here</link>. ''; }; @@ -909,9 +906,7 @@ in When using <command>pamu2fcfg</command>, you can specify your application ID with the <literal>-i</literal> flag. - More information can be found <link - xlink:href="https://developers.yubico.com/pam-u2f/Manuals/pam_u2f.8.html"> - here</link> + More information can be found <link xlink:href="https://developers.yubico.com/pam-u2f/Manuals/pam_u2f.8.html">here</link> ''; }; @@ -927,9 +922,7 @@ in When using <command>pamu2fcfg</command>, you can specify your application ID with the <literal>-o</literal> flag. - More information can be found <link - xlink:href="https://developers.yubico.com/pam-u2f/Manuals/pam_u2f.8.html"> - here</link> + More information can be found <link xlink:href="https://developers.yubico.com/pam-u2f/Manuals/pam_u2f.8.html">here</link> ''; }; @@ -995,8 +988,7 @@ in Note that this module must both be enabled using this option and on a per-PAM-service level as well (using <literal>usshAuth</literal>). - More information can be found <link - xlink:href="https://github.com/uber/pam-ussh">here</link>. + More information can be found <link xlink:href="https://github.com/uber/pam-ussh">here</link>. ''; }; @@ -1084,8 +1076,7 @@ in The file must have only one line: <literal>username:yubikey_token_id1:yubikey_token_id2</literal> - More information can be found <link - xlink:href="https://developers.yubico.com/yubico-pam/">here</link>. + More information can be found <link xlink:href="https://developers.yubico.com/yubico-pam/">here</link>. ''; }; control = mkOption { @@ -1130,8 +1121,7 @@ in Challenge-Response configurations. See the man-page ykpamcfg(1) for further details on how to configure offline Challenge-Response validation. - More information can be found <link - xlink:href="https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html">here</link>. + More information can be found <link xlink:href="https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html">here</link>. ''; }; challengeResponsePath = mkOption { @@ -1140,8 +1130,7 @@ in description = '' If not null, set the path used by yubico pam module where the challenge expected response is stored. - More information can be found <link - xlink:href="https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html">here</link>. + More information can be found <link xlink:href="https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html">here</link>. ''; }; }; diff --git a/nixos/modules/security/pam_mount.nix b/nixos/modules/security/pam_mount.nix index e159a73b66a46..ae314abd86c60 100644 --- a/nixos/modules/security/pam_mount.nix +++ b/nixos/modules/security/pam_mount.nix @@ -33,8 +33,7 @@ in default = []; description = '' List of volume definitions for pam_mount. - For more information, visit <link - xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html" />. + For more information, visit <link xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html"/>. ''; }; @@ -67,8 +66,7 @@ in description = '' Sets the Debug-Level. 0 disables debugging, 1 enables pam_mount tracing, and 2 additionally enables tracing in mount.crypt. The default is 0. - For more information, visit <link - xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html" />. + For more information, visit <link xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html"/>. ''; }; @@ -78,8 +76,7 @@ in description = '' Amount of microseconds to wait until killing remaining processes after final logout. - For more information, visit <link - xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html" />. + For more information, visit <link xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html"/>. ''; }; diff --git a/nixos/modules/security/pam_usb.nix b/nixos/modules/security/pam_usb.nix index 51d81e823f867..71e2af8f3a514 100644 --- a/nixos/modules/security/pam_usb.nix +++ b/nixos/modules/security/pam_usb.nix @@ -19,8 +19,7 @@ in default = false; description = '' Enable USB login for all login systems that support it. For - more information, visit <link - xlink:href="https://github.com/aluzzardi/pam_usb/wiki/Getting-Started#setting-up-devices-and-users" />. + more information, visit <link xlink:href="https://github.com/aluzzardi/pam_usb/wiki/Getting-Started#setting-up-devices-and-users"/>. ''; }; diff --git a/nixos/modules/services/backup/zrepl.nix b/nixos/modules/services/backup/zrepl.nix index e3a9009126455..7b31b0da03695 100644 --- a/nixos/modules/services/backup/zrepl.nix +++ b/nixos/modules/services/backup/zrepl.nix @@ -23,8 +23,7 @@ in settings = mkOption { default = { }; description = '' - Configuration for zrepl. See <link - xlink:href="https://zrepl.github.io/configuration.html"/> + Configuration for zrepl. See <link xlink:href="https://zrepl.github.io/configuration.html"/> for more information. ''; type = types.submodule { diff --git a/nixos/modules/services/continuous-integration/github-runner.nix b/nixos/modules/services/continuous-integration/github-runner.nix index 2da18bbdb3961..2c753b514c5be 100644 --- a/nixos/modules/services/continuous-integration/github-runner.nix +++ b/nixos/modules/services/continuous-integration/github-runner.nix @@ -22,8 +22,7 @@ in Whether to enable GitHub Actions runner. Note: GitHub recommends using self-hosted runners with private repositories only. Learn more here: - <link xlink:href="https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners" - >About self-hosted runners</link>. + <link xlink:href="https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners">About self-hosted runners</link>. ''; type = lib.types.bool; }; diff --git a/nixos/modules/services/databases/postgresql.nix b/nixos/modules/services/databases/postgresql.nix index a054a6d7a12f0..8225a9aaba617 100644 --- a/nixos/modules/services/databases/postgresql.nix +++ b/nixos/modules/services/databases/postgresql.nix @@ -81,8 +81,7 @@ in default = ""; description = '' Defines how users authenticate themselves to the server. See the - <link xlink:href="https://www.postgresql.org/docs/current/auth-pg-hba-conf.html"> - PostgreSQL documentation for pg_hba.conf</link> + <link xlink:href="https://www.postgresql.org/docs/current/auth-pg-hba-conf.html">PostgreSQL documentation for pg_hba.conf</link> for details on the expected format of this option. By default, peer based authentication will be used for users connecting via the Unix socket, and md5 password authentication will be diff --git a/nixos/modules/services/databases/victoriametrics.nix b/nixos/modules/services/databases/victoriametrics.nix index 28a6ccfd5e20c..4e002b3df7c7f 100644 --- a/nixos/modules/services/databases/victoriametrics.nix +++ b/nixos/modules/services/databases/victoriametrics.nix @@ -29,8 +29,8 @@ let cfg = config.services.victoriametrics; in type = types.listOf types.str; default = []; description = '' - Extra options to pass to VictoriaMetrics. See the README: <link - xlink:href="https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/README.md" /> + Extra options to pass to VictoriaMetrics. See the README: + <link xlink:href="https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/README.md"/> or <command>victoriametrics -help</command> for more information. ''; diff --git a/nixos/modules/services/development/zammad.nix b/nixos/modules/services/development/zammad.nix index 503f54aee2c70..e81eef3c0a51b 100644 --- a/nixos/modules/services/development/zammad.nix +++ b/nixos/modules/services/development/zammad.nix @@ -139,7 +139,7 @@ in ''; description = '' The <filename>database.yml</filename> configuration file as key value set. - See <link xlink:href='TODO' /> + See <link xlink:href="TODO"/> for list of configuration parameters. ''; }; diff --git a/nixos/modules/services/games/asf.nix b/nixos/modules/services/games/asf.nix index 37247e195a78c..6939e15c207d9 100644 --- a/nixos/modules/services/games/asf.nix +++ b/nixos/modules/services/games/asf.nix @@ -136,7 +136,9 @@ in }; settings = mkOption { type = types.attrs; - description = "Additional settings that are documented <link xlink:href=\"https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#bot-config\">here</link>."; + description = '' + Additional settings that are documented <link xlink:href="https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#bot-config">here</link>. + ''; default = { }; }; }; diff --git a/nixos/modules/services/hardware/udev.nix b/nixos/modules/services/hardware/udev.nix index f54979832cb3d..f745e2f7f6060 100644 --- a/nixos/modules/services/hardware/udev.nix +++ b/nixos/modules/services/hardware/udev.nix @@ -282,9 +282,8 @@ in default = true; type = types.bool; description = '' - Whether to assign <link - xlink:href='http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames'>predictable - names to network interfaces</link>. If enabled, interfaces + Whether to assign <link xlink:href="http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames">predictable names to network interfaces</link>. + If enabled, interfaces are assigned names that contain topology information (e.g. <literal>wlp3s0</literal>) and thus should be stable across reboots. If disabled, names depend on the order in diff --git a/nixos/modules/services/logging/filebeat.nix b/nixos/modules/services/logging/filebeat.nix index ec8df0a7b87d2..045cd1147ead9 100644 --- a/nixos/modules/services/logging/filebeat.nix +++ b/nixos/modules/services/logging/filebeat.nix @@ -161,8 +161,7 @@ in internal = true; description = '' Inputs specify how Filebeat locates and processes - input data. Use <xref - linkend="opt-services.filebeat.inputs"/> instead. + input data. Use <xref linkend="opt-services.filebeat.inputs"/> instead. See <link xlink:href="https://www.elastic.co/guide/en/beats/filebeat/current/configuration-filebeat-options.html"/>. ''; diff --git a/nixos/modules/services/mail/mailman.nix b/nixos/modules/services/mail/mailman.nix index eb24f73c1da82..c3eb61bd20d7a 100644 --- a/nixos/modules/services/mail/mailman.nix +++ b/nixos/modules/services/mail/mailman.nix @@ -114,7 +114,7 @@ in { example = "/run/secrets/ldap-bind"; description = '' Path to the file containing the bind password of the servie account - defined by <xref linkend="opt-services.mailman.ldap.bindDn" />. + defined by <xref linkend="opt-services.mailman.ldap.bindDn"/>. ''; }; superUserGroup = mkOption { diff --git a/nixos/modules/services/mail/sympa.nix b/nixos/modules/services/mail/sympa.nix index 0b72ce97512d5..0a2a885a80f68 100644 --- a/nixos/modules/services/mail/sympa.nix +++ b/nixos/modules/services/mail/sympa.nix @@ -88,7 +88,7 @@ in example = "cs"; description = '' Default Sympa language. - See <link xlink:href='https://github.com/sympa-community/sympa/tree/sympa-6.2/po/sympa' /> + See <link xlink:href="https://github.com/sympa-community/sympa/tree/sympa-6.2/po/sympa"/> for available options. ''; }; @@ -138,7 +138,7 @@ in }; description = '' The <filename>robot.conf</filename> configuration file as key value set. - See <link xlink:href='https://sympa-community.github.io/gpldoc/man/sympa.conf.5.html' /> + See <link xlink:href="https://sympa-community.github.io/gpldoc/man/sympa.conf.5.html"/> for list of configuration parameters. ''; }; @@ -287,7 +287,7 @@ in ''; description = '' The <filename>sympa.conf</filename> configuration file as key value set. - See <link xlink:href='https://sympa-community.github.io/gpldoc/man/sympa.conf.5.html' /> + See <link xlink:href="https://sympa-community.github.io/gpldoc/man/sympa.conf.5.html"/> for list of configuration parameters. ''; }; diff --git a/nixos/modules/services/matrix/appservice-discord.nix b/nixos/modules/services/matrix/appservice-discord.nix index 65ad96a3af364..87a706ae95ef0 100644 --- a/nixos/modules/services/matrix/appservice-discord.nix +++ b/nixos/modules/services/matrix/appservice-discord.nix @@ -44,8 +44,7 @@ in { <filename>config.yaml</filename> configuration as a Nix attribute set. Configuration options should match those described in - <link xlink:href="https://github.com/Half-Shot/matrix-appservice-discord/blob/master/config/config.sample.yaml"> - config.sample.yaml</link>. + <link xlink:href="https://github.com/Half-Shot/matrix-appservice-discord/blob/master/config/config.sample.yaml">config.sample.yaml</link>. <option>config.bridge.domain</option> and <option>config.bridge.homeserverUrl</option> should be set to match the public host name of the Matrix homeserver for webhooks and avatars to work. diff --git a/nixos/modules/services/matrix/mautrix-facebook.nix b/nixos/modules/services/matrix/mautrix-facebook.nix index 2f91e6e0e5213..384a4f4a706f5 100644 --- a/nixos/modules/services/matrix/mautrix-facebook.nix +++ b/nixos/modules/services/matrix/mautrix-facebook.nix @@ -78,8 +78,7 @@ in { description = '' <filename>config.yaml</filename> configuration as a Nix attribute set. Configuration options should match those described in - <link xlink:href="https://github.com/mautrix/facebook/blob/master/mautrix_facebook/example-config.yaml"> - example-config.yaml</link>. + <link xlink:href="https://github.com/mautrix/facebook/blob/master/mautrix_facebook/example-config.yaml">example-config.yaml</link>. Secret tokens should be specified using <option>environmentFile</option> instead of this world-readable attribute set. diff --git a/nixos/modules/services/matrix/mautrix-telegram.nix b/nixos/modules/services/matrix/mautrix-telegram.nix index 1d4061b8a8182..492ed1b24bcef 100644 --- a/nixos/modules/services/matrix/mautrix-telegram.nix +++ b/nixos/modules/services/matrix/mautrix-telegram.nix @@ -81,8 +81,7 @@ in { description = '' <filename>config.yaml</filename> configuration as a Nix attribute set. Configuration options should match those described in - <link xlink:href="https://github.com/tulir/mautrix-telegram/blob/master/example-config.yaml"> - example-config.yaml</link>. + <link xlink:href="https://github.com/tulir/mautrix-telegram/blob/master/example-config.yaml">example-config.yaml</link>. Secret tokens should be specified using <option>environmentFile</option> instead of this world-readable attribute set. diff --git a/nixos/modules/services/misc/etcd.nix b/nixos/modules/services/misc/etcd.nix index d589ad780c1b0..d0c82d7260233 100644 --- a/nixos/modules/services/misc/etcd.nix +++ b/nixos/modules/services/misc/etcd.nix @@ -127,7 +127,7 @@ in { extraConf = mkOption { description = '' Etcd extra configuration. See - <link xlink:href='https://github.com/coreos/etcd/blob/master/Documentation/op-guide/configuration.md#configuration-flags' /> + <link xlink:href="https://github.com/coreos/etcd/blob/master/Documentation/op-guide/configuration.md#configuration-flags"/> ''; type = types.attrsOf types.str; default = {}; diff --git a/nixos/modules/services/misc/etebase-server.nix b/nixos/modules/services/misc/etebase-server.nix index 24be9e8e2692b..1359c265c8f12 100644 --- a/nixos/modules/services/misc/etebase-server.nix +++ b/nixos/modules/services/misc/etebase-server.nix @@ -135,8 +135,8 @@ in default = {}; description = '' Configuration for <package>etebase-server</package>. Refer to - <link xlink:href="https://github.com/etesync/server/blob/master/etebase-server.ini.example" /> - and <link xlink:href="https://github.com/etesync/server/wiki" /> + <link xlink:href="https://github.com/etesync/server/blob/master/etebase-server.ini.example"/> + and <link xlink:href="https://github.com/etesync/server/wiki"/> for details on supported values. ''; example = { diff --git a/nixos/modules/services/misc/geoipupdate.nix b/nixos/modules/services/misc/geoipupdate.nix index 20bbba0aad9ae..98d470412142b 100644 --- a/nixos/modules/services/misc/geoipupdate.nix +++ b/nixos/modules/services/misc/geoipupdate.nix @@ -40,7 +40,7 @@ in description = '' <productname>geoipupdate</productname> configuration options. See - <link xlink:href="https://github.com/maxmind/geoipupdate/blob/main/doc/GeoIP.conf.md" /> + <link xlink:href="https://github.com/maxmind/geoipupdate/blob/main/doc/GeoIP.conf.md"/> for a full list of available options. Settings containing secret data should be set to an @@ -92,8 +92,7 @@ in Always handled as a secret whether the value is wrapped in a <literal>{ _secret = ...; }</literal> - attrset or not (refer to <xref - linkend="opt-services.geoipupdate.settings" /> for + attrset or not (refer to <xref linkend="opt-services.geoipupdate.settings"/> for details). ''; apply = x: if isAttrs x then x else { _secret = x; }; diff --git a/nixos/modules/services/misc/persistent-evdev.nix b/nixos/modules/services/misc/persistent-evdev.nix index 401d20010b12a..fd6e298ef651f 100644 --- a/nixos/modules/services/misc/persistent-evdev.nix +++ b/nixos/modules/services/misc/persistent-evdev.nix @@ -22,8 +22,8 @@ in Physical devices should already exist in <filename class="devicefile">/dev/input/by-id/</filename>. Proxy devices will be automatically given a <literal>uinput-</literal> prefix. - See the <link xlink:href="https://github.com/aiberia/persistent-evdev#example-usage-with-libvirt"> - project page</link> for example configuration of virtual devices with libvirt + See the <link xlink:href="https://github.com/aiberia/persistent-evdev#example-usage-with-libvirt">project page</link> + for example configuration of virtual devices with libvirt and remember to add <literal>uinput-*</literal> devices to the qemu <literal>cgroup_device_acl</literal> list (see <xref linkend="opt-virtualisation.libvirtd.qemu.verbatimConfig"/>). ''; diff --git a/nixos/modules/services/monitoring/cadvisor.nix b/nixos/modules/services/monitoring/cadvisor.nix index c844b1599dd46..7374b1ece4953 100644 --- a/nixos/modules/services/monitoring/cadvisor.nix +++ b/nixos/modules/services/monitoring/cadvisor.nix @@ -75,7 +75,7 @@ in { world-readable Nix store that contains the value of <option>storageDriverPassword</option>. It's recommended to override this with a path not in the Nix store. - Tip: use <link xlink:href='https://nixos.org/nixops/manual/#idm140737318306400'>nixops key management</link> + Tip: use <link xlink:href="https://nixos.org/nixops/manual/#idm140737318306400">nixops key management</link> ''; }; @@ -91,7 +91,7 @@ in { description = '' Additional cadvisor options. - See <link xlink:href='https://github.com/google/cadvisor/blob/master/docs/runtime_options.md'/> for available options. + See <link xlink:href="https://github.com/google/cadvisor/blob/master/docs/runtime_options.md"/> for available options. ''; }; }; diff --git a/nixos/modules/services/monitoring/grafana-image-renderer.nix b/nixos/modules/services/monitoring/grafana-image-renderer.nix index 97488f2653a5b..4820b19469875 100644 --- a/nixos/modules/services/monitoring/grafana-image-renderer.nix +++ b/nixos/modules/services/monitoring/grafana-image-renderer.nix @@ -92,7 +92,7 @@ in { description = '' Configuration attributes for <package>grafana-image-renderer</package>. - See <link xlink:href="https://github.com/grafana/grafana-image-renderer/blob/ce1f81438e5f69c7fd7c73ce08bab624c4c92e25/default.json" /> + See <link xlink:href="https://github.com/grafana/grafana-image-renderer/blob/ce1f81438e5f69c7fd7c73ce08bab624c4c92e25/default.json"/> for supported values. ''; }; diff --git a/nixos/modules/services/monitoring/graphite.nix b/nixos/modules/services/monitoring/graphite.nix index 73b509202df66..0905b4b57fb96 100644 --- a/nixos/modules/services/monitoring/graphite.nix +++ b/nixos/modules/services/monitoring/graphite.nix @@ -253,7 +253,7 @@ in { default = {}; description = '' Extra seyren configuration. See - <link xlink:href='https://github.com/scobal/seyren#config' /> + <link xlink:href="https://github.com/scobal/seyren#config"/> ''; type = types.attrsOf types.str; example = literalExpression '' diff --git a/nixos/modules/services/monitoring/munin.nix b/nixos/modules/services/monitoring/munin.nix index c77ae7b3b6eb2..3455d0d3d4a6f 100644 --- a/nixos/modules/services/monitoring/munin.nix +++ b/nixos/modules/services/monitoring/munin.nix @@ -142,7 +142,7 @@ in Enable Munin Node agent. Munin node listens on 0.0.0.0 and by default accepts connections only from 127.0.0.1 for security reasons. - See <link xlink:href='http://guide.munin-monitoring.org/en/latest/architecture/index.html' />. + See <link xlink:href="http://guide.munin-monitoring.org/en/latest/architecture/index.html"/>. ''; }; @@ -151,7 +151,7 @@ in type = types.lines; description = '' <filename>munin-node.conf</filename> extra configuration. See - <link xlink:href='http://guide.munin-monitoring.org/en/latest/reference/munin-node.conf.html' /> + <link xlink:href="http://guide.munin-monitoring.org/en/latest/reference/munin-node.conf.html"/> ''; }; @@ -160,7 +160,7 @@ in type = types.lines; description = '' <filename>plugin-conf.d</filename> extra plugin configuration. See - <link xlink:href='http://guide.munin-monitoring.org/en/latest/plugin/use.html' /> + <link xlink:href="http://guide.munin-monitoring.org/en/latest/plugin/use.html"/> ''; example = '' [fail2ban_*] @@ -268,9 +268,9 @@ in type = types.lines; description = '' <filename>munin.conf</filename> extra global configuration. - See <link xlink:href='http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html' />. + See <link xlink:href="http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html"/>. Useful to setup notifications, see - <link xlink:href='http://guide.munin-monitoring.org/en/latest/tutorial/alert.html' /> + <link xlink:href="http://guide.munin-monitoring.org/en/latest/tutorial/alert.html"/> ''; example = '' contact.email.command mail -s "Munin notification for ''${var:host}" someone@example.com @@ -283,7 +283,7 @@ in description = '' Definitions of hosts of nodes to collect data from. Needs at least one host for cron to succeed. See - <link xlink:href='http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html' /> + <link xlink:href="http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html"/> ''; example = literalExpression '' ''' diff --git a/nixos/modules/services/monitoring/nagios.nix b/nixos/modules/services/monitoring/nagios.nix index 69173ce4e44ed..a17797f682f8b 100644 --- a/nixos/modules/services/monitoring/nagios.nix +++ b/nixos/modules/services/monitoring/nagios.nix @@ -88,7 +88,7 @@ in options = { services.nagios = { - enable = mkEnableOption "<link xlink:href='http://www.nagios.org/'>Nagios</link> to monitor your system or network."; + enable = mkEnableOption ''<link xlink:href="http://www.nagios.org/">Nagios</link> to monitor your system or network.''; objectDefs = mkOption { description = " diff --git a/nixos/modules/services/monitoring/parsedmarc.nix b/nixos/modules/services/monitoring/parsedmarc.nix index 736718c25359c..60ebbd6f75258 100644 --- a/nixos/modules/services/monitoring/parsedmarc.nix +++ b/nixos/modules/services/monitoring/parsedmarc.nix @@ -69,14 +69,12 @@ in type = lib.types.bool; default = true; description = '' - Whether to enable and configure the <link - linkend="opt-services.geoipupdate.enable">geoipupdate</link> + Whether to enable and configure the <link linkend="opt-services.geoipupdate.enable">geoipupdate</link> service to automatically fetch GeoIP databases. Not crucial, but recommended for full functionality. - To finish the setup, you need to manually set the <xref - linkend="opt-services.geoipupdate.settings.AccountID" /> and - <xref linkend="opt-services.geoipupdate.settings.LicenseKey" /> + To finish the setup, you need to manually set the <xref linkend="opt-services.geoipupdate.settings.AccountID"/> and + <xref linkend="opt-services.geoipupdate.settings.LicenseKey"/> options. ''; }; @@ -101,7 +99,7 @@ in Whether the automatically provisioned Elasticsearch instance should be added as a grafana datasource. Has no effect unless - <xref linkend="opt-services.parsedmarc.provision.elasticsearch" /> + <xref linkend="opt-services.parsedmarc.provision.elasticsearch"/> is also enabled. ''; }; @@ -213,8 +211,7 @@ in Always handled as a secret whether the value is wrapped in a <literal>{ _secret = ...; }</literal> - attrset or not (refer to <xref - linkend="opt-services.parsedmarc.settings" /> for + attrset or not (refer to <xref linkend="opt-services.parsedmarc.settings"/> for details). ''; apply = x: if isAttrs x || x == null then x else { _secret = x; }; @@ -278,8 +275,7 @@ in Always handled as a secret whether the value is wrapped in a <literal>{ _secret = ...; }</literal> - attrset or not (refer to <xref - linkend="opt-services.parsedmarc.settings" /> for + attrset or not (refer to <xref linkend="opt-services.parsedmarc.settings"/> for details). ''; apply = x: if isAttrs x || x == null then x else { _secret = x; }; @@ -332,8 +328,7 @@ in Always handled as a secret whether the value is wrapped in a <literal>{ _secret = ...; }</literal> - attrset or not (refer to <xref - linkend="opt-services.parsedmarc.settings" /> for + attrset or not (refer to <xref linkend="opt-services.parsedmarc.settings"/> for details). ''; apply = x: if isAttrs x || x == null then x else { _secret = x; }; diff --git a/nixos/modules/services/monitoring/prometheus/default.nix b/nixos/modules/services/monitoring/prometheus/default.nix index db4286b66a5d3..3bc61fba158f3 100644 --- a/nixos/modules/services/monitoring/prometheus/default.nix +++ b/nixos/modules/services/monitoring/prometheus/default.nix @@ -379,9 +379,8 @@ let gce_sd_configs = mkOpt (types.listOf promTypes.gce_sd_config) '' List of Google Compute Engine service discovery configurations. - See <link - xlink:href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#gce_sd_config">the - relevant Prometheus configuration docs</link> for more detail. + See <link xlink:href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#gce_sd_config">the relevant Prometheus configuration docs</link> + for more detail. ''; hetzner_sd_configs = mkOpt (types.listOf promTypes.hetzner_sd_config) '' @@ -807,9 +806,7 @@ let filter = mkOpt types.str '' Filter can be used optionally to filter the instance list by other criteria Syntax of this filter string is described here in the filter - query parameter section: <link - xlink:href="https://cloud.google.com/compute/docs/reference/latest/instances/list" - />. + query parameter section: <link xlink:href="https://cloud.google.com/compute/docs/reference/latest/instances/list"/>. ''; refresh_interval = mkDefOpt types.str "60s" '' @@ -825,7 +822,7 @@ let The tag separator used to separate concatenated GCE instance network tags. See the GCP documentation on network tags for more information: - <link xlink:href="https://cloud.google.com/vpc/docs/add-remove-network-tags" /> + <link xlink:href="https://cloud.google.com/vpc/docs/add-remove-network-tags"/> ''; }; }; @@ -1033,13 +1030,13 @@ let auth_token = mkOpt types.str '' Optional authentication information for token-based authentication: - <link xlink:href="https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token" /> + <link xlink:href="https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token"/> It is mutually exclusive with <literal>auth_token_file</literal> and other authentication mechanisms. ''; auth_token_file = mkOpt types.str '' Optional authentication information for token-based authentication: - <link xlink:href="https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token" /> + <link xlink:href="https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token"/> It is mutually exclusive with <literal>auth_token</literal> and other authentication mechanisms. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix b/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix index 092ac6fea7d74..4e7aae0b34b59 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix @@ -33,10 +33,10 @@ in work with this exporter: <programlisting> { - <xref linkend="opt-services.prometheus.exporters.dovecot.enable" /> = true; - <xref linkend="opt-services.prometheus.exporters.dovecot.socketPath" /> = "/var/run/dovecot2/old-stats"; - <xref linkend="opt-services.dovecot2.mailPlugins.globally.enable" /> = [ "old_stats" ]; - <xref linkend="opt-services.dovecot2.extraConfig" /> = ''' + <xref linkend="opt-services.prometheus.exporters.dovecot.enable"/> = true; + <xref linkend="opt-services.prometheus.exporters.dovecot.socketPath"/> = "/var/run/dovecot2/old-stats"; + <xref linkend="opt-services.dovecot2.mailPlugins.globally.enable"/> = [ "old_stats" ]; + <xref linkend="opt-services.dovecot2.extraConfig"/> = ''' service old-stats { unix_listener old-stats { user = dovecot-exporter diff --git a/nixos/modules/services/monitoring/prometheus/exporters/process.nix b/nixos/modules/services/monitoring/prometheus/exporters/process.nix index 1e9c402fb55bd..666116991b5a9 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/process.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/process.nix @@ -22,7 +22,7 @@ in All settings expressed as an Nix attrset. Check the official documentation for the corresponding YAML - settings that can all be used here: <link xlink:href="https://github.com/ncabatoff/process-exporter" /> + settings that can all be used here: <link xlink:href="https://github.com/ncabatoff/process-exporter"/> ''; }; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/script.nix b/nixos/modules/services/monitoring/prometheus/exporters/script.nix index a805a0ad335d2..2a43fbcab3a10 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/script.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/script.nix @@ -41,7 +41,7 @@ in All settings expressed as an Nix attrset. Check the official documentation for the corresponding YAML - settings that can all be used here: <link xlink:href="https://github.com/adhocteam/script_exporter#sample-configuration" /> + settings that can all be used here: <link xlink:href="https://github.com/adhocteam/script_exporter#sample-configuration"/> ''; }; }; diff --git a/nixos/modules/services/networking/bird-lg.nix b/nixos/modules/services/networking/bird-lg.nix index db4a4140dd406..9f06bfcdc51ea 100644 --- a/nixos/modules/services/networking/bird-lg.nix +++ b/nixos/modules/services/networking/bird-lg.nix @@ -136,9 +136,9 @@ in extraArgs = mkOption { type = types.lines; default = ""; - description = " - Extra parameters documented <link xlink:href=\"https://github.com/xddxdd/bird-lg-go#frontend\">here</link>. - "; + description = '' + Extra parameters documented <link xlink:href="https://github.com/xddxdd/bird-lg-go#frontend">here</link>. + ''; }; }; @@ -183,9 +183,9 @@ in extraArgs = mkOption { type = types.lines; default = ""; - description = " - Extra parameters documented <link xlink:href=\"https://github.com/xddxdd/bird-lg-go#proxy\">here</link>. - "; + description = '' + Extra parameters documented <link xlink:href="https://github.com/xddxdd/bird-lg-go#proxy">here</link>. + ''; }; }; }; diff --git a/nixos/modules/services/networking/bird.nix b/nixos/modules/services/networking/bird.nix index b166209fa9692..4a738daf95864 100644 --- a/nixos/modules/services/networking/bird.nix +++ b/nixos/modules/services/networking/bird.nix @@ -15,7 +15,7 @@ in type = types.lines; description = '' BIRD Internet Routing Daemon configuration file. - <link xlink:href='http://bird.network.cz/'/> + <link xlink:href="http://bird.network.cz/"/> ''; }; checkConfig = mkOption { diff --git a/nixos/modules/services/networking/coredns.nix b/nixos/modules/services/networking/coredns.nix index 9a4140e9d58a8..966957f1a0f70 100644 --- a/nixos/modules/services/networking/coredns.nix +++ b/nixos/modules/services/networking/coredns.nix @@ -17,7 +17,10 @@ in { } ''; type = types.lines; - description = "Verbatim Corefile to use. See <link xlink:href=\"https://coredns.io/manual/toc/#configuration\"/> for details."; + description = '' + Verbatim Corefile to use. + See <link xlink:href="https://coredns.io/manual/toc/#configuration"/> for details. + ''; }; package = mkOption { diff --git a/nixos/modules/services/networking/seafile.nix b/nixos/modules/services/networking/seafile.nix index 7cda71458dd1b..d9617952ea59f 100644 --- a/nixos/modules/services/networking/seafile.nix +++ b/nixos/modules/services/networking/seafile.nix @@ -133,7 +133,7 @@ in { type = types.lines; description = '' Extra config to append to `seahub_settings.py` file. - Refer to <link xlink:href="https://manual.seafile.com/config/seahub_settings_py/" /> + Refer to <link xlink:href="https://manual.seafile.com/config/seahub_settings_py/"/> for all available options. ''; }; diff --git a/nixos/modules/services/networking/ssh/sshd.nix b/nixos/modules/services/networking/ssh/sshd.nix index e95fe19dede3c..cbc4e303b6411 100644 --- a/nixos/modules/services/networking/ssh/sshd.nix +++ b/nixos/modules/services/networking/ssh/sshd.nix @@ -302,9 +302,9 @@ in Allowed key exchange algorithms Uses the lower bound recommended in both - <link xlink:href="https://stribika.github.io/2015/01/04/secure-secure-shell.html" /> + <link xlink:href="https://stribika.github.io/2015/01/04/secure-secure-shell.html"/> and - <link xlink:href="https://infosec.mozilla.org/guidelines/openssh#modern-openssh-67" /> + <link xlink:href="https://infosec.mozilla.org/guidelines/openssh#modern-openssh-67"/> ''; }; @@ -322,9 +322,9 @@ in Allowed ciphers Defaults to recommended settings from both - <link xlink:href="https://stribika.github.io/2015/01/04/secure-secure-shell.html" /> + <link xlink:href="https://stribika.github.io/2015/01/04/secure-secure-shell.html"/> and - <link xlink:href="https://infosec.mozilla.org/guidelines/openssh#modern-openssh-67" /> + <link xlink:href="https://infosec.mozilla.org/guidelines/openssh#modern-openssh-67"/> ''; }; @@ -342,9 +342,9 @@ in Allowed MACs Defaults to recommended settings from both - <link xlink:href="https://stribika.github.io/2015/01/04/secure-secure-shell.html" /> + <link xlink:href="https://stribika.github.io/2015/01/04/secure-secure-shell.html"/> and - <link xlink:href="https://infosec.mozilla.org/guidelines/openssh#modern-openssh-67" /> + <link xlink:href="https://infosec.mozilla.org/guidelines/openssh#modern-openssh-67"/> ''; }; diff --git a/nixos/modules/services/networking/wireguard.nix b/nixos/modules/services/networking/wireguard.nix index 412e9c921f52e..994a0cf9ec1ed 100644 --- a/nixos/modules/services/networking/wireguard.nix +++ b/nixos/modules/services/networking/wireguard.nix @@ -122,8 +122,7 @@ let WireGuard interface is created, and which retains the socket even if the interface is moved via <option>interfaceNamespace</option>. When <literal>null</literal>, the interface is created in the init namespace. - See <link - xlink:href="https://www.wireguard.com/netns/">documentation</link>. + See <link xlink:href="https://www.wireguard.com/netns/">documentation</link>. ''; }; @@ -135,8 +134,7 @@ let interface is moved to. The special value <literal>init</literal> means the init namespace. When <literal>null</literal>, the interface is not moved. - See <link - xlink:href="https://www.wireguard.com/netns/">documentation</link>. + See <link xlink:href="https://www.wireguard.com/netns/">documentation</link>. ''; }; }; diff --git a/nixos/modules/services/networking/wpa_supplicant.nix b/nixos/modules/services/networking/wpa_supplicant.nix index e21c25e2f78f8..ac5f597b4752d 100644 --- a/nixos/modules/services/networking/wpa_supplicant.nix +++ b/nixos/modules/services/networking/wpa_supplicant.nix @@ -190,7 +190,7 @@ in { description = '' Whether to allow configuring networks "imperatively" (e.g. via <package>wpa_supplicant_gui</package>) and declaratively via - <xref linkend="opt-networking.wireless.networks" />. + <xref linkend="opt-networking.wireless.networks"/>. Please note that this adds a custom patch to <package>wpa_supplicant</package>. ''; diff --git a/nixos/modules/services/security/privacyidea.nix b/nixos/modules/services/security/privacyidea.nix index 599ade003c031..4be3a90b649f8 100644 --- a/nixos/modules/services/security/privacyidea.nix +++ b/nixos/modules/services/security/privacyidea.nix @@ -78,7 +78,7 @@ in using <package>envsubst</package> which is helpful for specifying secrets: <programlisting> - { <xref linkend="opt-services.privacyidea.secretKey" /> = "$SECRET"; } + { <xref linkend="opt-services.privacyidea.secretKey"/> = "$SECRET"; } </programlisting> The environment-file can now specify the actual secret key: @@ -207,7 +207,7 @@ in description = '' Attribute-set containing the settings for <package>privacyidea-ldap-proxy</package>. It's possible to pass secrets using env-vars as substitutes and - use the option <xref linkend="opt-services.privacyidea.ldap-proxy.environmentFile" /> + use the option <xref linkend="opt-services.privacyidea.ldap-proxy.environmentFile"/> to inject them via <package>envsubst</package>. ''; }; @@ -217,7 +217,7 @@ in type = types.nullOr types.str; description = '' Environment file containing secrets to be substituted into - <xref linkend="opt-services.privacyidea.ldap-proxy.settings" />. + <xref linkend="opt-services.privacyidea.ldap-proxy.settings"/>. ''; }; }; diff --git a/nixos/modules/services/security/step-ca.nix b/nixos/modules/services/security/step-ca.nix index 9b9b53f135166..1afcf659632e8 100644 --- a/nixos/modules/services/security/step-ca.nix +++ b/nixos/modules/services/security/step-ca.nix @@ -36,8 +36,8 @@ in type = with lib.types; attrsOf anything; description = '' Settings that go into <filename>ca.json</filename>. See - <link xlink:href="https://smallstep.com/docs/step-ca/configuration"> - the step-ca manual</link> for more information. The easiest way to + <link xlink:href="https://smallstep.com/docs/step-ca/configuration">the step-ca manual</link> + for more information. The easiest way to configure this module would be to run <literal>step ca init</literal> to generate <filename>ca.json</filename> and then import it using <literal>builtins.fromJSON</literal>. diff --git a/nixos/modules/services/security/tor.nix b/nixos/modules/services/security/tor.nix index f611fee69089e..0516d207707a4 100644 --- a/nixos/modules/services/security/tor.nix +++ b/nixos/modules/services/security/tor.nix @@ -287,7 +287,7 @@ in relay = { enable = mkEnableOption ''relaying of Tor traffic for others. - See <link xlink:href="https://www.torproject.org/docs/tor-doc-relay" /> + See <link xlink:href="https://www.torproject.org/docs/tor-doc-relay"/> for details. Setting this to true requires setting @@ -348,7 +348,7 @@ in <para> See - <link xlink:href="https://www.torproject.org/docs/tor-doc-relay.html.en" /> + <link xlink:href="https://www.torproject.org/docs/tor-doc-relay.html.en"/> for more info. </para> </listitem> @@ -366,7 +366,7 @@ in <para> Using this option will make Tor advertise your bridge to users through various mechanisms like - <link xlink:href="https://bridges.torproject.org/" />, though. + <link xlink:href="https://bridges.torproject.org/"/>, though. </para> <important> @@ -384,7 +384,7 @@ in </important> <para> - See <link xlink:href="https://www.torproject.org/docs/bridges.html.en" /> + See <link xlink:href="https://www.torproject.org/docs/bridges.html.en"/> for more info. </para> </listitem> @@ -419,7 +419,7 @@ in </para> <para> - See <link xlink:href="https://www.torproject.org/docs/bridges.html.en" /> + See <link xlink:href="https://www.torproject.org/docs/bridges.html.en"/> for more info. </para> </listitem> diff --git a/nixos/modules/services/security/vaultwarden/default.nix b/nixos/modules/services/security/vaultwarden/default.nix index 7e5389d78f4b7..1433438ba0091 100644 --- a/nixos/modules/services/security/vaultwarden/default.nix +++ b/nixos/modules/services/security/vaultwarden/default.nix @@ -116,7 +116,7 @@ in { The available configuration options can be found in <link xlink:href="https://github.com/dani-garcia/vaultwarden/blob/${vaultwarden.version}/.env.template">the environment template file</link>. - See <xref linkend="opt-services.vaultwarden.environmentFile" /> for how + See <xref linkend="opt-services.vaultwarden.environmentFile"/> for how to set up access to the Admin UI to invite initial users. ''; }; diff --git a/nixos/modules/services/web-apps/hedgedoc.nix b/nixos/modules/services/web-apps/hedgedoc.nix index b8d83984ca7dc..4e1a212598479 100644 --- a/nixos/modules/services/web-apps/hedgedoc.nix +++ b/nixos/modules/services/web-apps/hedgedoc.nix @@ -152,8 +152,7 @@ in ''; description = '' Specify the Content Security Policy which is passed to Helmet. - For configuration details see <link xlink:href="https://helmetjs.github.io/docs/csp/" - >https://helmetjs.github.io/docs/csp/</link>. + For configuration details see <link xlink:href="https://helmetjs.github.io/docs/csp/"/>. ''; }; protocolUseSSL = mkOption { diff --git a/nixos/modules/services/web-apps/keycloak.nix b/nixos/modules/services/web-apps/keycloak.nix index de76babbaedd9..110df53effda6 100644 --- a/nixos/modules/services/web-apps/keycloak.nix +++ b/nixos/modules/services/web-apps/keycloak.nix @@ -215,8 +215,7 @@ in manually provisioned database; has no effect when a local database is automatically provisioned. - To use this with a local database, set <xref - linkend="opt-services.keycloak.database.createLocally" /> to + To use this with a local database, set <xref linkend="opt-services.keycloak.database.createLocally"/> to <literal>false</literal> and create the database and user manually. ''; @@ -230,8 +229,7 @@ in provisioned database; has no effect when a local database is automatically provisioned. - To use this with a local database, set <xref - linkend="opt-services.keycloak.database.createLocally" /> to + To use this with a local database, set <xref linkend="opt-services.keycloak.database.createLocally"/> to <literal>false</literal> and create the database and user manually. ''; @@ -329,10 +327,8 @@ in want to set this to <literal>/auth</literal> to keep compatibility with your clients. - See <link - xlink:href="https://www.keycloak.org/migration/migrating-to-quarkus" - /> for more information on migrating from Wildfly - to Quarkus. + See <link xlink:href="https://www.keycloak.org/migration/migrating-to-quarkus"/> + for more information on migrating from Wildfly to Quarkus. </para> </note> ''; @@ -404,9 +400,7 @@ in </varlistentry> </variablelist> - See <link - xlink:href="https://www.keycloak.org/server/reverseproxy" - /> for more information. + See <link xlink:href="https://www.keycloak.org/server/reverseproxy"/> for more information. ''; }; }; @@ -425,8 +419,7 @@ in Configuration options corresponding to parameters set in <filename>conf/keycloak.conf</filename>. - Most available options are documented at <link - xlink:href="https://www.keycloak.org/server/all-config" />. + Most available options are documented at <link xlink:href="https://www.keycloak.org/server/all-config"/>. Options containing secret data should be set to an attribute set containing the attribute <literal>_secret</literal> - a diff --git a/nixos/modules/services/web-apps/mediawiki.nix b/nixos/modules/services/web-apps/mediawiki.nix index 977b6f60b230e..71154555942ea 100644 --- a/nixos/modules/services/web-apps/mediawiki.nix +++ b/nixos/modules/services/web-apps/mediawiki.nix @@ -280,7 +280,7 @@ in one version of MediaWiki, or have other applications that also use the database, you can give the table names a unique prefix to stop any naming conflicts or confusion. - See <link xlink:href='https://www.mediawiki.org/wiki/Manual:$wgDBprefix'/>. + See <link xlink:href="https://www.mediawiki.org/wiki/Manual:$wgDBprefix"/>. ''; }; diff --git a/nixos/modules/services/web-apps/nextcloud.nix b/nixos/modules/services/web-apps/nextcloud.nix index 08083b7a443f8..a121401f75845 100644 --- a/nixos/modules/services/web-apps/nextcloud.nix +++ b/nixos/modules/services/web-apps/nextcloud.nix @@ -94,7 +94,7 @@ in { default = config.services.nextcloud.home; defaultText = literalExpression "config.services.nextcloud.home"; description = '' - Data storage path of nextcloud. Will be <xref linkend="opt-services.nextcloud.home" /> by default. + Data storage path of nextcloud. Will be <xref linkend="opt-services.nextcloud.home"/> by default. This folder will be populated with a config.php and data folder which contains the state of the instance (excl the database)."; ''; example = "/mnt/nextcloud-file"; @@ -105,7 +105,7 @@ in { description = '' Extra apps to install. Should be an attrSet of appid to packages generated by fetchNextcloudApp. The appid must be identical to the "id" value in the apps appinfo/info.xml. - Using this will disable the appstore to prevent Nextcloud from updating these apps (see <xref linkend="opt-services.nextcloud.appstoreEnable" />). + Using this will disable the appstore to prevent Nextcloud from updating these apps (see <xref linkend="opt-services.nextcloud.appstoreEnable"/>). ''; example = literalExpression '' { @@ -128,7 +128,7 @@ in { type = types.bool; default = true; description = '' - Automatically enable the apps in <xref linkend="opt-services.nextcloud.extraApps" /> every time nextcloud starts. + Automatically enable the apps in <xref linkend="opt-services.nextcloud.extraApps"/> every time nextcloud starts. If set to false, apps need to be enabled in the Nextcloud user interface or with nextcloud-occ app:enable. ''; }; @@ -138,8 +138,8 @@ in { example = true; description = '' Allow the installation of apps and app updates from the store. - Enabled by default unless there are packages in <xref linkend="opt-services.nextcloud.extraApps" />. - Set to true to force enable the store even if <xref linkend="opt-services.nextcloud.extraApps" /> is used. + Enabled by default unless there are packages in <xref linkend="opt-services.nextcloud.extraApps"/>. + Set to true to force enable the store even if <xref linkend="opt-services.nextcloud.extraApps"/> is used. Set to false to disable the installation of apps from the global appstore. App management is always enabled regardless of this setting. ''; }; @@ -467,7 +467,7 @@ in { This is used by the theming app and for generating previews of certain images (e.g. SVG and HEIF). You may want to disable it for increased security. In that case, previews will still be available for some images (e.g. JPEG and PNG). - See <link xlink:href="https://github.com/nextcloud/server/issues/13099" />. + See <link xlink:href="https://github.com/nextcloud/server/issues/13099"/>. '' // { default = true; }; diff --git a/nixos/modules/services/web-apps/node-red.nix b/nixos/modules/services/web-apps/node-red.nix index 1b9d14ecf4ff4..3e6e38c50db51 100644 --- a/nixos/modules/services/web-apps/node-red.nix +++ b/nixos/modules/services/web-apps/node-red.nix @@ -49,8 +49,7 @@ in defaultText = literalExpression ''"''${package}/lib/node_modules/node-red/settings.js"''; description = '' Path to the JavaScript configuration file. - See <link - xlink:href="https://github.com/node-red/node-red/blob/master/packages/node_modules/node-red/settings.js"/> + See <link xlink:href="https://github.com/node-red/node-red/blob/master/packages/node_modules/node-red/settings.js"/> for a configuration example. ''; }; diff --git a/nixos/modules/services/web-apps/wiki-js.nix b/nixos/modules/services/web-apps/wiki-js.nix index 474fbb8f13c31..5dc0bb73259bf 100644 --- a/nixos/modules/services/web-apps/wiki-js.nix +++ b/nixos/modules/services/web-apps/wiki-js.nix @@ -95,12 +95,11 @@ in { }; description = '' Settings to configure <package>wiki-js</package>. This directly - corresponds to <link xlink:href="https://docs.requarks.io/install/config">the upstream - configuration options</link>. + corresponds to <link xlink:href="https://docs.requarks.io/install/config">the upstream configuration options</link>. Secrets can be injected via the environment by <itemizedlist> - <listitem><para>specifying <xref linkend="opt-services.wiki-js.environmentFile" /> + <listitem><para>specifying <xref linkend="opt-services.wiki-js.environmentFile"/> to contain secrets</para></listitem> <listitem><para>and setting sensitive values to <literal>$(ENVIRONMENT_VAR)</literal> with this value defined in the environment-file.</para></listitem> diff --git a/nixos/modules/services/web-apps/wordpress.nix b/nixos/modules/services/web-apps/wordpress.nix index 59471a739cbb7..b1ae4deb27617 100644 --- a/nixos/modules/services/web-apps/wordpress.nix +++ b/nixos/modules/services/web-apps/wordpress.nix @@ -192,7 +192,7 @@ let prefix. Typically this is changed if you are installing multiple WordPress blogs in the same database. - See <link xlink:href='https://codex.wordpress.org/Editing_wp-config.php#table_prefix'/>. + See <link xlink:href="https://codex.wordpress.org/Editing_wp-config.php#table_prefix"/>. ''; }; @@ -246,7 +246,7 @@ let description = '' Any additional text to be appended to the wp-config.php configuration file. This is a PHP script. For configuration - settings, see <link xlink:href='https://codex.wordpress.org/Editing_wp-config.php'/>. + settings, see <link xlink:href="https://codex.wordpress.org/Editing_wp-config.php"/>. ''; example = '' define( 'AUTOSAVE_INTERVAL', 60 ); // Seconds diff --git a/nixos/modules/services/web-servers/apache-httpd/vhost-options.nix b/nixos/modules/services/web-servers/apache-httpd/vhost-options.nix index e743eaa6215b1..559210a1418ce 100644 --- a/nixos/modules/services/web-servers/apache-httpd/vhost-options.nix +++ b/nixos/modules/services/web-servers/apache-httpd/vhost-options.nix @@ -261,8 +261,7 @@ in default = ""; example = "Disallow: /foo/"; description = '' - Specification of pages to be ignored by web crawlers. See <link - xlink:href='http://www.robotstxt.org/'/> for details. + Specification of pages to be ignored by web crawlers. See <link xlink:href="http://www.robotstxt.org/"/> for details. ''; }; @@ -280,8 +279,7 @@ in }; ''; description = '' - Declarative location config. See <link - xlink:href="https://httpd.apache.org/docs/2.4/mod/core.html#location"/> for details. + Declarative location config. See <link xlink:href="https://httpd.apache.org/docs/2.4/mod/core.html#location"/> for details. ''; }; diff --git a/nixos/modules/services/web-servers/nginx/default.nix b/nixos/modules/services/web-servers/nginx/default.nix index 5ccbaf77481b7..166f38f9ea284 100644 --- a/nixos/modules/services/web-servers/nginx/default.nix +++ b/nixos/modules/services/web-servers/nginx/default.nix @@ -504,16 +504,16 @@ in This is mutually exclusive to any other config option for <filename>nginx.conf</filename> except for <itemizedlist> - <listitem><para><xref linkend="opt-services.nginx.appendConfig" /> + <listitem><para><xref linkend="opt-services.nginx.appendConfig"/> </para></listitem> - <listitem><para><xref linkend="opt-services.nginx.httpConfig" /> + <listitem><para><xref linkend="opt-services.nginx.httpConfig"/> </para></listitem> - <listitem><para><xref linkend="opt-services.nginx.logError" /> + <listitem><para><xref linkend="opt-services.nginx.logError"/> </para></listitem> </itemizedlist> If additional verbatim config in addition to other options is needed, - <xref linkend="opt-services.nginx.appendConfig" /> should be used instead. + <xref linkend="opt-services.nginx.appendConfig"/> should be used instead. ''; }; diff --git a/nixos/modules/services/web-servers/uwsgi.nix b/nixos/modules/services/web-servers/uwsgi.nix index c76eb795a9ed6..af6c6c0661246 100644 --- a/nixos/modules/services/web-servers/uwsgi.nix +++ b/nixos/modules/services/web-servers/uwsgi.nix @@ -179,8 +179,7 @@ in { <para> When in Emperor mode, any capability to be inherited by a vassal must be specified again in the vassal configuration using <literal>cap</literal>. - See the uWSGI <link - xlink:href="https://uwsgi-docs.readthedocs.io/en/latest/Capabilities.html">docs</link> + See the uWSGI <link xlink:href="https://uwsgi-docs.readthedocs.io/en/latest/Capabilities.html">docs</link> for more information. </para> </note> diff --git a/nixos/modules/system/boot/initrd-network.nix b/nixos/modules/system/boot/initrd-network.nix index 43327fdd9da4b..eff125971d08c 100644 --- a/nixos/modules/system/boot/initrd-network.nix +++ b/nixos/modules/system/boot/initrd-network.nix @@ -53,9 +53,8 @@ in description = '' Add network connectivity support to initrd. The network may be configured using the <literal>ip</literal> kernel parameter, - as described in <link - xlink:href="https://www.kernel.org/doc/Documentation/filesystems/nfs/nfsroot.txt">the - kernel documentation</link>. Otherwise, if + as described in <link xlink:href="https://www.kernel.org/doc/Documentation/filesystems/nfs/nfsroot.txt">the kernel documentation</link>. + Otherwise, if <option>networking.useDHCP</option> is enabled, an IP address is acquired using DHCP. diff --git a/nixos/modules/system/boot/networkd.nix b/nixos/modules/system/boot/networkd.nix index b006ce77454fc..1849dcfe1e1e2 100644 --- a/nixos/modules/system/boot/networkd.nix +++ b/nixos/modules/system/boot/networkd.nix @@ -1170,8 +1170,7 @@ let <citerefentry><refentrytitle>systemd.netdev</refentrytitle> <manvolnum>5</manvolnum></citerefentry> for details. A detailed explanation about how VRFs work can be found in the - <link xlink:href="https://www.kernel.org/doc/Documentation/networking/vrf.txt">kernel - docs</link>. + <link xlink:href="https://www.kernel.org/doc/Documentation/networking/vrf.txt">kernel docs</link>. ''; }; @@ -1909,9 +1908,7 @@ in Extra command-line arguments to pass to systemd-networkd-wait-online. These also affect per-interface <literal>systemd-network-wait-online@</literal> services. - 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. + 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. ''; type = with types; listOf str; default = []; diff --git a/nixos/modules/system/boot/systemd/logind.nix b/nixos/modules/system/boot/systemd/logind.nix index 0df03e9769479..bd05c07e26f2e 100644 --- a/nixos/modules/system/boot/systemd/logind.nix +++ b/nixos/modules/system/boot/systemd/logind.nix @@ -31,8 +31,7 @@ in when the user logs out. If true, the scope unit corresponding to the session and all processes inside that scope will be terminated. If false, the scope is "abandoned" (see - <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.scope.html#"> - systemd.scope(5)</link>), and processes are not killed. + <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.scope.html#">systemd.scope(5)</link>), and processes are not killed. See <link xlink:href="https://www.freedesktop.org/software/systemd/man/logind.conf.html#KillUserProcesses=">logind.conf(5)</link> for more details. diff --git a/nixos/modules/tasks/network-interfaces.nix b/nixos/modules/tasks/network-interfaces.nix index e6cb2daaffca8..a462035329487 100644 --- a/nixos/modules/tasks/network-interfaces.nix +++ b/nixos/modules/tasks/network-interfaces.nix @@ -1292,7 +1292,7 @@ in description = '' Whether to enable IPv6 Privacy Extensions for interfaces not configured explicitly in - <xref linkend="opt-networking.interfaces._name_.tempAddress" />. + <xref linkend="opt-networking.interfaces._name_.tempAddress"/>. This sets the ipv6.conf.*.use_tempaddr sysctl for all interfaces. Possible values are: |