nixos/*: normalize link format

make (almost) all links appear on only a single line, with no
unnecessary whitespace, using double quotes for attributes. this lets us
automatically convert them to markdown easily.

the few remaining links are extremely long link in a gnome module, we'll
come back to those at a later date.

pennae 3aebb4a2 9c8531c8

+1 -2
nixos/modules/config/i18n.nix
···
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"/>.
'';
};
+1 -2
nixos/modules/config/users-groups.nix
···
<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.
'';
};
+1 -1
nixos/modules/config/xdg/portal.nix
···
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;
};
+1 -1
nixos/modules/hardware/tuxedo-keyboard.nix
···
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:
+1 -1
nixos/modules/programs/sway.nix
···
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 {
+2 -2
nixos/modules/security/acme/default.nix
···
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>
'';
};
+9 -20
nixos/modules/security/pam.nix
···
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>.
'';
};
···
<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>.
'';
};
···
<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>.
'';
};
···
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>
'';
};
···
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>
'';
};
···
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>.
'';
};
···
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 {
···
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 {
···
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>.
'';
};
};
+3 -6
nixos/modules/security/pam_mount.nix
···
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"/>.
'';
};
···
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"/>.
'';
};
···
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"/>.
'';
};
+1 -2
nixos/modules/security/pam_usb.nix
···
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"/>.
'';
};
+1 -2
nixos/modules/services/backup/zrepl.nix
···
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 {
+1 -2
nixos/modules/services/continuous-integration/github-runner.nix
···
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;
};
+1 -2
nixos/modules/services/databases/postgresql.nix
···
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
+2 -2
nixos/modules/services/databases/victoriametrics.nix
···
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.
'';
+1 -1
nixos/modules/services/development/zammad.nix
···
'';
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.
'';
};
+3 -1
nixos/modules/services/games/asf.nix
···
};
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 = { };
};
};
+2 -3
nixos/modules/services/hardware/udev.nix
···
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
+1 -2
nixos/modules/services/logging/filebeat.nix
···
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"/>.
'';
+1 -1
nixos/modules/services/mail/mailman.nix
···
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 {
+3 -3
nixos/modules/services/mail/sympa.nix
···
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.
'';
};
···
};
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.
'';
};
···
'';
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.
'';
};
+1 -2
nixos/modules/services/matrix/appservice-discord.nix
···
<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.
+1 -2
nixos/modules/services/matrix/mautrix-facebook.nix
···
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.
+1 -2
nixos/modules/services/matrix/mautrix-telegram.nix
···
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.
+1 -1
nixos/modules/services/misc/etcd.nix
···
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 = {};
+2 -2
nixos/modules/services/misc/etebase-server.nix
···
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 = {
+2 -3
nixos/modules/services/misc/geoipupdate.nix
···
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
···
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; };
+2 -2
nixos/modules/services/misc/persistent-evdev.nix
···
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"/>).
'';
+2 -2
nixos/modules/services/monitoring/cadvisor.nix
···
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>
'';
};
···
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.
'';
};
};
+1 -1
nixos/modules/services/monitoring/grafana-image-renderer.nix
···
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.
'';
};
+1 -1
nixos/modules/services/monitoring/graphite.nix
···
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 ''
+6 -6
nixos/modules/services/monitoring/munin.nix
···
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"/>.
'';
};
···
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"/>
'';
};
···
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_*]
···
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
···
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 ''
'''
+1 -1
nixos/modules/services/monitoring/nagios.nix
···
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 = "
+7 -12
nixos/modules/services/monitoring/parsedmarc.nix
···
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.
'';
};
···
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.
'';
};
···
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; };
···
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; };
···
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; };
+6 -9
nixos/modules/services/monitoring/prometheus/default.nix
···
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) ''
···
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" ''
···
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"/>
'';
};
};
···
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.
'';
};
+4 -4
nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix
···
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
+1 -1
nixos/modules/services/monitoring/prometheus/exporters/process.nix
···
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"/>
'';
};
};
+1 -1
nixos/modules/services/monitoring/prometheus/exporters/script.nix
···
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"/>
'';
};
};
+6 -6
nixos/modules/services/networking/bird-lg.nix
···
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>.
+
'';
};
};
···
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>.
+
'';
};
};
};
+1 -1
nixos/modules/services/networking/bird.nix
···
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 {
+4 -1
nixos/modules/services/networking/coredns.nix
···
}
'';
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 {
+1 -1
nixos/modules/services/networking/seafile.nix
···
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.
'';
};
+6 -6
nixos/modules/services/networking/ssh/sshd.nix
···
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"/>
'';
};
···
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"/>
'';
};
···
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"/>
'';
};
+2 -4
nixos/modules/services/networking/wireguard.nix
···
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>.
'';
};
···
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>.
'';
};
};
+1 -1
nixos/modules/services/networking/wpa_supplicant.nix
···
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>.
'';
+3 -3
nixos/modules/services/security/privacyidea.nix
···
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:
···
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>.
'';
};
···
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"/>.
'';
};
};
+2 -2
nixos/modules/services/security/step-ca.nix
···
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>.
+5 -5
nixos/modules/services/security/tor.nix
···
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
···
<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>
···
<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>
···
</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>
···
</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>
+1 -1
nixos/modules/services/security/vaultwarden/default.nix
···
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.
'';
};
+1 -2
nixos/modules/services/web-apps/hedgedoc.nix
···
'';
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 {
+6 -13
nixos/modules/services/web-apps/keycloak.nix
···
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.
'';
···
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.
'';
···
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>
'';
···
</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.
'';
};
};
···
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
+1 -1
nixos/modules/services/web-apps/mediawiki.nix
···
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"/>.
'';
};
+6 -6
nixos/modules/services/web-apps/nextcloud.nix
···
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";
···
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 ''
{
···
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.
'';
};
···
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.
'';
};
···
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;
};
+1 -2
nixos/modules/services/web-apps/node-red.nix
···
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.
'';
};
+2 -3
nixos/modules/services/web-apps/wiki-js.nix
···
};
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>
+2 -2
nixos/modules/services/web-apps/wordpress.nix
···
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"/>.
'';
};
···
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
+2 -4
nixos/modules/services/web-servers/apache-httpd/vhost-options.nix
···
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.
'';
};
···
};
'';
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.
'';
};
+4 -4
nixos/modules/services/web-servers/nginx/default.nix
···
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.
'';
};
+1 -2
nixos/modules/services/web-servers/uwsgi.nix
···
<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>
+2 -3
nixos/modules/system/boot/initrd-network.nix
···
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.
+2 -5
nixos/modules/system/boot/networkd.nix
···
<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>.
'';
};
···
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 = [];
+1 -2
nixos/modules/system/boot/systemd/logind.nix
···
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.
+1 -1
nixos/modules/tasks/network-interfaces.nix
···
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: