ilyakooo0/nixpkgs
1
0
Fork 0
mirror of https://github.com/ilyakooo0/nixpkgs.git synced 2024-09-21 20:49:52 +03:00
Code Issues Projects Releases Wiki Activity

nixos/*: normalize link format

Browse Source 
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.
This commit is contained in:
pennae 2022-08-03 03:05:47 +02:00
parent 9c8531c8a5
commit 3aebb4a2be
61 changed files with 140 additions and 189 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
nixos/modules/config/i18n.nix
View File

@ -75,8 +75,7 @@ with lib;
List of locales that the system should support. The value List of locales that the system should support. The value
<literal>"all"</literal> means that all locales supported by <literal>"all"</literal> means that all locales supported by
Glibc will be installed. A full list of supported locales Glibc will be installed. A full list of supported locales
can be found at <link can be found at <link xlink:href="https://sourceware.org/git/?p=glibc.git;a=blob;f=localedata/SUPPORTED"/>.
xlink:href="https://sourceware.org/git/?p=glibc.git;a=blob;f=localedata/SUPPORTED"/>.
''; '';
}; };

3
nixos/modules/config/users-groups.nix
View File

@ -156,8 +156,7 @@ let
<filename>pam_mount.conf.xml</filename>. <filename>pam_mount.conf.xml</filename>.
Useful attributes might include <literal>path</literal>, Useful attributes might include <literal>path</literal>,
<literal>options</literal>, <literal>fstype</literal>, and <literal>server</literal>. <literal>options</literal>, <literal>fstype</literal>, and <literal>server</literal>.
See <link See <link xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html"/>
xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html" />
for more information. for more information.
''; '';
}; };

2
nixos/modules/config/xdg/portal.nix
View File

@ -33,7 +33,7 @@ in
options.xdg.portal = { options.xdg.portal = {
enable = 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; default = false;
}; };

2
nixos/modules/hardware/tuxedo-keyboard.nix
View File

@ -13,7 +13,7 @@ in
To configure the driver, pass the options to the <option>boot.kernelParams</option> configuration. 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. 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: 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:

2
nixos/modules/programs/sway.nix
View File

@ -39,7 +39,7 @@ in {
Sway, the i3-compatible tiling Wayland compositor. You can manually launch Sway, the i3-compatible tiling Wayland compositor. You can manually launch
Sway by executing "exec sway" on a TTY. Copy /etc/sway/config to Sway by executing "exec sway" on a TTY. Copy /etc/sway/config to
~/.config/sway/config to modify the default configuration. See ~/.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''; "man 5 sway" for more information'';
wrapperFeatures = mkOption { wrapperFeatures = mkOption {

4
nixos/modules/security/acme/default.nix
View File

@ -581,8 +581,8 @@ let
Turns on the OCSP Must-Staple TLS extension. Turns on the OCSP Must-Staple TLS extension.
Make sure you know what you're doing! See: Make sure you know what you're doing! See:
<itemizedlist> <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.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.hboeck.de/archives/886-The-Problem-with-OCSP-Stapling-and-Must-Staple-and-why-Certificate-Revocation-is-still-broken.html"/></para></listitem>
</itemizedlist> </itemizedlist>
''; '';
}; };

29
nixos/modules/security/pam.nix
View File

@ -831,8 +831,7 @@ in
If set, users can log in with SSH keys and PKCS#11 tokens. If set, users can log in with SSH keys and PKCS#11 tokens.
More information can be found <link More information can be found <link xlink:href="https://github.com/OpenSC/pam_p11">here</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> <literal>username:first_keyHandle,first_public_key: second_keyHandle,second_public_key</literal>
This file can be generated using <command>pamu2fcfg</command> command. This file can be generated using <command>pamu2fcfg</command> command.
More information can be found <link More information can be found <link xlink:href="https://developers.yubico.com/pam-u2f/">here</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> <literal>username:first_keyHandle,first_public_key: second_keyHandle,second_public_key</literal>
This file can be generated using <command>pamu2fcfg</command> command. This file can be generated using <command>pamu2fcfg</command> command.
More information can be found <link More information can be found <link xlink:href="https://developers.yubico.com/pam-u2f/">here</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 When using <command>pamu2fcfg</command>, you can specify your
application ID with the <literal>-i</literal> flag. application ID with the <literal>-i</literal> flag.
More information can be found <link More information can be found <link xlink:href="https://developers.yubico.com/pam-u2f/Manuals/pam_u2f.8.html">here</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 When using <command>pamu2fcfg</command>, you can specify your
application ID with the <literal>-o</literal> flag. application ID with the <literal>-o</literal> flag.
More information can be found <link More information can be found <link xlink:href="https://developers.yubico.com/pam-u2f/Manuals/pam_u2f.8.html">here</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 Note that this module must both be enabled using this option and on a
per-PAM-service level as well (using <literal>usshAuth</literal>). per-PAM-service level as well (using <literal>usshAuth</literal>).
More information can be found <link More information can be found <link xlink:href="https://github.com/uber/pam-ussh">here</link>.
xlink:href="https://github.com/uber/pam-ussh">here</link>.
''; '';
}; };
@ -1084,8 +1076,7 @@ in
The file must have only one line: The file must have only one line:
<literal>username:yubikey_token_id1:yubikey_token_id2</literal> <literal>username:yubikey_token_id1:yubikey_token_id2</literal>
More information can be found <link More information can be found <link xlink:href="https://developers.yubico.com/yubico-pam/">here</link>.
xlink:href="https://developers.yubico.com/yubico-pam/">here</link>.
''; '';
}; };
control = mkOption { control = mkOption {
@ -1130,8 +1121,7 @@ in
Challenge-Response configurations. See the man-page ykpamcfg(1) for further Challenge-Response configurations. See the man-page ykpamcfg(1) for further
details on how to configure offline Challenge-Response validation. details on how to configure offline Challenge-Response validation.
More information can be found <link More information can be found <link xlink:href="https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html">here</link>.
xlink:href="https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html">here</link>.
''; '';
}; };
challengeResponsePath = mkOption { challengeResponsePath = mkOption {
@ -1140,8 +1130,7 @@ in
description = '' description = ''
If not null, set the path used by yubico pam module where the challenge expected response is stored. If not null, set the path used by yubico pam module where the challenge expected response is stored.
More information can be found <link More information can be found <link xlink:href="https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html">here</link>.
xlink:href="https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html">here</link>.
''; '';
}; };
}; };

9
nixos/modules/security/pam_mount.nix
View File

@ -33,8 +33,7 @@ in
default = []; default = [];
description = '' description = ''
List of volume definitions for pam_mount. List of volume definitions for pam_mount.
For more information, visit <link For more information, visit <link xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html"/>.
xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html" />.
''; '';
}; };
@ -67,8 +66,7 @@ in
description = '' description = ''
Sets the Debug-Level. 0 disables debugging, 1 enables pam_mount tracing, Sets the Debug-Level. 0 disables debugging, 1 enables pam_mount tracing,
and 2 additionally enables tracing in mount.crypt. The default is 0. and 2 additionally enables tracing in mount.crypt. The default is 0.
For more information, visit <link For more information, visit <link xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html"/>.
xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html" />.
''; '';
}; };
@ -78,8 +76,7 @@ in
description = '' description = ''
Amount of microseconds to wait until killing remaining processes after Amount of microseconds to wait until killing remaining processes after
final logout. final logout.
For more information, visit <link For more information, visit <link xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html"/>.
xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html" />.
''; '';
}; };

3
nixos/modules/security/pam_usb.nix
View File

@ -19,8 +19,7 @@ in
default = false; default = false;
description = '' description = ''
Enable USB login for all login systems that support it. For Enable USB login for all login systems that support it. For
more information, visit <link more information, visit <link xlink:href="https://github.com/aluzzardi/pam_usb/wiki/Getting-Started#setting-up-devices-and-users"/>.
xlink:href="https://github.com/aluzzardi/pam_usb/wiki/Getting-Started#setting-up-devices-and-users" />.
''; '';
}; };

3
nixos/modules/services/backup/zrepl.nix
View File

@ -23,8 +23,7 @@ in
settings = mkOption { settings = mkOption {
default = { }; default = { };
description = '' description = ''
Configuration for zrepl. See <link Configuration for zrepl. See <link xlink:href="https://zrepl.github.io/configuration.html"/>
xlink:href="https://zrepl.github.io/configuration.html"/>
for more information. for more information.
''; '';
type = types.submodule { type = types.submodule {

3
nixos/modules/services/continuous-integration/github-runner.nix
View File

@ -22,8 +22,7 @@ in
Whether to enable GitHub Actions runner. Whether to enable GitHub Actions runner.
Note: GitHub recommends using self-hosted runners with private repositories only. Learn more here: 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" <link xlink:href="https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners">About self-hosted runners</link>.
>About self-hosted runners</link>.
''; '';
type = lib.types.bool; type = lib.types.bool;
}; };

3
nixos/modules/services/databases/postgresql.nix
View File

@ -81,8 +81,7 @@ in
default = ""; default = "";
description = '' description = ''
Defines how users authenticate themselves to the server. See the Defines how users authenticate themselves to the server. See the
<link xlink:href="https://www.postgresql.org/docs/current/auth-pg-hba-conf.html"> <link xlink:href="https://www.postgresql.org/docs/current/auth-pg-hba-conf.html">PostgreSQL documentation for pg_hba.conf</link>
PostgreSQL documentation for pg_hba.conf</link>
for details on the expected format of this option. By default, for details on the expected format of this option. By default,
peer based authentication will be used for users connecting peer based authentication will be used for users connecting
via the Unix socket, and md5 password authentication will be via the Unix socket, and md5 password authentication will be

4
nixos/modules/services/databases/victoriametrics.nix
View File

@ -29,8 +29,8 @@ let cfg = config.services.victoriametrics; in
type = types.listOf types.str; type = types.listOf types.str;
default = []; default = [];
description = '' description = ''
Extra options to pass to VictoriaMetrics. See the README: <link Extra options to pass to VictoriaMetrics. See the README:
xlink:href="https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/README.md" /> <link xlink:href="https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/README.md"/>
or <command>victoriametrics -help</command> for more or <command>victoriametrics -help</command> for more
information. information.
''; '';

2
nixos/modules/services/development/zammad.nix
View File

@ -139,7 +139,7 @@ in
''; '';
description = '' description = ''
The <filename>database.yml</filename> configuration file as key value set. 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. for list of configuration parameters.
''; '';
}; };

4
nixos/modules/services/games/asf.nix
View File

@ -136,7 +136,9 @@ in
}; };
settings = mkOption { settings = mkOption {
type = types.attrs; 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 = { }; default = { };
}; };
}; };

5
nixos/modules/services/hardware/udev.nix
View File

@ -282,9 +282,8 @@ in
default = true; default = true;
type = types.bool; type = types.bool;
description = '' description = ''
Whether to assign <link Whether to assign <link xlink:href="http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames">predictable names to network interfaces</link>.
xlink:href='http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames'>predictable If enabled, interfaces
names to network interfaces</link>. If enabled, interfaces
are assigned names that contain topology information are assigned names that contain topology information
(e.g. <literal>wlp3s0</literal>) and thus should be stable (e.g. <literal>wlp3s0</literal>) and thus should be stable
across reboots. If disabled, names depend on the order in across reboots. If disabled, names depend on the order in

3
nixos/modules/services/logging/filebeat.nix
View File

@ -161,8 +161,7 @@ in
internal = true; internal = true;
description = '' description = ''
Inputs specify how Filebeat locates and processes Inputs specify how Filebeat locates and processes
input data. Use <xref input data. Use <xref linkend="opt-services.filebeat.inputs"/> instead.
linkend="opt-services.filebeat.inputs"/> instead.
See <link xlink:href="https://www.elastic.co/guide/en/beats/filebeat/current/configuration-filebeat-options.html"/>. See <link xlink:href="https://www.elastic.co/guide/en/beats/filebeat/current/configuration-filebeat-options.html"/>.
''; '';

2
nixos/modules/services/mail/mailman.nix
View File

@ -114,7 +114,7 @@ in {
example = "/run/secrets/ldap-bind"; example = "/run/secrets/ldap-bind";
description = '' description = ''
Path to the file containing the bind password of the servie account 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 { superUserGroup = mkOption {

6
nixos/modules/services/mail/sympa.nix
View File

@ -88,7 +88,7 @@ in
example = "cs"; example = "cs";
description = '' description = ''
Default Sympa language. 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. for available options.
''; '';
}; };
@ -138,7 +138,7 @@ in
}; };
description = '' description = ''
The <filename>robot.conf</filename> configuration file as key value set. 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. for list of configuration parameters.
''; '';
}; };
@ -287,7 +287,7 @@ in
''; '';
description = '' description = ''
The <filename>sympa.conf</filename> configuration file as key value set. 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. for list of configuration parameters.
''; '';
}; };

3
nixos/modules/services/matrix/appservice-discord.nix
View File

@ -44,8 +44,7 @@ in {
<filename>config.yaml</filename> configuration as a Nix attribute set. <filename>config.yaml</filename> configuration as a Nix attribute set.
Configuration options should match those described in Configuration options should match those described in
<link xlink:href="https://github.com/Half-Shot/matrix-appservice-discord/blob/master/config/config.sample.yaml"> <link xlink:href="https://github.com/Half-Shot/matrix-appservice-discord/blob/master/config/config.sample.yaml">config.sample.yaml</link>.
config.sample.yaml</link>.
<option>config.bridge.domain</option> and <option>config.bridge.homeserverUrl</option> <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. should be set to match the public host name of the Matrix homeserver for webhooks and avatars to work.

3
nixos/modules/services/matrix/mautrix-facebook.nix
View File

@ -78,8 +78,7 @@ in {
description = '' description = ''
<filename>config.yaml</filename> configuration as a Nix attribute set. <filename>config.yaml</filename> configuration as a Nix attribute set.
Configuration options should match those described in Configuration options should match those described in
<link xlink:href="https://github.com/mautrix/facebook/blob/master/mautrix_facebook/example-config.yaml"> <link xlink:href="https://github.com/mautrix/facebook/blob/master/mautrix_facebook/example-config.yaml">example-config.yaml</link>.
example-config.yaml</link>.
Secret tokens should be specified using <option>environmentFile</option> Secret tokens should be specified using <option>environmentFile</option>
instead of this world-readable attribute set. instead of this world-readable attribute set.

3
nixos/modules/services/matrix/mautrix-telegram.nix
View File

@ -81,8 +81,7 @@ in {
description = '' description = ''
<filename>config.yaml</filename> configuration as a Nix attribute set. <filename>config.yaml</filename> configuration as a Nix attribute set.
Configuration options should match those described in Configuration options should match those described in
<link xlink:href="https://github.com/tulir/mautrix-telegram/blob/master/example-config.yaml"> <link xlink:href="https://github.com/tulir/mautrix-telegram/blob/master/example-config.yaml">example-config.yaml</link>.
example-config.yaml</link>.
Secret tokens should be specified using <option>environmentFile</option> Secret tokens should be specified using <option>environmentFile</option>
instead of this world-readable attribute set. instead of this world-readable attribute set.

2
nixos/modules/services/misc/etcd.nix
View File

@ -127,7 +127,7 @@ in {
extraConf = mkOption { extraConf = mkOption {
description = '' description = ''
Etcd extra configuration. See 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; type = types.attrsOf types.str;
default = {}; default = {};

4
nixos/modules/services/misc/etebase-server.nix
View File

@ -135,8 +135,8 @@ in
default = {}; default = {};
description = '' description = ''
Configuration for <package>etebase-server</package>. Refer to Configuration for <package>etebase-server</package>. Refer to
<link xlink:href="https://github.com/etesync/server/blob/master/etebase-server.ini.example" /> <link xlink:href="https://github.com/etesync/server/blob/master/etebase-server.ini.example"/>
and <link xlink:href="https://github.com/etesync/server/wiki" /> and <link xlink:href="https://github.com/etesync/server/wiki"/>
for details on supported values. for details on supported values.
''; '';
example = { example = {

5
nixos/modules/services/misc/geoipupdate.nix
View File

@ -40,7 +40,7 @@ in
description = '' description = ''
<productname>geoipupdate</productname> configuration <productname>geoipupdate</productname> configuration
options. See 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. for a full list of available options.
Settings containing secret data should be set to an Settings containing secret data should be set to an
@ -92,8 +92,7 @@ in
Always handled as a secret whether the value is Always handled as a secret whether the value is
wrapped in a <literal>{ _secret = ...; }</literal> wrapped in a <literal>{ _secret = ...; }</literal>
attrset or not (refer to <xref attrset or not (refer to <xref linkend="opt-services.geoipupdate.settings"/> for
linkend="opt-services.geoipupdate.settings" /> for
details). details).
''; '';
apply = x: if isAttrs x then x else { _secret = x; }; apply = x: if isAttrs x then x else { _secret = x; };

4
nixos/modules/services/misc/persistent-evdev.nix
View File

@ -22,8 +22,8 @@ in
Physical devices should already exist in <filename class="devicefile">/dev/input/by-id/</filename>. 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. 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"> See the <link xlink:href="https://github.com/aiberia/persistent-evdev#example-usage-with-libvirt">project page</link>
project page</link> for example configuration of virtual devices with libvirt for example configuration of virtual devices with libvirt
and remember to add <literal>uinput-*</literal> devices to the qemu 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"/>). <literal>cgroup_device_acl</literal> list (see <xref linkend="opt-virtualisation.libvirtd.qemu.verbatimConfig"/>).
''; '';

4
nixos/modules/services/monitoring/cadvisor.nix
View File

@ -75,7 +75,7 @@ in {
world-readable Nix store that contains the value of <option>storageDriverPassword</option>. 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. 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 = '' description = ''
Additional cadvisor options. 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.
''; '';
}; };
}; };

2
nixos/modules/services/monitoring/grafana-image-renderer.nix
View File

@ -92,7 +92,7 @@ in {
description = '' description = ''
Configuration attributes for <package>grafana-image-renderer</package>. 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. for supported values.
''; '';
}; };

2
nixos/modules/services/monitoring/graphite.nix
View File

@ -253,7 +253,7 @@ in {
default = {}; default = {};
description = '' description = ''
Extra seyren configuration. See 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; type = types.attrsOf types.str;
example = literalExpression '' example = literalExpression ''

12
nixos/modules/services/monitoring/munin.nix
View File

@ -142,7 +142,7 @@ in
Enable Munin Node agent. Munin node listens on 0.0.0.0 and 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. 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; type = types.lines;
description = '' description = ''
<filename>munin-node.conf</filename> extra configuration. See <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; type = types.lines;
description = '' description = ''
<filename>plugin-conf.d</filename> extra plugin configuration. See <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 = '' example = ''
[fail2ban_*] [fail2ban_*]
@ -268,9 +268,9 @@ in
type = types.lines; type = types.lines;
description = '' description = ''
<filename>munin.conf</filename> extra global configuration. <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 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 = '' example = ''
contact.email.command mail -s "Munin notification for ''${var:host}" someone@example.com contact.email.command mail -s "Munin notification for ''${var:host}" someone@example.com
@ -283,7 +283,7 @@ in
description = '' description = ''
Definitions of hosts of nodes to collect data from. Needs at least one Definitions of hosts of nodes to collect data from. Needs at least one
host for cron to succeed. See 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 '' example = literalExpression ''
''' '''

2
nixos/modules/services/monitoring/nagios.nix
View File

@ -88,7 +88,7 @@ in
options = { options = {
services.nagios = { 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 { objectDefs = mkOption {
description = " description = "

19
nixos/modules/services/monitoring/parsedmarc.nix
View File

@ -69,14 +69,12 @@ in
type = lib.types.bool; type = lib.types.bool;
default = true; default = true;
description = '' description = ''
Whether to enable and configure the <link Whether to enable and configure the <link linkend="opt-services.geoipupdate.enable">geoipupdate</link>
linkend="opt-services.geoipupdate.enable">geoipupdate</link>
service to automatically fetch GeoIP databases. Not crucial, service to automatically fetch GeoIP databases. Not crucial,
but recommended for full functionality. but recommended for full functionality.
To finish the setup, you need to manually set the <xref To finish the setup, you need to manually set the <xref linkend="opt-services.geoipupdate.settings.AccountID"/> and
linkend="opt-services.geoipupdate.settings.AccountID" /> and <xref linkend="opt-services.geoipupdate.settings.LicenseKey"/>
<xref linkend="opt-services.geoipupdate.settings.LicenseKey" />
options. options.
''; '';
}; };
@ -101,7 +99,7 @@ in
Whether the automatically provisioned Elasticsearch Whether the automatically provisioned Elasticsearch
instance should be added as a grafana datasource. Has no instance should be added as a grafana datasource. Has no
effect unless effect unless
<xref linkend="opt-services.parsedmarc.provision.elasticsearch" /> <xref linkend="opt-services.parsedmarc.provision.elasticsearch"/>
is also enabled. is also enabled.
''; '';
}; };
@ -213,8 +211,7 @@ in
Always handled as a secret whether the value is Always handled as a secret whether the value is
wrapped in a <literal>{ _secret = ...; }</literal> wrapped in a <literal>{ _secret = ...; }</literal>
attrset or not (refer to <xref attrset or not (refer to <xref linkend="opt-services.parsedmarc.settings"/> for
linkend="opt-services.parsedmarc.settings" /> for
details). details).
''; '';
apply = x: if isAttrs x || x == null then x else { _secret = x; }; 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 Always handled as a secret whether the value is
wrapped in a <literal>{ _secret = ...; }</literal> wrapped in a <literal>{ _secret = ...; }</literal>
attrset or not (refer to <xref attrset or not (refer to <xref linkend="opt-services.parsedmarc.settings"/> for
linkend="opt-services.parsedmarc.settings" /> for
details). details).
''; '';
apply = x: if isAttrs x || x == null then x else { _secret = x; }; 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 Always handled as a secret whether the value is
wrapped in a <literal>{ _secret = ...; }</literal> wrapped in a <literal>{ _secret = ...; }</literal>
attrset or not (refer to <xref attrset or not (refer to <xref linkend="opt-services.parsedmarc.settings"/> for
linkend="opt-services.parsedmarc.settings" /> for
details). details).
''; '';
apply = x: if isAttrs x || x == null then x else { _secret = x; }; apply = x: if isAttrs x || x == null then x else { _secret = x; };

15
nixos/modules/services/monitoring/prometheus/default.nix
View File

@ -379,9 +379,8 @@ let
gce_sd_configs = mkOpt (types.listOf promTypes.gce_sd_config) '' gce_sd_configs = mkOpt (types.listOf promTypes.gce_sd_config) ''
List of Google Compute Engine service discovery configurations. List of Google Compute Engine service discovery configurations.
See <link See <link xlink:href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#gce_sd_config">the relevant Prometheus configuration docs</link>
xlink:href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#gce_sd_config">the for more detail.
relevant Prometheus configuration docs</link> for more detail.
''; '';
hetzner_sd_configs = mkOpt (types.listOf promTypes.hetzner_sd_config) '' hetzner_sd_configs = mkOpt (types.listOf promTypes.hetzner_sd_config) ''
@ -807,9 +806,7 @@ let
filter = mkOpt types.str '' filter = mkOpt types.str ''
Filter can be used optionally to filter the instance list by other Filter can be used optionally to filter the instance list by other
criteria Syntax of this filter string is described here in the filter criteria Syntax of this filter string is described here in the filter
query parameter section: <link query parameter section: <link xlink:href="https://cloud.google.com/compute/docs/reference/latest/instances/list"/>.
xlink:href="https://cloud.google.com/compute/docs/reference/latest/instances/list"
/>.
''; '';
refresh_interval = mkDefOpt types.str "60s" '' refresh_interval = mkDefOpt types.str "60s" ''
@ -825,7 +822,7 @@ let
The tag separator used to separate concatenated GCE instance network tags. The tag separator used to separate concatenated GCE instance network tags.
See the GCP documentation on network tags for more information: 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 '' auth_token = mkOpt types.str ''
Optional authentication information for token-based authentication: 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. It is mutually exclusive with <literal>auth_token_file</literal> and other authentication mechanisms.
''; '';
auth_token_file = mkOpt types.str '' auth_token_file = mkOpt types.str ''
Optional authentication information for token-based authentication: 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. It is mutually exclusive with <literal>auth_token</literal> and other authentication mechanisms.
''; '';
}; };

8
nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix
View File

@ -33,10 +33,10 @@ in
work with this exporter: work with this exporter:
<programlisting> <programlisting>
{ {
<xref linkend="opt-services.prometheus.exporters.dovecot.enable" /> = true; <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.prometheus.exporters.dovecot.socketPath"/> = "/var/run/dovecot2/old-stats";
<xref linkend="opt-services.dovecot2.mailPlugins.globally.enable" /> = [ "old_stats" ]; <xref linkend="opt-services.dovecot2.mailPlugins.globally.enable"/> = [ "old_stats" ];
<xref linkend="opt-services.dovecot2.extraConfig" /> = ''' <xref linkend="opt-services.dovecot2.extraConfig"/> = '''
service old-stats { service old-stats {
unix_listener old-stats { unix_listener old-stats {
user = dovecot-exporter user = dovecot-exporter

2
nixos/modules/services/monitoring/prometheus/exporters/process.nix
View File

@ -22,7 +22,7 @@ in
All settings expressed as an Nix attrset. All settings expressed as an Nix attrset.
Check the official documentation for the corresponding YAML 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"/>
''; '';
}; };
}; };

2
nixos/modules/services/monitoring/prometheus/exporters/script.nix
View File

@ -41,7 +41,7 @@ in
All settings expressed as an Nix attrset. All settings expressed as an Nix attrset.
Check the official documentation for the corresponding YAML 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"/>
''; '';
}; };
}; };

12
nixos/modules/services/networking/bird-lg.nix
View File

@ -136,9 +136,9 @@ in
extraArgs = mkOption { extraArgs = mkOption {
type = types.lines; type = types.lines;
default = ""; default = "";
description = " description = ''
Extra parameters documented <link xlink:href=\"https://github.com/xddxdd/bird-lg-go#frontend\">here</link>. Extra parameters documented <link xlink:href="https://github.com/xddxdd/bird-lg-go#frontend">here</link>.
"; '';
}; };
}; };
@ -183,9 +183,9 @@ in
extraArgs = mkOption { extraArgs = mkOption {
type = types.lines; type = types.lines;
default = ""; default = "";
description = " description = ''
Extra parameters documented <link xlink:href=\"https://github.com/xddxdd/bird-lg-go#proxy\">here</link>. Extra parameters documented <link xlink:href="https://github.com/xddxdd/bird-lg-go#proxy">here</link>.
"; '';
}; };
}; };
}; };

2
nixos/modules/services/networking/bird.nix
View File

@ -15,7 +15,7 @@ in
type = types.lines; type = types.lines;
description = '' description = ''
BIRD Internet Routing Daemon configuration file. BIRD Internet Routing Daemon configuration file.
<link xlink:href='http://bird.network.cz/'/> <link xlink:href="http://bird.network.cz/"/>
''; '';
}; };
checkConfig = mkOption { checkConfig = mkOption {

5
nixos/modules/services/networking/coredns.nix
View File

@ -17,7 +17,10 @@ in {
} }
''; '';
type = types.lines; 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 { package = mkOption {

2
nixos/modules/services/networking/seafile.nix
View File

@ -133,7 +133,7 @@ in {
type = types.lines; type = types.lines;
description = '' description = ''
Extra config to append to `seahub_settings.py` file. 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. for all available options.
''; '';
}; };

12
nixos/modules/services/networking/ssh/sshd.nix
View File

@ -302,9 +302,9 @@ in
Allowed key exchange algorithms Allowed key exchange algorithms
Uses the lower bound recommended in both 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 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 Allowed ciphers
Defaults to recommended settings from both 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 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 Allowed MACs
Defaults to recommended settings from both 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 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"/>
''; '';
}; };

6
nixos/modules/services/networking/wireguard.nix
View File

@ -122,8 +122,7 @@ let
WireGuard interface is created, and which retains the socket even if the WireGuard interface is created, and which retains the socket even if the
interface is moved via <option>interfaceNamespace</option>. When interface is moved via <option>interfaceNamespace</option>. When
<literal>null</literal>, the interface is created in the init namespace. <literal>null</literal>, the interface is created in the init namespace.
See <link See <link xlink:href="https://www.wireguard.com/netns/">documentation</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 interface is moved to. The special value <literal>init</literal> means
the init namespace. When <literal>null</literal>, the interface is not the init namespace. When <literal>null</literal>, the interface is not
moved. moved.
See <link See <link xlink:href="https://www.wireguard.com/netns/">documentation</link>.
xlink:href="https://www.wireguard.com/netns/">documentation</link>.
''; '';
}; };
}; };

2
nixos/modules/services/networking/wpa_supplicant.nix
View File

@ -190,7 +190,7 @@ in {
description = '' description = ''
Whether to allow configuring networks "imperatively" (e.g. via Whether to allow configuring networks "imperatively" (e.g. via
<package>wpa_supplicant_gui</package>) and declaratively 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>. Please note that this adds a custom patch to <package>wpa_supplicant</package>.
''; '';

6
nixos/modules/services/security/privacyidea.nix
View File

@ -78,7 +78,7 @@ in
using <package>envsubst</package> which is helpful for specifying using <package>envsubst</package> which is helpful for specifying
secrets: secrets:
<programlisting> <programlisting>
{ <xref linkend="opt-services.privacyidea.secretKey" /> = "$SECRET"; } { <xref linkend="opt-services.privacyidea.secretKey"/> = "$SECRET"; }
</programlisting> </programlisting>
The environment-file can now specify the actual secret key: The environment-file can now specify the actual secret key:
@ -207,7 +207,7 @@ in
description = '' description = ''
Attribute-set containing the settings for <package>privacyidea-ldap-proxy</package>. Attribute-set containing the settings for <package>privacyidea-ldap-proxy</package>.
It's possible to pass secrets using env-vars as substitutes and 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>. to inject them via <package>envsubst</package>.
''; '';
}; };
@ -217,7 +217,7 @@ in
type = types.nullOr types.str; type = types.nullOr types.str;
description = '' description = ''
Environment file containing secrets to be substituted into Environment file containing secrets to be substituted into
<xref linkend="opt-services.privacyidea.ldap-proxy.settings" />. <xref linkend="opt-services.privacyidea.ldap-proxy.settings"/>.
''; '';
}; };
}; };

4
nixos/modules/services/security/step-ca.nix
View File

@ -36,8 +36,8 @@ in
type = with lib.types; attrsOf anything; type = with lib.types; attrsOf anything;
description = '' description = ''
Settings that go into <filename>ca.json</filename>. See Settings that go into <filename>ca.json</filename>. See
<link xlink:href="https://smallstep.com/docs/step-ca/configuration"> <link xlink:href="https://smallstep.com/docs/step-ca/configuration">the step-ca manual</link>
the step-ca manual</link> for more information. The easiest way to for more information. The easiest way to
configure this module would be to run <literal>step ca init</literal> configure this module would be to run <literal>step ca init</literal>
to generate <filename>ca.json</filename> and then import it using to generate <filename>ca.json</filename> and then import it using
<literal>builtins.fromJSON</literal>. <literal>builtins.fromJSON</literal>.

10
nixos/modules/services/security/tor.nix
View File

@ -287,7 +287,7 @@ in
relay = { relay = {
enable = mkEnableOption ''relaying of Tor traffic for others. 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. for details.
Setting this to true requires setting Setting this to true requires setting
@ -348,7 +348,7 @@ in
<para> <para>
See 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. for more info.
</para> </para>
</listitem> </listitem>
@ -366,7 +366,7 @@ in
<para> <para>
Using this option will make Tor advertise your bridge Using this option will make Tor advertise your bridge
to users through various mechanisms like to users through various mechanisms like
<link xlink:href="https://bridges.torproject.org/" />, though. <link xlink:href="https://bridges.torproject.org/"/>, though.
</para> </para>
<important> <important>
@ -384,7 +384,7 @@ in
</important> </important>
<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. for more info.
</para> </para>
</listitem> </listitem>
@ -419,7 +419,7 @@ in
</para> </para>
<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. for more info.
</para> </para>
</listitem> </listitem>

2
nixos/modules/services/security/vaultwarden/default.nix
View File

@ -116,7 +116,7 @@ in {
The available configuration options can be found 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>. <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. to set up access to the Admin UI to invite initial users.
''; '';
}; };

3
nixos/modules/services/web-apps/hedgedoc.nix
View File

@ -152,8 +152,7 @@ in
''; '';
description = '' description = ''
Specify the Content Security Policy which is passed to Helmet. Specify the Content Security Policy which is passed to Helmet.
For configuration details see <link xlink:href="https://helmetjs.github.io/docs/csp/" For configuration details see <link xlink:href="https://helmetjs.github.io/docs/csp/"/>.
>https://helmetjs.github.io/docs/csp/</link>.
''; '';
}; };
protocolUseSSL = mkOption { protocolUseSSL = mkOption {

19
nixos/modules/services/web-apps/keycloak.nix
View File

@ -215,8 +215,7 @@ in
manually provisioned database; has no effect when a local manually provisioned database; has no effect when a local
database is automatically provisioned. database is automatically provisioned.
To use this with a local database, set <xref To use this with a local database, set <xref linkend="opt-services.keycloak.database.createLocally"/> to
linkend="opt-services.keycloak.database.createLocally" /> to
<literal>false</literal> and create the database and user <literal>false</literal> and create the database and user
manually. manually.
''; '';
@ -230,8 +229,7 @@ in
provisioned database; has no effect when a local database is provisioned database; has no effect when a local database is
automatically provisioned. automatically provisioned.
To use this with a local database, set <xref To use this with a local database, set <xref linkend="opt-services.keycloak.database.createLocally"/> to
linkend="opt-services.keycloak.database.createLocally" /> to
<literal>false</literal> and create the database and user <literal>false</literal> and create the database and user
manually. manually.
''; '';
@ -329,10 +327,8 @@ in
want to set this to <literal>/auth</literal> to want to set this to <literal>/auth</literal> to
keep compatibility with your clients. keep compatibility with your clients.
See <link See <link xlink:href="https://www.keycloak.org/migration/migrating-to-quarkus"/>
xlink:href="https://www.keycloak.org/migration/migrating-to-quarkus" for more information on migrating from Wildfly to Quarkus.
/> for more information on migrating from Wildfly
to Quarkus.
</para> </para>
</note> </note>
''; '';
@ -404,9 +400,7 @@ in
</varlistentry> </varlistentry>
</variablelist> </variablelist>
See <link See <link xlink:href="https://www.keycloak.org/server/reverseproxy"/> for more information.
xlink:href="https://www.keycloak.org/server/reverseproxy"
/> for more information.
''; '';
}; };
}; };
@ -425,8 +419,7 @@ in
Configuration options corresponding to parameters set in Configuration options corresponding to parameters set in
<filename>conf/keycloak.conf</filename>. <filename>conf/keycloak.conf</filename>.
Most available options are documented at <link Most available options are documented at <link xlink:href="https://www.keycloak.org/server/all-config"/>.
xlink:href="https://www.keycloak.org/server/all-config" />.
Options containing secret data should be set to an attribute Options containing secret data should be set to an attribute
set containing the attribute <literal>_secret</literal> - a set containing the attribute <literal>_secret</literal> - a

2
nixos/modules/services/web-apps/mediawiki.nix
View File

@ -280,7 +280,7 @@ in
one version of MediaWiki, or have other applications that also use the 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 database, you can give the table names a unique prefix to stop any naming
conflicts or confusion. 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"/>.
''; '';
}; };

12
nixos/modules/services/web-apps/nextcloud.nix
View File

@ -94,7 +94,7 @@ in {
default = config.services.nextcloud.home; default = config.services.nextcloud.home;
defaultText = literalExpression "config.services.nextcloud.home"; defaultText = literalExpression "config.services.nextcloud.home";
description = '' 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)."; 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"; example = "/mnt/nextcloud-file";
@ -105,7 +105,7 @@ in {
description = '' description = ''
Extra apps to install. Should be an attrSet of appid to packages generated by fetchNextcloudApp. 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. 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 '' example = literalExpression ''
{ {
@ -128,7 +128,7 @@ in {
type = types.bool; type = types.bool;
default = true; default = true;
description = '' 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. 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; example = true;
description = '' description = ''
Allow the installation of apps and app updates from the store. 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" />. 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 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. 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). 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 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). 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; default = true;
}; };

3
nixos/modules/services/web-apps/node-red.nix
View File

@ -49,8 +49,7 @@ in
defaultText = literalExpression ''"''${package}/lib/node_modules/node-red/settings.js"''; defaultText = literalExpression ''"''${package}/lib/node_modules/node-red/settings.js"'';
description = '' description = ''
Path to the JavaScript configuration file. Path to the JavaScript configuration file.
See <link See <link xlink:href="https://github.com/node-red/node-red/blob/master/packages/node_modules/node-red/settings.js"/>
xlink:href="https://github.com/node-red/node-red/blob/master/packages/node_modules/node-red/settings.js"/>
for a configuration example. for a configuration example.
''; '';
}; };

5
nixos/modules/services/web-apps/wiki-js.nix
View File

@ -95,12 +95,11 @@ in {
}; };
description = '' description = ''
Settings to configure <package>wiki-js</package>. This directly Settings to configure <package>wiki-js</package>. This directly
corresponds to <link xlink:href="https://docs.requarks.io/install/config">the upstream corresponds to <link xlink:href="https://docs.requarks.io/install/config">the upstream configuration options</link>.
configuration options</link>.
Secrets can be injected via the environment by Secrets can be injected via the environment by
<itemizedlist> <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> to contain secrets</para></listitem>
<listitem><para>and setting sensitive values to <literal>$(ENVIRONMENT_VAR)</literal> <listitem><para>and setting sensitive values to <literal>$(ENVIRONMENT_VAR)</literal>
with this value defined in the environment-file.</para></listitem> with this value defined in the environment-file.</para></listitem>

4
nixos/modules/services/web-apps/wordpress.nix
View File

@ -192,7 +192,7 @@ let
prefix. Typically this is changed if you are installing multiple WordPress blogs prefix. Typically this is changed if you are installing multiple WordPress blogs
in the same database. 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 = '' description = ''
Any additional text to be appended to the wp-config.php Any additional text to be appended to the wp-config.php
configuration file. This is a PHP script. For configuration 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 = '' example = ''
define( 'AUTOSAVE_INTERVAL', 60 ); // Seconds define( 'AUTOSAVE_INTERVAL', 60 ); // Seconds

6
nixos/modules/services/web-servers/apache-httpd/vhost-options.nix
View File

@ -261,8 +261,7 @@ in
default = ""; default = "";
example = "Disallow: /foo/"; example = "Disallow: /foo/";
description = '' description = ''
Specification of pages to be ignored by web crawlers. See <link Specification of pages to be ignored by web crawlers. See <link xlink:href="http://www.robotstxt.org/"/> for details.
xlink:href='http://www.robotstxt.org/'/> for details.
''; '';
}; };
@ -280,8 +279,7 @@ in
}; };
''; '';
description = '' description = ''
Declarative location config. See <link Declarative location config. See <link xlink:href="https://httpd.apache.org/docs/2.4/mod/core.html#location"/> for details.
xlink:href="https://httpd.apache.org/docs/2.4/mod/core.html#location"/> for details.
''; '';
}; };

8
nixos/modules/services/web-servers/nginx/default.nix
View File

@ -504,16 +504,16 @@ in
This is mutually exclusive to any other config option for This is mutually exclusive to any other config option for
<filename>nginx.conf</filename> except for <filename>nginx.conf</filename> except for
<itemizedlist> <itemizedlist>
<listitem><para><xref linkend="opt-services.nginx.appendConfig" /> <listitem><para><xref linkend="opt-services.nginx.appendConfig"/>
</para></listitem> </para></listitem>
<listitem><para><xref linkend="opt-services.nginx.httpConfig" /> <listitem><para><xref linkend="opt-services.nginx.httpConfig"/>
</para></listitem> </para></listitem>
<listitem><para><xref linkend="opt-services.nginx.logError" /> <listitem><para><xref linkend="opt-services.nginx.logError"/>
</para></listitem> </para></listitem>
</itemizedlist> </itemizedlist>
If additional verbatim config in addition to other options is needed, 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.
''; '';
}; };

3
nixos/modules/services/web-servers/uwsgi.nix
View File

@ -179,8 +179,7 @@ in {
<para> <para>
When in Emperor mode, any capability to be inherited by a vassal must When in Emperor mode, any capability to be inherited by a vassal must
be specified again in the vassal configuration using <literal>cap</literal>. be specified again in the vassal configuration using <literal>cap</literal>.
See the uWSGI <link See the uWSGI <link xlink:href="https://uwsgi-docs.readthedocs.io/en/latest/Capabilities.html">docs</link>
xlink:href="https://uwsgi-docs.readthedocs.io/en/latest/Capabilities.html">docs</link>
for more information. for more information.
</para> </para>
</note> </note>

5
nixos/modules/system/boot/initrd-network.nix
View File

@ -53,9 +53,8 @@ in
description = '' description = ''
Add network connectivity support to initrd. The network may be Add network connectivity support to initrd. The network may be
configured using the <literal>ip</literal> kernel parameter, configured using the <literal>ip</literal> kernel parameter,
as described in <link as described in <link xlink:href="https://www.kernel.org/doc/Documentation/filesystems/nfs/nfsroot.txt">the kernel documentation</link>.
xlink:href="https://www.kernel.org/doc/Documentation/filesystems/nfs/nfsroot.txt">the Otherwise, if
kernel documentation</link>. Otherwise, if
<option>networking.useDHCP</option> is enabled, an IP address <option>networking.useDHCP</option> is enabled, an IP address
is acquired using DHCP. is acquired using DHCP.

7
nixos/modules/system/boot/networkd.nix
View File

@ -1170,8 +1170,7 @@ let
<citerefentry><refentrytitle>systemd.netdev</refentrytitle> <citerefentry><refentrytitle>systemd.netdev</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> for details. <manvolnum>5</manvolnum></citerefentry> for details.
A detailed explanation about how VRFs work can be found in the 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 <link xlink:href="https://www.kernel.org/doc/Documentation/networking/vrf.txt">kernel docs</link>.
docs</link>.
''; '';
}; };
@ -1909,9 +1908,7 @@ in
Extra command-line arguments to pass to systemd-networkd-wait-online. Extra command-line arguments to pass to systemd-networkd-wait-online.
These also affect per-interface <literal>systemd-network-wait-online@</literal> services. 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"> 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.
<citerefentry><refentrytitle>systemd-networkd-wait-online.service</refentrytitle><manvolnum>8</manvolnum>
</citerefentry></link> for all available options.
''; '';
type = with types; listOf str; type = with types; listOf str;
default = []; default = [];

3
nixos/modules/system/boot/systemd/logind.nix
View File

@ -31,8 +31,7 @@ in
when the user logs out. If true, the scope unit corresponding when the user logs out. If true, the scope unit corresponding
to the session and all processes inside that scope will be to the session and all processes inside that scope will be
terminated. If false, the scope is "abandoned" (see terminated. If false, the scope is "abandoned" (see
<link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.scope.html#"> <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.scope.html#">systemd.scope(5)</link>), and processes are not killed.
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> See <link xlink:href="https://www.freedesktop.org/software/systemd/man/logind.conf.html#KillUserProcesses=">logind.conf(5)</link>
for more details. for more details.

2
nixos/modules/tasks/network-interfaces.nix
View File

@ -1292,7 +1292,7 @@ in
description = '' description = ''
Whether to enable IPv6 Privacy Extensions for interfaces not Whether to enable IPv6 Privacy Extensions for interfaces not
configured explicitly in 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 This sets the ipv6.conf.*.use_tempaddr sysctl for all
interfaces. Possible values are: interfaces. Possible values are: