From 3aebb4a2be8821a6d8a695f0908d8567dc00de31 Mon Sep 17 00:00:00 2001 From: pennae Date: Wed, 3 Aug 2022 03:05:47 +0200 Subject: 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. --- nixos/modules/config/i18n.nix | 3 +-- nixos/modules/config/users-groups.nix | 3 +-- nixos/modules/config/xdg/portal.nix | 2 +- nixos/modules/hardware/tuxedo-keyboard.nix | 2 +- nixos/modules/programs/sway.nix | 2 +- nixos/modules/security/acme/default.nix | 4 +-- nixos/modules/security/pam.nix | 29 +++++++--------------- nixos/modules/security/pam_mount.nix | 9 +++---- nixos/modules/security/pam_usb.nix | 3 +-- nixos/modules/services/backup/zrepl.nix | 3 +-- .../continuous-integration/github-runner.nix | 3 +-- nixos/modules/services/databases/postgresql.nix | 3 +-- .../modules/services/databases/victoriametrics.nix | 4 +-- nixos/modules/services/development/zammad.nix | 2 +- nixos/modules/services/games/asf.nix | 4 ++- nixos/modules/services/hardware/udev.nix | 5 ++-- nixos/modules/services/logging/filebeat.nix | 3 +-- nixos/modules/services/mail/mailman.nix | 2 +- nixos/modules/services/mail/sympa.nix | 6 ++--- .../modules/services/matrix/appservice-discord.nix | 3 +-- nixos/modules/services/matrix/mautrix-facebook.nix | 3 +-- nixos/modules/services/matrix/mautrix-telegram.nix | 3 +-- nixos/modules/services/misc/etcd.nix | 2 +- nixos/modules/services/misc/etebase-server.nix | 4 +-- nixos/modules/services/misc/geoipupdate.nix | 5 ++-- nixos/modules/services/misc/persistent-evdev.nix | 4 +-- nixos/modules/services/monitoring/cadvisor.nix | 4 +-- .../services/monitoring/grafana-image-renderer.nix | 2 +- nixos/modules/services/monitoring/graphite.nix | 2 +- nixos/modules/services/monitoring/munin.nix | 12 ++++----- nixos/modules/services/monitoring/nagios.nix | 2 +- nixos/modules/services/monitoring/parsedmarc.nix | 19 ++++++-------- .../services/monitoring/prometheus/default.nix | 15 +++++------ .../monitoring/prometheus/exporters/dovecot.nix | 8 +++--- .../monitoring/prometheus/exporters/process.nix | 2 +- .../monitoring/prometheus/exporters/script.nix | 2 +- nixos/modules/services/networking/bird-lg.nix | 12 ++++----- nixos/modules/services/networking/bird.nix | 2 +- nixos/modules/services/networking/coredns.nix | 5 +++- nixos/modules/services/networking/seafile.nix | 2 +- nixos/modules/services/networking/ssh/sshd.nix | 12 ++++----- nixos/modules/services/networking/wireguard.nix | 6 ++--- .../modules/services/networking/wpa_supplicant.nix | 2 +- nixos/modules/services/security/privacyidea.nix | 6 ++--- nixos/modules/services/security/step-ca.nix | 4 +-- nixos/modules/services/security/tor.nix | 10 ++++---- .../services/security/vaultwarden/default.nix | 2 +- nixos/modules/services/web-apps/hedgedoc.nix | 3 +-- nixos/modules/services/web-apps/keycloak.nix | 19 +++++--------- nixos/modules/services/web-apps/mediawiki.nix | 2 +- nixos/modules/services/web-apps/nextcloud.nix | 12 ++++----- nixos/modules/services/web-apps/node-red.nix | 3 +-- nixos/modules/services/web-apps/wiki-js.nix | 5 ++-- nixos/modules/services/web-apps/wordpress.nix | 4 +-- .../web-servers/apache-httpd/vhost-options.nix | 6 ++--- .../modules/services/web-servers/nginx/default.nix | 8 +++--- nixos/modules/services/web-servers/uwsgi.nix | 3 +-- nixos/modules/system/boot/initrd-network.nix | 5 ++-- nixos/modules/system/boot/networkd.nix | 7 ++---- nixos/modules/system/boot/systemd/logind.nix | 3 +-- nixos/modules/tasks/network-interfaces.nix | 2 +- 61 files changed, 140 insertions(+), 189 deletions(-) diff --git a/nixos/modules/config/i18n.nix b/nixos/modules/config/i18n.nix index 80ef515fbfe..dad06c1b44c 100644 --- a/nixos/modules/config/i18n.nix +++ b/nixos/modules/config/i18n.nix @@ -75,8 +75,7 @@ with lib; List of locales that the system should support. The value "all" means that all locales supported by Glibc will be installed. A full list of supported locales - can be found at . + can be found at . ''; }; diff --git a/nixos/modules/config/users-groups.nix b/nixos/modules/config/users-groups.nix index 446cc3698be..2e5984b55cc 100644 --- a/nixos/modules/config/users-groups.nix +++ b/nixos/modules/config/users-groups.nix @@ -156,8 +156,7 @@ let pam_mount.conf.xml. Useful attributes might include path, options, fstype, and server. - See + See for more information. ''; }; diff --git a/nixos/modules/config/xdg/portal.nix b/nixos/modules/config/xdg/portal.nix index 1e6ddd7c4a2..689abf267f0 100644 --- a/nixos/modules/config/xdg/portal.nix +++ b/nixos/modules/config/xdg/portal.nix @@ -33,7 +33,7 @@ in options.xdg.portal = { enable = - mkEnableOption "xdg desktop integration" // { + mkEnableOption ''xdg desktop integration'' // { default = false; }; diff --git a/nixos/modules/hardware/tuxedo-keyboard.nix b/nixos/modules/hardware/tuxedo-keyboard.nix index 97af7c61f3c..7bcabde4890 100644 --- a/nixos/modules/hardware/tuxedo-keyboard.nix +++ b/nixos/modules/hardware/tuxedo-keyboard.nix @@ -13,7 +13,7 @@ in To configure the driver, pass the options to the 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: + You can find all the supported parameters at: In order to use the custom lighting with the maximumg brightness and a color of 0xff0a0a one would put pass like this: diff --git a/nixos/modules/programs/sway.nix b/nixos/modules/programs/sway.nix index decae1b4d2d..af2b261d3c5 100644 --- a/nixos/modules/programs/sway.nix +++ b/nixos/modules/programs/sway.nix @@ -39,7 +39,7 @@ in { Sway, the i3-compatible tiling Wayland compositor. You can manually launch Sway by executing "exec sway" on a TTY. Copy /etc/sway/config to ~/.config/sway/config to modify the default configuration. See - and + and "man 5 sway" for more information''; wrapperFeatures = mkOption { diff --git a/nixos/modules/security/acme/default.nix b/nixos/modules/security/acme/default.nix index 5f4344d451c..4bc3d8e743d 100644 --- a/nixos/modules/security/acme/default.nix +++ b/nixos/modules/security/acme/default.nix @@ -581,8 +581,8 @@ let Turns on the OCSP Must-Staple TLS extension. Make sure you know what you're doing! See: - - + + ''; }; diff --git a/nixos/modules/security/pam.nix b/nixos/modules/security/pam.nix index 7903d333411..8a70e5f3adb 100644 --- a/nixos/modules/security/pam.nix +++ b/nixos/modules/security/pam.nix @@ -831,8 +831,7 @@ in If set, users can log in with SSH keys and PKCS#11 tokens. - More information can be found here. + More information can be found here. ''; }; @@ -872,8 +871,7 @@ in username:first_keyHandle,first_public_key: second_keyHandle,second_public_key This file can be generated using pamu2fcfg command. - More information can be found here. + More information can be found here. ''; }; @@ -894,8 +892,7 @@ in username:first_keyHandle,first_public_key: second_keyHandle,second_public_key This file can be generated using pamu2fcfg command. - More information can be found here. + More information can be found here. ''; }; @@ -909,9 +906,7 @@ in When using pamu2fcfg, you can specify your application ID with the -i flag. - More information can be found - here + More information can be found here ''; }; @@ -927,9 +922,7 @@ in When using pamu2fcfg, you can specify your application ID with the -o flag. - More information can be found - here + More information can be found here ''; }; @@ -995,8 +988,7 @@ in Note that this module must both be enabled using this option and on a per-PAM-service level as well (using usshAuth). - More information can be found here. + More information can be found here. ''; }; @@ -1084,8 +1076,7 @@ in The file must have only one line: username:yubikey_token_id1:yubikey_token_id2 - More information can be found here. + More information can be found here. ''; }; control = mkOption { @@ -1130,8 +1121,7 @@ in Challenge-Response configurations. See the man-page ykpamcfg(1) for further details on how to configure offline Challenge-Response validation. - More information can be found here. + More information can be found here. ''; }; challengeResponsePath = mkOption { @@ -1140,8 +1130,7 @@ in description = '' If not null, set the path used by yubico pam module where the challenge expected response is stored. - More information can be found here. + More information can be found here. ''; }; }; diff --git a/nixos/modules/security/pam_mount.nix b/nixos/modules/security/pam_mount.nix index e159a73b66a..ae314abd86c 100644 --- a/nixos/modules/security/pam_mount.nix +++ b/nixos/modules/security/pam_mount.nix @@ -33,8 +33,7 @@ in default = []; description = '' List of volume definitions for pam_mount. - For more information, visit . + For more information, visit . ''; }; @@ -67,8 +66,7 @@ in description = '' Sets the Debug-Level. 0 disables debugging, 1 enables pam_mount tracing, and 2 additionally enables tracing in mount.crypt. The default is 0. - For more information, visit . + For more information, visit . ''; }; @@ -78,8 +76,7 @@ in description = '' Amount of microseconds to wait until killing remaining processes after final logout. - For more information, visit . + For more information, visit . ''; }; diff --git a/nixos/modules/security/pam_usb.nix b/nixos/modules/security/pam_usb.nix index 51d81e823f8..71e2af8f3a5 100644 --- a/nixos/modules/security/pam_usb.nix +++ b/nixos/modules/security/pam_usb.nix @@ -19,8 +19,7 @@ in default = false; description = '' Enable USB login for all login systems that support it. For - more information, visit . + more information, visit . ''; }; diff --git a/nixos/modules/services/backup/zrepl.nix b/nixos/modules/services/backup/zrepl.nix index e3a90091264..7b31b0da036 100644 --- a/nixos/modules/services/backup/zrepl.nix +++ b/nixos/modules/services/backup/zrepl.nix @@ -23,8 +23,7 @@ in settings = mkOption { default = { }; description = '' - Configuration for zrepl. See + Configuration for zrepl. See for more information. ''; type = types.submodule { diff --git a/nixos/modules/services/continuous-integration/github-runner.nix b/nixos/modules/services/continuous-integration/github-runner.nix index 2da18bbdb39..2c753b514c5 100644 --- a/nixos/modules/services/continuous-integration/github-runner.nix +++ b/nixos/modules/services/continuous-integration/github-runner.nix @@ -22,8 +22,7 @@ in Whether to enable GitHub Actions runner. Note: GitHub recommends using self-hosted runners with private repositories only. Learn more here: - About self-hosted runners. + About self-hosted runners. ''; type = lib.types.bool; }; diff --git a/nixos/modules/services/databases/postgresql.nix b/nixos/modules/services/databases/postgresql.nix index a054a6d7a12..8225a9aaba6 100644 --- a/nixos/modules/services/databases/postgresql.nix +++ b/nixos/modules/services/databases/postgresql.nix @@ -81,8 +81,7 @@ in default = ""; description = '' Defines how users authenticate themselves to the server. See the - - PostgreSQL documentation for pg_hba.conf + PostgreSQL documentation for pg_hba.conf for details on the expected format of this option. By default, peer based authentication will be used for users connecting via the Unix socket, and md5 password authentication will be diff --git a/nixos/modules/services/databases/victoriametrics.nix b/nixos/modules/services/databases/victoriametrics.nix index 28a6ccfd5e2..4e002b3df7c 100644 --- a/nixos/modules/services/databases/victoriametrics.nix +++ b/nixos/modules/services/databases/victoriametrics.nix @@ -29,8 +29,8 @@ let cfg = config.services.victoriametrics; in type = types.listOf types.str; default = []; description = '' - Extra options to pass to VictoriaMetrics. See the README: + Extra options to pass to VictoriaMetrics. See the README: + or victoriametrics -help for more information. ''; diff --git a/nixos/modules/services/development/zammad.nix b/nixos/modules/services/development/zammad.nix index 503f54aee2c..e81eef3c0a5 100644 --- a/nixos/modules/services/development/zammad.nix +++ b/nixos/modules/services/development/zammad.nix @@ -139,7 +139,7 @@ in ''; description = '' The database.yml configuration file as key value set. - See + See for list of configuration parameters. ''; }; diff --git a/nixos/modules/services/games/asf.nix b/nixos/modules/services/games/asf.nix index 37247e195a7..6939e15c207 100644 --- a/nixos/modules/services/games/asf.nix +++ b/nixos/modules/services/games/asf.nix @@ -136,7 +136,9 @@ in }; settings = mkOption { type = types.attrs; - description = "Additional settings that are documented here."; + description = '' + Additional settings that are documented here. + ''; default = { }; }; }; diff --git a/nixos/modules/services/hardware/udev.nix b/nixos/modules/services/hardware/udev.nix index f54979832cb..f745e2f7f60 100644 --- a/nixos/modules/services/hardware/udev.nix +++ b/nixos/modules/services/hardware/udev.nix @@ -282,9 +282,8 @@ in default = true; type = types.bool; description = '' - Whether to assign predictable - names to network interfaces. If enabled, interfaces + Whether to assign predictable names to network interfaces. + If enabled, interfaces are assigned names that contain topology information (e.g. wlp3s0) and thus should be stable across reboots. If disabled, names depend on the order in diff --git a/nixos/modules/services/logging/filebeat.nix b/nixos/modules/services/logging/filebeat.nix index ec8df0a7b87..045cd1147ea 100644 --- a/nixos/modules/services/logging/filebeat.nix +++ b/nixos/modules/services/logging/filebeat.nix @@ -161,8 +161,7 @@ in internal = true; description = '' Inputs specify how Filebeat locates and processes - input data. Use instead. + input data. Use instead. See . ''; diff --git a/nixos/modules/services/mail/mailman.nix b/nixos/modules/services/mail/mailman.nix index eb24f73c1da..c3eb61bd20d 100644 --- a/nixos/modules/services/mail/mailman.nix +++ b/nixos/modules/services/mail/mailman.nix @@ -114,7 +114,7 @@ in { example = "/run/secrets/ldap-bind"; description = '' Path to the file containing the bind password of the servie account - defined by . + defined by . ''; }; superUserGroup = mkOption { diff --git a/nixos/modules/services/mail/sympa.nix b/nixos/modules/services/mail/sympa.nix index 0b72ce97512..0a2a885a80f 100644 --- a/nixos/modules/services/mail/sympa.nix +++ b/nixos/modules/services/mail/sympa.nix @@ -88,7 +88,7 @@ in example = "cs"; description = '' Default Sympa language. - See + See for available options. ''; }; @@ -138,7 +138,7 @@ in }; description = '' The robot.conf configuration file as key value set. - See + See for list of configuration parameters. ''; }; @@ -287,7 +287,7 @@ in ''; description = '' The sympa.conf configuration file as key value set. - See + See for list of configuration parameters. ''; }; diff --git a/nixos/modules/services/matrix/appservice-discord.nix b/nixos/modules/services/matrix/appservice-discord.nix index 65ad96a3af3..87a706ae95e 100644 --- a/nixos/modules/services/matrix/appservice-discord.nix +++ b/nixos/modules/services/matrix/appservice-discord.nix @@ -44,8 +44,7 @@ in { config.yaml configuration as a Nix attribute set. Configuration options should match those described in - - config.sample.yaml. + config.sample.yaml. and should be set to match the public host name of the Matrix homeserver for webhooks and avatars to work. diff --git a/nixos/modules/services/matrix/mautrix-facebook.nix b/nixos/modules/services/matrix/mautrix-facebook.nix index 2f91e6e0e52..384a4f4a706 100644 --- a/nixos/modules/services/matrix/mautrix-facebook.nix +++ b/nixos/modules/services/matrix/mautrix-facebook.nix @@ -78,8 +78,7 @@ in { description = '' config.yaml configuration as a Nix attribute set. Configuration options should match those described in - - example-config.yaml. + example-config.yaml. Secret tokens should be specified using instead of this world-readable attribute set. diff --git a/nixos/modules/services/matrix/mautrix-telegram.nix b/nixos/modules/services/matrix/mautrix-telegram.nix index 1d4061b8a81..492ed1b24bc 100644 --- a/nixos/modules/services/matrix/mautrix-telegram.nix +++ b/nixos/modules/services/matrix/mautrix-telegram.nix @@ -81,8 +81,7 @@ in { description = '' config.yaml configuration as a Nix attribute set. Configuration options should match those described in - - example-config.yaml. + example-config.yaml. Secret tokens should be specified using instead of this world-readable attribute set. diff --git a/nixos/modules/services/misc/etcd.nix b/nixos/modules/services/misc/etcd.nix index d589ad780c1..d0c82d72602 100644 --- a/nixos/modules/services/misc/etcd.nix +++ b/nixos/modules/services/misc/etcd.nix @@ -127,7 +127,7 @@ in { extraConf = mkOption { description = '' Etcd extra configuration. See - + ''; type = types.attrsOf types.str; default = {}; diff --git a/nixos/modules/services/misc/etebase-server.nix b/nixos/modules/services/misc/etebase-server.nix index 24be9e8e269..1359c265c8f 100644 --- a/nixos/modules/services/misc/etebase-server.nix +++ b/nixos/modules/services/misc/etebase-server.nix @@ -135,8 +135,8 @@ in default = {}; description = '' Configuration for etebase-server. Refer to - - and + + and for details on supported values. ''; example = { diff --git a/nixos/modules/services/misc/geoipupdate.nix b/nixos/modules/services/misc/geoipupdate.nix index 20bbba0aad9..98d47041214 100644 --- a/nixos/modules/services/misc/geoipupdate.nix +++ b/nixos/modules/services/misc/geoipupdate.nix @@ -40,7 +40,7 @@ in description = '' geoipupdate configuration options. See - + for a full list of available options. Settings containing secret data should be set to an @@ -92,8 +92,7 @@ in Always handled as a secret whether the value is wrapped in a { _secret = ...; } - attrset or not (refer to for + attrset or not (refer to for details). ''; apply = x: if isAttrs x then x else { _secret = x; }; diff --git a/nixos/modules/services/misc/persistent-evdev.nix b/nixos/modules/services/misc/persistent-evdev.nix index 401d20010b1..fd6e298ef65 100644 --- a/nixos/modules/services/misc/persistent-evdev.nix +++ b/nixos/modules/services/misc/persistent-evdev.nix @@ -22,8 +22,8 @@ in Physical devices should already exist in /dev/input/by-id/. Proxy devices will be automatically given a uinput- prefix. - See the - project page for example configuration of virtual devices with libvirt + See the project page + for example configuration of virtual devices with libvirt and remember to add uinput-* devices to the qemu cgroup_device_acl list (see ). ''; diff --git a/nixos/modules/services/monitoring/cadvisor.nix b/nixos/modules/services/monitoring/cadvisor.nix index c844b1599dd..7374b1ece49 100644 --- a/nixos/modules/services/monitoring/cadvisor.nix +++ b/nixos/modules/services/monitoring/cadvisor.nix @@ -75,7 +75,7 @@ in { world-readable Nix store that contains the value of . It's recommended to override this with a path not in the Nix store. - Tip: use nixops key management + Tip: use nixops key management ''; }; @@ -91,7 +91,7 @@ in { description = '' Additional cadvisor options. - See for available options. + See for available options. ''; }; }; diff --git a/nixos/modules/services/monitoring/grafana-image-renderer.nix b/nixos/modules/services/monitoring/grafana-image-renderer.nix index 97488f2653a..4820b194698 100644 --- a/nixos/modules/services/monitoring/grafana-image-renderer.nix +++ b/nixos/modules/services/monitoring/grafana-image-renderer.nix @@ -92,7 +92,7 @@ in { description = '' Configuration attributes for grafana-image-renderer. - See + See for supported values. ''; }; diff --git a/nixos/modules/services/monitoring/graphite.nix b/nixos/modules/services/monitoring/graphite.nix index 73b509202df..0905b4b57fb 100644 --- a/nixos/modules/services/monitoring/graphite.nix +++ b/nixos/modules/services/monitoring/graphite.nix @@ -253,7 +253,7 @@ in { default = {}; description = '' Extra seyren configuration. See - + ''; type = types.attrsOf types.str; example = literalExpression '' diff --git a/nixos/modules/services/monitoring/munin.nix b/nixos/modules/services/monitoring/munin.nix index c77ae7b3b6e..3455d0d3d4a 100644 --- a/nixos/modules/services/monitoring/munin.nix +++ b/nixos/modules/services/monitoring/munin.nix @@ -142,7 +142,7 @@ in Enable Munin Node agent. Munin node listens on 0.0.0.0 and by default accepts connections only from 127.0.0.1 for security reasons. - See . + See . ''; }; @@ -151,7 +151,7 @@ in type = types.lines; description = '' munin-node.conf extra configuration. See - + ''; }; @@ -160,7 +160,7 @@ in type = types.lines; description = '' plugin-conf.d extra plugin configuration. See - + ''; example = '' [fail2ban_*] @@ -268,9 +268,9 @@ in type = types.lines; description = '' munin.conf extra global configuration. - See . + See . Useful to setup notifications, see - + ''; example = '' contact.email.command mail -s "Munin notification for ''${var:host}" someone@example.com @@ -283,7 +283,7 @@ in description = '' Definitions of hosts of nodes to collect data from. Needs at least one host for cron to succeed. See - + ''; example = literalExpression '' ''' diff --git a/nixos/modules/services/monitoring/nagios.nix b/nixos/modules/services/monitoring/nagios.nix index 69173ce4e44..a17797f682f 100644 --- a/nixos/modules/services/monitoring/nagios.nix +++ b/nixos/modules/services/monitoring/nagios.nix @@ -88,7 +88,7 @@ in options = { services.nagios = { - enable = mkEnableOption "Nagios to monitor your system or network."; + enable = mkEnableOption ''Nagios to monitor your system or network.''; objectDefs = mkOption { description = " diff --git a/nixos/modules/services/monitoring/parsedmarc.nix b/nixos/modules/services/monitoring/parsedmarc.nix index 736718c2535..60ebbd6f752 100644 --- a/nixos/modules/services/monitoring/parsedmarc.nix +++ b/nixos/modules/services/monitoring/parsedmarc.nix @@ -69,14 +69,12 @@ in type = lib.types.bool; default = true; description = '' - Whether to enable and configure the geoipupdate + Whether to enable and configure the geoipupdate service to automatically fetch GeoIP databases. Not crucial, but recommended for full functionality. - To finish the setup, you need to manually set the and - + To finish the setup, you need to manually set the and + options. ''; }; @@ -101,7 +99,7 @@ in Whether the automatically provisioned Elasticsearch instance should be added as a grafana datasource. Has no effect unless - + is also enabled. ''; }; @@ -213,8 +211,7 @@ in Always handled as a secret whether the value is wrapped in a { _secret = ...; } - attrset or not (refer to for + attrset or not (refer to for details). ''; apply = x: if isAttrs x || x == null then x else { _secret = x; }; @@ -278,8 +275,7 @@ in Always handled as a secret whether the value is wrapped in a { _secret = ...; } - attrset or not (refer to for + attrset or not (refer to for details). ''; apply = x: if isAttrs x || x == null then x else { _secret = x; }; @@ -332,8 +328,7 @@ in Always handled as a secret whether the value is wrapped in a { _secret = ...; } - attrset or not (refer to for + attrset or not (refer to for details). ''; apply = x: if isAttrs x || x == null then x else { _secret = x; }; diff --git a/nixos/modules/services/monitoring/prometheus/default.nix b/nixos/modules/services/monitoring/prometheus/default.nix index db4286b66a5..3bc61fba158 100644 --- a/nixos/modules/services/monitoring/prometheus/default.nix +++ b/nixos/modules/services/monitoring/prometheus/default.nix @@ -379,9 +379,8 @@ let gce_sd_configs = mkOpt (types.listOf promTypes.gce_sd_config) '' List of Google Compute Engine service discovery configurations. - See the - relevant Prometheus configuration docs for more detail. + See the relevant Prometheus configuration docs + for more detail. ''; hetzner_sd_configs = mkOpt (types.listOf promTypes.hetzner_sd_config) '' @@ -807,9 +806,7 @@ let filter = mkOpt types.str '' Filter can be used optionally to filter the instance list by other criteria Syntax of this filter string is described here in the filter - query parameter section: . + query parameter section: . ''; refresh_interval = mkDefOpt types.str "60s" '' @@ -825,7 +822,7 @@ let The tag separator used to separate concatenated GCE instance network tags. See the GCP documentation on network tags for more information: - + ''; }; }; @@ -1033,13 +1030,13 @@ let auth_token = mkOpt types.str '' Optional authentication information for token-based authentication: - + It is mutually exclusive with auth_token_file and other authentication mechanisms. ''; auth_token_file = mkOpt types.str '' Optional authentication information for token-based authentication: - + It is mutually exclusive with auth_token and other authentication mechanisms. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix b/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix index 092ac6fea7d..4e7aae0b34b 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix @@ -33,10 +33,10 @@ in work with this exporter: { - = true; - = "/var/run/dovecot2/old-stats"; - = [ "old_stats" ]; - = ''' + = true; + = "/var/run/dovecot2/old-stats"; + = [ "old_stats" ]; + = ''' service old-stats { unix_listener old-stats { user = dovecot-exporter diff --git a/nixos/modules/services/monitoring/prometheus/exporters/process.nix b/nixos/modules/services/monitoring/prometheus/exporters/process.nix index 1e9c402fb55..666116991b5 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/process.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/process.nix @@ -22,7 +22,7 @@ in All settings expressed as an Nix attrset. Check the official documentation for the corresponding YAML - settings that can all be used here: + settings that can all be used here: ''; }; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/script.nix b/nixos/modules/services/monitoring/prometheus/exporters/script.nix index a805a0ad335..2a43fbcab3a 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/script.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/script.nix @@ -41,7 +41,7 @@ in All settings expressed as an Nix attrset. Check the official documentation for the corresponding YAML - settings that can all be used here: + settings that can all be used here: ''; }; }; diff --git a/nixos/modules/services/networking/bird-lg.nix b/nixos/modules/services/networking/bird-lg.nix index db4a4140dd4..9f06bfcdc51 100644 --- a/nixos/modules/services/networking/bird-lg.nix +++ b/nixos/modules/services/networking/bird-lg.nix @@ -136,9 +136,9 @@ in extraArgs = mkOption { type = types.lines; default = ""; - description = " - Extra parameters documented here. - "; + description = '' + Extra parameters documented here. + ''; }; }; @@ -183,9 +183,9 @@ in extraArgs = mkOption { type = types.lines; default = ""; - description = " - Extra parameters documented here. - "; + description = '' + Extra parameters documented here. + ''; }; }; }; diff --git a/nixos/modules/services/networking/bird.nix b/nixos/modules/services/networking/bird.nix index b166209fa96..4a738daf958 100644 --- a/nixos/modules/services/networking/bird.nix +++ b/nixos/modules/services/networking/bird.nix @@ -15,7 +15,7 @@ in type = types.lines; description = '' BIRD Internet Routing Daemon configuration file. - + ''; }; checkConfig = mkOption { diff --git a/nixos/modules/services/networking/coredns.nix b/nixos/modules/services/networking/coredns.nix index 9a4140e9d58..966957f1a0f 100644 --- a/nixos/modules/services/networking/coredns.nix +++ b/nixos/modules/services/networking/coredns.nix @@ -17,7 +17,10 @@ in { } ''; type = types.lines; - description = "Verbatim Corefile to use. See for details."; + description = '' + Verbatim Corefile to use. + See for details. + ''; }; package = mkOption { diff --git a/nixos/modules/services/networking/seafile.nix b/nixos/modules/services/networking/seafile.nix index 7cda71458dd..d9617952ea5 100644 --- a/nixos/modules/services/networking/seafile.nix +++ b/nixos/modules/services/networking/seafile.nix @@ -133,7 +133,7 @@ in { type = types.lines; description = '' Extra config to append to `seahub_settings.py` file. - Refer to + Refer to for all available options. ''; }; diff --git a/nixos/modules/services/networking/ssh/sshd.nix b/nixos/modules/services/networking/ssh/sshd.nix index e95fe19dede..cbc4e303b64 100644 --- a/nixos/modules/services/networking/ssh/sshd.nix +++ b/nixos/modules/services/networking/ssh/sshd.nix @@ -302,9 +302,9 @@ in Allowed key exchange algorithms Uses the lower bound recommended in both - + and - + ''; }; @@ -322,9 +322,9 @@ in Allowed ciphers Defaults to recommended settings from both - + and - + ''; }; @@ -342,9 +342,9 @@ in Allowed MACs Defaults to recommended settings from both - + and - + ''; }; diff --git a/nixos/modules/services/networking/wireguard.nix b/nixos/modules/services/networking/wireguard.nix index 412e9c921f5..994a0cf9ec1 100644 --- a/nixos/modules/services/networking/wireguard.nix +++ b/nixos/modules/services/networking/wireguard.nix @@ -122,8 +122,7 @@ let WireGuard interface is created, and which retains the socket even if the interface is moved via . When null, the interface is created in the init namespace. - See documentation. + See documentation. ''; }; @@ -135,8 +134,7 @@ let interface is moved to. The special value init means the init namespace. When null, the interface is not moved. - See documentation. + See documentation. ''; }; }; diff --git a/nixos/modules/services/networking/wpa_supplicant.nix b/nixos/modules/services/networking/wpa_supplicant.nix index e21c25e2f78..ac5f597b475 100644 --- a/nixos/modules/services/networking/wpa_supplicant.nix +++ b/nixos/modules/services/networking/wpa_supplicant.nix @@ -190,7 +190,7 @@ in { description = '' Whether to allow configuring networks "imperatively" (e.g. via wpa_supplicant_gui) and declaratively via - . + . Please note that this adds a custom patch to wpa_supplicant. ''; diff --git a/nixos/modules/services/security/privacyidea.nix b/nixos/modules/services/security/privacyidea.nix index 599ade003c0..4be3a90b649 100644 --- a/nixos/modules/services/security/privacyidea.nix +++ b/nixos/modules/services/security/privacyidea.nix @@ -78,7 +78,7 @@ in using envsubst which is helpful for specifying secrets: - { = "$SECRET"; } + { = "$SECRET"; } The environment-file can now specify the actual secret key: @@ -207,7 +207,7 @@ in description = '' Attribute-set containing the settings for privacyidea-ldap-proxy. It's possible to pass secrets using env-vars as substitutes and - use the option + use the option to inject them via envsubst. ''; }; @@ -217,7 +217,7 @@ in type = types.nullOr types.str; description = '' Environment file containing secrets to be substituted into - . + . ''; }; }; diff --git a/nixos/modules/services/security/step-ca.nix b/nixos/modules/services/security/step-ca.nix index 9b9b53f1351..1afcf659632 100644 --- a/nixos/modules/services/security/step-ca.nix +++ b/nixos/modules/services/security/step-ca.nix @@ -36,8 +36,8 @@ in type = with lib.types; attrsOf anything; description = '' Settings that go into ca.json. See - - the step-ca manual for more information. The easiest way to + the step-ca manual + for more information. The easiest way to configure this module would be to run step ca init to generate ca.json and then import it using builtins.fromJSON. diff --git a/nixos/modules/services/security/tor.nix b/nixos/modules/services/security/tor.nix index f611fee6908..0516d207707 100644 --- a/nixos/modules/services/security/tor.nix +++ b/nixos/modules/services/security/tor.nix @@ -287,7 +287,7 @@ in relay = { enable = mkEnableOption ''relaying of Tor traffic for others. - See + See for details. Setting this to true requires setting @@ -348,7 +348,7 @@ in See - + for more info. @@ -366,7 +366,7 @@ in Using this option will make Tor advertise your bridge to users through various mechanisms like - , though. + , though. @@ -384,7 +384,7 @@ in - See + See for more info. @@ -419,7 +419,7 @@ in - See + See for more info. diff --git a/nixos/modules/services/security/vaultwarden/default.nix b/nixos/modules/services/security/vaultwarden/default.nix index 7e5389d78f4..1433438ba00 100644 --- a/nixos/modules/services/security/vaultwarden/default.nix +++ b/nixos/modules/services/security/vaultwarden/default.nix @@ -116,7 +116,7 @@ in { The available configuration options can be found in the environment template file. - See for how + See for how to set up access to the Admin UI to invite initial users. ''; }; diff --git a/nixos/modules/services/web-apps/hedgedoc.nix b/nixos/modules/services/web-apps/hedgedoc.nix index b8d83984ca7..4e1a2125984 100644 --- a/nixos/modules/services/web-apps/hedgedoc.nix +++ b/nixos/modules/services/web-apps/hedgedoc.nix @@ -152,8 +152,7 @@ in ''; description = '' Specify the Content Security Policy which is passed to Helmet. - For configuration details see https://helmetjs.github.io/docs/csp/. + For configuration details see . ''; }; protocolUseSSL = mkOption { diff --git a/nixos/modules/services/web-apps/keycloak.nix b/nixos/modules/services/web-apps/keycloak.nix index de76babbaed..110df53effd 100644 --- a/nixos/modules/services/web-apps/keycloak.nix +++ b/nixos/modules/services/web-apps/keycloak.nix @@ -215,8 +215,7 @@ in manually provisioned database; has no effect when a local database is automatically provisioned. - To use this with a local database, set to + To use this with a local database, set to false and create the database and user manually. ''; @@ -230,8 +229,7 @@ in provisioned database; has no effect when a local database is automatically provisioned. - To use this with a local database, set to + To use this with a local database, set to false and create the database and user manually. ''; @@ -329,10 +327,8 @@ in want to set this to /auth to keep compatibility with your clients. - See for more information on migrating from Wildfly - to Quarkus. + See + for more information on migrating from Wildfly to Quarkus. ''; @@ -404,9 +400,7 @@ in - See for more information. + See for more information. ''; }; }; @@ -425,8 +419,7 @@ in Configuration options corresponding to parameters set in conf/keycloak.conf. - Most available options are documented at . + Most available options are documented at . Options containing secret data should be set to an attribute set containing the attribute _secret - a diff --git a/nixos/modules/services/web-apps/mediawiki.nix b/nixos/modules/services/web-apps/mediawiki.nix index 977b6f60b23..71154555942 100644 --- a/nixos/modules/services/web-apps/mediawiki.nix +++ b/nixos/modules/services/web-apps/mediawiki.nix @@ -280,7 +280,7 @@ in one version of MediaWiki, or have other applications that also use the database, you can give the table names a unique prefix to stop any naming conflicts or confusion. - See . + See . ''; }; diff --git a/nixos/modules/services/web-apps/nextcloud.nix b/nixos/modules/services/web-apps/nextcloud.nix index 08083b7a443..a121401f758 100644 --- a/nixos/modules/services/web-apps/nextcloud.nix +++ b/nixos/modules/services/web-apps/nextcloud.nix @@ -94,7 +94,7 @@ in { default = config.services.nextcloud.home; defaultText = literalExpression "config.services.nextcloud.home"; description = '' - Data storage path of nextcloud. Will be by default. + Data storage path of nextcloud. Will be by default. This folder will be populated with a config.php and data folder which contains the state of the instance (excl the database)."; ''; example = "/mnt/nextcloud-file"; @@ -105,7 +105,7 @@ in { description = '' Extra apps to install. Should be an attrSet of appid to packages generated by fetchNextcloudApp. The appid must be identical to the "id" value in the apps appinfo/info.xml. - Using this will disable the appstore to prevent Nextcloud from updating these apps (see ). + Using this will disable the appstore to prevent Nextcloud from updating these apps (see ). ''; example = literalExpression '' { @@ -128,7 +128,7 @@ in { type = types.bool; default = true; description = '' - Automatically enable the apps in every time nextcloud starts. + Automatically enable the apps in every time nextcloud starts. If set to false, apps need to be enabled in the Nextcloud user interface or with nextcloud-occ app:enable. ''; }; @@ -138,8 +138,8 @@ in { example = true; description = '' Allow the installation of apps and app updates from the store. - Enabled by default unless there are packages in . - Set to true to force enable the store even if is used. + Enabled by default unless there are packages in . + Set to true to force enable the store even if is used. Set to false to disable the installation of apps from the global appstore. App management is always enabled regardless of this setting. ''; }; @@ -467,7 +467,7 @@ in { This is used by the theming app and for generating previews of certain images (e.g. SVG and HEIF). You may want to disable it for increased security. In that case, previews will still be available for some images (e.g. JPEG and PNG). - See . + See . '' // { default = true; }; diff --git a/nixos/modules/services/web-apps/node-red.nix b/nixos/modules/services/web-apps/node-red.nix index 1b9d14ecf4f..3e6e38c50db 100644 --- a/nixos/modules/services/web-apps/node-red.nix +++ b/nixos/modules/services/web-apps/node-red.nix @@ -49,8 +49,7 @@ in defaultText = literalExpression ''"''${package}/lib/node_modules/node-red/settings.js"''; description = '' Path to the JavaScript configuration file. - See + See for a configuration example. ''; }; diff --git a/nixos/modules/services/web-apps/wiki-js.nix b/nixos/modules/services/web-apps/wiki-js.nix index 474fbb8f13c..5dc0bb73259 100644 --- a/nixos/modules/services/web-apps/wiki-js.nix +++ b/nixos/modules/services/web-apps/wiki-js.nix @@ -95,12 +95,11 @@ in { }; description = '' Settings to configure wiki-js. This directly - corresponds to the upstream - configuration options. + corresponds to the upstream configuration options. Secrets can be injected via the environment by - specifying + specifying to contain secrets and setting sensitive values to $(ENVIRONMENT_VAR) with this value defined in the environment-file. diff --git a/nixos/modules/services/web-apps/wordpress.nix b/nixos/modules/services/web-apps/wordpress.nix index 59471a739cb..b1ae4deb276 100644 --- a/nixos/modules/services/web-apps/wordpress.nix +++ b/nixos/modules/services/web-apps/wordpress.nix @@ -192,7 +192,7 @@ let prefix. Typically this is changed if you are installing multiple WordPress blogs in the same database. - See . + See . ''; }; @@ -246,7 +246,7 @@ let description = '' Any additional text to be appended to the wp-config.php configuration file. This is a PHP script. For configuration - settings, see . + settings, see . ''; example = '' define( 'AUTOSAVE_INTERVAL', 60 ); // Seconds diff --git a/nixos/modules/services/web-servers/apache-httpd/vhost-options.nix b/nixos/modules/services/web-servers/apache-httpd/vhost-options.nix index e743eaa6215..559210a1418 100644 --- a/nixos/modules/services/web-servers/apache-httpd/vhost-options.nix +++ b/nixos/modules/services/web-servers/apache-httpd/vhost-options.nix @@ -261,8 +261,7 @@ in default = ""; example = "Disallow: /foo/"; description = '' - Specification of pages to be ignored by web crawlers. See for details. + Specification of pages to be ignored by web crawlers. See for details. ''; }; @@ -280,8 +279,7 @@ in }; ''; description = '' - Declarative location config. See for details. + Declarative location config. See for details. ''; }; diff --git a/nixos/modules/services/web-servers/nginx/default.nix b/nixos/modules/services/web-servers/nginx/default.nix index 5ccbaf77481..166f38f9ea2 100644 --- a/nixos/modules/services/web-servers/nginx/default.nix +++ b/nixos/modules/services/web-servers/nginx/default.nix @@ -504,16 +504,16 @@ in This is mutually exclusive to any other config option for nginx.conf except for - + - + - + If additional verbatim config in addition to other options is needed, - should be used instead. + should be used instead. ''; }; diff --git a/nixos/modules/services/web-servers/uwsgi.nix b/nixos/modules/services/web-servers/uwsgi.nix index c76eb795a9e..af6c6c06612 100644 --- a/nixos/modules/services/web-servers/uwsgi.nix +++ b/nixos/modules/services/web-servers/uwsgi.nix @@ -179,8 +179,7 @@ in { When in Emperor mode, any capability to be inherited by a vassal must be specified again in the vassal configuration using cap. - See the uWSGI docs + See the uWSGI docs for more information. diff --git a/nixos/modules/system/boot/initrd-network.nix b/nixos/modules/system/boot/initrd-network.nix index 43327fdd9da..eff125971d0 100644 --- a/nixos/modules/system/boot/initrd-network.nix +++ b/nixos/modules/system/boot/initrd-network.nix @@ -53,9 +53,8 @@ in description = '' Add network connectivity support to initrd. The network may be configured using the ip kernel parameter, - as described in the - kernel documentation. Otherwise, if + as described in the kernel documentation. + Otherwise, if is enabled, an IP address is acquired using DHCP. diff --git a/nixos/modules/system/boot/networkd.nix b/nixos/modules/system/boot/networkd.nix index b006ce77454..1849dcfe1e1 100644 --- a/nixos/modules/system/boot/networkd.nix +++ b/nixos/modules/system/boot/networkd.nix @@ -1170,8 +1170,7 @@ let systemd.netdev 5 for details. A detailed explanation about how VRFs work can be found in the - kernel - docs. + kernel docs. ''; }; @@ -1909,9 +1908,7 @@ in Extra command-line arguments to pass to systemd-networkd-wait-online. These also affect per-interface systemd-network-wait-online@ services. - See - systemd-networkd-wait-online.service8 - for all available options. + See systemd-networkd-wait-online.service8 for all available options. ''; type = with types; listOf str; default = []; diff --git a/nixos/modules/system/boot/systemd/logind.nix b/nixos/modules/system/boot/systemd/logind.nix index 0df03e97694..bd05c07e26f 100644 --- a/nixos/modules/system/boot/systemd/logind.nix +++ b/nixos/modules/system/boot/systemd/logind.nix @@ -31,8 +31,7 @@ in when the user logs out. If true, the scope unit corresponding to the session and all processes inside that scope will be terminated. If false, the scope is "abandoned" (see - - systemd.scope(5)), and processes are not killed. + systemd.scope(5)), and processes are not killed. See logind.conf(5) for more details. diff --git a/nixos/modules/tasks/network-interfaces.nix b/nixos/modules/tasks/network-interfaces.nix index e6cb2daaffc..a4620353294 100644 --- a/nixos/modules/tasks/network-interfaces.nix +++ b/nixos/modules/tasks/network-interfaces.nix @@ -1292,7 +1292,7 @@ in description = '' Whether to enable IPv6 Privacy Extensions for interfaces not configured explicitly in - . + . This sets the ipv6.conf.*.use_tempaddr sysctl for all interfaces. Possible values are: -- cgit 1.4.1