diff options
author | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | 2022-08-02 06:02:34 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-08-02 06:02:34 +0000 |
commit | 0f0010fda33b7082197495df475d02f64d7e5050 (patch) | |
tree | deee10eaf5f1b24afc73804ae70aec24e6fcf2ce | |
parent | ad090ff8671dcb957c0bafef4eba9d527d90d957 (diff) | |
parent | d2042f91c1ad953825556be3ec2e53cf9a91fc77 (diff) |
Merge master into staging-next
1092 files changed, 9786 insertions, 9755 deletions
diff --git a/nixos/lib/make-options-doc/default.nix b/nixos/lib/make-options-doc/default.nix index 6649fc41d41aa..e039bc4a9b73d 100644 --- a/nixos/lib/make-options-doc/default.nix +++ b/nixos/lib/make-options-doc/default.nix @@ -99,6 +99,14 @@ let optionsNix = builtins.listToAttrs (map (o: { name = o.name; value = removeAttrs o ["name" "visible" "internal"]; }) optionsList); + pythonMD = + let + self = (pkgs.python3Minimal.override { + inherit self; + includeSiteCustomize = true; + }); + in self.withPackages (p: [ p.mistune_2_0 ]); + in rec { inherit optionsNix; @@ -116,17 +124,20 @@ in rec { optionsJSON = pkgs.runCommand "options.json" { meta.description = "List of NixOS options in JSON format"; - buildInputs = [ - pkgs.brotli - (let - self = (pkgs.python3Minimal.override { - inherit self; - includeSiteCustomize = true; - }); - in self.withPackages (p: [ p.mistune_2_0 ])) - ]; + buildInputs = [ pkgs.brotli pythonMD ]; options = builtins.toFile "options.json" (builtins.unsafeDiscardStringContext (builtins.toJSON optionsNix)); + # convert markdown to docbook in its own derivation to cache the + # conversion results. the conversion is surprisingly expensive. + baseJSON = + if baseOptionsJSON != null + then + pkgs.runCommand "base-json-md-converted" { + buildInputs = [ pythonMD ]; + } '' + python ${./mergeJSON.py} ${baseOptionsJSON} <(echo '{}') > $out + '' + else null; } '' # Export list of options in different format. @@ -143,7 +154,7 @@ in rec { else '' python ${./mergeJSON.py} \ ${lib.optionalString warningsAreErrors "--warnings-are-errors"} \ - ${baseOptionsJSON} $options \ + $baseJSON $options \ > $dst/options.json '' } diff --git a/nixos/lib/make-options-doc/mergeJSON.py b/nixos/lib/make-options-doc/mergeJSON.py index 33e5172270b58..e95352f4fe6f4 100644 --- a/nixos/lib/make-options-doc/mergeJSON.py +++ b/nixos/lib/make-options-doc/mergeJSON.py @@ -53,12 +53,14 @@ def convertMD(options: Dict[str, Any]) -> str: '.note': 'note' } class Renderer(mistune.renderers.BaseRenderer): + def __init__(self, path): + self.path = path def _get_method(self, name): try: return super(Renderer, self)._get_method(name) except AttributeError: def not_supported(*args, **kwargs): - raise NotImplementedError("md node not supported yet", name, args, **kwargs) + raise NotImplementedError("md node not supported yet", self.path, name, args, **kwargs) return not_supported def text(self, text): @@ -166,8 +168,8 @@ def convertMD(options: Dict[str, Any]) -> str: md.block.rules.append('admonition') plugins.append(admonition) - def convertString(text: str) -> str: - rendered = mistune.markdown(text, renderer=Renderer(), plugins=plugins) + def convertString(path: str, text: str) -> str: + rendered = mistune.markdown(text, renderer=Renderer(path), plugins=plugins) # keep trailing spaces so we can diff the generated XML to check for conversion bugs. return rendered.rstrip() + text[len(text.rstrip()):] @@ -179,12 +181,12 @@ def convertMD(options: Dict[str, Any]) -> str: for (name, option) in options.items(): if optionIs(option, 'description', 'mdDoc'): - option['description'] = convertString(option['description']['text']) + option['description'] = convertString(name, option['description']['text']) if optionIs(option, 'example', 'literalMD'): - docbook = convertString(option['example']['text']) + docbook = convertString(name, option['example']['text']) option['example'] = { '_type': 'literalDocBook', 'text': docbook } if optionIs(option, 'default', 'literalMD'): - docbook = convertString(option['default']['text']) + docbook = convertString(name, option['default']['text']) option['default'] = { '_type': 'literalDocBook', 'text': docbook } return options diff --git a/nixos/modules/config/console.nix b/nixos/modules/config/console.nix index 94c1c0514f9f8..7bcbf54cedd65 100644 --- a/nixos/modules/config/console.nix +++ b/nixos/modules/config/console.nix @@ -58,7 +58,7 @@ in type = with types; either str path; default = "us"; example = "fr"; - description = '' + description = lib.mdDoc '' The keyboard mapping table for the virtual consoles. ''; }; @@ -72,7 +72,7 @@ in "002b36" "cb4b16" "586e75" "657b83" "839496" "6c71c4" "93a1a1" "fdf6e3" ]; - description = '' + description = lib.mdDoc '' The 16 colors palette used by the virtual consoles. Leave empty to use the default colors. Colors must be in hexadecimal format and listed in @@ -84,7 +84,7 @@ in packages = mkOption { type = types.listOf types.package; default = [ ]; - description = '' + description = lib.mdDoc '' List of additional packages that provide console fonts, keymaps and other resources for virtual consoles use. ''; @@ -93,7 +93,7 @@ in useXkbConfig = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If set, configure the virtual console keymap from the xserver keyboard settings. ''; @@ -102,7 +102,7 @@ in earlySetup = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable setting virtual console options as early as possible (in initrd). ''; }; diff --git a/nixos/modules/config/fonts/fontconfig.nix b/nixos/modules/config/fonts/fontconfig.nix index a10a8c6428a10..f86c0387e91d0 100644 --- a/nixos/modules/config/fonts/fontconfig.nix +++ b/nixos/modules/config/fonts/fontconfig.nix @@ -246,7 +246,7 @@ in enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' If enabled, a Fontconfig configuration file will be built pointing to a set of default fonts. If you don't care about running X11 applications or any other program that uses @@ -267,7 +267,7 @@ in antialias = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Enable font antialiasing. At high resolution (> 200 DPI), antialiasing has no visible effect; users of such displays may want to disable this option. @@ -277,9 +277,9 @@ in localConf = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' System-wide customization file contents, has higher priority than - <literal>defaultFonts</literal> settings. + `defaultFonts` settings. ''; }; @@ -287,7 +287,7 @@ in monospace = mkOption { type = types.listOf types.str; default = ["DejaVu Sans Mono"]; - description = '' + description = lib.mdDoc '' System-wide default monospace font(s). Multiple fonts may be listed in case multiple languages must be supported. ''; @@ -296,7 +296,7 @@ in sansSerif = mkOption { type = types.listOf types.str; default = ["DejaVu Sans"]; - description = '' + description = lib.mdDoc '' System-wide default sans serif font(s). Multiple fonts may be listed in case multiple languages must be supported. ''; @@ -305,7 +305,7 @@ in serif = mkOption { type = types.listOf types.str; default = ["DejaVu Serif"]; - description = '' + description = lib.mdDoc '' System-wide default serif font(s). Multiple fonts may be listed in case multiple languages must be supported. ''; @@ -314,7 +314,7 @@ in emoji = mkOption { type = types.listOf types.str; default = ["Noto Color Emoji"]; - description = '' + description = lib.mdDoc '' System-wide default emoji font(s). Multiple fonts may be listed in case a font does not support all emoji. @@ -331,7 +331,7 @@ in enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Enable font hinting. Hinting aligns glyphs to pixel boundaries to improve rendering sharpness at low resolution. At high resolution (> 200 dpi) hinting will do nothing (at best); users of such @@ -342,7 +342,7 @@ in autohint = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the autohinter in place of the default interpreter. The results are usually lower quality than correctly-hinted fonts, but better than unhinted fonts. @@ -352,7 +352,7 @@ in style = mkOption { type = types.enum [ "hintnone" "hintslight" "hintmedium" "hintfull" ]; default = "hintslight"; - description = '' + description = lib.mdDoc '' Hintstyle is the amount of font reshaping done to line up to the grid. @@ -367,10 +367,10 @@ in includeUserConf = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Include the user configuration from - <filename>~/.config/fontconfig/fonts.conf</filename> or - <filename>~/.config/fontconfig/conf.d</filename>. + {file}`~/.config/fontconfig/fonts.conf` or + {file}`~/.config/fontconfig/conf.d`. ''; }; @@ -379,26 +379,26 @@ in rgba = mkOption { default = "rgb"; type = types.enum ["rgb" "bgr" "vrgb" "vbgr" "none"]; - description = '' + description = lib.mdDoc '' Subpixel order. The overwhelming majority of displays are - <literal>rgb</literal> in their normal orientation. Select - <literal>vrgb</literal> for mounting such a display 90 degrees - clockwise from its normal orientation or <literal>vbgr</literal> + `rgb` in their normal orientation. Select + `vrgb` for mounting such a display 90 degrees + clockwise from its normal orientation or `vbgr` for mounting 90 degrees counter-clockwise. Select - <literal>bgr</literal> in the unlikely event of mounting 180 + `bgr` in the unlikely event of mounting 180 degrees from the normal orientation. Reverse these directions in the improbable event that the display's native subpixel order is - <literal>bgr</literal>. + `bgr`. ''; }; lcdfilter = mkOption { default = "default"; type = types.enum ["none" "default" "light" "legacy"]; - description = '' + description = lib.mdDoc '' FreeType LCD filter. At high resolution (> 200 DPI), LCD filtering has no visible effect; users of such displays may want to select - <literal>none</literal>. + `none`. ''; }; @@ -407,7 +407,7 @@ in cache32Bit = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Generate system fonts cache for 32-bit applications. ''; }; @@ -415,8 +415,8 @@ in allowBitmaps = mkOption { type = types.bool; default = true; - description = '' - Allow bitmap fonts. Set to <literal>false</literal> to ban all + description = lib.mdDoc '' + Allow bitmap fonts. Set to `false` to ban all bitmap fonts. ''; }; @@ -424,8 +424,8 @@ in allowType1 = mkOption { type = types.bool; default = false; - description = '' - Allow Type-1 fonts. Default is <literal>false</literal> because of + description = lib.mdDoc '' + Allow Type-1 fonts. Default is `false` because of poor rendering. ''; }; @@ -433,7 +433,7 @@ in useEmbeddedBitmaps = mkOption { type = types.bool; default = false; - description = "Use embedded bitmaps in fonts like Calibri."; + description = lib.mdDoc "Use embedded bitmaps in fonts like Calibri."; }; }; diff --git a/nixos/modules/config/fonts/fonts.nix b/nixos/modules/config/fonts/fonts.nix index adc6654afc79b..c0619fa31a327 100644 --- a/nixos/modules/config/fonts/fonts.nix +++ b/nixos/modules/config/fonts/fonts.nix @@ -57,13 +57,13 @@ in type = types.listOf types.path; default = []; example = literalExpression "[ pkgs.dejavu_fonts ]"; - description = "List of primary font paths."; + description = lib.mdDoc "List of primary font paths."; }; enableDefaultFonts = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable a basic set of fonts providing several font styles and families and reasonable coverage of Unicode. ''; diff --git a/nixos/modules/config/fonts/ghostscript.nix b/nixos/modules/config/fonts/ghostscript.nix index b1dd81bf2d2ea..c284c4a0b0ab1 100644 --- a/nixos/modules/config/fonts/ghostscript.nix +++ b/nixos/modules/config/fonts/ghostscript.nix @@ -11,7 +11,7 @@ with lib; enableGhostscriptFonts = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to add the fonts provided by Ghostscript (such as various URW fonts and the “Base-14” Postscript fonts) to the list of system fonts, making them available to X11 diff --git a/nixos/modules/config/gnu.nix b/nixos/modules/config/gnu.nix index 255d9741ba714..d06b479e2af53 100644 --- a/nixos/modules/config/gnu.nix +++ b/nixos/modules/config/gnu.nix @@ -5,7 +5,7 @@ gnu = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' When enabled, GNU software is chosen by default whenever a there is a choice between GNU and non-GNU software (e.g., GNU lsh vs. OpenSSH). diff --git a/nixos/modules/config/gtk/gtk-icon-cache.nix b/nixos/modules/config/gtk/gtk-icon-cache.nix index ff9aa7c6a0477..87d5483e36ab9 100644 --- a/nixos/modules/config/gtk/gtk-icon-cache.nix +++ b/nixos/modules/config/gtk/gtk-icon-cache.nix @@ -7,7 +7,7 @@ with lib; type = types.bool; default = config.services.xserver.enable; defaultText = literalExpression "config.services.xserver.enable"; - description = '' + description = lib.mdDoc '' Whether to build icon theme caches for GTK applications. ''; }; diff --git a/nixos/modules/config/i18n.nix b/nixos/modules/config/i18n.nix index b78e678488530..80ef515fbfe20 100644 --- a/nixos/modules/config/i18n.nix +++ b/nixos/modules/config/i18n.nix @@ -21,7 +21,7 @@ with lib; } ''; example = literalExpression "pkgs.glibcLocales"; - description = '' + description = lib.mdDoc '' Customized pkg.glibcLocales package. Changing this option can disable handling of i18n.defaultLocale @@ -33,7 +33,7 @@ with lib; type = types.str; default = "en_US.UTF-8"; example = "nl_NL.UTF-8"; - description = '' + description = lib.mdDoc '' The default locale. It determines the language for program messages, the format for dates and times, sort order, and so on. It also determines the character set, such as UTF-8. @@ -44,10 +44,10 @@ with lib; type = types.attrsOf types.str; default = {}; example = { LC_MESSAGES = "en_US.UTF-8"; LC_TIME = "de_DE.UTF-8"; }; - description = '' + description = lib.mdDoc '' A set of additional system-wide locale settings other than - <literal>LANG</literal> which can be configured with - <option>i18n.defaultLocale</option>. + `LANG` which can be configured with + {option}`i18n.defaultLocale`. ''; }; diff --git a/nixos/modules/config/iproute2.nix b/nixos/modules/config/iproute2.nix index 5f41f3d21e453..2e059e281701b 100644 --- a/nixos/modules/config/iproute2.nix +++ b/nixos/modules/config/iproute2.nix @@ -11,7 +11,7 @@ in rttablesExtraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Verbatim lines to add to /etc/iproute2/rt_tables ''; }; diff --git a/nixos/modules/config/krb5/default.nix b/nixos/modules/config/krb5/default.nix index 911c5b629a9a1..6cc30c47b7de7 100644 --- a/nixos/modules/config/krb5/default.nix +++ b/nixos/modules/config/krb5/default.nix @@ -85,9 +85,9 @@ in { default = pkgs.krb5Full; defaultText = literalExpression "pkgs.krb5Full"; example = literalExpression "pkgs.heimdal"; - description = '' + description = lib.mdDoc '' The Kerberos implementation that will be present in - <literal>environment.systemPackages</literal> after enabling this + `environment.systemPackages` after enabling this service. ''; }; @@ -101,7 +101,7 @@ in { default_realm = "ATHENA.MIT.EDU"; }; ''; - description = '' + description = lib.mdDoc '' Settings used by the Kerberos V5 library. ''; }; @@ -121,7 +121,7 @@ in { }; ''; apply = attrs: filterEmbeddedMetadata attrs; - description = "Realm-specific contact information and settings."; + description = lib.mdDoc "Realm-specific contact information and settings."; }; domain_realm = mkOption { @@ -134,7 +134,7 @@ in { }; ''; apply = attrs: filterEmbeddedMetadata attrs; - description = '' + description = lib.mdDoc '' Map of server hostnames to Kerberos realms. ''; }; @@ -153,7 +153,7 @@ in { }; ''; apply = attrs: filterEmbeddedMetadata attrs; - description = '' + description = lib.mdDoc '' Authentication paths for non-hierarchical cross-realm authentication. ''; }; @@ -174,7 +174,7 @@ in { }; ''; apply = attrs: filterEmbeddedMetadata attrs; - description = '' + description = lib.mdDoc '' Settings used by some Kerberos V5 applications. ''; }; @@ -190,7 +190,7 @@ in { }; ''; apply = attrs: filterEmbeddedMetadata attrs; - description = '' + description = lib.mdDoc '' Controls plugin module registration. ''; }; @@ -235,14 +235,14 @@ in { admin_server = SYSLOG:NOTICE default = SYSLOG:NOTICE ''; - description = '' - Verbatim <literal>krb5.conf</literal> configuration. Note that this + description = lib.mdDoc '' + Verbatim `krb5.conf` configuration. Note that this is mutually exclusive with configuration via - <literal>libdefaults</literal>, <literal>realms</literal>, - <literal>domain_realm</literal>, <literal>capaths</literal>, - <literal>appdefaults</literal>, <literal>plugins</literal> and - <literal>extraConfig</literal> configuration options. Consult - <literal>man krb5.conf</literal> for documentation. + `libdefaults`, `realms`, + `domain_realm`, `capaths`, + `appdefaults`, `plugins` and + `extraConfig` configuration options. Consult + `man krb5.conf` for documentation. ''; }; @@ -250,9 +250,9 @@ in { type = with types; nullOr str; default = null; example = "ATHENA.MIT.EDU"; - description = '' + description = lib.mdDoc '' DEPRECATED, please use - <literal>krb5.libdefaults.default_realm</literal>. + `krb5.libdefaults.default_realm`. ''; }; @@ -260,9 +260,9 @@ in { type = with types; nullOr str; default = null; example = "athena.mit.edu"; - description = '' + description = lib.mdDoc '' DEPRECATED, please create a map of server hostnames to Kerberos realms - in <literal>krb5.domain_realm</literal>. + in `krb5.domain_realm`. ''; }; @@ -270,9 +270,9 @@ in { type = with types; nullOr str; default = null; example = "kerberos.mit.edu"; - description = '' - DEPRECATED, please pass a <literal>kdc</literal> attribute to a realm - in <literal>krb5.realms</literal>. + description = lib.mdDoc '' + DEPRECATED, please pass a `kdc` attribute to a realm + in `krb5.realms`. ''; }; @@ -280,9 +280,9 @@ in { type = with types; nullOr str; default = null; example = "kerberos.mit.edu"; - description = '' - DEPRECATED, please pass an <literal>admin_server</literal> attribute - to a realm in <literal>krb5.realms</literal>. + description = lib.mdDoc '' + DEPRECATED, please pass an `admin_server` attribute + to a realm in `krb5.realms`. ''; }; }; diff --git a/nixos/modules/config/ldap.nix b/nixos/modules/config/ldap.nix index 85cad8b93d8cb..0f54e4a8cf056 100644 --- a/nixos/modules/config/ldap.nix +++ b/nixos/modules/config/ldap.nix @@ -64,34 +64,34 @@ in loginPam = mkOption { type = types.bool; default = true; - description = "Whether to include authentication against LDAP in login PAM."; + description = lib.mdDoc "Whether to include authentication against LDAP in login PAM."; }; nsswitch = mkOption { type = types.bool; default = true; - description = "Whether to include lookup against LDAP in NSS."; + description = lib.mdDoc "Whether to include lookup against LDAP in NSS."; }; server = mkOption { type = types.str; example = "ldap://ldap.example.org/"; - description = "The URL of the LDAP server."; + description = lib.mdDoc "The URL of the LDAP server."; }; base = mkOption { type = types.str; example = "dc=example,dc=org"; - description = "The distinguished name of the search base."; + description = lib.mdDoc "The distinguished name of the search base."; }; useTLS = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If enabled, use TLS (encryption) over an LDAP (port 389) connection. The alternative is to specify an LDAPS server (port - 636) in <option>users.ldap.server</option> or to forego + 636) in {option}`users.ldap.server` or to forego security. ''; }; @@ -99,7 +99,7 @@ in timeLimit = mkOption { default = 0; type = types.int; - description = '' + description = lib.mdDoc '' Specifies the time limit (in seconds) to use when performing searches. A value of zero (0), which is the default, is to wait indefinitely for searches to be completed. @@ -110,7 +110,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to let the nslcd daemon (nss-pam-ldapd) handle the LDAP lookups for NSS and PAM. This can improve performance, and if you need to bind to the LDAP server with a password, @@ -125,9 +125,9 @@ in extraConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Extra configuration options that will be added verbatim at - the end of the nslcd configuration file (<literal>nslcd.conf(5)</literal>). + the end of the nslcd configuration file (`nslcd.conf(5)`). '' ; } ; @@ -135,7 +135,7 @@ in default = ""; example = "cn=admin,dc=example,dc=com"; type = types.str; - description = '' + description = lib.mdDoc '' The distinguished name to use to bind to the LDAP server when the root user tries to modify a user's password. ''; @@ -145,7 +145,7 @@ in default = ""; example = "/run/keys/nslcd.rootpwmodpw"; type = types.str; - description = '' + description = lib.mdDoc '' The path to a file containing the credentials with which to bind to the LDAP server if the root user tries to change a user's password. ''; @@ -157,7 +157,7 @@ in default = ""; example = "cn=admin,dc=example,dc=com"; type = types.str; - description = '' + description = lib.mdDoc '' The distinguished name to bind to the LDAP server with. If this is not specified, an anonymous bind will be done. ''; @@ -166,7 +166,7 @@ in passwordFile = mkOption { default = "/etc/ldap/bind.password"; type = types.str; - description = '' + description = lib.mdDoc '' The path to a file containing the credentials to use when binding to the LDAP server (if not binding anonymously). ''; @@ -175,10 +175,10 @@ in timeLimit = mkOption { default = 30; type = types.int; - description = '' + description = lib.mdDoc '' Specifies the time limit (in seconds) to use when connecting to the directory server. This is distinct from the time limit - specified in <option>users.ldap.timeLimit</option> and affects + specified in {option}`users.ldap.timeLimit` and affects the initial server connection only. ''; }; @@ -205,12 +205,12 @@ in extraConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Extra configuration options that will be added verbatim at - the end of the ldap configuration file (<literal>ldap.conf(5)</literal>). - If <option>users.ldap.daemon</option> is enabled, this + the end of the ldap configuration file (`ldap.conf(5)`). + If {option}`users.ldap.daemon` is enabled, this configuration will not be used. In that case, use - <option>users.ldap.daemon.extraConfig</option> instead. + {option}`users.ldap.daemon.extraConfig` instead. '' ; }; diff --git a/nixos/modules/config/networking.nix b/nixos/modules/config/networking.nix index bebfeb352c017..185eff746de0e 100644 --- a/nixos/modules/config/networking.nix +++ b/nixos/modules/config/networking.nix @@ -28,7 +28,7 @@ in "192.168.0.2" = [ "fileserver.local" "nameserver.local" ]; }; ''; - description = '' + description = lib.mdDoc '' Locally defined maps of hostnames to IP addresses. ''; }; @@ -37,8 +37,8 @@ in type = types.listOf types.path; defaultText = literalDocBook "Hosts from <option>networking.hosts</option> and <option>networking.extraHosts</option>"; example = literalExpression ''[ "''${pkgs.my-blocklist-package}/share/my-blocklist/hosts" ]''; - description = '' - Files that should be concatenated together to form <filename>/etc/hosts</filename>. + description = lib.mdDoc '' + Files that should be concatenated together to form {file}`/etc/hosts`. ''; }; @@ -46,9 +46,9 @@ in type = types.lines; default = ""; example = "192.168.0.1 lanlocalhost"; - description = '' - Additional verbatim entries to be appended to <filename>/etc/hosts</filename>. - For adding hosts from derivation results, use <option>networking.hostFiles</option> instead. + description = lib.mdDoc '' + Additional verbatim entries to be appended to {file}`/etc/hosts`. + For adding hosts from derivation results, use {option}`networking.hostFiles` instead. ''; }; @@ -60,7 +60,7 @@ in "3.nixos.pool.ntp.org" ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' The set of NTP servers from which to synchronise. ''; }; @@ -70,7 +70,7 @@ in default = lib.mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' This option specifies the default value for httpProxy, httpsProxy, ftpProxy and rsyncProxy. ''; example = "http://127.0.0.1:3128"; @@ -80,7 +80,7 @@ in type = types.nullOr types.str; default = cfg.proxy.default; defaultText = literalExpression "config.${opt.proxy.default}"; - description = '' + description = lib.mdDoc '' This option specifies the http_proxy environment variable. ''; example = "http://127.0.0.1:3128"; @@ -90,7 +90,7 @@ in type = types.nullOr types.str; default = cfg.proxy.default; defaultText = literalExpression "config.${opt.proxy.default}"; - description = '' + description = lib.mdDoc '' This option specifies the https_proxy environment variable. ''; example = "http://127.0.0.1:3128"; @@ -100,7 +100,7 @@ in type = types.nullOr types.str; default = cfg.proxy.default; defaultText = literalExpression "config.${opt.proxy.default}"; - description = '' + description = lib.mdDoc '' This option specifies the ftp_proxy environment variable. ''; example = "http://127.0.0.1:3128"; @@ -110,7 +110,7 @@ in type = types.nullOr types.str; default = cfg.proxy.default; defaultText = literalExpression "config.${opt.proxy.default}"; - description = '' + description = lib.mdDoc '' This option specifies the rsync_proxy environment variable. ''; example = "http://127.0.0.1:3128"; @@ -120,7 +120,7 @@ in type = types.nullOr types.str; default = cfg.proxy.default; defaultText = literalExpression "config.${opt.proxy.default}"; - description = '' + description = lib.mdDoc '' This option specifies the all_proxy environment variable. ''; example = "http://127.0.0.1:3128"; @@ -129,7 +129,7 @@ in noProxy = lib.mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' This option specifies the no_proxy environment variable. If a default proxy is used and noProxy is null, then noProxy will be set to 127.0.0.1,localhost. diff --git a/nixos/modules/config/no-x-libs.nix b/nixos/modules/config/no-x-libs.nix index 14fe180d0bc5f..42e68c2eadc10 100644 --- a/nixos/modules/config/no-x-libs.nix +++ b/nixos/modules/config/no-x-libs.nix @@ -10,7 +10,7 @@ with lib; environment.noXlibs = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Switch off the options in the default configuration that require X11 libraries. This includes client-side font configuration and SSH forwarding of X11 authentication diff --git a/nixos/modules/config/power-management.nix b/nixos/modules/config/power-management.nix index 710842e1503b2..919bb824bc5a7 100644 --- a/nixos/modules/config/power-management.nix +++ b/nixos/modules/config/power-management.nix @@ -20,7 +20,7 @@ in type = types.bool; default = true; description = - '' + lib.mdDoc '' Whether to enable power management. This includes support for suspend-to-RAM and powersave features on laptops. ''; @@ -29,7 +29,7 @@ in resumeCommands = mkOption { type = types.lines; default = ""; - description = "Commands executed after the system resumes from suspend-to-RAM."; + description = lib.mdDoc "Commands executed after the system resumes from suspend-to-RAM."; }; powerUpCommands = mkOption { @@ -39,7 +39,7 @@ in "''${pkgs.hdparm}/sbin/hdparm -B 255 /dev/sda" ''; description = - '' + lib.mdDoc '' Commands executed when the machine powers up. That is, they're executed both when the system first boots and when it resumes from suspend or hibernation. @@ -53,7 +53,7 @@ in "''${pkgs.hdparm}/sbin/hdparm -B 255 /dev/sda" ''; description = - '' + lib.mdDoc '' Commands executed when the machine powers down. That is, they're executed both when the system shuts down and when it goes to suspend or hibernation. diff --git a/nixos/modules/config/resolvconf.nix b/nixos/modules/config/resolvconf.nix index 3e14884bb2bff..cdc40d2c810bf 100644 --- a/nixos/modules/config/resolvconf.nix +++ b/nixos/modules/config/resolvconf.nix @@ -49,7 +49,7 @@ in type = types.bool; default = !(config.environment.etc ? "resolv.conf"); defaultText = literalExpression ''!(config.environment.etc ? "resolv.conf")''; - description = '' + description = lib.mdDoc '' Whether DNS configuration is managed by resolvconf. ''; }; @@ -58,9 +58,9 @@ in type = types.package; default = pkgs.openresolv; defaultText = literalExpression "pkgs.openresolv"; - description = '' - The package that provides the system-wide resolvconf command. Defaults to <literal>openresolv</literal> - if this module is enabled. Otherwise, can be used by other modules (for example <option>services.resolved</option>) to + description = lib.mdDoc '' + The package that provides the system-wide resolvconf command. Defaults to `openresolv` + if this module is enabled. Otherwise, can be used by other modules (for example {option}`services.resolved`) to provide a compatibility layer. This option generally shouldn't be set by the user. @@ -70,7 +70,7 @@ in dnsSingleRequest = lib.mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Recent versions of glibc will issue both ipv4 (A) and ipv6 (AAAA) address queries at the same time, from the same port. Sometimes upstream routers will systemically drop the ipv4 queries. The symptom of this problem is @@ -95,8 +95,8 @@ in type = types.lines; default = ""; example = "libc=NO"; - description = '' - Extra configuration to append to <filename>resolvconf.conf</filename>. + description = lib.mdDoc '' + Extra configuration to append to {file}`resolvconf.conf`. ''; }; @@ -104,15 +104,15 @@ in type = types.listOf types.str; default = []; example = [ "ndots:1" "rotate" ]; - description = '' - Set the options in <filename>/etc/resolv.conf</filename>. + description = lib.mdDoc '' + Set the options in {file}`/etc/resolv.conf`. ''; }; useLocalResolver = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Use local DNS server for resolving. ''; }; diff --git a/nixos/modules/config/shells-environment.nix b/nixos/modules/config/shells-environment.nix index ae3f618e273c3..660b2e1fa4bfb 100644 --- a/nixos/modules/config/shells-environment.nix +++ b/nixos/modules/config/shells-environment.nix @@ -35,7 +35,7 @@ in environment.variables = mkOption { default = {}; example = { EDITOR = "nvim"; VISUAL = "nvim"; }; - description = '' + description = lib.mdDoc '' A set of environment variables used in the global environment. These variables will be set on shell initialisation (e.g. in /etc/profile). The value of each variable can be either a string or a list of @@ -48,7 +48,7 @@ in environment.profiles = mkOption { default = []; - description = '' + description = lib.mdDoc '' A list of profiles used to setup the global environment. ''; type = types.listOf types.str; @@ -57,10 +57,10 @@ in environment.profileRelativeEnvVars = mkOption { type = types.attrsOf (types.listOf types.str); example = { PATH = [ "/bin" ]; MANPATH = [ "/man" "/share/man" ]; }; - description = '' + description = lib.mdDoc '' Attribute set of environment variable. Each attribute maps to a list of relative paths. Each relative path is appended to the each profile - of <option>environment.profiles</option> to form the content of the + of {option}`environment.profiles` to form the content of the corresponding environment variable. ''; }; @@ -68,7 +68,7 @@ in # !!! isn't there a better way? environment.extraInit = mkOption { default = ""; - description = '' + description = lib.mdDoc '' Shell script code called during global environment initialisation after all variables and profileVariables have been set. This code is assumed to be shell-independent, which means you should @@ -79,7 +79,7 @@ in environment.shellInit = mkOption { default = ""; - description = '' + description = lib.mdDoc '' Shell script code called during shell initialisation. This code is assumed to be shell-independent, which means you should stick to pure sh without sh word split. @@ -89,7 +89,7 @@ in environment.loginShellInit = mkOption { default = ""; - description = '' + description = lib.mdDoc '' Shell script code called during login shell initialisation. This code is assumed to be shell-independent, which means you should stick to pure sh without sh word split. @@ -99,7 +99,7 @@ in environment.interactiveShellInit = mkOption { default = ""; - description = '' + description = lib.mdDoc '' Shell script code called during interactive shell initialisation. This code is assumed to be shell-independent, which means you should stick to pure sh without sh word split. @@ -119,7 +119,7 @@ in }; environment.homeBinInPath = mkOption { - description = '' + description = lib.mdDoc '' Include ~/bin/ in $PATH. ''; default = false; @@ -127,7 +127,7 @@ in }; environment.localBinInPath = mkOption { - description = '' + description = lib.mdDoc '' Add ~/.local/bin/ to $PATH ''; default = false; @@ -151,9 +151,9 @@ in environment.shells = mkOption { default = []; example = literalExpression "[ pkgs.bashInteractive pkgs.zsh ]"; - description = '' + description = lib.mdDoc '' A list of permissible login shells for user accounts. - No need to mention <literal>/bin/sh</literal> + No need to mention `/bin/sh` here, it is placed into this list implicitly. ''; type = types.listOf (types.either types.shellPackage types.path); diff --git a/nixos/modules/config/swap.nix b/nixos/modules/config/swap.nix index 2b94b954cb80f..3216590d8f958 100644 --- a/nixos/modules/config/swap.nix +++ b/nixos/modules/config/swap.nix @@ -14,7 +14,7 @@ let enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Encrypt swap device with a random key. This way you won't have a persistent swap device. WARNING: Don't try to hibernate when you have at least one swap partition with @@ -31,7 +31,7 @@ let default = "aes-xts-plain64"; example = "serpent-xts-plain64"; type = types.str; - description = '' + description = lib.mdDoc '' Use specified cipher for randomEncryption. Hint: Run "cryptsetup benchmark" to see which one is fastest on your machine. @@ -42,7 +42,7 @@ let default = "/dev/urandom"; example = "/dev/random"; type = types.str; - description = '' + description = lib.mdDoc '' Define the source of randomness to obtain a random key for encryption. ''; }; @@ -50,7 +50,7 @@ let allowDiscards = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to allow TRIM requests to the underlying device. This option has security implications; please read the LUKS documentation before activating it. @@ -67,7 +67,7 @@ let device = mkOption { example = "/dev/sda3"; type = types.str; - description = "Path of the device or swap file."; + description = lib.mdDoc "Path of the device or swap file."; }; label = mkOption { @@ -82,7 +82,7 @@ let default = null; example = 2048; type = types.nullOr types.int; - description = '' + description = lib.mdDoc '' If this option is set, ‘device’ is interpreted as the path of a swapfile that will be created automatically with the indicated size (in megabytes). @@ -93,7 +93,7 @@ let default = null; example = 2048; type = types.nullOr types.int; - description = '' + description = lib.mdDoc '' Specify the priority of the swap device. Priority is a value between 0 and 32767. Higher numbers indicate higher priority. null lets the kernel choose a priority, which will show up as a negative value. @@ -108,7 +108,7 @@ let source = "/dev/random"; }; type = types.coercedTo types.bool randomEncryptionCoerce (types.submodule randomEncryptionOpts); - description = '' + description = lib.mdDoc '' Encrypt swap device with a random key. This way you won't have a persistent swap device. HINT: run "cryptsetup benchmark" to test cipher performance on your machine. @@ -127,7 +127,7 @@ let default = null; example = "once"; type = types.nullOr (types.enum ["once" "pages" "both" ]); - description = '' + description = lib.mdDoc '' Specify the discard policy for the swap device. If "once", then the whole swap space is discarded at swapon invocation. If "pages", asynchronous discard on freed pages is performed, before returning to @@ -140,7 +140,7 @@ let default = [ "defaults" ]; example = [ "nofail" ]; type = types.listOf types.nonEmptyStr; - description = '' + description = lib.mdDoc '' Options used to mount the swap. ''; }; @@ -181,13 +181,13 @@ in { device = "/var/swapfile"; } { label = "bigswap"; } ]; - description = '' + description = lib.mdDoc '' The swap devices and swap files. These must have been - initialised using <command>mkswap</command>. Each element + initialised using {command}`mkswap`. Each element should be an attribute set specifying either the path of the - swap device or file (<literal>device</literal>) or the label - of the swap device (<literal>label</literal>, see - <command>mkswap -L</command>). Using a label is + swap device or file (`device`) or the label + of the swap device (`label`, see + {command}`mkswap -L`). Using a label is recommended. ''; diff --git a/nixos/modules/config/system-path.nix b/nixos/modules/config/system-path.nix index 875c4c9c44155..de980e7383b0d 100644 --- a/nixos/modules/config/system-path.nix +++ b/nixos/modules/config/system-path.nix @@ -64,14 +64,14 @@ in type = types.listOf types.package; default = []; example = literalExpression "[ pkgs.firefox pkgs.thunderbird ]"; - description = '' + description = lib.mdDoc '' The set of packages that appear in /run/current-system/sw. These packages are automatically available to all users, and are automatically updated every time you rebuild the system configuration. (The latter is the main difference with installing them in the default profile, - <filename>/nix/var/nix/profiles/default</filename>. + {file}`/nix/var/nix/profiles/default`. ''; }; @@ -109,20 +109,20 @@ in # to work. default = []; example = ["/"]; - description = "List of directories to be symlinked in <filename>/run/current-system/sw</filename>."; + description = lib.mdDoc "List of directories to be symlinked in {file}`/run/current-system/sw`."; }; extraOutputsToInstall = mkOption { type = types.listOf types.str; default = [ ]; example = [ "doc" "info" "devdoc" ]; - description = "List of additional package outputs to be symlinked into <filename>/run/current-system/sw</filename>."; + description = lib.mdDoc "List of additional package outputs to be symlinked into {file}`/run/current-system/sw`."; }; extraSetup = mkOption { type = types.lines; default = ""; - description = "Shell fragments to be run after the system environment has been created. This should only be used for things that need to modify the internals of the environment, e.g. generating MIME caches. The environment being built can be accessed at $out."; + description = lib.mdDoc "Shell fragments to be run after the system environment has been created. This should only be used for things that need to modify the internals of the environment, e.g. generating MIME caches. The environment being built can be accessed at $out."; }; }; diff --git a/nixos/modules/config/terminfo.nix b/nixos/modules/config/terminfo.nix index 693404a429c31..82f9ae48372af 100644 --- a/nixos/modules/config/terminfo.nix +++ b/nixos/modules/config/terminfo.nix @@ -9,7 +9,7 @@ with lib; options.environment.enableAllTerminfo = with lib; mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to install all terminfo outputs ''; }; diff --git a/nixos/modules/config/users-groups.nix b/nixos/modules/config/users-groups.nix index 85dfb93656195..466e3f6138a50 100644 --- a/nixos/modules/config/users-groups.nix +++ b/nixos/modules/config/users-groups.nix @@ -56,7 +56,7 @@ let name = mkOption { type = types.passwdEntry types.str; apply = x: assert (builtins.stringLength x < 32 || abort "Username '${x}' is longer than 31 characters which is not allowed!"); x; - description = '' + description = lib.mdDoc '' The name of the user account. If undefined, the name of the attribute set will be used. ''; @@ -66,17 +66,17 @@ let type = types.passwdEntry types.str; default = ""; example = "Alice Q. User"; - description = '' + description = lib.mdDoc '' A short description of the user account, typically the user's full name. This is actually the “GECOS” or “comment” - field in <filename>/etc/passwd</filename>. + field in {file}`/etc/passwd`. ''; }; uid = mkOption { type = with types; nullOr int; default = null; - description = '' + description = lib.mdDoc '' The account UID. If the UID is null, a free UID is picked on activation. ''; @@ -85,15 +85,15 @@ let isSystemUser = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Indicates if the user is a system user or not. This option - only has an effect if <option>uid</option> is - <option>null</option>, in which case it determines whether + only has an effect if {option}`uid` is + {option}`null`, in which case it determines whether the user's UID is allocated in the range for system users (below 500) or in the range for normal users (starting at 1000). - Exactly one of <literal>isNormalUser</literal> and - <literal>isSystemUser</literal> must be true. + Exactly one of `isNormalUser` and + `isSystemUser` must be true. ''; }; @@ -118,31 +118,31 @@ let type = types.str; apply = x: assert (builtins.stringLength x < 32 || abort "Group name '${x}' is longer than 31 characters which is not allowed!"); x; default = ""; - description = "The user's primary group."; + description = lib.mdDoc "The user's primary group."; }; extraGroups = mkOption { type = types.listOf types.str; default = []; - description = "The user's auxiliary groups."; + description = lib.mdDoc "The user's auxiliary groups."; }; home = mkOption { type = types.passwdEntry types.path; default = "/var/empty"; - description = "The user's home directory."; + description = lib.mdDoc "The user's home directory."; }; homeMode = mkOption { type = types.strMatching "[0-7]{1,5}"; default = "700"; - description = "The user's home directory mode in numeric format. See chmod(1). The mode is only applied if <option>users.users.<name>.createHome</option> is true."; + description = lib.mdDoc "The user's home directory mode in numeric format. See chmod(1). The mode is only applied if {option}`users.users.<name>.createHome` is true."; }; cryptHomeLuks = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Path to encrypted luks device that contains the user's home directory. ''; @@ -183,10 +183,10 @@ let { startUid = 1000; count = 1; } { startUid = 100001; count = 65534; } ]; - description = '' + description = lib.mdDoc '' Subordinate user ids that user is allowed to use. - They are set into <filename>/etc/subuid</filename> and are used - by <literal>newuidmap</literal> for user namespaces. + They are set into {file}`/etc/subuid` and are used + by `newuidmap` for user namespaces. ''; }; @@ -197,10 +197,10 @@ let { startGid = 100; count = 1; } { startGid = 1001; count = 999; } ]; - description = '' + description = lib.mdDoc '' Subordinate group ids that user is allowed to use. - They are set into <filename>/etc/subgid</filename> and are used - by <literal>newgidmap</literal> for user namespaces. + They are set into {file}`/etc/subgid` and are used + by `newgidmap` for user namespaces. ''; }; @@ -208,7 +208,7 @@ let type = types.bool; default = false; example = true; - description = '' + description = lib.mdDoc '' Automatically allocate subordinate user and group ids for this user. Allocated range is currently always of size 65536. ''; @@ -217,7 +217,7 @@ let createHome = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to create the home directory and ensure ownership as well as permissions to match the user. ''; @@ -226,9 +226,9 @@ let useDefaultShell = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If true, the user's shell will be set to - <option>users.defaultUserShell</option>. + {option}`users.defaultUserShell`. ''; }; @@ -284,13 +284,13 @@ let initialPassword = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Specifies the initial password for the user, i.e. the password assigned if the user does not already exist. If - <option>users.mutableUsers</option> is true, the password + {option}`users.mutableUsers` is true, the password can be changed subsequently using the - <command>passwd</command> command. Otherwise, it's - equivalent to setting the <option>password</option> + {command}`passwd` command. Otherwise, it's + equivalent to setting the {option}`password` option. The same caveat applies: the password specified here is world-readable in the Nix store, so it should only be used for guest accounts or passwords that will be changed @@ -302,9 +302,9 @@ let type = types.listOf types.package; default = []; example = literalExpression "[ pkgs.firefox pkgs.thunderbird ]"; - description = '' + description = lib.mdDoc '' The set of packages that should be made available to the user. - This is in contrast to <option>environment.systemPackages</option>, + This is in contrast to {option}`environment.systemPackages`, which adds packages to all users. ''; }; @@ -344,7 +344,7 @@ let name = mkOption { type = types.passwdEntry types.str; - description = '' + description = lib.mdDoc '' The name of the group. If undefined, the name of the attribute set will be used. ''; @@ -353,7 +353,7 @@ let gid = mkOption { type = with types; nullOr int; default = null; - description = '' + description = lib.mdDoc '' The group GID. If the GID is null, a free GID is picked on activation. ''; @@ -362,9 +362,9 @@ let members = mkOption { type = with types; listOf (passwdEntry str); default = []; - description = '' + description = lib.mdDoc '' The user names of the group members, added to the - <literal>/etc/group</literal> file. + `/etc/group` file. ''; }; @@ -384,7 +384,7 @@ let options = { startUid = mkOption { type = types.int; - description = '' + description = lib.mdDoc '' Start of the range of subordinate user ids that user is allowed to use. ''; @@ -392,7 +392,7 @@ let count = mkOption { type = types.int; default = 1; - description = "Count of subordinate user ids"; + description = lib.mdDoc "Count of subordinate user ids"; }; }; }; @@ -401,7 +401,7 @@ let options = { startGid = mkOption { type = types.int; - description = '' + description = lib.mdDoc '' Start of the range of subordinate group ids that user is allowed to use. ''; @@ -409,7 +409,7 @@ let count = mkOption { type = types.int; default = 1; - description = "Count of subordinate group ids"; + description = lib.mdDoc "Count of subordinate group ids"; }; }; }; @@ -484,7 +484,7 @@ in { users.enforceIdUniqueness = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to require that no two users/groups share the same uid/gid. ''; }; @@ -503,7 +503,7 @@ in { shell = "/bin/sh"; }; }; - description = '' + description = lib.mdDoc '' Additional user accounts to be created automatically by the system. This can also be used to set options for root. ''; @@ -516,7 +516,7 @@ in { hackers = { }; }; type = with types; attrsOf (submodule groupOpts); - description = '' + description = lib.mdDoc '' Additional groups to be created automatically by the system. ''; }; @@ -525,8 +525,8 @@ in { users.allowNoPasswordLogin = mkOption { type = types.bool; default = false; - description = '' - Disable checking that at least the <literal>root</literal> user or a user in the <literal>wheel</literal> group can log in using + description = lib.mdDoc '' + Disable checking that at least the `root` user or a user in the `wheel` group can log in using a password or an SSH key. WARNING: enabling this can lock you out of your system. Enable this only if you know what are you doing. diff --git a/nixos/modules/config/vte.nix b/nixos/modules/config/vte.nix index 24d32a00fd458..a969607f6e0b0 100644 --- a/nixos/modules/config/vte.nix +++ b/nixos/modules/config/vte.nix @@ -25,7 +25,7 @@ in programs.bash.vteIntegration = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable Bash integration for VTE terminals. This allows it to preserve the current directory of the shell across terminals. @@ -35,7 +35,7 @@ in programs.zsh.vteIntegration = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable Zsh integration for VTE terminals. This allows it to preserve the current directory of the shell across terminals. diff --git a/nixos/modules/config/xdg/mime.nix b/nixos/modules/config/xdg/mime.nix index 9b6dd4cab5f5c..3aa863083219a 100644 --- a/nixos/modules/config/xdg/mime.nix +++ b/nixos/modules/config/xdg/mime.nix @@ -18,10 +18,10 @@ in xdg.mime.enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to install files to support the - <link xlink:href="https://specifications.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-latest.html">XDG Shared MIME-info specification</link> and the - <link xlink:href="https://specifications.freedesktop.org/mime-apps-spec/mime-apps-spec-latest.html">XDG MIME Applications specification</link>. + [XDG Shared MIME-info specification](https://specifications.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-latest.html) and the + [XDG MIME Applications specification](https://specifications.freedesktop.org/mime-apps-spec/mime-apps-spec-latest.html). ''; }; @@ -32,10 +32,10 @@ in "application/pdf" = "firefox.desktop"; "text/xml" = [ "nvim.desktop" "codium.desktop" ]; }; - description = '' + description = lib.mdDoc '' Adds associations between mimetypes and applications. See the - <link xlink:href="https://specifications.freedesktop.org/mime-apps-spec/mime-apps-spec-latest.html#associations"> - specifications</link> for more information. + [ + specifications](https://specifications.freedesktop.org/mime-apps-spec/mime-apps-spec-latest.html#associations) for more information. ''; }; @@ -46,10 +46,10 @@ in "application/pdf" = "firefox.desktop"; "image/png" = [ "sxiv.desktop" "gimp.desktop" ]; }; - description = '' + description = lib.mdDoc '' Sets the default applications for given mimetypes. See the - <link xlink:href="https://specifications.freedesktop.org/mime-apps-spec/mime-apps-spec-latest.html#default"> - specifications</link> for more information. + [ + specifications](https://specifications.freedesktop.org/mime-apps-spec/mime-apps-spec-latest.html#default) for more information. ''; }; @@ -60,10 +60,10 @@ in "audio/mp3" = [ "mpv.desktop" "umpv.desktop" ]; "inode/directory" = "codium.desktop"; }; - description = '' + description = lib.mdDoc '' Removes associations between mimetypes and applications. See the - <link xlink:href="https://specifications.freedesktop.org/mime-apps-spec/mime-apps-spec-latest.html#associations"> - specifications</link> for more information. + [ + specifications](https://specifications.freedesktop.org/mime-apps-spec/mime-apps-spec-latest.html#associations) for more information. ''; }; }; diff --git a/nixos/modules/config/zram.nix b/nixos/modules/config/zram.nix index 1f513b7e4daef..34e80df47a402 100644 --- a/nixos/modules/config/zram.nix +++ b/nixos/modules/config/zram.nix @@ -40,21 +40,21 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable in-memory compressed devices and swap space provided by the zram kernel module. - See <link xlink:href="https://www.kernel.org/doc/Documentation/blockdev/zram.txt"> + See [ https://www.kernel.org/doc/Documentation/blockdev/zram.txt - </link>. + ](https://www.kernel.org/doc/Documentation/blockdev/zram.txt). ''; }; numDevices = mkOption { default = 1; type = types.int; - description = '' + description = lib.mdDoc '' Number of zram devices to create. See also - <literal>zramSwap.swapDevices</literal> + `zramSwap.swapDevices` ''; }; @@ -62,20 +62,20 @@ in default = null; example = 1; type = with types; nullOr int; - description = '' + description = lib.mdDoc '' Number of zram devices to be used as swap. Must be - <literal><= zramSwap.numDevices</literal>. - Default is same as <literal>zramSwap.numDevices</literal>, recommended is 1. + `<= zramSwap.numDevices`. + Default is same as `zramSwap.numDevices`, recommended is 1. ''; }; memoryPercent = mkOption { default = 50; type = types.int; - description = '' + description = lib.mdDoc '' Maximum amount of memory that can be used by the zram swap devices (as a percentage of your total memory). Defaults to 1/2 of your total - RAM. Run <literal>zramctl</literal> to check how good memory is + RAM. Run `zramctl` to check how good memory is compressed. ''; }; @@ -83,7 +83,7 @@ in memoryMax = mkOption { default = null; type = with types; nullOr int; - description = '' + description = lib.mdDoc '' Maximum total amount of memory (in bytes) that can be used by the zram swap devices. ''; @@ -92,7 +92,7 @@ in priority = mkOption { default = 5; type = types.int; - description = '' + description = lib.mdDoc '' Priority of the zram swap devices. It should be a number higher than the priority of your disk-based swap devices (so that the system will fill the zram swap devices before falling back to disk swap). diff --git a/nixos/modules/hardware/acpilight.nix b/nixos/modules/hardware/acpilight.nix index 2de448a265c79..d8d82b0e81a47 100644 --- a/nixos/modules/hardware/acpilight.nix +++ b/nixos/modules/hardware/acpilight.nix @@ -10,7 +10,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable acpilight. This will allow brightness control via xbacklight from users in the video group ''; diff --git a/nixos/modules/hardware/all-firmware.nix b/nixos/modules/hardware/all-firmware.nix index bd5540646b086..2d5a0007ff01c 100644 --- a/nixos/modules/hardware/all-firmware.nix +++ b/nixos/modules/hardware/all-firmware.nix @@ -21,7 +21,7 @@ in { hardware.enableAllFirmware = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Turn on this option if you want to enable all the firmware. ''; }; @@ -30,7 +30,7 @@ in { default = config.hardware.enableAllFirmware; defaultText = lib.literalExpression "config.hardware.enableAllFirmware"; type = types.bool; - description = '' + description = lib.mdDoc '' Turn on this option if you want to enable all the firmware with a license allowing redistribution. ''; }; @@ -38,7 +38,7 @@ in { hardware.wirelessRegulatoryDatabase = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Load the wireless regulatory database at boot. ''; }; diff --git a/nixos/modules/hardware/bladeRF.nix b/nixos/modules/hardware/bladeRF.nix index 35b74b8382e3a..52a1f52024c8f 100644 --- a/nixos/modules/hardware/bladeRF.nix +++ b/nixos/modules/hardware/bladeRF.nix @@ -12,7 +12,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enables udev rules for BladeRF devices. By default grants access to users in the "bladerf" group. You may want to install the libbladeRF package. diff --git a/nixos/modules/hardware/ckb-next.nix b/nixos/modules/hardware/ckb-next.nix index 751ed663aab57..287d287a775c9 100644 --- a/nixos/modules/hardware/ckb-next.nix +++ b/nixos/modules/hardware/ckb-next.nix @@ -19,7 +19,7 @@ in type = types.nullOr types.int; default = null; example = 100; - description = '' + description = lib.mdDoc '' Limit access to the ckb daemon to a particular group. ''; }; @@ -28,7 +28,7 @@ in type = types.package; default = pkgs.ckb-next; defaultText = literalExpression "pkgs.ckb-next"; - description = '' + description = lib.mdDoc '' The package implementing the Corsair keyboard/mouse driver. ''; }; diff --git a/nixos/modules/hardware/cpu/amd-microcode.nix b/nixos/modules/hardware/cpu/amd-microcode.nix index 621c7066bfe1b..3f52cb1fca3e1 100644 --- a/nixos/modules/hardware/cpu/amd-microcode.nix +++ b/nixos/modules/hardware/cpu/amd-microcode.nix @@ -11,7 +11,7 @@ with lib; hardware.cpu.amd.updateMicrocode = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Update the CPU microcode for AMD processors. ''; }; diff --git a/nixos/modules/hardware/cpu/intel-microcode.nix b/nixos/modules/hardware/cpu/intel-microcode.nix index acce565fd808b..d30ebfefeeacf 100644 --- a/nixos/modules/hardware/cpu/intel-microcode.nix +++ b/nixos/modules/hardware/cpu/intel-microcode.nix @@ -11,7 +11,7 @@ with lib; hardware.cpu.intel.updateMicrocode = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Update the CPU microcode for Intel processors. ''; }; diff --git a/nixos/modules/hardware/device-tree.nix b/nixos/modules/hardware/device-tree.nix index 5a8a8e27bee1b..55852776220d3 100644 --- a/nixos/modules/hardware/device-tree.nix +++ b/nixos/modules/hardware/device-tree.nix @@ -9,14 +9,14 @@ let options = { name = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Name of this overlay ''; }; dtsFile = mkOption { type = types.nullOr types.path; - description = '' + description = lib.mdDoc '' Path to .dts overlay file, overlay is applied to each .dtb file matching "compatible" of the overlay. ''; @@ -27,7 +27,7 @@ let dtsText = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Literal DTS contents, overlay is applied to each .dtb file matching "compatible" of the overlay. ''; @@ -49,7 +49,7 @@ let dtboFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Path to .dtbo compiled overlay file. ''; }; @@ -115,7 +115,7 @@ in enable = mkOption { default = pkgs.stdenv.hostPlatform.linux-kernel.DTB or false; type = types.bool; - description = '' + description = lib.mdDoc '' Build device tree files. These are used to describe the non-discoverable hardware of a system. ''; @@ -126,7 +126,7 @@ in defaultText = literalExpression "config.boot.kernelPackages.kernel"; example = literalExpression "pkgs.linux_latest"; type = types.path; - description = '' + description = lib.mdDoc '' Kernel package containing the base device-tree (.dtb) to boot. Uses device trees bundled with the Linux kernel by default. ''; @@ -136,7 +136,7 @@ in default = null; example = "some-dtb.dtb"; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The name of an explicit dtb to be loaded, relative to the dtb base. Useful in extlinux scenarios if the bootloader doesn't pick the right .dtb file from FDTDIR. @@ -147,7 +147,7 @@ in type = types.nullOr types.str; default = null; example = "*rpi*.dtb"; - description = '' + description = lib.mdDoc '' Only include .dtb files matching glob expression. ''; }; @@ -167,7 +167,7 @@ in name = baseNameOf path; dtboFile = path; }) overlayType); - description = '' + description = lib.mdDoc '' List of overlays to apply to base device-tree (.dtb) files. ''; }; diff --git a/nixos/modules/hardware/digitalbitbox.nix b/nixos/modules/hardware/digitalbitbox.nix index 097448a74f4d9..74e46bd34acea 100644 --- a/nixos/modules/hardware/digitalbitbox.nix +++ b/nixos/modules/hardware/digitalbitbox.nix @@ -11,7 +11,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enables udev rules for Digital Bitbox devices. ''; }; @@ -20,7 +20,7 @@ in type = types.package; default = pkgs.digitalbitbox; defaultText = literalExpression "pkgs.digitalbitbox"; - description = "The Digital Bitbox package to use. This can be used to install a package with udev rules that differ from the defaults."; + description = lib.mdDoc "The Digital Bitbox package to use. This can be used to install a package with udev rules that differ from the defaults."; }; }; diff --git a/nixos/modules/hardware/hackrf.nix b/nixos/modules/hardware/hackrf.nix index 7f03b765bbdaf..38ef7fa6d3d4d 100644 --- a/nixos/modules/hardware/hackrf.nix +++ b/nixos/modules/hardware/hackrf.nix @@ -9,7 +9,7 @@ in enable = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Enables hackrf udev rules and ensures 'plugdev' group exists. This is a prerequisite to using HackRF devices without being root, since HackRF USB descriptors will be owned by plugdev through udev. ''; diff --git a/nixos/modules/hardware/i2c.nix b/nixos/modules/hardware/i2c.nix index ff14b4b1c891d..0b57cd1c28df7 100644 --- a/nixos/modules/hardware/i2c.nix +++ b/nixos/modules/hardware/i2c.nix @@ -17,7 +17,7 @@ in group = mkOption { type = types.str; default = "i2c"; - description = '' + description = lib.mdDoc '' Grant access to i2c devices (/dev/i2c-*) to users in this group. ''; }; diff --git a/nixos/modules/hardware/keyboard/zsa.nix b/nixos/modules/hardware/keyboard/zsa.nix index bb69cfa0bf091..5bf4022cdc435 100644 --- a/nixos/modules/hardware/keyboard/zsa.nix +++ b/nixos/modules/hardware/keyboard/zsa.nix @@ -9,7 +9,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enables udev rules for keyboards from ZSA like the ErgoDox EZ, Planck EZ and Moonlander Mark I. You need it when you want to flash a new configuration on the keyboard or use their live training in the browser. diff --git a/nixos/modules/hardware/logitech.nix b/nixos/modules/hardware/logitech.nix index 3ebe6aacf5d68..2e3a71c041585 100644 --- a/nixos/modules/hardware/logitech.nix +++ b/nixos/modules/hardware/logitech.nix @@ -24,7 +24,7 @@ in startWhenNeeded = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Only run the service when an actual supported device is plugged. ''; }; @@ -47,7 +47,7 @@ in enableGraphical = mkOption { type = types.bool; default = false; - description = "Enable graphical support applications."; + description = lib.mdDoc "Enable graphical support applications."; }; }; }; diff --git a/nixos/modules/hardware/mcelog.nix b/nixos/modules/hardware/mcelog.nix index 13ad238870c29..be8fc8cd1925d 100644 --- a/nixos/modules/hardware/mcelog.nix +++ b/nixos/modules/hardware/mcelog.nix @@ -10,7 +10,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the Machine Check Exception logger. ''; }; diff --git a/nixos/modules/hardware/network/ath-user-regd.nix b/nixos/modules/hardware/network/ath-user-regd.nix index b5ade5ed50105..a7f023d26ce79 100644 --- a/nixos/modules/hardware/network/ath-user-regd.nix +++ b/nixos/modules/hardware/network/ath-user-regd.nix @@ -14,7 +14,7 @@ in options.networking.wireless.athUserRegulatoryDomain = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If enabled, sets the ATH_USER_REGD kernel config switch to true to disable the enforcement of EEPROM regulatory restrictions for ath drivers. Requires at least Linux ${linuxKernelMinVersion}. diff --git a/nixos/modules/hardware/network/b43.nix b/nixos/modules/hardware/network/b43.nix index eb03bf223ccfe..7f045f7b70f93 100644 --- a/nixos/modules/hardware/network/b43.nix +++ b/nixos/modules/hardware/network/b43.nix @@ -13,7 +13,7 @@ let kernelVersion = config.boot.kernelPackages.kernel.version; in networking.enableB43Firmware = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Turn on this option if you want firmware for the NICs supported by the b43 module. ''; }; diff --git a/nixos/modules/hardware/network/intel-2200bg.nix b/nixos/modules/hardware/network/intel-2200bg.nix index 17b973474c93b..e1ec8134129e4 100644 --- a/nixos/modules/hardware/network/intel-2200bg.nix +++ b/nixos/modules/hardware/network/intel-2200bg.nix @@ -9,7 +9,7 @@ networking.enableIntel2200BGFirmware = lib.mkOption { default = false; type = lib.types.bool; - description = '' + description = lib.mdDoc '' Turn on this option if you want firmware for the Intel PRO/Wireless 2200BG to be loaded automatically. This is required if you want to use this device. diff --git a/nixos/modules/hardware/new-lg4ff.nix b/nixos/modules/hardware/new-lg4ff.nix index 3c7f66f8d89b5..fac376eb7a75d 100644 --- a/nixos/modules/hardware/new-lg4ff.nix +++ b/nixos/modules/hardware/new-lg4ff.nix @@ -10,7 +10,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enables improved Linux module drivers for Logitech driving wheels. This will replace the existing in-kernel hid-logitech modules. Works most notably on the Logitech G25, G27, G29 and Driving Force (GT). diff --git a/nixos/modules/hardware/nitrokey.nix b/nixos/modules/hardware/nitrokey.nix index baa07203118c6..fa9dd4d6d8f99 100644 --- a/nixos/modules/hardware/nitrokey.nix +++ b/nixos/modules/hardware/nitrokey.nix @@ -13,7 +13,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enables udev rules for Nitrokey devices. By default grants access to users in the "nitrokey" group. You may want to install the nitrokey-app package, depending on your device and needs. diff --git a/nixos/modules/hardware/onlykey/default.nix b/nixos/modules/hardware/onlykey/default.nix index 07358c8a87820..59e159dce4821 100644 --- a/nixos/modules/hardware/onlykey/default.nix +++ b/nixos/modules/hardware/onlykey/default.nix @@ -12,7 +12,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable OnlyKey device (https://crp.to/p/) support. ''; }; diff --git a/nixos/modules/hardware/opengl.nix b/nixos/modules/hardware/opengl.nix index 0d8aaf734591d..dd30bd92b4575 100644 --- a/nixos/modules/hardware/opengl.nix +++ b/nixos/modules/hardware/opengl.nix @@ -35,7 +35,7 @@ in hardware.opengl = { enable = mkOption { - description = '' + description = lib.mdDoc '' Whether to enable OpenGL drivers. This is needed to enable OpenGL support in X11 systems, as well as for Wayland compositors like sway and Weston. It is enabled by default @@ -51,7 +51,7 @@ in driSupport = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable accelerated OpenGL rendering through the Direct Rendering Interface (DRI). ''; @@ -60,11 +60,11 @@ in driSupport32Bit = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' On 64-bit systems, whether to support Direct Rendering for 32-bit applications (such as Wine). This is currently only - supported for the <literal>nvidia</literal> as well as - <literal>Mesa</literal>. + supported for the `nvidia` as well as + `Mesa`. ''; }; @@ -90,7 +90,7 @@ in type = types.listOf types.package; default = []; example = literalExpression "with pkgs; [ vaapiIntel libvdpau-va-gl vaapiVdpau intel-ocl ]"; - description = '' + description = lib.mdDoc '' Additional packages to add to OpenGL drivers. This can be used to add OpenCL drivers, VA-API/VDPAU drivers etc. ''; @@ -100,9 +100,9 @@ in type = types.listOf types.package; default = []; example = literalExpression "with pkgs.pkgsi686Linux; [ vaapiIntel libvdpau-va-gl vaapiVdpau ]"; - description = '' + description = lib.mdDoc '' Additional packages to add to 32-bit OpenGL drivers on - 64-bit systems. Used when <option>driSupport32Bit</option> is + 64-bit systems. Used when {option}`driSupport32Bit` is set. This can be used to add OpenCL drivers, VA-API/VDPAU drivers etc. ''; }; diff --git a/nixos/modules/hardware/openrazer.nix b/nixos/modules/hardware/openrazer.nix index bd9fc485e17ea..315a4a6824bb4 100644 --- a/nixos/modules/hardware/openrazer.nix +++ b/nixos/modules/hardware/openrazer.nix @@ -56,7 +56,7 @@ in verboseLogging = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable verbose logging. Logs debug messages. ''; }; @@ -64,7 +64,7 @@ in syncEffectsEnabled = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Set the sync effects flag to true so any assignment of effects will work across devices. ''; @@ -73,7 +73,7 @@ in devicesOffOnScreensaver = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Turn off the devices when the systems screensaver kicks in. ''; }; @@ -81,7 +81,7 @@ in mouseBatteryNotifier = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Mouse battery notifier. ''; }; @@ -89,7 +89,7 @@ in keyStatistics = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Collects number of keypresses per hour per key used to generate a heatmap. ''; @@ -98,7 +98,7 @@ in users = mkOption { type = with types; listOf str; default = []; - description = '' + description = lib.mdDoc '' Usernames to be added to the "openrazer" group, so that they can start and interact with the OpenRazer userspace daemon. ''; diff --git a/nixos/modules/hardware/opentabletdriver.nix b/nixos/modules/hardware/opentabletdriver.nix index caba934ebe773..6c5ca3d949e8b 100644 --- a/nixos/modules/hardware/opentabletdriver.nix +++ b/nixos/modules/hardware/opentabletdriver.nix @@ -12,7 +12,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable OpenTabletDriver udev rules, user service and blacklist kernel modules known to conflict with OpenTabletDriver. ''; @@ -21,7 +21,7 @@ in blacklistedKernelModules = mkOption { type = types.listOf types.str; default = [ "hid-uclogic" "wacom" ]; - description = '' + description = lib.mdDoc '' Blacklist of kernel modules known to conflict with OpenTabletDriver. ''; }; @@ -30,7 +30,7 @@ in type = types.package; default = pkgs.opentabletdriver; defaultText = literalExpression "pkgs.opentabletdriver"; - description = '' + description = lib.mdDoc '' OpenTabletDriver derivation to use. ''; }; @@ -39,7 +39,7 @@ in enable = mkOption { default = true; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to start OpenTabletDriver daemon as a systemd user service. ''; }; diff --git a/nixos/modules/hardware/pcmcia.nix b/nixos/modules/hardware/pcmcia.nix index aef35a28e54da..f7a5565d773e6 100644 --- a/nixos/modules/hardware/pcmcia.nix +++ b/nixos/modules/hardware/pcmcia.nix @@ -20,7 +20,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable this option to support PCMCIA card. ''; }; @@ -28,7 +28,7 @@ in firmware = mkOption { type = types.listOf types.path; default = []; - description = '' + description = lib.mdDoc '' List of firmware used to handle specific PCMCIA card. ''; }; @@ -36,7 +36,7 @@ in config = mkOption { default = null; type = types.nullOr types.path; - description = '' + description = lib.mdDoc '' Path to the configuration file which maps the memory, IRQs and ports used by the PCMCIA hardware. ''; diff --git a/nixos/modules/hardware/printers.nix b/nixos/modules/hardware/printers.nix index ef07542950bac..64c29bb0a5b3b 100644 --- a/nixos/modules/hardware/printers.nix +++ b/nixos/modules/hardware/printers.nix @@ -30,17 +30,17 @@ in { ensureDefaultPrinter = mkOption { type = types.nullOr printerName; default = null; - description = '' + description = lib.mdDoc '' Ensures the named printer is the default CUPS printer / printer queue. ''; }; ensurePrinters = mkOption { - description = '' + description = lib.mdDoc '' Will regularly ensure that the given CUPS printers are configured as declared here. If a printer's options are manually changed afterwards, they will be overwritten eventually. This option will never delete any printer, even if removed from this list. - You can check existing printers with <command>lpstat -s</command> - and remove printers with <command>lpadmin -x <printer-name></command>. + You can check existing printers with {command}`lpstat -s` + and remove printers with {command}`lpadmin -x <printer-name>`. Printers not listed here can still be manually configured. ''; default = []; @@ -49,7 +49,7 @@ in { name = mkOption { type = printerName; example = "BrotherHL_Workroom"; - description = '' + description = lib.mdDoc '' Name of the printer / printer queue. May contain any printable characters except "/", "#", and space. ''; @@ -58,7 +58,7 @@ in { type = types.nullOr types.str; default = null; example = "Workroom"; - description = '' + description = lib.mdDoc '' Optional human-readable location. ''; }; @@ -66,7 +66,7 @@ in { type = types.nullOr types.str; default = null; example = "Brother HL-5140"; - description = '' + description = lib.mdDoc '' Optional human-readable description. ''; }; @@ -76,9 +76,9 @@ in { "ipp://printserver.local/printers/BrotherHL_Workroom" "usb://HP/DESKJET%20940C?serial=CN16E6C364BH" ''; - description = '' + description = lib.mdDoc '' How to reach the printer. - <command>lpinfo -v</command> shows a list of supported device URIs and schemes. + {command}`lpinfo -v` shows a list of supported device URIs and schemes. ''; }; model = mkOption { @@ -86,9 +86,9 @@ in { example = literalExpression '' "gutenprint.''${lib.versions.majorMinor (lib.getVersion pkgs.gutenprint)}://brother-hl-5140/expert" ''; - description = '' + description = lib.mdDoc '' Location of the ppd driver file for the printer. - <command>lpinfo -m</command> shows a list of supported models. + {command}`lpinfo -m` shows a list of supported models. ''; }; ppdOptions = mkOption { @@ -98,9 +98,9 @@ in { Duplex = "DuplexNoTumble"; }; default = {}; - description = '' + description = lib.mdDoc '' Sets PPD options for the printer. - <command>lpoptions [-p printername] -l</command> shows suported PPD options for the given printer. + {command}`lpoptions [-p printername] -l` shows suported PPD options for the given printer. ''; }; }; diff --git a/nixos/modules/hardware/rtl-sdr.nix b/nixos/modules/hardware/rtl-sdr.nix index e85fc04e29bb6..7f462005f1570 100644 --- a/nixos/modules/hardware/rtl-sdr.nix +++ b/nixos/modules/hardware/rtl-sdr.nix @@ -8,7 +8,7 @@ in { enable = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Enables rtl-sdr udev rules, ensures 'plugdev' group exists, and blacklists DVB kernel modules. This is a prerequisite to using devices supported by rtl-sdr without being root, since rtl-sdr USB descriptors will be owned by plugdev through udev. ''; diff --git a/nixos/modules/hardware/saleae-logic.nix b/nixos/modules/hardware/saleae-logic.nix index a3810d640c483..02d234cd3f05b 100644 --- a/nixos/modules/hardware/saleae-logic.nix +++ b/nixos/modules/hardware/saleae-logic.nix @@ -11,7 +11,7 @@ in type = lib.types.package; default = pkgs.saleae-logic-2; defaultText = lib.literalExpression "pkgs.saleae-logic-2"; - description = '' + description = lib.mdDoc '' Saleae Logic package to use. ''; }; diff --git a/nixos/modules/hardware/sata.nix b/nixos/modules/hardware/sata.nix index 81592997d6e3d..bac24236f7dc8 100644 --- a/nixos/modules/hardware/sata.nix +++ b/nixos/modules/hardware/sata.nix @@ -41,7 +41,7 @@ in deciSeconds = mkOption { example = 70; type = types.int; - description = '' + description = lib.mdDoc '' Set SCT Error Recovery Control timeout in deciseconds for use in RAID configurations. Values are as follows: @@ -53,17 +53,17 @@ in }; drives = mkOption { - description = "List of drives for which to configure the timeout."; + description = lib.mdDoc "List of drives for which to configure the timeout."; type = types.listOf (types.submodule { options = { name = mkOption { - description = "Drive name without the full path."; + description = lib.mdDoc "Drive name without the full path."; type = types.str; }; idBy = mkOption { - description = "The method to identify the drive."; + description = lib.mdDoc "The method to identify the drive."; type = types.enum [ "path" "wwn" ]; default = "path"; }; diff --git a/nixos/modules/hardware/sensor/hddtemp.nix b/nixos/modules/hardware/sensor/hddtemp.nix index df3f75e229a2f..b69d012b4d092 100644 --- a/nixos/modules/hardware/sensor/hddtemp.nix +++ b/nixos/modules/hardware/sensor/hddtemp.nix @@ -30,7 +30,7 @@ in options = { hardware.sensor.hddtemp = { enable = mkOption { - description = '' + description = lib.mdDoc '' Enable this option to support HDD/SSD temperature sensors. ''; type = types.bool; @@ -38,24 +38,24 @@ in }; drives = mkOption { - description = "List of drives to monitor. If you pass /dev/disk/by-path/* entries the symlinks will be resolved as hddtemp doesn't like names with colons."; + description = lib.mdDoc "List of drives to monitor. If you pass /dev/disk/by-path/* entries the symlinks will be resolved as hddtemp doesn't like names with colons."; type = types.listOf types.str; }; unit = mkOption { - description = "Celcius or Fahrenheit"; + description = lib.mdDoc "Celcius or Fahrenheit"; type = types.enum [ "C" "F" ]; default = "C"; }; dbEntries = mkOption { - description = "Additional DB entries"; + description = lib.mdDoc "Additional DB entries"; type = types.listOf types.str; default = [ ]; }; extraArgs = mkOption { - description = "Additional arguments passed to the daemon."; + description = lib.mdDoc "Additional arguments passed to the daemon."; type = types.listOf types.str; default = [ ]; }; diff --git a/nixos/modules/hardware/sensor/iio.nix b/nixos/modules/hardware/sensor/iio.nix index 8b3ba87a7d9c4..6f7b1dc1f7f8b 100644 --- a/nixos/modules/hardware/sensor/iio.nix +++ b/nixos/modules/hardware/sensor/iio.nix @@ -8,7 +8,7 @@ with lib; options = { hardware.sensor.iio = { enable = mkOption { - description = '' + description = lib.mdDoc '' Enable this option to support IIO sensors with iio-sensor-proxy. IIO sensors are used for orientation and ambient light diff --git a/nixos/modules/hardware/steam-hardware.nix b/nixos/modules/hardware/steam-hardware.nix index 6218c9ffbb9b1..07edf68703904 100644 --- a/nixos/modules/hardware/steam-hardware.nix +++ b/nixos/modules/hardware/steam-hardware.nix @@ -13,7 +13,7 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable udev rules for Steam hardware such as the Steam Controller, other supported controllers and the HTC Vive"; + description = lib.mdDoc "Enable udev rules for Steam hardware such as the Steam Controller, other supported controllers and the HTC Vive"; }; }; diff --git a/nixos/modules/hardware/system-76.nix b/nixos/modules/hardware/system-76.nix index ca40ee0ebb37a..21cab4a3787c6 100644 --- a/nixos/modules/hardware/system-76.nix +++ b/nixos/modules/hardware/system-76.nix @@ -63,7 +63,7 @@ in { default = cfg.enableAll; defaultText = literalExpression "config.${opt.enableAll}"; example = true; - description = "Whether to enable the system76 firmware daemon"; + description = lib.mdDoc "Whether to enable the system76 firmware daemon"; type = types.bool; }; @@ -71,7 +71,7 @@ in { default = cfg.enableAll; defaultText = literalExpression "config.${opt.enableAll}"; example = true; - description = "Whether to make the system76 out-of-tree kernel modules available"; + description = lib.mdDoc "Whether to make the system76 out-of-tree kernel modules available"; type = types.bool; }; @@ -79,7 +79,7 @@ in { default = cfg.enableAll; defaultText = literalExpression "config.${opt.enableAll}"; example = true; - description = "Whether to enable the system76 power daemon"; + description = lib.mdDoc "Whether to enable the system76 power daemon"; type = types.bool; }; }; diff --git a/nixos/modules/hardware/ubertooth.nix b/nixos/modules/hardware/ubertooth.nix index 637fddfb37dff..e76fa45fea515 100644 --- a/nixos/modules/hardware/ubertooth.nix +++ b/nixos/modules/hardware/ubertooth.nix @@ -16,7 +16,7 @@ in { type = types.str; default = "ubertooth"; example = "wheel"; - description = "Group for Ubertooth's udev rules."; + description = lib.mdDoc "Group for Ubertooth's udev rules."; }; }; diff --git a/nixos/modules/hardware/usb-wwan.nix b/nixos/modules/hardware/usb-wwan.nix index 679a6c6497cb6..69673872cf9b7 100644 --- a/nixos/modules/hardware/usb-wwan.nix +++ b/nixos/modules/hardware/usb-wwan.nix @@ -11,7 +11,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable this option to support USB WWAN adapters. ''; }; diff --git a/nixos/modules/hardware/video/bumblebee.nix b/nixos/modules/hardware/video/bumblebee.nix index b6af4f80445ab..75f71d499e662 100644 --- a/nixos/modules/hardware/video/bumblebee.nix +++ b/nixos/modules/hardware/video/bumblebee.nix @@ -29,7 +29,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable the bumblebee daemon to manage Optimus hybrid video cards. This should power off secondary GPU until its use is requested by running an application with optirun. @@ -40,13 +40,13 @@ in default = "wheel"; example = "video"; type = types.str; - description = "Group for bumblebee socket"; + description = lib.mdDoc "Group for bumblebee socket"; }; connectDisplay = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Set to true if you intend to connect your discrete card to a monitor. This option will set up your Nvidia card for EDID discovery and to turn on the monitor signal. @@ -58,7 +58,7 @@ in driver = mkOption { default = "nvidia"; type = types.enum [ "nvidia" "nouveau" ]; - description = '' + description = lib.mdDoc '' Set driver used by bumblebeed. Supported are nouveau and nvidia. ''; }; @@ -66,7 +66,7 @@ in pmMethod = mkOption { default = "auto"; type = types.enum [ "auto" "bbswitch" "switcheroo" "none" ]; - description = '' + description = lib.mdDoc '' Set preferred power management method for unused card. ''; }; diff --git a/nixos/modules/hardware/video/nvidia.nix b/nixos/modules/hardware/video/nvidia.nix index f0f7b8e449a27..8c6c97f9b21d0 100644 --- a/nixos/modules/hardware/video/nvidia.nix +++ b/nixos/modules/hardware/video/nvidia.nix @@ -40,7 +40,7 @@ in hardware.nvidia.powerManagement.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Experimental power management through systemd. For more information, see the NVIDIA docs, on Chapter 21. Configuring Power Management Support. ''; @@ -49,7 +49,7 @@ in hardware.nvidia.powerManagement.finegrained = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Experimental power management of PRIME offload. For more information, see the NVIDIA docs, chapter 22. PCI-Express runtime power management. ''; @@ -58,11 +58,11 @@ in hardware.nvidia.modesetting.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable kernel modesetting when using the NVIDIA proprietary driver. Enabling this fixes screen tearing when using Optimus via PRIME (see - <option>hardware.nvidia.prime.sync.enable</option>. This is not enabled + {option}`hardware.nvidia.prime.sync.enable`. This is not enabled by default because it is not officially supported by NVIDIA and would not work with SLI. ''; @@ -72,7 +72,7 @@ in type = busIDType; default = ""; example = "PCI:1:0:0"; - description = '' + description = lib.mdDoc '' Bus ID of the NVIDIA GPU. You can find it using lspci; for example if lspci shows the NVIDIA GPU at "01:00.0", set this option to "PCI:1:0:0". ''; @@ -82,7 +82,7 @@ in type = busIDType; default = ""; example = "PCI:0:2:0"; - description = '' + description = lib.mdDoc '' Bus ID of the Intel GPU. You can find it using lspci; for example if lspci shows the Intel GPU at "00:02.0", set this option to "PCI:0:2:0". ''; @@ -92,7 +92,7 @@ in type = busIDType; default = ""; example = "PCI:4:0:0"; - description = '' + description = lib.mdDoc '' Bus ID of the AMD APU. You can find it using lspci; for example if lspci shows the AMD APU at "04:00.0", set this option to "PCI:4:0:0". ''; @@ -101,26 +101,26 @@ in hardware.nvidia.prime.sync.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable NVIDIA Optimus support using the NVIDIA proprietary driver via PRIME. If enabled, the NVIDIA GPU will be always on and used for all rendering, while enabling output to displays attached only to the integrated Intel GPU without a multiplexer. Note that this option only has any effect if the "nvidia" driver is specified - in <option>services.xserver.videoDrivers</option>, and it should preferably + in {option}`services.xserver.videoDrivers`, and it should preferably be the only driver there. If this is enabled, then the bus IDs of the NVIDIA and Intel GPUs have to be - specified (<option>hardware.nvidia.prime.nvidiaBusId</option> and - <option>hardware.nvidia.prime.intelBusId</option>). + specified ({option}`hardware.nvidia.prime.nvidiaBusId` and + {option}`hardware.nvidia.prime.intelBusId`). If you enable this, you may want to also enable kernel modesetting for the - NVIDIA driver (<option>hardware.nvidia.modesetting.enable</option>) in order + NVIDIA driver ({option}`hardware.nvidia.modesetting.enable`) in order to prevent tearing. Note that this configuration will only be successful when a display manager - for which the <option>services.xserver.displayManager.setupCommands</option> + for which the {option}`services.xserver.displayManager.setupCommands` option is supported is used. ''; }; @@ -128,7 +128,7 @@ in hardware.nvidia.prime.sync.allowExternalGpu = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Configure X to allow external NVIDIA GPUs when using optimus. ''; }; @@ -136,19 +136,19 @@ in hardware.nvidia.prime.offload.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable render offload support using the NVIDIA proprietary driver via PRIME. If this is enabled, then the bus IDs of the NVIDIA and Intel GPUs have to be - specified (<option>hardware.nvidia.prime.nvidiaBusId</option> and - <option>hardware.nvidia.prime.intelBusId</option>). + specified ({option}`hardware.nvidia.prime.nvidiaBusId` and + {option}`hardware.nvidia.prime.intelBusId`). ''; }; hardware.nvidia.nvidiaSettings = mkOption { default = true; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to add nvidia-settings, NVIDIA's GUI configuration tool, to systemPackages. ''; @@ -157,7 +157,7 @@ in hardware.nvidia.nvidiaPersistenced = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Update for NVIDA GPU headless mode, i.e. nvidia-persistenced. It ensures all GPUs stay awake even during headless mode. ''; @@ -166,7 +166,7 @@ in hardware.nvidia.forceFullCompositionPipeline = lib.mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to force-enable the full composition pipeline. This sometimes fixes screen tearing issues. This has been reported to reduce the performance of some OpenGL applications and may produce issues in WebGL. @@ -178,7 +178,7 @@ in type = types.package; default = config.boot.kernelPackages.nvidiaPackages.stable; defaultText = literalExpression "config.boot.kernelPackages.nvidiaPackages.stable"; - description = '' + description = lib.mdDoc '' The NVIDIA X11 derivation to use. ''; example = literalExpression "config.boot.kernelPackages.nvidiaPackages.legacy_340"; @@ -187,7 +187,7 @@ in hardware.nvidia.open = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to use the open source kernel module ''; }; diff --git a/nixos/modules/hardware/video/uvcvideo/default.nix b/nixos/modules/hardware/video/uvcvideo/default.nix index 338062cf69b7f..bb59e2f2ed2b0 100644 --- a/nixos/modules/hardware/video/uvcvideo/default.nix +++ b/nixos/modules/hardware/video/uvcvideo/default.nix @@ -22,12 +22,12 @@ in enable = mkOption { type = types.bool; default = false; - description = '' - Whether to enable <command>uvcvideo</command> dynamic controls. + description = lib.mdDoc '' + Whether to enable {command}`uvcvideo` dynamic controls. - Note that enabling this brings the <command>uvcdynctrl</command> tool + Note that enabling this brings the {command}`uvcdynctrl` tool into your environment and register all dynamic controls from - specified <command>packages</command> to the <command>uvcvideo</command> driver. + specified {command}`packages` to the {command}`uvcvideo` driver. ''; }; diff --git a/nixos/modules/hardware/video/webcam/facetimehd.nix b/nixos/modules/hardware/video/webcam/facetimehd.nix index c48eac5e9c116..8940674ce53be 100644 --- a/nixos/modules/hardware/video/webcam/facetimehd.nix +++ b/nixos/modules/hardware/video/webcam/facetimehd.nix @@ -18,10 +18,10 @@ in default = false; example = true; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to include sensor calibration files for facetimehd. This makes colors look much better but is experimental, see - <link xlink:href="https://github.com/patjak/facetimehd/wiki/Extracting-the-sensor-calibration-files"/> + <https://github.com/patjak/facetimehd/wiki/Extracting-the-sensor-calibration-files> for details. ''; }; diff --git a/nixos/modules/i18n/input-method/fcitx5.nix b/nixos/modules/i18n/input-method/fcitx5.nix index 9ef0285f7b933..7cdef9ae93211 100644 --- a/nixos/modules/i18n/input-method/fcitx5.nix +++ b/nixos/modules/i18n/input-method/fcitx5.nix @@ -15,7 +15,7 @@ in { type = with types; listOf package; default = []; example = literalExpression "with pkgs; [ fcitx5-rime ]"; - description = '' + description = lib.mdDoc '' Enabled Fcitx5 addons. ''; }; diff --git a/nixos/modules/i18n/input-method/kime.nix b/nixos/modules/i18n/input-method/kime.nix index 729a665614ae5..29224a6bf75fb 100644 --- a/nixos/modules/i18n/input-method/kime.nix +++ b/nixos/modules/i18n/input-method/kime.nix @@ -27,8 +27,8 @@ in }; } ''; - description = '' - kime configuration. Refer to <link xlink:href="https://github.com/Riey/kime/blob/v${pkgs.kime.version}/docs/CONFIGURATION.md"/> for details on supported values. + description = lib.mdDoc '' + kime configuration. Refer to <https://github.com/Riey/kime/blob/v${pkgs.kime.version}/docs/CONFIGURATION.md> for details on supported values. ''; }; }; diff --git a/nixos/modules/i18n/input-method/uim.nix b/nixos/modules/i18n/input-method/uim.nix index 459294657e0a6..9491ab2640fcc 100644 --- a/nixos/modules/i18n/input-method/uim.nix +++ b/nixos/modules/i18n/input-method/uim.nix @@ -13,7 +13,7 @@ in type = types.enum [ "gtk" "gtk3" "gtk-systray" "gtk3-systray" "qt4" ]; default = "gtk"; example = "gtk-systray"; - description = '' + description = lib.mdDoc '' selected UIM toolbar. ''; }; diff --git a/nixos/modules/misc/crashdump.nix b/nixos/modules/misc/crashdump.nix index b0f75d9caaa39..4ae18984ee5f5 100644 --- a/nixos/modules/misc/crashdump.nix +++ b/nixos/modules/misc/crashdump.nix @@ -16,7 +16,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If enabled, NixOS will set up a kernel that will boot on crash, and leave the user in systemd rescue to be able to save the crashed kernel dump at @@ -27,7 +27,7 @@ in reservedMemory = mkOption { default = "128M"; type = types.str; - description = '' + description = lib.mdDoc '' The amount of memory reserved for the crashdump kernel. If you choose a too high value, dmesg will mention "crashkernel reservation failed". @@ -36,7 +36,7 @@ in kernelParams = mkOption { type = types.listOf types.str; default = [ "1" "boot.shell_on_fail" ]; - description = '' + description = lib.mdDoc '' Parameters that will be passed to the kernel kexec-ed on crash. ''; }; diff --git a/nixos/modules/misc/lib.nix b/nixos/modules/misc/lib.nix index 121f396701eae..f97e9209e2f1e 100644 --- a/nixos/modules/misc/lib.nix +++ b/nixos/modules/misc/lib.nix @@ -7,7 +7,7 @@ type = lib.types.attrsOf lib.types.attrs; - description = '' + description = lib.mdDoc '' This option allows modules to define helper functions, constants, etc. ''; }; diff --git a/nixos/modules/misc/locate.nix b/nixos/modules/misc/locate.nix index 50495eebe4c29..bba35b752c9ab 100644 --- a/nixos/modules/misc/locate.nix +++ b/nixos/modules/misc/locate.nix @@ -19,9 +19,9 @@ in enable = mkOption { type = bool; default = false; - description = '' + description = lib.mdDoc '' If enabled, NixOS will periodically update the database of - files used by the <command>locate</command> command. + files used by the {command}`locate` command. ''; }; @@ -30,7 +30,7 @@ in default = pkgs.findutils.locate; defaultText = literalExpression "pkgs.findutils"; example = literalExpression "pkgs.mlocate"; - description = '' + description = lib.mdDoc '' The locate implementation to use ''; }; @@ -55,15 +55,15 @@ in extraFlags = mkOption { type = listOf str; default = [ ]; - description = '' - Extra flags to pass to <command>updatedb</command>. + description = lib.mdDoc '' + Extra flags to pass to {command}`updatedb`. ''; }; output = mkOption { type = path; default = "/var/cache/locatedb"; - description = '' + description = lib.mdDoc '' The database file to build. ''; }; @@ -71,9 +71,9 @@ in localuser = mkOption { type = nullOr str; default = "nobody"; - description = '' + description = lib.mdDoc '' The user to search non-network directories as, using - <command>su</command>. + {command}`su`. ''; }; @@ -159,7 +159,7 @@ in "vboxsf" "vperfctrfs" ]; - description = '' + description = lib.mdDoc '' Which filesystem types to exclude from indexing ''; }; @@ -176,7 +176,7 @@ in "/nix/store" "/nix/var/log/nix" ]; - description = '' + description = lib.mdDoc '' Which paths to exclude from indexing ''; }; @@ -188,7 +188,7 @@ in <literal>[ ".bzr" ".cache" ".git" ".hg" ".svn" ]</literal>, if supported by the locate implementation (i.e. mlocate or plocate). ''; - description = '' + description = lib.mdDoc '' Directory components which should exclude paths containing them from indexing ''; }; @@ -196,7 +196,7 @@ in pruneBindMounts = mkOption { type = bool; default = false; - description = '' + description = lib.mdDoc '' Whether not to index bind mounts ''; }; diff --git a/nixos/modules/programs/_1password-gui.nix b/nixos/modules/programs/_1password-gui.nix index 657116c267d92..20bd846d5162a 100644 --- a/nixos/modules/programs/_1password-gui.nix +++ b/nixos/modules/programs/_1password-gui.nix @@ -22,7 +22,7 @@ in type = types.listOf types.str; default = [ ]; example = literalExpression ''["user1" "user2" "user3"]''; - description = '' + description = lib.mdDoc '' A list of users who should be able to integrate 1Password with polkit-based authentication mechanisms. ''; }; diff --git a/nixos/modules/programs/autojump.nix b/nixos/modules/programs/autojump.nix index ecfc2f658079d..dde6870d98905 100644 --- a/nixos/modules/programs/autojump.nix +++ b/nixos/modules/programs/autojump.nix @@ -13,7 +13,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable autojump. ''; }; diff --git a/nixos/modules/programs/bandwhich.nix b/nixos/modules/programs/bandwhich.nix index 610d602ad2cc9..8d1612217ad87 100644 --- a/nixos/modules/programs/bandwhich.nix +++ b/nixos/modules/programs/bandwhich.nix @@ -11,7 +11,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to add bandwhich to the global environment and configure a setcap wrapper for it. ''; diff --git a/nixos/modules/programs/bash/undistract-me.nix b/nixos/modules/programs/bash/undistract-me.nix index 0e6465e048a10..8d1b1740f6448 100644 --- a/nixos/modules/programs/bash/undistract-me.nix +++ b/nixos/modules/programs/bash/undistract-me.nix @@ -14,7 +14,7 @@ in timeout = mkOption { default = 10; - description = '' + description = lib.mdDoc '' Number of seconds it would take for a command to be considered long-running. ''; type = types.int; diff --git a/nixos/modules/programs/captive-browser.nix b/nixos/modules/programs/captive-browser.nix index 1e5c6ff9b2440..7ebce17bebfd2 100644 --- a/nixos/modules/programs/captive-browser.nix +++ b/nixos/modules/programs/captive-browser.nix @@ -40,12 +40,12 @@ in type = types.package; default = pkgs.captive-browser; defaultText = literalExpression "pkgs.captive-browser"; - description = "Which package to use for captive-browser"; + description = lib.mdDoc "Which package to use for captive-browser"; }; interface = mkOption { type = types.str; - description = "your public network interface (wlp3s0, wlan0, eth0, ...)"; + description = lib.mdDoc "your public network interface (wlp3s0, wlan0, eth0, ...)"; }; # the options below are the same as in "captive-browser.toml" @@ -53,7 +53,7 @@ in type = types.str; default = browserDefault pkgs.chromium; defaultText = literalExpression (browserDefault "\${pkgs.chromium}"); - description = '' + description = lib.mdDoc '' The shell (/bin/sh) command executed once the proxy starts. When browser exits, the proxy exits. An extra env var PROXY is available. @@ -69,7 +69,7 @@ in dhcp-dns = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The shell (/bin/sh) command executed to obtain the DHCP DNS server address. The first match of an IPv4 regex is used. IPv4 only, because let's be real, it's a captive portal. @@ -79,7 +79,7 @@ in socks5-addr = mkOption { type = types.str; default = "localhost:1666"; - description = "the listen address for the SOCKS5 proxy server"; + description = lib.mdDoc "the listen address for the SOCKS5 proxy server"; }; bindInterface = mkOption { diff --git a/nixos/modules/programs/ccache.nix b/nixos/modules/programs/ccache.nix index 0f7fd0a3683c1..a554109533b26 100644 --- a/nixos/modules/programs/ccache.nix +++ b/nixos/modules/programs/ccache.nix @@ -9,13 +9,13 @@ in { enable = mkEnableOption "CCache"; cacheDir = mkOption { type = types.path; - description = "CCache directory"; + description = lib.mdDoc "CCache directory"; default = "/var/cache/ccache"; }; # target configuration packageNames = mkOption { type = types.listOf types.str; - description = "Nix top-level packages to be compiled using CCache"; + description = lib.mdDoc "Nix top-level packages to be compiled using CCache"; default = []; example = [ "wxGTK30" "ffmpeg" "libav_all" ]; }; diff --git a/nixos/modules/programs/cdemu.nix b/nixos/modules/programs/cdemu.nix index 142e293424057..d43f009f2f92e 100644 --- a/nixos/modules/programs/cdemu.nix +++ b/nixos/modules/programs/cdemu.nix @@ -10,29 +10,29 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' - <command>cdemu</command> for members of - <option>programs.cdemu.group</option>. + description = lib.mdDoc '' + {command}`cdemu` for members of + {option}`programs.cdemu.group`. ''; }; group = mkOption { type = types.str; default = "cdrom"; - description = '' - Group that users must be in to use <command>cdemu</command>. + description = lib.mdDoc '' + Group that users must be in to use {command}`cdemu`. ''; }; gui = mkOption { type = types.bool; default = true; - description = '' - Whether to install the <command>cdemu</command> GUI (gCDEmu). + description = lib.mdDoc '' + Whether to install the {command}`cdemu` GUI (gCDEmu). ''; }; image-analyzer = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to install the image analyzer. ''; }; diff --git a/nixos/modules/programs/chromium.nix b/nixos/modules/programs/chromium.nix index 4b8bec33eb873..98eb071e61442 100644 --- a/nixos/modules/programs/chromium.nix +++ b/nixos/modules/programs/chromium.nix @@ -23,14 +23,14 @@ in extensions = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' List of chromium extensions to install. For list of plugins ids see id in url of extensions on - <link xlink:href="https://chrome.google.com/webstore/category/extensions">chrome web store</link> + [chrome web store](https://chrome.google.com/webstore/category/extensions) page. To install a chromium extension not included in the chrome web store, append to the extension id a semicolon ";" followed by a URL pointing to an Update Manifest XML file. See - <link xlink:href="https://cloud.google.com/docs/chrome-enterprise/policies/?policy=ExtensionInstallForcelist">ExtensionInstallForcelist</link> + [ExtensionInstallForcelist](https://cloud.google.com/docs/chrome-enterprise/policies/?policy=ExtensionInstallForcelist) for additional details. ''; default = []; @@ -46,21 +46,21 @@ in homepageLocation = mkOption { type = types.nullOr types.str; - description = "Chromium default homepage"; + description = lib.mdDoc "Chromium default homepage"; default = null; example = "https://nixos.org"; }; defaultSearchProviderEnabled = mkOption { type = types.nullOr types.bool; - description = "Enable the default search provider."; + description = lib.mdDoc "Enable the default search provider."; default = null; example = true; }; defaultSearchProviderSearchURL = mkOption { type = types.nullOr types.str; - description = "Chromium default search provider url."; + description = lib.mdDoc "Chromium default search provider url."; default = null; example = "https://encrypted.google.com/search?q={searchTerms}&{google:RLZ}{google:originalQueryForSuggestion}{google:assistedQueryStats}{google:searchFieldtrialParameter}{google:searchClient}{google:sourceId}{google:instantExtendedEnabledParameter}ie={inputEncoding}"; @@ -68,7 +68,7 @@ in defaultSearchProviderSuggestURL = mkOption { type = types.nullOr types.str; - description = "Chromium default search provider url for suggestions."; + description = lib.mdDoc "Chromium default search provider url for suggestions."; default = null; example = "https://encrypted.google.com/complete/search?output=chrome&q={searchTerms}"; diff --git a/nixos/modules/programs/command-not-found/command-not-found.nix b/nixos/modules/programs/command-not-found/command-not-found.nix index 4d2a89b515842..b5c7626bd2075 100644 --- a/nixos/modules/programs/command-not-found/command-not-found.nix +++ b/nixos/modules/programs/command-not-found/command-not-found.nix @@ -26,7 +26,7 @@ in enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether interactive shells should show which Nix package (if any) provides a missing command. ''; @@ -34,7 +34,7 @@ in dbPath = mkOption { default = "/nix/var/nix/profiles/per-user/root/channels/nixos/programs.sqlite" ; - description = '' + description = lib.mdDoc '' Absolute path to programs.sqlite. By default this file will be provided by your channel diff --git a/nixos/modules/programs/criu.nix b/nixos/modules/programs/criu.nix index 1714e1331a485..9f03b0c6431a9 100644 --- a/nixos/modules/programs/criu.nix +++ b/nixos/modules/programs/criu.nix @@ -10,8 +10,8 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' - Install <command>criu</command> along with necessary kernel options. + description = lib.mdDoc '' + Install {command}`criu` along with necessary kernel options. ''; }; }; diff --git a/nixos/modules/programs/digitalbitbox/default.nix b/nixos/modules/programs/digitalbitbox/default.nix index cabdf260cda3d..101ee8ddbafc4 100644 --- a/nixos/modules/programs/digitalbitbox/default.nix +++ b/nixos/modules/programs/digitalbitbox/default.nix @@ -11,7 +11,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Installs the Digital Bitbox application and enables the complementary hardware module. ''; }; @@ -20,7 +20,7 @@ in type = types.package; default = pkgs.digitalbitbox; defaultText = literalExpression "pkgs.digitalbitbox"; - description = "The Digital Bitbox package to use. This can be used to install a package with udev rules that differ from the defaults."; + description = lib.mdDoc "The Digital Bitbox package to use. This can be used to install a package with udev rules that differ from the defaults."; }; }; diff --git a/nixos/modules/programs/dmrconfig.nix b/nixos/modules/programs/dmrconfig.nix index 89ac3443a1f33..20a0dc9556daa 100644 --- a/nixos/modules/programs/dmrconfig.nix +++ b/nixos/modules/programs/dmrconfig.nix @@ -14,7 +14,7 @@ in { enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to configure system to enable use of dmrconfig. This enables the required udev rules and installs the program. ''; @@ -25,7 +25,7 @@ in { default = pkgs.dmrconfig; type = types.package; defaultText = literalExpression "pkgs.dmrconfig"; - description = "dmrconfig derivation to use"; + description = lib.mdDoc "dmrconfig derivation to use"; }; }; }; diff --git a/nixos/modules/programs/evince.nix b/nixos/modules/programs/evince.nix index c033230afb102..bbc54241d52d2 100644 --- a/nixos/modules/programs/evince.nix +++ b/nixos/modules/programs/evince.nix @@ -28,7 +28,7 @@ in { type = types.package; default = pkgs.evince; defaultText = literalExpression "pkgs.evince"; - description = "Evince derivation to use."; + description = lib.mdDoc "Evince derivation to use."; }; }; diff --git a/nixos/modules/programs/feedbackd.nix b/nixos/modules/programs/feedbackd.nix index 4194080c8a734..7e6cf829467db 100644 --- a/nixos/modules/programs/feedbackd.nix +++ b/nixos/modules/programs/feedbackd.nix @@ -13,7 +13,7 @@ in { Your user needs to be in the `feedbackd` group to trigger effects. ''; package = mkOption { - description = '' + description = lib.mdDoc '' Which feedbackd package to use. ''; type = types.package; diff --git a/nixos/modules/programs/file-roller.nix b/nixos/modules/programs/file-roller.nix index 3c47d59816548..ca2651becfea9 100644 --- a/nixos/modules/programs/file-roller.nix +++ b/nixos/modules/programs/file-roller.nix @@ -27,7 +27,7 @@ in { type = types.package; default = pkgs.gnome.file-roller; defaultText = literalExpression "pkgs.gnome.file-roller"; - description = "File Roller derivation to use."; + description = lib.mdDoc "File Roller derivation to use."; }; }; diff --git a/nixos/modules/programs/flashrom.nix b/nixos/modules/programs/flashrom.nix index f026c2e31cda3..5f0de5a402341 100644 --- a/nixos/modules/programs/flashrom.nix +++ b/nixos/modules/programs/flashrom.nix @@ -10,7 +10,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Installs flashrom and configures udev rules for programmers used by flashrom. Grants access to users in the "flashrom" group. diff --git a/nixos/modules/programs/flexoptix-app.nix b/nixos/modules/programs/flexoptix-app.nix index 5e169be2d8933..e87d1076508b8 100644 --- a/nixos/modules/programs/flexoptix-app.nix +++ b/nixos/modules/programs/flexoptix-app.nix @@ -10,7 +10,7 @@ in { enable = mkEnableOption "FLEXOPTIX app + udev rules"; package = mkOption { - description = "FLEXOPTIX app package to use"; + description = lib.mdDoc "FLEXOPTIX app package to use"; type = types.package; default = pkgs.flexoptix-app; defaultText = literalExpression "pkgs.flexoptix-app"; diff --git a/nixos/modules/programs/freetds.nix b/nixos/modules/programs/freetds.nix index d95c44d756afb..98274fa9b5626 100644 --- a/nixos/modules/programs/freetds.nix +++ b/nixos/modules/programs/freetds.nix @@ -26,7 +26,7 @@ in } ''; description = - '' + lib.mdDoc '' Configure freetds database entries. Each attribute denotes a section within freetds.conf, and the value (a string) is the config content for that section. When at least one entry is configured diff --git a/nixos/modules/programs/fuse.nix b/nixos/modules/programs/fuse.nix index c15896efbb51a..b82d37a051e75 100644 --- a/nixos/modules/programs/fuse.nix +++ b/nixos/modules/programs/fuse.nix @@ -13,7 +13,7 @@ in { # negative numbers obviously make no sense: type = types.ints.between 0 32767; # 2^15 - 1 default = 1000; - description = '' + description = lib.mdDoc '' Set the maximum number of FUSE mounts allowed to non-root users. ''; }; @@ -21,7 +21,7 @@ in { userAllowOther = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Allow non-root users to specify the allow_other or allow_root mount options, see mount.fuse3(8). ''; diff --git a/nixos/modules/programs/gamemode.nix b/nixos/modules/programs/gamemode.nix index a377a1619aa04..84e20934edb6c 100644 --- a/nixos/modules/programs/gamemode.nix +++ b/nixos/modules/programs/gamemode.nix @@ -19,7 +19,7 @@ in settings = mkOption { type = settingsFormat.type; default = {}; - description = '' + description = lib.mdDoc '' System-wide configuration for GameMode (/etc/gamemode.ini). See gamemoded(8) man page for available settings. ''; diff --git a/nixos/modules/programs/git.nix b/nixos/modules/programs/git.nix index 06ce374b19923..c4cf3cc561aec 100644 --- a/nixos/modules/programs/git.nix +++ b/nixos/modules/programs/git.nix @@ -16,7 +16,7 @@ in default = pkgs.git; defaultText = literalExpression "pkgs.git"; example = literalExpression "pkgs.gitFull"; - description = "The git package to use"; + description = lib.mdDoc "The git package to use"; }; config = mkOption { @@ -26,7 +26,7 @@ in init.defaultBranch = "main"; url."https://github.com/".insteadOf = [ "gh:" "github:" ]; }; - description = '' + description = lib.mdDoc '' Configuration to write to /etc/gitconfig. See the CONFIGURATION FILE section of git-config(1) for more information. ''; @@ -39,7 +39,7 @@ in type = types.package; default = pkgs.git-lfs; defaultText = literalExpression "pkgs.git-lfs"; - description = "The git-lfs package to use"; + description = lib.mdDoc "The git-lfs package to use"; }; }; }; diff --git a/nixos/modules/programs/gnome-disks.nix b/nixos/modules/programs/gnome-disks.nix index 4b128b4712650..dcb20bd6037cd 100644 --- a/nixos/modules/programs/gnome-disks.nix +++ b/nixos/modules/programs/gnome-disks.nix @@ -26,7 +26,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable GNOME Disks daemon, a program designed to be a UDisks2 graphical front-end. ''; diff --git a/nixos/modules/programs/gnome-documents.nix b/nixos/modules/programs/gnome-documents.nix index 43ad3163efd85..2831ac9aff2e9 100644 --- a/nixos/modules/programs/gnome-documents.nix +++ b/nixos/modules/programs/gnome-documents.nix @@ -26,7 +26,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable GNOME Documents, a document manager application for GNOME. ''; diff --git a/nixos/modules/programs/gnupg.nix b/nixos/modules/programs/gnupg.nix index 7d8ab7dda9672..ad27766b72ecf 100644 --- a/nixos/modules/programs/gnupg.nix +++ b/nixos/modules/programs/gnupg.nix @@ -28,7 +28,7 @@ in type = types.package; default = pkgs.gnupg; defaultText = literalExpression "pkgs.gnupg"; - description = '' + description = lib.mdDoc '' The gpg package that should be used. ''; }; @@ -36,7 +36,7 @@ in agent.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enables GnuPG agent with socket-activation for every user session. ''; }; @@ -44,7 +44,7 @@ in agent.enableSSHSupport = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable SSH agent support in GnuPG agent. Also sets SSH_AUTH_SOCK environment variable correctly. This will disable socket-activation and thus always start a GnuPG agent per user session. @@ -54,7 +54,7 @@ in agent.enableExtraSocket = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable extra socket for GnuPG agent. ''; }; @@ -62,7 +62,7 @@ in agent.enableBrowserSocket = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable browser socket for GnuPG agent. ''; }; @@ -72,7 +72,7 @@ in example = "gnome3"; default = defaultPinentryFlavor; defaultText = literalDocBook ''matching the configured desktop environment''; - description = '' + description = lib.mdDoc '' Which pinentry interface to use. If not null, the path to the pinentry binary will be passed to gpg-agent via commandline and thus overrides the pinentry option in gpg-agent.conf in the user's @@ -86,7 +86,7 @@ in dirmngr.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enables GnuPG network certificate management daemon with socket-activation for every user session. ''; }; diff --git a/nixos/modules/programs/gpaste.nix b/nixos/modules/programs/gpaste.nix index cff2fb8d00348..074b4d59a365a 100644 --- a/nixos/modules/programs/gpaste.nix +++ b/nixos/modules/programs/gpaste.nix @@ -18,7 +18,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable GPaste, a clipboard manager. ''; }; diff --git a/nixos/modules/programs/htop.nix b/nixos/modules/programs/htop.nix index 5c197838e47c9..94f6e3c0efa72 100644 --- a/nixos/modules/programs/htop.nix +++ b/nixos/modules/programs/htop.nix @@ -21,7 +21,7 @@ in type = types.package; default = pkgs.htop; defaultText = "pkgs.htop"; - description = '' + description = lib.mdDoc '' The htop package that should be used. ''; }; @@ -35,7 +35,7 @@ in hide_kernel_threads = true; hide_userland_threads = true; }; - description = '' + description = lib.mdDoc '' Extra global default configuration for htop which is read on first startup only. Htop subsequently uses ~/.config/htop/htoprc diff --git a/nixos/modules/programs/java.nix b/nixos/modules/programs/java.nix index 4e4e0629e5d97..5994f53f76b7b 100644 --- a/nixos/modules/programs/java.nix +++ b/nixos/modules/programs/java.nix @@ -35,7 +35,7 @@ in package = mkOption { default = pkgs.jdk; defaultText = literalExpression "pkgs.jdk"; - description = '' + description = lib.mdDoc '' Java package to install. Typical values are pkgs.jdk or pkgs.jre. ''; type = types.package; diff --git a/nixos/modules/programs/k40-whisperer.nix b/nixos/modules/programs/k40-whisperer.nix index 3163e45f57e45..305c828f0a8a2 100644 --- a/nixos/modules/programs/k40-whisperer.nix +++ b/nixos/modules/programs/k40-whisperer.nix @@ -14,7 +14,7 @@ in group = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Group assigned to the device when connected. ''; default = "k40"; @@ -25,7 +25,7 @@ in default = pkgs.k40-whisperer; defaultText = literalExpression "pkgs.k40-whisperer"; example = literalExpression "pkgs.k40-whisperer"; - description = '' + description = lib.mdDoc '' K40 Whisperer package to use. ''; }; diff --git a/nixos/modules/programs/kdeconnect.nix b/nixos/modules/programs/kdeconnect.nix index 10d6e18a3d144..aa4302404ad47 100644 --- a/nixos/modules/programs/kdeconnect.nix +++ b/nixos/modules/programs/kdeconnect.nix @@ -16,7 +16,7 @@ with lib; defaultText = literalExpression "pkgs.plasma5Packages.kdeconnect-kde"; type = types.package; example = literalExpression "pkgs.gnomeExtensions.gsconnect"; - description = '' + description = lib.mdDoc '' The package providing the implementation for kdeconnect. ''; }; diff --git a/nixos/modules/programs/light.nix b/nixos/modules/programs/light.nix index 9f2a03e7e7639..57cc925be4655 100644 --- a/nixos/modules/programs/light.nix +++ b/nixos/modules/programs/light.nix @@ -12,7 +12,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to install Light backlight control command and udev rules granting access to members of the "video" group. ''; diff --git a/nixos/modules/programs/mosh.nix b/nixos/modules/programs/mosh.nix index e08099e21a00c..31aadb6aba616 100644 --- a/nixos/modules/programs/mosh.nix +++ b/nixos/modules/programs/mosh.nix @@ -10,7 +10,7 @@ in { options.programs.mosh = { enable = mkOption { - description = '' + description = lib.mdDoc '' Whether to enable mosh. Note, this will open ports in your firewall! ''; default = false; diff --git a/nixos/modules/programs/msmtp.nix b/nixos/modules/programs/msmtp.nix index 9c067bdc96957..fbdab2cac559e 100644 --- a/nixos/modules/programs/msmtp.nix +++ b/nixos/modules/programs/msmtp.nix @@ -15,7 +15,7 @@ in { setSendmail = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to set the system sendmail to msmtp's. ''; }; @@ -28,7 +28,7 @@ in { port = 587; tls = true; }; - description = '' + description = lib.mdDoc '' Default values applied to all accounts. See msmtp(1) for the available options. ''; @@ -62,7 +62,7 @@ in { extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra lines to add to the msmtp configuration verbatim. See msmtp(1) for the syntax and available options. ''; diff --git a/nixos/modules/programs/mtr.nix b/nixos/modules/programs/mtr.nix index 3cffe0fd8b2fa..173f247294174 100644 --- a/nixos/modules/programs/mtr.nix +++ b/nixos/modules/programs/mtr.nix @@ -11,7 +11,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to add mtr to the global environment and configure a setcap wrapper for it. ''; @@ -21,7 +21,7 @@ in { type = types.package; default = pkgs.mtr; defaultText = literalExpression "pkgs.mtr"; - description = '' + description = lib.mdDoc '' The package to use. ''; }; diff --git a/nixos/modules/programs/neovim.nix b/nixos/modules/programs/neovim.nix index 4649662542dee..b1dbcd1813099 100644 --- a/nixos/modules/programs/neovim.nix +++ b/nixos/modules/programs/neovim.nix @@ -16,7 +16,7 @@ in { defaultEditor = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' When enabled, installs neovim and configures neovim to be the default editor using the EDITOR environment variable. ''; @@ -25,35 +25,35 @@ in { viAlias = mkOption { type = types.bool; default = false; - description = '' - Symlink <command>vi</command> to <command>nvim</command> binary. + description = lib.mdDoc '' + Symlink {command}`vi` to {command}`nvim` binary. ''; }; vimAlias = mkOption { type = types.bool; default = false; - description = '' - Symlink <command>vim</command> to <command>nvim</command> binary. + description = lib.mdDoc '' + Symlink {command}`vim` to {command}`nvim` binary. ''; }; withRuby = mkOption { type = types.bool; default = true; - description = "Enable Ruby provider."; + description = lib.mdDoc "Enable Ruby provider."; }; withPython3 = mkOption { type = types.bool; default = true; - description = "Enable Python 3 provider."; + description = lib.mdDoc "Enable Python 3 provider."; }; withNodeJs = mkOption { type = types.bool; default = false; - description = "Enable Node provider."; + description = lib.mdDoc "Enable Node provider."; }; configure = mkOption { @@ -82,7 +82,7 @@ in { type = types.package; default = pkgs.neovim-unwrapped; defaultText = literalExpression "pkgs.neovim-unwrapped"; - description = "The package to use for the neovim binary."; + description = lib.mdDoc "The package to use for the neovim binary."; }; finalPackage = mkOption { @@ -97,8 +97,8 @@ in { example = literalExpression '' { "ftplugin/c.vim".text = "setlocal omnifunc=v:lua.vim.lsp.omnifunc"; } ''; - description = '' - Set of files that have to be linked in <filename>runtime</filename>. + description = lib.mdDoc '' + Set of files that have to be linked in {file}`runtime`. ''; type = with types; attrsOf (submodule ( @@ -108,7 +108,7 @@ in { enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether this /etc file should be generated. This option allows specific /etc files to be disabled. ''; @@ -116,7 +116,7 @@ in { target = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Name of symlink. Defaults to the attribute name. ''; @@ -125,12 +125,12 @@ in { text = mkOption { default = null; type = types.nullOr types.lines; - description = "Text of the file."; + description = lib.mdDoc "Text of the file."; }; source = mkOption { type = types.path; - description = "Path of the source file."; + description = lib.mdDoc "Path of the source file."; }; }; diff --git a/nixos/modules/programs/nethoscope.nix b/nixos/modules/programs/nethoscope.nix index 495548e9c6561..d8ece61c90a2b 100644 --- a/nixos/modules/programs/nethoscope.nix +++ b/nixos/modules/programs/nethoscope.nix @@ -12,7 +12,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to add nethoscope to the global environment and configure a setcap wrapper for it. ''; diff --git a/nixos/modules/programs/nm-applet.nix b/nixos/modules/programs/nm-applet.nix index 5bcee30125bb8..ef24030c9db93 100644 --- a/nixos/modules/programs/nm-applet.nix +++ b/nixos/modules/programs/nm-applet.nix @@ -11,7 +11,7 @@ indicator = lib.mkOption { type = lib.types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to use indicator instead of status icon. It is needed for Appindicator environments, like Enlightenment. ''; diff --git a/nixos/modules/programs/nncp.nix b/nixos/modules/programs/nncp.nix index 29a703eadf10e..f40e888dad8c0 100644 --- a/nixos/modules/programs/nncp.nix +++ b/nixos/modules/programs/nncp.nix @@ -16,7 +16,7 @@ in { group = mkOption { type = types.str; default = "uucp"; - description = '' + description = lib.mdDoc '' The group under which NNCP files shall be owned. Any member of this group may access the secret keys of this NNCP node. @@ -27,7 +27,7 @@ in { type = types.package; default = pkgs.nncp; defaultText = literalExpression "pkgs.nncp"; - description = "The NNCP package to use system-wide."; + description = lib.mdDoc "The NNCP package to use system-wide."; }; secrets = mkOption { diff --git a/nixos/modules/programs/noisetorch.nix b/nixos/modules/programs/noisetorch.nix index f76555289f1a3..c69b2581296f0 100644 --- a/nixos/modules/programs/noisetorch.nix +++ b/nixos/modules/programs/noisetorch.nix @@ -11,7 +11,7 @@ in { type = types.package; default = pkgs.noisetorch; defaultText = literalExpression "pkgs.noisetorch"; - description = '' + description = lib.mdDoc '' The noisetorch package to use. ''; }; diff --git a/nixos/modules/programs/npm.nix b/nixos/modules/programs/npm.nix index d79c6c7340007..709438048347e 100644 --- a/nixos/modules/programs/npm.nix +++ b/nixos/modules/programs/npm.nix @@ -15,7 +15,7 @@ in package = mkOption { type = types.package; - description = "The npm package version / flavor to use"; + description = lib.mdDoc "The npm package version / flavor to use"; default = pkgs.nodePackages.npm; defaultText = literalExpression "pkgs.nodePackages.npm"; example = literalExpression "pkgs.nodePackages_13_x.npm"; @@ -23,9 +23,9 @@ in npmrc = mkOption { type = lib.types.lines; - description = '' + description = lib.mdDoc '' The system-wide npm configuration. - See <link xlink:href="https://docs.npmjs.com/misc/config"/>. + See <https://docs.npmjs.com/misc/config>. ''; default = '' prefix = ''${HOME}/.npm diff --git a/nixos/modules/programs/plotinus.nix b/nixos/modules/programs/plotinus.nix index 2c90a41ba0296..a011bb862aeaf 100644 --- a/nixos/modules/programs/plotinus.nix +++ b/nixos/modules/programs/plotinus.nix @@ -17,7 +17,7 @@ in programs.plotinus = { enable = mkOption { default = false; - description = '' + description = lib.mdDoc '' Whether to enable the Plotinus GTK 3 plugin. Plotinus provides a popup (triggered by Ctrl-Shift-P) to search the menus of a compatible application. diff --git a/nixos/modules/programs/screen.nix b/nixos/modules/programs/screen.nix index 728a0eb8cea5b..68de9e52d7be3 100644 --- a/nixos/modules/programs/screen.nix +++ b/nixos/modules/programs/screen.nix @@ -13,7 +13,7 @@ in screenrc = mkOption { default = ""; - description = '' + description = lib.mdDoc '' The contents of /etc/screenrc file. ''; type = types.lines; diff --git a/nixos/modules/programs/shadow.nix b/nixos/modules/programs/shadow.nix index 963cd8853dbbb..fab809f279a36 100644 --- a/nixos/modules/programs/shadow.nix +++ b/nixos/modules/programs/shadow.nix @@ -59,7 +59,7 @@ in options = { users.defaultUserShell = lib.mkOption { - description = '' + description = lib.mdDoc '' This option defines the default shell assigned to user accounts. This can be either a full system path or a shell package. diff --git a/nixos/modules/programs/slock.nix b/nixos/modules/programs/slock.nix index ce80fcc5d4a8a..3db9866d9f1c3 100644 --- a/nixos/modules/programs/slock.nix +++ b/nixos/modules/programs/slock.nix @@ -12,7 +12,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to install slock screen locker with setuid wrapper. ''; }; diff --git a/nixos/modules/programs/ssh.nix b/nixos/modules/programs/ssh.nix index 75685de4f04e3..e0da6ef3b3ad3 100644 --- a/nixos/modules/programs/ssh.nix +++ b/nixos/modules/programs/ssh.nix @@ -40,20 +40,20 @@ in type = types.bool; default = config.services.xserver.enable; defaultText = literalExpression "config.services.xserver.enable"; - description = "Whether to configure SSH_ASKPASS in the environment."; + description = lib.mdDoc "Whether to configure SSH_ASKPASS in the environment."; }; askPassword = mkOption { type = types.str; default = "${pkgs.x11_ssh_askpass}/libexec/x11-ssh-askpass"; defaultText = literalExpression ''"''${pkgs.x11_ssh_askpass}/libexec/x11-ssh-askpass"''; - description = "Program used by SSH to ask for passwords."; + description = lib.mdDoc "Program used by SSH to ask for passwords."; }; forwardX11 = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to request X11 forwarding on outgoing connections by default. This is useful for running graphical programs on the remote machine and have them display to your local X11 server. Historically, this value has depended on the value used by the local sshd daemon, but there really isn't a relation between the two. @@ -66,8 +66,8 @@ in setXAuthLocation = mkOption { type = types.bool; - description = '' - Whether to set the path to <command>xauth</command> for X11-forwarded connections. + description = lib.mdDoc '' + Whether to set the path to {command}`xauth` for X11-forwarded connections. This causes a dependency on X11 packages. ''; }; @@ -76,7 +76,7 @@ in type = types.listOf types.str; default = []; example = [ "ssh-ed25519" "ssh-rsa" ]; - description = '' + description = lib.mdDoc '' Specifies the key types that will be used for public key authentication. ''; }; @@ -85,7 +85,7 @@ in type = types.listOf types.str; default = []; example = [ "ssh-ed25519" "ssh-rsa" ]; - description = '' + description = lib.mdDoc '' Specifies the host key algorithms that the client wants to use in order of preference. ''; }; @@ -104,11 +104,11 @@ in startAgent = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to start the OpenSSH agent when you log in. The OpenSSH agent remembers private keys for you so that you don't have to type in passphrases every time you make an SSH connection. Use - <command>ssh-add</command> to add a key to the agent. + {command}`ssh-add` to add a key to the agent. ''; }; @@ -116,7 +116,7 @@ in type = types.nullOr types.str; default = null; example = "1h"; - description = '' + description = lib.mdDoc '' How long to keep the private keys in memory. Use null to keep them forever. ''; }; @@ -125,7 +125,7 @@ in type = types.nullOr types.str; default = null; example = literalExpression ''"''${pkgs.opensc}/lib/opensc-pkcs11.so"''; - description = '' + description = lib.mdDoc '' A pattern-list of acceptable paths for PKCS#11 shared libraries that may be used with the -s option to ssh-add. ''; @@ -135,7 +135,7 @@ in type = types.package; default = pkgs.openssh; defaultText = literalExpression "pkgs.openssh"; - description = '' + description = lib.mdDoc '' The package used for the openssh client and daemon. ''; }; @@ -147,7 +147,7 @@ in certAuthority = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' This public key is an SSH certificate authority, rather than an individual host's key. ''; @@ -156,32 +156,32 @@ in type = types.listOf types.str; default = [ name ] ++ config.extraHostNames; defaultText = literalExpression "[ ${name} ] ++ config.${options.extraHostNames}"; - description = '' + description = lib.mdDoc '' A list of host names and/or IP numbers used for accessing the host's ssh service. This list includes the name of the - containing <literal>knownHosts</literal> attribute by default + containing `knownHosts` attribute by default for convenience. If you wish to configure multiple host keys - for the same host use multiple <literal>knownHosts</literal> + for the same host use multiple `knownHosts` entries with different attribute names and the same - <literal>hostNames</literal> list. + `hostNames` list. ''; }; extraHostNames = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' A list of additional host names and/or IP numbers used for accessing the host's ssh service. This list is ignored if - <literal>hostNames</literal> is set explicitly. + `hostNames` is set explicitly. ''; }; publicKey = mkOption { default = null; type = types.nullOr types.str; example = "ecdsa-sha2-nistp521 AAAAE2VjZHN...UEPg=="; - description = '' + description = lib.mdDoc '' The public key data for the host. You can fetch a public key - from a running SSH server with the <command>ssh-keyscan</command> + from a running SSH server with the {command}`ssh-keyscan` command. The public key should not include any host names, only the key type and the key itself. ''; @@ -189,25 +189,25 @@ in publicKeyFile = mkOption { default = null; type = types.nullOr types.path; - description = '' + description = lib.mdDoc '' The path to the public key file for the host. The public key file is read at build time and saved in the Nix store. You can fetch a public key file from a running SSH server - with the <command>ssh-keyscan</command> command. The content + with the {command}`ssh-keyscan` command. The content of the file should follow the same format as described for - the <literal>publicKey</literal> option. Only a single key + the `publicKey` option. Only a single key is supported. If a host has multiple keys, use - <option>programs.ssh.knownHostsFiles</option> instead. + {option}`programs.ssh.knownHostsFiles` instead. ''; }; }; })); - description = '' + description = lib.mdDoc '' The set of system-wide known SSH hosts. To make simple setups more convenient the name of an attribute in this set is used as a host name for the entry. This behaviour can be disabled by setting - <literal>hostNames</literal> explicitly. You can use - <literal>extraHostNames</literal> to add additional host names without + `hostNames` explicitly. You can use + `extraHostNames` to add additional host names without disabling this default. ''; example = literalExpression '' @@ -228,11 +228,11 @@ in knownHostsFiles = mkOption { default = []; type = with types; listOf path; - description = '' + description = lib.mdDoc '' Files containing SSH host keys to set as global known hosts. - <literal>/etc/ssh/ssh_known_hosts</literal> (which is - generated by <option>programs.ssh.knownHosts</option>) and - <literal>/etc/ssh/ssh_known_hosts2</literal> are always + `/etc/ssh/ssh_known_hosts` (which is + generated by {option}`programs.ssh.knownHosts`) and + `/etc/ssh/ssh_known_hosts2` are always included. ''; example = literalExpression '' @@ -251,7 +251,7 @@ in type = types.nullOr (types.listOf types.str); default = null; example = [ "curve25519-sha256@libssh.org" "diffie-hellman-group-exchange-sha256" ]; - description = '' + description = lib.mdDoc '' Specifies the available KEX (Key Exchange) algorithms. ''; }; @@ -260,7 +260,7 @@ in type = types.nullOr (types.listOf types.str); default = null; example = [ "chacha20-poly1305@openssh.com" "aes256-gcm@openssh.com" ]; - description = '' + description = lib.mdDoc '' Specifies the ciphers allowed and their order of preference. ''; }; @@ -269,7 +269,7 @@ in type = types.nullOr (types.listOf types.str); default = null; example = [ "hmac-sha2-512-etm@openssh.com" "hmac-sha1" ]; - description = '' + description = lib.mdDoc '' Specifies the MAC (message authentication code) algorithms in order of preference. The MAC algorithm is used for data integrity protection. ''; diff --git a/nixos/modules/programs/steam.nix b/nixos/modules/programs/steam.nix index ff4deba2bf0ae..d80718e792aff 100644 --- a/nixos/modules/programs/steam.nix +++ b/nixos/modules/programs/steam.nix @@ -18,7 +18,7 @@ in { remotePlay.openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for Steam Remote Play. ''; }; @@ -26,7 +26,7 @@ in { dedicatedServer.openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for Source Dedicated Server. ''; }; diff --git a/nixos/modules/programs/streamdeck-ui.nix b/nixos/modules/programs/streamdeck-ui.nix index 1434f82660de3..04aa0a80e8897 100644 --- a/nixos/modules/programs/streamdeck-ui.nix +++ b/nixos/modules/programs/streamdeck-ui.nix @@ -11,7 +11,7 @@ in { autoStart = mkOption { default = true; type = types.bool; - description = "Whether streamdeck-ui should be started automatically."; + description = lib.mdDoc "Whether streamdeck-ui should be started automatically."; }; }; diff --git a/nixos/modules/programs/sway.nix b/nixos/modules/programs/sway.nix index 01b0472813447..decae1b4d2da2 100644 --- a/nixos/modules/programs/sway.nix +++ b/nixos/modules/programs/sway.nix @@ -12,7 +12,7 @@ let type = types.bool; inherit default; example = !default; - description = "Whether to make use of the ${description}"; + description = lib.mdDoc "Whether to make use of the ${description}"; }; in { base = mkWrapperFeature true '' @@ -46,7 +46,7 @@ in { type = wrapperOptions; default = { }; example = { gtk = true; }; - description = '' + description = lib.mdDoc '' Attribute set of features to enable in the wrapper. ''; }; @@ -64,10 +64,10 @@ in { # use this if they aren't displayed properly: export _JAVA_AWT_WM_NONREPARENTING=1 ''; - description = '' + description = lib.mdDoc '' Shell commands executed just before Sway is started. See - <link xlink:href="https://github.com/swaywm/sway/wiki/Running-programs-natively-under-wayland" /> - and <link xlink:href="https://github.com/swaywm/wlroots/blob/master/docs/env_vars.md" /> + <https://github.com/swaywm/sway/wiki/Running-programs-natively-under-wayland> + and <https://github.com/swaywm/wlroots/blob/master/docs/env_vars.md> for some useful environment variables. ''; }; @@ -81,7 +81,7 @@ in { "--unsupported-gpu" "--my-next-gpu-wont-be-nvidia" ]; - description = '' + description = lib.mdDoc '' Command line arguments passed to launch Sway. Please DO NOT report issues if you use an unsupported GPU (proprietary drivers). ''; @@ -101,10 +101,10 @@ in { termite rofi light ] ''; - description = '' + description = lib.mdDoc '' Extra packages to be installed system wide. See - <link xlink:href="https://github.com/swaywm/sway/wiki/Useful-add-ons-for-sway" /> and - <link xlink:href="https://github.com/swaywm/sway/wiki/i3-Migration-Guide#common-x11-apps-used-on-i3-with-wayland-alternatives" /> + <https://github.com/swaywm/sway/wiki/Useful-add-ons-for-sway> and + <https://github.com/swaywm/sway/wiki/i3-Migration-Guide#common-x11-apps-used-on-i3-with-wayland-alternatives> for a list of useful software. ''; }; diff --git a/nixos/modules/programs/systemtap.nix b/nixos/modules/programs/systemtap.nix index 360e106678e65..cbb9ec164c6ca 100644 --- a/nixos/modules/programs/systemtap.nix +++ b/nixos/modules/programs/systemtap.nix @@ -10,8 +10,8 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' - Install <command>systemtap</command> along with necessary kernel options. + description = lib.mdDoc '' + Install {command}`systemtap` along with necessary kernel options. ''; }; }; diff --git a/nixos/modules/programs/thunar.nix b/nixos/modules/programs/thunar.nix index 5ea2982dd93cf..a67d8ae064dfe 100644 --- a/nixos/modules/programs/thunar.nix +++ b/nixos/modules/programs/thunar.nix @@ -16,7 +16,7 @@ in { plugins = mkOption { default = []; type = types.listOf types.package; - description = "List of thunar plugins to install."; + description = lib.mdDoc "List of thunar plugins to install."; example = literalExpression "with pkgs.xfce; [ thunar-archive-plugin thunar-volman ]"; }; diff --git a/nixos/modules/programs/tmux.nix b/nixos/modules/programs/tmux.nix index 74b3fbd9ac069..cf7ea4cfcf76a 100644 --- a/nixos/modules/programs/tmux.nix +++ b/nixos/modules/programs/tmux.nix @@ -70,14 +70,14 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whenever to configure <command>tmux</command> system-wide."; + description = lib.mdDoc "Whenever to configure {command}`tmux` system-wide."; relatedPackages = [ "tmux" ]; }; aggressiveResize = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Resize the window to the size of the smallest session for which it is the current window. ''; }; @@ -86,31 +86,31 @@ in { default = 0; example = 1; type = types.int; - description = "Base index for windows and panes."; + description = lib.mdDoc "Base index for windows and panes."; }; clock24 = mkOption { default = false; type = types.bool; - description = "Use 24 hour clock."; + description = lib.mdDoc "Use 24 hour clock."; }; customPaneNavigationAndResize = mkOption { default = false; type = types.bool; - description = "Override the hjkl and HJKL bindings for pane navigation and resizing in VI mode."; + description = lib.mdDoc "Override the hjkl and HJKL bindings for pane navigation and resizing in VI mode."; }; escapeTime = mkOption { default = 500; example = 0; type = types.int; - description = "Time in milliseconds for which tmux waits after an escape is input."; + description = lib.mdDoc "Time in milliseconds for which tmux waits after an escape is input."; }; extraConfig = mkOption { default = ""; - description = '' + description = lib.mdDoc '' Additional contents of /etc/tmux.conf ''; type = types.lines; @@ -120,53 +120,53 @@ in { default = 2000; example = 5000; type = types.int; - description = "Maximum number of lines held in window history."; + description = lib.mdDoc "Maximum number of lines held in window history."; }; keyMode = mkOption { default = defaultKeyMode; example = "vi"; type = types.enum [ "emacs" "vi" ]; - description = "VI or Emacs style shortcuts."; + description = lib.mdDoc "VI or Emacs style shortcuts."; }; newSession = mkOption { default = false; type = types.bool; - description = "Automatically spawn a session if trying to attach and none are running."; + description = lib.mdDoc "Automatically spawn a session if trying to attach and none are running."; }; reverseSplit = mkOption { default = false; type = types.bool; - description = "Reverse the window split shortcuts."; + description = lib.mdDoc "Reverse the window split shortcuts."; }; resizeAmount = mkOption { default = defaultResize; example = 10; type = types.int; - description = "Number of lines/columns when resizing."; + description = lib.mdDoc "Number of lines/columns when resizing."; }; shortcut = mkOption { default = defaultShortcut; example = "a"; type = types.str; - description = "Ctrl following by this key is used as the main shortcut."; + description = lib.mdDoc "Ctrl following by this key is used as the main shortcut."; }; terminal = mkOption { default = defaultTerminal; example = "screen-256color"; type = types.str; - description = "Set the $TERM variable."; + description = lib.mdDoc "Set the $TERM variable."; }; secureSocket = mkOption { default = true; type = types.bool; - description = '' + description = lib.mdDoc '' Store tmux socket under /run, which is more secure than /tmp, but as a downside it doesn't survive user logout. ''; @@ -175,7 +175,7 @@ in { plugins = mkOption { default = []; type = types.listOf types.package; - description = "List of plugins to install."; + description = lib.mdDoc "List of plugins to install."; example = lib.literalExpression "[ pkgs.tmuxPlugins.nord ]"; }; }; diff --git a/nixos/modules/programs/traceroute.nix b/nixos/modules/programs/traceroute.nix index 6e04057ac5034..df5f10b87d5f3 100644 --- a/nixos/modules/programs/traceroute.nix +++ b/nixos/modules/programs/traceroute.nix @@ -10,7 +10,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to configure a setcap wrapper for traceroute. ''; }; diff --git a/nixos/modules/programs/tsm-client.nix b/nixos/modules/programs/tsm-client.nix index 28db96253875f..0a3af3744a78f 100644 --- a/nixos/modules/programs/tsm-client.nix +++ b/nixos/modules/programs/tsm-client.nix @@ -26,43 +26,43 @@ let options.name = mkOption { type = servernameType; example = "mainTsmServer"; - description = '' + description = lib.mdDoc '' Local name of the IBM TSM server, must be uncapitalized and no longer than 64 chars. The value will be used for the - <literal>server</literal> - directive in <filename>dsm.sys</filename>. + `server` + directive in {file}`dsm.sys`. ''; }; options.server = mkOption { type = nonEmptyStr; example = "tsmserver.company.com"; - description = '' + description = lib.mdDoc '' Host/domain name or IP address of the IBM TSM server. The value will be used for the - <literal>tcpserveraddress</literal> - directive in <filename>dsm.sys</filename>. + `tcpserveraddress` + directive in {file}`dsm.sys`. ''; }; options.port = mkOption { type = addCheck port (p: p<=32767); default = 1500; # official default - description = '' + description = lib.mdDoc '' TCP port of the IBM TSM server. The value will be used for the - <literal>tcpport</literal> - directive in <filename>dsm.sys</filename>. + `tcpport` + directive in {file}`dsm.sys`. TSM does not support ports above 32767. ''; }; options.node = mkOption { type = nonEmptyStr; example = "MY-TSM-NODE"; - description = '' + description = lib.mdDoc '' Target node name on the IBM TSM server. The value will be used for the - <literal>nodename</literal> - directive in <filename>dsm.sys</filename>. + `nodename` + directive in {file}`dsm.sys`. ''; }; options.genPasswd = mkEnableOption '' @@ -80,12 +80,12 @@ let options.passwdDir = mkOption { type = path; example = "/home/alice/tsm-password"; - description = '' + description = lib.mdDoc '' Directory that holds the TSM node's password information. The value will be used for the - <literal>passworddir</literal> - directive in <filename>dsm.sys</filename>. + `passworddir` + directive in {file}`dsm.sys`. ''; }; options.includeExclude = mkOption { @@ -114,9 +114,9 @@ let default = {}; example.compression = "yes"; example.passwordaccess = null; - description = '' + description = lib.mdDoc '' Additional key-value pairs for the server stanza. - Values must be strings, or <literal>null</literal> + Values must be strings, or `null` for the key not to be used in the stanza (e.g. to overrule values generated by other options). ''; @@ -125,13 +125,13 @@ let type = lines; example = literalExpression ''lib.modules.mkAfter "compression no"''; - description = '' + description = lib.mdDoc '' Additional text lines for the server stanza. This option can be used if certion configuration keys must be used multiple times or ordered in a certain way - as the <option>extraConfig</option> option can't + as the {option}`extraConfig` option can't control the order of lines in the resulting stanza. - Note that the <literal>server</literal> + Note that the `server` line at the beginning of the stanza is not part of this option's value. ''; @@ -185,7 +185,7 @@ let node = "MY-TSM-NODE"; extraConfig.compression = "yes"; }; - description = '' + description = lib.mdDoc '' Server definitions ("stanzas") for the client system-options file. ''; @@ -194,20 +194,20 @@ let type = nullOr servernameType; default = null; example = "mainTsmServer"; - description = '' + description = lib.mdDoc '' If multiple server stanzas are declared with - <option>programs.tsmClient.servers</option>, + {option}`programs.tsmClient.servers`, this option may be used to name a default server stanza that IBM TSM uses in the absence of - a user-defined <filename>dsm.opt</filename> file. + a user-defined {file}`dsm.opt` file. This option translates to a - <literal>defaultserver</literal> configuration line. + `defaultserver` configuration line. ''; }; dsmSysText = mkOption { type = lines; readOnly = true; - description = '' + description = lib.mdDoc '' This configuration key contains the effective text of the client system-options file "dsm.sys". It should not be changed, but may be @@ -220,17 +220,17 @@ let default = pkgs.tsm-client; defaultText = literalExpression "pkgs.tsm-client"; example = literalExpression "pkgs.tsm-client-withGui"; - description = '' + description = lib.mdDoc '' The TSM client derivation to be added to the system environment. - It will called with <literal>.override</literal> + It will called with `.override` to add paths to the client system-options file. ''; }; wrappedPackage = mkOption { type = package; readOnly = true; - description = '' + description = lib.mdDoc '' The TSM client derivation, wrapped with the path to the client system-options file "dsm.sys". This option is to provide the effective derivation diff --git a/nixos/modules/programs/vim.nix b/nixos/modules/programs/vim.nix index 1695bc994732c..15983e371f0eb 100644 --- a/nixos/modules/programs/vim.nix +++ b/nixos/modules/programs/vim.nix @@ -9,7 +9,7 @@ in { defaultEditor = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' When enabled, installs vim and configures vim to be the default editor using the EDITOR environment variable. ''; @@ -20,7 +20,7 @@ in { default = pkgs.vim; defaultText = literalExpression "pkgs.vim"; example = literalExpression "pkgs.vimHugeX"; - description = '' + description = lib.mdDoc '' vim package to use. ''; }; diff --git a/nixos/modules/programs/wavemon.nix b/nixos/modules/programs/wavemon.nix index e5ccacba75d4a..4dbf2748913eb 100644 --- a/nixos/modules/programs/wavemon.nix +++ b/nixos/modules/programs/wavemon.nix @@ -10,7 +10,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to add wavemon to the global environment and configure a setcap wrapper for it. ''; diff --git a/nixos/modules/programs/weylus.nix b/nixos/modules/programs/weylus.nix index ea92c77e7c321..0a506bfa27851 100644 --- a/nixos/modules/programs/weylus.nix +++ b/nixos/modules/programs/weylus.nix @@ -12,7 +12,7 @@ in openFirewall = mkOption { type = bool; default = false; - description = '' + description = lib.mdDoc '' Open ports needed for the functionality of the program. ''; }; @@ -20,7 +20,7 @@ in users = mkOption { type = listOf str; default = [ ]; - description = '' + description = lib.mdDoc '' To enable stylus and multi-touch support, the user you're going to use must be added to this list. These users can synthesize input events system-wide, even when another user is logged in - untrusted users should not be added. ''; @@ -30,7 +30,7 @@ in type = package; default = pkgs.weylus; defaultText = "pkgs.weylus"; - description = "Weylus package to install."; + description = lib.mdDoc "Weylus package to install."; }; }; config = mkIf cfg.enable { diff --git a/nixos/modules/programs/wireshark.nix b/nixos/modules/programs/wireshark.nix index f7b0727cb2b39..088c2bb7958aa 100644 --- a/nixos/modules/programs/wireshark.nix +++ b/nixos/modules/programs/wireshark.nix @@ -11,7 +11,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to add Wireshark to the global environment and configure a setcap wrapper for 'dumpcap' for users in the 'wireshark' group. ''; @@ -20,7 +20,7 @@ in { type = types.package; default = pkgs.wireshark-cli; defaultText = literalExpression "pkgs.wireshark-cli"; - description = '' + description = lib.mdDoc '' Which Wireshark package to install in the global environment. ''; }; diff --git a/nixos/modules/programs/xfs_quota.nix b/nixos/modules/programs/xfs_quota.nix index c03e59a5b4abe..a1e9ff941c6b8 100644 --- a/nixos/modules/programs/xfs_quota.nix +++ b/nixos/modules/programs/xfs_quota.nix @@ -28,37 +28,37 @@ in options = { id = mkOption { type = types.int; - description = "Project ID."; + description = lib.mdDoc "Project ID."; }; fileSystem = mkOption { type = types.str; - description = "XFS filesystem hosting the xfs_quota project."; + description = lib.mdDoc "XFS filesystem hosting the xfs_quota project."; default = "/"; }; path = mkOption { type = types.str; - description = "Project directory."; + description = lib.mdDoc "Project directory."; }; sizeSoftLimit = mkOption { type = types.nullOr types.str; default = null; example = "30g"; - description = "Soft limit of the project size"; + description = lib.mdDoc "Soft limit of the project size"; }; sizeHardLimit = mkOption { type = types.nullOr types.str; default = null; example = "50g"; - description = "Hard limit of the project size."; + description = lib.mdDoc "Hard limit of the project size."; }; }; }); - description = "Setup of xfs_quota projects. Make sure the filesystem is mounted with the pquota option."; + description = lib.mdDoc "Setup of xfs_quota projects. Make sure the filesystem is mounted with the pquota option."; example = { projname = { diff --git a/nixos/modules/programs/xonsh.nix b/nixos/modules/programs/xonsh.nix index 6e40db51cdb2f..3223761f93408 100644 --- a/nixos/modules/programs/xonsh.nix +++ b/nixos/modules/programs/xonsh.nix @@ -18,7 +18,7 @@ in enable = mkOption { default = false; - description = '' + description = lib.mdDoc '' Whether to configure xonsh as an interactive shell. ''; type = types.bool; @@ -29,14 +29,14 @@ in default = pkgs.xonsh; defaultText = literalExpression "pkgs.xonsh"; example = literalExpression "pkgs.xonsh.override { configFile = \"/path/to/xonshrc\"; }"; - description = '' + description = lib.mdDoc '' xonsh package to use. ''; }; config = mkOption { default = ""; - description = "Control file to customize your shell behavior."; + description = lib.mdDoc "Control file to customize your shell behavior."; type = types.lines; }; diff --git a/nixos/modules/programs/xss-lock.nix b/nixos/modules/programs/xss-lock.nix index aba76133e5e33..c14c09721d6d1 100644 --- a/nixos/modules/programs/xss-lock.nix +++ b/nixos/modules/programs/xss-lock.nix @@ -14,16 +14,16 @@ in defaultText = literalExpression ''"''${pkgs.i3lock}/bin/i3lock"''; example = literalExpression ''"''${pkgs.i3lock-fancy}/bin/i3lock-fancy"''; type = types.separatedString " "; - description = "Locker to be used with xsslock"; + description = lib.mdDoc "Locker to be used with xsslock"; }; extraOptions = mkOption { default = [ ]; example = [ "--ignore-sleep" ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Additional command-line arguments to pass to - <command>xss-lock</command>. + {command}`xss-lock`. ''; }; }; diff --git a/nixos/modules/programs/xwayland.nix b/nixos/modules/programs/xwayland.nix index 3a8080fa4c4d8..9296116dca8ed 100644 --- a/nixos/modules/programs/xwayland.nix +++ b/nixos/modules/programs/xwayland.nix @@ -19,7 +19,7 @@ in defaultText = literalExpression '' optionalString config.fonts.fontDir.enable "/run/current-system/sw/share/X11/fonts" ''; - description = '' + description = lib.mdDoc '' Default font path. Setting this option causes Xwayland to be rebuilt. ''; }; @@ -34,7 +34,7 @@ in inherit (config.programs.xwayland) defaultFontPath; }) ''; - description = "The Xwayland package to use."; + description = lib.mdDoc "The Xwayland package to use."; }; }; diff --git a/nixos/modules/programs/yabar.nix b/nixos/modules/programs/yabar.nix index a8fac41e899c1..0ec668ada8eba 100644 --- a/nixos/modules/programs/yabar.nix +++ b/nixos/modules/programs/yabar.nix @@ -79,7 +79,7 @@ in example = "Droid Sans, FontAwesome Bold 9"; type = types.str; - description = '' + description = lib.mdDoc '' The font that will be used to draw the status bar. ''; }; @@ -89,7 +89,7 @@ in example = "bottom"; type = types.enum [ "top" "bottom" ]; - description = '' + description = lib.mdDoc '' The position where the bar will be rendered. ''; }; @@ -98,7 +98,7 @@ in default = {}; type = types.attrsOf types.str; - description = '' + description = lib.mdDoc '' An attribute set which contains further attributes of a bar. ''; }; @@ -109,7 +109,7 @@ in options.exec = mkOption { example = "YABAR_DATE"; type = types.str; - description = '' + description = lib.mdDoc '' The type of the indicator to be executed. ''; }; @@ -119,7 +119,7 @@ in example = "right"; type = types.enum [ "left" "center" "right" ]; - description = '' + description = lib.mdDoc '' Whether to align the indicator at the left or right of the bar. ''; }; @@ -128,20 +128,20 @@ in default = {}; type = types.attrsOf (types.either types.str types.int); - description = '' + description = lib.mdDoc '' An attribute set which contains further attributes of a indicator. ''; }; }); - description = '' + description = lib.mdDoc '' Indicators that should be rendered by yabar. ''; }; }; }); - description = '' + description = lib.mdDoc '' List of bars that should be rendered by yabar. ''; }; diff --git a/nixos/modules/programs/zsh/oh-my-zsh.nix b/nixos/modules/programs/zsh/oh-my-zsh.nix index 9d7622bd32873..b253b803edcc1 100644 --- a/nixos/modules/programs/zsh/oh-my-zsh.nix +++ b/nixos/modules/programs/zsh/oh-my-zsh.nix @@ -41,7 +41,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable oh-my-zsh. ''; }; @@ -59,7 +59,7 @@ in plugins = mkOption { default = []; type = types.listOf(types.str); - description = '' + description = lib.mdDoc '' List of oh-my-zsh plugins ''; }; @@ -84,7 +84,7 @@ in theme = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' Name of the theme to be used by oh-my-zsh. ''; }; diff --git a/nixos/modules/programs/zsh/zsh-autosuggestions.nix b/nixos/modules/programs/zsh/zsh-autosuggestions.nix index 2e53e907d547a..b6c36a082e77c 100644 --- a/nixos/modules/programs/zsh/zsh-autosuggestions.nix +++ b/nixos/modules/programs/zsh/zsh-autosuggestions.nix @@ -17,7 +17,7 @@ in highlightStyle = mkOption { type = types.str; default = "fg=8"; # https://github.com/zsh-users/zsh-autosuggestions/tree/v0.4.3#suggestion-highlight-style - description = "Highlight style for suggestions ({fore,back}ground color)"; + description = lib.mdDoc "Highlight style for suggestions ({fore,back}ground color)"; example = "fg=cyan"; }; @@ -40,14 +40,14 @@ in async = mkOption { type = types.bool; default = true; - description = "Whether to fetch suggestions asynchronously"; + description = lib.mdDoc "Whether to fetch suggestions asynchronously"; example = false; }; extraConfig = mkOption { type = with types; attrsOf str; default = {}; - description = "Attribute set with additional configuration values"; + description = lib.mdDoc "Attribute set with additional configuration values"; example = literalExpression '' { "ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE" = "20"; diff --git a/nixos/modules/programs/zsh/zsh-syntax-highlighting.nix b/nixos/modules/programs/zsh/zsh-syntax-highlighting.nix index 1eb53ccae52be..37e1c2ebc384b 100644 --- a/nixos/modules/programs/zsh/zsh-syntax-highlighting.nix +++ b/nixos/modules/programs/zsh/zsh-syntax-highlighting.nix @@ -30,7 +30,7 @@ in "line" ])); - description = '' + description = lib.mdDoc '' Specifies the highlighters to be used by zsh-syntax-highlighting. The following defined options can be found here: @@ -48,7 +48,7 @@ in } ''; - description = '' + description = lib.mdDoc '' Specifies custom patterns to be highlighted by zsh-syntax-highlighting. Please refer to the docs for more information about the usage: @@ -65,7 +65,7 @@ in } ''; - description = '' + description = lib.mdDoc '' Specifies custom styles to be highlighted by zsh-syntax-highlighting. Please refer to the docs for more information about the usage: diff --git a/nixos/modules/programs/zsh/zsh.nix b/nixos/modules/programs/zsh/zsh.nix index 5fe98b6801bbb..0c59d20fee467 100644 --- a/nixos/modules/programs/zsh/zsh.nix +++ b/nixos/modules/programs/zsh/zsh.nix @@ -44,27 +44,27 @@ in enable = mkOption { default = false; - description = '' + description = lib.mdDoc '' Whether to configure zsh as an interactive shell. To enable zsh for - a particular user, use the <option>users.users.<name?>.shell</option> + a particular user, use the {option}`users.users.<name?>.shell` option for that user. To enable zsh system-wide use the - <option>users.defaultUserShell</option> option. + {option}`users.defaultUserShell` option. ''; type = types.bool; }; shellAliases = mkOption { default = { }; - description = '' - Set of aliases for zsh shell, which overrides <option>environment.shellAliases</option>. - See <option>environment.shellAliases</option> for an option format description. + description = lib.mdDoc '' + Set of aliases for zsh shell, which overrides {option}`environment.shellAliases`. + See {option}`environment.shellAliases` for an option format description. ''; type = with types; attrsOf (nullOr (either str path)); }; shellInit = mkOption { default = ""; - description = '' + description = lib.mdDoc '' Shell script code called during zsh shell initialisation. ''; type = types.lines; @@ -72,7 +72,7 @@ in loginShellInit = mkOption { default = ""; - description = '' + description = lib.mdDoc '' Shell script code called during zsh login shell initialisation. ''; type = types.lines; @@ -80,7 +80,7 @@ in interactiveShellInit = mkOption { default = ""; - description = '' + description = lib.mdDoc '' Shell script code called during interactive zsh shell initialisation. ''; type = types.lines; @@ -94,7 +94,7 @@ in # a lot of different prompt variables. autoload -U promptinit && promptinit && prompt suse && setopt prompt_sp ''; - description = '' + description = lib.mdDoc '' Shell script code used to initialise the zsh prompt. ''; type = types.lines; @@ -102,7 +102,7 @@ in histSize = mkOption { default = 2000; - description = '' + description = lib.mdDoc '' Change history size. ''; type = types.int; @@ -110,7 +110,7 @@ in histFile = mkOption { default = "$HOME/.zsh_history"; - description = '' + description = lib.mdDoc '' Change history file. ''; type = types.str; @@ -124,15 +124,15 @@ in "HIST_FCNTL_LOCK" ]; example = [ "EXTENDED_HISTORY" "RM_STAR_WAIT" ]; - description = '' + description = lib.mdDoc '' Configure zsh options. See - <citerefentry><refentrytitle>zshoptions</refentrytitle><manvolnum>1</manvolnum></citerefentry>. + {manpage}`zshoptions(1)`. ''; }; enableCompletion = mkOption { default = true; - description = '' + description = lib.mdDoc '' Enable zsh completion for all interactive zsh shells. ''; type = types.bool; @@ -140,7 +140,7 @@ in enableBashCompletion = mkOption { default = false; - description = '' + description = lib.mdDoc '' Enable compatibility with bash's programmable completion system. ''; type = types.bool; @@ -149,11 +149,11 @@ in enableGlobalCompInit = mkOption { default = cfg.enableCompletion; defaultText = literalExpression "config.${opt.enableCompletion}"; - description = '' + description = lib.mdDoc '' Enable execution of compinit call for all interactive zsh shells. This option can be disabled if the user wants to extend its - <literal>fpath</literal> and a custom <literal>compinit</literal> + `fpath` and a custom `compinit` call in the local config is required. ''; type = types.bool; diff --git a/nixos/modules/security/acme/default.nix b/nixos/modules/security/acme/default.nix index d827c448055b7..54b44dcab62be 100644 --- a/nixos/modules/security/acme/default.nix +++ b/nixos/modules/security/acme/default.nix @@ -445,7 +445,7 @@ let validMinDays = mkOption { type = types.int; inherit (defaultAndText "validMinDays" 30) default defaultText; - description = "Minimum remaining validity before renewal in days."; + description = lib.mdDoc "Minimum remaining validity before renewal in days."; }; renewInterval = mkOption { @@ -466,11 +466,11 @@ let type = types.nullOr types.str; inherit (defaultAndText "webroot" null) default defaultText; example = "/var/lib/acme/acme-challenge"; - description = '' + description = lib.mdDoc '' Where the webroot of the HTTP vhost is located. - <filename>.well-known/acme-challenge/</filename> directory + {file}`.well-known/acme-challenge/` directory will be created below the webroot if it doesn't exist. - <literal>http://example.org/.well-known/acme-challenge/</literal> must also + `http://example.org/.well-known/acme-challenge/` must also be available (notice unencrypted HTTP). ''; }; @@ -478,17 +478,17 @@ let server = mkOption { type = types.nullOr types.str; inherit (defaultAndText "server" null) default defaultText; - description = '' + description = lib.mdDoc '' ACME Directory Resource URI. Defaults to Let's Encrypt's production endpoint, - <link xlink:href="https://acme-v02.api.letsencrypt.org/directory"/>, if unset. + <https://acme-v02.api.letsencrypt.org/directory>, if unset. ''; }; email = mkOption { type = types.str; inherit (defaultAndText "email" null) default defaultText; - description = '' + description = lib.mdDoc '' Email address for account creation and correspondence from the CA. It is recommended to use the same email for all certs to avoid account creation limits. @@ -498,7 +498,7 @@ let group = mkOption { type = types.str; inherit (defaultAndText "group" "acme") default defaultText; - description = "Group running the ACME client."; + description = lib.mdDoc "Group running the ACME client."; }; reloadServices = mkOption { @@ -514,7 +514,7 @@ let type = types.lines; inherit (defaultAndText "postRun" "") default defaultText; example = "cp full.pem backup.pem"; - description = '' + description = lib.mdDoc '' Commands to run after new certificates go live. Note that these commands run as the root user. @@ -525,10 +525,10 @@ let keyType = mkOption { type = types.str; inherit (defaultAndText "keyType" "ec256") default defaultText; - description = '' + description = lib.mdDoc '' Key type to use for private keys. For an up to date list of supported values check the --key-type option - at <link xlink:href="https://go-acme.github.io/lego/usage/cli/#usage"/>. + at <https://go-acme.github.io/lego/usage/cli/#usage>. ''; }; @@ -536,9 +536,9 @@ let type = types.nullOr types.str; inherit (defaultAndText "dnsProvider" null) default defaultText; example = "route53"; - description = '' + description = lib.mdDoc '' DNS Challenge provider. For a list of supported providers, see the "code" - field of the DNS providers listed at <link xlink:href="https://go-acme.github.io/lego/dns/"/>. + field of the DNS providers listed at <https://go-acme.github.io/lego/dns/>. ''; }; @@ -546,7 +546,7 @@ let type = types.nullOr types.str; inherit (defaultAndText "dnsResolver" null) default defaultText; example = "1.1.1.1:53"; - description = '' + description = lib.mdDoc '' Set the resolver to use for performing recursive DNS queries. Supported: host:port. The default is to use the system resolvers, or Google's DNS resolvers if the system's cannot be determined. @@ -556,11 +556,11 @@ let credentialsFile = mkOption { type = types.path; inherit (defaultAndText "credentialsFile" null) default defaultText; - description = '' + description = lib.mdDoc '' Path to an EnvironmentFile for the cert's service containing any required and optional environment variables for your selected dnsProvider. To find out what values you need to set, consult the documentation at - <link xlink:href="https://go-acme.github.io/lego/dns/"/> for the corresponding dnsProvider. + <https://go-acme.github.io/lego/dns/> for the corresponding dnsProvider. ''; example = "/var/src/secrets/example.org-route53-api-token"; }; @@ -568,7 +568,7 @@ let dnsPropagationCheck = mkOption { type = types.bool; inherit (defaultAndText "dnsPropagationCheck" true) default defaultText; - description = '' + description = lib.mdDoc '' Toggles lego DNS propagation check, which is used alongside DNS-01 challenge to ensure the DNS entries required are available. ''; @@ -590,7 +590,7 @@ let extraLegoFlags = mkOption { type = types.listOf types.str; inherit (defaultAndText "extraLegoFlags" []) default defaultText; - description = '' + description = lib.mdDoc '' Additional global flags to pass to all lego commands. ''; }; @@ -598,7 +598,7 @@ let extraLegoRenewFlags = mkOption { type = types.listOf types.str; inherit (defaultAndText "extraLegoRenewFlags" []) default defaultText; - description = '' + description = lib.mdDoc '' Additional flags to pass to lego renew. ''; }; @@ -606,7 +606,7 @@ let extraLegoRunFlags = mkOption { type = types.listOf types.str; inherit (defaultAndText "extraLegoRunFlags" []) default defaultText; - description = '' + description = lib.mdDoc '' Additional flags to pass to lego run. ''; }; @@ -637,13 +637,13 @@ let type = types.str; readOnly = true; default = "/var/lib/acme/${name}"; - description = "Directory where certificate and other state is stored."; + description = lib.mdDoc "Directory where certificate and other state is stored."; }; domain = mkOption { type = types.str; default = name; - description = "Domain to fetch certificate for (defaults to the entry name)."; + description = lib.mdDoc "Domain to fetch certificate for (defaults to the entry name)."; }; extraDomainNames = mkOption { @@ -655,7 +655,7 @@ let "mydomain.org" ] ''; - description = '' + description = lib.mdDoc '' A list of extra domain names, which are included in the one certificate to be issued. ''; }; @@ -667,7 +667,7 @@ let type = types.nullOr types.str; default = null; example = ":1360"; - description = '' + description = lib.mdDoc '' Interface and port to listen on to solve HTTP challenges in the form [INTERFACE]:PORT. If you use a port other than 80, you must proxy port 80 to this port. @@ -690,7 +690,7 @@ in { preliminarySelfsigned = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether a preliminary self-signed certificate should be generated before doing ACME requests. This can be useful when certificates are required in a webserver, but ACME needs the webserver to make its requests. @@ -703,16 +703,16 @@ in { acceptTerms = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Accept the CA's terms of service. The default provider is Let's Encrypt, - you can find their ToS at <link xlink:href="https://letsencrypt.org/repository/"/>. + you can find their ToS at <https://letsencrypt.org/repository/>. ''; }; useRoot = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to use the root user when generating certs. This is not recommended for security + compatiblity reasons. If a service requires root owned certificates consider following the guide on "Using ACME with services demanding root @@ -723,7 +723,7 @@ in { defaults = mkOption { type = types.submodule (inheritableModule true); - description = '' + description = lib.mdDoc '' Default values inheritable by all configured certs. You can use this to define options shared by all your certs. These defaults can also be ignored on a per-cert basis using the @@ -734,9 +734,9 @@ in { certs = mkOption { default = { }; type = with types; attrsOf (submodule [ (inheritableModule false) certOpts ]); - description = '' + description = lib.mdDoc '' Attribute set of certificates to get signed and renewed. Creates - <literal>acme-''${cert}.{service,timer}</literal> systemd units for + `acme-''${cert}.{service,timer}` systemd units for each certificate defined here. Other services can add dependencies to those units if they rely on the certificates being present, or trigger restarts of the service if certificates get renewed. diff --git a/nixos/modules/security/audit.nix b/nixos/modules/security/audit.nix index 2b22bdd9f0ae6..06b4766c8f5a9 100644 --- a/nixos/modules/security/audit.nix +++ b/nixos/modules/security/audit.nix @@ -56,7 +56,7 @@ in { enable = mkOption { type = types.enum [ false true "lock" ]; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the Linux audit system. The special `lock' value can be used to enable auditing and prevent disabling it until a restart. Be careful about locking this, as it will prevent you from changing your audit configuration until you @@ -67,13 +67,13 @@ in { failureMode = mkOption { type = types.enum [ "silent" "printk" "panic" ]; default = "printk"; - description = "How to handle critical errors in the auditing system"; + description = lib.mdDoc "How to handle critical errors in the auditing system"; }; backlogLimit = mkOption { type = types.int; default = 64; # Apparently the kernel default - description = '' + description = lib.mdDoc '' The maximum number of outstanding audit buffers allowed; exceeding this is considered a failure and handled in a manner specified by failureMode. ''; @@ -82,7 +82,7 @@ in { rateLimit = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' The maximum messages per second permitted before triggering a failure as specified by failureMode. Setting it to zero disables the limit. ''; @@ -92,7 +92,7 @@ in { type = types.listOf types.str; # (types.either types.str (types.submodule rule)); default = []; example = [ "-a exit,always -F arch=b64 -S execve" ]; - description = '' + description = lib.mdDoc '' The ordered audit rules, with each string appearing as one line of the audit.rules file. ''; }; diff --git a/nixos/modules/security/ca.nix b/nixos/modules/security/ca.nix index f71d9d90ec5b8..c704e2c1f51c3 100644 --- a/nixos/modules/security/ca.nix +++ b/nixos/modules/security/ca.nix @@ -23,12 +23,12 @@ in type = types.listOf types.path; default = []; example = literalExpression ''[ "''${pkgs.cacert}/etc/ssl/certs/ca-bundle.crt" ]''; - description = '' + description = lib.mdDoc '' A list of files containing trusted root certificates in PEM format. These are concatenated to form - <filename>/etc/ssl/certs/ca-certificates.crt</filename>, which is + {file}`/etc/ssl/certs/ca-certificates.crt`, which is used by many programs that use OpenSSL, such as - <command>curl</command> and <command>git</command>. + {command}`curl` and {command}`git`. ''; }; @@ -47,7 +47,7 @@ in ''' ] ''; - description = '' + description = lib.mdDoc '' A list of trusted root certificates in PEM format. ''; }; @@ -60,10 +60,10 @@ in "CA WoSign ECC Root" "Certification Authority of WoSign G2" ]; - description = '' + description = lib.mdDoc '' A list of blacklisted CA certificate names that won't be imported from the Mozilla Trust Store into - <filename>/etc/ssl/certs/ca-certificates.crt</filename>. Use the + {file}`/etc/ssl/certs/ca-certificates.crt`. Use the names from that file. ''; }; diff --git a/nixos/modules/security/chromium-suid-sandbox.nix b/nixos/modules/security/chromium-suid-sandbox.nix index bb99c053f7185..cab4b9f8d3abf 100644 --- a/nixos/modules/security/chromium-suid-sandbox.nix +++ b/nixos/modules/security/chromium-suid-sandbox.nix @@ -14,7 +14,7 @@ in options.security.chromiumSuidSandbox.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to install the Chromium SUID sandbox which is an executable that Chromium may use in order to achieve sandboxing. diff --git a/nixos/modules/security/dhparams.nix b/nixos/modules/security/dhparams.nix index cfa9003f12fb6..720936e68d72a 100644 --- a/nixos/modules/security/dhparams.nix +++ b/nixos/modules/security/dhparams.nix @@ -15,7 +15,7 @@ let type = bitType; default = cfg.defaultBitSize; defaultText = literalExpression "config.${opt.defaultBitSize}"; - description = '' + description = lib.mdDoc '' The bit size for the prime that is used during a Diffie-Hellman key exchange. ''; @@ -24,11 +24,11 @@ let options.path = mkOption { type = types.path; readOnly = true; - description = '' + description = lib.mdDoc '' The resulting path of the generated Diffie-Hellman parameters file for other services to reference. This could be either a store path or a file inside the directory specified by - <option>security.dhparams.path</option>. + {option}`security.dhparams.path`. ''; }; @@ -45,7 +45,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to generate new DH params and clean up old DH params. ''; }; @@ -101,21 +101,21 @@ in { defaultBitSize = mkOption { type = bitType; default = 2048; - description = '' + description = lib.mdDoc '' This allows to override the default bit size for all of the Diffie-Hellman parameters set in - <option>security.dhparams.params</option>. + {option}`security.dhparams.params`. ''; }; path = mkOption { type = types.str; default = "/var/lib/dhparams"; - description = '' + description = lib.mdDoc '' Path to the directory in which Diffie-Hellman parameters will be stored. This only is relevant if - <option>security.dhparams.stateful</option> is - <literal>true</literal>. + {option}`security.dhparams.stateful` is + `true`. ''; }; }; diff --git a/nixos/modules/security/doas.nix b/nixos/modules/security/doas.nix index 2a814f17e454f..d4b51b406e288 100644 --- a/nixos/modules/security/doas.nix +++ b/nixos/modules/security/doas.nix @@ -53,8 +53,8 @@ in enable = mkOption { type = with types; bool; default = false; - description = '' - Whether to enable the <command>doas</command> command, which allows + description = lib.mdDoc '' + Whether to enable the {command}`doas` command, which allows non-root users to execute commands as root. ''; }; @@ -171,13 +171,13 @@ in users = mkOption { type = with types; listOf (either str int); default = []; - description = "The usernames / UIDs this rule should apply for."; + description = lib.mdDoc "The usernames / UIDs this rule should apply for."; }; groups = mkOption { type = with types; listOf (either str int); default = []; - description = "The groups / GIDs this rule should apply for."; + description = lib.mdDoc "The groups / GIDs this rule should apply for."; }; runAs = mkOption { @@ -223,8 +223,8 @@ in extraConfig = mkOption { type = with types; lines; default = ""; - description = '' - Extra configuration text appended to <filename>doas.conf</filename>. + description = lib.mdDoc '' + Extra configuration text appended to {file}`doas.conf`. ''; }; }; diff --git a/nixos/modules/security/duosec.nix b/nixos/modules/security/duosec.nix index bbe246fe229ec..02b11766b3c09 100644 --- a/nixos/modules/security/duosec.nix +++ b/nixos/modules/security/duosec.nix @@ -36,24 +36,24 @@ in ssh.enable = mkOption { type = types.bool; default = false; - description = "If enabled, protect SSH logins with Duo Security."; + description = lib.mdDoc "If enabled, protect SSH logins with Duo Security."; }; pam.enable = mkOption { type = types.bool; default = false; - description = "If enabled, protect logins with Duo Security using PAM support."; + description = lib.mdDoc "If enabled, protect logins with Duo Security using PAM support."; }; integrationKey = mkOption { type = types.str; - description = "Integration key."; + description = lib.mdDoc "Integration key."; }; secretKeyFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' A file containing your secret key. The security of your Duo application is tied to the security of your secret key. ''; example = "/run/keys/duo-skey"; @@ -61,25 +61,25 @@ in host = mkOption { type = types.str; - description = "Duo API hostname."; + description = lib.mdDoc "Duo API hostname."; }; groups = mkOption { type = types.str; default = ""; example = "users,!wheel,!*admin guests"; - description = '' + description = lib.mdDoc '' If specified, Duo authentication is required only for users whose primary group or supplementary group list matches one of the space-separated pattern lists. Refer to - <link xlink:href="https://duo.com/docs/duounix"/> for details. + <https://duo.com/docs/duounix> for details. ''; }; failmode = mkOption { type = types.enum [ "safe" "secure" ]; default = "safe"; - description = '' + description = lib.mdDoc '' On service or configuration errors that prevent Duo authentication, fail "safe" (allow access) or "secure" (deny access). The default is "safe". @@ -89,7 +89,7 @@ in pushinfo = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Include information such as the command to be executed in the Duo Push message. ''; @@ -98,22 +98,22 @@ in autopush = mkOption { type = types.bool; default = false; - description = '' - If <literal>true</literal>, Duo Unix will automatically send + description = lib.mdDoc '' + If `true`, Duo Unix will automatically send a push login request to the user’s phone, falling back on a phone call if push is unavailable. If - <literal>false</literal>, the user will be prompted to + `false`, the user will be prompted to choose an authentication method. When configured with - <literal>autopush = yes</literal>, we recommend setting - <literal>prompts = 1</literal>. + `autopush = yes`, we recommend setting + `prompts = 1`. ''; }; motd = mkOption { type = types.bool; default = false; - description = '' - Print the contents of <literal>/etc/motd</literal> to screen + description = lib.mdDoc '' + Print the contents of `/etc/motd` to screen after a successful login. ''; }; @@ -121,30 +121,30 @@ in prompts = mkOption { type = types.enum [ 1 2 3 ]; default = 3; - description = '' + description = lib.mdDoc '' If a user fails to authenticate with a second factor, Duo Unix will prompt the user to authenticate again. This option sets the maximum number of prompts that Duo Unix will display before denying access. Must be 1, 2, or 3. Default is 3. - For example, when <literal>prompts = 1</literal>, the user + For example, when `prompts = 1`, the user will have to successfully authenticate on the first prompt, - whereas if <literal>prompts = 2</literal>, if the user + whereas if `prompts = 2`, if the user enters incorrect information at the initial prompt, he/she will be prompted to authenticate again. - When configured with <literal>autopush = true</literal>, we - recommend setting <literal>prompts = 1</literal>. + When configured with `autopush = true`, we + recommend setting `prompts = 1`. ''; }; acceptEnvFactor = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Look for factor selection or passcode in the - <literal>$DUO_PASSCODE</literal> environment variable before + `$DUO_PASSCODE` environment variable before prompting the user for input. When $DUO_PASSCODE is non-empty, it will override @@ -157,11 +157,11 @@ in fallbackLocalIP = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Duo Unix reports the IP address of the authorizing user, for the purposes of authorization and whitelisting. If Duo Unix cannot detect the IP address of the client, setting - <literal>fallbackLocalIP = yes</literal> will cause Duo Unix + `fallbackLocalIP = yes` will cause Duo Unix to send the IP address of the server it is running on. If you are using IP whitelisting, enabling this option could @@ -173,7 +173,7 @@ in allowTcpForwarding = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' By default, when SSH forwarding, enabling Duo Security will disable TCP forwarding. By enabling this, you potentially undermine some of the SSH based login security. Note this is diff --git a/nixos/modules/security/google_oslogin.nix b/nixos/modules/security/google_oslogin.nix index cf416035ef60c..f75b4df1851a5 100644 --- a/nixos/modules/security/google_oslogin.nix +++ b/nixos/modules/security/google_oslogin.nix @@ -16,7 +16,7 @@ in security.googleOsLogin.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable Google OS Login. The OS Login package enables the following components: diff --git a/nixos/modules/security/misc.nix b/nixos/modules/security/misc.nix index c20e067b8cc78..3c83ff8d77397 100644 --- a/nixos/modules/security/misc.nix +++ b/nixos/modules/security/misc.nix @@ -15,7 +15,7 @@ with lib; security.allowUserNamespaces = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to allow creation of user namespaces. The motivation for disabling user namespaces is the potential @@ -34,7 +34,7 @@ with lib; security.unprivilegedUsernsClone = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' When disabled, unprivileged users will not be able to create new namespaces. By default unprivileged user namespaces are disabled. This option only works in a hardened profile. @@ -44,7 +44,7 @@ with lib; security.protectKernelImage = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to prevent replacing the running kernel image. ''; }; @@ -71,7 +71,7 @@ with lib; security.forcePageTableIsolation = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to force-enable the Page Table Isolation (PTI) Linux kernel feature even on CPU models that claim to be safe from Meltdown. diff --git a/nixos/modules/security/oath.nix b/nixos/modules/security/oath.nix index 93bdc851117ae..3342866538464 100644 --- a/nixos/modules/security/oath.nix +++ b/nixos/modules/security/oath.nix @@ -11,7 +11,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the OATH (one-time password) PAM module. ''; }; @@ -19,7 +19,7 @@ with lib; digits = mkOption { type = types.enum [ 6 7 8 ]; default = 6; - description = '' + description = lib.mdDoc '' Specify the length of the one-time password in number of digits. ''; @@ -28,7 +28,7 @@ with lib; window = mkOption { type = types.int; default = 5; - description = '' + description = lib.mdDoc '' Specify the number of one-time passwords to check in order to accommodate for situations where the system and the client are slightly out of sync (iteration for HOTP or time @@ -39,7 +39,7 @@ with lib; usersFile = mkOption { type = types.path; default = "/etc/users.oath"; - description = '' + description = lib.mdDoc '' Set the path to file where the user's credentials are stored. This file must not be world readable! ''; diff --git a/nixos/modules/security/pam.nix b/nixos/modules/security/pam.nix index 16f4193d3bcec..7903d333411bd 100644 --- a/nixos/modules/security/pam.nix +++ b/nixos/modules/security/pam.nix @@ -15,24 +15,24 @@ let name = mkOption { example = "sshd"; type = types.str; - description = "Name of the PAM service."; + description = lib.mdDoc "Name of the PAM service."; }; unixAuth = mkOption { default = true; type = types.bool; - description = '' + description = lib.mdDoc '' Whether users can log in with passwords defined in - <filename>/etc/shadow</filename>. + {file}`/etc/shadow`. ''; }; rootOK = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If set, root doesn't need to authenticate (e.g. for the - <command>useradd</command> service). + {command}`useradd` service). ''; }; @@ -40,10 +40,10 @@ let default = config.security.pam.p11.enable; defaultText = literalExpression "config.security.pam.p11.enable"; type = types.bool; - description = '' + description = lib.mdDoc '' If set, keys listed in - <filename>~/.ssh/authorized_keys</filename> and - <filename>~/.eid/authorized_certificates</filename> + {file}`~/.ssh/authorized_keys` and + {file}`~/.eid/authorized_certificates` can be used to log in with the associated PKCS#11 tokens. ''; }; @@ -52,24 +52,24 @@ let default = config.security.pam.u2f.enable; defaultText = literalExpression "config.security.pam.u2f.enable"; type = types.bool; - description = '' + description = lib.mdDoc '' If set, users listed in - <filename>$XDG_CONFIG_HOME/Yubico/u2f_keys</filename> (or - <filename>$HOME/.config/Yubico/u2f_keys</filename> if XDG variable is + {file}`$XDG_CONFIG_HOME/Yubico/u2f_keys` (or + {file}`$HOME/.config/Yubico/u2f_keys` if XDG variable is not set) are able to log in with the associated U2F key. Path can be - changed using <option>security.pam.u2f.authFile</option> option. + changed using {option}`security.pam.u2f.authFile` option. ''; }; usshAuth = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If set, users with an SSH certificate containing an authorized principal in their SSH agent are able to log in. Specific options are controlled - using the <option>security.pam.ussh</option> options. + using the {option}`security.pam.ussh` options. - Note that the <option>security.pam.ussh.enable</option> must also be + Note that the {option}`security.pam.ussh.enable` must also be set for this option to take effect. ''; }; @@ -78,9 +78,9 @@ let default = config.security.pam.yubico.enable; defaultText = literalExpression "config.security.pam.yubico.enable"; type = types.bool; - description = '' + description = lib.mdDoc '' If set, users listed in - <filename>~/.yubico/authorized_yubikeys</filename> + {file}`~/.yubico/authorized_yubikeys` are able to log in with the associated Yubikey tokens. ''; }; @@ -89,9 +89,9 @@ let enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If set, users with enabled Google Authenticator (created - <filename>~/.google_authenticator</filename>) will be required + {file}`~/.google_authenticator`) will be required to provide Google Authenticator token to log in. ''; }; @@ -101,9 +101,9 @@ let default = config.security.pam.usb.enable; defaultText = literalExpression "config.security.pam.usb.enable"; type = types.bool; - description = '' + description = lib.mdDoc '' If set, users listed in - <filename>/etc/pamusb.conf</filename> are able to log in + {file}`/etc/pamusb.conf` are able to log in with the associated USB key. ''; }; @@ -112,21 +112,21 @@ let default = config.security.pam.enableOTPW; defaultText = literalExpression "config.security.pam.enableOTPW"; type = types.bool; - description = '' + description = lib.mdDoc '' If set, the OTPW system will be used (if - <filename>~/.otpw</filename> exists). + {file}`~/.otpw` exists). ''; }; googleOsLoginAccountVerification = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If set, will use the Google OS Login PAM modules - (<literal>pam_oslogin_login</literal>, - <literal>pam_oslogin_admin</literal>) to verify possible OS Login + (`pam_oslogin_login`, + `pam_oslogin_admin`) to verify possible OS Login users and set sudoers configuration accordingly. - This only makes sense to enable for the <literal>sshd</literal> PAM + This only makes sense to enable for the `sshd` PAM service. ''; }; @@ -134,10 +134,10 @@ let googleOsLoginAuthentication = mkOption { default = false; type = types.bool; - description = '' - If set, will use the <literal>pam_oslogin_login</literal>'s user + description = lib.mdDoc '' + If set, will use the `pam_oslogin_login`'s user authentication methods to authenticate users using 2FA. - This only makes sense to enable for the <literal>sshd</literal> PAM + This only makes sense to enable for the `sshd` PAM service. ''; }; @@ -146,7 +146,7 @@ let default = config.services.fprintd.enable; defaultText = literalExpression "config.services.fprintd.enable"; type = types.bool; - description = '' + description = lib.mdDoc '' If set, fingerprint reader will be used (if exists and your fingerprints are enrolled). ''; @@ -156,7 +156,7 @@ let default = config.security.pam.oath.enable; defaultText = literalExpression "config.security.pam.oath.enable"; type = types.bool; - description = '' + description = lib.mdDoc '' If set, the OATH Toolkit will be used. ''; }; @@ -164,11 +164,11 @@ let sshAgentAuth = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If set, the calling user's SSH agent is used to authenticate against the keys in the calling user's - <filename>~/.ssh/authorized_keys</filename>. This is useful - for <command>sudo</command> on password-less remote systems. + {file}`~/.ssh/authorized_keys`. This is useful + for {command}`sudo` on password-less remote systems. ''; }; @@ -176,10 +176,10 @@ let enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If set, use the Duo Security pam module - <literal>pam_duo</literal> for authentication. Requires - configuration of <option>security.duosec</option> options. + `pam_duo` for authentication. Requires + configuration of {option}`security.duosec` options. ''; }; }; @@ -187,7 +187,7 @@ let startSession = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If set, the service will register a new session with systemd's login manager. For local sessions, this will give the user access to audio devices, CD-ROM drives. In the @@ -199,21 +199,21 @@ let setEnvironment = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether the service should set the environment variables - listed in <option>environment.sessionVariables</option> - using <literal>pam_env.so</literal>. + listed in {option}`environment.sessionVariables` + using `pam_env.so`. ''; }; setLoginUid = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Set the login uid of the process - (<filename>/proc/self/loginuid</filename>) for auditing + ({file}`/proc/self/loginuid`) for auditing purposes. The login uid is only set by ‘entry points’ like - <command>login</command> and <command>sshd</command>, not by - commands like <command>sudo</command>. + {command}`login` and {command}`sshd`, not by + commands like {command}`sudo`. ''; }; @@ -221,7 +221,7 @@ let enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable or disable TTY auditing for specified users ''; }; @@ -229,7 +229,7 @@ let enablePattern = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' For each user matching one of comma-separated glob patterns, enable TTY auditing ''; @@ -238,7 +238,7 @@ let disablePattern = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' For each user matching one of comma-separated glob patterns, disable TTY auditing ''; @@ -247,7 +247,7 @@ let openOnly = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Set the TTY audit flag when opening the session, but do not restore it when closing the session. Using this option is necessary for some services @@ -260,10 +260,10 @@ let forwardXAuth = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether X authentication keys should be passed from the calling user to the target user (e.g. for - <command>su</command>) + {command}`su`) ''; }; @@ -271,7 +271,7 @@ let default = config.security.pam.mount.enable; defaultText = literalExpression "config.security.pam.mount.enable"; type = types.bool; - description = '' + description = lib.mdDoc '' Enable PAM mount (pam_mount) system to mount fileystems on user login. ''; }; @@ -279,13 +279,13 @@ let allowNullPassword = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to allow logging into accounts that have no password set (i.e., have an empty password field in - <filename>/etc/passwd</filename> or - <filename>/etc/group</filename>). This does not enable + {file}`/etc/passwd` or + {file}`/etc/group`). This does not enable logging into disabled accounts (i.e., that have the password - field set to <literal>!</literal>). Note that regardless of + field set to `!`). Note that regardless of what the pam_unix documentation says, accounts with hashed empty passwords are always allowed to log in. ''; @@ -294,7 +294,7 @@ let nodelay = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Wheather the delay after typing a wrong password should be disabled. ''; }; @@ -302,7 +302,7 @@ let requireWheel = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to permit root access only to members of group wheel. ''; }; @@ -322,15 +322,15 @@ let showMotd = mkOption { default = false; type = types.bool; - description = "Whether to show the message of the day."; + description = lib.mdDoc "Whether to show the message of the day."; }; makeHomeDir = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to try to create home directories for users - with <literal>$HOME</literal>s pointing to nonexistent + with `$HOME`s pointing to nonexistent locations on session login. ''; }; @@ -338,19 +338,19 @@ let updateWtmp = mkOption { default = false; type = types.bool; - description = "Whether to update <filename>/var/log/wtmp</filename>."; + description = lib.mdDoc "Whether to update {file}`/var/log/wtmp`."; }; logFailures = mkOption { default = false; type = types.bool; - description = "Whether to log authentication failures in <filename>/var/log/faillog</filename>."; + description = lib.mdDoc "Whether to log authentication failures in {file}`/var/log/faillog`."; }; enableAppArmor = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable support for attaching AppArmor profiles at the user/group level, e.g., as part of a role based access control scheme. @@ -360,7 +360,7 @@ let enableKwallet = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If enabled, pam_wallet will attempt to automatically unlock the user's default KDE wallet upon login. If the user has no wallet named "kdewallet", or the login password does not match their wallet @@ -370,13 +370,13 @@ let sssdStrictAccess = mkOption { default = false; type = types.bool; - description = "enforce sssd access control"; + description = lib.mdDoc "enforce sssd access control"; }; enableGnomeKeyring = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If enabled, pam_gnome_keyring will attempt to automatically unlock the user's default Gnome keyring upon login. If the user login password does not match their keyring password, Gnome Keyring will prompt separately @@ -388,24 +388,24 @@ let enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If enabled, pam_gnupg will attempt to automatically unlock the user's GPG keys with the login password via - <command>gpg-agent</command>. The keygrips of all keys to be - unlocked should be written to <filename>~/.pam-gnupg</filename>, - and can be queried with <command>gpg -K --with-keygrip</command>. + {command}`gpg-agent`. The keygrips of all keys to be + unlocked should be written to {file}`~/.pam-gnupg`, + and can be queried with {command}`gpg -K --with-keygrip`. Presetting passphrases must be enabled by adding - <literal>allow-preset-passphrase</literal> in - <filename>~/.gnupg/gpg-agent.conf</filename>. + `allow-preset-passphrase` in + {file}`~/.gnupg/gpg-agent.conf`. ''; }; noAutostart = mkOption { type = types.bool; default = false; - description = '' - Don't start <command>gpg-agent</command> if it is not running. - Useful in conjunction with starting <command>gpg-agent</command> as + description = lib.mdDoc '' + Don't start {command}`gpg-agent` if it is not running. + Useful in conjunction with starting {command}`gpg-agent` as a systemd user service. ''; }; @@ -413,16 +413,16 @@ let storeOnly = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Don't send the password immediately after login, but store for PAM - <literal>session</literal>. + `session`. ''; }; }; text = mkOption { type = types.nullOr types.lines; - description = "Contents of the PAM service file."; + description = lib.mdDoc "Contents of the PAM service file."; }; }; @@ -673,19 +673,19 @@ let limitsType = with lib.types; listOf (submodule ({ ... }: { options = { domain = mkOption { - description = "Username, groupname, or wildcard this limit applies to"; + description = lib.mdDoc "Username, groupname, or wildcard this limit applies to"; example = "@wheel"; type = str; }; type = mkOption { - description = "Type of this limit"; + description = lib.mdDoc "Type of this limit"; type = enum [ "-" "hard" "soft" ]; default = "-"; }; item = mkOption { - description = "Item this limit applies to"; + description = lib.mdDoc "Item this limit applies to"; type = enum [ "core" "data" @@ -709,7 +709,7 @@ let }; value = mkOption { - description = "Value of this limit"; + description = lib.mdDoc "Value of this limit"; type = oneOf [ str int ]; }; }; @@ -769,10 +769,10 @@ in default = {}; type = with types; attrsOf (submodule pamOpts); description = - '' + lib.mdDoc '' This option defines the PAM services. A service typically corresponds to a program that uses PAM, - e.g. <command>login</command> or <command>passwd</command>. + e.g. {command}`login` or {command}`passwd`. Each attribute of this set defines a PAM service, with the attribute name defining the name of the service. ''; @@ -782,9 +782,9 @@ in type = types.str; default = "/var/empty"; example = "/etc/skel"; - description = '' + description = lib.mdDoc '' Path to skeleton directory whose contents are copied to home - directories newly created by <literal>pam_mkhomedir</literal>. + directories newly created by `pam_mkhomedir`. ''; }; @@ -792,9 +792,9 @@ in type = types.bool; default = false; description = - '' + lib.mdDoc '' Enable sudo logins if the user's SSH agent provides a key - present in <filename>~/.ssh/authorized_keys</filename>. + present in {file}`~/.ssh/authorized_keys`. This allows machines to exclusively use SSH keys instead of passwords. ''; @@ -953,7 +953,7 @@ in debug = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Debug output to stderr. ''; }; @@ -961,7 +961,7 @@ in interactive = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Set to prompt a message and wait before testing the presence of a U2F device. Recommended if your device doesn’t have a tactile trigger. ''; @@ -970,12 +970,12 @@ in cue = mkOption { default = false; type = types.bool; - description = '' - By default <literal>pam-u2f</literal> module does not inform user + description = lib.mdDoc '' + By default `pam-u2f` module does not inform user that he needs to use the u2f device, it just waits without a prompt. - If you set this option to <literal>true</literal>, - <literal>cue</literal> option is added to <literal>pam-u2f</literal> + If you set this option to `true`, + `cue` option is added to `pam-u2f` module and reminder message will be displayed. ''; }; @@ -1003,11 +1003,11 @@ in caFile = mkOption { default = null; type = with types; nullOr path; - description = '' - By default <literal>pam-ussh</literal> reads the trusted user CA keys - from <filename>/etc/ssh/trusted_user_ca</filename>. + description = lib.mdDoc '' + By default `pam-ussh` reads the trusted user CA keys + from {file}`/etc/ssh/trusted_user_ca`. - This should be set the same as your <literal>TrustedUserCAKeys</literal> + This should be set the same as your `TrustedUserCAKeys` option for sshd. ''; }; @@ -1015,38 +1015,38 @@ in authorizedPrincipals = mkOption { default = null; type = with types; nullOr commas; - description = '' + description = lib.mdDoc '' Comma-separated list of authorized principals to permit; if the user presents a certificate with one of these principals, then they will be authorized. - Note that <literal>pam-ussh</literal> also requires that the certificate + Note that `pam-ussh` also requires that the certificate contain a principal matching the user's username. The principals from this list are in addition to those principals. - Mutually exclusive with <literal>authorizedPrincipalsFile</literal>. + Mutually exclusive with `authorizedPrincipalsFile`. ''; }; authorizedPrincipalsFile = mkOption { default = null; type = with types; nullOr path; - description = '' + description = lib.mdDoc '' Path to a list of principals; if the user presents a certificate with one of these principals, then they will be authorized. - Note that <literal>pam-ussh</literal> also requires that the certificate + Note that `pam-ussh` also requires that the certificate contain a principal matching the user's username. The principals from this file are in addition to those principals. - Mutually exclusive with <literal>authorizedPrincipals</literal>. + Mutually exclusive with `authorizedPrincipals`. ''; }; group = mkOption { default = null; type = with types; nullOr str; - description = '' + description = lib.mdDoc '' If set, then the authenticating user must be a member of this group to use this module. ''; @@ -1107,13 +1107,13 @@ in id = mkOption { example = "42"; type = types.str; - description = "client id"; + description = lib.mdDoc "client id"; }; debug = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Debug output to stderr. ''; }; @@ -1152,7 +1152,7 @@ in default = null; example = "Today is Sweetmorn, the 4th day of The Aftermath in the YOLD 3178."; type = types.nullOr types.lines; - description = "Message of the day shown to users when they log in."; + description = lib.mdDoc "Message of the day shown to users when they log in."; }; }; diff --git a/nixos/modules/security/pam_mount.nix b/nixos/modules/security/pam_mount.nix index 1d0efee8ca8ee..e159a73b66a46 100644 --- a/nixos/modules/security/pam_mount.nix +++ b/nixos/modules/security/pam_mount.nix @@ -23,7 +23,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable PAM mount system to mount fileystems on user login. ''; }; @@ -42,7 +42,7 @@ in type = types.listOf types.package; default = []; example = literalExpression "[ pkgs.bindfs ]"; - description = '' + description = lib.mdDoc '' Additional programs to include in the search path of pam_mount. Useful for example if you want to use some FUSE filesystems like bindfs. ''; @@ -54,7 +54,7 @@ in example = literalExpression '' [ "nodev" "nosuid" "force-user=%(USER)" "gid=%(USERGID)" "perms=0700" "chmod-deny" "chown-deny" "chgrp-deny" ] ''; - description = '' + description = lib.mdDoc '' Global mount options that apply to every FUSE volume. You can define volume-specific options in the volume definitions. ''; @@ -86,7 +86,7 @@ in logoutHup = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Kill remaining processes after logout by sending a SIGHUP. ''; }; @@ -94,7 +94,7 @@ in logoutTerm = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Kill remaining processes after logout by sending a SIGTERM. ''; }; @@ -102,7 +102,7 @@ in logoutKill = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Kill remaining processes after logout by sending a SIGKILL. ''; }; @@ -110,7 +110,7 @@ in createMountPoints = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Create mountpoints for volumes if they do not exist. ''; }; @@ -118,7 +118,7 @@ in removeCreatedMountPoints = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Remove mountpoints created by pam_mount after logout. This only affects mountpoints that have been created by pam_mount in the same session. diff --git a/nixos/modules/security/rtkit.nix b/nixos/modules/security/rtkit.nix index ad8746808e85e..0f58b4dce84a2 100644 --- a/nixos/modules/security/rtkit.nix +++ b/nixos/modules/security/rtkit.nix @@ -12,7 +12,7 @@ with lib; security.rtkit.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the RealtimeKit system service, which hands out realtime scheduling priority to user processes on demand. For example, the PulseAudio server uses this to diff --git a/nixos/modules/security/sudo.nix b/nixos/modules/security/sudo.nix index 4bf239fca8f90..2e30a8915d865 100644 --- a/nixos/modules/security/sudo.nix +++ b/nixos/modules/security/sudo.nix @@ -36,8 +36,8 @@ in type = types.bool; default = true; description = - '' - Whether to enable the <command>sudo</command> command, which + lib.mdDoc '' + Whether to enable the {command}`sudo` command, which allows non-root users to execute commands as root. ''; }; @@ -77,15 +77,15 @@ in # Note: if syntax errors are detected in this file, the NixOS # configuration will fail to build. description = - '' + lib.mdDoc '' This string contains the contents of the - <filename>sudoers</filename> file. + {file}`sudoers` file. ''; }; security.sudo.extraRules = mkOption { - description = '' - Define specific rules to be in the <filename>sudoers</filename> file. + description = lib.mdDoc '' + Define specific rules to be in the {file}`sudoers` file. More specific rules should come after more general ones in order to yield the expected behavior. You can use mkBefore/mkAfter to ensure this is the case when configuration options are merged. @@ -114,7 +114,7 @@ in options = { users = mkOption { type = with types; listOf (either str int); - description = '' + description = lib.mdDoc '' The usernames / UIDs this rule should apply for. ''; default = []; @@ -122,7 +122,7 @@ in groups = mkOption { type = with types; listOf (either str int); - description = '' + description = lib.mdDoc '' The groups / GIDs this rule should apply for. ''; default = []; @@ -131,7 +131,7 @@ in host = mkOption { type = types.str; default = "ALL"; - description = '' + description = lib.mdDoc '' For what host this rule should apply. ''; }; @@ -149,7 +149,7 @@ in }; commands = mkOption { - description = '' + description = lib.mdDoc '' The commands for which the rule should apply. ''; type = with types; listOf (either str (submodule { @@ -182,8 +182,8 @@ in security.sudo.extraConfig = mkOption { type = types.lines; default = ""; - description = '' - Extra configuration text appended to <filename>sudoers</filename>. + description = lib.mdDoc '' + Extra configuration text appended to {file}`sudoers`. ''; }; }; diff --git a/nixos/modules/security/tpm2.nix b/nixos/modules/security/tpm2.nix index be85fd246e3cc..375f4af1a64f2 100644 --- a/nixos/modules/security/tpm2.nix +++ b/nixos/modules/security/tpm2.nix @@ -20,7 +20,7 @@ in { enable = lib.mkEnableOption "Trusted Platform Module 2 support"; tssUser = lib.mkOption { - description = '' + description = lib.mdDoc '' Name of the tpm device-owner and service user, set if applyUdevRules is set. ''; @@ -30,7 +30,7 @@ in { }; tssGroup = lib.mkOption { - description = '' + description = lib.mdDoc '' Group of the tpm kernel resource manager (tpmrm) device-group, set if applyUdevRules is set. ''; @@ -39,7 +39,7 @@ in { }; applyUdevRules = lib.mkOption { - description = '' + description = lib.mdDoc '' Whether to make the /dev/tpm[0-9] devices accessible by the tssUser, or the /dev/tpmrm[0-9] by tssGroup respectively ''; @@ -53,7 +53,7 @@ in { ''; package = lib.mkOption { - description = "tpm2-abrmd package to use"; + description = lib.mdDoc "tpm2-abrmd package to use"; type = lib.types.package; default = pkgs.tpm2-abrmd; defaultText = lib.literalExpression "pkgs.tpm2-abrmd"; @@ -67,7 +67,7 @@ in { ''; package = lib.mkOption { - description = "tpm2-pkcs11 package to use"; + description = lib.mdDoc "tpm2-pkcs11 package to use"; type = lib.types.package; default = pkgs.tpm2-pkcs11; defaultText = lib.literalExpression "pkgs.tpm2-pkcs11"; @@ -97,7 +97,7 @@ in { }; interface = lib.mkOption { - description = '' + description = lib.mdDoc '' The name of the TPM command transmission interface (TCTI) library to use. ''; @@ -106,24 +106,24 @@ in { }; deviceConf = lib.mkOption { - description = '' + description = lib.mdDoc '' Configuration part of the device TCTI, e.g. the path to the TPM device. Applies if interface is set to "device". The format is specified in the - <link xlink:href="https://github.com/tpm2-software/tpm2-tools/blob/master/man/common/tcti.md#tcti-options"> - tpm2-tools repository</link>. + [ + tpm2-tools repository](https://github.com/tpm2-software/tpm2-tools/blob/master/man/common/tcti.md#tcti-options). ''; type = lib.types.str; default = "/dev/tpmrm0"; }; tabrmdConf = lib.mkOption { - description = '' + description = lib.mdDoc '' Configuration part of the tabrmd TCTI, like the D-Bus bus name. Applies if interface is set to "tabrmd". The format is specified in the - <link xlink:href="https://github.com/tpm2-software/tpm2-tools/blob/master/man/common/tcti.md#tcti-options"> - tpm2-tools repository</link>. + [ + tpm2-tools repository](https://github.com/tpm2-software/tpm2-tools/blob/master/man/common/tcti.md#tcti-options). ''; type = lib.types.str; default = "bus_name=com.intel.tss2.Tabrmd"; diff --git a/nixos/modules/security/wrappers/default.nix b/nixos/modules/security/wrappers/default.nix index 169ef7442626e..cdf99e697f6f2 100644 --- a/nixos/modules/security/wrappers/default.nix +++ b/nixos/modules/security/wrappers/default.nix @@ -22,30 +22,30 @@ let wrapperType = lib.types.submodule ({ name, config, ... }: { options.source = lib.mkOption { type = lib.types.path; - description = "The absolute path to the program to be wrapped."; + description = lib.mdDoc "The absolute path to the program to be wrapped."; }; options.program = lib.mkOption { type = with lib.types; nullOr str; default = name; - description = '' + description = lib.mdDoc '' The name of the wrapper program. Defaults to the attribute name. ''; }; options.owner = lib.mkOption { type = lib.types.str; - description = "The owner of the wrapper program."; + description = lib.mdDoc "The owner of the wrapper program."; }; options.group = lib.mkOption { type = lib.types.str; - description = "The group of the wrapper program."; + description = lib.mdDoc "The group of the wrapper program."; }; options.permissions = lib.mkOption { type = fileModeType; default = "u+rx,g+x,o+x"; example = "a+rx"; - description = '' + description = lib.mdDoc '' The permissions of the wrapper program. The format is that of a - symbolic or numeric file mode understood by <command>chmod</command>. + symbolic or numeric file mode understood by {command}`chmod`. ''; }; options.capabilities = lib.mkOption @@ -73,12 +73,12 @@ let options.setuid = lib.mkOption { type = lib.types.bool; default = false; - description = "Whether to add the setuid bit the wrapper program."; + description = lib.mdDoc "Whether to add the setuid bit the wrapper program."; }; options.setgid = lib.mkOption { type = lib.types.bool; default = false; - description = "Whether to add the setgid bit the wrapper program."; + description = lib.mdDoc "Whether to add the setgid bit the wrapper program."; }; }); @@ -179,12 +179,12 @@ in }; } ''; - description = '' + description = lib.mdDoc '' This option effectively allows adding setuid/setgid bits, capabilities, changing file ownership and permissions of a program without directly modifying it. This works by creating a wrapper program under the - <option>security.wrapperDir</option> directory, which is then added to - the shell <literal>PATH</literal>. + {option}`security.wrapperDir` directory, which is then added to + the shell `PATH`. ''; }; diff --git a/nixos/modules/services/admin/meshcentral.nix b/nixos/modules/services/admin/meshcentral.nix index 92762d2037c32..e1df39716d479 100644 --- a/nixos/modules/services/admin/meshcentral.nix +++ b/nixos/modules/services/admin/meshcentral.nix @@ -7,7 +7,7 @@ in with lib; { options.services.meshcentral = with types; { enable = mkEnableOption "MeshCentral computer management server"; package = mkOption { - description = "MeshCentral package to use. Replacing this may be necessary to add dependencies for extra functionality."; + description = lib.mdDoc "MeshCentral package to use. Replacing this may be necessary to add dependencies for extra functionality."; type = types.package; default = pkgs.meshcentral; defaultText = literalExpression "pkgs.meshcentral"; diff --git a/nixos/modules/services/admin/oxidized.nix b/nixos/modules/services/admin/oxidized.nix index 49ea3ced76a4b..f0d46f787b7c5 100644 --- a/nixos/modules/services/admin/oxidized.nix +++ b/nixos/modules/services/admin/oxidized.nix @@ -12,7 +12,7 @@ in user = mkOption { type = types.str; default = "oxidized"; - description = '' + description = lib.mdDoc '' User under which the oxidized service runs. ''; }; @@ -20,7 +20,7 @@ in group = mkOption { type = types.str; default = "oxidized"; - description = '' + description = lib.mdDoc '' Group under which the oxidized service runs. ''; }; @@ -28,7 +28,7 @@ in dataDir = mkOption { type = types.path; default = "/var/lib/oxidized"; - description = "State directory for the oxidized service."; + description = lib.mdDoc "State directory for the oxidized service."; }; configFile = mkOption { @@ -62,7 +62,7 @@ in # ... additional config '''; ''; - description = '' + description = lib.mdDoc '' Path to the oxidized configuration file. ''; }; @@ -76,7 +76,7 @@ in # ... additional hosts ''' ''; - description = '' + description = lib.mdDoc '' Path to the file/database which contains the targets for oxidized. ''; }; diff --git a/nixos/modules/services/admin/pgadmin.nix b/nixos/modules/services/admin/pgadmin.nix index 80b6814541045..aff25bcb68bec 100644 --- a/nixos/modules/services/admin/pgadmin.nix +++ b/nixos/modules/services/admin/pgadmin.nix @@ -31,18 +31,18 @@ in enable = mkEnableOption "PostgreSQL Admin 4"; port = mkOption { - description = "Port for pgadmin4 to run on"; + description = lib.mdDoc "Port for pgadmin4 to run on"; type = types.port; default = 5050; }; initialEmail = mkOption { - description = "Initial email for the pgAdmin account."; + description = lib.mdDoc "Initial email for the pgAdmin account."; type = types.str; }; initialPasswordFile = mkOption { - description = '' + description = lib.mdDoc '' Initial password file for the pgAdmin account. NOTE: Should be string not a store path, to prevent the password from being world readable. ''; @@ -52,9 +52,9 @@ in openFirewall = mkEnableOption "firewall passthrough for pgadmin4"; settings = mkOption { - description = '' + description = lib.mdDoc '' Settings for pgadmin4. - <link xlink:href="https://www.pgadmin.org/docs/pgadmin4/development/config_py.html">Documentation</link>. + [Documentation](https://www.pgadmin.org/docs/pgadmin4/development/config_py.html). ''; type = pyType; default= {}; diff --git a/nixos/modules/services/admin/salt/master.nix b/nixos/modules/services/admin/salt/master.nix index a3069c81c19ae..3c246a9423995 100644 --- a/nixos/modules/services/admin/salt/master.nix +++ b/nixos/modules/services/admin/salt/master.nix @@ -24,7 +24,7 @@ in configuration = mkOption { type = types.attrs; default = {}; - description = "Salt master configuration as Nix attribute set."; + description = lib.mdDoc "Salt master configuration as Nix attribute set."; }; }; }; diff --git a/nixos/modules/services/admin/salt/minion.nix b/nixos/modules/services/admin/salt/minion.nix index ac124c570d8d4..165ec8ef96b3a 100644 --- a/nixos/modules/services/admin/salt/minion.nix +++ b/nixos/modules/services/admin/salt/minion.nix @@ -25,9 +25,9 @@ in configuration = mkOption { type = types.attrs; default = {}; - description = '' + description = lib.mdDoc '' Salt minion configuration as Nix attribute set. - See <link xlink:href="https://docs.saltstack.com/en/latest/ref/configuration/minion.html"/> + See <https://docs.saltstack.com/en/latest/ref/configuration/minion.html> for details. ''; }; diff --git a/nixos/modules/services/amqp/activemq/default.nix b/nixos/modules/services/amqp/activemq/default.nix index 47669b05aa91b..bd37fe3b55742 100644 --- a/nixos/modules/services/amqp/activemq/default.nix +++ b/nixos/modules/services/amqp/activemq/default.nix @@ -27,7 +27,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the Apache ActiveMQ message broker service. ''; }; @@ -35,7 +35,7 @@ in { default = "${activemq}/conf"; defaultText = literalExpression ''"''${pkgs.activemq}/conf"''; type = types.str; - description = '' + description = lib.mdDoc '' The base directory for ActiveMQ's configuration. By default, this directory is searched for a file named activemq.xml, which should contain the configuration for the broker service. @@ -44,21 +44,21 @@ in { configurationURI = mkOption { type = types.str; default = "xbean:activemq.xml"; - description = '' + description = lib.mdDoc '' The URI that is passed along to the BrokerFactory to set up the configuration of the ActiveMQ broker service. You should not need to change this. For custom configuration, - set the <literal>configurationDir</literal> instead, and create + set the `configurationDir` instead, and create an activemq.xml configuration file in it. ''; }; baseDir = mkOption { type = types.str; default = "/var/activemq"; - description = '' + description = lib.mdDoc '' The base directory where ActiveMQ stores its persistent data and logs. This will be overridden if you set "activemq.base" and "activemq.data" - in the <literal>javaProperties</literal> option. You can also override + in the `javaProperties` option. You can also override this in activemq.xml. ''; }; @@ -76,7 +76,7 @@ in { "activemq.conf" = "${cfg.configurationDir}"; "activemq.home" = "${activemq}"; } // attrs; - description = '' + description = lib.mdDoc '' Specifies Java properties that are sent to the ActiveMQ broker service with the "-D" option. You can set properties here to change the behaviour and configuration of the broker. @@ -88,7 +88,7 @@ in { type = types.separatedString " "; default = ""; example = "-Xmx2G -Xms2G -XX:MaxPermSize=512M"; - description = '' + description = lib.mdDoc '' Add extra options here that you want to be sent to the Java runtime when the broker service is started. ''; diff --git a/nixos/modules/services/amqp/rabbitmq.nix b/nixos/modules/services/amqp/rabbitmq.nix index 3255942fe4386..9d3243722d627 100644 --- a/nixos/modules/services/amqp/rabbitmq.nix +++ b/nixos/modules/services/amqp/rabbitmq.nix @@ -20,7 +20,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the RabbitMQ server, an Advanced Message Queuing Protocol (AMQP) broker. ''; @@ -30,7 +30,7 @@ in default = pkgs.rabbitmq-server; type = types.package; defaultText = literalExpression "pkgs.rabbitmq-server"; - description = '' + description = lib.mdDoc '' Which rabbitmq package to use. ''; }; @@ -38,12 +38,12 @@ in listenAddress = mkOption { default = "127.0.0.1"; example = ""; - description = '' + description = lib.mdDoc '' IP address on which RabbitMQ will listen for AMQP connections. Set to the empty string to listen on all interfaces. Note that RabbitMQ creates a user named - <literal>guest</literal> with password - <literal>guest</literal> by default, so you should delete + `guest` with password + `guest` by default, so you should delete this user if you intend to allow external access. Together with 'port' setting it's mostly an alias for @@ -55,7 +55,7 @@ in port = mkOption { default = 5672; - description = '' + description = lib.mdDoc '' Port on which RabbitMQ will listen for AMQP connections. ''; type = types.port; @@ -64,7 +64,7 @@ in dataDir = mkOption { type = types.path; default = "/var/lib/rabbitmq"; - description = '' + description = lib.mdDoc '' Data directory for rabbitmq. ''; }; @@ -72,7 +72,7 @@ in cookie = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' Erlang cookie is a string of arbitrary length which must be the same for several nodes to be allowed to communicate. Leave empty to generate automatically. @@ -88,15 +88,15 @@ in "auth_backends.1.authz" = "rabbit_auth_backend_internal"; } ''; - description = '' + description = lib.mdDoc '' Configuration options in RabbitMQ's new config file format, which is a simple key-value format that can not express nested - data structures. This is known as the <literal>rabbitmq.conf</literal> file, + data structures. This is known as the `rabbitmq.conf` file, although outside NixOS that filename may have Erlang syntax, particularly prior to RabbitMQ 3.7.0. If you do need to express nested data structures, you can use - <literal>config</literal> option. Configuration from <literal>config</literal> + `config` option. Configuration from `config` will be merged into these options by RabbitMQ at runtime to form the final configuration. @@ -108,14 +108,14 @@ in config = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' Verbatim advanced configuration file contents using the Erlang syntax. - This is also known as the <literal>advanced.config</literal> file or the old config format. + This is also known as the `advanced.config` file or the old config format. - <literal>configItems</literal> is preferred whenever possible. However, nested - data structures can only be expressed properly using the <literal>config</literal> option. + `configItems` is preferred whenever possible. However, nested + data structures can only be expressed properly using the `config` option. - The contents of this option will be merged into the <literal>configItems</literal> + The contents of this option will be merged into the `configItems` by RabbitMQ at runtime to form the final configuration. See the second table on https://www.rabbitmq.com/configure.html#config-items @@ -126,13 +126,13 @@ in plugins = mkOption { default = [ ]; type = types.listOf types.str; - description = "The names of plugins to enable"; + description = lib.mdDoc "The names of plugins to enable"; }; pluginDirs = mkOption { default = [ ]; type = types.listOf types.path; - description = "The list of directories containing external plugins"; + description = lib.mdDoc "The list of directories containing external plugins"; }; managementPlugin = { @@ -140,7 +140,7 @@ in port = mkOption { default = 15672; type = types.port; - description = '' + description = lib.mdDoc '' On which port to run the management plugin ''; }; diff --git a/nixos/modules/services/audio/alsa.nix b/nixos/modules/services/audio/alsa.nix index 0d743ed31da8a..155780199fd64 100644 --- a/nixos/modules/services/audio/alsa.nix +++ b/nixos/modules/services/audio/alsa.nix @@ -25,7 +25,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable ALSA sound. ''; }; @@ -33,7 +33,7 @@ in enableOSSEmulation = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable ALSA OSS emulation (with certain cards sound mixing may not work!). ''; }; @@ -44,7 +44,7 @@ in example = '' defaults.pcm.!card 3 ''; - description = '' + description = lib.mdDoc '' Set addition configuration for system-wide alsa. ''; }; @@ -54,7 +54,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable volume and capture control with keyboard media keys. You want to leave this disabled if you run a desktop environment @@ -62,7 +62,7 @@ in You might want to enable this if you run a minimalistic desktop environment or work from bare linux ttys/framebuffers. - Enabling this will turn on <option>services.actkbd</option>. + Enabling this will turn on {option}`services.actkbd`. ''; }; @@ -70,7 +70,7 @@ in type = types.str; default = "1"; example = "1%"; - description = '' + description = lib.mdDoc '' The value by which to increment/decrement volume on media keys. See amixer(1) for allowed values. diff --git a/nixos/modules/services/audio/botamusique.nix b/nixos/modules/services/audio/botamusique.nix index f4fa0ead4f055..edb59a49fd1fb 100644 --- a/nixos/modules/services/audio/botamusique.nix +++ b/nixos/modules/services/audio/botamusique.nix @@ -18,7 +18,7 @@ in type = types.package; default = pkgs.botamusique; defaultText = literalExpression "pkgs.botamusique"; - description = "The botamusique package to use."; + description = lib.mdDoc "The botamusique package to use."; }; settings = mkOption { @@ -29,32 +29,32 @@ in type = types.str; default = "localhost"; example = "mumble.example.com"; - description = "Hostname of the mumble server to connect to."; + description = lib.mdDoc "Hostname of the mumble server to connect to."; }; server.port = mkOption { type = types.port; default = 64738; - description = "Port of the mumble server to connect to."; + description = lib.mdDoc "Port of the mumble server to connect to."; }; bot.username = mkOption { type = types.str; default = "botamusique"; - description = "Name the bot should appear with."; + description = lib.mdDoc "Name the bot should appear with."; }; bot.comment = mkOption { type = types.str; default = "Hi, I'm here to play radio, local music or youtube/soundcloud music. Have fun!"; - description = "Comment displayed for the bot."; + description = lib.mdDoc "Comment displayed for the bot."; }; }; }; default = {}; - description = '' - Your <filename>configuration.ini</filename> as a Nix attribute set. Look up - possible options in the <link xlink:href="https://github.com/azlux/botamusique/blob/master/configuration.example.ini">configuration.example.ini</link>. + description = lib.mdDoc '' + Your {file}`configuration.ini` as a Nix attribute set. Look up + possible options in the [configuration.example.ini](https://github.com/azlux/botamusique/blob/master/configuration.example.ini). ''; }; }; diff --git a/nixos/modules/services/audio/hqplayerd.nix b/nixos/modules/services/audio/hqplayerd.nix index 822a8abef2439..4045a34b40df0 100644 --- a/nixos/modules/services/audio/hqplayerd.nix +++ b/nixos/modules/services/audio/hqplayerd.nix @@ -18,7 +18,7 @@ in username = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Username used for HQPlayer's WebUI. Without this you will need to manually create the credentials after @@ -29,7 +29,7 @@ in password = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Password used for HQPlayer's WebUI. Without this you will need to manually create the credentials after @@ -41,7 +41,7 @@ in licenseFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Path to the HQPlayer license key file. Without this, the service will run in trial mode and restart every 30 @@ -52,7 +52,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Opens ports needed for the WebUI and controller API. ''; }; @@ -60,7 +60,7 @@ in config = mkOption { type = types.nullOr types.lines; default = null; - description = '' + description = lib.mdDoc '' HQplayer daemon configuration, written to /etc/hqplayer/hqplayerd.xml. Refer to share/doc/hqplayerd/readme.txt in the hqplayerd derivation for possible values. diff --git a/nixos/modules/services/audio/icecast.nix b/nixos/modules/services/audio/icecast.nix index 5ee5bd745f96e..0a81d71b56908 100644 --- a/nixos/modules/services/audio/icecast.nix +++ b/nixos/modules/services/audio/icecast.nix @@ -48,7 +48,7 @@ in { hostname = mkOption { type = types.nullOr types.str; - description = "DNS name or IP address that will be used for the stream directory lookups or possibily the playlist generation if a Host header is not provided."; + description = lib.mdDoc "DNS name or IP address that will be used for the stream directory lookups or possibily the playlist generation if a Host header is not provided."; default = config.networking.domain; defaultText = literalExpression "config.networking.domain"; }; @@ -56,51 +56,51 @@ in { admin = { user = mkOption { type = types.str; - description = "Username used for all administration functions."; + description = lib.mdDoc "Username used for all administration functions."; default = "admin"; }; password = mkOption { type = types.str; - description = "Password used for all administration functions."; + description = lib.mdDoc "Password used for all administration functions."; }; }; logDir = mkOption { type = types.path; - description = "Base directory used for logging."; + description = lib.mdDoc "Base directory used for logging."; default = "/var/log/icecast"; }; listen = { port = mkOption { type = types.int; - description = "TCP port that will be used to accept client connections."; + description = lib.mdDoc "TCP port that will be used to accept client connections."; default = 8000; }; address = mkOption { type = types.str; - description = "Address Icecast will listen on."; + description = lib.mdDoc "Address Icecast will listen on."; default = "::"; }; }; user = mkOption { type = types.str; - description = "User privileges for the server."; + description = lib.mdDoc "User privileges for the server."; default = "nobody"; }; group = mkOption { type = types.str; - description = "Group privileges for the server."; + description = lib.mdDoc "Group privileges for the server."; default = "nogroup"; }; extraConf = mkOption { type = types.lines; - description = "icecast.xml content."; + description = lib.mdDoc "icecast.xml content."; default = ""; }; diff --git a/nixos/modules/services/audio/jack.nix b/nixos/modules/services/audio/jack.nix index 84fc9957b879f..ae566bba84e4f 100644 --- a/nixos/modules/services/audio/jack.nix +++ b/nixos/modules/services/audio/jack.nix @@ -40,14 +40,14 @@ in { example = literalExpression '' [ "-dalsa" "--device" "hw:1" ]; ''; - description = '' + description = lib.mdDoc '' Specifies startup command line arguments to pass to JACK server. ''; }; session = mkOption { type = types.lines; - description = '' + description = lib.mdDoc '' Commands to run after JACK is started. ''; }; @@ -58,7 +58,7 @@ in { enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Route audio to/from generic ALSA-using applications using ALSA JACK PCM plugin. ''; }; @@ -66,7 +66,7 @@ in { support32Bit = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to support sound for 32-bit ALSA applications on 64-bit system. ''; }; @@ -76,7 +76,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Create ALSA loopback device, instead of using PCM plugin. Has broader application support (things like Steam will work), but may need fine-tuning for concrete hardware. @@ -86,14 +86,14 @@ in { index = mkOption { type = types.int; default = 10; - description = '' + description = lib.mdDoc '' Index of an ALSA loopback device. ''; }; config = mkOption { type = types.lines; - description = '' + description = lib.mdDoc '' ALSA config for loopback device. ''; }; @@ -105,7 +105,7 @@ in { period_size 2048 periods 2 ''; - description = '' + description = lib.mdDoc '' For music production software that still doesn't support JACK natively you would like to put buffer/period adjustments here to decrease dmix device latency. @@ -114,7 +114,7 @@ in { session = mkOption { type = types.lines; - description = '' + description = lib.mdDoc '' Additional commands to run to setup loopback device. ''; }; diff --git a/nixos/modules/services/audio/jmusicbot.nix b/nixos/modules/services/audio/jmusicbot.nix index e0f8d461af076..7e23ffe6bf2c0 100644 --- a/nixos/modules/services/audio/jmusicbot.nix +++ b/nixos/modules/services/audio/jmusicbot.nix @@ -13,12 +13,12 @@ in type = types.package; default = pkgs.jmusicbot; defaultText = literalExpression "pkgs.jmusicbot"; - description = "JMusicBot package to use"; + description = lib.mdDoc "JMusicBot package to use"; }; stateDir = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' The directory where config.txt and serversettings.json is saved. If left as the default value this directory will automatically be created before JMusicBot starts, otherwise the sysadmin is responsible for ensuring the directory exists with appropriate ownership and permissions. Untouched by the value of this option config.txt needs to be placed manually into this directory. diff --git a/nixos/modules/services/audio/liquidsoap.nix b/nixos/modules/services/audio/liquidsoap.nix index ffeefc0f988e1..c313104c46096 100644 --- a/nixos/modules/services/audio/liquidsoap.nix +++ b/nixos/modules/services/audio/liquidsoap.nix @@ -31,7 +31,7 @@ in services.liquidsoap.streams = mkOption { description = - '' + lib.mdDoc '' Set of Liquidsoap streams to start, one systemd service per stream. ''; diff --git a/nixos/modules/services/audio/mopidy.nix b/nixos/modules/services/audio/mopidy.nix index 9937feadaeb6b..9c8e9b693c3f7 100644 --- a/nixos/modules/services/audio/mopidy.nix +++ b/nixos/modules/services/audio/mopidy.nix @@ -31,7 +31,7 @@ in { dataDir = mkOption { default = "/var/lib/mopidy"; type = types.str; - description = '' + description = lib.mdDoc '' The directory where Mopidy stores its state. ''; }; @@ -40,7 +40,7 @@ in { default = []; type = types.listOf types.package; example = literalExpression "[ pkgs.mopidy-spotify ]"; - description = '' + description = lib.mdDoc '' Mopidy extensions that should be loaded by the service. ''; }; @@ -48,7 +48,7 @@ in { configuration = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' The configuration that Mopidy should use. ''; }; @@ -56,7 +56,7 @@ in { extraConfigFiles = mkOption { default = []; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Extra config file read by Mopidy when the service starts. Later files in the list overrides earlier configuration. ''; diff --git a/nixos/modules/services/audio/mpd.nix b/nixos/modules/services/audio/mpd.nix index 11733d99fca65..bbfccec98c4af 100644 --- a/nixos/modules/services/audio/mpd.nix +++ b/nixos/modules/services/audio/mpd.nix @@ -56,7 +56,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable MPD, the music player daemon. ''; }; @@ -64,8 +64,8 @@ in { startWhenNeeded = mkOption { type = types.bool; default = false; - description = '' - If set, <command>mpd</command> is socket-activated; that + description = lib.mdDoc '' + If set, {command}`mpd` is socket-activated; that is, instead of having it permanently running as a daemon, systemd will start it on the first incoming connection. ''; @@ -75,7 +75,7 @@ in { type = with types; either path (strMatching "(http|https|nfs|smb)://.+"); default = "${cfg.dataDir}/music"; defaultText = literalExpression ''"''${dataDir}/music"''; - description = '' + description = lib.mdDoc '' The directory or NFS/SMB network share where MPD reads music from. If left as the default value this directory will automatically be created before the MPD server starts, otherwise the sysadmin is responsible for ensuring @@ -87,7 +87,7 @@ in { type = types.path; default = "${cfg.dataDir}/playlists"; defaultText = literalExpression ''"''${dataDir}/playlists"''; - description = '' + description = lib.mdDoc '' The directory where MPD stores playlists. If left as the default value this directory will automatically be created before the MPD server starts, otherwise the sysadmin is responsible for ensuring the directory exists @@ -98,18 +98,18 @@ in { extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra directives added to to the end of MPD's configuration file, mpd.conf. Basic configuration like file location and uid/gid is added automatically to the beginning of the file. For available - options see <literal>man 5 mpd.conf</literal>'. + options see `man 5 mpd.conf`'. ''; }; dataDir = mkOption { type = types.path; default = "/var/lib/${name}"; - description = '' + description = lib.mdDoc '' The directory where MPD stores its state, tag cache, playlists etc. If left as the default value this directory will automatically be created before the MPD server starts, otherwise the sysadmin is responsible for @@ -120,13 +120,13 @@ in { user = mkOption { type = types.str; default = name; - description = "User account under which MPD runs."; + description = lib.mdDoc "User account under which MPD runs."; }; group = mkOption { type = types.str; default = name; - description = "Group account under which MPD runs."; + description = lib.mdDoc "Group account under which MPD runs."; }; network = { @@ -135,16 +135,16 @@ in { type = types.str; default = "127.0.0.1"; example = "any"; - description = '' + description = lib.mdDoc '' The address for the daemon to listen on. - Use <literal>any</literal> to listen on all addresses. + Use `any` to listen on all addresses. ''; }; port = mkOption { type = types.int; default = 6600; - description = '' + description = lib.mdDoc '' This setting is the TCP port that is desired for the daemon to get assigned to. ''; @@ -156,8 +156,8 @@ in { type = types.nullOr types.str; default = "${cfg.dataDir}/tag_cache"; defaultText = literalExpression ''"''${dataDir}/tag_cache"''; - description = '' - The path to MPD's database. If set to <literal>null</literal> the + description = lib.mdDoc '' + The path to MPD's database. If set to `null` the parameter is omitted from the configuration. ''; }; @@ -167,7 +167,7 @@ in { options = { passwordFile = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' Path to file containing the password. ''; }; @@ -176,14 +176,14 @@ in { in mkOption { type = types.listOf (types.enum perms); default = [ "read" ]; - description = '' + description = lib.mdDoc '' List of permissions that are granted with this password. Permissions can be "${concatStringsSep "\", \"" perms}". ''; }; }; }); - description = '' + description = lib.mdDoc '' Credentials and permissions for accessing the mpd server. ''; default = []; @@ -196,7 +196,7 @@ in { fluidsynth = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If set, add fluidsynth soundfont and configure the plugin. ''; }; diff --git a/nixos/modules/services/audio/mpdscribble.nix b/nixos/modules/services/audio/mpdscribble.nix index 333ffb709410a..d829bc7ae0d01 100644 --- a/nixos/modules/services/audio/mpdscribble.nix +++ b/nixos/modules/services/audio/mpdscribble.nix @@ -82,7 +82,7 @@ in { proxy = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' HTTP proxy URL. ''; }; @@ -90,7 +90,7 @@ in { verbose = mkOption { default = 1; type = types.int; - description = '' + description = lib.mdDoc '' Log level for the mpdscribble daemon. ''; }; @@ -99,7 +99,7 @@ in { default = 600; example = 60; type = types.int; - description = '' + description = lib.mdDoc '' How often should mpdscribble save the journal file? [seconds] ''; }; @@ -115,7 +115,7 @@ in { else "localhost" ''; type = types.str; - description = '' + description = lib.mdDoc '' Host for the mpdscribble daemon to search for a mpd daemon on. ''; }; @@ -133,9 +133,9 @@ in { otherwise <literal>null</literal>. ''; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' File containing the password for the mpd daemon. - If there is a local mpd configured using <option>services.mpd.credentials</option> + If there is a local mpd configured using {option}`services.mpd.credentials` the default is automatically set to a matching passwordFile of the local mpd. ''; }; @@ -144,7 +144,7 @@ in { default = mpdCfg.network.port; defaultText = literalExpression "config.${mpdOpt.network.port}"; type = types.port; - description = '' + description = lib.mdDoc '' Port for the mpdscribble daemon to search for a mpd daemon on. ''; }; @@ -157,18 +157,18 @@ in { type = types.str; default = endpointUrls.${name} or ""; description = - "The url endpoint where the scrobble API is listening."; + lib.mdDoc "The url endpoint where the scrobble API is listening."; }; username = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Username for the scrobble service. ''; }; passwordFile = mkOption { type = types.nullOr types.str; description = - "File containing the password, either as MD5SUM or cleartext."; + lib.mdDoc "File containing the password, either as MD5SUM or cleartext."; }; }; }; @@ -180,7 +180,7 @@ in { passwordFile = "/run/secrets/lastfm_password"; }; }; - description = '' + description = lib.mdDoc '' Endpoints to scrobble to. If the endpoint is one of "${ concatStringsSep "\", \"" (attrNames endpointUrls) diff --git a/nixos/modules/services/audio/navidrome.nix b/nixos/modules/services/audio/navidrome.nix index 319212c020777..a7c8953f5107e 100644 --- a/nixos/modules/services/audio/navidrome.nix +++ b/nixos/modules/services/audio/navidrome.nix @@ -21,8 +21,8 @@ in { example = { MusicFolder = "/mnt/music"; }; - description = '' - Configuration for Navidrome, see <link xlink:href="https://www.navidrome.org/docs/usage/configuration-options/"/> for supported values. + description = lib.mdDoc '' + Configuration for Navidrome, see <https://www.navidrome.org/docs/usage/configuration-options/> for supported values. ''; }; diff --git a/nixos/modules/services/audio/roon-bridge.nix b/nixos/modules/services/audio/roon-bridge.nix index e08f8a4f9e7a0..9a9a6479efc8c 100644 --- a/nixos/modules/services/audio/roon-bridge.nix +++ b/nixos/modules/services/audio/roon-bridge.nix @@ -12,21 +12,21 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for the bridge. ''; }; user = mkOption { type = types.str; default = "roon-bridge"; - description = '' + description = lib.mdDoc '' User to run the Roon bridge as. ''; }; group = mkOption { type = types.str; default = "roon-bridge"; - description = '' + description = lib.mdDoc '' Group to run the Roon Bridge as. ''; }; diff --git a/nixos/modules/services/audio/roon-server.nix b/nixos/modules/services/audio/roon-server.nix index c8a2071c15592..535950f75656f 100644 --- a/nixos/modules/services/audio/roon-server.nix +++ b/nixos/modules/services/audio/roon-server.nix @@ -12,21 +12,21 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for the server. ''; }; user = mkOption { type = types.str; default = "roon-server"; - description = '' + description = lib.mdDoc '' User to run the Roon Server as. ''; }; group = mkOption { type = types.str; default = "roon-server"; - description = '' + description = lib.mdDoc '' Group to run the Roon Server as. ''; }; diff --git a/nixos/modules/services/audio/slimserver.nix b/nixos/modules/services/audio/slimserver.nix index ecd2652849909..9fbc68b71364e 100644 --- a/nixos/modules/services/audio/slimserver.nix +++ b/nixos/modules/services/audio/slimserver.nix @@ -14,7 +14,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable slimserver. ''; }; @@ -23,13 +23,13 @@ in { type = types.package; default = pkgs.slimserver; defaultText = literalExpression "pkgs.slimserver"; - description = "Slimserver package to use."; + description = lib.mdDoc "Slimserver package to use."; }; dataDir = mkOption { type = types.path; default = "/var/lib/slimserver"; - description = '' + description = lib.mdDoc '' The directory where slimserver stores its state, tag cache, playlists etc. ''; diff --git a/nixos/modules/services/audio/snapserver.nix b/nixos/modules/services/audio/snapserver.nix index 91d97a0b551e2..fdc1f605bb32a 100644 --- a/nixos/modules/services/audio/snapserver.nix +++ b/nixos/modules/services/audio/snapserver.nix @@ -12,7 +12,7 @@ let sampleFormat = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Default sample format. ''; example = "48000:16:2"; @@ -21,7 +21,7 @@ let codec = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Default audio compression method. ''; example = "flac"; @@ -77,7 +77,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable snapserver. ''; }; @@ -86,7 +86,7 @@ in { type = types.str; default = "::"; example = "0.0.0.0"; - description = '' + description = lib.mdDoc '' The address where snapclients can connect. ''; }; @@ -94,7 +94,7 @@ in { port = mkOption { type = types.port; default = 1704; - description = '' + description = lib.mdDoc '' The port that snapclients can connect to. ''; }; @@ -104,7 +104,7 @@ in { # Make the behavior consistent with other services. Set the default to # false and remove the accompanying warning after NixOS 22.05 is released. default = true; - description = '' + description = lib.mdDoc '' Whether to automatically open the specified ports in the firewall. ''; }; @@ -115,7 +115,7 @@ in { streamBuffer = mkOption { type = with types; nullOr int; default = null; - description = '' + description = lib.mdDoc '' Stream read (input) buffer in ms. ''; example = 20; @@ -124,7 +124,7 @@ in { buffer = mkOption { type = with types; nullOr int; default = null; - description = '' + description = lib.mdDoc '' Network buffer in ms. ''; example = 1000; @@ -133,7 +133,7 @@ in { sendToMuted = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Send audio to muted clients. ''; }; @@ -141,7 +141,7 @@ in { tcp.enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable the JSON-RPC via TCP. ''; }; @@ -150,7 +150,7 @@ in { type = types.str; default = "::"; example = "0.0.0.0"; - description = '' + description = lib.mdDoc '' The address where the TCP JSON-RPC listens on. ''; }; @@ -158,7 +158,7 @@ in { tcp.port = mkOption { type = types.port; default = 1705; - description = '' + description = lib.mdDoc '' The port where the TCP JSON-RPC listens on. ''; }; @@ -166,7 +166,7 @@ in { http.enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable the JSON-RPC via HTTP. ''; }; @@ -175,7 +175,7 @@ in { type = types.str; default = "::"; example = "0.0.0.0"; - description = '' + description = lib.mdDoc '' The address where the HTTP JSON-RPC listens on. ''; }; @@ -183,7 +183,7 @@ in { http.port = mkOption { type = types.port; default = 1780; - description = '' + description = lib.mdDoc '' The port where the HTTP JSON-RPC listens on. ''; }; @@ -191,7 +191,7 @@ in { http.docRoot = mkOption { type = with types; nullOr path; default = null; - description = '' + description = lib.mdDoc '' Path to serve from the HTTP servers root. ''; }; @@ -201,12 +201,12 @@ in { options = { location = mkOption { type = types.oneOf [ types.path types.str ]; - description = '' - For type <literal>pipe</literal> or <literal>file</literal>, the path to the pipe or file. - For type <literal>librespot</literal>, <literal>airplay</literal> or <literal>process</literal>, the path to the corresponding binary. - For type <literal>tcp</literal>, the <literal>host:port</literal> address to connect to or listen on. - For type <literal>meta</literal>, a list of stream names in the form <literal>/one/two/...</literal>. Don't forget the leading slash. - For type <literal>alsa</literal>, use an empty string. + description = lib.mdDoc '' + For type `pipe` or `file`, the path to the pipe or file. + For type `librespot`, `airplay` or `process`, the path to the corresponding binary. + For type `tcp`, the `host:port` address to connect to or listen on. + For type `meta`, a list of stream names in the form `/one/two/...`. Don't forget the leading slash. + For type `alsa`, use an empty string. ''; example = literalExpression '' "/path/to/pipe" @@ -218,14 +218,14 @@ in { type = mkOption { type = types.enum [ "pipe" "librespot" "airplay" "file" "process" "tcp" "alsa" "spotify" "meta" ]; default = "pipe"; - description = '' + description = lib.mdDoc '' The type of input stream. ''; }; query = mkOption { type = attrsOf str; default = {}; - description = '' + description = lib.mdDoc '' Key-value pairs that convey additional parameters about a stream. ''; example = literalExpression '' @@ -253,7 +253,7 @@ in { }; }); default = { default = {}; }; - description = '' + description = lib.mdDoc '' The definition for an input source. ''; example = literalExpression '' diff --git a/nixos/modules/services/audio/spotifyd.nix b/nixos/modules/services/audio/spotifyd.nix index 22848ed98000d..87ee083e74b7d 100644 --- a/nixos/modules/services/audio/spotifyd.nix +++ b/nixos/modules/services/audio/spotifyd.nix @@ -22,9 +22,9 @@ in config = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' (Deprecated) Configuration for Spotifyd. For syntax and directives, see - <link xlink:href="https://github.com/Spotifyd/spotifyd#Configuration"/>. + <https://github.com/Spotifyd/spotifyd#Configuration>. ''; }; @@ -32,9 +32,9 @@ in default = {}; type = toml.type; example = { global.bitrate = 320; }; - description = '' + description = lib.mdDoc '' Configuration for Spotifyd. For syntax and directives, see - <link xlink:href="https://github.com/Spotifyd/spotifyd#Configuration"/>. + <https://github.com/Spotifyd/spotifyd#Configuration>. ''; }; }; diff --git a/nixos/modules/services/audio/squeezelite.nix b/nixos/modules/services/audio/squeezelite.nix index 36295e21c60f9..767eeda177f3c 100644 --- a/nixos/modules/services/audio/squeezelite.nix +++ b/nixos/modules/services/audio/squeezelite.nix @@ -21,7 +21,7 @@ in extraArguments = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' Additional command line arguments to pass to Squeezelite. ''; }; diff --git a/nixos/modules/services/audio/ympd.nix b/nixos/modules/services/audio/ympd.nix index 84b72d1425132..98522f2542396 100644 --- a/nixos/modules/services/audio/ympd.nix +++ b/nixos/modules/services/audio/ympd.nix @@ -17,7 +17,7 @@ in { webPort = mkOption { type = types.either types.str types.port; # string for backwards compat default = "8080"; - description = "The port where ympd's web interface will be available."; + description = lib.mdDoc "The port where ympd's web interface will be available."; example = "ssl://8080:/path/to/ssl-private-key.pem"; }; @@ -25,14 +25,14 @@ in { host = mkOption { type = types.str; default = "localhost"; - description = "The host where MPD is listening."; + description = lib.mdDoc "The host where MPD is listening."; }; port = mkOption { type = types.int; default = config.services.mpd.network.port; defaultText = literalExpression "config.services.mpd.network.port"; - description = "The port where MPD is listening."; + description = lib.mdDoc "The port where MPD is listening."; example = 6600; }; }; diff --git a/nixos/modules/services/backup/automysqlbackup.nix b/nixos/modules/services/backup/automysqlbackup.nix index cf0cb4da32cf1..194b49da539aa 100644 --- a/nixos/modules/services/backup/automysqlbackup.nix +++ b/nixos/modules/services/backup/automysqlbackup.nix @@ -35,7 +35,7 @@ in calendar = mkOption { type = types.str; default = "01:15:00"; - description = '' + description = lib.mdDoc '' Configured when to run the backup service systemd unit (DayOfWeek Year-Month-Day Hour:Minute:Second). ''; }; @@ -43,9 +43,9 @@ in config = mkOption { type = with types; attrsOf (oneOf [ str int bool (listOf str) ]); default = {}; - description = '' + description = lib.mdDoc '' automysqlbackup configuration. Refer to - <filename>''${pkgs.automysqlbackup}/etc/automysqlbackup.conf</filename> + {file}`''${pkgs.automysqlbackup}/etc/automysqlbackup.conf` for details on supported values. ''; example = literalExpression '' diff --git a/nixos/modules/services/backup/bacula.nix b/nixos/modules/services/backup/bacula.nix index 5989020423463..cb8a6eb4390c8 100644 --- a/nixos/modules/services/backup/bacula.nix +++ b/nixos/modules/services/backup/bacula.nix @@ -114,7 +114,7 @@ let password = mkOption { type = types.str; # TODO: required? - description = '' + description = lib.mdDoc '' Specifies the password that must be supplied for the default Bacula Console to be authorized. The same password must appear in the Director resource of the Console configuration file. For added @@ -135,10 +135,10 @@ let type = types.enum [ "no" "yes" ]; default = "no"; example = "yes"; - description = '' - If Monitor is set to <literal>no</literal>, this director will have + description = lib.mdDoc '' + If Monitor is set to `no`, this director will have full access to this Storage daemon. If Monitor is set to - <literal>yes</literal>, this director will only be able to fetch the + `yes`, this director will only be able to fetch the current status of this Storage daemon. Please note that if this director is being used by a Monitor, we @@ -154,15 +154,15 @@ let options = { changerDevice = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The specified name-string must be the generic SCSI device name of the autochanger that corresponds to the normal read/write Archive Device specified in the Device resource. This generic SCSI device name should be specified if you have an autochanger or if you have a standard tape drive and want to use the Alert Command (see below). For example, on Linux systems, for an Archive Device name of - <literal>/dev/nst0</literal>, you would specify - <literal>/dev/sg0</literal> for the Changer Device name. Depending + `/dev/nst0`, you would specify + `/dev/sg0` for the Changer Device name. Depending on your exact configuration, and the number of autochangers or the type of autochanger, what you specify here can vary. This directive is optional. See the Using AutochangersAutochangersChapter chapter of @@ -173,7 +173,7 @@ let changerCommand = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The name-string specifies an external program to be called that will automatically change volumes as required by Bacula. Normally, this directive will be specified only in the AutoChanger resource, which @@ -181,7 +181,7 @@ let different Changer Command in each Device resource. Most frequently, you will specify the Bacula supplied mtx-changer script as follows: - <literal>"/path/mtx-changer %c %o %S %a %d"</literal> + `"/path/mtx-changer %c %o %S %a %d"` and you will install the mtx on your system (found in the depkgs release). An example of this command is in the default bacula-sd.conf @@ -202,7 +202,7 @@ let extraAutochangerConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Extra configuration to be passed in Autochanger directive. ''; example = '' @@ -219,13 +219,13 @@ let archiveDevice = mkOption { # TODO: required? type = types.str; - description = '' + description = lib.mdDoc '' The specified name-string gives the system file name of the storage device managed by this storage daemon. This will usually be the device file name of a removable storage device (tape drive), for - example <literal>/dev/nst0</literal> or - <literal>/dev/rmt/0mbn</literal>. For a DVD-writer, it will be for - example <literal>/dev/hdc</literal>. It may also be a directory name + example `/dev/nst0` or + `/dev/rmt/0mbn`. For a DVD-writer, it will be for + example `/dev/hdc`. It may also be a directory name if you are archiving to disk storage. In this case, you must supply the full absolute path to the directory. When specifying a tape device, it is preferable that the "non-rewind" variant of the device @@ -236,9 +236,9 @@ let mediaType = mkOption { # TODO: required? type = types.str; - description = '' + description = lib.mdDoc '' The specified name-string names the type of media supported by this - device, for example, <literal>DLT7000</literal>. Media type names are + device, for example, `DLT7000`. Media type names are arbitrary in that you set them to anything you want, but they must be known to the volume database to keep track of which storage daemons can read which volumes. In general, each different storage type @@ -255,9 +255,9 @@ let Storage daemon, but it is with multiple Storage daemons, especially if they have incompatible media. - For example, if you specify a Media Type of <literal>DDS-4</literal> + For example, if you specify a Media Type of `DDS-4` then during the restore, Bacula will be able to choose any Storage - Daemon that handles <literal>DDS-4</literal>. If you have an + Daemon that handles `DDS-4`. If you have an autochanger, you might want to name the Media Type in a way that is unique to the autochanger, unless you wish to possibly use the Volumes in other drives. You should also ensure to have unique Media @@ -274,7 +274,7 @@ let extraDeviceConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Extra configuration to be passed in Device directive. ''; example = '' @@ -295,7 +295,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the Bacula File Daemon. ''; }; @@ -304,7 +304,7 @@ in { default = "${config.networking.hostName}-fd"; defaultText = literalExpression ''"''${config.networking.hostName}-fd"''; type = types.str; - description = '' + description = lib.mdDoc '' The client name that must be used by the Director when connecting. Generally, it is a good idea to use a name related to the machine so that error messages can be easily identified if you have multiple @@ -315,7 +315,7 @@ in { port = mkOption { default = 9102; type = types.int; - description = '' + description = lib.mdDoc '' This specifies the port number on which the Client listens for Director connections. It must agree with the FDPort specified in the Client resource of the Director's configuration file. @@ -324,7 +324,7 @@ in { director = mkOption { default = {}; - description = '' + description = lib.mdDoc '' This option defines director resources in Bacula File Daemon. ''; type = with types; attrsOf (submodule directorOptions); @@ -333,7 +333,7 @@ in { extraClientConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Extra configuration to be passed in Client directive. ''; example = '' @@ -345,7 +345,7 @@ in { extraMessagesConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Extra configuration to be passed in Messages directive. ''; example = '' @@ -358,7 +358,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable Bacula Storage Daemon. ''; }; @@ -367,7 +367,7 @@ in { default = "${config.networking.hostName}-sd"; defaultText = literalExpression ''"''${config.networking.hostName}-sd"''; type = types.str; - description = '' + description = lib.mdDoc '' Specifies the Name of the Storage daemon. ''; }; @@ -375,7 +375,7 @@ in { port = mkOption { default = 9103; type = types.int; - description = '' + description = lib.mdDoc '' Specifies port number on which the Storage daemon listens for Director connections. ''; @@ -383,7 +383,7 @@ in { director = mkOption { default = {}; - description = '' + description = lib.mdDoc '' This option defines Director resources in Bacula Storage Daemon. ''; type = with types; attrsOf (submodule directorOptions); @@ -391,7 +391,7 @@ in { device = mkOption { default = {}; - description = '' + description = lib.mdDoc '' This option defines Device resources in Bacula Storage Daemon. ''; type = with types; attrsOf (submodule deviceOptions); @@ -399,7 +399,7 @@ in { autochanger = mkOption { default = {}; - description = '' + description = lib.mdDoc '' This option defines Autochanger resources in Bacula Storage Daemon. ''; type = with types; attrsOf (submodule autochangerOptions); @@ -408,7 +408,7 @@ in { extraStorageConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Extra configuration to be passed in Storage directive. ''; example = '' @@ -420,7 +420,7 @@ in { extraMessagesConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Extra configuration to be passed in Messages directive. ''; example = '' @@ -434,7 +434,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable Bacula Director Daemon. ''; }; @@ -443,7 +443,7 @@ in { default = "${config.networking.hostName}-dir"; defaultText = literalExpression ''"''${config.networking.hostName}-dir"''; type = types.str; - description = '' + description = lib.mdDoc '' The director name used by the system administrator. This directive is required. ''; @@ -452,7 +452,7 @@ in { port = mkOption { default = 9101; type = types.int; - description = '' + description = lib.mdDoc '' Specify the port (a positive integer) on which the Director daemon will listen for Bacula Console connections. This same port number must be specified in the Director resource of the Console @@ -465,7 +465,7 @@ in { password = mkOption { # TODO: required? type = types.str; - description = '' + description = lib.mdDoc '' Specifies the password that must be supplied for a Director. ''; }; @@ -473,7 +473,7 @@ in { extraMessagesConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Extra configuration to be passed in Messages directive. ''; example = '' @@ -484,7 +484,7 @@ in { extraDirectorConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Extra configuration to be passed in Director directive. ''; example = '' @@ -496,7 +496,7 @@ in { extraConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Extra configuration for Bacula Director Daemon. ''; example = '' diff --git a/nixos/modules/services/backup/borgbackup.nix b/nixos/modules/services/backup/borgbackup.nix index 4c9ddfe4674b2..147b827497ccd 100644 --- a/nixos/modules/services/backup/borgbackup.nix +++ b/nixos/modules/services/backup/borgbackup.nix @@ -219,7 +219,7 @@ in { ###### interface options.services.borgbackup.jobs = mkOption { - description = '' + description = lib.mdDoc '' Deduplicating backups using BorgBackup. Adding a job will cause a borg-job-NAME wrapper to be added to your system path, so that you can perform maintenance easily. @@ -265,9 +265,9 @@ in { paths = mkOption { type = with types; nullOr (coercedTo str lib.singleton (listOf str)); default = null; - description = '' + description = lib.mdDoc '' Path(s) to back up. - Mutually exclusive with <option>dumpCommand</option>. + Mutually exclusive with {option}`dumpCommand`. ''; example = "/home/user"; }; @@ -275,42 +275,42 @@ in { dumpCommand = mkOption { type = with types; nullOr path; default = null; - description = '' + description = lib.mdDoc '' Backup the stdout of this program instead of filesystem paths. - Mutually exclusive with <option>paths</option>. + Mutually exclusive with {option}`paths`. ''; example = "/path/to/createZFSsend.sh"; }; repo = mkOption { type = types.str; - description = "Remote or local repository to back up to."; + description = lib.mdDoc "Remote or local repository to back up to."; example = "user@machine:/path/to/repo"; }; removableDevice = mkOption { type = types.bool; default = false; - description = "Whether the repo (which must be local) is a removable device."; + description = lib.mdDoc "Whether the repo (which must be local) is a removable device."; }; archiveBaseName = mkOption { type = types.nullOr (types.strMatching "[^/{}]+"); default = "${globalConfig.networking.hostName}-${name}"; defaultText = literalExpression ''"''${config.networking.hostName}-<name>"''; - description = '' + description = lib.mdDoc '' How to name the created archives. A timestamp, whose format is - determined by <option>dateFormat</option>, will be appended. The full - name can be modified at runtime (<literal>$archiveName</literal>). - Placeholders like <literal>{hostname}</literal> must not be used. - Use <literal>null</literal> for no base name. + determined by {option}`dateFormat`, will be appended. The full + name can be modified at runtime (`$archiveName`). + Placeholders like `{hostname}` must not be used. + Use `null` for no base name. ''; }; dateFormat = mkOption { type = types.str; - description = '' - Arguments passed to <command>date</command> + description = lib.mdDoc '' + Arguments passed to {command}`date` to create a timestamp suffix for the archive name. ''; default = "+%Y-%m-%dT%H:%M:%S"; @@ -347,19 +347,19 @@ in { user = mkOption { type = types.str; - description = '' - The user <command>borg</command> is run as. + description = lib.mdDoc '' + The user {command}`borg` is run as. User or group need read permission - for the specified <option>paths</option>. + for the specified {option}`paths`. ''; default = "root"; }; group = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The group borg is run as. User or group needs read permission - for the specified <option>paths</option>. + for the specified {option}`paths`. ''; default = "root"; }; @@ -371,20 +371,20 @@ in { "authenticated" "authenticated-blake2" "none" ]; - description = '' + description = lib.mdDoc '' Encryption mode to use. Setting a mode - other than <literal>"none"</literal> requires - you to specify a <option>passCommand</option> - or a <option>passphrase</option>. + other than `"none"` requires + you to specify a {option}`passCommand` + or a {option}`passphrase`. ''; example = "repokey-blake2"; }; encryption.passCommand = mkOption { type = with types; nullOr str; - description = '' + description = lib.mdDoc '' A command which prints the passphrase to stdout. - Mutually exclusive with <option>passphrase</option>. + Mutually exclusive with {option}`passphrase`. ''; default = null; example = "cat /path/to/passphrase_file"; @@ -392,11 +392,11 @@ in { encryption.passphrase = mkOption { type = with types; nullOr str; - description = '' + description = lib.mdDoc '' The passphrase the backups are encrypted with. - Mutually exclusive with <option>passCommand</option>. + Mutually exclusive with {option}`passCommand`. If you do not want the passphrase to be stored in the - world-readable Nix store, use <option>passCommand</option>. + world-readable Nix store, use {option}`passCommand`. ''; default = null; }; @@ -406,9 +406,9 @@ in { # compression mode must be given, # compression level is optional type = types.strMatching "none|(auto,)?(lz4|zstd|zlib|lzma)(,[[:digit:]]{1,2})?"; - description = '' + description = lib.mdDoc '' Compression method to use. Refer to - <command>borg help compression</command> + {command}`borg help compression` for all available options. ''; default = "lz4"; @@ -417,9 +417,9 @@ in { exclude = mkOption { type = with types; listOf str; - description = '' + description = lib.mdDoc '' Exclude paths matching any of the given patterns. See - <command>borg help patterns</command> for pattern syntax. + {command}`borg help patterns` for pattern syntax. ''; default = [ ]; example = [ @@ -430,9 +430,9 @@ in { readWritePaths = mkOption { type = with types; listOf path; - description = '' + description = lib.mdDoc '' By default, borg cannot write anywhere on the system but - <literal>$HOME/.config/borg</literal> and <literal>$HOME/.cache/borg</literal>. + `$HOME/.config/borg` and `$HOME/.cache/borg`. If, for example, your preHook script needs to dump files somewhere, put those directories here. ''; @@ -444,8 +444,8 @@ in { privateTmp = mkOption { type = types.bool; - description = '' - Set the <literal>PrivateTmp</literal> option for + description = lib.mdDoc '' + Set the `PrivateTmp` option for the systemd-service. Set to false if you need sockets or other files from global /tmp. ''; @@ -454,10 +454,10 @@ in { doInit = mkOption { type = types.bool; - description = '' - Run <command>borg init</command> if the - specified <option>repo</option> does not exist. - You should set this to <literal>false</literal> + description = lib.mdDoc '' + Run {command}`borg init` if the + specified {option}`repo` does not exist. + You should set this to `false` if the repository is located on an external drive that might not always be mounted. ''; @@ -466,10 +466,10 @@ in { appendFailedSuffix = mkOption { type = types.bool; - description = '' - Append a <literal>.failed</literal> suffix + description = lib.mdDoc '' + Append a `.failed` suffix to the archive name, which is only removed if - <command>borg create</command> has a zero exit status. + {command}`borg create` has a zero exit status. ''; default = true; }; @@ -479,9 +479,9 @@ in { # means there is no limit of yearly archives to keep # The regex is for use with e.g. --keep-within 1y type = with types; attrsOf (either int (strMatching "[[:digit:]]+[Hdwmy]")); - description = '' + description = lib.mdDoc '' Prune a repository by deleting all archives not matching any of the - specified retention options. See <command>borg help prune</command> + specified retention options. See {command}`borg help prune` for the available options. ''; default = { }; @@ -497,10 +497,10 @@ in { prune.prefix = mkOption { type = types.nullOr (types.str); - description = '' + description = lib.mdDoc '' Only consider archive names starting with this prefix for pruning. By default, only archives created by this job are considered. - Use <literal>""</literal> or <literal>null</literal> to consider all archives. + Use `""` or `null` to consider all archives. ''; default = config.archiveBaseName; defaultText = literalExpression "archiveBaseName"; @@ -508,7 +508,7 @@ in { environment = mkOption { type = with types; attrsOf str; - description = '' + description = lib.mdDoc '' Environment variables passed to the backup script. You can for example specify which SSH key to use. ''; @@ -518,7 +518,7 @@ in { preHook = mkOption { type = types.lines; - description = '' + description = lib.mdDoc '' Shell commands to run before the backup. This can for example be used to mount file systems. ''; @@ -531,43 +531,43 @@ in { postInit = mkOption { type = types.lines; - description = '' - Shell commands to run after <command>borg init</command>. + description = lib.mdDoc '' + Shell commands to run after {command}`borg init`. ''; default = ""; }; postCreate = mkOption { type = types.lines; - description = '' - Shell commands to run after <command>borg create</command>. The name - of the created archive is stored in <literal>$archiveName</literal>. + description = lib.mdDoc '' + Shell commands to run after {command}`borg create`. The name + of the created archive is stored in `$archiveName`. ''; default = ""; }; postPrune = mkOption { type = types.lines; - description = '' - Shell commands to run after <command>borg prune</command>. + description = lib.mdDoc '' + Shell commands to run after {command}`borg prune`. ''; default = ""; }; postHook = mkOption { type = types.lines; - description = '' + description = lib.mdDoc '' Shell commands to run just before exit. They are executed even if a previous command exits with a non-zero exit code. - The latter is available as <literal>$exitStatus</literal>. + The latter is available as `$exitStatus`. ''; default = ""; }; extraArgs = mkOption { type = types.str; - description = '' - Additional arguments for all <command>borg</command> calls the + description = lib.mdDoc '' + Additional arguments for all {command}`borg` calls the service has. Handle with care. ''; default = ""; @@ -576,9 +576,9 @@ in { extraInitArgs = mkOption { type = types.str; - description = '' - Additional arguments for <command>borg init</command>. - Can also be set at runtime using <literal>$extraInitArgs</literal>. + description = lib.mdDoc '' + Additional arguments for {command}`borg init`. + Can also be set at runtime using `$extraInitArgs`. ''; default = ""; example = "--append-only"; @@ -586,9 +586,9 @@ in { extraCreateArgs = mkOption { type = types.str; - description = '' - Additional arguments for <command>borg create</command>. - Can also be set at runtime using <literal>$extraCreateArgs</literal>. + description = lib.mdDoc '' + Additional arguments for {command}`borg create`. + Can also be set at runtime using `$extraCreateArgs`. ''; default = ""; example = "--stats --checkpoint-interval 600"; @@ -596,9 +596,9 @@ in { extraPruneArgs = mkOption { type = types.str; - description = '' - Additional arguments for <command>borg prune</command>. - Can also be set at runtime using <literal>$extraPruneArgs</literal>. + description = lib.mdDoc '' + Additional arguments for {command}`borg prune`. + Can also be set at runtime using `$extraPruneArgs`. ''; default = ""; example = "--save-space"; @@ -610,12 +610,12 @@ in { }; options.services.borgbackup.repos = mkOption { - description = '' + description = lib.mdDoc '' Serve BorgBackup repositories to given public SSH keys, restricting their access to the repository only. See also the chapter about BorgBackup in the NixOS manual. Also, clients do not need to specify the absolute path when accessing the repository, - i.e. <literal>user@machine:.</literal> is enough. (Note colon and dot.) + i.e. `user@machine:.` is enough. (Note colon and dot.) ''; default = { }; type = types.attrsOf (types.submodule ( @@ -623,7 +623,7 @@ in { options = { path = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' Where to store the backups. Note that the directory is created automatically, with correct permissions. ''; @@ -632,30 +632,30 @@ in { user = mkOption { type = types.str; - description = '' - The user <command>borg serve</command> is run as. + description = lib.mdDoc '' + The user {command}`borg serve` is run as. User or group needs write permission - for the specified <option>path</option>. + for the specified {option}`path`. ''; default = "borg"; }; group = mkOption { type = types.str; - description = '' - The group <command>borg serve</command> is run as. + description = lib.mdDoc '' + The group {command}`borg serve` is run as. User or group needs write permission - for the specified <option>path</option>. + for the specified {option}`path`. ''; default = "borg"; }; authorizedKeys = mkOption { type = with types; listOf str; - description = '' + description = lib.mdDoc '' Public SSH keys that are given full write access to this repository. You should use a different SSH key for each repository you write to, because - the specified keys are restricted to running <command>borg serve</command> + the specified keys are restricted to running {command}`borg serve` and can only access this single repository. ''; default = [ ]; @@ -663,7 +663,7 @@ in { authorizedKeysAppendOnly = mkOption { type = with types; listOf str; - description = '' + description = lib.mdDoc '' Public SSH keys that can only be used to append new data (archives) to the repository. Note that archives can still be marked as deleted and are subsequently removed from disk upon accessing the repo with full write access, e.g. when pruning. @@ -673,11 +673,11 @@ in { allowSubRepos = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Allow clients to create repositories in subdirectories of the - specified <option>path</option>. These can be accessed using - <literal>user@machine:path/to/subrepo</literal>. Note that a - <option>quota</option> applies to repositories independently. + specified {option}`path`. These can be accessed using + `user@machine:path/to/subrepo`. Note that a + {option}`quota` applies to repositories independently. Therefore, if this is enabled, clients can create multiple repositories and upload an arbitrary amount of data. ''; @@ -687,9 +687,9 @@ in { quota = mkOption { # See the definition of parse_file_size() in src/borg/helpers/parseformat.py type = with types; nullOr (strMatching "[[:digit:].]+[KMGTP]?"); - description = '' + description = lib.mdDoc '' Storage quota for the repository. This quota is ensured for all - sub-repositories if <option>allowSubRepos</option> is enabled + sub-repositories if {option}`allowSubRepos` is enabled but not for the overall storage space used. ''; default = null; diff --git a/nixos/modules/services/backup/borgmatic.nix b/nixos/modules/services/backup/borgmatic.nix index 9414d78aa751d..7236a1f194115 100644 --- a/nixos/modules/services/backup/borgmatic.nix +++ b/nixos/modules/services/backup/borgmatic.nix @@ -11,7 +11,7 @@ in { enable = mkEnableOption "borgmatic"; settings = mkOption { - description = '' + description = lib.mdDoc '' See https://torsion.org/borgmatic/docs/reference/configuration/ ''; type = types.submodule { @@ -19,7 +19,7 @@ in { options.location = { source_directories = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' List of source directories to backup (required). Globs and tildes are expanded. ''; @@ -27,7 +27,7 @@ in { }; repositories = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Paths to local or remote repositories (required). Tildes are expanded. Multiple repositories are backed up to in sequence. Borg placeholders can be used. See the output of diff --git a/nixos/modules/services/backup/btrbk.nix b/nixos/modules/services/backup/btrbk.nix index e17761ffc3cb9..f1d58f597c255 100644 --- a/nixos/modules/services/backup/btrbk.nix +++ b/nixos/modules/services/backup/btrbk.nix @@ -74,23 +74,23 @@ in options = { services.btrbk = { extraPackages = mkOption { - description = "Extra packages for btrbk, like compression utilities for <literal>stream_compress</literal>"; + description = lib.mdDoc "Extra packages for btrbk, like compression utilities for `stream_compress`"; type = types.listOf types.package; default = [ ]; example = literalExpression "[ pkgs.xz ]"; }; niceness = mkOption { - description = "Niceness for local instances of btrbk. Also applies to remote ones connecting via ssh when positive."; + description = lib.mdDoc "Niceness for local instances of btrbk. Also applies to remote ones connecting via ssh when positive."; type = types.ints.between (-20) 19; default = 10; }; ioSchedulingClass = mkOption { - description = "IO scheduling class for btrbk (see ionice(1) for a quick description). Applies to local instances, and remote ones connecting by ssh if set to idle."; + description = lib.mdDoc "IO scheduling class for btrbk (see ionice(1) for a quick description). Applies to local instances, and remote ones connecting by ssh if set to idle."; type = types.enum [ "idle" "best-effort" "realtime" ]; default = "best-effort"; }; instances = mkOption { - description = "Set of btrbk instances. The instance named <literal>btrbk</literal> is the default one."; + description = lib.mdDoc "Set of btrbk instances. The instance named `btrbk` is the default one."; type = with types; attrsOf ( submodule { @@ -98,7 +98,7 @@ in onCalendar = mkOption { type = types.nullOr types.str; default = "daily"; - description = '' + description = lib.mdDoc '' How often this btrbk instance is started. See systemd.time(7) for more information about the format. Setting it to null disables the timer, thus this instance can only be started manually. ''; @@ -119,7 +119,7 @@ in }; }; }; - description = "configuration options for btrbk. Nested attrsets translate to subsections."; + description = lib.mdDoc "configuration options for btrbk. Nested attrsets translate to subsections."; }; }; } @@ -127,18 +127,18 @@ in default = { }; }; sshAccess = mkOption { - description = "SSH keys that should be able to make or push snapshots on this system remotely with btrbk"; + description = lib.mdDoc "SSH keys that should be able to make or push snapshots on this system remotely with btrbk"; type = with types; listOf ( submodule { options = { key = mkOption { type = str; - description = "SSH public key allowed to login as user <literal>btrbk</literal> to run remote backups."; + description = lib.mdDoc "SSH public key allowed to login as user `btrbk` to run remote backups."; }; roles = mkOption { type = listOf (enum [ "info" "source" "target" "delete" "snapshot" "send" "receive" ]); example = [ "source" "info" "send" ]; - description = "What actions can be performed with this SSH key. See ssh_filter_btrbk(1) for details"; + description = lib.mdDoc "What actions can be performed with this SSH key. See ssh_filter_btrbk(1) for details"; }; }; } diff --git a/nixos/modules/services/backup/duplicati.nix b/nixos/modules/services/backup/duplicati.nix index 97864c44691b0..8da29a04c824b 100644 --- a/nixos/modules/services/backup/duplicati.nix +++ b/nixos/modules/services/backup/duplicati.nix @@ -13,7 +13,7 @@ in port = mkOption { default = 8200; type = types.int; - description = '' + description = lib.mdDoc '' Port serving the web interface ''; }; @@ -35,7 +35,7 @@ in interface = mkOption { default = "127.0.0.1"; type = types.str; - description = '' + description = lib.mdDoc '' Listening interface for the web UI Set it to "any" to listen on all available interfaces ''; @@ -44,7 +44,7 @@ in user = mkOption { default = "duplicati"; type = types.str; - description = '' + description = lib.mdDoc '' Duplicati runs as it's own user. It will only be able to backup world-readable files. Run as root with special care. ''; diff --git a/nixos/modules/services/backup/duplicity.nix b/nixos/modules/services/backup/duplicity.nix index 6949fa8b995c0..8c41059555693 100644 --- a/nixos/modules/services/backup/duplicity.nix +++ b/nixos/modules/services/backup/duplicity.nix @@ -18,7 +18,7 @@ in root = mkOption { type = types.path; default = "/"; - description = '' + description = lib.mdDoc '' Root directory to backup. ''; }; @@ -96,10 +96,10 @@ in type = types.str; default = "never"; example = "1M"; - description = '' - If <literal>"never"</literal> (the default) always do incremental + description = lib.mdDoc '' + If `"never"` (the default) always do incremental backups (the first backup will be a full backup, of course). If - <literal>"always"</literal> always do full backups. Otherwise, this + `"always"` always do full backups. Otherwise, this must be a string representing a duration. Full backups will be made when the latest full backup is older than this duration. If this is not the case, an incremental backup is performed. @@ -111,7 +111,7 @@ in type = types.nullOr types.str; default = null; example = "6M"; - description = '' + description = lib.mdDoc '' If non-null, delete all backup sets older than the given time. Old backup sets will not be deleted if backup sets newer than time depend on them. ''; @@ -120,7 +120,7 @@ in type = types.nullOr types.int; default = null; example = 2; - description = '' + description = lib.mdDoc '' If non-null, delete all backups sets that are older than the count:th last full backup (in other words, keep the last count full backups and associated incremental sets). @@ -130,7 +130,7 @@ in type = types.nullOr types.int; default = null; example = 1; - description = '' + description = lib.mdDoc '' If non-null, delete incremental sets of all backups sets that are older than the count:th last full backup (in other words, keep only old full backups and not their increments). diff --git a/nixos/modules/services/backup/mysql-backup.nix b/nixos/modules/services/backup/mysql-backup.nix index c40a0b5abc40e..41adb63e7fa8d 100644 --- a/nixos/modules/services/backup/mysql-backup.nix +++ b/nixos/modules/services/backup/mysql-backup.nix @@ -42,7 +42,7 @@ in calendar = mkOption { type = types.str; default = "01:15:00"; - description = '' + description = lib.mdDoc '' Configured when to run the backup service systemd unit (DayOfWeek Year-Month-Day Hour:Minute:Second). ''; }; @@ -50,7 +50,7 @@ in user = mkOption { type = types.str; default = defaultUser; - description = '' + description = lib.mdDoc '' User to be used to perform backup. ''; }; @@ -58,7 +58,7 @@ in databases = mkOption { default = []; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' List of database names to dump. ''; }; @@ -66,7 +66,7 @@ in location = mkOption { type = types.path; default = "/var/backup/mysql"; - description = '' + description = lib.mdDoc '' Location to put the gzipped MySQL database dumps. ''; }; @@ -74,7 +74,7 @@ in singleTransaction = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to create database dump in a single transaction ''; }; diff --git a/nixos/modules/services/backup/postgresql-backup.nix b/nixos/modules/services/backup/postgresql-backup.nix index f22b613382734..744ccb98e2c2b 100644 --- a/nixos/modules/services/backup/postgresql-backup.nix +++ b/nixos/modules/services/backup/postgresql-backup.nix @@ -76,8 +76,8 @@ in { startAt = mkOption { default = "*-*-* 01:15:00"; type = with types; either (listOf str) str; - description = '' - This option defines (see <literal>systemd.time</literal> for format) when the + description = lib.mdDoc '' + This option defines (see `systemd.time` for format) when the databases should be dumped. The default is to update at 01:15 (at night) every day. ''; @@ -87,10 +87,10 @@ in { default = cfg.databases == []; defaultText = literalExpression "services.postgresqlBackup.databases == []"; type = lib.types.bool; - description = '' + description = lib.mdDoc '' Backup all databases using pg_dumpall. This option is mutual exclusive to - <literal>services.postgresqlBackup.databases</literal>. + `services.postgresqlBackup.databases`. The resulting backup dump will have the name all.sql.gz. This option is the default if no databases are specified. ''; @@ -99,7 +99,7 @@ in { databases = mkOption { default = []; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' List of database names to dump. ''; }; @@ -107,7 +107,7 @@ in { location = mkOption { default = "/var/backup/postgresql"; type = types.path; - description = '' + description = lib.mdDoc '' Path of directory where the PostgreSQL database dumps will be placed. ''; }; @@ -115,9 +115,9 @@ in { pgdumpOptions = mkOption { type = types.separatedString " "; default = "-C"; - description = '' + description = lib.mdDoc '' Command line options for pg_dump. This options is not used - if <literal>config.services.postgresqlBackup.backupAll</literal> is enabled. + if `config.services.postgresqlBackup.backupAll` is enabled. Note that config.services.postgresqlBackup.backupAll is also active, when no databases where specified. ''; @@ -126,7 +126,7 @@ in { compression = mkOption { type = types.enum ["none" "gzip" "zstd"]; default = "gzip"; - description = '' + description = lib.mdDoc '' The type of compression to use on the generated database dump. ''; }; @@ -134,7 +134,7 @@ in { compressionLevel = mkOption { type = types.ints.between 1 19; default = 6; - description = '' + description = lib.mdDoc '' The compression level used when compression is enabled. gzip accepts levels 1 to 9. zstd accepts levels 1 to 19. ''; diff --git a/nixos/modules/services/backup/postgresql-wal-receiver.nix b/nixos/modules/services/backup/postgresql-wal-receiver.nix index 32643adfdaeac..01fd57f5c5062 100644 --- a/nixos/modules/services/backup/postgresql-wal-receiver.nix +++ b/nixos/modules/services/backup/postgresql-wal-receiver.nix @@ -8,7 +8,7 @@ let postgresqlPackage = mkOption { type = types.package; example = literalExpression "pkgs.postgresql_11"; - description = '' + description = lib.mdDoc '' PostgreSQL package to use. ''; }; @@ -16,7 +16,7 @@ let directory = mkOption { type = types.path; example = literalExpression "/mnt/pg_wal/main/"; - description = '' + description = lib.mdDoc '' Directory to write the output to. ''; }; @@ -24,7 +24,7 @@ let statusInterval = mkOption { type = types.int; default = 10; - description = '' + description = lib.mdDoc '' Specifies the number of seconds between status packets sent back to the server. This allows for easier monitoring of the progress from server. A value of zero disables the periodic status updates completely, @@ -36,27 +36,27 @@ let type = types.str; default = ""; example = "some_slot_name"; - description = '' - Require <command>pg_receivewal</command> to use an existing replication slot (see - <link xlink:href="https://www.postgresql.org/docs/current/warm-standby.html#STREAMING-REPLICATION-SLOTS">Section 26.2.6 of the PostgreSQL manual</link>). - When this option is used, <command>pg_receivewal</command> will report a flush position to the server, + description = lib.mdDoc '' + Require {command}`pg_receivewal` to use an existing replication slot (see + [Section 26.2.6 of the PostgreSQL manual](https://www.postgresql.org/docs/current/warm-standby.html#STREAMING-REPLICATION-SLOTS)). + When this option is used, {command}`pg_receivewal` will report a flush position to the server, indicating when each segment has been synchronized to disk so that the server can remove that segment if it is not otherwise needed. - When the replication client of <command>pg_receivewal</command> is configured on the server as a synchronous standby, + When the replication client of {command}`pg_receivewal` is configured on the server as a synchronous standby, then using a replication slot will report the flush position to the server, but only when a WAL file is closed. Therefore, that configuration will cause transactions on the primary to wait for a long time and effectively not work satisfactorily. - The option <option>synchronous</option> must be specified in addition to make this work correctly. + The option {option}`synchronous` must be specified in addition to make this work correctly. ''; }; synchronous = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Flush the WAL data to disk immediately after it has been received. - Also send a status packet back to the server immediately after flushing, regardless of <option>statusInterval</option>. + Also send a status packet back to the server immediately after flushing, regardless of {option}`statusInterval`. - This option should be specified if the replication client of <command>pg_receivewal</command> is configured on the server as a synchronous standby, + This option should be specified if the replication client of {command}`pg_receivewal` is configured on the server as a synchronous standby, to ensure that timely feedback is sent to the server. ''; }; @@ -64,10 +64,10 @@ let compress = mkOption { type = types.ints.between 0 9; default = 0; - description = '' + description = lib.mdDoc '' Enables gzip compression of write-ahead logs, and specifies the compression level - (<literal>0</literal> through <literal>9</literal>, <literal>0</literal> being no compression and <literal>9</literal> being best compression). - The suffix <literal>.gz</literal> will automatically be added to all filenames. + (`0` through `9`, `0` being no compression and `9` being best compression). + The suffix `.gz` will automatically be added to all filenames. This option requires PostgreSQL >= 10. ''; @@ -76,11 +76,11 @@ let connection = mkOption { type = types.str; example = "postgresql://user@somehost"; - description = '' + description = lib.mdDoc '' Specifies parameters used to connect to the server, as a connection string. - See <link xlink:href="https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING">Section 34.1.1 of the PostgreSQL manual</link> for more information. + See [Section 34.1.1 of the PostgreSQL manual](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING) for more information. - Because <command>pg_receivewal</command> doesn't connect to any particular database in the cluster, + Because {command}`pg_receivewal` doesn't connect to any particular database in the cluster, database name in the connection string will be ignored. ''; }; @@ -93,8 +93,8 @@ let "--no-sync" ] ''; - description = '' - A list of extra arguments to pass to the <command>pg_receivewal</command> command. + description = lib.mdDoc '' + A list of extra arguments to pass to the {command}`pg_receivewal` command. ''; }; @@ -107,9 +107,9 @@ let PGSSLMODE = "require"; } ''; - description = '' + description = lib.mdDoc '' Environment variables passed to the service. - Usable parameters are listed in <link xlink:href="https://www.postgresql.org/docs/current/libpq-envars.html">Section 34.14 of the PostgreSQL manual</link>. + Usable parameters are listed in [Section 34.14 of the PostgreSQL manual](https://www.postgresql.org/docs/current/libpq-envars.html). ''; }; }; @@ -131,10 +131,10 @@ in { }; } ''; - description = '' + description = lib.mdDoc '' PostgreSQL WAL receivers. - Stream write-ahead logs from a PostgreSQL server using <command>pg_receivewal</command> (formerly <command>pg_receivexlog</command>). - See <link xlink:href="https://www.postgresql.org/docs/current/app-pgreceivewal.html">the man page</link> for more information. + Stream write-ahead logs from a PostgreSQL server using {command}`pg_receivewal` (formerly {command}`pg_receivexlog`). + See [the man page](https://www.postgresql.org/docs/current/app-pgreceivewal.html) for more information. ''; }; }; diff --git a/nixos/modules/services/backup/restic-rest-server.nix b/nixos/modules/services/backup/restic-rest-server.nix index 4717119f178ad..1d3892c158e04 100644 --- a/nixos/modules/services/backup/restic-rest-server.nix +++ b/nixos/modules/services/backup/restic-rest-server.nix @@ -15,19 +15,19 @@ in default = ":8000"; example = "127.0.0.1:8080"; type = types.str; - description = "Listen on a specific IP address and port."; + description = lib.mdDoc "Listen on a specific IP address and port."; }; dataDir = mkOption { default = "/var/lib/restic"; type = types.path; - description = "The directory for storing the restic repository."; + description = lib.mdDoc "The directory for storing the restic repository."; }; appendOnly = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable append only mode. This mode allows creation of new backups but prevents deletion and modification of existing backups. This can be useful when backing up systems that have a potential of being hacked. @@ -37,7 +37,7 @@ in privateRepos = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable private repos. Grants access only when a subdirectory with the same name as the user is specified in the repository URL. ''; @@ -46,13 +46,13 @@ in prometheus = mkOption { default = false; type = types.bool; - description = "Enable Prometheus metrics at /metrics."; + description = lib.mdDoc "Enable Prometheus metrics at /metrics."; }; extraFlags = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Extra commandline options to pass to Restic REST server. ''; }; @@ -61,7 +61,7 @@ in default = pkgs.restic-rest-server; defaultText = literalExpression "pkgs.restic-rest-server"; type = types.package; - description = "Restic REST server package to use."; + description = lib.mdDoc "Restic REST server package to use."; }; }; diff --git a/nixos/modules/services/backup/restic.nix b/nixos/modules/services/backup/restic.nix index a0de1124c661c..76d7f093f21c0 100644 --- a/nixos/modules/services/backup/restic.nix +++ b/nixos/modules/services/backup/restic.nix @@ -8,14 +8,14 @@ let in { options.services.restic.backups = mkOption { - description = '' + description = lib.mdDoc '' Periodic backups to create with Restic. ''; type = types.attrsOf (types.submodule ({ config, name, ... }: { options = { passwordFile = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Read the repository password from a file. ''; example = "/etc/nixos/restic-password"; @@ -26,7 +26,7 @@ in # added on 2021-08-28, s3CredentialsFile should # be removed in the future (+ remember the warning) default = config.s3CredentialsFile; - description = '' + description = lib.mdDoc '' file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5) ''; @@ -35,7 +35,7 @@ in s3CredentialsFile = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' file containing the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY for an S3-hosted repository, in the format of an EnvironmentFile as described by systemd.exec(5) @@ -45,13 +45,13 @@ in rcloneOptions = mkOption { type = with types; nullOr (attrsOf (oneOf [ str bool ])); default = null; - description = '' + description = lib.mdDoc '' Options to pass to rclone to control its behavior. - See <link xlink:href="https://rclone.org/docs/#options"/> for + See <https://rclone.org/docs/#options> for available options. When specifying option names, strip the - leading <literal>--</literal>. To set a flag such as - <literal>--drive-use-trash</literal>, which does not take a value, - set the value to the Boolean <literal>true</literal>. + leading `--`. To set a flag such as + `--drive-use-trash`, which does not take a value, + set the value to the Boolean `true`. ''; example = { bwlimit = "10M"; @@ -62,16 +62,16 @@ in rcloneConfig = mkOption { type = with types; nullOr (attrsOf (oneOf [ str bool ])); default = null; - description = '' + description = lib.mdDoc '' Configuration for the rclone remote being used for backup. See the remote's specific options under rclone's docs at - <link xlink:href="https://rclone.org/docs/"/>. When specifying + <https://rclone.org/docs/>. When specifying option names, use the "config" name specified in the docs. - For example, to set <literal>--b2-hard-delete</literal> for a B2 - remote, use <literal>hard_delete = true</literal> in the + For example, to set `--b2-hard-delete` for a B2 + remote, use `hard_delete = true` in the attribute set. Warning: Secrets set in here will be world-readable in the Nix - store! Consider using the <literal>rcloneConfigFile</literal> + store! Consider using the `rcloneConfigFile` option instead to specify secret values separately. Note that options set here will override those set in the config file. ''; @@ -86,11 +86,11 @@ in rcloneConfigFile = mkOption { type = with types; nullOr path; default = null; - description = '' + description = lib.mdDoc '' Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in - <literal>rcloneConfig</literal> will override those set in this + `rcloneConfig` will override those set in this file. ''; }; @@ -98,7 +98,7 @@ in repository = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' repository to backup to. ''; example = "sftp:backup@192.168.1.100:/backups/${name}"; @@ -107,7 +107,7 @@ in repositoryFile = mkOption { type = with types; nullOr path; default = null; - description = '' + description = lib.mdDoc '' Path to the file containing the repository location to backup to. ''; }; @@ -115,7 +115,7 @@ in paths = mkOption { type = types.nullOr (types.listOf types.str); default = null; - description = '' + description = lib.mdDoc '' Which paths to backup. If null or an empty array, no backup command will be run. This can be used to create a prune-only job. @@ -131,7 +131,7 @@ in default = { OnCalendar = "daily"; }; - description = '' + description = lib.mdDoc '' When to run the backup. See man systemd.timer for details. ''; example = { @@ -143,7 +143,7 @@ in user = mkOption { type = types.str; default = "root"; - description = '' + description = lib.mdDoc '' As which user the backup should run. ''; example = "postgresql"; @@ -152,7 +152,7 @@ in extraBackupArgs = mkOption { type = types.listOf types.str; default = [ ]; - description = '' + description = lib.mdDoc '' Extra arguments passed to restic backup. ''; example = [ @@ -163,7 +163,7 @@ in extraOptions = mkOption { type = types.listOf types.str; default = [ ]; - description = '' + description = lib.mdDoc '' Extra extended options to be passed to the restic --option flag. ''; example = [ @@ -174,7 +174,7 @@ in initialize = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Create the repository if it doesn't exist. ''; }; @@ -199,7 +199,7 @@ in dynamicFilesFrom = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' A script that produces a list of files to back up. The results of this command are given to the '--files-from' option. @@ -210,7 +210,7 @@ in backupPrepareCommand = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' A script that must run before starting the backup process. ''; }; @@ -218,7 +218,7 @@ in backupCleanupCommand = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' A script that must run after finishing the backup process. ''; }; diff --git a/nixos/modules/services/backup/rsnapshot.nix b/nixos/modules/services/backup/rsnapshot.nix index 6635a51ec2c65..b18c02d7d11cf 100644 --- a/nixos/modules/services/backup/rsnapshot.nix +++ b/nixos/modules/services/backup/rsnapshot.nix @@ -24,7 +24,7 @@ in services.rsnapshot = { enable = mkEnableOption "rsnapshot backups"; enableManualRsnapshot = mkOption { - description = "Whether to enable manual usage of the rsnapshot command with this module."; + description = lib.mdDoc "Whether to enable manual usage of the rsnapshot command with this module."; default = true; type = types.bool; }; @@ -37,7 +37,7 @@ in backup /home/ localhost/ ''; type = types.lines; - description = '' + description = lib.mdDoc '' rsnapshot configuration option in addition to the defaults from rsnapshot and this module. @@ -53,7 +53,7 @@ in default = {}; example = { hourly = "0 * * * *"; daily = "50 21 * * *"; }; type = types.attrsOf types.str; - description = '' + description = lib.mdDoc '' Periodicity at which intervals should be run by cron. Note that the intervals also have to exist in configuration as retain options. diff --git a/nixos/modules/services/backup/sanoid.nix b/nixos/modules/services/backup/sanoid.nix index 5eb031b2e9f09..847b8507f7038 100644 --- a/nixos/modules/services/backup/sanoid.nix +++ b/nixos/modules/services/backup/sanoid.nix @@ -12,37 +12,37 @@ let commonOptions = { hourly = mkOption { - description = "Number of hourly snapshots."; + description = lib.mdDoc "Number of hourly snapshots."; type = with types; nullOr ints.unsigned; default = null; }; daily = mkOption { - description = "Number of daily snapshots."; + description = lib.mdDoc "Number of daily snapshots."; type = with types; nullOr ints.unsigned; default = null; }; monthly = mkOption { - description = "Number of monthly snapshots."; + description = lib.mdDoc "Number of monthly snapshots."; type = with types; nullOr ints.unsigned; default = null; }; yearly = mkOption { - description = "Number of yearly snapshots."; + description = lib.mdDoc "Number of yearly snapshots."; type = with types; nullOr ints.unsigned; default = null; }; autoprune = mkOption { - description = "Whether to automatically prune old snapshots."; + description = lib.mdDoc "Whether to automatically prune old snapshots."; type = with types; nullOr bool; default = null; }; autosnap = mkOption { - description = "Whether to automatically take snapshots."; + description = lib.mdDoc "Whether to automatically take snapshots."; type = with types; nullOr bool; default = null; }; @@ -50,7 +50,7 @@ let datasetOptions = rec { use_template = mkOption { - description = "Names of the templates to use for this dataset."; + description = lib.mdDoc "Names of the templates to use for this dataset."; type = types.listOf (types.str // { check = (types.enum (attrNames cfg.templates)).check; description = "configured template name"; @@ -60,9 +60,9 @@ let useTemplate = use_template; recursive = mkOption { - description = '' + description = lib.mdDoc '' Whether to recursively snapshot dataset children. - You can also set this to <literal>"zfs"</literal> to handle datasets + You can also set this to `"zfs"` to handle datasets recursively in an atomic way without the possibility to override settings for child datasets. ''; @@ -71,7 +71,7 @@ let }; process_children_only = mkOption { - description = "Whether to only snapshot child datasets if recursing."; + description = lib.mdDoc "Whether to only snapshot child datasets if recursing."; type = types.bool; default = false; }; @@ -135,7 +135,7 @@ in config.process_children_only = mkAliasDefinitions (mkDefault options.processChildrenOnly or { }); })); default = { }; - description = "Datasets to snapshot."; + description = lib.mdDoc "Datasets to snapshot."; }; templates = mkOption { @@ -144,14 +144,14 @@ in options = commonOptions; }); default = { }; - description = "Templates for datasets."; + description = lib.mdDoc "Templates for datasets."; }; settings = mkOption { type = types.attrsOf datasetSettingsType; - description = '' + description = lib.mdDoc '' Free-form settings written directly to the config file. See - <link xlink:href="https://github.com/jimsalterjrs/sanoid/blob/master/sanoid.defaults.conf"/> + <https://github.com/jimsalterjrs/sanoid/blob/master/sanoid.defaults.conf> for allowed values. ''; }; @@ -160,9 +160,9 @@ in type = types.listOf types.str; default = [ ]; example = [ "--verbose" "--readonly" "--debug" ]; - description = '' + description = lib.mdDoc '' Extra arguments to pass to sanoid. See - <link xlink:href="https://github.com/jimsalterjrs/sanoid/#sanoid-command-line-options"/> + <https://github.com/jimsalterjrs/sanoid/#sanoid-command-line-options> for allowed options. ''; }; diff --git a/nixos/modules/services/backup/syncoid.nix b/nixos/modules/services/backup/syncoid.nix index 4df10f5ee02bf..e53528fb66fce 100644 --- a/nixos/modules/services/backup/syncoid.nix +++ b/nixos/modules/services/backup/syncoid.nix @@ -102,7 +102,7 @@ in type = types.str; default = "syncoid"; example = "backup"; - description = '' + description = lib.mdDoc '' The user for the service. ZFS privilege delegation will be automatically configured for any local pools used by syncoid if this option is set to a user other than root. The user will be given the @@ -116,7 +116,7 @@ in type = types.str; default = "syncoid"; example = "backup"; - description = "The group for the service."; + description = lib.mdDoc "The group for the service."; }; sshKey = mkOption { @@ -124,7 +124,7 @@ in # Prevent key from being copied to store apply = mapNullable toString; default = null; - description = '' + description = lib.mdDoc '' SSH private key file to use to login to the remote system. Can be overridden in individual commands. ''; @@ -134,10 +134,10 @@ in type = types.listOf types.str; # Permissions snapshot and destroy are in case --no-sync-snap is not used default = [ "bookmark" "hold" "send" "snapshot" "destroy" ]; - description = '' - Permissions granted for the <option>services.syncoid.user</option> user + description = lib.mdDoc '' + Permissions granted for the {option}`services.syncoid.user` user for local source datasets. See - <link xlink:href="https://openzfs.github.io/openzfs-docs/man/8/zfs-allow.8.html"/> + <https://openzfs.github.io/openzfs-docs/man/8/zfs-allow.8.html> for available permissions. ''; }; @@ -146,13 +146,13 @@ in type = types.listOf types.str; default = [ "change-key" "compression" "create" "mount" "mountpoint" "receive" "rollback" ]; example = [ "create" "mount" "receive" "rollback" ]; - description = '' - Permissions granted for the <option>services.syncoid.user</option> user + description = lib.mdDoc '' + Permissions granted for the {option}`services.syncoid.user` user for local target datasets. See - <link xlink:href="https://openzfs.github.io/openzfs-docs/man/8/zfs-allow.8.html"/> + <https://openzfs.github.io/openzfs-docs/man/8/zfs-allow.8.html> for available permissions. - Make sure to include the <literal>change-key</literal> permission if you send raw encrypted datasets, - the <literal>compression</literal> permission if you send raw compressed datasets, and so on. + Make sure to include the `change-key` permission if you send raw encrypted datasets, + the `compression` permission if you send raw compressed datasets, and so on. For remote target datasets you'll have to set your remote user permissions by yourself. ''; }; @@ -161,10 +161,10 @@ in type = types.listOf types.str; default = [ ]; example = [ "--no-sync-snap" ]; - description = '' + description = lib.mdDoc '' Arguments to add to every syncoid command, unless disabled for that command. See - <link xlink:href="https://github.com/jimsalterjrs/sanoid/#syncoid-command-line-options"/> + <https://github.com/jimsalterjrs/sanoid/#syncoid-command-line-options> for available options. ''; }; @@ -172,7 +172,7 @@ in service = mkOption { type = types.attrs; default = { }; - description = '' + description = lib.mdDoc '' Systemd configuration common to all syncoid services. ''; }; @@ -183,7 +183,7 @@ in source = mkOption { type = types.str; example = "pool/dataset"; - description = '' + description = lib.mdDoc '' Source ZFS dataset. Can be either local or remote. Defaults to the attribute name. ''; @@ -205,32 +205,32 @@ in type = types.nullOr types.path; # Prevent key from being copied to store apply = mapNullable toString; - description = '' + description = lib.mdDoc '' SSH private key file to use to login to the remote system. - Defaults to <option>services.syncoid.sshKey</option> option. + Defaults to {option}`services.syncoid.sshKey` option. ''; }; localSourceAllow = mkOption { type = types.listOf types.str; - description = '' - Permissions granted for the <option>services.syncoid.user</option> user + description = lib.mdDoc '' + Permissions granted for the {option}`services.syncoid.user` user for local source datasets. See - <link xlink:href="https://openzfs.github.io/openzfs-docs/man/8/zfs-allow.8.html"/> + <https://openzfs.github.io/openzfs-docs/man/8/zfs-allow.8.html> for available permissions. - Defaults to <option>services.syncoid.localSourceAllow</option> option. + Defaults to {option}`services.syncoid.localSourceAllow` option. ''; }; localTargetAllow = mkOption { type = types.listOf types.str; - description = '' - Permissions granted for the <option>services.syncoid.user</option> user + description = lib.mdDoc '' + Permissions granted for the {option}`services.syncoid.user` user for local target datasets. See - <link xlink:href="https://openzfs.github.io/openzfs-docs/man/8/zfs-allow.8.html"/> + <https://openzfs.github.io/openzfs-docs/man/8/zfs-allow.8.html> for available permissions. - Make sure to include the <literal>change-key</literal> permission if you send raw encrypted datasets, - the <literal>compression</literal> permission if you send raw compressed datasets, and so on. + Make sure to include the `change-key` permission if you send raw encrypted datasets, + the `compression` permission if you send raw compressed datasets, and so on. For remote target datasets you'll have to set your remote user permissions by yourself. ''; }; @@ -239,7 +239,7 @@ in type = types.separatedString " "; default = ""; example = "Lc e"; - description = '' + description = lib.mdDoc '' Advanced options to pass to zfs send. Options are specified without their leading dashes and separated by spaces. ''; @@ -249,7 +249,7 @@ in type = types.separatedString " "; default = ""; example = "ux recordsize o compression=lz4"; - description = '' + description = lib.mdDoc '' Advanced options to pass to zfs recv. Options are specified without their leading dashes and separated by spaces. ''; @@ -258,7 +258,7 @@ in useCommonArgs = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to add the configured common arguments to this command. ''; }; @@ -266,7 +266,7 @@ in service = mkOption { type = types.attrs; default = { }; - description = '' + description = lib.mdDoc '' Systemd configuration specific to this syncoid service. ''; }; @@ -275,7 +275,7 @@ in type = types.listOf types.str; default = [ ]; example = [ "--sshport 2222" ]; - description = "Extra syncoid arguments for this command."; + description = lib.mdDoc "Extra syncoid arguments for this command."; }; }; config = { @@ -291,7 +291,7 @@ in "pool/test".target = "root@target:pool/test"; } ''; - description = "Syncoid commands to run."; + description = lib.mdDoc "Syncoid commands to run."; }; }; diff --git a/nixos/modules/services/backup/tarsnap.nix b/nixos/modules/services/backup/tarsnap.nix index 9b5fd90012e0e..965166479be56 100644 --- a/nixos/modules/services/backup/tarsnap.nix +++ b/nixos/modules/services/backup/tarsnap.nix @@ -35,10 +35,10 @@ in keyfile = mkOption { type = types.str; default = "/root/tarsnap.key"; - description = '' + description = lib.mdDoc '' The keyfile which associates this machine with your tarsnap account. - Create the keyfile with <command>tarsnap-keygen</command>. + Create the keyfile with {command}`tarsnap-keygen`. Note that each individual archive (specified below) may also have its own individual keyfile specified. Tarsnap does not allow multiple @@ -47,11 +47,11 @@ in archives specified, you should either spread out your backups to be far apart, or specify a separate key for each archive. By default every archive defaults to using - <literal>"/root/tarsnap.key"</literal>. + `"/root/tarsnap.key"`. It's recommended for backups that you generate a key for every archive - using <literal>tarsnap-keygen(1)</literal>, and then generate a - write-only tarsnap key using <literal>tarsnap-keymgmt(1)</literal>, + using `tarsnap-keygen(1)`, and then generate a + write-only tarsnap key using `tarsnap-keymgmt(1)`, and keep your master key(s) for a particular machine off-site. The keyfile name should be given as a string and not a path, to @@ -67,18 +67,18 @@ in type = types.str; default = gcfg.keyfile; defaultText = literalExpression "config.${opt.keyfile}"; - description = '' + description = lib.mdDoc '' Set a specific keyfile for this archive. This defaults to - <literal>"/root/tarsnap.key"</literal> if left unspecified. + `"/root/tarsnap.key"` if left unspecified. Use this option if you want to run multiple backups concurrently - each archive must have a unique key. You can generate a write-only key derived from your master key (which - is recommended) using <literal>tarsnap-keymgmt(1)</literal>. + is recommended) using `tarsnap-keymgmt(1)`. Note: every archive must have an individual master key. You must generate multiple keys with - <literal>tarsnap-keygen(1)</literal>, and then generate write + `tarsnap-keygen(1)`, and then generate write only keys from those. The keyfile name should be given as a string and not a path, to @@ -92,47 +92,47 @@ in defaultText = literalExpression '' "/var/cache/tarsnap/''${utils.escapeSystemdPath config.${options.keyfile}}" ''; - description = '' + description = lib.mdDoc '' The cache allows tarsnap to identify previously stored data blocks, reducing archival time and bandwidth usage. Should the cache become desynchronized or corrupted, tarsnap will refuse to run until you manually rebuild the cache with - <command>tarsnap --fsck</command>. + {command}`tarsnap --fsck`. - Set to <literal>null</literal> to disable caching. + Set to `null` to disable caching. ''; }; nodump = mkOption { type = types.bool; default = true; - description = '' - Exclude files with the <literal>nodump</literal> flag. + description = lib.mdDoc '' + Exclude files with the `nodump` flag. ''; }; printStats = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Print global archive statistics upon completion. The output is available via - <command>systemctl status tarsnap-archive-name</command>. + {command}`systemctl status tarsnap-archive-name`. ''; }; checkpointBytes = mkOption { type = types.nullOr types.str; default = "1GB"; - description = '' - Create a checkpoint every <literal>checkpointBytes</literal> + description = lib.mdDoc '' + Create a checkpoint every `checkpointBytes` of uploaded data (optionally specified using an SI prefix). 1GB is the minimum value. A higher value is recommended, as checkpointing is expensive. - Set to <literal>null</literal> to disable checkpointing. + Set to `null` to disable checkpointing. ''; }; @@ -152,7 +152,7 @@ in aggressiveNetworking = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Upload data over multiple TCP connections, potentially increasing tarsnap's bandwidth utilisation at the cost of slowing down all other network traffic. Not @@ -164,13 +164,13 @@ in directories = mkOption { type = types.listOf types.path; default = []; - description = "List of filesystem paths to archive."; + description = lib.mdDoc "List of filesystem paths to archive."; }; excludes = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Exclude files and directories matching these patterns. ''; }; @@ -178,7 +178,7 @@ in includes = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Include only files and directories matching these patterns (the empty list includes everything). @@ -189,7 +189,7 @@ in lowmem = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Reduce memory consumption by not caching small files. Possibly beneficial if the average file size is smaller than 1 MB and the number of files is lower than the @@ -200,9 +200,9 @@ in verylowmem = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Reduce memory consumption by a factor of 2 beyond what - <literal>lowmem</literal> does, at the cost of significantly + `lowmem` does, at the cost of significantly slowing down the archiving process. ''; }; @@ -210,7 +210,7 @@ in maxbw = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Abort archival if upstream bandwidth usage in bytes exceeds this threshold. ''; @@ -220,7 +220,7 @@ in type = types.nullOr types.int; default = null; example = literalExpression "25 * 1000"; - description = '' + description = lib.mdDoc '' Upload bandwidth rate limit in bytes. ''; }; @@ -229,7 +229,7 @@ in type = types.nullOr types.int; default = null; example = literalExpression "50 * 1000"; - description = '' + description = lib.mdDoc '' Download bandwidth rate limit in bytes. ''; }; @@ -237,21 +237,21 @@ in verbose = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to produce verbose logging output. ''; }; explicitSymlinks = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to follow symlinks specified as archives. ''; }; followSymlinks = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to follow all symlinks in archive trees. ''; }; @@ -274,17 +274,17 @@ in } ''; - description = '' + description = lib.mdDoc '' Tarsnap archive configurations. Each attribute names an archive to be created at a given time interval, according to the options associated with it. When uploading to the tarsnap server, archive names are suffixed by a 1 second resolution timestamp, - with the format <literal>%Y%m%d%H%M%S</literal>. + with the format `%Y%m%d%H%M%S`. For each member of the set is created a timer which triggers the - instanced <literal>tarsnap-archive-name</literal> service unit. You may use - <command>systemctl start tarsnap-archive-name</command> to - manually trigger creation of <literal>archive-name</literal> at + instanced `tarsnap-archive-name` service unit. You may use + {command}`systemctl start tarsnap-archive-name` to + manually trigger creation of `archive-name` at any time. ''; }; diff --git a/nixos/modules/services/backup/tsm.nix b/nixos/modules/services/backup/tsm.nix index 4e690ac6ecda1..bd6f3d71fe6c6 100644 --- a/nixos/modules/services/backup/tsm.nix +++ b/nixos/modules/services/backup/tsm.nix @@ -18,38 +18,38 @@ let type = nonEmptyStr; default = "backup"; example = "incr"; - description = '' + description = lib.mdDoc '' The actual command passed to the - <literal>dsmc</literal> executable to start the backup. + `dsmc` executable to start the backup. ''; }; servername = mkOption { type = nonEmptyStr; example = "mainTsmServer"; - description = '' + description = lib.mdDoc '' Create a systemd system service - <literal>tsm-backup.service</literal> that starts + `tsm-backup.service` that starts a backup based on the given servername's stanza. Note that this server's - <option>passwdDir</option> will default to - <filename>/var/lib/tsm-backup/password</filename> + {option}`passwdDir` will default to + {file}`/var/lib/tsm-backup/password` (but may be overridden); also, the service will use - <filename>/var/lib/tsm-backup</filename> as - <literal>HOME</literal> when calling - <literal>dsmc</literal>. + {file}`/var/lib/tsm-backup` as + `HOME` when calling + `dsmc`. ''; }; autoTime = mkOption { type = nullOr nonEmptyStr; default = null; example = "12:00"; - description = '' + description = lib.mdDoc '' The backup service will be invoked automatically at the given date/time, which must be in the format described in - <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>5</manvolnum></citerefentry>. - The default <literal>null</literal> + {manpage}`systemd.time(5)`. + The default `null` disables automatic backups. ''; }; diff --git a/nixos/modules/services/backup/zfs-replication.nix b/nixos/modules/services/backup/zfs-replication.nix index 6d75774c78f91..1a089bb34866b 100644 --- a/nixos/modules/services/backup/zfs-replication.nix +++ b/nixos/modules/services/backup/zfs-replication.nix @@ -12,43 +12,43 @@ in { enable = mkEnableOption "ZFS snapshot replication."; followDelete = mkOption { - description = "Remove remote snapshots that don't have a local correspondant."; + description = lib.mdDoc "Remove remote snapshots that don't have a local correspondant."; default = true; type = types.bool; }; host = mkOption { - description = "Remote host where snapshots should be sent. <literal>lz4</literal> is expected to be installed on this host."; + description = lib.mdDoc "Remote host where snapshots should be sent. `lz4` is expected to be installed on this host."; example = "example.com"; type = types.str; }; identityFilePath = mkOption { - description = "Path to SSH key used to login to host."; + description = lib.mdDoc "Path to SSH key used to login to host."; example = "/home/username/.ssh/id_rsa"; type = types.path; }; localFilesystem = mkOption { - description = "Local ZFS fileystem from which snapshots should be sent. Defaults to the attribute name."; + description = lib.mdDoc "Local ZFS fileystem from which snapshots should be sent. Defaults to the attribute name."; example = "pool/file/path"; type = types.str; }; remoteFilesystem = mkOption { - description = "Remote ZFS filesystem where snapshots should be sent."; + description = lib.mdDoc "Remote ZFS filesystem where snapshots should be sent."; example = "pool/file/path"; type = types.str; }; recursive = mkOption { - description = "Recursively discover snapshots to send."; + description = lib.mdDoc "Recursively discover snapshots to send."; default = true; type = types.bool; }; username = mkOption { - description = "Username used by SSH to login to remote host."; + description = lib.mdDoc "Username used by SSH to login to remote host."; example = "username"; type = types.str; }; diff --git a/nixos/modules/services/backup/znapzend.nix b/nixos/modules/services/backup/znapzend.nix index 09e60177c3909..ecd90ba5b30a3 100644 --- a/nixos/modules/services/backup/znapzend.nix +++ b/nixos/modules/services/backup/znapzend.nix @@ -52,7 +52,7 @@ let label = mkOption { type = str; - description = "Label for this destination. Defaults to the attribute name."; + description = lib.mdDoc "Label for this destination. Defaults to the attribute name."; }; plan = mkOption { @@ -63,15 +63,15 @@ let dataset = mkOption { type = str; - description = "Dataset name to send snapshots to."; + description = lib.mdDoc "Dataset name to send snapshots to."; example = "tank/main"; }; host = mkOption { type = nullOr str; - description = '' + description = lib.mdDoc '' Host to use for the destination dataset. Can be prefixed with - <literal>user@</literal> to specify the ssh user. + `user@` to specify the ssh user. ''; default = null; example = "john@example.com"; @@ -79,11 +79,11 @@ let presend = mkOption { type = nullOr str; - description = '' + description = lib.mdDoc '' Command to run before sending the snapshot to the destination. - Intended to run a remote script via <command>ssh</command> on the + Intended to run a remote script via {command}`ssh` on the destination, e.g. to bring up a backup disk or server or to put a - zpool online/offline. See also <option>postsend</option>. + zpool online/offline. See also {option}`postsend`. ''; default = null; example = "ssh root@bserv zpool import -Nf tank"; @@ -91,11 +91,11 @@ let postsend = mkOption { type = nullOr str; - description = '' + description = lib.mdDoc '' Command to run after sending the snapshot to the destination. - Intended to run a remote script via <command>ssh</command> on the + Intended to run a remote script via {command}`ssh` on the destination, e.g. to bring up a backup disk or server or to put a - zpool online/offline. See also <option>presend</option>. + zpool online/offline. See also {option}`presend`. ''; default = null; example = "ssh root@bserv zpool export tank"; @@ -115,32 +115,32 @@ let enable = mkOption { type = bool; - description = "Whether to enable this source."; + description = lib.mdDoc "Whether to enable this source."; default = true; }; recursive = mkOption { type = bool; - description = "Whether to do recursive snapshots."; + description = lib.mdDoc "Whether to do recursive snapshots."; default = false; }; mbuffer = { enable = mkOption { type = bool; - description = "Whether to use <command>mbuffer</command>."; + description = lib.mdDoc "Whether to use {command}`mbuffer`."; default = false; }; port = mkOption { type = nullOr ints.u16; - description = '' - Port to use for <command>mbuffer</command>. + description = lib.mdDoc '' + Port to use for {command}`mbuffer`. - If this is null, it will run <command>mbuffer</command> through + If this is null, it will run {command}`mbuffer` through ssh. - If this is not null, it will run <command>mbuffer</command> + If this is not null, it will run {command}`mbuffer` directly through TCP, which is not encrypted but faster. In that case the given port needs to be open on the destination host. ''; @@ -149,8 +149,8 @@ let size = mkOption { type = mbufferSizeType; - description = '' - The size for <command>mbuffer</command>. + description = lib.mdDoc '' + The size for {command}`mbuffer`. Supports the units b, k, M, G. ''; default = "1G"; @@ -160,10 +160,10 @@ let presnap = mkOption { type = nullOr str; - description = '' + description = lib.mdDoc '' Command to run before snapshots are taken on the source dataset, e.g. for database locking/flushing. See also - <option>postsnap</option>. + {option}`postsnap`. ''; default = null; example = literalExpression '' @@ -173,9 +173,9 @@ let postsnap = mkOption { type = nullOr str; - description = '' + description = lib.mdDoc '' Command to run after snapshots are taken on the source dataset, - e.g. for database unlocking. See also <option>presnap</option>. + e.g. for database unlocking. See also {option}`presnap`. ''; default = null; example = literalExpression '' @@ -185,13 +185,13 @@ let timestampFormat = mkOption { type = timestampType; - description = '' + description = lib.mdDoc '' The timestamp format to use for constructing snapshot names. - The syntax is <literal>strftime</literal>-like. The string must - consist of the mandatory <literal>%Y %m %d %H %M %S</literal>. - Optionally <literal>- _ . :</literal> characters as well as any + The syntax is `strftime`-like. The string must + consist of the mandatory `%Y %m %d %H %M %S`. + Optionally `- _ . :` characters as well as any alphanumeric character are allowed. If suffixed by a - <literal>Z</literal>, times will be in UTC. + `Z`, times will be in UTC. ''; default = "%Y-%m-%d-%H%M%S"; example = "znapzend-%m.%d.%Y-%H%M%SZ"; @@ -199,7 +199,7 @@ let sendDelay = mkOption { type = int; - description = '' + description = lib.mdDoc '' Specify delay (in seconds) before sending snaps to the destination. May be useful if you want to control sending time. ''; @@ -215,13 +215,13 @@ let dataset = mkOption { type = str; - description = "The dataset to use for this source."; + description = lib.mdDoc "The dataset to use for this source."; example = "tank/home"; }; destinations = mkOption { type = attrsOf (destType config); - description = "Additional destinations."; + description = lib.mdDoc "Additional destinations."; default = {}; example = literalExpression '' { @@ -300,7 +300,7 @@ in default = "debug"; example = "warning"; type = enum ["debug" "info" "warning" "err" "alert"]; - description = '' + description = lib.mdDoc '' The log level when logging to file. Any of debug, info, warning, err, alert. Default in daemonized form is debug. ''; @@ -318,18 +318,18 @@ in noDestroy = mkOption { type = bool; default = false; - description = "Does all changes to the filesystem except destroy."; + description = lib.mdDoc "Does all changes to the filesystem except destroy."; }; autoCreation = mkOption { type = bool; default = false; - description = "Automatically create the destination dataset if it does not exist."; + description = lib.mdDoc "Automatically create the destination dataset if it does not exist."; }; zetup = mkOption { type = attrsOf srcType; - description = "Znapzend configuration."; + description = lib.mdDoc "Znapzend configuration."; default = {}; example = literalExpression '' { @@ -350,7 +350,7 @@ in pure = mkOption { type = bool; - description = '' + description = lib.mdDoc '' Do not persist any stateful znapzend setups. If this option is enabled, your previously set znapzend setups will be cleared and only the ones defined with this module will be applied. diff --git a/nixos/modules/services/backup/zrepl.nix b/nixos/modules/services/backup/zrepl.nix index 1b4216ed1714a..e3a9009126455 100644 --- a/nixos/modules/services/backup/zrepl.nix +++ b/nixos/modules/services/backup/zrepl.nix @@ -17,7 +17,7 @@ in type = types.package; default = pkgs.zrepl; defaultText = literalExpression "pkgs.zrepl"; - description = "Which package to use for zrepl"; + description = lib.mdDoc "Which package to use for zrepl"; }; settings = mkOption { diff --git a/nixos/modules/services/blockchain/ethereum/geth.nix b/nixos/modules/services/blockchain/ethereum/geth.nix index bf2cf1edd4d8d..4f045acd95688 100644 --- a/nixos/modules/services/blockchain/ethereum/geth.nix +++ b/nixos/modules/services/blockchain/ethereum/geth.nix @@ -14,7 +14,7 @@ let port = mkOption { type = types.port; default = 30303; - description = "Port number Go Ethereum will be listening on, both TCP and UDP."; + description = lib.mdDoc "Port number Go Ethereum will be listening on, both TCP and UDP."; }; http = { @@ -22,19 +22,19 @@ let address = mkOption { type = types.str; default = "127.0.0.1"; - description = "Listen address of Go Ethereum HTTP API."; + description = lib.mdDoc "Listen address of Go Ethereum HTTP API."; }; port = mkOption { type = types.port; default = 8545; - description = "Port number of Go Ethereum HTTP API."; + description = lib.mdDoc "Port number of Go Ethereum HTTP API."; }; apis = mkOption { type = types.nullOr (types.listOf types.str); default = null; - description = "APIs to enable over WebSocket"; + description = lib.mdDoc "APIs to enable over WebSocket"; example = ["net" "eth"]; }; }; @@ -44,19 +44,19 @@ let address = mkOption { type = types.str; default = "127.0.0.1"; - description = "Listen address of Go Ethereum WebSocket API."; + description = lib.mdDoc "Listen address of Go Ethereum WebSocket API."; }; port = mkOption { type = types.port; default = 8546; - description = "Port number of Go Ethereum WebSocket API."; + description = lib.mdDoc "Port number of Go Ethereum WebSocket API."; }; apis = mkOption { type = types.nullOr (types.listOf types.str); default = null; - description = "APIs to enable over WebSocket"; + description = lib.mdDoc "APIs to enable over WebSocket"; example = ["net" "eth"]; }; }; @@ -66,43 +66,43 @@ let address = mkOption { type = types.str; default = "127.0.0.1"; - description = "Listen address of Go Ethereum metrics service."; + description = lib.mdDoc "Listen address of Go Ethereum metrics service."; }; port = mkOption { type = types.port; default = 6060; - description = "Port number of Go Ethereum metrics service."; + description = lib.mdDoc "Port number of Go Ethereum metrics service."; }; }; network = mkOption { type = types.nullOr (types.enum [ "goerli" "rinkeby" "yolov2" "ropsten" ]); default = null; - description = "The network to connect to. Mainnet (null) is the default ethereum network."; + description = lib.mdDoc "The network to connect to. Mainnet (null) is the default ethereum network."; }; syncmode = mkOption { type = types.enum [ "snap" "fast" "full" "light" ]; default = "snap"; - description = "Blockchain sync mode."; + description = lib.mdDoc "Blockchain sync mode."; }; gcmode = mkOption { type = types.enum [ "full" "archive" ]; default = "full"; - description = "Blockchain garbage collection mode."; + description = lib.mdDoc "Blockchain garbage collection mode."; }; maxpeers = mkOption { type = types.int; default = 50; - description = "Maximum peers to connect to."; + description = lib.mdDoc "Maximum peers to connect to."; }; extraArgs = mkOption { type = types.listOf types.str; - description = "Additional arguments passed to Go Ethereum."; + description = lib.mdDoc "Additional arguments passed to Go Ethereum."; default = []; }; @@ -110,7 +110,7 @@ let default = pkgs.go-ethereum.geth; defaultText = literalExpression "pkgs.go-ethereum.geth"; type = types.package; - description = "Package to use as Go Ethereum node."; + description = lib.mdDoc "Package to use as Go Ethereum node."; }; }; }; @@ -124,7 +124,7 @@ in services.geth = mkOption { type = types.attrsOf (types.submodule gethOpts); default = {}; - description = "Specification of one or more geth instances."; + description = lib.mdDoc "Specification of one or more geth instances."; }; }; diff --git a/nixos/modules/services/cluster/corosync/default.nix b/nixos/modules/services/cluster/corosync/default.nix index b4144917feea9..9730894454167 100644 --- a/nixos/modules/services/cluster/corosync/default.nix +++ b/nixos/modules/services/cluster/corosync/default.nix @@ -13,37 +13,37 @@ in type = types.package; default = pkgs.corosync; defaultText = literalExpression "pkgs.corosync"; - description = "Package that should be used for corosync."; + description = lib.mdDoc "Package that should be used for corosync."; }; clusterName = mkOption { type = types.str; default = "nixcluster"; - description = "Name of the corosync cluster."; + description = lib.mdDoc "Name of the corosync cluster."; }; extraOptions = mkOption { type = with types; listOf str; default = []; - description = "Additional options with which to start corosync."; + description = lib.mdDoc "Additional options with which to start corosync."; }; nodelist = mkOption { - description = "Corosync nodelist: all cluster members."; + description = lib.mdDoc "Corosync nodelist: all cluster members."; default = []; type = with types; listOf (submodule { options = { nodeid = mkOption { type = int; - description = "Node ID number"; + description = lib.mdDoc "Node ID number"; }; name = mkOption { type = str; - description = "Node name"; + description = lib.mdDoc "Node name"; }; ring_addrs = mkOption { type = listOf str; - description = "List of addresses, one for each ring."; + description = lib.mdDoc "List of addresses, one for each ring."; }; }; }); diff --git a/nixos/modules/services/cluster/hadoop/hdfs.nix b/nixos/modules/services/cluster/hadoop/hdfs.nix index 325a002ad32fc..6c185b9cd2450 100644 --- a/nixos/modules/services/cluster/hadoop/hdfs.nix +++ b/nixos/modules/services/cluster/hadoop/hdfs.nix @@ -11,7 +11,7 @@ let enable = mkEnableOption serviceName; restartIfChanged = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Automatically restart the service on config change. This can be set to false to defer restarts on clusters running critical applications. Please consider the security implications of inadvertently running an older version, @@ -22,7 +22,7 @@ let extraFlags = mkOption{ type = with types; listOf str; default = []; - description = "Extra command line flags to pass to ${serviceName}"; + description = lib.mdDoc "Extra command line flags to pass to ${serviceName}"; example = [ "-Dcom.sun.management.jmxremote" "-Dcom.sun.management.jmxremote.port=8010" @@ -31,13 +31,13 @@ let extraEnv = mkOption{ type = with types; attrsOf str; default = {}; - description = "Extra environment variables for ${serviceName}"; + description = lib.mdDoc "Extra environment variables for ${serviceName}"; }; } // (optionalAttrs firewallOption { openFirewall = mkOption { type = types.bool; default = false; - description = "Open firewall ports for ${serviceName}."; + description = lib.mdDoc "Open firewall ports for ${serviceName}."; }; }) // (optionalAttrs (extraOpts != null) extraOpts); @@ -83,12 +83,12 @@ in formatOnInit = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Format HDFS namenode on first start. This is useful for quickly spinning up ephemeral HDFS clusters with a single namenode. For HA clusters, initialization involves multiple steps across multiple nodes. Follow this guide to initialize an HA cluster manually: - <link xlink:href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HDFSHighAvailabilityWithQJM.html"/> + <https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HDFSHighAvailabilityWithQJM.html> ''; }; }; @@ -96,19 +96,19 @@ in datanode = hadoopServiceOption { serviceName = "HDFS DataNode"; } // { dataDirs = mkOption { default = null; - description = "Tier and path definitions for datanode storage."; + description = lib.mdDoc "Tier and path definitions for datanode storage."; type = with types; nullOr (listOf (submodule { options = { type = mkOption { type = enum [ "SSD" "DISK" "ARCHIVE" "RAM_DISK" ]; - description = '' + description = lib.mdDoc '' Storage types ([SSD]/[DISK]/[ARCHIVE]/[RAM_DISK]) for HDFS storage policies. ''; }; path = mkOption { type = path; example = [ "/var/lib/hadoop/hdfs/dn" ]; - description = "Determines where on the local filesystem a data node should store its blocks."; + description = lib.mdDoc "Determines where on the local filesystem a data node should store its blocks."; }; }; })); @@ -126,7 +126,7 @@ in tempPath = mkOption { type = types.path; default = "/tmp/hadoop/httpfs"; - description = "HTTPFS_TEMP path used by HTTPFS"; + description = lib.mdDoc "HTTPFS_TEMP path used by HTTPFS"; }; }; diff --git a/nixos/modules/services/cluster/hadoop/yarn.nix b/nixos/modules/services/cluster/hadoop/yarn.nix index 74e16bdec687a..0a03fe6dab696 100644 --- a/nixos/modules/services/cluster/hadoop/yarn.nix +++ b/nixos/modules/services/cluster/hadoop/yarn.nix @@ -5,7 +5,7 @@ let hadoopConf = "${import ./conf.nix { inherit cfg pkgs lib; }}/"; restartIfChanged = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Automatically restart the service on config change. This can be set to false to defer restarts on clusters running critical applications. Please consider the security implications of inadvertently running an older version, @@ -16,7 +16,7 @@ let extraFlags = mkOption{ type = with types; listOf str; default = []; - description = "Extra command line flags to pass to the service"; + description = lib.mdDoc "Extra command line flags to pass to the service"; example = [ "-Dcom.sun.management.jmxremote" "-Dcom.sun.management.jmxremote.port=8010" @@ -25,7 +25,7 @@ let extraEnv = mkOption{ type = with types; attrsOf str; default = {}; - description = "Extra environment variables"; + description = lib.mdDoc "Extra environment variables"; }; in { @@ -37,7 +37,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open firewall ports for resourcemanager ''; }; @@ -48,22 +48,22 @@ in resource = { cpuVCores = mkOption { - description = "Number of vcores that can be allocated for containers."; + description = lib.mdDoc "Number of vcores that can be allocated for containers."; type = with types; nullOr ints.positive; default = null; }; maximumAllocationVCores = mkOption { - description = "The maximum virtual CPU cores any container can be allocated."; + description = lib.mdDoc "The maximum virtual CPU cores any container can be allocated."; type = with types; nullOr ints.positive; default = null; }; memoryMB = mkOption { - description = "Amount of physical memory, in MB, that can be allocated for containers."; + description = lib.mdDoc "Amount of physical memory, in MB, that can be allocated for containers."; type = with types; nullOr ints.positive; default = null; }; maximumAllocationMB = mkOption { - description = "The maximum physical memory any container can be allocated."; + description = lib.mdDoc "The maximum physical memory any container can be allocated."; type = with types; nullOr ints.positive; default = null; }; @@ -72,13 +72,13 @@ in useCGroups = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Use cgroups to enforce resource limits on containers ''; }; localDir = mkOption { - description = "List of directories to store localized files in."; + description = lib.mdDoc "List of directories to store localized files in."; type = with types; nullOr (listOf path); example = [ "/var/lib/hadoop/yarn/nm" ]; default = null; @@ -87,14 +87,14 @@ in addBinBash = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Add /bin/bash. This is needed by the linux container executor's launch script. ''; }; openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open firewall ports for nodemanager. Because containers can listen on any ephemeral port, TCP ports 1024–65535 will be opened. ''; diff --git a/nixos/modules/services/cluster/k3s/default.nix b/nixos/modules/services/cluster/k3s/default.nix index bc5e8c66e2a5f..a1f6d4ecdfad1 100644 --- a/nixos/modules/services/cluster/k3s/default.nix +++ b/nixos/modules/services/cluster/k3s/default.nix @@ -19,11 +19,11 @@ in type = types.package; default = pkgs.k3s; defaultText = literalExpression "pkgs.k3s"; - description = "Package that should be used for k3s"; + description = lib.mdDoc "Package that should be used for k3s"; }; role = mkOption { - description = '' + description = lib.mdDoc '' Whether k3s should run as a server or agent. Note that the server, by default, also runs as an agent. ''; @@ -33,14 +33,14 @@ in serverAddr = mkOption { type = types.str; - description = "The k3s server to connect to. This option only makes sense for an agent."; + description = lib.mdDoc "The k3s server to connect to. This option only makes sense for an agent."; example = "https://10.0.0.10:6443"; default = ""; }; token = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The k3s token to use when connecting to the server. This option only makes sense for an agent. WARNING: This option will expose store your token unencrypted world-readable in the nix store. If this is undesired use the tokenFile option instead. @@ -50,12 +50,12 @@ in tokenFile = mkOption { type = types.nullOr types.path; - description = "File path containing k3s token to use when connecting to the server. This option only makes sense for an agent."; + description = lib.mdDoc "File path containing k3s token to use when connecting to the server. This option only makes sense for an agent."; default = null; }; extraFlags = mkOption { - description = "Extra flags to pass to the k3s command."; + description = lib.mdDoc "Extra flags to pass to the k3s command."; type = types.str; default = ""; example = "--no-deploy traefik --cluster-cidr 10.24.0.0/16"; @@ -64,13 +64,13 @@ in disableAgent = mkOption { type = types.bool; default = false; - description = "Only run the server. This option only makes sense for a server."; + description = lib.mdDoc "Only run the server. This option only makes sense for a server."; }; configPath = mkOption { type = types.nullOr types.path; default = null; - description = "File path containing the k3s YAML config. This is useful when the config is generated (for example on boot)."; + description = lib.mdDoc "File path containing the k3s YAML config. This is useful when the config is generated (for example on boot)."; }; }; diff --git a/nixos/modules/services/cluster/kubernetes/addon-manager.nix b/nixos/modules/services/cluster/kubernetes/addon-manager.nix index b677d900ff50a..99fd1e6f04925 100644 --- a/nixos/modules/services/cluster/kubernetes/addon-manager.nix +++ b/nixos/modules/services/cluster/kubernetes/addon-manager.nix @@ -21,7 +21,7 @@ in options.services.kubernetes.addonManager = with lib.types; { bootstrapAddons = mkOption { - description = '' + description = lib.mdDoc '' Bootstrap addons are like regular addons, but they are applied with cluster-admin rigths. They are applied at addon-manager startup only. ''; @@ -43,7 +43,7 @@ in }; addons = mkOption { - description = "Kubernetes addons (any kind of Kubernetes resource can be an addon)."; + description = lib.mdDoc "Kubernetes addons (any kind of Kubernetes resource can be an addon)."; default = { }; type = attrsOf (either attrs (listOf attrs)); example = literalExpression '' diff --git a/nixos/modules/services/cluster/kubernetes/addons/dns.nix b/nixos/modules/services/cluster/kubernetes/addons/dns.nix index 7bd4991f43f7b..5b1e9a6876826 100644 --- a/nixos/modules/services/cluster/kubernetes/addons/dns.nix +++ b/nixos/modules/services/cluster/kubernetes/addons/dns.nix @@ -15,7 +15,7 @@ in { enable = mkEnableOption "kubernetes dns addon"; clusterIp = mkOption { - description = "Dns addon clusterIP"; + description = lib.mdDoc "Dns addon clusterIP"; # this default is also what kubernetes users default = ( @@ -31,31 +31,31 @@ in { }; clusterDomain = mkOption { - description = "Dns cluster domain"; + description = lib.mdDoc "Dns cluster domain"; default = "cluster.local"; type = types.str; }; replicas = mkOption { - description = "Number of DNS pod replicas to deploy in the cluster."; + description = lib.mdDoc "Number of DNS pod replicas to deploy in the cluster."; default = 2; type = types.int; }; reconcileMode = mkOption { - description = '' + description = lib.mdDoc '' Controls the addon manager reconciliation mode for the DNS addon. Setting reconcile mode to EnsureExists makes it possible to tailor DNS behavior by editing the coredns ConfigMap. - See: <link xlink:href="https://github.com/kubernetes/kubernetes/blob/master/cluster/addons/addon-manager/README.md"/>. + See: <https://github.com/kubernetes/kubernetes/blob/master/cluster/addons/addon-manager/README.md>. ''; default = "Reconcile"; type = types.enum [ "Reconcile" "EnsureExists" ]; }; coredns = mkOption { - description = "Docker image to seed for the CoreDNS container."; + description = lib.mdDoc "Docker image to seed for the CoreDNS container."; type = types.attrs; default = { imageName = "coredns/coredns"; @@ -66,10 +66,10 @@ in { }; corefile = mkOption { - description = '' + description = lib.mdDoc '' Custom coredns corefile configuration. - See: <link xlink:href="https://coredns.io/manual/toc/#configuration"/>. + See: <https://coredns.io/manual/toc/#configuration>. ''; type = types.str; default = '' diff --git a/nixos/modules/services/cluster/kubernetes/apiserver.nix b/nixos/modules/services/cluster/kubernetes/apiserver.nix index a192e93badc23..c9ae2c14bbf94 100644 --- a/nixos/modules/services/cluster/kubernetes/apiserver.nix +++ b/nixos/modules/services/cluster/kubernetes/apiserver.nix @@ -30,7 +30,7 @@ in options.services.kubernetes.apiserver = with lib.types; { advertiseAddress = mkOption { - description = '' + description = lib.mdDoc '' Kubernetes apiserver IP address on which to advertise the apiserver to members of the cluster. This address must be reachable by the rest of the cluster. @@ -40,40 +40,40 @@ in }; allowPrivileged = mkOption { - description = "Whether to allow privileged containers on Kubernetes."; + description = lib.mdDoc "Whether to allow privileged containers on Kubernetes."; default = false; type = bool; }; authorizationMode = mkOption { - description = '' + description = lib.mdDoc '' Kubernetes apiserver authorization mode (AlwaysAllow/AlwaysDeny/ABAC/Webhook/RBAC/Node). See - <link xlink:href="https://kubernetes.io/docs/reference/access-authn-authz/authorization/"/> + <https://kubernetes.io/docs/reference/access-authn-authz/authorization/> ''; default = ["RBAC" "Node"]; # Enabling RBAC by default, although kubernetes default is AllowAllow type = listOf (enum ["AlwaysAllow" "AlwaysDeny" "ABAC" "Webhook" "RBAC" "Node"]); }; authorizationPolicy = mkOption { - description = '' + description = lib.mdDoc '' Kubernetes apiserver authorization policy file. See - <link xlink:href="https://kubernetes.io/docs/reference/access-authn-authz/authorization/"/> + <https://kubernetes.io/docs/reference/access-authn-authz/authorization/> ''; default = []; type = listOf attrs; }; basicAuthFile = mkOption { - description = '' + description = lib.mdDoc '' Kubernetes apiserver basic authentication file. See - <link xlink:href="https://kubernetes.io/docs/reference/access-authn-authz/authentication"/> + <https://kubernetes.io/docs/reference/access-authn-authz/authentication> ''; default = null; type = nullOr path; }; bindAddress = mkOption { - description = '' + description = lib.mdDoc '' The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. @@ -83,16 +83,16 @@ in }; clientCaFile = mkOption { - description = "Kubernetes apiserver CA file for client auth."; + description = lib.mdDoc "Kubernetes apiserver CA file for client auth."; default = top.caFile; defaultText = literalExpression "config.${otop.caFile}"; type = nullOr path; }; disableAdmissionPlugins = mkOption { - description = '' + description = lib.mdDoc '' Kubernetes admission control plugins to disable. See - <link xlink:href="https://kubernetes.io/docs/admin/admission-controllers/"/> + <https://kubernetes.io/docs/admin/admission-controllers/> ''; default = []; type = listOf str; @@ -101,9 +101,9 @@ in enable = mkEnableOption "Kubernetes apiserver"; enableAdmissionPlugins = mkOption { - description = '' + description = lib.mdDoc '' Kubernetes admission control plugins to enable. See - <link xlink:href="https://kubernetes.io/docs/admin/admission-controllers/"/> + <https://kubernetes.io/docs/admin/admission-controllers/> ''; default = [ "NamespaceLifecycle" "LimitRanger" "ServiceAccount" @@ -120,25 +120,25 @@ in etcd = { servers = mkOption { - description = "List of etcd servers."; + description = lib.mdDoc "List of etcd servers."; default = ["http://127.0.0.1:2379"]; type = types.listOf types.str; }; keyFile = mkOption { - description = "Etcd key file."; + description = lib.mdDoc "Etcd key file."; default = null; type = types.nullOr types.path; }; certFile = mkOption { - description = "Etcd cert file."; + description = lib.mdDoc "Etcd cert file."; default = null; type = types.nullOr types.path; }; caFile = mkOption { - description = "Etcd ca file."; + description = lib.mdDoc "Etcd ca file."; default = top.caFile; defaultText = literalExpression "config.${otop.caFile}"; type = types.nullOr types.path; @@ -146,77 +146,77 @@ in }; extraOpts = mkOption { - description = "Kubernetes apiserver extra command line options."; + description = lib.mdDoc "Kubernetes apiserver extra command line options."; default = ""; type = separatedString " "; }; extraSANs = mkOption { - description = "Extra x509 Subject Alternative Names to be added to the kubernetes apiserver tls cert."; + description = lib.mdDoc "Extra x509 Subject Alternative Names to be added to the kubernetes apiserver tls cert."; default = []; type = listOf str; }; featureGates = mkOption { - description = "List set of feature gates"; + description = lib.mdDoc "List set of feature gates"; default = top.featureGates; defaultText = literalExpression "config.${otop.featureGates}"; type = listOf str; }; insecureBindAddress = mkOption { - description = "The IP address on which to serve the --insecure-port."; + description = lib.mdDoc "The IP address on which to serve the --insecure-port."; default = "127.0.0.1"; type = str; }; insecurePort = mkOption { - description = "Kubernetes apiserver insecure listening port. (0 = disabled)"; + description = lib.mdDoc "Kubernetes apiserver insecure listening port. (0 = disabled)"; default = 0; type = int; }; kubeletClientCaFile = mkOption { - description = "Path to a cert file for connecting to kubelet."; + description = lib.mdDoc "Path to a cert file for connecting to kubelet."; default = top.caFile; defaultText = literalExpression "config.${otop.caFile}"; type = nullOr path; }; kubeletClientCertFile = mkOption { - description = "Client certificate to use for connections to kubelet."; + description = lib.mdDoc "Client certificate to use for connections to kubelet."; default = null; type = nullOr path; }; kubeletClientKeyFile = mkOption { - description = "Key to use for connections to kubelet."; + description = lib.mdDoc "Key to use for connections to kubelet."; default = null; type = nullOr path; }; preferredAddressTypes = mkOption { - description = "List of the preferred NodeAddressTypes to use for kubelet connections."; + description = lib.mdDoc "List of the preferred NodeAddressTypes to use for kubelet connections."; type = nullOr str; default = null; }; proxyClientCertFile = mkOption { - description = "Client certificate to use for connections to proxy."; + description = lib.mdDoc "Client certificate to use for connections to proxy."; default = null; type = nullOr path; }; proxyClientKeyFile = mkOption { - description = "Key to use for connections to proxy."; + description = lib.mdDoc "Key to use for connections to proxy."; default = null; type = nullOr path; }; runtimeConfig = mkOption { - description = '' + description = lib.mdDoc '' Api runtime configuration. See - <link xlink:href="https://kubernetes.io/docs/tasks/administer-cluster/cluster-management/"/> + <https://kubernetes.io/docs/tasks/administer-cluster/cluster-management/> ''; default = "authentication.k8s.io/v1beta1=true"; example = "api/all=false,api/v1=true"; @@ -224,7 +224,7 @@ in }; storageBackend = mkOption { - description = '' + description = lib.mdDoc '' Kubernetes apiserver storage backend. ''; default = "etcd3"; @@ -232,13 +232,13 @@ in }; securePort = mkOption { - description = "Kubernetes apiserver secure port."; + description = lib.mdDoc "Kubernetes apiserver secure port."; default = 6443; type = int; }; apiAudiences = mkOption { - description = '' + description = lib.mdDoc '' Kubernetes apiserver ServiceAccount issuer. ''; default = "api,https://kubernetes.default.svc"; @@ -246,7 +246,7 @@ in }; serviceAccountIssuer = mkOption { - description = '' + description = lib.mdDoc '' Kubernetes apiserver ServiceAccount issuer. ''; default = "https://kubernetes.default.svc"; @@ -254,7 +254,7 @@ in }; serviceAccountSigningKeyFile = mkOption { - description = '' + description = lib.mdDoc '' Path to the file that contains the current private key of the service account token issuer. The issuer will sign issued ID tokens with this private key. @@ -263,7 +263,7 @@ in }; serviceAccountKeyFile = mkOption { - description = '' + description = lib.mdDoc '' File containing PEM-encoded x509 RSA or ECDSA private or public keys, used to verify ServiceAccount tokens. The specified file can contain multiple keys, and the flag can be specified multiple times with @@ -274,7 +274,7 @@ in }; serviceClusterIpRange = mkOption { - description = '' + description = lib.mdDoc '' A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes for pods. ''; @@ -283,39 +283,39 @@ in }; tlsCertFile = mkOption { - description = "Kubernetes apiserver certificate file."; + description = lib.mdDoc "Kubernetes apiserver certificate file."; default = null; type = nullOr path; }; tlsKeyFile = mkOption { - description = "Kubernetes apiserver private key file."; + description = lib.mdDoc "Kubernetes apiserver private key file."; default = null; type = nullOr path; }; tokenAuthFile = mkOption { - description = '' + description = lib.mdDoc '' Kubernetes apiserver token authentication file. See - <link xlink:href="https://kubernetes.io/docs/reference/access-authn-authz/authentication"/> + <https://kubernetes.io/docs/reference/access-authn-authz/authentication> ''; default = null; type = nullOr path; }; verbosity = mkOption { - description = '' + description = lib.mdDoc '' Optional glog verbosity level for logging statements. See - <link xlink:href="https://github.com/kubernetes/community/blob/master/contributors/devel/logging.md"/> + <https://github.com/kubernetes/community/blob/master/contributors/devel/logging.md> ''; default = null; type = nullOr int; }; webhookConfig = mkOption { - description = '' + description = lib.mdDoc '' Kubernetes apiserver Webhook config file. It uses the kubeconfig file format. - See <link xlink:href="https://kubernetes.io/docs/reference/access-authn-authz/webhook/"/> + See <https://kubernetes.io/docs/reference/access-authn-authz/webhook/> ''; default = null; type = nullOr path; diff --git a/nixos/modules/services/cluster/kubernetes/controller-manager.nix b/nixos/modules/services/cluster/kubernetes/controller-manager.nix index 7c317e94deebf..6080e6f991511 100644 --- a/nixos/modules/services/cluster/kubernetes/controller-manager.nix +++ b/nixos/modules/services/cluster/kubernetes/controller-manager.nix @@ -17,19 +17,19 @@ in options.services.kubernetes.controllerManager = with lib.types; { allocateNodeCIDRs = mkOption { - description = "Whether to automatically allocate CIDR ranges for cluster nodes."; + description = lib.mdDoc "Whether to automatically allocate CIDR ranges for cluster nodes."; default = true; type = bool; }; bindAddress = mkOption { - description = "Kubernetes controller manager listening address."; + description = lib.mdDoc "Kubernetes controller manager listening address."; default = "127.0.0.1"; type = str; }; clusterCidr = mkOption { - description = "Kubernetes CIDR Range for Pods in cluster."; + description = lib.mdDoc "Kubernetes CIDR Range for Pods in cluster."; default = top.clusterCidr; defaultText = literalExpression "config.${otop.clusterCidr}"; type = str; @@ -38,20 +38,20 @@ in enable = mkEnableOption "Kubernetes controller manager"; extraOpts = mkOption { - description = "Kubernetes controller manager extra command line options."; + description = lib.mdDoc "Kubernetes controller manager extra command line options."; default = ""; type = separatedString " "; }; featureGates = mkOption { - description = "List set of feature gates"; + description = lib.mdDoc "List set of feature gates"; default = top.featureGates; defaultText = literalExpression "config.${otop.featureGates}"; type = listOf str; }; insecurePort = mkOption { - description = "Kubernetes controller manager insecure listening port."; + description = lib.mdDoc "Kubernetes controller manager insecure listening port."; default = 0; type = int; }; @@ -59,13 +59,13 @@ in kubeconfig = top.lib.mkKubeConfigOptions "Kubernetes controller manager"; leaderElect = mkOption { - description = "Whether to start leader election before executing main loop."; + description = lib.mdDoc "Whether to start leader election before executing main loop."; type = bool; default = true; }; rootCaFile = mkOption { - description = '' + description = lib.mdDoc '' Kubernetes controller manager certificate authority file included in service account's token secret. ''; @@ -75,13 +75,13 @@ in }; securePort = mkOption { - description = "Kubernetes controller manager secure listening port."; + description = lib.mdDoc "Kubernetes controller manager secure listening port."; default = 10252; type = int; }; serviceAccountKeyFile = mkOption { - description = '' + description = lib.mdDoc '' Kubernetes controller manager PEM-encoded private RSA key file used to sign service account tokens ''; @@ -90,21 +90,21 @@ in }; tlsCertFile = mkOption { - description = "Kubernetes controller-manager certificate file."; + description = lib.mdDoc "Kubernetes controller-manager certificate file."; default = null; type = nullOr path; }; tlsKeyFile = mkOption { - description = "Kubernetes controller-manager private key file."; + description = lib.mdDoc "Kubernetes controller-manager private key file."; default = null; type = nullOr path; }; verbosity = mkOption { - description = '' + description = lib.mdDoc '' Optional glog verbosity level for logging statements. See - <link xlink:href="https://github.com/kubernetes/community/blob/master/contributors/devel/logging.md"/> + <https://github.com/kubernetes/community/blob/master/contributors/devel/logging.md> ''; default = null; type = nullOr int; diff --git a/nixos/modules/services/cluster/kubernetes/default.nix b/nixos/modules/services/cluster/kubernetes/default.nix index 35ec99d83c842..f5374fc719422 100644 --- a/nixos/modules/services/cluster/kubernetes/default.nix +++ b/nixos/modules/services/cluster/kubernetes/default.nix @@ -77,25 +77,25 @@ let mkKubeConfigOptions = prefix: { server = mkOption { - description = "${prefix} kube-apiserver server address."; + description = lib.mdDoc "${prefix} kube-apiserver server address."; type = types.str; }; caFile = mkOption { - description = "${prefix} certificate authority file used to connect to kube-apiserver."; + description = lib.mdDoc "${prefix} certificate authority file used to connect to kube-apiserver."; type = types.nullOr types.path; default = cfg.caFile; defaultText = literalExpression "config.${opt.caFile}"; }; certFile = mkOption { - description = "${prefix} client certificate file used to connect to kube-apiserver."; + description = lib.mdDoc "${prefix} client certificate file used to connect to kube-apiserver."; type = types.nullOr types.path; default = null; }; keyFile = mkOption { - description = "${prefix} client key file used to connect to kube-apiserver."; + description = lib.mdDoc "${prefix} client key file used to connect to kube-apiserver."; type = types.nullOr types.path; default = null; }; @@ -111,7 +111,7 @@ in { options.services.kubernetes = { roles = mkOption { - description = '' + description = lib.mdDoc '' Kubernetes role that this machine should take. Master role will enable etcd, apiserver, scheduler, controller manager @@ -123,7 +123,7 @@ in { }; package = mkOption { - description = "Kubernetes package to use."; + description = lib.mdDoc "Kubernetes package to use."; type = types.package; default = pkgs.kubernetes; defaultText = literalExpression "pkgs.kubernetes"; @@ -132,7 +132,7 @@ in { kubeconfig = mkKubeConfigOptions "Default kubeconfig"; apiserverAddress = mkOption { - description = '' + description = lib.mdDoc '' Clusterwide accessible address for the kubernetes apiserver, including protocol and optional port. ''; @@ -141,49 +141,49 @@ in { }; caFile = mkOption { - description = "Default kubernetes certificate authority"; + description = lib.mdDoc "Default kubernetes certificate authority"; type = types.nullOr types.path; default = null; }; dataDir = mkOption { - description = "Kubernetes root directory for managing kubelet files."; + description = lib.mdDoc "Kubernetes root directory for managing kubelet files."; default = "/var/lib/kubernetes"; type = types.path; }; easyCerts = mkOption { - description = "Automatically setup x509 certificates and keys for the entire cluster."; + description = lib.mdDoc "Automatically setup x509 certificates and keys for the entire cluster."; default = false; type = types.bool; }; featureGates = mkOption { - description = "List set of feature gates."; + description = lib.mdDoc "List set of feature gates."; default = []; type = types.listOf types.str; }; masterAddress = mkOption { - description = "Clusterwide available network address or hostname for the kubernetes master server."; + description = lib.mdDoc "Clusterwide available network address or hostname for the kubernetes master server."; example = "master.example.com"; type = types.str; }; path = mkOption { - description = "Packages added to the services' PATH environment variable. Both the bin and sbin subdirectories of each package are added."; + description = lib.mdDoc "Packages added to the services' PATH environment variable. Both the bin and sbin subdirectories of each package are added."; type = types.listOf types.package; default = []; }; clusterCidr = mkOption { - description = "Kubernetes controller manager and proxy CIDR Range for Pods in cluster."; + description = lib.mdDoc "Kubernetes controller manager and proxy CIDR Range for Pods in cluster."; default = "10.1.0.0/16"; type = types.nullOr types.str; }; lib = mkOption { - description = "Common functions for the kubernetes modules."; + description = lib.mdDoc "Common functions for the kubernetes modules."; default = { inherit mkCert; inherit mkKubeConfig; @@ -193,7 +193,7 @@ in { }; secretsPath = mkOption { - description = "Default location for kubernetes secrets. Not a store location."; + description = lib.mdDoc "Default location for kubernetes secrets. Not a store location."; type = types.path; default = cfg.dataDir + "/secrets"; defaultText = literalExpression '' diff --git a/nixos/modules/services/cluster/kubernetes/kubelet.nix b/nixos/modules/services/cluster/kubernetes/kubelet.nix index 4363ed35d3416..cbb1cffc16944 100644 --- a/nixos/modules/services/cluster/kubernetes/kubelet.nix +++ b/nixos/modules/services/cluster/kubernetes/kubelet.nix @@ -38,17 +38,17 @@ let taintOptions = with lib.types; { name, ... }: { options = { key = mkOption { - description = "Key of taint."; + description = lib.mdDoc "Key of taint."; default = name; defaultText = literalDocBook "Name of this submodule."; type = str; }; value = mkOption { - description = "Value of taint."; + description = lib.mdDoc "Value of taint."; type = str; }; effect = mkOption { - description = "Effect of taint."; + description = lib.mdDoc "Effect of taint."; example = "NoSchedule"; type = enum ["NoSchedule" "PreferNoSchedule" "NoExecute"]; }; @@ -68,26 +68,26 @@ in options.services.kubernetes.kubelet = with lib.types; { address = mkOption { - description = "Kubernetes kubelet info server listening address."; + description = lib.mdDoc "Kubernetes kubelet info server listening address."; default = "0.0.0.0"; type = str; }; clusterDns = mkOption { - description = "Use alternative DNS."; + description = lib.mdDoc "Use alternative DNS."; default = "10.1.0.1"; type = str; }; clusterDomain = mkOption { - description = "Use alternative domain."; + description = lib.mdDoc "Use alternative domain."; default = config.services.kubernetes.addons.dns.clusterDomain; defaultText = literalExpression "config.${options.services.kubernetes.addons.dns.clusterDomain}"; type = str; }; clientCaFile = mkOption { - description = "Kubernetes apiserver CA file for client authentication."; + description = lib.mdDoc "Kubernetes apiserver CA file for client authentication."; default = top.caFile; defaultText = literalExpression "config.${otop.caFile}"; type = nullOr path; @@ -95,13 +95,13 @@ in cni = { packages = mkOption { - description = "List of network plugin packages to install."; + description = lib.mdDoc "List of network plugin packages to install."; type = listOf package; default = []; }; config = mkOption { - description = "Kubernetes CNI configuration."; + description = lib.mdDoc "Kubernetes CNI configuration."; type = listOf attrs; default = []; example = literalExpression '' @@ -127,20 +127,20 @@ in }; configDir = mkOption { - description = "Path to Kubernetes CNI configuration directory."; + description = lib.mdDoc "Path to Kubernetes CNI configuration directory."; type = nullOr path; default = null; }; }; containerRuntime = mkOption { - description = "Which container runtime type to use"; + description = lib.mdDoc "Which container runtime type to use"; type = enum ["docker" "remote"]; default = "remote"; }; containerRuntimeEndpoint = mkOption { - description = "Endpoint at which to find the container runtime api interface/socket"; + description = lib.mdDoc "Endpoint at which to find the container runtime api interface/socket"; type = str; default = "unix:///run/containerd/containerd.sock"; }; @@ -148,13 +148,13 @@ in enable = mkEnableOption "Kubernetes kubelet."; extraOpts = mkOption { - description = "Kubernetes kubelet extra command line options."; + description = lib.mdDoc "Kubernetes kubelet extra command line options."; default = ""; type = separatedString " "; }; featureGates = mkOption { - description = "List set of feature gates"; + description = lib.mdDoc "List set of feature gates"; default = top.featureGates; defaultText = literalExpression "config.${otop.featureGates}"; type = listOf str; @@ -162,20 +162,20 @@ in healthz = { bind = mkOption { - description = "Kubernetes kubelet healthz listening address."; + description = lib.mdDoc "Kubernetes kubelet healthz listening address."; default = "127.0.0.1"; type = str; }; port = mkOption { - description = "Kubernetes kubelet healthz port."; + description = lib.mdDoc "Kubernetes kubelet healthz port."; default = 10248; type = int; }; }; hostname = mkOption { - description = "Kubernetes kubelet hostname override."; + description = lib.mdDoc "Kubernetes kubelet hostname override."; default = config.networking.hostName; defaultText = literalExpression "config.networking.hostName"; type = str; @@ -184,69 +184,69 @@ in kubeconfig = top.lib.mkKubeConfigOptions "Kubelet"; manifests = mkOption { - description = "List of manifests to bootstrap with kubelet (only pods can be created as manifest entry)"; + description = lib.mdDoc "List of manifests to bootstrap with kubelet (only pods can be created as manifest entry)"; type = attrsOf attrs; default = {}; }; networkPlugin = mkOption { - description = "Network plugin to use by Kubernetes."; + description = lib.mdDoc "Network plugin to use by Kubernetes."; type = nullOr (enum ["cni" "kubenet"]); default = "kubenet"; }; nodeIp = mkOption { - description = "IP address of the node. If set, kubelet will use this IP address for the node."; + description = lib.mdDoc "IP address of the node. If set, kubelet will use this IP address for the node."; default = null; type = nullOr str; }; registerNode = mkOption { - description = "Whether to auto register kubelet with API server."; + description = lib.mdDoc "Whether to auto register kubelet with API server."; default = true; type = bool; }; port = mkOption { - description = "Kubernetes kubelet info server listening port."; + description = lib.mdDoc "Kubernetes kubelet info server listening port."; default = 10250; type = int; }; seedDockerImages = mkOption { - description = "List of docker images to preload on system"; + description = lib.mdDoc "List of docker images to preload on system"; default = []; type = listOf package; }; taints = mkOption { - description = "Node taints (https://kubernetes.io/docs/concepts/configuration/assign-pod-node/)."; + description = lib.mdDoc "Node taints (https://kubernetes.io/docs/concepts/configuration/assign-pod-node/)."; default = {}; type = attrsOf (submodule [ taintOptions ]); }; tlsCertFile = mkOption { - description = "File containing x509 Certificate for HTTPS."; + description = lib.mdDoc "File containing x509 Certificate for HTTPS."; default = null; type = nullOr path; }; tlsKeyFile = mkOption { - description = "File containing x509 private key matching tlsCertFile."; + description = lib.mdDoc "File containing x509 private key matching tlsCertFile."; default = null; type = nullOr path; }; unschedulable = mkOption { - description = "Whether to set node taint to unschedulable=true as it is the case of node that has only master role."; + description = lib.mdDoc "Whether to set node taint to unschedulable=true as it is the case of node that has only master role."; default = false; type = bool; }; verbosity = mkOption { - description = '' + description = lib.mdDoc '' Optional glog verbosity level for logging statements. See - <link xlink:href="https://github.com/kubernetes/community/blob/master/contributors/devel/logging.md"/> + <https://github.com/kubernetes/community/blob/master/contributors/devel/logging.md> ''; default = null; type = nullOr int; diff --git a/nixos/modules/services/cluster/kubernetes/pki.nix b/nixos/modules/services/cluster/kubernetes/pki.nix index 7d9198d20e8cf..7c46ac8558462 100644 --- a/nixos/modules/services/cluster/kubernetes/pki.nix +++ b/nixos/modules/services/cluster/kubernetes/pki.nix @@ -44,13 +44,13 @@ in enable = mkEnableOption "easyCert issuer service"; certs = mkOption { - description = "List of certificate specs to feed to cert generator."; + description = lib.mdDoc "List of certificate specs to feed to cert generator."; default = {}; type = attrs; }; genCfsslCACert = mkOption { - description = '' + description = lib.mdDoc '' Whether to automatically generate cfssl CA certificate and key, if they don't exist. ''; @@ -59,7 +59,7 @@ in }; genCfsslAPICerts = mkOption { - description = '' + description = lib.mdDoc '' Whether to automatically generate cfssl API webserver TLS cert and key, if they don't exist. ''; @@ -68,7 +68,7 @@ in }; cfsslAPIExtraSANs = mkOption { - description = '' + description = lib.mdDoc '' Extra x509 Subject Alternative Names to be added to the cfssl API webserver TLS cert. ''; default = []; @@ -77,7 +77,7 @@ in }; genCfsslAPIToken = mkOption { - description = '' + description = lib.mdDoc '' Whether to automatically generate cfssl API-token secret, if they doesn't exist. ''; @@ -86,13 +86,13 @@ in }; pkiTrustOnBootstrap = mkOption { - description = "Whether to always trust remote cfssl server upon initial PKI bootstrap."; + description = lib.mdDoc "Whether to always trust remote cfssl server upon initial PKI bootstrap."; default = true; type = bool; }; caCertPathPrefix = mkOption { - description = '' + description = lib.mdDoc '' Path-prefrix for the CA-certificate to be used for cfssl signing. Suffixes ".pem" and "-key.pem" will be automatically appended for the public and private keys respectively. @@ -103,7 +103,7 @@ in }; caSpec = mkOption { - description = "Certificate specification for the auto-generated CAcert."; + description = lib.mdDoc "Certificate specification for the auto-generated CAcert."; default = { CN = "kubernetes-cluster-ca"; O = "NixOS"; diff --git a/nixos/modules/services/cluster/kubernetes/proxy.nix b/nixos/modules/services/cluster/kubernetes/proxy.nix index 0fd98d1c15761..51114c3249943 100644 --- a/nixos/modules/services/cluster/kubernetes/proxy.nix +++ b/nixos/modules/services/cluster/kubernetes/proxy.nix @@ -16,7 +16,7 @@ in options.services.kubernetes.proxy = with lib.types; { bindAddress = mkOption { - description = "Kubernetes proxy listening address."; + description = lib.mdDoc "Kubernetes proxy listening address."; default = "0.0.0.0"; type = str; }; @@ -24,20 +24,20 @@ in enable = mkEnableOption "Kubernetes proxy"; extraOpts = mkOption { - description = "Kubernetes proxy extra command line options."; + description = lib.mdDoc "Kubernetes proxy extra command line options."; default = ""; type = separatedString " "; }; featureGates = mkOption { - description = "List set of feature gates"; + description = lib.mdDoc "List set of feature gates"; default = top.featureGates; defaultText = literalExpression "config.${otop.featureGates}"; type = listOf str; }; hostname = mkOption { - description = "Kubernetes proxy hostname override."; + description = lib.mdDoc "Kubernetes proxy hostname override."; default = config.networking.hostName; defaultText = literalExpression "config.networking.hostName"; type = str; @@ -46,9 +46,9 @@ in kubeconfig = top.lib.mkKubeConfigOptions "Kubernetes proxy"; verbosity = mkOption { - description = '' + description = lib.mdDoc '' Optional glog verbosity level for logging statements. See - <link xlink:href="https://github.com/kubernetes/community/blob/master/contributors/devel/logging.md"/> + <https://github.com/kubernetes/community/blob/master/contributors/devel/logging.md> ''; default = null; type = nullOr int; diff --git a/nixos/modules/services/cluster/kubernetes/scheduler.nix b/nixos/modules/services/cluster/kubernetes/scheduler.nix index 2d95528a6ead0..ddc67889a3702 100644 --- a/nixos/modules/services/cluster/kubernetes/scheduler.nix +++ b/nixos/modules/services/cluster/kubernetes/scheduler.nix @@ -12,7 +12,7 @@ in options.services.kubernetes.scheduler = with lib.types; { address = mkOption { - description = "Kubernetes scheduler listening address."; + description = lib.mdDoc "Kubernetes scheduler listening address."; default = "127.0.0.1"; type = str; }; @@ -20,13 +20,13 @@ in enable = mkEnableOption "Kubernetes scheduler"; extraOpts = mkOption { - description = "Kubernetes scheduler extra command line options."; + description = lib.mdDoc "Kubernetes scheduler extra command line options."; default = ""; type = separatedString " "; }; featureGates = mkOption { - description = "List set of feature gates"; + description = lib.mdDoc "List set of feature gates"; default = top.featureGates; defaultText = literalExpression "config.${otop.featureGates}"; type = listOf str; @@ -35,21 +35,21 @@ in kubeconfig = top.lib.mkKubeConfigOptions "Kubernetes scheduler"; leaderElect = mkOption { - description = "Whether to start leader election before executing main loop."; + description = lib.mdDoc "Whether to start leader election before executing main loop."; type = bool; default = true; }; port = mkOption { - description = "Kubernetes scheduler listening port."; + description = lib.mdDoc "Kubernetes scheduler listening port."; default = 10251; type = int; }; verbosity = mkOption { - description = '' + description = lib.mdDoc '' Optional glog verbosity level for logging statements. See - <link xlink:href="https://github.com/kubernetes/community/blob/master/contributors/devel/logging.md"/> + <https://github.com/kubernetes/community/blob/master/contributors/devel/logging.md> ''; default = null; type = nullOr int; diff --git a/nixos/modules/services/cluster/pacemaker/default.nix b/nixos/modules/services/cluster/pacemaker/default.nix index 7eeadffcc586b..41d98a460f5cc 100644 --- a/nixos/modules/services/cluster/pacemaker/default.nix +++ b/nixos/modules/services/cluster/pacemaker/default.nix @@ -13,7 +13,7 @@ in type = types.package; default = pkgs.pacemaker; defaultText = literalExpression "pkgs.pacemaker"; - description = "Package that should be used for pacemaker."; + description = lib.mdDoc "Package that should be used for pacemaker."; }; }; diff --git a/nixos/modules/services/cluster/spark/default.nix b/nixos/modules/services/cluster/spark/default.nix index e6b44e130a3e0..30d8fa0fc412a 100644 --- a/nixos/modules/services/cluster/spark/default.nix +++ b/nixos/modules/services/cluster/spark/default.nix @@ -10,13 +10,13 @@ with lib; enable = mkEnableOption "Spark master service"; bind = mkOption { type = types.str; - description = "Address the spark master binds to."; + description = lib.mdDoc "Address the spark master binds to."; default = "127.0.0.1"; example = "0.0.0.0"; }; restartIfChanged = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Automatically restart master service on config change. This can be set to false to defer restarts on clusters running critical applications. Please consider the security implications of inadvertently running an older version, @@ -26,7 +26,7 @@ with lib; }; extraEnvironment = mkOption { type = types.attrsOf types.str; - description = "Extra environment variables to pass to spark master. See spark-standalone documentation."; + description = lib.mdDoc "Extra environment variables to pass to spark master. See spark-standalone documentation."; default = {}; example = { SPARK_MASTER_WEBUI_PORT = 8181; @@ -38,17 +38,17 @@ with lib; enable = mkEnableOption "Spark worker service"; workDir = mkOption { type = types.path; - description = "Spark worker work dir."; + description = lib.mdDoc "Spark worker work dir."; default = "/var/lib/spark"; }; master = mkOption { type = types.str; - description = "Address of the spark master."; + description = lib.mdDoc "Address of the spark master."; default = "127.0.0.1:7077"; }; restartIfChanged = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Automatically restart worker service on config change. This can be set to false to defer restarts on clusters running critical applications. Please consider the security implications of inadvertently running an older version, @@ -58,7 +58,7 @@ with lib; }; extraEnvironment = mkOption { type = types.attrsOf types.str; - description = "Extra environment variables to pass to spark worker."; + description = lib.mdDoc "Extra environment variables to pass to spark worker."; default = {}; example = { SPARK_WORKER_CORES = 5; @@ -68,18 +68,18 @@ with lib; }; confDir = mkOption { type = types.path; - description = "Spark configuration directory. Spark will use the configuration files (spark-defaults.conf, spark-env.sh, log4j.properties, etc) from this directory."; + description = lib.mdDoc "Spark configuration directory. Spark will use the configuration files (spark-defaults.conf, spark-env.sh, log4j.properties, etc) from this directory."; default = "${cfg.package}/lib/${cfg.package.untarDir}/conf"; defaultText = literalExpression ''"''${package}/lib/''${package.untarDir}/conf"''; }; logDir = mkOption { type = types.path; - description = "Spark log directory."; + description = lib.mdDoc "Spark log directory."; default = "/var/log/spark"; }; package = mkOption { type = types.package; - description = "Spark package."; + description = lib.mdDoc "Spark package."; default = pkgs.spark; defaultText = literalExpression "pkgs.spark"; example = literalExpression ''pkgs.spark.overrideAttrs (super: rec { diff --git a/nixos/modules/services/computing/boinc/client.nix b/nixos/modules/services/computing/boinc/client.nix index 52249455fd45a..ec88be95ecbfc 100644 --- a/nixos/modules/services/computing/boinc/client.nix +++ b/nixos/modules/services/computing/boinc/client.nix @@ -19,7 +19,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the BOINC distributed computing client. If this option is set to true, the boinc_client daemon will be run as a background service. The boinccmd command can be used to control the @@ -31,7 +31,7 @@ in type = types.package; default = pkgs.boinc; defaultText = literalExpression "pkgs.boinc"; - description = '' + description = lib.mdDoc '' Which BOINC package to use. ''; }; @@ -39,7 +39,7 @@ in dataDir = mkOption { type = types.path; default = "/var/lib/boinc"; - description = '' + description = lib.mdDoc '' The directory in which to store BOINC's configuration and data files. ''; }; diff --git a/nixos/modules/services/computing/foldingathome/client.nix b/nixos/modules/services/computing/foldingathome/client.nix index aa9d0a5218fab..ad88fffe43ceb 100644 --- a/nixos/modules/services/computing/foldingathome/client.nix +++ b/nixos/modules/services/computing/foldingathome/client.nix @@ -24,7 +24,7 @@ in type = types.package; default = pkgs.fahclient; defaultText = literalExpression "pkgs.fahclient"; - description = '' + description = lib.mdDoc '' Which Folding@home client to use. ''; }; @@ -32,7 +32,7 @@ in user = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The user associated with the reported computation results. This will be used in the ranking statistics. ''; @@ -41,7 +41,7 @@ in team = mkOption { type = types.int; default = 236565; - description = '' + description = lib.mdDoc '' The team ID associated with the reported computation results. This will be used in the ranking statistics. @@ -52,7 +52,7 @@ in daemonNiceLevel = mkOption { type = types.ints.between (-20) 19; default = 0; - description = '' + description = lib.mdDoc '' Daemon process priority for FAHClient. 0 is the default Unix process priority, 19 is the lowest. ''; @@ -61,9 +61,9 @@ in extraArgs = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Extra startup options for the FAHClient. Run - <literal>FAHClient --help</literal> to find all the available options. + `FAHClient --help` to find all the available options. ''; }; }; diff --git a/nixos/modules/services/computing/slurm/slurm.nix b/nixos/modules/services/computing/slurm/slurm.nix index b9792fd1334c3..785267d4b376c 100644 --- a/nixos/modules/services/computing/slurm/slurm.nix +++ b/nixos/modules/services/computing/slurm/slurm.nix @@ -66,11 +66,11 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the slurm control daemon. Note that the standard authentication method is "munge". The "munge" service needs to be provided with a password file in order for - slurm to work properly (see <literal>services.munge.password</literal>). + slurm to work properly (see `services.munge.password`). ''; }; }; @@ -82,9 +82,9 @@ in type = types.str; default = config.networking.hostName; defaultText = literalExpression "config.networking.hostName"; - description = '' - Hostname of the machine where <literal>slurmdbd</literal> - is running (i.e. name returned by <literal>hostname -s</literal>). + description = lib.mdDoc '' + Hostname of the machine where `slurmdbd` + is running (i.e. name returned by `hostname -s`). ''; }; @@ -92,7 +92,7 @@ in type = types.str; default = cfg.user; defaultText = literalExpression "config.${opt.user}"; - description = '' + description = lib.mdDoc '' Database user name. ''; }; @@ -100,9 +100,9 @@ in storagePassFile = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Path to file with database password. The content of this will be used to - create the password for the <literal>StoragePass</literal> option. + create the password for the `StoragePass` option. ''; }; @@ -124,10 +124,10 @@ in enableStools = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to provide a slurm.conf file. Enable this option if you do not run a slurm daemon on this host - (i.e. <literal>server.enable</literal> and <literal>client.enable</literal> are <literal>false</literal>) + (i.e. `server.enable` and `client.enable` are `false`) but you still want to run slurm commands from this host. ''; }; @@ -137,7 +137,7 @@ in default = pkgs.slurm.override { enableX11 = ! cfg.enableSrunX11; }; defaultText = literalExpression "pkgs.slurm"; example = literalExpression "pkgs.slurm-full"; - description = '' + description = lib.mdDoc '' The package to use for slurm binaries. ''; }; @@ -146,7 +146,7 @@ in type = types.nullOr types.str; default = null; example = null; - description = '' + description = lib.mdDoc '' The short hostname of the machine where SLURM control functions are executed (i.e. the name returned by the command "hostname -s", use "tux001" rather than "tux001.my.com"). @@ -158,7 +158,7 @@ in default = cfg.controlMachine; defaultText = literalExpression "config.${opt.controlMachine}"; example = null; - description = '' + description = lib.mdDoc '' Name that ControlMachine should be referred to in establishing a communications path. ''; @@ -168,7 +168,7 @@ in type = types.str; default = "default"; example = "myCluster"; - description = '' + description = lib.mdDoc '' Necessary to distinguish accounting records in a multi-cluster environment. ''; }; @@ -177,7 +177,7 @@ in type = types.listOf types.str; default = []; example = literalExpression ''[ "linux[1-32] CPUs=1 State=UNKNOWN" ];''; - description = '' + description = lib.mdDoc '' Name that SLURM uses to refer to a node (or base partition for BlueGene systems). Typically this would be the string that "/bin/hostname -s" returns. Note that now you have to write node's parameters after the name. @@ -188,7 +188,7 @@ in type = types.listOf types.str; default = []; example = literalExpression ''[ "debug Nodes=linux[1-32] Default=YES MaxTime=INFINITE State=UP" ];''; - description = '' + description = lib.mdDoc '' Name by which the partition may be referenced. Note that now you have to write the partition's parameters after the name. ''; @@ -197,17 +197,17 @@ in enableSrunX11 = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If enabled srun will accept the option "--x11" to allow for X11 forwarding from within an interactive session or a batch job. This activates the slurm-spank-x11 module. Note that this option also enables - <option>services.openssh.forwardX11</option> on the client. + {option}`services.openssh.forwardX11` on the client. This option requires slurm to be compiled without native X11 support. The default behavior is to re-compile the slurm package with native X11 support disabled if this option is set to true. - To use the native X11 support add <literal>PrologFlags=X11</literal> in <option>extraConfig</option>. + To use the native X11 support add `PrologFlags=X11` in {option}`extraConfig`. Note that this method will only work RSA SSH host keys. ''; }; @@ -215,7 +215,7 @@ in procTrackType = mkOption { type = types.str; default = "proctrack/linuxproc"; - description = '' + description = lib.mdDoc '' Plugin to be used for process tracking on a job step basis. The slurmd daemon uses this mechanism to identify all processes which are children of processes it spawns for a user job step. @@ -225,7 +225,7 @@ in stateSaveLocation = mkOption { type = types.str; default = "/var/spool/slurmctld"; - description = '' + description = lib.mdDoc '' Directory into which the Slurm controller, slurmctld, saves its state. ''; }; @@ -233,7 +233,7 @@ in user = mkOption { type = types.str; default = defaultUser; - description = '' + description = lib.mdDoc '' Set this option when you want to run the slurmctld daemon as something else than the default slurm user "slurm". Note that the UID of this user needs to be the same @@ -244,7 +244,7 @@ in extraConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Extra configuration options that will be added verbatim at the end of the slurm configuration file. ''; @@ -253,28 +253,28 @@ in extraPlugstackConfig = mkOption { default = ""; type = types.lines; - description = '' - Extra configuration that will be added to the end of <literal>plugstack.conf</literal>. + description = lib.mdDoc '' + Extra configuration that will be added to the end of `plugstack.conf`. ''; }; extraCgroupConfig = mkOption { default = ""; type = types.lines; - description = '' - Extra configuration for <literal>cgroup.conf</literal>. This file is - used when <literal>procTrackType=proctrack/cgroup</literal>. + description = lib.mdDoc '' + Extra configuration for `cgroup.conf`. This file is + used when `procTrackType=proctrack/cgroup`. ''; }; extraConfigPaths = mkOption { type = with types; listOf path; default = []; - description = '' + description = lib.mdDoc '' Slurm expects config files for plugins in the same path - as <literal>slurm.conf</literal>. Add extra nix store + as `slurm.conf`. Add extra nix store paths that should be merged into same directory as - <literal>slurm.conf</literal>. + `slurm.conf`. ''; }; diff --git a/nixos/modules/services/computing/torque/mom.nix b/nixos/modules/services/computing/torque/mom.nix index 6747bd4b0d5aa..bf3679847b94e 100644 --- a/nixos/modules/services/computing/torque/mom.nix +++ b/nixos/modules/services/computing/torque/mom.nix @@ -21,7 +21,7 @@ in serverNode = mkOption { type = types.str; - description = "Hostname running pbs server."; + description = lib.mdDoc "Hostname running pbs server."; }; }; diff --git a/nixos/modules/services/continuous-integration/buildbot/master.nix b/nixos/modules/services/continuous-integration/buildbot/master.nix index 80c6c6abfd0b8..ab1a8076c935a 100644 --- a/nixos/modules/services/continuous-integration/buildbot/master.nix +++ b/nixos/modules/services/continuous-integration/buildbot/master.nix @@ -61,7 +61,7 @@ in { factorySteps = mkOption { type = types.listOf types.str; - description = "Factory Steps"; + description = lib.mdDoc "Factory Steps"; default = []; example = [ "steps.Git(repourl='https://github.com/buildbot/pyflakes.git', mode='incremental')" @@ -71,7 +71,7 @@ in { changeSource = mkOption { type = types.listOf types.str; - description = "List of Change Sources."; + description = lib.mdDoc "List of Change Sources."; default = []; example = [ "changes.GitPoller('https://github.com/buildbot/pyflakes.git', workdir='gitpoller-workdir', branch='master', pollinterval=300)" @@ -81,18 +81,18 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the Buildbot continuous integration server."; + description = lib.mdDoc "Whether to enable the Buildbot continuous integration server."; }; extraConfig = mkOption { type = types.str; - description = "Extra configuration to append to master.cfg"; + description = lib.mdDoc "Extra configuration to append to master.cfg"; default = "c['buildbotNetUsageData'] = None"; }; masterCfg = mkOption { type = types.path; - description = "Optionally pass master.cfg path. Other options in this configuration will be ignored."; + description = lib.mdDoc "Optionally pass master.cfg path. Other options in this configuration will be ignored."; default = defaultMasterCfg; defaultText = literalDocBook ''generated configuration file''; example = "/etc/nixos/buildbot/master.cfg"; @@ -100,7 +100,7 @@ in { schedulers = mkOption { type = types.listOf types.str; - description = "List of Schedulers."; + description = lib.mdDoc "List of Schedulers."; default = [ "schedulers.SingleBranchScheduler(name='all', change_filter=util.ChangeFilter(branch='master'), treeStableTimer=None, builderNames=['runtests'])" "schedulers.ForceScheduler(name='force',builderNames=['runtests'])" @@ -109,7 +109,7 @@ in { builders = mkOption { type = types.listOf types.str; - description = "List of Builders."; + description = lib.mdDoc "List of Builders."; default = [ "util.BuilderConfig(name='runtests',workernames=['example-worker'],factory=factory)" ]; @@ -117,52 +117,52 @@ in { workers = mkOption { type = types.listOf types.str; - description = "List of Workers."; + description = lib.mdDoc "List of Workers."; default = [ "worker.Worker('example-worker', 'pass')" ]; }; reporters = mkOption { default = []; type = types.listOf types.str; - description = "List of reporter objects used to present build status to various users."; + description = lib.mdDoc "List of reporter objects used to present build status to various users."; }; user = mkOption { default = "buildbot"; type = types.str; - description = "User the buildbot server should execute under."; + description = lib.mdDoc "User the buildbot server should execute under."; }; group = mkOption { default = "buildbot"; type = types.str; - description = "Primary group of buildbot user."; + description = lib.mdDoc "Primary group of buildbot user."; }; extraGroups = mkOption { type = types.listOf types.str; default = []; - description = "List of extra groups that the buildbot user should be a part of."; + description = lib.mdDoc "List of extra groups that the buildbot user should be a part of."; }; home = mkOption { default = "/home/buildbot"; type = types.path; - description = "Buildbot home directory."; + description = lib.mdDoc "Buildbot home directory."; }; buildbotDir = mkOption { default = "${cfg.home}/master"; defaultText = literalExpression ''"''${config.${opt.home}}/master"''; type = types.path; - description = "Specifies the Buildbot directory."; + description = lib.mdDoc "Specifies the Buildbot directory."; }; pbPort = mkOption { default = 9989; type = types.either types.str types.int; example = "'tcp:9990:interface=127.0.0.1'"; - description = '' + description = lib.mdDoc '' The buildmaster will listen on a TCP port of your choosing for connections from workers. It can also use this port for connections from remote Change Sources, @@ -170,51 +170,51 @@ in { This port should be visible to the outside world, and you’ll need to tell your worker admins about your choice. If put in (single) quotes, this can also be used as a connection string, - as defined in the <link xlink:href="https://twistedmatrix.com/documents/current/core/howto/endpoints.html">ConnectionStrings guide</link>. + as defined in the [ConnectionStrings guide](https://twistedmatrix.com/documents/current/core/howto/endpoints.html). ''; }; listenAddress = mkOption { default = "0.0.0.0"; type = types.str; - description = "Specifies the bind address on which the buildbot HTTP interface listens."; + description = lib.mdDoc "Specifies the bind address on which the buildbot HTTP interface listens."; }; buildbotUrl = mkOption { default = "http://localhost:8010/"; type = types.str; - description = "Specifies the Buildbot URL."; + description = lib.mdDoc "Specifies the Buildbot URL."; }; title = mkOption { default = "Buildbot"; type = types.str; - description = "Specifies the Buildbot Title."; + description = lib.mdDoc "Specifies the Buildbot Title."; }; titleUrl = mkOption { default = "Buildbot"; type = types.str; - description = "Specifies the Buildbot TitleURL."; + description = lib.mdDoc "Specifies the Buildbot TitleURL."; }; dbUrl = mkOption { default = "sqlite:///state.sqlite"; type = types.str; - description = "Specifies the database connection string."; + description = lib.mdDoc "Specifies the database connection string."; }; port = mkOption { default = 8010; type = types.int; - description = "Specifies port number on which the buildbot HTTP interface listens."; + description = lib.mdDoc "Specifies port number on which the buildbot HTTP interface listens."; }; package = mkOption { type = types.package; default = pkgs.python3Packages.buildbot-full; defaultText = literalExpression "pkgs.python3Packages.buildbot-full"; - description = "Package to use for buildbot."; + description = lib.mdDoc "Package to use for buildbot."; example = literalExpression "pkgs.python3Packages.buildbot"; }; @@ -222,14 +222,14 @@ in { default = [ pkgs.git ]; defaultText = literalExpression "[ pkgs.git ]"; type = types.listOf types.package; - description = "Packages to add to PATH for the buildbot process."; + description = lib.mdDoc "Packages to add to PATH for the buildbot process."; }; pythonPackages = mkOption { type = types.functionTo (types.listOf types.package); default = pythonPackages: with pythonPackages; [ ]; defaultText = literalExpression "pythonPackages: with pythonPackages; [ ]"; - description = "Packages to add the to the PYTHONPATH of the buildbot process."; + description = lib.mdDoc "Packages to add the to the PYTHONPATH of the buildbot process."; example = literalExpression "pythonPackages: with pythonPackages; [ requests ]"; }; }; diff --git a/nixos/modules/services/continuous-integration/buildbot/worker.nix b/nixos/modules/services/continuous-integration/buildbot/worker.nix index 1d7f53bb6559a..245f685764dc1 100644 --- a/nixos/modules/services/continuous-integration/buildbot/worker.nix +++ b/nixos/modules/services/continuous-integration/buildbot/worker.nix @@ -49,73 +49,73 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the Buildbot Worker."; + description = lib.mdDoc "Whether to enable the Buildbot Worker."; }; user = mkOption { default = "bbworker"; type = types.str; - description = "User the buildbot Worker should execute under."; + description = lib.mdDoc "User the buildbot Worker should execute under."; }; group = mkOption { default = "bbworker"; type = types.str; - description = "Primary group of buildbot Worker user."; + description = lib.mdDoc "Primary group of buildbot Worker user."; }; extraGroups = mkOption { type = types.listOf types.str; default = []; - description = "List of extra groups that the Buildbot Worker user should be a part of."; + description = lib.mdDoc "List of extra groups that the Buildbot Worker user should be a part of."; }; home = mkOption { default = "/home/bbworker"; type = types.path; - description = "Buildbot home directory."; + description = lib.mdDoc "Buildbot home directory."; }; buildbotDir = mkOption { default = "${cfg.home}/worker"; defaultText = literalExpression ''"''${config.${opt.home}}/worker"''; type = types.path; - description = "Specifies the Buildbot directory."; + description = lib.mdDoc "Specifies the Buildbot directory."; }; workerUser = mkOption { default = "example-worker"; type = types.str; - description = "Specifies the Buildbot Worker user."; + description = lib.mdDoc "Specifies the Buildbot Worker user."; }; workerPass = mkOption { default = "pass"; type = types.str; - description = "Specifies the Buildbot Worker password."; + description = lib.mdDoc "Specifies the Buildbot Worker password."; }; workerPassFile = mkOption { type = types.path; - description = "File used to store the Buildbot Worker password"; + description = lib.mdDoc "File used to store the Buildbot Worker password"; }; hostMessage = mkOption { default = null; type = types.nullOr types.str; - description = "Description of this worker"; + description = lib.mdDoc "Description of this worker"; }; adminMessage = mkOption { default = null; type = types.nullOr types.str; - description = "Name of the administrator of this worker"; + description = lib.mdDoc "Name of the administrator of this worker"; }; masterUrl = mkOption { default = "localhost:9989"; type = types.str; - description = "Specifies the Buildbot Worker connection string."; + description = lib.mdDoc "Specifies the Buildbot Worker connection string."; }; keepalive = mkOption { @@ -131,7 +131,7 @@ in { type = types.package; default = pkgs.python3Packages.buildbot-worker; defaultText = literalExpression "pkgs.python3Packages.buildbot-worker"; - description = "Package to use for buildbot worker."; + description = lib.mdDoc "Package to use for buildbot worker."; example = literalExpression "pkgs.python2Packages.buildbot-worker"; }; @@ -139,7 +139,7 @@ in { default = with pkgs; [ git ]; defaultText = literalExpression "[ pkgs.git ]"; type = types.listOf types.package; - description = "Packages to add to PATH for the buildbot process."; + description = lib.mdDoc "Packages to add to PATH for the buildbot process."; }; }; }; diff --git a/nixos/modules/services/continuous-integration/buildkite-agents.nix b/nixos/modules/services/continuous-integration/buildkite-agents.nix index 1872567c9f127..cafa40dc6e5f1 100644 --- a/nixos/modules/services/continuous-integration/buildkite-agents.nix +++ b/nixos/modules/services/continuous-integration/buildkite-agents.nix @@ -34,32 +34,32 @@ let enable = mkOption { default = true; type = types.bool; - description = "Whether to enable this buildkite agent"; + description = lib.mdDoc "Whether to enable this buildkite agent"; }; package = mkOption { default = pkgs.buildkite-agent; defaultText = literalExpression "pkgs.buildkite-agent"; - description = "Which buildkite-agent derivation to use"; + description = lib.mdDoc "Which buildkite-agent derivation to use"; type = types.package; }; dataDir = mkOption { default = "/var/lib/buildkite-agent-${name}"; - description = "The workdir for the agent"; + description = lib.mdDoc "The workdir for the agent"; type = types.str; }; runtimePackages = mkOption { default = [ pkgs.bash pkgs.gnutar pkgs.gzip pkgs.git pkgs.nix ]; defaultText = literalExpression "[ pkgs.bash pkgs.gnutar pkgs.gzip pkgs.git pkgs.nix ]"; - description = "Add programs to the buildkite-agent environment"; + description = lib.mdDoc "Add programs to the buildkite-agent environment"; type = types.listOf types.package; }; tokenPath = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' The token from your Buildkite "Agents" page. A run-time path to the token file, which is supposed to be provisioned @@ -70,7 +70,7 @@ let name = mkOption { type = types.str; default = "%hostname-${name}-%n"; - description = '' + description = lib.mdDoc '' The name of the agent as seen in the buildkite dashboard. ''; }; @@ -79,7 +79,7 @@ let type = types.attrsOf (types.either types.str (types.listOf types.str)); default = {}; example = { queue = "default"; docker = "true"; ruby2 ="true"; }; - description = '' + description = lib.mdDoc '' Tags for the agent. ''; }; @@ -88,7 +88,7 @@ let type = types.lines; default = ""; example = "debug=true"; - description = '' + description = lib.mdDoc '' Extra lines to be added verbatim to the configuration file. ''; }; @@ -100,7 +100,7 @@ let ## don't end up in the Nix store. apply = final: if final == null then null else toString final; - description = '' + description = lib.mdDoc '' OpenSSH private key A run-time path to the key file, which is supposed to be provisioned @@ -169,9 +169,9 @@ let type = types.path; default = hooksDir config; defaultText = literalDocBook "generated from <option>services.buildkite-agents.<name>.hooks</option>"; - description = '' + description = lib.mdDoc '' Path to the directory storing the hooks. - Consider using <option>services.buildkite-agents.<name>.hooks.<name></option> + Consider using {option}`services.buildkite-agents.<name>.hooks.<name>` instead. ''; }; @@ -180,7 +180,7 @@ let type = types.str; default = "${pkgs.bash}/bin/bash -e -c"; defaultText = literalExpression ''"''${pkgs.bash}/bin/bash -e -c"''; - description = '' + description = lib.mdDoc '' Command that buildkite-agent 3 will execute when it spawns a shell. ''; }; diff --git a/nixos/modules/services/continuous-integration/github-runner.nix b/nixos/modules/services/continuous-integration/github-runner.nix index 19e73582a0904..2da18bbdb3961 100644 --- a/nixos/modules/services/continuous-integration/github-runner.nix +++ b/nixos/modules/services/continuous-integration/github-runner.nix @@ -30,17 +30,17 @@ in url = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Repository to add the runner to. Changing this option triggers a new runner registration. IMPORTANT: If your token is org-wide (not per repository), you need to provide a github org link, not a single repository, so do it like this - <literal>https://github.com/nixos</literal>, not like this - <literal>https://github.com/nixos/nixpkgs</literal>. - Otherwise, you are going to get a <literal>404 NotFound</literal> - from <literal>POST https://api.github.com/actions/runner-registration</literal> + `https://github.com/nixos`, not like this + `https://github.com/nixos/nixpkgs`. + Otherwise, you are going to get a `404 NotFound` + from `POST https://api.github.com/actions/runner-registration` in the configure script. ''; example = "https://github.com/nixos/nixpkgs"; @@ -48,7 +48,7 @@ in tokenFile = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' The full path to a file which contains the runner registration token. The file should contain exactly one line with the token without any newline. The token can be used to re-register a runner of the same name but is time-limited. @@ -61,7 +61,7 @@ in name = mkOption { # Same pattern as for `networking.hostName` type = types.strMatching "^$|^[[:alnum:]]([[:alnum:]_-]{0,61}[[:alnum:]])?$"; - description = '' + description = lib.mdDoc '' Name of the runner to configure. Defaults to the hostname. Changing this option triggers a new runner registration. @@ -73,7 +73,7 @@ in runnerGroup = mkOption { type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' Name of the runner group to add this runner to (defaults to the default runner group). Changing this option triggers a new runner registration. @@ -83,8 +83,8 @@ in extraLabels = mkOption { type = types.listOf types.str; - description = '' - Extra labels in addition to the default (<literal>["self-hosted", "Linux", "X64"]</literal>). + description = lib.mdDoc '' + Extra labels in addition to the default (`["self-hosted", "Linux", "X64"]`). Changing this option triggers a new runner registration. ''; @@ -94,7 +94,7 @@ in replace = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Replace any existing runner with the same name. Without this flag, registering a new runner with the same name fails. @@ -104,15 +104,15 @@ in extraPackages = mkOption { type = types.listOf types.package; - description = '' - Extra packages to add to <literal>PATH</literal> of the service to make them available to workflows. + description = lib.mdDoc '' + Extra packages to add to `PATH` of the service to make them available to workflows. ''; default = [ ]; }; package = mkOption { type = types.package; - description = '' + description = lib.mdDoc '' Which github-runner derivation to use. ''; default = pkgs.github-runner; diff --git a/nixos/modules/services/continuous-integration/gocd-agent/default.nix b/nixos/modules/services/continuous-integration/gocd-agent/default.nix index c63998c6736a6..c9e22dff15270 100644 --- a/nixos/modules/services/continuous-integration/gocd-agent/default.nix +++ b/nixos/modules/services/continuous-integration/gocd-agent/default.nix @@ -13,7 +13,7 @@ in { user = mkOption { default = "gocd-agent"; type = types.str; - description = '' + description = lib.mdDoc '' User the Go.CD agent should execute under. ''; }; @@ -21,7 +21,7 @@ in { group = mkOption { default = "gocd-agent"; type = types.str; - description = '' + description = lib.mdDoc '' If the default user "gocd-agent" is configured then this is the primary group of that user. ''; @@ -31,7 +31,7 @@ in { type = types.listOf types.str; default = [ ]; example = [ "wheel" "docker" ]; - description = '' + description = lib.mdDoc '' List of extra groups that the "gocd-agent" user should be a part of. ''; }; @@ -40,7 +40,7 @@ in { default = [ pkgs.stdenv pkgs.jre pkgs.git config.programs.ssh.package pkgs.nix ]; defaultText = literalExpression "[ pkgs.stdenv pkgs.jre pkgs.git config.programs.ssh.package pkgs.nix ]"; type = types.listOf types.package; - description = '' + description = lib.mdDoc '' Packages to add to PATH for the Go.CD agent process. ''; }; @@ -53,7 +53,7 @@ in { agent.auto.register.environments=QA,Performance agent.auto.register.hostname=Agent01 ''; - description = '' + description = lib.mdDoc '' Agent registration configuration. ''; }; @@ -61,7 +61,7 @@ in { goServer = mkOption { default = "https://127.0.0.1:8154/go"; type = types.str; - description = '' + description = lib.mdDoc '' URL of the GoCD Server to attach the Go.CD Agent to. ''; }; @@ -69,7 +69,7 @@ in { workDir = mkOption { default = "/var/lib/go-agent"; type = types.str; - description = '' + description = lib.mdDoc '' Specifies the working directory in which the Go.CD agent java archive resides. ''; }; @@ -77,7 +77,7 @@ in { initialJavaHeapSize = mkOption { default = "128m"; type = types.str; - description = '' + description = lib.mdDoc '' Specifies the initial java heap memory size for the Go.CD agent java process. ''; }; @@ -85,7 +85,7 @@ in { maxJavaHeapMemory = mkOption { default = "256m"; type = types.str; - description = '' + description = lib.mdDoc '' Specifies the java maximum heap memory size for the Go.CD agent java process. ''; }; @@ -108,7 +108,7 @@ in { "-Djava.security.egd=file:/dev/./urandom" ] ''; - description = '' + description = lib.mdDoc '' Specifies startup command line arguments to pass to Go.CD agent java process. ''; @@ -127,7 +127,7 @@ in { "-XX:+PrintGCDetails" "-XX:+PrintGC" ]; - description = '' + description = lib.mdDoc '' Specifies additional command line arguments to pass to Go.CD agent java process. Example contains debug and gcLog arguments. ''; @@ -136,10 +136,10 @@ in { environment = mkOption { default = { }; type = with types; attrsOf str; - description = '' + description = lib.mdDoc '' Additional environment variables to be passed to the Go.CD agent process. As a base environment, Go.CD agent receives NIX_PATH from - <option>environment.sessionVariables</option>, NIX_REMOTE is set to + {option}`environment.sessionVariables`, NIX_REMOTE is set to "daemon". ''; }; diff --git a/nixos/modules/services/continuous-integration/gocd-server/default.nix b/nixos/modules/services/continuous-integration/gocd-server/default.nix index 3540656f93448..50b5a20ad7ed2 100644 --- a/nixos/modules/services/continuous-integration/gocd-server/default.nix +++ b/nixos/modules/services/continuous-integration/gocd-server/default.nix @@ -13,7 +13,7 @@ in { user = mkOption { default = "gocd-server"; type = types.str; - description = '' + description = lib.mdDoc '' User the Go.CD server should execute under. ''; }; @@ -21,7 +21,7 @@ in { group = mkOption { default = "gocd-server"; type = types.str; - description = '' + description = lib.mdDoc '' If the default user "gocd-server" is configured then this is the primary group of that user. ''; }; @@ -30,7 +30,7 @@ in { default = [ ]; type = types.listOf types.str; example = [ "wheel" "docker" ]; - description = '' + description = lib.mdDoc '' List of extra groups that the "gocd-server" user should be a part of. ''; }; @@ -39,7 +39,7 @@ in { default = "0.0.0.0"; example = "localhost"; type = types.str; - description = '' + description = lib.mdDoc '' Specifies the bind address on which the Go.CD server HTTP interface listens. ''; }; @@ -47,7 +47,7 @@ in { port = mkOption { default = 8153; type = types.int; - description = '' + description = lib.mdDoc '' Specifies port number on which the Go.CD server HTTP interface listens. ''; }; @@ -55,7 +55,7 @@ in { sslPort = mkOption { default = 8154; type = types.int; - description = '' + description = lib.mdDoc '' Specifies port number on which the Go.CD server HTTPS interface listens. ''; }; @@ -63,7 +63,7 @@ in { workDir = mkOption { default = "/var/lib/go-server"; type = types.str; - description = '' + description = lib.mdDoc '' Specifies the working directory in which the Go.CD server java archive resides. ''; }; @@ -72,7 +72,7 @@ in { default = [ pkgs.stdenv pkgs.jre pkgs.git config.programs.ssh.package pkgs.nix ]; defaultText = literalExpression "[ pkgs.stdenv pkgs.jre pkgs.git config.programs.ssh.package pkgs.nix ]"; type = types.listOf types.package; - description = '' + description = lib.mdDoc '' Packages to add to PATH for the Go.CD server's process. ''; }; @@ -80,7 +80,7 @@ in { initialJavaHeapSize = mkOption { default = "512m"; type = types.str; - description = '' + description = lib.mdDoc '' Specifies the initial java heap memory size for the Go.CD server's java process. ''; }; @@ -88,7 +88,7 @@ in { maxJavaHeapMemory = mkOption { default = "1024m"; type = types.str; - description = '' + description = lib.mdDoc '' Specifies the java maximum heap memory size for the Go.CD server's java process. ''; }; @@ -122,7 +122,7 @@ in { ] ''; - description = '' + description = lib.mdDoc '' Specifies startup command line arguments to pass to Go.CD server java process. ''; @@ -141,7 +141,7 @@ in { "-XX:+PrintGCDetails" "-XX:+PrintGC" ]; - description = '' + description = lib.mdDoc '' Specifies additional command line arguments to pass to Go.CD server's java process. Example contains debug and gcLog arguments. ''; @@ -150,10 +150,10 @@ in { environment = mkOption { default = { }; type = with types; attrsOf str; - description = '' + description = lib.mdDoc '' Additional environment variables to be passed to the gocd-server process. As a base environment, gocd-server receives NIX_PATH from - <option>environment.sessionVariables</option>, NIX_REMOTE is set to + {option}`environment.sessionVariables`, NIX_REMOTE is set to "daemon". ''; }; diff --git a/nixos/modules/services/continuous-integration/hail.nix b/nixos/modules/services/continuous-integration/hail.nix index 4070a3425c4f1..76d7356e24725 100644 --- a/nixos/modules/services/continuous-integration/hail.nix +++ b/nixos/modules/services/continuous-integration/hail.nix @@ -13,7 +13,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enables the Hail Auto Update Service. Hail can automatically deploy artifacts built by a Hydra Continous Integration server. A common use case is to provide continous deployment for single services or a full NixOS configuration.''; @@ -21,22 +21,22 @@ in { profile = mkOption { type = types.str; default = "hail-profile"; - description = "The name of the Nix profile used by Hail."; + description = lib.mdDoc "The name of the Nix profile used by Hail."; }; hydraJobUri = mkOption { type = types.str; - description = "The URI of the Hydra Job."; + description = lib.mdDoc "The URI of the Hydra Job."; }; netrc = mkOption { type = types.nullOr types.path; - description = "The netrc file to use when fetching data from Hydra."; + description = lib.mdDoc "The netrc file to use when fetching data from Hydra."; default = null; }; package = mkOption { type = types.package; default = pkgs.haskellPackages.hail; defaultText = literalExpression "pkgs.haskellPackages.hail"; - description = "Hail package to use."; + description = lib.mdDoc "Hail package to use."; }; }; diff --git a/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix b/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix index 80c88714bfc17..9e1fb03075767 100644 --- a/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix +++ b/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix @@ -28,7 +28,7 @@ let freeformType = format.type; options = { apiBaseUrl = mkOption { - description = '' + description = lib.mdDoc '' API base URL that the agent will connect to. When using Hercules CI Enterprise, set this to the URL where your @@ -40,19 +40,19 @@ let baseDirectory = mkOption { type = types.path; default = "/var/lib/hercules-ci-agent"; - description = '' + description = lib.mdDoc '' State directory (secrets, work directory, etc) for agent ''; }; concurrentTasks = mkOption { - description = '' + description = lib.mdDoc '' Number of tasks to perform simultaneously. A task is a single derivation build, an evaluation or an effect run. - At minimum, you need 2 concurrent tasks for <literal>x86_64-linux</literal> + At minimum, you need 2 concurrent tasks for `x86_64-linux` in your cluster, to allow for import from derivation. - <literal>concurrentTasks</literal> can be around the CPU core count or lower if memory is + `concurrentTasks` can be around the CPU core count or lower if memory is the bottleneck. The optimal value depends on the resource consumption characteristics of your workload, @@ -66,7 +66,7 @@ let default = "auto"; }; labels = mkOption { - description = '' + description = lib.mdDoc '' A key-value map of user data. This data will be available to organization members in the dashboard and API. @@ -85,7 +85,7 @@ let ''; }; workDirectory = mkOption { - description = '' + description = lib.mdDoc '' The directory in which temporary subdirectories are created for task state. This includes sources for Nix evaluation. ''; type = types.path; @@ -93,10 +93,10 @@ let defaultText = literalExpression ''baseDirectory + "/work"''; }; staticSecretsDirectory = mkOption { - description = '' - This is the default directory to look for statically configured secrets like <literal>cluster-join-token.key</literal>. + description = lib.mdDoc '' + This is the default directory to look for statically configured secrets like `cluster-join-token.key`. - See also <literal>clusterJoinTokenPath</literal> and <literal>binaryCachesPath</literal> for fine-grained configuration. + See also `clusterJoinTokenPath` and `binaryCachesPath` for fine-grained configuration. ''; type = types.path; default = config.baseDirectory + "/secrets"; @@ -190,26 +190,26 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable to run Hercules CI Agent as a system service. - <link xlink:href="https://hercules-ci.com">Hercules CI</link> is a + [Hercules CI](https://hercules-ci.com) is a continuous integation service that is centered around Nix. - Support is available at <link xlink:href="mailto:help@hercules-ci.com">help@hercules-ci.com</link>. + Support is available at [help@hercules-ci.com](mailto:help@hercules-ci.com). ''; }; checkNix = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to make sure that the system's Nix (nix-daemon) is compatible. If you set this to false, please keep up with the change log. ''; }; package = mkOption { - description = '' + description = lib.mdDoc '' Package containing the bin/hercules-ci-agent executable. ''; type = types.package; @@ -217,12 +217,12 @@ in defaultText = literalExpression "pkgs.hercules-ci-agent"; }; settings = mkOption { - description = '' - These settings are written to the <literal>agent.toml</literal> file. + description = lib.mdDoc '' + These settings are written to the `agent.toml` file. Not all settings are listed as options, can be set nonetheless. - For the exhaustive list of settings, see <link xlink:href="https://docs.hercules-ci.com/hercules-ci/reference/agent-config/"/>. + For the exhaustive list of settings, see <https://docs.hercules-ci.com/hercules-ci/reference/agent-config/>. ''; type = types.submoduleWith { modules = [ settingsModule ]; }; }; diff --git a/nixos/modules/services/continuous-integration/hydra/default.nix b/nixos/modules/services/continuous-integration/hydra/default.nix index d3945f2370d71..f4cdf690bb3aa 100644 --- a/nixos/modules/services/continuous-integration/hydra/default.nix +++ b/nixos/modules/services/continuous-integration/hydra/default.nix @@ -78,7 +78,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to run Hydra services. ''; }; @@ -101,12 +101,12 @@ in type = types.package; default = pkgs.hydra_unstable; defaultText = literalExpression "pkgs.hydra_unstable"; - description = "The Hydra package."; + description = lib.mdDoc "The Hydra package."; }; hydraURL = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The base URL for the Hydra webserver instance. Used for links in emails. ''; }; @@ -124,7 +124,7 @@ in port = mkOption { type = types.int; default = 3000; - description = '' + description = lib.mdDoc '' TCP port the web server should listen to. ''; }; @@ -132,7 +132,7 @@ in minimumDiskFree = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' Threshold of minimum disk space (GiB) to determine if the queue runner should run or not. ''; }; @@ -140,14 +140,14 @@ in minimumDiskFreeEvaluator = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' Threshold of minimum disk space (GiB) to determine if the evaluator should run or not. ''; }; notificationSender = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Sender email address used for email notifications. ''; }; @@ -156,7 +156,7 @@ in type = types.nullOr types.str; default = null; example = "localhost"; - description = '' + description = lib.mdDoc '' Hostname of the SMTP server to use to send email. ''; }; @@ -164,7 +164,7 @@ in tracker = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Piece of HTML that is included on all pages. ''; }; @@ -172,7 +172,7 @@ in logo = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Path to a file containing the logo of your Hydra instance. ''; }; @@ -180,24 +180,24 @@ in debugServer = mkOption { type = types.bool; default = false; - description = "Whether to run the server in debug mode."; + description = lib.mdDoc "Whether to run the server in debug mode."; }; extraConfig = mkOption { type = types.lines; - description = "Extra lines for the Hydra configuration."; + description = lib.mdDoc "Extra lines for the Hydra configuration."; }; extraEnv = mkOption { type = types.attrsOf types.str; default = {}; - description = "Extra environment variables for Hydra."; + description = lib.mdDoc "Extra environment variables for Hydra."; }; gcRootsDir = mkOption { type = types.path; default = "/nix/var/nix/gcroots/hydra"; - description = "Directory that holds Hydra garbage collector roots."; + description = lib.mdDoc "Directory that holds Hydra garbage collector roots."; }; buildMachinesFiles = mkOption { @@ -205,13 +205,13 @@ in default = optional (config.nix.buildMachines != []) "/etc/nix/machines"; defaultText = literalExpression ''optional (config.nix.buildMachines != []) "/etc/nix/machines"''; example = [ "/etc/nix/machines" "/var/lib/hydra/provisioner/machines" ]; - description = "List of files containing build machines."; + description = lib.mdDoc "List of files containing build machines."; }; useSubstitutes = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to use binary caches for downloading store paths. Note that binary substitutions trigger (a potentially large number of) additional HTTP requests that slow down the queue monitor thread significantly. diff --git a/nixos/modules/services/continuous-integration/jenkins/default.nix b/nixos/modules/services/continuous-integration/jenkins/default.nix index d37dcb5519d28..6cd5718f42276 100644 --- a/nixos/modules/services/continuous-integration/jenkins/default.nix +++ b/nixos/modules/services/continuous-integration/jenkins/default.nix @@ -9,7 +9,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the jenkins continuous integration server. ''; }; @@ -17,7 +17,7 @@ in { user = mkOption { default = "jenkins"; type = types.str; - description = '' + description = lib.mdDoc '' User the jenkins server should execute under. ''; }; @@ -25,7 +25,7 @@ in { group = mkOption { default = "jenkins"; type = types.str; - description = '' + description = lib.mdDoc '' If the default user "jenkins" is configured then this is the primary group of that user. ''; @@ -35,7 +35,7 @@ in { type = types.listOf types.str; default = [ ]; example = [ "wheel" "dialout" ]; - description = '' + description = lib.mdDoc '' List of extra groups that the "jenkins" user should be a part of. ''; }; @@ -43,7 +43,7 @@ in { home = mkOption { default = "/var/lib/jenkins"; type = types.path; - description = '' + description = lib.mdDoc '' The path to use as JENKINS_HOME. If the default user "jenkins" is configured then this is the home of the "jenkins" user. ''; @@ -53,7 +53,7 @@ in { default = "0.0.0.0"; example = "localhost"; type = types.str; - description = '' + description = lib.mdDoc '' Specifies the bind address on which the jenkins HTTP interface listens. The default is the wildcard address. ''; @@ -62,7 +62,7 @@ in { port = mkOption { default = 8080; type = types.port; - description = '' + description = lib.mdDoc '' Specifies port number on which the jenkins HTTP interface listens. The default is 8080. ''; @@ -72,7 +72,7 @@ in { default = ""; example = "/jenkins"; type = types.str; - description = '' + description = lib.mdDoc '' Specifies a urlPrefix to use with jenkins. If the example /jenkins is given, the jenkins server will be accessible using localhost:8080/jenkins. @@ -83,14 +83,14 @@ in { default = pkgs.jenkins; defaultText = literalExpression "pkgs.jenkins"; type = types.package; - description = "Jenkins package to use."; + description = lib.mdDoc "Jenkins package to use."; }; packages = mkOption { default = [ pkgs.stdenv pkgs.git pkgs.jdk11 config.programs.ssh.package pkgs.nix ]; defaultText = literalExpression "[ pkgs.stdenv pkgs.git pkgs.jdk11 config.programs.ssh.package pkgs.nix ]"; type = types.listOf types.package; - description = '' + description = lib.mdDoc '' Packages to add to PATH for the jenkins process. ''; }; @@ -98,12 +98,12 @@ in { environment = mkOption { default = { }; type = with types; attrsOf str; - description = '' + description = lib.mdDoc '' Additional environment variables to be passed to the jenkins process. As a base environment, jenkins receives NIX_PATH from - <option>environment.sessionVariables</option>, NIX_REMOTE is set to + {option}`environment.sessionVariables`, NIX_REMOTE is set to "daemon" and JENKINS_HOME is set to the value of - <option>services.jenkins.home</option>. + {option}`services.jenkins.home`. This option has precedence and can be used to override those mentioned variables. ''; @@ -112,13 +112,13 @@ in { plugins = mkOption { default = null; type = types.nullOr (types.attrsOf types.package); - description = '' + description = lib.mdDoc '' A set of plugins to activate. Note that this will completely remove and replace any previously installed plugins. If you have manually-installed plugins that you want to keep while using this module, set this option to - <literal>null</literal>. You can generate this set with a - tool such as <literal>jenkinsPlugins2nix</literal>. + `null`. You can generate this set with a + tool such as `jenkinsPlugins2nix`. ''; example = literalExpression '' import path/to/jenkinsPlugins2nix-generated-plugins.nix { inherit (pkgs) fetchurl stdenv; } @@ -129,7 +129,7 @@ in { type = types.listOf types.str; default = [ ]; example = [ "--debug=9" ]; - description = '' + description = lib.mdDoc '' Additional command line arguments to pass to Jenkins. ''; }; @@ -138,7 +138,7 @@ in { type = types.listOf types.str; default = [ ]; example = [ "-Xmx80m" ]; - description = '' + description = lib.mdDoc '' Additional command line arguments to pass to the Java run time (as opposed to Jenkins). ''; }; @@ -146,12 +146,12 @@ in { withCLI = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to make the CLI available. More info about the CLI available at - <link xlink:href="https://www.jenkins.io/doc/book/managing/cli"> - https://www.jenkins.io/doc/book/managing/cli</link> . + [ + https://www.jenkins.io/doc/book/managing/cli](https://www.jenkins.io/doc/book/managing/cli) . ''; }; }; diff --git a/nixos/modules/services/continuous-integration/jenkins/job-builder.nix b/nixos/modules/services/continuous-integration/jenkins/job-builder.nix index 49b39b03d4758..8dc06bf264162 100644 --- a/nixos/modules/services/continuous-integration/jenkins/job-builder.nix +++ b/nixos/modules/services/continuous-integration/jenkins/job-builder.nix @@ -12,7 +12,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether or not to enable the Jenkins Job Builder (JJB) service. It allows defining jobs for Jenkins in a declarative manner. @@ -24,15 +24,15 @@ in { deleted. Please see the Jenkins Job Builder documentation for more info: - <link xlink:href="http://docs.openstack.org/infra/jenkins-job-builder/"> - http://docs.openstack.org/infra/jenkins-job-builder/</link> + [ + http://docs.openstack.org/infra/jenkins-job-builder/](http://docs.openstack.org/infra/jenkins-job-builder/) ''; }; accessUser = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' User id in Jenkins used to reload config. ''; }; @@ -40,10 +40,10 @@ in { accessToken = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' User token in Jenkins used to reload config. WARNING: This token will be world readable in the Nix store. To keep - it secret, use the <option>accessTokenFile</option> option instead. + it secret, use the {option}`accessTokenFile` option instead. ''; }; @@ -51,8 +51,8 @@ in { default = ""; type = types.str; example = "/run/keys/jenkins-job-builder-access-token"; - description = '' - File containing the API token for the <option>accessUser</option> + description = lib.mdDoc '' + File containing the API token for the {option}`accessUser` user. ''; }; @@ -66,7 +66,7 @@ in { builders: - shell: echo 'Hello world!' ''; - description = '' + description = lib.mdDoc '' Job descriptions for Jenkins Job Builder in YAML format. ''; }; @@ -86,7 +86,7 @@ in { ''' ] ''; - description = '' + description = lib.mdDoc '' Job descriptions for Jenkins Job Builder in JSON format. ''; }; @@ -104,7 +104,7 @@ in { } ] ''; - description = '' + description = lib.mdDoc '' Job descriptions for Jenkins Job Builder in Nix format. This is a trivial wrapper around jsonJobs, using builtins.toJSON diff --git a/nixos/modules/services/continuous-integration/jenkins/slave.nix b/nixos/modules/services/continuous-integration/jenkins/slave.nix index 871b9914fb27a..9b86917ab380f 100644 --- a/nixos/modules/services/continuous-integration/jenkins/slave.nix +++ b/nixos/modules/services/continuous-integration/jenkins/slave.nix @@ -14,7 +14,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If true the system will be configured to work as a jenkins slave. If the system is also configured to work as a jenkins master then this has no effect. In progress: Currently only assures the jenkins user is configured. @@ -24,7 +24,7 @@ in { user = mkOption { default = "jenkins"; type = types.str; - description = '' + description = lib.mdDoc '' User the jenkins slave agent should execute under. ''; }; @@ -32,7 +32,7 @@ in { group = mkOption { default = "jenkins"; type = types.str; - description = '' + description = lib.mdDoc '' If the default slave agent user "jenkins" is configured then this is the primary group of that user. ''; @@ -41,7 +41,7 @@ in { home = mkOption { default = "/var/lib/jenkins"; type = types.path; - description = '' + description = lib.mdDoc '' The path to use as JENKINS_HOME. If the default user "jenkins" is configured then this is the home of the "jenkins" user. ''; @@ -50,7 +50,7 @@ in { javaPackage = mkOption { default = pkgs.jdk; defaultText = literalExpression "pkgs.jdk"; - description = '' + description = lib.mdDoc '' Java package to install. ''; type = types.package; diff --git a/nixos/modules/services/databases/aerospike.nix b/nixos/modules/services/databases/aerospike.nix index 8109762aea788..9ffedaebf6676 100644 --- a/nixos/modules/services/databases/aerospike.nix +++ b/nixos/modules/services/databases/aerospike.nix @@ -45,13 +45,13 @@ in default = pkgs.aerospike; defaultText = literalExpression "pkgs.aerospike"; type = types.package; - description = "Which Aerospike derivation to use"; + description = lib.mdDoc "Which Aerospike derivation to use"; }; workDir = mkOption { type = types.str; default = "/var/lib/aerospike"; - description = "Location where Aerospike stores its files"; + description = lib.mdDoc "Location where Aerospike stores its files"; }; networkConfig = mkOption { @@ -80,7 +80,7 @@ in port 3003 } ''; - description = "network section of configuration file"; + description = lib.mdDoc "network section of configuration file"; }; extraConfig = mkOption { @@ -94,7 +94,7 @@ in storage-engine memory } ''; - description = "Extra configuration"; + description = lib.mdDoc "Extra configuration"; }; }; diff --git a/nixos/modules/services/databases/cassandra.nix b/nixos/modules/services/databases/cassandra.nix index b457e69babaad..38db1d2e9f719 100644 --- a/nixos/modules/services/databases/cassandra.nix +++ b/nixos/modules/services/databases/cassandra.nix @@ -422,11 +422,11 @@ in options = { username = mkOption { type = types.str; - description = "Username for JMX"; + description = lib.mdDoc "Username for JMX"; }; password = mkOption { type = types.str; - description = "Password for JMX"; + description = lib.mdDoc "Password for JMX"; }; }; }); @@ -440,7 +440,7 @@ in else null; defaultText = literalMD ''generated configuration file if version is at least 3.11, otherwise `null`''; example = "/var/lib/cassandra/jmx.password"; - description = '' + description = lib.mdDoc '' Specify your own jmx roles file. Make sure the permissions forbid "others" from reading the file if diff --git a/nixos/modules/services/databases/clickhouse.nix b/nixos/modules/services/databases/clickhouse.nix index 3a161d56107eb..53637f4171c23 100644 --- a/nixos/modules/services/databases/clickhouse.nix +++ b/nixos/modules/services/databases/clickhouse.nix @@ -17,7 +17,7 @@ with lib; type = types.package; default = pkgs.clickhouse; defaultText = "pkgs.clickhouse"; - description = '' + description = lib.mdDoc '' ClickHouse package to use. ''; }; diff --git a/nixos/modules/services/databases/cockroachdb.nix b/nixos/modules/services/databases/cockroachdb.nix index 9a7aebe4f6ae9..b8d7321d00f56 100644 --- a/nixos/modules/services/databases/cockroachdb.nix +++ b/nixos/modules/services/databases/cockroachdb.nix @@ -35,13 +35,13 @@ let address = mkOption { type = types.str; default = "localhost"; - description = "Address to bind to for ${descr}"; + description = lib.mdDoc "Address to bind to for ${descr}"; }; port = mkOption { type = types.port; default = defaultPort; - description = "Port to bind to for ${descr}"; + description = lib.mdDoc "Port to bind to for ${descr}"; }; }; in @@ -80,50 +80,50 @@ in join = mkOption { type = types.nullOr types.str; default = null; - description = "The addresses for connecting the node to a cluster."; + description = lib.mdDoc "The addresses for connecting the node to a cluster."; }; insecure = mkOption { type = types.bool; default = false; - description = "Run in insecure mode."; + description = lib.mdDoc "Run in insecure mode."; }; certsDir = mkOption { type = types.nullOr types.path; default = null; - description = "The path to the certificate directory."; + description = lib.mdDoc "The path to the certificate directory."; }; user = mkOption { type = types.str; default = "cockroachdb"; - description = "User account under which CockroachDB runs"; + description = lib.mdDoc "User account under which CockroachDB runs"; }; group = mkOption { type = types.str; default = "cockroachdb"; - description = "User account under which CockroachDB runs"; + description = lib.mdDoc "User account under which CockroachDB runs"; }; openPorts = mkOption { type = types.bool; default = false; - description = "Open firewall ports for cluster communication by default"; + description = lib.mdDoc "Open firewall ports for cluster communication by default"; }; cache = mkOption { type = types.str; default = "25%"; - description = '' + description = lib.mdDoc '' The total size for caches. This can be a percentage, expressed with a fraction sign or as a decimal-point number, or any bytes-based unit. For example, - <literal>"25%"</literal>, <literal>"0.25"</literal> both represent + `"25%"`, `"0.25"` both represent 25% of the available system memory. The values - <literal>"1000000000"</literal> and <literal>"1GB"</literal> both + `"1000000000"` and `"1GB"` both represent 1 gigabyte of memory. ''; @@ -132,15 +132,15 @@ in maxSqlMemory = mkOption { type = types.str; default = "25%"; - description = '' + description = lib.mdDoc '' The maximum in-memory storage capacity available to store temporary data for SQL queries. This can be a percentage, expressed with a fraction sign or as a decimal-point number, or any bytes-based unit. For example, - <literal>"25%"</literal>, <literal>"0.25"</literal> both represent + `"25%"`, `"0.25"` both represent 25% of the available system memory. The values - <literal>"1000000000"</literal> and <literal>"1GB"</literal> both + `"1000000000"` and `"1GB"` both represent 1 gigabyte of memory. ''; }; @@ -149,7 +149,7 @@ in type = types.package; default = pkgs.cockroachdb; defaultText = literalExpression "pkgs.cockroachdb"; - description = '' + description = lib.mdDoc '' The CockroachDB derivation to use for running the service. This would primarily be useful to enable Enterprise Edition features @@ -162,9 +162,9 @@ in type = types.listOf types.str; default = []; example = [ "--advertise-addr" "[fe80::f6f2:::]" ]; - description = '' - Extra CLI arguments passed to <command>cockroach start</command>. - For the full list of supported argumemnts, check <link xlink:href="https://www.cockroachlabs.com/docs/stable/cockroach-start.html#flags"/> + description = lib.mdDoc '' + Extra CLI arguments passed to {command}`cockroach start`. + For the full list of supported argumemnts, check <https://www.cockroachlabs.com/docs/stable/cockroach-start.html#flags> ''; }; }; diff --git a/nixos/modules/services/databases/couchdb.nix b/nixos/modules/services/databases/couchdb.nix index 39d1ead28fc0c..2a570d09a2c47 100644 --- a/nixos/modules/services/databases/couchdb.nix +++ b/nixos/modules/services/databases/couchdb.nix @@ -37,7 +37,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to run CouchDB Server. ''; }; @@ -46,7 +46,7 @@ in { type = types.package; default = pkgs.couchdb3; defaultText = literalExpression "pkgs.couchdb3"; - description = '' + description = lib.mdDoc '' CouchDB package to use. ''; }; @@ -54,7 +54,7 @@ in { adminUser = mkOption { type = types.str; default = "admin"; - description = '' + description = lib.mdDoc '' Couchdb (i.e. fauxton) account with permission for all dbs and tasks. ''; @@ -63,7 +63,7 @@ in { adminPass = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Couchdb (i.e. fauxton) account with permission for all dbs and tasks. ''; @@ -72,7 +72,7 @@ in { user = mkOption { type = types.str; default = "couchdb"; - description = '' + description = lib.mdDoc '' User account under which couchdb runs. ''; }; @@ -80,7 +80,7 @@ in { group = mkOption { type = types.str; default = "couchdb"; - description = '' + description = lib.mdDoc '' Group account under which couchdb runs. ''; }; @@ -90,7 +90,7 @@ in { databaseDir = mkOption { type = types.path; default = "/var/lib/couchdb"; - description = '' + description = lib.mdDoc '' Specifies location of CouchDB database files (*.couch named). This location should be writable and readable for the user the CouchDB service runs as (couchdb by default). @@ -100,7 +100,7 @@ in { uriFile = mkOption { type = types.path; default = "/run/couchdb/couchdb.uri"; - description = '' + description = lib.mdDoc '' This file contains the full URI that can be used to access this instance of CouchDB. It is used to help discover the port CouchDB is running on (if it was set to 0 (e.g. automatically assigned any free @@ -112,7 +112,7 @@ in { viewIndexDir = mkOption { type = types.path; default = "/var/lib/couchdb"; - description = '' + description = lib.mdDoc '' Specifies location of CouchDB view index files. This location should be writable and readable for the user that runs the CouchDB service (couchdb by default). @@ -122,7 +122,7 @@ in { bindAddress = mkOption { type = types.str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' Defines the IP address by which CouchDB will be accessible. ''; }; @@ -130,7 +130,7 @@ in { port = mkOption { type = types.int; default = 5984; - description = '' + description = lib.mdDoc '' Defined the port number to listen. ''; }; @@ -138,7 +138,7 @@ in { logFile = mkOption { type = types.path; default = "/var/log/couchdb.log"; - description = '' + description = lib.mdDoc '' Specifies the location of file for logging output. ''; }; @@ -146,7 +146,7 @@ in { extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration. Overrides any other cofiguration. ''; }; @@ -155,14 +155,14 @@ in { type = types.path; default = "${cfg.package}/etc/vm.args"; defaultText = literalExpression ''"config.${opt.package}/etc/vm.args"''; - description = '' + description = lib.mdDoc '' vm.args configuration. Overrides Couchdb's Erlang VM parameters file. ''; }; configFile = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' Configuration file for persisting runtime changes. File needs to be readable and writable from couchdb user/group. ''; diff --git a/nixos/modules/services/databases/dgraph.nix b/nixos/modules/services/databases/dgraph.nix index 5c1ae536051c1..a6178b3d1ccfd 100644 --- a/nixos/modules/services/databases/dgraph.nix +++ b/nixos/modules/services/databases/dgraph.nix @@ -60,7 +60,7 @@ in settings = mkOption { type = settingsFormat.type; default = {}; - description = '' + description = lib.mdDoc '' Contents of the dgraph config. For more details see https://dgraph.io/docs/deploy/config ''; }; @@ -69,14 +69,14 @@ in host = mkOption { type = types.str; default = "localhost"; - description = '' + description = lib.mdDoc '' The host which dgraph alpha will be run on. ''; }; port = mkOption { type = types.port; default = 7080; - description = '' + description = lib.mdDoc '' The port which to run dgraph alpha on. ''; }; @@ -87,14 +87,14 @@ in host = mkOption { type = types.str; default = "localhost"; - description = '' + description = lib.mdDoc '' The host which dgraph zero will be run on. ''; }; port = mkOption { type = types.port; default = 5080; - description = '' + description = lib.mdDoc '' The port which to run dgraph zero on. ''; }; diff --git a/nixos/modules/services/databases/dragonflydb.nix b/nixos/modules/services/databases/dragonflydb.nix index e72afa9d90890..e35de2019afef 100644 --- a/nixos/modules/services/databases/dragonflydb.nix +++ b/nixos/modules/services/databases/dragonflydb.nix @@ -30,55 +30,55 @@ in user = mkOption { type = types.str; default = "dragonfly"; - description = "The user to run DragonflyDB as"; + description = lib.mdDoc "The user to run DragonflyDB as"; }; port = mkOption { type = types.port; default = 6379; - description = "The TCP port to accept connections."; + description = lib.mdDoc "The TCP port to accept connections."; }; bind = mkOption { type = with types; nullOr str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' The IP interface to bind to. - <literal>null</literal> means "all interfaces". + `null` means "all interfaces". ''; }; requirePass = mkOption { type = with types; nullOr str; default = null; - description = "Password for database"; + description = lib.mdDoc "Password for database"; example = "letmein!"; }; maxMemory = mkOption { type = with types; nullOr ints.unsigned; default = null; - description = '' + description = lib.mdDoc '' The maximum amount of memory to use for storage (in bytes). - <literal>null</literal> means this will be automatically set. + `null` means this will be automatically set. ''; }; memcachePort = mkOption { type = with types; nullOr port; default = null; - description = '' + description = lib.mdDoc '' To enable memcached compatible API on this port. - <literal>null</literal> means disabled. + `null` means disabled. ''; }; keysOutputLimit = mkOption { type = types.ints.unsigned; default = 8192; - description = '' + description = lib.mdDoc '' Maximum number of returned keys in keys command. - <literal>keys</literal> is a dangerous command. + `keys` is a dangerous command. We truncate its result to avoid blowup in memory when fetching too many keys. ''; }; @@ -86,13 +86,13 @@ in dbNum = mkOption { type = with types; nullOr ints.unsigned; default = null; - description = "Maximum number of supported databases for <literal>select</literal>"; + description = lib.mdDoc "Maximum number of supported databases for `select`"; }; cacheMode = mkOption { type = with types; nullOr bool; default = null; - description = '' + description = lib.mdDoc '' Once this mode is on, Dragonfly will evict items least likely to be stumbled upon in the future but only when it is near maxmemory limit. ''; diff --git a/nixos/modules/services/databases/firebird.nix b/nixos/modules/services/databases/firebird.nix index 4e3130bea22f8..3a7ebd6bbd096 100644 --- a/nixos/modules/services/databases/firebird.nix +++ b/nixos/modules/services/databases/firebird.nix @@ -56,7 +56,7 @@ in port = mkOption { default = 3050; type = types.port; - description = '' + description = lib.mdDoc '' Port Firebird uses. ''; }; @@ -64,7 +64,7 @@ in user = mkOption { default = "firebird"; type = types.str; - description = '' + description = lib.mdDoc '' User account under which firebird runs. ''; }; @@ -72,7 +72,7 @@ in baseDir = mkOption { default = "/var/lib/firebird"; type = types.str; - description = '' + description = lib.mdDoc '' Location containing data/ and system/ directories. data/ stores the databases, system/ stores the password database security2.fdb. ''; diff --git a/nixos/modules/services/databases/foundationdb.nix b/nixos/modules/services/databases/foundationdb.nix index e22127403e91c..f71228708e426 100644 --- a/nixos/modules/services/databases/foundationdb.nix +++ b/nixos/modules/services/databases/foundationdb.nix @@ -66,7 +66,7 @@ in package = mkOption { type = types.package; - description = '' + description = lib.mdDoc '' The FoundationDB package to use for this server. This must be specified by the user in order to ensure migrations and upgrades are controlled appropriately. ''; @@ -75,19 +75,19 @@ in publicAddress = mkOption { type = types.str; default = "auto"; - description = "Publicly visible IP address of the process. Port is determined by process ID"; + description = lib.mdDoc "Publicly visible IP address of the process. Port is determined by process ID"; }; listenAddress = mkOption { type = types.str; default = "public"; - description = "Publicly visible IP address of the process. Port is determined by process ID"; + description = lib.mdDoc "Publicly visible IP address of the process. Port is determined by process ID"; }; listenPortStart = mkOption { type = types.int; default = 4500; - description = '' + description = lib.mdDoc '' Starting port number for database listening sockets. Every FDB process binds to a subsequent port, to this number reflects the start of the overall range. e.g. having 8 server processes will use all ports between 4500 and 4507. @@ -106,43 +106,43 @@ in dataDir = mkOption { type = types.path; default = "/var/lib/foundationdb"; - description = "Data directory. All cluster data will be put under here."; + description = lib.mdDoc "Data directory. All cluster data will be put under here."; }; logDir = mkOption { type = types.path; default = "/var/log/foundationdb"; - description = "Log directory."; + description = lib.mdDoc "Log directory."; }; user = mkOption { type = types.str; default = "foundationdb"; - description = "User account under which FoundationDB runs."; + description = lib.mdDoc "User account under which FoundationDB runs."; }; group = mkOption { type = types.str; default = "foundationdb"; - description = "Group account under which FoundationDB runs."; + description = lib.mdDoc "Group account under which FoundationDB runs."; }; class = mkOption { type = types.nullOr (types.enum [ "storage" "transaction" "stateless" ]); default = null; - description = "Process class"; + description = lib.mdDoc "Process class"; }; restartDelay = mkOption { type = types.int; default = 10; - description = "Number of seconds to wait before restarting servers."; + description = lib.mdDoc "Number of seconds to wait before restarting servers."; }; logSize = mkOption { type = types.str; default = "10MiB"; - description = '' + description = lib.mdDoc '' Roll over to a new log file after the current log file reaches the specified size. ''; @@ -151,7 +151,7 @@ in maxLogSize = mkOption { type = types.str; default = "100MiB"; - description = '' + description = lib.mdDoc '' Delete the oldest log file when the total size of all log files exceeds the specified size. If set to 0, old log files will not be deleted. @@ -161,33 +161,33 @@ in serverProcesses = mkOption { type = types.int; default = 1; - description = "Number of fdbserver processes to run."; + description = lib.mdDoc "Number of fdbserver processes to run."; }; backupProcesses = mkOption { type = types.int; default = 1; - description = "Number of backup_agent processes to run for snapshots."; + description = lib.mdDoc "Number of backup_agent processes to run for snapshots."; }; memory = mkOption { type = types.str; default = "8GiB"; - description = '' + description = lib.mdDoc '' Maximum memory used by the process. The default value is - <literal>8GiB</literal>. When specified without a unit, - <literal>MiB</literal> is assumed. This parameter does not + `8GiB`. When specified without a unit, + `MiB` is assumed. This parameter does not change the memory allocation of the program. Rather, it sets a hard limit beyond which the process will kill itself and - be restarted. The default value of <literal>8GiB</literal> + be restarted. The default value of `8GiB` is double the intended memory usage in the default configuration (providing an emergency buffer to deal with memory leaks or similar problems). It is not recommended to decrease the value of this parameter below its default value. It may be increased if you wish to allocate a very large amount of storage engine memory or cache. In - particular, when the <literal>storageMemory</literal> - parameter is increased, the <literal>memory</literal> + particular, when the `storageMemory` + parameter is increased, the `memory` parameter should be increased by an equal amount. ''; }; @@ -195,22 +195,22 @@ in storageMemory = mkOption { type = types.str; default = "1GiB"; - description = '' + description = lib.mdDoc '' Maximum memory used for data storage. The default value is - <literal>1GiB</literal>. When specified without a unit, - <literal>MB</literal> is assumed. Clusters using the memory + `1GiB`. When specified without a unit, + `MB` is assumed. Clusters using the memory storage engine will be restricted to using this amount of memory per process for purposes of data storage. Memory overhead associated with storing the data is counted against this total. If you increase the - <literal>storageMemory</literal>, you should also increase - the <literal>memory</literal> parameter by the same amount. + `storageMemory`, you should also increase + the `memory` parameter by the same amount. ''; }; tls = mkOption { default = null; - description = '' + description = lib.mdDoc '' FoundationDB Transport Security Layer (TLS) settings. ''; @@ -218,7 +218,7 @@ in options = { certificate = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Path to the TLS certificate file. This certificate will be offered to, and may be verified by, clients. ''; @@ -226,13 +226,13 @@ in key = mkOption { type = types.str; - description = "Private key file for the certificate."; + description = lib.mdDoc "Private key file for the certificate."; }; allowedPeers = mkOption { type = types.str; default = "Check.Valid=1,Check.Unexpired=1"; - description = '' + description = lib.mdDoc '' "Peer verification string". This may be used to adjust which TLS client certificates a server will accept, as a form of user authorization; for example, it may only accept TLS clients who @@ -253,7 +253,7 @@ in dataHall = null; }; - description = '' + description = lib.mdDoc '' FoundationDB locality settings. ''; @@ -262,7 +262,7 @@ in machineId = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' Machine identifier key. All processes on a machine should share a unique id. By default, processes on a machine determine a unique id to share. This does not generally need to be set. @@ -272,7 +272,7 @@ in zoneId = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' Zone identifier key. Processes that share a zone id are considered non-unique for the purposes of data replication. If unset, defaults to machine id. @@ -282,7 +282,7 @@ in datacenterId = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' Data center identifier key. All processes physically located in a data center should share the id. If you are depending on data center based replication this must be set on all processes. @@ -292,7 +292,7 @@ in dataHall = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' Data hall identifier key. All processes physically located in a data hall should share the id. If you are depending on data hall based replication this must be set on all processes. @@ -305,7 +305,7 @@ in extraReadWritePaths = mkOption { default = [ ]; type = types.listOf types.path; - description = '' + description = lib.mdDoc '' An extra set of filesystem paths that FoundationDB can read to and write from. By default, FoundationDB runs under a heavily namespaced systemd environment without write access to most of @@ -319,13 +319,13 @@ in pidfile = mkOption { type = types.path; default = "/run/foundationdb.pid"; - description = "Path to pidfile for fdbmonitor."; + description = lib.mdDoc "Path to pidfile for fdbmonitor."; }; traceFormat = mkOption { type = types.enum [ "xml" "json" ]; default = "xml"; - description = "Trace logging format."; + description = lib.mdDoc "Trace logging format."; }; }; diff --git a/nixos/modules/services/databases/hbase.nix b/nixos/modules/services/databases/hbase.nix index fe4f05eec643c..5cc5d97e79846 100644 --- a/nixos/modules/services/databases/hbase.nix +++ b/nixos/modules/services/databases/hbase.nix @@ -41,7 +41,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to run HBase. ''; }; @@ -50,7 +50,7 @@ in { type = types.package; default = pkgs.hbase; defaultText = literalExpression "pkgs.hbase"; - description = '' + description = lib.mdDoc '' HBase package to use. ''; }; @@ -59,7 +59,7 @@ in { user = mkOption { type = types.str; default = "hbase"; - description = '' + description = lib.mdDoc '' User account under which HBase runs. ''; }; @@ -67,7 +67,7 @@ in { group = mkOption { type = types.str; default = "hbase"; - description = '' + description = lib.mdDoc '' Group account under which HBase runs. ''; }; @@ -75,7 +75,7 @@ in { dataDir = mkOption { type = types.path; default = "/var/lib/hbase"; - description = '' + description = lib.mdDoc '' Specifies location of HBase database files. This location should be writable and readable for the user the HBase service runs as (hbase by default). @@ -85,7 +85,7 @@ in { logDir = mkOption { type = types.path; default = "/var/log/hbase"; - description = '' + description = lib.mdDoc '' Specifies the location of HBase log files. ''; }; @@ -102,8 +102,8 @@ in { "hbase.zookeeper.property.dataDir" = "''${config.${opt.dataDir}}/zookeeper"; } ''; - description = '' - configurations in hbase-site.xml, see <link xlink:href="https://github.com/apache/hbase/blob/master/hbase-server/src/test/resources/hbase-site.xml"/> for details. + description = lib.mdDoc '' + configurations in hbase-site.xml, see <https://github.com/apache/hbase/blob/master/hbase-server/src/test/resources/hbase-site.xml> for details. ''; }; diff --git a/nixos/modules/services/databases/influxdb.nix b/nixos/modules/services/databases/influxdb.nix index f7383b2023a4e..9b3922c70af34 100644 --- a/nixos/modules/services/databases/influxdb.nix +++ b/nixos/modules/services/databases/influxdb.nix @@ -114,38 +114,38 @@ in enable = mkOption { default = false; - description = "Whether to enable the influxdb server"; + description = lib.mdDoc "Whether to enable the influxdb server"; type = types.bool; }; package = mkOption { default = pkgs.influxdb; defaultText = literalExpression "pkgs.influxdb"; - description = "Which influxdb derivation to use"; + description = lib.mdDoc "Which influxdb derivation to use"; type = types.package; }; user = mkOption { default = "influxdb"; - description = "User account under which influxdb runs"; + description = lib.mdDoc "User account under which influxdb runs"; type = types.str; }; group = mkOption { default = "influxdb"; - description = "Group under which influxdb runs"; + description = lib.mdDoc "Group under which influxdb runs"; type = types.str; }; dataDir = mkOption { default = "/var/db/influxdb"; - description = "Data directory for influxd data files."; + description = lib.mdDoc "Data directory for influxd data files."; type = types.path; }; extraConfig = mkOption { default = {}; - description = "Extra configuration options for influxdb"; + description = lib.mdDoc "Extra configuration options for influxdb"; type = types.attrs; }; }; diff --git a/nixos/modules/services/databases/influxdb2.nix b/nixos/modules/services/databases/influxdb2.nix index 340c515bbb434..8eeec7816c29f 100644 --- a/nixos/modules/services/databases/influxdb2.nix +++ b/nixos/modules/services/databases/influxdb2.nix @@ -15,13 +15,13 @@ in package = mkOption { default = pkgs.influxdb2-server; defaultText = literalExpression "pkgs.influxdb2"; - description = "influxdb2 derivation to use."; + description = lib.mdDoc "influxdb2 derivation to use."; type = types.package; }; settings = mkOption { default = { }; - description = ''configuration options for influxdb2, see <link xlink:href="https://docs.influxdata.com/influxdb/v2.0/reference/config-options"/> for details.''; + description = lib.mdDoc ''configuration options for influxdb2, see <https://docs.influxdata.com/influxdb/v2.0/reference/config-options> for details.''; type = format.type; }; }; diff --git a/nixos/modules/services/databases/memcached.nix b/nixos/modules/services/databases/memcached.nix index 1c06937e2f30f..33627e8ad3491 100644 --- a/nixos/modules/services/databases/memcached.nix +++ b/nixos/modules/services/databases/memcached.nix @@ -22,19 +22,19 @@ in user = mkOption { type = types.str; default = "memcached"; - description = "The user to run Memcached as"; + description = lib.mdDoc "The user to run Memcached as"; }; listen = mkOption { type = types.str; default = "127.0.0.1"; - description = "The IP address to bind to."; + description = lib.mdDoc "The IP address to bind to."; }; port = mkOption { type = types.port; default = 11211; - description = "The port to bind to."; + description = lib.mdDoc "The port to bind to."; }; enableUnixSocket = mkEnableOption "unix socket at /run/memcached/memcached.sock"; @@ -42,19 +42,19 @@ in maxMemory = mkOption { type = types.ints.unsigned; default = 64; - description = "The maximum amount of memory to use for storage, in megabytes."; + description = lib.mdDoc "The maximum amount of memory to use for storage, in megabytes."; }; maxConnections = mkOption { type = types.ints.unsigned; default = 1024; - description = "The maximum number of simultaneous connections."; + description = lib.mdDoc "The maximum number of simultaneous connections."; }; extraOptions = mkOption { type = types.listOf types.str; default = []; - description = "A list of extra options that will be added as a suffix when running memcached."; + description = lib.mdDoc "A list of extra options that will be added as a suffix when running memcached."; }; }; diff --git a/nixos/modules/services/databases/monetdb.nix b/nixos/modules/services/databases/monetdb.nix index 52a2ef041f8b5..c6836128d9ab6 100644 --- a/nixos/modules/services/databases/monetdb.nix +++ b/nixos/modules/services/databases/monetdb.nix @@ -18,38 +18,38 @@ in { type = types.package; default = pkgs.monetdb; defaultText = literalExpression "pkgs.monetdb"; - description = "MonetDB package to use."; + description = lib.mdDoc "MonetDB package to use."; }; user = mkOption { type = types.str; default = "monetdb"; - description = "User account under which MonetDB runs."; + description = lib.mdDoc "User account under which MonetDB runs."; }; group = mkOption { type = types.str; default = "monetdb"; - description = "Group under which MonetDB runs."; + description = lib.mdDoc "Group under which MonetDB runs."; }; dataDir = mkOption { type = types.path; default = "/var/lib/monetdb"; - description = "Data directory for the dbfarm."; + description = lib.mdDoc "Data directory for the dbfarm."; }; port = mkOption { type = types.ints.u16; default = 50000; - description = "Port to listen on."; + description = lib.mdDoc "Port to listen on."; }; listenAddress = mkOption { type = types.str; default = "127.0.0.1"; example = "0.0.0.0"; - description = "Address to listen on."; + description = lib.mdDoc "Address to listen on."; }; }; }; diff --git a/nixos/modules/services/databases/mongodb.nix b/nixos/modules/services/databases/mongodb.nix index fccf85d482e07..981185cc534ca 100644 --- a/nixos/modules/services/databases/mongodb.nix +++ b/nixos/modules/services/databases/mongodb.nix @@ -43,49 +43,49 @@ in user = mkOption { type = types.str; default = "mongodb"; - description = "User account under which MongoDB runs"; + description = lib.mdDoc "User account under which MongoDB runs"; }; bind_ip = mkOption { type = types.str; default = "127.0.0.1"; - description = "IP to bind to"; + description = lib.mdDoc "IP to bind to"; }; quiet = mkOption { type = types.bool; default = false; - description = "quieter output"; + description = lib.mdDoc "quieter output"; }; enableAuth = mkOption { type = types.bool; default = false; - description = "Enable client authentication. Creates a default superuser with username root!"; + description = lib.mdDoc "Enable client authentication. Creates a default superuser with username root!"; }; initialRootPassword = mkOption { type = types.nullOr types.str; default = null; - description = "Password for the root user if auth is enabled."; + description = lib.mdDoc "Password for the root user if auth is enabled."; }; dbpath = mkOption { type = types.str; default = "/var/db/mongodb"; - description = "Location where MongoDB stores its files"; + description = lib.mdDoc "Location where MongoDB stores its files"; }; pidFile = mkOption { type = types.str; default = "/run/mongodb.pid"; - description = "Location of MongoDB pid file"; + description = lib.mdDoc "Location of MongoDB pid file"; }; replSetName = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' If this instance is part of a replica set, set its name here. Otherwise, leave empty to run as single node. ''; @@ -97,13 +97,13 @@ in example = '' storage.journal.enabled: false ''; - description = "MongoDB extra configuration in YAML format"; + description = lib.mdDoc "MongoDB extra configuration in YAML format"; }; initialScript = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' A file containing MongoDB statements to execute on first startup. ''; }; diff --git a/nixos/modules/services/databases/mysql.nix b/nixos/modules/services/databases/mysql.nix index 625b31d081c9a..b7a55900c122f 100644 --- a/nixos/modules/services/databases/mysql.nix +++ b/nixos/modules/services/databases/mysql.nix @@ -88,9 +88,9 @@ in defaultText = '' A configuration file automatically generated by NixOS. ''; - description = '' + description = lib.mdDoc '' Override the configuration file used by MySQL. By default, - NixOS generates one automatically from <option>services.mysql.settings</option>. + NixOS generates one automatically from {option}`services.mysql.settings`. ''; example = literalExpression '' pkgs.writeText "my.cnf" ''' @@ -143,14 +143,14 @@ in options = { name = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The name of the database to create. ''; }; schema = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' The initial schema of the database; if null (the default), an empty database is created. ''; @@ -158,7 +158,7 @@ in }; }); default = []; - description = '' + description = lib.mdDoc '' List of database names and their initial schemas that should be used to create databases on the first startup of MySQL. The schema attribute is optional: If not specified, an empty database is created. ''; @@ -171,13 +171,13 @@ in initialScript = mkOption { type = types.nullOr types.path; default = null; - description = "A file containing SQL statements to be executed on the first startup. Can be used for granting certain permissions on the database."; + description = lib.mdDoc "A file containing SQL statements to be executed on the first startup. Can be used for granting certain permissions on the database."; }; ensureDatabases = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Ensures that the specified databases exist. This option will never delete existing databases, especially not when the value of this option is changed. This means that databases created once through this option or @@ -194,7 +194,7 @@ in options = { name = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Name of the user to ensure. ''; }; @@ -223,7 +223,7 @@ in }; }); default = []; - description = '' + description = lib.mdDoc '' Ensures that the specified users exist and have at least the ensured permissions. The MySQL users will be identified using Unix socket authentication. This authenticates the Unix user with the same name only, and that without the need for a password. @@ -253,39 +253,39 @@ in role = mkOption { type = types.enum [ "master" "slave" "none" ]; default = "none"; - description = "Role of the MySQL server instance."; + description = lib.mdDoc "Role of the MySQL server instance."; }; serverId = mkOption { type = types.int; default = 1; - description = "Id of the MySQL server instance. This number must be unique for each instance."; + description = lib.mdDoc "Id of the MySQL server instance. This number must be unique for each instance."; }; masterHost = mkOption { type = types.str; - description = "Hostname of the MySQL master server."; + description = lib.mdDoc "Hostname of the MySQL master server."; }; slaveHost = mkOption { type = types.str; - description = "Hostname of the MySQL slave server."; + description = lib.mdDoc "Hostname of the MySQL slave server."; }; masterUser = mkOption { type = types.str; - description = "Username of the MySQL replication user."; + description = lib.mdDoc "Username of the MySQL replication user."; }; masterPassword = mkOption { type = types.str; - description = "Password of the MySQL replication user."; + description = lib.mdDoc "Password of the MySQL replication user."; }; masterPort = mkOption { type = types.port; default = 3306; - description = "Port number on which the MySQL master server runs."; + description = lib.mdDoc "Port number on which the MySQL master server runs."; }; }; }; diff --git a/nixos/modules/services/databases/neo4j.nix b/nixos/modules/services/databases/neo4j.nix index 8816f3b2e4b64..dbbb79f01ebb5 100644 --- a/nixos/modules/services/databases/neo4j.nix +++ b/nixos/modules/services/databases/neo4j.nix @@ -123,7 +123,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable Neo4j Community Edition. ''; }; @@ -131,7 +131,7 @@ in { allowUpgrade = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Allow upgrade of Neo4j database files from an older version. ''; }; @@ -170,9 +170,9 @@ in { extraServerConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration for Neo4j Community server. Refer to the - <link xlink:href="https://neo4j.com/docs/operations-manual/current/reference/configuration-settings/">complete reference</link> + [complete reference](https://neo4j.com/docs/operations-manual/current/reference/configuration-settings/) of Neo4j configuration settings. ''; }; @@ -181,7 +181,7 @@ in { type = types.package; default = pkgs.neo4j; defaultText = literalExpression "pkgs.neo4j"; - description = '' + description = lib.mdDoc '' Neo4j package to use. ''; }; @@ -189,7 +189,7 @@ in { readOnly = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Only allow read operations from this Neo4j instance. ''; }; @@ -197,9 +197,9 @@ in { workerCount = mkOption { type = types.ints.between 0 44738; default = 0; - description = '' + description = lib.mdDoc '' Number of Neo4j worker threads, where the default of - <literal>0</literal> indicates a worker count equal to the number of + `0` indicates a worker count equal to the number of available processors. ''; }; @@ -208,9 +208,9 @@ in { enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Enable the BOLT connector for Neo4j. Setting this option to - <literal>false</literal> will stop Neo4j from listening for incoming + `false` will stop Neo4j from listening for incoming connections on the BOLT port (7687 by default). ''; }; @@ -218,9 +218,9 @@ in { listenAddress = mkOption { type = types.str; default = ":7687"; - description = '' + description = lib.mdDoc '' Neo4j listen address for BOLT traffic. The listen address is - expressed in the format <literal><ip-address>:<port-number></literal>. + expressed in the format `<ip-address>:<port-number>`. ''; }; @@ -247,7 +247,7 @@ in { tlsLevel = mkOption { type = types.enum [ "REQUIRED" "OPTIONAL" "DISABLED" ]; default = "OPTIONAL"; - description = '' + description = lib.mdDoc '' SSL/TSL requirement level for BOLT traffic. ''; }; @@ -297,11 +297,11 @@ in { home = mkOption { type = types.path; default = "/var/lib/neo4j"; - description = '' + description = lib.mdDoc '' Path of the Neo4j home directory. Other default directories are subdirectories of this path. This directory will be created if - non-existent, and its ownership will be <command>chown</command> to - the Neo4j daemon user <literal>neo4j</literal>. + non-existent, and its ownership will be {command}`chown` to + the Neo4j daemon user `neo4j`. ''; }; @@ -343,10 +343,10 @@ in { enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' The HTTP connector is required for Neo4j, and cannot be disabled. - Setting this option to <literal>false</literal> will force the HTTP - connector's <option>listenAddress</option> to the loopback + Setting this option to `false` will force the HTTP + connector's {option}`listenAddress` to the loopback interface to prevent connection of remote clients. To prevent all clients from connecting, block the HTTP port (7474 by default) by firewall. @@ -356,9 +356,9 @@ in { listenAddress = mkOption { type = types.str; default = ":7474"; - description = '' + description = lib.mdDoc '' Neo4j listen address for HTTP traffic. The listen address is - expressed in the format <literal><ip-address>:<port-number></literal>. + expressed in the format `<ip-address>:<port-number>`. ''; }; }; @@ -367,9 +367,9 @@ in { enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Enable the HTTPS connector for Neo4j. Setting this option to - <literal>false</literal> will stop Neo4j from listening for incoming + `false` will stop Neo4j from listening for incoming connections on the HTTPS port (7473 by default). ''; }; @@ -377,9 +377,9 @@ in { listenAddress = mkOption { type = types.str; default = ":7473"; - description = '' + description = lib.mdDoc '' Neo4j listen address for HTTPS traffic. The listen address is - expressed in the format <literal><ip-address>:<port-number></literal>. + expressed in the format `<ip-address>:<port-number>`. ''; }; @@ -403,9 +403,9 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable a remote shell server which Neo4j Shell clients can log in to. - Only applicable to <command>neo4j-shell</command>. + Only applicable to {command}`neo4j-shell`. ''; }; }; @@ -456,7 +456,7 @@ in { ciphers = mkOption { type = types.nullOr (types.listOf types.str); default = null; - description = '' + description = lib.mdDoc '' Restrict the allowed ciphers of this policy to those defined here. The default ciphers are those of the JVM platform. ''; @@ -465,7 +465,7 @@ in { clientAuth = mkOption { type = types.enum [ "NONE" "OPTIONAL" "REQUIRE" ]; default = "REQUIRE"; - description = '' + description = lib.mdDoc '' The client authentication stance for this policy. ''; }; @@ -473,9 +473,9 @@ in { privateKey = mkOption { type = types.str; default = "private.key"; - description = '' + description = lib.mdDoc '' The name of private PKCS #8 key file for this policy to be found - in the <option>baseDirectory</option>, or the absolute path to + in the {option}`baseDirectory`, or the absolute path to the key file. It is mandatory that a key can be found or generated. ''; }; @@ -500,22 +500,22 @@ in { type = types.path; default = "${config.baseDirectory}/revoked"; defaultText = literalExpression ''"''${config.${options.baseDirectory}}/revoked"''; - description = '' + description = lib.mdDoc '' Path to directory of CRLs (Certificate Revocation Lists) in PEM format. Must be an absolute path. The existence of this directory is mandatory and will need to be created manually when: setting this option to something other than its default; setting - either this policy's <option>baseDirectory</option> or - <option>directories.certificates</option> to something other than + either this policy's {option}`baseDirectory` or + {option}`directories.certificates` to something other than their default. Ensure read/write permissions are given to the - Neo4j daemon user <literal>neo4j</literal>. + Neo4j daemon user `neo4j`. ''; }; tlsVersions = mkOption { type = types.listOf types.str; default = [ "TLSv1.2" ]; - description = '' + description = lib.mdDoc '' Restrict the TLS protocol versions of this policy to those defined here. ''; @@ -524,7 +524,7 @@ in { trustAll = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Makes this policy trust all remote parties. Enabling this is not recommended and the policy's trusted directory will be ignored. Use of this mode is discouraged. It would offer encryption but @@ -573,12 +573,12 @@ in { })); default = {}; - description = '' + description = lib.mdDoc '' Defines the SSL policies for use with Neo4j connectors. Each attribute of this set defines a policy, with the attribute name defining the name of the policy and its namespace. Refer to the operations manual section on Neo4j's - <link xlink:href="https://neo4j.com/docs/operations-manual/current/security/ssl-framework/">SSL Framework</link> + [SSL Framework](https://neo4j.com/docs/operations-manual/current/security/ssl-framework/) for further details. ''; }; @@ -587,10 +587,10 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the Usage Data Collector which Neo4j uses to collect usage data. Refer to the operations manual section on the - <link xlink:href="https://neo4j.com/docs/operations-manual/current/configuration/usage-data-collector/">Usage Data Collector</link> + [Usage Data Collector](https://neo4j.com/docs/operations-manual/current/configuration/usage-data-collector/) for more information. ''; }; diff --git a/nixos/modules/services/databases/openldap.nix b/nixos/modules/services/databases/openldap.nix index a6a43e8dab915..9bb0640439475 100644 --- a/nixos/modules/services/databases/openldap.nix +++ b/nixos/modules/services/databases/openldap.nix @@ -31,7 +31,7 @@ let attrs = mkOption { type = types.attrsOf ldapValueType; default = {}; - description = "Attributes of the parent entry."; + description = lib.mdDoc "Attributes of the parent entry."; }; children = mkOption { # Hide the child attributes, to avoid infinite recursion in e.g. documentation @@ -40,7 +40,7 @@ let hiddenOptions = lib.mapAttrs (name: attr: attr // { visible = false; }) options; in types.attrsOf (types.submodule { options = hiddenOptions; }); default = {}; - description = "Child entries of the current entry, with recursively the same structure."; + description = lib.mdDoc "Child entries of the current entry, with recursively the same structure."; example = lib.literalExpression '' { "cn=schema" = { @@ -59,7 +59,7 @@ let includes = mkOption { type = types.listOf types.path; default = []; - description = '' + description = lib.mdDoc '' LDIF files to include after the parent's attributes but before its children. ''; }; @@ -95,7 +95,7 @@ in { type = types.package; default = pkgs.openldap; defaultText = literalExpression "pkgs.openldap"; - description = '' + description = lib.mdDoc '' OpenLDAP package to use. This can be used to, for example, set an OpenLDAP package @@ -107,25 +107,25 @@ in { user = mkOption { type = types.str; default = "openldap"; - description = "User account under which slapd runs."; + description = lib.mdDoc "User account under which slapd runs."; }; group = mkOption { type = types.str; default = "openldap"; - description = "Group account under which slapd runs."; + description = lib.mdDoc "Group account under which slapd runs."; }; urlList = mkOption { type = types.listOf types.str; default = [ "ldap:///" ]; - description = "URL list slapd should listen on."; + description = lib.mdDoc "URL list slapd should listen on."; example = [ "ldaps:///" ]; }; settings = mkOption { type = ldapAttrsType; - description = "Configuration for OpenLDAP, in OLC format"; + description = lib.mdDoc "Configuration for OpenLDAP, in OLC format"; example = lib.literalExpression '' { attrs.olcLogLevel = [ "stats" ]; @@ -194,7 +194,7 @@ in { declarativeContents = mkOption { type = with types; attrsOf lines; default = {}; - description = '' + description = lib.mdDoc '' Declarative contents for the LDAP database, in LDIF format by suffix. All data will be erased when starting the LDAP server. Modifications diff --git a/nixos/modules/services/databases/opentsdb.nix b/nixos/modules/services/databases/opentsdb.nix index e873b2f701157..45c84b12a50eb 100644 --- a/nixos/modules/services/databases/opentsdb.nix +++ b/nixos/modules/services/databases/opentsdb.nix @@ -18,7 +18,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to run OpenTSDB. ''; }; @@ -27,7 +27,7 @@ in { type = types.package; default = pkgs.opentsdb; defaultText = literalExpression "pkgs.opentsdb"; - description = '' + description = lib.mdDoc '' OpenTSDB package to use. ''; }; @@ -35,7 +35,7 @@ in { user = mkOption { type = types.str; default = "opentsdb"; - description = '' + description = lib.mdDoc '' User account under which OpenTSDB runs. ''; }; @@ -43,7 +43,7 @@ in { group = mkOption { type = types.str; default = "opentsdb"; - description = '' + description = lib.mdDoc '' Group account under which OpenTSDB runs. ''; }; @@ -51,7 +51,7 @@ in { port = mkOption { type = types.int; default = 4242; - description = '' + description = lib.mdDoc '' Which port OpenTSDB listens on. ''; }; @@ -62,7 +62,7 @@ in { tsd.core.auto_create_metrics = true tsd.http.request.enable_chunked = true ''; - description = '' + description = lib.mdDoc '' The contents of OpenTSDB's configuration file ''; }; diff --git a/nixos/modules/services/databases/pgmanage.nix b/nixos/modules/services/databases/pgmanage.nix index f30f71866afd6..f50e7244ee115 100644 --- a/nixos/modules/services/databases/pgmanage.nix +++ b/nixos/modules/services/databases/pgmanage.nix @@ -50,7 +50,7 @@ in { type = types.package; default = pkgs.pgmanage; defaultText = literalExpression "pkgs.pgmanage"; - description = '' + description = lib.mdDoc '' The pgmanage package to use. ''; }; @@ -78,7 +78,7 @@ in { allowCustomConnections = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' This tells pgmanage whether or not to allow anyone to use a custom connection from the login screen. ''; @@ -87,7 +87,7 @@ in { port = mkOption { type = types.int; default = 8080; - description = '' + description = lib.mdDoc '' This tells pgmanage what port to listen on for browser requests. ''; }; @@ -95,7 +95,7 @@ in { localOnly = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' This tells pgmanage whether or not to set the listening socket to local addresses only. ''; @@ -104,7 +104,7 @@ in { superOnly = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' This tells pgmanage whether or not to only allow super users to login. The recommended value is true and will restrict users who are not super users from logging in to any PostgreSQL instance through @@ -116,7 +116,7 @@ in { loginGroup = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' This tells pgmanage to only allow users in a certain PostgreSQL group to login to pgmanage. Note that a connection will be made to PostgreSQL in order to test if the user is a member of the login group. @@ -126,7 +126,7 @@ in { loginTimeout = mkOption { type = types.int; default = 3600; - description = '' + description = lib.mdDoc '' Number of seconds of inactivity before user is automatically logged out. ''; @@ -135,7 +135,7 @@ in { sqlRoot = mkOption { type = types.str; default = "/var/lib/pgmanage"; - description = '' + description = lib.mdDoc '' This tells pgmanage where to put the SQL file history. All tabs are saved to this location so that if you get disconnected from pgmanage you don't lose your work. @@ -147,16 +147,16 @@ in { options = { cert = mkOption { type = types.str; - description = "TLS certificate"; + description = lib.mdDoc "TLS certificate"; }; key = mkOption { type = types.str; - description = "TLS key"; + description = lib.mdDoc "TLS key"; }; }; }); default = null; - description = '' + description = lib.mdDoc '' These options tell pgmanage where the TLS Certificate and Key files reside. If you use these options then you'll only be able to access pgmanage through a secure TLS connection. These options are only @@ -165,14 +165,14 @@ in { configuration. This allows your web server to terminate the secure connection and pass on the request to pgmanage. You can find help to set up this configuration in: - <link xlink:href="https://github.com/pgManage/pgManage/blob/master/INSTALL_NGINX.md"/> + <https://github.com/pgManage/pgManage/blob/master/INSTALL_NGINX.md> ''; }; logLevel = mkOption { type = types.enum ["error" "warn" "notice" "info"]; default = "error"; - description = '' + description = lib.mdDoc '' Verbosity of logs ''; }; diff --git a/nixos/modules/services/databases/postgresql.nix b/nixos/modules/services/databases/postgresql.nix index 550bd36efff28..e27f4518dfada 100644 --- a/nixos/modules/services/databases/postgresql.nix +++ b/nixos/modules/services/databases/postgresql.nix @@ -45,7 +45,7 @@ in package = mkOption { type = types.package; example = literalExpression "pkgs.postgresql_11"; - description = '' + description = lib.mdDoc '' PostgreSQL package to use. ''; }; @@ -53,7 +53,7 @@ in port = mkOption { type = types.int; default = 5432; - description = '' + description = lib.mdDoc '' The port on which PostgreSQL listens. ''; }; @@ -61,14 +61,14 @@ in checkConfig = mkOption { type = types.bool; default = true; - description = "Check the syntax of the configuration file at compile time"; + description = lib.mdDoc "Check the syntax of the configuration file at compile time"; }; dataDir = mkOption { type = types.path; defaultText = literalExpression ''"/var/lib/postgresql/''${config.services.postgresql.package.psqlSchema}"''; example = "/var/lib/postgresql/11"; - description = '' + description = lib.mdDoc '' The data directory for PostgreSQL. If left as the default value this directory will automatically be created before the PostgreSQL server starts, otherwise the sysadmin is responsible for ensuring the directory exists with appropriate ownership @@ -96,7 +96,7 @@ in identMap = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Defines the mapping from system users to database users. The general form is: @@ -109,8 +109,8 @@ in type = with types; listOf str; default = []; example = [ "--data-checksums" "--allow-group-access" ]; - description = '' - Additional arguments passed to <literal>initdb</literal> during data dir + description = lib.mdDoc '' + Additional arguments passed to `initdb` during data dir initialisation. ''; }; @@ -118,7 +118,7 @@ in initialScript = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' A file containing SQL statements to execute on first startup. ''; }; @@ -126,7 +126,7 @@ in ensureDatabases = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Ensures that the specified databases exist. This option will never delete existing databases, especially not when the value of this option is changed. This means that databases created once through this option or @@ -143,7 +143,7 @@ in options = { name = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Name of the user to ensure. ''; }; @@ -171,7 +171,7 @@ in }; }); default = []; - description = '' + description = lib.mdDoc '' Ensures that the specified users exist and have at least the ensured permissions. The PostgreSQL users will be identified using peer authentication. This authenticates the Unix user with the same name only, and that without the need for a password. @@ -200,7 +200,7 @@ in enableTCPIP = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether PostgreSQL should listen on all network interfaces. If disabled, the database can only be accessed via its Unix domain socket or via TCP connections to localhost. @@ -211,9 +211,9 @@ in type = types.str; default = "[%p] "; example = "%m [%p] "; - description = '' + description = lib.mdDoc '' A printf-style string that is output at the beginning of each log line. - Upstream default is <literal>'%m [%p] '</literal>, i.e. it includes the timestamp. We do + Upstream default is `'%m [%p] '`, i.e. it includes the timestamp. We do not include the timestamp, because journal has it anyway. ''; }; @@ -222,9 +222,9 @@ in type = types.listOf types.path; default = []; example = literalExpression "with pkgs.postgresql_11.pkgs; [ postgis pg_repack ]"; - description = '' + description = lib.mdDoc '' List of PostgreSQL plugins. PostgreSQL version for each plugin should - match version for <literal>services.postgresql.package</literal> value. + match version for `services.postgresql.package` value. ''; }; @@ -255,8 +255,8 @@ in recoveryConfig = mkOption { type = types.nullOr types.lines; default = null; - description = '' - Contents of the <filename>recovery.conf</filename> file. + description = lib.mdDoc '' + Contents of the {file}`recovery.conf` file. ''; }; diff --git a/nixos/modules/services/databases/redis.nix b/nixos/modules/services/databases/redis.nix index 5532c54019706..b346438cfffca 100644 --- a/nixos/modules/services/databases/redis.nix +++ b/nixos/modules/services/databases/redis.nix @@ -58,7 +58,7 @@ in { type = types.package; default = pkgs.redis; defaultText = literalExpression "pkgs.redis"; - description = "Which Redis derivation to use."; + description = lib.mdDoc "Which Redis derivation to use."; }; vmOverCommit = mkEnableOption '' @@ -84,14 +84,14 @@ in { defaultText = literalExpression '' if name == "" then "redis" else "redis-''${name}" ''; - description = "The username and groupname for redis-server."; + description = lib.mdDoc "The username and groupname for redis-server."; }; port = mkOption { type = types.port; default = if name == "" then 6379 else 0; defaultText = literalExpression ''if name == "" then 6379 else 0''; - description = '' + description = lib.mdDoc '' The TCP port to accept connections. If port 0 is specified Redis will not listen on a TCP socket. ''; @@ -100,7 +100,7 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to open ports in the firewall for the server. ''; }; @@ -108,9 +108,9 @@ in { bind = mkOption { type = with types; nullOr str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' The IP interface to bind to. - <literal>null</literal> means "all interfaces". + `null` means "all interfaces". ''; example = "192.0.2.1"; }; @@ -121,13 +121,13 @@ in { defaultText = literalExpression '' if name == "" then "/run/redis/redis.sock" else "/run/redis-''${name}/redis.sock" ''; - description = "The path to the socket to bind to."; + description = lib.mdDoc "The path to the socket to bind to."; }; unixSocketPerm = mkOption { type = types.int; default = 660; - description = "Change permissions for the socket"; + description = lib.mdDoc "Change permissions for the socket"; example = 600; }; @@ -135,32 +135,32 @@ in { type = types.str; default = "notice"; # debug, verbose, notice, warning example = "debug"; - description = "Specify the server verbosity level, options: debug, verbose, notice, warning."; + description = lib.mdDoc "Specify the server verbosity level, options: debug, verbose, notice, warning."; }; logfile = mkOption { type = types.str; default = "/dev/null"; - description = "Specify the log file name. Also 'stdout' can be used to force Redis to log on the standard output."; + description = lib.mdDoc "Specify the log file name. Also 'stdout' can be used to force Redis to log on the standard output."; example = "/var/log/redis.log"; }; syslog = mkOption { type = types.bool; default = true; - description = "Enable logging to the system logger."; + description = lib.mdDoc "Enable logging to the system logger."; }; databases = mkOption { type = types.int; default = 16; - description = "Set the number of databases."; + description = lib.mdDoc "Set the number of databases."; }; maxclients = mkOption { type = types.int; default = 10000; - description = "Set the max number of connected clients at the same time."; + description = lib.mdDoc "Set the max number of connected clients at the same time."; }; save = mkOption { @@ -178,27 +178,27 @@ in { options = { ip = mkOption { type = str; - description = "IP of the Redis master"; + description = lib.mdDoc "IP of the Redis master"; example = "192.168.1.100"; }; port = mkOption { type = port; - description = "port of the Redis master"; + description = lib.mdDoc "port of the Redis master"; default = 6379; }; }; })); default = null; - description = "IP and port to which this redis instance acts as a slave."; + description = lib.mdDoc "IP and port to which this redis instance acts as a slave."; example = { ip = "192.168.1.100"; port = 6379; }; }; masterAuth = mkOption { type = with types; nullOr str; default = null; - description = ''If the master is password protected (using the requirePass configuration) + description = lib.mdDoc ''If the master is password protected (using the requirePass configuration) it is possible to tell the slave to authenticate before starting the replication synchronization process, otherwise the master will refuse the slave request. (STORED PLAIN TEXT, WORLD-READABLE IN NIX STORE)''; @@ -207,7 +207,7 @@ in { requirePass = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Password for database (STORED PLAIN TEXT, WORLD-READABLE IN NIX STORE). Use requirePassFile to store it outside of the nix store in a dedicated file. ''; @@ -217,42 +217,42 @@ in { requirePassFile = mkOption { type = with types; nullOr path; default = null; - description = "File with password for the database."; + description = lib.mdDoc "File with password for the database."; example = "/run/keys/redis-password"; }; appendOnly = mkOption { type = types.bool; default = false; - description = "By default data is only periodically persisted to disk, enable this option to use an append-only file for improved persistence."; + description = lib.mdDoc "By default data is only periodically persisted to disk, enable this option to use an append-only file for improved persistence."; }; appendFsync = mkOption { type = types.str; default = "everysec"; # no, always, everysec - description = "How often to fsync the append-only log, options: no, always, everysec."; + description = lib.mdDoc "How often to fsync the append-only log, options: no, always, everysec."; }; slowLogLogSlowerThan = mkOption { type = types.int; default = 10000; - description = "Log queries whose execution take longer than X in milliseconds."; + description = lib.mdDoc "Log queries whose execution take longer than X in milliseconds."; example = 1000; }; slowLogMaxLen = mkOption { type = types.int; default = 128; - description = "Maximum number of items to keep in slow log."; + description = lib.mdDoc "Maximum number of items to keep in slow log."; }; settings = mkOption { # TODO: this should be converted to freeformType type = with types; attrsOf (oneOf [ bool int str (listOf str) ]); default = {}; - description = '' + description = lib.mdDoc '' Redis configuration. Refer to - <link xlink:href="https://redis.io/topics/config"/> + <https://redis.io/topics/config> for details on supported values. ''; example = literalExpression '' @@ -294,7 +294,7 @@ in { (mkIf (config.requirePass != null) { requirepass = config.requirePass; }) ]; })); - description = "Configuration of multiple <literal>redis-server</literal> instances."; + description = lib.mdDoc "Configuration of multiple `redis-server` instances."; default = {}; }; }; diff --git a/nixos/modules/services/databases/victoriametrics.nix b/nixos/modules/services/databases/victoriametrics.nix index 0513dcff172b3..28a6ccfd5e20c 100644 --- a/nixos/modules/services/databases/victoriametrics.nix +++ b/nixos/modules/services/databases/victoriametrics.nix @@ -7,21 +7,21 @@ let cfg = config.services.victoriametrics; in type = types.package; default = pkgs.victoriametrics; defaultText = literalExpression "pkgs.victoriametrics"; - description = '' + description = lib.mdDoc '' The VictoriaMetrics distribution to use. ''; }; listenAddress = mkOption { default = ":8428"; type = types.str; - description = '' + description = lib.mdDoc '' The listen address for the http interface. ''; }; retentionPeriod = mkOption { type = types.int; default = 1; - description = '' + description = lib.mdDoc '' Retention period in months. ''; }; diff --git a/nixos/modules/services/desktops/accountsservice.nix b/nixos/modules/services/desktops/accountsservice.nix index ae2ecb5ffeb71..af62850acdc17 100644 --- a/nixos/modules/services/desktops/accountsservice.nix +++ b/nixos/modules/services/desktops/accountsservice.nix @@ -19,7 +19,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable AccountsService, a DBus service for accessing the list of user accounts and information attached to those accounts. ''; diff --git a/nixos/modules/services/desktops/cpupower-gui.nix b/nixos/modules/services/desktops/cpupower-gui.nix index f66afc0a3dc17..47071aebce8d3 100644 --- a/nixos/modules/services/desktops/cpupower-gui.nix +++ b/nixos/modules/services/desktops/cpupower-gui.nix @@ -11,7 +11,7 @@ in { type = lib.types.bool; default = false; example = true; - description = '' + description = lib.mdDoc '' Enables dbus/systemd service needed by cpupower-gui. These services are responsible for retrieving and modifying cpu power saving settings. diff --git a/nixos/modules/services/desktops/dleyna-renderer.nix b/nixos/modules/services/desktops/dleyna-renderer.nix index 7f88605f627c1..daf65180b36fb 100644 --- a/nixos/modules/services/desktops/dleyna-renderer.nix +++ b/nixos/modules/services/desktops/dleyna-renderer.nix @@ -10,7 +10,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable dleyna-renderer service, a DBus service for handling DLNA renderers. ''; diff --git a/nixos/modules/services/desktops/dleyna-server.nix b/nixos/modules/services/desktops/dleyna-server.nix index 9a131a5e700f2..9cbcd2a9cdaee 100644 --- a/nixos/modules/services/desktops/dleyna-server.nix +++ b/nixos/modules/services/desktops/dleyna-server.nix @@ -10,7 +10,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable dleyna-server service, a DBus service for handling DLNA servers. ''; diff --git a/nixos/modules/services/desktops/geoclue2.nix b/nixos/modules/services/desktops/geoclue2.nix index 60a34dd656313..58bebd9bd46d6 100644 --- a/nixos/modules/services/desktops/geoclue2.nix +++ b/nixos/modules/services/desktops/geoclue2.nix @@ -16,19 +16,19 @@ let options = { desktopID = mkOption { type = types.str; - description = "Desktop ID of the application."; + description = lib.mdDoc "Desktop ID of the application."; }; isAllowed = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Whether the application will be allowed access to location information. ''; }; isSystem = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Whether the application is a system component or not. ''; }; @@ -36,7 +36,7 @@ let users = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' List of UIDs of all users for which this application is allowed location info access, Defaults to an empty string to allow it for all users. ''; @@ -67,7 +67,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable GeoClue 2 daemon, a DBus service that provides location information for accessing. ''; @@ -76,7 +76,7 @@ in enableDemoAgent = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to use the GeoClue demo agent. This should be overridden by desktop environments that provide their own agent. @@ -86,7 +86,7 @@ in enableNmea = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to fetch location from NMEA sources on local network. ''; }; @@ -94,7 +94,7 @@ in enable3G = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable 3G source. ''; }; @@ -102,7 +102,7 @@ in enableCDMA = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable CDMA source. ''; }; @@ -110,7 +110,7 @@ in enableModemGPS = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable Modem-GPS source. ''; }; @@ -118,7 +118,7 @@ in enableWifi = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable WiFi source. ''; }; @@ -127,7 +127,7 @@ in type = types.str; default = "https://location.services.mozilla.com/v1/geolocate?key=geoclue"; example = "https://www.googleapis.com/geolocation/v1/geolocate?key=YOUR_KEY"; - description = '' + description = lib.mdDoc '' The url to the wifi GeoLocation Service. ''; }; @@ -135,7 +135,7 @@ in submitData = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to submit data to a GeoLocation Service. ''; }; @@ -143,7 +143,7 @@ in submissionUrl = mkOption { type = types.str; default = "https://location.services.mozilla.com/v1/submit?key=geoclue"; - description = '' + description = lib.mdDoc '' The url to submit data to a GeoLocation Service. ''; }; @@ -151,7 +151,7 @@ in submissionNick = mkOption { type = types.str; default = "geoclue"; - description = '' + description = lib.mdDoc '' A nickname to submit network data with. Must be 2-32 characters long. ''; @@ -167,7 +167,7 @@ in users = [ "300" ]; }; ''; - description = '' + description = lib.mdDoc '' Specify extra settings per application. ''; }; diff --git a/nixos/modules/services/desktops/gnome/at-spi2-core.nix b/nixos/modules/services/desktops/gnome/at-spi2-core.nix index 1268a9d49b82d..495ea5af9879d 100644 --- a/nixos/modules/services/desktops/gnome/at-spi2-core.nix +++ b/nixos/modules/services/desktops/gnome/at-spi2-core.nix @@ -27,12 +27,12 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable at-spi2-core, a service for the Assistive Technologies available on the GNOME platform. Enable this if you get the error or warning - <literal>The name org.a11y.Bus was not provided by any .service files</literal>. + `The name org.a11y.Bus was not provided by any .service files`. ''; }; diff --git a/nixos/modules/services/desktops/gnome/evolution-data-server.nix b/nixos/modules/services/desktops/gnome/evolution-data-server.nix index bd2242d98182e..65bb75c62d2ce 100644 --- a/nixos/modules/services/desktops/gnome/evolution-data-server.nix +++ b/nixos/modules/services/desktops/gnome/evolution-data-server.nix @@ -31,7 +31,7 @@ with lib; plugins = mkOption { type = types.listOf types.package; default = [ ]; - description = "Plugins for Evolution Data Server."; + description = lib.mdDoc "Plugins for Evolution Data Server."; }; }; programs.evolution = { @@ -40,7 +40,7 @@ with lib; type = types.listOf types.package; default = [ ]; example = literalExpression "[ pkgs.evolution-ews ]"; - description = "Plugins for Evolution."; + description = lib.mdDoc "Plugins for Evolution."; }; }; diff --git a/nixos/modules/services/desktops/gnome/gnome-keyring.nix b/nixos/modules/services/desktops/gnome/gnome-keyring.nix index d821da164beb1..6c7e713b32d56 100644 --- a/nixos/modules/services/desktops/gnome/gnome-keyring.nix +++ b/nixos/modules/services/desktops/gnome/gnome-keyring.nix @@ -27,7 +27,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable GNOME Keyring daemon, a service designed to take care of the user's security credentials, such as user names and passwords. diff --git a/nixos/modules/services/desktops/gnome/gnome-online-accounts.nix b/nixos/modules/services/desktops/gnome/gnome-online-accounts.nix index 01f7e3695cf04..ed5e000cae3e6 100644 --- a/nixos/modules/services/desktops/gnome/gnome-online-accounts.nix +++ b/nixos/modules/services/desktops/gnome/gnome-online-accounts.nix @@ -27,7 +27,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable GNOME Online Accounts daemon, a service that provides a single sign-on framework for the GNOME desktop. ''; diff --git a/nixos/modules/services/desktops/gnome/gnome-online-miners.nix b/nixos/modules/services/desktops/gnome/gnome-online-miners.nix index 5f9039f68c4ee..7cf1bfa1b046b 100644 --- a/nixos/modules/services/desktops/gnome/gnome-online-miners.nix +++ b/nixos/modules/services/desktops/gnome/gnome-online-miners.nix @@ -27,7 +27,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable GNOME Online Miners, a service that crawls through your online content. ''; diff --git a/nixos/modules/services/desktops/gnome/rygel.nix b/nixos/modules/services/desktops/gnome/rygel.nix index 7ea9778fc408d..9c0faaa4885be 100644 --- a/nixos/modules/services/desktops/gnome/rygel.nix +++ b/nixos/modules/services/desktops/gnome/rygel.nix @@ -21,10 +21,10 @@ with lib; services.gnome.rygel = { enable = mkOption { default = false; - description = '' + description = lib.mdDoc '' Whether to enable Rygel UPnP Mediaserver. - You will need to also allow UPnP connections in firewall, see the following <link xlink:href="https://github.com/NixOS/nixpkgs/pull/45045#issuecomment-416030795">comment</link>. + You will need to also allow UPnP connections in firewall, see the following [comment](https://github.com/NixOS/nixpkgs/pull/45045#issuecomment-416030795). ''; type = types.bool; }; diff --git a/nixos/modules/services/desktops/gnome/sushi.nix b/nixos/modules/services/desktops/gnome/sushi.nix index 3133a3a0d9854..446851f434d8a 100644 --- a/nixos/modules/services/desktops/gnome/sushi.nix +++ b/nixos/modules/services/desktops/gnome/sushi.nix @@ -27,7 +27,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable Sushi, a quick previewer for nautilus. ''; }; diff --git a/nixos/modules/services/desktops/gnome/tracker-miners.nix b/nixos/modules/services/desktops/gnome/tracker-miners.nix index 9351007d30b5d..a3c58f3742082 100644 --- a/nixos/modules/services/desktops/gnome/tracker-miners.nix +++ b/nixos/modules/services/desktops/gnome/tracker-miners.nix @@ -27,7 +27,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable Tracker miners, indexing services for Tracker search engine and metadata storage system. ''; diff --git a/nixos/modules/services/desktops/gnome/tracker.nix b/nixos/modules/services/desktops/gnome/tracker.nix index fef399d0112e4..485632712f68d 100644 --- a/nixos/modules/services/desktops/gnome/tracker.nix +++ b/nixos/modules/services/desktops/gnome/tracker.nix @@ -30,7 +30,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable Tracker services, a search engine, search tool and metadata storage system. ''; diff --git a/nixos/modules/services/desktops/gsignond.nix b/nixos/modules/services/desktops/gsignond.nix index 465acd73fa64d..cf80fd75452bf 100644 --- a/nixos/modules/services/desktops/gsignond.nix +++ b/nixos/modules/services/desktops/gsignond.nix @@ -20,7 +20,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable gSignOn daemon, a DBus service which performs user authentication on behalf of its clients. ''; @@ -29,7 +29,7 @@ in plugins = mkOption { type = types.listOf types.package; default = []; - description = '' + description = lib.mdDoc '' What plugins to use with the gSignOn daemon. ''; }; diff --git a/nixos/modules/services/desktops/gvfs.nix b/nixos/modules/services/desktops/gvfs.nix index 1aa64ea37db5e..4aa6412aaa5f0 100644 --- a/nixos/modules/services/desktops/gvfs.nix +++ b/nixos/modules/services/desktops/gvfs.nix @@ -36,7 +36,7 @@ in type = types.package; default = pkgs.gnome.gvfs; defaultText = literalExpression "pkgs.gnome.gvfs"; - description = "Which GVfs package to use."; + description = lib.mdDoc "Which GVfs package to use."; }; }; diff --git a/nixos/modules/services/desktops/pipewire/pipewire.nix b/nixos/modules/services/desktops/pipewire/pipewire.nix index dd1f5e3a018db..ed64406ab6a80 100644 --- a/nixos/modules/services/desktops/pipewire/pipewire.nix +++ b/nixos/modules/services/desktops/pipewire/pipewire.nix @@ -56,7 +56,7 @@ in { type = types.package; default = pkgs.pipewire; defaultText = literalExpression "pkgs.pipewire"; - description = '' + description = lib.mdDoc '' The pipewire derivation to use. ''; }; @@ -64,7 +64,7 @@ in { socketActivation = mkOption { default = true; type = types.bool; - description = '' + description = lib.mdDoc '' Automatically run pipewire when connections are made to the pipewire socket. ''; }; @@ -73,7 +73,7 @@ in { client = mkOption { type = json.type; default = {}; - description = '' + description = lib.mdDoc '' Configuration for pipewire clients. For details see https://gitlab.freedesktop.org/pipewire/pipewire/-/blob/${cfg.package.version}/src/daemon/client.conf.in ''; @@ -82,7 +82,7 @@ in { client-rt = mkOption { type = json.type; default = {}; - description = '' + description = lib.mdDoc '' Configuration for realtime pipewire clients. For details see https://gitlab.freedesktop.org/pipewire/pipewire/-/blob/${cfg.package.version}/src/daemon/client-rt.conf.in ''; @@ -91,7 +91,7 @@ in { jack = mkOption { type = json.type; default = {}; - description = '' + description = lib.mdDoc '' Configuration for the pipewire daemon's jack module. For details see https://gitlab.freedesktop.org/pipewire/pipewire/-/blob/${cfg.package.version}/src/daemon/jack.conf.in ''; @@ -100,7 +100,7 @@ in { pipewire = mkOption { type = json.type; default = {}; - description = '' + description = lib.mdDoc '' Configuration for the pipewire daemon. For details see https://gitlab.freedesktop.org/pipewire/pipewire/-/blob/${cfg.package.version}/src/daemon/pipewire.conf.in ''; @@ -109,7 +109,7 @@ in { pipewire-pulse = mkOption { type = json.type; default = {}; - description = '' + description = lib.mdDoc '' Configuration for the pipewire-pulse daemon. For details see https://gitlab.freedesktop.org/pipewire/pipewire/-/blob/${cfg.package.version}/src/daemon/pipewire-pulse.conf.in ''; @@ -122,7 +122,7 @@ in { # this is for backwards compatibility default = cfg.alsa.enable || cfg.jack.enable || cfg.pulse.enable; defaultText = lib.literalExpression "config.services.pipewire.alsa.enable || config.services.pipewire.jack.enable || config.services.pipewire.pulse.enable"; - description = "Whether to use PipeWire as the primary sound server"; + description = lib.mdDoc "Whether to use PipeWire as the primary sound server"; }; }; @@ -142,7 +142,7 @@ in { systemWide = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' If true, a system-wide PipeWire service and socket is enabled allowing all users in the "pipewire" group to use it simultaneously. If false, then user units are used instead, restricting access to diff --git a/nixos/modules/services/desktops/pipewire/wireplumber.nix b/nixos/modules/services/desktops/pipewire/wireplumber.nix index 004392c7873c4..32490773b5e9e 100644 --- a/nixos/modules/services/desktops/pipewire/wireplumber.nix +++ b/nixos/modules/services/desktops/pipewire/wireplumber.nix @@ -14,14 +14,14 @@ in type = lib.types.bool; default = config.services.pipewire.enable; defaultText = lib.literalExpression "config.services.pipewire.enable"; - description = "Whether to enable Wireplumber, a modular session / policy manager for PipeWire"; + description = lib.mdDoc "Whether to enable Wireplumber, a modular session / policy manager for PipeWire"; }; package = lib.mkOption { type = lib.types.package; default = pkgs.wireplumber; defaultText = lib.literalExpression "pkgs.wireplumber"; - description = "The wireplumber derivation to use."; + description = lib.mdDoc "The wireplumber derivation to use."; }; }; }; diff --git a/nixos/modules/services/desktops/profile-sync-daemon.nix b/nixos/modules/services/desktops/profile-sync-daemon.nix index 6206295272fc5..e307c67350044 100644 --- a/nixos/modules/services/desktops/profile-sync-daemon.nix +++ b/nixos/modules/services/desktops/profile-sync-daemon.nix @@ -9,7 +9,7 @@ in { enable = mkOption { type = bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the Profile Sync daemon. ''; }; @@ -17,7 +17,7 @@ in { type = str; default = "1h"; example = "1h 30min"; - description = '' + description = lib.mdDoc '' The amount of time to wait before syncing browser profiles back to the disk. diff --git a/nixos/modules/services/desktops/telepathy.nix b/nixos/modules/services/desktops/telepathy.nix index b5f6a5fcbcfdd..cdc6eb26de7ef 100644 --- a/nixos/modules/services/desktops/telepathy.nix +++ b/nixos/modules/services/desktops/telepathy.nix @@ -19,7 +19,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable Telepathy service, a communications framework that enables real-time communication via pluggable protocol backends. ''; diff --git a/nixos/modules/services/development/blackfire.nix b/nixos/modules/services/development/blackfire.nix index 8564aabc6a37d..6b71e59d4bd55 100644 --- a/nixos/modules/services/development/blackfire.nix +++ b/nixos/modules/services/development/blackfire.nix @@ -18,7 +18,7 @@ in { services.blackfire-agent = { enable = lib.mkEnableOption "Blackfire profiler agent"; settings = lib.mkOption { - description = '' + description = lib.mdDoc '' See https://blackfire.io/docs/up-and-running/configuration/agent ''; type = lib.types.submodule { @@ -27,7 +27,7 @@ in { options = { server-id = lib.mkOption { type = lib.types.str; - description = '' + description = lib.mdDoc '' Sets the server id used to authenticate with Blackfire You can find your personal server-id at https://blackfire.io/my/settings/credentials @@ -36,7 +36,7 @@ in { server-token = lib.mkOption { type = lib.types.str; - description = '' + description = lib.mdDoc '' Sets the server token used to authenticate with Blackfire You can find your personal server-token at https://blackfire.io/my/settings/credentials diff --git a/nixos/modules/services/development/bloop.nix b/nixos/modules/services/development/bloop.nix index c1180a8bbdd46..27da76a744320 100644 --- a/nixos/modules/services/development/bloop.nix +++ b/nixos/modules/services/development/bloop.nix @@ -17,7 +17,7 @@ in { "-J-XX:MaxInlineLevel=20" "-J-XX:+UseParallelGC" ]; - description = '' + description = lib.mdDoc '' Specifies additional command line argument to pass to bloop java process. ''; @@ -26,7 +26,7 @@ in { install = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to install a user service for the Bloop server. The service must be manually started for each user with diff --git a/nixos/modules/services/development/distccd.nix b/nixos/modules/services/development/distccd.nix index 9f6d5c813c458..7a8e780c3eb63 100644 --- a/nixos/modules/services/development/distccd.nix +++ b/nixos/modules/services/development/distccd.nix @@ -14,7 +14,7 @@ in type = types.listOf types.str; default = [ "127.0.0.1" ]; example = [ "127.0.0.1" "192.168.0.0/24" "10.0.0.0/24" ]; - description = '' + description = lib.mdDoc '' Client IPs which are allowed to connect to distccd in CIDR notation. Anyone who can connect to the distccd server can run arbitrary @@ -26,7 +26,7 @@ in jobTimeout = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Maximum duration, in seconds, of a single compilation request. ''; }; @@ -34,7 +34,7 @@ in logLevel = mkOption { type = types.nullOr (types.enum [ "critical" "error" "warning" "notice" "info" "debug" ]); default = "warning"; - description = '' + description = lib.mdDoc '' Set the minimum severity of error that will be included in the log file. Useful if you only want to see error messages rather than an entry for each connection. @@ -44,7 +44,7 @@ in maxJobs = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Maximum number of tasks distccd should execute at any time. ''; }; @@ -53,7 +53,7 @@ in nice = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Niceness of the compilation tasks. ''; }; @@ -61,7 +61,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Opens the specified TCP port for distcc. ''; }; @@ -70,7 +70,7 @@ in type = types.package; default = pkgs.distcc; defaultText = literalExpression "pkgs.distcc"; - description = '' + description = lib.mdDoc '' The distcc package to use. ''; }; @@ -78,7 +78,7 @@ in port = mkOption { type = types.port; default = 3632; - description = '' + description = lib.mdDoc '' The TCP port which distccd will listen on. ''; }; @@ -88,7 +88,7 @@ in port = mkOption { type = types.port; default = 3633; - description = '' + description = lib.mdDoc '' The TCP port which the distccd statistics HTTP server will listen on. ''; @@ -98,7 +98,7 @@ in zeroconf = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to register via mDNS/DNS-SD ''; }; diff --git a/nixos/modules/services/development/hoogle.nix b/nixos/modules/services/development/hoogle.nix index 7c2a1c8e16247..399ffccabfc6d 100644 --- a/nixos/modules/services/development/hoogle.nix +++ b/nixos/modules/services/development/hoogle.nix @@ -19,7 +19,7 @@ in { port = mkOption { type = types.port; default = 8080; - description = '' + description = lib.mdDoc '' Port number Hoogle will be listening to. ''; }; @@ -39,7 +39,7 @@ in { }; haskellPackages = mkOption { - description = "Which haskell package set to use."; + description = lib.mdDoc "Which haskell package set to use."; type = types.attrs; default = pkgs.haskellPackages; defaultText = literalExpression "pkgs.haskellPackages"; @@ -47,13 +47,13 @@ in { home = mkOption { type = types.str; - description = "Url for hoogle logo"; + description = lib.mdDoc "Url for hoogle logo"; default = "https://hoogle.haskell.org"; }; host = mkOption { type = types.str; - description = "Set the host to bind on."; + description = lib.mdDoc "Set the host to bind on."; default = "127.0.0.1"; }; }; diff --git a/nixos/modules/services/development/lorri.nix b/nixos/modules/services/development/lorri.nix index bda63518bfd95..a82b3f57f8e8e 100644 --- a/nixos/modules/services/development/lorri.nix +++ b/nixos/modules/services/development/lorri.nix @@ -18,7 +18,7 @@ in { package = lib.mkOption { default = pkgs.lorri; type = lib.types.package; - description = '' + description = lib.mdDoc '' The lorri package to use. ''; defaultText = lib.literalExpression "pkgs.lorri"; diff --git a/nixos/modules/services/development/rstudio-server/default.nix b/nixos/modules/services/development/rstudio-server/default.nix index cd903c7e55bfc..74a7cd2f4e57b 100644 --- a/nixos/modules/services/development/rstudio-server/default.nix +++ b/nixos/modules/services/development/rstudio-server/default.nix @@ -26,7 +26,7 @@ in serverWorkingDir = mkOption { type = types.str; default = "/var/lib/rstudio-server"; - description = '' + description = lib.mdDoc '' Default working directory for server (server-working-dir in rserver.conf). ''; }; @@ -34,7 +34,7 @@ in listenAddr = mkOption { type = types.str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' Address to listen on (www-address in rserver.conf). ''; }; @@ -44,7 +44,7 @@ in default = pkgs.rstudio-server; defaultText = literalExpression "pkgs.rstudio-server"; example = literalExpression "pkgs.rstudioServerWrapper.override { packages = [ pkgs.rPackages.ggplot2 ]; }"; - description = '' + description = lib.mdDoc '' Rstudio server package to use. Can be set to rstudioServerWrapper to provide packages. ''; }; @@ -52,7 +52,7 @@ in rserverExtraConfig = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Extra contents for rserver.conf. ''; }; @@ -60,7 +60,7 @@ in rsessionExtraConfig = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Extra contents for resssion.conf. ''; }; diff --git a/nixos/modules/services/development/zammad.nix b/nixos/modules/services/development/zammad.nix index d457a60718730..503f54aee2c70 100644 --- a/nixos/modules/services/development/zammad.nix +++ b/nixos/modules/services/development/zammad.nix @@ -34,13 +34,13 @@ in type = types.package; default = pkgs.zammad; defaultText = literalExpression "pkgs.zammad"; - description = "Zammad package to use."; + description = lib.mdDoc "Zammad package to use."; }; dataDir = mkOption { type = types.path; default = "/var/lib/zammad"; - description = '' + description = lib.mdDoc '' Path to a folder that will contain Zammad working directory. ''; }; @@ -49,25 +49,25 @@ in type = types.str; default = "127.0.0.1"; example = "192.168.23.42"; - description = "Host address."; + description = lib.mdDoc "Host address."; }; openPorts = mkOption { type = types.bool; default = false; - description = "Whether to open firewall ports for Zammad"; + description = lib.mdDoc "Whether to open firewall ports for Zammad"; }; port = mkOption { type = types.port; default = 3000; - description = "Web service port."; + description = lib.mdDoc "Web service port."; }; websocketPort = mkOption { type = types.port; default = 6042; - description = "Websocket service port."; + description = lib.mdDoc "Websocket service port."; }; database = { @@ -75,7 +75,7 @@ in type = types.enum [ "PostgreSQL" "MySQL" ]; default = "PostgreSQL"; example = "MySQL"; - description = "Database engine to use."; + description = lib.mdDoc "Database engine to use."; }; host = mkOption { @@ -90,7 +90,7 @@ in MySQL = "localhost"; }.''${config.services.zammad.database.type}; ''; - description = '' + description = lib.mdDoc '' Database host address. ''; }; @@ -98,13 +98,13 @@ in port = mkOption { type = types.nullOr types.port; default = null; - description = "Database port. Use <literal>null</literal> for default port."; + description = lib.mdDoc "Database port. Use `null` for default port."; }; name = mkOption { type = types.str; default = "zammad"; - description = '' + description = lib.mdDoc '' Database name. ''; }; @@ -112,22 +112,22 @@ in user = mkOption { type = types.nullOr types.str; default = "zammad"; - description = "Database user."; + description = lib.mdDoc "Database user."; }; passwordFile = mkOption { type = types.nullOr types.path; default = null; example = "/run/keys/zammad-dbpassword"; - description = '' - A file containing the password for <option>services.zammad.database.user</option>. + description = lib.mdDoc '' + A file containing the password for {option}`services.zammad.database.user`. ''; }; createLocally = mkOption { type = types.bool; default = true; - description = "Whether to create a local database automatically."; + description = lib.mdDoc "Whether to create a local database automatically."; }; settings = mkOption { diff --git a/nixos/modules/services/display-managers/greetd.nix b/nixos/modules/services/display-managers/greetd.nix index 4fc6ca3674915..a81fcbf19d176 100644 --- a/nixos/modules/services/display-managers/greetd.nix +++ b/nixos/modules/services/display-managers/greetd.nix @@ -14,7 +14,7 @@ in type = types.package; default = pkgs.greetd.greetd; defaultText = literalExpression "pkgs.greetd.greetd"; - description = "The greetd package that should be used."; + description = lib.mdDoc "The greetd package that should be used."; }; settings = mkOption { @@ -26,8 +26,8 @@ in }; } ''; - description = '' - greetd configuration (<link xlink:href="https://man.sr.ht/~kennylevinsen/greetd/">documentation</link>) + description = lib.mdDoc '' + greetd configuration ([documentation](https://man.sr.ht/~kennylevinsen/greetd/)) as a Nix attribute set. ''; }; @@ -35,7 +35,7 @@ in vt = mkOption { type = types.int; default = 1; - description = '' + description = lib.mdDoc '' The virtual console (tty) that greetd should use. This option also disables getty on that tty. ''; }; @@ -44,7 +44,7 @@ in type = types.bool; default = !(cfg.settings ? initial_session); defaultText = literalExpression "!(config.services.greetd.settings ? initial_session)"; - description = '' + description = lib.mdDoc '' Wether to restart greetd when it terminates (e.g. on failure). This is usually desirable so a user can always log in, but should be disabled when using 'settings.initial_session' (autologin), because every greetd restart will trigger the autologin again. diff --git a/nixos/modules/services/editors/emacs.nix b/nixos/modules/services/editors/emacs.nix index e2bbd27f6e560..0d9949d2ba5de 100644 --- a/nixos/modules/services/editors/emacs.nix +++ b/nixos/modules/services/editors/emacs.nix @@ -67,7 +67,7 @@ in type = types.package; default = pkgs.emacs; defaultText = literalExpression "pkgs.emacs"; - description = '' + description = lib.mdDoc '' emacs derivation to use. ''; }; @@ -75,7 +75,7 @@ in defaultEditor = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' When enabled, configures emacsclient to be the default editor using the EDITOR environment variable. ''; diff --git a/nixos/modules/services/editors/haste.nix b/nixos/modules/services/editors/haste.nix index 35fe26766ef7d..2208dccbc03ad 100644 --- a/nixos/modules/services/editors/haste.nix +++ b/nixos/modules/services/editors/haste.nix @@ -14,9 +14,9 @@ in openFirewall = mkEnableOption "firewall passthrough for haste-server"; settings = mkOption { - description = '' + description = lib.mdDoc '' Configuration for haste-server. - For documentation see <link xlink:href="https://github.com/toptal/haste-server#settings">project readme</link> + For documentation see [project readme](https://github.com/toptal/haste-server#settings) ''; type = format.type; }; diff --git a/nixos/modules/services/editors/infinoted.nix b/nixos/modules/services/editors/infinoted.nix index 16fe52a232bd4..d2eb4946f2fbf 100644 --- a/nixos/modules/services/editors/infinoted.nix +++ b/nixos/modules/services/editors/infinoted.nix @@ -12,7 +12,7 @@ in { type = types.package; default = pkgs.libinfinity; defaultText = literalExpression "pkgs.libinfinity"; - description = '' + description = lib.mdDoc '' Package providing infinoted ''; }; @@ -20,7 +20,7 @@ in { keyFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Private key to use for TLS ''; }; @@ -28,7 +28,7 @@ in { certificateFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Server certificate to use for TLS ''; }; @@ -45,7 +45,7 @@ in { securityPolicy = mkOption { type = types.enum ["no-tls" "allow-tls" "require-tls"]; default = "require-tls"; - description = '' + description = lib.mdDoc '' How strictly to enforce clients connection with TLS. ''; }; @@ -53,7 +53,7 @@ in { port = mkOption { type = types.port; default = 6523; - description = '' + description = lib.mdDoc '' Port to listen on ''; }; @@ -61,7 +61,7 @@ in { rootDirectory = mkOption { type = types.path; default = "/var/lib/infinoted/documents/"; - description = '' + description = lib.mdDoc '' Root of the directory structure to serve ''; }; @@ -69,7 +69,7 @@ in { plugins = mkOption { type = types.listOf types.str; default = [ "note-text" "note-chat" "logging" "autosave" ]; - description = '' + description = lib.mdDoc '' Plugins to enable ''; }; @@ -77,7 +77,7 @@ in { passwordFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' File to read server-wide password from ''; }; @@ -88,7 +88,7 @@ in { [autosave] interval=10 ''; - description = '' + description = lib.mdDoc '' Additional configuration to append to infinoted.conf ''; }; @@ -96,7 +96,7 @@ in { user = mkOption { type = types.str; default = "infinoted"; - description = '' + description = lib.mdDoc '' What to call the dedicated user under which infinoted is run ''; }; @@ -104,7 +104,7 @@ in { group = mkOption { type = types.str; default = "infinoted"; - description = '' + description = lib.mdDoc '' What to call the primary group of the dedicated user under which infinoted is run ''; }; diff --git a/nixos/modules/services/finance/odoo.nix b/nixos/modules/services/finance/odoo.nix index 422ee95100742..78c54a9e056b5 100644 --- a/nixos/modules/services/finance/odoo.nix +++ b/nixos/modules/services/finance/odoo.nix @@ -15,27 +15,27 @@ in type = types.package; default = pkgs.odoo; defaultText = literalExpression "pkgs.odoo"; - description = "Odoo package to use."; + description = lib.mdDoc "Odoo package to use."; }; addons = mkOption { type = with types; listOf package; default = []; example = literalExpression "[ pkgs.odoo_enterprise ]"; - description = "Odoo addons."; + description = lib.mdDoc "Odoo addons."; }; settings = mkOption { type = format.type; default = {}; - description = '' - Odoo configuration settings. For more details see <link xlink:href="https://www.odoo.com/documentation/15.0/administration/install/deploy.html"/> + description = lib.mdDoc '' + Odoo configuration settings. For more details see <https://www.odoo.com/documentation/15.0/administration/install/deploy.html> ''; }; domain = mkOption { type = with types; nullOr str; - description = "Domain to host Odoo with nginx"; + description = lib.mdDoc "Domain to host Odoo with nginx"; default = null; }; }; diff --git a/nixos/modules/services/games/asf.nix b/nixos/modules/services/games/asf.nix index ed1a5544d7a48..37247e195a78c 100644 --- a/nixos/modules/services/games/asf.nix +++ b/nixos/modules/services/games/asf.nix @@ -32,7 +32,7 @@ in options.services.archisteamfarm = { enable = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' If enabled, starts the ArchisSteamFarm service. For configuring the SteamGuard token you will need to use the web-ui, which is enabled by default over on 127.0.0.1:1242. You cannot configure ASF in any way outside of nix, since all the config files get wiped on restart and replaced with the programatically set ones by nix. @@ -50,7 +50,7 @@ in type = types.package; default = pkgs.ArchiSteamFarm.ui; description = - "Web-UI package to use. Contents must be in lib/dist."; + lib.mdDoc "Web-UI package to use. Contents must be in lib/dist."; }; }; }; @@ -61,20 +61,20 @@ in example = { enable = false; }; - description = "The Web-UI hosted on 127.0.0.1:1242."; + description = lib.mdDoc "The Web-UI hosted on 127.0.0.1:1242."; }; package = mkOption { type = types.package; default = pkgs.ArchiSteamFarm; description = - "Package to use. Should always be the latest version, for security reasons, since this module uses very new features and to not get out of sync with the Steam API."; + lib.mdDoc "Package to use. Should always be the latest version, for security reasons, since this module uses very new features and to not get out of sync with the Steam API."; }; dataDir = mkOption { type = types.path; default = "/var/lib/asf"; - description = '' + description = lib.mdDoc '' The ASF home directory used to store all data. If left as the default value this directory will automatically be created before the ASF server starts, otherwise the sysadmin is responsible for ensuring the directory exists with appropriate ownership and permissions.''; }; @@ -96,14 +96,14 @@ in ipcPasswordFile = mkOption { type = types.nullOr types.path; default = null; - description = "Path to a file containig the password. The file must be readable by the <literal>asf</literal> user/group."; + description = lib.mdDoc "Path to a file containig the password. The file must be readable by the `asf` user/group."; }; ipcSettings = mkOption { type = format.type; - description = '' + description = lib.mdDoc '' Settings to write to IPC.config. - All options can be found <link xlink:href="https://github.com/JustArchiNET/ArchiSteamFarm/wiki/IPC#custom-configuration">here</link>. + All options can be found [here](https://github.com/JustArchiNET/ArchiSteamFarm/wiki/IPC#custom-configuration). ''; example = { Kestrel = { @@ -122,17 +122,17 @@ in options = { username = mkOption { type = types.str; - description = "Name of the user to log in. Default is attribute name."; + description = lib.mdDoc "Name of the user to log in. Default is attribute name."; default = ""; }; passwordFile = mkOption { type = types.path; - description = "Path to a file containig the password. The file must be readable by the <literal>asf</literal> user/group."; + description = lib.mdDoc "Path to a file containig the password. The file must be readable by the `asf` user/group."; }; enabled = mkOption { type = types.bool; default = true; - description = "Whether to enable the bot on startup."; + description = lib.mdDoc "Whether to enable the bot on startup."; }; settings = mkOption { type = types.attrs; @@ -141,7 +141,7 @@ in }; }; }); - description = '' + description = lib.mdDoc '' Bots name and configuration. ''; example = { diff --git a/nixos/modules/services/games/crossfire-server.nix b/nixos/modules/services/games/crossfire-server.nix index a33025e0c3e13..4b9813245fb76 100644 --- a/nixos/modules/services/games/crossfire-server.nix +++ b/nixos/modules/services/games/crossfire-server.nix @@ -10,7 +10,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If enabled, the Crossfire game server will be started at boot. ''; }; @@ -19,7 +19,7 @@ in { type = types.package; default = pkgs.crossfire-server; defaultText = literalExpression "pkgs.crossfire-server"; - description = '' + description = lib.mdDoc '' The package to use for the Crossfire server (and map/arch data, if you don't change dataDir). ''; @@ -29,7 +29,7 @@ in { type = types.str; default = "${cfg.package}/share/crossfire"; defaultText = literalExpression ''"''${config.services.crossfire.package}/share/crossfire"''; - description = '' + description = lib.mdDoc '' Where to load readonly data from -- maps, archetypes, treasure tables, and the like. If you plan to edit the data on the live server (rather than overlaying the crossfire-maps and crossfire-arch packages and @@ -54,7 +54,7 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to open ports in the firewall for the server. ''; }; diff --git a/nixos/modules/services/games/deliantra-server.nix b/nixos/modules/services/games/deliantra-server.nix index b7011f4c35428..1a0618601240e 100644 --- a/nixos/modules/services/games/deliantra-server.nix +++ b/nixos/modules/services/games/deliantra-server.nix @@ -10,7 +10,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If enabled, the Deliantra game server will be started at boot. ''; }; @@ -19,7 +19,7 @@ in { type = types.package; default = pkgs.deliantra-server; defaultText = literalExpression "pkgs.deliantra-server"; - description = '' + description = lib.mdDoc '' The package to use for the Deliantra server (and map/arch data, if you don't change dataDir). ''; @@ -29,7 +29,7 @@ in { type = types.str; default = "${pkgs.deliantra-data}"; defaultText = literalExpression ''"''${pkgs.deliantra-data}"''; - description = '' + description = lib.mdDoc '' Where to store readonly data (maps, archetypes, sprites, etc). Note that if you plan to use the live map editor (rather than editing the maps offline and then nixos-rebuilding), THIS MUST BE WRITEABLE -- @@ -54,14 +54,14 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to open ports in the firewall for the server. ''; }; configFiles = mkOption { type = types.attrsOf types.str; - description = '' + description = lib.mdDoc '' Contents of the server configuration files. These will be appended to the example configurations the server comes with and overwrite any default settings defined therein. diff --git a/nixos/modules/services/games/factorio.nix b/nixos/modules/services/games/factorio.nix index bb6898a08c52b..893afa97722e4 100644 --- a/nixos/modules/services/games/factorio.nix +++ b/nixos/modules/services/games/factorio.nix @@ -48,7 +48,7 @@ in port = mkOption { type = types.int; default = 34197; - description = '' + description = lib.mdDoc '' The port to which the service should bind. ''; }; @@ -56,7 +56,7 @@ in bind = mkOption { type = types.str; default = "0.0.0.0"; - description = '' + description = lib.mdDoc '' The address to which the service should bind. ''; }; @@ -65,7 +65,7 @@ in type = types.listOf types.str; default = []; example = [ "username" ]; - description = '' + description = lib.mdDoc '' List of player names which will be admin. ''; }; @@ -73,14 +73,14 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to automatically open the specified UDP port in the firewall. ''; }; saveName = mkOption { type = types.str; default = "default"; - description = '' + description = lib.mdDoc '' The name of the savegame that will be used by the server. When not present in /var/lib/''${config.services.factorio.stateDirName}/saves, @@ -90,7 +90,7 @@ in loadLatestSave = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Load the latest savegame on startup. This overrides saveName, in that the latest save will always be used even if a saved game of the given name exists. It still controls the 'canonical' name of the savegame. @@ -107,7 +107,7 @@ in type = types.path; default = configFile; defaultText = literalExpression "configFile"; - description = '' + description = lib.mdDoc '' The server's configuration file. The default file generated by this module contains lines essential to @@ -118,7 +118,7 @@ in stateDirName = mkOption { type = types.str; default = "factorio"; - description = '' + description = lib.mdDoc '' Name of the directory under /var/lib holding the server's data. The configuration and map will be stored here. @@ -127,7 +127,7 @@ in mods = mkOption { type = types.listOf types.package; default = []; - description = '' + description = lib.mdDoc '' Mods the server should install and activate. The derivations in this list must "build" the mod by simply copying @@ -139,14 +139,14 @@ in game-name = mkOption { type = types.nullOr types.str; default = "Factorio Game"; - description = '' + description = lib.mdDoc '' Name of the game as it will appear in the game listing. ''; }; description = mkOption { type = types.nullOr types.str; default = ""; - description = '' + description = lib.mdDoc '' Description of the game that will appear in the listing. ''; }; @@ -154,28 +154,28 @@ in type = types.attrs; default = {}; example = { admins = [ "username" ];}; - description = '' + description = lib.mdDoc '' Extra game configuration that will go into server-settings.json ''; }; public = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Game will be published on the official Factorio matching server. ''; }; lan = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Game will be broadcast on LAN. ''; }; username = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Your factorio.com login credentials. Required for games with visibility public. ''; }; @@ -184,35 +184,35 @@ in default = pkgs.factorio-headless; defaultText = literalExpression "pkgs.factorio-headless"; example = literalExpression "pkgs.factorio-headless-experimental"; - description = '' + description = lib.mdDoc '' Factorio version to use. This defaults to the stable channel. ''; }; password = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Your factorio.com login credentials. Required for games with visibility public. ''; }; token = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Authentication token. May be used instead of 'password' above. ''; }; game-password = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Game password. ''; }; requireUserVerification = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' When set to true, the server will only allow clients that have a valid factorio.com account. ''; }; @@ -220,14 +220,14 @@ in type = types.nullOr types.int; default = null; example = 10; - description = '' + description = lib.mdDoc '' Autosave interval in minutes. ''; }; nonBlockingSaving = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Highly experimental feature, enable only at your own risk of losing your saves. On UNIX systems, server will fork itself to create an autosave. Autosaving on connected Windows clients will be disabled regardless of autosave_only_on_server option. diff --git a/nixos/modules/services/games/freeciv.nix b/nixos/modules/services/games/freeciv.nix index 4923891a61799..02af9fda7afdf 100644 --- a/nixos/modules/services/games/freeciv.nix +++ b/nixos/modules/services/games/freeciv.nix @@ -27,7 +27,7 @@ in services.freeciv = { enable = mkEnableOption ''freeciv''; settings = mkOption { - description = '' + description = lib.mdDoc '' Parameters of freeciv-server. ''; default = {}; @@ -36,7 +36,7 @@ in options.Announce = mkOption { type = types.enum ["IPv4" "IPv6" "none"]; default = "none"; - description = "Announce game in LAN using given protocol."; + description = lib.mdDoc "Announce game in LAN using given protocol."; }; options.auth = mkEnableOption "server authentication"; options.Database = mkOption { @@ -47,12 +47,12 @@ in backend="sqlite" database="/var/lib/freeciv/auth.sqlite" ''; - description = "Enable database connection with given configuration."; + description = lib.mdDoc "Enable database connection with given configuration."; }; options.debug = mkOption { type = types.ints.between 0 3; default = 0; - description = "Set debug log level."; + description = lib.mdDoc "Set debug log level."; }; options.exit-on-end = mkEnableOption "exit instead of restarting when a game ends."; options.Guests = mkEnableOption "guests to login if auth is enabled"; @@ -60,12 +60,12 @@ in options.port = mkOption { type = types.port; default = 5556; - description = "Listen for clients on given port"; + description = lib.mdDoc "Listen for clients on given port"; }; options.quitidle = mkOption { type = types.nullOr types.int; default = null; - description = "Quit if no players for given time in seconds."; + description = lib.mdDoc "Quit if no players for given time in seconds."; }; options.read = mkOption { type = types.lines; @@ -73,12 +73,12 @@ in default = '' /fcdb lua sqlite_createdb() ''; - description = "Startup script."; + description = lib.mdDoc "Startup script."; }; options.saves = mkOption { type = types.nullOr types.str; default = "/var/lib/freeciv/saves/"; - description = '' + description = lib.mdDoc '' Save games to given directory, a sub-directory named after the starting date of the service will me inserted to preserve older saves. diff --git a/nixos/modules/services/games/minecraft-server.nix b/nixos/modules/services/games/minecraft-server.nix index 309fe43eaf4c4..77f92ab97db74 100644 --- a/nixos/modules/services/games/minecraft-server.nix +++ b/nixos/modules/services/games/minecraft-server.nix @@ -54,21 +54,21 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If enabled, start a Minecraft Server. The server data will be loaded from and saved to - <option>services.minecraft-server.dataDir</option>. + {option}`services.minecraft-server.dataDir`. ''; }; declarative = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to use a declarative Minecraft server configuration. - Only if set to <literal>true</literal>, the options - <option>services.minecraft-server.whitelist</option> and - <option>services.minecraft-server.serverProperties</option> will be + Only if set to `true`, the options + {option}`services.minecraft-server.whitelist` and + {option}`services.minecraft-server.serverProperties` will be applied. ''; }; @@ -76,18 +76,18 @@ in { eula = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether you agree to - <link xlink:href="https://account.mojang.com/documents/minecraft_eula"> - Mojangs EULA</link>. This option must be set to - <literal>true</literal> to run Minecraft server. + [ + Mojangs EULA](https://account.mojang.com/documents/minecraft_eula). This option must be set to + `true` to run Minecraft server. ''; }; dataDir = mkOption { type = types.path; default = "/var/lib/minecraft"; - description = '' + description = lib.mdDoc '' Directory to store Minecraft database and other state/data files. ''; }; @@ -95,7 +95,7 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to open ports in the firewall for the server. ''; }; @@ -108,14 +108,14 @@ in { }; in types.attrsOf minecraftUUID; default = {}; - description = '' + description = lib.mdDoc '' Whitelisted players, only has an effect when - <option>services.minecraft-server.declarative</option> is - <literal>true</literal> and the whitelist is enabled - via <option>services.minecraft-server.serverProperties</option> by - setting <literal>white-list</literal> to <literal>true</literal>. + {option}`services.minecraft-server.declarative` is + `true` and the whitelist is enabled + via {option}`services.minecraft-server.serverProperties` by + setting `white-list` to `true`. This is a mapping from Minecraft usernames to UUIDs. - You can use <link xlink:href="https://mcuuid.net/"/> to get a + You can use <https://mcuuid.net/> to get a Minecraft UUID for a username. ''; example = literalExpression '' @@ -141,11 +141,11 @@ in { "rcon.password" = "hunter2"; } ''; - description = '' + description = lib.mdDoc '' Minecraft server properties for the server.properties file. Only has - an effect when <option>services.minecraft-server.declarative</option> - is set to <literal>true</literal>. See - <link xlink:href="https://minecraft.gamepedia.com/Server.properties#Java_Edition_3"/> + an effect when {option}`services.minecraft-server.declarative` + is set to `true`. See + <https://minecraft.gamepedia.com/Server.properties#Java_Edition_3> for documentation on these values. ''; }; @@ -155,7 +155,7 @@ in { default = pkgs.minecraft-server; defaultText = literalExpression "pkgs.minecraft-server"; example = literalExpression "pkgs.minecraft-server_1_12_2"; - description = "Version of minecraft-server to run."; + description = lib.mdDoc "Version of minecraft-server to run."; }; jvmOpts = mkOption { @@ -165,7 +165,7 @@ in { example = "-Xms4092M -Xmx4092M -XX:+UseG1GC -XX:+CMSIncrementalPacing " + "-XX:+CMSClassUnloadingEnabled -XX:ParallelGCThreads=2 " + "-XX:MinHeapFreeRatio=5 -XX:MaxHeapFreeRatio=10"; - description = "JVM options for the Minecraft server."; + description = lib.mdDoc "JVM options for the Minecraft server."; }; }; }; diff --git a/nixos/modules/services/games/minetest-server.nix b/nixos/modules/services/games/minetest-server.nix index 2111c970d4f27..bc6ab7462d6bd 100644 --- a/nixos/modules/services/games/minetest-server.nix +++ b/nixos/modules/services/games/minetest-server.nix @@ -19,7 +19,7 @@ in enable = mkOption { type = types.bool; default = false; - description = "If enabled, starts a Minetest Server."; + description = lib.mdDoc "If enabled, starts a Minetest Server."; }; gameId = mkOption { @@ -58,7 +58,7 @@ in logPath = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Path to logfile for logging. If set to null, logging will be output to stdout which means @@ -69,7 +69,7 @@ in port = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Port number to bind to. If set to null, the default 30000 will be used. diff --git a/nixos/modules/services/games/openarena.nix b/nixos/modules/services/games/openarena.nix index 9c441e98b2068..e38bc8f205a12 100644 --- a/nixos/modules/services/games/openarena.nix +++ b/nixos/modules/services/games/openarena.nix @@ -13,13 +13,13 @@ in openPorts = mkOption { type = types.bool; default = false; - description = "Whether to open firewall ports for OpenArena"; + description = lib.mdDoc "Whether to open firewall ports for OpenArena"; }; extraFlags = mkOption { type = types.listOf types.str; default = []; - description = "Extra flags to pass to <command>oa_ded</command>"; + description = lib.mdDoc "Extra flags to pass to {command}`oa_ded`"; example = [ "+set dedicated 2" "+set sv_hostname 'My NixOS OpenArena Server'" diff --git a/nixos/modules/services/games/quake3-server.nix b/nixos/modules/services/games/quake3-server.nix index 175af4a838289..69fdbc50d87db 100644 --- a/nixos/modules/services/games/quake3-server.nix +++ b/nixos/modules/services/games/quake3-server.nix @@ -42,7 +42,7 @@ in { port = mkOption { type = types.port; default = 27960; - description = '' + description = lib.mdDoc '' UDP Port the server should listen on. ''; }; @@ -50,7 +50,7 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open the firewall. ''; }; @@ -62,7 +62,7 @@ in { seta rconPassword "superSecret" // sets RCON password for remote console seta sv_hostname "My Quake 3 server" // name that appears in server list ''; - description = '' + description = lib.mdDoc '' Extra configuration options. Note that options changed via RCON will not be persisted. To list all possible options, use "cvarlist 1" via RCON. ''; @@ -73,7 +73,7 @@ in { default = defaultBaseq3; defaultText = literalDocBook "Manually downloaded Quake 3 installation directory."; example = "/var/lib/q3ds"; - description = '' + description = lib.mdDoc '' Path to the baseq3 files (pak*.pk3). If this is on the nix store (type = package) all .pk3 files should be saved in the top-level directory. If this is on another filesystem (e.g /var/lib/baseq3) the .pk3 files are searched in $baseq3/.q3a/baseq3/ diff --git a/nixos/modules/services/games/teeworlds.nix b/nixos/modules/services/games/teeworlds.nix index babf989c98ca5..6ddd0bee60cd2 100644 --- a/nixos/modules/services/games/teeworlds.nix +++ b/nixos/modules/services/games/teeworlds.nix @@ -25,13 +25,13 @@ in openPorts = mkOption { type = types.bool; default = false; - description = "Whether to open firewall ports for Teeworlds"; + description = lib.mdDoc "Whether to open firewall ports for Teeworlds"; }; name = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Name of the server. Defaults to 'unnamed server'. ''; }; @@ -40,7 +40,7 @@ in type = types.bool; example = true; default = false; - description = '' + description = lib.mdDoc '' Whether the server registers as public server in the global server list. This is disabled by default because of privacy. ''; }; @@ -48,7 +48,7 @@ in motd = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Set the server message of the day text. ''; }; @@ -56,7 +56,7 @@ in password = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Password to connect to the server. ''; }; @@ -64,7 +64,7 @@ in rconPassword = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Password to access the remote console. If not set, a randomly generated one is displayed in the server log. ''; }; @@ -72,7 +72,7 @@ in port = mkOption { type = types.int; default = 8303; - description = '' + description = lib.mdDoc '' Port the server will listen on. ''; }; diff --git a/nixos/modules/services/games/terraria.nix b/nixos/modules/services/games/terraria.nix index 29f976b3c2aec..cd1bb7d819dca 100644 --- a/nixos/modules/services/games/terraria.nix +++ b/nixos/modules/services/games/terraria.nix @@ -36,16 +36,16 @@ in enable = mkOption { type = types.bool; default = false; - description = '' - If enabled, starts a Terraria server. The server can be connected to via <literal>tmux -S ''${config.${opt.dataDir}}/terraria.sock attach</literal> - for administration by users who are a part of the <literal>terraria</literal> group (use <literal>C-b d</literal> shortcut to detach again). + description = lib.mdDoc '' + If enabled, starts a Terraria server. The server can be connected to via `tmux -S ''${config.${opt.dataDir}}/terraria.sock attach` + for administration by users who are a part of the `terraria` group (use `C-b d` shortcut to detach again). ''; }; port = mkOption { type = types.port; default = 7777; - description = '' + description = lib.mdDoc '' Specifies the port to listen on. ''; }; @@ -53,7 +53,7 @@ in maxPlayers = mkOption { type = types.ints.u8; default = 255; - description = '' + description = lib.mdDoc '' Sets the max number of players (between 1 and 255). ''; }; @@ -61,15 +61,15 @@ in password = mkOption { type = types.nullOr types.str; default = null; - description = '' - Sets the server password. Leave <literal>null</literal> for no password. + description = lib.mdDoc '' + Sets the server password. Leave `null` for no password. ''; }; messageOfTheDay = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Set the server message of the day text. ''; }; @@ -77,18 +77,18 @@ in worldPath = mkOption { type = types.nullOr types.path; default = null; - description = '' - The path to the world file (<literal>.wld</literal>) which should be loaded. + description = lib.mdDoc '' + The path to the world file (`.wld`) which should be loaded. If no world exists at this path, one will be created with the size - specified by <literal>autoCreatedWorldSize</literal>. + specified by `autoCreatedWorldSize`. ''; }; autoCreatedWorldSize = mkOption { type = types.enum [ "small" "medium" "large" ]; default = "medium"; - description = '' - Specifies the size of the auto-created world if <literal>worldPath</literal> does not + description = lib.mdDoc '' + Specifies the size of the auto-created world if `worldPath` does not point to an existing world. ''; }; @@ -96,7 +96,7 @@ in banListPath = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' The path to the ban list. ''; }; @@ -104,26 +104,26 @@ in secure = mkOption { type = types.bool; default = false; - description = "Adds additional cheat protection to the server."; + description = lib.mdDoc "Adds additional cheat protection to the server."; }; noUPnP = mkOption { type = types.bool; default = false; - description = "Disables automatic Universal Plug and Play."; + description = lib.mdDoc "Disables automatic Universal Plug and Play."; }; openFirewall = mkOption { type = types.bool; default = false; - description = "Wheter to open ports in the firewall"; + description = lib.mdDoc "Wheter to open ports in the firewall"; }; dataDir = mkOption { type = types.str; default = "/var/lib/terraria"; example = "/srv/terraria"; - description = "Path to variable state data directory for terraria."; + description = lib.mdDoc "Path to variable state data directory for terraria."; }; }; }; diff --git a/nixos/modules/services/hardware/acpid.nix b/nixos/modules/services/hardware/acpid.nix index 883ef08300372..fef2c14b9dcec 100644 --- a/nixos/modules/services/hardware/acpid.nix +++ b/nixos/modules/services/hardware/acpid.nix @@ -53,7 +53,7 @@ in logEvents = mkOption { type = types.bool; default = false; - description = "Log all event activity."; + description = lib.mdDoc "Log all event activity."; }; handlers = mkOption { @@ -62,12 +62,12 @@ in event = mkOption { type = types.str; example = literalExpression ''"button/power.*" "button/lid.*" "ac_adapter.*" "button/mute.*" "button/volumedown.*" "cd/play.*" "cd/next.*"''; - description = "Event type."; + description = lib.mdDoc "Event type."; }; action = mkOption { type = types.lines; - description = "Shell commands to execute when the event is triggered."; + description = lib.mdDoc "Shell commands to execute when the event is triggered."; }; }; }); @@ -104,19 +104,19 @@ in powerEventCommands = mkOption { type = types.lines; default = ""; - description = "Shell commands to execute on a button/power.* event."; + description = lib.mdDoc "Shell commands to execute on a button/power.* event."; }; lidEventCommands = mkOption { type = types.lines; default = ""; - description = "Shell commands to execute on a button/lid.* event."; + description = lib.mdDoc "Shell commands to execute on a button/lid.* event."; }; acEventCommands = mkOption { type = types.lines; default = ""; - description = "Shell commands to execute on an ac_adapter.* event."; + description = lib.mdDoc "Shell commands to execute on an ac_adapter.* event."; }; }; diff --git a/nixos/modules/services/hardware/actkbd.nix b/nixos/modules/services/hardware/actkbd.nix index b499de97b2c3c..3ad2998e823d9 100644 --- a/nixos/modules/services/hardware/actkbd.nix +++ b/nixos/modules/services/hardware/actkbd.nix @@ -20,25 +20,25 @@ let keys = mkOption { type = types.listOf types.int; - description = "List of keycodes to match."; + description = lib.mdDoc "List of keycodes to match."; }; events = mkOption { type = types.listOf (types.enum ["key" "rep" "rel"]); default = [ "key" ]; - description = "List of events to match."; + description = lib.mdDoc "List of events to match."; }; attributes = mkOption { type = types.listOf types.str; default = [ "exec" ]; - description = "List of attributes."; + description = lib.mdDoc "List of attributes."; }; command = mkOption { type = types.str; default = ""; - description = "What to run."; + description = lib.mdDoc "What to run."; }; }; @@ -78,19 +78,19 @@ in [ { keys = [ 113 ]; events = [ "key" ]; command = "''${pkgs.alsa-utils}/bin/amixer -q set Master toggle"; } ] ''; - description = '' - Key bindings for <command>actkbd</command>. + description = lib.mdDoc '' + Key bindings for {command}`actkbd`. - See <command>actkbd</command> <filename>README</filename> for documentation. + See {command}`actkbd` {file}`README` for documentation. - The example shows a piece of what <option>sound.mediaKeys.enable</option> does when enabled. + The example shows a piece of what {option}`sound.mediaKeys.enable` does when enabled. ''; }; extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Literal contents to append to the end of actkbd configuration file. ''; }; diff --git a/nixos/modules/services/hardware/argonone.nix b/nixos/modules/services/hardware/argonone.nix index 638181b1b12e2..61656237d6f5f 100644 --- a/nixos/modules/services/hardware/argonone.nix +++ b/nixos/modules/services/hardware/argonone.nix @@ -10,7 +10,7 @@ in type = lib.types.package; default = pkgs.argononed; defaultText = "pkgs.argononed"; - description = '' + description = lib.mdDoc '' The package implementing the Argon One driver ''; }; diff --git a/nixos/modules/services/hardware/bluetooth.nix b/nixos/modules/services/hardware/bluetooth.nix index 69a66723e76cb..a1e980dbec5e8 100644 --- a/nixos/modules/services/hardware/bluetooth.nix +++ b/nixos/modules/services/hardware/bluetooth.nix @@ -43,7 +43,7 @@ in powerOnBoot = mkOption { type = types.bool; default = true; - description = "Whether to power up the default Bluetooth controller on boot."; + description = lib.mdDoc "Whether to power up the default Bluetooth controller on boot."; }; package = mkOption { @@ -64,7 +64,7 @@ in disabledPlugins = mkOption { type = types.listOf types.str; default = [ ]; - description = "Built-in plugins to disable"; + description = lib.mdDoc "Built-in plugins to disable"; }; settings = mkOption { @@ -75,7 +75,7 @@ in ControllerMode = "bredr"; }; }; - description = "Set configuration for system-wide bluetooth (/etc/bluetooth/main.conf)."; + description = lib.mdDoc "Set configuration for system-wide bluetooth (/etc/bluetooth/main.conf)."; }; }; }; diff --git a/nixos/modules/services/hardware/bolt.nix b/nixos/modules/services/hardware/bolt.nix index 32b60af060376..6990a9ea63b37 100644 --- a/nixos/modules/services/hardware/bolt.nix +++ b/nixos/modules/services/hardware/bolt.nix @@ -12,7 +12,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable Bolt, a userspace daemon to enable security levels for Thunderbolt 3 on GNU/Linux. diff --git a/nixos/modules/services/hardware/brltty.nix b/nixos/modules/services/hardware/brltty.nix index 730560175327e..3133804f485f6 100644 --- a/nixos/modules/services/hardware/brltty.nix +++ b/nixos/modules/services/hardware/brltty.nix @@ -25,7 +25,7 @@ in { services.brltty.enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the BRLTTY daemon."; + description = lib.mdDoc "Whether to enable the BRLTTY daemon."; }; }; diff --git a/nixos/modules/services/hardware/fancontrol.nix b/nixos/modules/services/hardware/fancontrol.nix index 861b70970b879..65c0c60ed3b71 100644 --- a/nixos/modules/services/hardware/fancontrol.nix +++ b/nixos/modules/services/hardware/fancontrol.nix @@ -13,7 +13,7 @@ in config = mkOption { type = types.lines; - description = "Required fancontrol configuration file content. See <citerefentry><refentrytitle>pwmconfig</refentrytitle><manvolnum>8</manvolnum></citerefentry> from the lm_sensors package."; + description = lib.mdDoc "Required fancontrol configuration file content. See {manpage}`pwmconfig(8)` from the lm_sensors package."; example = '' # Configuration file generated by pwmconfig INTERVAL=10 diff --git a/nixos/modules/services/hardware/freefall.nix b/nixos/modules/services/hardware/freefall.nix index 3f7b159244960..7b794264ff35e 100644 --- a/nixos/modules/services/hardware/freefall.nix +++ b/nixos/modules/services/hardware/freefall.nix @@ -13,7 +13,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to protect HP/Dell laptop hard drives (not SSDs) in free fall. ''; }; @@ -22,7 +22,7 @@ in { type = types.package; default = pkgs.freefall; defaultText = literalExpression "pkgs.freefall"; - description = '' + description = lib.mdDoc '' freefall derivation to use. ''; }; @@ -30,7 +30,7 @@ in { devices = mkOption { type = types.listOf types.str; default = [ "/dev/sda" ]; - description = '' + description = lib.mdDoc '' Device paths to all internal spinning hard drives. ''; }; diff --git a/nixos/modules/services/hardware/fwupd.nix b/nixos/modules/services/hardware/fwupd.nix index e0506416ffa3f..241c9d143d328 100644 --- a/nixos/modules/services/hardware/fwupd.nix +++ b/nixos/modules/services/hardware/fwupd.nix @@ -53,7 +53,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable fwupd, a DBus service that allows applications to update firmware. ''; @@ -63,7 +63,7 @@ in { type = types.listOf types.str; default = []; example = [ "2082b5e0-7a64-478a-b1b2-e3404fab6dad" ]; - description = '' + description = lib.mdDoc '' Allow disabling specific devices by their GUID ''; }; @@ -72,7 +72,7 @@ in { type = types.listOf types.str; default = []; example = [ "udev" ]; - description = '' + description = lib.mdDoc '' Allow disabling specific plugins ''; }; @@ -81,7 +81,7 @@ in { type = types.listOf types.path; default = []; example = literalExpression "[ /etc/nixos/fwupd/myfirmware.pem ]"; - description = '' + description = lib.mdDoc '' Installing a public key allows firmware signed with a matching private key to be recognized as trusted, which may require less authentication to install than for untrusted files. By default trusted firmware can be upgraded (but not downgraded) without the user or administrator password. Only very few keys are installed by default. ''; }; @@ -89,9 +89,9 @@ in { enableTestRemote = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable test remote. This is used by - <link xlink:href="https://github.com/fwupd/fwupd/blob/master/data/installed-tests/README.md">installed tests</link>. + [installed tests](https://github.com/fwupd/fwupd/blob/master/data/installed-tests/README.md). ''; }; @@ -99,7 +99,7 @@ in { type = types.package; default = pkgs.fwupd; defaultText = literalExpression "pkgs.fwupd"; - description = '' + description = lib.mdDoc '' Which fwupd package to use. ''; }; diff --git a/nixos/modules/services/hardware/illum.nix b/nixos/modules/services/hardware/illum.nix index 7f7a850002342..46172fb7b53ad 100644 --- a/nixos/modules/services/hardware/illum.nix +++ b/nixos/modules/services/hardware/illum.nix @@ -13,7 +13,7 @@ in { enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable illum, a daemon for controlling screen brightness with brightness buttons. ''; }; diff --git a/nixos/modules/services/hardware/interception-tools.nix b/nixos/modules/services/hardware/interception-tools.nix index e69c05841ee01..4f86bd470ea7b 100644 --- a/nixos/modules/services/hardware/interception-tools.nix +++ b/nixos/modules/services/hardware/interception-tools.nix @@ -9,14 +9,14 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the interception tools service."; + description = lib.mdDoc "Whether to enable the interception tools service."; }; plugins = mkOption { type = types.listOf types.package; default = [ pkgs.interception-tools-plugins.caps2esc ]; defaultText = literalExpression "[ pkgs.interception-tools-plugins.caps2esc ]"; - description = '' + description = lib.mdDoc '' A list of interception tools plugins that will be made available to use inside the udevmon configuration. ''; @@ -36,7 +36,7 @@ in { EVENTS: EV_KEY: [KEY_X, KEY_Y] ''; - description = '' + description = lib.mdDoc '' String of udevmon YAML configuration, or path to a udevmon YAML configuration file. ''; diff --git a/nixos/modules/services/hardware/joycond.nix b/nixos/modules/services/hardware/joycond.nix index d81c1bb6d63d0..c3a71edaa2ffd 100644 --- a/nixos/modules/services/hardware/joycond.nix +++ b/nixos/modules/services/hardware/joycond.nix @@ -15,7 +15,7 @@ with lib; type = types.package; default = pkgs.joycond; defaultText = "pkgs.joycond"; - description = '' + description = lib.mdDoc '' The joycond package to use. ''; }; diff --git a/nixos/modules/services/hardware/lcd.nix b/nixos/modules/services/hardware/lcd.nix index dc8595ea60cde..ec4b27bd84828 100644 --- a/nixos/modules/services/hardware/lcd.nix +++ b/nixos/modules/services/hardware/lcd.nix @@ -36,26 +36,26 @@ in with lib; { serverHost = mkOption { type = str; default = "localhost"; - description = "Host on which LCDd is listening."; + description = lib.mdDoc "Host on which LCDd is listening."; }; serverPort = mkOption { type = int; default = 13666; - description = "Port on which LCDd is listening."; + description = lib.mdDoc "Port on which LCDd is listening."; }; server = { enable = mkOption { type = bool; default = false; - description = "Enable the LCD panel server (LCDd)"; + description = lib.mdDoc "Enable the LCD panel server (LCDd)"; }; openPorts = mkOption { type = bool; default = false; - description = "Open the ports in the firewall"; + description = lib.mdDoc "Open the ports in the firewall"; }; usbPermissions = mkOption { @@ -86,25 +86,25 @@ in with lib; { usbVid = mkOption { type = str; default = ""; - description = "The vendor ID of the USB device to claim."; + description = lib.mdDoc "The vendor ID of the USB device to claim."; }; usbPid = mkOption { type = str; default = ""; - description = "The product ID of the USB device to claim."; + description = lib.mdDoc "The product ID of the USB device to claim."; }; usbGroup = mkOption { type = str; default = "dialout"; - description = "The group to use for settings permissions. This group must exist or you will have to create it."; + description = lib.mdDoc "The group to use for settings permissions. This group must exist or you will have to create it."; }; extraConfig = mkOption { type = lines; default = ""; - description = "Additional configuration added verbatim to the server config."; + description = lib.mdDoc "Additional configuration added verbatim to the server config."; }; }; @@ -112,19 +112,19 @@ in with lib; { enable = mkOption { type = bool; default = false; - description = "Enable the LCD panel client (LCDproc)"; + description = lib.mdDoc "Enable the LCD panel client (LCDproc)"; }; extraConfig = mkOption { type = lines; default = ""; - description = "Additional configuration added verbatim to the client config."; + description = lib.mdDoc "Additional configuration added verbatim to the client config."; }; restartForever = mkOption { type = bool; default = true; - description = "Try restarting the client forever."; + description = lib.mdDoc "Try restarting the client forever."; }; }; }; diff --git a/nixos/modules/services/hardware/lirc.nix b/nixos/modules/services/hardware/lirc.nix index f970b0a095c35..dfdd768c35442 100644 --- a/nixos/modules/services/hardware/lirc.nix +++ b/nixos/modules/services/hardware/lirc.nix @@ -19,18 +19,18 @@ in { [lircd] nodaemon = False ''; - description = "LIRC default options descriped in man:lircd(8) (<filename>lirc_options.conf</filename>)"; + description = lib.mdDoc "LIRC default options descriped in man:lircd(8) ({file}`lirc_options.conf`)"; }; configs = mkOption { type = types.listOf types.lines; - description = "Configurations for lircd to load, see man:lircd.conf(5) for details (<filename>lircd.conf</filename>)"; + description = lib.mdDoc "Configurations for lircd to load, see man:lircd.conf(5) for details ({file}`lircd.conf`)"; }; extraArguments = mkOption { type = types.listOf types.str; default = []; - description = "Extra arguments to lircd."; + description = lib.mdDoc "Extra arguments to lircd."; }; }; }; diff --git a/nixos/modules/services/hardware/nvidia-optimus.nix b/nixos/modules/services/hardware/nvidia-optimus.nix index d53175052c74a..5b5273ed78235 100644 --- a/nixos/modules/services/hardware/nvidia-optimus.nix +++ b/nixos/modules/services/hardware/nvidia-optimus.nix @@ -11,7 +11,7 @@ let kernel = config.boot.kernelPackages; in hardware.nvidiaOptimus.disable = lib.mkOption { default = false; type = lib.types.bool; - description = '' + description = lib.mdDoc '' Completely disable the NVIDIA graphics card and use the integrated graphics processor instead. ''; diff --git a/nixos/modules/services/hardware/pcscd.nix b/nixos/modules/services/hardware/pcscd.nix index b1a5c680a022e..c4ae6e19b79b6 100644 --- a/nixos/modules/services/hardware/pcscd.nix +++ b/nixos/modules/services/hardware/pcscd.nix @@ -23,7 +23,7 @@ in default = [ pkgs.ccid ]; defaultText = literalExpression "[ pkgs.ccid ]"; example = literalExpression "[ pkgs.pcsc-cyberjack ]"; - description = "Plugin packages to be used for PCSC-Lite."; + description = lib.mdDoc "Plugin packages to be used for PCSC-Lite."; }; readerConfig = mkOption { diff --git a/nixos/modules/services/hardware/pommed.nix b/nixos/modules/services/hardware/pommed.nix index bf7d6a46a293d..a71004c1767c4 100644 --- a/nixos/modules/services/hardware/pommed.nix +++ b/nixos/modules/services/hardware/pommed.nix @@ -13,7 +13,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to use the pommed tool to handle Apple laptop keyboard hotkeys. ''; @@ -22,12 +22,12 @@ in { configFile = mkOption { type = types.nullOr types.path; default = null; - description = '' - The path to the <filename>pommed.conf</filename> file. Leave + description = lib.mdDoc '' + The path to the {file}`pommed.conf` file. Leave to null to use the default config file - (<filename>/etc/pommed.conf.mactel</filename>). See the - files <filename>/etc/pommed.conf.mactel</filename> and - <filename>/etc/pommed.conf.pmac</filename> for examples to + ({file}`/etc/pommed.conf.mactel`). See the + files {file}`/etc/pommed.conf.mactel` and + {file}`/etc/pommed.conf.pmac` for examples to build on. ''; }; diff --git a/nixos/modules/services/hardware/power-profiles-daemon.nix b/nixos/modules/services/hardware/power-profiles-daemon.nix index 4144bc6670885..101da01b4a712 100644 --- a/nixos/modules/services/hardware/power-profiles-daemon.nix +++ b/nixos/modules/services/hardware/power-profiles-daemon.nix @@ -18,7 +18,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable power-profiles-daemon, a DBus daemon that allows changing system behavior based upon user-selected power profiles. ''; diff --git a/nixos/modules/services/hardware/rasdaemon.nix b/nixos/modules/services/hardware/rasdaemon.nix index 2d4c6d2ce959e..7048a56cb7fee 100644 --- a/nixos/modules/services/hardware/rasdaemon.nix +++ b/nixos/modules/services/hardware/rasdaemon.nix @@ -15,13 +15,13 @@ in record = mkOption { type = types.bool; default = true; - description = "record events via sqlite3, required for ras-mc-ctl"; + description = lib.mdDoc "record events via sqlite3, required for ras-mc-ctl"; }; mainboard = mkOption { type = types.lines; default = ""; - description = "Custom mainboard description, see <citerefentry><refentrytitle>ras-mc-ctl</refentrytitle><manvolnum>8</manvolnum></citerefentry> for more details."; + description = lib.mdDoc "Custom mainboard description, see {manpage}`ras-mc-ctl(8)` for more details."; example = '' vendor = ASRock model = B450M Pro4 @@ -40,7 +40,7 @@ in labels = mkOption { type = types.lines; default = ""; - description = "Additional memory module label descriptions to be placed in /etc/ras/dimm_labels.d/labels"; + description = lib.mdDoc "Additional memory module label descriptions to be placed in /etc/ras/dimm_labels.d/labels"; example = '' # vendor and model may be shown by 'ras-mc-ctl --mainboard' vendor: ASRock @@ -57,7 +57,7 @@ in config = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' rasdaemon configuration, currently only used for CE PFA for details, read rasdaemon.outPath/etc/sysconfig/rasdaemon's comments ''; @@ -72,7 +72,7 @@ in extraModules = mkOption { type = types.listOf types.str; default = []; - description = "extra kernel modules to load"; + description = lib.mdDoc "extra kernel modules to load"; example = [ "i7core_edac" ]; }; diff --git a/nixos/modules/services/hardware/sane.nix b/nixos/modules/services/hardware/sane.nix index caf232e234eb5..aaf19c1cc0ac1 100644 --- a/nixos/modules/services/hardware/sane.nix +++ b/nixos/modules/services/hardware/sane.nix @@ -60,7 +60,7 @@ in hardware.sane.snapshot = mkOption { type = types.bool; default = false; - description = "Use a development snapshot of SANE scanner drivers."; + description = lib.mdDoc "Use a development snapshot of SANE scanner drivers."; }; hardware.sane.extraBackends = mkOption { @@ -80,9 +80,9 @@ in type = types.listOf types.str; default = []; example = [ "v4l" ]; - description = '' + description = lib.mdDoc '' Names of backends which are enabled by default but should be disabled. - See <literal>$SANE_CONFIG_DIR/dll.conf</literal> for the list of possible names. + See `$SANE_CONFIG_DIR/dll.conf` for the list of possible names. ''; }; @@ -96,7 +96,7 @@ in type = types.lines; default = ""; example = "192.168.0.16"; - description = '' + description = lib.mdDoc '' Network hosts that should be probed for remote scanners. ''; }; @@ -105,7 +105,7 @@ in type = types.bool; default = false; example = true; - description = '' + description = lib.mdDoc '' Whether to enable drivers for the Fujitsu ScanSnap scanners. The driver files are unfree and extracted from the Windows driver image. @@ -116,22 +116,22 @@ in type = types.package; default = pkgs.sane-drivers.epjitsu; defaultText = literalExpression "pkgs.sane-drivers.epjitsu"; - description = '' + description = lib.mdDoc '' Epjitsu driver package to use. Useful if you want to extract the driver files yourself. - The process is described in the <literal>/etc/sane.d/epjitsu.conf</literal> file in - the <literal>sane-backends</literal> package. + The process is described in the `/etc/sane.d/epjitsu.conf` file in + the `sane-backends` package. ''; }; services.saned.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable saned network daemon for remote connection to scanners. - saned would be runned from <literal>scanner</literal> user; to allow - access to hardware that doesn't have <literal>scanner</literal> group + saned would be runned from `scanner` user; to allow + access to hardware that doesn't have `scanner` group you should add needed groups to this user. ''; }; @@ -140,7 +140,7 @@ in type = types.lines; default = ""; example = "192.168.0.0/24"; - description = '' + description = lib.mdDoc '' Extra saned configuration lines. ''; }; diff --git a/nixos/modules/services/hardware/sane_extra_backends/brscan4.nix b/nixos/modules/services/hardware/sane_extra_backends/brscan4.nix index 8f9998108406b..f01446c411ee8 100644 --- a/nixos/modules/services/hardware/sane_extra_backends/brscan4.nix +++ b/nixos/modules/services/hardware/sane_extra_backends/brscan4.nix @@ -15,7 +15,7 @@ let name = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The friendly name you give to the network device. If undefined, the name of attribute will be used. ''; @@ -25,7 +25,7 @@ let model = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The model of the network device. ''; @@ -35,7 +35,7 @@ let ip = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' The ip address of the device. If undefined, you will have to provide a nodename. ''; @@ -46,7 +46,7 @@ let nodename = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' The node name of the device. If undefined, you will have to provide an ip. ''; @@ -82,7 +82,7 @@ in office2 = { model = "MFC-7860DW"; nodename = "BRW0080927AFBCE"; }; }; type = with types; attrsOf (submodule netDeviceOpts); - description = '' + description = lib.mdDoc '' The list of network devices that will be registered against the brscan4 sane backend. ''; diff --git a/nixos/modules/services/hardware/sane_extra_backends/brscan5.nix b/nixos/modules/services/hardware/sane_extra_backends/brscan5.nix index 2e4ad8cc3ba0d..506cb8167eace 100644 --- a/nixos/modules/services/hardware/sane_extra_backends/brscan5.nix +++ b/nixos/modules/services/hardware/sane_extra_backends/brscan5.nix @@ -15,7 +15,7 @@ let name = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The friendly name you give to the network device. If undefined, the name of attribute will be used. ''; @@ -25,7 +25,7 @@ let model = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The model of the network device. ''; @@ -35,7 +35,7 @@ let ip = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' The ip address of the device. If undefined, you will have to provide a nodename. ''; @@ -46,7 +46,7 @@ let nodename = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' The node name of the device. If undefined, you will have to provide an ip. ''; @@ -77,7 +77,7 @@ in office2 = { model = "MFC-7860DW"; nodename = "BRW0080927AFBCE"; }; }; type = with types; attrsOf (submodule netDeviceOpts); - description = '' + description = lib.mdDoc '' The list of network devices that will be registered against the brscan5 sane backend. ''; diff --git a/nixos/modules/services/hardware/tcsd.nix b/nixos/modules/services/hardware/tcsd.nix index e414b9647c9bb..f22924d410d53 100644 --- a/nixos/modules/services/hardware/tcsd.nix +++ b/nixos/modules/services/hardware/tcsd.nix @@ -40,7 +40,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable tcsd, a Trusted Computing management service that provides TCG Software Stack (TSS). The tcsd daemon is the only portal to the Trusted Platform Module (TPM), a hardware @@ -51,19 +51,19 @@ in user = mkOption { default = "tss"; type = types.str; - description = "User account under which tcsd runs."; + description = lib.mdDoc "User account under which tcsd runs."; }; group = mkOption { default = "tss"; type = types.str; - description = "Group account under which tcsd runs."; + description = lib.mdDoc "Group account under which tcsd runs."; }; stateDir = mkOption { default = "/var/lib/tpm"; type = types.path; - description = '' + description = lib.mdDoc '' The location of the system persistent storage file. The system persistent storage file holds keys and data across restarts of the TCSD and system reboots. @@ -73,20 +73,20 @@ in firmwarePCRs = mkOption { default = "0,1,2,3,4,5,6,7"; type = types.str; - description = "PCR indices used in the TPM for firmware measurements."; + description = lib.mdDoc "PCR indices used in the TPM for firmware measurements."; }; kernelPCRs = mkOption { default = "8,9,10,11,12"; type = types.str; - description = "PCR indices used in the TPM for kernel measurements."; + description = lib.mdDoc "PCR indices used in the TPM for kernel measurements."; }; platformCred = mkOption { default = "${cfg.stateDir}/platform.cert"; defaultText = literalExpression ''"''${config.${opt.stateDir}}/platform.cert"''; type = types.path; - description = '' + description = lib.mdDoc '' Path to the platform credential for your TPM. Your TPM manufacturer may have provided you with a set of credentials (certificates) that should be used when creating identities @@ -100,7 +100,7 @@ in default = "${cfg.stateDir}/conformance.cert"; defaultText = literalExpression ''"''${config.${opt.stateDir}}/conformance.cert"''; type = types.path; - description = '' + description = lib.mdDoc '' Path to the conformance credential for your TPM. See also the platformCred option''; }; @@ -109,7 +109,7 @@ in default = "${cfg.stateDir}/endorsement.cert"; defaultText = literalExpression ''"''${config.${opt.stateDir}}/endorsement.cert"''; type = types.path; - description = '' + description = lib.mdDoc '' Path to the endorsement credential for your TPM. See also the platformCred option''; }; diff --git a/nixos/modules/services/hardware/thermald.nix b/nixos/modules/services/hardware/thermald.nix index fcd02ea90c6c5..b433f46f28654 100644 --- a/nixos/modules/services/hardware/thermald.nix +++ b/nixos/modules/services/hardware/thermald.nix @@ -14,7 +14,7 @@ in debug = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable debug logging. ''; }; @@ -22,14 +22,14 @@ in configFile = mkOption { type = types.nullOr types.path; default = null; - description = "the thermald manual configuration file."; + description = lib.mdDoc "the thermald manual configuration file."; }; package = mkOption { type = types.package; default = pkgs.thermald; defaultText = literalExpression "pkgs.thermald"; - description = "Which thermald package to use."; + description = lib.mdDoc "Which thermald package to use."; }; }; }; diff --git a/nixos/modules/services/hardware/thinkfan.nix b/nixos/modules/services/hardware/thinkfan.nix index 4ea829e496e88..86dabe71a4fad 100644 --- a/nixos/modules/services/hardware/thinkfan.nix +++ b/nixos/modules/services/hardware/thinkfan.nix @@ -29,16 +29,16 @@ let options = { type = mkOption { type = types.enum [ "hwmon" "atasmart" "tpacpi" "nvml" ]; - description = '' + description = lib.mdDoc '' The ${name} type, can be - <literal>hwmon</literal> for standard ${name}s, + `hwmon` for standard ${name}s, - <literal>atasmart</literal> to read the temperature via + `atasmart` to read the temperature via S.M.A.R.T (requires smartSupport to be enabled), - <literal>tpacpi</literal> for the legacy thinkpac_acpi driver, or + `tpacpi` for the legacy thinkpac_acpi driver, or - <literal>nvml</literal> for the (proprietary) nVidia driver. + `nvml` for the (proprietary) nVidia driver. ''; }; query = mkOption { @@ -67,7 +67,7 @@ let correction = mkOption { type = with types; nullOr (listOf int); default = null; - description = '' + description = lib.mdDoc '' A list of values to be added to the temperature of each sensor, can be used to equalize small discrepancies in temperature ratings. ''; @@ -118,7 +118,7 @@ in { smartSupport = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to build thinkfan with S.M.A.R.T. support to read temperatures directly from hard disks. ''; @@ -159,7 +159,7 @@ in { [7 60 85] ["level auto" 80 32767] ]; - description = '' + description = lib.mdDoc '' [LEVEL LOW HIGH] LEVEL is the fan level to use: it can be an integer (0-7 with thinkpad_acpi), @@ -175,7 +175,7 @@ in { type = types.listOf types.str; default = [ ]; example = [ "-b" "0" ]; - description = '' + description = lib.mdDoc '' A list of extra command line arguments to pass to thinkfan. Check the thinkfan(1) manpage for available arguments. ''; @@ -184,12 +184,12 @@ in { settings = mkOption { type = types.attrsOf settingsFormat.type; default = { }; - description = '' + description = lib.mdDoc '' Thinkfan settings. Use this option to configure thinkfan settings not exposed in a NixOS option or to bypass one. - Before changing this, read the <literal>thinkfan.conf(5)</literal> + Before changing this, read the `thinkfan.conf(5)` manpage and take a look at the example config file at - <link xlink:href="https://github.com/vmatare/thinkfan/blob/master/examples/thinkfan.yaml"/> + <https://github.com/vmatare/thinkfan/blob/master/examples/thinkfan.yaml> ''; }; diff --git a/nixos/modules/services/hardware/throttled.nix b/nixos/modules/services/hardware/throttled.nix index 1905eb565c6dc..559b29627cb80 100644 --- a/nixos/modules/services/hardware/throttled.nix +++ b/nixos/modules/services/hardware/throttled.nix @@ -12,7 +12,7 @@ in { extraConfig = mkOption { type = types.str; default = ""; - description = "Alternative configuration"; + description = lib.mdDoc "Alternative configuration"; }; }; }; diff --git a/nixos/modules/services/hardware/tlp.nix b/nixos/modules/services/hardware/tlp.nix index eb53f565a67f0..d2cc7c661c693 100644 --- a/nixos/modules/services/hardware/tlp.nix +++ b/nixos/modules/services/hardware/tlp.nix @@ -20,7 +20,7 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the TLP power management daemon."; + description = lib.mdDoc "Whether to enable the TLP power management daemon."; }; settings = mkOption {type = with types; attrsOf (oneOf [bool int float str (listOf str)]); @@ -29,7 +29,7 @@ in SATA_LINKPWR_ON_BAT = "med_power_with_dipm"; USB_BLACKLIST_PHONE = 1; }; - description = '' + description = lib.mdDoc '' Options passed to TLP. See https://linrunner.de/tlp for all supported options.. ''; }; @@ -37,7 +37,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Verbatim additional configuration variables for TLP. DEPRECATED: use services.tlp.settings instead. ''; diff --git a/nixos/modules/services/hardware/trezord.nix b/nixos/modules/services/hardware/trezord.nix index a65d4250c2e54..70c1fd09860e8 100644 --- a/nixos/modules/services/hardware/trezord.nix +++ b/nixos/modules/services/hardware/trezord.nix @@ -18,7 +18,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable Trezor bridge daemon, for use with Trezor hardware bitcoin wallets. ''; }; @@ -26,7 +26,7 @@ in { emulator.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable Trezor emulator support. ''; }; @@ -34,7 +34,7 @@ in { emulator.port = mkOption { type = types.port; default = 21324; - description = '' + description = lib.mdDoc '' Listening port for the Trezor emulator. ''; }; diff --git a/nixos/modules/services/hardware/triggerhappy.nix b/nixos/modules/services/hardware/triggerhappy.nix index c2fa87875e115..54eac70643ffc 100644 --- a/nixos/modules/services/hardware/triggerhappy.nix +++ b/nixos/modules/services/hardware/triggerhappy.nix @@ -22,18 +22,18 @@ let keys = mkOption { type = types.listOf types.str; - description = "List of keys to match. Key names as defined in linux/input-event-codes.h"; + description = lib.mdDoc "List of keys to match. Key names as defined in linux/input-event-codes.h"; }; event = mkOption { type = types.enum ["press" "hold" "release"]; default = "press"; - description = "Event to match."; + description = lib.mdDoc "Event to match."; }; cmd = mkOption { type = types.str; - description = "What to run."; + description = lib.mdDoc "What to run."; }; }; @@ -52,8 +52,8 @@ in enable = mkOption { type = types.bool; default = false; - description = '' - Whether to enable the <command>triggerhappy</command> hotkey daemon. + description = lib.mdDoc '' + Whether to enable the {command}`triggerhappy` hotkey daemon. ''; }; @@ -61,8 +61,8 @@ in type = types.str; default = "nobody"; example = "root"; - description = '' - User account under which <command>triggerhappy</command> runs. + description = lib.mdDoc '' + User account under which {command}`triggerhappy` runs. ''; }; @@ -72,16 +72,16 @@ in example = lib.literalExpression '' [ { keys = ["PLAYPAUSE"]; cmd = "''${pkgs.mpc-cli}/bin/mpc -q toggle"; } ] ''; - description = '' - Key bindings for <command>triggerhappy</command>. + description = lib.mdDoc '' + Key bindings for {command}`triggerhappy`. ''; }; extraConfig = mkOption { type = types.lines; default = ""; - description = '' - Literal contents to append to the end of <command>triggerhappy</command> configuration file. + description = lib.mdDoc '' + Literal contents to append to the end of {command}`triggerhappy` configuration file. ''; }; diff --git a/nixos/modules/services/hardware/udev.nix b/nixos/modules/services/hardware/udev.nix index 2e9deebbb74ab..514763e409a1a 100644 --- a/nixos/modules/services/hardware/udev.nix +++ b/nixos/modules/services/hardware/udev.nix @@ -196,7 +196,7 @@ in boot.hardwareScan = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to try to load kernel modules for all detected hardware. Usually this does a good job of providing you with the modules you need, but sometimes it can crash the system or cause other @@ -234,9 +234,9 @@ in ENV{ID_VENDOR_ID}=="046d", ENV{ID_MODEL_ID}=="0825", ENV{PULSE_IGNORE}="1" ''; type = types.lines; - description = '' - Additional <command>udev</command> rules. They'll be written - into file <filename>99-local.rules</filename>. Thus they are + description = lib.mdDoc '' + Additional {command}`udev` rules. They'll be written + into file {file}`99-local.rules`. Thus they are read and applied after all other rules. ''; }; @@ -249,9 +249,9 @@ in KEYBOARD_KEY_700e2=leftctrl ''; type = types.lines; - description = '' - Additional <command>hwdb</command> files. They'll be written - into file <filename>99-local.hwdb</filename>. Thus they are + description = lib.mdDoc '' + Additional {command}`hwdb` files. They'll be written + into file {file}`99-local.hwdb`. Thus they are read after all other files. ''; }; @@ -261,7 +261,7 @@ in hardware.firmware = mkOption { type = types.listOf types.package; default = []; - description = '' + description = lib.mdDoc '' List of packages containing firmware files. Such files will be loaded automatically if the kernel asks for them (i.e., when it has detected specific hardware that requires @@ -331,10 +331,10 @@ in SUBSYSTEM=="net", ACTION=="add", DRIVERS=="?*", ATTR{address}=="00:1D:60:B9:6D:4F", KERNEL=="eth*", NAME="my_fast_network_card" ''; type = types.lines; - description = '' - <command>udev</command> rules to include in the initrd - <emphasis>only</emphasis>. They'll be written into file - <filename>99-local.rules</filename>. Thus they are read and applied + description = lib.mdDoc '' + {command}`udev` rules to include in the initrd + *only*. They'll be written into file + {file}`99-local.rules`. Thus they are read and applied after the essential initrd rules. ''; }; diff --git a/nixos/modules/services/hardware/udisks2.nix b/nixos/modules/services/hardware/udisks2.nix index ea552ce867e87..f9b5afceac326 100644 --- a/nixos/modules/services/hardware/udisks2.nix +++ b/nixos/modules/services/hardware/udisks2.nix @@ -22,7 +22,7 @@ in enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable Udisks, a DBus service that allows applications to query and manipulate storage devices. ''; @@ -51,10 +51,10 @@ in }; }; ''; - description = '' + description = lib.mdDoc '' Options passed to udisksd. - See <link xlink:href="http://manpages.ubuntu.com/manpages/latest/en/man5/udisks2.conf.5.html">here</link> and - drive configuration in <link xlink:href="http://manpages.ubuntu.com/manpages/latest/en/man8/udisks.8.html">here</link> for supported options. + See [here](http://manpages.ubuntu.com/manpages/latest/en/man5/udisks2.conf.5.html) and + drive configuration in [here](http://manpages.ubuntu.com/manpages/latest/en/man8/udisks.8.html) for supported options. ''; }; diff --git a/nixos/modules/services/hardware/undervolt.nix b/nixos/modules/services/hardware/undervolt.nix index a743bbf21c8c2..2bf37b4112609 100644 --- a/nixos/modules/services/hardware/undervolt.nix +++ b/nixos/modules/services/hardware/undervolt.nix @@ -42,7 +42,7 @@ in verbose = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable verbose logging. ''; }; @@ -51,7 +51,7 @@ in type = types.package; default = pkgs.undervolt; defaultText = literalExpression "pkgs.undervolt"; - description = '' + description = lib.mdDoc '' undervolt derivation to use. ''; }; @@ -59,7 +59,7 @@ in coreOffset = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' The amount of voltage in mV to offset the CPU cores by. ''; }; @@ -67,7 +67,7 @@ in gpuOffset = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' The amount of voltage in mV to offset the GPU by. ''; }; @@ -75,7 +75,7 @@ in uncoreOffset = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' The amount of voltage in mV to offset uncore by. ''; }; @@ -83,7 +83,7 @@ in analogioOffset = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' The amount of voltage in mV to offset analogio by. ''; }; @@ -91,7 +91,7 @@ in temp = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' The temperature target in Celsius degrees. ''; }; @@ -99,7 +99,7 @@ in tempAc = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' The temperature target on AC power in Celsius degrees. ''; }; @@ -107,7 +107,7 @@ in tempBat = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' The temperature target on battery power in Celsius degrees. ''; }; @@ -115,7 +115,7 @@ in p1.limit = mkOption { type = with types; nullOr int; default = null; - description = '' + description = lib.mdDoc '' The P1 Power Limit in Watts. Both limit and window must be set. ''; @@ -123,7 +123,7 @@ in p1.window = mkOption { type = with types; nullOr (oneOf [ float int ]); default = null; - description = '' + description = lib.mdDoc '' The P1 Time Window in seconds. Both limit and window must be set. ''; @@ -132,7 +132,7 @@ in p2.limit = mkOption { type = with types; nullOr int; default = null; - description = '' + description = lib.mdDoc '' The P2 Power Limit in Watts. Both limit and window must be set. ''; @@ -140,7 +140,7 @@ in p2.window = mkOption { type = with types; nullOr (oneOf [ float int ]); default = null; - description = '' + description = lib.mdDoc '' The P2 Time Window in seconds. Both limit and window must be set. ''; @@ -149,7 +149,7 @@ in useTimer = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to set a timer that applies the undervolt settings every 30s. This will cause spam in the journal but might be required for some hardware under specific conditions. diff --git a/nixos/modules/services/hardware/upower.nix b/nixos/modules/services/hardware/upower.nix index 81bf497c993db..54208158b1ab9 100644 --- a/nixos/modules/services/hardware/upower.nix +++ b/nixos/modules/services/hardware/upower.nix @@ -21,7 +21,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable Upower, a DBus service that provides power management support to applications. ''; @@ -31,7 +31,7 @@ in type = types.package; default = pkgs.upower; defaultText = literalExpression "pkgs.upower"; - description = '' + description = lib.mdDoc '' Which upower package to use. ''; }; @@ -59,7 +59,7 @@ in noPollBatteries = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Don't poll the kernel for battery level changes. Some hardware will send us battery level changes through @@ -71,7 +71,7 @@ in ignoreLid = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Do we ignore the lid state Some laptops are broken. The lid state is either inverted, or stuck @@ -85,7 +85,7 @@ in usePercentageForPolicy = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Policy for warnings and action based on battery levels Whether battery percentage based policy should be used. The default @@ -99,17 +99,17 @@ in percentageLow = mkOption { type = types.ints.unsigned; default = 10; - description = '' - When <literal>usePercentageForPolicy</literal> is - <literal>true</literal>, the levels at which UPower will consider the + description = lib.mdDoc '' + When `usePercentageForPolicy` is + `true`, the levels at which UPower will consider the battery low. This will also be used for batteries which don't have time information such as that of peripherals. - If any value (of <literal>percentageLow</literal>, - <literal>percentageCritical</literal> and - <literal>percentageAction</literal>) is invalid, or not in descending + If any value (of `percentageLow`, + `percentageCritical` and + `percentageAction`) is invalid, or not in descending order, the defaults will be used. ''; }; @@ -117,17 +117,17 @@ in percentageCritical = mkOption { type = types.ints.unsigned; default = 3; - description = '' - When <literal>usePercentageForPolicy</literal> is - <literal>true</literal>, the levels at which UPower will consider the + description = lib.mdDoc '' + When `usePercentageForPolicy` is + `true`, the levels at which UPower will consider the battery critical. This will also be used for batteries which don't have time information such as that of peripherals. - If any value (of <literal>percentageLow</literal>, - <literal>percentageCritical</literal> and - <literal>percentageAction</literal>) is invalid, or not in descending + If any value (of `percentageLow`, + `percentageCritical` and + `percentageAction`) is invalid, or not in descending order, the defaults will be used. ''; }; @@ -135,17 +135,17 @@ in percentageAction = mkOption { type = types.ints.unsigned; default = 2; - description = '' - When <literal>usePercentageForPolicy</literal> is - <literal>true</literal>, the levels at which UPower will take action + description = lib.mdDoc '' + When `usePercentageForPolicy` is + `true`, the levels at which UPower will take action for the critical battery level. This will also be used for batteries which don't have time information such as that of peripherals. - If any value (of <literal>percentageLow</literal>, - <literal>percentageCritical</literal> and - <literal>percentageAction</literal>) is invalid, or not in descending + If any value (of `percentageLow`, + `percentageCritical` and + `percentageAction`) is invalid, or not in descending order, the defaults will be used. ''; }; @@ -153,13 +153,13 @@ in timeLow = mkOption { type = types.ints.unsigned; default = 1200; - description = '' - When <literal>usePercentageForPolicy</literal> is - <literal>false</literal>, the time remaining in seconds at which + description = lib.mdDoc '' + When `usePercentageForPolicy` is + `false`, the time remaining in seconds at which UPower will consider the battery low. - If any value (of <literal>timeLow</literal>, - <literal>timeCritical</literal> and <literal>timeAction</literal>) is + If any value (of `timeLow`, + `timeCritical` and `timeAction`) is invalid, or not in descending order, the defaults will be used. ''; }; @@ -167,13 +167,13 @@ in timeCritical = mkOption { type = types.ints.unsigned; default = 300; - description = '' - When <literal>usePercentageForPolicy</literal> is - <literal>false</literal>, the time remaining in seconds at which + description = lib.mdDoc '' + When `usePercentageForPolicy` is + `false`, the time remaining in seconds at which UPower will consider the battery critical. - If any value (of <literal>timeLow</literal>, - <literal>timeCritical</literal> and <literal>timeAction</literal>) is + If any value (of `timeLow`, + `timeCritical` and `timeAction`) is invalid, or not in descending order, the defaults will be used. ''; }; @@ -181,13 +181,13 @@ in timeAction = mkOption { type = types.ints.unsigned; default = 120; - description = '' - When <literal>usePercentageForPolicy</literal> is - <literal>false</literal>, the time remaining in seconds at which + description = lib.mdDoc '' + When `usePercentageForPolicy` is + `false`, the time remaining in seconds at which UPower will take action for the critical battery level. - If any value (of <literal>timeLow</literal>, - <literal>timeCritical</literal> and <literal>timeAction</literal>) is + If any value (of `timeLow`, + `timeCritical` and `timeAction`) is invalid, or not in descending order, the defaults will be used. ''; }; @@ -195,9 +195,9 @@ in criticalPowerAction = mkOption { type = types.enum [ "PowerOff" "Hibernate" "HybridSleep" ]; default = "HybridSleep"; - description = '' - The action to take when <literal>timeAction</literal> or - <literal>percentageAction</literal> has been reached for the batteries + description = lib.mdDoc '' + The action to take when `timeAction` or + `percentageAction` has been reached for the batteries (UPS or laptop batteries) supplying the computer ''; }; diff --git a/nixos/modules/services/hardware/usbmuxd.nix b/nixos/modules/services/hardware/usbmuxd.nix index 11a4b0a858f9c..b4c954906dd3a 100644 --- a/nixos/modules/services/hardware/usbmuxd.nix +++ b/nixos/modules/services/hardware/usbmuxd.nix @@ -16,7 +16,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the usbmuxd ("USB multiplexing daemon") service. This daemon is in charge of multiplexing connections over USB to an iOS device. This is needed for transferring data from and to iOS devices (see ifuse). Also @@ -27,7 +27,7 @@ in user = mkOption { type = types.str; default = defaultUserGroup; - description = '' + description = lib.mdDoc '' The user usbmuxd should use to run after startup. ''; }; @@ -35,7 +35,7 @@ in group = mkOption { type = types.str; default = defaultUserGroup; - description = '' + description = lib.mdDoc '' The group usbmuxd should use to run after startup. ''; }; diff --git a/nixos/modules/services/hardware/usbrelayd.nix b/nixos/modules/services/hardware/usbrelayd.nix index 2cee4e1ff7e8c..471657190bbca 100644 --- a/nixos/modules/services/hardware/usbrelayd.nix +++ b/nixos/modules/services/hardware/usbrelayd.nix @@ -9,7 +9,7 @@ in broker = mkOption { type = str; - description = "Hostname or IP address of your MQTT Broker."; + description = lib.mdDoc "Hostname or IP address of your MQTT Broker."; default = "127.0.0.1"; example = [ "mqtt" @@ -19,7 +19,7 @@ in clientName = mkOption { type = str; - description = "Name, your client connects as."; + description = lib.mdDoc "Name, your client connects as."; default = "MyUSBRelay"; }; }; diff --git a/nixos/modules/services/hardware/vdr.nix b/nixos/modules/services/hardware/vdr.nix index 5ec222b805c84..4fc2905c09694 100644 --- a/nixos/modules/services/hardware/vdr.nix +++ b/nixos/modules/services/hardware/vdr.nix @@ -19,19 +19,19 @@ in { default = pkgs.vdr; defaultText = literalExpression "pkgs.vdr"; example = literalExpression "pkgs.wrapVdr.override { plugins = with pkgs.vdrPlugins; [ hello ]; }"; - description = "Package to use."; + description = lib.mdDoc "Package to use."; }; videoDir = mkOption { type = types.path; default = "/srv/vdr/video"; - description = "Recording directory"; + description = lib.mdDoc "Recording directory"; }; extraArguments = mkOption { type = types.listOf types.str; default = []; - description = "Additional command line arguments to pass to VDR."; + description = lib.mdDoc "Additional command line arguments to pass to VDR."; }; enableLirc = mkEnableOption "LIRC"; diff --git a/nixos/modules/services/home-automation/home-assistant.nix b/nixos/modules/services/home-automation/home-assistant.nix index 1d76d2fd39c68..6324965c621cf 100644 --- a/nixos/modules/services/home-automation/home-assistant.nix +++ b/nixos/modules/services/home-automation/home-assistant.nix @@ -82,7 +82,7 @@ in { configDir = mkOption { default = "/var/lib/hass"; type = types.path; - description = "The config directory, where your <filename>configuration.yaml</filename> is located."; + description = lib.mdDoc "The config directory, where your {file}`configuration.yaml` is located."; }; extraComponents = mkOption { @@ -107,10 +107,10 @@ in { "wled" ] ''; - description = '' - List of <link xlink:href="https://www.home-assistant.io/integrations/">components</link> that have their dependencies included in the package. + description = lib.mdDoc '' + List of [components](https://www.home-assistant.io/integrations/) that have their dependencies included in the package. - The component name can be found in the URL, for example <literal>https://www.home-assistant.io/integrations/ffmpeg/</literal> would map to <literal>ffmpeg</literal>. + The component name can be found in the URL, for example `https://www.home-assistant.io/integrations/ffmpeg/` would map to `ffmpeg`. ''; }; @@ -148,7 +148,7 @@ in { type = types.nullOr types.str; default = null; example = "Home"; - description = '' + description = lib.mdDoc '' Name of the location where Home Assistant is running. ''; }; @@ -157,7 +157,7 @@ in { type = types.nullOr (types.either types.float types.str); default = null; example = 52.3; - description = '' + description = lib.mdDoc '' Latitude of your location required to calculate the time the sun rises and sets. ''; }; @@ -166,7 +166,7 @@ in { type = types.nullOr (types.either types.float types.str); default = null; example = 4.9; - description = '' + description = lib.mdDoc '' Longitude of your location required to calculate the time the sun rises and sets. ''; }; @@ -175,7 +175,7 @@ in { type = types.nullOr (types.enum [ "metric" "imperial" ]); default = null; example = "metric"; - description = '' + description = lib.mdDoc '' The unit system to use. This also sets temperature_unit, Celsius for Metric and Fahrenheit for Imperial. ''; }; @@ -184,8 +184,8 @@ in { type = types.nullOr (types.enum [ "C" "F" ]); default = null; example = "C"; - description = '' - Override temperature unit set by unit_system. <literal>C</literal> for Celsius, <literal>F</literal> for Fahrenheit. + description = lib.mdDoc '' + Override temperature unit set by unit_system. `C` for Celsius, `F` for Fahrenheit. ''; }; @@ -196,8 +196,8 @@ in { config.time.timeZone or null ''; example = "Europe/Amsterdam"; - description = '' - Pick your time zone from the column TZ of Wikipedia’s <link xlink:href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">list of tz database time zones</link>. + description = lib.mdDoc '' + Pick your time zone from the column TZ of Wikipedia’s [list of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). ''; }; }; @@ -211,7 +211,7 @@ in { "::" ]; example = "::1"; - description = '' + description = lib.mdDoc '' Only listen to incoming requests on specific IP/host. The default listed assumes support for IPv4 and IPv6. ''; }; @@ -219,7 +219,7 @@ in { server_port = mkOption { default = 8123; type = types.port; - description = '' + description = lib.mdDoc '' The port on which to listen. ''; }; @@ -238,8 +238,8 @@ in { else "storage"; ''; example = "yaml"; - description = '' - In what mode should the main Lovelace panel be, <literal>yaml</literal> or <literal>storage</literal> (UI managed). + description = lib.mdDoc '' + In what mode should the main Lovelace panel be, `yaml` or `storage` (UI managed). ''; }; }; @@ -262,14 +262,14 @@ in { feedreader.urls = [ "https://nixos.org/blogs.xml" ]; } ''; - description = '' - Your <filename>configuration.yaml</filename> as a Nix attribute set. + description = lib.mdDoc '' + Your {file}`configuration.yaml` as a Nix attribute set. - YAML functions like <link xlink:href="https://www.home-assistant.io/docs/configuration/secrets/">secrets</link> + YAML functions like [secrets](https://www.home-assistant.io/docs/configuration/secrets/) can be passed as a string and will be unquoted automatically. - Unless this option is explicitly set to <literal>null</literal> - we assume your <filename>configuration.yaml</filename> is + Unless this option is explicitly set to `null` + we assume your {file}`configuration.yaml` is managed through this module and thereby overwritten on startup. ''; }; @@ -277,12 +277,12 @@ in { configWritable = mkOption { default = false; type = types.bool; - description = '' - Whether to make <filename>configuration.yaml</filename> writable. + description = lib.mdDoc '' + Whether to make {file}`configuration.yaml` writable. This will allow you to edit it from Home Assistant's web interface. - This only has an effect if <option>config</option> is set. + This only has an effect if {option}`config` is set. However, bear in mind that it will be overwritten at every start of the service. ''; }; @@ -304,23 +304,23 @@ in { } ]; } ''; - description = '' - Your <filename>ui-lovelace.yaml</filename> as a Nix attribute set. - Setting this option will automatically set <literal>lovelace.mode</literal> to <literal>yaml</literal>. + description = lib.mdDoc '' + Your {file}`ui-lovelace.yaml` as a Nix attribute set. + Setting this option will automatically set `lovelace.mode` to `yaml`. - Beware that setting this option will delete your previous <filename>ui-lovelace.yaml</filename> + Beware that setting this option will delete your previous {file}`ui-lovelace.yaml` ''; }; lovelaceConfigWritable = mkOption { default = false; type = types.bool; - description = '' - Whether to make <filename>ui-lovelace.yaml</filename> writable. + description = lib.mdDoc '' + Whether to make {file}`ui-lovelace.yaml` writable. This will allow you to edit it from Home Assistant's web interface. - This only has an effect if <option>lovelaceConfig</option> is set. + This only has an effect if {option}`lovelaceConfig` is set. However, bear in mind that it will be overwritten at every start of the service. ''; }; @@ -347,7 +347,7 @@ in { ]; } ''; - description = '' + description = lib.mdDoc '' The Home Assistant package to use. ''; }; @@ -355,7 +355,7 @@ in { openFirewall = mkOption { default = false; type = types.bool; - description = "Whether to open the firewall for the specified port."; + description = lib.mdDoc "Whether to open the firewall for the specified port."; }; }; diff --git a/nixos/modules/services/home-automation/zigbee2mqtt.nix b/nixos/modules/services/home-automation/zigbee2mqtt.nix index ff6d595e5a6e3..48474ab3facee 100644 --- a/nixos/modules/services/home-automation/zigbee2mqtt.nix +++ b/nixos/modules/services/home-automation/zigbee2mqtt.nix @@ -21,7 +21,7 @@ in enable = mkEnableOption "enable zigbee2mqtt service"; package = mkOption { - description = "Zigbee2mqtt package to use"; + description = lib.mdDoc "Zigbee2mqtt package to use"; default = pkgs.zigbee2mqtt; defaultText = literalExpression '' pkgs.zigbee2mqtt @@ -30,7 +30,7 @@ in }; dataDir = mkOption { - description = "Zigbee2mqtt data directory"; + description = lib.mdDoc "Zigbee2mqtt data directory"; default = "/var/lib/zigbee2mqtt"; type = types.path; }; @@ -47,9 +47,9 @@ in }; } ''; - description = '' - Your <filename>configuration.yaml</filename> as a Nix attribute set. - Check the <link xlink:href="https://www.zigbee2mqtt.io/information/configuration.html">documentation</link> + description = lib.mdDoc '' + Your {file}`configuration.yaml` as a Nix attribute set. + Check the [documentation](https://www.zigbee2mqtt.io/information/configuration.html) for possible options. ''; }; diff --git a/nixos/modules/services/logging/SystemdJournal2Gelf.nix b/nixos/modules/services/logging/SystemdJournal2Gelf.nix index f28ecab8ac237..3d85c2b62c634 100644 --- a/nixos/modules/services/logging/SystemdJournal2Gelf.nix +++ b/nixos/modules/services/logging/SystemdJournal2Gelf.nix @@ -10,7 +10,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable SystemdJournal2Gelf. ''; }; @@ -18,7 +18,7 @@ in graylogServer = mkOption { type = types.str; example = "graylog2.example.com:11201"; - description = '' + description = lib.mdDoc '' Host and port of your graylog2 input. This should be a GELF UDP input. ''; @@ -27,9 +27,9 @@ in extraOptions = mkOption { type = types.separatedString " "; default = ""; - description = '' + description = lib.mdDoc '' Any extra flags to pass to SystemdJournal2Gelf. Note that - these are basically <literal>journalctl</literal> flags. + these are basically `journalctl` flags. ''; }; @@ -37,7 +37,7 @@ in type = types.package; default = pkgs.systemd-journal2gelf; defaultText = literalExpression "pkgs.systemd-journal2gelf"; - description = '' + description = lib.mdDoc '' SystemdJournal2Gelf package to use. ''; }; diff --git a/nixos/modules/services/logging/awstats.nix b/nixos/modules/services/logging/awstats.nix index df0124380ff0d..8dbf895a769b9 100644 --- a/nixos/modules/services/logging/awstats.nix +++ b/nixos/modules/services/logging/awstats.nix @@ -11,14 +11,14 @@ let type = types.enum [ "mail" "web" ]; default = "web"; example = "mail"; - description = '' + description = lib.mdDoc '' The type of log being collected. ''; }; domain = mkOption { type = types.str; default = name; - description = "The domain name to collect stats for."; + description = lib.mdDoc "The domain name to collect stats for."; example = "example.com"; }; @@ -52,7 +52,7 @@ let type = types.listOf types.str; default = []; example = [ "www.example.org" ]; - description = '' + description = lib.mdDoc '' List of aliases the site has. ''; }; @@ -65,7 +65,7 @@ let "ValidHTTPCodes" = "404"; } ''; - description = "Extra configuration to be appended to awstats.\${name}.conf."; + description = lib.mdDoc "Extra configuration to be appended to awstats.\${name}.conf."; }; webService = { @@ -74,13 +74,13 @@ let hostname = mkOption { type = types.str; default = config.domain; - description = "The hostname the web service appears under."; + description = lib.mdDoc "The hostname the web service appears under."; }; urlPrefix = mkOption { type = types.str; default = "/awstats"; - description = "The URL prefix under which the awstats pages appear."; + description = lib.mdDoc "The URL prefix under which the awstats pages appear."; }; }; }; @@ -100,7 +100,7 @@ in dataDir = mkOption { type = types.path; default = "/var/lib/awstats"; - description = "The directory where awstats data will be stored."; + description = lib.mdDoc "The directory where awstats data will be stored."; }; configs = mkOption { @@ -114,7 +114,7 @@ in }; } ''; - description = "Attribute set of domains to collect stats for."; + description = lib.mdDoc "Attribute set of domains to collect stats for."; }; updateAt = mkOption { diff --git a/nixos/modules/services/logging/filebeat.nix b/nixos/modules/services/logging/filebeat.nix index 223a993c505b4..ec8df0a7b87d2 100644 --- a/nixos/modules/services/logging/filebeat.nix +++ b/nixos/modules/services/logging/filebeat.nix @@ -25,7 +25,7 @@ in default = pkgs.filebeat; defaultText = literalExpression "pkgs.filebeat"; example = literalExpression "pkgs.filebeat7"; - description = '' + description = lib.mdDoc '' The filebeat package to use. ''; }; @@ -53,12 +53,12 @@ in type = mkOption { type = types.str; default = name; - description = '' + description = lib.mdDoc '' The input type. - Look for the value after <literal>type:</literal> on + Look for the value after `type:` on the individual input pages linked from - <link xlink:href="https://www.elastic.co/guide/en/beats/filebeat/current/configuration-filebeat-options.html"/>. + <https://www.elastic.co/guide/en/beats/filebeat/current/configuration-filebeat-options.html>. ''; }; }; @@ -103,12 +103,12 @@ in module = mkOption { type = types.str; default = name; - description = '' + description = lib.mdDoc '' The name of the module. - Look for the value after <literal>module:</literal> on + Look for the value after `module:` on the individual input pages linked from - <link xlink:href="https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-modules.html"/>. + <https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-modules.html>. ''; }; }; @@ -139,7 +139,7 @@ in type = with types; listOf str; default = [ "127.0.0.1:9200" ]; example = [ "myEShost:9200" ]; - description = '' + description = lib.mdDoc '' The list of Elasticsearch nodes to connect to. The events are distributed to these nodes in round @@ -147,10 +147,10 @@ in event is automatically sent to another node. Each Elasticsearch node can be defined as a URL or IP:PORT. For example: - <literal>http://192.15.3.2</literal>, - <literal>https://es.found.io:9230</literal> or - <literal>192.24.3.2:9300</literal>. If no port is - specified, <literal>9200</literal> is used. + `http://192.15.3.2`, + `https://es.found.io:9230` or + `192.24.3.2:9300`. If no port is + specified, `9200` is used. ''; }; @@ -200,20 +200,20 @@ in }; ''; - description = '' + description = lib.mdDoc '' Configuration for filebeat. See - <link xlink:href="https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-reference-yml.html"/> + <https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-reference-yml.html> for supported values. Options containing secret data should be set to an attribute - set containing the attribute <literal>_secret</literal> - a + set containing the attribute `_secret` - a string pointing to a file containing the value the option should be set to. See the example to get a better picture of this: in the resulting - <filename>filebeat.yml</filename> file, the - <literal>output.elasticsearch.password</literal> + {file}`filebeat.yml` file, the + `output.elasticsearch.password` key will be set to the contents of the - <filename>/var/keys/elasticsearch_password</filename> file. + {file}`/var/keys/elasticsearch_password` file. ''; }; }; diff --git a/nixos/modules/services/logging/fluentd.nix b/nixos/modules/services/logging/fluentd.nix index dd19617a13ffc..fe9f4b07e1622 100644 --- a/nixos/modules/services/logging/fluentd.nix +++ b/nixos/modules/services/logging/fluentd.nix @@ -15,26 +15,26 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable fluentd."; + description = lib.mdDoc "Whether to enable fluentd."; }; config = mkOption { type = types.lines; default = ""; - description = "Fluentd config."; + description = lib.mdDoc "Fluentd config."; }; package = mkOption { type = types.path; default = pkgs.fluentd; defaultText = literalExpression "pkgs.fluentd"; - description = "The fluentd package to use."; + description = lib.mdDoc "The fluentd package to use."; }; plugins = mkOption { type = types.listOf types.path; default = []; - description = '' + description = lib.mdDoc '' A list of plugin paths to pass into fluentd. It will make plugins defined in ruby files there available in your config. ''; diff --git a/nixos/modules/services/logging/graylog.nix b/nixos/modules/services/logging/graylog.nix index 28e2d18bf0311..9f7160b3e8738 100644 --- a/nixos/modules/services/logging/graylog.nix +++ b/nixos/modules/services/logging/graylog.nix @@ -39,30 +39,30 @@ in type = types.package; default = pkgs.graylog; defaultText = literalExpression "pkgs.graylog"; - description = "Graylog package to use."; + description = lib.mdDoc "Graylog package to use."; }; user = mkOption { type = types.str; default = "graylog"; - description = "User account under which graylog runs"; + description = lib.mdDoc "User account under which graylog runs"; }; isMaster = mkOption { type = types.bool; default = true; - description = "Whether this is the master instance of your Graylog cluster"; + description = lib.mdDoc "Whether this is the master instance of your Graylog cluster"; }; nodeIdFile = mkOption { type = types.str; default = "/var/lib/graylog/server/node-id"; - description = "Path of the file containing the graylog node-id"; + description = lib.mdDoc "Path of the file containing the graylog node-id"; }; passwordSecret = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' You MUST set a secret to secure/pepper the stored user passwords here. Use at least 64 characters. Generate one by using for example: pwgen -N 1 -s 96 ''; @@ -71,13 +71,13 @@ in rootUsername = mkOption { type = types.str; default = "admin"; - description = "Name of the default administrator user"; + description = lib.mdDoc "Name of the default administrator user"; }; rootPasswordSha2 = mkOption { type = types.str; example = "e3c652f0ba0b4801205814f8b6bc49672c4c74e25b497770bb89b22cdeb4e952"; - description = '' + description = lib.mdDoc '' You MUST specify a hash password for the root user (which you only need to initially set up the system and in case you lose connectivity to your authentication backend) This password cannot be changed using the API or via the web interface. If you need to change it, @@ -90,29 +90,29 @@ in elasticsearchHosts = mkOption { type = types.listOf types.str; example = literalExpression ''[ "http://node1:9200" "http://user:password@node2:19200" ]''; - description = "List of valid URIs of the http ports of your elastic nodes. If one or more of your elasticsearch hosts require authentication, include the credentials in each node URI that requires authentication"; + description = lib.mdDoc "List of valid URIs of the http ports of your elastic nodes. If one or more of your elasticsearch hosts require authentication, include the credentials in each node URI that requires authentication"; }; messageJournalDir = mkOption { type = types.str; default = "/var/lib/graylog/data/journal"; - description = "The directory which will be used to store the message journal. The directory must be exclusively used by Graylog and must not contain any other files than the ones created by Graylog itself"; + description = lib.mdDoc "The directory which will be used to store the message journal. The directory must be exclusively used by Graylog and must not contain any other files than the ones created by Graylog itself"; }; mongodbUri = mkOption { type = types.str; default = "mongodb://localhost/graylog"; - description = "MongoDB connection string. See http://docs.mongodb.org/manual/reference/connection-string/ for details"; + description = lib.mdDoc "MongoDB connection string. See http://docs.mongodb.org/manual/reference/connection-string/ for details"; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Any other configuration options you might want to add"; + description = lib.mdDoc "Any other configuration options you might want to add"; }; plugins = mkOption { - description = "Extra graylog plugins"; + description = lib.mdDoc "Extra graylog plugins"; default = [ ]; type = types.listOf types.package; }; diff --git a/nixos/modules/services/logging/heartbeat.nix b/nixos/modules/services/logging/heartbeat.nix index 843ec033911f1..72fbf41739df8 100644 --- a/nixos/modules/services/logging/heartbeat.nix +++ b/nixos/modules/services/logging/heartbeat.nix @@ -25,7 +25,7 @@ in default = pkgs.heartbeat; defaultText = literalExpression "pkgs.heartbeat"; example = literalExpression "pkgs.heartbeat7"; - description = '' + description = lib.mdDoc '' The heartbeat package to use. ''; }; @@ -33,19 +33,19 @@ in name = mkOption { type = types.str; default = "heartbeat"; - description = "Name of the beat"; + description = lib.mdDoc "Name of the beat"; }; tags = mkOption { type = types.listOf types.str; default = []; - description = "Tags to place on the shipped log messages"; + description = lib.mdDoc "Tags to place on the shipped log messages"; }; stateDir = mkOption { type = types.str; default = "/var/lib/heartbeat"; - description = "The state directory. heartbeat's own logs and other data are stored here."; + description = lib.mdDoc "The state directory. heartbeat's own logs and other data are stored here."; }; extraConfig = mkOption { @@ -56,7 +56,7 @@ in urls: ["http://localhost:9200"] schedule: '@every 10s' ''; - description = "Any other configuration options you want to add"; + description = lib.mdDoc "Any other configuration options you want to add"; }; }; diff --git a/nixos/modules/services/logging/journalbeat.nix b/nixos/modules/services/logging/journalbeat.nix index 4035ab48b4b87..a38283ae1e41a 100644 --- a/nixos/modules/services/logging/journalbeat.nix +++ b/nixos/modules/services/logging/journalbeat.nix @@ -24,7 +24,7 @@ in type = types.package; default = pkgs.journalbeat; defaultText = literalExpression "pkgs.journalbeat"; - description = '' + description = lib.mdDoc '' The journalbeat package to use ''; }; @@ -32,20 +32,20 @@ in name = mkOption { type = types.str; default = "journalbeat"; - description = "Name of the beat"; + description = lib.mdDoc "Name of the beat"; }; tags = mkOption { type = types.listOf types.str; default = []; - description = "Tags to place on the shipped log messages"; + description = lib.mdDoc "Tags to place on the shipped log messages"; }; stateDir = mkOption { type = types.str; default = "journalbeat"; - description = '' - Directory below <literal>/var/lib/</literal> to store journalbeat's + description = lib.mdDoc '' + Directory below `/var/lib/` to store journalbeat's own logs and other data. This directory will be created automatically using systemd's StateDirectory mechanism. ''; @@ -54,7 +54,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = "Any other configuration options you want to add"; + description = lib.mdDoc "Any other configuration options you want to add"; }; }; diff --git a/nixos/modules/services/logging/journaldriver.nix b/nixos/modules/services/logging/journaldriver.nix index 9bd581e9ec0e5..59eedff90d60e 100644 --- a/nixos/modules/services/logging/journaldriver.nix +++ b/nixos/modules/services/logging/journaldriver.nix @@ -17,7 +17,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable journaldriver to forward journald logs to Stackdriver Logging. ''; @@ -26,7 +26,7 @@ in { logLevel = mkOption { type = types.str; default = "info"; - description = '' + description = lib.mdDoc '' Log level at which journaldriver logs its own output. ''; }; @@ -34,7 +34,7 @@ in { logName = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Configures the name of the target log in Stackdriver Logging. This option can be set to, for example, the hostname of a machine to improve the user experience in the logging @@ -45,7 +45,7 @@ in { googleCloudProject = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Configures the name of the Google Cloud project to which to forward journald logs. @@ -57,7 +57,7 @@ in { logStream = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Configures the name of the Stackdriver Logging log stream into which to write journald entries. @@ -69,7 +69,7 @@ in { applicationCredentials = mkOption { type = with types; nullOr path; default = null; - description = '' + description = lib.mdDoc '' Path to the service account private key (in JSON-format) used to forward log entries to Stackdriver Logging on non-GCP instances. diff --git a/nixos/modules/services/logging/journalwatch.nix b/nixos/modules/services/logging/journalwatch.nix index fb86904d1ea29..a315da3ea0eee 100644 --- a/nixos/modules/services/logging/journalwatch.nix +++ b/nixos/modules/services/logging/journalwatch.nix @@ -51,7 +51,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If enabled, periodically check the journal with journalwatch and report the results by mail. ''; }; @@ -59,12 +59,12 @@ in { priority = mkOption { type = types.int; default = 6; - description = '' + description = lib.mdDoc '' Lowest priority of message to be considered. A value between 7 ("debug"), and 0 ("emerg"). Defaults to 6 ("info"). If you don't care about anything with "info" priority, you can reduce this to e.g. 5 ("notice") to considerably reduce the amount of - messages without needing many <option>filterBlocks</option>. + messages without needing many {option}`filterBlocks`. ''; }; @@ -75,7 +75,7 @@ in { type = types.str; default = "journalwatch@${config.networking.hostName}"; defaultText = literalExpression ''"journalwatch@''${config.networking.hostName}"''; - description = '' + description = lib.mdDoc '' Mail address to send journalwatch reports from. ''; }; @@ -83,7 +83,7 @@ in { mailTo = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Mail address to send journalwatch reports to. ''; }; @@ -91,7 +91,7 @@ in { mailBinary = mkOption { type = types.path; default = "/run/wrappers/bin/sendmail"; - description = '' + description = lib.mdDoc '' Sendmail-compatible binary to be used to send the messages. ''; }; @@ -99,10 +99,10 @@ in { extraConfig = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Extra lines to be added verbatim to the journalwatch/config configuration file. You can add any commandline argument to the config, without the '--'. - See <literal>journalwatch --help</literal> for all arguments and their description. + See `journalwatch --help` for all arguments and their description. ''; }; @@ -112,12 +112,12 @@ in { match = mkOption { type = types.str; example = "SYSLOG_IDENTIFIER = systemd"; - description = '' - Syntax: <literal>field = value</literal> - Specifies the log entry <literal>field</literal> this block should apply to. - If the <literal>field</literal> of a message matches this <literal>value</literal>, - this patternBlock's <option>filters</option> are applied. - If <literal>value</literal> starts and ends with a slash, it is interpreted as + description = lib.mdDoc '' + Syntax: `field = value` + Specifies the log entry `field` this block should apply to. + If the `field` of a message matches this `value`, + this patternBlock's {option}`filters` are applied. + If `value` starts and ends with a slash, it is interpreted as an extended python regular expression, if not, it's an exact match. The journal fields are explained in systemd.journal-fields(7). ''; @@ -129,8 +129,8 @@ in { (Stopped|Stopping|Starting|Started) .* (Reached target|Stopped target) .* ''; - description = '' - The filters to apply on all messages which satisfy <option>match</option>. + description = lib.mdDoc '' + The filters to apply on all messages which satisfy {option}`match`. Any of those messages that match any specified filter will be removed from journalwatch's output. Each filter is an extended Python regular expression. You can specify multiple filters and separate them by newlines. @@ -175,7 +175,7 @@ in { ]; - description = '' + description = lib.mdDoc '' filterBlocks can be defined to blacklist journal messages which are not errors. Each block matches on a log entry field, and the filters in that block then are matched against all messages with a matching log entry field. @@ -191,7 +191,7 @@ in { interval = mkOption { type = types.str; default = "hourly"; - description = '' + description = lib.mdDoc '' How often to run journalwatch. The format is described in systemd.time(7). @@ -200,7 +200,7 @@ in { accuracy = mkOption { type = types.str; default = "10min"; - description = '' + description = lib.mdDoc '' The time window around the interval in which the journalwatch run will be scheduled. The format is described in systemd.time(7). diff --git a/nixos/modules/services/logging/logcheck.nix b/nixos/modules/services/logging/logcheck.nix index c8738b734f9a1..b1279f0fe5861 100644 --- a/nixos/modules/services/logging/logcheck.nix +++ b/nixos/modules/services/logging/logcheck.nix @@ -56,7 +56,7 @@ let levelOption = mkOption { default = "server"; type = types.enum [ "workstation" "server" "paranoid" ]; - description = '' + description = lib.mdDoc '' Set the logcheck level. ''; }; @@ -68,7 +68,7 @@ let regex = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' Regex specifying which log lines to ignore. ''; }; @@ -80,7 +80,7 @@ let user = mkOption { default = "root"; type = types.str; - description = '' + description = lib.mdDoc '' User that runs the cronjob. ''; }; @@ -88,7 +88,7 @@ let cmdline = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' Command line for the cron job. Will be turned into a regex for the logcheck ignore rule. ''; }; @@ -97,7 +97,7 @@ let default = null; type = types.nullOr (types.str); example = "02 06 * * *"; - description = '' + description = lib.mdDoc '' "min hr dom mon dow" crontab time args, to auto-create a cronjob too. Leave at null to not do this and just add a logcheck ignore rule. ''; @@ -112,7 +112,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable the logcheck cron job. ''; }; @@ -120,7 +120,7 @@ in user = mkOption { default = "logcheck"; type = types.str; - description = '' + description = lib.mdDoc '' Username for the logcheck user. ''; }; @@ -129,7 +129,7 @@ in default = "*"; example = "6"; type = types.str; - description = '' + description = lib.mdDoc '' Time of day to run logcheck. A logcheck will be scheduled at xx:02 each day. Leave default (*) to run every hour. Of course when nothing special was logged, logcheck will be silent. @@ -140,7 +140,7 @@ in default = "root"; example = "you@domain.com"; type = types.str; - description = '' + description = lib.mdDoc '' Email address to send reports to. ''; }; @@ -148,7 +148,7 @@ in level = mkOption { default = "server"; type = types.str; - description = '' + description = lib.mdDoc '' Set the logcheck level. Either "workstation", "server", or "paranoid". ''; }; @@ -156,7 +156,7 @@ in config = mkOption { default = "FQDN=1"; type = types.lines; - description = '' + description = lib.mdDoc '' Config options that you would like in logcheck.conf. ''; }; @@ -165,7 +165,7 @@ in default = [ "/var/log/messages" ]; type = types.listOf types.path; example = [ "/var/log/messages" "/var/log/mail" ]; - description = '' + description = lib.mdDoc '' Which log files to check. ''; }; @@ -174,14 +174,14 @@ in default = []; example = [ "/etc/logcheck" ]; type = types.listOf types.path; - description = '' + description = lib.mdDoc '' Directories with extra rules. ''; }; ignore = mkOption { default = {}; - description = '' + description = lib.mdDoc '' This option defines extra ignore rules. ''; type = with types; attrsOf (submodule ignoreOptions); @@ -189,7 +189,7 @@ in ignoreCron = mkOption { default = {}; - description = '' + description = lib.mdDoc '' This option defines extra ignore rules for cronjobs. ''; type = with types; attrsOf (submodule ignoreCronOptions); @@ -199,7 +199,7 @@ in default = []; type = types.listOf types.str; example = [ "postdrop" "mongodb" ]; - description = '' + description = lib.mdDoc '' Extra groups for the logcheck user, for example to be able to use sendmail, or to access certain log files. ''; diff --git a/nixos/modules/services/logging/logrotate.nix b/nixos/modules/services/logging/logrotate.nix index 893d951ee2348..a6eb08ac5eac4 100644 --- a/nixos/modules/services/logging/logrotate.nix +++ b/nixos/modules/services/logging/logrotate.nix @@ -13,7 +13,7 @@ let enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable log rotation for this path. This can be used to explicitly disable logging that has been configured by NixOS. ''; @@ -28,7 +28,7 @@ let type = with types; either str (listOf str); default = name; defaultText = "attribute name"; - description = '' + description = lib.mdDoc '' The path to log files to be rotated. Spaces are allowed and normal shell quoting rules apply, with ', ", and \ characters supported. @@ -38,7 +38,7 @@ let user = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' The user account to use for rotation. ''; }; @@ -46,7 +46,7 @@ let group = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' The group to use for rotation. ''; }; @@ -54,7 +54,7 @@ let frequency = mkOption { type = types.enum [ "hourly" "daily" "weekly" "monthly" "yearly" ]; default = "daily"; - description = '' + description = lib.mdDoc '' How often to rotate the logs. ''; }; @@ -62,7 +62,7 @@ let keep = mkOption { type = types.int; default = 20; - description = '' + description = lib.mdDoc '' How many rotations to keep. ''; }; @@ -70,9 +70,9 @@ let extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra logrotate config options for this path. Refer to - <link xlink:href="https://linux.die.net/man/8/logrotate"/> for details. + <https://linux.die.net/man/8/logrotate> for details. ''; }; @@ -212,11 +212,11 @@ in settings = mkOption { default = { }; - description = '' + description = lib.mdDoc '' logrotate freeform settings: each attribute here will define its own section, ordered by priority, which can either define files to rotate with their settings or settings common to all further files settings. - Refer to <link xlink:href="https://linux.die.net/man/8/logrotate"/> for details. + Refer to <https://linux.die.net/man/8/logrotate> for details. ''; type = types.attrsOf (types.submodule ({ name, ... }: { freeformType = with types; attrsOf (nullOr (oneOf [ int bool str ])); @@ -229,7 +229,7 @@ in global = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether this setting is a global option or not: set to have these settings apply to all files settings with a higher priority. ''; @@ -240,7 +240,7 @@ in defaultText = '' The attrset name if not specified ''; - description = '' + description = lib.mdDoc '' Single or list of files for which rules are defined. The files are quoted with double-quotes in logrotate configuration, so globs and spaces are supported. @@ -251,7 +251,7 @@ in frequency = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' How often to rotate the logs. Defaults to previously set global setting, which itself defauts to weekly. ''; @@ -294,7 +294,7 @@ in checkConfig = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether the config should be checked at build time. Some options are not checkable at build time because of the build sandbox: @@ -304,7 +304,7 @@ in and users are replaced by dummy users), so tests are complemented by a logrotate-checkconf service that is enabled by default. This extra check can be disabled by disabling it at the systemd level with the - <option>services.systemd.services.logrotate-checkconf.enable</option> option. + {option}`services.systemd.services.logrotate-checkconf.enable` option. Conversely there are still things that might make this check fail incorrectly (e.g. a file path where we don't have access to intermediate directories): diff --git a/nixos/modules/services/logging/logstash.nix b/nixos/modules/services/logging/logstash.nix index 5d00feabe1c1d..e9e3ae1f14ce7 100644 --- a/nixos/modules/services/logging/logstash.nix +++ b/nixos/modules/services/logging/logstash.nix @@ -51,27 +51,27 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable logstash."; + description = lib.mdDoc "Enable logstash."; }; package = mkOption { type = types.package; default = pkgs.logstash; defaultText = literalExpression "pkgs.logstash"; - description = "Logstash package to use."; + description = lib.mdDoc "Logstash package to use."; }; plugins = mkOption { type = types.listOf types.path; default = [ ]; example = literalExpression "[ pkgs.logstash-contrib ]"; - description = "The paths to find other logstash plugins in."; + description = lib.mdDoc "The paths to find other logstash plugins in."; }; dataDir = mkOption { type = types.str; default = "/var/lib/logstash"; - description = '' + description = lib.mdDoc '' A path to directory writable by logstash that it uses to store data. Plugins will also have access to this path. ''; @@ -80,31 +80,31 @@ in logLevel = mkOption { type = types.enum [ "debug" "info" "warn" "error" "fatal" ]; default = "warn"; - description = "Logging verbosity level."; + description = lib.mdDoc "Logging verbosity level."; }; filterWorkers = mkOption { type = types.int; default = 1; - description = "The quantity of filter workers to run."; + description = lib.mdDoc "The quantity of filter workers to run."; }; listenAddress = mkOption { type = types.str; default = "127.0.0.1"; - description = "Address on which to start webserver."; + description = lib.mdDoc "Address on which to start webserver."; }; port = mkOption { type = types.str; default = "9292"; - description = "Port on which to start webserver."; + description = lib.mdDoc "Port on which to start webserver."; }; inputConfig = mkOption { type = types.lines; default = "generator { }"; - description = "Logstash input configuration."; + description = lib.mdDoc "Logstash input configuration."; example = literalExpression '' ''' # Read from journal @@ -119,7 +119,7 @@ in filterConfig = mkOption { type = types.lines; default = ""; - description = "logstash filter configuration."; + description = lib.mdDoc "logstash filter configuration."; example = '' if [type] == "syslog" { # Keep only relevant systemd fields @@ -137,7 +137,7 @@ in outputConfig = mkOption { type = types.lines; default = "stdout { codec => rubydebug }"; - description = "Logstash output configuration."; + description = lib.mdDoc "Logstash output configuration."; example = '' redis { host => ["localhost"] data_type => "list" key => "logstash" codec => json } elasticsearch { } @@ -147,7 +147,7 @@ in extraSettings = mkOption { type = types.lines; default = ""; - description = "Extra Logstash settings in YAML format."; + description = lib.mdDoc "Extra Logstash settings in YAML format."; example = '' pipeline: batch: @@ -159,7 +159,7 @@ in extraJvmOptions = mkOption { type = types.lines; default = ""; - description = "Extra JVM options, one per line (jvm.options format)."; + description = lib.mdDoc "Extra JVM options, one per line (jvm.options format)."; example = '' -Xms2g -Xmx2g diff --git a/nixos/modules/services/logging/promtail.nix b/nixos/modules/services/logging/promtail.nix index a34bc07b6ab2f..bdf98322fa4f7 100644 --- a/nixos/modules/services/logging/promtail.nix +++ b/nixos/modules/services/logging/promtail.nix @@ -17,7 +17,7 @@ in { configuration = mkOption { type = (pkgs.formats.json {}).type; - description = '' + description = lib.mdDoc '' Specify the configuration for Promtail in Nix. ''; }; @@ -26,7 +26,7 @@ in { type = listOf str; default = []; example = [ "--server.http-listen-port=3101" ]; - description = '' + description = lib.mdDoc '' Specify a list of additional command line flags, which get escaped and are then passed to Loki. ''; diff --git a/nixos/modules/services/logging/rsyslogd.nix b/nixos/modules/services/logging/rsyslogd.nix index b924d94e0b0de..21d6482d9ffdf 100644 --- a/nixos/modules/services/logging/rsyslogd.nix +++ b/nixos/modules/services/logging/rsyslogd.nix @@ -39,7 +39,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable syslogd. Note that systemd also logs syslog messages, so you normally don't need to run syslogd. ''; @@ -69,8 +69,8 @@ in type = types.listOf types.str; default = [ ]; example = [ "-m 0" ]; - description = '' - Additional parameters passed to <command>rsyslogd</command>. + description = lib.mdDoc '' + Additional parameters passed to {command}`rsyslogd`. ''; }; diff --git a/nixos/modules/services/logging/syslog-ng.nix b/nixos/modules/services/logging/syslog-ng.nix index 1c11de51f2c76..d22acbeaa70c5 100644 --- a/nixos/modules/services/logging/syslog-ng.nix +++ b/nixos/modules/services/logging/syslog-ng.nix @@ -36,7 +36,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the syslog-ng daemon. ''; }; @@ -44,24 +44,24 @@ in { type = types.package; default = pkgs.syslogng; defaultText = literalExpression "pkgs.syslogng"; - description = '' + description = lib.mdDoc '' The package providing syslog-ng binaries. ''; }; extraModulePaths = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' A list of paths that should be included in syslog-ng's - <literal>--module-path</literal> option. They should usually - end in <literal>/lib/syslog-ng</literal> + `--module-path` option. They should usually + end in `/lib/syslog-ng` ''; }; extraConfig = mkOption { type = types.lines; default = ""; - description = '' - Configuration added to the end of <literal>syslog-ng.conf</literal>. + description = lib.mdDoc '' + Configuration added to the end of `syslog-ng.conf`. ''; }; configHeader = mkOption { @@ -70,7 +70,7 @@ in { @version: 3.6 @include "scl.conf" ''; - description = '' + description = lib.mdDoc '' The very first lines of the configuration file. Should usually contain the syslog-ng version header. ''; diff --git a/nixos/modules/services/logging/syslogd.nix b/nixos/modules/services/logging/syslogd.nix index fe0b0490811de..a51bf08e5d255 100644 --- a/nixos/modules/services/logging/syslogd.nix +++ b/nixos/modules/services/logging/syslogd.nix @@ -39,7 +39,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable syslogd. Note that systemd also logs syslog messages, so you normally don't need to run syslogd. ''; @@ -48,7 +48,7 @@ in tty = mkOption { type = types.str; default = "tty10"; - description = '' + description = lib.mdDoc '' The tty device on which syslogd will print important log messages. Leave this option blank to disable tty logging. ''; @@ -67,7 +67,7 @@ in enableNetworkInput = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Accept logging through UDP. Option -r of syslogd(8). ''; }; @@ -86,8 +86,8 @@ in type = types.listOf types.str; default = [ ]; example = [ "-m 0" ]; - description = '' - Additional parameters passed to <command>syslogd</command>. + description = lib.mdDoc '' + Additional parameters passed to {command}`syslogd`. ''; }; diff --git a/nixos/modules/services/logging/vector.nix b/nixos/modules/services/logging/vector.nix index be36b2a41bbaa..93d8550c31b24 100644 --- a/nixos/modules/services/logging/vector.nix +++ b/nixos/modules/services/logging/vector.nix @@ -11,7 +11,7 @@ in journaldAccess = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable Vector to access journald. ''; }; @@ -19,7 +19,7 @@ in settings = mkOption { type = (pkgs.formats.json { }).type; default = { }; - description = '' + description = lib.mdDoc '' Specify the configuration for Vector in Nix. ''; }; diff --git a/nixos/modules/services/mail/clamsmtp.nix b/nixos/modules/services/mail/clamsmtp.nix index fc1267c5d2809..a0de25962845f 100644 --- a/nixos/modules/services/mail/clamsmtp.nix +++ b/nixos/modules/services/mail/clamsmtp.nix @@ -12,17 +12,17 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable clamsmtp."; + description = lib.mdDoc "Whether to enable clamsmtp."; }; instances = mkOption { - description = "Instances of clamsmtp to run."; + description = lib.mdDoc "Instances of clamsmtp to run."; type = types.listOf (types.submodule { options = { action = mkOption { type = types.enum [ "bounce" "drop" "pass" ]; default = "drop"; description = - '' + lib.mdDoc '' Action to take when a virus is detected. Note that viruses often spoof sender addresses, so bouncing is @@ -35,7 +35,7 @@ in default = ""; example = "X-Virus-Scanned: ClamAV using ClamSMTP"; description = - '' + lib.mdDoc '' A header to add to scanned messages. See clamsmtpd.conf(5) for more details. Empty means no header. ''; @@ -45,7 +45,7 @@ in type = types.int; default = 0; description = - '' + lib.mdDoc '' Number of seconds to wait between each NOOP sent to the sending server. 0 to disable. @@ -58,7 +58,7 @@ in type = types.str; example = "127.0.0.1:10025"; description = - '' + lib.mdDoc '' Address to wait for incoming SMTP connections on. See clamsmtpd.conf(5) for more details. ''; @@ -68,7 +68,7 @@ in type = types.bool; default = false; description = - '' + lib.mdDoc '' Whether to quarantine files that contain viruses by leaving them in the temporary directory. ''; @@ -77,13 +77,13 @@ in maxConnections = mkOption { type = types.int; default = 64; - description = "Maximum number of connections to accept at once."; + description = lib.mdDoc "Maximum number of connections to accept at once."; }; outAddress = mkOption { type = types.str; description = - '' + lib.mdDoc '' Address of the SMTP server to send email to once it has been scanned. ''; @@ -93,7 +93,7 @@ in type = types.str; default = "/tmp"; description = - '' + lib.mdDoc '' Temporary directory that needs to be accessible to both clamd and clamsmtpd. ''; @@ -102,20 +102,20 @@ in timeout = mkOption { type = types.int; default = 180; - description = "Time-out for network connections."; + description = lib.mdDoc "Time-out for network connections."; }; transparentProxy = mkOption { type = types.bool; default = false; - description = "Enable clamsmtp's transparent proxy support."; + description = lib.mdDoc "Enable clamsmtp's transparent proxy support."; }; virusAction = mkOption { type = with types; nullOr path; default = null; description = - '' + lib.mdDoc '' Command to run when a virus is found. Please see VIRUS ACTION in clamsmtpd(8) for a discussion of this option and its safe use. ''; @@ -125,7 +125,7 @@ in type = types.bool; default = false; description = - '' + lib.mdDoc '' Send the XCLIENT command to the receiving server, for forwarding client addresses and connection information if the receiving server supports this feature. diff --git a/nixos/modules/services/mail/davmail.nix b/nixos/modules/services/mail/davmail.nix index e9f31e6fb3901..a01d8758c0eb5 100644 --- a/nixos/modules/services/mail/davmail.nix +++ b/nixos/modules/services/mail/davmail.nix @@ -29,17 +29,17 @@ in url = mkOption { type = types.str; - description = "Outlook Web Access URL to access the exchange server, i.e. the base webmail URL."; + description = lib.mdDoc "Outlook Web Access URL to access the exchange server, i.e. the base webmail URL."; example = "https://outlook.office365.com/EWS/Exchange.asmx"; }; config = mkOption { type = configType; default = {}; - description = '' + description = lib.mdDoc '' Davmail configuration. Refer to - <link xlink:href="http://davmail.sourceforge.net/serversetup.html"/> - and <link xlink:href="http://davmail.sourceforge.net/advanced.html"/> + <http://davmail.sourceforge.net/serversetup.html> + and <http://davmail.sourceforge.net/advanced.html> for details on supported values. ''; example = literalExpression '' diff --git a/nixos/modules/services/mail/dkimproxy-out.nix b/nixos/modules/services/mail/dkimproxy-out.nix index f4ac9e47007af..aa465891db212 100644 --- a/nixos/modules/services/mail/dkimproxy-out.nix +++ b/nixos/modules/services/mail/dkimproxy-out.nix @@ -15,7 +15,7 @@ in type = types.bool; default = false; description = - '' + lib.mdDoc '' Whether to enable dkimproxy_out. Note that a key will be auto-generated, and can be found in @@ -26,19 +26,19 @@ in listen = mkOption { type = types.str; example = "127.0.0.1:10027"; - description = "Address:port DKIMproxy should listen on."; + description = lib.mdDoc "Address:port DKIMproxy should listen on."; }; relay = mkOption { type = types.str; example = "127.0.0.1:10028"; - description = "Address:port DKIMproxy should forward mail to."; + description = lib.mdDoc "Address:port DKIMproxy should forward mail to."; }; domains = mkOption { type = with types; listOf str; example = [ "example.org" "example.com" ]; - description = "List of domains DKIMproxy can sign for."; + description = lib.mdDoc "List of domains DKIMproxy can sign for."; }; selector = mkOption { @@ -59,7 +59,7 @@ in type = types.int; default = 2048; description = - '' + lib.mdDoc '' Size of the RSA key to use to sign outgoing emails. Note that the maximum mandatorily verified as per RFC6376 is 2048. ''; diff --git a/nixos/modules/services/mail/dovecot.nix b/nixos/modules/services/mail/dovecot.nix index a8c1f176782c3..4caf8dbfd2b0a 100644 --- a/nixos/modules/services/mail/dovecot.nix +++ b/nixos/modules/services/mail/dovecot.nix @@ -137,25 +137,25 @@ let example = "Spam"; default = name; readOnly = true; - description = "The name of the mailbox."; + description = lib.mdDoc "The name of the mailbox."; }; auto = mkOption { type = types.enum [ "no" "create" "subscribe" ]; default = "no"; example = "subscribe"; - description = "Whether to automatically create or create and subscribe to the mailbox or not."; + description = lib.mdDoc "Whether to automatically create or create and subscribe to the mailbox or not."; }; specialUse = mkOption { type = types.nullOr (types.enum [ "All" "Archive" "Drafts" "Flagged" "Junk" "Sent" "Trash" ]); default = null; example = "Junk"; - description = "Null if no special use flag is set. Other than that every use flag mentioned in the RFC is valid."; + description = lib.mdDoc "Null if no special use flag is set. Other than that every use flag mentioned in the RFC is valid."; }; autoexpunge = mkOption { type = types.nullOr types.str; default = null; example = "60d"; - description = '' + description = lib.mdDoc '' To automatically remove all email from the mailbox which is older than the specified time. ''; @@ -180,26 +180,26 @@ in protocols = mkOption { type = types.listOf types.str; default = []; - description = "Additional listeners to start when Dovecot is enabled."; + description = lib.mdDoc "Additional listeners to start when Dovecot is enabled."; }; user = mkOption { type = types.str; default = "dovecot2"; - description = "Dovecot user name."; + description = lib.mdDoc "Dovecot user name."; }; group = mkOption { type = types.str; default = "dovecot2"; - description = "Dovecot group name."; + description = lib.mdDoc "Dovecot group name."; }; extraConfig = mkOption { type = types.lines; default = ""; example = "mail_debug = yes"; - description = "Additional entries to put verbatim into Dovecot's config file."; + description = lib.mdDoc "Additional entries to put verbatim into Dovecot's config file."; }; mailPlugins = @@ -209,7 +209,7 @@ in enable = mkOption { type = types.listOf types.str; default = []; - description = "mail plugins to enable as a list of strings to append to the ${hint} <literal>$mail_plugins</literal> configuration variable"; + description = lib.mdDoc "mail plugins to enable as a list of strings to append to the ${hint} `$mail_plugins` configuration variable"; }; }; }; @@ -218,20 +218,20 @@ in type = with types; submodule { options = { globally = mkOption { - description = "Additional entries to add to the mail_plugins variable for all protocols"; + description = lib.mdDoc "Additional entries to add to the mail_plugins variable for all protocols"; type = plugins "top-level"; example = { enable = [ "virtual" ]; }; default = { enable = []; }; }; perProtocol = mkOption { - description = "Additional entries to add to the mail_plugins variable, per protocol"; + description = lib.mdDoc "Additional entries to add to the mail_plugins variable, per protocol"; type = attrsOf (plugins "corresponding per-protocol"); default = {}; example = { imap = [ "imap_acl" ]; }; }; }; }; - description = "Additional entries to add to the mail_plugins variable, globally and per protocol"; + description = lib.mdDoc "Additional entries to add to the mail_plugins variable, globally and per protocol"; example = { globally.enable = [ "acl" ]; perProtocol.imap.enable = [ "imap_acl" ]; @@ -242,7 +242,7 @@ in configFile = mkOption { type = types.nullOr types.path; default = null; - description = "Config file used for the whole dovecot configuration."; + description = lib.mdDoc "Config file used for the whole dovecot configuration."; apply = v: if v != null then v else pkgs.writeText "dovecot.conf" dovecotConf; }; @@ -250,7 +250,7 @@ in type = types.str; default = "maildir:/var/spool/mail/%u"; /* Same as inbox, as postfix */ example = "maildir:~/mail:INBOX=/var/spool/mail/%u"; - description = '' + description = lib.mdDoc '' Location that dovecot will use for mail folders. Dovecot mail_location option. ''; }; @@ -258,13 +258,13 @@ in mailUser = mkOption { type = types.nullOr types.str; default = null; - description = "Default user to store mail for virtual users."; + description = lib.mdDoc "Default user to store mail for virtual users."; }; mailGroup = mkOption { type = types.nullOr types.str; default = null; - description = "Default group to store mail for virtual users."; + description = lib.mdDoc "Default group to store mail for virtual users."; }; createMailUser = mkEnableOption ''automatically creating the user @@ -275,7 +275,7 @@ in type = types.listOf types.package; default = []; example = literalExpression "[ pkgs.dovecot_pigeonhole ]"; - description = '' + description = lib.mdDoc '' Symlinks the contents of lib/dovecot of every given package into /etc/dovecot/modules. This will make the given modules available if a dovecot package with the module_dir patch applied is being used. @@ -285,19 +285,19 @@ in sslCACert = mkOption { type = types.nullOr types.str; default = null; - description = "Path to the server's CA certificate key."; + description = lib.mdDoc "Path to the server's CA certificate key."; }; sslServerCert = mkOption { type = types.nullOr types.str; default = null; - description = "Path to the server's public key."; + description = lib.mdDoc "Path to the server's public key."; }; sslServerKey = mkOption { type = types.nullOr types.str; default = null; - description = "Path to the server's private key."; + description = lib.mdDoc "Path to the server's private key."; }; enablePAM = mkEnableOption "creating a own Dovecot PAM service and configure PAM user logins." // { default = true; }; @@ -307,7 +307,7 @@ in sieveScripts = mkOption { type = types.attrsOf types.path; default = {}; - description = "Sieve scripts to be executed. Key is a sequence, e.g. 'before2', 'after' etc."; + description = lib.mdDoc "Sieve scripts to be executed. Key is a sequence, e.g. 'before2', 'after' etc."; }; showPAMFailure = mkEnableOption "showing the PAM failure message on authentication error (useful for OTPW)."; @@ -323,7 +323,7 @@ in Spam = { specialUse = "Junk"; auto = "create"; }; } ''; - description = "Configure mailboxes and auto create or subscribe them."; + description = lib.mdDoc "Configure mailboxes and auto create or subscribe them."; }; enableQuota = mkEnableOption "the dovecot quota service."; @@ -331,7 +331,7 @@ in quotaPort = mkOption { type = types.str; default = "12340"; - description = '' + description = lib.mdDoc '' The Port the dovecot quota service binds to. If using postfix, add check_policy_service inet:localhost:12340 to your smtpd_recipient_restrictions in your postfix config. ''; @@ -340,7 +340,7 @@ in type = types.str; default = "100G"; example = "10G"; - description = "Quota limit for the user in bytes. Supports suffixes b, k, M, G, T and %."; + description = lib.mdDoc "Quota limit for the user in bytes. Supports suffixes b, k, M, G, T and %."; }; }; diff --git a/nixos/modules/services/mail/dspam.nix b/nixos/modules/services/mail/dspam.nix index 766ebc8095a07..4fccd452a4fec 100644 --- a/nixos/modules/services/mail/dspam.nix +++ b/nixos/modules/services/mail/dspam.nix @@ -38,43 +38,43 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the dspam spam filter."; + description = lib.mdDoc "Whether to enable the dspam spam filter."; }; user = mkOption { type = types.str; default = "dspam"; - description = "User for the dspam daemon."; + description = lib.mdDoc "User for the dspam daemon."; }; group = mkOption { type = types.str; default = "dspam"; - description = "Group for the dspam daemon."; + description = lib.mdDoc "Group for the dspam daemon."; }; storageDriver = mkOption { type = types.str; default = "hash"; - description = "Storage driver backend to use for dspam."; + description = lib.mdDoc "Storage driver backend to use for dspam."; }; domainSocket = mkOption { type = types.nullOr types.path; default = defaultSock; - description = "Path to local domain socket which is used for communication with the daemon. Set to null to disable UNIX socket."; + description = lib.mdDoc "Path to local domain socket which is used for communication with the daemon. Set to null to disable UNIX socket."; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Additional dspam configuration."; + description = lib.mdDoc "Additional dspam configuration."; }; maintenanceInterval = mkOption { type = types.nullOr types.str; default = null; - description = "If set, maintenance script will be run at specified (in systemd.timer format) interval"; + description = lib.mdDoc "If set, maintenance script will be run at specified (in systemd.timer format) interval"; }; }; diff --git a/nixos/modules/services/mail/exim.nix b/nixos/modules/services/mail/exim.nix index 7356db2b6a629..cd0da4fc50987 100644 --- a/nixos/modules/services/mail/exim.nix +++ b/nixos/modules/services/mail/exim.nix @@ -17,13 +17,13 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the Exim mail transfer agent."; + description = lib.mdDoc "Whether to enable the Exim mail transfer agent."; }; config = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Verbatim Exim configuration. This should not contain exim_user, exim_group, exim_path, or spool_directory. ''; @@ -32,7 +32,7 @@ in user = mkOption { type = types.str; default = "exim"; - description = '' + description = lib.mdDoc '' User to use when no root privileges are required. In particular, this applies when receiving messages and when doing remote deliveries. (Local deliveries run as various non-root users, @@ -44,7 +44,7 @@ in group = mkOption { type = types.str; default = "exim"; - description = '' + description = lib.mdDoc '' Group to use when no root privileges are required. ''; }; @@ -52,7 +52,7 @@ in spoolDir = mkOption { type = types.path; default = "/var/spool/exim"; - description = '' + description = lib.mdDoc '' Location of the spool directory of exim. ''; }; @@ -61,7 +61,7 @@ in type = types.package; default = pkgs.exim; defaultText = literalExpression "pkgs.exim"; - description = '' + description = lib.mdDoc '' The Exim derivation to use. This can be used to enable features such as LDAP or PAM support. ''; @@ -70,7 +70,7 @@ in queueRunnerInterval = mkOption { type = types.str; default = "5m"; - description = '' + description = lib.mdDoc '' How often to spawn a new queue runner. ''; }; diff --git a/nixos/modules/services/mail/maddy.nix b/nixos/modules/services/mail/maddy.nix index 0b06905ac6f16..2f9abd3ed1f09 100644 --- a/nixos/modules/services/mail/maddy.nix +++ b/nixos/modules/services/mail/maddy.nix @@ -173,7 +173,7 @@ in { default = "localhost"; type = with types; uniq string; example = ''example.com''; - description = '' + description = lib.mdDoc '' Hostname to use. It should be FQDN. ''; }; @@ -182,7 +182,7 @@ in { default = "localhost"; type = with types; uniq string; example = ''mail.example.com''; - description = '' + description = lib.mdDoc '' Primary MX domain to use. It should be FQDN. ''; }; @@ -195,7 +195,7 @@ in { "example.com" "other.example.com" ]; - description = '' + description = lib.mdDoc '' Define list of allowed domains. ''; }; @@ -217,7 +217,7 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open the configured incoming and outgoing mail server ports. ''; }; diff --git a/nixos/modules/services/mail/mailcatcher.nix b/nixos/modules/services/mail/mailcatcher.nix index 84f06ed199dc6..01f3a9776bbbf 100644 --- a/nixos/modules/services/mail/mailcatcher.nix +++ b/nixos/modules/services/mail/mailcatcher.nix @@ -16,32 +16,32 @@ in http.ip = mkOption { type = types.str; default = "127.0.0.1"; - description = "The ip address of the http server."; + description = lib.mdDoc "The ip address of the http server."; }; http.port = mkOption { type = types.port; default = 1080; - description = "The port address of the http server."; + description = lib.mdDoc "The port address of the http server."; }; http.path = mkOption { type = with types; nullOr str; default = null; - description = "Prefix to all HTTP paths."; + description = lib.mdDoc "Prefix to all HTTP paths."; example = "/mailcatcher"; }; smtp.ip = mkOption { type = types.str; default = "127.0.0.1"; - description = "The ip address of the smtp server."; + description = lib.mdDoc "The ip address of the smtp server."; }; smtp.port = mkOption { type = types.port; default = 1025; - description = "The port address of the smtp server."; + description = lib.mdDoc "The port address of the smtp server."; }; }; diff --git a/nixos/modules/services/mail/mailhog.nix b/nixos/modules/services/mail/mailhog.nix index b113f4ff3decd..defc58b80681e 100644 --- a/nixos/modules/services/mail/mailhog.nix +++ b/nixos/modules/services/mail/mailhog.nix @@ -32,31 +32,31 @@ in storage = mkOption { type = types.enum [ "maildir" "memory" ]; default = "memory"; - description = "Store mails on disk or in memory."; + description = lib.mdDoc "Store mails on disk or in memory."; }; apiPort = mkOption { type = types.port; default = 8025; - description = "Port on which the API endpoint will listen."; + description = lib.mdDoc "Port on which the API endpoint will listen."; }; smtpPort = mkOption { type = types.port; default = 1025; - description = "Port on which the SMTP endpoint will listen."; + description = lib.mdDoc "Port on which the SMTP endpoint will listen."; }; uiPort = mkOption { type = types.port; default = 8025; - description = "Port on which the HTTP UI will listen."; + description = lib.mdDoc "Port on which the HTTP UI will listen."; }; extraArgs = mkOption { type = types.listOf types.str; default = []; - description = "List of additional arguments to pass to the MailHog process."; + description = lib.mdDoc "List of additional arguments to pass to the MailHog process."; }; }; }; diff --git a/nixos/modules/services/mail/mailman.nix b/nixos/modules/services/mail/mailman.nix index f08605218a535..eb24f73c1da82 100644 --- a/nixos/modules/services/mail/mailman.nix +++ b/nixos/modules/services/mail/mailman.nix @@ -90,7 +90,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Enable Mailman on this host. Requires an active MTA on the host (e.g. Postfix)."; + description = lib.mdDoc "Enable Mailman on this host. Requires an active MTA on the host (e.g. Postfix)."; }; ldap = { @@ -98,14 +98,14 @@ in { serverUri = mkOption { type = types.str; example = "ldaps://ldap.host"; - description = '' + description = lib.mdDoc '' LDAP host to connect against. ''; }; bindDn = mkOption { type = types.str; example = "cn=root,dc=nixos,dc=org"; - description = '' + description = lib.mdDoc '' Service account to bind against. ''; }; @@ -121,7 +121,7 @@ in { type = types.nullOr types.str; default = null; example = "cn=admin,ou=groups,dc=nixos,dc=org"; - description = '' + description = lib.mdDoc '' Group where a user must be a member of to gain superuser rights. ''; }; @@ -129,14 +129,14 @@ in { query = mkOption { type = types.str; example = "(&(objectClass=inetOrgPerson)(|(uid=%(user)s)(mail=%(user)s)))"; - description = '' + description = lib.mdDoc '' Query to find a user in the LDAP database. ''; }; ou = mkOption { type = types.str; example = "ou=users,dc=nixos,dc=org"; - description = '' + description = lib.mdDoc '' Organizational unit to look up a user. ''; }; @@ -150,21 +150,21 @@ in { ]; default = "posixGroup"; apply = v: "${toUpper (substring 0 1 v)}${substring 1 (stringLength v) v}Type"; - description = '' + description = lib.mdDoc '' Type of group to perform a group search against. ''; }; query = mkOption { type = types.str; example = "(objectClass=groupOfNames)"; - description = '' + description = lib.mdDoc '' Query to find a group associated to a user in the LDAP database. ''; }; ou = mkOption { type = types.str; example = "ou=groups,dc=nixos,dc=org"; - description = '' + description = lib.mdDoc '' Organizational unit to look up a group. ''; }; @@ -173,29 +173,29 @@ in { username = mkOption { default = "uid"; type = types.str; - description = '' - LDAP-attribute that corresponds to the <literal>username</literal>-attribute in mailman. + description = lib.mdDoc '' + LDAP-attribute that corresponds to the `username`-attribute in mailman. ''; }; firstName = mkOption { default = "givenName"; type = types.str; - description = '' - LDAP-attribute that corresponds to the <literal>firstName</literal>-attribute in mailman. + description = lib.mdDoc '' + LDAP-attribute that corresponds to the `firstName`-attribute in mailman. ''; }; lastName = mkOption { default = "sn"; type = types.str; - description = '' - LDAP-attribute that corresponds to the <literal>lastName</literal>-attribute in mailman. + description = lib.mdDoc '' + LDAP-attribute that corresponds to the `lastName`-attribute in mailman. ''; }; email = mkOption { default = "mail"; type = types.str; - description = '' - LDAP-attribute that corresponds to the <literal>email</literal>-attribute in mailman. + description = lib.mdDoc '' + LDAP-attribute that corresponds to the `email`-attribute in mailman. ''; }; }; @@ -205,7 +205,7 @@ in { type = types.bool; default = true; example = false; - description = '' + description = lib.mdDoc '' Enable Postfix integration. Requires an active Postfix installation. If you want to use another MTA, set this option to false and configure @@ -218,7 +218,7 @@ in { siteOwner = mkOption { type = types.str; example = "postmaster@example.org"; - description = '' + description = lib.mdDoc '' Certain messages that must be delivered to a human, but which can't be delivered to a list owner (e.g. a bounce from a list owner), will be sent to this address. It should point to a human. @@ -228,7 +228,7 @@ in { webHosts = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' The list of hostnames and/or IP addresses from which the Mailman Web UI will accept requests. By default, "localhost" and "127.0.0.1" are enabled. All additional names under which your web server accepts @@ -240,7 +240,7 @@ in { webUser = mkOption { type = types.str; default = "mailman-web"; - description = '' + description = lib.mdDoc '' User to run mailman-web as ''; }; @@ -248,7 +248,7 @@ in { webSettings = mkOption { type = types.attrs; default = {}; - description = '' + description = lib.mdDoc '' Overrides for the default mailman-web Django settings. ''; }; @@ -256,8 +256,8 @@ in { restApiPassFile = mkOption { default = null; type = types.nullOr types.str; - description = '' - Path to the file containing the value for <literal>MAILMAN_REST_API_PASS</literal>. + description = lib.mdDoc '' + Path to the file containing the value for `MAILMAN_REST_API_PASS`. ''; }; @@ -266,13 +266,13 @@ in { }; extraPythonPackages = mkOption { - description = "Packages to add to the python environment used by mailman and mailman-web"; + description = lib.mdDoc "Packages to add to the python environment used by mailman and mailman-web"; type = types.listOf types.package; default = []; }; settings = mkOption { - description = "Settings for mailman.cfg"; + description = lib.mdDoc "Settings for mailman.cfg"; type = types.attrsOf (types.attrsOf types.str); default = {}; }; @@ -283,7 +283,7 @@ in { baseUrl = mkOption { type = types.str; default = "http://localhost:18507/archives/"; - description = '' + description = lib.mdDoc '' Where can Mailman connect to Hyperkitty's internal API, preferably on localhost? ''; diff --git a/nixos/modules/services/mail/mlmmj.nix b/nixos/modules/services/mail/mlmmj.nix index fd74f2dc5f07f..0a6c7eceaa6b9 100644 --- a/nixos/modules/services/mail/mlmmj.nix +++ b/nixos/modules/services/mail/mlmmj.nix @@ -56,31 +56,31 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable mlmmj"; + description = lib.mdDoc "Enable mlmmj"; }; user = mkOption { type = types.str; default = "mlmmj"; - description = "mailinglist local user"; + description = lib.mdDoc "mailinglist local user"; }; group = mkOption { type = types.str; default = "mlmmj"; - description = "mailinglist local group"; + description = lib.mdDoc "mailinglist local group"; }; listDomain = mkOption { type = types.str; default = "localhost"; - description = "Set the mailing list domain"; + description = lib.mdDoc "Set the mailing list domain"; }; mailLists = mkOption { type = types.listOf types.str; default = []; - description = "The collection of hosted maillists"; + description = lib.mdDoc "The collection of hosted maillists"; }; maintInterval = mkOption { diff --git a/nixos/modules/services/mail/nullmailer.nix b/nixos/modules/services/mail/nullmailer.nix index f9c345669978a..59329667f7ad0 100644 --- a/nixos/modules/services/mail/nullmailer.nix +++ b/nixos/modules/services/mail/nullmailer.nix @@ -10,13 +10,13 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = "Whether to enable nullmailer daemon."; + description = lib.mdDoc "Whether to enable nullmailer daemon."; }; user = mkOption { type = types.str; default = "nullmailer"; - description = '' + description = lib.mdDoc '' User to use to run nullmailer-send. ''; }; @@ -24,7 +24,7 @@ with lib; group = mkOption { type = types.str; default = "nullmailer"; - description = '' + description = lib.mdDoc '' Group to use to run nullmailer-send. ''; }; @@ -32,7 +32,7 @@ with lib; setSendmail = mkOption { type = types.bool; default = true; - description = "Whether to set the system sendmail to nullmailer's."; + description = lib.mdDoc "Whether to set the system sendmail to nullmailer's."; }; remotesFile = mkOption { @@ -51,7 +51,7 @@ with lib; adminaddr = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' If set, all recipients to users at either "localhost" (the literal string) or the canonical host name (from the me control attribute) are remapped to this address. This is provided to allow local daemons to be able to send email to @@ -64,7 +64,7 @@ with lib; allmailfrom = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' If set, content will override the envelope sender on all messages. ''; }; @@ -72,7 +72,7 @@ with lib; defaultdomain = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The content of this attribute is appended to any host name that does not contain a period (except localhost), including defaulthost and idhost. Defaults to the value of the me attribute, if it exists, @@ -83,7 +83,7 @@ with lib; defaulthost = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The content of this attribute is appended to any address that is missing a host name. Defaults to the value of the me control attribute, if it exists, otherwise the literal name defaulthost. @@ -93,7 +93,7 @@ with lib; doublebounceto = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' If the original sender was empty (the original message was a delivery status or disposition notification), the double bounce is sent to the address in this attribute. @@ -103,7 +103,7 @@ with lib; helohost = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Sets the environment variable $HELOHOST which is used by the SMTP protocol module to set the parameter given to the HELO command. Defaults to the value of the me configuration attribute. @@ -113,7 +113,7 @@ with lib; idhost = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The content of this attribute is used when building the message-id string for the message. Defaults to the canonicalized value of defaulthost. ''; @@ -122,7 +122,7 @@ with lib; maxpause = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The maximum time to pause between successive queue runs, in seconds. Defaults to 24 hours (86400). ''; @@ -131,7 +131,7 @@ with lib; me = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The fully-qualifiled host name of the computer running nullmailer. Defaults to the literal name me. ''; @@ -140,7 +140,7 @@ with lib; pausetime = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The minimum time to pause between successive queue runs when there are messages in the queue, in seconds. Defaults to 1 minute (60). Each time this timeout is reached, the timeout is doubled to a @@ -170,7 +170,7 @@ with lib; sendtimeout = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The time to wait for a remote module listed above to complete sending a message before killing it and trying again, in seconds. Defaults to 1 hour (3600). If this is set to 0, nullmailer-send diff --git a/nixos/modules/services/mail/offlineimap.nix b/nixos/modules/services/mail/offlineimap.nix index 4514775811900..17c09df8f92aa 100644 --- a/nixos/modules/services/mail/offlineimap.nix +++ b/nixos/modules/services/mail/offlineimap.nix @@ -26,26 +26,26 @@ in { type = types.package; default = pkgs.offlineimap; defaultText = literalExpression "pkgs.offlineimap"; - description = "Offlineimap derivation to use."; + description = lib.mdDoc "Offlineimap derivation to use."; }; path = mkOption { type = types.listOf types.path; default = []; example = literalExpression "[ pkgs.pass pkgs.bash pkgs.notmuch ]"; - description = "List of derivations to put in Offlineimap's path."; + description = lib.mdDoc "List of derivations to put in Offlineimap's path."; }; onCalendar = mkOption { type = types.str; default = "*:0/3"; # every 3 minutes - description = "How often is offlineimap started. Default is '*:0/3' meaning every 3 minutes. See systemd.time(7) for more information about the format."; + description = lib.mdDoc "How often is offlineimap started. Default is '*:0/3' meaning every 3 minutes. See systemd.time(7) for more information about the format."; }; timeoutStartSec = mkOption { type = types.str; default = "120sec"; # Kill if still alive after 2 minutes - description = "How long waiting for offlineimap before killing it. Default is '120sec' meaning every 2 minutes. See systemd.time(7) for more information about the format."; + description = lib.mdDoc "How long waiting for offlineimap before killing it. Default is '120sec' meaning every 2 minutes. See systemd.time(7) for more information about the format."; }; }; config = mkIf (cfg.enable || cfg.install) { diff --git a/nixos/modules/services/mail/opendkim.nix b/nixos/modules/services/mail/opendkim.nix index f1ffc5d3aeef2..a377fccc7bd28 100644 --- a/nixos/modules/services/mail/opendkim.nix +++ b/nixos/modules/services/mail/opendkim.nix @@ -31,25 +31,25 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the OpenDKIM sender authentication system."; + description = lib.mdDoc "Whether to enable the OpenDKIM sender authentication system."; }; socket = mkOption { type = types.str; default = defaultSock; - description = "Socket which is used for communication with OpenDKIM."; + description = lib.mdDoc "Socket which is used for communication with OpenDKIM."; }; user = mkOption { type = types.str; default = "opendkim"; - description = "User for the daemon."; + description = lib.mdDoc "User for the daemon."; }; group = mkOption { type = types.str; default = "opendkim"; - description = "Group for the daemon."; + description = lib.mdDoc "Group for the daemon."; }; domains = mkOption { @@ -57,15 +57,15 @@ in { default = "csl:${config.networking.hostName}"; defaultText = literalExpression ''"csl:''${config.networking.hostName}"''; example = "csl:example.com,mydomain.net"; - description = '' - Local domains set (see <literal>opendkim(8)</literal> for more information on datasets). + description = lib.mdDoc '' + Local domains set (see `opendkim(8)` for more information on datasets). Messages from them are signed, not verified. ''; }; keyPath = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' The path that opendkim should put its generated private keys into. The DNS settings will be found in this directory with the name selector.txt. ''; @@ -74,13 +74,13 @@ in { selector = mkOption { type = types.str; - description = "Selector to use when signing."; + description = lib.mdDoc "Selector to use when signing."; }; configFile = mkOption { type = types.nullOr types.path; default = null; - description = "Additional opendkim configuration."; + description = lib.mdDoc "Additional opendkim configuration."; }; }; diff --git a/nixos/modules/services/mail/opensmtpd.nix b/nixos/modules/services/mail/opensmtpd.nix index e7632be280458..6ad3386d2d4eb 100644 --- a/nixos/modules/services/mail/opensmtpd.nix +++ b/nixos/modules/services/mail/opensmtpd.nix @@ -28,27 +28,27 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the OpenSMTPD server."; + description = lib.mdDoc "Whether to enable the OpenSMTPD server."; }; package = mkOption { type = types.package; default = pkgs.opensmtpd; defaultText = literalExpression "pkgs.opensmtpd"; - description = "The OpenSMTPD package to use."; + description = lib.mdDoc "The OpenSMTPD package to use."; }; setSendmail = mkOption { type = types.bool; default = true; - description = "Whether to set the system sendmail to OpenSMTPD's."; + description = lib.mdDoc "Whether to set the system sendmail to OpenSMTPD's."; }; extraServerArgs = mkOption { type = types.listOf types.str; default = []; example = [ "-v" "-P mta" ]; - description = '' + description = lib.mdDoc '' Extra command line arguments provided when the smtpd process is started. ''; @@ -60,7 +60,7 @@ in { listen on lo accept for any deliver to lmtp localhost:24 ''; - description = '' + description = lib.mdDoc '' The contents of the smtpd.conf configuration file. See the OpenSMTPD documentation for syntax information. ''; @@ -69,7 +69,7 @@ in { procPackages = mkOption { type = types.listOf types.package; default = []; - description = '' + description = lib.mdDoc '' Packages to search for filters, tables, queues, and schedulers. Add OpenSMTPD-extras here if you want to use the filters, etc. from diff --git a/nixos/modules/services/mail/pfix-srsd.nix b/nixos/modules/services/mail/pfix-srsd.nix index e3dbf2a014f06..d46447a480a5c 100644 --- a/nixos/modules/services/mail/pfix-srsd.nix +++ b/nixos/modules/services/mail/pfix-srsd.nix @@ -12,11 +12,11 @@ with lib; enable = mkOption { default = false; type = types.bool; - description = "Whether to run the postfix sender rewriting scheme daemon."; + description = lib.mdDoc "Whether to run the postfix sender rewriting scheme daemon."; }; domain = mkOption { - description = "The domain for which to enable srs"; + description = lib.mdDoc "The domain for which to enable srs"; type = types.str; example = "example.com"; }; diff --git a/nixos/modules/services/mail/postfix.nix b/nixos/modules/services/mail/postfix.nix index de00c87b95a5b..2fc79949fbc93 100644 --- a/nixos/modules/services/mail/postfix.nix +++ b/nixos/modules/services/mail/postfix.nix @@ -45,7 +45,7 @@ let type = types.str; default = name; example = "smtp"; - description = '' + description = lib.mdDoc '' The name of the service to run. Defaults to the attribute set key. ''; }; @@ -54,16 +54,16 @@ let type = types.enum [ "inet" "unix" "unix-dgram" "fifo" "pass" ]; default = "unix"; example = "inet"; - description = "The type of the service"; + description = lib.mdDoc "The type of the service"; }; private = mkOption { type = types.bool; example = false; - description = '' + description = lib.mdDoc '' Whether the service's sockets and storage directory is restricted to - be only available via the mail system. If <literal>null</literal> is - given it uses the postfix default <literal>true</literal>. + be only available via the mail system. If `null` is + given it uses the postfix default `true`. ''; }; @@ -76,19 +76,19 @@ let chroot = mkOption { type = types.bool; example = true; - description = '' + description = lib.mdDoc '' Whether the service is chrooted to have only access to the - <option>services.postfix.queueDir</option> and the closure of - store paths specified by the <option>program</option> option. + {option}`services.postfix.queueDir` and the closure of + store paths specified by the {option}`program` option. ''; }; wakeup = mkOption { type = types.int; example = 60; - description = '' + description = lib.mdDoc '' Automatically wake up the service after the specified number of - seconds. If <literal>0</literal> is given, never wake the service + seconds. If `0` is given, never wake the service up. ''; }; @@ -96,22 +96,22 @@ let wakeupUnusedComponent = mkOption { type = types.bool; example = false; - description = '' - If set to <literal>false</literal> the component will only be woken + description = lib.mdDoc '' + If set to `false` the component will only be woken up if it is used. This is equivalent to postfix' notion of adding a question mark behind the wakeup time in - <filename>master.cf</filename> + {file}`master.cf` ''; }; maxproc = mkOption { type = types.int; example = 1; - description = '' + description = lib.mdDoc '' The maximum number of processes to spawn for this service. If the - value is <literal>0</literal> it doesn't have any limit. If - <literal>null</literal> is given it uses the postfix default of - <literal>100</literal>. + value is `0` it doesn't have any limit. If + `null` is given it uses the postfix default of + `100`. ''; }; @@ -119,9 +119,9 @@ let type = types.str; default = name; example = "smtpd"; - description = '' + description = lib.mdDoc '' A program name specifying a Postfix service/daemon process. - By default it's the attribute <option>name</option>. + By default it's the attribute {option}`name`. ''; }; @@ -129,8 +129,8 @@ let type = types.listOf types.str; default = []; example = [ "-o" "smtp_helo_timeout=5" ]; - description = '' - Arguments to pass to the <option>command</option>. There is no shell + description = lib.mdDoc '' + Arguments to pass to the {option}`command`. There is no shell processing involved and shell syntax is passed verbatim to the process. ''; @@ -221,13 +221,13 @@ let type = types.str; default = "/^.*/"; example = "/^X-Mailer:/"; - description = "A regexp pattern matching the header"; + description = lib.mdDoc "A regexp pattern matching the header"; }; action = mkOption { type = types.str; default = "DUNNO"; example = "BCC mail@example.com"; - description = "The action to be executed when the pattern is matched"; + description = lib.mdDoc "The action to be executed when the pattern is matched"; }; }; }; @@ -267,25 +267,25 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to run the Postfix mail server."; + description = lib.mdDoc "Whether to run the Postfix mail server."; }; enableSmtp = mkOption { type = types.bool; default = true; - description = "Whether to enable smtp in master.cf."; + description = lib.mdDoc "Whether to enable smtp in master.cf."; }; enableSubmission = mkOption { type = types.bool; default = false; - description = "Whether to enable smtp submission."; + description = lib.mdDoc "Whether to enable smtp submission."; }; enableSubmissions = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable smtp submission via smtps. According to RFC 8314 this should be preferred @@ -308,7 +308,7 @@ in smtpd_client_restrictions = "permit_sasl_authenticated,reject"; milter_macro_daemon_name = "ORIGINATING"; }; - description = "Options for the submission config in master.cf"; + description = lib.mdDoc "Options for the submission config in master.cf"; }; submissionsOptions = mkOption { @@ -324,7 +324,7 @@ in smtpd_client_restrictions = "permit_sasl_authenticated,reject"; milter_macro_daemon_name = "ORIGINATING"; }; - description = '' + description = lib.mdDoc '' Options for the submission config via smtps in master.cf. smtpd_tls_security_level will be set to encrypt, if it is missing @@ -337,19 +337,19 @@ in setSendmail = mkOption { type = types.bool; default = true; - description = "Whether to set the system sendmail to postfix's."; + description = lib.mdDoc "Whether to set the system sendmail to postfix's."; }; user = mkOption { type = types.str; default = "postfix"; - description = "What to call the Postfix user (must be used only for postfix)."; + description = lib.mdDoc "What to call the Postfix user (must be used only for postfix)."; }; group = mkOption { type = types.str; default = "postfix"; - description = "What to call the Postfix group (must be used only for postfix)."; + description = lib.mdDoc "What to call the Postfix group (must be used only for postfix)."; }; setgidGroup = mkOption { @@ -480,12 +480,12 @@ in type = with types; enum [ "hash" "regexp" "pcre" ]; default = "hash"; example = "regexp"; - description = "The format the alias map should have. Use regexp if you want to use regular expressions."; + description = lib.mdDoc "The format the alias map should have. Use regexp if you want to use regular expressions."; }; config = mkOption { type = with types; attrsOf (oneOf [ bool str (listOf str) ]); - description = '' + description = lib.mdDoc '' The main.cf configuration file as key value set. ''; example = { @@ -506,7 +506,7 @@ in type = types.str; default = "${pkgs.cacert}/etc/ssl/certs/ca-bundle.crt"; defaultText = literalExpression ''"''${pkgs.cacert}/etc/ssl/certs/ca-bundle.crt"''; - description = '' + description = lib.mdDoc '' File containing trusted certification authorities (CA) to verify certificates of mailservers contacted for mail delivery. This basically sets smtp_tls_CAfile and enables opportunistic tls. Defaults to NixOS trusted certification authorities. ''; }; @@ -514,13 +514,13 @@ in sslCert = mkOption { type = types.str; default = ""; - description = "SSL certificate to use."; + description = lib.mdDoc "SSL certificate to use."; }; sslKey = mkOption { type = types.str; default = ""; - description = "SSL key to use."; + description = lib.mdDoc "SSL key to use."; }; recipientDelimiter = mkOption { @@ -552,18 +552,18 @@ in virtualMapType = mkOption { type = types.enum ["hash" "regexp" "pcre"]; default = "hash"; - description = '' - What type of virtual alias map file to use. Use <literal>"regexp"</literal> for regular expressions. + description = lib.mdDoc '' + What type of virtual alias map file to use. Use `"regexp"` for regular expressions. ''; }; localRecipients = mkOption { type = with types; nullOr (listOf str); default = null; - description = '' + description = lib.mdDoc '' List of accepted local users. Specify a bare username, an - <literal>"@domain.tld"</literal> wild-card, or a complete - <literal>"user@domain.tld"</literal> address. If set, these names end + `"@domain.tld"` wild-card, or a complete + `"user@domain.tld"` address. If set, these names end up in the local recipient map -- see the local(8) man-page -- and effectively replace the system user database lookup that's otherwise used by default. @@ -581,13 +581,13 @@ in dnsBlacklists = mkOption { default = []; type = with types; listOf str; - description = "dns blacklist servers to use with smtpd_client_restrictions"; + description = lib.mdDoc "dns blacklist servers to use with smtpd_client_restrictions"; }; dnsBlacklistOverrides = mkOption { default = ""; type = types.lines; - description = "contents of check_client_access for overriding dnsBlacklists"; + description = lib.mdDoc "contents of check_client_access for overriding dnsBlacklists"; }; masterConfig = mkOption { @@ -599,10 +599,10 @@ in args = [ "-o" "smtpd_tls_security_level=encrypt" ]; }; }; - description = '' + description = lib.mdDoc '' An attribute set of service options, which correspond to the service definitions usually done within the Postfix - <filename>master.cf</filename> file. + {file}`master.cf` file. ''; }; @@ -610,46 +610,46 @@ in type = types.lines; default = ""; example = "submission inet n - n - - smtpd"; - description = "Extra lines to append to the generated master.cf file."; + description = lib.mdDoc "Extra lines to append to the generated master.cf file."; }; enableHeaderChecks = mkOption { type = types.bool; default = false; example = true; - description = "Whether to enable postfix header checks"; + description = lib.mdDoc "Whether to enable postfix header checks"; }; headerChecks = mkOption { type = types.listOf (types.submodule headerCheckOptions); default = []; example = [ { pattern = "/^X-Spam-Flag:/"; action = "REDIRECT spam@example.com"; } ]; - description = "Postfix header checks."; + description = lib.mdDoc "Postfix header checks."; }; extraHeaderChecks = mkOption { type = types.lines; default = ""; example = "/^X-Spam-Flag:/ REDIRECT spam@example.com"; - description = "Extra lines to /etc/postfix/header_checks file."; + description = lib.mdDoc "Extra lines to /etc/postfix/header_checks file."; }; aliasFiles = mkOption { type = types.attrsOf types.path; default = {}; - description = "Aliases' tables to be compiled and placed into /var/lib/postfix/conf."; + description = lib.mdDoc "Aliases' tables to be compiled and placed into /var/lib/postfix/conf."; }; mapFiles = mkOption { type = types.attrsOf types.path; default = {}; - description = "Maps to be compiled and placed into /var/lib/postfix/conf."; + description = lib.mdDoc "Maps to be compiled and placed into /var/lib/postfix/conf."; }; useSrs = mkOption { type = types.bool; default = false; - description = "Whether to enable sender rewriting scheme"; + description = lib.mdDoc "Whether to enable sender rewriting scheme"; }; }; diff --git a/nixos/modules/services/mail/postfixadmin.nix b/nixos/modules/services/mail/postfixadmin.nix index 8adae3c1a0138..27b5c60ec072f 100644 --- a/nixos/modules/services/mail/postfixadmin.nix +++ b/nixos/modules/services/mail/postfixadmin.nix @@ -25,13 +25,13 @@ in hostName = mkOption { type = types.str; example = "postfixadmin.example.com"; - description = "Hostname to use for the nginx vhost"; + description = lib.mdDoc "Hostname to use for the nginx vhost"; }; adminEmail = mkOption { type = types.str; example = "postmaster@example.com"; - description = '' + description = lib.mdDoc '' Defines the Site Admin's email address. This will be used to send emails from to create mailboxes and from Send Email / Broadcast message pages. @@ -40,9 +40,9 @@ in setupPasswordFile = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' Password file for the admin. - Generate with <literal>php -r "echo password_hash('some password here', PASSWORD_DEFAULT);"</literal> + Generate with `php -r "echo password_hash('some password here', PASSWORD_DEFAULT);"` ''; }; @@ -50,36 +50,36 @@ in username = mkOption { type = types.str; default = "postfixadmin"; - description = '' + description = lib.mdDoc '' Username for the postgresql connection. - If <literal>database.host</literal> is set to <literal>localhost</literal>, a unix user and group of the same name will be created as well. + If `database.host` is set to `localhost`, a unix user and group of the same name will be created as well. ''; }; host = mkOption { type = types.str; default = "localhost"; - description = '' + description = lib.mdDoc '' Host of the postgresql server. If this is not set to - <literal>localhost</literal>, you have to create the + `localhost`, you have to create the postgresql user and database yourself, with appropriate permissions. ''; }; passwordFile = mkOption { type = types.path; - description = "Password file for the postgresql connection. Must be readable by user <literal>nginx</literal>."; + description = lib.mdDoc "Password file for the postgresql connection. Must be readable by user `nginx`."; }; dbname = mkOption { type = types.str; default = "postfixadmin"; - description = "Name of the postgresql database"; + description = lib.mdDoc "Name of the postgresql database"; }; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Extra configuration for the postfixadmin instance, see postfixadmin's config.inc.php for available options."; + description = lib.mdDoc "Extra configuration for the postfixadmin instance, see postfixadmin's config.inc.php for available options."; }; }; diff --git a/nixos/modules/services/mail/postgrey.nix b/nixos/modules/services/mail/postgrey.nix index 7c206e3725e6b..301bc69e1cac3 100644 --- a/nixos/modules/services/mail/postgrey.nix +++ b/nixos/modules/services/mail/postgrey.nix @@ -59,7 +59,7 @@ in { enable = mkOption { type = bool; default = false; - description = "Whether to run the Postgrey daemon"; + description = lib.mdDoc "Whether to run the Postgrey daemon"; }; socket = mkOption { type = socket; @@ -71,73 +71,73 @@ in { addr = "127.0.0.1"; port = 10030; }; - description = "Socket to bind to"; + description = lib.mdDoc "Socket to bind to"; }; greylistText = mkOption { type = str; default = "Greylisted for %%s seconds"; - description = "Response status text for greylisted messages; use %%s for seconds left until greylisting is over and %%r for mail domain of recipient"; + description = lib.mdDoc "Response status text for greylisted messages; use %%s for seconds left until greylisting is over and %%r for mail domain of recipient"; }; greylistAction = mkOption { type = str; default = "DEFER_IF_PERMIT"; - description = "Response status for greylisted messages (see access(5))"; + description = lib.mdDoc "Response status for greylisted messages (see access(5))"; }; greylistHeader = mkOption { type = str; default = "X-Greylist: delayed %%t seconds by postgrey-%%v at %%h; %%d"; - description = "Prepend header to greylisted mails; use %%t for seconds delayed due to greylisting, %%v for the version of postgrey, %%d for the date, and %%h for the host"; + description = lib.mdDoc "Prepend header to greylisted mails; use %%t for seconds delayed due to greylisting, %%v for the version of postgrey, %%d for the date, and %%h for the host"; }; delay = mkOption { type = natural; default = 300; - description = "Greylist for N seconds"; + description = lib.mdDoc "Greylist for N seconds"; }; maxAge = mkOption { type = natural; default = 35; - description = "Delete entries from whitelist if they haven't been seen for N days"; + description = lib.mdDoc "Delete entries from whitelist if they haven't been seen for N days"; }; retryWindow = mkOption { type = either str natural; default = 2; example = "12h"; - description = "Allow N days for the first retry. Use string with appended 'h' to specify time in hours"; + description = lib.mdDoc "Allow N days for the first retry. Use string with appended 'h' to specify time in hours"; }; lookupBySubnet = mkOption { type = bool; default = true; - description = "Strip the last N bits from IP addresses, determined by IPv4CIDR and IPv6CIDR"; + description = lib.mdDoc "Strip the last N bits from IP addresses, determined by IPv4CIDR and IPv6CIDR"; }; IPv4CIDR = mkOption { type = natural; default = 24; - description = "Strip N bits from IPv4 addresses if lookupBySubnet is true"; + description = lib.mdDoc "Strip N bits from IPv4 addresses if lookupBySubnet is true"; }; IPv6CIDR = mkOption { type = natural; default = 64; - description = "Strip N bits from IPv6 addresses if lookupBySubnet is true"; + description = lib.mdDoc "Strip N bits from IPv6 addresses if lookupBySubnet is true"; }; privacy = mkOption { type = bool; default = true; - description = "Store data using one-way hash functions (SHA1)"; + description = lib.mdDoc "Store data using one-way hash functions (SHA1)"; }; autoWhitelist = mkOption { type = nullOr natural'; default = 5; - description = "Whitelist clients after successful delivery of N messages"; + description = lib.mdDoc "Whitelist clients after successful delivery of N messages"; }; whitelistClients = mkOption { type = listOf path; default = []; - description = "Client address whitelist files (see postgrey(8))"; + description = lib.mdDoc "Client address whitelist files (see postgrey(8))"; }; whitelistRecipients = mkOption { type = listOf path; default = []; - description = "Recipient address whitelist files (see postgrey(8))"; + description = lib.mdDoc "Recipient address whitelist files (see postgrey(8))"; }; }; }; diff --git a/nixos/modules/services/mail/postsrsd.nix b/nixos/modules/services/mail/postsrsd.nix index 2ebc675ab10af..41301c8697d7c 100644 --- a/nixos/modules/services/mail/postsrsd.nix +++ b/nixos/modules/services/mail/postsrsd.nix @@ -17,24 +17,24 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the postsrsd SRS server for Postfix."; + description = lib.mdDoc "Whether to enable the postsrsd SRS server for Postfix."; }; secretsFile = mkOption { type = types.path; default = "/var/lib/postsrsd/postsrsd.secret"; - description = "Secret keys used for signing and verification"; + description = lib.mdDoc "Secret keys used for signing and verification"; }; domain = mkOption { type = types.str; - description = "Domain name for rewrite"; + description = lib.mdDoc "Domain name for rewrite"; }; separator = mkOption { type = types.enum ["-" "=" "+"]; default = "="; - description = "First separator character in generated addresses"; + description = lib.mdDoc "First separator character in generated addresses"; }; # bindAddress = mkOption { # uncomment once 1.5 is released @@ -46,37 +46,37 @@ in { forwardPort = mkOption { type = types.int; default = 10001; - description = "Port for the forward SRS lookup"; + description = lib.mdDoc "Port for the forward SRS lookup"; }; reversePort = mkOption { type = types.int; default = 10002; - description = "Port for the reverse SRS lookup"; + description = lib.mdDoc "Port for the reverse SRS lookup"; }; timeout = mkOption { type = types.int; default = 1800; - description = "Timeout for idle client connections in seconds"; + description = lib.mdDoc "Timeout for idle client connections in seconds"; }; excludeDomains = mkOption { type = types.listOf types.str; default = []; - description = "Origin domains to exclude from rewriting in addition to primary domain"; + description = lib.mdDoc "Origin domains to exclude from rewriting in addition to primary domain"; }; user = mkOption { type = types.str; default = "postsrsd"; - description = "User for the daemon"; + description = lib.mdDoc "User for the daemon"; }; group = mkOption { type = types.str; default = "postsrsd"; - description = "Group for the daemon"; + description = lib.mdDoc "Group for the daemon"; }; }; diff --git a/nixos/modules/services/mail/public-inbox.nix b/nixos/modules/services/mail/public-inbox.nix index 0f9bc4ef226d2..bb835881ba0a0 100644 --- a/nixos/modules/services/mail/public-inbox.nix +++ b/nixos/modules/services/mail/public-inbox.nix @@ -150,19 +150,19 @@ in type = types.package; default = pkgs.public-inbox; defaultText = literalExpression "pkgs.public-inbox"; - description = "public-inbox package to use."; + description = lib.mdDoc "public-inbox package to use."; }; path = mkOption { type = with types; listOf package; default = []; example = literalExpression "with pkgs; [ spamassassin ]"; - description = '' + description = lib.mdDoc '' Additional packages to place in the path of public-inbox-mda, public-inbox-watch, etc. ''; }; inboxes = mkOption { - description = '' + description = lib.mdDoc '' Inboxes to configure, where attribute names are inbox names. ''; default = {}; @@ -171,29 +171,29 @@ in options.inboxdir = mkOption { type = types.str; default = "${stateDir}/inboxes/${name}"; - description = "The absolute path to the directory which hosts the public-inbox."; + description = lib.mdDoc "The absolute path to the directory which hosts the public-inbox."; }; options.address = mkOption { type = with types; listOf str; example = "example-discuss@example.org"; - description = "The email addresses of the public-inbox."; + description = lib.mdDoc "The email addresses of the public-inbox."; }; options.url = mkOption { type = with types; nullOr str; default = null; example = "https://example.org/lists/example-discuss"; - description = "URL where this inbox can be accessed over HTTP."; + description = lib.mdDoc "URL where this inbox can be accessed over HTTP."; }; options.description = mkOption { type = types.str; example = "user/dev discussion of public-inbox itself"; - description = "User-visible description for the repository."; + description = lib.mdDoc "User-visible description for the repository."; apply = pkgs.writeText "public-inbox-description-${name}"; }; options.newsgroup = mkOption { type = with types; nullOr str; default = null; - description = "NNTP group name for the inbox."; + description = lib.mdDoc "NNTP group name for the inbox."; }; options.watch = mkOption { type = with types; listOf str; @@ -215,7 +215,7 @@ in description = "list of coderepo names"; }; default = []; - description = "Nicknames of a 'coderepo' section associated with the inbox."; + description = lib.mdDoc "Nicknames of a 'coderepo' section associated with the inbox."; }; })); }; @@ -228,7 +228,7 @@ in type = with types; listOf str; default = [ "/" ]; example = [ "/lists/archives" ]; - description = '' + description = lib.mdDoc '' Root paths or URLs that public-inbox will be served on. If domain parts are present, only requests to those domains will be accepted. @@ -264,35 +264,35 @@ in type = with types; nullOr path; default = "${cfg.package.sa_config}/user/.spamassassin/user_prefs"; defaultText = literalExpression "\${cfg.package.sa_config}/user/.spamassassin/user_prefs"; - description = "SpamAssassin configuration specific to public-inbox."; + description = lib.mdDoc "SpamAssassin configuration specific to public-inbox."; }; settings = mkOption { - description = '' - Settings for the <link xlink:href="https://public-inbox.org/public-inbox-config.html">public-inbox config file</link>. + description = lib.mdDoc '' + Settings for the [public-inbox config file](https://public-inbox.org/public-inbox-config.html). ''; default = {}; type = types.submodule { freeformType = gitIni.type; options.publicinbox = mkOption { default = {}; - description = "public inboxes"; + description = lib.mdDoc "public inboxes"; type = types.submodule { freeformType = with types; /*inbox name*/attrsOf (/*inbox option name*/attrsOf /*inbox option value*/iniAtom); options.css = mkOption { type = with types; listOf str; default = []; - description = "The local path name of a CSS file for the PSGI web interface."; + description = lib.mdDoc "The local path name of a CSS file for the PSGI web interface."; }; options.nntpserver = mkOption { type = with types; listOf str; default = []; example = [ "nntp://news.public-inbox.org" "nntps://news.public-inbox.org" ]; - description = "NNTP URLs to this public-inbox instance"; + description = lib.mdDoc "NNTP URLs to this public-inbox instance"; }; options.wwwlisting = mkOption { type = with types; enum [ "all" "404" "match=domain" ]; default = "404"; - description = '' + description = lib.mdDoc '' Controls which lists (if any) are listed for when the root public-inbox URL is accessed over HTTP. ''; @@ -319,23 +319,23 @@ in type = with types; nullOr str; default = null; example = "maildir:/path/to/spam"; - description = '' + description = lib.mdDoc '' If set, mail in this maildir will be trained as spam and deleted from all watched inboxes ''; }; options.coderepo = mkOption { default = {}; - description = "code repositories"; + description = lib.mdDoc "code repositories"; type = types.attrsOf (types.submodule { freeformType = types.attrsOf iniAtom; options.cgitUrl = mkOption { type = types.str; - description = "URL of a cgit instance"; + description = lib.mdDoc "URL of a cgit instance"; }; options.dir = mkOption { type = types.str; - description = "Path to a git repository"; + description = lib.mdDoc "Path to a git repository"; }; }); }; diff --git a/nixos/modules/services/mail/roundcube.nix b/nixos/modules/services/mail/roundcube.nix index 1dd393da88221..3b6c06d19e862 100644 --- a/nixos/modules/services/mail/roundcube.nix +++ b/nixos/modules/services/mail/roundcube.nix @@ -26,7 +26,7 @@ in hostName = mkOption { type = types.str; example = "webmail.example.com"; - description = "Hostname to use for the nginx vhost"; + description = lib.mdDoc "Hostname to use for the nginx vhost"; }; package = mkOption { @@ -38,7 +38,7 @@ in roundcube.withPlugins (plugins: [ plugins.persistent_login ]) ''; - description = '' + description = lib.mdDoc '' The package which contains roundcube's sources. Can be overriden to create an environment which contains roundcube and third-party plugins. ''; @@ -48,41 +48,41 @@ in username = mkOption { type = types.str; default = "roundcube"; - description = '' + description = lib.mdDoc '' Username for the postgresql connection. - If <literal>database.host</literal> is set to <literal>localhost</literal>, a unix user and group of the same name will be created as well. + If `database.host` is set to `localhost`, a unix user and group of the same name will be created as well. ''; }; host = mkOption { type = types.str; default = "localhost"; - description = '' + description = lib.mdDoc '' Host of the postgresql server. If this is not set to - <literal>localhost</literal>, you have to create the + `localhost`, you have to create the postgresql user and database yourself, with appropriate permissions. ''; }; password = mkOption { type = types.str; - description = "Password for the postgresql connection. Do not use: the password will be stored world readable in the store; use <literal>passwordFile</literal> instead."; + description = lib.mdDoc "Password for the postgresql connection. Do not use: the password will be stored world readable in the store; use `passwordFile` instead."; default = ""; }; passwordFile = mkOption { type = types.str; - description = "Password file for the postgresql connection. Must be readable by user <literal>nginx</literal>. Ignored if <literal>database.host</literal> is set to <literal>localhost</literal>, as peer authentication will be used."; + description = lib.mdDoc "Password file for the postgresql connection. Must be readable by user `nginx`. Ignored if `database.host` is set to `localhost`, as peer authentication will be used."; }; dbname = mkOption { type = types.str; default = "roundcube"; - description = "Name of the postgresql database"; + description = lib.mdDoc "Name of the postgresql database"; }; }; plugins = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' List of roundcube plugins to enable. Currently, only those directly shipped with Roundcube are supported. ''; }; @@ -91,7 +91,7 @@ in type = types.listOf types.package; default = []; example = literalExpression "with pkgs.aspellDicts; [ en fr de ]"; - description = '' + description = lib.mdDoc '' List of aspell dictionnaries for spell checking. If empty, spell checking is disabled. ''; }; @@ -111,7 +111,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = "Extra configuration for roundcube webmail instance"; + description = lib.mdDoc "Extra configuration for roundcube webmail instance"; }; }; diff --git a/nixos/modules/services/mail/rspamd.nix b/nixos/modules/services/mail/rspamd.nix index a570e137a55a7..ed4d7a504412d 100644 --- a/nixos/modules/services/mail/rspamd.nix +++ b/nixos/modules/services/mail/rspamd.nix @@ -52,21 +52,21 @@ let enable = mkOption { type = types.nullOr types.bool; default = null; - description = "Whether to run the rspamd worker."; + description = lib.mdDoc "Whether to run the rspamd worker."; }; name = mkOption { type = types.nullOr types.str; default = name; - description = "Name of the worker"; + description = lib.mdDoc "Name of the worker"; }; type = mkOption { type = types.nullOr (types.enum [ "normal" "controller" "fuzzy" "rspamd_proxy" "lua" "proxy" ]); - description = '' - The type of this worker. The type <literal>proxy</literal> is + description = lib.mdDoc '' + The type of this worker. The type `proxy` is deprecated and only kept for backwards compatibility and should be - replaced with <literal>rspamd_proxy</literal>. + replaced with `rspamd_proxy`. ''; apply = let from = "services.rspamd.workers.\"${name}\".type"; @@ -77,7 +77,7 @@ let bindSockets = mkOption { type = types.listOf (types.either types.str (types.submodule bindSocketOpts)); default = []; - description = '' + description = lib.mdDoc '' List of sockets to listen, in format acceptable by rspamd ''; example = [{ @@ -94,21 +94,21 @@ let count = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Number of worker instances to run ''; }; includes = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' List of files to include in configuration ''; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Additional entries to put verbatim into worker section of rspamd config file."; + description = lib.mdDoc "Additional entries to put verbatim into worker section of rspamd config file."; }; }; config = mkIf (name == "normal" || name == "controller" || name == "fuzzy" || name == "rspamd_proxy") { @@ -186,7 +186,7 @@ let enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether this file ${prefix} should be generated. This option allows specific ${prefix} files to be disabled. ''; @@ -195,12 +195,12 @@ let text = mkOption { default = null; type = types.nullOr types.lines; - description = "Text of the file."; + description = lib.mdDoc "Text of the file."; }; source = mkOption { type = types.path; - description = "Path of the source file."; + description = lib.mdDoc "Path of the source file."; }; }; config = { @@ -232,14 +232,14 @@ in debug = mkOption { type = types.bool; default = false; - description = "Whether to run the rspamd daemon in debug mode."; + description = lib.mdDoc "Whether to run the rspamd daemon in debug mode."; }; locals = mkOption { type = with types; attrsOf (submodule (configFileModule "locals")); default = {}; - description = '' - Local configuration files, written into <filename>/etc/rspamd/local.d/{name}</filename>. + description = lib.mdDoc '' + Local configuration files, written into {file}`/etc/rspamd/local.d/{name}`. ''; example = literalExpression '' { "redis.conf".source = "/nix/store/.../etc/dir/redis.conf"; @@ -251,8 +251,8 @@ in overrides = mkOption { type = with types; attrsOf (submodule (configFileModule "overrides")); default = {}; - description = '' - Overridden configuration files, written into <filename>/etc/rspamd/override.d/{name}</filename>. + description = lib.mdDoc '' + Overridden configuration files, written into {file}`/etc/rspamd/override.d/{name}`. ''; example = literalExpression '' { "redis.conf".source = "/nix/store/.../etc/dir/redis.conf"; @@ -264,15 +264,15 @@ in localLuaRules = mkOption { default = null; type = types.nullOr types.path; - description = '' - Path of file to link to <filename>/etc/rspamd/rspamd.local.lua</filename> for local + description = lib.mdDoc '' + Path of file to link to {file}`/etc/rspamd/rspamd.local.lua` for local rules written in Lua ''; }; workers = mkOption { type = with types; attrsOf (submodule workerOpts); - description = '' + description = lib.mdDoc '' Attribute set of workers to start. ''; default = { @@ -301,7 +301,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration to add at the end of the rspamd configuration file. ''; @@ -310,7 +310,7 @@ in user = mkOption { type = types.str; default = "rspamd"; - description = '' + description = lib.mdDoc '' User to use when no root privileges are required. ''; }; @@ -318,7 +318,7 @@ in group = mkOption { type = types.str; default = "rspamd"; - description = '' + description = lib.mdDoc '' Group to use when no root privileges are required. ''; }; @@ -327,12 +327,12 @@ in enable = mkOption { type = types.bool; default = false; - description = "Add rspamd milter to postfix main.conf"; + description = lib.mdDoc "Add rspamd milter to postfix main.conf"; }; config = mkOption { type = with types; attrsOf (oneOf [ bool str (listOf str) ]); - description = '' + description = lib.mdDoc '' Addon to postfix configuration ''; default = { diff --git a/nixos/modules/services/mail/rss2email.nix b/nixos/modules/services/mail/rss2email.nix index 7f8d2adac648a..7b74db1e711b9 100644 --- a/nixos/modules/services/mail/rss2email.nix +++ b/nixos/modules/services/mail/rss2email.nix @@ -15,57 +15,57 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable rss2email."; + description = lib.mdDoc "Whether to enable rss2email."; }; to = mkOption { type = types.str; - description = "Mail address to which to send emails"; + description = lib.mdDoc "Mail address to which to send emails"; }; interval = mkOption { type = types.str; default = "12h"; - description = "How often to check the feeds, in systemd interval format"; + description = lib.mdDoc "How often to check the feeds, in systemd interval format"; }; config = mkOption { type = with types; attrsOf (oneOf [ str int bool ]); default = {}; - description = '' + description = lib.mdDoc '' The configuration to give rss2email. - Default will use system-wide <literal>sendmail</literal> to send the + Default will use system-wide `sendmail` to send the email. This is rss2email's default when running - <literal>r2e new</literal>. + `r2e new`. This set contains key-value associations that will be set in the - <literal>[DEFAULT]</literal> block along with the - <literal>to</literal> parameter. + `[DEFAULT]` block along with the + `to` parameter. - See <literal>man r2e</literal> for more information on which + See `man r2e` for more information on which parameters are accepted. ''; }; feeds = mkOption { - description = "The feeds to watch."; + description = lib.mdDoc "The feeds to watch."; type = types.attrsOf (types.submodule { options = { url = mkOption { type = types.str; - description = "The URL at which to fetch the feed."; + description = lib.mdDoc "The URL at which to fetch the feed."; }; to = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Email address to which to send feed items. - If <literal>null</literal>, this will not be set in the + If `null`, this will not be set in the configuration file, and rss2email will make it default to - <literal>rss2email.to</literal>. + `rss2email.to`. ''; }; }; diff --git a/nixos/modules/services/mail/schleuder.nix b/nixos/modules/services/mail/schleuder.nix index 7ba15f1070bde..80b37ac129d08 100644 --- a/nixos/modules/services/mail/schleuder.nix +++ b/nixos/modules/services/mail/schleuder.nix @@ -21,7 +21,7 @@ in enable = lib.mkEnableOption "Schleuder secure remailer"; enablePostfix = lib.mkEnableOption "automatic postfix integration" // { default = true; }; lists = lib.mkOption { - description = '' + description = lib.mdDoc '' List of list addresses that should be handled by Schleuder. Note that this is only handled by the postfix integration, and @@ -42,16 +42,16 @@ in }; */ settings = lib.mkOption { - description = '' + description = lib.mdDoc '' Settings for schleuder.yml. - Check the <link xlink:href="https://0xacab.org/schleuder/schleuder/blob/master/etc/schleuder.yml">example configuration</link> for possible values. + Check the [example configuration](https://0xacab.org/schleuder/schleuder/blob/master/etc/schleuder.yml) for possible values. ''; type = lib.types.submodule { freeformType = settingsFormat.type; options.keyserver = lib.mkOption { type = lib.types.str; - description = '' + description = lib.mdDoc '' Key server from which to fetch and update keys. Note that NixOS uses a different default from upstream, since the upstream default sks-keyservers.net is deprecated. @@ -62,15 +62,15 @@ in default = { }; }; extraSettingsFile = lib.mkOption { - description = "YAML file to merge into the schleuder config at runtime. This can be used for secrets such as API keys."; + description = lib.mdDoc "YAML file to merge into the schleuder config at runtime. This can be used for secrets such as API keys."; type = lib.types.nullOr lib.types.path; default = null; }; listDefaults = lib.mkOption { - description = '' + description = lib.mdDoc '' Default settings for lists (list-defaults.yml). - Check the <link xlink:href="https://0xacab.org/schleuder/schleuder/-/blob/master/etc/list-defaults.yml">example configuration</link> for possible values. + Check the [example configuration](https://0xacab.org/schleuder/schleuder/-/blob/master/etc/list-defaults.yml) for possible values. ''; type = settingsFormat.type; default = { }; diff --git a/nixos/modules/services/mail/spamassassin.nix b/nixos/modules/services/mail/spamassassin.nix index 3b10d8d29090d..153e3c000845c 100644 --- a/nixos/modules/services/mail/spamassassin.nix +++ b/nixos/modules/services/mail/spamassassin.nix @@ -17,7 +17,7 @@ in debug = mkOption { type = types.bool; default = false; - description = "Whether to run the SpamAssassin daemon in debug mode"; + description = lib.mdDoc "Whether to run the SpamAssassin daemon in debug mode"; }; config = mkOption { @@ -54,7 +54,7 @@ in initPreConf = mkOption { type = with types; either str path; - description = "The SpamAssassin init.pre config."; + description = lib.mdDoc "The SpamAssassin init.pre config."; apply = val: if builtins.isPath val then val else pkgs.writeText "init.pre" val; default = '' diff --git a/nixos/modules/services/mail/sympa.nix b/nixos/modules/services/mail/sympa.nix index f3578bef96ea4..1d46b090cd844 100644 --- a/nixos/modules/services/mail/sympa.nix +++ b/nixos/modules/services/mail/sympa.nix @@ -96,7 +96,7 @@ in listMasters = mkOption { type = listOf str; example = [ "postmaster@sympa.example.org" ]; - description = '' + description = lib.mdDoc '' The list of the email addresses of the listmasters (users authorized to perform global server commands). ''; @@ -106,9 +106,9 @@ in type = nullOr str; default = null; example = "lists.example.org"; - description = '' - Main domain to be used in <filename>sympa.conf</filename>. - If <literal>null</literal>, one of the <option>services.sympa.domains</option> is chosen for you. + description = lib.mdDoc '' + Main domain to be used in {file}`sympa.conf`. + If `null`, one of the {option}`services.sympa.domains` is chosen for you. ''; }; @@ -119,8 +119,8 @@ in type = nullOr str; default = null; example = "archive.example.org"; - description = '' - Domain part of the web interface URL (no web interface for this domain if <literal>null</literal>). + description = lib.mdDoc '' + Domain part of the web interface URL (no web interface for this domain if `null`). DNS record of type A (or AAAA or CNAME) has to exist with this value. ''; }; @@ -128,7 +128,7 @@ in type = str; default = "/"; example = "/sympa"; - description = "URL path part of the web interface."; + description = lib.mdDoc "URL path part of the web interface."; }; settings = mkOption { type = attrsOf (oneOf [ str int bool ]); @@ -149,7 +149,7 @@ in }; })); - description = '' + description = lib.mdDoc '' Email domains handled by this instance. There have to be MX records for keys of this attribute set. ''; @@ -172,36 +172,36 @@ in type = enum [ "SQLite" "PostgreSQL" "MySQL" ]; default = "SQLite"; example = "MySQL"; - description = "Database engine to use."; + description = lib.mdDoc "Database engine to use."; }; host = mkOption { type = nullOr str; default = null; - description = '' + description = lib.mdDoc '' Database host address. - For MySQL, use <literal>localhost</literal> to connect using Unix domain socket. + For MySQL, use `localhost` to connect using Unix domain socket. - For PostgreSQL, use path to directory (e.g. <filename>/run/postgresql</filename>) + For PostgreSQL, use path to directory (e.g. {file}`/run/postgresql`) to connect using Unix domain socket located in this directory. - Use <literal>null</literal> to fall back on Sympa default, or when using - <option>services.sympa.database.createLocally</option>. + Use `null` to fall back on Sympa default, or when using + {option}`services.sympa.database.createLocally`. ''; }; port = mkOption { type = nullOr port; default = null; - description = "Database port. Use <literal>null</literal> for default port."; + description = lib.mdDoc "Database port. Use `null` for default port."; }; name = mkOption { type = str; default = if cfg.database.type == "SQLite" then "${dataDir}/sympa.sqlite" else "sympa"; defaultText = literalExpression ''if database.type == "SQLite" then "${dataDir}/sympa.sqlite" else "sympa"''; - description = '' + description = lib.mdDoc '' Database name. When using SQLite this must be an absolute path to the database file. ''; @@ -210,22 +210,22 @@ in user = mkOption { type = nullOr str; default = user; - description = "Database user. The system user name is used as a default."; + description = lib.mdDoc "Database user. The system user name is used as a default."; }; passwordFile = mkOption { type = nullOr path; default = null; example = "/run/keys/sympa-dbpassword"; - description = '' - A file containing the password for <option>services.sympa.database.user</option>. + description = lib.mdDoc '' + A file containing the password for {option}`services.sympa.database.user`. ''; }; createLocally = mkOption { type = bool; default = true; - description = "Whether to create a local database automatically."; + description = lib.mdDoc "Whether to create a local database automatically."; }; }; @@ -233,7 +233,7 @@ in enable = mkOption { type = bool; default = true; - description = "Whether to enable Sympa web interface."; + description = lib.mdDoc "Whether to enable Sympa web interface."; }; server = mkOption { @@ -249,7 +249,7 @@ in https = mkOption { type = bool; default = true; - description = '' + description = lib.mdDoc '' Whether to use HTTPS. When nginx integration is enabled, this option forces SSL and enables ACME. Please note that Sympa web interface always uses https links even when this option is disabled. ''; @@ -258,7 +258,7 @@ in fcgiProcs = mkOption { type = ints.positive; default = 2; - description = "Number of FastCGI processes to fork."; + description = lib.mdDoc "Number of FastCGI processes to fork."; }; }; @@ -266,12 +266,12 @@ in type = mkOption { type = enum [ "postfix" "none" ]; default = "postfix"; - description = '' - Mail transfer agent (MTA) integration. Use <literal>none</literal> if you want to configure it yourself. + description = lib.mdDoc '' + Mail transfer agent (MTA) integration. Use `none` if you want to configure it yourself. - The <literal>postfix</literal> integration sets up local Postfix instance that will pass incoming + The `postfix` integration sets up local Postfix instance that will pass incoming messages from configured domains to Sympa. You still need to configure at least outgoing message - handling using e.g. <option>services.postfix.relayHost</option>. + handling using e.g. {option}`services.postfix.relayHost`. ''; }; }; @@ -298,16 +298,16 @@ in enable = mkOption { type = bool; default = true; - description = "Whether this file should be generated. This option allows specific files to be disabled."; + description = lib.mdDoc "Whether this file should be generated. This option allows specific files to be disabled."; }; text = mkOption { default = null; type = nullOr lines; - description = "Text of the file."; + description = lib.mdDoc "Text of the file."; }; source = mkOption { type = path; - description = "Path of the source file."; + description = lib.mdDoc "Path of the source file."; }; }; @@ -321,7 +321,7 @@ in }; } ''; - description = "Set of files to be linked in <filename>${dataDir}</filename>."; + description = lib.mdDoc "Set of files to be linked in {file}`${dataDir}`."; }; }; diff --git a/nixos/modules/services/matrix/appservice-discord.nix b/nixos/modules/services/matrix/appservice-discord.nix index 8a8c7f41e3cbb..fa55b3c5de70e 100644 --- a/nixos/modules/services/matrix/appservice-discord.nix +++ b/nixos/modules/services/matrix/appservice-discord.nix @@ -64,11 +64,11 @@ in { environmentFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' File containing environment variables to be passed to the matrix-appservice-discord service, in which secret tokens can be specified securely by defining values for - <literal>APPSERVICE_DISCORD_AUTH_CLIENT_I_D</literal> and - <literal>APPSERVICE_DISCORD_AUTH_BOT_TOKEN</literal>. + `APPSERVICE_DISCORD_AUTH_CLIENT_I_D` and + `APPSERVICE_DISCORD_AUTH_BOT_TOKEN`. ''; }; @@ -76,7 +76,7 @@ in { type = types.str; default = "http://localhost:${toString cfg.port}"; defaultText = literalExpression ''"http://localhost:''${toString config.${opt.port}}"''; - description = '' + description = lib.mdDoc '' The URL where the application service is listening for HS requests. ''; }; @@ -84,7 +84,7 @@ in { port = mkOption { type = types.port; default = 9005; # from https://github.com/Half-Shot/matrix-appservice-discord/blob/master/package.json#L11 - description = '' + description = lib.mdDoc '' Port number on which the bridge should listen for internal communication with the Matrix homeserver. ''; }; @@ -92,7 +92,7 @@ in { localpart = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' The user_id localpart to assign to the AS. ''; }; @@ -103,7 +103,7 @@ in { defaultText = literalExpression '' optional config.services.matrix-synapse.enable "matrix-synapse.service" ''; - description = '' + description = lib.mdDoc '' List of Systemd services to require and wait for when starting the application service, such as the Matrix homeserver if it's running on the same host. ''; diff --git a/nixos/modules/services/matrix/appservice-irc.nix b/nixos/modules/services/matrix/appservice-irc.nix index ff938527ed58a..b24edba96d938 100644 --- a/nixos/modules/services/matrix/appservice-irc.nix +++ b/nixos/modules/services/matrix/appservice-irc.nix @@ -32,26 +32,26 @@ in { port = mkOption { type = port; - description = "The port to listen on"; + description = lib.mdDoc "The port to listen on"; default = 8009; }; needBindingCap = mkOption { type = bool; - description = "Whether the daemon needs to bind to ports below 1024 (e.g. for the ident service)"; + description = lib.mdDoc "Whether the daemon needs to bind to ports below 1024 (e.g. for the ident service)"; default = false; }; passwordEncryptionKeyLength = mkOption { type = ints.unsigned; - description = "Length of the key to encrypt IRC passwords with"; + description = lib.mdDoc "Length of the key to encrypt IRC passwords with"; default = 4096; example = 8192; }; registrationUrl = mkOption { type = str; - description = '' + description = lib.mdDoc '' The URL where the application service is listening for homeserver requests, from the Matrix homeserver perspective. ''; @@ -60,14 +60,14 @@ in { localpart = mkOption { type = str; - description = "The user_id localpart to assign to the appservice"; + description = lib.mdDoc "The user_id localpart to assign to the appservice"; default = "appservice-irc"; }; settings = mkOption { - description = '' + description = lib.mdDoc '' Configuration for the appservice, see - <link xlink:href="https://github.com/matrix-org/matrix-appservice-irc/blob/${pkgs.matrix-appservice-irc.version}/config.sample.yaml"/> + <https://github.com/matrix-org/matrix-appservice-irc/blob/${pkgs.matrix-appservice-irc.version}/config.sample.yaml> for supported values ''; default = {}; @@ -76,7 +76,7 @@ in { options = { homeserver = mkOption { - description = "Homeserver configuration"; + description = lib.mdDoc "Homeserver configuration"; default = {}; type = submodule { freeformType = jsonType; @@ -84,12 +84,12 @@ in { options = { url = mkOption { type = str; - description = "The URL to the home server for client-server API calls"; + description = lib.mdDoc "The URL to the home server for client-server API calls"; }; domain = mkOption { type = str; - description = '' + description = lib.mdDoc '' The 'domain' part for user IDs on this home server. Usually (but not always) is the "domain name" part of the homeserver URL. ''; @@ -100,21 +100,21 @@ in { database = mkOption { default = {}; - description = "Configuration for the database"; + description = lib.mdDoc "Configuration for the database"; type = submodule { freeformType = jsonType; options = { engine = mkOption { type = str; - description = "Which database engine to use"; + description = lib.mdDoc "Which database engine to use"; default = "nedb"; example = "postgres"; }; connectionString = mkOption { type = str; - description = "The database connection string"; + description = lib.mdDoc "The database connection string"; default = "nedb://var/lib/matrix-appservice-irc/data"; example = "postgres://username:password@host:port/databasename"; }; @@ -124,14 +124,14 @@ in { ircService = mkOption { default = {}; - description = "IRC bridge configuration"; + description = lib.mdDoc "IRC bridge configuration"; type = submodule { freeformType = jsonType; options = { passwordEncryptionKeyPath = mkOption { type = str; - description = '' + description = lib.mdDoc '' Location of the key with which IRC passwords are encrypted for storage. Will be generated on first run if not present. ''; @@ -140,7 +140,7 @@ in { servers = mkOption { type = submodule { freeformType = jsonType; }; - description = "IRC servers to connect to"; + description = lib.mdDoc "IRC servers to connect to"; }; }; }; diff --git a/nixos/modules/services/matrix/conduit.nix b/nixos/modules/services/matrix/conduit.nix index 108f64de7aa95..29040c3850085 100644 --- a/nixos/modules/services/matrix/conduit.nix +++ b/nixos/modules/services/matrix/conduit.nix @@ -15,7 +15,7 @@ in extraEnvironment = mkOption { type = types.attrsOf types.str; - description = "Extra Environment variables to pass to the conduit server."; + description = lib.mdDoc "Extra Environment variables to pass to the conduit server."; default = {}; example = { RUST_BACKTRACE="yes"; }; }; @@ -25,7 +25,7 @@ in default = pkgs.matrix-conduit; defaultText = "pkgs.matrix-conduit"; example = "pkgs.matrix-conduit"; - description = '' + description = lib.mdDoc '' Package of the conduit matrix server to use. ''; }; @@ -37,50 +37,50 @@ in global.server_name = mkOption { type = types.str; example = "example.com"; - description = "The server_name is the name of this server. It is used as a suffix for user # and room ids."; + description = lib.mdDoc "The server_name is the name of this server. It is used as a suffix for user # and room ids."; }; global.port = mkOption { type = types.port; default = 6167; - description = "The port Conduit will be running on. You need to set up a reverse proxy in your web server (e.g. apache or nginx), so all requests to /_matrix on port 443 and 8448 will be forwarded to the Conduit instance running on this port"; + description = lib.mdDoc "The port Conduit will be running on. You need to set up a reverse proxy in your web server (e.g. apache or nginx), so all requests to /_matrix on port 443 and 8448 will be forwarded to the Conduit instance running on this port"; }; global.max_request_size = mkOption { type = types.ints.positive; default = 20000000; - description = "Max request size in bytes. Don't forget to also change it in the proxy."; + description = lib.mdDoc "Max request size in bytes. Don't forget to also change it in the proxy."; }; global.allow_registration = mkOption { type = types.bool; default = false; - description = "Whether new users can register on this server."; + description = lib.mdDoc "Whether new users can register on this server."; }; global.allow_encryption = mkOption { type = types.bool; default = true; - description = "Whether new encrypted rooms can be created. Note: existing rooms will continue to work."; + description = lib.mdDoc "Whether new encrypted rooms can be created. Note: existing rooms will continue to work."; }; global.allow_federation = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether this server federates with other servers. ''; }; global.trusted_servers = mkOption { type = types.listOf types.str; default = [ "matrix.org" ]; - description = "Servers trusted with signing server keys."; + description = lib.mdDoc "Servers trusted with signing server keys."; }; global.address = mkOption { type = types.str; default = "::1"; - description = "Address to listen on for connections by the reverse proxy/tls terminator."; + description = lib.mdDoc "Address to listen on for connections by the reverse proxy/tls terminator."; }; global.database_path = mkOption { type = types.str; default = "/var/lib/matrix-conduit/"; readOnly = true; - description = '' + description = lib.mdDoc '' Path to the conduit database, the directory where conduit will save its data. Note that due to using the DynamicUser feature of systemd, this value should not be changed and is set to be read only. @@ -90,7 +90,7 @@ in type = types.enum [ "sqlite" "rocksdb" ]; default = "sqlite"; example = "rocksdb"; - description = '' + description = lib.mdDoc '' The database backend for the service. Switching it on an existing instance will require manual migration of data. ''; @@ -98,9 +98,9 @@ in }; }; default = {}; - description = '' + description = lib.mdDoc '' Generates the conduit.toml configuration file. Refer to - <link xlink:href="https://gitlab.com/famedly/conduit/-/blob/master/conduit-example.toml"/> + <https://gitlab.com/famedly/conduit/-/blob/master/conduit-example.toml> for details on supported values. Note that database_path can not be edited because the service's reliance on systemd StateDir. ''; diff --git a/nixos/modules/services/matrix/dendrite.nix b/nixos/modules/services/matrix/dendrite.nix index 54052084b3378..4275950ec7850 100644 --- a/nixos/modules/services/matrix/dendrite.nix +++ b/nixos/modules/services/matrix/dendrite.nix @@ -11,14 +11,14 @@ in httpPort = lib.mkOption { type = lib.types.nullOr lib.types.port; default = 8008; - description = '' + description = lib.mdDoc '' The port to listen for HTTP requests on. ''; }; httpsPort = lib.mkOption { type = lib.types.nullOr lib.types.port; default = null; - description = '' + description = lib.mdDoc '' The port to listen for HTTPS requests on. ''; }; @@ -78,11 +78,11 @@ in type = lib.types.listOf lib.types.str; default = [ ]; example = [ "private_key:/path/to/my_private_key" ]; - description = '' + description = lib.mdDoc '' This can be used to pass secrets to the systemd service without adding them to the nix store. To use the example setting, see the example of - <option>services.dendrite.settings.global.private_key</option>. + {option}`services.dendrite.settings.global.private_key`. See the LoadCredential section of systemd.exec manual for more information. ''; }; @@ -93,7 +93,7 @@ in server_name = lib.mkOption { type = lib.types.str; example = "example.com"; - description = '' + description = lib.mdDoc '' The domain name of the server, with optional explicit port. This is used by remote servers to connect to this server. This is also the last part of your UserID. @@ -117,7 +117,7 @@ in type = lib.types.listOf lib.types.str; example = [ "matrix.org" ]; default = [ "matrix.org" "vector.im" ]; - description = '' + description = lib.mdDoc '' Lists of domains that the server will trust as identity servers to verify third party identifiers such as phone numbers and email addresses @@ -128,7 +128,7 @@ in connection_string = lib.mkOption { type = lib.types.str; default = "file:federationapi.db"; - description = '' + description = lib.mdDoc '' Database for the Appservice API. ''; }; @@ -137,7 +137,7 @@ in registration_disabled = lib.mkOption { type = lib.types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to disable user registration to the server without the shared secret. ''; @@ -147,7 +147,7 @@ in connection_string = lib.mkOption { type = lib.types.str; default = "file:federationapi.db"; - description = '' + description = lib.mdDoc '' Database for the Federation API. ''; }; @@ -156,7 +156,7 @@ in connection_string = lib.mkOption { type = lib.types.str; default = "file:keyserver.db"; - description = '' + description = lib.mdDoc '' Database for the Key Server (for end-to-end encryption). ''; }; @@ -166,7 +166,7 @@ in connection_string = lib.mkOption { type = lib.types.str; default = "file:mediaapi.db"; - description = '' + description = lib.mdDoc '' Database for the Media API. ''; }; @@ -174,7 +174,7 @@ in base_path = lib.mkOption { type = lib.types.str; default = "${workingDir}/media_store"; - description = '' + description = lib.mdDoc '' Storage path for uploaded media. ''; }; @@ -183,7 +183,7 @@ in connection_string = lib.mkOption { type = lib.types.str; default = "file:roomserver.db"; - description = '' + description = lib.mdDoc '' Database for the Room Server. ''; }; @@ -192,7 +192,7 @@ in connection_string = lib.mkOption { type = lib.types.str; default = "file:syncserver.db"; - description = '' + description = lib.mdDoc '' Database for the Sync API. ''; }; @@ -202,7 +202,7 @@ in connection_string = lib.mkOption { type = lib.types.str; default = "file:userapi_accounts.db"; - description = '' + description = lib.mdDoc '' Database for the User API, accounts. ''; }; @@ -211,7 +211,7 @@ in connection_string = lib.mkOption { type = lib.types.str; default = "file:userapi_devices.db"; - description = '' + description = lib.mdDoc '' Database for the User API, devices. ''; }; @@ -222,7 +222,7 @@ in connection_string = lib.mkOption { type = lib.types.str; default = "file:mscs.db"; - description = '' + description = lib.mdDoc '' Database for exerimental MSC's. ''; }; @@ -230,16 +230,16 @@ in }; }; default = { }; - description = '' + description = lib.mdDoc '' Configuration for dendrite, see: - <link xlink:href="https://github.com/matrix-org/dendrite/blob/master/dendrite-config.yaml"/> + <https://github.com/matrix-org/dendrite/blob/master/dendrite-config.yaml> for available options with which to populate settings. ''; }; openRegistration = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Allow open registration without secondary verification (reCAPTCHA). ''; }; diff --git a/nixos/modules/services/matrix/mautrix-facebook.nix b/nixos/modules/services/matrix/mautrix-facebook.nix index e046c791ac013..55067abaa52a2 100644 --- a/nixos/modules/services/matrix/mautrix-facebook.nix +++ b/nixos/modules/services/matrix/mautrix-facebook.nix @@ -91,28 +91,28 @@ in { environmentFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' File containing environment variables to be passed to the mautrix-telegram service. - Any config variable can be overridden by setting <literal>MAUTRIX_FACEBOOK_SOME_KEY</literal> to override the <literal>some.key</literal> variable. + Any config variable can be overridden by setting `MAUTRIX_FACEBOOK_SOME_KEY` to override the `some.key` variable. ''; }; configurePostgresql = mkOption { type = types.bool; default = true; - description = '' - Enable PostgreSQL and create a user and database for mautrix-facebook. The default <literal>settings</literal> reference this database, if you disable this option you must provide a database URL. + description = lib.mdDoc '' + Enable PostgreSQL and create a user and database for mautrix-facebook. The default `settings` reference this database, if you disable this option you must provide a database URL. ''; }; registrationData = mkOption { type = types.attrs; default = {}; - description = '' + description = lib.mdDoc '' Output data for appservice registration. Simply make any desired changes and serialize to JSON. Note that this data contains secrets so think twice before putting it into the nix store. - Currently <literal>as_token</literal> and <literal>hs_token</literal> need to be added as they are not known to this module. + Currently `as_token` and `hs_token` need to be added as they are not known to this module. ''; }; }; diff --git a/nixos/modules/services/matrix/mautrix-telegram.nix b/nixos/modules/services/matrix/mautrix-telegram.nix index 88e5c38f71633..c6527be5263cb 100644 --- a/nixos/modules/services/matrix/mautrix-telegram.nix +++ b/nixos/modules/services/matrix/mautrix-telegram.nix @@ -94,14 +94,14 @@ in { environmentFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' File containing environment variables to be passed to the mautrix-telegram service, in which secret tokens can be specified securely by defining values for - <literal>MAUTRIX_TELEGRAM_APPSERVICE_AS_TOKEN</literal>, - <literal>MAUTRIX_TELEGRAM_APPSERVICE_HS_TOKEN</literal>, - <literal>MAUTRIX_TELEGRAM_TELEGRAM_API_ID</literal>, - <literal>MAUTRIX_TELEGRAM_TELEGRAM_API_HASH</literal> and optionally - <literal>MAUTRIX_TELEGRAM_TELEGRAM_BOT_TOKEN</literal>. + `MAUTRIX_TELEGRAM_APPSERVICE_AS_TOKEN`, + `MAUTRIX_TELEGRAM_APPSERVICE_HS_TOKEN`, + `MAUTRIX_TELEGRAM_TELEGRAM_API_ID`, + `MAUTRIX_TELEGRAM_TELEGRAM_API_HASH` and optionally + `MAUTRIX_TELEGRAM_TELEGRAM_BOT_TOKEN`. ''; }; @@ -111,7 +111,7 @@ in { defaultText = literalExpression '' optional config.services.matrix-synapse.enable "matrix-synapse.service" ''; - description = '' + description = lib.mdDoc '' List of Systemd services to require and wait for when starting the application service. ''; }; diff --git a/nixos/modules/services/misc/airsonic.nix b/nixos/modules/services/misc/airsonic.nix index 2b9c6d80abbd7..01e330929ca1f 100644 --- a/nixos/modules/services/misc/airsonic.nix +++ b/nixos/modules/services/misc/airsonic.nix @@ -14,13 +14,13 @@ in { user = mkOption { type = types.str; default = "airsonic"; - description = "User account under which airsonic runs."; + description = lib.mdDoc "User account under which airsonic runs."; }; home = mkOption { type = types.path; default = "/var/lib/airsonic"; - description = '' + description = lib.mdDoc '' The directory where Airsonic will create files. Make sure it is writable. ''; @@ -29,7 +29,7 @@ in { virtualHost = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Name of the nginx virtualhost to use and setup. If null, do not setup any virtualhost. ''; }; @@ -37,7 +37,7 @@ in { listenAddress = mkOption { type = types.str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' The host name or IP address on which to bind Airsonic. The default value is appropriate for first launch, when the default credentials are easy to guess. It is also appropriate @@ -50,7 +50,7 @@ in { port = mkOption { type = types.int; default = 4040; - description = '' + description = lib.mdDoc '' The port on which Airsonic will listen for incoming HTTP traffic. Set to 0 to disable. ''; @@ -59,7 +59,7 @@ in { contextPath = mkOption { type = types.path; default = "/"; - description = '' + description = lib.mdDoc '' The context path, i.e., the last part of the Airsonic URL. Typically '/' or '/airsonic'. Default '/' ''; @@ -68,7 +68,7 @@ in { maxMemory = mkOption { type = types.int; default = 100; - description = '' + description = lib.mdDoc '' The memory limit (max Java heap size) in megabytes. Default: 100 ''; @@ -78,7 +78,7 @@ in { type = types.listOf types.path; default = [ "${pkgs.ffmpeg.bin}/bin/ffmpeg" ]; defaultText = literalExpression ''[ "''${pkgs.ffmpeg.bin}/bin/ffmpeg" ]''; - description = '' + description = lib.mdDoc '' List of paths to transcoder executables that should be accessible from Airsonic. Symlinks will be created to each executable inside ''${config.${opt.home}}/transcoders. @@ -89,7 +89,7 @@ in { type = types.package; default = pkgs.jre8; defaultText = literalExpression "pkgs.jre8"; - description = '' + description = lib.mdDoc '' JRE package to use. Airsonic only supports Java 8, airsonic-advanced requires at least @@ -101,11 +101,11 @@ in { type = types.path; default = "${pkgs.airsonic}/webapps/airsonic.war"; defaultText = literalExpression ''"''${pkgs.airsonic}/webapps/airsonic.war"''; - description = "Airsonic war file to use."; + description = lib.mdDoc "Airsonic war file to use."; }; jvmOptions = mkOption { - description = '' + description = lib.mdDoc '' Extra command line options for the JVM running AirSonic. Useful for sending jukebox output to non-default alsa devices. diff --git a/nixos/modules/services/misc/ananicy.nix b/nixos/modules/services/misc/ananicy.nix index 191666bc36259..bf33b2c0602ba 100644 --- a/nixos/modules/services/misc/ananicy.nix +++ b/nixos/modules/services/misc/ananicy.nix @@ -18,7 +18,7 @@ in default = pkgs.ananicy; defaultText = literalExpression "pkgs.ananicy"; example = literalExpression "pkgs.ananicy-cpp"; - description = '' + description = lib.mdDoc '' Which ananicy package to use. ''; }; @@ -29,18 +29,18 @@ in example = { apply_nice = false; }; - description = '' - See <link xlink:href="https://github.com/Nefelim4ag/Ananicy/blob/master/ananicy.d/ananicy.conf"/> + description = lib.mdDoc '' + See <https://github.com/Nefelim4ag/Ananicy/blob/master/ananicy.d/ananicy.conf> ''; }; extraRules = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Extra rules in json format on separate lines. See: - <link xlink:href="https://github.com/Nefelim4ag/Ananicy#configuration"/> - <link xlink:href="https://gitlab.com/ananicy-cpp/ananicy-cpp/#global-configuration"/> + <https://github.com/Nefelim4ag/Ananicy#configuration> + <https://gitlab.com/ananicy-cpp/ananicy-cpp/#global-configuration> ''; example = literalExpression '' ''' diff --git a/nixos/modules/services/misc/ankisyncd.nix b/nixos/modules/services/misc/ankisyncd.nix index 69e471f4f577b..fe71b528b6abc 100644 --- a/nixos/modules/services/misc/ankisyncd.nix +++ b/nixos/modules/services/misc/ankisyncd.nix @@ -34,25 +34,25 @@ in type = types.package; default = pkgs.ankisyncd; defaultText = literalExpression "pkgs.ankisyncd"; - description = "The package to use for the ankisyncd command."; + description = lib.mdDoc "The package to use for the ankisyncd command."; }; host = mkOption { type = types.str; default = "localhost"; - description = "ankisyncd host"; + description = lib.mdDoc "ankisyncd host"; }; port = mkOption { type = types.int; default = 27701; - description = "ankisyncd port"; + description = lib.mdDoc "ankisyncd port"; }; openFirewall = mkOption { default = false; type = types.bool; - description = "Whether to open the firewall for the specified port."; + description = lib.mdDoc "Whether to open the firewall for the specified port."; }; }; diff --git a/nixos/modules/services/misc/apache-kafka.nix b/nixos/modules/services/misc/apache-kafka.nix index d1856fff4aa40..c428cfbc67e04 100644 --- a/nixos/modules/services/misc/apache-kafka.nix +++ b/nixos/modules/services/misc/apache-kafka.nix @@ -26,49 +26,49 @@ in { options.services.apache-kafka = { enable = mkOption { - description = "Whether to enable Apache Kafka."; + description = lib.mdDoc "Whether to enable Apache Kafka."; default = false; type = types.bool; }; brokerId = mkOption { - description = "Broker ID."; + description = lib.mdDoc "Broker ID."; default = -1; type = types.int; }; port = mkOption { - description = "Port number the broker should listen on."; + description = lib.mdDoc "Port number the broker should listen on."; default = 9092; type = types.int; }; hostname = mkOption { - description = "Hostname the broker should bind to."; + description = lib.mdDoc "Hostname the broker should bind to."; default = "localhost"; type = types.str; }; logDirs = mkOption { - description = "Log file directories"; + description = lib.mdDoc "Log file directories"; default = [ "/tmp/kafka-logs" ]; type = types.listOf types.path; }; zookeeper = mkOption { - description = "Zookeeper connection string"; + description = lib.mdDoc "Zookeeper connection string"; default = "localhost:2181"; type = types.str; }; extraProperties = mkOption { - description = "Extra properties for server.properties."; + description = lib.mdDoc "Extra properties for server.properties."; type = types.nullOr types.lines; default = null; }; serverProperties = mkOption { - description = '' + description = lib.mdDoc '' Complete server.properties content. Other server.properties config options will be ignored if this option is used. ''; @@ -77,7 +77,7 @@ in { }; log4jProperties = mkOption { - description = "Kafka log4j property configuration."; + description = lib.mdDoc "Kafka log4j property configuration."; default = '' log4j.rootLogger=INFO, stdout @@ -89,7 +89,7 @@ in { }; jvmOptions = mkOption { - description = "Extra command line options for the JVM running Kafka."; + description = lib.mdDoc "Extra command line options for the JVM running Kafka."; default = []; type = types.listOf types.str; example = [ @@ -100,14 +100,14 @@ in { }; package = mkOption { - description = "The kafka package to use"; + description = lib.mdDoc "The kafka package to use"; default = pkgs.apacheKafka; defaultText = literalExpression "pkgs.apacheKafka"; type = types.package; }; jre = mkOption { - description = "The JRE with which to run Kafka"; + description = lib.mdDoc "The JRE with which to run Kafka"; default = cfg.package.passthru.jre; defaultText = literalExpression "pkgs.apacheKafka.passthru.jre"; type = types.package; diff --git a/nixos/modules/services/misc/autofs.nix b/nixos/modules/services/misc/autofs.nix index 5fce990afecec..55ab15ff003d1 100644 --- a/nixos/modules/services/misc/autofs.nix +++ b/nixos/modules/services/misc/autofs.nix @@ -21,7 +21,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Mount filesystems on demand. Unmount them automatically. You may also be interested in afuse. ''; @@ -46,21 +46,21 @@ in /auto file:''${mapConf} ''' ''; - description = '' - Contents of <literal>/etc/auto.master</literal> file. See <command>auto.master(5)</command> and <command>autofs(5)</command>. + description = lib.mdDoc '' + Contents of `/etc/auto.master` file. See {command}`auto.master(5)` and {command}`autofs(5)`. ''; }; timeout = mkOption { type = types.int; default = 600; - description = "Set the global minimum timeout, in seconds, until directories are unmounted"; + description = lib.mdDoc "Set the global minimum timeout, in seconds, until directories are unmounted"; }; debug = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Pass -d and -7 to automount and write log to the system journal. ''; }; diff --git a/nixos/modules/services/misc/autorandr.nix b/nixos/modules/services/misc/autorandr.nix index ef799e9ce3b63..11dc915c2afa4 100644 --- a/nixos/modules/services/misc/autorandr.nix +++ b/nixos/modules/services/misc/autorandr.nix @@ -36,13 +36,13 @@ let config = mkOption { type = types.attrsOf configModule; - description = "Per output profile configuration."; + description = lib.mdDoc "Per output profile configuration."; default = { }; }; hooks = mkOption { type = hooksModule; - description = "Profile hook scripts."; + description = lib.mdDoc "Profile hook scripts."; default = { }; }; }; @@ -52,54 +52,54 @@ let options = { enable = mkOption { type = types.bool; - description = "Whether to enable the output."; + description = lib.mdDoc "Whether to enable the output."; default = true; }; crtc = mkOption { type = types.nullOr types.ints.unsigned; - description = "Output video display controller."; + description = lib.mdDoc "Output video display controller."; default = null; example = 0; }; primary = mkOption { type = types.bool; - description = "Whether output should be marked as primary"; + description = lib.mdDoc "Whether output should be marked as primary"; default = false; }; position = mkOption { type = types.str; - description = "Output position"; + description = lib.mdDoc "Output position"; default = ""; example = "5760x0"; }; mode = mkOption { type = types.str; - description = "Output resolution."; + description = lib.mdDoc "Output resolution."; default = ""; example = "3840x2160"; }; rate = mkOption { type = types.str; - description = "Output framerate."; + description = lib.mdDoc "Output framerate."; default = ""; example = "60.00"; }; gamma = mkOption { type = types.str; - description = "Output gamma configuration."; + description = lib.mdDoc "Output gamma configuration."; default = ""; example = "1.0:0.909:0.833"; }; rotate = mkOption { type = types.nullOr (types.enum [ "normal" "left" "right" "inverted" ]); - description = "Output rotate configuration."; + description = lib.mdDoc "Output rotate configuration."; default = null; example = "left"; }; @@ -126,7 +126,7 @@ let dpi = mkOption { type = types.nullOr types.ints.positive; - description = "Output DPI configuration."; + description = lib.mdDoc "Output DPI configuration."; default = null; example = 96; }; @@ -136,19 +136,19 @@ let options = { method = mkOption { type = types.enum [ "factor" "pixel" ]; - description = "Output scaling method."; + description = lib.mdDoc "Output scaling method."; default = "factor"; example = "pixel"; }; x = mkOption { type = types.either types.float types.ints.positive; - description = "Horizontal scaling factor/pixels."; + description = lib.mdDoc "Horizontal scaling factor/pixels."; }; y = mkOption { type = types.either types.float types.ints.positive; - description = "Vertical scaling factor/pixels."; + description = lib.mdDoc "Vertical scaling factor/pixels."; }; }; }); @@ -184,19 +184,19 @@ let options = { postswitch = mkOption { type = types.attrsOf hookType; - description = "Postswitch hook executed after mode switch."; + description = lib.mdDoc "Postswitch hook executed after mode switch."; default = { }; }; preswitch = mkOption { type = types.attrsOf hookType; - description = "Preswitch hook executed before mode switch."; + description = lib.mdDoc "Preswitch hook executed before mode switch."; default = { }; }; predetect = mkOption { type = types.attrsOf hookType; - description = '' + description = lib.mdDoc '' Predetect hook executed before autorandr attempts to run xrandr. ''; default = { }; @@ -253,7 +253,7 @@ in { defaultTarget = mkOption { default = "default"; type = types.str; - description = '' + description = lib.mdDoc '' Fallback if no monitor layout can be detected. See the docs (https://github.com/phillipberndt/autorandr/blob/v1.0/README.md#how-to-use) for further reference. @@ -262,7 +262,7 @@ in { hooks = mkOption { type = hooksModule; - description = "Global hook scripts"; + description = lib.mdDoc "Global hook scripts"; default = { }; example = '' { @@ -292,7 +292,7 @@ in { }; profiles = mkOption { type = types.attrsOf profileModule; - description = "Autorandr profiles specification."; + description = lib.mdDoc "Autorandr profiles specification."; default = { }; example = literalExpression '' { diff --git a/nixos/modules/services/misc/bazarr.nix b/nixos/modules/services/misc/bazarr.nix index 99343a146a7ad..8c0b4b88e5d7a 100644 --- a/nixos/modules/services/misc/bazarr.nix +++ b/nixos/modules/services/misc/bazarr.nix @@ -13,25 +13,25 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = "Open ports in the firewall for the bazarr web interface."; + description = lib.mdDoc "Open ports in the firewall for the bazarr web interface."; }; listenPort = mkOption { type = types.port; default = 6767; - description = "Port on which the bazarr web interface should listen"; + description = lib.mdDoc "Port on which the bazarr web interface should listen"; }; user = mkOption { type = types.str; default = "bazarr"; - description = "User account under which bazarr runs."; + description = lib.mdDoc "User account under which bazarr runs."; }; group = mkOption { type = types.str; default = "bazarr"; - description = "Group under which bazarr runs."; + description = lib.mdDoc "Group under which bazarr runs."; }; }; }; diff --git a/nixos/modules/services/misc/beanstalkd.nix b/nixos/modules/services/misc/beanstalkd.nix index 1c674a5b23bf0..498e287ac7d4e 100644 --- a/nixos/modules/services/misc/beanstalkd.nix +++ b/nixos/modules/services/misc/beanstalkd.nix @@ -17,13 +17,13 @@ in listen = { port = mkOption { type = types.int; - description = "TCP port that will be used to accept client connections."; + description = lib.mdDoc "TCP port that will be used to accept client connections."; default = 11300; }; address = mkOption { type = types.str; - description = "IP address to listen on."; + description = lib.mdDoc "IP address to listen on."; default = "127.0.0.1"; example = "0.0.0.0"; }; @@ -32,7 +32,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = "Whether to open ports in the firewall for the server."; + description = lib.mdDoc "Whether to open ports in the firewall for the server."; }; }; }; diff --git a/nixos/modules/services/misc/bees.nix b/nixos/modules/services/misc/bees.nix index fa00d7e4f55d0..1b4923150266b 100644 --- a/nixos/modules/services/misc/bees.nix +++ b/nixos/modules/services/misc/bees.nix @@ -47,12 +47,12 @@ let type = types.enum (attrNames logLevels ++ attrValues logLevels); apply = v: if isString v then logLevels.${v} else v; default = "info"; - description = "Log verbosity (syslog keyword/level)."; + description = lib.mdDoc "Log verbosity (syslog keyword/level)."; }; options.workDir = mkOption { type = str; default = ".beeshome"; - description = '' + description = lib.mdDoc '' Name (relative to the root of the filesystem) of the subvolume where the hash table will be stored. ''; @@ -60,7 +60,7 @@ let options.extraOptions = mkOption { type = listOf str; default = [ ]; - description = '' + description = lib.mdDoc '' Extra command-line options passed to the daemon. See upstream bees documentation. ''; example = literalExpression '' @@ -75,7 +75,7 @@ in options.services.beesd = { filesystems = mkOption { type = with types; attrsOf (submodule fsOptions); - description = "BTRFS filesystems to run block-level deduplication on."; + description = lib.mdDoc "BTRFS filesystems to run block-level deduplication on."; default = { }; example = literalExpression '' { diff --git a/nixos/modules/services/misc/bepasty.nix b/nixos/modules/services/misc/bepasty.nix index f69832e5b2bd9..8d18ef7f1946d 100644 --- a/nixos/modules/services/misc/bepasty.nix +++ b/nixos/modules/services/misc/bepasty.nix @@ -17,7 +17,7 @@ in servers = mkOption { default = {}; - description = '' + description = lib.mdDoc '' configure a number of bepasty servers which will be started with gunicorn. ''; @@ -27,7 +27,7 @@ in bind = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Bind address to be used for this server. ''; example = "0.0.0.0:8000"; @@ -36,7 +36,7 @@ in dataDir = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Path to the directory where the pastes will be saved to ''; default = default_home+"/data"; @@ -44,7 +44,7 @@ in defaultPermissions = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' default permissions for all unauthenticated accesses. ''; example = "read,create,delete"; @@ -53,7 +53,7 @@ in extraConfig = mkOption { type = types.lines; - description = '' + description = lib.mdDoc '' Extra configuration for bepasty server to be appended on the configuration. see https://bepasty-server.readthedocs.org/en/latest/quickstart.html#configuring-bepasty @@ -70,13 +70,13 @@ in secretKey = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' server secret for safe session cookies, must be set. Warning: this secret is stored in the WORLD-READABLE Nix store! - It's recommended to use <option>secretKeyFile</option> - which takes precedence over <option>secretKey</option>. + It's recommended to use {option}`secretKeyFile` + which takes precedence over {option}`secretKey`. ''; default = ""; }; @@ -84,19 +84,19 @@ in secretKeyFile = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' A file that contains the server secret for safe session cookies, must be set. - <option>secretKeyFile</option> takes precedence over <option>secretKey</option>. + {option}`secretKeyFile` takes precedence over {option}`secretKey`. - Warning: when <option>secretKey</option> is non-empty <option>secretKeyFile</option> + Warning: when {option}`secretKey` is non-empty {option}`secretKeyFile` defaults to a file in the WORLD-READABLE Nix store containing that secret. ''; }; workDir = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Path to the working directory (used for config and pidfile). Defaults to the users home directory. ''; diff --git a/nixos/modules/services/misc/calibre-server.nix b/nixos/modules/services/misc/calibre-server.nix index 2467d34b524a5..d75c33bab5189 100644 --- a/nixos/modules/services/misc/calibre-server.nix +++ b/nixos/modules/services/misc/calibre-server.nix @@ -26,20 +26,20 @@ in enable = mkEnableOption "calibre-server"; libraries = mkOption { - description = '' + description = lib.mdDoc '' The directories of the libraries to serve. They must be readable for the user under which the server runs. ''; type = types.listOf types.path; }; user = mkOption { - description = "The user under which calibre-server runs."; + description = lib.mdDoc "The user under which calibre-server runs."; type = types.str; default = "calibre-server"; }; group = mkOption { - description = "The group under which calibre-server runs."; + description = lib.mdDoc "The group under which calibre-server runs."; type = types.str; default = "calibre-server"; }; diff --git a/nixos/modules/services/misc/canto-daemon.nix b/nixos/modules/services/misc/canto-daemon.nix index db51a263aab53..8150e038bc137 100644 --- a/nixos/modules/services/misc/canto-daemon.nix +++ b/nixos/modules/services/misc/canto-daemon.nix @@ -16,7 +16,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the canto RSS daemon."; + description = lib.mdDoc "Whether to enable the canto RSS daemon."; }; }; diff --git a/nixos/modules/services/misc/cfdyndns.nix b/nixos/modules/services/misc/cfdyndns.nix index 5885617d7429e..74d7a0b2c6297 100644 --- a/nixos/modules/services/misc/cfdyndns.nix +++ b/nixos/modules/services/misc/cfdyndns.nix @@ -18,7 +18,7 @@ in email = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The email address to use to authenticate to CloudFlare. ''; }; @@ -26,7 +26,7 @@ in apikeyFile = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The path to a file containing the API Key used to authenticate with CloudFlare. ''; @@ -36,7 +36,7 @@ in default = []; example = [ "host.tld" ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' The records to update in CloudFlare. ''; }; diff --git a/nixos/modules/services/misc/cgminer.nix b/nixos/modules/services/misc/cgminer.nix index 60f75530723b7..a67986d301164 100644 --- a/nixos/modules/services/misc/cgminer.nix +++ b/nixos/modules/services/misc/cgminer.nix @@ -36,20 +36,20 @@ in package = mkOption { default = pkgs.cgminer; defaultText = literalExpression "pkgs.cgminer"; - description = "Which cgminer derivation to use."; + description = lib.mdDoc "Which cgminer derivation to use."; type = types.package; }; user = mkOption { type = types.str; default = "cgminer"; - description = "User account under which cgminer runs"; + description = lib.mdDoc "User account under which cgminer runs"; }; pools = mkOption { default = []; # Run benchmark type = types.listOf (types.attrsOf types.str); - description = "List of pools where to mine"; + description = lib.mdDoc "List of pools where to mine"; example = [{ url = "http://p2pool.org:9332"; username = "17EUZxTvs9uRmPsjPZSYUU3zCz9iwstudk"; @@ -60,7 +60,7 @@ in hardware = mkOption { default = []; # Run without options type = types.listOf (types.attrsOf (types.either types.str types.int)); - description= "List of config options for every GPU"; + description= lib.mdDoc "List of config options for every GPU"; example = [ { intensity = 9; @@ -87,7 +87,7 @@ in config = mkOption { default = {}; type = types.attrsOf (types.either types.bool types.int); - description = "Additional config"; + description = lib.mdDoc "Additional config"; example = { auto-fan = true; auto-gpu = true; diff --git a/nixos/modules/services/misc/clipcat.nix b/nixos/modules/services/misc/clipcat.nix index 8b749aa728969..0c067d23d327a 100644 --- a/nixos/modules/services/misc/clipcat.nix +++ b/nixos/modules/services/misc/clipcat.nix @@ -13,7 +13,7 @@ in { type = types.package; default = pkgs.clipcat; defaultText = literalExpression "pkgs.clipcat"; - description = "clipcat derivation to use."; + description = lib.mdDoc "clipcat derivation to use."; }; }; diff --git a/nixos/modules/services/misc/clipmenu.nix b/nixos/modules/services/misc/clipmenu.nix index ef95985f8d8ae..a31879284e428 100644 --- a/nixos/modules/services/misc/clipmenu.nix +++ b/nixos/modules/services/misc/clipmenu.nix @@ -13,7 +13,7 @@ in { type = types.package; default = pkgs.clipmenu; defaultText = literalExpression "pkgs.clipmenu"; - description = "clipmenu derivation to use."; + description = lib.mdDoc "clipmenu derivation to use."; }; }; diff --git a/nixos/modules/services/misc/confd.nix b/nixos/modules/services/misc/confd.nix index 6c66786524ba8..87a9a25d4913c 100755 --- a/nixos/modules/services/misc/confd.nix +++ b/nixos/modules/services/misc/confd.nix @@ -20,49 +20,49 @@ in { enable = mkEnableOption "confd service"; backend = mkOption { - description = "Confd config storage backend to use."; + description = lib.mdDoc "Confd config storage backend to use."; default = "etcd"; type = types.enum ["etcd" "consul" "redis" "zookeeper"]; }; interval = mkOption { - description = "Confd check interval."; + description = lib.mdDoc "Confd check interval."; default = 10; type = types.int; }; nodes = mkOption { - description = "Confd list of nodes to connect to."; + description = lib.mdDoc "Confd list of nodes to connect to."; default = [ "http://127.0.0.1:2379" ]; type = types.listOf types.str; }; watch = mkOption { - description = "Confd, whether to watch etcd config for changes."; + description = lib.mdDoc "Confd, whether to watch etcd config for changes."; default = true; type = types.bool; }; prefix = mkOption { - description = "The string to prefix to keys."; + description = lib.mdDoc "The string to prefix to keys."; default = "/"; type = types.path; }; logLevel = mkOption { - description = "Confd log level."; + description = lib.mdDoc "Confd log level."; default = "info"; type = types.enum ["info" "debug"]; }; confDir = mkOption { - description = "The path to the confd configs."; + description = lib.mdDoc "The path to the confd configs."; default = "/etc/confd"; type = types.path; }; package = mkOption { - description = "Confd package to use."; + description = lib.mdDoc "Confd package to use."; default = pkgs.confd; defaultText = literalExpression "pkgs.confd"; type = types.package; diff --git a/nixos/modules/services/misc/cpuminer-cryptonight.nix b/nixos/modules/services/misc/cpuminer-cryptonight.nix index 907b9d90da295..7b18c6b3cd208 100644 --- a/nixos/modules/services/misc/cpuminer-cryptonight.nix +++ b/nixos/modules/services/misc/cpuminer-cryptonight.nix @@ -23,27 +23,27 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the cpuminer cryptonight miner. ''; }; url = mkOption { type = types.str; - description = "URL of mining server"; + description = lib.mdDoc "URL of mining server"; }; user = mkOption { type = types.str; - description = "Username for mining server"; + description = lib.mdDoc "Username for mining server"; }; pass = mkOption { type = types.str; default = "x"; - description = "Password for mining server"; + description = lib.mdDoc "Password for mining server"; }; threads = mkOption { type = types.int; default = 0; - description = "Number of miner threads, defaults to available processors"; + description = lib.mdDoc "Number of miner threads, defaults to available processors"; }; }; diff --git a/nixos/modules/services/misc/dictd.nix b/nixos/modules/services/misc/dictd.nix index 8cb51bb0b7a7f..4b714b84f3b20 100644 --- a/nixos/modules/services/misc/dictd.nix +++ b/nixos/modules/services/misc/dictd.nix @@ -17,7 +17,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the DICT.org dictionary server. ''; }; @@ -27,7 +27,7 @@ in default = with pkgs.dictdDBs; [ wiktionary wordnet ]; defaultText = literalExpression "with pkgs.dictdDBs; [ wiktionary wordnet ]"; example = literalExpression "[ pkgs.dictdDBs.nld2eng ]"; - description = "List of databases to make available."; + description = lib.mdDoc "List of databases to make available."; }; }; diff --git a/nixos/modules/services/misc/disnix.nix b/nixos/modules/services/misc/disnix.nix index 07c0613336aa2..08e0a321a238a 100644 --- a/nixos/modules/services/misc/disnix.nix +++ b/nixos/modules/services/misc/disnix.nix @@ -22,14 +22,14 @@ in enableMultiUser = mkOption { type = types.bool; default = true; - description = "Whether to support multi-user mode by enabling the Disnix D-Bus service"; + description = lib.mdDoc "Whether to support multi-user mode by enabling the Disnix D-Bus service"; }; useWebServiceInterface = mkEnableOption "the DisnixWebService interface running on Apache Tomcat"; package = mkOption { type = types.path; - description = "The Disnix package"; + description = lib.mdDoc "The Disnix package"; default = pkgs.disnix; defaultText = literalExpression "pkgs.disnix"; }; @@ -39,7 +39,7 @@ in profiles = mkOption { type = types.listOf types.str; default = [ "default" ]; - description = "Names of the Disnix profiles to expose in the system's PATH"; + description = lib.mdDoc "Names of the Disnix profiles to expose in the system's PATH"; }; }; diff --git a/nixos/modules/services/misc/docker-registry.nix b/nixos/modules/services/misc/docker-registry.nix index cb68a29c530bb..5b32762a36970 100644 --- a/nixos/modules/services/misc/docker-registry.nix +++ b/nixos/modules/services/misc/docker-registry.nix @@ -50,13 +50,13 @@ in { enable = mkEnableOption "Docker Registry"; listenAddress = mkOption { - description = "Docker registry host or ip to bind to."; + description = lib.mdDoc "Docker registry host or ip to bind to."; default = "127.0.0.1"; type = types.str; }; port = mkOption { - description = "Docker registry port to bind to."; + description = lib.mdDoc "Docker registry port to bind to."; default = 5000; type = types.port; }; @@ -64,7 +64,7 @@ in { storagePath = mkOption { type = types.nullOr types.path; default = "/var/lib/docker-registry"; - description = '' + description = lib.mdDoc '' Docker registry storage path for the filesystem storage backend. Set to null to configure another backend via extraConfig. ''; @@ -73,7 +73,7 @@ in { enableDelete = mkOption { type = types.bool; default = false; - description = "Enable delete for manifests and blobs."; + description = lib.mdDoc "Enable delete for manifests and blobs."; }; enableRedisCache = mkEnableOption "redis as blob cache"; @@ -81,17 +81,17 @@ in { redisUrl = mkOption { type = types.str; default = "localhost:6379"; - description = "Set redis host and port."; + description = lib.mdDoc "Set redis host and port."; }; redisPassword = mkOption { type = types.str; default = ""; - description = "Set redis password."; + description = lib.mdDoc "Set redis password."; }; extraConfig = mkOption { - description = '' + description = lib.mdDoc '' Docker extra registry configuration via environment variables. ''; default = {}; diff --git a/nixos/modules/services/misc/domoticz.nix b/nixos/modules/services/misc/domoticz.nix index b1353d484048f..d01158b327a60 100644 --- a/nixos/modules/services/misc/domoticz.nix +++ b/nixos/modules/services/misc/domoticz.nix @@ -17,13 +17,13 @@ in { bind = mkOption { type = types.str; default = "0.0.0.0"; - description = "IP address to bind to."; + description = lib.mdDoc "IP address to bind to."; }; port = mkOption { type = types.int; default = 8080; - description = "Port to bind to for HTTP, set to 0 to disable HTTP."; + description = lib.mdDoc "Port to bind to for HTTP, set to 0 to disable HTTP."; }; }; diff --git a/nixos/modules/services/misc/duckling.nix b/nixos/modules/services/misc/duckling.nix index 77d2a92380b09..55a87fccf8e70 100644 --- a/nixos/modules/services/misc/duckling.nix +++ b/nixos/modules/services/misc/duckling.nix @@ -12,7 +12,7 @@ in { port = mkOption { type = types.port; default = 8080; - description = '' + description = lib.mdDoc '' Port on which duckling will run. ''; }; diff --git a/nixos/modules/services/misc/dwm-status.nix b/nixos/modules/services/misc/dwm-status.nix index 5f591b3c5d41a..92705e5515ea8 100644 --- a/nixos/modules/services/misc/dwm-status.nix +++ b/nixos/modules/services/misc/dwm-status.nix @@ -29,14 +29,14 @@ in default = pkgs.dwm-status; defaultText = literalExpression "pkgs.dwm-status"; example = literalExpression "pkgs.dwm-status.override { enableAlsaUtils = false; }"; - description = '' + description = lib.mdDoc '' Which dwm-status package to use. ''; }; order = mkOption { type = types.listOf (types.enum [ "audio" "backlight" "battery" "cpu_load" "network" "time" ]); - description = '' + description = lib.mdDoc '' List of enabled features in order. ''; }; @@ -44,7 +44,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra config in TOML format. ''; }; diff --git a/nixos/modules/services/misc/dysnomia.nix b/nixos/modules/services/misc/dysnomia.nix index 1964fa93f9369..4d748ec6eb66d 100644 --- a/nixos/modules/services/misc/dysnomia.nix +++ b/nixos/modules/services/misc/dysnomia.nix @@ -87,52 +87,52 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable Dysnomia"; + description = lib.mdDoc "Whether to enable Dysnomia"; }; enableAuthentication = mkOption { type = types.bool; default = false; - description = "Whether to publish privacy-sensitive authentication credentials"; + description = lib.mdDoc "Whether to publish privacy-sensitive authentication credentials"; }; package = mkOption { type = types.path; - description = "The Dysnomia package"; + description = lib.mdDoc "The Dysnomia package"; }; properties = mkOption { - description = "An attribute set in which each attribute represents a machine property. Optionally, these values can be shell substitutions."; + description = lib.mdDoc "An attribute set in which each attribute represents a machine property. Optionally, these values can be shell substitutions."; default = {}; type = types.attrs; }; containers = mkOption { - description = "An attribute set in which each key represents a container and each value an attribute set providing its configuration properties"; + description = lib.mdDoc "An attribute set in which each key represents a container and each value an attribute set providing its configuration properties"; default = {}; type = types.attrsOf types.attrs; }; components = mkOption { - description = "An atttribute set in which each key represents a container and each value an attribute set in which each key represents a component and each value a derivation constructing its initial state"; + description = lib.mdDoc "An atttribute set in which each key represents a container and each value an attribute set in which each key represents a component and each value a derivation constructing its initial state"; default = {}; type = types.attrsOf types.attrs; }; extraContainerProperties = mkOption { - description = "An attribute set providing additional container settings in addition to the default properties"; + description = lib.mdDoc "An attribute set providing additional container settings in addition to the default properties"; default = {}; type = types.attrs; }; extraContainerPaths = mkOption { - description = "A list of paths containing additional container configurations that are added to the search folders"; + description = lib.mdDoc "A list of paths containing additional container configurations that are added to the search folders"; default = []; type = types.listOf types.path; }; extraModulePaths = mkOption { - description = "A list of paths containing additional modules that are added to the search folders"; + description = lib.mdDoc "A list of paths containing additional modules that are added to the search folders"; default = []; type = types.listOf types.path; }; @@ -140,7 +140,7 @@ in enableLegacyModules = mkOption { type = types.bool; default = true; - description = "Whether to enable Dysnomia legacy process and wrapper modules"; + description = lib.mdDoc "Whether to enable Dysnomia legacy process and wrapper modules"; }; }; }; diff --git a/nixos/modules/services/misc/errbot.nix b/nixos/modules/services/misc/errbot.nix index b447ba5d438d2..a650bc5bbd921 100644 --- a/nixos/modules/services/misc/errbot.nix +++ b/nixos/modules/services/misc/errbot.nix @@ -27,48 +27,48 @@ in { options = { services.errbot.instances = mkOption { default = {}; - description = "Errbot instance configs"; + description = lib.mdDoc "Errbot instance configs"; type = types.attrsOf (types.submodule { options = { dataDir = mkOption { type = types.nullOr types.path; default = null; - description = "Data directory for errbot instance."; + description = lib.mdDoc "Data directory for errbot instance."; }; plugins = mkOption { type = types.listOf types.package; default = []; - description = "List of errbot plugin derivations."; + description = lib.mdDoc "List of errbot plugin derivations."; }; logLevel = mkOption { type = types.str; default = "INFO"; - description = "Errbot log level"; + description = lib.mdDoc "Errbot log level"; }; admins = mkOption { type = types.listOf types.str; default = []; - description = "List of identifiers of errbot admins."; + description = lib.mdDoc "List of identifiers of errbot admins."; }; backend = mkOption { type = types.str; default = "XMPP"; - description = "Errbot backend name."; + description = lib.mdDoc "Errbot backend name."; }; identity = mkOption { type = types.attrs; - description = "Errbot identity configuration"; + description = lib.mdDoc "Errbot identity configuration"; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "String to be appended to the config verbatim"; + description = lib.mdDoc "String to be appended to the config verbatim"; }; }; }); diff --git a/nixos/modules/services/misc/etcd.nix b/nixos/modules/services/misc/etcd.nix index 3925b7dd16367..d589ad780c1b0 100644 --- a/nixos/modules/services/misc/etcd.nix +++ b/nixos/modules/services/misc/etcd.nix @@ -10,116 +10,116 @@ in { options.services.etcd = { enable = mkOption { - description = "Whether to enable etcd."; + description = lib.mdDoc "Whether to enable etcd."; default = false; type = types.bool; }; name = mkOption { - description = "Etcd unique node name."; + description = lib.mdDoc "Etcd unique node name."; default = config.networking.hostName; defaultText = literalExpression "config.networking.hostName"; type = types.str; }; advertiseClientUrls = mkOption { - description = "Etcd list of this member's client URLs to advertise to the rest of the cluster."; + description = lib.mdDoc "Etcd list of this member's client URLs to advertise to the rest of the cluster."; default = cfg.listenClientUrls; defaultText = literalExpression "config.${opt.listenClientUrls}"; type = types.listOf types.str; }; listenClientUrls = mkOption { - description = "Etcd list of URLs to listen on for client traffic."; + description = lib.mdDoc "Etcd list of URLs to listen on for client traffic."; default = ["http://127.0.0.1:2379"]; type = types.listOf types.str; }; listenPeerUrls = mkOption { - description = "Etcd list of URLs to listen on for peer traffic."; + description = lib.mdDoc "Etcd list of URLs to listen on for peer traffic."; default = ["http://127.0.0.1:2380"]; type = types.listOf types.str; }; initialAdvertisePeerUrls = mkOption { - description = "Etcd list of this member's peer URLs to advertise to rest of the cluster."; + description = lib.mdDoc "Etcd list of this member's peer URLs to advertise to rest of the cluster."; default = cfg.listenPeerUrls; defaultText = literalExpression "config.${opt.listenPeerUrls}"; type = types.listOf types.str; }; initialCluster = mkOption { - description = "Etcd initial cluster configuration for bootstrapping."; + description = lib.mdDoc "Etcd initial cluster configuration for bootstrapping."; default = ["${cfg.name}=http://127.0.0.1:2380"]; defaultText = literalExpression ''["''${config.${opt.name}}=http://127.0.0.1:2380"]''; type = types.listOf types.str; }; initialClusterState = mkOption { - description = "Etcd initial cluster configuration for bootstrapping."; + description = lib.mdDoc "Etcd initial cluster configuration for bootstrapping."; default = "new"; type = types.enum ["new" "existing"]; }; initialClusterToken = mkOption { - description = "Etcd initial cluster token for etcd cluster during bootstrap."; + description = lib.mdDoc "Etcd initial cluster token for etcd cluster during bootstrap."; default = "etcd-cluster"; type = types.str; }; discovery = mkOption { - description = "Etcd discovery url"; + description = lib.mdDoc "Etcd discovery url"; default = ""; type = types.str; }; clientCertAuth = mkOption { - description = "Whether to use certs for client authentication"; + description = lib.mdDoc "Whether to use certs for client authentication"; default = false; type = types.bool; }; trustedCaFile = mkOption { - description = "Certificate authority file to use for clients"; + description = lib.mdDoc "Certificate authority file to use for clients"; default = null; type = types.nullOr types.path; }; certFile = mkOption { - description = "Cert file to use for clients"; + description = lib.mdDoc "Cert file to use for clients"; default = null; type = types.nullOr types.path; }; keyFile = mkOption { - description = "Key file to use for clients"; + description = lib.mdDoc "Key file to use for clients"; default = null; type = types.nullOr types.path; }; peerCertFile = mkOption { - description = "Cert file to use for peer to peer communication"; + description = lib.mdDoc "Cert file to use for peer to peer communication"; default = cfg.certFile; defaultText = literalExpression "config.${opt.certFile}"; type = types.nullOr types.path; }; peerKeyFile = mkOption { - description = "Key file to use for peer to peer communication"; + description = lib.mdDoc "Key file to use for peer to peer communication"; default = cfg.keyFile; defaultText = literalExpression "config.${opt.keyFile}"; type = types.nullOr types.path; }; peerTrustedCaFile = mkOption { - description = "Certificate authority file to use for peer to peer communication"; + description = lib.mdDoc "Certificate authority file to use for peer to peer communication"; default = cfg.trustedCaFile; defaultText = literalExpression "config.${opt.trustedCaFile}"; type = types.nullOr types.path; }; peerClientCertAuth = mkOption { - description = "Whether to check all incoming peer requests from the cluster for valid client certificates signed by the supplied CA"; + description = lib.mdDoc "Whether to check all incoming peer requests from the cluster for valid client certificates signed by the supplied CA"; default = false; type = types.bool; }; @@ -145,7 +145,7 @@ in { dataDir = mkOption { type = types.path; default = "/var/lib/etcd"; - description = "Etcd data directory."; + description = lib.mdDoc "Etcd data directory."; }; }; diff --git a/nixos/modules/services/misc/etebase-server.nix b/nixos/modules/services/misc/etebase-server.nix index cb99364aa1a60..24be9e8e2692b 100644 --- a/nixos/modules/services/misc/etebase-server.nix +++ b/nixos/modules/services/misc/etebase-server.nix @@ -36,12 +36,12 @@ in type = types.bool; default = false; example = true; - description = '' + description = lib.mdDoc '' Whether to enable the Etebase server. Once enabled you need to create an admin user by invoking the - shell command <literal>etebase-server createsuperuser</literal> with - the user specified by the <literal>user</literal> option or a superuser. + shell command `etebase-server createsuperuser` with + the user specified by the `user` option or a superuser. Then you can login and create accounts on your-etebase-server.com/admin ''; }; @@ -49,19 +49,19 @@ in dataDir = mkOption { type = types.str; default = "/var/lib/etebase-server"; - description = "Directory to store the Etebase server data."; + description = lib.mdDoc "Directory to store the Etebase server data."; }; port = mkOption { type = with types; nullOr port; default = 8001; - description = "Port to listen on."; + description = lib.mdDoc "Port to listen on."; }; openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to open ports in the firewall for the server. ''; }; @@ -69,7 +69,7 @@ in unixSocket = mkOption { type = with types; nullOr str; default = null; - description = "The path to the socket to bind to."; + description = lib.mdDoc "The path to the socket to bind to."; example = "/run/etebase-server/etebase-server.sock"; }; @@ -82,14 +82,14 @@ in debug = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to set django's DEBUG flag. ''; }; secret_file = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' The path to a file containing the secret used as django's SECRET_KEY. ''; @@ -98,13 +98,13 @@ in type = types.str; default = "${cfg.dataDir}/static"; defaultText = literalExpression ''"''${config.services.etebase-server.dataDir}/static"''; - description = "The directory for static files."; + description = lib.mdDoc "The directory for static files."; }; media_root = mkOption { type = types.str; default = "${cfg.dataDir}/media"; defaultText = literalExpression ''"''${config.services.etebase-server.dataDir}/media"''; - description = "The media directory."; + description = lib.mdDoc "The media directory."; }; }; allowed_hosts = { @@ -112,7 +112,7 @@ in type = types.str; default = "0.0.0.0"; example = "localhost"; - description = '' + description = lib.mdDoc '' The main host that is allowed access. ''; }; @@ -121,13 +121,13 @@ in engine = mkOption { type = types.enum [ "django.db.backends.sqlite3" "django.db.backends.postgresql" ]; default = "django.db.backends.sqlite3"; - description = "The database engine to use."; + description = lib.mdDoc "The database engine to use."; }; name = mkOption { type = types.str; default = "${cfg.dataDir}/db.sqlite3"; defaultText = literalExpression ''"''${config.services.etebase-server.dataDir}/db.sqlite3"''; - description = "The database name."; + description = lib.mdDoc "The database name."; }; }; }; @@ -153,7 +153,7 @@ in user = mkOption { type = types.str; default = defaultUser; - description = "User under which Etebase server runs."; + description = lib.mdDoc "User under which Etebase server runs."; }; }; }; diff --git a/nixos/modules/services/misc/etesync-dav.nix b/nixos/modules/services/misc/etesync-dav.nix index 9d7cfda371b13..6a755be8500a4 100644 --- a/nixos/modules/services/misc/etesync-dav.nix +++ b/nixos/modules/services/misc/etesync-dav.nix @@ -12,32 +12,32 @@ in host = mkOption { type = types.str; default = "localhost"; - description = "The server host address."; + description = lib.mdDoc "The server host address."; }; port = mkOption { type = types.port; default = 37358; - description = "The server host port."; + description = lib.mdDoc "The server host port."; }; apiUrl = mkOption { type = types.str; default = "https://api.etesync.com/"; - description = "The url to the etesync API."; + description = lib.mdDoc "The url to the etesync API."; }; openFirewall = mkOption { default = false; type = types.bool; - description = "Whether to open the firewall for the specified port."; + description = lib.mdDoc "Whether to open the firewall for the specified port."; }; sslCertificate = mkOption { type = types.nullOr types.path; default = null; example = "/var/etesync.crt"; - description = '' + description = lib.mdDoc '' Path to server SSL certificate. It will be copied into etesync-dav's data directory. ''; @@ -47,7 +47,7 @@ in type = types.nullOr types.path; default = null; example = "/var/etesync.key"; - description = '' + description = lib.mdDoc '' Path to server SSL certificate key. It will be copied into etesync-dav's data directory. ''; diff --git a/nixos/modules/services/misc/ethminer.nix b/nixos/modules/services/misc/ethminer.nix index 2236346698288..909c49866e543 100644 --- a/nixos/modules/services/misc/ethminer.nix +++ b/nixos/modules/services/misc/ethminer.nix @@ -18,61 +18,61 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable ethminer ether mining."; + description = lib.mdDoc "Enable ethminer ether mining."; }; recheckInterval = mkOption { type = types.ints.unsigned; default = 2000; - description = "Interval in milliseconds between farm rechecks."; + description = lib.mdDoc "Interval in milliseconds between farm rechecks."; }; toolkit = mkOption { type = types.enum [ "cuda" "opencl" ]; default = "cuda"; - description = "Cuda or opencl toolkit."; + description = lib.mdDoc "Cuda or opencl toolkit."; }; apiPort = mkOption { type = types.int; default = -3333; - description = "Ethminer api port. minus sign puts api in read-only mode."; + description = lib.mdDoc "Ethminer api port. minus sign puts api in read-only mode."; }; wallet = mkOption { type = types.str; example = "0x0123456789abcdef0123456789abcdef01234567"; - description = "Ethereum wallet address."; + description = lib.mdDoc "Ethereum wallet address."; }; pool = mkOption { type = types.str; example = "eth-us-east1.nanopool.org"; - description = "Mining pool address."; + description = lib.mdDoc "Mining pool address."; }; stratumPort = mkOption { type = types.port; default = 9999; - description = "Stratum protocol tcp port."; + description = lib.mdDoc "Stratum protocol tcp port."; }; rig = mkOption { type = types.str; default = "mining-rig-name"; - description = "Mining rig name."; + description = lib.mdDoc "Mining rig name."; }; registerMail = mkOption { type = types.str; example = "email%40example.org"; - description = "Url encoded email address to register with pool."; + description = lib.mdDoc "Url encoded email address to register with pool."; }; maxPower = mkOption { type = types.ints.unsigned; default = 113; - description = "Miner max watt usage."; + description = lib.mdDoc "Miner max watt usage."; }; }; diff --git a/nixos/modules/services/misc/exhibitor.nix b/nixos/modules/services/misc/exhibitor.nix index 4c935efbd8440..3db42b8e4a43f 100644 --- a/nixos/modules/services/misc/exhibitor.nix +++ b/nixos/modules/services/misc/exhibitor.nix @@ -80,69 +80,69 @@ in port = mkOption { type = types.int; default = 8080; - description = '' + description = lib.mdDoc '' The port for exhibitor to listen on and communicate with other exhibitors. ''; }; baseDir = mkOption { type = types.str; default = "/var/exhibitor"; - description = '' + description = lib.mdDoc '' Baseline directory for exhibitor runtime config. ''; }; configType = mkOption { type = types.enum [ "file" "s3" "zookeeper" "none" ]; - description = '' + description = lib.mdDoc '' Which configuration type you want to use. Additional config will be required depending on which type you are using. ''; }; hostname = mkOption { type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' Hostname to use and advertise ''; default = null; }; nodeModification = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Whether the Explorer UI will allow nodes to be modified (use with caution). ''; default = true; }; configCheckMs = mkOption { type = types.int; - description = '' + description = lib.mdDoc '' Period (ms) to check for shared config updates. ''; default = 30000; }; headingText = mkOption { type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' Extra text to display in UI header ''; default = null; }; jqueryStyle = mkOption { type = types.enum [ "red" "black" "custom" ]; - description = '' + description = lib.mdDoc '' Styling used for the JQuery-based UI. ''; default = "red"; }; logLines = mkOption { type = types.int; - description = '' + description = lib.mdDoc '' Max lines of logging to keep in memory for display. ''; default = 1000; }; servo = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' ZooKeeper will be queried once a minute for its state via the 'mntr' four letter word (this requires ZooKeeper 3.4.x+). Servo will be used to publish this data via JMX. @@ -151,14 +151,14 @@ in }; timeout = mkOption { type = types.int; - description = '' + description = lib.mdDoc '' Connection timeout (ms) for ZK connections. ''; default = 30000; }; autoManageInstances = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Automatically manage ZooKeeper instances in the ensemble ''; default = false; @@ -167,7 +167,7 @@ in type = types.str; default = "${cfg.baseDir}/zkData"; defaultText = literalExpression ''"''${config.${opt.baseDir}}/zkData"''; - description = '' + description = lib.mdDoc '' The Zookeeper data directory ''; }; @@ -175,56 +175,56 @@ in type = types.path; default = "${cfg.baseDir}/zkLogs"; defaultText = literalExpression ''"''${config.${opt.baseDir}}/zkLogs"''; - description = '' + description = lib.mdDoc '' The Zookeeper logs directory ''; }; extraConf = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Extra Exhibitor configuration to put in the ZooKeeper config file. ''; }; zkExtraCfg = mkOption { type = types.str; default = "initLimit=5&syncLimit=2&tickTime=2000"; - description = '' + description = lib.mdDoc '' Extra options to pass into Zookeeper ''; }; zkClientPort = mkOption { type = types.int; default = 2181; - description = '' + description = lib.mdDoc '' Zookeeper client port ''; }; zkConnectPort = mkOption { type = types.int; default = 2888; - description = '' + description = lib.mdDoc '' The port to use for followers to talk to each other. ''; }; zkElectionPort = mkOption { type = types.int; default = 3888; - description = '' + description = lib.mdDoc '' The port for Zookeepers to use for leader election. ''; }; zkCleanupPeriod = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' How often (in milliseconds) to run the Zookeeper log cleanup task. ''; }; zkServersSpec = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Zookeeper server spec for all servers in the ensemble. ''; example = [ "S:1:zk1.example.com" "S:2:zk2.example.com" "S:3:zk3.example.com" "O:4:zk-observer.example.com" ]; @@ -234,14 +234,14 @@ in s3Backup = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable backups to S3 ''; }; fileSystemBackup = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enables file system backup of ZooKeeper log files ''; }; @@ -249,21 +249,21 @@ in # Options for using zookeeper configType zkConfigConnect = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' The initial connection string for ZooKeeper shared config storage ''; example = ["host1:2181" "host2:2181"]; }; zkConfigExhibitorPath = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' If the ZooKeeper shared config is also running Exhibitor, the URI path for the REST call ''; default = "/"; }; zkConfigExhibitorPort = mkOption { type = types.nullOr types.int; - description = '' + description = lib.mdDoc '' If the ZooKeeper shared config is also running Exhibitor, the port that Exhibitor is listening on. IMPORTANT: if this value is not set it implies that Exhibitor is not being used on the ZooKeeper shared config. @@ -271,7 +271,7 @@ in }; zkConfigPollMs = mkOption { type = types.int; - description = '' + description = lib.mdDoc '' The period in ms to check for changes in the config ensemble ''; default = 10000; @@ -280,21 +280,21 @@ in sleepMs = mkOption { type = types.int; default = 1000; - description = '' + description = lib.mdDoc '' Retry sleep time connecting to the ZooKeeper config ''; }; retryQuantity = mkOption { type = types.int; default = 3; - description = '' + description = lib.mdDoc '' Retries connecting to the ZooKeeper config ''; }; }; zkConfigZPath = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The base ZPath that Exhibitor should use ''; example = "/exhibitor/config"; @@ -304,19 +304,19 @@ in s3Config = { bucketName = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Bucket name to store config ''; }; objectKey = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' S3 key name to store the config ''; }; configPrefix = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' When using AWS S3 shared config files, the prefix to use for values such as locks ''; default = "exhibitor-"; @@ -326,7 +326,7 @@ in # The next two are used for either s3backup or s3 configType s3Credentials = mkOption { type = types.nullOr types.path; - description = '' + description = lib.mdDoc '' Optional credentials to use for s3backup or s3config. Argument is the path to an AWS credential properties file with two properties: com.netflix.exhibitor.s3.access-key-id and com.netflix.exhibitor.s3.access-secret-key @@ -335,7 +335,7 @@ in }; s3Region = mkOption { type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' Optional region for S3 calls ''; default = null; @@ -344,7 +344,7 @@ in # Config options for file config type fsConfigDir = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' Directory to store Exhibitor properties (cannot be used with s3config). Exhibitor uses file system locks so you can specify a shared location so as to enable complete ensemble management. @@ -352,14 +352,14 @@ in }; fsConfigLockPrefix = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' A prefix for a locking mechanism used in conjunction with fsconfigdir ''; default = "exhibitor-lock-"; }; fsConfigName = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The name of the file to store config in ''; default = "exhibitor.properties"; diff --git a/nixos/modules/services/misc/felix.nix b/nixos/modules/services/misc/felix.nix index 0283de128afe4..7654ad284409b 100644 --- a/nixos/modules/services/misc/felix.nix +++ b/nixos/modules/services/misc/felix.nix @@ -23,19 +23,19 @@ in type = types.listOf types.package; default = [ pkgs.felix_remoteshell ]; defaultText = literalExpression "[ pkgs.felix_remoteshell ]"; - description = "List of bundles that should be activated on startup"; + description = lib.mdDoc "List of bundles that should be activated on startup"; }; user = mkOption { type = types.str; default = "osgi"; - description = "User account under which Apache Felix runs."; + description = lib.mdDoc "User account under which Apache Felix runs."; }; group = mkOption { type = types.str; default = "osgi"; - description = "Group account under which Apache Felix runs."; + description = lib.mdDoc "Group account under which Apache Felix runs."; }; }; diff --git a/nixos/modules/services/misc/freeswitch.nix b/nixos/modules/services/misc/freeswitch.nix index 472b0b73ff69d..8a74b229ce34b 100644 --- a/nixos/modules/services/misc/freeswitch.nix +++ b/nixos/modules/services/misc/freeswitch.nix @@ -34,9 +34,9 @@ in { default = "${config.services.freeswitch.package}/share/freeswitch/conf/vanilla"; defaultText = literalExpression ''"''${config.services.freeswitch.package}/share/freeswitch/conf/vanilla"''; example = literalExpression ''"''${config.services.freeswitch.package}/share/freeswitch/conf/minimal"''; - description = '' + description = lib.mdDoc '' Configuration template to use. - See available templates in <link xlink:href="https://github.com/signalwire/freeswitch/tree/master/conf">FreeSWITCH repository</link>. + See available templates in [FreeSWITCH repository](https://github.com/signalwire/freeswitch/tree/master/conf). You can also set your own configuration directory. ''; }; @@ -51,18 +51,18 @@ in { '''; } ''; - description = '' + description = lib.mdDoc '' Override file in FreeSWITCH config template directory. Each top-level attribute denotes a file path in the configuration directory, its value is the file path. - See <link xlink:href="https://freeswitch.org/confluence/display/FREESWITCH/Default+Configuration">FreeSWITCH documentation</link> for more info. - Also check available templates in <link xlink:href="https://github.com/signalwire/freeswitch/tree/master/conf">FreeSWITCH repository</link>. + See [FreeSWITCH documentation](https://freeswitch.org/confluence/display/FREESWITCH/Default+Configuration) for more info. + Also check available templates in [FreeSWITCH repository](https://github.com/signalwire/freeswitch/tree/master/conf). ''; }; package = mkOption { type = types.package; default = pkgs.freeswitch; defaultText = literalExpression "pkgs.freeswitch"; - description = '' + description = lib.mdDoc '' FreeSWITCH package. ''; }; diff --git a/nixos/modules/services/misc/gammu-smsd.nix b/nixos/modules/services/misc/gammu-smsd.nix index d4bb58d81dde3..daa0e22e327a9 100644 --- a/nixos/modules/services/misc/gammu-smsd.nix +++ b/nixos/modules/services/misc/gammu-smsd.nix @@ -58,39 +58,39 @@ in { user = mkOption { type = types.str; default = "smsd"; - description = "User that has access to the device"; + description = lib.mdDoc "User that has access to the device"; }; device = { path = mkOption { type = types.path; - description = "Device node or address of the phone"; + description = lib.mdDoc "Device node or address of the phone"; example = "/dev/ttyUSB2"; }; group = mkOption { type = types.str; default = "root"; - description = "Owner group of the device"; + description = lib.mdDoc "Owner group of the device"; example = "dialout"; }; connection = mkOption { type = types.str; default = "at"; - description = "Protocol which will be used to talk to the phone"; + description = lib.mdDoc "Protocol which will be used to talk to the phone"; }; synchronizeTime = mkOption { type = types.bool; default = true; - description = "Whether to set time from computer to the phone during starting connection"; + description = lib.mdDoc "Whether to set time from computer to the phone during starting connection"; }; pin = mkOption { type = types.nullOr types.str; default = null; - description = "PIN code for the simcard"; + description = lib.mdDoc "PIN code for the simcard"; }; }; @@ -99,13 +99,13 @@ in { file = mkOption { type = types.str; default = "syslog"; - description = "Path to file where information about communication will be stored"; + description = lib.mdDoc "Path to file where information about communication will be stored"; }; format = mkOption { type = types.enum [ "nothing" "text" "textall" "textalldate" "errors" "errorsdate" "binary" ]; default = "errors"; - description = "Determines what will be logged to the LogFile"; + description = lib.mdDoc "Determines what will be logged to the LogFile"; }; }; @@ -114,14 +114,14 @@ in { gammu = mkOption { type = types.lines; default = ""; - description = "Extra config lines to be added into [gammu] section"; + description = lib.mdDoc "Extra config lines to be added into [gammu] section"; }; smsd = mkOption { type = types.lines; default = ""; - description = "Extra config lines to be added into [smsd] section"; + description = lib.mdDoc "Extra config lines to be added into [smsd] section"; }; }; @@ -130,69 +130,69 @@ in { service = mkOption { type = types.enum [ "null" "files" "sql" ]; default = "null"; - description = "Service to use to store sms data."; + description = lib.mdDoc "Service to use to store sms data."; }; files = { inboxPath = mkOption { type = types.path; default = "/var/spool/sms/inbox/"; - description = "Where the received SMSes are stored"; + description = lib.mdDoc "Where the received SMSes are stored"; }; outboxPath = mkOption { type = types.path; default = "/var/spool/sms/outbox/"; - description = "Where SMSes to be sent should be placed"; + description = lib.mdDoc "Where SMSes to be sent should be placed"; }; sentSMSPath = mkOption { type = types.path; default = "/var/spool/sms/sent/"; - description = "Where the transmitted SMSes are placed"; + description = lib.mdDoc "Where the transmitted SMSes are placed"; }; errorSMSPath = mkOption { type = types.path; default = "/var/spool/sms/error/"; - description = "Where SMSes with error in transmission is placed"; + description = lib.mdDoc "Where SMSes with error in transmission is placed"; }; }; sql = { driver = mkOption { type = types.enum [ "native_mysql" "native_pgsql" "odbc" "dbi" ]; - description = "DB driver to use"; + description = lib.mdDoc "DB driver to use"; }; sqlDialect = mkOption { type = types.nullOr types.str; default = null; - description = "SQL dialect to use (odbc driver only)"; + description = lib.mdDoc "SQL dialect to use (odbc driver only)"; }; database = mkOption { type = types.nullOr types.str; default = null; - description = "Database name to store sms data"; + description = lib.mdDoc "Database name to store sms data"; }; host = mkOption { type = types.str; default = "localhost"; - description = "Database server address"; + description = lib.mdDoc "Database server address"; }; user = mkOption { type = types.nullOr types.str; default = null; - description = "User name used for connection to the database"; + description = lib.mdDoc "User name used for connection to the database"; }; password = mkOption { type = types.nullOr types.str; default = null; - description = "User password used for connetion to the database"; + description = lib.mdDoc "User password used for connetion to the database"; }; }; }; diff --git a/nixos/modules/services/misc/geoipupdate.nix b/nixos/modules/services/misc/geoipupdate.nix index db643c3d84795..20bbba0aad9ae 100644 --- a/nixos/modules/services/misc/geoipupdate.nix +++ b/nixos/modules/services/misc/geoipupdate.nix @@ -65,7 +65,7 @@ in AccountID = lib.mkOption { type = lib.types.int; - description = '' + description = lib.mdDoc '' Your MaxMind account ID. ''; }; @@ -77,10 +77,10 @@ in "GeoLite2-City" "GeoLite2-Country" ]; - description = '' + description = lib.mdDoc '' List of database edition IDs. This includes new string - IDs like <literal>GeoIP2-City</literal> and old - numeric IDs like <literal>106</literal>. + IDs like `GeoIP2-City` and old + numeric IDs like `106`. ''; }; @@ -103,10 +103,10 @@ in type = lib.types.path; default = "/var/lib/GeoIP"; example = "/run/GeoIP"; - description = '' + description = lib.mdDoc '' The directory to store the database files in. The directory will be automatically created, the owner - changed to <literal>geoip</literal> and permissions + changed to `geoip` and permissions set to world readable. This applies if the directory already exists as well, so don't use a directory with sensitive contents. diff --git a/nixos/modules/services/misc/gitea.nix b/nixos/modules/services/misc/gitea.nix index 81ec0d7c47e1b..82345ad78631a 100644 --- a/nixos/modules/services/misc/gitea.nix +++ b/nixos/modules/services/misc/gitea.nix @@ -27,26 +27,26 @@ in enable = mkOption { default = false; type = types.bool; - description = "Enable Gitea Service."; + description = lib.mdDoc "Enable Gitea Service."; }; package = mkOption { default = pkgs.gitea; type = types.package; defaultText = literalExpression "pkgs.gitea"; - description = "gitea derivation to use"; + description = lib.mdDoc "gitea derivation to use"; }; useWizard = mkOption { default = false; type = types.bool; - description = "Do not generate a configuration and use gitea' installation wizard instead. The first registered user will be administrator."; + description = lib.mdDoc "Do not generate a configuration and use gitea' installation wizard instead. The first registered user will be administrator."; }; stateDir = mkOption { default = "/var/lib/gitea"; type = types.str; - description = "gitea data directory."; + description = lib.mdDoc "gitea data directory."; }; log = { @@ -54,19 +54,19 @@ in default = "${cfg.stateDir}/log"; defaultText = literalExpression ''"''${config.${opt.stateDir}}/log"''; type = types.str; - description = "Root path for log files."; + description = lib.mdDoc "Root path for log files."; }; level = mkOption { default = "Info"; type = types.enum [ "Trace" "Debug" "Info" "Warn" "Error" "Critical" ]; - description = "General log level."; + description = lib.mdDoc "General log level."; }; }; user = mkOption { type = types.str; default = "gitea"; - description = "User account under which gitea runs."; + description = lib.mdDoc "User account under which gitea runs."; }; database = { @@ -74,13 +74,13 @@ in type = types.enum [ "sqlite3" "mysql" "postgres" ]; example = "mysql"; default = "sqlite3"; - description = "Database engine to use."; + description = lib.mdDoc "Database engine to use."; }; host = mkOption { type = types.str; default = "127.0.0.1"; - description = "Database host address."; + description = lib.mdDoc "Database host address."; }; port = mkOption { @@ -91,28 +91,28 @@ in then 3306 else config.${options.services.postgresql.port} ''; - description = "Database host port."; + description = lib.mdDoc "Database host port."; }; name = mkOption { type = types.str; default = "gitea"; - description = "Database name."; + description = lib.mdDoc "Database name."; }; user = mkOption { type = types.str; default = "gitea"; - description = "Database user."; + description = lib.mdDoc "Database user."; }; password = mkOption { type = types.str; default = ""; - description = '' - The password corresponding to <option>database.user</option>. + description = lib.mdDoc '' + The password corresponding to {option}`database.user`. Warning: this is stored in cleartext in the Nix store! - Use <option>database.passwordFile</option> instead. + Use {option}`database.passwordFile` instead. ''; }; @@ -120,9 +120,9 @@ in type = types.nullOr types.path; default = null; example = "/run/keys/gitea-dbpassword"; - description = '' + description = lib.mdDoc '' A file containing the password corresponding to - <option>database.user</option>. + {option}`database.user`. ''; }; @@ -131,20 +131,20 @@ in default = if (cfg.database.createDatabase && usePostgresql) then "/run/postgresql" else if (cfg.database.createDatabase && useMysql) then "/run/mysqld/mysqld.sock" else null; defaultText = literalExpression "null"; example = "/run/mysqld/mysqld.sock"; - description = "Path to the unix socket file to use for authentication."; + description = lib.mdDoc "Path to the unix socket file to use for authentication."; }; path = mkOption { type = types.str; default = "${cfg.stateDir}/data/gitea.db"; defaultText = literalExpression ''"''${config.${opt.stateDir}}/data/gitea.db"''; - description = "Path to the sqlite3 database file."; + description = lib.mdDoc "Path to the sqlite3 database file."; }; createDatabase = mkOption { type = types.bool; default = true; - description = "Whether to create a local database automatically."; + description = lib.mdDoc "Whether to create a local database automatically."; }; }; @@ -152,7 +152,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable a timer that runs gitea dump to generate backup-files of the current gitea database and repositories. ''; @@ -175,13 +175,13 @@ in type = types.str; default = "${cfg.stateDir}/dump"; defaultText = literalExpression ''"''${config.${opt.stateDir}}/dump"''; - description = "Path to the dump files."; + description = lib.mdDoc "Path to the dump files."; }; type = mkOption { type = types.enum [ "zip" "rar" "tar" "sz" "tar.gz" "tar.xz" "tar.bz2" "tar.br" "tar.lz4" ]; default = "zip"; - description = "Archive format used to store the dump file."; + description = lib.mdDoc "Archive format used to store the dump file."; }; file = mkOption { @@ -196,14 +196,14 @@ in enable = mkOption { type = types.bool; default = true; - description = "Enable external SSH feature."; + description = lib.mdDoc "Enable external SSH feature."; }; clonePort = mkOption { type = types.int; default = 22; example = 2222; - description = '' + description = lib.mdDoc '' SSH port displayed in clone URL. The option is required to configure a service when the external visible port differs from the local listening port i.e. if port forwarding is used. @@ -215,64 +215,64 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enables git-lfs support."; + description = lib.mdDoc "Enables git-lfs support."; }; contentDir = mkOption { type = types.str; default = "${cfg.stateDir}/data/lfs"; defaultText = literalExpression ''"''${config.${opt.stateDir}}/data/lfs"''; - description = "Where to store LFS files."; + description = lib.mdDoc "Where to store LFS files."; }; }; appName = mkOption { type = types.str; default = "gitea: Gitea Service"; - description = "Application name."; + description = lib.mdDoc "Application name."; }; repositoryRoot = mkOption { type = types.str; default = "${cfg.stateDir}/repositories"; defaultText = literalExpression ''"''${config.${opt.stateDir}}/repositories"''; - description = "Path to the git repositories."; + description = lib.mdDoc "Path to the git repositories."; }; domain = mkOption { type = types.str; default = "localhost"; - description = "Domain name of your server."; + description = lib.mdDoc "Domain name of your server."; }; rootUrl = mkOption { type = types.str; default = "http://localhost:3000/"; - description = "Full public URL of gitea server."; + description = lib.mdDoc "Full public URL of gitea server."; }; httpAddress = mkOption { type = types.str; default = "0.0.0.0"; - description = "HTTP listen address."; + description = lib.mdDoc "HTTP listen address."; }; httpPort = mkOption { type = types.int; default = 3000; - description = "HTTP listen port."; + description = lib.mdDoc "HTTP listen port."; }; enableUnixSocket = mkOption { type = types.bool; default = false; - description = "Configure Gitea to listen on a unix socket instead of the default TCP port."; + description = lib.mdDoc "Configure Gitea to listen on a unix socket instead of the default TCP port."; }; cookieSecure = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Marks session cookies as "secure" as a hint for browsers to only send them via HTTPS. This option is recommend, if gitea is being served over HTTPS. ''; @@ -283,14 +283,14 @@ in default = gitea.data; defaultText = literalExpression "package.data"; example = "/var/lib/gitea/data"; - description = "Upper level of template and static files path."; + description = lib.mdDoc "Upper level of template and static files path."; }; mailerPasswordFile = mkOption { type = types.nullOr types.str; default = null; example = "/var/lib/secrets/gitea/mailpw"; - description = "Path to a file containing the SMTP password."; + description = lib.mdDoc "Path to a file containing the SMTP password."; }; disableRegistration = mkEnableOption "the registration lock" // { @@ -308,8 +308,8 @@ in settings = mkOption { type = with types; attrsOf (attrsOf (oneOf [ bool int str ])); default = {}; - description = '' - Gitea configuration. Refer to <link xlink:href="https://docs.gitea.io/en-us/config-cheat-sheet/"/> + description = lib.mdDoc '' + Gitea configuration. Refer to <https://docs.gitea.io/en-us/config-cheat-sheet/> for details on supported values. ''; example = literalExpression '' @@ -335,7 +335,7 @@ in extraConfig = mkOption { type = with types; nullOr str; default = null; - description = "Configuration lines appended to the generated gitea configuration file."; + description = lib.mdDoc "Configuration lines appended to the generated gitea configuration file."; }; }; }; diff --git a/nixos/modules/services/misc/gitlab.nix b/nixos/modules/services/misc/gitlab.nix index 77556bfe00707..938b1d4ed1025 100644 --- a/nixos/modules/services/misc/gitlab.nix +++ b/nixos/modules/services/misc/gitlab.nix @@ -252,7 +252,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the gitlab service. ''; }; @@ -261,7 +261,7 @@ in { type = types.package; default = pkgs.gitlab; defaultText = literalExpression "pkgs.gitlab"; - description = "Reference to the gitlab package"; + description = lib.mdDoc "Reference to the gitlab package"; example = literalExpression "pkgs.gitlab-ee"; }; @@ -269,48 +269,48 @@ in { type = types.package; default = pkgs.gitlab-shell; defaultText = literalExpression "pkgs.gitlab-shell"; - description = "Reference to the gitlab-shell package"; + description = lib.mdDoc "Reference to the gitlab-shell package"; }; packages.gitlab-workhorse = mkOption { type = types.package; default = pkgs.gitlab-workhorse; defaultText = literalExpression "pkgs.gitlab-workhorse"; - description = "Reference to the gitlab-workhorse package"; + description = lib.mdDoc "Reference to the gitlab-workhorse package"; }; packages.gitaly = mkOption { type = types.package; default = pkgs.gitaly; defaultText = literalExpression "pkgs.gitaly"; - description = "Reference to the gitaly package"; + description = lib.mdDoc "Reference to the gitaly package"; }; packages.pages = mkOption { type = types.package; default = pkgs.gitlab-pages; defaultText = literalExpression "pkgs.gitlab-pages"; - description = "Reference to the gitlab-pages package"; + description = lib.mdDoc "Reference to the gitlab-pages package"; }; statePath = mkOption { type = types.str; default = "/var/gitlab/state"; - description = '' + description = lib.mdDoc '' GitLab state directory. Configuration, repositories and logs, among other things, are stored here. The directory will be created automatically if it doesn't exist already. Its parent directories must be owned by - either <literal>root</literal> or the user set in - <option>services.gitlab.user</option>. + either `root` or the user set in + {option}`services.gitlab.user`. ''; }; extraEnv = mkOption { type = types.attrsOf types.str; default = {}; - description = '' + description = lib.mdDoc '' Additional environment variables for the GitLab environment. ''; }; @@ -331,7 +331,7 @@ in { type = types.str; default = cfg.statePath + "/backup"; defaultText = literalExpression ''config.${opt.statePath} + "/backup"''; - description = "GitLab path for backups."; + description = lib.mdDoc "GitLab path for backups."; }; backup.keepTime = mkOption { @@ -364,13 +364,13 @@ in { default = []; example = [ "artifacts" "lfs" ]; apply = x: if isString x then x else concatStringsSep "," x; - description = '' + description = lib.mdDoc '' Directories to exclude from the backup. The example excludes CI artifacts and LFS objects from the backups. The - <literal>tar</literal> option skips the creation of a tar + `tar` option skips the creation of a tar file. - Refer to <link xlink:href="https://docs.gitlab.com/ee/raketasks/backup_restore.html#excluding-specific-directories-from-the-backup"/> + Refer to <https://docs.gitlab.com/ee/raketasks/backup_restore.html#excluding-specific-directories-from-the-backup> for more information. ''; }; @@ -403,13 +403,13 @@ in { storage_class = "STANDARD"; }; ''; - description = '' + description = lib.mdDoc '' GitLab automatic upload specification. Tells GitLab to upload the backup to a remote location when done. Attributes specified here are added under - <literal>production -> backup -> upload</literal> in - <filename>config/gitlab.yml</filename>. + `production -> backup -> upload` in + {file}`config/gitlab.yml`. ''; }; @@ -425,7 +425,7 @@ in { databasePasswordFile = mkOption { type = with types; nullOr path; default = null; - description = '' + description = lib.mdDoc '' File containing the GitLab database user password. This should be a string, not a nix path, since nix paths are @@ -436,43 +436,43 @@ in { databaseCreateLocally = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether a database should be automatically created on the - local host. Set this to <literal>false</literal> if you plan + local host. Set this to `false` if you plan on provisioning a local database yourself. This has no effect - if <option>services.gitlab.databaseHost</option> is customized. + if {option}`services.gitlab.databaseHost` is customized. ''; }; databaseName = mkOption { type = types.str; default = "gitlab"; - description = "GitLab database name."; + description = lib.mdDoc "GitLab database name."; }; databaseUsername = mkOption { type = types.str; default = "gitlab"; - description = "GitLab database user."; + description = lib.mdDoc "GitLab database user."; }; databasePool = mkOption { type = types.int; default = 5; - description = "Database connection pool size."; + description = lib.mdDoc "Database connection pool size."; }; extraDatabaseConfig = mkOption { type = types.attrs; default = {}; - description = "Extra configuration in config/database.yml."; + description = lib.mdDoc "Extra configuration in config/database.yml."; }; redisUrl = mkOption { type = types.str; default = "redis://localhost:${toString config.services.redis.servers.gitlab.port}/"; defaultText = literalExpression ''redis://localhost:''${toString config.services.redis.servers.gitlab.port}/''; - description = "Redis URL for all GitLab services except gitlab-shell"; + description = lib.mdDoc "Redis URL for all GitLab services except gitlab-shell"; }; extraGitlabRb = mkOption { @@ -488,7 +488,7 @@ in { } end ''; - description = '' + description = lib.mdDoc '' Extra configuration to be placed in config/extra-gitlab.rb. This can be used to add configuration not otherwise exposed through this module's options. @@ -499,13 +499,13 @@ in { type = types.str; default = config.networking.hostName; defaultText = literalExpression "config.networking.hostName"; - description = "GitLab host name. Used e.g. for copy-paste URLs."; + description = lib.mdDoc "GitLab host name. Used e.g. for copy-paste URLs."; }; port = mkOption { type = types.port; default = 8080; - description = '' + description = lib.mdDoc '' GitLab server port for copy-paste URLs, e.g. 80 or 443 if you're service over https. ''; @@ -514,25 +514,25 @@ in { https = mkOption { type = types.bool; default = false; - description = "Whether gitlab prints URLs with https as scheme."; + description = lib.mdDoc "Whether gitlab prints URLs with https as scheme."; }; user = mkOption { type = types.str; default = "gitlab"; - description = "User to run gitlab and all related services."; + description = lib.mdDoc "User to run gitlab and all related services."; }; group = mkOption { type = types.str; default = "gitlab"; - description = "Group to run gitlab and all related services."; + description = lib.mdDoc "Group to run gitlab and all related services."; }; initialRootEmail = mkOption { type = types.str; default = "admin@local.host"; - description = '' + description = lib.mdDoc '' Initial email address of the root account if this is a new install. ''; }; @@ -540,7 +540,7 @@ in { initialRootPasswordFile = mkOption { type = with types; nullOr path; default = null; - description = '' + description = lib.mdDoc '' File containing the initial password of the root account if this is a new install. @@ -553,51 +553,51 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Enable GitLab container registry."; + description = lib.mdDoc "Enable GitLab container registry."; }; host = mkOption { type = types.str; default = config.services.gitlab.host; defaultText = literalExpression "config.services.gitlab.host"; - description = "GitLab container registry host name."; + description = lib.mdDoc "GitLab container registry host name."; }; port = mkOption { type = types.int; default = 4567; - description = "GitLab container registry port."; + description = lib.mdDoc "GitLab container registry port."; }; certFile = mkOption { type = types.path; - description = "Path to GitLab container registry certificate."; + description = lib.mdDoc "Path to GitLab container registry certificate."; }; keyFile = mkOption { type = types.path; - description = "Path to GitLab container registry certificate-key."; + description = lib.mdDoc "Path to GitLab container registry certificate-key."; }; defaultForProjects = mkOption { type = types.bool; default = cfg.registry.enable; defaultText = literalExpression "config.${opt.registry.enable}"; - description = "If GitLab container registry should be enabled by default for projects."; + description = lib.mdDoc "If GitLab container registry should be enabled by default for projects."; }; issuer = mkOption { type = types.str; default = "gitlab-issuer"; - description = "GitLab container registry issuer."; + description = lib.mdDoc "GitLab container registry issuer."; }; serviceName = mkOption { type = types.str; default = "container_registry"; - description = "GitLab container registry service name."; + description = lib.mdDoc "GitLab container registry service name."; }; externalAddress = mkOption { type = types.str; default = ""; - description = "External address used to access registry from the internet"; + description = lib.mdDoc "External address used to access registry from the internet"; }; externalPort = mkOption { type = types.int; - description = "External port used to access registry from the internet"; + description = lib.mdDoc "External port used to access registry from the internet"; }; }; @@ -605,31 +605,31 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Enable gitlab mail delivery over SMTP."; + description = lib.mdDoc "Enable gitlab mail delivery over SMTP."; }; address = mkOption { type = types.str; default = "localhost"; - description = "Address of the SMTP server for GitLab."; + description = lib.mdDoc "Address of the SMTP server for GitLab."; }; port = mkOption { type = types.int; default = 25; - description = "Port of the SMTP server for GitLab."; + description = lib.mdDoc "Port of the SMTP server for GitLab."; }; username = mkOption { type = with types; nullOr str; default = null; - description = "Username of the SMTP server for GitLab."; + description = lib.mdDoc "Username of the SMTP server for GitLab."; }; passwordFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' File containing the password of the SMTP server for GitLab. This should be a string, not a nix path, since nix paths @@ -640,44 +640,44 @@ in { domain = mkOption { type = types.str; default = "localhost"; - description = "HELO domain to use for outgoing mail."; + description = lib.mdDoc "HELO domain to use for outgoing mail."; }; authentication = mkOption { type = with types; nullOr str; default = null; - description = "Authentication type to use, see http://api.rubyonrails.org/classes/ActionMailer/Base.html"; + description = lib.mdDoc "Authentication type to use, see http://api.rubyonrails.org/classes/ActionMailer/Base.html"; }; enableStartTLSAuto = mkOption { type = types.bool; default = true; - description = "Whether to try to use StartTLS."; + description = lib.mdDoc "Whether to try to use StartTLS."; }; tls = mkOption { type = types.bool; default = false; - description = "Whether to use TLS wrapper-mode."; + description = lib.mdDoc "Whether to use TLS wrapper-mode."; }; opensslVerifyMode = mkOption { type = types.str; default = "peer"; - description = "How OpenSSL checks the certificate, see http://api.rubyonrails.org/classes/ActionMailer/Base.html"; + description = lib.mdDoc "How OpenSSL checks the certificate, see http://api.rubyonrails.org/classes/ActionMailer/Base.html"; }; }; pagesExtraArgs = mkOption { type = types.listOf types.str; default = [ "-listen-proxy" "127.0.0.1:8090" ]; - description = "Arguments to pass to the gitlab-pages daemon"; + description = lib.mdDoc "Arguments to pass to the gitlab-pages daemon"; }; secrets.secretFile = mkOption { type = with types; nullOr path; default = null; - description = '' + description = lib.mdDoc '' A file containing the secret used to encrypt variables in the DB. If you change or lose this key you will be unable to access variables stored in database. @@ -693,7 +693,7 @@ in { secrets.dbFile = mkOption { type = with types; nullOr path; default = null; - description = '' + description = lib.mdDoc '' A file containing the secret used to encrypt variables in the DB. If you change or lose this key you will be unable to access variables stored in database. @@ -709,7 +709,7 @@ in { secrets.otpFile = mkOption { type = with types; nullOr path; default = null; - description = '' + description = lib.mdDoc '' A file containing the secret used to encrypt secrets for OTP tokens. If you change or lose this key, users which have 2FA enabled for login won't be able to login anymore. @@ -725,7 +725,7 @@ in { secrets.jwsFile = mkOption { type = with types; nullOr path; default = null; - description = '' + description = lib.mdDoc '' A file containing the secret used to encrypt session keys. If you change or lose this key, users will be disconnected. @@ -743,7 +743,7 @@ in { extraShellConfig = mkOption { type = types.attrs; default = {}; - description = "Extra configuration to merge into shell-config.yml"; + description = lib.mdDoc "Extra configuration to merge into shell-config.yml"; }; puma.workers = mkOption { @@ -805,12 +805,12 @@ in { sidekiq.memoryKiller.enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether the Sidekiq MemoryKiller should be turned on. MemoryKiller kills Sidekiq when its memory consumption exceeds a certain limit. - See <link xlink:href="https://docs.gitlab.com/ee/administration/operations/sidekiq_memory_killer.html"/> + See <https://docs.gitlab.com/ee/administration/operations/sidekiq_memory_killer.html> for details. ''; }; @@ -819,7 +819,7 @@ in { type = types.int; default = 2000; apply = x: builtins.toString (x * 1024); - description = '' + description = lib.mdDoc '' The maximum amount of memory, in MiB, a Sidekiq worker is allowed to consume before being killed. ''; @@ -829,7 +829,7 @@ in { type = types.int; default = 900; apply = x: builtins.toString x; - description = '' + description = lib.mdDoc '' The time MemoryKiller waits after noticing excessive memory consumption before killing Sidekiq. ''; @@ -839,7 +839,7 @@ in { type = types.int; default = 30; apply = x: builtins.toString x; - description = '' + description = lib.mdDoc '' The time allowed for all jobs to finish before Sidekiq is killed forcefully. ''; @@ -849,7 +849,7 @@ in { enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Enable rotation of log files. ''; }; @@ -857,21 +857,21 @@ in { frequency = mkOption { type = types.str; default = "daily"; - description = "How often to rotate the logs."; + description = lib.mdDoc "How often to rotate the logs."; }; keep = mkOption { type = types.int; default = 30; - description = "How many rotations to keep."; + description = lib.mdDoc "How many rotations to keep."; }; extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra logrotate config options for this path. Refer to - <link xlink:href="https://linux.die.net/man/8/logrotate"/> for details. + <https://linux.die.net/man/8/logrotate> for details. ''; }; }; @@ -914,21 +914,21 @@ in { }; }; ''; - description = '' + description = lib.mdDoc '' Extra options to be added under - <literal>production</literal> in - <filename>config/gitlab.yml</filename>, as a nix attribute + `production` in + {file}`config/gitlab.yml`, as a nix attribute set. Options containing secret data should be set to an attribute - set containing the attribute <literal>_secret</literal> - a + set containing the attribute `_secret` - a string pointing to a file containing the value the option should be set to. See the example to get a better picture of this: in the resulting - <filename>config/gitlab.yml</filename> file, the - <literal>production.omniauth.providers[0].args.client_options.secret</literal> + {file}`config/gitlab.yml` file, the + `production.omniauth.providers[0].args.client_options.secret` key will be set to the contents of the - <filename>/var/keys/gitlab_oidc_secret</filename> file. + {file}`/var/keys/gitlab_oidc_secret` file. ''; }; }; diff --git a/nixos/modules/services/misc/gitolite.nix b/nixos/modules/services/misc/gitolite.nix index 810ef1f21b9c9..b313be074db0d 100644 --- a/nixos/modules/services/misc/gitolite.nix +++ b/nixos/modules/services/misc/gitolite.nix @@ -26,7 +26,7 @@ in dataDir = mkOption { type = types.str; default = "/var/lib/gitolite"; - description = '' + description = lib.mdDoc '' The gitolite home directory used to store all repositories. If left as the default value this directory will automatically be created before the gitolite server starts, otherwise the sysadmin is responsible for ensuring the directory exists with appropriate ownership @@ -36,7 +36,7 @@ in adminPubkey = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Initial administrative public key for Gitolite. This should be an SSH Public Key. Note that this key will only be used once, upon the first initialization of the Gitolite user. @@ -47,8 +47,8 @@ in enableGitAnnex = mkOption { type = types.bool; default = false; - description = '' - Enable git-annex support. Uses the <literal>extraGitoliteRc</literal> option + description = lib.mdDoc '' + Enable git-annex support. Uses the `extraGitoliteRc` option to apply the necessary configuration. ''; }; @@ -56,8 +56,8 @@ in commonHooks = mkOption { type = types.listOf types.path; default = []; - description = '' - A list of custom git hooks that get copied to <literal>~/.gitolite/hooks/common</literal>. + description = lib.mdDoc '' + A list of custom git hooks that get copied to `~/.gitolite/hooks/common`. ''; }; @@ -97,7 +97,7 @@ in user = mkOption { type = types.str; default = "gitolite"; - description = '' + description = lib.mdDoc '' Gitolite user account. This is the username of the gitolite endpoint. ''; }; @@ -105,7 +105,7 @@ in group = mkOption { type = types.str; default = "gitolite"; - description = '' + description = lib.mdDoc '' Primary group of the Gitolite user account. ''; }; diff --git a/nixos/modules/services/misc/gitweb.nix b/nixos/modules/services/misc/gitweb.nix index a1180716e36bb..ef20347ee245f 100644 --- a/nixos/modules/services/misc/gitweb.nix +++ b/nixos/modules/services/misc/gitweb.nix @@ -13,7 +13,7 @@ in projectroot = mkOption { default = "/srv/git"; type = types.path; - description = '' + description = lib.mdDoc '' Path to git projects (bare repositories) that should be served by gitweb. Must not end with a slash. ''; @@ -22,7 +22,7 @@ in extraConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Verbatim configuration text appended to the generated gitweb.conf file. ''; example = '' @@ -35,7 +35,7 @@ in gitwebTheme = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Use an alternative theme for gitweb, strongly inspired by GitHub. ''; }; diff --git a/nixos/modules/services/misc/gogs.nix b/nixos/modules/services/misc/gogs.nix index c7ae4f494071b..e726f2c5c7ce0 100644 --- a/nixos/modules/services/misc/gogs.nix +++ b/nixos/modules/services/misc/gogs.nix @@ -48,31 +48,31 @@ in enable = mkOption { default = false; type = types.bool; - description = "Enable Go Git Service."; + description = lib.mdDoc "Enable Go Git Service."; }; useWizard = mkOption { default = false; type = types.bool; - description = "Do not generate a configuration and use Gogs' installation wizard instead. The first registered user will be administrator."; + description = lib.mdDoc "Do not generate a configuration and use Gogs' installation wizard instead. The first registered user will be administrator."; }; stateDir = mkOption { default = "/var/lib/gogs"; type = types.str; - description = "Gogs data directory."; + description = lib.mdDoc "Gogs data directory."; }; user = mkOption { type = types.str; default = "gogs"; - description = "User account under which Gogs runs."; + description = lib.mdDoc "User account under which Gogs runs."; }; group = mkOption { type = types.str; default = "gogs"; - description = "Group account under which Gogs runs."; + description = lib.mdDoc "Group account under which Gogs runs."; }; database = { @@ -80,40 +80,40 @@ in type = types.enum [ "sqlite3" "mysql" "postgres" ]; example = "mysql"; default = "sqlite3"; - description = "Database engine to use."; + description = lib.mdDoc "Database engine to use."; }; host = mkOption { type = types.str; default = "127.0.0.1"; - description = "Database host address."; + description = lib.mdDoc "Database host address."; }; port = mkOption { type = types.int; default = 3306; - description = "Database host port."; + description = lib.mdDoc "Database host port."; }; name = mkOption { type = types.str; default = "gogs"; - description = "Database name."; + description = lib.mdDoc "Database name."; }; user = mkOption { type = types.str; default = "gogs"; - description = "Database user."; + description = lib.mdDoc "Database user."; }; password = mkOption { type = types.str; default = ""; - description = '' - The password corresponding to <option>database.user</option>. + description = lib.mdDoc '' + The password corresponding to {option}`database.user`. Warning: this is stored in cleartext in the Nix store! - Use <option>database.passwordFile</option> instead. + Use {option}`database.passwordFile` instead. ''; }; @@ -121,9 +121,9 @@ in type = types.nullOr types.path; default = null; example = "/run/keys/gogs-dbpassword"; - description = '' + description = lib.mdDoc '' A file containing the password corresponding to - <option>database.user</option>. + {option}`database.user`. ''; }; @@ -131,51 +131,51 @@ in type = types.str; default = "${cfg.stateDir}/data/gogs.db"; defaultText = literalExpression ''"''${config.${opt.stateDir}}/data/gogs.db"''; - description = "Path to the sqlite3 database file."; + description = lib.mdDoc "Path to the sqlite3 database file."; }; }; appName = mkOption { type = types.str; default = "Gogs: Go Git Service"; - description = "Application name."; + description = lib.mdDoc "Application name."; }; repositoryRoot = mkOption { type = types.str; default = "${cfg.stateDir}/repositories"; defaultText = literalExpression ''"''${config.${opt.stateDir}}/repositories"''; - description = "Path to the git repositories."; + description = lib.mdDoc "Path to the git repositories."; }; domain = mkOption { type = types.str; default = "localhost"; - description = "Domain name of your server."; + description = lib.mdDoc "Domain name of your server."; }; rootUrl = mkOption { type = types.str; default = "http://localhost:3000/"; - description = "Full public URL of Gogs server."; + description = lib.mdDoc "Full public URL of Gogs server."; }; httpAddress = mkOption { type = types.str; default = "0.0.0.0"; - description = "HTTP listen address."; + description = lib.mdDoc "HTTP listen address."; }; httpPort = mkOption { type = types.int; default = 3000; - description = "HTTP listen port."; + description = lib.mdDoc "HTTP listen port."; }; cookieSecure = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Marks session cookies as "secure" as a hint for browsers to only send them via HTTPS. This option is recommend, if Gogs is being served over HTTPS. ''; @@ -184,7 +184,7 @@ in extraConfig = mkOption { type = types.str; default = ""; - description = "Configuration lines appended to the generated Gogs configuration file."; + description = lib.mdDoc "Configuration lines appended to the generated Gogs configuration file."; }; }; }; diff --git a/nixos/modules/services/misc/gollum.nix b/nixos/modules/services/misc/gollum.nix index 5a5f488dc565b..a4bed2da8a2f4 100644 --- a/nixos/modules/services/misc/gollum.nix +++ b/nixos/modules/services/misc/gollum.nix @@ -11,80 +11,80 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable the Gollum service."; + description = lib.mdDoc "Enable the Gollum service."; }; address = mkOption { type = types.str; default = "0.0.0.0"; - description = "IP address on which the web server will listen."; + description = lib.mdDoc "IP address on which the web server will listen."; }; port = mkOption { type = types.int; default = 4567; - description = "Port on which the web server will run."; + description = lib.mdDoc "Port on which the web server will run."; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Content of the configuration file"; + description = lib.mdDoc "Content of the configuration file"; }; mathjax = mkOption { type = types.bool; default = false; - description = "Enable support for math rendering using MathJax"; + description = lib.mdDoc "Enable support for math rendering using MathJax"; }; allowUploads = mkOption { type = types.nullOr (types.enum [ "dir" "page" ]); default = null; - description = "Enable uploads of external files"; + description = lib.mdDoc "Enable uploads of external files"; }; user-icons = mkOption { type = types.nullOr (types.enum [ "gravatar" "identicon" ]); default = null; - description = "Enable specific user icons for history view"; + description = lib.mdDoc "Enable specific user icons for history view"; }; emoji = mkOption { type = types.bool; default = false; - description = "Parse and interpret emoji tags"; + description = lib.mdDoc "Parse and interpret emoji tags"; }; h1-title = mkOption { type = types.bool; default = false; - description = "Use the first h1 as page title"; + description = lib.mdDoc "Use the first h1 as page title"; }; no-edit = mkOption { type = types.bool; default = false; - description = "Disable editing pages"; + description = lib.mdDoc "Disable editing pages"; }; local-time = mkOption { type = types.bool; default = false; - description = "Use the browser's local timezone instead of the server's for displaying dates."; + description = lib.mdDoc "Use the browser's local timezone instead of the server's for displaying dates."; }; branch = mkOption { type = types.str; default = "master"; example = "develop"; - description = "Git branch to serve"; + description = lib.mdDoc "Git branch to serve"; }; stateDir = mkOption { type = types.path; default = "/var/lib/gollum"; - description = "Specifies the path of the repository directory. If it does not exist, Gollum will create it on startup."; + description = lib.mdDoc "Specifies the path of the repository directory. If it does not exist, Gollum will create it on startup."; }; }; diff --git a/nixos/modules/services/misc/gpsd.nix b/nixos/modules/services/misc/gpsd.nix index 6494578f76472..1ab8d1bbe0629 100644 --- a/nixos/modules/services/misc/gpsd.nix +++ b/nixos/modules/services/misc/gpsd.nix @@ -21,7 +21,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable `gpsd', a GPS service daemon. ''; }; @@ -29,9 +29,9 @@ in device = mkOption { type = types.str; default = "/dev/ttyUSB0"; - description = '' + description = lib.mdDoc '' A device may be a local serial device for GPS input, or a URL of the form: - <literal>[{dgpsip|ntrip}://][user:passwd@]host[:port][/stream]</literal> + `[{dgpsip|ntrip}://][user:passwd@]host[:port][/stream]` in which case it specifies an input source for DGPS or ntrip data. ''; }; @@ -39,7 +39,7 @@ in readonly = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable the broken-device-safety, otherwise known as read-only mode. Some popular bluetooth and USB receivers lock up or become totally inaccessible when @@ -56,7 +56,7 @@ in nowait = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' don't wait for client connects to poll GPS ''; }; @@ -64,7 +64,7 @@ in port = mkOption { type = types.port; default = 2947; - description = '' + description = lib.mdDoc '' The port where to listen for TCP connections. ''; }; @@ -72,7 +72,7 @@ in debugLevel = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' The debugging level. ''; }; diff --git a/nixos/modules/services/misc/greenclip.nix b/nixos/modules/services/misc/greenclip.nix index 32e8d746cb5c6..210827ea0755e 100644 --- a/nixos/modules/services/misc/greenclip.nix +++ b/nixos/modules/services/misc/greenclip.nix @@ -13,7 +13,7 @@ in { type = types.package; default = pkgs.haskellPackages.greenclip; defaultText = literalExpression "pkgs.haskellPackages.greenclip"; - description = "greenclip derivation to use."; + description = lib.mdDoc "greenclip derivation to use."; }; }; diff --git a/nixos/modules/services/misc/headphones.nix b/nixos/modules/services/misc/headphones.nix index 31bd61cb4c200..472b330fff15d 100644 --- a/nixos/modules/services/misc/headphones.nix +++ b/nixos/modules/services/misc/headphones.nix @@ -20,38 +20,38 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the headphones server."; + description = lib.mdDoc "Whether to enable the headphones server."; }; dataDir = mkOption { type = types.path; default = "/var/lib/${name}"; - description = "Path where to store data files."; + description = lib.mdDoc "Path where to store data files."; }; configFile = mkOption { type = types.path; default = "${cfg.dataDir}/config.ini"; defaultText = literalExpression ''"''${config.${opt.dataDir}}/config.ini"''; - description = "Path to config file."; + description = lib.mdDoc "Path to config file."; }; host = mkOption { type = types.str; default = "localhost"; - description = "Host to listen on."; + description = lib.mdDoc "Host to listen on."; }; port = mkOption { type = types.ints.u16; default = 8181; - description = "Port to bind to."; + description = lib.mdDoc "Port to bind to."; }; user = mkOption { type = types.str; default = name; - description = "User to run the service as"; + description = lib.mdDoc "User to run the service as"; }; group = mkOption { type = types.str; default = name; - description = "Group to run the service as"; + description = lib.mdDoc "Group to run the service as"; }; }; }; diff --git a/nixos/modules/services/misc/heisenbridge.nix b/nixos/modules/services/misc/heisenbridge.nix index deefb061d8b31..486ba512ac549 100644 --- a/nixos/modules/services/misc/heisenbridge.nix +++ b/nixos/modules/services/misc/heisenbridge.nix @@ -30,20 +30,20 @@ in default = pkgs.heisenbridge; defaultText = "pkgs.heisenbridge"; example = "pkgs.heisenbridge.override { … = …; }"; - description = '' + description = lib.mdDoc '' Package of the application to run, exposed for overriding purposes. ''; }; homeserver = mkOption { type = types.str; - description = "The URL to the home server for client-server API calls"; + description = lib.mdDoc "The URL to the home server for client-server API calls"; example = "http://localhost:8008"; }; registrationUrl = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The URL where the application service is listening for HS requests, from the Matrix HS perspective.# The default value assumes the bridge runs on the same host as the home server, in the same network. ''; @@ -54,26 +54,26 @@ in address = mkOption { type = types.str; - description = "Address to listen on. IPv6 does not seem to be supported."; + description = lib.mdDoc "Address to listen on. IPv6 does not seem to be supported."; default = "127.0.0.1"; example = "0.0.0.0"; }; port = mkOption { type = types.port; - description = "The port to listen on"; + description = lib.mdDoc "The port to listen on"; default = 9898; }; debug = mkOption { type = types.bool; - description = "More verbose logging. Recommended during initial setup."; + description = lib.mdDoc "More verbose logging. Recommended during initial setup."; default = false; }; owner = mkOption { type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' Set owner MXID otherwise first talking local user will claim the bridge ''; default = null; @@ -81,7 +81,7 @@ in }; namespaces = mkOption { - description = "Configure the 'namespaces' section of the registration.yml for the bridge and the server"; + description = lib.mdDoc "Configure the 'namespaces' section of the registration.yml for the bridge and the server"; # TODO link to Matrix documentation of the format type = types.submodule { freeformType = jsonType; @@ -102,13 +102,13 @@ in identd.enable = mkEnableOption "identd service support"; identd.port = mkOption { type = types.port; - description = "identd listen port"; + description = lib.mdDoc "identd listen port"; default = 113; }; extraArgs = mkOption { type = types.listOf types.str; - description = "Heisenbridge is configured over the command line. Append extra arguments here"; + description = lib.mdDoc "Heisenbridge is configured over the command line. Append extra arguments here"; default = [ ]; }; }; diff --git a/nixos/modules/services/misc/ihaskell.nix b/nixos/modules/services/misc/ihaskell.nix index 9978e8a46534e..ff5709922e612 100644 --- a/nixos/modules/services/misc/ihaskell.nix +++ b/nixos/modules/services/misc/ihaskell.nix @@ -17,7 +17,7 @@ in enable = mkOption { type = types.bool; default = false; - description = "Autostart an IHaskell notebook service."; + description = lib.mdDoc "Autostart an IHaskell notebook service."; }; extraPackages = mkOption { diff --git a/nixos/modules/services/misc/input-remapper.nix b/nixos/modules/services/misc/input-remapper.nix index f5fb2bf53086f..f66d714e1174e 100644 --- a/nixos/modules/services/misc/input-remapper.nix +++ b/nixos/modules/services/misc/input-remapper.nix @@ -13,7 +13,7 @@ let cfg = config.services.input-remapper; in default = [ "graphical.target" ]; example = [ "multi-user.target" ]; type = types.listOf types.str; - description = "Specifies the WantedBy setting for the input-remapper service."; + description = lib.mdDoc "Specifies the WantedBy setting for the input-remapper service."; }; }; }; diff --git a/nixos/modules/services/misc/irkerd.nix b/nixos/modules/services/misc/irkerd.nix index 993d77ba424c9..d080cc0a7358c 100644 --- a/nixos/modules/services/misc/irkerd.nix +++ b/nixos/modules/services/misc/irkerd.nix @@ -9,13 +9,13 @@ in { options.services.irkerd = { enable = mkOption { - description = "Whether to enable irker, an IRC notification daemon."; + description = lib.mdDoc "Whether to enable irker, an IRC notification daemon."; default = false; type = types.bool; }; openPorts = mkOption { - description = "Open ports in the firewall for irkerd"; + description = lib.mdDoc "Open ports in the firewall for irkerd"; default = false; type = types.bool; }; @@ -24,7 +24,7 @@ in default = "localhost"; example = "0.0.0.0"; type = types.str; - description = '' + description = lib.mdDoc '' Specifies the bind address on which the irker daemon listens. The default is localhost. @@ -36,7 +36,7 @@ in nick = mkOption { default = "irker"; type = types.str; - description = "Nick to use for irker"; + description = lib.mdDoc "Nick to use for irker"; }; }; diff --git a/nixos/modules/services/misc/jackett.nix b/nixos/modules/services/misc/jackett.nix index c2144d4a9a9f5..e8315d13417b4 100644 --- a/nixos/modules/services/misc/jackett.nix +++ b/nixos/modules/services/misc/jackett.nix @@ -14,32 +14,32 @@ in dataDir = mkOption { type = types.str; default = "/var/lib/jackett/.config/Jackett"; - description = "The directory where Jackett stores its data files."; + description = lib.mdDoc "The directory where Jackett stores its data files."; }; openFirewall = mkOption { type = types.bool; default = false; - description = "Open ports in the firewall for the Jackett web interface."; + description = lib.mdDoc "Open ports in the firewall for the Jackett web interface."; }; user = mkOption { type = types.str; default = "jackett"; - description = "User account under which Jackett runs."; + description = lib.mdDoc "User account under which Jackett runs."; }; group = mkOption { type = types.str; default = "jackett"; - description = "Group under which Jackett runs."; + description = lib.mdDoc "Group under which Jackett runs."; }; package = mkOption { type = types.package; default = pkgs.jackett; defaultText = literalExpression "pkgs.jackett"; - description = "Jackett package to use."; + description = lib.mdDoc "Jackett package to use."; }; }; }; diff --git a/nixos/modules/services/misc/jellyfin.nix b/nixos/modules/services/misc/jellyfin.nix index e2f227b06196a..af5256e46da82 100644 --- a/nixos/modules/services/misc/jellyfin.nix +++ b/nixos/modules/services/misc/jellyfin.nix @@ -13,14 +13,14 @@ in user = mkOption { type = types.str; default = "jellyfin"; - description = "User account under which Jellyfin runs."; + description = lib.mdDoc "User account under which Jellyfin runs."; }; package = mkOption { type = types.package; default = pkgs.jellyfin; defaultText = literalExpression "pkgs.jellyfin"; - description = '' + description = lib.mdDoc '' Jellyfin package to use. ''; }; @@ -28,13 +28,13 @@ in group = mkOption { type = types.str; default = "jellyfin"; - description = "Group under which jellyfin runs."; + description = lib.mdDoc "Group under which jellyfin runs."; }; openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open the default ports in the firewall for the media server. The HTTP/HTTPS ports can be changed in the Web UI, so this option should only be used if they are unchanged. diff --git a/nixos/modules/services/misc/klipper.nix b/nixos/modules/services/misc/klipper.nix index fee7779141cdd..52913369bbcdd 100644 --- a/nixos/modules/services/misc/klipper.nix +++ b/nixos/modules/services/misc/klipper.nix @@ -20,31 +20,31 @@ in type = types.package; default = pkgs.klipper; defaultText = literalExpression "pkgs.klipper"; - description = "The Klipper package."; + description = lib.mdDoc "The Klipper package."; }; inputTTY = mkOption { type = types.path; default = "/run/klipper/tty"; - description = "Path of the virtual printer symlink to create."; + description = lib.mdDoc "Path of the virtual printer symlink to create."; }; apiSocket = mkOption { type = types.nullOr types.path; default = "/run/klipper/api"; - description = "Path of the API socket to create."; + description = lib.mdDoc "Path of the API socket to create."; }; octoprintIntegration = mkOption { type = types.bool; default = false; - description = "Allows Octoprint to control Klipper."; + description = lib.mdDoc "Allows Octoprint to control Klipper."; }; user = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' User account under which Klipper runs. If null is specified (default), a temporary user will be created by systemd. @@ -54,7 +54,7 @@ in group = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Group account under which Klipper runs. If null is specified (default), a temporary user will be created by systemd. @@ -64,8 +64,8 @@ in settings = mkOption { type = format.type; default = { }; - description = '' - Configuration for Klipper. See the <link xlink:href="https://www.klipper3d.org/Overview.html#configuration-and-tuning-guides">documentation</link> + description = lib.mdDoc '' + Configuration for Klipper. See the [documentation](https://www.klipper3d.org/Overview.html#configuration-and-tuning-guides) for supported values. ''; }; diff --git a/nixos/modules/services/misc/leaps.nix b/nixos/modules/services/misc/leaps.nix index f797218522c50..0308fbfcf4752 100644 --- a/nixos/modules/services/misc/leaps.nix +++ b/nixos/modules/services/misc/leaps.nix @@ -13,18 +13,18 @@ in port = mkOption { type = types.port; default = 8080; - description = "A port where leaps listens for incoming http requests"; + description = lib.mdDoc "A port where leaps listens for incoming http requests"; }; address = mkOption { default = ""; type = types.str; example = "127.0.0.1"; - description = "Hostname or IP-address to listen to. By default it will listen on all interfaces."; + description = lib.mdDoc "Hostname or IP-address to listen to. By default it will listen on all interfaces."; }; path = mkOption { default = "/"; type = types.path; - description = "Subdirectory used for reverse proxy setups"; + description = lib.mdDoc "Subdirectory used for reverse proxy setups"; }; }; }; diff --git a/nixos/modules/services/misc/libreddit.nix b/nixos/modules/services/misc/libreddit.nix index e21a884478441..0359f57c0dcfd 100644 --- a/nixos/modules/services/misc/libreddit.nix +++ b/nixos/modules/services/misc/libreddit.nix @@ -19,20 +19,20 @@ in default = "0.0.0.0"; example = "127.0.0.1"; type = types.str; - description = "The address to listen on"; + description = lib.mdDoc "The address to listen on"; }; port = mkOption { default = 8080; example = 8000; type = types.port; - description = "The port to listen on"; + description = lib.mdDoc "The port to listen on"; }; openFirewall = mkOption { type = types.bool; default = false; - description = "Open ports in the firewall for the libreddit web interface"; + description = lib.mdDoc "Open ports in the firewall for the libreddit web interface"; }; }; diff --git a/nixos/modules/services/misc/lidarr.nix b/nixos/modules/services/misc/lidarr.nix index 20153c7e61a61..d070a7f091f2b 100644 --- a/nixos/modules/services/misc/lidarr.nix +++ b/nixos/modules/services/misc/lidarr.nix @@ -13,20 +13,20 @@ in dataDir = mkOption { type = types.str; default = "/var/lib/lidarr/.config/Lidarr"; - description = "The directory where Lidarr stores its data files."; + description = lib.mdDoc "The directory where Lidarr stores its data files."; }; package = mkOption { type = types.package; default = pkgs.lidarr; defaultText = literalExpression "pkgs.lidarr"; - description = "The Lidarr package to use"; + description = lib.mdDoc "The Lidarr package to use"; }; openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for Lidarr ''; }; @@ -34,7 +34,7 @@ in user = mkOption { type = types.str; default = "lidarr"; - description = '' + description = lib.mdDoc '' User account under which Lidarr runs. ''; }; @@ -42,7 +42,7 @@ in group = mkOption { type = types.str; default = "lidarr"; - description = '' + description = lib.mdDoc '' Group under which Lidarr runs. ''; }; diff --git a/nixos/modules/services/misc/lifecycled.nix b/nixos/modules/services/misc/lifecycled.nix index 1c8942998d6cd..fc8c77c6ca4f9 100644 --- a/nixos/modules/services/misc/lifecycled.nix +++ b/nixos/modules/services/misc/lifecycled.nix @@ -33,12 +33,12 @@ in frequency = mkOption { type = types.str; default = "hourly"; - description = '' + description = lib.mdDoc '' How often to trigger the queue cleaner. NOTE: This string should be a valid value for a systemd - timer's <literal>OnCalendar</literal> configuration. See - <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry> + timer's `OnCalendar` configuration. See + {manpage}`systemd.timer(5)` for more information. ''; }; @@ -46,7 +46,7 @@ in parallel = mkOption { type = types.ints.unsigned; default = 20; - description = '' + description = lib.mdDoc '' The number of parallel deletes to run. ''; }; @@ -55,7 +55,7 @@ in instanceId = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The instance ID to listen for events for. ''; }; @@ -63,7 +63,7 @@ in snsTopic = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The SNS topic that receives events. ''; }; @@ -71,14 +71,14 @@ in noSpot = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Disable the spot termination listener. ''; }; handler = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' The script to invoke to handle events. ''; }; @@ -86,7 +86,7 @@ in json = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable JSON logging. ''; }; @@ -94,7 +94,7 @@ in cloudwatchGroup = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Write logs to a specific Cloudwatch Logs group. ''; }; @@ -102,7 +102,7 @@ in cloudwatchStream = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Write logs to a specific Cloudwatch Logs stream. Defaults to the instance ID. ''; }; @@ -110,7 +110,7 @@ in debug = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable debugging information. ''; }; @@ -120,7 +120,7 @@ in awsRegion = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The region used for accessing AWS services. ''; }; diff --git a/nixos/modules/services/misc/logkeys.nix b/nixos/modules/services/misc/logkeys.nix index 0082db63a06ae..628f5627433b9 100644 --- a/nixos/modules/services/misc/logkeys.nix +++ b/nixos/modules/services/misc/logkeys.nix @@ -9,7 +9,7 @@ in { enable = mkEnableOption "logkeys service"; device = mkOption { - description = "Use the given device as keyboard input event device instead of /dev/input/eventX default."; + description = lib.mdDoc "Use the given device as keyboard input event device instead of /dev/input/eventX default."; default = null; type = types.nullOr types.str; example = "/dev/input/event15"; diff --git a/nixos/modules/services/misc/mame.nix b/nixos/modules/services/misc/mame.nix index dd6c5ef9aa005..6e9d2fd26cff1 100644 --- a/nixos/modules/services/misc/mame.nix +++ b/nixos/modules/services/misc/mame.nix @@ -12,19 +12,19 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to setup TUN/TAP Ethernet interface for MAME emulator. ''; }; user = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' User from which you run MAME binary. ''; }; hostAddr = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' IP address of the host system. Usually an address of the main network adapter or the adapter through which you get an internet connection. ''; @@ -32,9 +32,9 @@ in }; emuAddr = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' IP address of the guest system. The same you set inside guest OS under - MAME. Should be on the same subnet as <option>services.mame.hostAddr</option>. + MAME. Should be on the same subnet as {option}`services.mame.hostAddr`. ''; example = "192.168.31.155"; }; diff --git a/nixos/modules/services/misc/mbpfan.nix b/nixos/modules/services/misc/mbpfan.nix index 7a149ff47e617..786ecf2d696f1 100644 --- a/nixos/modules/services/misc/mbpfan.nix +++ b/nixos/modules/services/misc/mbpfan.nix @@ -16,7 +16,7 @@ in { type = types.package; default = pkgs.mbpfan; defaultText = literalExpression "pkgs.mbpfan"; - description = '' + description = lib.mdDoc '' The package used for the mbpfan daemon. ''; }; @@ -24,14 +24,14 @@ in { verbose = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If true, sets the log level to verbose. ''; }; settings = mkOption { default = {}; - description = "INI configuration for Mbpfan."; + description = lib.mdDoc "INI configuration for Mbpfan."; type = types.submodule { freeformType = settingsFormat.type; @@ -48,22 +48,22 @@ in { options.general.low_temp = mkOption { type = types.int; default = 55; - description = "If temperature is below this, fans will run at minimum speed."; + description = lib.mdDoc "If temperature is below this, fans will run at minimum speed."; }; options.general.high_temp = mkOption { type = types.int; default = 58; - description = "If temperature is above this, fan speed will gradually increase."; + description = lib.mdDoc "If temperature is above this, fan speed will gradually increase."; }; options.general.max_temp = mkOption { type = types.int; default = 86; - description = "If temperature is above this, fans will run at maximum speed."; + description = lib.mdDoc "If temperature is above this, fans will run at maximum speed."; }; options.general.polling_interval = mkOption { type = types.int; default = 1; - description = "The polling interval."; + description = lib.mdDoc "The polling interval."; }; }; }; diff --git a/nixos/modules/services/misc/mediatomb.nix b/nixos/modules/services/misc/mediatomb.nix index ee5c0ef8d277b..8cac87f532666 100644 --- a/nixos/modules/services/misc/mediatomb.nix +++ b/nixos/modules/services/misc/mediatomb.nix @@ -15,19 +15,19 @@ let options = { path = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Absolute directory path to the media directory to index. ''; }; recursive = mkOption { type = types.bool; default = false; - description = "Whether the indexation must take place recursively or not."; + description = lib.mdDoc "Whether the indexation must take place recursively or not."; }; hidden-files = mkOption { type = types.bool; default = true; - description = "Whether to index the hidden files or not."; + description = lib.mdDoc "Whether to index the hidden files or not."; }; }; }; @@ -202,7 +202,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the Gerbera/Mediatomb DLNA server. ''; }; @@ -210,7 +210,7 @@ in { serverName = mkOption { type = types.str; default = "Gerbera (Mediatomb)"; - description = '' + description = lib.mdDoc '' How to identify the server on the network. ''; }; @@ -219,7 +219,7 @@ in { type = types.package; default = pkgs.gerbera; defaultText = literalExpression "pkgs.gerbera"; - description = '' + description = lib.mdDoc '' Underlying package to be used with the module. ''; }; @@ -227,7 +227,7 @@ in { ps3Support = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable ps3 specific tweaks. WARNING: incompatible with DSM 320 support. ''; @@ -236,7 +236,7 @@ in { dsmSupport = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable D-Link DSM 320 specific tweaks. WARNING: incompatible with ps3 support. ''; @@ -245,7 +245,7 @@ in { tg100Support = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable Telegent TG100 specific tweaks. ''; }; @@ -253,7 +253,7 @@ in { transcoding = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable transcoding. ''; }; @@ -262,7 +262,7 @@ in { type = types.path; default = "/var/lib/${name}"; defaultText = literalExpression ''"/var/lib/''${config.${opt.package}.pname}"''; - description = '' + description = lib.mdDoc '' The directory where Gerbera/Mediatomb stores its state, data, etc. ''; }; @@ -270,7 +270,7 @@ in { pcDirectoryHide = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to list the top-level directory or not (from upnp client standpoint). ''; }; @@ -278,19 +278,19 @@ in { user = mkOption { type = types.str; default = "mediatomb"; - description = "User account under which the service runs."; + description = lib.mdDoc "User account under which the service runs."; }; group = mkOption { type = types.str; default = "mediatomb"; - description = "Group account under which the service runs."; + description = lib.mdDoc "Group account under which the service runs."; }; port = mkOption { type = types.int; default = 49152; - description = '' + description = lib.mdDoc '' The network port to listen on. ''; }; @@ -298,7 +298,7 @@ in { interface = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' A specific interface to bind to. ''; }; @@ -306,12 +306,12 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If false (the default), this is up to the user to declare the firewall rules. If true, this opens port 1900 (tcp and udp) and the port specified by - <option>sercvices.mediatomb.port</option>. + {option}`sercvices.mediatomb.port`. - If the option <option>services.mediatomb.interface</option> is set, + If the option {option}`services.mediatomb.interface` is set, the firewall rules opened are dedicated to that interface. Otherwise, those rules are opened globally. ''; @@ -320,7 +320,7 @@ in { uuid = mkOption { type = types.str; default = "fdfc8a4e-a3ad-4c1d-b43d-a2eedb03a687"; - description = '' + description = lib.mdDoc '' A unique (on your network) to identify the server by. ''; }; @@ -328,7 +328,7 @@ in { mediaDirectories = mkOption { type = with types; listOf (submodule mediaDirectory); default = []; - description = '' + description = lib.mdDoc '' Declare media directories to index. ''; example = [ @@ -340,12 +340,12 @@ in { customCfg = mkOption { type = types.bool; default = false; - description = '' - Allow the service to create and use its own config file inside the <literal>dataDir</literal> as - configured by <option>services.mediatomb.dataDir</option>. + description = lib.mdDoc '' + Allow the service to create and use its own config file inside the `dataDir` as + configured by {option}`services.mediatomb.dataDir`. Deactivated by default, the service then runs with the configuration generated from this module. Otherwise, when enabled, no service configuration is generated. Gerbera/Mediatomb then starts using - config.xml within the configured <literal>dataDir</literal>. It's up to the user to make a correct + config.xml within the configured `dataDir`. It's up to the user to make a correct configuration file. ''; }; diff --git a/nixos/modules/services/misc/metabase.nix b/nixos/modules/services/misc/metabase.nix index e78100a046a20..26c48c05037e9 100644 --- a/nixos/modules/services/misc/metabase.nix +++ b/nixos/modules/services/misc/metabase.nix @@ -19,7 +19,7 @@ in { ip = mkOption { type = types.str; default = "0.0.0.0"; - description = '' + description = lib.mdDoc '' IP address that Metabase should listen on. ''; }; @@ -27,7 +27,7 @@ in { port = mkOption { type = types.port; default = 3000; - description = '' + description = lib.mdDoc '' Listen port for Metabase. ''; }; @@ -37,7 +37,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable SSL (https) support. ''; }; @@ -45,7 +45,7 @@ in { port = mkOption { type = types.port; default = 8443; - description = '' + description = lib.mdDoc '' Listen port over SSL (https) for Metabase. ''; }; @@ -54,8 +54,8 @@ in { type = types.nullOr types.path; default = "${dataDir}/metabase.jks"; example = "/etc/secrets/keystore.jks"; - description = '' - <link xlink:href="https://www.digitalocean.com/community/tutorials/java-keytool-essentials-working-with-java-keystores">Java KeyStore</link> file containing the certificates. + description = lib.mdDoc '' + [Java KeyStore](https://www.digitalocean.com/community/tutorials/java-keytool-essentials-working-with-java-keystores) file containing the certificates. ''; }; @@ -64,7 +64,7 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for Metabase. ''; }; diff --git a/nixos/modules/services/misc/moonraker.nix b/nixos/modules/services/misc/moonraker.nix index b75227effa04f..5b4e4bd34dc9d 100644 --- a/nixos/modules/services/misc/moonraker.nix +++ b/nixos/modules/services/misc/moonraker.nix @@ -20,20 +20,20 @@ in { type = types.path; default = config.services.klipper.apiSocket; defaultText = literalExpression "config.services.klipper.apiSocket"; - description = "Path to Klipper's API socket."; + description = lib.mdDoc "Path to Klipper's API socket."; }; stateDir = mkOption { type = types.path; default = "/var/lib/moonraker"; - description = "The directory containing the Moonraker databases."; + description = lib.mdDoc "The directory containing the Moonraker databases."; }; configDir = mkOption { type = types.path; default = cfg.stateDir + "/config"; defaultText = literalExpression ''config.${opt.stateDir} + "/config"''; - description = '' + description = lib.mdDoc '' The directory containing client-writable configuration files. Clients will be able to edit files in this directory via the API. This directory must be writable. @@ -43,26 +43,26 @@ in { user = mkOption { type = types.str; default = "moonraker"; - description = "User account under which Moonraker runs."; + description = lib.mdDoc "User account under which Moonraker runs."; }; group = mkOption { type = types.str; default = "moonraker"; - description = "Group account under which Moonraker runs."; + description = lib.mdDoc "Group account under which Moonraker runs."; }; address = mkOption { type = types.str; default = "127.0.0.1"; example = "0.0.0.0"; - description = "The IP or host to listen on."; + description = lib.mdDoc "The IP or host to listen on."; }; port = mkOption { type = types.ints.unsigned; default = 7125; - description = "The port to listen on."; + description = lib.mdDoc "The port to listen on."; }; settings = mkOption { @@ -74,8 +74,8 @@ in { cors_domains = [ "https://app.fluidd.xyz" ]; }; }; - description = '' - Configuration for Moonraker. See the <link xlink:href="https://moonraker.readthedocs.io/en/latest/configuration/">documentation</link> + description = lib.mdDoc '' + Configuration for Moonraker. See the [documentation](https://moonraker.readthedocs.io/en/latest/configuration/) for supported values. ''; }; @@ -83,12 +83,12 @@ in { allowSystemControl = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to allow Moonraker to perform system-level operations. Moonraker exposes APIs to perform system-level operations, such as reboot, shutdown, and management of systemd units. See the - <link xlink:href="https://moonraker.readthedocs.io/en/latest/web_api/#machine-commands">documentation</link> + [documentation](https://moonraker.readthedocs.io/en/latest/web_api/#machine-commands) for details on what clients are able to do. ''; }; diff --git a/nixos/modules/services/misc/mx-puppet-discord.nix b/nixos/modules/services/misc/mx-puppet-discord.nix index 6214f7f7eb6b4..18b083b99ba37 100644 --- a/nixos/modules/services/misc/mx-puppet-discord.nix +++ b/nixos/modules/services/misc/mx-puppet-discord.nix @@ -57,11 +57,11 @@ in { relay.whitelist = [ "@.*:example.com" ]; } ''; - description = '' - <filename>config.yaml</filename> configuration as a Nix attribute set. + description = lib.mdDoc '' + {file}`config.yaml` configuration as a Nix attribute set. Configuration options should match those described in - <link xlink:href="https://github.com/matrix-discord/mx-puppet-discord/blob/master/sample.config.yaml"> - sample.config.yaml</link>. + [ + sample.config.yaml](https://github.com/matrix-discord/mx-puppet-discord/blob/master/sample.config.yaml). ''; }; serviceDependencies = mkOption { @@ -70,7 +70,7 @@ in { defaultText = literalExpression '' optional config.services.matrix-synapse.enable "matrix-synapse.service" ''; - description = '' + description = lib.mdDoc '' List of Systemd services to require and wait for when starting the application service. ''; }; diff --git a/nixos/modules/services/misc/n8n.nix b/nixos/modules/services/misc/n8n.nix index 77e717eeff9fb..40a262116c83b 100644 --- a/nixos/modules/services/misc/n8n.nix +++ b/nixos/modules/services/misc/n8n.nix @@ -15,14 +15,14 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = "Open ports in the firewall for the n8n web interface."; + description = lib.mdDoc "Open ports in the firewall for the n8n web interface."; }; settings = mkOption { type = format.type; default = {}; - description = '' - Configuration for n8n, see <link xlink:href="https://docs.n8n.io/reference/configuration.html"/> + description = lib.mdDoc '' + Configuration for n8n, see <https://docs.n8n.io/reference/configuration.html> for supported values. ''; }; diff --git a/nixos/modules/services/misc/nitter.nix b/nixos/modules/services/misc/nitter.nix index 5bf0e6bc00893..cb6ba7b739dd8 100644 --- a/nixos/modules/services/misc/nitter.nix +++ b/nixos/modules/services/misc/nitter.nix @@ -53,7 +53,7 @@ in default = pkgs.nitter; type = types.package; defaultText = literalExpression "pkgs.nitter"; - description = "The nitter derivation to use."; + description = lib.mdDoc "The nitter derivation to use."; }; server = { @@ -61,46 +61,46 @@ in type = types.str; default = "0.0.0.0"; example = "127.0.0.1"; - description = "The address to listen on."; + description = lib.mdDoc "The address to listen on."; }; port = mkOption { type = types.port; default = 8080; example = 8000; - description = "The port to listen on."; + description = lib.mdDoc "The port to listen on."; }; https = mkOption { type = types.bool; default = false; - description = "Set secure attribute on cookies. Keep it disabled to enable cookies when not using HTTPS."; + description = lib.mdDoc "Set secure attribute on cookies. Keep it disabled to enable cookies when not using HTTPS."; }; httpMaxConnections = mkOption { type = types.int; default = 100; - description = "Maximum number of HTTP connections."; + description = lib.mdDoc "Maximum number of HTTP connections."; }; staticDir = mkOption { type = types.path; default = "${cfg.package}/share/nitter/public"; defaultText = literalExpression ''"''${config.services.nitter.package}/share/nitter/public"''; - description = "Path to the static files directory."; + description = lib.mdDoc "Path to the static files directory."; }; title = mkOption { type = types.str; default = "nitter"; - description = "Title of the instance."; + description = lib.mdDoc "Title of the instance."; }; hostname = mkOption { type = types.str; default = "localhost"; example = "nitter.net"; - description = "Hostname of the instance."; + description = lib.mdDoc "Hostname of the instance."; }; }; @@ -108,37 +108,37 @@ in listMinutes = mkOption { type = types.int; default = 240; - description = "How long to cache list info (not the tweets, so keep it high)."; + description = lib.mdDoc "How long to cache list info (not the tweets, so keep it high)."; }; rssMinutes = mkOption { type = types.int; default = 10; - description = "How long to cache RSS queries."; + description = lib.mdDoc "How long to cache RSS queries."; }; redisHost = mkOption { type = types.str; default = "localhost"; - description = "Redis host."; + description = lib.mdDoc "Redis host."; }; redisPort = mkOption { type = types.port; default = 6379; - description = "Redis port."; + description = lib.mdDoc "Redis port."; }; redisConnections = mkOption { type = types.int; default = 20; - description = "Redis connection pool size."; + description = lib.mdDoc "Redis connection pool size."; }; redisMaxConnections = mkOption { type = types.int; default = 30; - description = '' + description = lib.mdDoc '' Maximum number of connections to Redis. New connections are opened when none are available, but if the @@ -152,13 +152,13 @@ in base64Media = mkOption { type = types.bool; default = false; - description = "Use base64 encoding for proxied media URLs."; + description = lib.mdDoc "Use base64 encoding for proxied media URLs."; }; tokenCount = mkOption { type = types.int; default = 10; - description = '' + description = lib.mdDoc '' Minimum amount of usable tokens. Tokens are used to authorize API requests, but they expire after @@ -175,105 +175,105 @@ in type = types.str; default = ""; example = "nitter.net"; - description = "Replace Twitter links with links to this instance (blank to disable)."; + description = lib.mdDoc "Replace Twitter links with links to this instance (blank to disable)."; }; replaceYouTube = mkOption { type = types.str; default = ""; example = "piped.kavin.rocks"; - description = "Replace YouTube links with links to this instance (blank to disable)."; + description = lib.mdDoc "Replace YouTube links with links to this instance (blank to disable)."; }; replaceInstagram = mkOption { type = types.str; default = ""; - description = "Replace Instagram links with links to this instance (blank to disable)."; + description = lib.mdDoc "Replace Instagram links with links to this instance (blank to disable)."; }; mp4Playback = mkOption { type = types.bool; default = true; - description = "Enable MP4 video playback."; + description = lib.mdDoc "Enable MP4 video playback."; }; hlsPlayback = mkOption { type = types.bool; default = false; - description = "Enable HLS video streaming (requires JavaScript)."; + description = lib.mdDoc "Enable HLS video streaming (requires JavaScript)."; }; proxyVideos = mkOption { type = types.bool; default = true; - description = "Proxy video streaming through the server (might be slow)."; + description = lib.mdDoc "Proxy video streaming through the server (might be slow)."; }; muteVideos = mkOption { type = types.bool; default = false; - description = "Mute videos by default."; + description = lib.mdDoc "Mute videos by default."; }; autoplayGifs = mkOption { type = types.bool; default = true; - description = "Autoplay GIFs."; + description = lib.mdDoc "Autoplay GIFs."; }; theme = mkOption { type = types.str; default = "Nitter"; - description = "Instance theme."; + description = lib.mdDoc "Instance theme."; }; infiniteScroll = mkOption { type = types.bool; default = false; - description = "Infinite scrolling (requires JavaScript, experimental!)."; + description = lib.mdDoc "Infinite scrolling (requires JavaScript, experimental!)."; }; stickyProfile = mkOption { type = types.bool; default = true; - description = "Make profile sidebar stick to top."; + description = lib.mdDoc "Make profile sidebar stick to top."; }; bidiSupport = mkOption { type = types.bool; default = false; - description = "Support bidirectional text (makes clicking on tweets harder)."; + description = lib.mdDoc "Support bidirectional text (makes clicking on tweets harder)."; }; hideTweetStats = mkOption { type = types.bool; default = false; - description = "Hide tweet stats (replies, retweets, likes)."; + description = lib.mdDoc "Hide tweet stats (replies, retweets, likes)."; }; hideBanner = mkOption { type = types.bool; default = false; - description = "Hide profile banner."; + description = lib.mdDoc "Hide profile banner."; }; hidePins = mkOption { type = types.bool; default = false; - description = "Hide pinned tweets."; + description = lib.mdDoc "Hide pinned tweets."; }; hideReplies = mkOption { type = types.bool; default = false; - description = "Hide tweet replies."; + description = lib.mdDoc "Hide tweet replies."; }; }; settings = mkOption { type = types.attrs; default = {}; - description = '' + description = lib.mdDoc '' Add settings here to override NixOS module generated settings. Check the official repository for the available settings: @@ -284,13 +284,13 @@ in redisCreateLocally = mkOption { type = types.bool; default = true; - description = "Configure local Redis server for Nitter."; + description = lib.mdDoc "Configure local Redis server for Nitter."; }; openFirewall = mkOption { type = types.bool; default = false; - description = "Open ports in the firewall for Nitter web interface."; + description = lib.mdDoc "Open ports in the firewall for Nitter web interface."; }; }; }; diff --git a/nixos/modules/services/misc/nix-daemon.nix b/nixos/modules/services/misc/nix-daemon.nix index f6f74d12e1063..c76aaaa559bf4 100644 --- a/nixos/modules/services/misc/nix-daemon.nix +++ b/nixos/modules/services/misc/nix-daemon.nix @@ -127,7 +127,7 @@ in enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable Nix. Disabling Nix makes the system hard to modify and the Nix programs and configuration will not be made available by NixOS itself. ''; @@ -137,7 +137,7 @@ in type = types.package; default = pkgs.nix; defaultText = literalExpression "pkgs.nix"; - description = '' + description = lib.mdDoc '' This option specifies the Nix package instance to use throughout the system. ''; }; @@ -145,9 +145,9 @@ in distributedBuilds = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to distribute builds to the machines listed in - <option>nix.buildMachines</option>. + {option}`nix.buildMachines`. ''; }; @@ -186,22 +186,22 @@ in type = types.enum [ "best-effort" "idle" ]; default = "best-effort"; example = "idle"; - description = '' + description = lib.mdDoc '' Nix daemon process I/O scheduling class. This class propagates to - build processes. <literal>best-effort</literal> is the default - class for regular tasks. The <literal>idle</literal> class is for + build processes. `best-effort` is the default + class for regular tasks. The `idle` class is for extremely low-priority tasks that should only perform I/O when no other task does. - Please note that while using the <literal>idle</literal> scheduling + Please note that while using the `idle` scheduling class can improve responsiveness of a system performing expensive builds, it might also slow down or starve crucial configuration updates during load. - <literal>idle</literal> may therefore be a sensible class for + `idle` may therefore be a sensible class for systems that experience only intermittent phases of high I/O load, such as desktop or portable computers used interactively. Other - systems should use the <literal>best-effort</literal> class. + systems should use the `best-effort` class. ''; }; @@ -209,7 +209,7 @@ in type = types.int; default = 0; example = 1; - description = '' + description = lib.mdDoc '' Nix daemon process I/O scheduling priority. This priority propagates to build processes. The supported priorities depend on the scheduling policy: With idle, priorities are not used in scheduling @@ -224,7 +224,7 @@ in hostName = mkOption { type = types.str; example = "nixbuilder.example.org"; - description = '' + description = lib.mdDoc '' The hostname of the build machine. ''; }; @@ -254,11 +254,11 @@ in type = types.nullOr types.str; default = null; example = "builder"; - description = '' + description = lib.mdDoc '' The username to log in as on the remote host. This user must be able to log in and run nix commands non-interactively. It must also be privileged to build derivations, so must be included in - <option>nix.settings.trusted-users</option>. + {option}`nix.settings.trusted-users`. ''; }; sshKey = mkOption { @@ -278,7 +278,7 @@ in maxJobs = mkOption { type = types.int; default = 1; - description = '' + description = lib.mdDoc '' The number of concurrent jobs the build machine supports. The build machine will enforce its own limits, but this allows hydra to schedule better since there is no work-stealing between build @@ -288,7 +288,7 @@ in speedFactor = mkOption { type = types.int; default = 1; - description = '' + description = lib.mdDoc '' The relative speed of this builder. This is an arbitrary integer that indicates the speed of this builder, relative to other builders. Higher is faster. @@ -309,7 +309,7 @@ in type = types.listOf types.str; default = [ ]; example = [ "kvm" "big-parallel" ]; - description = '' + description = lib.mdDoc '' A list of features supported by this builder. The builder will be ignored for derivations that require features not in this list. @@ -318,18 +318,18 @@ in publicHostKey = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The (base64-encoded) public host key of this builder. The field - is calculated via <command>base64 -w0 /etc/ssh/ssh_host_type_key.pub</command>. + is calculated via {command}`base64 -w0 /etc/ssh/ssh_host_type_key.pub`. If null, SSH will use its regular known-hosts file when connecting. ''; }; }; }); default = [ ]; - description = '' + description = lib.mdDoc '' This option lists the machines to be used if distributed builds are - enabled (see <option>nix.distributedBuilds</option>). + enabled (see {option}`nix.distributedBuilds`). Nix will perform derivations on those machines via SSH by copying the inputs to the Nix store on the remote machine, starting the build, then copying the output back to the local Nix store. @@ -346,8 +346,8 @@ in nrBuildUsers = mkOption { type = types.int; - description = '' - Number of <literal>nixbld</literal> user accounts created to + description = lib.mdDoc '' + Number of `nixbld` user accounts created to perform secure concurrent builds. If you receive an error message saying that “all build users are currently in use”, you should increase this value. @@ -357,9 +357,9 @@ in readOnlyStore = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' If set, NixOS will enforce the immutability of the Nix store - by making <filename>/nix/store</filename> a read-only bind + by making {file}`/nix/store` a read-only bind mount. Nix will automatically make the store writable when needed. ''; @@ -372,17 +372,17 @@ in "nixos-config=/etc/nixos/configuration.nix" "/nix/var/nix/profiles/per-user/root/channels" ]; - description = '' + description = lib.mdDoc '' The default Nix expression search path, used by the Nix evaluator to look up paths enclosed in angle brackets - (e.g. <literal><nixpkgs></literal>). + (e.g. `<nixpkgs>`). ''; }; checkConfig = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' If enabled (the default), checks for data type mismatches and that Nix can parse the generated nix.conf. ''; @@ -404,28 +404,28 @@ in from = mkOption { type = referenceAttrs; example = { type = "indirect"; id = "nixpkgs"; }; - description = "The flake reference to be rewritten."; + description = lib.mdDoc "The flake reference to be rewritten."; }; to = mkOption { type = referenceAttrs; example = { type = "github"; owner = "my-org"; repo = "my-nixpkgs"; }; - description = "The flake reference <option>from</option> is rewritten to."; + description = lib.mdDoc "The flake reference {option}`from` is rewritten to."; }; flake = mkOption { type = types.nullOr types.attrs; default = null; example = literalExpression "nixpkgs"; - description = '' - The flake input <option>from</option> is rewritten to. + description = lib.mdDoc '' + The flake input {option}`from` is rewritten to. ''; }; exact = mkOption { type = types.bool; default = true; - description = '' - Whether the <option>from</option> reference needs to match exactly. If set, - a <option>from</option> reference like <literal>nixpkgs</literal> does not - match with a reference like <literal>nixpkgs/nixos-20.03</literal>. + description = lib.mdDoc '' + Whether the {option}`from` reference needs to match exactly. If set, + a {option}`from` reference like `nixpkgs` does not + match with a reference like `nixpkgs/nixos-20.03`. ''; }; }; @@ -442,7 +442,7 @@ in } )); default = { }; - description = '' + description = lib.mdDoc '' A system-wide flake registry. ''; }; @@ -454,7 +454,7 @@ in keep-outputs = true keep-derivations = true ''; - description = "Additional text appended to <filename>nix.conf</filename>."; + description = lib.mdDoc "Additional text appended to {file}`nix.conf`."; }; settings = mkOption { @@ -466,7 +466,7 @@ in type = types.either types.int (types.enum [ "auto" ]); default = "auto"; example = 64; - description = '' + description = lib.mdDoc '' This option defines the maximum number of jobs that Nix will try to build in parallel. The default is auto, which means it will use all available logical cores. It is recommend to set it to the total @@ -479,7 +479,7 @@ in type = types.bool; default = false; example = true; - description = '' + description = lib.mdDoc '' If set to true, Nix automatically detects files in the store that have identical contents, and replaces them with hard links to a single copy. This saves disk space. If set to false (the default), you can still run @@ -491,7 +491,7 @@ in type = types.int; default = 0; example = 64; - description = '' + description = lib.mdDoc '' This option defines the maximum number of concurrent tasks during one build. It affects, e.g., -j option for make. The special value 0 means that the builder should use all @@ -504,7 +504,7 @@ in sandbox = mkOption { type = types.either types.bool (types.enum [ "relaxed" ]); default = true; - description = '' + description = lib.mdDoc '' If set, Nix will perform builds in a sandboxed environment that it will set up automatically for each build. This prevents impurities in builds by disallowing access to dependencies outside of the Nix @@ -520,7 +520,7 @@ in type = types.listOf types.str; default = [ ]; example = [ "/dev" "/proc" ]; - description = '' + description = lib.mdDoc '' Directories from the host filesystem to be included in the sandbox. ''; @@ -528,7 +528,7 @@ in substituters = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' List of binary cache URLs used to obtain pre-built binaries of Nix packages. @@ -540,21 +540,21 @@ in type = types.listOf types.str; default = [ ]; example = [ "https://hydra.nixos.org/" ]; - description = '' + description = lib.mdDoc '' List of binary cache URLs that non-root users can use (in addition to those specified using - <option>nix.settings.substituters</option>) by passing - <literal>--option binary-caches</literal> to Nix commands. + {option}`nix.settings.substituters`) by passing + `--option binary-caches` to Nix commands. ''; }; require-sigs = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' If enabled (the default), Nix will only download binaries from binary caches if they are cryptographically signed with any of the keys listed in - <option>nix.settings.trusted-public-keys</option>. If disabled, signatures are neither + {option}`nix.settings.trusted-public-keys`. If disabled, signatures are neither required nor checked, so it's strongly recommended that you use only trustworthy caches and https to prevent man-in-the-middle attacks. ''; @@ -577,13 +577,13 @@ in type = types.listOf types.str; default = [ "root" ]; example = [ "root" "alice" "@wheel" ]; - description = '' + description = lib.mdDoc '' A list of names of users that have additional rights when connecting to the Nix daemon, such as the ability to specify additional binary caches, or to import unsigned NARs. You can also specify groups by prefixing them with - <literal>@</literal>; for instance, - <literal>@wheel</literal> means all users in the wheel + `@`; for instance, + `@wheel` means all users in the wheel group. ''; }; @@ -591,13 +591,13 @@ in system-features = mkOption { type = types.listOf types.str; example = [ "kvm" "big-parallel" "gccarch-skylake" ]; - description = '' + description = lib.mdDoc '' The set of features supported by the machine. Derivations can express dependencies on system features through the - <literal>requiredSystemFeatures</literal> attribute. + `requiredSystemFeatures` attribute. - By default, pseudo-features <literal>nixos-test</literal>, <literal>benchmark</literal>, - and <literal>big-parallel</literal> used in Nixpkgs are set, <literal>kvm</literal> + By default, pseudo-features `nixos-test`, `benchmark`, + and `big-parallel` used in Nixpkgs are set, `kvm` is also included in it is avaliable. ''; }; diff --git a/nixos/modules/services/misc/nix-gc.nix b/nixos/modules/services/misc/nix-gc.nix index 0fcb016010175..ac554dcea8d45 100644 --- a/nixos/modules/services/misc/nix-gc.nix +++ b/nixos/modules/services/misc/nix-gc.nix @@ -17,7 +17,7 @@ in automatic = mkOption { default = false; type = types.bool; - description = "Automatically run the garbage collector at a specific time."; + description = lib.mdDoc "Automatically run the garbage collector at a specific time."; }; dates = mkOption { @@ -51,7 +51,7 @@ in default = true; type = types.bool; example = false; - description = '' + description = lib.mdDoc '' Takes a boolean argument. If true, the time when the service unit was last triggered is stored on disk. When the timer is activated, the service unit is triggered immediately if it @@ -67,8 +67,8 @@ in default = ""; example = "--max-freed $((64 * 1024**3))"; type = types.str; - description = '' - Options given to <filename>nix-collect-garbage</filename> when the + description = lib.mdDoc '' + Options given to {file}`nix-collect-garbage` when the garbage collector is run automatically. ''; }; diff --git a/nixos/modules/services/misc/nix-optimise.nix b/nixos/modules/services/misc/nix-optimise.nix index acf8177b146ae..bcfc69c521deb 100644 --- a/nixos/modules/services/misc/nix-optimise.nix +++ b/nixos/modules/services/misc/nix-optimise.nix @@ -17,7 +17,7 @@ in automatic = mkOption { default = false; type = types.bool; - description = "Automatically run the nix store optimiser at a specific time."; + description = lib.mdDoc "Automatically run the nix store optimiser at a specific time."; }; dates = mkOption { diff --git a/nixos/modules/services/misc/nix-ssh-serve.nix b/nixos/modules/services/misc/nix-ssh-serve.nix index 355fad5db4681..b656692ca01cd 100644 --- a/nixos/modules/services/misc/nix-ssh-serve.nix +++ b/nixos/modules/services/misc/nix-ssh-serve.nix @@ -14,26 +14,26 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable serving the Nix store as a remote store via SSH."; + description = lib.mdDoc "Whether to enable serving the Nix store as a remote store via SSH."; }; write = mkOption { type = types.bool; default = false; - description = "Whether to enable writing to the Nix store as a remote store via SSH. Note: the sshServe user is named nix-ssh and is not a trusted-user. nix-ssh should be added to the <option>nix.settings.trusted-users</option> option in most use cases, such as allowing remote building of derivations."; + description = lib.mdDoc "Whether to enable writing to the Nix store as a remote store via SSH. Note: the sshServe user is named nix-ssh and is not a trusted-user. nix-ssh should be added to the {option}`nix.settings.trusted-users` option in most use cases, such as allowing remote building of derivations."; }; keys = mkOption { type = types.listOf types.str; default = []; example = [ "ssh-dss AAAAB3NzaC1k... alice@example.org" ]; - description = "A list of SSH public keys allowed to access the binary cache via SSH."; + description = lib.mdDoc "A list of SSH public keys allowed to access the binary cache via SSH."; }; protocol = mkOption { type = types.enum [ "ssh" "ssh-ng" ]; default = "ssh"; - description = "The specific Nix-over-SSH protocol to use."; + description = lib.mdDoc "The specific Nix-over-SSH protocol to use."; }; }; diff --git a/nixos/modules/services/misc/nzbget.nix b/nixos/modules/services/misc/nzbget.nix index 27c5f2e395f6d..ddcb16e135cf1 100644 --- a/nixos/modules/services/misc/nzbget.nix +++ b/nixos/modules/services/misc/nzbget.nix @@ -30,21 +30,21 @@ in user = mkOption { type = types.str; default = "nzbget"; - description = "User account under which NZBGet runs"; + description = lib.mdDoc "User account under which NZBGet runs"; }; group = mkOption { type = types.str; default = "nzbget"; - description = "Group under which NZBGet runs"; + description = lib.mdDoc "Group under which NZBGet runs"; }; settings = mkOption { type = with types; attrsOf (oneOf [ bool int str ]); default = {}; - description = '' + description = lib.mdDoc '' NZBGet configuration, passed via command line using switch -o. Refer to - <link xlink:href="https://github.com/nzbget/nzbget/blob/master/nzbget.conf"/> + <https://github.com/nzbget/nzbget/blob/master/nzbget.conf> for details on supported values. ''; example = { diff --git a/nixos/modules/services/misc/nzbhydra2.nix b/nixos/modules/services/misc/nzbhydra2.nix index 500c40f117dda..b728ca248ce31 100644 --- a/nixos/modules/services/misc/nzbhydra2.nix +++ b/nixos/modules/services/misc/nzbhydra2.nix @@ -12,21 +12,21 @@ in { dataDir = mkOption { type = types.str; default = "/var/lib/nzbhydra2"; - description = "The directory where NZBHydra2 stores its data files."; + description = lib.mdDoc "The directory where NZBHydra2 stores its data files."; }; openFirewall = mkOption { type = types.bool; default = false; description = - "Open ports in the firewall for the NZBHydra2 web interface."; + lib.mdDoc "Open ports in the firewall for the NZBHydra2 web interface."; }; package = mkOption { type = types.package; default = pkgs.nzbhydra2; defaultText = literalExpression "pkgs.nzbhydra2"; - description = "NZBHydra2 package to use."; + description = lib.mdDoc "NZBHydra2 package to use."; }; }; }; diff --git a/nixos/modules/services/misc/octoprint.nix b/nixos/modules/services/misc/octoprint.nix index cd846d3f268da..071174c141d16 100644 --- a/nixos/modules/services/misc/octoprint.nix +++ b/nixos/modules/services/misc/octoprint.nix @@ -34,7 +34,7 @@ in host = mkOption { type = types.str; default = "0.0.0.0"; - description = '' + description = lib.mdDoc '' Host to bind OctoPrint to. ''; }; @@ -42,7 +42,7 @@ in port = mkOption { type = types.port; default = 5000; - description = '' + description = lib.mdDoc '' Port to bind OctoPrint to. ''; }; @@ -50,19 +50,19 @@ in user = mkOption { type = types.str; default = "octoprint"; - description = "User for the daemon."; + description = lib.mdDoc "User for the daemon."; }; group = mkOption { type = types.str; default = "octoprint"; - description = "Group for the daemon."; + description = lib.mdDoc "Group for the daemon."; }; stateDir = mkOption { type = types.path; default = "/var/lib/octoprint"; - description = "State directory of the daemon."; + description = lib.mdDoc "State directory of the daemon."; }; plugins = mkOption { @@ -70,13 +70,13 @@ in default = plugins: []; defaultText = literalExpression "plugins: []"; example = literalExpression "plugins: with plugins; [ themeify stlviewer ]"; - description = "Additional plugins to be used. Available plugins are passed through the plugins input."; + description = lib.mdDoc "Additional plugins to be used. Available plugins are passed through the plugins input."; }; extraConfig = mkOption { type = types.attrs; default = {}; - description = "Extra options which are added to OctoPrint's YAML configuration file."; + description = lib.mdDoc "Extra options which are added to OctoPrint's YAML configuration file."; }; }; diff --git a/nixos/modules/services/misc/ombi.nix b/nixos/modules/services/misc/ombi.nix index b5882168e519b..51cfb05d35c94 100644 --- a/nixos/modules/services/misc/ombi.nix +++ b/nixos/modules/services/misc/ombi.nix @@ -16,31 +16,31 @@ in { dataDir = mkOption { type = types.str; default = "/var/lib/ombi"; - description = "The directory where Ombi stores its data files."; + description = lib.mdDoc "The directory where Ombi stores its data files."; }; port = mkOption { type = types.port; default = 5000; - description = "The port for the Ombi web interface."; + description = lib.mdDoc "The port for the Ombi web interface."; }; openFirewall = mkOption { type = types.bool; default = false; - description = "Open ports in the firewall for the Ombi web interface."; + description = lib.mdDoc "Open ports in the firewall for the Ombi web interface."; }; user = mkOption { type = types.str; default = "ombi"; - description = "User account under which Ombi runs."; + description = lib.mdDoc "User account under which Ombi runs."; }; group = mkOption { type = types.str; default = "ombi"; - description = "Group under which Ombi runs."; + description = lib.mdDoc "Group under which Ombi runs."; }; }; }; diff --git a/nixos/modules/services/misc/osrm.nix b/nixos/modules/services/misc/osrm.nix index 79c347ab7e0ef..bcfb868422cc7 100644 --- a/nixos/modules/services/misc/osrm.nix +++ b/nixos/modules/services/misc/osrm.nix @@ -11,44 +11,44 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable the OSRM service."; + description = lib.mdDoc "Enable the OSRM service."; }; address = mkOption { type = types.str; default = "0.0.0.0"; - description = "IP address on which the web server will listen."; + description = lib.mdDoc "IP address on which the web server will listen."; }; port = mkOption { type = types.int; default = 5000; - description = "Port on which the web server will run."; + description = lib.mdDoc "Port on which the web server will run."; }; threads = mkOption { type = types.int; default = 4; - description = "Number of threads to use."; + description = lib.mdDoc "Number of threads to use."; }; algorithm = mkOption { type = types.enum [ "CH" "CoreCH" "MLD" ]; default = "MLD"; - description = "Algorithm to use for the data. Must be one of CH, CoreCH, MLD"; + description = lib.mdDoc "Algorithm to use for the data. Must be one of CH, CoreCH, MLD"; }; extraFlags = mkOption { type = types.listOf types.str; default = []; example = [ "--max-table-size 1000" "--max-matching-size 1000" ]; - description = "Extra command line arguments passed to osrm-routed"; + description = lib.mdDoc "Extra command line arguments passed to osrm-routed"; }; dataFile = mkOption { type = types.path; example = "/var/lib/osrm/berlin-latest.osrm"; - description = "Data file location"; + description = lib.mdDoc "Data file location"; }; }; diff --git a/nixos/modules/services/misc/owncast.nix b/nixos/modules/services/misc/owncast.nix index 0852335238fd4..23c49d1c1196f 100644 --- a/nixos/modules/services/misc/owncast.nix +++ b/nixos/modules/services/misc/owncast.nix @@ -10,7 +10,7 @@ in { dataDir = mkOption { type = types.str; default = "/var/lib/owncast"; - description = '' + description = lib.mdDoc '' The directory where owncast stores its data files. If left as the default value this directory will automatically be created before the owncast server starts, otherwise the sysadmin is responsible for ensuring the directory exists with appropriate ownership and permissions. ''; }; @@ -18,7 +18,7 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open the appropriate ports in the firewall for owncast. ''; }; @@ -26,26 +26,26 @@ in { user = mkOption { type = types.str; default = "owncast"; - description = "User account under which owncast runs."; + description = lib.mdDoc "User account under which owncast runs."; }; group = mkOption { type = types.str; default = "owncast"; - description = "Group under which owncast runs."; + description = lib.mdDoc "Group under which owncast runs."; }; listen = mkOption { type = types.str; default = "127.0.0.1"; example = "0.0.0.0"; - description = "The IP address to bind the owncast web server to."; + description = lib.mdDoc "The IP address to bind the owncast web server to."; }; port = mkOption { type = types.port; default = 8080; - description = '' + description = lib.mdDoc '' TCP port where owncast web-gui listens. ''; }; @@ -53,7 +53,7 @@ in { rtmp-port = mkOption { type = types.port; default = 1935; - description = '' + description = lib.mdDoc '' TCP port where owncast rtmp service listens. ''; }; diff --git a/nixos/modules/services/misc/packagekit.nix b/nixos/modules/services/misc/packagekit.nix index 9191078ef9ca4..04150ef76ff69 100644 --- a/nixos/modules/services/misc/packagekit.nix +++ b/nixos/modules/services/misc/packagekit.nix @@ -48,13 +48,13 @@ in settings = mkOption { type = iniFmt.type; default = { }; - description = "Additional settings passed straight through to PackageKit.conf"; + description = lib.mdDoc "Additional settings passed straight through to PackageKit.conf"; }; vendorSettings = mkOption { type = iniFmt.type; default = { }; - description = "Additional settings passed straight through to Vendor.conf"; + description = lib.mdDoc "Additional settings passed straight through to Vendor.conf"; }; }; diff --git a/nixos/modules/services/misc/paperless.nix b/nixos/modules/services/misc/paperless.nix index 17cd555d7e1bd..fbf1338a0dffd 100644 --- a/nixos/modules/services/misc/paperless.nix +++ b/nixos/modules/services/misc/paperless.nix @@ -93,7 +93,7 @@ in enable = mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable Paperless. When started, the Paperless database is automatically created if it doesn't @@ -101,54 +101,54 @@ in Both tasks are achieved by running a Django migration. A script to manage the Paperless instance (by wrapping Django's manage.py) is linked to - <literal>''${dataDir}/paperless-manage</literal>. + `''${dataDir}/paperless-manage`. ''; }; dataDir = mkOption { type = types.str; default = "/var/lib/paperless"; - description = "Directory to store the Paperless data."; + description = lib.mdDoc "Directory to store the Paperless data."; }; mediaDir = mkOption { type = types.str; default = "${cfg.dataDir}/media"; defaultText = literalExpression ''"''${dataDir}/media"''; - description = "Directory to store the Paperless documents."; + description = lib.mdDoc "Directory to store the Paperless documents."; }; consumptionDir = mkOption { type = types.str; default = "${cfg.dataDir}/consume"; defaultText = literalExpression ''"''${dataDir}/consume"''; - description = "Directory from which new documents are imported."; + description = lib.mdDoc "Directory from which new documents are imported."; }; consumptionDirIsPublic = mkOption { type = types.bool; default = false; - description = "Whether all users can write to the consumption dir."; + description = lib.mdDoc "Whether all users can write to the consumption dir."; }; passwordFile = mkOption { type = types.nullOr types.path; default = null; example = "/run/keys/paperless-password"; - description = '' + description = lib.mdDoc '' A file containing the superuser password. A superuser is required to access the web interface. If unset, you can create a superuser manually by running - <literal>''${dataDir}/paperless-manage createsuperuser</literal>. + `''${dataDir}/paperless-manage createsuperuser`. - The default superuser name is <literal>admin</literal>. To change it, set - option <option>extraConfig.PAPERLESS_ADMIN_USER</option>. + The default superuser name is `admin`. To change it, set + option {option}`extraConfig.PAPERLESS_ADMIN_USER`. WARNING: When changing the superuser name after the initial setup, the old superuser will continue to exist. To disable login for the web interface, set the following: - <literal>extraConfig.PAPERLESS_AUTO_LOGIN_USERNAME = "admin";</literal>. + `extraConfig.PAPERLESS_AUTO_LOGIN_USERNAME = "admin";`. WARNING: Only use this on a trusted system without internet access to Paperless. ''; }; @@ -156,22 +156,22 @@ in address = mkOption { type = types.str; default = "localhost"; - description = "Web interface address."; + description = lib.mdDoc "Web interface address."; }; port = mkOption { type = types.port; default = 28981; - description = "Web interface port."; + description = lib.mdDoc "Web interface port."; }; extraConfig = mkOption { type = types.attrs; default = {}; - description = '' + description = lib.mdDoc '' Extra paperless config options. - See <link xlink:href="https://paperless-ngx.readthedocs.io/en/latest/configuration.html">the documentation</link> + See [the documentation](https://paperless-ngx.readthedocs.io/en/latest/configuration.html) for available options. ''; example = literalExpression '' @@ -184,14 +184,14 @@ in user = mkOption { type = types.str; default = defaultUser; - description = "User under which Paperless runs."; + description = lib.mdDoc "User under which Paperless runs."; }; package = mkOption { type = types.package; default = pkgs.paperless-ngx; defaultText = literalExpression "pkgs.paperless-ngx"; - description = "The Paperless package to use."; + description = lib.mdDoc "The Paperless package to use."; }; }; diff --git a/nixos/modules/services/misc/parsoid.nix b/nixos/modules/services/misc/parsoid.nix index 09b7f977bfbfc..101ece5ab4c63 100644 --- a/nixos/modules/services/misc/parsoid.nix +++ b/nixos/modules/services/misc/parsoid.nix @@ -39,7 +39,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable Parsoid -- bidirectional wikitext parser. ''; @@ -48,7 +48,7 @@ in wikis = mkOption { type = types.listOf (types.either types.str types.attrs); example = [ "http://localhost/api.php" ]; - description = '' + description = lib.mdDoc '' Used MediaWiki API endpoints. ''; }; @@ -56,7 +56,7 @@ in workers = mkOption { type = types.int; default = 2; - description = '' + description = lib.mdDoc '' Number of Parsoid workers. ''; }; @@ -64,7 +64,7 @@ in interface = mkOption { type = types.str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' Interface to listen on. ''; }; @@ -72,7 +72,7 @@ in port = mkOption { type = types.int; default = 8000; - description = '' + description = lib.mdDoc '' Port to listen on. ''; }; @@ -80,7 +80,7 @@ in extraConfig = mkOption { type = types.attrs; default = {}; - description = '' + description = lib.mdDoc '' Extra configuration to add to parsoid configuration. ''; }; diff --git a/nixos/modules/services/misc/pinnwand.nix b/nixos/modules/services/misc/pinnwand.nix index cbc796c9a7c88..4eda25b4eb88a 100644 --- a/nixos/modules/services/misc/pinnwand.nix +++ b/nixos/modules/services/misc/pinnwand.nix @@ -14,15 +14,15 @@ in port = mkOption { type = types.port; - description = "The port to listen on."; + description = lib.mdDoc "The port to listen on."; default = 8000; }; settings = mkOption { type = format.type; - description = '' - Your <filename>pinnwand.toml</filename> as a Nix attribute set. Look up - possible options in the <link xlink:href="https://github.com/supakeen/pinnwand/blob/master/pinnwand.toml-example">pinnwand.toml-example</link>. + description = lib.mdDoc '' + Your {file}`pinnwand.toml` as a Nix attribute set. Look up + possible options in the [pinnwand.toml-example](https://github.com/supakeen/pinnwand/blob/master/pinnwand.toml-example). ''; default = {}; }; diff --git a/nixos/modules/services/misc/plex.nix b/nixos/modules/services/misc/plex.nix index 1cd8da768f48d..cb41bbb54b27b 100644 --- a/nixos/modules/services/misc/plex.nix +++ b/nixos/modules/services/misc/plex.nix @@ -17,7 +17,7 @@ in dataDir = mkOption { type = types.str; default = "/var/lib/plex"; - description = '' + description = lib.mdDoc '' The directory where Plex stores its data files. ''; }; @@ -25,7 +25,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for the media server. ''; }; @@ -33,7 +33,7 @@ in user = mkOption { type = types.str; default = "plex"; - description = '' + description = lib.mdDoc '' User account under which Plex runs. ''; }; @@ -41,7 +41,7 @@ in group = mkOption { type = types.str; default = "plex"; - description = '' + description = lib.mdDoc '' Group under which Plex runs. ''; }; @@ -49,7 +49,7 @@ in extraPlugins = mkOption { type = types.listOf types.path; default = []; - description = '' + description = lib.mdDoc '' A list of paths to extra plugin bundles to install in Plex's plugin directory. Every time the systemd unit for Plex starts up, all of the symlinks in Plex's plugin directory will be cleared and this module @@ -73,7 +73,7 @@ in extraScanners = mkOption { type = types.listOf types.path; default = []; - description = '' + description = lib.mdDoc '' A list of paths to extra scanners to install in Plex's scanners directory. @@ -97,7 +97,7 @@ in type = types.package; default = pkgs.plex; defaultText = literalExpression "pkgs.plex"; - description = '' + description = lib.mdDoc '' The Plex package to use. Plex subscribers may wish to use their own package here, pointing to subscriber-only server versions. ''; diff --git a/nixos/modules/services/misc/plikd.nix b/nixos/modules/services/misc/plikd.nix index a62dbef1d2af3..9ae9e064fd546 100644 --- a/nixos/modules/services/misc/plikd.nix +++ b/nixos/modules/services/misc/plikd.nix @@ -16,14 +16,14 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = "Open ports in the firewall for the plikd."; + description = lib.mdDoc "Open ports in the firewall for the plikd."; }; settings = mkOption { type = format.type; default = {}; - description = '' - Configuration for plikd, see <link xlink:href="https://github.com/root-gg/plik/blob/master/server/plikd.cfg"/> + description = lib.mdDoc '' + Configuration for plikd, see <https://github.com/root-gg/plik/blob/master/server/plikd.cfg> for supported values. ''; }; diff --git a/nixos/modules/services/misc/podgrab.nix b/nixos/modules/services/misc/podgrab.nix index 7077408b7942f..590309ace7ec6 100644 --- a/nixos/modules/services/misc/podgrab.nix +++ b/nixos/modules/services/misc/podgrab.nix @@ -10,7 +10,7 @@ in type = with types; nullOr str; default = null; example = "/run/secrets/password.env"; - description = '' + description = lib.mdDoc '' The path to a file containing the PASSWORD environment variable definition for Podgrab's authentification. ''; @@ -20,7 +20,7 @@ in type = types.port; default = 8080; example = 4242; - description = "The port on which Podgrab will listen for incoming HTTP traffic."; + description = lib.mdDoc "The port on which Podgrab will listen for incoming HTTP traffic."; }; }; diff --git a/nixos/modules/services/misc/polaris.nix b/nixos/modules/services/misc/polaris.nix index 68045af1528b5..b5f7f17e664ce 100644 --- a/nixos/modules/services/misc/polaris.nix +++ b/nixos/modules/services/misc/polaris.nix @@ -18,26 +18,26 @@ in user = mkOption { type = types.str; default = "polaris"; - description = "User account under which Polaris runs."; + description = lib.mdDoc "User account under which Polaris runs."; }; group = mkOption { type = types.str; default = "polaris"; - description = "Group under which Polaris is run."; + description = lib.mdDoc "Group under which Polaris is run."; }; extraGroups = mkOption { type = types.listOf types.str; default = []; - description = "Polaris' auxiliary groups."; + description = lib.mdDoc "Polaris' auxiliary groups."; example = literalExpression ''["media" "music"]''; }; port = mkOption { type = types.port; default = 5050; - description = '' + description = lib.mdDoc '' The port which the Polaris REST api and web UI should listen to. Note: polaris is hardcoded to listen to the hostname "0.0.0.0". ''; @@ -46,10 +46,10 @@ in settings = mkOption { type = settingsFormat.type; default = {}; - description = '' + description = lib.mdDoc '' Contents for the TOML Polaris config, applied each start. Although poorly documented, an example may be found here: - <link xlink:href="https://github.com/agersant/polaris/blob/374d0ca56fc0a466d797a4b252e2078607476797/test-data/config.toml">test-config.toml</link> + [test-config.toml](https://github.com/agersant/polaris/blob/374d0ca56fc0a466d797a4b252e2078607476797/test-data/config.toml) ''; example = literalExpression '' { @@ -73,7 +73,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open the configured port in the firewall. ''; }; diff --git a/nixos/modules/services/misc/prowlarr.nix b/nixos/modules/services/misc/prowlarr.nix index ef820b4022d5b..6152ee4a76970 100644 --- a/nixos/modules/services/misc/prowlarr.nix +++ b/nixos/modules/services/misc/prowlarr.nix @@ -14,7 +14,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = "Open ports in the firewall for the Prowlarr web interface."; + description = lib.mdDoc "Open ports in the firewall for the Prowlarr web interface."; }; }; }; diff --git a/nixos/modules/services/misc/pykms.nix b/nixos/modules/services/misc/pykms.nix index 2f752bcc7ed6b..d24cd1bfa05b6 100644 --- a/nixos/modules/services/misc/pykms.nix +++ b/nixos/modules/services/misc/pykms.nix @@ -18,43 +18,43 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the PyKMS service."; + description = lib.mdDoc "Whether to enable the PyKMS service."; }; listenAddress = mkOption { type = types.str; default = "0.0.0.0"; - description = "The IP address on which to listen."; + description = lib.mdDoc "The IP address on which to listen."; }; port = mkOption { type = types.int; default = 1688; - description = "The port on which to listen."; + description = lib.mdDoc "The port on which to listen."; }; openFirewallPort = mkOption { type = types.bool; default = false; - description = "Whether the listening port should be opened automatically."; + description = lib.mdDoc "Whether the listening port should be opened automatically."; }; memoryLimit = mkOption { type = types.str; default = "64M"; - description = "How much memory to use at most."; + description = lib.mdDoc "How much memory to use at most."; }; logLevel = mkOption { type = types.enum [ "CRITICAL" "ERROR" "WARNING" "INFO" "DEBUG" "MININFO" ]; default = "INFO"; - description = "How much to log"; + description = lib.mdDoc "How much to log"; }; extraArgs = mkOption { type = types.listOf types.str; default = [ ]; - description = "Additional arguments"; + description = lib.mdDoc "Additional arguments"; }; }; }; diff --git a/nixos/modules/services/misc/radarr.nix b/nixos/modules/services/misc/radarr.nix index 826d59da0af14..a2d7b734f709e 100644 --- a/nixos/modules/services/misc/radarr.nix +++ b/nixos/modules/services/misc/radarr.nix @@ -12,7 +12,7 @@ in enable = mkEnableOption "Radarr"; package = mkOption { - description = "Radarr package to use"; + description = lib.mdDoc "Radarr package to use"; default = pkgs.radarr; defaultText = literalExpression "pkgs.radarr"; example = literalExpression "pkgs.radarr"; @@ -22,25 +22,25 @@ in dataDir = mkOption { type = types.str; default = "/var/lib/radarr/.config/Radarr"; - description = "The directory where Radarr stores its data files."; + description = lib.mdDoc "The directory where Radarr stores its data files."; }; openFirewall = mkOption { type = types.bool; default = false; - description = "Open ports in the firewall for the Radarr web interface."; + description = lib.mdDoc "Open ports in the firewall for the Radarr web interface."; }; user = mkOption { type = types.str; default = "radarr"; - description = "User account under which Radarr runs."; + description = lib.mdDoc "User account under which Radarr runs."; }; group = mkOption { type = types.str; default = "radarr"; - description = "Group under which Radarr runs."; + description = lib.mdDoc "Group under which Radarr runs."; }; }; }; diff --git a/nixos/modules/services/misc/redmine.nix b/nixos/modules/services/misc/redmine.nix index 696b8d1a25d9c..13b62f4355796 100644 --- a/nixos/modules/services/misc/redmine.nix +++ b/nixos/modules/services/misc/redmine.nix @@ -55,40 +55,40 @@ in type = types.package; default = pkgs.redmine; defaultText = literalExpression "pkgs.redmine"; - description = "Which Redmine package to use."; + description = lib.mdDoc "Which Redmine package to use."; example = literalExpression "pkgs.redmine.override { ruby = pkgs.ruby_2_7; }"; }; user = mkOption { type = types.str; default = "redmine"; - description = "User under which Redmine is ran."; + description = lib.mdDoc "User under which Redmine is ran."; }; group = mkOption { type = types.str; default = "redmine"; - description = "Group under which Redmine is ran."; + description = lib.mdDoc "Group under which Redmine is ran."; }; port = mkOption { type = types.port; default = 3000; - description = "Port on which Redmine is ran."; + description = lib.mdDoc "Port on which Redmine is ran."; }; stateDir = mkOption { type = types.str; default = "/var/lib/redmine"; - description = "The state directory, logs and plugins are stored here."; + description = lib.mdDoc "The state directory, logs and plugins are stored here."; }; settings = mkOption { type = format.type; default = {}; - description = '' - Redmine configuration (<filename>configuration.yml</filename>). Refer to - <link xlink:href="https://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration"/> + description = lib.mdDoc '' + Redmine configuration ({file}`configuration.yml`). Refer to + <https://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration> for details. ''; example = literalExpression '' @@ -107,10 +107,10 @@ in extraEnv = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration in additional_environment.rb. - See <link xlink:href="https://svn.redmine.org/redmine/trunk/config/additional_environment.rb.example"/> + See <https://svn.redmine.org/redmine/trunk/config/additional_environment.rb.example> for details. ''; example = '' @@ -121,7 +121,7 @@ in themes = mkOption { type = types.attrsOf types.path; default = {}; - description = "Set of themes."; + description = lib.mdDoc "Set of themes."; example = literalExpression '' { dkuk-redmine_alex_skin = builtins.fetchurl { @@ -135,7 +135,7 @@ in plugins = mkOption { type = types.attrsOf types.path; default = {}; - description = "Set of plugins."; + description = lib.mdDoc "Set of plugins."; example = literalExpression '' { redmine_env_auth = builtins.fetchurl { @@ -151,41 +151,41 @@ in type = types.enum [ "mysql2" "postgresql" ]; example = "postgresql"; default = "mysql2"; - description = "Database engine to use."; + description = lib.mdDoc "Database engine to use."; }; host = mkOption { type = types.str; default = "localhost"; - description = "Database host address."; + description = lib.mdDoc "Database host address."; }; port = mkOption { type = types.int; default = if cfg.database.type == "postgresql" then 5432 else 3306; defaultText = literalExpression "3306"; - description = "Database host port."; + description = lib.mdDoc "Database host port."; }; name = mkOption { type = types.str; default = "redmine"; - description = "Database name."; + description = lib.mdDoc "Database name."; }; user = mkOption { type = types.str; default = "redmine"; - description = "Database user."; + description = lib.mdDoc "Database user."; }; passwordFile = mkOption { type = types.nullOr types.path; default = null; example = "/run/keys/redmine-dbpassword"; - description = '' + description = lib.mdDoc '' A file containing the password corresponding to - <option>database.user</option>. + {option}`database.user`. ''; }; @@ -197,13 +197,13 @@ in else null; defaultText = literalExpression "/run/mysqld/mysqld.sock"; example = "/run/mysqld/mysqld.sock"; - description = "Path to the unix socket file to use for authentication."; + description = lib.mdDoc "Path to the unix socket file to use for authentication."; }; createLocally = mkOption { type = types.bool; default = true; - description = "Create the database and database user locally."; + description = lib.mdDoc "Create the database and database user locally."; }; }; }; diff --git a/nixos/modules/services/misc/ripple-data-api.nix b/nixos/modules/services/misc/ripple-data-api.nix index 93eba98b7d309..7d8a4cb2b44cb 100644 --- a/nixos/modules/services/misc/ripple-data-api.nix +++ b/nixos/modules/services/misc/ripple-data-api.nix @@ -38,44 +38,44 @@ in { enable = mkEnableOption "ripple data api"; port = mkOption { - description = "Ripple data api port"; + description = lib.mdDoc "Ripple data api port"; default = 5993; type = types.int; }; importMode = mkOption { - description = "Ripple data api import mode."; + description = lib.mdDoc "Ripple data api import mode."; default = "liveOnly"; type = types.enum ["live" "liveOnly"]; }; minLedger = mkOption { - description = "Ripple data api minimal ledger to fetch."; + description = lib.mdDoc "Ripple data api minimal ledger to fetch."; default = null; type = types.nullOr types.int; }; maxLedger = mkOption { - description = "Ripple data api maximal ledger to fetch."; + description = lib.mdDoc "Ripple data api maximal ledger to fetch."; default = null; type = types.nullOr types.int; }; redis = { enable = mkOption { - description = "Whether to enable caching of ripple data to redis."; + description = lib.mdDoc "Whether to enable caching of ripple data to redis."; default = true; type = types.bool; }; host = mkOption { - description = "Ripple data api redis host."; + description = lib.mdDoc "Ripple data api redis host."; default = "localhost"; type = types.str; }; port = mkOption { - description = "Ripple data api redis port."; + description = lib.mdDoc "Ripple data api redis port."; default = 5984; type = types.int; }; @@ -83,44 +83,44 @@ in { couchdb = { host = mkOption { - description = "Ripple data api couchdb host."; + description = lib.mdDoc "Ripple data api couchdb host."; default = "localhost"; type = types.str; }; port = mkOption { - description = "Ripple data api couchdb port."; + description = lib.mdDoc "Ripple data api couchdb port."; default = 5984; type = types.int; }; db = mkOption { - description = "Ripple data api couchdb database."; + description = lib.mdDoc "Ripple data api couchdb database."; default = "rippled"; type = types.str; }; user = mkOption { - description = "Ripple data api couchdb username."; + description = lib.mdDoc "Ripple data api couchdb username."; default = "rippled"; type = types.str; }; pass = mkOption { - description = "Ripple data api couchdb password."; + description = lib.mdDoc "Ripple data api couchdb password."; default = ""; type = types.str; }; create = mkOption { - description = "Whether to create couchdb database needed by ripple data api."; + description = lib.mdDoc "Whether to create couchdb database needed by ripple data api."; type = types.bool; default = true; }; }; rippleds = mkOption { - description = "List of rippleds to be used by ripple data api."; + description = lib.mdDoc "List of rippleds to be used by ripple data api."; default = [ "http://s_east.ripple.com:51234" "http://s_west.ripple.com:51234" diff --git a/nixos/modules/services/misc/rippled.nix b/nixos/modules/services/misc/rippled.nix index f6ec0677774b3..8b6704c1be77f 100644 --- a/nixos/modules/services/misc/rippled.nix +++ b/nixos/modules/services/misc/rippled.nix @@ -92,41 +92,41 @@ let ip = mkOption { default = "127.0.0.1"; - description = "Ip where rippled listens."; + description = lib.mdDoc "Ip where rippled listens."; type = types.str; }; port = mkOption { - description = "Port where rippled listens."; + description = lib.mdDoc "Port where rippled listens."; type = types.int; }; protocol = mkOption { - description = "Protocols expose by rippled."; + description = lib.mdDoc "Protocols expose by rippled."; type = types.listOf (types.enum ["http" "https" "ws" "wss" "peer"]); }; user = mkOption { - description = "When set, these credentials will be required on HTTP/S requests."; + description = lib.mdDoc "When set, these credentials will be required on HTTP/S requests."; type = types.str; default = ""; }; password = mkOption { - description = "When set, these credentials will be required on HTTP/S requests."; + description = lib.mdDoc "When set, these credentials will be required on HTTP/S requests."; type = types.str; default = ""; }; admin = mkOption { - description = "A comma-separated list of admin IP addresses."; + description = lib.mdDoc "A comma-separated list of admin IP addresses."; type = types.listOf types.str; default = ["127.0.0.1"]; }; ssl = { key = mkOption { - description = '' + description = lib.mdDoc '' Specifies the filename holding the SSL key in PEM format. ''; default = null; @@ -134,7 +134,7 @@ let }; cert = mkOption { - description = '' + description = lib.mdDoc '' Specifies the path to the SSL certificate file in PEM format. This is not needed if the chain includes it. ''; @@ -143,7 +143,7 @@ let }; chain = mkOption { - description = '' + description = lib.mdDoc '' If you need a certificate chain, specify the path to the certificate chain here. The chain may include the end certificate. ''; @@ -157,33 +157,33 @@ let dbOptions = { options = { type = mkOption { - description = "Rippled database type."; + description = lib.mdDoc "Rippled database type."; type = types.enum ["rocksdb" "nudb"]; default = "rocksdb"; }; path = mkOption { - description = "Location to store the database."; + description = lib.mdDoc "Location to store the database."; type = types.path; default = cfg.databasePath; defaultText = literalExpression "config.${opt.databasePath}"; }; compression = mkOption { - description = "Whether to enable snappy compression."; + description = lib.mdDoc "Whether to enable snappy compression."; type = types.nullOr types.bool; default = null; }; onlineDelete = mkOption { - description = "Enable automatic purging of older ledger information."; + description = lib.mdDoc "Enable automatic purging of older ledger information."; type = types.nullOr (types.addCheck types.int (v: v > 256)); default = cfg.ledgerHistory; defaultText = literalExpression "config.${opt.ledgerHistory}"; }; advisoryDelete = mkOption { - description = '' + description = lib.mdDoc '' If set, then require administrative RPC call "can_delete" to enable online deletion of ledger records. ''; @@ -192,7 +192,7 @@ let }; extraOpts = mkOption { - description = "Extra database options."; + description = lib.mdDoc "Extra database options."; type = types.lines; default = ""; }; @@ -210,14 +210,14 @@ in enable = mkEnableOption "rippled"; package = mkOption { - description = "Which rippled package to use."; + description = lib.mdDoc "Which rippled package to use."; type = types.package; default = pkgs.rippled; defaultText = literalExpression "pkgs.rippled"; }; ports = mkOption { - description = "Ports exposed by rippled"; + description = lib.mdDoc "Ports exposed by rippled"; type = with types; attrsOf (submodule portOptions); default = { rpc = { @@ -241,7 +241,7 @@ in }; nodeDb = mkOption { - description = "Rippled main database options."; + description = lib.mdDoc "Rippled main database options."; type = with types; nullOr (submodule dbOptions); default = { type = "rocksdb"; @@ -256,19 +256,19 @@ in }; tempDb = mkOption { - description = "Rippled temporary database options."; + description = lib.mdDoc "Rippled temporary database options."; type = with types; nullOr (submodule dbOptions); default = null; }; importDb = mkOption { - description = "Settings for performing a one-time import."; + description = lib.mdDoc "Settings for performing a one-time import."; type = with types; nullOr (submodule dbOptions); default = null; }; nodeSize = mkOption { - description = '' + description = lib.mdDoc '' Rippled size of the node you are running. "tiny", "small", "medium", "large", and "huge" ''; @@ -277,7 +277,7 @@ in }; ips = mkOption { - description = '' + description = lib.mdDoc '' List of hostnames or ips where the Ripple protocol is served. For a starter list, you can either copy entries from: https://ripple.com/ripple.txt or if you prefer you can let it @@ -292,7 +292,7 @@ in }; ipsFixed = mkOption { - description = '' + description = lib.mdDoc '' List of IP addresses or hostnames to which rippled should always attempt to maintain peer connections with. This is useful for manually forming private networks, for example to configure a @@ -306,7 +306,7 @@ in }; validators = mkOption { - description = '' + description = lib.mdDoc '' List of nodes to always accept as validators. Nodes are specified by domain or public key. ''; @@ -321,7 +321,7 @@ in }; databasePath = mkOption { - description = '' + description = lib.mdDoc '' Path to the ripple database. ''; type = types.path; @@ -329,7 +329,7 @@ in }; validationQuorum = mkOption { - description = '' + description = lib.mdDoc '' The minimum number of trusted validations a ledger must have before the server considers it fully validated. ''; @@ -338,7 +338,7 @@ in }; ledgerHistory = mkOption { - description = '' + description = lib.mdDoc '' The number of past ledgers to acquire on server startup and the minimum to maintain while running. ''; @@ -347,7 +347,7 @@ in }; fetchDepth = mkOption { - description = '' + description = lib.mdDoc '' The number of past ledgers to serve to other peers that request historical ledger data (or "full" for no limit). ''; @@ -356,7 +356,7 @@ in }; sntpServers = mkOption { - description = '' + description = lib.mdDoc '' IP address or domain of NTP servers to use for time synchronization.; ''; type = types.listOf types.str; @@ -369,7 +369,7 @@ in }; logLevel = mkOption { - description = "Logging verbosity."; + description = lib.mdDoc "Logging verbosity."; type = types.enum ["debug" "error" "info"]; default = "error"; }; @@ -378,13 +378,13 @@ in enable = mkEnableOption "statsd monitoring for rippled"; address = mkOption { - description = "The UDP address and port of the listening StatsD server."; + description = lib.mdDoc "The UDP address and port of the listening StatsD server."; default = "127.0.0.1:8125"; type = types.str; }; prefix = mkOption { - description = "A string prepended to each collected metric."; + description = lib.mdDoc "A string prepended to each collected metric."; default = ""; type = types.str; }; @@ -393,7 +393,7 @@ in extraConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Extra lines to be added verbatim to the rippled.cfg configuration file. ''; }; diff --git a/nixos/modules/services/misc/rmfakecloud.nix b/nixos/modules/services/misc/rmfakecloud.nix index fe522653c216f..2feb663f7cb69 100644 --- a/nixos/modules/services/misc/rmfakecloud.nix +++ b/nixos/modules/services/misc/rmfakecloud.nix @@ -15,7 +15,7 @@ in { type = types.package; default = pkgs.rmfakecloud; defaultText = literalExpression "pkgs.rmfakecloud"; - description = '' + description = lib.mdDoc '' rmfakecloud package to use. The default does not include the web user interface. @@ -25,7 +25,7 @@ in { storageUrl = mkOption { type = types.str; example = "https://local.appspot.com"; - description = '' + description = lib.mdDoc '' URL used by the tablet to access the rmfakecloud service. ''; }; @@ -33,7 +33,7 @@ in { port = mkOption { type = types.port; default = 3000; - description = '' + description = lib.mdDoc '' Listening port number. ''; }; @@ -41,7 +41,7 @@ in { logLevel = mkOption { type = types.enum [ "info" "debug" "warn" "error" ]; default = "info"; - description = '' + description = lib.mdDoc '' Logging level. ''; }; @@ -63,7 +63,7 @@ in { type = with types; nullOr path; default = null; example = "/etc/secrets/rmfakecloud.env"; - description = '' + description = lib.mdDoc '' Path to an environment file loaded for the rmfakecloud service. This can be used to securely store tokens and secrets outside of the diff --git a/nixos/modules/services/misc/serviio.nix b/nixos/modules/services/misc/serviio.nix index 0ead6a8169189..57efebb2c03f0 100644 --- a/nixos/modules/services/misc/serviio.nix +++ b/nixos/modules/services/misc/serviio.nix @@ -31,7 +31,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the Serviio Media Server. ''; }; @@ -39,7 +39,7 @@ in { dataDir = mkOption { type = types.path; default = "/var/lib/serviio"; - description = '' + description = lib.mdDoc '' The directory where serviio stores its state, data, etc. ''; }; diff --git a/nixos/modules/services/misc/sickbeard.nix b/nixos/modules/services/misc/sickbeard.nix index a3db992863426..bd8d8d8fa7cc4 100644 --- a/nixos/modules/services/misc/sickbeard.nix +++ b/nixos/modules/services/misc/sickbeard.nix @@ -20,43 +20,43 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the sickbeard server."; + description = lib.mdDoc "Whether to enable the sickbeard server."; }; package = mkOption { type = types.package; default = pkgs.sickbeard; defaultText = literalExpression "pkgs.sickbeard"; example = literalExpression "pkgs.sickrage"; - description ='' - Enable <literal>pkgs.sickrage</literal> or <literal>pkgs.sickgear</literal> + description =lib.mdDoc '' + Enable `pkgs.sickrage` or `pkgs.sickgear` as an alternative to SickBeard ''; }; dataDir = mkOption { type = types.path; default = "/var/lib/${name}"; - description = "Path where to store data files."; + description = lib.mdDoc "Path where to store data files."; }; configFile = mkOption { type = types.path; default = "${cfg.dataDir}/config.ini"; defaultText = literalExpression ''"''${config.${opt.dataDir}}/config.ini"''; - description = "Path to config file."; + description = lib.mdDoc "Path to config file."; }; port = mkOption { type = types.ints.u16; default = 8081; - description = "Port to bind to."; + description = lib.mdDoc "Port to bind to."; }; user = mkOption { type = types.str; default = name; - description = "User to run the service as"; + description = lib.mdDoc "User to run the service as"; }; group = mkOption { type = types.str; default = name; - description = "Group to run the service as"; + description = lib.mdDoc "Group to run the service as"; }; }; }; diff --git a/nixos/modules/services/misc/signald.nix b/nixos/modules/services/misc/signald.nix index 4cd34e4326d77..8a1d2c4ad3880 100644 --- a/nixos/modules/services/misc/signald.nix +++ b/nixos/modules/services/misc/signald.nix @@ -13,19 +13,19 @@ in user = mkOption { type = types.str; default = defaultUser; - description = "User under which signald runs."; + description = lib.mdDoc "User under which signald runs."; }; group = mkOption { type = types.str; default = defaultUser; - description = "Group under which signald runs."; + description = lib.mdDoc "Group under which signald runs."; }; socketPath = mkOption { type = types.str; default = "/run/signald/signald.sock"; - description = "Path to the signald socket"; + description = lib.mdDoc "Path to the signald socket"; }; }; diff --git a/nixos/modules/services/misc/siproxd.nix b/nixos/modules/services/misc/siproxd.nix index 20fe0793b84b6..f1a1ed4d29b38 100644 --- a/nixos/modules/services/misc/siproxd.nix +++ b/nixos/modules/services/misc/siproxd.nix @@ -37,7 +37,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the Siproxd SIP proxy/masquerading daemon. ''; @@ -46,20 +46,20 @@ in ifInbound = mkOption { type = types.str; example = "eth0"; - description = "Local network interface"; + description = lib.mdDoc "Local network interface"; }; ifOutbound = mkOption { type = types.str; example = "ppp0"; - description = "Public network interface"; + description = lib.mdDoc "Public network interface"; }; hostsAllowReg = mkOption { type = types.listOf types.str; default = [ ]; example = [ "192.168.1.0/24" "192.168.2.0/24" ]; - description = '' + description = lib.mdDoc '' Acess control list for incoming SIP registrations. ''; }; @@ -68,7 +68,7 @@ in type = types.listOf types.str; default = [ ]; example = [ "123.45.0.0/16" "123.46.0.0/16" ]; - description = '' + description = lib.mdDoc '' Acess control list for incoming SIP traffic. ''; }; @@ -77,7 +77,7 @@ in type = types.listOf types.str; default = [ ]; example = [ "10.0.0.0/8" "11.0.0.0/8" ]; - description = '' + description = lib.mdDoc '' Acess control list for denying incoming SIP registrations and traffic. ''; @@ -86,7 +86,7 @@ in sipListenPort = mkOption { type = types.int; default = 5060; - description = '' + description = lib.mdDoc '' Port to listen for incoming SIP messages. ''; }; @@ -94,7 +94,7 @@ in rtpPortLow = mkOption { type = types.int; default = 7070; - description = '' + description = lib.mdDoc '' Bottom of UDP port range for incoming and outgoing RTP traffic ''; }; @@ -102,7 +102,7 @@ in rtpPortHigh = mkOption { type = types.int; default = 7089; - description = '' + description = lib.mdDoc '' Top of UDP port range for incoming and outgoing RTP traffic ''; }; @@ -110,7 +110,7 @@ in rtpTimeout = mkOption { type = types.int; default = 300; - description = '' + description = lib.mdDoc '' Timeout for an RTP stream. If for the specified number of seconds no data is relayed on an active stream, it is considered dead and will be killed. @@ -120,7 +120,7 @@ in rtpDscp = mkOption { type = types.int; default = 46; - description = '' + description = lib.mdDoc '' DSCP (differentiated services) value to be assigned to RTP packets. Allows QOS aware routers to handle different types traffic with different priorities. @@ -130,7 +130,7 @@ in sipDscp = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' DSCP (differentiated services) value to be assigned to SIP packets. Allows QOS aware routers to handle different types traffic with different priorities. @@ -140,7 +140,7 @@ in passwordFile = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Path to per-user password file. ''; }; @@ -148,7 +148,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration to add to siproxd configuration. ''; }; diff --git a/nixos/modules/services/misc/snapper.nix b/nixos/modules/services/misc/snapper.nix index 3c3f6c4d641b2..7d7e3db3ce08a 100644 --- a/nixos/modules/services/misc/snapper.nix +++ b/nixos/modules/services/misc/snapper.nix @@ -12,7 +12,7 @@ in snapshotRootOnBoot = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to snapshot root on boot ''; }; @@ -44,7 +44,7 @@ in filters = mkOption { type = types.nullOr types.lines; default = null; - description = '' + description = lib.mdDoc '' Global display difference filter. See man:snapper(8) for more details. ''; }; @@ -64,7 +64,7 @@ in } ''; - description = '' + description = lib.mdDoc '' Subvolume configuration ''; @@ -72,7 +72,7 @@ in options = { subvolume = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' Path of the subvolume or mount point. This path is a subvolume and has to contain a subvolume named .snapshots. @@ -83,7 +83,7 @@ in fstype = mkOption { type = types.enum [ "btrfs" ]; default = "btrfs"; - description = '' + description = lib.mdDoc '' Filesystem type. Only btrfs is stable and tested. ''; }; @@ -91,7 +91,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Additional configuration next to SUBVOLUME and FSTYPE. See man:snapper-configs(5). ''; diff --git a/nixos/modules/services/misc/sonarr.nix b/nixos/modules/services/misc/sonarr.nix index 77c7f0582d0b6..a956a14d00728 100644 --- a/nixos/modules/services/misc/sonarr.nix +++ b/nixos/modules/services/misc/sonarr.nix @@ -13,13 +13,13 @@ in dataDir = mkOption { type = types.str; default = "/var/lib/sonarr/.config/NzbDrone"; - description = "The directory where Sonarr stores its data files."; + description = lib.mdDoc "The directory where Sonarr stores its data files."; }; openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for the Sonarr web interface ''; }; @@ -27,13 +27,13 @@ in user = mkOption { type = types.str; default = "sonarr"; - description = "User account under which Sonaar runs."; + description = lib.mdDoc "User account under which Sonaar runs."; }; group = mkOption { type = types.str; default = "sonarr"; - description = "Group under which Sonaar runs."; + description = lib.mdDoc "Group under which Sonaar runs."; }; }; }; diff --git a/nixos/modules/services/misc/ssm-agent.nix b/nixos/modules/services/misc/ssm-agent.nix index 4ae596ade1745..5f2b47bae4745 100644 --- a/nixos/modules/services/misc/ssm-agent.nix +++ b/nixos/modules/services/misc/ssm-agent.nix @@ -21,7 +21,7 @@ in { package = mkOption { type = types.path; - description = "The SSM agent package to use"; + description = lib.mdDoc "The SSM agent package to use"; default = pkgs.ssm-agent.override { overrideEtc = false; }; defaultText = literalExpression "pkgs.ssm-agent.override { overrideEtc = false; }"; }; diff --git a/nixos/modules/services/misc/sssd.nix b/nixos/modules/services/misc/sssd.nix index 873c3b7351934..3f6b96258f16c 100644 --- a/nixos/modules/services/misc/sssd.nix +++ b/nixos/modules/services/misc/sssd.nix @@ -10,7 +10,7 @@ in { config = mkOption { type = types.lines; - description = "Contents of <filename>sssd.conf</filename>."; + description = lib.mdDoc "Contents of {file}`sssd.conf`."; default = '' [sssd] config_file_version = 2 @@ -33,9 +33,9 @@ in { sshAuthorizedKeysIntegration = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to make sshd look up authorized keys from SSS. - For this to work, the <literal>ssh</literal> SSS service must be enabled in the sssd configuration. + For this to work, the `ssh` SSS service must be enabled in the sssd configuration. ''; }; diff --git a/nixos/modules/services/misc/subsonic.nix b/nixos/modules/services/misc/subsonic.nix index 2dda8970dd306..d657ae2b998a1 100644 --- a/nixos/modules/services/misc/subsonic.nix +++ b/nixos/modules/services/misc/subsonic.nix @@ -13,7 +13,7 @@ in { home = mkOption { type = types.path; default = "/var/lib/subsonic"; - description = '' + description = lib.mdDoc '' The directory where Subsonic will create files. Make sure it is writable. ''; @@ -22,7 +22,7 @@ in { listenAddress = mkOption { type = types.str; default = "0.0.0.0"; - description = '' + description = lib.mdDoc '' The host name or IP address on which to bind Subsonic. Only relevant if you have multiple network interfaces and want to make Subsonic available on only one of them. The default value @@ -33,7 +33,7 @@ in { port = mkOption { type = types.port; default = 4040; - description = '' + description = lib.mdDoc '' The port on which Subsonic will listen for incoming HTTP traffic. Set to 0 to disable. ''; @@ -42,7 +42,7 @@ in { httpsPort = mkOption { type = types.port; default = 0; - description = '' + description = lib.mdDoc '' The port on which Subsonic will listen for incoming HTTPS traffic. Set to 0 to disable. ''; @@ -51,7 +51,7 @@ in { contextPath = mkOption { type = types.path; default = "/"; - description = '' + description = lib.mdDoc '' The context path, i.e., the last part of the Subsonic URL. Typically '/' or '/subsonic'. Default '/' ''; @@ -60,7 +60,7 @@ in { maxMemory = mkOption { type = types.int; default = 100; - description = '' + description = lib.mdDoc '' The memory limit (max Java heap size) in megabytes. Default: 100 ''; @@ -69,7 +69,7 @@ in { defaultMusicFolder = mkOption { type = types.path; default = "/var/music"; - description = '' + description = lib.mdDoc '' Configure Subsonic to use this folder for music. This option only has effect the first time Subsonic is started. ''; @@ -78,7 +78,7 @@ in { defaultPodcastFolder = mkOption { type = types.path; default = "/var/music/Podcast"; - description = '' + description = lib.mdDoc '' Configure Subsonic to use this folder for Podcasts. This option only has effect the first time Subsonic is started. ''; @@ -87,7 +87,7 @@ in { defaultPlaylistFolder = mkOption { type = types.path; default = "/var/playlists"; - description = '' + description = lib.mdDoc '' Configure Subsonic to use this folder for playlists. This option only has effect the first time Subsonic is started. ''; @@ -97,7 +97,7 @@ in { type = types.listOf types.path; default = [ "${pkgs.ffmpeg.bin}/bin/ffmpeg" ]; defaultText = literalExpression ''[ "''${pkgs.ffmpeg.bin}/bin/ffmpeg" ]''; - description = '' + description = lib.mdDoc '' List of paths to transcoder executables that should be accessible from Subsonic. Symlinks will be created to each executable inside ''${config.${opt.home}}/transcoders. diff --git a/nixos/modules/services/misc/svnserve.nix b/nixos/modules/services/misc/svnserve.nix index 5fa262ca3b945..a0103641c650a 100644 --- a/nixos/modules/services/misc/svnserve.nix +++ b/nixos/modules/services/misc/svnserve.nix @@ -20,13 +20,13 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable svnserve to serve Subversion repositories through the SVN protocol."; + description = lib.mdDoc "Whether to enable svnserve to serve Subversion repositories through the SVN protocol."; }; svnBaseDir = mkOption { type = types.str; default = "/repos"; - description = "Base directory from which Subversion repositories are accessed."; + description = lib.mdDoc "Base directory from which Subversion repositories are accessed."; }; }; diff --git a/nixos/modules/services/misc/synergy.nix b/nixos/modules/services/misc/synergy.nix index d6cd5d7f0d66e..c02d80b35c69a 100644 --- a/nixos/modules/services/misc/synergy.nix +++ b/nixos/modules/services/misc/synergy.nix @@ -24,14 +24,14 @@ in screenName = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' Use the given name instead of the hostname to identify ourselves to the server. ''; }; serverAddress = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The server address is of the form: [hostname][:port]. The hostname must be the address or hostname of the server. The port overrides the default port, 24800. @@ -40,7 +40,7 @@ in autoStart = mkOption { default = true; type = types.bool; - description = "Whether the Synergy client should be started automatically."; + description = lib.mdDoc "Whether the Synergy client should be started automatically."; }; }; @@ -50,12 +50,12 @@ in configFile = mkOption { type = types.path; default = "/etc/synergy-server.conf"; - description = "The Synergy server configuration file."; + description = lib.mdDoc "The Synergy server configuration file."; }; screenName = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Use the given name instead of the hostname to identify this screen in the configuration. ''; @@ -63,18 +63,18 @@ in address = mkOption { type = types.str; default = ""; - description = "Address on which to listen for clients."; + description = lib.mdDoc "Address on which to listen for clients."; }; autoStart = mkOption { default = true; type = types.bool; - description = "Whether the Synergy server should be started automatically."; + description = lib.mdDoc "Whether the Synergy server should be started automatically."; }; tls = { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether TLS encryption should be used. Using this requires a TLS certificate that can be @@ -87,7 +87,7 @@ in type = types.nullOr types.str; default = null; example = "~/.synergy/SSL/Synergy.pem"; - description = "The TLS certificate to use for encryption."; + description = lib.mdDoc "The TLS certificate to use for encryption."; }; }; }; diff --git a/nixos/modules/services/misc/taskserver/default.nix b/nixos/modules/services/misc/taskserver/default.nix index e20804929981f..d9572f006ee28 100644 --- a/nixos/modules/services/misc/taskserver/default.nix +++ b/nixos/modules/services/misc/taskserver/default.nix @@ -89,7 +89,7 @@ let type = types.uniq (types.listOf types.str); default = []; example = [ "alice" "bob" ]; - description = '' + description = lib.mdDoc '' A list of user names that belong to the organization. ''; }; @@ -98,7 +98,7 @@ let type = types.listOf types.str; default = []; example = [ "workers" "slackers" ]; - description = '' + description = lib.mdDoc '' A list of group names that belong to the organization. ''; }; @@ -151,19 +151,19 @@ in { user = mkOption { type = types.str; default = "taskd"; - description = "User for Taskserver."; + description = lib.mdDoc "User for Taskserver."; }; group = mkOption { type = types.str; default = "taskd"; - description = "Group for Taskserver."; + description = lib.mdDoc "Group for Taskserver."; }; dataDir = mkOption { type = types.path; default = "/var/lib/taskserver"; - description = "Data directory for Taskserver."; + description = lib.mdDoc "Data directory for Taskserver."; }; ciphers = mkOption { @@ -184,17 +184,17 @@ in { example.myShinyOrganisation.users = [ "alice" "bob" ]; example.myShinyOrganisation.groups = [ "staff" "outsiders" ]; example.yetAnotherOrganisation.users = [ "foo" "bar" ]; - description = '' + description = lib.mdDoc '' An attribute set where the keys name the organisation and the values - are a set of lists of <option>users</option> and - <option>groups</option>. + are a set of lists of {option}`users` and + {option}`groups`. ''; }; confirmation = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Determines whether certain commands are confirmed. ''; }; @@ -202,7 +202,7 @@ in { debug = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Logs debugging information. ''; }; @@ -210,7 +210,7 @@ in { extensions = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Fully qualified path of the Taskserver extension scripts. Currently there are none. ''; @@ -219,7 +219,7 @@ in { ipLog = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Logs the IP addresses of incoming requests. ''; }; @@ -238,7 +238,7 @@ in { requestLimit = mkOption { type = types.int; default = 1048576; - description = '' + description = lib.mdDoc '' Size limit of incoming requests, in bytes. ''; }; @@ -247,13 +247,13 @@ in { type = with types; either str (listOf str); default = []; example = [ "[Tt]ask [2-9]+" ]; - description = '' + description = lib.mdDoc '' A list of regular expressions that are matched against the reported - client id (such as <literal>task 2.3.0</literal>). + client id (such as `task 2.3.0`). - The values <literal>all</literal> or <literal>none</literal> have + The values `all` or `none` have special meaning. Overidden by any entry in the option - <option>services.taskserver.disallowedClientIDs</option>. + {option}`services.taskserver.disallowedClientIDs`. ''; }; @@ -261,13 +261,13 @@ in { type = with types; either str (listOf str); default = []; example = [ "[Tt]ask [2-9]+" ]; - description = '' + description = lib.mdDoc '' A list of regular expressions that are matched against the reported - client id (such as <literal>task 2.3.0</literal>). + client id (such as `task 2.3.0`). - The values <literal>all</literal> or <literal>none</literal> have + The values `all` or `none` have special meaning. Any entry here overrides those in - <option>services.taskserver.allowedClientIDs</option>. + {option}`services.taskserver.allowedClientIDs`. ''; }; @@ -275,7 +275,7 @@ in { type = types.str; default = "localhost"; example = "::"; - description = '' + description = lib.mdDoc '' The address (IPv4, IPv6 or DNS) to listen on. ''; }; @@ -283,7 +283,7 @@ in { listenPort = mkOption { type = types.int; default = 53589; - description = '' + description = lib.mdDoc '' Port number of the Taskserver. ''; }; @@ -291,7 +291,7 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to open the firewall for the specified Taskserver port. ''; }; @@ -299,7 +299,7 @@ in { fqdn = mkOption { type = types.str; default = "localhost"; - description = '' + description = lib.mdDoc '' The fully qualified domain name of this server, which is also used as the common name in the certificates. ''; @@ -308,12 +308,12 @@ in { trust = mkOption { type = types.enum [ "allow all" "strict" ]; default = "strict"; - description = '' + description = lib.mdDoc '' Determines how client certificates are validated. - The value <literal>allow all</literal> performs no client + The value `allow all` performs no client certificate validation. This is not recommended. The value - <literal>strict</literal> causes the client certificate to be + `strict` causes the client certificate to be validated against a CA. ''; }; diff --git a/nixos/modules/services/misc/tautulli.nix b/nixos/modules/services/misc/tautulli.nix index 9a972b291225c..3f6633c9a5701 100644 --- a/nixos/modules/services/misc/tautulli.nix +++ b/nixos/modules/services/misc/tautulli.nix @@ -17,38 +17,38 @@ in dataDir = mkOption { type = types.str; default = "/var/lib/plexpy"; - description = "The directory where Tautulli stores its data files."; + description = lib.mdDoc "The directory where Tautulli stores its data files."; }; configFile = mkOption { type = types.str; default = "/var/lib/plexpy/config.ini"; - description = "The location of Tautulli's config file."; + description = lib.mdDoc "The location of Tautulli's config file."; }; port = mkOption { type = types.int; default = 8181; - description = "TCP port where Tautulli listens."; + description = lib.mdDoc "TCP port where Tautulli listens."; }; user = mkOption { type = types.str; default = "plexpy"; - description = "User account under which Tautulli runs."; + description = lib.mdDoc "User account under which Tautulli runs."; }; group = mkOption { type = types.str; default = "nogroup"; - description = "Group under which Tautulli runs."; + description = lib.mdDoc "Group under which Tautulli runs."; }; package = mkOption { type = types.package; default = pkgs.tautulli; defaultText = literalExpression "pkgs.tautulli"; - description = '' + description = lib.mdDoc '' The Tautulli package to use. ''; }; diff --git a/nixos/modules/services/misc/tiddlywiki.nix b/nixos/modules/services/misc/tiddlywiki.nix index 2adc08f6cfedc..7052be23d76f4 100644 --- a/nixos/modules/services/misc/tiddlywiki.nix +++ b/nixos/modules/services/misc/tiddlywiki.nix @@ -24,9 +24,9 @@ in { readers="(authenticated)"; port = 3456; }; - description = '' - Parameters passed to <literal>--listen</literal> command. - Refer to <link xlink:href="https://tiddlywiki.com/#WebServer"/> + description = lib.mdDoc '' + Parameters passed to `--listen` command. + Refer to <https://tiddlywiki.com/#WebServer> for details on supported values. ''; }; diff --git a/nixos/modules/services/misc/tp-auto-kbbl.nix b/nixos/modules/services/misc/tp-auto-kbbl.nix index 59018f7f81ffa..54dec0b3fea37 100644 --- a/nixos/modules/services/misc/tp-auto-kbbl.nix +++ b/nixos/modules/services/misc/tp-auto-kbbl.nix @@ -15,21 +15,21 @@ in { type = types.package; default = pkgs.tp-auto-kbbl; defaultText = literalExpression "pkgs.tp-auto-kbbl"; - description = "Package providing <command>tp-auto-kbbl</command>."; + description = lib.mdDoc "Package providing {command}`tp-auto-kbbl`."; }; arguments = mkOption { type = types.listOf types.str; default = [ ]; - description = '' - List of arguments appended to <literal>./tp-auto-kbbl --device [device] [arguments]</literal> + description = lib.mdDoc '' + List of arguments appended to `./tp-auto-kbbl --device [device] [arguments]` ''; }; device = mkOption { type = types.str; default = "/dev/input/event0"; - description = "Device watched for activities."; + description = lib.mdDoc "Device watched for activities."; }; }; diff --git a/nixos/modules/services/misc/tzupdate.nix b/nixos/modules/services/misc/tzupdate.nix index eac1e1112a5ab..300a578f7c4a6 100644 --- a/nixos/modules/services/misc/tzupdate.nix +++ b/nixos/modules/services/misc/tzupdate.nix @@ -9,7 +9,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the tzupdate timezone updating service. This provides a one-shot service which can be activated with systemctl to update the timezone. diff --git a/nixos/modules/services/misc/uhub.nix b/nixos/modules/services/misc/uhub.nix index 99774fbb920a0..c3eda0db44d5d 100644 --- a/nixos/modules/services/misc/uhub.nix +++ b/nixos/modules/services/misc/uhub.nix @@ -15,7 +15,7 @@ in { services.uhub = mkOption { default = { }; - description = "Uhub ADC hub instances"; + description = lib.mdDoc "Uhub ADC hub instances"; type = types.attrsOf (types.submodule { options = { @@ -24,12 +24,12 @@ in { enableTLS = mkOption { type = types.bool; default = false; - description = "Whether to enable TLS support."; + description = lib.mdDoc "Whether to enable TLS support."; }; settings = mkOption { inherit (settingsFormat) type; - description = '' + description = lib.mdDoc '' Configuration of uhub. See https://www.uhub.org/doc/config.php for a list of options. ''; @@ -44,7 +44,7 @@ in { }; plugins = mkOption { - description = "Uhub plugin configuration."; + description = lib.mdDoc "Uhub plugin configuration."; type = with types; listOf (submodule { options = { @@ -52,10 +52,10 @@ in { type = path; example = literalExpression "$${pkgs.uhub}/plugins/mod_auth_sqlite.so"; - description = "Path to plugin file."; + description = lib.mdDoc "Path to plugin file."; }; settings = mkOption { - description = "Settings specific to this plugin."; + description = lib.mdDoc "Settings specific to this plugin."; type = with types; attrsOf str; example = { file = "/etc/uhub/users.db"; }; }; diff --git a/nixos/modules/services/misc/weechat.nix b/nixos/modules/services/misc/weechat.nix index 7a4c4dca2ac99..b1de30ae2b827 100644 --- a/nixos/modules/services/misc/weechat.nix +++ b/nixos/modules/services/misc/weechat.nix @@ -10,18 +10,18 @@ in options.services.weechat = { enable = mkEnableOption "weechat"; root = mkOption { - description = "Weechat state directory."; + description = lib.mdDoc "Weechat state directory."; type = types.str; default = "/var/lib/weechat"; }; sessionName = mkOption { - description = "Name of the `screen' session for weechat."; + description = lib.mdDoc "Name of the `screen' session for weechat."; default = "weechat-screen"; type = types.str; }; binary = mkOption { type = types.path; - description = "Binary to execute."; + description = lib.mdDoc "Binary to execute."; default = "${pkgs.weechat}/bin/weechat"; defaultText = literalExpression ''"''${pkgs.weechat}/bin/weechat"''; example = literalExpression ''"''${pkgs.weechat}/bin/weechat-headless"''; diff --git a/nixos/modules/services/misc/xmr-stak.nix b/nixos/modules/services/misc/xmr-stak.nix index 9256e9ae01cb9..c218f747f2816 100644 --- a/nixos/modules/services/misc/xmr-stak.nix +++ b/nixos/modules/services/misc/xmr-stak.nix @@ -23,7 +23,7 @@ in type = types.listOf types.str; default = []; example = [ "--noCPU" "--currency monero" ]; - description = "List of parameters to pass to xmr-stak."; + description = lib.mdDoc "List of parameters to pass to xmr-stak."; }; configFiles = mkOption { @@ -52,7 +52,7 @@ in '''; } ''; - description = '' + description = lib.mdDoc '' Content of config files like config.txt, pools.txt or cpu.txt. ''; }; diff --git a/nixos/modules/services/misc/xmrig.nix b/nixos/modules/services/misc/xmrig.nix index c5c3803920c8d..a98b2292f559d 100644 --- a/nixos/modules/services/misc/xmrig.nix +++ b/nixos/modules/services/misc/xmrig.nix @@ -20,7 +20,7 @@ with lib; default = pkgs.xmrig; defaultText = literalExpression "pkgs.xmrig"; example = literalExpression "pkgs.xmrig-mo"; - description = "XMRig package to use."; + description = lib.mdDoc "XMRig package to use."; }; settings = mkOption { @@ -42,9 +42,9 @@ with lib; ] } ''; - description = '' + description = lib.mdDoc '' XMRig configuration. Refer to - <link xlink:href="https://xmrig.com/docs/miner/config"/> + <https://xmrig.com/docs/miner/config> for details on supported values. ''; }; diff --git a/nixos/modules/services/misc/zoneminder.nix b/nixos/modules/services/misc/zoneminder.nix index a557e742b7cfa..ab24372037e62 100644 --- a/nixos/modules/services/misc/zoneminder.nix +++ b/nixos/modules/services/misc/zoneminder.nix @@ -93,7 +93,7 @@ in { hostname = mkOption { type = types.str; default = "localhost"; - description = '' + description = lib.mdDoc '' The hostname on which to listen. ''; }; @@ -101,7 +101,7 @@ in { port = mkOption { type = types.int; default = 8095; - description = '' + description = lib.mdDoc '' The port on which to listen. ''; }; @@ -109,7 +109,7 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open the firewall port(s). ''; }; @@ -118,7 +118,7 @@ in { createLocally = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Create the database and database user locally. ''; }; @@ -126,7 +126,7 @@ in { host = mkOption { type = types.str; default = "localhost"; - description = '' + description = lib.mdDoc '' Hostname hosting the database. ''; }; @@ -134,7 +134,7 @@ in { name = mkOption { type = types.str; default = "zm"; - description = '' + description = lib.mdDoc '' Name of database. ''; }; @@ -142,7 +142,7 @@ in { username = mkOption { type = types.str; default = "zmuser"; - description = '' + description = lib.mdDoc '' Username for accessing the database. ''; }; @@ -150,9 +150,9 @@ in { password = mkOption { type = types.str; default = "zmpass"; - description = '' + description = lib.mdDoc '' Username for accessing the database. - Not used if <literal>createLocally</literal> is set. + Not used if `createLocally` is set. ''; }; }; @@ -160,7 +160,7 @@ in { cameras = mkOption { type = types.int; default = 1; - description = '' + description = lib.mdDoc '' Set this to the number of cameras you expect to support. ''; }; @@ -169,7 +169,7 @@ in { type = types.nullOr types.str; default = null; example = "/storage/tank"; - description = '' + description = lib.mdDoc '' ZoneMinder can generate quite a lot of data, so in case you don't want to use the default ${defaultDir}, you can override the path here. ''; @@ -178,7 +178,7 @@ in { extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Additional configuration added verbatim to the configuration file. ''; }; diff --git a/nixos/modules/services/misc/zookeeper.nix b/nixos/modules/services/misc/zookeeper.nix index fefbf9a86de49..17d4a00f28f1e 100644 --- a/nixos/modules/services/misc/zookeeper.nix +++ b/nixos/modules/services/misc/zookeeper.nix @@ -25,25 +25,25 @@ in { options.services.zookeeper = { enable = mkOption { - description = "Whether to enable Zookeeper."; + description = lib.mdDoc "Whether to enable Zookeeper."; default = false; type = types.bool; }; port = mkOption { - description = "Zookeeper Client port."; + description = lib.mdDoc "Zookeeper Client port."; default = 2181; type = types.int; }; id = mkOption { - description = "Zookeeper ID."; + description = lib.mdDoc "Zookeeper ID."; default = 0; type = types.int; }; purgeInterval = mkOption { - description = '' + description = lib.mdDoc '' The time interval in hours for which the purge task has to be triggered. Set to a positive integer (1 and above) to enable the auto purging. ''; default = 1; @@ -51,7 +51,7 @@ in { }; extraConf = mkOption { - description = "Extra configuration for Zookeeper."; + description = lib.mdDoc "Extra configuration for Zookeeper."; type = types.lines; default = '' initLimit=5 @@ -61,7 +61,7 @@ in { }; servers = mkOption { - description = "All Zookeeper Servers."; + description = lib.mdDoc "All Zookeeper Servers."; default = ""; type = types.lines; example = '' @@ -72,7 +72,7 @@ in { }; logging = mkOption { - description = "Zookeeper logging configuration."; + description = lib.mdDoc "Zookeeper logging configuration."; default = '' zookeeper.root.logger=INFO, CONSOLE log4j.rootLogger=INFO, CONSOLE @@ -87,13 +87,13 @@ in { dataDir = mkOption { type = types.path; default = "/var/lib/zookeeper"; - description = '' + description = lib.mdDoc '' Data directory for Zookeeper ''; }; extraCmdLineOptions = mkOption { - description = "Extra command line options for the Zookeeper launcher."; + description = lib.mdDoc "Extra command line options for the Zookeeper launcher."; default = [ "-Dcom.sun.management.jmxremote" "-Dcom.sun.management.jmxremote.local.only=true" ]; type = types.listOf types.str; example = [ "-Djava.net.preferIPv4Stack=true" "-Dcom.sun.management.jmxremote" "-Dcom.sun.management.jmxremote.local.only=true" ]; @@ -102,20 +102,20 @@ in { preferIPv4 = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Add the -Djava.net.preferIPv4Stack=true flag to the Zookeeper server. ''; }; package = mkOption { - description = "The zookeeper package to use"; + description = lib.mdDoc "The zookeeper package to use"; default = pkgs.zookeeper; defaultText = literalExpression "pkgs.zookeeper"; type = types.package; }; jre = mkOption { - description = "The JRE with which to run Zookeeper"; + description = lib.mdDoc "The JRE with which to run Zookeeper"; default = cfg.package.jre; defaultText = literalExpression "pkgs.zookeeper.jre"; example = literalExpression "pkgs.jre"; diff --git a/nixos/modules/services/monitoring/alerta.nix b/nixos/modules/services/monitoring/alerta.nix index a73d94001f710..c0caa0dc3beb1 100644 --- a/nixos/modules/services/monitoring/alerta.nix +++ b/nixos/modules/services/monitoring/alerta.nix @@ -26,53 +26,53 @@ in port = mkOption { type = types.int; default = 5000; - description = "Port of Alerta"; + description = lib.mdDoc "Port of Alerta"; }; bind = mkOption { type = types.str; default = "0.0.0.0"; - description = "Address to bind to. The default is to bind to all addresses"; + description = lib.mdDoc "Address to bind to. The default is to bind to all addresses"; }; logDir = mkOption { type = types.path; - description = "Location where the logfiles are stored"; + description = lib.mdDoc "Location where the logfiles are stored"; default = "/var/log/alerta"; }; databaseUrl = mkOption { type = types.str; - description = "URL of the MongoDB or PostgreSQL database to connect to"; + description = lib.mdDoc "URL of the MongoDB or PostgreSQL database to connect to"; default = "mongodb://localhost"; }; databaseName = mkOption { type = types.str; - description = "Name of the database instance to connect to"; + description = lib.mdDoc "Name of the database instance to connect to"; default = "monitoring"; }; corsOrigins = mkOption { type = types.listOf types.str; - description = "List of URLs that can access the API for Cross-Origin Resource Sharing (CORS)"; + description = lib.mdDoc "List of URLs that can access the API for Cross-Origin Resource Sharing (CORS)"; default = [ "http://localhost" "http://localhost:5000" ]; }; authenticationRequired = mkOption { type = types.bool; - description = "Whether users must authenticate when using the web UI or command-line tool"; + description = lib.mdDoc "Whether users must authenticate when using the web UI or command-line tool"; default = false; }; signupEnabled = mkOption { type = types.bool; - description = "Whether to prevent sign-up of new users via the web UI"; + description = lib.mdDoc "Whether to prevent sign-up of new users via the web UI"; default = true; }; extraConfig = mkOption { - description = "These lines go into alertad.conf verbatim."; + description = lib.mdDoc "These lines go into alertad.conf verbatim."; default = ""; type = types.lines; }; diff --git a/nixos/modules/services/monitoring/apcupsd.nix b/nixos/modules/services/monitoring/apcupsd.nix index 1dccbc93edf84..d4216b44cdc8c 100644 --- a/nixos/modules/services/monitoring/apcupsd.nix +++ b/nixos/modules/services/monitoring/apcupsd.nix @@ -75,7 +75,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable the APC UPS daemon. apcupsd monitors your UPS and permits orderly shutdown of your computer in the event of a power failure. User manual: http://www.apcupsd.com/manual/manual.html. @@ -92,7 +92,7 @@ in MINUTES 5 ''; type = types.lines; - description = '' + description = lib.mdDoc '' Contents of the runtime configuration file, apcupsd.conf. The default settings makes apcupsd autodetect USB UPSes, limit network access to localhost and shutdown the system when the battery level is below 50 @@ -107,7 +107,7 @@ in doshutdown = "# shell commands to notify that the computer is shutting down"; }; type = types.attrsOf types.lines; - description = '' + description = lib.mdDoc '' Each attribute in this option names an apcupsd event and the string value it contains will be executed in a shell, in response to that event (prior to the default action). See "man apccontrol" for the diff --git a/nixos/modules/services/monitoring/arbtt.nix b/nixos/modules/services/monitoring/arbtt.nix index 94eead220aed6..8bf4f78cc7279 100644 --- a/nixos/modules/services/monitoring/arbtt.nix +++ b/nixos/modules/services/monitoring/arbtt.nix @@ -10,7 +10,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the arbtt statistics capture service. ''; }; @@ -19,7 +19,7 @@ in { type = types.package; default = pkgs.haskellPackages.arbtt; defaultText = literalExpression "pkgs.haskellPackages.arbtt"; - description = '' + description = lib.mdDoc '' The package to use for the arbtt binaries. ''; }; @@ -28,7 +28,7 @@ in { type = types.str; default = "%h/.arbtt/capture.log"; example = "/home/username/.arbtt-capture.log"; - description = '' + description = lib.mdDoc '' The log file for captured samples. ''; }; @@ -37,7 +37,7 @@ in { type = types.int; default = 60; example = 120; - description = '' + description = lib.mdDoc '' The sampling interval in seconds. ''; }; diff --git a/nixos/modules/services/monitoring/bosun.nix b/nixos/modules/services/monitoring/bosun.nix index 4b278b9c200b9..27966e089eb9e 100644 --- a/nixos/modules/services/monitoring/bosun.nix +++ b/nixos/modules/services/monitoring/bosun.nix @@ -25,7 +25,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to run bosun. ''; }; @@ -34,7 +34,7 @@ in { type = types.package; default = pkgs.bosun; defaultText = literalExpression "pkgs.bosun"; - description = '' + description = lib.mdDoc '' bosun binary to use. ''; }; @@ -42,7 +42,7 @@ in { user = mkOption { type = types.str; default = "bosun"; - description = '' + description = lib.mdDoc '' User account under which bosun runs. ''; }; @@ -50,7 +50,7 @@ in { group = mkOption { type = types.str; default = "bosun"; - description = '' + description = lib.mdDoc '' Group account under which bosun runs. ''; }; @@ -58,7 +58,7 @@ in { opentsdbHost = mkOption { type = types.nullOr types.str; default = "localhost:4242"; - description = '' + description = lib.mdDoc '' Host and port of the OpenTSDB database that stores bosun data. To disable opentsdb you can pass null as parameter. ''; @@ -68,7 +68,7 @@ in { type = types.nullOr types.str; default = null; example = "localhost:8086"; - description = '' + description = lib.mdDoc '' Host and port of the influxdb database. ''; }; @@ -76,7 +76,7 @@ in { listenAddress = mkOption { type = types.str; default = ":8070"; - description = '' + description = lib.mdDoc '' The host address and port that bosun's web interface will listen on. ''; }; @@ -84,7 +84,7 @@ in { stateFile = mkOption { type = types.path; default = "/var/lib/bosun/bosun.state"; - description = '' + description = lib.mdDoc '' Path to bosun's state file. ''; }; @@ -92,7 +92,7 @@ in { ledisDir = mkOption { type = types.path; default = "/var/lib/bosun/ledis_data"; - description = '' + description = lib.mdDoc '' Path to bosun's ledis data dir ''; }; @@ -100,7 +100,7 @@ in { checkFrequency = mkOption { type = types.str; default = "5m"; - description = '' + description = lib.mdDoc '' Bosun's check frequency ''; }; @@ -108,7 +108,7 @@ in { extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration options for Bosun. You should describe your desired templates, alerts, macros, etc through this configuration option. diff --git a/nixos/modules/services/monitoring/cadvisor.nix b/nixos/modules/services/monitoring/cadvisor.nix index dfbf07efcaea9..c844b1599dd46 100644 --- a/nixos/modules/services/monitoring/cadvisor.nix +++ b/nixos/modules/services/monitoring/cadvisor.nix @@ -11,56 +11,56 @@ in { enable = mkOption { default = false; type = types.bool; - description = "Whether to enable cadvisor service."; + description = lib.mdDoc "Whether to enable cadvisor service."; }; listenAddress = mkOption { default = "127.0.0.1"; type = types.str; - description = "Cadvisor listening host"; + description = lib.mdDoc "Cadvisor listening host"; }; port = mkOption { default = 8080; type = types.int; - description = "Cadvisor listening port"; + description = lib.mdDoc "Cadvisor listening port"; }; storageDriver = mkOption { default = null; type = types.nullOr types.str; example = "influxdb"; - description = "Cadvisor storage driver."; + description = lib.mdDoc "Cadvisor storage driver."; }; storageDriverHost = mkOption { default = "localhost:8086"; type = types.str; - description = "Cadvisor storage driver host."; + description = lib.mdDoc "Cadvisor storage driver host."; }; storageDriverDb = mkOption { default = "root"; type = types.str; - description = "Cadvisord storage driver database name."; + description = lib.mdDoc "Cadvisord storage driver database name."; }; storageDriverUser = mkOption { default = "root"; type = types.str; - description = "Cadvisor storage driver username."; + description = lib.mdDoc "Cadvisor storage driver username."; }; storageDriverPassword = mkOption { default = "root"; type = types.str; - description = '' + description = lib.mdDoc '' Cadvisor storage driver password. Warning: this password is stored in the world-readable Nix store. It's - recommended to use the <option>storageDriverPasswordFile</option> option + recommended to use the {option}`storageDriverPasswordFile` option since that gives you control over the security of the password. - <option>storageDriverPasswordFile</option> also takes precedence over <option>storageDriverPassword</option>. + {option}`storageDriverPasswordFile` also takes precedence over {option}`storageDriverPassword`. ''; }; @@ -82,7 +82,7 @@ in { storageDriverSecure = mkOption { default = false; type = types.bool; - description = "Cadvisor storage driver, enable secure communication."; + description = lib.mdDoc "Cadvisor storage driver, enable secure communication."; }; extraOptions = mkOption { diff --git a/nixos/modules/services/monitoring/collectd.nix b/nixos/modules/services/monitoring/collectd.nix index 1b9af58575604..5c62d509511d9 100644 --- a/nixos/modules/services/monitoring/collectd.nix +++ b/nixos/modules/services/monitoring/collectd.nix @@ -33,7 +33,7 @@ in { validateConfig = mkOption { default = true; - description = '' + description = lib.mdDoc '' Validate the syntax of collectd configuration file at build time. Disable this if you use the Include directive on files unavailable in the build sandbox, or when cross-compiling. @@ -44,7 +44,7 @@ in { package = mkOption { default = pkgs.collectd; defaultText = literalExpression "pkgs.collectd"; - description = '' + description = lib.mdDoc '' Which collectd package to use. ''; type = types.package; @@ -60,7 +60,7 @@ in { user = mkOption { default = "collectd"; - description = '' + description = lib.mdDoc '' User under which to run collectd. ''; type = nullOr str; @@ -68,7 +68,7 @@ in { dataDir = mkOption { default = "/var/lib/collectd"; - description = '' + description = lib.mdDoc '' Data directory for collectd agent. ''; type = path; @@ -76,7 +76,7 @@ in { autoLoadPlugin = mkOption { default = false; - description = '' + description = lib.mdDoc '' Enable plugin autoloading. ''; type = bool; @@ -84,7 +84,7 @@ in { include = mkOption { default = []; - description = '' + description = lib.mdDoc '' Additional paths to load config from. ''; type = listOf str; @@ -93,7 +93,7 @@ in { plugins = mkOption { default = {}; example = { cpu = ""; memory = ""; network = "Server 192.168.1.1 25826"; }; - description = '' + description = lib.mdDoc '' Attribute set of plugin names to plugin config segments ''; type = attrsOf lines; @@ -101,7 +101,7 @@ in { extraConfig = mkOption { default = ""; - description = '' + description = lib.mdDoc '' Extra configuration for collectd. Use mkBefore to add lines before the default config, and mkAfter to add them below. ''; diff --git a/nixos/modules/services/monitoring/datadog-agent.nix b/nixos/modules/services/monitoring/datadog-agent.nix index 6d9d1ef973a44..9b984fafc12b5 100644 --- a/nixos/modules/services/monitoring/datadog-agent.nix +++ b/nixos/modules/services/monitoring/datadog-agent.nix @@ -50,7 +50,7 @@ let in { options.services.datadog-agent = { enable = mkOption { - description = '' + description = lib.mdDoc '' Whether to enable the datadog-agent v7 monitoring service ''; default = false; @@ -70,7 +70,7 @@ in { }; apiKeyFile = mkOption { - description = '' + description = lib.mdDoc '' Path to a file containing the Datadog API key to associate the agent with your account. ''; @@ -79,7 +79,7 @@ in { }; ddUrl = mkOption { - description = '' + description = lib.mdDoc '' Custom dd_url to configure the agent with. Useful if traffic to datadog needs to go through a proxy. Don't use this to point to another datadog site (EU) - use site instead. @@ -90,7 +90,7 @@ in { }; site = mkOption { - description = '' + description = lib.mdDoc '' The datadog site to point the agent towards. Set to datadoghq.eu to point it to their EU site. ''; @@ -100,21 +100,21 @@ in { }; tags = mkOption { - description = "The tags to mark this Datadog agent"; + description = lib.mdDoc "The tags to mark this Datadog agent"; example = [ "test" "service" ]; default = null; type = types.nullOr (types.listOf types.str); }; hostname = mkOption { - description = "The hostname to show in the Datadog dashboard (optional)"; + description = lib.mdDoc "The hostname to show in the Datadog dashboard (optional)"; default = null; example = "mymachine.mydomain"; type = types.nullOr types.str; }; logLevel = mkOption { - description = "Logging verbosity."; + description = lib.mdDoc "Logging verbosity."; default = null; type = types.nullOr (types.enum ["DEBUG" "INFO" "WARN" "ERROR"]); }; @@ -123,7 +123,7 @@ in { default = {}; type = types.attrs; - description = '' + description = lib.mdDoc '' Extra integrations from the Datadog core-integrations repository that should be built and included. @@ -145,14 +145,14 @@ in { extraConfig = mkOption { default = {}; type = types.attrs; - description = '' + description = lib.mdDoc '' Extra configuration options that will be merged into the - main config file <filename>datadog.yaml</filename>. + main config file {file}`datadog.yaml`. ''; }; enableLiveProcessCollection = mkOption { - description = '' + description = lib.mdDoc '' Whether to enable the live process collection agent. ''; default = false; @@ -160,7 +160,7 @@ in { }; enableTraceAgent = mkOption { - description = '' + description = lib.mdDoc '' Whether to enable the trace agent. ''; default = false; @@ -207,7 +207,7 @@ in { }; diskCheck = mkOption { - description = "Disk check config"; + description = lib.mdDoc "Disk check config"; type = types.attrs; default = { init_config = {}; @@ -216,7 +216,7 @@ in { }; networkCheck = mkOption { - description = "Network check config"; + description = lib.mdDoc "Network check config"; type = types.attrs; default = { init_config = {}; diff --git a/nixos/modules/services/monitoring/dd-agent/dd-agent.nix b/nixos/modules/services/monitoring/dd-agent/dd-agent.nix index a290dae8d4b99..8c0070c4853a6 100644 --- a/nixos/modules/services/monitoring/dd-agent/dd-agent.nix +++ b/nixos/modules/services/monitoring/dd-agent/dd-agent.nix @@ -112,68 +112,68 @@ let in { options.services.dd-agent = { enable = mkOption { - description = '' + description = lib.mdDoc '' Whether to enable the dd-agent v5 monitoring service. - For datadog-agent v6, see <option>services.datadog-agent.enable</option>. + For datadog-agent v6, see {option}`services.datadog-agent.enable`. ''; default = false; type = types.bool; }; api_key = mkOption { - description = '' + description = lib.mdDoc '' The Datadog API key to associate the agent with your account. Warning: this key is stored in cleartext within the world-readable Nix store! Consider using the new v6 - <option>services.datadog-agent</option> module instead. + {option}`services.datadog-agent` module instead. ''; example = "ae0aa6a8f08efa988ba0a17578f009ab"; type = types.str; }; tags = mkOption { - description = "The tags to mark this Datadog agent"; + description = lib.mdDoc "The tags to mark this Datadog agent"; example = [ "test" "service" ]; default = null; type = types.nullOr (types.listOf types.str); }; hostname = mkOption { - description = "The hostname to show in the Datadog dashboard (optional)"; + description = lib.mdDoc "The hostname to show in the Datadog dashboard (optional)"; default = null; example = "mymachine.mydomain"; type = types.nullOr types.str; }; postgresqlConfig = mkOption { - description = "Datadog PostgreSQL integration configuration"; + description = lib.mdDoc "Datadog PostgreSQL integration configuration"; default = null; type = types.nullOr types.lines; }; nginxConfig = mkOption { - description = "Datadog nginx integration configuration"; + description = lib.mdDoc "Datadog nginx integration configuration"; default = null; type = types.nullOr types.lines; }; mongoConfig = mkOption { - description = "MongoDB integration configuration"; + description = lib.mdDoc "MongoDB integration configuration"; default = null; type = types.nullOr types.lines; }; jmxConfig = mkOption { - description = "JMX integration configuration"; + description = lib.mdDoc "JMX integration configuration"; default = null; type = types.nullOr types.lines; }; processConfig = mkOption { - description = '' + description = lib.mdDoc '' Process integration configuration - See <link xlink:href="https://docs.datadoghq.com/integrations/process/"/> + See <https://docs.datadoghq.com/integrations/process/> ''; default = null; type = types.nullOr types.lines; diff --git a/nixos/modules/services/monitoring/fusion-inventory.nix b/nixos/modules/services/monitoring/fusion-inventory.nix index 9b65c76ce02e5..6b440e9fa45b3 100644 --- a/nixos/modules/services/monitoring/fusion-inventory.nix +++ b/nixos/modules/services/monitoring/fusion-inventory.nix @@ -26,7 +26,7 @@ in { servers = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' The urls of the OCS/GLPI servers to connect to. ''; }; @@ -34,7 +34,7 @@ in { extraConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Configuration that is injected verbatim into the configuration file. ''; }; diff --git a/nixos/modules/services/monitoring/grafana-agent.nix b/nixos/modules/services/monitoring/grafana-agent.nix index a4b18b4f28e9a..8190f44c72f7f 100644 --- a/nixos/modules/services/monitoring/grafana-agent.nix +++ b/nixos/modules/services/monitoring/grafana-agent.nix @@ -17,11 +17,11 @@ in type = types.package; default = pkgs.grafana-agent; defaultText = "pkgs.grafana-agent"; - description = "The grafana-agent package to use."; + description = lib.mdDoc "The grafana-agent package to use."; }; credentials = mkOption { - description = '' + description = lib.mdDoc '' Credentials to load at service startup. Keys that are UPPER_SNAKE will be loaded as env vars. Values are absolute paths to the credentials. ''; type = types.attrsOf types.str; diff --git a/nixos/modules/services/monitoring/grafana-image-renderer.nix b/nixos/modules/services/monitoring/grafana-image-renderer.nix index b8b95d846c6af..97488f2653a5b 100644 --- a/nixos/modules/services/monitoring/grafana-image-renderer.nix +++ b/nixos/modules/services/monitoring/grafana-image-renderer.nix @@ -14,7 +14,7 @@ in { chromium = mkOption { type = types.package; - description = '' + description = lib.mdDoc '' The chromium to use for image rendering. ''; }; @@ -32,15 +32,15 @@ in { port = mkOption { type = types.port; default = 8081; - description = '' + description = lib.mdDoc '' The TCP port to use for the rendering server. ''; }; logging.level = mkOption { type = types.enum [ "error" "warning" "info" "debug" ]; default = "info"; - description = '' - The log-level of the <filename>grafana-image-renderer.service</filename>-unit. + description = lib.mdDoc '' + The log-level of the {file}`grafana-image-renderer.service`-unit. ''; }; }; @@ -48,14 +48,14 @@ in { width = mkOption { default = 1000; type = types.ints.positive; - description = '' + description = lib.mdDoc '' Width of the PNG used to display the alerting graph. ''; }; height = mkOption { default = 500; type = types.ints.positive; - description = '' + description = lib.mdDoc '' Height of the PNG used to display the alerting graph. ''; }; diff --git a/nixos/modules/services/monitoring/grafana-reporter.nix b/nixos/modules/services/monitoring/grafana-reporter.nix index e40d78f538faf..7a27b5cbce31b 100644 --- a/nixos/modules/services/monitoring/grafana-reporter.nix +++ b/nixos/modules/services/monitoring/grafana-reporter.nix @@ -11,36 +11,36 @@ in { grafana = { protocol = mkOption { - description = "Grafana protocol."; + description = lib.mdDoc "Grafana protocol."; default = "http"; type = types.enum ["http" "https"]; }; addr = mkOption { - description = "Grafana address."; + description = lib.mdDoc "Grafana address."; default = "127.0.0.1"; type = types.str; }; port = mkOption { - description = "Grafana port."; + description = lib.mdDoc "Grafana port."; default = 3000; type = types.int; }; }; addr = mkOption { - description = "Listening address."; + description = lib.mdDoc "Listening address."; default = "127.0.0.1"; type = types.str; }; port = mkOption { - description = "Listening port."; + description = lib.mdDoc "Listening port."; default = 8686; type = types.int; }; templateDir = mkOption { - description = "Optional template directory to use custom tex templates"; + description = lib.mdDoc "Optional template directory to use custom tex templates"; default = pkgs.grafana_reporter; defaultText = literalExpression "pkgs.grafana_reporter"; type = types.either types.str types.path; diff --git a/nixos/modules/services/monitoring/grafana.nix b/nixos/modules/services/monitoring/grafana.nix index 68b4796f4f4ec..456fe92eea386 100644 --- a/nixos/modules/services/monitoring/grafana.nix +++ b/nixos/modules/services/monitoring/grafana.nix @@ -108,90 +108,90 @@ let options = { name = mkOption { type = types.str; - description = "Name of the datasource. Required."; + description = lib.mdDoc "Name of the datasource. Required."; }; type = mkOption { type = types.str; - description = "Datasource type. Required."; + description = lib.mdDoc "Datasource type. Required."; }; access = mkOption { type = types.enum ["proxy" "direct"]; default = "proxy"; - description = "Access mode. proxy or direct (Server or Browser in the UI). Required."; + description = lib.mdDoc "Access mode. proxy or direct (Server or Browser in the UI). Required."; }; orgId = mkOption { type = types.int; default = 1; - description = "Org id. will default to orgId 1 if not specified."; + description = lib.mdDoc "Org id. will default to orgId 1 if not specified."; }; uid = mkOption { type = types.nullOr types.str; default = null; - description = "Custom UID which can be used to reference this datasource in other parts of the configuration, if not specified will be generated automatically."; + description = lib.mdDoc "Custom UID which can be used to reference this datasource in other parts of the configuration, if not specified will be generated automatically."; }; url = mkOption { type = types.str; - description = "Url of the datasource."; + description = lib.mdDoc "Url of the datasource."; }; password = mkOption { type = types.nullOr types.str; default = null; - description = "Database password, if used."; + description = lib.mdDoc "Database password, if used."; }; user = mkOption { type = types.nullOr types.str; default = null; - description = "Database user, if used."; + description = lib.mdDoc "Database user, if used."; }; database = mkOption { type = types.nullOr types.str; default = null; - description = "Database name, if used."; + description = lib.mdDoc "Database name, if used."; }; basicAuth = mkOption { type = types.nullOr types.bool; default = null; - description = "Enable/disable basic auth."; + description = lib.mdDoc "Enable/disable basic auth."; }; basicAuthUser = mkOption { type = types.nullOr types.str; default = null; - description = "Basic auth username."; + description = lib.mdDoc "Basic auth username."; }; basicAuthPassword = mkOption { type = types.nullOr types.str; default = null; - description = "Basic auth password."; + description = lib.mdDoc "Basic auth password."; }; withCredentials = mkOption { type = types.bool; default = false; - description = "Enable/disable with credentials headers."; + description = lib.mdDoc "Enable/disable with credentials headers."; }; isDefault = mkOption { type = types.bool; default = false; - description = "Mark as default datasource. Max one per org."; + description = lib.mdDoc "Mark as default datasource. Max one per org."; }; jsonData = mkOption { type = types.nullOr types.attrs; default = null; - description = "Datasource specific configuration."; + description = lib.mdDoc "Datasource specific configuration."; }; secureJsonData = mkOption { type = types.nullOr types.attrs; default = null; - description = "Datasource specific secure configuration."; + description = lib.mdDoc "Datasource specific secure configuration."; }; version = mkOption { type = types.int; default = 1; - description = "Version."; + description = lib.mdDoc "Version."; }; editable = mkOption { type = types.bool; default = false; - description = "Allow users to edit datasources from the UI."; + description = lib.mdDoc "Allow users to edit datasources from the UI."; }; }; }; @@ -202,42 +202,42 @@ let name = mkOption { type = types.str; default = "default"; - description = "Provider name."; + description = lib.mdDoc "Provider name."; }; orgId = mkOption { type = types.int; default = 1; - description = "Organization ID."; + description = lib.mdDoc "Organization ID."; }; folder = mkOption { type = types.str; default = ""; - description = "Add dashboards to the specified folder."; + description = lib.mdDoc "Add dashboards to the specified folder."; }; type = mkOption { type = types.str; default = "file"; - description = "Dashboard provider type."; + description = lib.mdDoc "Dashboard provider type."; }; disableDeletion = mkOption { type = types.bool; default = false; - description = "Disable deletion when JSON file is removed."; + description = lib.mdDoc "Disable deletion when JSON file is removed."; }; updateIntervalSeconds = mkOption { type = types.int; default = 10; - description = "How often Grafana will scan for changed dashboards."; + description = lib.mdDoc "How often Grafana will scan for changed dashboards."; }; options = { path = mkOption { type = types.path; - description = "Path grafana will watch for dashboards."; + description = lib.mdDoc "Path grafana will watch for dashboards."; }; foldersFromFilesStructure = mkOption { type = types.bool; default = false; - description = "Use folder names from filesystem to create folders in Grafana."; + description = lib.mdDoc "Use folder names from filesystem to create folders in Grafana."; }; }; }; @@ -248,55 +248,55 @@ let name = mkOption { type = types.str; default = "default"; - description = "Notifier name."; + description = lib.mdDoc "Notifier name."; }; type = mkOption { type = types.enum ["dingding" "discord" "email" "googlechat" "hipchat" "kafka" "line" "teams" "opsgenie" "pagerduty" "prometheus-alertmanager" "pushover" "sensu" "sensugo" "slack" "telegram" "threema" "victorops" "webhook"]; - description = "Notifier type."; + description = lib.mdDoc "Notifier type."; }; uid = mkOption { type = types.str; - description = "Unique notifier identifier."; + description = lib.mdDoc "Unique notifier identifier."; }; org_id = mkOption { type = types.int; default = 1; - description = "Organization ID."; + description = lib.mdDoc "Organization ID."; }; org_name = mkOption { type = types.str; default = "Main Org."; - description = "Organization name."; + description = lib.mdDoc "Organization name."; }; is_default = mkOption { type = types.bool; - description = "Is the default notifier."; + description = lib.mdDoc "Is the default notifier."; default = false; }; send_reminder = mkOption { type = types.bool; default = true; - description = "Should the notifier be sent reminder notifications while alerts continue to fire."; + description = lib.mdDoc "Should the notifier be sent reminder notifications while alerts continue to fire."; }; frequency = mkOption { type = types.str; default = "5m"; - description = "How frequently should the notifier be sent reminders."; + description = lib.mdDoc "How frequently should the notifier be sent reminders."; }; disable_resolve_message = mkOption { type = types.bool; default = false; - description = "Turn off the message that sends when an alert returns to OK."; + description = lib.mdDoc "Turn off the message that sends when an alert returns to OK."; }; settings = mkOption { type = types.nullOr types.attrs; default = null; - description = "Settings for the notifier type."; + description = lib.mdDoc "Settings for the notifier type."; }; secure_settings = mkOption { type = types.nullOr types.attrs; default = null; - description = "Secure settings for the notifier type."; + description = lib.mdDoc "Secure settings for the notifier type."; }; }; }; @@ -305,62 +305,62 @@ in { enable = mkEnableOption "grafana"; protocol = mkOption { - description = "Which protocol to listen."; + description = lib.mdDoc "Which protocol to listen."; default = "http"; type = types.enum ["http" "https" "socket"]; }; addr = mkOption { - description = "Listening address."; + description = lib.mdDoc "Listening address."; default = "127.0.0.1"; type = types.str; }; port = mkOption { - description = "Listening port."; + description = lib.mdDoc "Listening port."; default = 3000; type = types.port; }; socket = mkOption { - description = "Listening socket."; + description = lib.mdDoc "Listening socket."; default = "/run/grafana/grafana.sock"; type = types.str; }; domain = mkOption { - description = "The public facing domain name used to access grafana from a browser."; + description = lib.mdDoc "The public facing domain name used to access grafana from a browser."; default = "localhost"; type = types.str; }; rootUrl = mkOption { - description = "Full public facing url."; + description = lib.mdDoc "Full public facing url."; default = "%(protocol)s://%(domain)s:%(http_port)s/"; type = types.str; }; certFile = mkOption { - description = "Cert file for ssl."; + description = lib.mdDoc "Cert file for ssl."; default = ""; type = types.str; }; certKey = mkOption { - description = "Cert key for ssl."; + description = lib.mdDoc "Cert key for ssl."; default = ""; type = types.str; }; staticRootPath = mkOption { - description = "Root path for static assets."; + description = lib.mdDoc "Root path for static assets."; default = "${cfg.package}/share/grafana/public"; defaultText = literalExpression ''"''${package}/share/grafana/public"''; type = types.str; }; package = mkOption { - description = "Package to use."; + description = lib.mdDoc "Package to use."; default = pkgs.grafana; defaultText = literalExpression "pkgs.grafana"; type = types.package; @@ -369,7 +369,7 @@ in { declarativePlugins = mkOption { type = with types; nullOr (listOf path); default = null; - description = "If non-null, then a list of packages containing Grafana plugins to install. If set, plugins cannot be manually installed."; + description = lib.mdDoc "If non-null, then a list of packages containing Grafana plugins to install. If set, plugins cannot be manually installed."; example = literalExpression "with pkgs.grafanaPlugins; [ grafana-piechart-panel ]"; # Make sure each plugin is added only once; otherwise building # the link farm fails, since the same path is added multiple @@ -378,38 +378,38 @@ in { }; dataDir = mkOption { - description = "Data directory."; + description = lib.mdDoc "Data directory."; default = "/var/lib/grafana"; type = types.path; }; database = { type = mkOption { - description = "Database type."; + description = lib.mdDoc "Database type."; default = "sqlite3"; type = types.enum ["mysql" "sqlite3" "postgres"]; }; host = mkOption { - description = "Database host."; + description = lib.mdDoc "Database host."; default = "127.0.0.1:3306"; type = types.str; }; name = mkOption { - description = "Database name."; + description = lib.mdDoc "Database name."; default = "grafana"; type = types.str; }; user = mkOption { - description = "Database user."; + description = lib.mdDoc "Database user."; default = "root"; type = types.str; }; password = mkOption { - description = '' + description = lib.mdDoc '' Database password. This option is mutual exclusive with the passwordFile option. ''; @@ -418,7 +418,7 @@ in { }; passwordFile = mkOption { - description = '' + description = lib.mdDoc '' File that containts the database password. This option is mutual exclusive with the password option. ''; @@ -427,14 +427,14 @@ in { }; path = mkOption { - description = "Database path."; + description = lib.mdDoc "Database path."; default = "${cfg.dataDir}/data/grafana.db"; defaultText = literalExpression ''"''${config.${opt.dataDir}}/data/grafana.db"''; type = types.path; }; connMaxLifetime = mkOption { - description = '' + description = lib.mdDoc '' Sets the maximum amount of time (in seconds) a connection may be reused. For MySQL this setting should be shorter than the `wait_timeout' variable. ''; @@ -447,19 +447,19 @@ in { provision = { enable = mkEnableOption "provision"; datasources = mkOption { - description = "Grafana datasources configuration."; + description = lib.mdDoc "Grafana datasources configuration."; default = []; type = types.listOf grafanaTypes.datasourceConfig; apply = x: map _filter x; }; dashboards = mkOption { - description = "Grafana dashboard configuration."; + description = lib.mdDoc "Grafana dashboard configuration."; default = []; type = types.listOf grafanaTypes.dashboardConfig; apply = x: map _filter x; }; notifiers = mkOption { - description = "Grafana notifier configuration."; + description = lib.mdDoc "Grafana notifier configuration."; default = []; type = types.listOf grafanaTypes.notifierConfig; apply = x: map _filter x; @@ -468,13 +468,13 @@ in { security = { adminUser = mkOption { - description = "Default admin username."; + description = lib.mdDoc "Default admin username."; default = "admin"; type = types.str; }; adminPassword = mkOption { - description = '' + description = lib.mdDoc '' Default admin password. This option is mutual exclusive with the adminPasswordFile option. ''; @@ -483,22 +483,22 @@ in { }; adminPasswordFile = mkOption { - description = '' + description = lib.mdDoc '' Default admin password. - This option is mutual exclusive with the <literal>adminPassword</literal> option. + This option is mutual exclusive with the `adminPassword` option. ''; default = null; type = types.nullOr types.path; }; secretKey = mkOption { - description = "Secret key used for signing."; + description = lib.mdDoc "Secret key used for signing."; default = "SW2YcwTIb9zpOOhoPsMm"; type = types.str; }; secretKeyFile = mkOption { - description = "Secret key used for signing."; + description = lib.mdDoc "Secret key used for signing."; default = null; type = types.nullOr types.path; }; @@ -506,7 +506,7 @@ in { server = { serveFromSubPath = mkOption { - description = "Serve Grafana from subpath specified in rootUrl setting"; + description = lib.mdDoc "Serve Grafana from subpath specified in rootUrl setting"; default = false; type = types.bool; }; @@ -515,17 +515,17 @@ in { smtp = { enable = mkEnableOption "smtp"; host = mkOption { - description = "Host to connect to."; + description = lib.mdDoc "Host to connect to."; default = "localhost:25"; type = types.str; }; user = mkOption { - description = "User used for authentication."; + description = lib.mdDoc "User used for authentication."; default = ""; type = types.str; }; password = mkOption { - description = '' + description = lib.mdDoc '' Password used for authentication. This option is mutual exclusive with the passwordFile option. ''; @@ -533,7 +533,7 @@ in { type = types.str; }; passwordFile = mkOption { - description = '' + description = lib.mdDoc '' Password used for authentication. This option is mutual exclusive with the password option. ''; @@ -541,7 +541,7 @@ in { type = types.nullOr types.path; }; fromAddress = mkOption { - description = "Email address used for sending."; + description = lib.mdDoc "Email address used for sending."; default = "admin@grafana.localhost"; type = types.str; }; @@ -549,25 +549,25 @@ in { users = { allowSignUp = mkOption { - description = "Disable user signup / registration."; + description = lib.mdDoc "Disable user signup / registration."; default = false; type = types.bool; }; allowOrgCreate = mkOption { - description = "Whether user is allowed to create organizations."; + description = lib.mdDoc "Whether user is allowed to create organizations."; default = false; type = types.bool; }; autoAssignOrg = mkOption { - description = "Whether to automatically assign new users to default org."; + description = lib.mdDoc "Whether to automatically assign new users to default org."; default = true; type = types.bool; }; autoAssignOrgRole = mkOption { - description = "Default role new users will be auto assigned."; + description = lib.mdDoc "Default role new users will be auto assigned."; default = "Viewer"; type = types.enum ["Viewer" "Editor"]; }; @@ -575,51 +575,51 @@ in { auth = { disableLoginForm = mkOption { - description = "Set to true to disable (hide) the login form, useful if you use OAuth"; + description = lib.mdDoc "Set to true to disable (hide) the login form, useful if you use OAuth"; default = false; type = types.bool; }; anonymous = { enable = mkOption { - description = "Whether to allow anonymous access."; + description = lib.mdDoc "Whether to allow anonymous access."; default = false; type = types.bool; }; org_name = mkOption { - description = "Which organization to allow anonymous access to."; + description = lib.mdDoc "Which organization to allow anonymous access to."; default = "Main Org."; type = types.str; }; org_role = mkOption { - description = "Which role anonymous users have in the organization."; + description = lib.mdDoc "Which role anonymous users have in the organization."; default = "Viewer"; type = types.str; }; }; azuread = { enable = mkOption { - description = "Whether to allow Azure AD OAuth."; + description = lib.mdDoc "Whether to allow Azure AD OAuth."; default = false; type = types.bool; }; allowSignUp = mkOption { - description = "Whether to allow sign up with Azure AD OAuth."; + description = lib.mdDoc "Whether to allow sign up with Azure AD OAuth."; default = false; type = types.bool; }; clientId = mkOption { - description = "Azure AD OAuth client ID."; + description = lib.mdDoc "Azure AD OAuth client ID."; default = ""; type = types.str; }; clientSecretFile = mkOption { - description = "Azure AD OAuth client secret."; + description = lib.mdDoc "Azure AD OAuth client secret."; default = null; type = types.nullOr types.path; }; tenantId = mkOption { - description = '' + description = lib.mdDoc '' Tenant id used to create auth and token url. Default to "common" , let user sign in with any tenant. ''; @@ -627,7 +627,7 @@ in { type = types.str; }; allowedDomains = mkOption { - description = '' + description = lib.mdDoc '' To limit access to authenticated users who are members of one or more groups, set allowedGroups to a comma- or space-separated list of group object IDs. You can find object IDs for a specific group on the Azure portal. @@ -636,7 +636,7 @@ in { type = types.str; }; allowedGroups = mkOption { - description = '' + description = lib.mdDoc '' Limits access to users who belong to specific domains. Separate domains with space or comma. ''; @@ -646,22 +646,22 @@ in { }; google = { enable = mkOption { - description = "Whether to allow Google OAuth2."; + description = lib.mdDoc "Whether to allow Google OAuth2."; default = false; type = types.bool; }; allowSignUp = mkOption { - description = "Whether to allow sign up with Google OAuth2."; + description = lib.mdDoc "Whether to allow sign up with Google OAuth2."; default = false; type = types.bool; }; clientId = mkOption { - description = "Google OAuth2 client ID."; + description = lib.mdDoc "Google OAuth2 client ID."; default = ""; type = types.str; }; clientSecretFile = mkOption { - description = "Google OAuth2 client secret."; + description = lib.mdDoc "Google OAuth2 client secret."; default = null; type = types.nullOr types.path; }; @@ -670,16 +670,16 @@ in { analytics.reporting = { enable = mkOption { - description = "Whether to allow anonymous usage reporting to stats.grafana.net."; + description = lib.mdDoc "Whether to allow anonymous usage reporting to stats.grafana.net."; default = true; type = types.bool; }; }; extraOptions = mkOption { - description = '' + description = lib.mdDoc '' Extra configuration options passed as env variables as specified in - <link xlink:href="http://docs.grafana.org/installation/configuration/">documentation</link>, + [documentation](http://docs.grafana.org/installation/configuration/), but without GF_ prefix ''; default = {}; diff --git a/nixos/modules/services/monitoring/graphite.nix b/nixos/modules/services/monitoring/graphite.nix index 1dc2cee479ac3..73b509202df66 100644 --- a/nixos/modules/services/monitoring/graphite.nix +++ b/nixos/modules/services/monitoring/graphite.nix @@ -73,26 +73,26 @@ in { dataDir = mkOption { type = types.path; default = "/var/db/graphite"; - description = '' + description = lib.mdDoc '' Data directory for graphite. ''; }; web = { enable = mkOption { - description = "Whether to enable graphite web frontend."; + description = lib.mdDoc "Whether to enable graphite web frontend."; default = false; type = types.bool; }; listenAddress = mkOption { - description = "Graphite web frontend listen address."; + description = lib.mdDoc "Graphite web frontend listen address."; default = "127.0.0.1"; type = types.str; }; port = mkOption { - description = "Graphite web frontend port."; + description = lib.mdDoc "Graphite web frontend port."; default = 8080; type = types.int; }; @@ -100,16 +100,16 @@ in { extraConfig = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Graphite webapp settings. See: - <link xlink:href="http://graphite.readthedocs.io/en/latest/config-local-settings.html"/> + <http://graphite.readthedocs.io/en/latest/config-local-settings.html> ''; }; }; carbon = { config = mkOption { - description = "Content of carbon configuration file."; + description = lib.mdDoc "Content of carbon configuration file."; default = '' [cache] # Listen on localhost by default for security reasons @@ -125,13 +125,13 @@ in { }; enableCache = mkOption { - description = "Whether to enable carbon cache, the graphite storage daemon."; + description = lib.mdDoc "Whether to enable carbon cache, the graphite storage daemon."; default = false; type = types.bool; }; storageAggregation = mkOption { - description = "Defines how to aggregate data to lower-precision retentions."; + description = lib.mdDoc "Defines how to aggregate data to lower-precision retentions."; default = null; type = types.nullOr types.str; example = '' @@ -143,7 +143,7 @@ in { }; storageSchemas = mkOption { - description = "Defines retention rates for storing metrics."; + description = lib.mdDoc "Defines retention rates for storing metrics."; default = ""; type = types.nullOr types.str; example = '' @@ -154,21 +154,21 @@ in { }; blacklist = mkOption { - description = "Any metrics received which match one of the experssions will be dropped."; + description = lib.mdDoc "Any metrics received which match one of the experssions will be dropped."; default = null; type = types.nullOr types.str; example = "^some\\.noisy\\.metric\\.prefix\\..*"; }; whitelist = mkOption { - description = "Only metrics received which match one of the experssions will be persisted."; + description = lib.mdDoc "Only metrics received which match one of the experssions will be persisted."; default = null; type = types.nullOr types.str; example = ".*"; }; rewriteRules = mkOption { - description = '' + description = lib.mdDoc '' Regular expression patterns that can be used to rewrite metric names in a search and replace fashion. ''; @@ -182,13 +182,13 @@ in { }; enableRelay = mkOption { - description = "Whether to enable carbon relay, the carbon replication and sharding service."; + description = lib.mdDoc "Whether to enable carbon relay, the carbon replication and sharding service."; default = false; type = types.bool; }; relayRules = mkOption { - description = "Relay rules are used to send certain metrics to a certain backend."; + description = lib.mdDoc "Relay rules are used to send certain metrics to a certain backend."; default = null; type = types.nullOr types.str; example = '' @@ -199,13 +199,13 @@ in { }; enableAggregator = mkOption { - description = "Whether to enable carbon aggregator, the carbon buffering service."; + description = lib.mdDoc "Whether to enable carbon aggregator, the carbon buffering service."; default = false; type = types.bool; }; aggregationRules = mkOption { - description = "Defines if and how received metrics will be aggregated."; + description = lib.mdDoc "Defines if and how received metrics will be aggregated."; default = null; type = types.nullOr types.str; example = '' @@ -217,13 +217,13 @@ in { seyren = { enable = mkOption { - description = "Whether to enable seyren service."; + description = lib.mdDoc "Whether to enable seyren service."; default = false; type = types.bool; }; port = mkOption { - description = "Seyren listening port."; + description = lib.mdDoc "Seyren listening port."; default = 8081; type = types.int; }; @@ -231,21 +231,21 @@ in { seyrenUrl = mkOption { default = "http://localhost:${toString cfg.seyren.port}/"; defaultText = literalExpression ''"http://localhost:''${toString config.${opt.seyren.port}}/"''; - description = "Host where seyren is accessible."; + description = lib.mdDoc "Host where seyren is accessible."; type = types.str; }; graphiteUrl = mkOption { default = "http://${cfg.web.listenAddress}:${toString cfg.web.port}"; defaultText = literalExpression ''"http://''${config.${opt.web.listenAddress}}:''${toString config.${opt.web.port}}"''; - description = "Host where graphite service runs."; + description = lib.mdDoc "Host where graphite service runs."; type = types.str; }; mongoUrl = mkOption { default = "mongodb://${config.services.mongodb.bind_ip}:27017/seyren"; defaultText = literalExpression ''"mongodb://''${config.services.mongodb.bind_ip}:27017/seyren"''; - description = "Mongodb connection string."; + description = lib.mdDoc "Mongodb connection string."; type = types.str; }; diff --git a/nixos/modules/services/monitoring/heapster.nix b/nixos/modules/services/monitoring/heapster.nix index 44f53e1890ac5..2f2467477ae2f 100644 --- a/nixos/modules/services/monitoring/heapster.nix +++ b/nixos/modules/services/monitoring/heapster.nix @@ -7,31 +7,31 @@ let in { options.services.heapster = { enable = mkOption { - description = "Whether to enable heapster monitoring"; + description = lib.mdDoc "Whether to enable heapster monitoring"; default = false; type = types.bool; }; source = mkOption { - description = "Heapster metric source"; + description = lib.mdDoc "Heapster metric source"; example = "kubernetes:https://kubernetes.default"; type = types.str; }; sink = mkOption { - description = "Heapster metic sink"; + description = lib.mdDoc "Heapster metic sink"; example = "influxdb:http://localhost:8086"; type = types.str; }; extraOpts = mkOption { - description = "Heapster extra options"; + description = lib.mdDoc "Heapster extra options"; default = ""; type = types.separatedString " "; }; package = mkOption { - description = "Package to use by heapster"; + description = lib.mdDoc "Package to use by heapster"; default = pkgs.heapster; defaultText = literalExpression "pkgs.heapster"; type = types.package; diff --git a/nixos/modules/services/monitoring/incron.nix b/nixos/modules/services/monitoring/incron.nix index 2681c35d6a015..53cbe1a9e26a1 100644 --- a/nixos/modules/services/monitoring/incron.nix +++ b/nixos/modules/services/monitoring/incron.nix @@ -27,12 +27,12 @@ in allow = mkOption { type = types.nullOr (types.listOf types.str); default = null; - description = '' + description = lib.mdDoc '' Users allowed to use incrontab. If empty then no user will be allowed to have their own incrontab. - If <literal>null</literal> then will defer to <option>deny</option>. - If both <option>allow</option> and <option>deny</option> are null + If `null` then will defer to {option}`deny`. + If both {option}`allow` and {option}`deny` are null then all users will be allowed to have their own incrontab. ''; }; @@ -40,13 +40,13 @@ in deny = mkOption { type = types.nullOr (types.listOf types.str); default = null; - description = "Users forbidden from using incrontab."; + description = lib.mdDoc "Users forbidden from using incrontab."; }; systab = mkOption { type = types.lines; default = ""; - description = "The system incrontab contents."; + description = lib.mdDoc "The system incrontab contents."; example = '' /var/mail IN_CLOSE_WRITE abc $@/$# /tmp IN_ALL_EVENTS efg $@/$# $& @@ -57,7 +57,7 @@ in type = types.listOf types.package; default = []; example = literalExpression "[ pkgs.rsync ]"; - description = "Extra packages available to the system incrontab."; + description = lib.mdDoc "Extra packages available to the system incrontab."; }; }; diff --git a/nixos/modules/services/monitoring/kapacitor.nix b/nixos/modules/services/monitoring/kapacitor.nix index a79c647becfc4..9cdb0e4495a4b 100644 --- a/nixos/modules/services/monitoring/kapacitor.nix +++ b/nixos/modules/services/monitoring/kapacitor.nix @@ -62,24 +62,24 @@ in dataDir = mkOption { type = types.path; default = "/var/lib/kapacitor"; - description = "Location where Kapacitor stores its state"; + description = lib.mdDoc "Location where Kapacitor stores its state"; }; port = mkOption { type = types.int; default = 9092; - description = "Port of Kapacitor"; + description = lib.mdDoc "Port of Kapacitor"; }; bind = mkOption { type = types.str; default = ""; example = "0.0.0.0"; - description = "Address to bind to. The default is to bind to all addresses"; + description = lib.mdDoc "Address to bind to. The default is to bind to all addresses"; }; extraConfig = mkOption { - description = "These lines go into kapacitord.conf verbatim."; + description = lib.mdDoc "These lines go into kapacitord.conf verbatim."; default = ""; type = types.lines; }; @@ -87,24 +87,24 @@ in user = mkOption { type = types.str; default = "kapacitor"; - description = "User account under which Kapacitor runs"; + description = lib.mdDoc "User account under which Kapacitor runs"; }; group = mkOption { type = types.str; default = "kapacitor"; - description = "Group under which Kapacitor runs"; + description = lib.mdDoc "Group under which Kapacitor runs"; }; taskSnapshotInterval = mkOption { type = types.str; - description = "Specifies how often to snapshot the task state (in InfluxDB time units)"; + description = lib.mdDoc "Specifies how often to snapshot the task state (in InfluxDB time units)"; default = "1m0s"; }; loadDirectory = mkOption { type = types.nullOr types.path; - description = "Directory where to load services from, such as tasks, templates and handlers (or null to disable service loading on startup)"; + description = lib.mdDoc "Directory where to load services from, such as tasks, templates and handlers (or null to disable service loading on startup)"; default = null; }; @@ -112,18 +112,18 @@ in enable = mkEnableOption "kapacitor.defaultDatabase"; url = mkOption { - description = "The URL to an InfluxDB server that serves as the default database"; + description = lib.mdDoc "The URL to an InfluxDB server that serves as the default database"; example = "http://localhost:8086"; type = types.str; }; username = mkOption { - description = "The username to connect to the remote InfluxDB server"; + description = lib.mdDoc "The username to connect to the remote InfluxDB server"; type = types.str; }; password = mkOption { - description = "The password to connect to the remote InfluxDB server"; + description = lib.mdDoc "The password to connect to the remote InfluxDB server"; type = types.str; }; }; @@ -132,25 +132,25 @@ in enable = mkEnableOption "kapacitor alerta integration"; url = mkOption { - description = "The URL to the Alerta REST API"; + description = lib.mdDoc "The URL to the Alerta REST API"; default = "http://localhost:5000"; type = types.str; }; token = mkOption { - description = "Default Alerta authentication token"; + description = lib.mdDoc "Default Alerta authentication token"; type = types.str; default = ""; }; environment = mkOption { - description = "Default Alerta environment"; + description = lib.mdDoc "Default Alerta environment"; type = types.str; default = "Production"; }; origin = mkOption { - description = "Default origin of alert"; + description = lib.mdDoc "Default origin of alert"; type = types.str; default = "kapacitor"; }; diff --git a/nixos/modules/services/monitoring/loki.nix b/nixos/modules/services/monitoring/loki.nix index ebac70c30c22e..d73e2abb71d21 100644 --- a/nixos/modules/services/monitoring/loki.nix +++ b/nixos/modules/services/monitoring/loki.nix @@ -17,7 +17,7 @@ in { user = mkOption { type = types.str; default = "loki"; - description = '' + description = lib.mdDoc '' User under which the Loki service runs. ''; }; @@ -25,7 +25,7 @@ in { group = mkOption { type = types.str; default = "loki"; - description = '' + description = lib.mdDoc '' Group under which the Loki service runs. ''; }; @@ -33,7 +33,7 @@ in { dataDir = mkOption { type = types.path; default = "/var/lib/loki"; - description = '' + description = lib.mdDoc '' Specify the directory for Loki. ''; }; @@ -41,7 +41,7 @@ in { configuration = mkOption { type = (pkgs.formats.json {}).type; default = {}; - description = '' + description = lib.mdDoc '' Specify the configuration for Loki in Nix. ''; }; @@ -49,7 +49,7 @@ in { configFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Specify a configuration file that Loki should use. ''; }; @@ -58,7 +58,7 @@ in { type = types.listOf types.str; default = []; example = [ "--server.http-listen-port=3101" ]; - description = '' + description = lib.mdDoc '' Specify a list of additional command line flags, which get escaped and are then passed to Loki. ''; diff --git a/nixos/modules/services/monitoring/longview.nix b/nixos/modules/services/monitoring/longview.nix index 9c38956f9ba85..5825cab0134c2 100644 --- a/nixos/modules/services/monitoring/longview.nix +++ b/nixos/modules/services/monitoring/longview.nix @@ -16,7 +16,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If enabled, system metrics will be sent to Linode LongView. ''; }; @@ -25,12 +25,12 @@ in { type = types.str; default = ""; example = "01234567-89AB-CDEF-0123456789ABCDEF"; - description = '' + description = lib.mdDoc '' Longview API key. To get this, look in Longview settings which are found at https://manager.linode.com/longview/. Warning: this secret is stored in the world-readable Nix store! - Use <option>apiKeyFile</option> instead. + Use {option}`apiKeyFile` instead. ''; }; @@ -38,12 +38,12 @@ in { type = types.nullOr types.path; default = null; example = "/run/keys/longview-api-key"; - description = '' + description = lib.mdDoc '' A file containing the Longview API key. To get this, look in Longview settings which are found at https://manager.linode.com/longview/. - <option>apiKeyFile</option> takes precedence over <option>apiKey</option>. + {option}`apiKeyFile` takes precedence over {option}`apiKey`. ''; }; @@ -51,7 +51,7 @@ in { type = types.str; default = ""; example = "http://127.0.0.1/server-status"; - description = '' + description = lib.mdDoc '' The Apache status page URL. If provided, Longview will gather statistics from this location. This requires Apache mod_status to be loaded and enabled. @@ -62,7 +62,7 @@ in { type = types.str; default = ""; example = "http://127.0.0.1/nginx_status"; - description = '' + description = lib.mdDoc '' The Nginx status page URL. Longview will gather statistics from this URL. This requires the Nginx stub_status module to be enabled and configured at the given location. @@ -72,7 +72,7 @@ in { mysqlUser = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' The user for connecting to the MySQL database. If provided, Longview will connect to MySQL and collect statistics about queries, etc. This user does not need to have been granted @@ -83,10 +83,10 @@ in { mysqlPassword = mkOption { type = types.str; default = ""; - description = '' - The password corresponding to <option>mysqlUser</option>. + description = lib.mdDoc '' + The password corresponding to {option}`mysqlUser`. Warning: this is stored in cleartext in the Nix store! - Use <option>mysqlPasswordFile</option> instead. + Use {option}`mysqlPasswordFile` instead. ''; }; @@ -94,8 +94,8 @@ in { type = types.nullOr types.path; default = null; example = "/run/keys/dbpassword"; - description = '' - A file containing the password corresponding to <option>mysqlUser</option>. + description = lib.mdDoc '' + A file containing the password corresponding to {option}`mysqlUser`. ''; }; diff --git a/nixos/modules/services/monitoring/mackerel-agent.nix b/nixos/modules/services/monitoring/mackerel-agent.nix index aeb6247abd8b1..89c6d4d6c65bd 100644 --- a/nixos/modules/services/monitoring/mackerel-agent.nix +++ b/nixos/modules/services/monitoring/mackerel-agent.nix @@ -29,11 +29,11 @@ in { }; settings = mkOption { - description = '' + description = lib.mdDoc '' Options for mackerel-agent.conf. Documentation: - <link xlink:href="https://mackerel.io/docs/entry/spec/agent"/> + <https://mackerel.io/docs/entry/spec/agent> ''; default = {}; @@ -48,12 +48,12 @@ in { options.host_status = { on_start = mkOption { type = types.enum [ "working" "standby" "maintenance" "poweroff" ]; - description = "Host status after agent startup."; + description = lib.mdDoc "Host status after agent startup."; default = "working"; }; on_stop = mkOption { type = types.enum [ "working" "standby" "maintenance" "poweroff" ]; - description = "Host status after agent shutdown."; + description = lib.mdDoc "Host status after agent shutdown."; default = "poweroff"; }; }; diff --git a/nixos/modules/services/monitoring/metricbeat.nix b/nixos/modules/services/monitoring/metricbeat.nix index e75039daa1079..0968d25c2ad2d 100644 --- a/nixos/modules/services/monitoring/metricbeat.nix +++ b/nixos/modules/services/monitoring/metricbeat.nix @@ -26,7 +26,7 @@ in default = pkgs.metricbeat; defaultText = literalExpression "pkgs.metricbeat"; example = literalExpression "pkgs.metricbeat7"; - description = '' + description = lib.mdDoc '' The metricbeat package to use ''; }; @@ -51,11 +51,11 @@ in module = mkOption { type = types.str; default = name; - description = '' + description = lib.mdDoc '' The name of the module. - Look for the value after <literal>module:</literal> on the individual - module pages linked from <link xlink:href="https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-modules.html"/>. + Look for the value after `module:` on the individual + module pages linked from <https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-modules.html>. ''; }; }; @@ -80,18 +80,18 @@ in name = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Name of the beat. Defaults to the hostname. - See <link xlink:href="https://www.elastic.co/guide/en/beats/metricbeat/current/configuration-general-options.html#_name"/>. + See <https://www.elastic.co/guide/en/beats/metricbeat/current/configuration-general-options.html#_name>. ''; }; tags = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Tags to place on the shipped metrics. - See <link xlink:href="https://www.elastic.co/guide/en/beats/metricbeat/current/configuration-general-options.html#_tags_2"/>. + See <https://www.elastic.co/guide/en/beats/metricbeat/current/configuration-general-options.html#_tags_2>. ''; }; @@ -108,8 +108,8 @@ in }; }; default = {}; - description = '' - Configuration for metricbeat. See <link xlink:href="https://www.elastic.co/guide/en/beats/metricbeat/current/configuring-howto-metricbeat.html"/> for supported values. + description = lib.mdDoc '' + Configuration for metricbeat. See <https://www.elastic.co/guide/en/beats/metricbeat/current/configuring-howto-metricbeat.html> for supported values. ''; }; diff --git a/nixos/modules/services/monitoring/mimir.nix b/nixos/modules/services/monitoring/mimir.nix index 83c0b23c59dd8..87f7af7855e15 100644 --- a/nixos/modules/services/monitoring/mimir.nix +++ b/nixos/modules/services/monitoring/mimir.nix @@ -13,7 +13,7 @@ in { configuration = mkOption { type = (pkgs.formats.json {}).type; default = {}; - description = '' + description = lib.mdDoc '' Specify the configuration for Mimir in Nix. ''; }; @@ -21,7 +21,7 @@ in { configFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Specify a configuration file that Mimir should use. ''; }; diff --git a/nixos/modules/services/monitoring/monit.nix b/nixos/modules/services/monitoring/monit.nix index 379ee967620e0..6ce5b44eb279b 100644 --- a/nixos/modules/services/monitoring/monit.nix +++ b/nixos/modules/services/monitoring/monit.nix @@ -14,7 +14,7 @@ in config = mkOption { type = types.lines; default = ""; - description = "monitrc content"; + description = lib.mdDoc "monitrc content"; }; }; diff --git a/nixos/modules/services/monitoring/munin.nix b/nixos/modules/services/monitoring/munin.nix index 4fddb1e37e2e3..c77ae7b3b6eb2 100644 --- a/nixos/modules/services/monitoring/munin.nix +++ b/nixos/modules/services/monitoring/munin.nix @@ -171,7 +171,7 @@ in extraPlugins = mkOption { default = {}; type = with types; attrsOf path; - description = '' + description = lib.mdDoc '' Additional Munin plugins to activate. Keys are the name of the plugin symlink, values are the path to the underlying plugin script. You can use the same plugin script multiple times (e.g. for wildcard @@ -179,15 +179,15 @@ in Note that these plugins do not participate in autoconfiguration. If you want to autoconfigure additional plugins, use - <option>services.munin-node.extraAutoPlugins</option>. + {option}`services.munin-node.extraAutoPlugins`. Plugins enabled in this manner take precedence over autoconfigured plugins. Plugins will be copied into the Nix store, and it will attempt to modify them to run properly by fixing hardcoded references to - <literal>/bin</literal>, <literal>/usr/bin</literal>, - <literal>/sbin</literal>, and <literal>/usr/sbin</literal>. + `/bin`, `/usr/bin`, + `/sbin`, and `/usr/sbin`. ''; example = literalExpression '' { @@ -201,24 +201,24 @@ in extraAutoPlugins = mkOption { default = []; type = with types; listOf path; - description = '' + description = lib.mdDoc '' Additional Munin plugins to autoconfigure, using - <literal>munin-node-configure --suggest</literal>. These should be + `munin-node-configure --suggest`. These should be the actual paths to the plugin files (or directories containing them), not just their names. If you want to manually enable individual plugins instead, use - <option>services.munin-node.extraPlugins</option>. + {option}`services.munin-node.extraPlugins`. Note that only plugins that have the 'autoconfig' capability will do anything if listed here, since plugins that cannot autoconfigure won't be automatically enabled by - <literal>munin-node-configure</literal>. + `munin-node-configure`. Plugins will be copied into the Nix store, and it will attempt to modify them to run properly by fixing hardcoded references to - <literal>/bin</literal>, <literal>/usr/bin</literal>, - <literal>/sbin</literal>, and <literal>/usr/sbin</literal>. + `/bin`, `/usr/bin`, + `/sbin`, and `/usr/sbin`. ''; example = literalExpression '' [ @@ -234,14 +234,14 @@ in # NaNs in the output. default = [ "munin_stats" ]; type = with types; listOf str; - description = '' + description = lib.mdDoc '' Munin plugins to disable, even if - <literal>munin-node-configure --suggest</literal> tries to enable + `munin-node-configure --suggest` tries to enable them. To disable a wildcard plugin, use an actual wildcard, as in the example. munin_stats is disabled by default as it tries to read - <literal>/var/log/munin/munin-update.log</literal> for timing + `/var/log/munin/munin-update.log` for timing information, and the NixOS build of Munin does not write this file. ''; example = [ "diskstats" "zfs_usage_*" ]; @@ -253,12 +253,12 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable munin-cron. Takes care of all heavy lifting to collect data from nodes and draws graphs to html. Runs munin-update, munin-limits, munin-graphs and munin-html in that order. - HTML output is in <filename>/var/www/munin/</filename>, configure your + HTML output is in {file}`/var/www/munin/`, configure your favourite webserver to serve static files. ''; }; @@ -296,7 +296,7 @@ in extraCSS = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Custom styling for the HTML that munin-cron generates. This will be appended to the CSS files used by munin-cron and will thus take precedence over the builtin styles. diff --git a/nixos/modules/services/monitoring/netdata.nix b/nixos/modules/services/monitoring/netdata.nix index baf869af1c428..4fd07a4ba1432 100644 --- a/nixos/modules/services/monitoring/netdata.nix +++ b/nixos/modules/services/monitoring/netdata.nix @@ -55,24 +55,24 @@ in { type = types.package; default = pkgs.netdata; defaultText = literalExpression "pkgs.netdata"; - description = "Netdata package to use."; + description = lib.mdDoc "Netdata package to use."; }; user = mkOption { type = types.str; default = "netdata"; - description = "User account under which netdata runs."; + description = lib.mdDoc "User account under which netdata runs."; }; group = mkOption { type = types.str; default = "netdata"; - description = "Group under which netdata runs."; + description = lib.mdDoc "Group under which netdata runs."; }; configText = mkOption { type = types.nullOr types.lines; - description = "Verbatim netdata.conf, cannot be combined with config."; + description = lib.mdDoc "Verbatim netdata.conf, cannot be combined with config."; default = null; example = '' [global] @@ -86,7 +86,7 @@ in { enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable python-based plugins ''; }; @@ -101,7 +101,7 @@ in { ps.dnspython ] ''; - description = '' + description = lib.mdDoc '' Extra python packages available at runtime to enable additional python plugins. ''; @@ -129,7 +129,7 @@ in { config = mkOption { type = types.attrsOf types.attrs; default = {}; - description = "netdata.conf configuration as nix attributes. cannot be combined with configText."; + description = lib.mdDoc "netdata.conf configuration as nix attributes. cannot be combined with configText."; example = literalExpression '' global = { "debug log" = "syslog"; @@ -142,7 +142,7 @@ in { configDir = mkOption { type = types.attrsOf types.path; default = {}; - description = '' + description = lib.mdDoc '' Complete netdata config directory except netdata.conf. The default configuration is merged with changes defined in this option. @@ -162,11 +162,11 @@ in { enableAnalyticsReporting = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable reporting of anonymous usage statistics to Netdata Inc. via either Google Analytics (in versions prior to 1.29.4), or Netdata Inc.'s self-hosted PostHog (in versions 1.29.4 and later). - See: <link xlink:href="https://learn.netdata.cloud/docs/agent/anonymous-statistics"/> + See: <https://learn.netdata.cloud/docs/agent/anonymous-statistics> ''; }; }; diff --git a/nixos/modules/services/monitoring/parsedmarc.nix b/nixos/modules/services/monitoring/parsedmarc.nix index efc7f69be7d64..736718c25359c 100644 --- a/nixos/modules/services/monitoring/parsedmarc.nix +++ b/nixos/modules/services/monitoring/parsedmarc.nix @@ -40,7 +40,7 @@ in recipientName = lib.mkOption { type = lib.types.str; default = "dmarc"; - description = '' + description = lib.mdDoc '' The DMARC mail recipient name, i.e. the name part of the email address which receives DMARC reports. @@ -54,7 +54,7 @@ in default = config.networking.fqdn; defaultText = lib.literalExpression "config.networking.fqdn"; example = "monitoring.example.com"; - description = '' + description = lib.mdDoc '' The hostname to use when configuring Postfix. Should correspond to the host's fully qualified domain @@ -84,7 +84,7 @@ in elasticsearch = lib.mkOption { type = lib.types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to set up and use a local instance of Elasticsearch. ''; }; @@ -110,7 +110,7 @@ in type = lib.types.bool; default = config.services.grafana.enable; defaultText = lib.literalExpression "config.services.grafana.enable"; - description = '' + description = lib.mdDoc '' Whether the official parsedmarc grafana dashboard should be provisioned to the local grafana instance. ''; @@ -134,20 +134,20 @@ in }; } ''; - description = '' + description = lib.mdDoc '' Configuration parameters to set in - <filename>parsedmarc.ini</filename>. For a full list of + {file}`parsedmarc.ini`. For a full list of available parameters, see - <link xlink:href="https://domainaware.github.io/parsedmarc/#configuration-file" />. + <https://domainaware.github.io/parsedmarc/#configuration-file>. Settings containing secret data should be set to an attribute - set containing the attribute <literal>_secret</literal> - a + set containing the attribute `_secret` - a string pointing to a file containing the value the option should be set to. See the example to get a better picture of - this: in the resulting <filename>parsedmarc.ini</filename> - file, the <literal>splunk_hec.token</literal> key will be set + this: in the resulting {file}`parsedmarc.ini` + file, the `splunk_hec.token` key will be set to the contents of the - <filename>/run/keys/splunk_token</filename> file. + {file}`/run/keys/splunk_token` file. ''; type = lib.types.submodule { @@ -158,7 +158,7 @@ in save_aggregate = lib.mkOption { type = lib.types.bool; default = true; - description = '' + description = lib.mdDoc '' Save aggregate report data to Elasticsearch and/or Splunk. ''; }; @@ -166,7 +166,7 @@ in save_forensic = lib.mkOption { type = lib.types.bool; default = true; - description = '' + description = lib.mdDoc '' Save forensic report data to Elasticsearch and/or Splunk. ''; }; @@ -176,7 +176,7 @@ in host = lib.mkOption { type = lib.types.str; default = "localhost"; - description = '' + description = lib.mdDoc '' The IMAP server hostname or IP address. ''; }; @@ -184,7 +184,7 @@ in port = lib.mkOption { type = lib.types.port; default = 993; - description = '' + description = lib.mdDoc '' The IMAP server port. ''; }; @@ -192,7 +192,7 @@ in ssl = lib.mkOption { type = lib.types.bool; default = true; - description = '' + description = lib.mdDoc '' Use an encrypted SSL/TLS connection. ''; }; @@ -200,7 +200,7 @@ in user = lib.mkOption { type = with lib.types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' The IMAP server username. ''; }; @@ -223,7 +223,7 @@ in watch = lib.mkOption { type = lib.types.bool; default = true; - description = '' + description = lib.mdDoc '' Use the IMAP IDLE command to process messages as they arrive. ''; }; @@ -231,7 +231,7 @@ in delete = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Delete messages after processing them, instead of archiving them. ''; }; @@ -241,7 +241,7 @@ in host = lib.mkOption { type = with lib.types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' The SMTP server hostname or IP address. ''; }; @@ -249,7 +249,7 @@ in port = lib.mkOption { type = with lib.types; nullOr port; default = null; - description = '' + description = lib.mdDoc '' The SMTP server port. ''; }; @@ -257,7 +257,7 @@ in ssl = lib.mkOption { type = with lib.types; nullOr bool; default = null; - description = '' + description = lib.mdDoc '' Use an encrypted SSL/TLS connection. ''; }; @@ -265,7 +265,7 @@ in user = lib.mkOption { type = with lib.types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' The SMTP server username. ''; }; @@ -288,8 +288,8 @@ in from = lib.mkOption { type = with lib.types; nullOr str; default = null; - description = '' - The <literal>From</literal> address to use for the + description = lib.mdDoc '' + The `From` address to use for the outgoing mail. ''; }; @@ -297,7 +297,7 @@ in to = lib.mkOption { type = with lib.types; nullOr (listOf str); default = null; - description = '' + description = lib.mdDoc '' The addresses to send outgoing mail to. ''; }; @@ -308,7 +308,7 @@ in default = []; type = with lib.types; listOf str; apply = x: if x == [] then null else lib.concatStringsSep "," x; - description = '' + description = lib.mdDoc '' A list of Elasticsearch hosts to push parsed reports to. ''; @@ -317,7 +317,7 @@ in user = lib.mkOption { type = with lib.types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Username to use when connecting to Elasticsearch, if required. ''; @@ -342,7 +342,7 @@ in ssl = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to use an encrypted SSL/TLS connection. ''; }; @@ -350,7 +350,7 @@ in cert_path = lib.mkOption { type = lib.types.path; default = "/etc/ssl/certs/ca-certificates.crt"; - description = '' + description = lib.mdDoc '' The path to a TLS certificate bundle used to verify the server's certificate. ''; diff --git a/nixos/modules/services/monitoring/prometheus/alertmanager.nix b/nixos/modules/services/monitoring/prometheus/alertmanager.nix index 1f396634ae015..60e0523cc3535 100644 --- a/nixos/modules/services/monitoring/prometheus/alertmanager.nix +++ b/nixos/modules/services/monitoring/prometheus/alertmanager.nix @@ -46,7 +46,7 @@ in { type = types.package; default = pkgs.prometheus-alertmanager; defaultText = literalExpression "pkgs.alertmanager"; - description = '' + description = lib.mdDoc '' Package that should be used for alertmanager. ''; }; @@ -54,7 +54,7 @@ in { configuration = mkOption { type = types.nullOr types.attrs; default = null; - description = '' + description = lib.mdDoc '' Alertmanager configuration as nix attribute set. ''; }; @@ -62,7 +62,7 @@ in { configText = mkOption { type = types.nullOr types.lines; default = null; - description = '' + description = lib.mdDoc '' Alertmanager configuration as YAML text. If non-null, this option defines the text that is written to alertmanager.yml. If null, the contents of alertmanager.yml is generated from the structured config @@ -73,7 +73,7 @@ in { logFormat = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' If set use a syslog logger or JSON logging. ''; }; @@ -81,7 +81,7 @@ in { logLevel = mkOption { type = types.enum ["debug" "info" "warn" "error" "fatal"]; default = "warn"; - description = '' + description = lib.mdDoc '' Only log messages with the given severity or above. ''; }; @@ -89,7 +89,7 @@ in { webExternalUrl = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The URL under which Alertmanager is externally reachable (for example, if Alertmanager is served via a reverse proxy). Used for generating relative and absolute links back to Alertmanager itself. If the URL has a path portion, it will be used to prefix all HTTP endoints served by Alertmanager. @@ -100,7 +100,7 @@ in { listenAddress = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Address to listen on for the web interface and API. Empty string will listen on all interfaces. "localhost" will listen on 127.0.0.1 (but not ::1). ''; @@ -109,7 +109,7 @@ in { port = mkOption { type = types.int; default = 9093; - description = '' + description = lib.mdDoc '' Port to listen on for the web interface and API. ''; }; @@ -117,7 +117,7 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open port in firewall for incoming connections. ''; }; @@ -125,7 +125,7 @@ in { clusterPeers = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Initial peers for HA cluster. ''; }; @@ -133,7 +133,7 @@ in { extraFlags = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Extra commandline options when launching the Alertmanager. ''; }; @@ -142,11 +142,11 @@ in { type = types.nullOr types.path; default = null; example = "/root/alertmanager.env"; - description = '' + description = lib.mdDoc '' File to load as environment file. Environment variables from this file will be interpolated into the config file using envsubst with this syntax: - <literal>$ENVIRONMENT ''${VARIABLE}</literal> + `$ENVIRONMENT ''${VARIABLE}` ''; }; }; diff --git a/nixos/modules/services/monitoring/prometheus/default.nix b/nixos/modules/services/monitoring/prometheus/default.nix index 41848c1c6d3a7..db4286b66a5d3 100644 --- a/nixos/modules/services/monitoring/prometheus/default.nix +++ b/nixos/modules/services/monitoring/prometheus/default.nix @@ -184,7 +184,7 @@ let options = { username = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' HTTP username ''; }; @@ -257,7 +257,7 @@ let }; job_name = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The job name assigned to scraped metrics by default. ''; }; @@ -513,7 +513,7 @@ let subscription_id = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The subscription ID. ''; }; @@ -618,7 +618,7 @@ let mkDockerSdConfigModule = extraOptions: mkSdConfigModule ({ host = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Address of the Docker daemon. ''; }; @@ -675,7 +675,7 @@ let options = { names = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' A list of DNS SRV record names to be queried. ''; }; @@ -698,7 +698,7 @@ let options = { region = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The AWS Region. If blank, the region from the instance metadata is used. ''; }; @@ -762,7 +762,7 @@ let promTypes.eureka_sd_config = mkSdConfigModule { server = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The URL to connect to the Eureka server. ''; }; @@ -772,7 +772,7 @@ let options = { files = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Patterns for files from which target groups are extracted. Refer to the Prometheus documentation for permitted filename patterns and formats. @@ -791,14 +791,14 @@ let # required configuration values for `gce_sd_config`. project = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The GCP Project. ''; }; zone = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The zone of the scrape targets. If you need multiple zones use multiple gce_sd_configs. ''; @@ -833,9 +833,9 @@ let promTypes.hetzner_sd_config = mkSdConfigModule { role = mkOption { type = types.enum [ "robot" "hcloud" ]; - description = '' + description = lib.mdDoc '' The Hetzner role of entities that should be discovered. - One of <literal>robot</literal> or <literal>hcloud</literal>. + One of `robot` or `hcloud`. ''; }; @@ -852,7 +852,7 @@ let options = { url = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' URL from which the targets are fetched. ''; }; @@ -889,7 +889,7 @@ let role = mkOption { type = types.enum [ "endpoints" "service" "pod" "node" "ingress" ]; - description = '' + description = lib.mdDoc '' The Kubernetes role of entities that should be discovered. One of endpoints, service, pod, node, or ingress. ''; @@ -954,7 +954,7 @@ let promTypes.kuma_sd_config = mkSdConfigModule { server = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Address of the Kuma Control Plane's MADS xDS server. ''; }; @@ -1022,7 +1022,7 @@ let promTypes.marathon_sd_config = mkSdConfigModule { servers = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' List of URLs to be used to contact Marathon servers. You need to provide at least one server URL. ''; }; @@ -1048,14 +1048,14 @@ let options = { servers = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' The Zookeeper servers. ''; }; paths = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Paths can point to a single service, or the root of a tree of services. ''; }; @@ -1097,14 +1097,14 @@ let { role = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The OpenStack role of entities that should be discovered. ''; }; region = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The OpenStack Region. ''; }; @@ -1165,14 +1165,14 @@ let promTypes.puppetdb_sd_config = mkSdConfigModule { url = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The URL of the PuppetDB root query endpoint. ''; }; query = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Puppet Query Language (PQL) query. Only resources are supported. https://puppet.com/docs/puppetdb/latest/api/query/v4/pql.html ''; @@ -1201,7 +1201,7 @@ let options = { access_key = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Access key to use. https://console.scaleway.com/project/credentials ''; }; @@ -1218,7 +1218,7 @@ let project_id = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Project ID of the targets. ''; }; @@ -1275,7 +1275,7 @@ let options = { account = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The account to use for discovering new targets. ''; }; @@ -1288,15 +1288,15 @@ let dns_suffix = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The DNS suffix which should be applied to target. ''; }; endpoint = mkOption { type = types.str; - description = '' - The Triton discovery endpoint (e.g. <literal>cmon.us-east-3b.triton.zone</literal>). This is + description = lib.mdDoc '' + The Triton discovery endpoint (e.g. `cmon.us-east-3b.triton.zone`). This is often the same value as dns_suffix. ''; }; @@ -1327,21 +1327,21 @@ let promTypes.uyuni_sd_config = mkSdConfigModule { server = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The URL to connect to the Uyuni server. ''; }; username = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Credentials are used to authenticate the requests to Uyuni API. ''; }; password = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Credentials are used to authenticate the requests to Uyuni API. ''; }; @@ -1363,14 +1363,14 @@ let options = { targets = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' The targets specified by the target group. ''; }; labels = mkOption { type = types.attrsOf types.str; default = { }; - description = '' + description = lib.mdDoc '' Labels assigned to all metrics scraped from the targets. ''; }; @@ -1426,7 +1426,7 @@ let options = { url = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' ServerName extension to indicate the name of the server. http://tools.ietf.org/html/rfc4366#section-3.1 ''; @@ -1512,7 +1512,7 @@ let options = { url = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' ServerName extension to indicate the name of the server. http://tools.ietf.org/html/rfc4366#section-3.1 ''; @@ -1569,7 +1569,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the Prometheus monitoring daemon. ''; }; @@ -1578,7 +1578,7 @@ in type = types.package; default = pkgs.prometheus; defaultText = literalExpression "pkgs.prometheus"; - description = '' + description = lib.mdDoc '' The prometheus package that should be used. ''; }; @@ -1586,7 +1586,7 @@ in port = mkOption { type = types.port; default = 9090; - description = '' + description = lib.mdDoc '' Port to listen on. ''; }; @@ -1594,7 +1594,7 @@ in listenAddress = mkOption { type = types.str; default = "0.0.0.0"; - description = '' + description = lib.mdDoc '' Address to listen on for the web interface, API, and telemetry. ''; }; @@ -1602,8 +1602,8 @@ in stateDir = mkOption { type = types.str; default = "prometheus2"; - description = '' - Directory below <literal>/var/lib</literal> to store Prometheus metrics data. + description = lib.mdDoc '' + Directory below `/var/lib` to store Prometheus metrics data. This directory will be created automatically using systemd's StateDirectory mechanism. ''; }; @@ -1611,7 +1611,7 @@ in extraFlags = mkOption { type = types.listOf types.str; default = [ ]; - description = '' + description = lib.mdDoc '' Extra commandline options when launching Prometheus. ''; }; @@ -1619,11 +1619,11 @@ in enableReload = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Reload prometheus when configuration file changes (instead of restart). The following property holds: switching to a configuration - (<literal>switch-to-configuration</literal>) that changes the prometheus + (`switch-to-configuration`) that changes the prometheus configuration only finishes successully when prometheus has finished loading the new configuration. ''; @@ -1632,7 +1632,7 @@ in configText = mkOption { type = types.nullOr types.lines; default = null; - description = '' + description = lib.mdDoc '' If non-null, this option defines the text that is written to prometheus.yml. If null, the contents of prometheus.yml is generated from the structured config options. @@ -1642,7 +1642,7 @@ in globalConfig = mkOption { type = promTypes.globalConfig; default = { }; - description = '' + description = lib.mdDoc '' Parameters that are valid in all configuration contexts. They also serve as defaults for other configuration sections ''; @@ -1651,25 +1651,25 @@ in remoteRead = mkOption { type = types.listOf promTypes.remote_read; default = [ ]; - description = '' + description = lib.mdDoc '' Parameters of the endpoints to query from. - See <link xlink:href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_read">the official documentation</link> for more information. + See [the official documentation](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_read) for more information. ''; }; remoteWrite = mkOption { type = types.listOf promTypes.remote_write; default = [ ]; - description = '' + description = lib.mdDoc '' Parameters of the endpoints to send samples to. - See <link xlink:href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write">the official documentation</link> for more information. + See [the official documentation](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write) for more information. ''; }; rules = mkOption { type = types.listOf types.str; default = [ ]; - description = '' + description = lib.mdDoc '' Alerting and/or Recording rules to evaluate at runtime. ''; }; @@ -1677,7 +1677,7 @@ in ruleFiles = mkOption { type = types.listOf types.path; default = [ ]; - description = '' + description = lib.mdDoc '' Any additional rules files to include in this configuration. ''; }; @@ -1685,7 +1685,7 @@ in scrapeConfigs = mkOption { type = types.listOf promTypes.scrape_config; default = [ ]; - description = '' + description = lib.mdDoc '' A list of scrape configurations. ''; }; @@ -1704,16 +1704,16 @@ in } ] ''; default = [ ]; - description = '' + description = lib.mdDoc '' A list of alertmanagers to send alerts to. - See <link xlink:href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config">the official documentation</link> for more information. + See [the official documentation](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config) for more information. ''; }; alertmanagerNotificationQueueCapacity = mkOption { type = types.int; default = 10000; - description = '' + description = lib.mdDoc '' The capacity of the queue for pending alert manager notifications. ''; }; @@ -1722,7 +1722,7 @@ in type = types.nullOr types.str; default = null; example = "https://example.com/"; - description = '' + description = lib.mdDoc '' The URL under which Prometheus is externally reachable (for example, if Prometheus is served via a reverse proxy). ''; @@ -1750,7 +1750,7 @@ in type = types.nullOr types.str; default = null; example = "15d"; - description = '' + description = lib.mdDoc '' How long to retain samples in storage. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/pushgateway.nix b/nixos/modules/services/monitoring/prometheus/pushgateway.nix index 01b9937624367..ac7a2300f67cb 100644 --- a/nixos/modules/services/monitoring/prometheus/pushgateway.nix +++ b/nixos/modules/services/monitoring/prometheus/pushgateway.nix @@ -27,7 +27,7 @@ in { type = types.package; default = pkgs.prometheus-pushgateway; defaultText = literalExpression "pkgs.prometheus-pushgateway"; - description = '' + description = lib.mdDoc '' Package that should be used for the prometheus pushgateway. ''; }; @@ -35,27 +35,27 @@ in { web.listen-address = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Address to listen on for the web interface, API and telemetry. - <literal>null</literal> will default to <literal>:9091</literal>. + `null` will default to `:9091`. ''; }; web.telemetry-path = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Path under which to expose metrics. - <literal>null</literal> will default to <literal>/metrics</literal>. + `null` will default to `/metrics`. ''; }; web.external-url = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The URL under which Pushgateway is externally reachable. ''; }; @@ -63,11 +63,11 @@ in { web.route-prefix = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Prefix for the internal routes of web endpoints. Defaults to the path of - <option>services.prometheus.pushgateway.web.external-url</option>. + {option}`services.prometheus.pushgateway.web.external-url`. ''; }; @@ -75,20 +75,20 @@ in { type = types.nullOr types.str; default = null; example = "10m"; - description = '' + description = lib.mdDoc '' The minimum interval at which to write out the persistence file. - <literal>null</literal> will default to <literal>5m</literal>. + `null` will default to `5m`. ''; }; log.level = mkOption { type = types.nullOr (types.enum ["debug" "info" "warn" "error" "fatal"]); default = null; - description = '' + description = lib.mdDoc '' Only log messages with the given severity or above. - <literal>null</literal> will default to <literal>info</literal>. + `null` will default to `info`. ''; }; @@ -96,17 +96,17 @@ in { type = types.nullOr types.str; default = null; example = "logger:syslog?appname=bob&local=7"; - description = '' + description = lib.mdDoc '' Set the log target and format. - <literal>null</literal> will default to <literal>logger:stderr</literal>. + `null` will default to `logger:stderr`. ''; }; extraFlags = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Extra commandline options when launching the Pushgateway. ''; }; @@ -114,26 +114,26 @@ in { persistMetrics = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to persist metrics to a file. When enabled metrics will be saved to a file called - <literal>metrics</literal> in the directory - <literal>/var/lib/pushgateway</literal>. The directory below - <literal>/var/lib</literal> can be set using - <option>services.prometheus.pushgateway.stateDir</option>. + `metrics` in the directory + `/var/lib/pushgateway`. The directory below + `/var/lib` can be set using + {option}`services.prometheus.pushgateway.stateDir`. ''; }; stateDir = mkOption { type = types.str; default = "pushgateway"; - description = '' - Directory below <literal>/var/lib</literal> to store metrics. + description = lib.mdDoc '' + Directory below `/var/lib` to store metrics. This directory will be created automatically using systemd's StateDirectory mechanism when - <option>services.prometheus.pushgateway.persistMetrics</option> + {option}`services.prometheus.pushgateway.persistMetrics` is enabled. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/xmpp-alerts.nix b/nixos/modules/services/monitoring/prometheus/xmpp-alerts.nix index 980c93c9c4788..1d7da7ced3fef 100644 --- a/nixos/modules/services/monitoring/prometheus/xmpp-alerts.nix +++ b/nixos/modules/services/monitoring/prometheus/xmpp-alerts.nix @@ -21,9 +21,9 @@ in type = settingsFormat.type; default = {}; - description = '' + description = lib.mdDoc '' Configuration for prometheus xmpp-alerts, see - <link xlink:href="https://github.com/jelmer/prometheus-xmpp-alerts/blob/master/xmpp-alerts.yml.example"/> + <https://github.com/jelmer/prometheus-xmpp-alerts/blob/master/xmpp-alerts.yml.example> for supported values. ''; }; diff --git a/nixos/modules/services/monitoring/riemann-dash.nix b/nixos/modules/services/monitoring/riemann-dash.nix index 16eb83008509a..1ca8af14e7772 100644 --- a/nixos/modules/services/monitoring/riemann-dash.nix +++ b/nixos/modules/services/monitoring/riemann-dash.nix @@ -26,20 +26,20 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the riemann-dash dashboard daemon. ''; }; config = mkOption { type = types.lines; - description = '' + description = lib.mdDoc '' Contents added to the end of the riemann-dash configuration file. ''; }; dataDir = mkOption { type = types.str; default = "/var/riemann-dash"; - description = '' + description = lib.mdDoc '' Location of the riemann-base dir. The dashboard configuration file is is stored to this directory. The directory is created automatically on service start, and owner is set to the riemanndash user. diff --git a/nixos/modules/services/monitoring/riemann-tools.nix b/nixos/modules/services/monitoring/riemann-tools.nix index 86a11694e7b49..b5cd79c743013 100644 --- a/nixos/modules/services/monitoring/riemann-tools.nix +++ b/nixos/modules/services/monitoring/riemann-tools.nix @@ -23,14 +23,14 @@ in { enableHealth = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the riemann-health daemon. ''; }; riemannHost = mkOption { type = types.str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' Address of the host riemann node. Defaults to localhost. ''; }; diff --git a/nixos/modules/services/monitoring/riemann.nix b/nixos/modules/services/monitoring/riemann.nix index 13d2b1cc06027..8d61ec2a308ff 100644 --- a/nixos/modules/services/monitoring/riemann.nix +++ b/nixos/modules/services/monitoring/riemann.nix @@ -30,13 +30,13 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the Riemann network monitoring daemon. ''; }; config = mkOption { type = types.lines; - description = '' + description = lib.mdDoc '' Contents of the Riemann configuration file. For more complicated config you should use configFile. ''; @@ -44,17 +44,17 @@ in { configFiles = mkOption { type = with types; listOf path; default = []; - description = '' + description = lib.mdDoc '' Extra files containing Riemann configuration. These files will be loaded at runtime by Riemann (with Clojure's - <literal>load-file</literal> function) at the end of the + `load-file` function) at the end of the configuration if you use the config option, this is ignored if you use configFile. ''; }; configFile = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' A Riemann config file. Any files in the same directory as this file will be added to the classpath by Riemann. ''; @@ -62,14 +62,14 @@ in { extraClasspathEntries = mkOption { type = with types; listOf str; default = []; - description = '' + description = lib.mdDoc '' Extra entries added to the Java classpath when running Riemann. ''; }; extraJavaOpts = mkOption { type = with types; listOf str; default = []; - description = '' + description = lib.mdDoc '' Extra Java options used when launching Riemann. ''; }; diff --git a/nixos/modules/services/monitoring/scollector.nix b/nixos/modules/services/monitoring/scollector.nix index 6a6fe110f9407..48be309c95996 100644 --- a/nixos/modules/services/monitoring/scollector.nix +++ b/nixos/modules/services/monitoring/scollector.nix @@ -35,7 +35,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to run scollector. ''; }; @@ -44,7 +44,7 @@ in { type = types.package; default = pkgs.scollector; defaultText = literalExpression "pkgs.scollector"; - description = '' + description = lib.mdDoc '' scollector binary to use. ''; }; @@ -52,7 +52,7 @@ in { user = mkOption { type = types.str; default = "scollector"; - description = '' + description = lib.mdDoc '' User account under which scollector runs. ''; }; @@ -60,7 +60,7 @@ in { group = mkOption { type = types.str; default = "scollector"; - description = '' + description = lib.mdDoc '' Group account under which scollector runs. ''; }; @@ -68,7 +68,7 @@ in { bosunHost = mkOption { type = types.str; default = "localhost:8070"; - description = '' + description = lib.mdDoc '' Host and port of the bosun server that will store the collected data. ''; @@ -78,7 +78,7 @@ in { type = with types; attrsOf (listOf path); default = {}; example = literalExpression ''{ "0" = [ "''${postgresStats}/bin/collect-stats" ]; }''; - description = '' + description = lib.mdDoc '' An attribute set mapping the frequency of collection to a list of binaries that should be executed at that frequency. You can use "0" to run a binary forever. @@ -89,7 +89,7 @@ in { type = with types; listOf str; default = []; example = [ "-d" ]; - description = '' + description = lib.mdDoc '' Extra scollector command line options ''; }; @@ -97,7 +97,7 @@ in { extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra scollector configuration added to the end of scollector.toml ''; }; diff --git a/nixos/modules/services/monitoring/smartd.nix b/nixos/modules/services/monitoring/smartd.nix index 6d39cc3e4e6bb..83791631d2cac 100644 --- a/nixos/modules/services/monitoring/smartd.nix +++ b/nixos/modules/services/monitoring/smartd.nix @@ -72,14 +72,14 @@ let device = mkOption { example = "/dev/sda"; type = types.str; - description = "Location of the device."; + description = lib.mdDoc "Location of the device."; }; options = mkOption { default = ""; example = "-d sat"; type = types.separatedString " "; - description = "Options that determine how smartd monitors the device."; + description = lib.mdDoc "Options that determine how smartd monitors the device."; }; }; @@ -100,12 +100,12 @@ in autodetect = mkOption { default = true; type = types.bool; - description = '' + description = lib.mdDoc '' Whenever smartd should monitor all devices connected to the machine at the time it's being started (the default). Set to false to monitor the devices listed in - <option>services.smartd.devices</option> only. + {option}`services.smartd.devices` only. ''; }; @@ -113,11 +113,11 @@ in default = []; type = types.listOf types.str; example = ["-A /var/log/smartd/" "--interval=3600"]; - description = '' - Extra command-line options passed to the <literal>smartd</literal> + description = lib.mdDoc '' + Extra command-line options passed to the `smartd` daemon on startup. - (See <literal>man 8 smartd</literal>.) + (See `man 8 smartd`.) ''; }; @@ -128,7 +128,7 @@ in default = config.services.mail.sendmailSetuidWrapper != null; defaultText = literalExpression "config.services.mail.sendmailSetuidWrapper != null"; type = types.bool; - description = "Whenever to send e-mail notifications."; + description = lib.mdDoc "Whenever to send e-mail notifications."; }; sender = mkOption { @@ -144,17 +144,17 @@ in recipient = mkOption { default = "root"; type = types.str; - description = "Recipient of the notification messages."; + description = lib.mdDoc "Recipient of the notification messages."; }; mailer = mkOption { default = "/run/wrappers/bin/sendmail"; type = types.path; - description = '' + description = lib.mdDoc '' Sendmail-compatible binary to be used to send the messages. You should probably enable - <option>services.postfix</option> or some other MTA for + {option}`services.postfix` or some other MTA for this to work. ''; }; @@ -164,7 +164,7 @@ in enable = mkOption { default = true; type = types.bool; - description = "Whenever to send wall notifications to all users."; + description = lib.mdDoc "Whenever to send wall notifications to all users."; }; }; @@ -173,21 +173,21 @@ in default = config.services.xserver.enable; defaultText = literalExpression "config.services.xserver.enable"; type = types.bool; - description = "Whenever to send X11 xmessage notifications."; + description = lib.mdDoc "Whenever to send X11 xmessage notifications."; }; display = mkOption { default = ":${toString config.services.xserver.display}"; defaultText = literalExpression ''":''${toString config.services.xserver.display}"''; type = types.str; - description = "DISPLAY to send X11 notifications to."; + description = lib.mdDoc "DISPLAY to send X11 notifications to."; }; }; test = mkOption { default = false; type = types.bool; - description = "Whenever to send a test notification on startup."; + description = lib.mdDoc "Whenever to send a test notification on startup."; }; }; @@ -197,12 +197,12 @@ in default = "-a"; type = types.separatedString " "; example = "-a -o on -s (S/../.././02|L/../../7/04)"; - description = '' + description = lib.mdDoc '' Common default options for explicitly monitored (listed in - <option>services.smartd.devices</option>) devices. + {option}`services.smartd.devices`) devices. The default value turns on monitoring of all the things (see - <literal>man 5 smartd.conf</literal>). + `man 5 smartd.conf`). The example also turns on SMART Automatic Offline Testing on startup, and schedules short self-tests daily, and long @@ -214,8 +214,8 @@ in default = cfg.defaults.monitored; defaultText = literalExpression "config.${opt.defaults.monitored}"; type = types.separatedString " "; - description = '' - Like <option>services.smartd.defaults.monitored</option>, but for the + description = lib.mdDoc '' + Like {option}`services.smartd.defaults.monitored`, but for the autodetected devices. ''; }; @@ -225,7 +225,7 @@ in default = []; example = [ { device = "/dev/sda"; } { device = "/dev/sdb"; options = "-d sat"; } ]; type = with types; listOf (submodule smartdDeviceOpts); - description = "List of devices to monitor."; + description = lib.mdDoc "List of devices to monitor."; }; }; diff --git a/nixos/modules/services/monitoring/statsd.nix b/nixos/modules/services/monitoring/statsd.nix index 30b2916a99285..d109e0826204d 100644 --- a/nixos/modules/services/monitoring/statsd.nix +++ b/nixos/modules/services/monitoring/statsd.nix @@ -59,31 +59,31 @@ in enable = mkEnableOption "statsd"; listenAddress = mkOption { - description = "Address that statsd listens on over UDP"; + description = lib.mdDoc "Address that statsd listens on over UDP"; default = "127.0.0.1"; type = types.str; }; port = mkOption { - description = "Port that stats listens for messages on over UDP"; + description = lib.mdDoc "Port that stats listens for messages on over UDP"; default = 8125; type = types.int; }; mgmt_address = mkOption { - description = "Address to run management TCP interface on"; + description = lib.mdDoc "Address to run management TCP interface on"; default = "127.0.0.1"; type = types.str; }; mgmt_port = mkOption { - description = "Port to run the management TCP interface on"; + description = lib.mdDoc "Port to run the management TCP interface on"; default = 8126; type = types.int; }; backends = mkOption { - description = "List of backends statsd will use for data persistence"; + description = lib.mdDoc "List of backends statsd will use for data persistence"; default = []; example = [ "graphite" @@ -97,19 +97,19 @@ in }; graphiteHost = mkOption { - description = "Hostname or IP of Graphite server"; + description = lib.mdDoc "Hostname or IP of Graphite server"; default = null; type = types.nullOr types.str; }; graphitePort = mkOption { - description = "Port of Graphite server (i.e. carbon-cache)."; + description = lib.mdDoc "Port of Graphite server (i.e. carbon-cache)."; default = null; type = types.nullOr types.int; }; extraConfig = mkOption { - description = "Extra configuration options for statsd"; + description = lib.mdDoc "Extra configuration options for statsd"; default = ""; type = types.nullOr types.str; }; diff --git a/nixos/modules/services/monitoring/sysstat.nix b/nixos/modules/services/monitoring/sysstat.nix index ca2cff8272320..f8621f08bb8cf 100644 --- a/nixos/modules/services/monitoring/sysstat.nix +++ b/nixos/modules/services/monitoring/sysstat.nix @@ -10,7 +10,7 @@ in { collect-frequency = mkOption { type = types.str; default = "*:00/10"; - description = '' + description = lib.mdDoc '' OnCalendar specification for sysstat-collect ''; }; @@ -18,7 +18,7 @@ in { collect-args = mkOption { type = types.str; default = "1 1"; - description = '' + description = lib.mdDoc '' Arguments to pass sa1 when collecting statistics ''; }; diff --git a/nixos/modules/services/monitoring/telegraf.nix b/nixos/modules/services/monitoring/telegraf.nix index 13aae58d0f37d..d228b5cc2d0a2 100644 --- a/nixos/modules/services/monitoring/telegraf.nix +++ b/nixos/modules/services/monitoring/telegraf.nix @@ -16,7 +16,7 @@ in { package = mkOption { default = pkgs.telegraf; defaultText = literalExpression "pkgs.telegraf"; - description = "Which telegraf derivation to use"; + description = lib.mdDoc "Which telegraf derivation to use"; type = types.package; }; @@ -24,17 +24,17 @@ in { type = types.listOf types.path; default = []; example = [ "/run/keys/telegraf.env" ]; - description = '' + description = lib.mdDoc '' File to load as environment file. Environment variables from this file will be interpolated into the config file using envsubst with this - syntax: <literal>$ENVIRONMENT</literal> or <literal>''${VARIABLE}</literal>. + syntax: `$ENVIRONMENT` or `''${VARIABLE}`. This is useful to avoid putting secrets into the nix store. ''; }; extraConfig = mkOption { default = {}; - description = "Extra configuration options for telegraf"; + description = lib.mdDoc "Extra configuration options for telegraf"; type = settingsFormat.type; example = { outputs.influxdb = { diff --git a/nixos/modules/services/monitoring/thanos.nix b/nixos/modules/services/monitoring/thanos.nix index 9e93d8dbb0efd..c7404241fbf5a 100644 --- a/nixos/modules/services/monitoring/thanos.nix +++ b/nixos/modules/services/monitoring/thanos.nix @@ -86,11 +86,11 @@ let defaultText = literalDocBook '' calculated from <literal>config.services.thanos.${cmd}</literal> ''; - description = '' - Arguments to the <literal>thanos ${cmd}</literal> command. + description = lib.mdDoc '' + Arguments to the `thanos ${cmd}` command. Defaults to a list of arguments formed by converting the structured - options of <option>services.thanos.${cmd}</option> to a list of arguments. + options of {option}`services.thanos.${cmd}` to a list of arguments. Overriding this option will cause none of the structured options to have any effect. So only set this if you know what you're doing! @@ -127,10 +127,10 @@ let if config.services.thanos.<cmd>.tracing.config == null then null else toString (toYAML "tracing.yaml" config.services.thanos.<cmd>.tracing.config); ''; - description = '' + description = lib.mdDoc '' Path to YAML file that contains tracing configuration. - See format details: <link xlink:href="https://thanos.io/tracing.md/#configuration"/> + See format details: <https://thanos.io/tracing.md/#configuration> ''; }; }; @@ -192,10 +192,10 @@ let if config.services.thanos.<cmd>.objstore.config == null then null else toString (toYAML "objstore.yaml" config.services.thanos.<cmd>.objstore.config); ''; - description = '' + description = lib.mdDoc '' Path to YAML file that contains object store configuration. - See format details: <link xlink:href="https://thanos.io/storage.md/#configuration"/> + See format details: <https://thanos.io/storage.md/#configuration> ''; }; }; @@ -231,7 +231,7 @@ let type = types.str; default = "/var/lib/${config.services.prometheus.stateDir}/data"; defaultText = literalExpression ''"/var/lib/''${config.services.prometheus.stateDir}/data"''; - description = '' + description = lib.mdDoc '' Data directory of TSDB. ''; }; @@ -660,7 +660,7 @@ in { type = types.package; default = pkgs.thanos; defaultText = literalExpression "pkgs.thanos"; - description = '' + description = lib.mdDoc '' The thanos package that should be used. ''; }; diff --git a/nixos/modules/services/monitoring/tuptime.nix b/nixos/modules/services/monitoring/tuptime.nix index de80282559aeb..ffe24c0ef0be8 100644 --- a/nixos/modules/services/monitoring/tuptime.nix +++ b/nixos/modules/services/monitoring/tuptime.nix @@ -16,13 +16,13 @@ in { enable = mkOption { type = types.bool; default = true; - description = "Whether to regularly log uptime to detect bad shutdowns."; + description = lib.mdDoc "Whether to regularly log uptime to detect bad shutdowns."; }; period = mkOption { type = types.str; default = "*:0/5"; - description = "systemd calendar event"; + description = lib.mdDoc "systemd calendar event"; }; }; }; diff --git a/nixos/modules/services/monitoring/unifi-poller.nix b/nixos/modules/services/monitoring/unifi-poller.nix index cca4a0e720714..a955bf4907fc4 100644 --- a/nixos/modules/services/monitoring/unifi-poller.nix +++ b/nixos/modules/services/monitoring/unifi-poller.nix @@ -17,7 +17,7 @@ in { debug = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Turns on line numbers, microsecond logging, and a per-device log. This may be noisy if you have a lot of devices. It adds one line per device. ''; @@ -25,14 +25,14 @@ in { quiet = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Turns off per-interval logs. Only startup and error logs will be emitted. ''; }; plugins = mkOption { type = with types; listOf str; default = []; - description = '' + description = lib.mdDoc '' Load additional plugins. ''; }; @@ -42,21 +42,21 @@ in { disable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to disable the prometheus ouput plugin. ''; }; http_listen = mkOption { type = types.str; default = "[::]:9130"; - description = '' + description = lib.mdDoc '' Bind the prometheus exporter to this IP or hostname. ''; }; report_errors = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to report errors. ''; }; @@ -66,21 +66,21 @@ in { disable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to disable the influxdb ouput plugin. ''; }; url = mkOption { type = types.str; default = "http://127.0.0.1:8086"; - description = '' + description = lib.mdDoc '' URL of the influxdb host. ''; }; user = mkOption { type = types.str; default = "unifipoller"; - description = '' + description = lib.mdDoc '' Username for the influxdb. ''; }; @@ -88,7 +88,7 @@ in { type = types.path; default = pkgs.writeText "unifi-poller-influxdb-default.password" "unifipoller"; defaultText = literalExpression "unifi-poller-influxdb-default.password"; - description = '' + description = lib.mdDoc '' Path of a file containing the password for influxdb. This file needs to be readable by the unifi-poller user. ''; @@ -97,21 +97,21 @@ in { db = mkOption { type = types.str; default = "unifi"; - description = '' + description = lib.mdDoc '' Database name. Database should exist. ''; }; verify_ssl = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Verify the influxdb's certificate. ''; }; interval = mkOption { type = types.str; default = "30s"; - description = '' + description = lib.mdDoc '' Setting this lower than the Unifi controller's refresh interval may lead to zeroes in your database. ''; @@ -122,14 +122,14 @@ in { url = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' URL of the Loki host. ''; }; user = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Username for Loki. ''; }; @@ -137,7 +137,7 @@ in { type = types.path; default = pkgs.writeText "unifi-poller-loki-default.password" ""; defaultText = "unifi-poller-influxdb-default.password"; - description = '' + description = lib.mdDoc '' Path of a file containing the password for Loki. This file needs to be readable by the unifi-poller user. ''; @@ -146,28 +146,28 @@ in { verify_ssl = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Verify Loki's certificate. ''; }; tenant_id = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Tenant ID to use in Loki. ''; }; interval = mkOption { type = types.str; default = "2m"; - description = '' + description = lib.mdDoc '' How often the events are polled and pushed to Loki. ''; }; timeout = mkOption { type = types.str; default = "10s"; - description = '' + description = lib.mdDoc '' Should be increased in case of timeout errors. ''; }; @@ -178,7 +178,7 @@ in { user = mkOption { type = types.str; default = "unifi"; - description = '' + description = lib.mdDoc '' Unifi service user name. ''; }; @@ -186,7 +186,7 @@ in { type = types.path; default = pkgs.writeText "unifi-poller-unifi-default.password" "unifi"; defaultText = literalExpression "unifi-poller-unifi-default.password"; - description = '' + description = lib.mdDoc '' Path of a file containing the password for the unifi service user. This file needs to be readable by the unifi-poller user. ''; @@ -195,14 +195,14 @@ in { url = mkOption { type = types.str; default = "https://unifi:8443"; - description = '' + description = lib.mdDoc '' URL of the Unifi controller. ''; }; sites = mkOption { type = with types; either (enum [ "default" "all" ]) (listOf str); default = "all"; - description = '' + description = lib.mdDoc '' List of site names for which statistics should be exported. Or the string "default" for the default site or the string "all" for all sites. ''; @@ -211,35 +211,35 @@ in { save_ids = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Collect and save data from the intrusion detection system to influxdb and Loki. ''; }; save_events = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Collect and save data from UniFi events to influxdb and Loki. ''; }; save_alarms = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Collect and save data from UniFi alarms to influxdb and Loki. ''; }; save_anomalies = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Collect and save data from UniFi anomalies to influxdb and Loki. ''; }; save_dpi = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Collect and save data from deep packet inspection. Adds around 150 data points and impacts performance. ''; @@ -247,14 +247,14 @@ in { save_sites = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Collect and save site data. ''; }; hash_pii = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Hash, with md5, client names and MAC addresses. This attempts to protect personally identifiable information. ''; @@ -262,7 +262,7 @@ in { verify_ssl = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Verify the Unifi controller's certificate. ''; }; @@ -272,7 +272,7 @@ in { dynamic = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Let prometheus select which controller to poll when scraping. Use with default credentials. See unifi-poller wiki for more. ''; @@ -283,7 +283,7 @@ in { controllers = mkOption { type = with types; listOf (submodule { options = controllerOptions; }); default = []; - description = '' + description = lib.mdDoc '' List of Unifi controllers to poll. Use defaults if empty. ''; apply = map (flip removeAttrs [ "_module" ]); diff --git a/nixos/modules/services/monitoring/ups.nix b/nixos/modules/services/monitoring/ups.nix index ae5097c54424c..8af2c2a1f253b 100644 --- a/nixos/modules/services/monitoring/ups.nix +++ b/nixos/modules/services/monitoring/ups.nix @@ -16,7 +16,7 @@ let # /nix/store/nut/share/driver.list driver = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Specify the program to run to talk to this UPS. apcsmart, bestups, and sec are some examples. ''; @@ -24,7 +24,7 @@ let port = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The serial port to which your UPS is connected. /dev/ttyS0 is usually the first port on Linux boxes, for example. ''; @@ -33,7 +33,7 @@ let shutdownOrder = mkOption { default = 0; type = types.int; - description = '' + description = lib.mdDoc '' When you have multiple UPSes on your system, you usually need to turn them off in a certain order. upsdrvctl shuts down all the 0s, then the 1s, 2s, and so on. To exclude a UPS from the @@ -44,7 +44,7 @@ let maxStartDelay = mkOption { default = null; type = types.uniq (types.nullOr types.int); - description = '' + description = lib.mdDoc '' This can be set as a global variable above your first UPS definition and it can also be set in a UPS section. This value controls how long upsdrvctl will wait for the driver to finish @@ -56,7 +56,7 @@ let description = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' Description of the UPS. ''; }; @@ -64,7 +64,7 @@ let directives = mkOption { default = []; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' List of configuration directives for this UPS. ''; }; @@ -72,7 +72,7 @@ let summary = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Lines which would be added inside ups.conf for handling this UPS. ''; }; @@ -106,7 +106,7 @@ in enable = mkOption { default = false; type = with types; bool; - description = '' + description = lib.mdDoc '' Enables support for Power Devices, such as Uninterruptible Power Supplies, Power Distribution Units and Solar Controllers. ''; @@ -143,7 +143,7 @@ in schedulerRules = mkOption { example = "/etc/nixos/upssched.conf"; type = types.str; - description = '' + description = lib.mdDoc '' File which contains the rules to handle UPS events. ''; }; @@ -152,7 +152,7 @@ in maxStartDelay = mkOption { default = 45; type = types.int; - description = '' + description = lib.mdDoc '' This can be set as a global variable above your first UPS definition and it can also be set in a UPS section. This value controls how long upsdrvctl will wait for the driver to finish @@ -164,7 +164,7 @@ in ups = mkOption { default = {}; # see nut/etc/ups.conf.sample - description = '' + description = lib.mdDoc '' This is where you configure all the UPSes that this system will be monitoring directly. These are usually attached to serial ports, but USB devices are also supported. diff --git a/nixos/modules/services/monitoring/uptime.nix b/nixos/modules/services/monitoring/uptime.nix index 79b86be6cc715..24ca7c3763f41 100644 --- a/nixos/modules/services/monitoring/uptime.nix +++ b/nixos/modules/services/monitoring/uptime.nix @@ -26,7 +26,7 @@ let in { options.services.uptime = { configFile = mkOption { - description = '' + description = lib.mdDoc '' The uptime configuration file If mongodb: server != localhost, please set usesRemoteMongo = true @@ -44,7 +44,7 @@ in { }; usesRemoteMongo = mkOption { - description = "Whether the configuration file specifies a remote mongo instance"; + description = lib.mdDoc "Whether the configuration file specifies a remote mongo instance"; default = false; @@ -59,7 +59,7 @@ in { }; nodeEnv = mkOption { - description = "The node environment to run in (development, production, etc.)"; + description = lib.mdDoc "The node environment to run in (development, production, etc.)"; type = types.str; diff --git a/nixos/modules/services/monitoring/zabbix-agent.nix b/nixos/modules/services/monitoring/zabbix-agent.nix index c48b973f1ef7e..f2a8adace69e9 100644 --- a/nixos/modules/services/monitoring/zabbix-agent.nix +++ b/nixos/modules/services/monitoring/zabbix-agent.nix @@ -35,7 +35,7 @@ in type = types.package; default = pkgs.zabbix.agent; defaultText = literalExpression "pkgs.zabbix.agent"; - description = "The Zabbix package to use."; + description = lib.mdDoc "The Zabbix package to use."; }; extraPackages = mkOption { @@ -51,7 +51,7 @@ in modules = mkOption { type = types.attrsOf types.package; - description = "A set of modules to load."; + description = lib.mdDoc "A set of modules to load."; default = {}; example = literalExpression '' { @@ -71,7 +71,7 @@ in server = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The IP address or hostname of the Zabbix server to connect to. ''; }; @@ -80,7 +80,7 @@ in ip = mkOption { type = types.str; default = "0.0.0.0"; - description = '' + description = lib.mdDoc '' List of comma delimited IP addresses that the agent should listen on. ''; }; @@ -88,7 +88,7 @@ in port = mkOption { type = types.port; default = 10050; - description = '' + description = lib.mdDoc '' Agent will listen on this port for connections from the server. ''; }; @@ -97,7 +97,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for the Zabbix Agent. ''; }; @@ -105,9 +105,9 @@ in settings = mkOption { type = with types; attrsOf (oneOf [ int str (listOf str) ]); default = {}; - description = '' + description = lib.mdDoc '' Zabbix Agent configuration. Refer to - <link xlink:href="https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_agentd"/> + <https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_agentd> for details on supported values. ''; example = { diff --git a/nixos/modules/services/monitoring/zabbix-proxy.nix b/nixos/modules/services/monitoring/zabbix-proxy.nix index 0ebd7bcff8343..9cfe1bdaa2054 100644 --- a/nixos/modules/services/monitoring/zabbix-proxy.nix +++ b/nixos/modules/services/monitoring/zabbix-proxy.nix @@ -42,7 +42,7 @@ in server = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The IP address or hostname of the Zabbix server to connect to. ''; }; @@ -54,7 +54,7 @@ in else if cfg.database.type == "pgsql" then pkgs.zabbix.proxy-pgsql else pkgs.zabbix.proxy-sqlite; defaultText = literalExpression "pkgs.zabbix.proxy-pgsql"; - description = "The Zabbix package to use."; + description = lib.mdDoc "The Zabbix package to use."; }; extraPackages = mkOption { @@ -69,7 +69,7 @@ in modules = mkOption { type = types.attrsOf types.package; - description = "A set of modules to load."; + description = lib.mdDoc "A set of modules to load."; default = {}; example = literalExpression '' { @@ -92,13 +92,13 @@ in type = types.enum [ "mysql" "pgsql" "sqlite" ]; example = "mysql"; default = "pgsql"; - description = "Database engine to use."; + description = lib.mdDoc "Database engine to use."; }; host = mkOption { type = types.str; default = "localhost"; - description = "Database host address."; + description = lib.mdDoc "Database host address."; }; port = mkOption { @@ -109,29 +109,29 @@ in then config.${options.services.mysql.port} else config.${options.services.postgresql.port} ''; - description = "Database host port."; + description = lib.mdDoc "Database host port."; }; name = mkOption { type = types.str; default = if cfg.database.type == "sqlite" then "${stateDir}/zabbix.db" else "zabbix"; defaultText = literalExpression "zabbix"; - description = "Database name."; + description = lib.mdDoc "Database name."; }; user = mkOption { type = types.str; default = "zabbix"; - description = "Database user."; + description = lib.mdDoc "Database user."; }; passwordFile = mkOption { type = types.nullOr types.path; default = null; example = "/run/keys/zabbix-dbpassword"; - description = '' + description = lib.mdDoc '' A file containing the password corresponding to - <option>database.user</option>. + {option}`database.user`. ''; }; @@ -139,13 +139,13 @@ in type = types.nullOr types.path; default = null; example = "/run/postgresql"; - description = "Path to the unix socket file to use for authentication."; + description = lib.mdDoc "Path to the unix socket file to use for authentication."; }; createLocally = mkOption { type = types.bool; default = true; - description = "Whether to create a local database automatically."; + description = lib.mdDoc "Whether to create a local database automatically."; }; }; @@ -153,7 +153,7 @@ in ip = mkOption { type = types.str; default = "0.0.0.0"; - description = '' + description = lib.mdDoc '' List of comma delimited IP addresses that the trapper should listen on. Trapper will listen on all network interfaces if this parameter is missing. ''; @@ -162,7 +162,7 @@ in port = mkOption { type = types.port; default = 10051; - description = '' + description = lib.mdDoc '' Listen port for trapper. ''; }; @@ -171,7 +171,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for the Zabbix Proxy. ''; }; @@ -179,9 +179,9 @@ in settings = mkOption { type = with types; attrsOf (oneOf [ int str (listOf str) ]); default = {}; - description = '' + description = lib.mdDoc '' Zabbix Proxy configuration. Refer to - <link xlink:href="https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_proxy"/> + <https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_proxy> for details on supported values. ''; example = { diff --git a/nixos/modules/services/monitoring/zabbix-server.nix b/nixos/modules/services/monitoring/zabbix-server.nix index 9f960517a81b0..566ec4ab2f6d0 100644 --- a/nixos/modules/services/monitoring/zabbix-server.nix +++ b/nixos/modules/services/monitoring/zabbix-server.nix @@ -46,7 +46,7 @@ in type = types.package; default = if cfg.database.type == "mysql" then pkgs.zabbix.server-mysql else pkgs.zabbix.server-pgsql; defaultText = literalExpression "pkgs.zabbix.server-pgsql"; - description = "The Zabbix package to use."; + description = lib.mdDoc "The Zabbix package to use."; }; extraPackages = mkOption { @@ -61,7 +61,7 @@ in modules = mkOption { type = types.attrsOf types.package; - description = "A set of modules to load."; + description = lib.mdDoc "A set of modules to load."; default = {}; example = literalExpression '' { @@ -84,13 +84,13 @@ in type = types.enum [ "mysql" "pgsql" ]; example = "mysql"; default = "pgsql"; - description = "Database engine to use."; + description = lib.mdDoc "Database engine to use."; }; host = mkOption { type = types.str; default = "localhost"; - description = "Database host address."; + description = lib.mdDoc "Database host address."; }; port = mkOption { @@ -101,28 +101,28 @@ in then config.${options.services.mysql.port} else config.${options.services.postgresql.port} ''; - description = "Database host port."; + description = lib.mdDoc "Database host port."; }; name = mkOption { type = types.str; default = "zabbix"; - description = "Database name."; + description = lib.mdDoc "Database name."; }; user = mkOption { type = types.str; default = "zabbix"; - description = "Database user."; + description = lib.mdDoc "Database user."; }; passwordFile = mkOption { type = types.nullOr types.path; default = null; example = "/run/keys/zabbix-dbpassword"; - description = '' + description = lib.mdDoc '' A file containing the password corresponding to - <option>database.user</option>. + {option}`database.user`. ''; }; @@ -130,13 +130,13 @@ in type = types.nullOr types.path; default = null; example = "/run/postgresql"; - description = "Path to the unix socket file to use for authentication."; + description = lib.mdDoc "Path to the unix socket file to use for authentication."; }; createLocally = mkOption { type = types.bool; default = true; - description = "Whether to create a local database automatically."; + description = lib.mdDoc "Whether to create a local database automatically."; }; }; @@ -144,7 +144,7 @@ in ip = mkOption { type = types.str; default = "0.0.0.0"; - description = '' + description = lib.mdDoc '' List of comma delimited IP addresses that the trapper should listen on. Trapper will listen on all network interfaces if this parameter is missing. ''; @@ -153,7 +153,7 @@ in port = mkOption { type = types.port; default = 10051; - description = '' + description = lib.mdDoc '' Listen port for trapper. ''; }; @@ -162,7 +162,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for the Zabbix Server. ''; }; @@ -170,9 +170,9 @@ in settings = mkOption { type = with types; attrsOf (oneOf [ int str (listOf str) ]); default = {}; - description = '' + description = lib.mdDoc '' Zabbix Server configuration. Refer to - <link xlink:href="https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_server"/> + <https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_server> for details on supported values. ''; example = { diff --git a/nixos/modules/services/network-filesystems/cachefilesd.nix b/nixos/modules/services/network-filesystems/cachefilesd.nix index 229c9665419f5..da5a79a062c7c 100644 --- a/nixos/modules/services/network-filesystems/cachefilesd.nix +++ b/nixos/modules/services/network-filesystems/cachefilesd.nix @@ -20,20 +20,20 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable cachefilesd network filesystems caching daemon."; + description = lib.mdDoc "Whether to enable cachefilesd network filesystems caching daemon."; }; cacheDir = mkOption { type = types.str; default = "/var/cache/fscache"; - description = "Directory to contain filesystem cache."; + description = lib.mdDoc "Directory to contain filesystem cache."; }; extraConfig = mkOption { type = types.lines; default = ""; example = "brun 10%"; - description = "Additional configuration file entries. See cachefilesd.conf(5) for more information."; + description = lib.mdDoc "Additional configuration file entries. See cachefilesd.conf(5) for more information."; }; }; diff --git a/nixos/modules/services/network-filesystems/ceph.nix b/nixos/modules/services/network-filesystems/ceph.nix index 7a1444decafaf..2437aba86e4f3 100644 --- a/nixos/modules/services/network-filesystems/ceph.nix +++ b/nixos/modules/services/network-filesystems/ceph.nix @@ -80,7 +80,7 @@ in example = '' 433a2193-4f8a-47a0-95d2-209d7ca2cca5 ''; - description = '' + description = lib.mdDoc '' Filesystem ID, a generated uuid, its must be generated and set before attempting to start a cluster ''; @@ -89,7 +89,7 @@ in clusterName = mkOption { type = types.str; default = "ceph"; - description = '' + description = lib.mdDoc '' Name of cluster ''; }; @@ -98,7 +98,7 @@ in type = types.path; default = "${pkgs.ceph.lib}/lib/ceph/mgr"; defaultText = literalExpression ''"''${pkgs.ceph.lib}/lib/ceph/mgr"''; - description = '' + description = lib.mdDoc '' Path at which to find ceph-mgr modules. ''; }; @@ -109,7 +109,7 @@ in example = '' node0, node1, node2 ''; - description = '' + description = lib.mdDoc '' List of hosts that will be used as monitors at startup. ''; }; @@ -120,7 +120,7 @@ in example = '' 10.10.0.1, 10.10.0.2, 10.10.0.3 ''; - description = '' + description = lib.mdDoc '' List of hostname shortnames/IP addresses of the initial monitors. ''; }; @@ -128,7 +128,7 @@ in maxOpenFiles = mkOption { type = types.int; default = 131072; - description = '' + description = lib.mdDoc '' Max open files for each OSD daemon. ''; }; @@ -136,7 +136,7 @@ in authClusterRequired = mkOption { type = types.enum [ "cephx" "none" ]; default = "cephx"; - description = '' + description = lib.mdDoc '' Enables requiring daemons to authenticate with eachother in the cluster. ''; }; @@ -144,7 +144,7 @@ in authServiceRequired = mkOption { type = types.enum [ "cephx" "none" ]; default = "cephx"; - description = '' + description = lib.mdDoc '' Enables requiring clients to authenticate with the cluster to access services in the cluster (e.g. radosgw, mds or osd). ''; }; @@ -152,7 +152,7 @@ in authClientRequired = mkOption { type = types.enum [ "cephx" "none" ]; default = "cephx"; - description = '' + description = lib.mdDoc '' Enables requiring the cluster to authenticate itself to the client. ''; }; @@ -163,7 +163,7 @@ in example = '' 10.20.0.0/24, 192.168.1.0/24 ''; - description = '' + description = lib.mdDoc '' A comma-separated list of subnets that will be used as public networks in the cluster. ''; }; @@ -174,7 +174,7 @@ in example = '' 10.10.0.0/24, 192.168.0.0/24 ''; - description = '' + description = lib.mdDoc '' A comma-separated list of subnets that will be used as cluster networks in the cluster. ''; }; @@ -183,7 +183,7 @@ in type = with types; nullOr path; default = "${pkgs.mailcap}/etc/mime.types"; defaultText = literalExpression ''"''${pkgs.mailcap}/etc/mime.types"''; - description = '' + description = lib.mdDoc '' Path to mime types used by radosgw. ''; }; @@ -195,7 +195,7 @@ in example = { "ms bind ipv6" = "true"; }; - description = '' + description = lib.mdDoc '' Extra configuration to add to the global section. Use for setting values that are common for all daemons in the cluster. ''; }; @@ -206,7 +206,7 @@ in type = with types; listOf str; default = []; example = [ "name1" "name2" ]; - description = '' + description = lib.mdDoc '' A list of names for manager daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in mgr.name1 ''; @@ -214,7 +214,7 @@ in extraConfig = mkOption { type = with types; attrsOf str; default = {}; - description = '' + description = lib.mdDoc '' Extra configuration to add to the global section for manager daemons. ''; }; @@ -226,7 +226,7 @@ in type = with types; listOf str; default = []; example = [ "name1" "name2" ]; - description = '' + description = lib.mdDoc '' A list of monitor daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in mon.name1 ''; @@ -234,7 +234,7 @@ in extraConfig = mkOption { type = with types; attrsOf str; default = {}; - description = '' + description = lib.mdDoc '' Extra configuration to add to the monitor section. ''; }; @@ -246,7 +246,7 @@ in type = with types; listOf str; default = []; example = [ "name1" "name2" ]; - description = '' + description = lib.mdDoc '' A list of OSD daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in osd.name1 ''; @@ -262,7 +262,7 @@ in "osd pool default pgp num" = "200"; "osd crush chooseleaf type" = "1"; }; - description = '' + description = lib.mdDoc '' Extra configuration to add to the OSD section. ''; }; @@ -274,7 +274,7 @@ in type = with types; listOf str; default = []; example = [ "name1" "name2" ]; - description = '' + description = lib.mdDoc '' A list of metadata service daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in mds.name1 ''; @@ -282,7 +282,7 @@ in extraConfig = mkOption { type = with types; attrsOf str; default = {}; - description = '' + description = lib.mdDoc '' Extra configuration to add to the MDS section. ''; }; @@ -294,7 +294,7 @@ in type = with types; listOf str; default = []; example = [ "name1" "name2" ]; - description = '' + description = lib.mdDoc '' A list of rados gateway daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in client.name1, radosgw daemons aren't daemons to cluster in the sense that OSD, MGR or MON daemons are. They are simply @@ -315,7 +315,7 @@ in "client.radosgw.node0" = { "some config option" = "true"; }; }; ''; - description = '' + description = lib.mdDoc '' Extra configuration to add to the client section. Configuration for rados gateways would be added here, with their own sections, see example. ''; diff --git a/nixos/modules/services/network-filesystems/davfs2.nix b/nixos/modules/services/network-filesystems/davfs2.nix index 8cf314fe63a50..8024cfba08be5 100644 --- a/nixos/modules/services/network-filesystems/davfs2.nix +++ b/nixos/modules/services/network-filesystems/davfs2.nix @@ -15,7 +15,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable davfs2. ''; }; @@ -23,7 +23,7 @@ in davUser = mkOption { type = types.str; default = "davfs2"; - description = '' + description = lib.mdDoc '' When invoked by root the mount.davfs daemon will run as this user. Value must be given as name, not as numerical id. ''; @@ -32,7 +32,7 @@ in davGroup = mkOption { type = types.str; default = "davfs2"; - description = '' + description = lib.mdDoc '' The group of the running mount.davfs daemon. Ordinary users must be member of this group in order to mount a davfs2 file system. Value must be given as name, not as numerical id. @@ -47,7 +47,7 @@ in proxy foo.bar:8080 use_locks 0 ''; - description = '' + description = lib.mdDoc '' Extra lines appended to the configuration of davfs2. '' ; }; diff --git a/nixos/modules/services/network-filesystems/diod.nix b/nixos/modules/services/network-filesystems/diod.nix index 063bae6ddb1d6..541b4ffd6b46c 100644 --- a/nixos/modules/services/network-filesystems/diod.nix +++ b/nixos/modules/services/network-filesystems/diod.nix @@ -26,13 +26,13 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the diod 9P file server."; + description = lib.mdDoc "Whether to enable the diod 9P file server."; }; listen = mkOption { type = types.listOf types.str; default = [ "0.0.0.0:564" ]; - description = '' + description = lib.mdDoc '' [ "IP:PORT" [,"IP:PORT",...] ] List the interfaces and ports that diod should listen on. ''; @@ -41,7 +41,7 @@ in exports = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' List the file systems that clients will be allowed to mount. All paths should be fully qualified. The exports table can include two types of element: a string element (as above), @@ -57,7 +57,7 @@ in exportall = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Export all file systems listed in /proc/mounts. If new file systems are mounted after diod has started, they will become immediately mountable. If there is a duplicate entry for a file system in the exports list, any options listed in @@ -68,7 +68,7 @@ in exportopts = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Establish a default set of export options. These are overridden, not appended to, by opts attributes in an "exports" entry. ''; @@ -77,7 +77,7 @@ in nwthreads = mkOption { type = types.int; default = 16; - description = '' + description = lib.mdDoc '' Sets the (fixed) number of worker threads created to handle 9P requests for a unique aname. ''; @@ -86,7 +86,7 @@ in authRequired = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Allow clients to connect without authentication, i.e. without a valid MUNGE credential. ''; }; @@ -94,7 +94,7 @@ in userdb = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' This option disables password/group lookups. It allows any uid to attach and assumes gid=uid, and supplementary groups contain only the primary gid. ''; @@ -103,7 +103,7 @@ in allsquash = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Remap all users to "nobody". The attaching user need not be present in the password file. ''; @@ -112,7 +112,7 @@ in squashuser = mkOption { type = types.str; default = "nobody"; - description = '' + description = lib.mdDoc '' Change the squash user. The squash user must be present in the password file. ''; }; @@ -120,7 +120,7 @@ in logdest = mkOption { type = types.str; default = "syslog:daemon:err"; - description = '' + description = lib.mdDoc '' Set the destination for logging. The value has the form of "syslog:facility:level" or "filename". ''; @@ -130,7 +130,7 @@ in statfsPassthru = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' This option configures statfs to return the host file system's type rather than V9FS_MAGIC. ''; @@ -139,7 +139,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = "Extra configuration options for diod.conf."; + description = lib.mdDoc "Extra configuration options for diod.conf."; }; }; }; diff --git a/nixos/modules/services/network-filesystems/drbd.nix b/nixos/modules/services/network-filesystems/drbd.nix index c730e0b34e90b..e74ed391d48e3 100644 --- a/nixos/modules/services/network-filesystems/drbd.nix +++ b/nixos/modules/services/network-filesystems/drbd.nix @@ -15,7 +15,7 @@ let cfg = config.services.drbd; in services.drbd.enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable support for DRBD, the Distributed Replicated Block Device. ''; @@ -24,8 +24,8 @@ let cfg = config.services.drbd; in services.drbd.config = mkOption { default = ""; type = types.lines; - description = '' - Contents of the <filename>drbd.conf</filename> configuration file. + description = lib.mdDoc '' + Contents of the {file}`drbd.conf` configuration file. ''; }; diff --git a/nixos/modules/services/network-filesystems/glusterfs.nix b/nixos/modules/services/network-filesystems/glusterfs.nix index aa5dd91d55370..99aa26feb6f1a 100644 --- a/nixos/modules/services/network-filesystems/glusterfs.nix +++ b/nixos/modules/services/network-filesystems/glusterfs.nix @@ -37,13 +37,13 @@ in logLevel = mkOption { type = types.enum ["DEBUG" "INFO" "WARNING" "ERROR" "CRITICAL" "TRACE" "NONE"]; - description = "Log level used by the GlusterFS daemon"; + description = lib.mdDoc "Log level used by the GlusterFS daemon"; default = "INFO"; }; useRpcbind = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Enable use of rpcbind. This is required for Gluster's NFS functionality. You may want to turn it off to reduce the attack surface for DDoS reflection attacks. @@ -56,13 +56,13 @@ in enableGlustereventsd = mkOption { type = types.bool; - description = "Whether to enable the GlusterFS Events Daemon"; + description = lib.mdDoc "Whether to enable the GlusterFS Events Daemon"; default = true; }; killMode = mkOption { type = types.enum ["control-group" "process" "mixed" "none"]; - description = '' + description = lib.mdDoc '' The systemd KillMode to use for glusterd. glusterd spawns other daemons like gsyncd. @@ -79,7 +79,7 @@ in stopKillTimeout = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The systemd TimeoutStopSec to use. After this time after having been asked to shut down, glusterd @@ -94,17 +94,17 @@ in extraFlags = mkOption { type = types.listOf types.str; - description = "Extra flags passed to the GlusterFS daemon"; + description = lib.mdDoc "Extra flags passed to the GlusterFS daemon"; default = []; }; tlsSettings = mkOption { - description = '' + description = lib.mdDoc '' Make the server communicate via TLS. This means it will only connect to other gluster servers having certificates signed by the same CA. - Enabling this will create a file <filename>/var/lib/glusterd/secure-access</filename>. + Enabling this will create a file {file}`/var/lib/glusterd/secure-access`. Disabling will delete this file again. See also: https://gluster.readthedocs.io/en/latest/Administrator%20Guide/SSL/ @@ -114,17 +114,17 @@ in options = { tlsKeyPath = mkOption { type = types.str; - description = "Path to the private key used for TLS."; + description = lib.mdDoc "Path to the private key used for TLS."; }; tlsPem = mkOption { type = types.path; - description = "Path to the certificate used for TLS."; + description = lib.mdDoc "Path to the certificate used for TLS."; }; caCert = mkOption { type = types.path; - description = "Path certificate authority used to sign the cluster certificates."; + description = lib.mdDoc "Path certificate authority used to sign the cluster certificates."; }; }; }); diff --git a/nixos/modules/services/network-filesystems/ipfs.nix b/nixos/modules/services/network-filesystems/ipfs.nix index b7e6a787cfb1b..af4b725bf21b3 100644 --- a/nixos/modules/services/network-filesystems/ipfs.nix +++ b/nixos/modules/services/network-filesystems/ipfs.nix @@ -58,19 +58,19 @@ in type = types.package; default = pkgs.ipfs; defaultText = literalExpression "pkgs.ipfs"; - description = "Which IPFS package to use."; + description = lib.mdDoc "Which IPFS package to use."; }; user = mkOption { type = types.str; default = "ipfs"; - description = "User under which the IPFS daemon runs"; + description = lib.mdDoc "User under which the IPFS daemon runs"; }; group = mkOption { type = types.str; default = "ipfs"; - description = "Group under which the IPFS daemon runs"; + description = lib.mdDoc "Group under which the IPFS daemon runs"; }; dataDir = mkOption { @@ -84,49 +84,49 @@ in then "/var/lib/ipfs" else "/var/lib/ipfs/.ipfs" ''; - description = "The data dir for IPFS"; + description = lib.mdDoc "The data dir for IPFS"; }; defaultMode = mkOption { type = types.enum [ "online" "offline" "norouting" ]; default = "online"; - description = "systemd service that is enabled by default"; + description = lib.mdDoc "systemd service that is enabled by default"; }; autoMount = mkOption { type = types.bool; default = false; - description = "Whether IPFS should try to mount /ipfs and /ipns at startup."; + description = lib.mdDoc "Whether IPFS should try to mount /ipfs and /ipns at startup."; }; autoMigrate = mkOption { type = types.bool; default = true; - description = "Whether IPFS should try to run the fs-repo-migration at startup."; + description = lib.mdDoc "Whether IPFS should try to run the fs-repo-migration at startup."; }; ipfsMountDir = mkOption { type = types.str; default = "/ipfs"; - description = "Where to mount the IPFS namespace to"; + description = lib.mdDoc "Where to mount the IPFS namespace to"; }; ipnsMountDir = mkOption { type = types.str; default = "/ipns"; - description = "Where to mount the IPNS namespace to"; + description = lib.mdDoc "Where to mount the IPNS namespace to"; }; gatewayAddress = mkOption { type = types.str; default = "/ip4/127.0.0.1/tcp/8080"; - description = "Where the IPFS Gateway can be reached"; + description = lib.mdDoc "Where the IPFS Gateway can be reached"; }; apiAddress = mkOption { type = types.str; default = "/ip4/127.0.0.1/tcp/5001"; - description = "Where IPFS exposes its API to"; + description = lib.mdDoc "Where IPFS exposes its API to"; }; swarmAddress = mkOption { @@ -137,25 +137,25 @@ in "/ip4/0.0.0.0/udp/4001/quic" "/ip6/::/udp/4001/quic" ]; - description = "Where IPFS listens for incoming p2p connections"; + description = lib.mdDoc "Where IPFS listens for incoming p2p connections"; }; enableGC = mkOption { type = types.bool; default = false; - description = "Whether to enable automatic garbage collection"; + description = lib.mdDoc "Whether to enable automatic garbage collection"; }; emptyRepo = mkOption { type = types.bool; default = false; - description = "If set to true, the repo won't be initialized with help files"; + description = lib.mdDoc "If set to true, the repo won't be initialized with help files"; }; extraConfig = mkOption { type = types.attrs; - description = '' - Attrset of daemon configuration to set using <command>ipfs config</command>, every time the daemon starts. + description = lib.mdDoc '' + Attrset of daemon configuration to set using {command}`ipfs config`, every time the daemon starts. These are applied last, so may override configuration set by other options in this module. Keep in mind that this configuration is stateful; i.e., unsetting anything in here does not reset the value to the default! ''; @@ -174,13 +174,13 @@ in extraFlags = mkOption { type = types.listOf types.str; - description = "Extra flags passed to the IPFS daemon"; + description = lib.mdDoc "Extra flags passed to the IPFS daemon"; default = [ ]; }; localDiscovery = mkOption { type = types.bool; - description = ''Whether to enable local discovery for the ipfs daemon. + description = lib.mdDoc ''Whether to enable local discovery for the ipfs daemon. This will allow ipfs to scan ports on your local network. Some hosting services will ban you if you do this. ''; default = false; @@ -189,14 +189,14 @@ in serviceFdlimit = mkOption { type = types.nullOr types.int; default = null; - description = "The fdlimit for the IPFS systemd unit or <literal>null</literal> to have the daemon attempt to manage it"; + description = lib.mdDoc "The fdlimit for the IPFS systemd unit or `null` to have the daemon attempt to manage it"; example = 64 * 1024; }; startWhenNeeded = mkOption { type = types.bool; default = false; - description = "Whether to use socket activation to start IPFS when needed."; + description = lib.mdDoc "Whether to use socket activation to start IPFS when needed."; }; }; diff --git a/nixos/modules/services/network-filesystems/kbfs.nix b/nixos/modules/services/network-filesystems/kbfs.nix index a43ac656f6676..33ff283d5e81d 100644 --- a/nixos/modules/services/network-filesystems/kbfs.nix +++ b/nixos/modules/services/network-filesystems/kbfs.nix @@ -15,15 +15,15 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to mount the Keybase filesystem."; + description = lib.mdDoc "Whether to mount the Keybase filesystem."; }; enableRedirector = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the Keybase root redirector service, allowing - any user to access KBFS files via <literal>/keybase</literal>, + any user to access KBFS files via `/keybase`, which will show different contents depending on the requester. ''; }; @@ -32,7 +32,7 @@ in { type = types.str; default = "%h/keybase"; example = "/keybase"; - description = "Mountpoint for the Keybase filesystem."; + description = lib.mdDoc "Mountpoint for the Keybase filesystem."; }; extraFlags = mkOption { @@ -42,7 +42,7 @@ in { "-label kbfs" "-mount-type normal" ]; - description = '' + description = lib.mdDoc '' Additional flags to pass to the Keybase filesystem on launch. ''; }; diff --git a/nixos/modules/services/network-filesystems/litestream/default.nix b/nixos/modules/services/network-filesystems/litestream/default.nix index 51eb920d778dc..25744b9196461 100644 --- a/nixos/modules/services/network-filesystems/litestream/default.nix +++ b/nixos/modules/services/network-filesystems/litestream/default.nix @@ -11,15 +11,15 @@ in enable = mkEnableOption "litestream"; package = mkOption { - description = "Package to use."; + description = lib.mdDoc "Package to use."; default = pkgs.litestream; defaultText = literalExpression "pkgs.litestream"; type = types.package; }; settings = mkOption { - description = '' - See the <link xlink:href="https://litestream.io/reference/config/">documentation</link>. + description = lib.mdDoc '' + See the [documentation](https://litestream.io/reference/config/). ''; type = settingsFormat.type; example = { diff --git a/nixos/modules/services/network-filesystems/moosefs.nix b/nixos/modules/services/network-filesystems/moosefs.nix index 88b2ada37e750..6ad4b37761a83 100644 --- a/nixos/modules/services/network-filesystems/moosefs.nix +++ b/nixos/modules/services/network-filesystems/moosefs.nix @@ -75,14 +75,14 @@ in { masterHost = mkOption { type = types.str; default = null; - description = "IP or DNS name of master host."; + description = lib.mdDoc "IP or DNS name of master host."; }; runAsUser = mkOption { type = types.bool; default = true; example = true; - description = "Run daemons as user moosefs instead of root."; + description = lib.mdDoc "Run daemons as user moosefs instead of root."; }; client.enable = mkEnableOption "Moosefs client."; @@ -90,11 +90,11 @@ in { master = { enable = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Enable Moosefs master daemon. - You need to run <literal>mfsmaster-init</literal> on a freshly installed master server to - initialize the <literal>DATA_PATH</literal> direcory. + You need to run `mfsmaster-init` on a freshly installed master server to + initialize the `DATA_PATH` direcory. ''; default = false; }; @@ -102,7 +102,7 @@ in { exports = mkOption { type = with types; listOf str; default = null; - description = "Paths to export (see mfsexports.cfg)."; + description = lib.mdDoc "Paths to export (see mfsexports.cfg)."; example = [ "* / rw,alldirs,admin,maproot=0:0" "* . rw" @@ -111,7 +111,7 @@ in { openFirewall = mkOption { type = types.bool; - description = "Whether to automatically open the necessary ports in the firewall."; + description = lib.mdDoc "Whether to automatically open the necessary ports in the firewall."; default = false; }; @@ -122,11 +122,11 @@ in { options.DATA_PATH = mkOption { type = types.str; default = "/var/lib/mfs"; - description = "Data storage directory."; + description = lib.mdDoc "Data storage directory."; }; }; - description = "Contents of config file (mfsmaster.cfg)."; + description = lib.mdDoc "Contents of config file (mfsmaster.cfg)."; }; }; @@ -140,11 +140,11 @@ in { options.DATA_PATH = mkOption { type = types.str; default = "/var/lib/mfs"; - description = "Data storage directory"; + description = lib.mdDoc "Data storage directory"; }; }; - description = "Contents of metalogger config file (mfsmetalogger.cfg)."; + description = lib.mdDoc "Contents of metalogger config file (mfsmetalogger.cfg)."; }; }; @@ -153,14 +153,14 @@ in { openFirewall = mkOption { type = types.bool; - description = "Whether to automatically open the necessary ports in the firewall."; + description = lib.mdDoc "Whether to automatically open the necessary ports in the firewall."; default = false; }; hdds = mkOption { type = with types; listOf str; default = null; - description = "Mount points to be used by chunkserver for storage (see mfshdd.cfg)."; + description = lib.mdDoc "Mount points to be used by chunkserver for storage (see mfshdd.cfg)."; example = [ "/mnt/hdd1" ]; }; @@ -171,11 +171,11 @@ in { options.DATA_PATH = mkOption { type = types.str; default = "/var/lib/mfs"; - description = "Directory for lock file."; + description = lib.mdDoc "Directory for lock file."; }; }; - description = "Contents of chunkserver config file (mfschunkserver.cfg)."; + description = lib.mdDoc "Contents of chunkserver config file (mfschunkserver.cfg)."; }; }; }; diff --git a/nixos/modules/services/network-filesystems/netatalk.nix b/nixos/modules/services/network-filesystems/netatalk.nix index 06a36eb30c29c..e870056e1d116 100644 --- a/nixos/modules/services/network-filesystems/netatalk.nix +++ b/nixos/modules/services/network-filesystems/netatalk.nix @@ -15,7 +15,7 @@ in { port = mkOption { type = types.port; default = 548; - description = "TCP port to be used for AFP."; + description = lib.mdDoc "TCP port to be used for AFP."; }; settings = mkOption { diff --git a/nixos/modules/services/network-filesystems/nfsd.nix b/nixos/modules/services/network-filesystems/nfsd.nix index 1b62bfa820358..22c7c8790c2e8 100644 --- a/nixos/modules/services/network-filesystems/nfsd.nix +++ b/nixos/modules/services/network-filesystems/nfsd.nix @@ -26,7 +26,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the kernel's NFS server. ''; }; @@ -34,7 +34,7 @@ in extraNfsdConfig = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration options for the [nfsd] section of /etc/nfs.conf. ''; }; @@ -63,7 +63,7 @@ in nproc = mkOption { type = types.int; default = 8; - description = '' + description = lib.mdDoc '' Number of NFS server threads. Defaults to the recommended value of 8. ''; }; @@ -71,14 +71,14 @@ in createMountPoints = mkOption { type = types.bool; default = false; - description = "Whether to create the mount points in the exports file at startup time."; + description = lib.mdDoc "Whether to create the mount points in the exports file at startup time."; }; mountdPort = mkOption { type = types.nullOr types.int; default = null; example = 4002; - description = '' + description = lib.mdDoc '' Use fixed port for rpc.mountd, useful if server is behind firewall. ''; }; @@ -87,9 +87,9 @@ in type = types.nullOr types.int; default = null; example = 4001; - description = '' + description = lib.mdDoc '' Use a fixed port for the NFS lock manager kernel module - (<literal>lockd/nlockmgr</literal>). This is useful if the + (`lockd/nlockmgr`). This is useful if the NFS server is behind a firewall. ''; }; @@ -98,8 +98,8 @@ in type = types.nullOr types.int; default = null; example = 4000; - description = '' - Use a fixed port for <command>rpc.statd</command>. This is + description = lib.mdDoc '' + Use a fixed port for {command}`rpc.statd`. This is useful if the NFS server is behind a firewall. ''; }; diff --git a/nixos/modules/services/network-filesystems/orangefs/client.nix b/nixos/modules/services/network-filesystems/orangefs/client.nix index 36ea5af2168d0..26cc0e169aecd 100644 --- a/nixos/modules/services/network-filesystems/orangefs/client.nix +++ b/nixos/modules/services/network-filesystems/orangefs/client.nix @@ -15,13 +15,13 @@ in { extraOptions = mkOption { type = with types; listOf str; default = []; - description = "Extra command line options for pvfs2-client."; + description = lib.mdDoc "Extra command line options for pvfs2-client."; }; fileSystems = mkOption { - description = '' + description = lib.mdDoc '' The orangefs file systems to be mounted. - This option is prefered over using <option>fileSystems</option> directly since + This option is prefered over using {option}`fileSystems` directly since the pvfs client service needs to be running for it to be mounted. ''; @@ -36,19 +36,19 @@ in { mountPoint = mkOption { type = types.str; default = "/orangefs"; - description = "Mount point."; + description = lib.mdDoc "Mount point."; }; options = mkOption { type = with types; listOf str; default = []; - description = "Mount options"; + description = lib.mdDoc "Mount options"; }; target = mkOption { type = types.str; example = "tcp://server:3334/orangefs"; - description = "Target URL"; + description = lib.mdDoc "Target URL"; }; }; })); diff --git a/nixos/modules/services/network-filesystems/orangefs/server.nix b/nixos/modules/services/network-filesystems/orangefs/server.nix index 621c2fe8f78df..3bc3325e18641 100644 --- a/nixos/modules/services/network-filesystems/orangefs/server.nix +++ b/nixos/modules/services/network-filesystems/orangefs/server.nix @@ -79,40 +79,40 @@ in { logType = mkOption { type = with types; enum [ "file" "syslog" ]; default = "syslog"; - description = "Destination for log messages."; + description = lib.mdDoc "Destination for log messages."; }; dataStorageSpace = mkOption { type = types.nullOr types.str; default = null; example = "/data/storage"; - description = "Directory for data storage."; + description = lib.mdDoc "Directory for data storage."; }; metadataStorageSpace = mkOption { type = types.nullOr types.str; default = null; example = "/data/meta"; - description = "Directory for meta data storage."; + description = lib.mdDoc "Directory for meta data storage."; }; BMIModules = mkOption { type = with types; listOf str; default = [ "bmi_tcp" ]; example = [ "bmi_tcp" "bmi_ib"]; - description = "List of BMI modules to load."; + description = lib.mdDoc "List of BMI modules to load."; }; extraDefaults = mkOption { type = types.lines; default = ""; - description = "Extra config for <literal><Defaults></literal> section."; + description = lib.mdDoc "Extra config for `<Defaults>` section."; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Extra config for the global section."; + description = lib.mdDoc "Extra config for the global section."; }; servers = mkOption { @@ -122,12 +122,12 @@ in { node1 = "tcp://node1:3334"; node2 = "tcp://node2:3334"; }; - description = "URLs for storage server including port. The attribute names define the server alias."; + description = lib.mdDoc "URLs for storage server including port. The attribute names define the server alias."; }; fileSystems = mkOption { - description = '' - These options will create the <literal><FileSystem></literal> sections of config file. + description = lib.mdDoc '' + These options will create the `<FileSystem>` sections of config file. ''; default = { orangefs = {}; }; example = literalExpression '' @@ -146,37 +146,37 @@ in { id = mkOption { type = types.int; default = 1; - description = "File system ID (must be unique within configuration)."; + description = lib.mdDoc "File system ID (must be unique within configuration)."; }; rootHandle = mkOption { type = types.int; default = 3; - description = "File system root ID."; + description = lib.mdDoc "File system root ID."; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Extra config for <literal><FileSystem></literal> section."; + description = lib.mdDoc "Extra config for `<FileSystem>` section."; }; troveSyncMeta = mkOption { type = types.bool; default = true; - description = "Sync meta data."; + description = lib.mdDoc "Sync meta data."; }; troveSyncData = mkOption { type = types.bool; default = false; - description = "Sync data."; + description = lib.mdDoc "Sync data."; }; extraStorageHints = mkOption { type = types.lines; default = ""; - description = "Extra config for <literal><StorageHints></literal> section."; + description = lib.mdDoc "Extra config for `<StorageHints>` section."; }; }; })); diff --git a/nixos/modules/services/network-filesystems/rsyncd.nix b/nixos/modules/services/network-filesystems/rsyncd.nix index e72f9b54cd6fa..ab24ebfee273c 100644 --- a/nixos/modules/services/network-filesystems/rsyncd.nix +++ b/nixos/modules/services/network-filesystems/rsyncd.nix @@ -15,7 +15,7 @@ in { port = mkOption { default = 873; type = types.port; - description = "TCP port the daemon will listen on."; + description = lib.mdDoc "TCP port the daemon will listen on."; }; settings = mkOption { @@ -50,7 +50,7 @@ in { default = false; type = types.bool; description = - "If enabled Rsync will be socket-activated rather than run persistently."; + lib.mdDoc "If enabled Rsync will be socket-activated rather than run persistently."; }; }; diff --git a/nixos/modules/services/network-filesystems/samba-wsdd.nix b/nixos/modules/services/network-filesystems/samba-wsdd.nix index 800ef448d3769..38980593e7682 100644 --- a/nixos/modules/services/network-filesystems/samba-wsdd.nix +++ b/nixos/modules/services/network-filesystems/samba-wsdd.nix @@ -23,46 +23,46 @@ in { type = types.nullOr types.str; default = null; example = "eth0"; - description = "Interface or address to use."; + description = lib.mdDoc "Interface or address to use."; }; hoplimit = mkOption { type = types.nullOr types.int; default = null; example = 2; - description = "Hop limit for multicast packets (default = 1)."; + description = lib.mdDoc "Hop limit for multicast packets (default = 1)."; }; workgroup = mkOption { type = types.nullOr types.str; default = null; example = "HOME"; - description = "Set workgroup name (default WORKGROUP)."; + description = lib.mdDoc "Set workgroup name (default WORKGROUP)."; }; hostname = mkOption { type = types.nullOr types.str; default = null; example = "FILESERVER"; - description = "Override (NetBIOS) hostname to be used (default hostname)."; + description = lib.mdDoc "Override (NetBIOS) hostname to be used (default hostname)."; }; domain = mkOption { type = types.nullOr types.str; default = null; - description = "Set domain name (disables workgroup)."; + description = lib.mdDoc "Set domain name (disables workgroup)."; }; discovery = mkOption { type = types.bool; default = false; - description = "Enable discovery operation mode."; + description = lib.mdDoc "Enable discovery operation mode."; }; listen = mkOption { type = types.str; default = "/run/wsdd/wsdd.sock"; - description = "Listen on path or localhost port in discovery mode."; + description = lib.mdDoc "Listen on path or localhost port in discovery mode."; }; extraOptions = mkOption { type = types.listOf types.str; default = [ "--shortlog" ]; example = [ "--verbose" "--no-http" "--ipv4only" "--no-host" ]; - description = "Additional wsdd options."; + description = lib.mdDoc "Additional wsdd options."; }; }; }; diff --git a/nixos/modules/services/network-filesystems/samba.nix b/nixos/modules/services/network-filesystems/samba.nix index 992f948e8cd53..7a07b043859b8 100644 --- a/nixos/modules/services/network-filesystems/samba.nix +++ b/nixos/modules/services/network-filesystems/samba.nix @@ -96,7 +96,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to automatically open the necessary ports in the firewall. ''; }; @@ -104,7 +104,7 @@ in enableNmbd = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable Samba's nmbd, which replies to NetBIOS over IP name service requests. It also participates in the browsing protocols which make up the Windows "Network Neighborhood" view. @@ -114,7 +114,7 @@ in enableWinbindd = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable Samba's winbindd, which provides a number of services to the Name Service Switch capability found in most modern C libraries, to arbitrary applications via PAM and ntlm_auth and to Samba itself. @@ -126,7 +126,7 @@ in default = pkgs.samba; defaultText = literalExpression "pkgs.samba"; example = literalExpression "pkgs.samba4Full"; - description = '' + description = lib.mdDoc '' Defines which package should be used for the samba server. ''; }; @@ -134,7 +134,7 @@ in invalidUsers = mkOption { type = types.listOf types.str; default = [ "root" ]; - description = '' + description = lib.mdDoc '' List of users who are denied to login via Samba. ''; }; @@ -142,7 +142,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Additional global section and extra section lines go in here. ''; example = '' @@ -154,7 +154,7 @@ in configText = mkOption { type = types.nullOr types.lines; default = null; - description = '' + description = lib.mdDoc '' Verbatim contents of smb.conf. If null (default), use the autogenerated file from NixOS instead. ''; @@ -163,13 +163,13 @@ in securityType = mkOption { type = types.str; default = "user"; - description = "Samba security type"; + description = lib.mdDoc "Samba security type"; }; nsswins = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable the WINS NSS (Name Service Switch) plug-in. Enabling it allows applications to resolve WINS/NetBIOS names (a.k.a. Windows machine names) by transparently querying the winbindd daemon. @@ -178,9 +178,9 @@ in shares = mkOption { default = {}; - description = '' + description = lib.mdDoc '' A set describing shared resources. - See <command>man smb.conf</command> for options. + See {command}`man smb.conf` for options. ''; type = types.attrsOf (types.attrsOf types.unspecified); example = literalExpression '' diff --git a/nixos/modules/services/network-filesystems/tahoe.nix b/nixos/modules/services/network-filesystems/tahoe.nix index 5426463dffaca..a816b5757f729 100644 --- a/nixos/modules/services/network-filesystems/tahoe.nix +++ b/nixos/modules/services/network-filesystems/tahoe.nix @@ -12,21 +12,21 @@ in options = { nickname = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The nickname of this Tahoe introducer. ''; }; tub.port = mkOption { default = 3458; type = types.int; - description = '' + description = lib.mdDoc '' The port on which the introducer will listen. ''; }; tub.location = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The external location that the introducer should listen on. If specified, the port should be included. @@ -36,13 +36,13 @@ in default = pkgs.tahoelafs; defaultText = literalExpression "pkgs.tahoelafs"; type = types.package; - description = '' + description = lib.mdDoc '' The package to use for the Tahoe LAFS daemon. ''; }; }; }); - description = '' + description = lib.mdDoc '' The Tahoe introducers. ''; }; @@ -52,14 +52,14 @@ in options = { nickname = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The nickname of this Tahoe node. ''; }; tub.port = mkOption { default = 3457; type = types.int; - description = '' + description = lib.mdDoc '' The port on which the tub will listen. This is the correct setting to tweak if you want Tahoe's storage @@ -69,7 +69,7 @@ in tub.location = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The external location that the node should listen on. This is the setting to tweak if there are multiple interfaces @@ -81,7 +81,7 @@ in web.port = mkOption { default = 3456; type = types.int; - description = '' + description = lib.mdDoc '' The port on which the Web server will listen. This is the correct setting to tweak if you want Tahoe's WUI to @@ -91,7 +91,7 @@ in client.introducer = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The furl for a Tahoe introducer node. Like all furls, keep this safe and don't share it. @@ -100,7 +100,7 @@ in client.helper = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The furl for a Tahoe helper node. Like all furls, keep this safe and don't share it. @@ -109,14 +109,14 @@ in client.shares.needed = mkOption { default = 3; type = types.int; - description = '' + description = lib.mdDoc '' The number of shares required to reconstitute a file. ''; }; client.shares.happy = mkOption { default = 7; type = types.int; - description = '' + description = lib.mdDoc '' The number of distinct storage nodes required to store a file. ''; @@ -124,7 +124,7 @@ in client.shares.total = mkOption { default = 10; type = types.int; - description = '' + description = lib.mdDoc '' The number of shares required to store a file. ''; }; @@ -132,7 +132,7 @@ in storage.reservedSpace = mkOption { default = "1G"; type = types.str; - description = '' + description = lib.mdDoc '' The amount of filesystem space to not use for storage. ''; }; @@ -141,7 +141,7 @@ in sftpd.port = mkOption { default = null; type = types.nullOr types.int; - description = '' + description = lib.mdDoc '' The port on which the SFTP server will listen. This is the correct setting to tweak if you want Tahoe's SFTP @@ -151,28 +151,28 @@ in sftpd.hostPublicKeyFile = mkOption { default = null; type = types.nullOr types.path; - description = '' + description = lib.mdDoc '' Path to the SSH host public key. ''; }; sftpd.hostPrivateKeyFile = mkOption { default = null; type = types.nullOr types.path; - description = '' + description = lib.mdDoc '' Path to the SSH host private key. ''; }; sftpd.accounts.file = mkOption { default = null; type = types.nullOr types.path; - description = '' + description = lib.mdDoc '' Path to the accounts file. ''; }; sftpd.accounts.url = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' URL of the accounts server. ''; }; @@ -180,13 +180,13 @@ in default = pkgs.tahoelafs; defaultText = literalExpression "pkgs.tahoelafs"; type = types.package; - description = '' + description = lib.mdDoc '' The package to use for the Tahoe LAFS daemon. ''; }; }; }); - description = '' + description = lib.mdDoc '' The Tahoe nodes. ''; }; diff --git a/nixos/modules/services/network-filesystems/u9fs.nix b/nixos/modules/services/network-filesystems/u9fs.nix index 77961b78cadb8..d6968b2cb826b 100644 --- a/nixos/modules/services/network-filesystems/u9fs.nix +++ b/nixos/modules/services/network-filesystems/u9fs.nix @@ -14,16 +14,16 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to run the u9fs 9P server for Unix."; + description = lib.mdDoc "Whether to run the u9fs 9P server for Unix."; }; listenStreams = mkOption { type = types.listOf types.str; default = [ "564" ]; example = [ "192.168.16.1:564" ]; - description = '' + description = lib.mdDoc '' Sockets to listen for clients on. - See <command>man 5 systemd.socket</command> for socket syntax. + See {command}`man 5 systemd.socket` for socket syntax. ''; }; @@ -31,7 +31,7 @@ in type = types.str; default = "nobody"; description = - "User to run u9fs under."; + lib.mdDoc "User to run u9fs under."; }; extraArgs = mkOption { @@ -39,9 +39,9 @@ in default = ""; example = "-a none"; description = - '' + lib.mdDoc '' Extra arguments to pass on invocation, - see <command>man 4 u9fs</command> + see {command}`man 4 u9fs` ''; }; diff --git a/nixos/modules/services/network-filesystems/webdav-server-rs.nix b/nixos/modules/services/network-filesystems/webdav-server-rs.nix index 1c5c299cb6735..bd07b8d4381bf 100644 --- a/nixos/modules/services/network-filesystems/webdav-server-rs.nix +++ b/nixos/modules/services/network-filesystems/webdav-server-rs.nix @@ -19,22 +19,22 @@ in user = mkOption { type = types.str; default = "webdav"; - description = "User to run under when setuid is not enabled."; + description = lib.mdDoc "User to run under when setuid is not enabled."; }; group = mkOption { type = types.str; default = "webdav"; - description = "Group to run under when setuid is not enabled."; + description = lib.mdDoc "Group to run under when setuid is not enabled."; }; settings = mkOption { type = format.type; default = { }; - description = '' + description = lib.mdDoc '' Attrset that is converted and passed as config file. Available options can be found at - <link xlink:href="https://github.com/miquels/webdav-server-rs/blob/master/webdav-server.toml">here</link>. + [here](https://github.com/miquels/webdav-server-rs/blob/master/webdav-server.toml). ''; example = literalExpression '' { @@ -73,7 +73,7 @@ in type = types.path; default = format.generate "webdav-server.toml" settings; defaultText = "Config file generated from services.webdav-server-rs.settings"; - description = '' + description = lib.mdDoc '' Path to config file. If this option is set, it will override any configuration done in services.webdav-server-rs.settings. ''; diff --git a/nixos/modules/services/network-filesystems/webdav.nix b/nixos/modules/services/network-filesystems/webdav.nix index a810af40fd478..5628fd1e6c6f1 100644 --- a/nixos/modules/services/network-filesystems/webdav.nix +++ b/nixos/modules/services/network-filesystems/webdav.nix @@ -13,27 +13,27 @@ in user = mkOption { type = types.str; default = "webdav"; - description = "User account under which WebDAV runs."; + description = lib.mdDoc "User account under which WebDAV runs."; }; group = mkOption { type = types.str; default = "webdav"; - description = "Group under which WebDAV runs."; + description = lib.mdDoc "Group under which WebDAV runs."; }; settings = mkOption { type = format.type; default = { }; - description = '' + description = lib.mdDoc '' Attrset that is converted and passed as config file. Available options can be found at - <link xlink:href="https://github.com/hacdias/webdav">here</link>. + [here](https://github.com/hacdias/webdav). This program supports reading username and password configuration from environment variables, so it's strongly recommended to store username and password in a separate - <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.exec.html#EnvironmentFile=">EnvironmentFile</link>. + [EnvironmentFile](https://www.freedesktop.org/software/systemd/man/systemd.exec.html#EnvironmentFile=). This prevents adding secrets to the world-readable Nix store. ''; example = literalExpression '' @@ -57,7 +57,7 @@ in type = types.path; default = format.generate "webdav.yaml" cfg.settings; defaultText = "Config file generated from services.webdav.settings"; - description = '' + description = lib.mdDoc '' Path to config file. If this option is set, it will override any configuration done in options.services.webdav.settings. ''; diff --git a/nixos/modules/services/network-filesystems/xtreemfs.nix b/nixos/modules/services/network-filesystems/xtreemfs.nix index fc07231157877..7b476fc7ac939 100644 --- a/nixos/modules/services/network-filesystems/xtreemfs.nix +++ b/nixos/modules/services/network-filesystems/xtreemfs.nix @@ -94,7 +94,7 @@ in homeDir = mkOption { type = types.path; default = "/var/lib/xtreemfs"; - description = '' + description = lib.mdDoc '' XtreemFS home dir for the xtreemfs user. ''; }; @@ -103,7 +103,7 @@ in enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable XtreemFS DIR service. ''; }; @@ -120,7 +120,7 @@ in port = mkOption { default = 32638; type = types.port; - description = '' + description = lib.mdDoc '' The port to listen on for incoming connections (TCP). ''; }; @@ -128,7 +128,7 @@ in type = types.str; example = "127.0.0.1"; default = ""; - description = '' + description = lib.mdDoc '' If specified, it defines the interface to listen on. If not specified, the service will listen on all interfaces (any). ''; @@ -136,7 +136,7 @@ in httpPort = mkOption { default = 30638; type = types.port; - description = '' + description = lib.mdDoc '' Specifies the listen port for the HTTP service that returns the status page. ''; @@ -145,7 +145,7 @@ in type = types.enum [ "ASYNC" "SYNC_WRITE_METADATA" "SYNC_WRITE" "FDATASYNC" "FSYNC" ]; default = "FSYNC"; example = "FDATASYNC"; - description = '' + description = lib.mdDoc '' The sync mode influences how operations are committed to the disk log before the operation is acknowledged to the caller. @@ -173,7 +173,7 @@ in ssl.trusted_certs.pw = jks_passphrase ssl.trusted_certs.container = jks ''; - description = '' + description = lib.mdDoc '' Configuration of XtreemFS DIR service. WARNING: configuration is saved as plaintext inside nix store. For more options: http://www.xtreemfs.org/xtfs-guide-1.5.1/index.html @@ -215,7 +215,7 @@ in babudb.ssl.authenticationWithoutEncryption = false ''; - description = '' + description = lib.mdDoc '' Configuration of XtreemFS DIR replication plugin. WARNING: configuration is saved as plaintext inside nix store. For more options: http://www.xtreemfs.org/xtfs-guide-1.5.1/index.html @@ -228,7 +228,7 @@ in enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable XtreemFS MRC service. ''; }; @@ -245,7 +245,7 @@ in port = mkOption { default = 32636; type = types.port; - description = '' + description = lib.mdDoc '' The port to listen on for incoming connections (TCP). ''; }; @@ -253,7 +253,7 @@ in example = "127.0.0.1"; type = types.str; default = ""; - description = '' + description = lib.mdDoc '' If specified, it defines the interface to listen on. If not specified, the service will listen on all interfaces (any). ''; @@ -261,7 +261,7 @@ in httpPort = mkOption { default = 30636; type = types.port; - description = '' + description = lib.mdDoc '' Specifies the listen port for the HTTP service that returns the status page. ''; @@ -270,7 +270,7 @@ in default = "FSYNC"; type = types.enum [ "ASYNC" "SYNC_WRITE_METADATA" "SYNC_WRITE" "FDATASYNC" "FSYNC" ]; example = "FDATASYNC"; - description = '' + description = lib.mdDoc '' The sync mode influences how operations are committed to the disk log before the operation is acknowledged to the caller. @@ -316,7 +316,7 @@ in ssl.trusted_certs.pw = jks_passphrase ssl.trusted_certs.container = jks ''; - description = '' + description = lib.mdDoc '' Configuration of XtreemFS MRC service. WARNING: configuration is saved as plaintext inside nix store. For more options: http://www.xtreemfs.org/xtfs-guide-1.5.1/index.html @@ -358,7 +358,7 @@ in babudb.ssl.authenticationWithoutEncryption = false ''; - description = '' + description = lib.mdDoc '' Configuration of XtreemFS MRC replication plugin. WARNING: configuration is saved as plaintext inside nix store. For more options: http://www.xtreemfs.org/xtfs-guide-1.5.1/index.html @@ -371,7 +371,7 @@ in enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable XtreemFS OSD service. ''; }; @@ -388,7 +388,7 @@ in port = mkOption { default = 32640; type = types.port; - description = '' + description = lib.mdDoc '' The port to listen on for incoming connections (TCP and UDP). ''; }; @@ -396,7 +396,7 @@ in example = "127.0.0.1"; type = types.str; default = ""; - description = '' + description = lib.mdDoc '' If specified, it defines the interface to listen on. If not specified, the service will listen on all interfaces (any). ''; @@ -404,7 +404,7 @@ in httpPort = mkOption { default = 30640; type = types.port; - description = '' + description = lib.mdDoc '' Specifies the listen port for the HTTP service that returns the status page. ''; @@ -435,7 +435,7 @@ in ssl.trusted_certs.pw = jks_passphrase ssl.trusted_certs.container = jks ''; - description = '' + description = lib.mdDoc '' Configuration of XtreemFS OSD service. WARNING: configuration is saved as plaintext inside nix store. For more options: http://www.xtreemfs.org/xtfs-guide-1.5.1/index.html diff --git a/nixos/modules/services/network-filesystems/yandex-disk.nix b/nixos/modules/services/network-filesystems/yandex-disk.nix index a5b1f9d4ab630..94f806a617894 100644 --- a/nixos/modules/services/network-filesystems/yandex-disk.nix +++ b/nixos/modules/services/network-filesystems/yandex-disk.nix @@ -31,7 +31,7 @@ in username = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' Your yandex.com login name. ''; }; @@ -39,7 +39,7 @@ in password = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' Your yandex.com password. Warning: it will be world-readable in /nix/store. ''; }; @@ -47,7 +47,7 @@ in user = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The user the yandex-disk daemon should run as. ''; }; @@ -55,14 +55,14 @@ in directory = mkOption { type = types.path; default = "/home/Yandex.Disk"; - description = "The directory to use for Yandex.Disk storage"; + description = lib.mdDoc "The directory to use for Yandex.Disk storage"; }; excludes = mkOption { default = ""; type = types.commas; example = "data,backup"; - description = '' + description = lib.mdDoc '' Comma-separated list of directories which are excluded from synchronization. ''; }; diff --git a/nixos/modules/services/networking/3proxy.nix b/nixos/modules/services/networking/3proxy.nix index 326a8671fccad..9fc1dac7c280c 100644 --- a/nixos/modules/services/networking/3proxy.nix +++ b/nixos/modules/services/networking/3proxy.nix @@ -10,7 +10,7 @@ in { confFile = mkOption { type = types.path; example = "/var/lib/3proxy/3proxy.conf"; - description = '' + description = lib.mdDoc '' Ignore all other 3proxy options and load configuration from this file. ''; }; @@ -90,7 +90,7 @@ in { type = types.str; default = "[::]"; example = "127.0.0.1"; - description = '' + description = lib.mdDoc '' Address used for service. ''; }; @@ -98,7 +98,7 @@ in { type = types.nullOr types.int; default = null; example = 3128; - description = '' + description = lib.mdDoc '' Override default port used for service. ''; }; @@ -106,7 +106,7 @@ in { type = types.int; default = 100; example = 1000; - description = '' + description = lib.mdDoc '' Maximum number of simulationeous connections to this service. ''; }; @@ -171,7 +171,7 @@ in { type = types.listOf types.str; default = [ ]; example = [ "user1" "user2" "user3" ]; - description = '' + description = lib.mdDoc '' List of users, use empty list for any. ''; }; @@ -179,7 +179,7 @@ in { type = types.listOf types.str; default = [ ]; example = [ "127.0.0.1" "192.168.1.0/24" ]; - description = '' + description = lib.mdDoc '' List of source IP range, use empty list for any. ''; }; @@ -198,7 +198,7 @@ in { type = types.listOf types.int; default = [ ]; example = [ 80 443 ]; - description = '' + description = lib.mdDoc '' List of target ports, use empty list for any. ''; }; @@ -220,7 +220,7 @@ in { } ] ''; - description = '' + description = lib.mdDoc '' Use this option to limit user access to resources. ''; }; @@ -228,17 +228,17 @@ in { type = types.nullOr types.str; default = null; example = "-46"; - description = '' + description = lib.mdDoc '' Extra arguments for service. - Consult "Options" section in <link xlink:href="https://github.com/z3APA3A/3proxy/wiki/3proxy.cfg">documentation</link> for available arguments. + Consult "Options" section in [documentation](https://github.com/z3APA3A/3proxy/wiki/3proxy.cfg) for available arguments. ''; }; extraConfig = mkOption { type = types.nullOr types.lines; default = null; - description = '' + description = lib.mdDoc '' Extra configuration for service. Use this to configure things like bandwidth limiter or ACL-based redirection. - Consult <link xlink:href="https://github.com/z3APA3A/3proxy/wiki/3proxy.cfg">documentation</link> for available options. + Consult [documentation](https://github.com/z3APA3A/3proxy/wiki/3proxy.cfg) for available options. ''; }; }; @@ -266,14 +266,14 @@ in { } ] ''; - description = '' + description = lib.mdDoc '' Use this option to define 3proxy services. ''; }; denyPrivate = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to deny access to private IP ranges including loopback. ''; }; @@ -290,7 +290,7 @@ in { "::1" "fc00::/7" ]; - description = '' + description = lib.mdDoc '' What IP ranges to deny access when denyPrivate is set tu true. ''; }; @@ -301,7 +301,7 @@ in { type = types.listOf types.str; default = [ ]; example = [ "127.0.0.53" "192.168.1.3:5353/tcp" ]; - description = '' + description = lib.mdDoc '' List of nameservers to use. Up to 5 nservers may be specified. If no nserver is configured, @@ -311,12 +311,12 @@ in { nscache = mkOption { type = types.int; default = 65535; - description = "Set name cache size for IPv4."; + description = lib.mdDoc "Set name cache size for IPv4."; }; nscache6 = mkOption { type = types.int; default = 65535; - description = "Set name cache size for IPv6."; + description = lib.mdDoc "Set name cache size for IPv6."; }; nsrecord = mkOption { type = types.attrsOf types.str; @@ -327,21 +327,21 @@ in { "site.local" = "192.168.1.43"; } ''; - description = "Adds static nsrecords."; + description = lib.mdDoc "Adds static nsrecords."; }; }; }; default = { }; - description = '' + description = lib.mdDoc '' Use this option to configure name resolution and DNS caching. ''; }; extraConfig = mkOption { type = types.nullOr types.lines; default = null; - description = '' + description = lib.mdDoc '' Extra configuration, appended to the 3proxy configuration file. - Consult <link xlink:href="https://github.com/z3APA3A/3proxy/wiki/3proxy.cfg">documentation</link> for available options. + Consult [documentation](https://github.com/z3APA3A/3proxy/wiki/3proxy.cfg) for available options. ''; }; }; diff --git a/nixos/modules/services/networking/adguardhome.nix b/nixos/modules/services/networking/adguardhome.nix index 98ddf0716087a..13ef78c10c53d 100644 --- a/nixos/modules/services/networking/adguardhome.nix +++ b/nixos/modules/services/networking/adguardhome.nix @@ -30,7 +30,7 @@ in { host = mkOption { default = "0.0.0.0"; type = str; - description = '' + description = lib.mdDoc '' Host address to bind HTTP server to. ''; }; @@ -38,7 +38,7 @@ in { port = mkOption { default = 3000; type = port; - description = '' + description = lib.mdDoc '' Port to serve HTTP pages on. ''; }; @@ -46,7 +46,7 @@ in { openFirewall = mkOption { default = false; type = bool; - description = '' + description = lib.mdDoc '' Open ports in the firewall for the AdGuard Home web interface. Does not open the port needed to access the DNS resolver. ''; @@ -55,7 +55,7 @@ in { mutableSettings = mkOption { default = true; type = bool; - description = '' + description = lib.mdDoc '' Allow changes made on the AdGuard Home web interface to persist between service restarts. ''; @@ -80,7 +80,7 @@ in { extraArgs = mkOption { default = [ ]; type = listOf str; - description = '' + description = lib.mdDoc '' Extra command line parameters to be passed to the adguardhome binary. ''; }; diff --git a/nixos/modules/services/networking/amuled.nix b/nixos/modules/services/networking/amuled.nix index aa72a047526b0..1cd543358196f 100644 --- a/nixos/modules/services/networking/amuled.nix +++ b/nixos/modules/services/networking/amuled.nix @@ -19,7 +19,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to run the AMule daemon. You need to manually run "amuled --ec-config" to configure the service for the first time. ''; }; @@ -30,7 +30,7 @@ in defaultText = literalExpression '' "/home/''${config.${opt.user}}/" ''; - description = '' + description = lib.mdDoc '' The directory holding configuration, incoming and temporary files. ''; }; @@ -38,7 +38,7 @@ in user = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The user the AMule daemon should run as. ''; }; diff --git a/nixos/modules/services/networking/antennas.nix b/nixos/modules/services/networking/antennas.nix index ef98af22f20f2..e3bde2b67d260 100644 --- a/nixos/modules/services/networking/antennas.nix +++ b/nixos/modules/services/networking/antennas.nix @@ -13,25 +13,25 @@ in tvheadendUrl = mkOption { type = types.str; default = "http://localhost:9981"; - description = "URL of Tvheadend."; + description = lib.mdDoc "URL of Tvheadend."; }; antennasUrl = mkOption { type = types.str; default = "http://127.0.0.1:5004"; - description = "URL of Antennas."; + description = lib.mdDoc "URL of Antennas."; }; tunerCount = mkOption { type = types.int; default = 6; - description = "Numbers of tuners in tvheadend."; + description = lib.mdDoc "Numbers of tuners in tvheadend."; }; deviceUUID = mkOption { type = types.str; default = "2f70c0d7-90a3-4429-8275-cbeeee9cd605"; - description = "Device tuner UUID. Change this if you are running multiple instances."; + description = lib.mdDoc "Device tuner UUID. Change this if you are running multiple instances."; }; }; }; diff --git a/nixos/modules/services/networking/aria2.nix b/nixos/modules/services/networking/aria2.nix index 156fef144791e..e848869cc0ac1 100644 --- a/nixos/modules/services/networking/aria2.nix +++ b/nixos/modules/services/networking/aria2.nix @@ -28,7 +28,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether or not to enable the headless Aria2 daemon service. Aria2 daemon can be controlled via the RPC interface using @@ -41,7 +41,7 @@ in openPorts = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open listen and RPC ports found in listenPortRange and rpcListenPort options in the firewall. ''; @@ -49,26 +49,26 @@ in downloadDir = mkOption { type = types.path; default = downloadDir; - description = '' + description = lib.mdDoc '' Directory to store downloaded files. ''; }; listenPortRange = mkOption { type = types.listOf types.attrs; default = [ { from = 6881; to = 6999; } ]; - description = '' + description = lib.mdDoc '' Set UDP listening port range used by DHT(IPv4, IPv6) and UDP tracker. ''; }; rpcListenPort = mkOption { type = types.int; default = 6800; - description = "Specify a port number for JSON-RPC/XML-RPC server to listen to. Possible Values: 1024-65535"; + description = lib.mdDoc "Specify a port number for JSON-RPC/XML-RPC server to listen to. Possible Values: 1024-65535"; }; rpcSecret = mkOption { type = types.str; default = "aria2rpc"; - description = '' + description = lib.mdDoc '' Set RPC secret authorization token. Read https://aria2.github.io/manual/en/html/aria2c.html#rpc-auth to know how this option value is used. ''; @@ -77,7 +77,7 @@ in type = types.separatedString " "; example = "--rpc-listen-all --remote-time=true"; default = ""; - description = '' + description = lib.mdDoc '' Additional arguments to be passed to Aria2. ''; }; diff --git a/nixos/modules/services/networking/asterisk.nix b/nixos/modules/services/networking/asterisk.nix index 297d0b3b2d02b..5a1d03f072117 100644 --- a/nixos/modules/services/networking/asterisk.nix +++ b/nixos/modules/services/networking/asterisk.nix @@ -59,7 +59,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the Asterisk PBX server. ''; }; @@ -72,9 +72,9 @@ in verbose=3 debug=3 ''; - description = '' + description = lib.mdDoc '' Extra configuration options appended to the default - <literal>asterisk.conf</literal> file. + `asterisk.conf` file. ''; }; @@ -127,19 +127,19 @@ in '''; } ''; - description = '' + description = lib.mdDoc '' Sets the content of config files (typically ending with - <literal>.conf</literal>) in the Asterisk configuration directory. + `.conf`) in the Asterisk configuration directory. - Note that if you want to change <literal>asterisk.conf</literal>, it - is preferable to use the <option>services.asterisk.extraConfig</option> - option over this option. If <literal>"asterisk.conf"</literal> is - specified with the <option>confFiles</option> option (not recommended), - you must be prepared to set your own <literal>astetcdir</literal> + Note that if you want to change `asterisk.conf`, it + is preferable to use the {option}`services.asterisk.extraConfig` + option over this option. If `"asterisk.conf"` is + specified with the {option}`confFiles` option (not recommended), + you must be prepared to set your own `astetcdir` path. See - <link xlink:href="http://www.asterisk.org/community/documentation"/> + <http://www.asterisk.org/community/documentation> for more examples of what is possible here. ''; }; @@ -148,9 +148,9 @@ in default = [ "ari.conf" "acl.conf" "agents.conf" "amd.conf" "calendar.conf" "cdr.conf" "cdr_syslog.conf" "cdr_custom.conf" "cel.conf" "cel_custom.conf" "cli_aliases.conf" "confbridge.conf" "dundi.conf" "features.conf" "hep.conf" "iax.conf" "pjsip.conf" "pjsip_wizard.conf" "phone.conf" "phoneprov.conf" "queues.conf" "res_config_sqlite3.conf" "res_parking.conf" "statsd.conf" "udptl.conf" "unistim.conf" ]; type = types.listOf types.str; example = [ "sip.conf" "dundi.conf" ]; - description = ''Sets these config files to the default content. The default value for + description = lib.mdDoc ''Sets these config files to the default content. The default value for this option contains all necesscary files to avoid errors at startup. - This does not override settings via <option>services.asterisk.confFiles</option>. + This does not override settings via {option}`services.asterisk.confFiles`. ''; }; @@ -159,7 +159,7 @@ in type = types.listOf types.str; example = [ "-vvvddd" "-e" "1024" ]; - description = '' + description = lib.mdDoc '' Additional command line arguments to pass to Asterisk. ''; }; @@ -167,7 +167,7 @@ in type = types.package; default = pkgs.asterisk; defaultText = literalExpression "pkgs.asterisk"; - description = "The Asterisk package to use."; + description = lib.mdDoc "The Asterisk package to use."; }; }; }; diff --git a/nixos/modules/services/networking/atftpd.nix b/nixos/modules/services/networking/atftpd.nix index da5e305201f86..e31b447e6c5b4 100644 --- a/nixos/modules/services/networking/atftpd.nix +++ b/nixos/modules/services/networking/atftpd.nix @@ -19,7 +19,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable the atftpd TFTP server. By default, the server binds to address 0.0.0.0. ''; @@ -33,7 +33,7 @@ in "--verbose=7" ] ''; - description = '' + description = lib.mdDoc '' Extra command line arguments to pass to atftp. ''; }; @@ -41,7 +41,7 @@ in root = mkOption { default = "/srv/tftp"; type = types.path; - description = '' + description = lib.mdDoc '' Document root directory for the atftpd. ''; }; diff --git a/nixos/modules/services/networking/autossh.nix b/nixos/modules/services/networking/autossh.nix index 245f2bfc2cf38..ed9c07d9a1470 100644 --- a/nixos/modules/services/networking/autossh.nix +++ b/nixos/modules/services/networking/autossh.nix @@ -22,18 +22,18 @@ in name = mkOption { type = types.str; example = "socks-peer"; - description = "Name of the local AutoSSH session"; + description = lib.mdDoc "Name of the local AutoSSH session"; }; user = mkOption { type = types.str; example = "bill"; - description = "Name of the user the AutoSSH session should run as"; + description = lib.mdDoc "Name of the user the AutoSSH session should run as"; }; monitoringPort = mkOption { type = types.int; default = 0; example = 20000; - description = '' + description = lib.mdDoc '' Port to be used by AutoSSH for peer monitoring. Note, that AutoSSH also uses mport+1. Value of 0 disables the keep-alive style monitoring @@ -42,7 +42,7 @@ in extraArguments = mkOption { type = types.separatedString " "; example = "-N -D4343 bill@socks.example.net"; - description = '' + description = lib.mdDoc '' Arguments to be passed to AutoSSH and retransmitted to SSH process. Some meaningful options include -N (don't run remote command), -D (open SOCKS proxy on local port), -R (forward @@ -54,7 +54,7 @@ in }); default = []; - description = '' + description = lib.mdDoc '' List of AutoSSH sessions to start as systemd services. Each service is named 'autossh-{session.name}'. ''; diff --git a/nixos/modules/services/networking/avahi-daemon.nix b/nixos/modules/services/networking/avahi-daemon.nix index 50c4ffdedce8d..498e5a4767083 100644 --- a/nixos/modules/services/networking/avahi-daemon.nix +++ b/nixos/modules/services/networking/avahi-daemon.nix @@ -43,7 +43,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to run the Avahi daemon, which allows Avahi clients to use Avahi's service discovery facilities and also allows the local machine to advertise its presence and services @@ -55,16 +55,16 @@ in type = types.str; default = config.networking.hostName; defaultText = literalExpression "config.networking.hostName"; - description = '' + description = lib.mdDoc '' Host name advertised on the LAN. If not set, avahi will use the value - of <option>config.networking.hostName</option>. + of {option}`config.networking.hostName`. ''; }; domainName = mkOption { type = types.str; default = "local"; - description = '' + description = lib.mdDoc '' Domain name for all advertisements. ''; }; @@ -73,7 +73,7 @@ in type = types.listOf types.str; default = [ ]; example = [ "0pointer.de" "zeroconf.org" ]; - description = '' + description = lib.mdDoc '' List of non-local DNS domains to be browsed. ''; }; @@ -81,22 +81,22 @@ in ipv4 = mkOption { type = types.bool; default = true; - description = "Whether to use IPv4."; + description = lib.mdDoc "Whether to use IPv4."; }; ipv6 = mkOption { type = types.bool; default = config.networking.enableIPv6; defaultText = literalExpression "config.networking.enableIPv6"; - description = "Whether to use IPv6."; + description = lib.mdDoc "Whether to use IPv6."; }; interfaces = mkOption { type = types.nullOr (types.listOf types.str); default = null; - description = '' - List of network interfaces that should be used by the <command>avahi-daemon</command>. - Other interfaces will be ignored. If <literal>null</literal>, all local interfaces + description = lib.mdDoc '' + List of network interfaces that should be used by the {command}`avahi-daemon`. + Other interfaces will be ignored. If `null`, all local interfaces except loopback and point-to-point will be used. ''; }; @@ -104,7 +104,7 @@ in openFirewall = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to open the firewall for UDP port 5353. ''; }; @@ -112,7 +112,7 @@ in allowPointToPoint = mkOption { type = types.bool; default = false; - description= '' + description= lib.mdDoc '' Whether to use POINTTOPOINT interfaces. Might make mDNS unreliable due to usually large latencies with such links and opens a potential security hole by allowing mDNS access from Internet connections. @@ -122,13 +122,13 @@ in wideArea = mkOption { type = types.bool; default = true; - description = "Whether to enable wide-area service discovery."; + description = lib.mdDoc "Whether to enable wide-area service discovery."; }; reflector = mkOption { type = types.bool; default = false; - description = "Reflect incoming mDNS requests to all allowed network interfaces."; + description = lib.mdDoc "Reflect incoming mDNS requests to all allowed network interfaces."; }; extraServiceFiles = mkOption { @@ -161,25 +161,25 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to allow publishing in general."; + description = lib.mdDoc "Whether to allow publishing in general."; }; userServices = mkOption { type = types.bool; default = false; - description = "Whether to publish user services. Will set <literal>addresses=true</literal>."; + description = lib.mdDoc "Whether to publish user services. Will set `addresses=true`."; }; addresses = mkOption { type = types.bool; default = false; - description = "Whether to register mDNS address records for all local IP addresses."; + description = lib.mdDoc "Whether to register mDNS address records for all local IP addresses."; }; hinfo = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to register a mDNS HINFO record which contains information about the local operating system and CPU. ''; @@ -188,7 +188,7 @@ in workstation = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to register a service of type "_workstation._tcp" on the local LAN. ''; }; @@ -196,14 +196,14 @@ in domain = mkOption { type = types.bool; default = false; - description = "Whether to announce the locally used domain name for browsing by other hosts."; + description = lib.mdDoc "Whether to announce the locally used domain name for browsing by other hosts."; }; }; nssmdns = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the mDNS NSS (Name Service Switch) plug-in. Enabling it allows applications to resolve names in the `.local' domain by transparently querying the Avahi daemon. @@ -213,7 +213,7 @@ in cacheEntriesMax = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Number of resource records to be cached per interface. Use 0 to disable caching. Avahi daemon defaults to 4096 if not set. ''; @@ -222,7 +222,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra config to append to avahi-daemon.conf. ''; }; diff --git a/nixos/modules/services/networking/babeld.nix b/nixos/modules/services/networking/babeld.nix index aae6f1498a426..b393b6e059209 100644 --- a/nixos/modules/services/networking/babeld.nix +++ b/nixos/modules/services/networking/babeld.nix @@ -44,9 +44,9 @@ in interfaceDefaults = mkOption { default = null; - description = '' + description = lib.mdDoc '' A set describing default parameters for babeld interfaces. - See <citerefentry><refentrytitle>babeld</refentrytitle><manvolnum>8</manvolnum></citerefentry> for options. + See {manpage}`babeld(8)` for options. ''; type = types.nullOr (types.attrsOf types.unspecified); example = @@ -58,9 +58,9 @@ in interfaces = mkOption { default = {}; - description = '' + description = lib.mdDoc '' A set describing babeld interfaces. - See <citerefentry><refentrytitle>babeld</refentrytitle><manvolnum>8</manvolnum></citerefentry> for options. + See {manpage}`babeld(8)` for options. ''; type = types.attrsOf (types.attrsOf types.unspecified); example = @@ -75,9 +75,9 @@ in extraConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Options that will be copied to babeld.conf. - See <citerefentry><refentrytitle>babeld</refentrytitle><manvolnum>8</manvolnum></citerefentry> for details. + See {manpage}`babeld(8)` for details. ''; }; }; diff --git a/nixos/modules/services/networking/bee-clef.nix b/nixos/modules/services/networking/bee-clef.nix index 719714b289827..852e1396b9159 100644 --- a/nixos/modules/services/networking/bee-clef.nix +++ b/nixos/modules/services/networking/bee-clef.nix @@ -19,7 +19,7 @@ in { dataDir = mkOption { type = types.nullOr types.str; default = "/var/lib/bee-clef"; - description = '' + description = lib.mdDoc '' Data dir for bee-clef. Beware that some helper scripts may not work when changed! The service itself should work fine, though. ''; @@ -28,13 +28,13 @@ in { passwordFile = mkOption { type = types.nullOr types.str; default = "/var/lib/bee-clef/password"; - description = "Password file for bee-clef."; + description = lib.mdDoc "Password file for bee-clef."; }; user = mkOption { type = types.str; default = "bee-clef"; - description = '' + description = lib.mdDoc '' User the bee-clef daemon should execute under. ''; }; @@ -42,7 +42,7 @@ in { group = mkOption { type = types.str; default = "bee-clef"; - description = '' + description = lib.mdDoc '' Group the bee-clef daemon should execute under. ''; }; diff --git a/nixos/modules/services/networking/bee.nix b/nixos/modules/services/networking/bee.nix index d6efade0630ff..a99513cb8cc79 100644 --- a/nixos/modules/services/networking/bee.nix +++ b/nixos/modules/services/networking/bee.nix @@ -22,14 +22,14 @@ in { default = pkgs.bee; defaultText = literalExpression "pkgs.bee"; example = literalExpression "pkgs.bee-unstable"; - description = "The package providing the bee binary for the service."; + description = lib.mdDoc "The package providing the bee binary for the service."; }; settings = mkOption { type = format.type; - description = '' + description = lib.mdDoc '' Ethereum Swarm Bee configuration. Refer to - <link xlink:href="https://gateway.ethswarm.org/bzz/docs.swarm.eth/docs/installation/configuration/"/> + <https://gateway.ethswarm.org/bzz/docs.swarm.eth/docs/installation/configuration/> for details on supported values. ''; }; @@ -37,7 +37,7 @@ in { daemonNiceLevel = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' Daemon process priority for bee. 0 is the default Unix process priority, 19 is the lowest. ''; @@ -46,7 +46,7 @@ in { user = mkOption { type = types.str; default = "bee"; - description = '' + description = lib.mdDoc '' User the bee binary should execute under. ''; }; @@ -54,7 +54,7 @@ in { group = mkOption { type = types.str; default = "bee"; - description = '' + description = lib.mdDoc '' Group the bee binary should execute under. ''; }; diff --git a/nixos/modules/services/networking/biboumi.nix b/nixos/modules/services/networking/biboumi.nix index 3f46b95eaf0c0..7e60330088324 100644 --- a/nixos/modules/services/networking/biboumi.nix +++ b/nixos/modules/services/networking/biboumi.nix @@ -19,8 +19,8 @@ in enable = mkEnableOption "the Biboumi XMPP gateway to IRC"; settings = mkOption { - description = '' - See <link xlink:href="https://lab.louiz.org/louiz/biboumi/blob/8.5/doc/biboumi.1.rst">biboumi 8.5</link> + description = lib.mdDoc '' + See [biboumi 8.5](https://lab.louiz.org/louiz/biboumi/blob/8.5/doc/biboumi.1.rst) for documentation. ''; default = {}; @@ -34,7 +34,7 @@ in default = []; example = ["admin@example.org"]; apply = concatStringsSep ":"; - description = '' + description = lib.mdDoc '' The bare JID of the gateway administrator. This JID will have more privileges than other standard users, for example some administration ad-hoc commands will only be available to that JID. @@ -43,7 +43,7 @@ in options.ca_file = mkOption { type = types.path; default = "/etc/ssl/certs/ca-certificates.crt"; - description = '' + description = lib.mdDoc '' Specifies which file should be used as the list of trusted CA when negociating a TLS session. ''; @@ -51,7 +51,7 @@ in options.db_name = mkOption { type = with types; either path str; default = "${stateDir}/biboumi.sqlite"; - description = '' + description = lib.mdDoc '' The name of the database to use. ''; example = "postgresql://user:secret@localhost"; @@ -59,7 +59,7 @@ in options.hostname = mkOption { type = types.str; example = "biboumi.example.org"; - description = '' + description = lib.mdDoc '' The hostname served by the XMPP gateway. This domain must be configured in the XMPP server as an external component. @@ -69,14 +69,14 @@ in type = types.port; default = 113; example = 0; - description = '' + description = lib.mdDoc '' The TCP port on which to listen for identd queries. ''; }; options.log_level = mkOption { type = types.ints.between 0 3; default = 1; - description = '' + description = lib.mdDoc '' Indicate what type of log messages to write in the logs. 0 is debug, 1 is info, 2 is warning, 3 is error. ''; @@ -96,7 +96,7 @@ in options.persistent_by_default = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether all rooms will be persistent by default: the value of the “persistent” option in the global configuration of each user will be “true”, but the value of each individual room will still @@ -108,7 +108,7 @@ in type = types.path; default = "${pkgs.biboumi}/etc/biboumi"; defaultText = literalExpression ''"''${pkgs.biboumi}/etc/biboumi"''; - description = '' + description = lib.mdDoc '' A directory that should contain the policy files, used to customize Botan’s behaviour when negociating the TLS connections with the IRC servers. @@ -117,14 +117,14 @@ in options.port = mkOption { type = types.port; default = 5347; - description = '' + description = lib.mdDoc '' The TCP port to use to connect to the local XMPP component. ''; }; options.realname_customization = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether the users will be able to use the ad-hoc commands that lets them configure their realname and username. @@ -133,7 +133,7 @@ in options.realname_from_jid = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether the realname and username of each biboumi user will be extracted from their JID. Otherwise they will be set to the nick @@ -143,7 +143,7 @@ in options.xmpp_server_ip = mkOption { type = types.str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' The IP address to connect to the XMPP server on. The connection to the XMPP server is unencrypted, so the biboumi instance and the server should diff --git a/nixos/modules/services/networking/bind.nix b/nixos/modules/services/networking/bind.nix index 2045612ec0549..0966332f7d0d2 100644 --- a/nixos/modules/services/networking/bind.nix +++ b/nixos/modules/services/networking/bind.nix @@ -17,28 +17,28 @@ let name = mkOption { type = types.str; default = name; - description = "Name of the zone."; + description = lib.mdDoc "Name of the zone."; }; master = mkOption { - description = "Master=false means slave server"; + description = lib.mdDoc "Master=false means slave server"; type = types.bool; }; file = mkOption { type = types.either types.str types.path; - description = "Zone file resource records contain columns of data, separated by whitespace, that define the record."; + description = lib.mdDoc "Zone file resource records contain columns of data, separated by whitespace, that define the record."; }; masters = mkOption { type = types.listOf types.str; - description = "List of servers for inclusion in stub and secondary zones."; + description = lib.mdDoc "List of servers for inclusion in stub and secondary zones."; }; slaves = mkOption { type = types.listOf types.str; - description = "Addresses who may request zone transfers."; + description = lib.mdDoc "Addresses who may request zone transfers."; default = [ ]; }; extraConfig = mkOption { type = types.str; - description = "Extra zone config to be appended at the end of the zone section."; + description = lib.mdDoc "Extra zone config to be appended at the end of the zone section."; default = ""; }; }; @@ -111,7 +111,7 @@ in type = types.package; default = pkgs.bind; defaultText = literalExpression "pkgs.bind"; - description = "The BIND package to use."; + description = lib.mdDoc "The BIND package to use."; }; cacheNetworks = mkOption { @@ -178,7 +178,7 @@ in directory = mkOption { type = types.str; default = "/run/named"; - description = "Working directory of BIND."; + description = lib.mdDoc "Working directory of BIND."; }; zones = mkOption { @@ -209,7 +209,7 @@ in extraOptions = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra lines to be added verbatim to the options section of the generated named configuration file. ''; diff --git a/nixos/modules/services/networking/bird-lg.nix b/nixos/modules/services/networking/bird-lg.nix index 515ef38608b4b..db4a4140dd406 100644 --- a/nixos/modules/services/networking/bird-lg.nix +++ b/nixos/modules/services/networking/bird-lg.nix @@ -12,19 +12,19 @@ in type = types.package; default = pkgs.bird-lg; defaultText = literalExpression "pkgs.bird-lg"; - description = "The Bird Looking Glass package to use."; + description = lib.mdDoc "The Bird Looking Glass package to use."; }; user = mkOption { type = types.str; default = "bird-lg"; - description = "User to run the service."; + description = lib.mdDoc "User to run the service."; }; group = mkOption { type = types.str; default = "bird-lg"; - description = "Group to run the service."; + description = lib.mdDoc "Group to run the service."; }; frontend = { @@ -33,103 +33,103 @@ in listenAddress = mkOption { type = types.str; default = "127.0.0.1:5000"; - description = "Address to listen on."; + description = lib.mdDoc "Address to listen on."; }; proxyPort = mkOption { type = types.port; default = 8000; - description = "Port bird-lg-proxy is running on."; + description = lib.mdDoc "Port bird-lg-proxy is running on."; }; domain = mkOption { type = types.str; default = ""; example = "dn42.lantian.pub"; - description = "Server name domain suffixes."; + description = lib.mdDoc "Server name domain suffixes."; }; servers = mkOption { type = types.listOf types.str; default = [ ]; example = [ "gigsgigscloud" "hostdare" ]; - description = "Server name prefixes."; + description = lib.mdDoc "Server name prefixes."; }; whois = mkOption { type = types.str; default = "whois.verisign-grs.com"; - description = "Whois server for queries."; + description = lib.mdDoc "Whois server for queries."; }; dnsInterface = mkOption { type = types.str; default = "asn.cymru.com"; - description = "DNS zone to query ASN information."; + description = lib.mdDoc "DNS zone to query ASN information."; }; bgpMapInfo = mkOption { type = types.listOf types.str; default = [ "asn" "as-name" "ASName" "descr" ]; - description = "Information displayed in bgpmap."; + description = lib.mdDoc "Information displayed in bgpmap."; }; titleBrand = mkOption { type = types.str; default = "Bird-lg Go"; - description = "Prefix of page titles in browser tabs."; + description = lib.mdDoc "Prefix of page titles in browser tabs."; }; netSpecificMode = mkOption { type = types.str; default = ""; example = "dn42"; - description = "Apply network-specific changes for some networks."; + description = lib.mdDoc "Apply network-specific changes for some networks."; }; protocolFilter = mkOption { type = types.listOf types.str; default = [ ]; example = [ "ospf" ]; - description = "Information displayed in bgpmap."; + description = lib.mdDoc "Information displayed in bgpmap."; }; nameFilter = mkOption { type = types.str; default = ""; example = "^ospf"; - description = "Protocol names to hide in summary tables (RE2 syntax),"; + description = lib.mdDoc "Protocol names to hide in summary tables (RE2 syntax),"; }; timeout = mkOption { type = types.int; default = 120; - description = "Time before request timed out, in seconds."; + description = lib.mdDoc "Time before request timed out, in seconds."; }; navbar = { brand = mkOption { type = types.str; default = "Bird-lg Go"; - description = "Brand to show in the navigation bar ."; + description = lib.mdDoc "Brand to show in the navigation bar ."; }; brandURL = mkOption { type = types.str; default = "/"; - description = "URL of the brand to show in the navigation bar."; + description = lib.mdDoc "URL of the brand to show in the navigation bar."; }; allServers = mkOption { type = types.str; default = "ALL Servers"; - description = "Text of 'All server' button in the navigation bar."; + description = lib.mdDoc "Text of 'All server' button in the navigation bar."; }; allServersURL = mkOption { type = types.str; default = "all"; - description = "URL of 'All servers' button."; + description = lib.mdDoc "URL of 'All servers' button."; }; }; @@ -148,21 +148,21 @@ in listenAddress = mkOption { type = types.str; default = "127.0.0.1:8000"; - description = "Address to listen on."; + description = lib.mdDoc "Address to listen on."; }; allowedIPs = mkOption { type = types.listOf types.str; default = [ ]; example = [ "192.168.25.52" "192.168.25.53" ]; - description = "List of IPs to allow (default all allowed)."; + description = lib.mdDoc "List of IPs to allow (default all allowed)."; }; birdSocket = mkOption { type = types.str; default = "/run/bird.ctl"; example = "/var/run/bird/bird.ctl"; - description = "Bird control socket path."; + description = lib.mdDoc "Bird control socket path."; }; traceroute = { @@ -170,13 +170,13 @@ in type = types.str; default = "${pkgs.traceroute}/bin/traceroute"; defaultText = literalExpression ''"''${pkgs.traceroute}/bin/traceroute"''; - description = "Traceroute's binary path."; + description = lib.mdDoc "Traceroute's binary path."; }; rawOutput = mkOption { type = types.bool; default = false; - description = "Display traceroute output in raw format."; + description = lib.mdDoc "Display traceroute output in raw format."; }; }; diff --git a/nixos/modules/services/networking/bitcoind.nix b/nixos/modules/services/networking/bitcoind.nix index 80033d958609e..1788d5fcf58d3 100644 --- a/nixos/modules/services/networking/bitcoind.nix +++ b/nixos/modules/services/networking/bitcoind.nix @@ -11,7 +11,7 @@ let name = mkOption { type = types.str; example = "alice"; - description = '' + description = lib.mdDoc '' Username for JSON-RPC connections. ''; }; @@ -41,14 +41,14 @@ let type = types.package; default = pkgs.bitcoind; defaultText = literalExpression "pkgs.bitcoind"; - description = "The package providing bitcoin binaries."; + description = lib.mdDoc "The package providing bitcoin binaries."; }; configFile = mkOption { type = types.nullOr types.path; default = null; example = "/var/lib/${name}/bitcoin.conf"; - description = "The configuration file path to supply bitcoind."; + description = lib.mdDoc "The configuration file path to supply bitcoind."; }; extraConfig = mkOption { @@ -59,32 +59,32 @@ let rpcthreads=16 logips=1 ''; - description = "Additional configurations to be appended to <filename>bitcoin.conf</filename>."; + description = lib.mdDoc "Additional configurations to be appended to {file}`bitcoin.conf`."; }; dataDir = mkOption { type = types.path; default = "/var/lib/bitcoind-${name}"; - description = "The data directory for bitcoind."; + description = lib.mdDoc "The data directory for bitcoind."; }; user = mkOption { type = types.str; default = "bitcoind-${name}"; - description = "The user as which to run bitcoind."; + description = lib.mdDoc "The user as which to run bitcoind."; }; group = mkOption { type = types.str; default = config.user; - description = "The group as which to run bitcoind."; + description = lib.mdDoc "The group as which to run bitcoind."; }; rpc = { port = mkOption { type = types.nullOr types.port; default = null; - description = "Override the default port on which to listen for JSON-RPC connections."; + description = lib.mdDoc "Override the default port on which to listen for JSON-RPC connections."; }; users = mkOption { default = {}; @@ -95,33 +95,33 @@ let } ''; type = types.attrsOf (types.submodule rpcUserOpts); - description = "RPC user information for JSON-RPC connnections."; + description = lib.mdDoc "RPC user information for JSON-RPC connnections."; }; }; pidFile = mkOption { type = types.path; default = "${config.dataDir}/bitcoind.pid"; - description = "Location of bitcoind pid file."; + description = lib.mdDoc "Location of bitcoind pid file."; }; testnet = mkOption { type = types.bool; default = false; - description = "Whether to use the testnet instead of mainnet."; + description = lib.mdDoc "Whether to use the testnet instead of mainnet."; }; port = mkOption { type = types.nullOr types.port; default = null; - description = "Override the default port on which to listen for connections."; + description = lib.mdDoc "Override the default port on which to listen for connections."; }; dbCache = mkOption { type = types.nullOr (types.ints.between 4 16384); default = null; example = 4000; - description = "Override the default database cache size in MiB."; + description = lib.mdDoc "Override the default database cache size in MiB."; }; prune = mkOption { @@ -132,7 +132,7 @@ let ); default = null; example = 10000; - description = '' + description = lib.mdDoc '' Reduce storage requirements by enabling pruning (deleting) of old blocks. This allows the pruneblockchain RPC to be called to delete specific blocks, and enables automatic pruning of old blocks if a @@ -147,7 +147,7 @@ let extraCmdlineOptions = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Extra command line options to pass to bitcoind. Run bitcoind --help to list all available options. ''; @@ -161,7 +161,7 @@ in services.bitcoind = mkOption { type = types.attrsOf (types.submodule bitcoindOpts); default = {}; - description = "Specification of one or more bitcoind instances."; + description = lib.mdDoc "Specification of one or more bitcoind instances."; }; }; diff --git a/nixos/modules/services/networking/bitlbee.nix b/nixos/modules/services/networking/bitlbee.nix index f76cffc79bfa4..e2844feda0284 100644 --- a/nixos/modules/services/networking/bitlbee.nix +++ b/nixos/modules/services/networking/bitlbee.nix @@ -49,7 +49,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to run the BitlBee IRC to other chat network gateway. Running it allows you to access the MSN, Jabber, Yahoo! and ICQ chat networks via an IRC client. @@ -69,7 +69,7 @@ in portNumber = mkOption { default = 6667; type = types.int; - description = '' + description = lib.mdDoc '' Number of the port BitlBee will be listening to. ''; }; @@ -77,7 +77,7 @@ in authBackend = mkOption { default = "storage"; type = types.enum [ "storage" "pam" ]; - description = '' + description = lib.mdDoc '' How users are authenticated storage -- save passwords internally pam -- Linux PAM authentication @@ -87,7 +87,7 @@ in authMode = mkOption { default = "Open"; type = types.enum [ "Open" "Closed" "Registered" ]; - description = '' + description = lib.mdDoc '' The following authentication modes are available: Open -- Accept connections from anyone, use NickServ for user authentication. Closed -- Require authorization (using the PASS command during login) before allowing the user to connect at all. @@ -98,7 +98,7 @@ in hostName = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' Normally, BitlBee gets a hostname using getsockname(). If you have a nicer alias for your BitlBee daemon, you can set it here and BitlBee will identify itself with that name instead. @@ -109,7 +109,7 @@ in type = types.listOf types.package; default = []; example = literalExpression "[ pkgs.bitlbee-facebook ]"; - description = '' + description = lib.mdDoc '' The list of bitlbee plugins to install. ''; }; @@ -118,7 +118,7 @@ in type = types.listOf types.package; default = []; example = literalExpression "[ pkgs.purple-matrix ]"; - description = '' + description = lib.mdDoc '' The list of libpurple plugins to install. ''; }; @@ -126,7 +126,7 @@ in configDir = mkOption { default = "/var/lib/bitlbee"; type = types.path; - description = '' + description = lib.mdDoc '' Specify an alternative directory to store all the per-user configuration files. ''; @@ -135,7 +135,7 @@ in protocols = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' This option allows to remove the support of protocol, even if compiled in. If nothing is given, there are no restrictions. ''; @@ -144,7 +144,7 @@ in extraSettings = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Will be inserted in the Settings section of the config file. ''; }; @@ -152,7 +152,7 @@ in extraDefaults = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Will be inserted in the Default section of the config file. ''; }; diff --git a/nixos/modules/services/networking/blockbook-frontend.nix b/nixos/modules/services/networking/blockbook-frontend.nix index eeea521c8d510..0164883c7470c 100644 --- a/nixos/modules/services/networking/blockbook-frontend.nix +++ b/nixos/modules/services/networking/blockbook-frontend.nix @@ -16,28 +16,28 @@ let type = types.package; default = pkgs.blockbook; defaultText = literalExpression "pkgs.blockbook"; - description = "Which blockbook package to use."; + description = lib.mdDoc "Which blockbook package to use."; }; user = mkOption { type = types.str; default = "blockbook-frontend-${name}"; - description = "The user as which to run blockbook-frontend-${name}."; + description = lib.mdDoc "The user as which to run blockbook-frontend-${name}."; }; group = mkOption { type = types.str; default = "${config.user}"; - description = "The group as which to run blockbook-frontend-${name}."; + description = lib.mdDoc "The group as which to run blockbook-frontend-${name}."; }; certFile = mkOption { type = types.nullOr types.path; default = null; example = "/etc/secrets/blockbook-frontend-${name}/certFile"; - description = '' + description = lib.mdDoc '' To enable SSL, specify path to the name of certificate files without extension. - Expecting <filename>certFile.crt</filename> and <filename>certFile.key</filename>. + Expecting {file}`certFile.crt` and {file}`certFile.key`. ''; }; @@ -45,14 +45,14 @@ let type = with types; nullOr path; default = null; example = "${config.dataDir}/config.json"; - description = "Location of the blockbook configuration file."; + description = lib.mdDoc "Location of the blockbook configuration file."; }; coinName = mkOption { type = types.str; default = "Bitcoin"; - description = '' - See <link xlink:href="https://github.com/trezor/blockbook/blob/master/bchain/coins/blockchain.go#L61"/> + description = lib.mdDoc '' + See <https://github.com/trezor/blockbook/blob/master/bchain/coins/blockchain.go#L61> for current of coins supported in master (Note: may differ from release). ''; }; @@ -62,8 +62,8 @@ let default = "${config.package}/share/css/"; defaultText = literalExpression ''"''${package}/share/css/"''; example = literalExpression ''"''${dataDir}/static/css/"''; - description = '' - Location of the dir with <filename>main.css</filename> CSS file. + description = lib.mdDoc '' + Location of the dir with {file}`main.css` CSS file. By default, the one shipped with the package is used. ''; }; @@ -71,68 +71,68 @@ let dataDir = mkOption { type = types.path; default = "/var/lib/blockbook-frontend-${name}"; - description = "Location of blockbook-frontend-${name} data directory."; + description = lib.mdDoc "Location of blockbook-frontend-${name} data directory."; }; debug = mkOption { type = types.bool; default = false; - description = "Debug mode, return more verbose errors, reload templates on each request."; + description = lib.mdDoc "Debug mode, return more verbose errors, reload templates on each request."; }; internal = mkOption { type = types.nullOr types.str; default = ":9030"; - description = "Internal http server binding <literal>[address]:port</literal>."; + description = lib.mdDoc "Internal http server binding `[address]:port`."; }; messageQueueBinding = mkOption { type = types.str; default = "tcp://127.0.0.1:38330"; - description = "Message Queue Binding <literal>address:port</literal>."; + description = lib.mdDoc "Message Queue Binding `address:port`."; }; public = mkOption { type = types.nullOr types.str; default = ":9130"; - description = "Public http server binding <literal>[address]:port</literal>."; + description = lib.mdDoc "Public http server binding `[address]:port`."; }; rpc = { url = mkOption { type = types.str; default = "http://127.0.0.1"; - description = "URL for JSON-RPC connections."; + description = lib.mdDoc "URL for JSON-RPC connections."; }; port = mkOption { type = types.port; default = 8030; - description = "Port for JSON-RPC connections."; + description = lib.mdDoc "Port for JSON-RPC connections."; }; user = mkOption { type = types.str; default = "rpc"; - description = "Username for JSON-RPC connections."; + description = lib.mdDoc "Username for JSON-RPC connections."; }; password = mkOption { type = types.str; default = "rpc"; - description = '' + description = lib.mdDoc '' RPC password for JSON-RPC connections. Warning: this is stored in cleartext in the Nix store!!! - Use <literal>configFile</literal> or <literal>passwordFile</literal> if needed. + Use `configFile` or `passwordFile` if needed. ''; }; passwordFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' File containing password of the RPC user. - Note: This options is ignored when <literal>configFile</literal> is used. + Note: This options is ignored when `configFile` is used. ''; }; }; @@ -140,7 +140,7 @@ let sync = mkOption { type = types.bool; default = true; - description = "Synchronizes until tip, if together with zeromq, keeps index synchronized."; + description = lib.mdDoc "Synchronizes until tip, if together with zeromq, keeps index synchronized."; }; templateDir = mkOption { @@ -148,7 +148,7 @@ let default = "${config.package}/share/templates/"; defaultText = literalExpression ''"''${package}/share/templates/"''; example = literalExpression ''"''${dataDir}/templates/static/"''; - description = "Location of the HTML templates. By default, ones shipped with the package are used."; + description = lib.mdDoc "Location of the HTML templates. By default, ones shipped with the package are used."; }; extraConfig = mkOption { @@ -171,10 +171,10 @@ let "mempool_sub_workers" = 2; "block_addresses_to_keep" = 300; }''; - description = '' - Additional configurations to be appended to <filename>coin.conf</filename>. + description = lib.mdDoc '' + Additional configurations to be appended to {file}`coin.conf`. Overrides any already defined configuration options. - See <link xlink:href="https://github.com/trezor/blockbook/tree/master/configs/coins"/> + See <https://github.com/trezor/blockbook/tree/master/configs/coins> for current configuration options supported in master (Note: may differ from release). ''; }; @@ -183,7 +183,7 @@ let type = types.listOf types.str; default = []; example = [ "-workers=1" "-dbcache=0" "-logtosderr" ]; - description = '' + description = lib.mdDoc '' Extra command line options to pass to Blockbook. Run blockbook --help to list all available options. ''; @@ -198,7 +198,7 @@ in services.blockbook-frontend = mkOption { type = types.attrsOf (types.submodule blockbookOpts); default = {}; - description = "Specification of one or more blockbook-frontend instances."; + description = lib.mdDoc "Specification of one or more blockbook-frontend instances."; }; }; diff --git a/nixos/modules/services/networking/blocky.nix b/nixos/modules/services/networking/blocky.nix index 7488e05fc0331..42eab14596677 100644 --- a/nixos/modules/services/networking/blocky.nix +++ b/nixos/modules/services/networking/blocky.nix @@ -15,9 +15,9 @@ in settings = mkOption { type = format.type; default = { }; - description = '' + description = lib.mdDoc '' Blocky configuration. Refer to - <link xlink:href="https://0xerr0r.github.io/blocky/configuration/"/> + <https://0xerr0r.github.io/blocky/configuration/> for details on supported values. ''; }; diff --git a/nixos/modules/services/networking/charybdis.nix b/nixos/modules/services/networking/charybdis.nix index ff09c0160cb67..c875557a1a38e 100644 --- a/nixos/modules/services/networking/charybdis.nix +++ b/nixos/modules/services/networking/charybdis.nix @@ -22,7 +22,7 @@ in config = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Charybdis IRC daemon configuration file. ''; }; @@ -30,7 +30,7 @@ in statedir = mkOption { type = types.path; default = "/var/lib/charybdis"; - description = '' + description = lib.mdDoc '' Location of the state directory of charybdis. ''; }; @@ -38,7 +38,7 @@ in user = mkOption { type = types.str; default = "ircd"; - description = '' + description = lib.mdDoc '' Charybdis IRC daemon user. ''; }; @@ -46,7 +46,7 @@ in group = mkOption { type = types.str; default = "ircd"; - description = '' + description = lib.mdDoc '' Charybdis IRC daemon group. ''; }; @@ -54,7 +54,7 @@ in motd = mkOption { type = types.nullOr types.lines; default = null; - description = '' + description = lib.mdDoc '' Charybdis MOTD text. Charybdis will read its MOTD from /etc/charybdis/ircd.motd . diff --git a/nixos/modules/services/networking/cjdns.nix b/nixos/modules/services/networking/cjdns.nix index 0d97d379e907e..5a19475161fdf 100644 --- a/nixos/modules/services/networking/cjdns.nix +++ b/nixos/modules/services/networking/cjdns.nix @@ -13,27 +13,27 @@ let { options = { password = mkOption { type = types.str; - description = "Authorized password to the opposite end of the tunnel."; + description = lib.mdDoc "Authorized password to the opposite end of the tunnel."; }; login = mkOption { default = ""; type = types.str; - description = "(optional) name your peer has for you"; + description = lib.mdDoc "(optional) name your peer has for you"; }; peerName = mkOption { default = ""; type = types.str; - description = "(optional) human-readable name for peer"; + description = lib.mdDoc "(optional) human-readable name for peer"; }; publicKey = mkOption { type = types.str; - description = "Public key at the opposite end of the tunnel."; + description = lib.mdDoc "Public key at the opposite end of the tunnel."; }; hostname = mkOption { default = ""; example = "foobar.hype"; type = types.str; - description = "Optional hostname to add to /etc/hosts; prevents reverse lookup failures."; + description = lib.mdDoc "Optional hostname to add to /etc/hosts; prevents reverse lookup failures."; }; }; }; @@ -87,7 +87,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the cjdns network encryption and routing engine. A file at /etc/cjdns.keys will be created if it does not exist to contain a random @@ -99,7 +99,7 @@ in type = types.attrs; default = {}; example = { router.interface.tunDevice = "tun10"; }; - description = '' + description = lib.mdDoc '' Extra configuration, given as attrs, that will be merged recursively with the rest of the JSON generated by this module, at the root node. ''; @@ -109,7 +109,7 @@ in type = types.nullOr types.path; default = null; example = "/etc/cjdroute.conf"; - description = '' + description = lib.mdDoc '' Ignore all other cjdns options and load configuration from this file. ''; }; @@ -122,7 +122,7 @@ in "z9md3t4p45mfrjzdjurxn4wuj0d8swv" "49275fut6tmzu354pq70sr5b95qq0vj" ]; - description = '' + description = lib.mdDoc '' Any remote cjdns nodes that offer these passwords on connection will be allowed to route through this node. ''; @@ -132,7 +132,7 @@ in bind = mkOption { type = types.str; default = "127.0.0.1:11234"; - description = '' + description = lib.mdDoc '' Bind the administration port to this address and port. ''; }; @@ -143,7 +143,7 @@ in type = types.str; default = ""; example = "192.168.1.32:43211"; - description = '' + description = lib.mdDoc '' Address and port to bind UDP tunnels to. ''; }; @@ -159,7 +159,7 @@ in }; } ''; - description = '' + description = lib.mdDoc '' Credentials for making UDP tunnels. ''; }; @@ -171,16 +171,16 @@ in default = ""; example = "eth0"; description = - '' + lib.mdDoc '' Bind to this device for native ethernet operation. - <literal>all</literal> is a pseudo-name which will try to connect to all devices. + `all` is a pseudo-name which will try to connect to all devices. ''; }; beacon = mkOption { type = types.int; default = 2; - description = '' + description = lib.mdDoc '' Auto-connect to other cjdns nodes on the same network. Options: 0: Disabled. @@ -206,7 +206,7 @@ in }; } ''; - description = '' + description = lib.mdDoc '' Credentials for connecting look similar to UDP credientials except they begin with the mac address. ''; @@ -216,9 +216,9 @@ in addExtraHosts = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to add cjdns peers with an associated hostname to - <filename>/etc/hosts</filename>. Beware that enabling this + {file}`/etc/hosts`. Beware that enabling this incurs heavy eval-time costs. ''; }; diff --git a/nixos/modules/services/networking/cloudflare-dyndns.nix b/nixos/modules/services/networking/cloudflare-dyndns.nix index ab5b1a08539a5..5dd90cfe35baa 100644 --- a/nixos/modules/services/networking/cloudflare-dyndns.nix +++ b/nixos/modules/services/networking/cloudflare-dyndns.nix @@ -23,7 +23,7 @@ in domains = mkOption { type = types.listOf types.str; default = [ ]; - description = '' + description = lib.mdDoc '' List of domain names to update records for. ''; }; @@ -31,7 +31,7 @@ in proxied = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether this is a DNS-only record, or also being proxied through CloudFlare. ''; }; @@ -39,7 +39,7 @@ in ipv4 = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable setting IPv4 A records. ''; }; @@ -47,7 +47,7 @@ in ipv6 = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable setting IPv6 AAAA records. ''; }; @@ -55,7 +55,7 @@ in deleteMissing = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to delete the record when no IP address is found. ''; }; diff --git a/nixos/modules/services/networking/cntlm.nix b/nixos/modules/services/networking/cntlm.nix index eea28e12ce0ea..2b5d0583c653b 100644 --- a/nixos/modules/services/networking/cntlm.nix +++ b/nixos/modules/services/networking/cntlm.nix @@ -37,33 +37,33 @@ in username = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Proxy account name, without the possibility to include domain name ('at' sign is interpreted literally). ''; }; domain = mkOption { type = types.str; - description = "Proxy account domain/workgroup name."; + description = lib.mdDoc "Proxy account domain/workgroup name."; }; password = mkOption { default = "/etc/cntlm.password"; type = types.str; - description = "Proxy account password. Note: use chmod 0600 on /etc/cntlm.password for security."; + description = lib.mdDoc "Proxy account password. Note: use chmod 0600 on /etc/cntlm.password for security."; }; netbios_hostname = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' The hostname of your machine. ''; }; proxy = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' A list of NTLM/NTLMv2 authenticating HTTP proxies. Parent proxy, which requires authentication. The same as proxy on the command-line, can be used more than once to specify unlimited @@ -74,7 +74,7 @@ in }; noproxy = mkOption { - description = '' + description = lib.mdDoc '' A list of domains where the proxy is skipped. ''; default = []; @@ -85,19 +85,19 @@ in port = mkOption { default = [3128]; type = types.listOf types.port; - description = "Specifies on which ports the cntlm daemon listens."; + description = lib.mdDoc "Specifies on which ports the cntlm daemon listens."; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Additional config appended to the end of the generated <filename>cntlm.conf</filename>."; + description = lib.mdDoc "Additional config appended to the end of the generated {file}`cntlm.conf`."; }; configText = mkOption { type = types.lines; default = ""; - description = "Verbatim contents of <filename>cntlm.conf</filename>."; + description = lib.mdDoc "Verbatim contents of {file}`cntlm.conf`."; }; }; diff --git a/nixos/modules/services/networking/connman.nix b/nixos/modules/services/networking/connman.nix index 9945dc83a279e..498991419579e 100644 --- a/nixos/modules/services/networking/connman.nix +++ b/nixos/modules/services/networking/connman.nix @@ -27,7 +27,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to use ConnMan for managing your network connections. ''; }; @@ -35,7 +35,7 @@ in { enableVPN = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable ConnMan VPN service. ''; }; @@ -43,7 +43,7 @@ in { extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Configuration lines appended to the generated connman configuration file. ''; }; @@ -51,7 +51,7 @@ in { networkInterfaceBlacklist = mkOption { type = with types; listOf str; default = [ "vmnet" "vboxnet" "virbr" "ifb" "ve" ]; - description = '' + description = lib.mdDoc '' Default blacklisted interfaces, this includes NixOS containers interfaces (ve). ''; }; @@ -60,9 +60,9 @@ in { backend = mkOption { type = types.enum [ "wpa_supplicant" "iwd" ]; default = "wpa_supplicant"; - description = '' + description = lib.mdDoc '' Specify the Wi-Fi backend used. - Currently supported are <option>wpa_supplicant</option> or <option>iwd</option>. + Currently supported are {option}`wpa_supplicant` or {option}`iwd`. ''; }; }; @@ -71,14 +71,14 @@ in { type = with types; listOf str; default = [ ]; example = [ "--nodnsproxy" ]; - description = '' + description = lib.mdDoc '' Extra flags to pass to connmand ''; }; package = mkOption { type = types.package; - description = "The connman package / build flavor"; + description = lib.mdDoc "The connman package / build flavor"; default = connman; defaultText = literalExpression "pkgs.connman"; example = literalExpression "pkgs.connmanFull"; diff --git a/nixos/modules/services/networking/consul.nix b/nixos/modules/services/networking/consul.nix index cb53cc01f52dd..16f1b5eec879d 100644 --- a/nixos/modules/services/networking/consul.nix +++ b/nixos/modules/services/networking/consul.nix @@ -28,7 +28,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enables the consul daemon. ''; }; @@ -37,7 +37,7 @@ in type = types.package; default = pkgs.consul; defaultText = literalExpression "pkgs.consul"; - description = '' + description = lib.mdDoc '' The package used for the Consul agent and CLI. ''; }; @@ -46,7 +46,7 @@ in webUi = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enables the web interface on the consul http port. ''; }; @@ -54,7 +54,7 @@ in leaveOnStop = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If enabled, causes a leave action to be sent when closing consul. This allows a clean termination of the node, but permanently removes it from the cluster. You probably don't want this option unless you @@ -68,7 +68,7 @@ in advertise = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The name of the interface to pull the advertise_addr from. ''; }; @@ -76,7 +76,7 @@ in bind = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The name of the interface to pull the bind_addr from. ''; }; @@ -85,7 +85,7 @@ in forceAddrFamily = mkOption { type = types.enum [ "any" "ipv4" "ipv6" ]; default = "any"; - description = '' + description = lib.mdDoc '' Whether to bind ipv4/ipv6 or both kind of addresses. ''; }; @@ -93,7 +93,7 @@ in forceIpv4 = mkOption { type = types.nullOr types.bool; default = null; - description = '' + description = lib.mdDoc '' Deprecated: Use consul.forceAddrFamily instead. Whether we should force the interfaces to only pull ipv4 addresses. ''; @@ -102,7 +102,7 @@ in dropPrivileges = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether the consul agent should be run as a non-root consul user. ''; }; @@ -110,7 +110,7 @@ in extraConfig = mkOption { default = { }; type = types.attrsOf types.anything; - description = '' + description = lib.mdDoc '' Extra configuration options which are serialized to json and added to the config.json file. ''; @@ -119,7 +119,7 @@ in extraConfigFiles = mkOption { default = [ ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Additional configuration files to pass to consul NOTE: These will not trigger the service to be restarted when altered. ''; @@ -129,32 +129,32 @@ in enable = mkEnableOption "consul-alerts"; package = mkOption { - description = "Package to use for consul-alerts."; + description = lib.mdDoc "Package to use for consul-alerts."; default = pkgs.consul-alerts; defaultText = literalExpression "pkgs.consul-alerts"; type = types.package; }; listenAddr = mkOption { - description = "Api listening address."; + description = lib.mdDoc "Api listening address."; default = "localhost:9000"; type = types.str; }; consulAddr = mkOption { - description = "Consul api listening adddress"; + description = lib.mdDoc "Consul api listening adddress"; default = "localhost:8500"; type = types.str; }; watchChecks = mkOption { - description = "Whether to enable check watcher."; + description = lib.mdDoc "Whether to enable check watcher."; default = true; type = types.bool; }; watchEvents = mkOption { - description = "Whether to enable event watcher."; + description = lib.mdDoc "Whether to enable event watcher."; default = true; type = types.bool; }; diff --git a/nixos/modules/services/networking/coredns.nix b/nixos/modules/services/networking/coredns.nix index 88615d8e610f2..9a4140e9d58a8 100644 --- a/nixos/modules/services/networking/coredns.nix +++ b/nixos/modules/services/networking/coredns.nix @@ -24,7 +24,7 @@ in { default = pkgs.coredns; defaultText = literalExpression "pkgs.coredns"; type = types.package; - description = "Coredns package to use."; + description = lib.mdDoc "Coredns package to use."; }; }; diff --git a/nixos/modules/services/networking/corerad.nix b/nixos/modules/services/networking/corerad.nix index 9d79d5d7686b2..88428eba5589c 100644 --- a/nixos/modules/services/networking/corerad.nix +++ b/nixos/modules/services/networking/corerad.nix @@ -36,8 +36,8 @@ in { }; } ''; - description = '' - Configuration for CoreRAD, see <link xlink:href="https://github.com/mdlayher/corerad/blob/main/internal/config/reference.toml"/> + description = lib.mdDoc '' + Configuration for CoreRAD, see <https://github.com/mdlayher/corerad/blob/main/internal/config/reference.toml> for supported values. Ignored if configFile is set. ''; }; @@ -45,14 +45,14 @@ in { configFile = mkOption { type = types.path; example = literalExpression ''"''${pkgs.corerad}/etc/corerad/corerad.toml"''; - description = "Path to CoreRAD TOML configuration file."; + description = lib.mdDoc "Path to CoreRAD TOML configuration file."; }; package = mkOption { default = pkgs.corerad; defaultText = literalExpression "pkgs.corerad"; type = types.package; - description = "CoreRAD package to use."; + description = lib.mdDoc "CoreRAD package to use."; }; }; diff --git a/nixos/modules/services/networking/coturn.nix b/nixos/modules/services/networking/coturn.nix index ce563c31136f6..788c51aed6b03 100644 --- a/nixos/modules/services/networking/coturn.nix +++ b/nixos/modules/services/networking/coturn.nix @@ -44,7 +44,7 @@ in { listening-port = mkOption { type = types.int; default = 3478; - description = '' + description = lib.mdDoc '' TURN listener port for UDP and TCP. Note: actually, TLS and DTLS sessions can connect to the "plain" TCP and UDP port(s), too - if allowed by configuration. @@ -53,7 +53,7 @@ in { tls-listening-port = mkOption { type = types.int; default = 5349; - description = '' + description = lib.mdDoc '' TURN listener port for TLS. Note: actually, "plain" TCP and UDP sessions can connect to the TLS and DTLS port(s), too - if allowed by configuration. The TURN server @@ -69,7 +69,7 @@ in { type = types.int; default = cfg.listening-port + 1; defaultText = literalExpression "listening-port + 1"; - description = '' + description = lib.mdDoc '' Alternative listening port for UDP and TCP listeners; default (or zero) value means "listening port plus one". This is needed for RFC 5780 support @@ -84,7 +84,7 @@ in { type = types.int; default = cfg.tls-listening-port + 1; defaultText = literalExpression "tls-listening-port + 1"; - description = '' + description = lib.mdDoc '' Alternative listening port for TLS and DTLS protocols. ''; }; @@ -92,7 +92,7 @@ in { type = types.listOf types.str; default = []; example = [ "203.0.113.42" "2001:DB8::42" ]; - description = '' + description = lib.mdDoc '' Listener IP addresses of relay server. If no IP(s) specified in the config file or in the command line options, then all IPv4 and IPv6 system IPs will be used for listening. @@ -102,7 +102,7 @@ in { type = types.listOf types.str; default = []; example = [ "203.0.113.42" "2001:DB8::42" ]; - description = '' + description = lib.mdDoc '' Relay address (the local IP address that will be used to relay the packets to the peer). Multiple relay addresses may be used. @@ -118,28 +118,28 @@ in { min-port = mkOption { type = types.int; default = 49152; - description = '' + description = lib.mdDoc '' Lower bound of UDP relay endpoints ''; }; max-port = mkOption { type = types.int; default = 65535; - description = '' + description = lib.mdDoc '' Upper bound of UDP relay endpoints ''; }; lt-cred-mech = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Use long-term credential mechanism. ''; }; no-auth = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' This option is opposite to lt-cred-mech. (TURN Server with no-auth option allows anonymous access). If neither option is defined, and no users are defined, @@ -151,7 +151,7 @@ in { use-auth-secret = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' TURN REST API flag. Flag that sets a special authorization option that is based upon authentication secret. This feature can be used with the long-term authentication mechanism, only. @@ -175,7 +175,7 @@ in { static-auth-secret = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' 'Static' authentication secret value (a string) for TURN REST API only. If not set, then the turn server will try to use the 'dynamic' value in turn_secret table @@ -186,7 +186,7 @@ in { static-auth-secret-file = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Path to the file containing the static authentication secret. ''; }; @@ -195,7 +195,7 @@ in { default = config.networking.hostName; defaultText = literalExpression "config.networking.hostName"; example = "example.com"; - description = '' + description = lib.mdDoc '' The default realm to be used for the users when no explicit origin/realm relationship was found in the database, or if the TURN server is not using any database (just the commands-line settings @@ -207,7 +207,7 @@ in { type = types.nullOr types.str; default = null; example = "/var/lib/acme/example.com/fullchain.pem"; - description = '' + description = lib.mdDoc '' Certificate file in PEM format. ''; }; @@ -215,21 +215,21 @@ in { type = types.nullOr types.str; default = null; example = "/var/lib/acme/example.com/key.pem"; - description = '' + description = lib.mdDoc '' Private key file in PEM format. ''; }; dh-file = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Use custom DH TLS key, stored in PEM format in the file. ''; }; secure-stun = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Require authentication of the STUN Binding request. By default, the clients are allowed anonymous access to the STUN Binding functionality. ''; @@ -237,28 +237,28 @@ in { no-cli = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Turn OFF the CLI support. ''; }; cli-ip = mkOption { type = types.str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' Local system IP address to be used for CLI server endpoint. ''; }; cli-port = mkOption { type = types.int; default = 5766; - description = '' + description = lib.mdDoc '' CLI server port. ''; }; cli-password = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' CLI access password. For the security reasons, it is recommended to use the encrypted for of the password (see the -P command in the turnadmin utility). @@ -267,37 +267,37 @@ in { no-udp = mkOption { type = types.bool; default = false; - description = "Disable UDP client listener"; + description = lib.mdDoc "Disable UDP client listener"; }; no-tcp = mkOption { type = types.bool; default = false; - description = "Disable TCP client listener"; + description = lib.mdDoc "Disable TCP client listener"; }; no-tls = mkOption { type = types.bool; default = false; - description = "Disable TLS client listener"; + description = lib.mdDoc "Disable TLS client listener"; }; no-dtls = mkOption { type = types.bool; default = false; - description = "Disable DTLS client listener"; + description = lib.mdDoc "Disable DTLS client listener"; }; no-udp-relay = mkOption { type = types.bool; default = false; - description = "Disable UDP relay endpoints"; + description = lib.mdDoc "Disable UDP relay endpoints"; }; no-tcp-relay = mkOption { type = types.bool; default = false; - description = "Disable TCP relay endpoints"; + description = lib.mdDoc "Disable TCP relay endpoints"; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Additional configuration options"; + description = lib.mdDoc "Additional configuration options"; }; }; }; diff --git a/nixos/modules/services/networking/croc.nix b/nixos/modules/services/networking/croc.nix index d044979e10dfa..82035856733cc 100644 --- a/nixos/modules/services/networking/croc.nix +++ b/nixos/modules/services/networking/croc.nix @@ -10,12 +10,12 @@ in ports = lib.mkOption { type = with types; listOf port; default = [9009 9010 9011 9012 9013]; - description = "Ports of the relay."; + description = lib.mdDoc "Ports of the relay."; }; pass = lib.mkOption { type = with types; either path str; default = "pass123"; - description = "Password or passwordfile for the relay."; + description = lib.mdDoc "Password or passwordfile for the relay."; }; openFirewall = lib.mkEnableOption "opening of the peer port(s) in the firewall"; debug = lib.mkEnableOption "debug logs"; diff --git a/nixos/modules/services/networking/dante.nix b/nixos/modules/services/networking/dante.nix index 20d4faa1cdb15..5ddbee88609be 100644 --- a/nixos/modules/services/networking/dante.nix +++ b/nixos/modules/services/networking/dante.nix @@ -23,7 +23,7 @@ in config = mkOption { type = types.lines; - description = '' + description = lib.mdDoc '' Contents of Dante's configuration file. NOTE: user.privileged, user.unprivileged and logoutput are set by the service. ''; diff --git a/nixos/modules/services/networking/ddclient.nix b/nixos/modules/services/networking/ddclient.nix index 43a50af8f9b59..a0e9405343bad 100644 --- a/nixos/modules/services/networking/ddclient.nix +++ b/nixos/modules/services/networking/ddclient.nix @@ -63,7 +63,7 @@ with lib; enable = mkOption { default = false; type = bool; - description = '' + description = lib.mdDoc '' Whether to synchronise your machine's IP address with a dynamic DNS provider (e.g. dyndns.org). ''; }; @@ -72,7 +72,7 @@ with lib; type = package; default = pkgs.ddclient; defaultText = "pkgs.ddclient"; - description = '' + description = lib.mdDoc '' The ddclient executable package run by the service. ''; }; @@ -80,7 +80,7 @@ with lib; domains = mkOption { default = [ "" ]; type = listOf str; - description = '' + description = lib.mdDoc '' Domain name(s) to synchronize. ''; }; @@ -90,7 +90,7 @@ with lib; default = lib.optionalString (config.services.ddclient.protocol == "nsupdate") "${pkgs.bind.dnsutils}/bin/nsupdate"; defaultText = ""; type = str; - description = '' + description = lib.mdDoc '' User name. ''; }; @@ -98,7 +98,7 @@ with lib; passwordFile = mkOption { default = null; type = nullOr str; - description = '' + description = lib.mdDoc '' A file containing the password or a TSIG key in named format when using the nsupdate protocol. ''; }; @@ -106,16 +106,16 @@ with lib; interval = mkOption { default = "10min"; type = str; - description = '' + description = lib.mdDoc '' The interval at which to run the check and update. - See <command>man 7 systemd.time</command> for the format. + See {command}`man 7 systemd.time` for the format. ''; }; configFile = mkOption { default = null; type = nullOr path; - description = '' + description = lib.mdDoc '' Path to configuration file. When set this overrides the generated configuration from module options. ''; @@ -125,7 +125,7 @@ with lib; protocol = mkOption { default = "dyndns2"; type = str; - description = '' + description = lib.mdDoc '' Protocol to use with dynamic DNS provider (see https://sourceforge.net/p/ddclient/wiki/protocols). ''; }; @@ -133,7 +133,7 @@ with lib; server = mkOption { default = ""; type = str; - description = '' + description = lib.mdDoc '' Server address. ''; }; @@ -141,7 +141,7 @@ with lib; ssl = mkOption { default = true; type = bool; - description = '' + description = lib.mdDoc '' Whether to use SSL/TLS to connect to dynamic DNS provider. ''; }; @@ -149,7 +149,7 @@ with lib; ipv6 = mkOption { default = false; type = bool; - description = '' + description = lib.mdDoc '' Whether to use IPv6. ''; }; @@ -158,7 +158,7 @@ with lib; quiet = mkOption { default = false; type = bool; - description = '' + description = lib.mdDoc '' Print no messages for unnecessary updates. ''; }; @@ -166,7 +166,7 @@ with lib; script = mkOption { default = ""; type = str; - description = '' + description = lib.mdDoc '' script as required by some providers. ''; }; @@ -174,7 +174,7 @@ with lib; use = mkOption { default = "web, web=checkip.dyndns.com/, web-skip='Current IP Address: '"; type = str; - description = '' + description = lib.mdDoc '' Method to determine the IP address to send to the dynamic DNS provider. ''; }; @@ -182,7 +182,7 @@ with lib; verbose = mkOption { default = false; type = bool; - description = '' + description = lib.mdDoc '' Print verbose information. ''; }; @@ -190,7 +190,7 @@ with lib; zone = mkOption { default = ""; type = str; - description = '' + description = lib.mdDoc '' zone as required by some providers. ''; }; @@ -198,7 +198,7 @@ with lib; extraConfig = mkOption { default = ""; type = lines; - description = '' + description = lib.mdDoc '' Extra configuration. Contents will be added verbatim to the configuration file. ''; }; diff --git a/nixos/modules/services/networking/dhcpcd.nix b/nixos/modules/services/networking/dhcpcd.nix index a4c8608c31db8..6b7ce828919cc 100644 --- a/nixos/modules/services/networking/dhcpcd.nix +++ b/nixos/modules/services/networking/dhcpcd.nix @@ -103,7 +103,7 @@ in networking.dhcpcd.enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable dhcpcd for device configuration. This is mainly to explicitly disable dhcpcd (for example when using networkd). ''; @@ -112,7 +112,7 @@ in networking.dhcpcd.persistent = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whenever to leave interfaces configured on dhcpcd daemon shutdown. Set to true if you have your root or store mounted over the network or this machine accepts SSH connections @@ -124,7 +124,7 @@ in networking.dhcpcd.denyInterfaces = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Disable the DHCP client for any interface whose name matches any of the shell glob patterns in this list. The purpose of this option is to blacklist virtual interfaces such as those @@ -135,7 +135,7 @@ in networking.dhcpcd.allowInterfaces = mkOption { type = types.nullOr (types.listOf types.str); default = null; - description = '' + description = lib.mdDoc '' Enable the DHCP client for any interface whose name matches any of the shell glob patterns in this list. Any interface not explicitly matched by this pattern will be denied. This pattern only @@ -146,7 +146,7 @@ in networking.dhcpcd.extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Literal string to append to the config file generated for dhcpcd. ''; }; @@ -164,7 +164,7 @@ in networking.dhcpcd.wait = mkOption { type = types.enum [ "background" "any" "ipv4" "ipv6" "both" "if-carrier-up" ]; default = "any"; - description = '' + description = lib.mdDoc '' This option specifies when the dhcpcd service will fork to background. If set to "background", dhcpcd will fork to background immediately. If set to "ipv4" or "ipv6", dhcpcd will wait for the corresponding IP diff --git a/nixos/modules/services/networking/dhcpd.nix b/nixos/modules/services/networking/dhcpd.nix index 49950efc0a1bd..0bd5e4ef55358 100644 --- a/nixos/modules/services/networking/dhcpd.nix +++ b/nixos/modules/services/networking/dhcpd.nix @@ -77,7 +77,7 @@ let hostName = mkOption { type = types.str; example = "foo"; - description = '' + description = lib.mdDoc '' Hostname which is assigned statically to the machine. ''; }; @@ -85,7 +85,7 @@ let ethernetAddress = mkOption { type = types.str; example = "00:16:76:9a:32:1d"; - description = '' + description = lib.mdDoc '' MAC address of the machine. ''; }; @@ -93,7 +93,7 @@ let ipAddress = mkOption { type = types.str; example = "192.168.1.10"; - description = '' + description = lib.mdDoc '' IP address of the machine. ''; }; @@ -106,7 +106,7 @@ let enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the DHCPv${postfix} server. ''; }; @@ -124,7 +124,7 @@ let range 192.168.1.100 192.168.1.200; } ''; - description = '' + description = lib.mdDoc '' Extra text to be appended to the DHCP server configuration file. Currently, you almost certainly need to specify something there, such as the options specifying the subnet mask, DNS servers, @@ -135,7 +135,7 @@ let extraFlags = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Additional command line flags to be passed to the dhcpd daemon. ''; }; @@ -143,7 +143,7 @@ let configFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' The path of the DHCP server configuration file. If no file is specified, a file is generated using the other options. ''; @@ -152,7 +152,7 @@ let interfaces = mkOption { type = types.listOf types.str; default = ["eth0"]; - description = '' + description = lib.mdDoc '' The interfaces on which the DHCP server should listen. ''; }; @@ -170,7 +170,7 @@ let ipAddress = "192.168.1.11"; } ]; - description = '' + description = lib.mdDoc '' A list mapping Ethernet addresses to IPv${postfix} addresses for the DHCP server. ''; @@ -179,7 +179,7 @@ let authoritative = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether the DHCP server shall send DHCPNAK messages to misconfigured clients. If this is not done, clients may be unable to get a correct IP address after changing subnets until their old lease has expired. diff --git a/nixos/modules/services/networking/dnscache.nix b/nixos/modules/services/networking/dnscache.nix index 7452210de47fe..eff13f69f470a 100644 --- a/nixos/modules/services/networking/dnscache.nix +++ b/nixos/modules/services/networking/dnscache.nix @@ -38,26 +38,26 @@ in { enable = mkOption { default = false; type = types.bool; - description = "Whether to run the dnscache caching dns server."; + description = lib.mdDoc "Whether to run the dnscache caching dns server."; }; ip = mkOption { default = "0.0.0.0"; type = types.str; - description = "IP address on which to listen for connections."; + description = lib.mdDoc "IP address on which to listen for connections."; }; clientIps = mkOption { default = [ "127.0.0.1" ]; type = types.listOf types.str; - description = "Client IP addresses (or prefixes) from which to accept connections."; + description = lib.mdDoc "Client IP addresses (or prefixes) from which to accept connections."; example = ["192.168" "172.23.75.82"]; }; domainServers = mkOption { default = { }; type = types.attrsOf (types.listOf types.str); - description = '' + description = lib.mdDoc '' Table of {hostname: server} pairs to use as authoritative servers for hosts (and subhosts). If entry for @ is not specified predefined list of root servers is used. ''; @@ -72,7 +72,7 @@ in { forwardOnly = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to treat root servers (for @) as caching servers, requesting addresses the same way a client does. This is needed if you want to use e.g. Google DNS as your upstream DNS. diff --git a/nixos/modules/services/networking/dnscrypt-proxy2.nix b/nixos/modules/services/networking/dnscrypt-proxy2.nix index 316e6e37f9da8..ff7934101039f 100644 --- a/nixos/modules/services/networking/dnscrypt-proxy2.nix +++ b/nixos/modules/services/networking/dnscrypt-proxy2.nix @@ -9,9 +9,9 @@ in enable = mkEnableOption "dnscrypt-proxy2"; settings = mkOption { - description = '' + description = lib.mdDoc '' Attrset that is converted and passed as TOML config file. - For available params, see: <link xlink:href="https://github.com/DNSCrypt/dnscrypt-proxy/blob/${pkgs.dnscrypt-proxy2.version}/dnscrypt-proxy/example-dnscrypt-proxy.toml"/> + For available params, see: <https://github.com/DNSCrypt/dnscrypt-proxy/blob/${pkgs.dnscrypt-proxy2.version}/dnscrypt-proxy/example-dnscrypt-proxy.toml> ''; example = literalExpression '' { @@ -28,8 +28,8 @@ in }; upstreamDefaults = mkOption { - description = '' - Whether to base the config declared in <option>services.dnscrypt-proxy2.settings</option> on the upstream example config (<link xlink:href="https://github.com/DNSCrypt/dnscrypt-proxy/blob/master/dnscrypt-proxy/example-dnscrypt-proxy.toml"/>) + description = lib.mdDoc '' + Whether to base the config declared in {option}`services.dnscrypt-proxy2.settings` on the upstream example config (<https://github.com/DNSCrypt/dnscrypt-proxy/blob/master/dnscrypt-proxy/example-dnscrypt-proxy.toml>) Disable this if you want to declare your dnscrypt config from scratch. ''; @@ -38,8 +38,8 @@ in }; configFile = mkOption { - description = '' - Path to TOML config file. See: <link xlink:href="https://github.com/DNSCrypt/dnscrypt-proxy/blob/master/dnscrypt-proxy/example-dnscrypt-proxy.toml"/> + description = lib.mdDoc '' + Path to TOML config file. See: <https://github.com/DNSCrypt/dnscrypt-proxy/blob/master/dnscrypt-proxy/example-dnscrypt-proxy.toml> If this option is set, it will override any configuration done in options.services.dnscrypt-proxy2.settings. ''; example = "/etc/dnscrypt-proxy/dnscrypt-proxy.toml"; diff --git a/nixos/modules/services/networking/dnscrypt-wrapper.nix b/nixos/modules/services/networking/dnscrypt-wrapper.nix index c2add170e9cc7..5df1e8b51a52a 100644 --- a/nixos/modules/services/networking/dnscrypt-wrapper.nix +++ b/nixos/modules/services/networking/dnscrypt-wrapper.nix @@ -129,7 +129,7 @@ in { address = mkOption { type = types.str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' The DNSCrypt wrapper will bind to this IP address. ''; }; @@ -137,7 +137,7 @@ in { port = mkOption { type = types.int; default = 5353; - description = '' + description = lib.mdDoc '' The DNSCrypt wrapper will listen for DNS queries on this port. ''; }; @@ -147,9 +147,9 @@ in { default = "2.dnscrypt-cert.${config.networking.hostName}"; defaultText = literalExpression ''"2.dnscrypt-cert.''${config.networking.hostName}"''; example = "2.dnscrypt-cert.myresolver"; - description = '' + description = lib.mdDoc '' The name that will be given to this DNSCrypt resolver. - Note: the resolver name must start with <literal>2.dnscrypt-cert.</literal>. + Note: the resolver name must start with `2.dnscrypt-cert.`. ''; }; @@ -157,7 +157,7 @@ in { type = types.nullOr types.path; default = null; example = "/etc/secrets/public.key"; - description = '' + description = lib.mdDoc '' The filepath to the provider public key. If not given a new provider key pair will be generated on the first run. ''; @@ -167,7 +167,7 @@ in { type = types.nullOr types.path; default = null; example = "/etc/secrets/secret.key"; - description = '' + description = lib.mdDoc '' The filepath to the provider secret key. If not given a new provider key pair will be generated on the first run. ''; @@ -176,7 +176,7 @@ in { upstream.address = mkOption { type = types.str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' The IP address of the upstream DNS server DNSCrypt will "wrap". ''; }; @@ -184,7 +184,7 @@ in { upstream.port = mkOption { type = types.int; default = 53; - description = '' + description = lib.mdDoc '' The port of the upstream DNS server DNSCrypt will "wrap". ''; }; @@ -192,7 +192,7 @@ in { keys.expiration = mkOption { type = types.int; default = 30; - description = '' + description = lib.mdDoc '' The duration (in days) of the time-limited secret key. This will be automatically rotated before expiration. ''; @@ -201,7 +201,7 @@ in { keys.checkInterval = mkOption { type = types.int; default = 1440; - description = '' + description = lib.mdDoc '' The time interval (in minutes) between key expiration checks. ''; }; diff --git a/nixos/modules/services/networking/dnsdist.nix b/nixos/modules/services/networking/dnsdist.nix index c7c6a79864cb4..44503248cf89d 100644 --- a/nixos/modules/services/networking/dnsdist.nix +++ b/nixos/modules/services/networking/dnsdist.nix @@ -15,19 +15,19 @@ in { listenAddress = mkOption { type = types.str; - description = "Listen IP Address"; + description = lib.mdDoc "Listen IP Address"; default = "0.0.0.0"; }; listenPort = mkOption { type = types.int; - description = "Listen port"; + description = lib.mdDoc "Listen port"; default = 53; }; extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra lines to be added verbatim to dnsdist.conf. ''; }; diff --git a/nixos/modules/services/networking/dnsmasq.nix b/nixos/modules/services/networking/dnsmasq.nix index 59a3ca2f28e37..cfc37b74b9a94 100644 --- a/nixos/modules/services/networking/dnsmasq.nix +++ b/nixos/modules/services/networking/dnsmasq.nix @@ -32,7 +32,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to run dnsmasq. ''; }; @@ -40,7 +40,7 @@ in resolveLocalQueries = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether dnsmasq should resolve local queries (i.e. add 127.0.0.1 to /etc/resolv.conf). ''; @@ -50,7 +50,7 @@ in type = types.listOf types.str; default = []; example = [ "8.8.8.8" "8.8.4.4" ]; - description = '' + description = lib.mdDoc '' The DNS servers which dnsmasq should query. ''; }; @@ -58,7 +58,7 @@ in alwaysKeepRunning = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If enabled, systemd will always respawn dnsmasq even if shut down manually. The default, disabled, will only restart it on error. ''; }; @@ -66,9 +66,9 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration directives that should be added to - <literal>dnsmasq.conf</literal>. + `dnsmasq.conf`. ''; }; diff --git a/nixos/modules/services/networking/doh-proxy-rust.nix b/nixos/modules/services/networking/doh-proxy-rust.nix index efd492e23f8c8..bfd88430d78ca 100644 --- a/nixos/modules/services/networking/doh-proxy-rust.nix +++ b/nixos/modules/services/networking/doh-proxy-rust.nix @@ -16,9 +16,9 @@ in { type = types.listOf types.str; default = []; example = [ "--server-address=9.9.9.9:53" ]; - description = '' + description = lib.mdDoc '' A list of command-line flags to pass to doh-proxy. For details on the - available options, see <link xlink:href="https://github.com/jedisct1/doh-server#usage"/>. + available options, see <https://github.com/jedisct1/doh-server#usage>. ''; }; diff --git a/nixos/modules/services/networking/ejabberd.nix b/nixos/modules/services/networking/ejabberd.nix index daf8d5c424758..3feafc3bb3bd1 100644 --- a/nixos/modules/services/networking/ejabberd.nix +++ b/nixos/modules/services/networking/ejabberd.nix @@ -26,63 +26,63 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable ejabberd server"; + description = lib.mdDoc "Whether to enable ejabberd server"; }; package = mkOption { type = types.package; default = pkgs.ejabberd; defaultText = literalExpression "pkgs.ejabberd"; - description = "ejabberd server package to use"; + description = lib.mdDoc "ejabberd server package to use"; }; user = mkOption { type = types.str; default = "ejabberd"; - description = "User under which ejabberd is ran"; + description = lib.mdDoc "User under which ejabberd is ran"; }; group = mkOption { type = types.str; default = "ejabberd"; - description = "Group under which ejabberd is ran"; + description = lib.mdDoc "Group under which ejabberd is ran"; }; spoolDir = mkOption { type = types.path; default = "/var/lib/ejabberd"; - description = "Location of the spooldir of ejabberd"; + description = lib.mdDoc "Location of the spooldir of ejabberd"; }; logsDir = mkOption { type = types.path; default = "/var/log/ejabberd"; - description = "Location of the logfile directory of ejabberd"; + description = lib.mdDoc "Location of the logfile directory of ejabberd"; }; configFile = mkOption { type = types.nullOr types.path; - description = "Configuration file for ejabberd in YAML format"; + description = lib.mdDoc "Configuration file for ejabberd in YAML format"; default = null; }; ctlConfig = mkOption { type = types.lines; default = ""; - description = "Configuration of ejabberdctl"; + description = lib.mdDoc "Configuration of ejabberdctl"; }; loadDumps = mkOption { type = types.listOf types.path; default = []; - description = "Configuration dumps that should be loaded on the first startup"; + description = lib.mdDoc "Configuration dumps that should be loaded on the first startup"; example = literalExpression "[ ./myejabberd.dump ]"; }; imagemagick = mkOption { type = types.bool; default = false; - description = "Add ImageMagick to server's path; allows for image thumbnailing"; + description = lib.mdDoc "Add ImageMagick to server's path; allows for image thumbnailing"; }; }; diff --git a/nixos/modules/services/networking/envoy.nix b/nixos/modules/services/networking/envoy.nix index b7f859c73d9dd..6f3080d19e2b0 100644 --- a/nixos/modules/services/networking/envoy.nix +++ b/nixos/modules/services/networking/envoy.nix @@ -39,7 +39,7 @@ in }; } ''; - description = '' + description = lib.mdDoc '' Specify the configuration for Envoy in Nix. ''; }; diff --git a/nixos/modules/services/networking/epmd.nix b/nixos/modules/services/networking/epmd.nix index 75d78476e5783..534b80906211f 100644 --- a/nixos/modules/services/networking/epmd.nix +++ b/nixos/modules/services/networking/epmd.nix @@ -11,7 +11,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable socket activation for Erlang Port Mapper Daemon (epmd), which acts as a name server on all hosts involved in distributed Erlang computations. @@ -21,7 +21,7 @@ in type = types.package; default = pkgs.erlang; defaultText = literalExpression "pkgs.erlang"; - description = '' + description = lib.mdDoc '' The Erlang package to use to get epmd binary. That way you can re-use an Erlang runtime that is already installed for other purposes. ''; @@ -30,7 +30,7 @@ in { type = types.str; default = "[::]:4369"; - description = '' + description = lib.mdDoc '' the listenStream used by the systemd socket. see https://www.freedesktop.org/software/systemd/man/systemd.socket.html#ListenStream= for more informations. use this to change the port epmd will run on. diff --git a/nixos/modules/services/networking/ergo.nix b/nixos/modules/services/networking/ergo.nix index 6e55a7cfff6c8..0dbb862b8ecd2 100644 --- a/nixos/modules/services/networking/ergo.nix +++ b/nixos/modules/services/networking/ergo.nix @@ -38,20 +38,20 @@ in { dataDir = mkOption { type = types.path; default = "/var/lib/ergo"; - description = "The data directory for the Ergo node."; + description = lib.mdDoc "The data directory for the Ergo node."; }; listen = { ip = mkOption { type = types.str; default = "0.0.0.0"; - description = "IP address on which the Ergo node should listen."; + description = lib.mdDoc "IP address on which the Ergo node should listen."; }; port = mkOption { type = types.port; default = 9006; - description = "Listen port for the Ergo node."; + description = lib.mdDoc "Listen port for the Ergo node."; }; }; @@ -60,20 +60,20 @@ in { type = types.nullOr types.str; default = null; example = "324dcf027dd4a30a932c441f365a25e86b173defa4b8e58948253471b81b72cf"; - description = "Hex-encoded Blake2b256 hash of an API key as a 64-chars long Base16 string."; + description = lib.mdDoc "Hex-encoded Blake2b256 hash of an API key as a 64-chars long Base16 string."; }; listen = { ip = mkOption { type = types.str; default = "0.0.0.0"; - description = "IP address that the Ergo node API should listen on if <option>api.keyHash</option> is defined."; + description = lib.mdDoc "IP address that the Ergo node API should listen on if {option}`api.keyHash` is defined."; }; port = mkOption { type = types.port; default = 9052; - description = "Listen port for the API endpoint if <option>api.keyHash</option> is defined."; + description = lib.mdDoc "Listen port for the API endpoint if {option}`api.keyHash` is defined."; }; }; }; @@ -81,26 +81,26 @@ in { testnet = mkOption { type = types.bool; default = false; - description = "Connect to testnet network instead of the default mainnet."; + description = lib.mdDoc "Connect to testnet network instead of the default mainnet."; }; user = mkOption { type = types.str; default = "ergo"; - description = "The user as which to run the Ergo node."; + description = lib.mdDoc "The user as which to run the Ergo node."; }; group = mkOption { type = types.str; default = cfg.user; defaultText = literalExpression "config.${opt.user}"; - description = "The group as which to run the Ergo node."; + description = lib.mdDoc "The group as which to run the Ergo node."; }; openFirewall = mkOption { type = types.bool; default = false; - description = "Open ports in the firewall for the Ergo node as well as the API."; + description = lib.mdDoc "Open ports in the firewall for the Ergo node as well as the API."; }; }; }; diff --git a/nixos/modules/services/networking/ergochat.nix b/nixos/modules/services/networking/ergochat.nix index cfaf69fc61391..5e815a9eff207 100644 --- a/nixos/modules/services/networking/ergochat.nix +++ b/nixos/modules/services/networking/ergochat.nix @@ -9,7 +9,7 @@ in { openFilesLimit = lib.mkOption { type = lib.types.int; default = 1024; - description = '' + description = lib.mdDoc '' Maximum number of open files. Limits the clients and server connections. ''; }; @@ -18,15 +18,15 @@ in { type = lib.types.path; default = (pkgs.formats.yaml {}).generate "ergo.conf" cfg.settings; defaultText = "generated config file from <literal>.settings</literal>"; - description = '' + description = lib.mdDoc '' Path to configuration file. - Setting this will skip any configuration done via <literal>.settings</literal> + Setting this will skip any configuration done via `.settings` ''; }; settings = lib.mkOption { type = (pkgs.formats.yaml {}).type; - description = '' + description = lib.mdDoc '' Ergo IRC daemon configuration file. https://raw.githubusercontent.com/ergochat/ergo/master/default.yaml ''; diff --git a/nixos/modules/services/networking/eternal-terminal.nix b/nixos/modules/services/networking/eternal-terminal.nix index 0dcf3d28f4e0e..e90b6103a2181 100644 --- a/nixos/modules/services/networking/eternal-terminal.nix +++ b/nixos/modules/services/networking/eternal-terminal.nix @@ -21,7 +21,7 @@ in port = mkOption { default = 2022; type = types.int; - description = '' + description = lib.mdDoc '' The port the server should listen on. Will use the server's default (2022) if not specified. Make sure to open this port in the firewall if necessary. @@ -31,7 +31,7 @@ in verbosity = mkOption { default = 0; type = types.enum (lib.range 0 9); - description = '' + description = lib.mdDoc '' The verbosity level (0-9). ''; }; @@ -39,7 +39,7 @@ in silent = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If enabled, disables all logging. ''; }; @@ -47,7 +47,7 @@ in logSize = mkOption { default = 20971520; type = types.int; - description = '' + description = lib.mdDoc '' The maximum log size. ''; }; diff --git a/nixos/modules/services/networking/expressvpn.nix b/nixos/modules/services/networking/expressvpn.nix index d8ae6528a4d4e..30de6987d31fe 100644 --- a/nixos/modules/services/networking/expressvpn.nix +++ b/nixos/modules/services/networking/expressvpn.nix @@ -5,7 +5,7 @@ with lib; options.services.expressvpn.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the ExpressVPN daemon. ''; }; diff --git a/nixos/modules/services/networking/fakeroute.nix b/nixos/modules/services/networking/fakeroute.nix index 7916ad4098a7c..ed6b1a3c4d262 100644 --- a/nixos/modules/services/networking/fakeroute.nix +++ b/nixos/modules/services/networking/fakeroute.nix @@ -19,7 +19,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the fakeroute service. ''; }; @@ -33,7 +33,7 @@ in "198.116.142.34" "63.199.8.242" ]; - description = '' + description = lib.mdDoc '' Fake route that will appear after the real one to any host running a traceroute. ''; diff --git a/nixos/modules/services/networking/ferm.nix b/nixos/modules/services/networking/ferm.nix index 8e03f30efc00a..7faebcef6300a 100644 --- a/nixos/modules/services/networking/ferm.nix +++ b/nixos/modules/services/networking/ferm.nix @@ -28,13 +28,13 @@ in { ''; }; config = mkOption { - description = "Verbatim ferm.conf configuration."; + description = lib.mdDoc "Verbatim ferm.conf configuration."; default = ""; defaultText = literalDocBook "empty firewall, allows any traffic"; type = types.lines; }; package = mkOption { - description = "The ferm package."; + description = lib.mdDoc "The ferm package."; type = types.package; default = pkgs.ferm; defaultText = literalExpression "pkgs.ferm"; diff --git a/nixos/modules/services/networking/fireqos.nix b/nixos/modules/services/networking/fireqos.nix index 0b34f0b6b8b48..5469bce58c605 100644 --- a/nixos/modules/services/networking/fireqos.nix +++ b/nixos/modules/services/networking/fireqos.nix @@ -28,7 +28,7 @@ in { class web commit 50kbit match tcp ports 80,443 ''; - description = '' + description = lib.mdDoc '' The FireQOS configuration goes here. ''; }; diff --git a/nixos/modules/services/networking/firewall.nix b/nixos/modules/services/networking/firewall.nix index c213a5516a498..48cb83e344ec9 100644 --- a/nixos/modules/services/networking/firewall.nix +++ b/nixos/modules/services/networking/firewall.nix @@ -258,7 +258,7 @@ let apply = canonicalizePortList; example = [ 22 80 ]; description = - '' + lib.mdDoc '' List of TCP ports on which incoming connections are accepted. ''; @@ -269,7 +269,7 @@ let default = [ ]; example = [ { from = 8999; to = 9003; } ]; description = - '' + lib.mdDoc '' A range of TCP ports on which incoming connections are accepted. ''; @@ -281,7 +281,7 @@ let apply = canonicalizePortList; example = [ 53 ]; description = - '' + lib.mdDoc '' List of open UDP ports. ''; }; @@ -291,7 +291,7 @@ let default = [ ]; example = [ { from = 60000; to = 61000; } ]; description = - '' + lib.mdDoc '' Range of open UDP ports. ''; }; @@ -310,7 +310,7 @@ in type = types.bool; default = true; description = - '' + lib.mdDoc '' Whether to enable the firewall. This is a simple stateful firewall that blocks connection attempts to unauthorised TCP or UDP ports on this machine. It does not affect packet @@ -324,7 +324,7 @@ in defaultText = literalExpression "pkgs.iptables"; example = literalExpression "pkgs.iptables-legacy"; description = - '' + lib.mdDoc '' The iptables package to use for running the firewall service." ''; }; @@ -333,7 +333,7 @@ in type = types.bool; default = true; description = - '' + lib.mdDoc '' Whether to log rejected or dropped incoming connections. Note: The logs are found in the kernel logs, i.e. dmesg or journalctl -k. @@ -344,7 +344,7 @@ in type = types.bool; default = false; description = - '' + lib.mdDoc '' Whether to log all rejected or dropped incoming packets. This tends to give a lot of log messages, so it's mostly useful for debugging. @@ -357,8 +357,8 @@ in type = types.bool; default = true; description = - '' - If <option>networking.firewall.logRefusedPackets</option> + lib.mdDoc '' + If {option}`networking.firewall.logRefusedPackets` and this option are enabled, then only log packets specifically directed at this machine, i.e., not broadcasts or multicasts. @@ -369,7 +369,7 @@ in type = types.bool; default = false; description = - '' + lib.mdDoc '' If set, refused packets are rejected rather than dropped (ignored). This means that an ICMP "port unreachable" error message is sent back to the client (or a TCP RST packet in @@ -383,7 +383,7 @@ in default = [ ]; example = [ "enp0s2" ]; description = - '' + lib.mdDoc '' Traffic coming in from these interfaces will be accepted unconditionally. Traffic from the loopback (lo) interface will always be accepted. @@ -394,7 +394,7 @@ in type = types.bool; default = true; description = - '' + lib.mdDoc '' Whether to respond to incoming ICMPv4 echo requests ("pings"). ICMPv6 pings are always allowed because the larger address space of IPv6 makes network scanning much @@ -407,7 +407,7 @@ in default = null; example = "--limit 1/minute --limit-burst 5"; description = - '' + lib.mdDoc '' If pings are allowed, this allows setting rate limits on them. If non-null, this option should be in the form of flags like "--limit 1/minute --limit-burst 5" @@ -420,7 +420,7 @@ in defaultText = literalDocBook "<literal>true</literal> if supported by the chosen kernel"; example = "loose"; description = - '' + lib.mdDoc '' Performs a reverse path filter test on a packet. If a reply to the packet would not be sent via the same interface that the packet arrived on, it is refused. @@ -440,7 +440,7 @@ in type = types.bool; default = false; description = - '' + lib.mdDoc '' Logs dropped packets failing the reverse path filter test if the option networking.firewall.checkReversePath is enabled. ''; @@ -451,7 +451,7 @@ in default = [ ]; example = [ "ftp" "irc" "sane" "sip" "tftp" "amanda" "h323" "netbios_sn" "pptp" "snmp" ]; description = - '' + lib.mdDoc '' List of connection-tracking helpers that are auto-loaded. The complete list of possible values is given in the example. @@ -471,7 +471,7 @@ in type = types.bool; default = false; description = - '' + lib.mdDoc '' Whether to auto-load connection-tracking helpers. See the description at networking.firewall.connectionTrackingModules @@ -484,7 +484,7 @@ in default = ""; example = "iptables -A INPUT -p icmp -j ACCEPT"; description = - '' + lib.mdDoc '' Additional shell commands executed as part of the firewall initialisation script. These are executed just before the final "reject" firewall rule is added, so they can be used @@ -497,7 +497,7 @@ in default = [ ]; example = literalExpression "[ pkgs.ipset ]"; description = - '' + lib.mdDoc '' Additional packages to be included in the environment of the system as well as the path of networking.firewall.extraCommands. ''; @@ -508,7 +508,7 @@ in default = ""; example = "iptables -P INPUT ACCEPT"; description = - '' + lib.mdDoc '' Additional shell commands executed as part of the firewall shutdown script. These are executed just after the removal of the NixOS input rule, or if the service enters a failed @@ -520,7 +520,7 @@ in default = { }; type = with types; attrsOf (submodule [ { options = commonOptions; } ]); description = - '' + lib.mdDoc '' Interface-specific open ports. ''; }; diff --git a/nixos/modules/services/networking/flannel.nix b/nixos/modules/services/networking/flannel.nix index 4698c1f682c99..547b6e03949b6 100644 --- a/nixos/modules/services/networking/flannel.nix +++ b/nixos/modules/services/networking/flannel.nix @@ -17,14 +17,14 @@ in { enable = mkEnableOption "flannel"; package = mkOption { - description = "Package to use for flannel"; + description = lib.mdDoc "Package to use for flannel"; type = types.package; default = pkgs.flannel; defaultText = literalExpression "pkgs.flannel"; }; publicIp = mkOption { - description = '' + description = lib.mdDoc '' IP accessible by other nodes for inter-host communication. Defaults to the IP of the interface being used for communication. ''; @@ -33,7 +33,7 @@ in { }; iface = mkOption { - description = '' + description = lib.mdDoc '' Interface to use (IP or name) for inter-host communication. Defaults to the interface for the default route on the machine. ''; @@ -43,38 +43,38 @@ in { etcd = { endpoints = mkOption { - description = "Etcd endpoints"; + description = lib.mdDoc "Etcd endpoints"; type = types.listOf types.str; default = ["http://127.0.0.1:2379"]; }; prefix = mkOption { - description = "Etcd key prefix"; + description = lib.mdDoc "Etcd key prefix"; type = types.str; default = "/coreos.com/network"; }; caFile = mkOption { - description = "Etcd certificate authority file"; + description = lib.mdDoc "Etcd certificate authority file"; type = types.nullOr types.path; default = null; }; certFile = mkOption { - description = "Etcd cert file"; + description = lib.mdDoc "Etcd cert file"; type = types.nullOr types.path; default = null; }; keyFile = mkOption { - description = "Etcd key file"; + description = lib.mdDoc "Etcd key file"; type = types.nullOr types.path; default = null; }; }; kubeconfig = mkOption { - description = '' + description = lib.mdDoc '' Path to kubeconfig to use for storing flannel config using the Kubernetes API ''; @@ -88,7 +88,7 @@ in { }; nodeName = mkOption { - description = '' + description = lib.mdDoc '' Needed when running with Kubernetes as backend as this cannot be auto-detected"; ''; type = types.nullOr types.str; @@ -100,13 +100,13 @@ in { }; storageBackend = mkOption { - description = "Determines where flannel stores its configuration at runtime"; + description = lib.mdDoc "Determines where flannel stores its configuration at runtime"; type = types.enum ["etcd" "kubernetes"]; default = "etcd"; }; subnetLen = mkOption { - description = '' + description = lib.mdDoc '' The size of the subnet allocated to each host. Defaults to 24 (i.e. /24) unless the Network was configured to be smaller than a /24 in which case it is one less than the network. @@ -116,7 +116,7 @@ in { }; subnetMin = mkOption { - description = '' + description = lib.mdDoc '' The beginning of IP range which the subnet allocation should start with. Defaults to the first subnet of Network. ''; @@ -125,7 +125,7 @@ in { }; subnetMax = mkOption { - description = '' + description = lib.mdDoc '' The end of IP range which the subnet allocation should start with. Defaults to the last subnet of Network. ''; @@ -134,7 +134,7 @@ in { }; backend = mkOption { - description = "Type of backend to use and specific configurations for that backend."; + description = lib.mdDoc "Type of backend to use and specific configurations for that backend."; type = types.attrs; default = { Type = "vxlan"; diff --git a/nixos/modules/services/networking/freenet.nix b/nixos/modules/services/networking/freenet.nix index 3da3ab0c7df48..e1737e820a519 100644 --- a/nixos/modules/services/networking/freenet.nix +++ b/nixos/modules/services/networking/freenet.nix @@ -22,13 +22,13 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable the Freenet daemon"; + description = lib.mdDoc "Enable the Freenet daemon"; }; nice = mkOption { type = types.int; default = 10; - description = "Set the nice level for the Freenet daemon"; + description = lib.mdDoc "Set the nice level for the Freenet daemon"; }; }; diff --git a/nixos/modules/services/networking/freeradius.nix b/nixos/modules/services/networking/freeradius.nix index 7fa3a8fa17fa7..6c6777c8a5723 100644 --- a/nixos/modules/services/networking/freeradius.nix +++ b/nixos/modules/services/networking/freeradius.nix @@ -38,7 +38,7 @@ let configDir = mkOption { type = types.path; default = "/etc/raddb"; - description = '' + description = lib.mdDoc '' The path of the freeradius server configuration directory. ''; }; @@ -46,7 +46,7 @@ let debug = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable debug logging for freeradius (-xx option). This should not be left on, since it includes sensitive data such as passwords in the logs. diff --git a/nixos/modules/services/networking/frr.nix b/nixos/modules/services/networking/frr.nix index 98452123f0306..71b66b71ee422 100644 --- a/nixos/modules/services/networking/frr.nix +++ b/nixos/modules/services/networking/frr.nix @@ -57,7 +57,7 @@ let type = types.nullOr types.path; default = null; example = "/etc/frr/${daemonName service}.conf"; - description = '' + description = lib.mdDoc '' Configuration file to use for FRR ${daemonName service}. By default the NixOS generated files are used. ''; @@ -86,7 +86,7 @@ let }; in examples.${service} or ""; - description = '' + description = lib.mdDoc '' ${daemonName service} configuration statements. ''; }; @@ -94,7 +94,7 @@ let vtyListenAddress = mkOption { type = types.str; default = "localhost"; - description = '' + description = lib.mdDoc '' Address to bind to for the VTY interface. ''; }; @@ -102,7 +102,7 @@ let vtyListenPort = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' TCP Port to bind to for the VTY interface. ''; }; @@ -110,7 +110,7 @@ let extraOptions = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Extra options for the daemon. ''; }; @@ -128,7 +128,7 @@ in enable = mkOption { type = types.bool; default = any isEnabled services; - description = '' + description = lib.mdDoc '' Whether to enable the Zebra routing manager. The Zebra routing manager is automatically enabled diff --git a/nixos/modules/services/networking/gateone.nix b/nixos/modules/services/networking/gateone.nix index e68f8a47d5c0d..dc4a65f020d41 100644 --- a/nixos/modules/services/networking/gateone.nix +++ b/nixos/modules/services/networking/gateone.nix @@ -10,12 +10,12 @@ options = { pidDir = mkOption { default = "/run/gateone"; type = types.path; - description = "Path of pid files for GateOne."; + description = lib.mdDoc "Path of pid files for GateOne."; }; settingsDir = mkOption { default = "/var/lib/gateone"; type = types.path; - description = "Path of configuration files for GateOne."; + description = lib.mdDoc "Path of configuration files for GateOne."; }; }; }; diff --git a/nixos/modules/services/networking/ghostunnel.nix b/nixos/modules/services/networking/ghostunnel.nix index 7a62d378e2c6e..6cac6a69b0679 100644 --- a/nixos/modules/services/networking/ghostunnel.nix +++ b/nixos/modules/services/networking/ghostunnel.nix @@ -23,14 +23,14 @@ let options = { listen = mkOption { - description = '' + description = lib.mdDoc '' Address and port to listen on (can be HOST:PORT, unix:PATH). ''; type = types.str; }; target = mkOption { - description = '' + description = lib.mdDoc '' Address to forward connections to (can be HOST:PORT or unix:PATH). ''; type = types.str; @@ -76,7 +76,7 @@ let }; disableAuthentication = mkOption { - description = '' + description = lib.mdDoc '' Disable client authentication, no client certificate will be required. ''; type = types.bool; @@ -84,7 +84,7 @@ let }; allowAll = mkOption { - description = '' + description = lib.mdDoc '' If true, allow all clients, do not check client cert subject. ''; type = types.bool; @@ -92,7 +92,7 @@ let }; allowCN = mkOption { - description = '' + description = lib.mdDoc '' Allow client if common name appears in the list. ''; type = types.listOf types.str; @@ -100,7 +100,7 @@ let }; allowOU = mkOption { - description = '' + description = lib.mdDoc '' Allow client if organizational unit name appears in the list. ''; type = types.listOf types.str; @@ -108,7 +108,7 @@ let }; allowDNS = mkOption { - description = '' + description = lib.mdDoc '' Allow client if DNS subject alternative name appears in the list. ''; type = types.listOf types.str; @@ -116,7 +116,7 @@ let }; allowURI = mkOption { - description = '' + description = lib.mdDoc '' Allow client if URI subject alternative name appears in the list. ''; type = types.listOf types.str; @@ -130,7 +130,7 @@ let }; unsafeTarget = mkOption { - description = '' + description = lib.mdDoc '' If set, does not limit target to localhost, 127.0.0.1, [::1], or UNIX sockets. This is meant to protect against accidental unencrypted traffic on @@ -216,14 +216,14 @@ in services.ghostunnel.enable = mkEnableOption "ghostunnel"; services.ghostunnel.package = mkOption { - description = "The ghostunnel package to use."; + description = lib.mdDoc "The ghostunnel package to use."; type = types.package; default = pkgs.ghostunnel; defaultText = literalExpression "pkgs.ghostunnel"; }; services.ghostunnel.servers = mkOption { - description = '' + description = lib.mdDoc '' Server mode ghostunnels (TLS listener -> plain TCP/UNIX target) ''; type = types.attrsOf (types.submodule module); diff --git a/nixos/modules/services/networking/git-daemon.nix b/nixos/modules/services/networking/git-daemon.nix index 6be72505c216e..80b15eedbbd4e 100644 --- a/nixos/modules/services/networking/git-daemon.nix +++ b/nixos/modules/services/networking/git-daemon.nix @@ -15,7 +15,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable Git daemon, which allows public hosting of git repositories without any access controls. This is mostly intended for read-only access. @@ -31,7 +31,7 @@ in type = types.str; default = ""; example = "/srv/git/"; - description = '' + description = lib.mdDoc '' Remap all the path requests as relative to the given path. For example, if you set base-path to /srv/git, then if you later try to pull git://example.com/hello.git, Git daemon will interpret the path as /srv/git/hello.git. @@ -41,7 +41,7 @@ in exportAll = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Publish all directories that look like Git repositories (have the objects and refs subdirectories), even if they do not have the git-daemon-export-ok file. @@ -57,7 +57,7 @@ in type = types.listOf types.str; default = []; example = [ "/srv/git" "/home/user/git/repo2" ]; - description = '' + description = lib.mdDoc '' A whitelist of paths of git repositories, or directories containing repositories all of which would be published. Paths must not end in "/". @@ -70,31 +70,31 @@ in type = types.str; default = ""; example = "example.com"; - description = "Listen on a specific IP address or hostname."; + description = lib.mdDoc "Listen on a specific IP address or hostname."; }; port = mkOption { type = types.port; default = 9418; - description = "Port to listen on."; + description = lib.mdDoc "Port to listen on."; }; options = mkOption { type = types.str; default = ""; - description = "Extra configuration options to be passed to Git daemon."; + description = lib.mdDoc "Extra configuration options to be passed to Git daemon."; }; user = mkOption { type = types.str; default = "git"; - description = "User under which Git daemon would be running."; + description = lib.mdDoc "User under which Git daemon would be running."; }; group = mkOption { type = types.str; default = "git"; - description = "Group under which Git daemon would be running."; + description = lib.mdDoc "Group under which Git daemon would be running."; }; }; diff --git a/nixos/modules/services/networking/globalprotect-vpn.nix b/nixos/modules/services/networking/globalprotect-vpn.nix index 976fdf2b962ae..19d6e8bfac692 100644 --- a/nixos/modules/services/networking/globalprotect-vpn.nix +++ b/nixos/modules/services/networking/globalprotect-vpn.nix @@ -16,9 +16,9 @@ in enable = mkEnableOption "globalprotect"; csdWrapper = mkOption { - description = '' + description = lib.mdDoc '' A script that will produce a Host Integrity Protection (HIP) report, - as described at <link xlink:href="https://www.infradead.org/openconnect/hip.html" /> + as described at <https://www.infradead.org/openconnect/hip.html> ''; default = null; example = literalExpression ''"''${pkgs.openconnect}/libexec/openconnect/hipreport.sh"''; diff --git a/nixos/modules/services/networking/gnunet.nix b/nixos/modules/services/networking/gnunet.nix index 5c41967d279b6..2ab9097e7f7db 100644 --- a/nixos/modules/services/networking/gnunet.nix +++ b/nixos/modules/services/networking/gnunet.nix @@ -47,7 +47,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to run the GNUnet daemon. GNUnet is GNU's anonymous peer-to-peer communication and file sharing framework. ''; @@ -57,7 +57,7 @@ in quota = mkOption { type = types.int; default = 1024; - description = '' + description = lib.mdDoc '' Maximum file system usage (in MiB) for file sharing. ''; }; @@ -67,7 +67,7 @@ in port = mkOption { type = types.port; default = 2086; # assigned by IANA - description = '' + description = lib.mdDoc '' The UDP port for use by GNUnet. ''; }; @@ -77,7 +77,7 @@ in port = mkOption { type = types.port; default = 2086; # assigned by IANA - description = '' + description = lib.mdDoc '' The TCP port for use by GNUnet. ''; }; @@ -87,7 +87,7 @@ in maxNetDownBandwidth = mkOption { type = types.int; default = 50000; - description = '' + description = lib.mdDoc '' Maximum bandwidth usage (in bits per second) for GNUnet when downloading data. ''; @@ -96,7 +96,7 @@ in maxNetUpBandwidth = mkOption { type = types.int; default = 50000; - description = '' + description = lib.mdDoc '' Maximum bandwidth usage (in bits per second) for GNUnet when downloading data. ''; @@ -105,7 +105,7 @@ in hardNetUpBandwidth = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' Hard bandwidth limit (in bits per second) when uploading data. ''; @@ -116,7 +116,7 @@ in type = types.package; default = pkgs.gnunet; defaultText = literalExpression "pkgs.gnunet"; - description = "Overridable attribute of the gnunet package to use."; + description = lib.mdDoc "Overridable attribute of the gnunet package to use."; example = literalExpression "pkgs.gnunet_git"; }; diff --git a/nixos/modules/services/networking/go-neb.nix b/nixos/modules/services/networking/go-neb.nix index 765834fad83e1..ffa7923d6fbe0 100644 --- a/nixos/modules/services/networking/go-neb.nix +++ b/nixos/modules/services/networking/go-neb.nix @@ -13,7 +13,7 @@ in { bindAddress = mkOption { type = types.str; - description = "Port (and optionally address) to listen on."; + description = lib.mdDoc "Port (and optionally address) to listen on."; default = ":4050"; }; @@ -21,25 +21,25 @@ in { type = types.nullOr types.path; default = null; example = "/run/keys/go-neb.env"; - description = '' + description = lib.mdDoc '' Environment variables from this file will be interpolated into the - final config file using envsubst with this syntax: <literal>$ENVIRONMENT</literal> - or <literal>''${VARIABLE}</literal>. - The file should contain lines formatted as <literal>SECRET_VAR=SECRET_VALUE</literal>. + final config file using envsubst with this syntax: `$ENVIRONMENT` + or `''${VARIABLE}`. + The file should contain lines formatted as `SECRET_VAR=SECRET_VALUE`. This is useful to avoid putting secrets into the nix store. ''; }; baseUrl = mkOption { type = types.str; - description = "Public-facing endpoint that can receive webhooks."; + description = lib.mdDoc "Public-facing endpoint that can receive webhooks."; }; config = mkOption { inherit (settingsFormat) type; - description = '' - Your <filename>config.yaml</filename> as a Nix attribute set. - See <link xlink:href="https://github.com/matrix-org/go-neb/blob/master/config.sample.yaml">config.sample.yaml</link> + description = lib.mdDoc '' + Your {file}`config.yaml` as a Nix attribute set. + See [config.sample.yaml](https://github.com/matrix-org/go-neb/blob/master/config.sample.yaml) for possible options. ''; }; diff --git a/nixos/modules/services/networking/go-shadowsocks2.nix b/nixos/modules/services/networking/go-shadowsocks2.nix index afbd7ea27c65c..e3f99f68d61fa 100644 --- a/nixos/modules/services/networking/go-shadowsocks2.nix +++ b/nixos/modules/services/networking/go-shadowsocks2.nix @@ -9,7 +9,7 @@ in { listenAddress = mkOption { type = types.str; - description = "Server listen address or URL"; + description = lib.mdDoc "Server listen address or URL"; example = "ss://AEAD_CHACHA20_POLY1305:your-password@:8488"; }; }; diff --git a/nixos/modules/services/networking/gobgpd.nix b/nixos/modules/services/networking/gobgpd.nix index 29ef9a5cf1e3b..f1e2095708f97 100644 --- a/nixos/modules/services/networking/gobgpd.nix +++ b/nixos/modules/services/networking/gobgpd.nix @@ -13,9 +13,9 @@ in { settings = mkOption { type = format.type; default = { }; - description = '' + description = lib.mdDoc '' GoBGP configuration. Refer to - <link xlink:href="https://github.com/osrg/gobgp#documentation"/> + <https://github.com/osrg/gobgp#documentation> for details on supported values. ''; example = literalExpression '' diff --git a/nixos/modules/services/networking/gvpe.nix b/nixos/modules/services/networking/gvpe.nix index 4fad37ba15eef..5ecf78d09efcd 100644 --- a/nixos/modules/services/networking/gvpe.nix +++ b/nixos/modules/services/networking/gvpe.nix @@ -47,7 +47,7 @@ in nodename = mkOption { default = null; type = types.nullOr types.str; - description ='' + description =lib.mdDoc '' GVPE node name ''; }; @@ -68,7 +68,7 @@ in on alpha if-up = if-up-0 on alpha pid-file = /var/gvpe/gvpe.pid ''; - description = '' + description = lib.mdDoc '' GVPE config contents ''; }; @@ -76,14 +76,14 @@ in default = null; type = types.nullOr types.path; example = "/root/my-gvpe-conf"; - description = '' + description = lib.mdDoc '' GVPE config file, if already present ''; }; ipAddress = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' IP address to assign to GVPE interface ''; }; @@ -91,14 +91,14 @@ in default = null; type = types.nullOr types.str; example = "10.0.0.0/8"; - description = '' + description = lib.mdDoc '' IP subnet assigned to GVPE network ''; }; customIFSetup = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Additional commands to apply in ifup script ''; }; diff --git a/nixos/modules/services/networking/hans.nix b/nixos/modules/services/networking/hans.nix index 2639b4b680011..f74d602be933c 100644 --- a/nixos/modules/services/networking/hans.nix +++ b/nixos/modules/services/networking/hans.nix @@ -41,21 +41,21 @@ in server = mkOption { type = types.str; default = ""; - description = "IP address of server running hans"; + description = lib.mdDoc "IP address of server running hans"; example = "192.0.2.1"; }; extraConfig = mkOption { type = types.str; default = ""; - description = "Additional command line parameters"; + description = lib.mdDoc "Additional command line parameters"; example = "-v"; }; passwordFile = mkOption { type = types.str; default = ""; - description = "File that containts password"; + description = lib.mdDoc "File that containts password"; }; }; @@ -66,33 +66,33 @@ in enable = mkOption { type = types.bool; default = false; - description = "enable hans server"; + description = lib.mdDoc "enable hans server"; }; ip = mkOption { type = types.str; default = ""; - description = "The assigned ip range"; + description = lib.mdDoc "The assigned ip range"; example = "198.51.100.0"; }; respondToSystemPings = mkOption { type = types.bool; default = false; - description = "Force hans respond to ordinary pings"; + description = lib.mdDoc "Force hans respond to ordinary pings"; }; extraConfig = mkOption { type = types.str; default = ""; - description = "Additional command line parameters"; + description = lib.mdDoc "Additional command line parameters"; example = "-v"; }; passwordFile = mkOption { type = types.str; default = ""; - description = "File that containts password"; + description = lib.mdDoc "File that containts password"; }; }; diff --git a/nixos/modules/services/networking/haproxy.nix b/nixos/modules/services/networking/haproxy.nix index e9d72b35499d1..e0b686434b6e9 100644 --- a/nixos/modules/services/networking/haproxy.nix +++ b/nixos/modules/services/networking/haproxy.nix @@ -20,7 +20,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable HAProxy, the reliable, high performance TCP/HTTP load balancer. ''; @@ -29,21 +29,21 @@ with lib; user = mkOption { type = types.str; default = "haproxy"; - description = "User account under which haproxy runs."; + description = lib.mdDoc "User account under which haproxy runs."; }; group = mkOption { type = types.str; default = "haproxy"; - description = "Group account under which haproxy runs."; + description = lib.mdDoc "Group account under which haproxy runs."; }; config = mkOption { type = types.nullOr types.lines; default = null; - description = '' + description = lib.mdDoc '' Contents of the HAProxy configuration file, - <filename>haproxy.conf</filename>. + {file}`haproxy.conf`. ''; }; }; diff --git a/nixos/modules/services/networking/headscale.nix b/nixos/modules/services/networking/headscale.nix index a9958c884da8d..f7141de97b5e5 100644 --- a/nixos/modules/services/networking/headscale.nix +++ b/nixos/modules/services/networking/headscale.nix @@ -18,7 +18,7 @@ in type = types.package; default = pkgs.headscale; defaultText = literalExpression "pkgs.headscale"; - description = '' + description = lib.mdDoc '' Which headscale package to use for the running server. ''; }; @@ -52,7 +52,7 @@ in serverUrl = mkOption { type = types.str; default = "http://127.0.0.1:8080"; - description = '' + description = lib.mdDoc '' The url clients will connect to. ''; example = "https://myheadscale.example.com:443"; @@ -61,7 +61,7 @@ in address = mkOption { type = types.str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' Listening address of headscale. ''; example = "0.0.0.0"; @@ -70,7 +70,7 @@ in port = mkOption { type = types.port; default = 8080; - description = '' + description = lib.mdDoc '' Listening port of headscale. ''; example = 443; @@ -79,7 +79,7 @@ in privateKeyFile = mkOption { type = types.path; default = "${dataDir}/private.key"; - description = '' + description = lib.mdDoc '' Path to private key file, generated automatically if it does not exist. ''; }; @@ -88,18 +88,18 @@ in urls = mkOption { type = types.listOf types.str; default = [ "https://controlplane.tailscale.com/derpmap/default" ]; - description = '' + description = lib.mdDoc '' List of urls containing DERP maps. - See <link xlink:href="https://tailscale.com/blog/how-tailscale-works/">How Tailscale works</link> for more information on DERP maps. + See [How Tailscale works](https://tailscale.com/blog/how-tailscale-works/) for more information on DERP maps. ''; }; paths = mkOption { type = types.listOf types.path; default = [ ]; - description = '' + description = lib.mdDoc '' List of file paths containing DERP maps. - See <link xlink:href="https://tailscale.com/blog/how-tailscale-works/">How Tailscale works</link> for more information on DERP maps. + See [How Tailscale works](https://tailscale.com/blog/how-tailscale-works/) for more information on DERP maps. ''; }; @@ -107,7 +107,7 @@ in autoUpdate = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to automatically update DERP maps on a set frequency. ''; example = false; @@ -116,7 +116,7 @@ in updateFrequency = mkOption { type = types.str; default = "24h"; - description = '' + description = lib.mdDoc '' Frequency to update DERP maps. ''; example = "5m"; @@ -127,7 +127,7 @@ in ephemeralNodeInactivityTimeout = mkOption { type = types.str; default = "30m"; - description = '' + description = lib.mdDoc '' Time before an inactive ephemeral node is deleted. ''; example = "5m"; @@ -138,58 +138,58 @@ in type = types.enum [ "sqlite3" "postgres" ]; example = "postgres"; default = "sqlite3"; - description = "Database engine to use."; + description = lib.mdDoc "Database engine to use."; }; host = mkOption { type = types.nullOr types.str; default = null; example = "127.0.0.1"; - description = "Database host address."; + description = lib.mdDoc "Database host address."; }; port = mkOption { type = types.nullOr types.port; default = null; example = 3306; - description = "Database host port."; + description = lib.mdDoc "Database host port."; }; name = mkOption { type = types.nullOr types.str; default = null; example = "headscale"; - description = "Database name."; + description = lib.mdDoc "Database name."; }; user = mkOption { type = types.nullOr types.str; default = null; example = "headscale"; - description = "Database user."; + description = lib.mdDoc "Database user."; }; passwordFile = mkOption { type = types.nullOr types.path; default = null; example = "/run/keys/headscale-dbpassword"; - description = '' + description = lib.mdDoc '' A file containing the password corresponding to - <option>database.user</option>. + {option}`database.user`. ''; }; path = mkOption { type = types.nullOr types.str; default = "${dataDir}/db.sqlite"; - description = "Path to the sqlite3 database file."; + description = lib.mdDoc "Path to the sqlite3 database file."; }; }; logLevel = mkOption { type = types.str; default = "info"; - description = '' + description = lib.mdDoc '' headscale log level. ''; example = "debug"; @@ -199,7 +199,7 @@ in nameservers = mkOption { type = types.listOf types.str; default = [ "1.1.1.1" ]; - description = '' + description = lib.mdDoc '' List of nameservers to pass to Tailscale clients. ''; }; @@ -207,7 +207,7 @@ in domains = mkOption { type = types.listOf types.str; default = [ ]; - description = '' + description = lib.mdDoc '' Search domains to inject to Tailscale clients. ''; example = [ "mydomain.internal" ]; @@ -226,12 +226,12 @@ in baseDomain = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Defines the base domain to create the hostnames for MagicDNS. - <option>baseDomain</option> must be a FQDNs, without the trailing dot. + {option}`baseDomain` must be a FQDNs, without the trailing dot. The FQDN of the hosts will be - <literal>hostname.namespace.base_domain</literal> (e.g. - <literal>myhost.mynamespace.example.com</literal>). + `hostname.namespace.base_domain` (e.g. + `myhost.mynamespace.example.com`). ''; }; }; @@ -240,7 +240,7 @@ in issuer = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' URL to OpenID issuer. ''; example = "https://openid.example.com"; @@ -249,7 +249,7 @@ in clientId = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' OpenID Connect client ID. ''; }; @@ -257,7 +257,7 @@ in clientSecretFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Path to OpenID Connect client secret file. ''; }; @@ -265,7 +265,7 @@ in domainMap = mkOption { type = types.attrsOf types.str; default = { }; - description = '' + description = lib.mdDoc '' Domain map is used to map incomming users (by their email) to a namespace. The key can be a string, or regex. ''; @@ -281,25 +281,25 @@ in hostname = mkOption { type = types.nullOr types.str; default = ""; - description = '' + description = lib.mdDoc '' Domain name to request a TLS certificate for. ''; }; challengeType = mkOption { type = types.enum [ "TLS_ALPN-01" "HTTP-01" ]; default = "HTTP-01"; - description = '' + description = lib.mdDoc '' Type of ACME challenge to use, currently supported types: - <literal>HTTP-01</literal> or <literal>TLS_ALPN-01</literal>. + `HTTP-01` or `TLS_ALPN-01`. ''; }; httpListen = mkOption { type = types.nullOr types.str; default = ":http"; - description = '' + description = lib.mdDoc '' When HTTP-01 challenge is chosen, letsencrypt must set up a verification endpoint, and it will be listening on: - <literal>:http = port 80</literal>. + `:http = port 80`. ''; }; }; @@ -307,14 +307,14 @@ in certFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Path to already created certificate. ''; }; keyFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Path to key for already created certificate. ''; }; @@ -323,7 +323,7 @@ in aclPolicyFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Path to a file containg ACL policies. ''; }; @@ -331,10 +331,10 @@ in settings = mkOption { type = settingsFormat.type; default = { }; - description = '' - Overrides to <filename>config.yaml</filename> as a Nix attribute set. + description = lib.mdDoc '' + Overrides to {file}`config.yaml` as a Nix attribute set. This option is ideal for overriding settings not exposed as Nix options. - Check the <link xlink:href="https://github.com/juanfont/headscale/blob/main/config-example.yaml">example config</link> + Check the [example config](https://github.com/juanfont/headscale/blob/main/config-example.yaml) for possible options. ''; }; diff --git a/nixos/modules/services/networking/hostapd.nix b/nixos/modules/services/networking/hostapd.nix index f719ff59cc7f0..ec1a7a58b1e09 100644 --- a/nixos/modules/services/networking/hostapd.nix +++ b/nixos/modules/services/networking/hostapd.nix @@ -53,13 +53,13 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable putting a wireless interface into infrastructure mode, allowing other wireless devices to associate with the wireless interface and do wireless networking. A simple access point will - <option>enable hostapd.wpa</option>, - <option>hostapd.wpaPassphrase</option>, and - <option>hostapd.ssid</option>, as well as DHCP on the wireless + {option}`enable hostapd.wpa`, + {option}`hostapd.wpaPassphrase`, and + {option}`hostapd.ssid`, as well as DHCP on the wireless interface to provide IP addresses to the associated stations, and NAT (from the wireless interface to an upstream interface). ''; @@ -69,15 +69,15 @@ in default = ""; example = "wlp2s0"; type = types.str; - description = '' - The interfaces <command>hostapd</command> will use. + description = lib.mdDoc '' + The interfaces {command}`hostapd` will use. ''; }; noScan = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Do not scan for overlapping BSSs in HT40+/- mode. Caution: turning this on will violate regulatory requirements! ''; @@ -87,8 +87,8 @@ in default = "nl80211"; example = "hostapd"; type = types.str; - description = '' - Which driver <command>hostapd</command> will use. + description = lib.mdDoc '' + Which driver {command}`hostapd` will use. Most applications will probably use the default. ''; }; @@ -97,13 +97,13 @@ in default = "nixos"; example = "mySpecialSSID"; type = types.str; - description = "SSID to be used in IEEE 802.11 management frames."; + description = lib.mdDoc "SSID to be used in IEEE 802.11 management frames."; }; hwMode = mkOption { default = "g"; type = types.enum [ "a" "b" "g" ]; - description = '' + description = lib.mdDoc '' Operation mode. (a = IEEE 802.11a, b = IEEE 802.11b, g = IEEE 802.11g). ''; @@ -113,11 +113,11 @@ in default = 7; example = 11; type = types.int; - description = '' + description = lib.mdDoc '' Channel number (IEEE 802.11) Please note that some drivers do not use this value from - <command>hostapd</command> and the channel will need to be configured - separately with <command>iwconfig</command>. + {command}`hostapd` and the channel will need to be configured + separately with {command}`iwconfig`. ''; }; @@ -125,15 +125,15 @@ in default = "wheel"; example = "network"; type = types.str; - description = '' - Members of this group can control <command>hostapd</command>. + description = lib.mdDoc '' + Members of this group can control {command}`hostapd`. ''; }; wpa = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Enable WPA (IEEE 802.11i/D3.0) to authenticate with the access point. ''; }; @@ -142,7 +142,7 @@ in default = "my_sekret"; example = "any_64_char_string"; type = types.str; - description = '' + description = lib.mdDoc '' WPA-PSK (pre-shared-key) passphrase. Clients will need this passphrase to associate with this access point. Warning: This passphrase will get put into a world-readable file in @@ -153,7 +153,7 @@ in logLevel = mkOption { default = 2; type = types.int; - description = '' + description = lib.mdDoc '' Levels (minimum value for logged events): 0 = verbose debugging 1 = debugging @@ -167,7 +167,7 @@ in default = null; example = "US"; type = with types; nullOr str; - description = '' + description = lib.mdDoc '' Country code (ISO/IEC 3166-1). Used to set regulatory domain. Set as needed to indicate country in which device is operating. This can limit available channels and transmit power. @@ -187,7 +187,7 @@ in ht_capab=[HT40-][SHORT-GI-40][DSSS_CCK-40] ''; type = types.lines; - description = "Extra configuration options to put in hostapd.conf."; + description = lib.mdDoc "Extra configuration options to put in hostapd.conf."; }; }; }; diff --git a/nixos/modules/services/networking/htpdate.nix b/nixos/modules/services/networking/htpdate.nix index 6954e5b060c4c..8b9bb2888dacb 100644 --- a/nixos/modules/services/networking/htpdate.nix +++ b/nixos/modules/services/networking/htpdate.nix @@ -19,7 +19,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable htpdate daemon. ''; }; @@ -27,7 +27,7 @@ in extraOptions = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Additional command line arguments to pass to htpdate. ''; }; @@ -35,7 +35,7 @@ in servers = mkOption { type = types.listOf types.str; default = [ "www.google.com" ]; - description = '' + description = lib.mdDoc '' HTTP servers to use for time synchronization. ''; }; @@ -44,7 +44,7 @@ in type = types.str; default = ""; example = "127.0.0.1:8118"; - description = '' + description = lib.mdDoc '' HTTP proxy used for requests. ''; }; diff --git a/nixos/modules/services/networking/https-dns-proxy.nix b/nixos/modules/services/networking/https-dns-proxy.nix index 85d6c362b466b..4b6e302e445f0 100644 --- a/nixos/modules/services/networking/https-dns-proxy.nix +++ b/nixos/modules/services/networking/https-dns-proxy.nix @@ -45,20 +45,20 @@ in enable = mkEnableOption "https-dns-proxy daemon"; address = mkOption { - description = "The address on which to listen"; + description = lib.mdDoc "The address on which to listen"; type = types.str; default = "127.0.0.1"; }; port = mkOption { - description = "The port on which to listen"; + description = lib.mdDoc "The port on which to listen"; type = types.port; default = 5053; }; provider = { kind = mkOption { - description = '' + description = lib.mdDoc '' The upstream provider to use or custom in case you do not trust any of the predefined providers or just want to use your own. @@ -74,18 +74,18 @@ in }; ips = mkOption { - description = "The custom provider IPs"; + description = lib.mdDoc "The custom provider IPs"; type = types.listOf types.str; }; url = mkOption { - description = "The custom provider URL"; + description = lib.mdDoc "The custom provider URL"; type = types.str; }; }; preferIPv4 = mkOption { - description = '' + description = lib.mdDoc '' https_dns_proxy will by default use IPv6 and fail if it is not available. To play it safe, we choose IPv4. ''; @@ -94,7 +94,7 @@ in }; extraArgs = mkOption { - description = "Additional arguments to pass to the process."; + description = lib.mdDoc "Additional arguments to pass to the process."; type = types.listOf types.str; default = [ "-v" ]; }; diff --git a/nixos/modules/services/networking/hylafax/options.nix b/nixos/modules/services/networking/hylafax/options.nix index 8f621b61002fc..bc289132a7601 100644 --- a/nixos/modules/services/networking/hylafax/options.nix +++ b/nixos/modules/services/networking/hylafax/options.nix @@ -37,17 +37,17 @@ let name = mkOption { type = nonEmptyStr; example = "ttyS1"; - description = '' + description = lib.mdDoc '' Name of modem device, - will be searched for in <filename>/dev</filename>. + will be searched for in {file}`/dev`. ''; }; type = mkOption { type = nonEmptyStr; example = "cirrus"; - description = '' + description = lib.mdDoc '' Name of modem configuration file, - will be searched for in <filename>config</filename> + will be searched for in {file}`config` in the spooling area directory. ''; }; @@ -59,11 +59,11 @@ let FAXNumber = "123456"; LocalIdentifier = "LostInBerlin"; }; - description = '' + description = lib.mdDoc '' Attribute set of values for the given modem. ${commonDescr} Options defined here override options in - <option>commonModemConfig</option> for this modem. + {option}`commonModemConfig` for this modem. ''; }; }; @@ -124,9 +124,9 @@ in type = bool; default = true; example = false; - description = '' + description = lib.mdDoc '' Autostart the HylaFAX queue manager at system start. - If this is <literal>false</literal>, the queue manager + If this is `false`, the queue manager will still be started if there are pending jobs or if a user tries to connect to it. ''; @@ -136,34 +136,34 @@ in type = nullOr nonEmptyStr; default = null; example = "49"; - description = "Country code for server and all modems."; + description = lib.mdDoc "Country code for server and all modems."; }; areaCode = mkOption { type = nullOr nonEmptyStr; default = null; example = "30"; - description = "Area code for server and all modems."; + description = lib.mdDoc "Area code for server and all modems."; }; longDistancePrefix = mkOption { type = nullOr str; default = null; example = "0"; - description = "Long distance prefix for server and all modems."; + description = lib.mdDoc "Long distance prefix for server and all modems."; }; internationalPrefix = mkOption { type = nullOr str; default = null; example = "00"; - description = "International prefix for server and all modems."; + description = lib.mdDoc "International prefix for server and all modems."; }; spoolAreaPath = mkOption { type = path; default = "/var/spool/fax"; - description = '' + description = lib.mdDoc '' The spooling area will be created/maintained at the location given here. ''; @@ -197,11 +197,11 @@ in type = path; example = literalExpression ''"''${pkgs.postfix}/bin/sendmail"''; # '' ; # fix vim - description = '' - Path to <filename>sendmail</filename> program. + description = lib.mdDoc '' + Path to {file}`sendmail` program. The default uses the local sendmail wrapper - (see <option>config.services.mail.sendmailSetuidWrapper</option>), - otherwise the <filename>false</filename> + (see {option}`config.services.mail.sendmailSetuidWrapper`), + otherwise the {file}`false` binary to cause an error if used. ''; }; @@ -209,9 +209,9 @@ in hfaxdConfig = mkOption { type = configAttrType; example.RecvqProtection = "0400"; - description = '' + description = lib.mdDoc '' Attribute set of lines for the global - hfaxd config file <filename>etc/hfaxd.conf</filename>. + hfaxd config file {file}`etc/hfaxd.conf`. ${commonDescr} ''; }; @@ -222,9 +222,9 @@ in InternationalPrefix = "00"; LongDistancePrefix = "0"; }; - description = '' + description = lib.mdDoc '' Attribute set of lines for the global - faxq config file <filename>etc/config</filename>. + faxq config file {file}`etc/config`. ${commonDescr} ''; }; @@ -254,7 +254,7 @@ in LocalIdentifier = "Smith"; }; }; - description = '' + description = lib.mdDoc '' Description of installed modems. At least on modem must be defined to enable the HylaFAX server. @@ -265,7 +265,7 @@ in type = lines; default = ""; example = "chmod 0755 . # everyone may read my faxes"; - description = '' + description = lib.mdDoc '' Additional shell code that is executed within the spooling area directory right after its setup. ''; @@ -280,16 +280,16 @@ in type = nullOr nonEmptyStr; default = null; example = "daily"; - description = '' + description = lib.mdDoc '' Purge old files from the spooling area with - <filename>faxcron</filename> with the given frequency + {file}`faxcron` with the given frequency (see systemd.time(7)). ''; }; faxcron.infoDays = mkOption { type = ints.positive; default = 30; - description = '' + description = lib.mdDoc '' Set the expiration time for data in the remote machine information directory in days. ''; @@ -297,7 +297,7 @@ in faxcron.logDays = mkOption { type = ints.positive; default = 30; - description = '' + description = lib.mdDoc '' Set the expiration time for session trace log files in days. ''; @@ -305,7 +305,7 @@ in faxcron.rcvDays = mkOption { type = ints.positive; default = 7; - description = '' + description = lib.mdDoc '' Set the expiration time for files in the received facsimile queue in days. ''; @@ -320,9 +320,9 @@ in type = nullOr nonEmptyStr; default = null; example = "daily"; - description = '' + description = lib.mdDoc '' Purge old files from the spooling area with - <filename>faxcron</filename> with the given frequency + {file}`faxcron` with the given frequency (see systemd.time(7)). ''; }; @@ -330,12 +330,12 @@ in type = enum [ "never" "as-flagged" "always" ]; default = "as-flagged"; example = "always"; - description = '' + description = lib.mdDoc '' Enable or suppress job archiving: - <literal>never</literal> disables job archiving, - <literal>as-flagged</literal> archives jobs that + `never` disables job archiving, + `as-flagged` archives jobs that have been flagged for archiving by sendfax, - <literal>always</literal> forces archiving of all jobs. + `always` forces archiving of all jobs. See also sendfax(1) and faxqclean(8). ''; }; @@ -343,7 +343,7 @@ in type = ints.positive; default = 15; example = literalExpression "24*60"; - description = '' + description = lib.mdDoc '' Set the job age threshold (in minutes) that controls how long jobs may reside in the doneq directory. @@ -353,7 +353,7 @@ in type = ints.positive; default = 60; example = literalExpression "24*60"; - description = '' + description = lib.mdDoc '' Set the document age threshold (in minutes) that controls how long unreferenced files may reside in the docq directory. diff --git a/nixos/modules/services/networking/i2pd.nix b/nixos/modules/services/networking/i2pd.nix index 06f3420b8ff83..fb83778fcf7eb 100644 --- a/nixos/modules/services/networking/i2pd.nix +++ b/nixos/modules/services/networking/i2pd.nix @@ -24,29 +24,29 @@ let name = mkOption { type = types.str; default = name; - description = "The endpoint name."; + description = lib.mdDoc "The endpoint name."; }; address = mkOption { type = types.str; default = addr; - description = "Bind address for ${name} endpoint."; + description = lib.mdDoc "Bind address for ${name} endpoint."; }; port = mkOption { type = types.port; default = port; - description = "Bind port for ${name} endpoint."; + description = lib.mdDoc "Bind port for ${name} endpoint."; }; }; i2cpOpts = name: { length = mkOption { type = types.int; - description = "Guaranteed minimum hops for ${name} tunnels."; + description = lib.mdDoc "Guaranteed minimum hops for ${name} tunnels."; default = 3; }; quantity = mkOption { type = types.int; - description = "Number of simultaneous ${name} tunnels."; + description = lib.mdDoc "Number of simultaneous ${name} tunnels."; default = 5; }; }; @@ -56,7 +56,7 @@ let keys = mkOption { type = with types; nullOr str; default = keyloc; - description = '' + description = lib.mdDoc '' File to persist ${lib.toUpper name} keys. ''; }; @@ -64,12 +64,12 @@ let outbound = i2cpOpts name; latency.min = mkOption { type = with types; nullOr int; - description = "Min latency for tunnels."; + description = lib.mdDoc "Min latency for tunnels."; default = null; }; latency.max = mkOption { type = with types; nullOr int; - description = "Max latency for tunnels."; + description = lib.mdDoc "Max latency for tunnels."; default = null; }; }; @@ -79,17 +79,17 @@ let inbound = i2cpOpts name; crypto.tagsToSend = mkOption { type = types.int; - description = "Number of ElGamal/AES tags to send."; + description = lib.mdDoc "Number of ElGamal/AES tags to send."; default = 40; }; destination = mkOption { type = types.str; - description = "Remote endpoint, I2P hostname or b32.i2p address."; + description = lib.mdDoc "Remote endpoint, I2P hostname or b32.i2p address."; }; keys = mkOption { type = types.str; default = name + "-keys.dat"; - description = "Keyset used for tunnel identity."; + description = lib.mdDoc "Keyset used for tunnel identity."; }; } // mkEndpointOpt name "127.0.0.1" 0; @@ -259,7 +259,7 @@ in type = types.package; default = pkgs.i2pd; defaultText = literalExpression "pkgs.i2pd"; - description = '' + description = lib.mdDoc '' i2pd package to use. ''; }; @@ -267,12 +267,12 @@ in logLevel = mkOption { type = types.enum ["debug" "info" "warn" "error"]; default = "error"; - description = '' - The log level. <command>i2pd</command> defaults to "info" + description = lib.mdDoc '' + The log level. {command}`i2pd` defaults to "info" but that generates copious amounts of log messages. We default to "error" which is similar to the default log - level of <command>tor</command>. + level of {command}`tor`. ''; }; @@ -281,7 +281,7 @@ in address = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Your external IP or hostname. ''; }; @@ -289,7 +289,7 @@ in family = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Specify a family the router belongs to. ''; }; @@ -297,7 +297,7 @@ in dataDir = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Alternative path to storage of i2pd data (RI, keys, peer profiles, ...) ''; }; @@ -305,7 +305,7 @@ in share = mkOption { type = types.int; default = 100; - description = '' + description = lib.mdDoc '' Limit of transit traffic from max bandwidth in percents. ''; }; @@ -313,7 +313,7 @@ in ifname = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Network interface to bind to. ''; }; @@ -321,7 +321,7 @@ in ifname4 = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' IPv4 interface to bind to. ''; }; @@ -329,7 +329,7 @@ in ifname6 = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' IPv6 interface to bind to. ''; }; @@ -337,7 +337,7 @@ in ntcpProxy = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Proxy URL for NTCP transport. ''; }; @@ -360,7 +360,7 @@ in netid = mkOption { type = types.int; default = 2; - description = '' + description = lib.mdDoc '' I2P overlay netid. ''; }; @@ -368,16 +368,16 @@ in bandwidth = mkOption { type = with types; nullOr int; default = null; - description = '' + description = lib.mdDoc '' Set a router bandwidth limit integer in KBps. - If not set, <command>i2pd</command> defaults to 32KBps. + If not set, {command}`i2pd` defaults to 32KBps. ''; }; port = mkOption { type = with types; nullOr int; default = null; - description = '' + description = lib.mdDoc '' I2P listen port. If no one is given the router will pick between 9111 and 30777. ''; }; @@ -390,7 +390,7 @@ in upnp.name = mkOption { type = types.str; default = "I2Pd"; - description = '' + description = lib.mdDoc '' Name i2pd appears in UPnP forwardings list. ''; }; @@ -411,7 +411,7 @@ in reseed.file = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Full path to SU3 file to reseed from. ''; }; @@ -419,7 +419,7 @@ in reseed.urls = mkOption { type = with types; listOf str; default = []; - description = '' + description = lib.mdDoc '' Reseed URLs. ''; }; @@ -427,7 +427,7 @@ in reseed.floodfill = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Path to router info of floodfill to reseed from. ''; }; @@ -435,7 +435,7 @@ in reseed.zipfile = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Path to local .zip file to reseed from. ''; }; @@ -443,7 +443,7 @@ in reseed.proxy = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' URL for reseed proxy, supports http/socks. ''; }; @@ -451,7 +451,7 @@ in addressbook.defaulturl = mkOption { type = types.str; default = "http://joajgazyztfssty4w2on5oaqksz6tqoxbduy553y34mf4byv6gpq.b32.i2p/export/alive-hosts.txt"; - description = '' + description = lib.mdDoc '' AddressBook subscription URL for initial setup ''; }; @@ -462,7 +462,7 @@ in "http://i2p-projekt.i2p/hosts.txt" "http://stats.i2p/cgi-bin/newhosts.txt" ]; - description = '' + description = lib.mdDoc '' AddressBook subscription URLs ''; }; @@ -472,7 +472,7 @@ in trust.family = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Router Familiy to trust for first hops. ''; }; @@ -480,7 +480,7 @@ in trust.routers = mkOption { type = with types; listOf str; default = []; - description = '' + description = lib.mdDoc '' Only connect to the listed routers. ''; }; @@ -497,7 +497,7 @@ in ntcp2.port = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' Port to listen for incoming NTCP2 connections (0=auto). ''; }; @@ -505,7 +505,7 @@ in limits.transittunnels = mkOption { type = types.int; default = 2500; - description = '' + description = lib.mdDoc '' Maximum number of active transit sessions. ''; }; @@ -513,7 +513,7 @@ in limits.coreSize = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' Maximum size of corefile in Kb (0 - use system limit). ''; }; @@ -521,7 +521,7 @@ in limits.openFiles = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' Maximum number of open files (0 - use system default). ''; }; @@ -529,7 +529,7 @@ in limits.ntcpHard = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' Maximum number of active transit sessions. ''; }; @@ -537,7 +537,7 @@ in limits.ntcpSoft = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' Threshold to start probabalistic backoff with ntcp sessions (default: use system limit). ''; }; @@ -545,7 +545,7 @@ in limits.ntcpThreads = mkOption { type = types.int; default = 1; - description = '' + description = lib.mdDoc '' Maximum number of threads used by NTCP DH worker. ''; }; @@ -555,7 +555,7 @@ in yggdrasil.address = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Your local yggdrasil address. Specify it if you want to bind your router to a particular address. ''; @@ -568,7 +568,7 @@ in user = mkOption { type = types.str; default = "i2pd"; - description = '' + description = lib.mdDoc '' Username for webconsole access ''; }; @@ -576,7 +576,7 @@ in pass = mkOption { type = types.str; default = "i2pd"; - description = '' + description = lib.mdDoc '' Password for webconsole access. ''; }; @@ -584,7 +584,7 @@ in strictHeaders = mkOption { type = with types; nullOr bool; default = null; - description = '' + description = lib.mdDoc '' Enable strict host checking on WebUI. ''; }; @@ -592,7 +592,7 @@ in hostname = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Expected hostname for WebUI. ''; }; @@ -603,7 +603,7 @@ in outproxy = mkOption { type = with types; nullOr str; default = null; - description = "Upstream outproxy bind address."; + description = lib.mdDoc "Upstream outproxy bind address."; }; }; proto.socksProxy = (mkKeyedEndpointOpt "socksproxy" "127.0.0.1" 4447 "socksproxy-keys.dat") @@ -612,12 +612,12 @@ in outproxy = mkOption { type = types.str; default = "127.0.0.1"; - description = "Upstream outproxy bind address."; + description = lib.mdDoc "Upstream outproxy bind address."; }; outproxyPort = mkOption { type = types.int; default = 4444; - description = "Upstream outproxy bind port."; + description = lib.mdDoc "Upstream outproxy bind port."; }; }; @@ -634,7 +634,7 @@ in destinationPort = mkOption { type = with types; nullOr int; default = null; - description = "Connect to particular port at destination."; + description = lib.mdDoc "Connect to particular port at destination."; }; } // commonTunOpts name; config = { @@ -642,7 +642,7 @@ in }; } )); - description = '' + description = lib.mdDoc '' Connect to someone as a client and establish a local accept endpoint ''; }; @@ -655,12 +655,12 @@ in inPort = mkOption { type = types.int; default = 0; - description = "Service port. Default to the tunnel's listen port."; + description = lib.mdDoc "Service port. Default to the tunnel's listen port."; }; accessList = mkOption { type = with types; listOf str; default = []; - description = "I2P nodes that are allowed to connect to this service."; + description = lib.mdDoc "I2P nodes that are allowed to connect to this service."; }; } // commonTunOpts name; config = { @@ -668,7 +668,7 @@ in }; } )); - description = '' + description = lib.mdDoc '' Serve something on I2P network at port and delegate requests to address inPort. ''; }; diff --git a/nixos/modules/services/networking/icecream/daemon.nix b/nixos/modules/services/networking/icecream/daemon.nix index 8593c94e34dc3..f94832c4778b5 100644 --- a/nixos/modules/services/networking/icecream/daemon.nix +++ b/nixos/modules/services/networking/icecream/daemon.nix @@ -16,14 +16,14 @@ in { openFirewall = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Whether to automatically open receive port in the firewall. ''; }; openBroadcast = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Whether to automatically open the firewall for scheduler discovery. ''; }; @@ -31,7 +31,7 @@ in { cacheLimit = mkOption { type = types.ints.u16; default = 256; - description = '' + description = lib.mdDoc '' Maximum size in Megabytes of cache used to store compile environments of compile clients. ''; }; @@ -39,7 +39,7 @@ in { netName = mkOption { type = types.str; default = "ICECREAM"; - description = '' + description = lib.mdDoc '' Network name to connect to. A scheduler with the same name needs to be running. ''; }; @@ -47,7 +47,7 @@ in { noRemote = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Prevent jobs from other nodes being scheduled on this daemon. ''; }; @@ -55,7 +55,7 @@ in { schedulerHost = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Explicit scheduler hostname, useful in firewalled environments. Uses scheduler autodiscovery via broadcast if set to null. @@ -65,7 +65,7 @@ in { maxProcesses = mkOption { type = types.nullOr types.ints.u16; default = null; - description = '' + description = lib.mdDoc '' Maximum number of compile jobs started in parallel for this daemon. Uses the number of CPUs if set to null. @@ -75,7 +75,7 @@ in { nice = mkOption { type = types.int; default = 5; - description = '' + description = lib.mdDoc '' The level of niceness to use. ''; }; @@ -83,7 +83,7 @@ in { hostname = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Hostname of the daemon in the icecream infrastructure. Uses the hostname retrieved via uname if set to null. @@ -93,7 +93,7 @@ in { user = mkOption { type = types.str; default = "icecc"; - description = '' + description = lib.mdDoc '' User to run the icecream daemon as. Set to root to enable receive of remote compile environments. ''; @@ -103,13 +103,13 @@ in { default = pkgs.icecream; defaultText = literalExpression "pkgs.icecream"; type = types.package; - description = "Icecream package to use."; + description = lib.mdDoc "Icecream package to use."; }; extraArgs = mkOption { type = types.listOf types.str; default = []; - description = "Additional command line parameters."; + description = lib.mdDoc "Additional command line parameters."; example = [ "-v" ]; }; }; diff --git a/nixos/modules/services/networking/icecream/scheduler.nix b/nixos/modules/services/networking/icecream/scheduler.nix index 14fbc966b9893..51f3988fe5847 100644 --- a/nixos/modules/services/networking/icecream/scheduler.nix +++ b/nixos/modules/services/networking/icecream/scheduler.nix @@ -16,7 +16,7 @@ in { netName = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Network name for the icecream scheduler. Uses the default ICECREAM if null. @@ -26,14 +26,14 @@ in { port = mkOption { type = types.port; default = 8765; - description = '' + description = lib.mdDoc '' Server port to listen for icecream daemon requests. ''; }; openFirewall = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Whether to automatically open the daemon port in the firewall. ''; }; @@ -41,7 +41,7 @@ in { openTelnet = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to open the telnet TCP port on 8766. ''; }; @@ -49,7 +49,7 @@ in { persistentClientConnection = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to prevent clients from connecting to a better scheduler. ''; }; @@ -58,13 +58,13 @@ in { default = pkgs.icecream; defaultText = literalExpression "pkgs.icecream"; type = types.package; - description = "Icecream package to use."; + description = lib.mdDoc "Icecream package to use."; }; extraArgs = mkOption { type = types.listOf types.str; default = []; - description = "Additional command line parameters"; + description = lib.mdDoc "Additional command line parameters"; example = [ "-v" ]; }; }; diff --git a/nixos/modules/services/networking/inspircd.nix b/nixos/modules/services/networking/inspircd.nix index 81c367ec8f7dd..f2464b9a11fa2 100644 --- a/nixos/modules/services/networking/inspircd.nix +++ b/nixos/modules/services/networking/inspircd.nix @@ -19,10 +19,10 @@ in { default = pkgs.inspircd; defaultText = lib.literalExpression "pkgs.inspircd"; example = lib.literalExpression "pkgs.inspircdMinimal"; - description = '' + description = lib.mdDoc '' The InspIRCd package to use. This is mainly useful to specify an overridden version of the - <literal>pkgs.inspircd</literal> dervivation, for + `pkgs.inspircd` dervivation, for example if you want to use a more minimal InspIRCd distribution with less modules enabled or with modules enabled which can't be distributed in binary @@ -32,13 +32,13 @@ in { config = lib.mkOption { type = lib.types.lines; - description = '' - Verbatim <literal>inspircd.conf</literal> file. + description = lib.mdDoc '' + Verbatim `inspircd.conf` file. For a list of options, consult the - <link xlink:href="https://docs.inspircd.org/3/configuration/">InspIRCd documentation</link>, the - <link xlink:href="https://docs.inspircd.org/3/modules/">Module documentation</link> + [InspIRCd documentation](https://docs.inspircd.org/3/configuration/), the + [Module documentation](https://docs.inspircd.org/3/modules/) and the example configuration files distributed - with <literal>pkgs.inspircd.doc</literal> + with `pkgs.inspircd.doc` ''; }; }; diff --git a/nixos/modules/services/networking/iodine.nix b/nixos/modules/services/networking/iodine.nix index e241afe3269bb..c24f118ce898d 100644 --- a/nixos/modules/services/networking/iodine.nix +++ b/nixos/modules/services/networking/iodine.nix @@ -52,28 +52,28 @@ in server = mkOption { type = types.str; default = ""; - description = "Hostname of server running iodined"; + description = lib.mdDoc "Hostname of server running iodined"; example = "tunnel.mydomain.com"; }; relay = mkOption { type = types.str; default = ""; - description = "DNS server to use as an intermediate relay to the iodined server"; + description = lib.mdDoc "DNS server to use as an intermediate relay to the iodined server"; example = "8.8.8.8"; }; extraConfig = mkOption { type = types.str; default = ""; - description = "Additional command line parameters"; + description = lib.mdDoc "Additional command line parameters"; example = "-l 192.168.1.10 -p 23"; }; passwordFile = mkOption { type = types.str; default = ""; - description = "Path to a file containing the password."; + description = lib.mdDoc "Path to a file containing the password."; }; }; } @@ -85,34 +85,34 @@ in enable = mkOption { type = types.bool; default = false; - description = "enable iodined server"; + description = lib.mdDoc "enable iodined server"; }; ip = mkOption { type = types.str; default = ""; - description = "The assigned ip address or ip range"; + description = lib.mdDoc "The assigned ip address or ip range"; example = "172.16.10.1/24"; }; domain = mkOption { type = types.str; default = ""; - description = "Domain or subdomain of which nameservers point to us"; + description = lib.mdDoc "Domain or subdomain of which nameservers point to us"; example = "tunnel.mydomain.com"; }; extraConfig = mkOption { type = types.str; default = ""; - description = "Additional command line parameters"; + description = lib.mdDoc "Additional command line parameters"; example = "-l 192.168.1.10 -p 23"; }; passwordFile = mkOption { type = types.str; default = ""; - description = "File that contains password"; + description = lib.mdDoc "File that contains password"; }; }; diff --git a/nixos/modules/services/networking/iperf3.nix b/nixos/modules/services/networking/iperf3.nix index 0fe378b225d71..0c308f8e7c096 100644 --- a/nixos/modules/services/networking/iperf3.nix +++ b/nixos/modules/services/networking/iperf3.nix @@ -7,52 +7,52 @@ let port = mkOption { type = types.ints.u16; default = 5201; - description = "Server port to listen on for iperf3 client requsts."; + description = lib.mdDoc "Server port to listen on for iperf3 client requsts."; }; affinity = mkOption { type = types.nullOr types.ints.unsigned; default = null; - description = "CPU affinity for the process."; + description = lib.mdDoc "CPU affinity for the process."; }; bind = mkOption { type = types.nullOr types.str; default = null; - description = "Bind to the specific interface associated with the given address."; + description = lib.mdDoc "Bind to the specific interface associated with the given address."; }; openFirewall = mkOption { type = types.bool; default = false; - description = "Open ports in the firewall for iperf3."; + description = lib.mdDoc "Open ports in the firewall for iperf3."; }; verbose = mkOption { type = types.bool; default = false; - description = "Give more detailed output."; + description = lib.mdDoc "Give more detailed output."; }; forceFlush = mkOption { type = types.bool; default = false; - description = "Force flushing output at every interval."; + description = lib.mdDoc "Force flushing output at every interval."; }; debug = mkOption { type = types.bool; default = false; - description = "Emit debugging output."; + description = lib.mdDoc "Emit debugging output."; }; rsaPrivateKey = mkOption { type = types.nullOr types.path; default = null; - description = "Path to the RSA private key (not password-protected) used to decrypt authentication credentials from the client."; + description = lib.mdDoc "Path to the RSA private key (not password-protected) used to decrypt authentication credentials from the client."; }; authorizedUsersFile = mkOption { type = types.nullOr types.path; default = null; - description = "Path to the configuration file containing authorized users credentials to run iperf tests."; + description = lib.mdDoc "Path to the configuration file containing authorized users credentials to run iperf tests."; }; extraFlags = mkOption { type = types.listOf types.str; default = [ ]; - description = "Extra flags to pass to iperf3(1)."; + description = lib.mdDoc "Extra flags to pass to iperf3(1)."; }; }; diff --git a/nixos/modules/services/networking/iscsi/initiator.nix b/nixos/modules/services/networking/iscsi/initiator.nix index 051c9c7bff3c6..7414a705a2570 100644 --- a/nixos/modules/services/networking/iscsi/initiator.nix +++ b/nixos/modules/services/networking/iscsi/initiator.nix @@ -12,16 +12,16 @@ in discoverPortal = mkOption { type = nullOr str; default = null; - description = "Portal to discover targets on"; + description = lib.mdDoc "Portal to discover targets on"; }; name = mkOption { type = str; - description = "Name of this iscsi initiator"; + description = lib.mdDoc "Name of this iscsi initiator"; example = "iqn.2020-08.org.linux-iscsi.initiatorhost:example"; }; package = mkOption { type = package; - description = "openiscsi package to use"; + description = lib.mdDoc "openiscsi package to use"; default = pkgs.openiscsi; defaultText = literalExpression "pkgs.openiscsi"; }; @@ -29,11 +29,11 @@ in extraConfig = mkOption { type = str; default = ""; - description = "Lines to append to default iscsid.conf"; + description = lib.mdDoc "Lines to append to default iscsid.conf"; }; extraConfigFile = mkOption { - description = '' + description = lib.mdDoc '' Append an additional file's contents to /etc/iscsid.conf. Use a non-store path and store passwords in this file. ''; diff --git a/nixos/modules/services/networking/iscsi/root-initiator.nix b/nixos/modules/services/networking/iscsi/root-initiator.nix index c12aca1bc24d7..b55fda6725213 100644 --- a/nixos/modules/services/networking/iscsi/root-initiator.nix +++ b/nixos/modules/services/networking/iscsi/root-initiator.nix @@ -19,7 +19,7 @@ in # machines to be up. options.boot.iscsi-initiator = with types; { name = mkOption { - description = '' + description = lib.mdDoc '' Name of the iSCSI initiator to boot from. Note, booting from iscsi requires networkd based networking. ''; @@ -29,7 +29,7 @@ in }; discoverPortal = mkOption { - description = '' + description = lib.mdDoc '' iSCSI portal to boot from. ''; default = null; @@ -38,7 +38,7 @@ in }; target = mkOption { - description = '' + description = lib.mdDoc '' Name of the iSCSI target to boot from. ''; default = null; @@ -47,7 +47,7 @@ in }; logLevel = mkOption { - description = '' + description = lib.mdDoc '' Higher numbers elicits more logs. ''; default = 1; @@ -56,7 +56,7 @@ in }; loginAll = mkOption { - description = '' + description = lib.mdDoc '' Do not log into a specific target on the portal, but to all that we discover. This overrides setting target. ''; @@ -65,13 +65,13 @@ in }; extraIscsiCommands = mkOption { - description = "Extra iscsi commands to run in the initrd."; + description = lib.mdDoc "Extra iscsi commands to run in the initrd."; default = ""; type = lines; }; extraConfig = mkOption { - description = "Extra lines to append to /etc/iscsid.conf"; + description = lib.mdDoc "Extra lines to append to /etc/iscsid.conf"; default = null; type = nullOr lines; }; diff --git a/nixos/modules/services/networking/iscsi/target.nix b/nixos/modules/services/networking/iscsi/target.nix index 8a10e7d346ae3..5bdac4336ce6f 100644 --- a/nixos/modules/services/networking/iscsi/target.nix +++ b/nixos/modules/services/networking/iscsi/target.nix @@ -14,7 +14,7 @@ in config = mkOption { type = attrs; default = {}; - description = '' + description = lib.mdDoc '' Content of /etc/target/saveconfig.json This file is normally read and written by targetcli ''; diff --git a/nixos/modules/services/networking/iwd.nix b/nixos/modules/services/networking/iwd.nix index 5c1480e7e2fb9..4921fe2c76ccb 100644 --- a/nixos/modules/services/networking/iwd.nix +++ b/nixos/modules/services/networking/iwd.nix @@ -32,9 +32,9 @@ in }; }; - description = '' + description = lib.mdDoc '' Options passed to iwd. - See <link xlink:href="https://iwd.wiki.kernel.org/networkconfigurationsettings">here</link> for supported options. + See [here](https://iwd.wiki.kernel.org/networkconfigurationsettings) for supported options. ''; }; }; diff --git a/nixos/modules/services/networking/jibri/default.nix b/nixos/modules/services/networking/jibri/default.nix index 113a7aa4384ab..4ac5bae22cc94 100644 --- a/nixos/modules/services/networking/jibri/default.nix +++ b/nixos/modules/services/networking/jibri/default.nix @@ -93,9 +93,9 @@ in config = mkOption { type = attrs; default = { }; - description = '' + description = lib.mdDoc '' Jibri configuration. - See <link xlink:href="https://github.com/jitsi/jibri/blob/master/src/main/resources/reference.conf" /> + See <https://github.com/jitsi/jibri/blob/master/src/main/resources/reference.conf> for default configuration with comments. ''; }; @@ -136,7 +136,7 @@ in exit 0 ''''''; ''; - description = '' + description = lib.mdDoc '' This script runs when jibri finishes recording a video of a conference. ''; }; @@ -145,14 +145,14 @@ in type = bool; default = false; example = true; - description = '' + description = lib.mdDoc '' Whether to enable the flag "--ignore-certificate-errors" for the Chromium browser opened by Jibri. Intended for use in automated tests or anywhere else where using a verified cert for Jitsi-Meet is not possible. ''; }; xmppEnvironments = mkOption { - description = '' + description = lib.mdDoc '' XMPP servers to connect to. ''; example = literalExpression '' @@ -189,54 +189,54 @@ in xmppServerHosts = mkOption { type = listOf str; example = [ "xmpp.example.org" ]; - description = '' + description = lib.mdDoc '' Hostnames of the XMPP servers to connect to. ''; }; xmppDomain = mkOption { type = str; example = "xmpp.example.org"; - description = '' + description = lib.mdDoc '' The base XMPP domain. ''; }; control.muc.domain = mkOption { type = str; - description = '' + description = lib.mdDoc '' The domain part of the MUC to connect to for control. ''; }; control.muc.roomName = mkOption { type = str; default = "JibriBrewery"; - description = '' + description = lib.mdDoc '' The room name of the MUC to connect to for control. ''; }; control.muc.nickname = mkOption { type = str; default = "jibri"; - description = '' + description = lib.mdDoc '' The nickname for this Jibri instance in the MUC. ''; }; control.login.domain = mkOption { type = str; - description = '' + description = lib.mdDoc '' The domain part of the JID for this Jibri instance. ''; }; control.login.username = mkOption { type = str; default = "jvb"; - description = '' + description = lib.mdDoc '' User part of the JID. ''; }; control.login.passwordFile = mkOption { type = str; example = "/run/keys/jibri-xmpp1"; - description = '' + description = lib.mdDoc '' File containing the password for the user. ''; }; @@ -244,28 +244,28 @@ in call.login.domain = mkOption { type = str; example = "recorder.xmpp.example.org"; - description = '' + description = lib.mdDoc '' The domain part of the JID for the recorder. ''; }; call.login.username = mkOption { type = str; default = "recorder"; - description = '' + description = lib.mdDoc '' User part of the JID for the recorder. ''; }; call.login.passwordFile = mkOption { type = str; example = "/run/keys/jibri-recorder-xmpp1"; - description = '' + description = lib.mdDoc '' File containing the password for the user. ''; }; disableCertificateVerification = mkOption { type = bool; default = false; - description = '' + description = lib.mdDoc '' Whether to skip validation of the server's certificate. ''; }; @@ -274,7 +274,7 @@ in type = str; default = "0"; example = "conference."; - description = '' + description = lib.mdDoc '' The prefix to strip from the room's JID domain to derive the call URL. ''; }; @@ -282,7 +282,7 @@ in type = str; default = "0"; example = "1 hour"; - description = '' + description = lib.mdDoc '' The duration that the Jibri session can be. A value of zero means indefinitely. ''; diff --git a/nixos/modules/services/networking/jicofo.nix b/nixos/modules/services/networking/jicofo.nix index 647119b9039e6..3b9038f567413 100644 --- a/nixos/modules/services/networking/jicofo.nix +++ b/nixos/modules/services/networking/jicofo.nix @@ -12,7 +12,7 @@ in xmppHost = mkOption { type = str; example = "localhost"; - description = '' + description = lib.mdDoc '' Hostname of the XMPP server to connect to. ''; }; @@ -20,17 +20,17 @@ in xmppDomain = mkOption { type = nullOr str; example = "meet.example.org"; - description = '' + description = lib.mdDoc '' Domain name of the XMMP server to which to connect as a component. - If null, <option>xmppHost</option> is used. + If null, {option}`xmppHost` is used. ''; }; componentPasswordFile = mkOption { type = str; example = "/run/keys/jicofo-component"; - description = '' + description = lib.mdDoc '' Path to file containing component secret. ''; }; @@ -38,7 +38,7 @@ in userName = mkOption { type = str; default = "focus"; - description = '' + description = lib.mdDoc '' User part of the JID for XMPP user connection. ''; }; @@ -46,7 +46,7 @@ in userDomain = mkOption { type = str; example = "auth.meet.example.org"; - description = '' + description = lib.mdDoc '' Domain part of the JID for XMPP user connection. ''; }; @@ -54,7 +54,7 @@ in userPasswordFile = mkOption { type = str; example = "/run/keys/jicofo-user"; - description = '' + description = lib.mdDoc '' Path to file containing password for XMPP user connection. ''; }; @@ -62,7 +62,7 @@ in bridgeMuc = mkOption { type = str; example = "jvbbrewery@internal.meet.example.org"; - description = '' + description = lib.mdDoc '' JID of the internal MUC used to communicate with Videobridges. ''; }; @@ -75,8 +75,8 @@ in "org.jitsi.jicofo.auth.URL" = "XMPP:jitsi-meet.example.com"; } ''; - description = '' - Contents of the <filename>sip-communicator.properties</filename> configuration file for jicofo. + description = lib.mdDoc '' + Contents of the {file}`sip-communicator.properties` configuration file for jicofo. ''; }; }; diff --git a/nixos/modules/services/networking/jitsi-videobridge.nix b/nixos/modules/services/networking/jitsi-videobridge.nix index abb0bd0a25e18..36e7616d7550b 100644 --- a/nixos/modules/services/networking/jitsi-videobridge.nix +++ b/nixos/modules/services/networking/jitsi-videobridge.nix @@ -67,19 +67,19 @@ in }; } ''; - description = '' + description = lib.mdDoc '' Videobridge configuration. - See <link xlink:href="https://github.com/jitsi/jitsi-videobridge/blob/master/src/main/resources/reference.conf" /> + See <https://github.com/jitsi/jitsi-videobridge/blob/master/src/main/resources/reference.conf> for default configuration with comments. ''; }; xmppConfigs = mkOption { - description = '' + description = lib.mdDoc '' XMPP servers to connect to. - See <link xlink:href="https://github.com/jitsi/jitsi-videobridge/blob/master/doc/muc.md" /> for more information. + See <https://github.com/jitsi/jitsi-videobridge/blob/master/doc/muc.md> for more information. ''; default = { }; example = literalExpression '' @@ -98,7 +98,7 @@ in hostName = mkOption { type = str; example = "xmpp.example.org"; - description = '' + description = lib.mdDoc '' Hostname of the XMPP server to connect to. Name of the attribute set is used by default. ''; }; @@ -106,35 +106,35 @@ in type = nullOr str; default = null; example = "auth.xmpp.example.org"; - description = '' + description = lib.mdDoc '' Domain part of JID of the XMPP user, if it is different from hostName. ''; }; userName = mkOption { type = str; default = "jvb"; - description = '' + description = lib.mdDoc '' User part of the JID. ''; }; passwordFile = mkOption { type = str; example = "/run/keys/jitsi-videobridge-xmpp1"; - description = '' + description = lib.mdDoc '' File containing the password for the user. ''; }; mucJids = mkOption { type = str; example = "jvbbrewery@internal.xmpp.example.org"; - description = '' + description = lib.mdDoc '' JID of the MUC to join. JiCoFo needs to be configured to join the same MUC. ''; }; mucNickname = mkOption { # Upstream DEBs use UUID, let's use hostname instead. type = str; - description = '' + description = lib.mdDoc '' Videobridges use the same XMPP account and need to be distinguished by the nickname (aka resource part of the JID). By default, system hostname is used. ''; @@ -142,7 +142,7 @@ in disableCertificateVerification = mkOption { type = bool; default = false; - description = '' + description = lib.mdDoc '' Whether to skip validation of the server's certificate. ''; }; @@ -161,7 +161,7 @@ in type = nullOr str; default = null; example = "192.168.1.42"; - description = '' + description = lib.mdDoc '' Local address when running behind NAT. ''; }; @@ -170,7 +170,7 @@ in type = nullOr str; default = null; example = "1.2.3.4"; - description = '' + description = lib.mdDoc '' Public address when running behind NAT. ''; }; @@ -179,7 +179,7 @@ in extraProperties = mkOption { type = attrsOf str; default = { }; - description = '' + description = lib.mdDoc '' Additional Java properties passed to jitsi-videobridge. ''; }; @@ -187,14 +187,14 @@ in openFirewall = mkOption { type = bool; default = false; - description = '' + description = lib.mdDoc '' Whether to open ports in the firewall for the videobridge. ''; }; apis = mkOption { type = with types; listOf str; - description = '' + description = lib.mdDoc '' What is passed as --apis= parameter. If this is empty, "none" is passed. Needed for monitoring jitsi. ''; diff --git a/nixos/modules/services/networking/kea.nix b/nixos/modules/services/networking/kea.nix index 994c511bdc2d6..d9d6e3f42ceb3 100644 --- a/nixos/modules/services/networking/kea.nix +++ b/nixos/modules/services/networking/kea.nix @@ -35,7 +35,7 @@ in { options.services.kea = with types; { ctrl-agent = mkOption { - description = '' + description = lib.mdDoc '' Kea Control Agent configuration ''; default = {}; @@ -46,7 +46,7 @@ in extraArgs = mkOption { type = listOf str; default = []; - description = '' + description = lib.mdDoc '' List of additonal arguments to pass to the daemon. ''; }; @@ -65,8 +65,8 @@ in settings = mkOption { type = format.type; default = null; - description = '' - Kea Control Agent configuration as an attribute set, see <link xlink:href="https://kea.readthedocs.io/en/kea-${package.version}/arm/agent.html"/>. + description = lib.mdDoc '' + Kea Control Agent configuration as an attribute set, see <https://kea.readthedocs.io/en/kea-${package.version}/arm/agent.html>. ''; }; }; @@ -74,7 +74,7 @@ in }; dhcp4 = mkOption { - description = '' + description = lib.mdDoc '' DHCP4 Server configuration ''; default = {}; @@ -85,7 +85,7 @@ in extraArgs = mkOption { type = listOf str; default = []; - description = '' + description = lib.mdDoc '' List of additonal arguments to pass to the daemon. ''; }; @@ -125,8 +125,8 @@ in } ]; } ]; }; - description = '' - Kea DHCP4 configuration as an attribute set, see <link xlink:href="https://kea.readthedocs.io/en/kea-${package.version}/arm/dhcp4-srv.html"/>. + description = lib.mdDoc '' + Kea DHCP4 configuration as an attribute set, see <https://kea.readthedocs.io/en/kea-${package.version}/arm/dhcp4-srv.html>. ''; }; }; @@ -134,7 +134,7 @@ in }; dhcp6 = mkOption { - description = '' + description = lib.mdDoc '' DHCP6 Server configuration ''; default = {}; @@ -145,7 +145,7 @@ in extraArgs = mkOption { type = listOf str; default = []; - description = '' + description = lib.mdDoc '' List of additonal arguments to pass to the daemon. ''; }; @@ -186,8 +186,8 @@ in } ]; } ]; }; - description = '' - Kea DHCP6 configuration as an attribute set, see <link xlink:href="https://kea.readthedocs.io/en/kea-${package.version}/arm/dhcp6-srv.html"/>. + description = lib.mdDoc '' + Kea DHCP6 configuration as an attribute set, see <https://kea.readthedocs.io/en/kea-${package.version}/arm/dhcp6-srv.html>. ''; }; }; @@ -195,7 +195,7 @@ in }; dhcp-ddns = mkOption { - description = '' + description = lib.mdDoc '' Kea DHCP-DDNS configuration ''; default = {}; @@ -206,7 +206,7 @@ in extraArgs = mkOption { type = listOf str; default = []; - description = '' + description = lib.mdDoc '' List of additonal arguments to pass to the daemon. ''; }; @@ -239,8 +239,8 @@ in ddns-domains = [ ]; }; }; - description = '' - Kea DHCP-DDNS configuration as an attribute set, see <link xlink:href="https://kea.readthedocs.io/en/kea-${package.version}/arm/ddns.html"/>. + description = lib.mdDoc '' + Kea DHCP-DDNS configuration as an attribute set, see <https://kea.readthedocs.io/en/kea-${package.version}/arm/ddns.html>. ''; }; }; diff --git a/nixos/modules/services/networking/keybase.nix b/nixos/modules/services/networking/keybase.nix index 495102cb7eeee..ae10aebb86e25 100644 --- a/nixos/modules/services/networking/keybase.nix +++ b/nixos/modules/services/networking/keybase.nix @@ -14,7 +14,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to start the Keybase service."; + description = lib.mdDoc "Whether to start the Keybase service."; }; }; diff --git a/nixos/modules/services/networking/knot.nix b/nixos/modules/services/networking/knot.nix index a58a03997b3b8..20f11f0cd5924 100644 --- a/nixos/modules/services/networking/knot.nix +++ b/nixos/modules/services/networking/knot.nix @@ -42,7 +42,7 @@ in { extraArgs = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' List of additional command line paramters for knotd ''; }; @@ -50,7 +50,7 @@ in { keyFiles = mkOption { type = types.listOf types.path; default = []; - description = '' + description = lib.mdDoc '' A list of files containing additional configuration to be included using the include directive. This option allows to include configuration like TSIG keys without @@ -63,7 +63,7 @@ in { extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra lines to be added verbatim to knot.conf ''; }; @@ -72,7 +72,7 @@ in { type = types.package; default = pkgs.knot-dns; defaultText = literalExpression "pkgs.knot-dns"; - description = '' + description = lib.mdDoc '' Which Knot DNS package to use ''; }; diff --git a/nixos/modules/services/networking/kresd.nix b/nixos/modules/services/networking/kresd.nix index 28b8be7a9a0de..623e477ca7a89 100644 --- a/nixos/modules/services/networking/kresd.nix +++ b/nixos/modules/services/networking/kresd.nix @@ -50,10 +50,10 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable knot-resolver domain name server. DNSSEC validation is turned on by default. - You can run <literal>sudo nc -U /run/knot-resolver/control/1</literal> + You can run `sudo nc -U /run/knot-resolver/control/1` and give commands interactively to kresd@1.service. ''; }; @@ -69,7 +69,7 @@ in { extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra lines to be added verbatim to the generated configuration file. ''; }; @@ -77,7 +77,7 @@ in { type = with types; listOf str; default = [ "[::1]:53" "127.0.0.1:53" ]; example = [ "53" ]; - description = '' + description = lib.mdDoc '' What addresses and ports the server should listen on. For detailed syntax see ListenStream in man systemd.socket. ''; @@ -86,7 +86,7 @@ in { type = with types; listOf str; default = []; example = [ "198.51.100.1:853" "[2001:db8::1]:853" "853" ]; - description = '' + description = lib.mdDoc '' Addresses and ports on which kresd should provide DNS over TLS (see RFC 7858). For detailed syntax see ListenStream in man systemd.socket. ''; @@ -95,7 +95,7 @@ in { type = with types; listOf str; default = []; example = [ "198.51.100.1:443" "[2001:db8::1]:443" "443" ]; - description = '' + description = lib.mdDoc '' Addresses and ports on which kresd should provide DNS over HTTPS/2 (see RFC 8484). For detailed syntax see ListenStream in man systemd.socket. ''; @@ -103,7 +103,7 @@ in { instances = mkOption { type = types.ints.unsigned; default = 1; - description = '' + description = lib.mdDoc '' The number of instances to start. They will be called kresd@{1,2,...}.service. Knot Resolver uses no threads, so this is the way to scale. You can dynamically start/stop them at will, so this is just system default. diff --git a/nixos/modules/services/networking/lambdabot.nix b/nixos/modules/services/networking/lambdabot.nix index 3005e58245546..8609bc9719622 100644 --- a/nixos/modules/services/networking/lambdabot.nix +++ b/nixos/modules/services/networking/lambdabot.nix @@ -21,20 +21,20 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable the Lambdabot IRC bot"; + description = lib.mdDoc "Enable the Lambdabot IRC bot"; }; package = mkOption { type = types.package; default = pkgs.lambdabot; defaultText = literalExpression "pkgs.lambdabot"; - description = "Used lambdabot package"; + description = lib.mdDoc "Used lambdabot package"; }; script = mkOption { type = types.str; default = ""; - description = "Lambdabot script"; + description = lib.mdDoc "Lambdabot script"; }; }; diff --git a/nixos/modules/services/networking/libreswan.nix b/nixos/modules/services/networking/libreswan.nix index 429167aed9d7e..08ffcca8a5aca 100644 --- a/nixos/modules/services/networking/libreswan.nix +++ b/nixos/modules/services/networking/libreswan.nix @@ -60,7 +60,7 @@ in protostack=netkey virtual_private=%v4:10.0.0.0/8,%v4:192.168.0.0/16,%v4:172.16.0.0/12,%v4:25.0.0.0/8,%v4:100.64.0.0/10,%v6:fd00::/8,%v6:fe80::/10 ''; - description = "Options to go in the 'config setup' section of the Libreswan IPsec configuration"; + description = lib.mdDoc "Options to go in the 'config setup' section of the Libreswan IPsec configuration"; }; connections = mkOption { @@ -79,7 +79,7 @@ in '''; } ''; - description = "A set of connections to define for the Libreswan IPsec service"; + description = lib.mdDoc "A set of connections to define for the Libreswan IPsec service"; }; policies = mkOption { @@ -105,10 +105,10 @@ in disableRedirects = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to disable send and accept redirects for all nework interfaces. - See the Libreswan <link xlink:href="https://libreswan.org/wiki/FAQ#Why_is_it_recommended_to_disable_send_redirects_in_.2Fproc.2Fsys.2Fnet_.3F"> - FAQ</link> page for why this is recommended. + See the Libreswan [ + FAQ](https://libreswan.org/wiki/FAQ#Why_is_it_recommended_to_disable_send_redirects_in_.2Fproc.2Fsys.2Fnet_.3F) page for why this is recommended. ''; }; diff --git a/nixos/modules/services/networking/lldpd.nix b/nixos/modules/services/networking/lldpd.nix index d5de9c45d84b7..41a3713fcefe6 100644 --- a/nixos/modules/services/networking/lldpd.nix +++ b/nixos/modules/services/networking/lldpd.nix @@ -15,7 +15,7 @@ in type = types.listOf types.str; default = []; example = [ "-c" "-k" "-I eth0" ]; - description = "List of command line parameters for lldpd"; + description = lib.mdDoc "List of command line parameters for lldpd"; }; }; diff --git a/nixos/modules/services/networking/logmein-hamachi.nix b/nixos/modules/services/networking/logmein-hamachi.nix index 11cbdda2f845b..7c00b82e3b348 100644 --- a/nixos/modules/services/networking/logmein-hamachi.nix +++ b/nixos/modules/services/networking/logmein-hamachi.nix @@ -18,7 +18,7 @@ in type = types.bool; default = false; description = - '' + lib.mdDoc '' Whether to enable LogMeIn Hamachi, a proprietary (closed source) commercial VPN software. ''; diff --git a/nixos/modules/services/networking/lokinet.nix b/nixos/modules/services/networking/lokinet.nix index cf091341c8390..6dc33faa82b40 100644 --- a/nixos/modules/services/networking/lokinet.nix +++ b/nixos/modules/services/networking/lokinet.nix @@ -13,14 +13,14 @@ in with lib; { type = types.package; default = pkgs.lokinet; defaultText = literalExpression "pkgs.lokinet"; - description = "Lokinet package to use."; + description = lib.mdDoc "Lokinet package to use."; }; useLocally = mkOption { type = types.bool; default = false; example = true; - description = "Whether to use Lokinet locally."; + description = lib.mdDoc "Whether to use Lokinet locally."; }; settings = mkOption { @@ -33,14 +33,14 @@ in with lib; { bind = mkOption { type = str; default = "127.3.2.1"; - description = "Address to bind to for handling DNS requests."; + description = lib.mdDoc "Address to bind to for handling DNS requests."; }; upstream = mkOption { type = listOf str; default = [ "9.9.9.10" ]; example = [ "1.1.1.1" "8.8.8.8" ]; - description = '' + description = lib.mdDoc '' Upstream resolver(s) to use as fallback for non-loki addresses. Multiple values accepted. ''; @@ -51,7 +51,7 @@ in with lib; { exit = mkOption { type = bool; default = false; - description = '' + description = lib.mdDoc '' Whether to act as an exit node. Beware that this increases demand on the server and may pose liability concerns. Enable at your own risk. @@ -76,7 +76,7 @@ in with lib; { type = nullOr str; default = null; example = "snappkey.private"; - description = '' + description = lib.mdDoc '' The private key to persist address with. If not specified the address will be ephemeral. This keyfile is generated automatically if the specified file doesn't exist. ''; diff --git a/nixos/modules/services/networking/lxd-image-server.nix b/nixos/modules/services/networking/lxd-image-server.nix index d326626eed442..44f93a5c56ec3 100644 --- a/nixos/modules/services/networking/lxd-image-server.nix +++ b/nixos/modules/services/networking/lxd-image-server.nix @@ -15,17 +15,17 @@ in group = mkOption { type = types.str; - description = "Group assigned to the user and the webroot directory."; + description = lib.mdDoc "Group assigned to the user and the webroot directory."; default = "nginx"; example = "www-data"; }; settings = mkOption { type = format.type; - description = '' + description = lib.mdDoc '' Configuration for lxd-image-server. - Example see <link xlink:href="https://github.com/Avature/lxd-image-server/blob/master/config.toml"/>. + Example see <https://github.com/Avature/lxd-image-server/blob/master/config.toml>. ''; default = {}; }; @@ -34,7 +34,7 @@ in enable = mkEnableOption "nginx"; domain = mkOption { type = types.str; - description = "Domain to use for nginx virtual host."; + description = lib.mdDoc "Domain to use for nginx virtual host."; example = "images.example.org"; }; }; diff --git a/nixos/modules/services/networking/matterbridge.nix b/nixos/modules/services/networking/matterbridge.nix index 9186eee26abfc..f75be9b4e37bb 100644 --- a/nixos/modules/services/networking/matterbridge.nix +++ b/nixos/modules/services/networking/matterbridge.nix @@ -23,7 +23,7 @@ in type = with types; nullOr str; default = null; example = "/etc/nixos/matterbridge.toml"; - description = '' + description = lib.mdDoc '' The path to the matterbridge configuration file. ''; }; @@ -62,10 +62,10 @@ in account="mattermost.work" channel="off-topic" ''; - description = '' + description = lib.mdDoc '' WARNING: THIS IS INSECURE, as your password will end up in - <filename>/nix/store</filename>, thus publicly readable. Use - <literal>services.matterbridge.configPath</literal> instead. + {file}`/nix/store`, thus publicly readable. Use + `services.matterbridge.configPath` instead. The matterbridge configuration file in the TOML file format. ''; @@ -73,7 +73,7 @@ in user = mkOption { type = types.str; default = "matterbridge"; - description = '' + description = lib.mdDoc '' User which runs the matterbridge service. ''; }; @@ -81,7 +81,7 @@ in group = mkOption { type = types.str; default = "matterbridge"; - description = '' + description = lib.mdDoc '' Group which runs the matterbridge service. ''; }; diff --git a/nixos/modules/services/networking/minidlna.nix b/nixos/modules/services/networking/minidlna.nix index 57c37718e7cb5..0cac41f58da39 100644 --- a/nixos/modules/services/networking/minidlna.nix +++ b/nixos/modules/services/networking/minidlna.nix @@ -14,25 +14,25 @@ in options.services.minidlna.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable MiniDLNA, a simple DLNA server. It serves media files such as video and music to DLNA client devices such as televisions and media players. If you use the firewall consider - adding the following: <literal>services.minidlna.openFirewall = true;</literal> + adding the following: `services.minidlna.openFirewall = true;` ''; }; options.services.minidlna.openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to open both HTTP (TCP) and SSDP (UDP) ports in the firewall. ''; }; options.services.minidlna.settings = mkOption { default = {}; - description = '' + description = lib.mdDoc '' The contents of MiniDLNA's configuration file. When the service is activated, a basic template is generated from the current options opened here. @@ -44,21 +44,21 @@ in type = types.listOf types.str; default = []; example = [ "/data/media" "V,/home/alice/video" ]; - description = '' + description = lib.mdDoc '' Directories to be scanned for media files. - The prefixes <literal>A,</literal>,<literal>V,</literal> and - <literal>P,</literal> restrict a directory to audio, video + The prefixes `A,`,`V,` and + `P,` restrict a directory to audio, video or image files. The directories must be accessible to the - <literal>minidlna</literal> user account. + `minidlna` user account. ''; }; options.notify_interval = mkOption { type = types.int; default = 90000; - description = '' + description = lib.mdDoc '' The interval between announces (in seconds). Instead of waiting on announces, one can open port UDP 1900 or - set <literal>openFirewall</literal> option to use SSDP discovery. + set `openFirewall` option to use SSDP discovery. Furthermore announce interval has now been set as 90000 in order to prevent disconnects with certain clients and to rely solely on the SSDP method. @@ -76,47 +76,47 @@ in options.port = mkOption { type = types.port; default = 8200; - description = "Port number for HTTP traffic (descriptions, SOAP, media transfer)."; + description = lib.mdDoc "Port number for HTTP traffic (descriptions, SOAP, media transfer)."; }; options.db_dir = mkOption { type = types.path; default = "/var/cache/minidlna"; example = "/tmp/minidlna"; - description = "Specify the directory where you want MiniDLNA to store its database and album art cache."; + description = lib.mdDoc "Specify the directory where you want MiniDLNA to store its database and album art cache."; }; options.friendly_name = mkOption { type = types.str; default = "${config.networking.hostName} MiniDLNA"; defaultText = literalExpression "config.networking.hostName"; example = "rpi3"; - description = "Name that the DLNA server presents to clients."; + description = lib.mdDoc "Name that the DLNA server presents to clients."; }; options.root_container = mkOption { type = types.str; default = "."; example = "B"; - description = "Use a different container as the root of the directory tree presented to clients."; + description = lib.mdDoc "Use a different container as the root of the directory tree presented to clients."; }; options.log_level = mkOption { type = types.str; default = "warn"; example = "general,artwork,database,inotify,scanner,metadata,http,ssdp,tivo=warn"; - description = "Defines the type of messages that should be logged and down to which level of importance."; + description = lib.mdDoc "Defines the type of messages that should be logged and down to which level of importance."; }; options.inotify = mkOption { type = types.enum [ "yes" "no" ]; default = "no"; - description = "Whether to enable inotify monitoring to automatically discover new files."; + description = lib.mdDoc "Whether to enable inotify monitoring to automatically discover new files."; }; options.enable_tivo = mkOption { type = types.enum [ "yes" "no" ]; default = "no"; - description = "Support for streaming .jpg and .mp3 files to a TiVo supporting HMO."; + description = lib.mdDoc "Support for streaming .jpg and .mp3 files to a TiVo supporting HMO."; }; options.wide_links = mkOption { type = types.enum [ "yes" "no" ]; default = "no"; - description = "Set this to yes to allow symlinks that point outside user-defined media_dirs."; + description = lib.mdDoc "Set this to yes to allow symlinks that point outside user-defined media_dirs."; }; }; }; diff --git a/nixos/modules/services/networking/miniupnpd.nix b/nixos/modules/services/networking/miniupnpd.nix index c095d99485461..524270edd1c6b 100644 --- a/nixos/modules/services/networking/miniupnpd.nix +++ b/nixos/modules/services/networking/miniupnpd.nix @@ -23,7 +23,7 @@ in externalInterface = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Name of the external interface. ''; }; @@ -31,7 +31,7 @@ in internalIPs = mkOption { type = types.listOf types.str; example = [ "192.168.1.1/24" "enp1s0" ]; - description = '' + description = lib.mdDoc '' The IP address ranges to listen on. ''; }; @@ -41,7 +41,7 @@ in upnp = mkOption { default = true; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable UPNP support. ''; }; @@ -49,7 +49,7 @@ in appendConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Configuration lines appended to the MiniUPnP config. ''; }; diff --git a/nixos/modules/services/networking/miredo.nix b/nixos/modules/services/networking/miredo.nix index b7f657efb712c..5e42678c32f3d 100644 --- a/nixos/modules/services/networking/miredo.nix +++ b/nixos/modules/services/networking/miredo.nix @@ -26,7 +26,7 @@ in type = types.package; default = pkgs.miredo; defaultText = literalExpression "pkgs.miredo"; - description = '' + description = lib.mdDoc '' The package to use for the miredo daemon's binary. ''; }; @@ -34,7 +34,7 @@ in serverAddress = mkOption { default = "teredo.remlab.net"; type = types.str; - description = '' + description = lib.mdDoc '' The hostname or primary IPv4 address of the Teredo server. This setting is required if Miredo runs as a Teredo client. "teredo.remlab.net" is an experimental service for testing only. @@ -45,7 +45,7 @@ in interfaceName = mkOption { default = "teredo"; type = types.str; - description = '' + description = lib.mdDoc '' Name of the network tunneling interface. ''; }; @@ -53,7 +53,7 @@ in bindAddress = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' Depending on the local firewall/NAT rules, you might need to force Miredo to use a fixed UDP port and or IPv4 address. ''; @@ -62,7 +62,7 @@ in bindPort = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' Depending on the local firewall/NAT rules, you might need to force Miredo to use a fixed UDP port and or IPv4 address. ''; diff --git a/nixos/modules/services/networking/mjpg-streamer.nix b/nixos/modules/services/networking/mjpg-streamer.nix index dbc35e2e71c00..8b490f0248bcc 100644 --- a/nixos/modules/services/networking/mjpg-streamer.nix +++ b/nixos/modules/services/networking/mjpg-streamer.nix @@ -17,7 +17,7 @@ in { inputPlugin = mkOption { type = types.str; default = "input_uvc.so"; - description = '' + description = lib.mdDoc '' Input plugin. See plugins documentation for more information. ''; }; @@ -25,8 +25,8 @@ in { outputPlugin = mkOption { type = types.str; default = "output_http.so -w @www@ -n -p 5050"; - description = '' - Output plugin. <literal>@www@</literal> is substituted for default mjpg-streamer www directory. + description = lib.mdDoc '' + Output plugin. `@www@` is substituted for default mjpg-streamer www directory. See plugins documentation for more information. ''; }; @@ -34,13 +34,13 @@ in { user = mkOption { type = types.str; default = "mjpg-streamer"; - description = "mjpg-streamer user name."; + description = lib.mdDoc "mjpg-streamer user name."; }; group = mkOption { type = types.str; default = "video"; - description = "mjpg-streamer group name."; + description = lib.mdDoc "mjpg-streamer group name."; }; }; diff --git a/nixos/modules/services/networking/monero.nix b/nixos/modules/services/networking/monero.nix index 8bed89917c855..032f6df4e79e8 100644 --- a/nixos/modules/services/networking/monero.nix +++ b/nixos/modules/services/networking/monero.nix @@ -55,7 +55,7 @@ in dataDir = mkOption { type = types.str; default = "/var/lib/monero"; - description = '' + description = lib.mdDoc '' The directory where Monero stores its data files. ''; }; @@ -63,7 +63,7 @@ in mining.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to mine monero. ''; }; @@ -71,7 +71,7 @@ in mining.address = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Monero address where to send mining rewards. ''; }; @@ -79,16 +79,16 @@ in mining.threads = mkOption { type = types.addCheck types.int (x: x>=0); default = 0; - description = '' + description = lib.mdDoc '' Number of threads used for mining. - Set to <literal>0</literal> to use all available. + Set to `0` to use all available. ''; }; rpc.user = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' User name for RPC connections. ''; }; @@ -96,7 +96,7 @@ in rpc.password = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Password for RPC connections. ''; }; @@ -104,7 +104,7 @@ in rpc.address = mkOption { type = types.str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' IP address the RPC server will bind to. ''; }; @@ -112,7 +112,7 @@ in rpc.port = mkOption { type = types.port; default = 18081; - description = '' + description = lib.mdDoc '' Port the RPC server will bind to. ''; }; @@ -120,7 +120,7 @@ in rpc.restricted = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to restrict RPC to view only commands. ''; }; @@ -128,43 +128,43 @@ in limits.upload = mkOption { type = types.addCheck types.int (x: x>=-1); default = -1; - description = '' + description = lib.mdDoc '' Limit of the upload rate in kB/s. - Set to <literal>-1</literal> to leave unlimited. + Set to `-1` to leave unlimited. ''; }; limits.download = mkOption { type = types.addCheck types.int (x: x>=-1); default = -1; - description = '' + description = lib.mdDoc '' Limit of the download rate in kB/s. - Set to <literal>-1</literal> to leave unlimited. + Set to `-1` to leave unlimited. ''; }; limits.threads = mkOption { type = types.addCheck types.int (x: x>=0); default = 0; - description = '' + description = lib.mdDoc '' Maximum number of threads used for a parallel job. - Set to <literal>0</literal> to leave unlimited. + Set to `0` to leave unlimited. ''; }; limits.syncSize = mkOption { type = types.addCheck types.int (x: x>=0); default = 0; - description = '' + description = lib.mdDoc '' Maximum number of blocks to sync at once. - Set to <literal>0</literal> for adaptive. + Set to `0` for adaptive. ''; }; extraNodes = mkOption { type = types.listOf types.str; default = [ ]; - description = '' + description = lib.mdDoc '' List of additional peer IP addresses to add to the local list. ''; }; @@ -172,7 +172,7 @@ in priorityNodes = mkOption { type = types.listOf types.str; default = [ ]; - description = '' + description = lib.mdDoc '' List of peer IP addresses to connect to and attempt to keep the connection open. ''; @@ -190,7 +190,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra lines to be added verbatim to monerod configuration. ''; }; diff --git a/nixos/modules/services/networking/morty.nix b/nixos/modules/services/networking/morty.nix index dff2f482ca6b2..cc5d7998f36bd 100644 --- a/nixos/modules/services/networking/morty.nix +++ b/nixos/modules/services/networking/morty.nix @@ -22,43 +22,43 @@ in ipv6 = mkOption { type = types.bool; default = true; - description = "Allow IPv6 HTTP requests?"; + description = lib.mdDoc "Allow IPv6 HTTP requests?"; }; key = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' HMAC url validation key (hexadecimal encoded). Leave blank to disable. Without validation key, anyone can submit proxy requests. Leave blank to disable. - Generate with <literal>printf %s somevalue | openssl dgst -sha1 -hmac somekey</literal> + Generate with `printf %s somevalue | openssl dgst -sha1 -hmac somekey` ''; }; timeout = mkOption { type = types.int; default = 2; - description = "Request timeout in seconds."; + description = lib.mdDoc "Request timeout in seconds."; }; package = mkOption { type = types.package; default = pkgs.morty; defaultText = literalExpression "pkgs.morty"; - description = "morty package to use."; + description = lib.mdDoc "morty package to use."; }; port = mkOption { type = types.int; default = 3000; - description = "Listing port"; + description = lib.mdDoc "Listing port"; }; listenAddress = mkOption { type = types.str; default = "127.0.0.1"; - description = "The address on which the service listens"; + description = lib.mdDoc "The address on which the service listens"; }; }; diff --git a/nixos/modules/services/networking/mosquitto.nix b/nixos/modules/services/networking/mosquitto.nix index 70c6725d1035c..49f0cc90122b2 100644 --- a/nixos/modules/services/networking/mosquitto.nix +++ b/nixos/modules/services/networking/mosquitto.nix @@ -36,7 +36,7 @@ let password = mkOption { type = uniq (nullOr str); default = null; - description = '' + description = lib.mdDoc '' Specifies the (clear text) password for the MQTT User. ''; }; @@ -45,7 +45,7 @@ let type = uniq (nullOr types.path); example = "/path/to/file"; default = null; - description = '' + description = lib.mdDoc '' Specifies the path to a file containing the clear text password for the MQTT user. ''; @@ -77,7 +77,7 @@ let type = listOf str; example = [ "read A/B" "readwrite A/#" ]; default = []; - description = '' + description = lib.mdDoc '' Control client access to topics on the broker. ''; }; @@ -231,7 +231,7 @@ let options = { port = mkOption { type = port; - description = '' + description = lib.mdDoc '' Port to listen on. Must be set to 0 to listen on a unix domain socket. ''; default = 1883; @@ -259,7 +259,7 @@ let users = mkOption { type = attrsOf userOptions; example = { john = { password = "123456"; acl = [ "readwrite john/#" ]; }; }; - description = '' + description = lib.mdDoc '' A set of users and their passwords and ACLs. ''; default = {}; @@ -267,7 +267,7 @@ let omitPasswordAuth = mkOption { type = bool; - description = '' + description = lib.mdDoc '' Omits password checking, allowing anyone to log in with any user name unless other mandatory authentication methods (eg TLS client certificates) are configured. ''; @@ -276,7 +276,7 @@ let acl = mkOption { type = listOf str; - description = '' + description = lib.mdDoc '' Additional ACL items to prepend to the generated ACL file. ''; example = [ "pattern read #" "topic readwrite anon/report/#" ]; @@ -287,7 +287,7 @@ let type = submodule { freeformType = attrsOf optionType; }; - description = '' + description = lib.mdDoc '' Additional settings for this listener. ''; default = {}; @@ -354,14 +354,14 @@ let options = { address = mkOption { type = str; - description = '' + description = lib.mdDoc '' Address of the remote MQTT broker. ''; }; port = mkOption { type = port; - description = '' + description = lib.mdDoc '' Port of the remote MQTT broker. ''; default = 1883; @@ -369,17 +369,17 @@ let }; }); default = []; - description = '' + description = lib.mdDoc '' Remote endpoints for the bridge. ''; }; topics = mkOption { type = listOf str; - description = '' + description = lib.mdDoc '' Topic patterns to be shared between the two brokers. - Refer to the <link xlink:href="https://mosquitto.org/man/mosquitto-conf-5.html"> - mosquitto.conf documentation</link> for details on the format. + Refer to the [ + mosquitto.conf documentation](https://mosquitto.org/man/mosquitto-conf-5.html) for details on the format. ''; default = []; example = [ "# both 2 local/topic/ remote/topic/" ]; @@ -389,7 +389,7 @@ let type = submodule { freeformType = attrsOf optionType; }; - description = '' + description = lib.mdDoc '' Additional settings for this bridge. ''; default = {}; @@ -449,7 +449,7 @@ let type = package; default = pkgs.mosquitto; defaultText = literalExpression "pkgs.mosquitto"; - description = '' + description = lib.mdDoc '' Mosquitto package to use. ''; }; @@ -457,7 +457,7 @@ let bridges = mkOption { type = attrsOf bridgeOptions; default = {}; - description = '' + description = lib.mdDoc '' Bridges to build to other MQTT brokers. ''; }; @@ -465,7 +465,7 @@ let listeners = mkOption { type = listOf listenerOptions; default = {}; - description = '' + description = lib.mdDoc '' Listeners to configure on this broker. ''; }; @@ -483,7 +483,7 @@ let logDest = mkOption { type = listOf (either path (enum [ "stdout" "stderr" "syslog" "topic" "dlt" ])); - description = '' + description = lib.mdDoc '' Destinations to send log messages to. ''; default = [ "stderr" ]; @@ -492,7 +492,7 @@ let logType = mkOption { type = listOf (enum [ "debug" "error" "warning" "notice" "information" "subscribe" "unsubscribe" "websockets" "none" "all" ]); - description = '' + description = lib.mdDoc '' Types of messages to log. ''; default = []; @@ -500,7 +500,7 @@ let persistence = mkOption { type = bool; - description = '' + description = lib.mdDoc '' Enable persistent storage of subscriptions and messages. ''; default = true; @@ -509,7 +509,7 @@ let dataDir = mkOption { default = "/var/lib/mosquitto"; type = types.path; - description = '' + description = lib.mdDoc '' The data directory. ''; }; @@ -518,7 +518,7 @@ let type = submodule { freeformType = attrsOf optionType; }; - description = '' + description = lib.mdDoc '' Global configuration options for the mosquitto broker. ''; default = {}; diff --git a/nixos/modules/services/networking/mozillavpn.nix b/nixos/modules/services/networking/mozillavpn.nix index e35ba65314e9b..71cbb0470412a 100644 --- a/nixos/modules/services/networking/mozillavpn.nix +++ b/nixos/modules/services/networking/mozillavpn.nix @@ -4,7 +4,7 @@ options.services.mozillavpn.enable = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the Mozilla VPN daemon. ''; }; diff --git a/nixos/modules/services/networking/mstpd.nix b/nixos/modules/services/networking/mstpd.nix index bd71010ce549c..ba82c5ac8232a 100644 --- a/nixos/modules/services/networking/mstpd.nix +++ b/nixos/modules/services/networking/mstpd.nix @@ -9,7 +9,7 @@ with lib; enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable the multiple spanning tree protocol daemon. ''; }; diff --git a/nixos/modules/services/networking/mtprotoproxy.nix b/nixos/modules/services/networking/mtprotoproxy.nix index d896f227b82c8..7ff1cb0b2da37 100644 --- a/nixos/modules/services/networking/mtprotoproxy.nix +++ b/nixos/modules/services/networking/mtprotoproxy.nix @@ -42,7 +42,7 @@ in port = mkOption { type = types.int; default = 3256; - description = '' + description = lib.mdDoc '' TCP port to accept mtproto connections on. ''; }; @@ -53,7 +53,7 @@ in tg = "00000000000000000000000000000000"; tg2 = "0123456789abcdef0123456789abcdef"; }; - description = '' + description = lib.mdDoc '' Allowed users and their secrets. A secret is a 32 characters long hex string. ''; }; @@ -61,7 +61,7 @@ in secureOnly = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Don't allow users to connect in non-secure mode (without random padding). ''; }; @@ -71,7 +71,7 @@ in default = null; # Taken from mtproxyproto's repo. example = "3c09c680b76ee91a4c25ad51f742267d"; - description = '' + description = lib.mdDoc '' Tag for advertising that can be obtained from @MTProxybot. ''; }; @@ -82,7 +82,7 @@ in example = { STATS_PRINT_PERIOD = 600; }; - description = '' + description = lib.mdDoc '' Extra configuration options for mtprotoproxy. ''; }; diff --git a/nixos/modules/services/networking/mtr-exporter.nix b/nixos/modules/services/networking/mtr-exporter.nix index ca261074ebde7..b95af08d3634b 100644 --- a/nixos/modules/services/networking/mtr-exporter.nix +++ b/nixos/modules/services/networking/mtr-exporter.nix @@ -14,32 +14,32 @@ in { target = mkOption { type = types.str; example = "example.org"; - description = "Target to check using MTR."; + description = lib.mdDoc "Target to check using MTR."; }; interval = mkOption { type = types.int; default = 60; - description = "Interval between MTR checks in seconds."; + description = lib.mdDoc "Interval between MTR checks in seconds."; }; port = mkOption { type = types.port; default = 8080; - description = "Listen port for MTR exporter."; + description = lib.mdDoc "Listen port for MTR exporter."; }; address = mkOption { type = types.str; default = "127.0.0.1"; - description = "Listen address for MTR exporter."; + description = lib.mdDoc "Listen address for MTR exporter."; }; mtrFlags = mkOption { type = with types; listOf str; default = []; example = ["-G1"]; - description = "Additional flags to pass to MTR."; + description = lib.mdDoc "Additional flags to pass to MTR."; }; }; }; diff --git a/nixos/modules/services/networking/mullvad-vpn.nix b/nixos/modules/services/networking/mullvad-vpn.nix index 9ec1ddc929e1f..ca60682b4b8b5 100644 --- a/nixos/modules/services/networking/mullvad-vpn.nix +++ b/nixos/modules/services/networking/mullvad-vpn.nix @@ -7,9 +7,9 @@ with lib; options.services.mullvad-vpn.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' This option enables Mullvad VPN daemon. - This sets <option>networking.firewall.checkReversePath</option> to "loose", which might be undesirable for security. + This sets {option}`networking.firewall.checkReversePath` to "loose", which might be undesirable for security. ''; }; diff --git a/nixos/modules/services/networking/multipath.nix b/nixos/modules/services/networking/multipath.nix index 1a44184ff6dcc..3dc6be96e7a7b 100644 --- a/nixos/modules/services/networking/multipath.nix +++ b/nixos/modules/services/networking/multipath.nix @@ -26,7 +26,7 @@ in { package = mkOption { type = package; - description = "multipath-tools package to use"; + description = lib.mdDoc "multipath-tools package to use"; default = pkgs.multipath-tools; defaultText = "pkgs.multipath-tools"; }; @@ -44,7 +44,7 @@ in { }, ... ] ''; - description = '' + description = lib.mdDoc '' This option allows you to define arrays for use in multipath groups. ''; @@ -54,62 +54,62 @@ in { vendor = mkOption { type = str; example = "COMPELNT"; - description = "Regular expression to match the vendor name"; + description = lib.mdDoc "Regular expression to match the vendor name"; }; product = mkOption { type = str; example = "Compellent Vol"; - description = "Regular expression to match the product name"; + description = lib.mdDoc "Regular expression to match the product name"; }; revision = mkOption { type = nullOr str; default = null; - description = "Regular expression to match the product revision"; + description = lib.mdDoc "Regular expression to match the product revision"; }; product_blacklist = mkOption { type = nullOr str; default = null; - description = "Products with the given vendor matching this string are blacklisted"; + description = lib.mdDoc "Products with the given vendor matching this string are blacklisted"; }; alias_prefix = mkOption { type = nullOr str; default = null; - description = "The user_friendly_names prefix to use for this device type, instead of the default mpath"; + description = lib.mdDoc "The user_friendly_names prefix to use for this device type, instead of the default mpath"; }; vpd_vendor = mkOption { type = nullOr str; default = null; - description = "The vendor specific vpd page information, using the vpd page abbreviation"; + description = lib.mdDoc "The vendor specific vpd page information, using the vpd page abbreviation"; }; hardware_handler = mkOption { type = nullOr (enum [ "emc" "rdac" "hp_sw" "alua" "ana" ]); default = null; - description = "The hardware handler to use for this device type"; + description = lib.mdDoc "The hardware handler to use for this device type"; }; # Optional arguments path_grouping_policy = mkOption { type = nullOr (enum [ "failover" "multibus" "group_by_serial" "group_by_prio" "group_by_node_name" ]); default = null; # real default: "failover" - description = "The default path grouping policy to apply to unspecified multipaths"; + description = lib.mdDoc "The default path grouping policy to apply to unspecified multipaths"; }; uid_attribute = mkOption { type = nullOr str; default = null; - description = "The udev attribute providing a unique path identifier (WWID)"; + description = lib.mdDoc "The udev attribute providing a unique path identifier (WWID)"; }; getuid_callout = mkOption { type = nullOr str; default = null; - description = '' + description = lib.mdDoc '' (Superseded by uid_attribute) The default program and args to callout to obtain a unique path identifier. Should be specified with an absolute path. ''; @@ -123,13 +123,13 @@ in { ''"historical-service-time 0"'' ]); default = null; # real default: "service-time 0" - description = "The default path selector algorithm to use; they are offered by the kernel multipath target"; + description = lib.mdDoc "The default path selector algorithm to use; they are offered by the kernel multipath target"; }; path_checker = mkOption { type = enum [ "readsector0" "tur" "emc_clariion" "hp_sw" "rdac" "directio" "cciss_tur" "none" ]; default = "tur"; - description = "The default method used to determine the paths state"; + description = lib.mdDoc "The default method used to determine the paths state"; }; prio = mkOption { @@ -138,31 +138,31 @@ in { "random" "weightedpath" "path_latency" "ana" "datacore" "iet" ]); default = null; # real default: "const" - description = "The name of the path priority routine"; + description = lib.mdDoc "The name of the path priority routine"; }; prio_args = mkOption { type = nullOr str; default = null; - description = "Arguments to pass to to the prio function"; + description = lib.mdDoc "Arguments to pass to to the prio function"; }; features = mkOption { type = nullOr str; default = null; - description = "Specify any device-mapper features to be used"; + description = lib.mdDoc "Specify any device-mapper features to be used"; }; failback = mkOption { type = nullOr str; default = null; # real default: "manual" - description = "Tell multipathd how to manage path group failback. Quote integers as strings"; + description = lib.mdDoc "Tell multipathd how to manage path group failback. Quote integers as strings"; }; rr_weight = mkOption { type = nullOr (enum [ "priorities" "uniform" ]); default = null; # real default: "uniform" - description = '' + description = lib.mdDoc '' If set to priorities the multipath configurator will assign path weights as "path prio * rr_min_io". ''; @@ -171,13 +171,13 @@ in { no_path_retry = mkOption { type = nullOr str; default = null; # real default: "fail" - description = "Specify what to do when all paths are down. Quote integers as strings"; + description = lib.mdDoc "Specify what to do when all paths are down. Quote integers as strings"; }; rr_min_io = mkOption { type = nullOr int; default = null; # real default: 1000 - description = '' + description = lib.mdDoc '' Number of I/O requests to route to a path before switching to the next in the same path group. This is only for Block I/O (BIO) based multipath and only apply to round-robin path_selector. @@ -187,7 +187,7 @@ in { rr_min_io_rq = mkOption { type = nullOr int; default = null; # real default: 1 - description = '' + description = lib.mdDoc '' Number of I/O requests to route to a path before switching to the next in the same path group. This is only for Request based multipath and only apply to round-robin path_selector. @@ -197,7 +197,7 @@ in { fast_io_fail_tmo = mkOption { type = nullOr str; default = null; # real default: 5 - description = '' + description = lib.mdDoc '' Specify the number of seconds the SCSI layer will wait after a problem has been detected on a FC remote port before failing I/O to devices on that remote port. This should be smaller than dev_loss_tmo. Setting this to "off" will disable @@ -208,7 +208,7 @@ in { dev_loss_tmo = mkOption { type = nullOr str; default = null; # real default: 600 - description = '' + description = lib.mdDoc '' Specify the number of seconds the SCSI layer will wait after a problem has been detected on a FC remote port before removing it from the system. This can be set to "infinity" which sets it to the max value of 2147483647 @@ -224,7 +224,7 @@ in { flush_on_last_del = mkOption { type = nullOr (enum [ "yes" "no" ]); default = null; # real default: "no" - description = '' + description = lib.mdDoc '' If set to "yes" multipathd will disable queueing when the last path to a device has been deleted. ''; @@ -233,7 +233,7 @@ in { user_friendly_names = mkOption { type = nullOr (enum [ "yes" "no" ]); default = null; # real default: "no" - description = '' + description = lib.mdDoc '' If set to "yes", using the bindings file /etc/multipath/bindings to assign a persistent and unique alias to the multipath, in the form of mpath. If set to "no" use the WWID as the alias. In either @@ -245,7 +245,7 @@ in { detect_prio = mkOption { type = nullOr (enum [ "yes" "no" ]); default = null; # real default: "yes" - description = '' + description = lib.mdDoc '' If set to "yes", multipath will try to detect if the device supports SCSI-3 ALUA. If so, the device will automatically use the sysfs prioritizer if the required sysf attributes access_state and @@ -257,7 +257,7 @@ in { detect_checker = mkOption { type = nullOr (enum [ "yes" "no" ]); default = null; # real default: "yes" - description = '' + description = lib.mdDoc '' If set to "yes", multipath will try to detect if the device supports SCSI-3 ALUA. If so, the device will automatically use the tur checker. If set to "no", the checker will be selected as usual. @@ -267,7 +267,7 @@ in { deferred_remove = mkOption { type = nullOr (enum [ "yes" "no" ]); default = null; # real default: "no" - description = '' + description = lib.mdDoc '' If set to "yes", multipathd will do a deferred remove instead of a regular remove when the last path device has been deleted. This means that if the multipath device is still in use, it will be freed when @@ -279,7 +279,7 @@ in { san_path_err_threshold = mkOption { type = nullOr str; default = null; - description = '' + description = lib.mdDoc '' If set to a value greater than 0, multipathd will watch paths and check how many times a path has been failed due to errors.If the number of failures on a particular path is greater then the san_path_err_threshold, @@ -292,7 +292,7 @@ in { san_path_err_forget_rate = mkOption { type = nullOr str; default = null; - description = '' + description = lib.mdDoc '' If set to a value greater than 0, multipathd will check whether the path failures has exceeded the san_path_err_threshold within this many checks i.e san_path_err_forget_rate. If so we will not reinstante the path till @@ -303,7 +303,7 @@ in { san_path_err_recovery_time = mkOption { type = nullOr str; default = null; - description = '' + description = lib.mdDoc '' If set to a value greater than 0, multipathd will make sure that when path failures has exceeded the san_path_err_threshold within san_path_err_forget_rate then the path will be placed in failed state @@ -316,61 +316,61 @@ in { marginal_path_err_sample_time = mkOption { type = nullOr int; default = null; - description = "One of the four parameters of supporting path check based on accounting IO error such as intermittent error"; + description = lib.mdDoc "One of the four parameters of supporting path check based on accounting IO error such as intermittent error"; }; marginal_path_err_rate_threshold = mkOption { type = nullOr int; default = null; - description = "The error rate threshold as a permillage (1/1000)"; + description = lib.mdDoc "The error rate threshold as a permillage (1/1000)"; }; marginal_path_err_recheck_gap_time = mkOption { type = nullOr str; default = null; - description = "One of the four parameters of supporting path check based on accounting IO error such as intermittent error"; + description = lib.mdDoc "One of the four parameters of supporting path check based on accounting IO error such as intermittent error"; }; marginal_path_double_failed_time = mkOption { type = nullOr str; default = null; - description = "One of the four parameters of supporting path check based on accounting IO error such as intermittent error"; + description = lib.mdDoc "One of the four parameters of supporting path check based on accounting IO error such as intermittent error"; }; delay_watch_checks = mkOption { type = nullOr str; default = null; - description = "This option is deprecated, and mapped to san_path_err_forget_rate"; + description = lib.mdDoc "This option is deprecated, and mapped to san_path_err_forget_rate"; }; delay_wait_checks = mkOption { type = nullOr str; default = null; - description = "This option is deprecated, and mapped to san_path_err_recovery_time"; + description = lib.mdDoc "This option is deprecated, and mapped to san_path_err_recovery_time"; }; skip_kpartx = mkOption { type = nullOr (enum [ "yes" "no" ]); default = null; # real default: "no" - description = "If set to yes, kpartx will not automatically create partitions on the device"; + description = lib.mdDoc "If set to yes, kpartx will not automatically create partitions on the device"; }; max_sectors_kb = mkOption { type = nullOr int; default = null; - description = "Sets the max_sectors_kb device parameter on all path devices and the multipath device to the specified value"; + description = lib.mdDoc "Sets the max_sectors_kb device parameter on all path devices and the multipath device to the specified value"; }; ghost_delay = mkOption { type = nullOr int; default = null; - description = "Sets the number of seconds that multipath will wait after creating a device with only ghost paths before marking it ready for use in systemd"; + description = lib.mdDoc "Sets the number of seconds that multipath will wait after creating a device with only ghost paths before marking it ready for use in systemd"; }; all_tg_pt = mkOption { type = nullOr str; default = null; - description = "Set the 'all targets ports' flag when registering keys with mpathpersist"; + description = lib.mdDoc "Set the 'all targets ports' flag when registering keys with mpathpersist"; }; }; @@ -380,7 +380,7 @@ in { defaults = mkOption { type = nullOr str; default = null; - description = '' + description = lib.mdDoc '' This section defines default values for attributes which are used whenever no values are given in the appropriate device or multipath sections. @@ -390,7 +390,7 @@ in { blacklist = mkOption { type = nullOr str; default = null; - description = '' + description = lib.mdDoc '' This section defines which devices should be excluded from the multipath topology discovery. ''; @@ -399,7 +399,7 @@ in { blacklist_exceptions = mkOption { type = nullOr str; default = null; - description = '' + description = lib.mdDoc '' This section defines which devices should be included in the multipath topology discovery, despite being listed in the blacklist section. @@ -409,7 +409,7 @@ in { overrides = mkOption { type = nullOr str; default = null; - description = '' + description = lib.mdDoc '' This section defines values for attributes that should override the device-specific settings for all devices. ''; @@ -418,13 +418,13 @@ in { extraConfig = mkOption { type = nullOr str; default = null; - description = "Lines to append to default multipath.conf"; + description = lib.mdDoc "Lines to append to default multipath.conf"; }; extraConfigFile = mkOption { type = nullOr str; default = null; - description = "Append an additional file's contents to /etc/multipath.conf"; + description = lib.mdDoc "Append an additional file's contents to /etc/multipath.conf"; }; pathGroups = mkOption { @@ -439,7 +439,7 @@ in { }, ... ] ''; - description = '' + description = lib.mdDoc '' This option allows you to define multipath groups as described in http://christophe.varoqui.free.fr/usage.html. ''; @@ -449,34 +449,34 @@ in { alias = mkOption { type = int; example = 1001234; - description = "The name of the multipath device"; + description = lib.mdDoc "The name of the multipath device"; }; wwid = mkOption { type = hexStr; example = "360080e500043b35c0123456789abcdef"; - description = "The identifier for the multipath device"; + description = lib.mdDoc "The identifier for the multipath device"; }; array = mkOption { type = str; default = null; example = "bigarray.example.com"; - description = "The DNS name of the storage array"; + description = lib.mdDoc "The DNS name of the storage array"; }; fsType = mkOption { type = nullOr str; default = null; example = "zfs"; - description = "Type of the filesystem"; + description = lib.mdDoc "Type of the filesystem"; }; options = mkOption { type = nullOr str; default = null; example = "ro"; - description = "Options used to mount the file system"; + description = lib.mdDoc "Options used to mount the file system"; }; }; diff --git a/nixos/modules/services/networking/murmur.nix b/nixos/modules/services/networking/murmur.nix index 84b9936aa6235..3bff9faa6a369 100644 --- a/nixos/modules/services/networking/murmur.nix +++ b/nixos/modules/services/networking/murmur.nix @@ -56,13 +56,13 @@ in enable = mkOption { type = types.bool; default = false; - description = "If enabled, start the Murmur Mumble server."; + description = lib.mdDoc "If enabled, start the Murmur Mumble server."; }; openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for the Murmur Mumble server. ''; }; @@ -70,17 +70,17 @@ in autobanAttempts = mkOption { type = types.int; default = 10; - description = '' + description = lib.mdDoc '' Number of attempts a client is allowed to make in - <literal>autobanTimeframe</literal> seconds, before being - banned for <literal>autobanTime</literal>. + `autobanTimeframe` seconds, before being + banned for `autobanTime`. ''; }; autobanTimeframe = mkOption { type = types.int; default = 120; - description = '' + description = lib.mdDoc '' Timeframe in which a client can connect without being banned for repeated attempts (in seconds). ''; @@ -89,51 +89,51 @@ in autobanTime = mkOption { type = types.int; default = 300; - description = "The amount of time an IP ban lasts (in seconds)."; + description = lib.mdDoc "The amount of time an IP ban lasts (in seconds)."; }; logFile = mkOption { type = types.nullOr types.path; default = null; example = "/var/log/murmur/murmurd.log"; - description = "Path to the log file for Murmur daemon. Empty means log to journald."; + description = lib.mdDoc "Path to the log file for Murmur daemon. Empty means log to journald."; }; welcometext = mkOption { type = types.str; default = ""; - description = "Welcome message for connected clients."; + description = lib.mdDoc "Welcome message for connected clients."; }; port = mkOption { type = types.port; default = 64738; - description = "Ports to bind to (UDP and TCP)."; + description = lib.mdDoc "Ports to bind to (UDP and TCP)."; }; hostName = mkOption { type = types.str; default = ""; - description = "Host to bind to. Defaults binding on all addresses."; + description = lib.mdDoc "Host to bind to. Defaults binding on all addresses."; }; package = mkOption { type = types.package; default = pkgs.murmur; defaultText = literalExpression "pkgs.murmur"; - description = "Overridable attribute of the murmur package to use."; + description = lib.mdDoc "Overridable attribute of the murmur package to use."; }; password = mkOption { type = types.str; default = ""; - description = "Required password to join server, if specified."; + description = lib.mdDoc "Required password to join server, if specified."; }; bandwidth = mkOption { type = types.int; default = 72000; - description = '' + description = lib.mdDoc '' Maximum bandwidth (in bits per second) that clients may send speech at. ''; @@ -142,25 +142,25 @@ in users = mkOption { type = types.int; default = 100; - description = "Maximum number of concurrent clients allowed."; + description = lib.mdDoc "Maximum number of concurrent clients allowed."; }; textMsgLength = mkOption { type = types.int; default = 5000; - description = "Max length of text messages. Set 0 for no limit."; + description = lib.mdDoc "Max length of text messages. Set 0 for no limit."; }; imgMsgLength = mkOption { type = types.int; default = 131072; - description = "Max length of image messages. Set 0 for no limit."; + description = lib.mdDoc "Max length of image messages. Set 0 for no limit."; }; allowHtml = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Allow HTML in client messages, comments, and channel descriptions. ''; @@ -169,7 +169,7 @@ in logDays = mkOption { type = types.int; default = 31; - description = '' + description = lib.mdDoc '' How long to store RPC logs for in the database. Set 0 to keep logs forever, or -1 to disable DB logging. ''; @@ -178,7 +178,7 @@ in bonjour = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable Bonjour auto-discovery, which allows clients over your LAN to automatically discover Murmur servers. ''; @@ -187,13 +187,13 @@ in sendVersion = mkOption { type = types.bool; default = true; - description = "Send Murmur version in UDP response."; + description = lib.mdDoc "Send Murmur version in UDP response."; }; registerName = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Public server registration name, and also the name of the Root channel. Even if you don't publicly register your server, you probably still want to set this. @@ -203,7 +203,7 @@ in registerPassword = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Public server registry password, used authenticate your server to the registry to prevent impersonation; required for subsequent registry updates. @@ -213,7 +213,7 @@ in registerUrl = mkOption { type = types.str; default = ""; - description = "URL website for your server."; + description = lib.mdDoc "URL website for your server."; }; registerHostname = mkOption { @@ -230,31 +230,31 @@ in clientCertRequired = mkOption { type = types.bool; default = false; - description = "Require clients to authenticate via certificates."; + description = lib.mdDoc "Require clients to authenticate via certificates."; }; sslCert = mkOption { type = types.str; default = ""; - description = "Path to your SSL certificate."; + description = lib.mdDoc "Path to your SSL certificate."; }; sslKey = mkOption { type = types.str; default = ""; - description = "Path to your SSL key."; + description = lib.mdDoc "Path to your SSL key."; }; sslCa = mkOption { type = types.str; default = ""; - description = "Path to your SSL CA certificate."; + description = lib.mdDoc "Path to your SSL CA certificate."; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Extra configuration to put into murmur.ini."; + description = lib.mdDoc "Extra configuration to put into murmur.ini."; }; environmentFile = mkOption { diff --git a/nixos/modules/services/networking/mxisd.nix b/nixos/modules/services/networking/mxisd.nix index 1509671bc54ae..9ddc2094b6dff 100644 --- a/nixos/modules/services/networking/mxisd.nix +++ b/nixos/modules/services/networking/mxisd.nix @@ -43,7 +43,7 @@ in { type = types.package; default = pkgs.ma1sd; defaultText = literalExpression "pkgs.ma1sd"; - description = "The mxisd/ma1sd package to use"; + description = lib.mdDoc "The mxisd/ma1sd package to use"; }; environmentFile = mkOption { @@ -58,20 +58,20 @@ in { dataDir = mkOption { type = types.str; default = "/var/lib/mxisd"; - description = "Where data mxisd/ma1sd uses resides"; + description = lib.mdDoc "Where data mxisd/ma1sd uses resides"; }; extraConfig = mkOption { type = types.attrs; default = {}; - description = "Extra options merged into the mxisd/ma1sd configuration"; + description = lib.mdDoc "Extra options merged into the mxisd/ma1sd configuration"; }; matrix = { domain = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' the domain of the matrix homeserver ''; }; @@ -83,7 +83,7 @@ in { name = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Public hostname of mxisd/ma1sd, if different from the Matrix domain. ''; }; @@ -91,7 +91,7 @@ in { port = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' HTTP port to listen on (unencrypted) ''; }; diff --git a/nixos/modules/services/networking/namecoind.nix b/nixos/modules/services/networking/namecoind.nix index 8f7a5123f7e18..45a90741465a3 100644 --- a/nixos/modules/services/networking/namecoind.nix +++ b/nixos/modules/services/networking/namecoind.nix @@ -49,7 +49,7 @@ in wallet = mkOption { type = types.path; default = "${dataDir}/wallet.dat"; - description = '' + description = lib.mdDoc '' Wallet file. The ownership of the file has to be namecoin:namecoin, and the permissions must be 0640. ''; @@ -58,7 +58,7 @@ in generate = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to generate (mine) Namecoins. ''; }; @@ -66,7 +66,7 @@ in extraNodes = mkOption { type = types.listOf types.str; default = [ ]; - description = '' + description = lib.mdDoc '' List of additional peer IP addresses to connect to. ''; }; @@ -74,7 +74,7 @@ in trustedNodes = mkOption { type = types.listOf types.str; default = [ ]; - description = '' + description = lib.mdDoc '' List of the only peer IP addresses to connect to. If specified no other connection will be made. ''; @@ -83,7 +83,7 @@ in rpc.user = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' User name for RPC connections. ''; }; @@ -91,7 +91,7 @@ in rpc.password = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Password for RPC connections. ''; }; @@ -99,7 +99,7 @@ in rpc.address = mkOption { type = types.str; default = "0.0.0.0"; - description = '' + description = lib.mdDoc '' IP address the RPC server will bind to. ''; }; @@ -107,7 +107,7 @@ in rpc.port = mkOption { type = types.port; default = 8332; - description = '' + description = lib.mdDoc '' Port the RPC server will bind to. ''; }; @@ -116,7 +116,7 @@ in type = types.nullOr types.path; default = null; example = "/var/lib/namecoind/server.cert"; - description = '' + description = lib.mdDoc '' Certificate file for securing RPC connections. ''; }; @@ -125,7 +125,7 @@ in type = types.nullOr types.path; default = null; example = "/var/lib/namecoind/server.pem"; - description = '' + description = lib.mdDoc '' Key file for securing RPC connections. ''; }; @@ -134,7 +134,7 @@ in rpc.allowFrom = mkOption { type = types.listOf types.str; default = [ "127.0.0.1" ]; - description = '' + description = lib.mdDoc '' List of IP address ranges allowed to use the RPC API. Wiledcards (*) can be user to specify a range. ''; diff --git a/nixos/modules/services/networking/nar-serve.nix b/nixos/modules/services/networking/nar-serve.nix index 745138186a207..09f019d41bb73 100644 --- a/nixos/modules/services/networking/nar-serve.nix +++ b/nixos/modules/services/networking/nar-serve.nix @@ -15,7 +15,7 @@ in port = mkOption { type = types.port; default = 8383; - description = '' + description = lib.mdDoc '' Port number where nar-serve will listen on. ''; }; diff --git a/nixos/modules/services/networking/nat.nix b/nixos/modules/services/networking/nat.nix index 2e58cd699b256..0eb9b158e6869 100644 --- a/nixos/modules/services/networking/nat.nix +++ b/nixos/modules/services/networking/nat.nix @@ -136,7 +136,7 @@ in type = types.bool; default = false; description = - '' + lib.mdDoc '' Whether to enable Network Address Translation (NAT). ''; }; @@ -145,7 +145,7 @@ in type = types.bool; default = false; description = - '' + lib.mdDoc '' Whether to enable IPv6 NAT. ''; }; @@ -155,7 +155,7 @@ in default = []; example = [ "eth0" ]; description = - '' + lib.mdDoc '' The interfaces for which to perform NAT. Packets coming from these interface and destined for the external interface will be rewritten. @@ -167,7 +167,7 @@ in default = []; example = [ "192.168.1.0/24" ]; description = - '' + lib.mdDoc '' The IP address ranges for which to perform NAT. Packets coming from these addresses (on any interface) and destined for the external interface will be rewritten. @@ -179,7 +179,7 @@ in default = []; example = [ "fc00::/64" ]; description = - '' + lib.mdDoc '' The IPv6 address ranges for which to perform NAT. Packets coming from these addresses (on any interface) and destined for the external interface will be rewritten. @@ -191,7 +191,7 @@ in default = null; example = "eth1"; description = - '' + lib.mdDoc '' The name of the external network interface. ''; }; @@ -201,7 +201,7 @@ in default = null; example = "203.0.113.123"; description = - '' + lib.mdDoc '' The public IP address to which packets from the local network are to be rewritten. If this is left empty, the IP address associated with the external interface will be @@ -214,7 +214,7 @@ in default = null; example = "2001:dc0:2001:11::175"; description = - '' + lib.mdDoc '' The public IPv6 address to which packets from the local network are to be rewritten. If this is left empty, the IP address associated with the external interface will be @@ -228,27 +228,27 @@ in sourcePort = mkOption { type = types.either types.int (types.strMatching "[[:digit:]]+:[[:digit:]]+"); example = 8080; - description = "Source port of the external interface; to specify a port range, use a string with a colon (e.g. \"60000:61000\")"; + description = lib.mdDoc "Source port of the external interface; to specify a port range, use a string with a colon (e.g. \"60000:61000\")"; }; destination = mkOption { type = types.str; example = "10.0.0.1:80"; - description = "Forward connection to destination ip:port (or [ipv6]:port); to specify a port range, use ip:start-end"; + description = lib.mdDoc "Forward connection to destination ip:port (or [ipv6]:port); to specify a port range, use ip:start-end"; }; proto = mkOption { type = types.str; default = "tcp"; example = "udp"; - description = "Protocol of forwarded connection"; + description = lib.mdDoc "Protocol of forwarded connection"; }; loopbackIPs = mkOption { type = types.listOf types.str; default = []; example = literalExpression ''[ "55.1.2.3" ]''; - description = "Public IPs for NAT reflection; for connections to `loopbackip:sourcePort' from the host itself and from other hosts behind NAT"; + description = lib.mdDoc "Public IPs for NAT reflection; for connections to `loopbackip:sourcePort' from the host itself and from other hosts behind NAT"; }; }; }); @@ -258,7 +258,7 @@ in { sourcePort = 8080; destination = "[fc00::2]:80"; proto = "tcp"; } ]; description = - '' + lib.mdDoc '' List of forwarded ports from the external interface to internal destinations by using DNAT. Destination can be IPv6 if IPv6 NAT is enabled. @@ -270,7 +270,7 @@ in default = null; example = "10.0.0.1"; description = - '' + lib.mdDoc '' The local IP address to which all traffic that does not match any forwarding rule is forwarded. ''; @@ -281,7 +281,7 @@ in default = ""; example = "iptables -A INPUT -p icmp -j ACCEPT"; description = - '' + lib.mdDoc '' Additional shell commands executed as part of the nat initialisation script. ''; @@ -292,7 +292,7 @@ in default = ""; example = "iptables -D INPUT -p icmp -j ACCEPT || true"; description = - '' + lib.mdDoc '' Additional shell commands executed as part of the nat teardown script. ''; diff --git a/nixos/modules/services/networking/nats.nix b/nixos/modules/services/networking/nats.nix index 3e86a4f07bc70..41e38add69fe4 100644 --- a/nixos/modules/services/networking/nats.nix +++ b/nixos/modules/services/networking/nats.nix @@ -21,20 +21,20 @@ in { user = mkOption { type = types.str; default = "nats"; - description = "User account under which NATS runs."; + description = lib.mdDoc "User account under which NATS runs."; }; group = mkOption { type = types.str; default = "nats"; - description = "Group under which NATS runs."; + description = lib.mdDoc "Group under which NATS runs."; }; serverName = mkOption { default = "nats"; example = "n1-c3"; type = types.str; - description = '' + description = lib.mdDoc '' Name of the NATS server, must be unique if clustered. ''; }; @@ -44,7 +44,7 @@ in { port = mkOption { default = 4222; type = types.port; - description = '' + description = lib.mdDoc '' Port on which to listen. ''; }; @@ -52,7 +52,7 @@ in { dataDir = mkOption { default = "/var/lib/nats"; type = types.path; - description = '' + description = lib.mdDoc '' The NATS data directory. Only used if JetStream is enabled, for storing stream metadata and messages. @@ -74,10 +74,10 @@ in { }; }; ''; - description = '' + description = lib.mdDoc '' Declarative NATS configuration. See the - <link xlink:href="https://docs.nats.io/nats-server/configuration"> - NATS documentation</link> for a list of options. + [ + NATS documentation](https://docs.nats.io/nats-server/configuration) for a list of options. ''; }; }; diff --git a/nixos/modules/services/networking/nbd.nix b/nixos/modules/services/networking/nbd.nix index df3358f51876a..3a813d10257d9 100644 --- a/nixos/modules/services/networking/nbd.nix +++ b/nixos/modules/services/networking/nbd.nix @@ -48,7 +48,7 @@ in listenPort = mkOption { type = types.port; default = 10809; - description = "Port to listen on. The port is NOT automatically opened in the firewall."; + description = lib.mdDoc "Port to listen on. The port is NOT automatically opened in the firewall."; }; extraOptions = mkOption { @@ -64,14 +64,14 @@ in }; exports = mkOption { - description = "Files or block devices to make available over the network."; + description = lib.mdDoc "Files or block devices to make available over the network."; default = { }; type = with types; attrsOf (submodule { options = { path = mkOption { type = str; - description = "File or block device to export."; + description = lib.mdDoc "File or block device to export."; example = "/dev/sdb1"; }; @@ -79,7 +79,7 @@ in type = nullOr (listOf str); default = null; example = [ "10.10.0.0/24" "127.0.0.1" ]; - description = "IPs and subnets that are authorized to connect for this device. If not specified, the server will allow all connections."; + description = lib.mdDoc "IPs and subnets that are authorized to connect for this device. If not specified, the server will allow all connections."; }; extraOptions = mkOption { @@ -100,7 +100,7 @@ in listenAddress = mkOption { type = with types; nullOr str; - description = "Address to listen on. If not specified, the server will listen on all interfaces."; + description = lib.mdDoc "Address to listen on. If not specified, the server will listen on all interfaces."; default = null; example = "10.10.0.1"; }; diff --git a/nixos/modules/services/networking/ncdns.nix b/nixos/modules/services/networking/ncdns.nix index c8d1b6718e2e2..8ee787b7d797c 100644 --- a/nixos/modules/services/networking/ncdns.nix +++ b/nixos/modules/services/networking/ncdns.nix @@ -59,7 +59,7 @@ in address = mkOption { type = types.str; default = "[::1]"; - description = '' + description = lib.mdDoc '' The IP address the ncdns resolver will bind to. Leave this unchanged if you do not wish to directly expose the resolver. ''; @@ -68,7 +68,7 @@ in port = mkOption { type = types.port; default = 5333; - description = '' + description = lib.mdDoc '' The port the ncdns resolver will bind to. ''; }; @@ -96,7 +96,7 @@ in type = types.str; default = ""; example = "root@example.com"; - description = '' + description = lib.mdDoc '' An email address for the SOA record at the bit zone. If you are only using ncdns locally you can ignore this. ''; @@ -105,9 +105,9 @@ in identity.address = mkOption { type = types.str; default = "127.127.127.127"; - description = '' + description = lib.mdDoc '' The IP address the hostname specified in - <option>services.ncdns.identity.hostname</option> should resolve to. + {option}`services.ncdns.identity.hostname` should resolve to. If you are only using ncdns locally you can ignore this. ''; }; @@ -136,7 +136,7 @@ in dnssec.keys.private = mkOption { type = types.path; default = defaultFiles.private; - description = '' + description = lib.mdDoc '' Path to the file containing the KSK private key. ''; }; @@ -157,7 +157,7 @@ in dnssec.keys.zonePrivate = mkOption { type = types.path; default = defaultFiles.zonePrivate; - description = '' + description = lib.mdDoc '' Path to the file containing the ZSK private key. ''; }; @@ -189,8 +189,8 @@ in services.pdns-recursor.resolveNamecoin = mkOption { type = types.bool; default = false; - description = '' - Resolve <literal>.bit</literal> top-level domains using ncdns and namecoin. + description = lib.mdDoc '' + Resolve `.bit` top-level domains using ncdns and namecoin. ''; }; diff --git a/nixos/modules/services/networking/ndppd.nix b/nixos/modules/services/networking/ndppd.nix index 6046ac860cfae..ed97fe233b8a0 100644 --- a/nixos/modules/services/networking/ndppd.nix +++ b/nixos/modules/services/networking/ndppd.nix @@ -26,7 +26,7 @@ let options = { interface = mkOption { type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' Listen for any Neighbor Solicitation messages on this interface, and respond to them according to a set of rules. Defaults to the name of the attrset. @@ -35,14 +35,14 @@ let }; router = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Turns on or off the router flag for Neighbor Advertisement Messages. ''; default = true; }; timeout = mkOption { type = types.int; - description = '' + description = lib.mdDoc '' Controls how long to wait for a Neighbor Advertisment Message before invalidating the entry, in milliseconds. ''; @@ -50,7 +50,7 @@ let }; ttl = mkOption { type = types.int; - description = '' + description = lib.mdDoc '' Controls how long a valid or invalid entry remains in the cache, in milliseconds. ''; @@ -58,7 +58,7 @@ let }; rules = mkOption { type = types.attrsOf rule; - description = '' + description = lib.mdDoc '' This is a rule that the target address is to match against. If no netmask is provided, /128 is assumed. You may have several rule sections, and the addresses may or may not overlap. @@ -72,7 +72,7 @@ let options = { network = mkOption { type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' This is the target address is to match against. If no netmask is provided, /128 is assumed. The addresses of serveral rules may or may not overlap. @@ -82,7 +82,7 @@ let }; method = mkOption { type = types.enum [ "static" "iface" "auto" ]; - description = '' + description = lib.mdDoc '' static: Immediately answer any Neighbor Solicitation Messages (if they match the IP rule). iface: Forward the Neighbor Solicitation Message through the specified @@ -95,7 +95,7 @@ let }; interface = mkOption { type = types.nullOr types.str; - description = "Interface to use when method is iface."; + description = lib.mdDoc "Interface to use when method is iface."; default = null; }; }; @@ -124,12 +124,12 @@ in { }; configFile = mkOption { type = types.nullOr types.path; - description = "Path to configuration file."; + description = lib.mdDoc "Path to configuration file."; default = null; }; routeTTL = mkOption { type = types.int; - description = '' + description = lib.mdDoc '' This tells 'ndppd' how often to reload the route file /proc/net/ipv6_route, in milliseconds. ''; @@ -137,7 +137,7 @@ in { }; proxies = mkOption { type = types.attrsOf proxy; - description = '' + description = lib.mdDoc '' This sets up a listener, that will listen for any Neighbor Solicitation messages, and respond to them according to a set of rules. ''; diff --git a/nixos/modules/services/networking/nebula.nix b/nixos/modules/services/networking/nebula.nix index c83cd9d521c6d..2bedafc5d9fe8 100644 --- a/nixos/modules/services/networking/nebula.nix +++ b/nixos/modules/services/networking/nebula.nix @@ -17,45 +17,45 @@ in options = { services.nebula = { networks = mkOption { - description = "Nebula network definitions."; + description = lib.mdDoc "Nebula network definitions."; default = {}; type = types.attrsOf (types.submodule { options = { enable = mkOption { type = types.bool; default = true; - description = "Enable or disable this network."; + description = lib.mdDoc "Enable or disable this network."; }; package = mkOption { type = types.package; default = pkgs.nebula; defaultText = literalExpression "pkgs.nebula"; - description = "Nebula derivation to use."; + description = lib.mdDoc "Nebula derivation to use."; }; ca = mkOption { type = types.path; - description = "Path to the certificate authority certificate."; + description = lib.mdDoc "Path to the certificate authority certificate."; example = "/etc/nebula/ca.crt"; }; cert = mkOption { type = types.path; - description = "Path to the host certificate."; + description = lib.mdDoc "Path to the host certificate."; example = "/etc/nebula/host.crt"; }; key = mkOption { type = types.path; - description = "Path to the host key."; + description = lib.mdDoc "Path to the host key."; example = "/etc/nebula/host.key"; }; staticHostMap = mkOption { type = types.attrsOf (types.listOf (types.str)); default = {}; - description = '' + description = lib.mdDoc '' The static host map defines a set of hosts with fixed IP addresses on the internet (or any network). A host can have multiple fixed IP addresses defined here, and nebula will try each when establishing a tunnel. ''; @@ -65,13 +65,13 @@ in isLighthouse = mkOption { type = types.bool; default = false; - description = "Whether this node is a lighthouse."; + description = lib.mdDoc "Whether this node is a lighthouse."; }; lighthouses = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' List of IPs of lighthouse hosts this node should report to and query from. This should be empty on lighthouse nodes. The IPs should be the lighthouse's Nebula IPs, not their external IPs. ''; @@ -81,19 +81,19 @@ in listen.host = mkOption { type = types.str; default = "0.0.0.0"; - description = "IP address to listen on."; + description = lib.mdDoc "IP address to listen on."; }; listen.port = mkOption { type = types.port; default = 4242; - description = "Port number to listen on."; + description = lib.mdDoc "Port number to listen on."; }; tun.disable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' When tun is disabled, a lighthouse can be started without a local tun interface (and therefore without root). ''; }; @@ -101,29 +101,29 @@ in tun.device = mkOption { type = types.nullOr types.str; default = null; - description = "Name of the tun device. Defaults to nebula.\${networkName}."; + description = lib.mdDoc "Name of the tun device. Defaults to nebula.\${networkName}."; }; firewall.outbound = mkOption { type = types.listOf types.attrs; default = []; - description = "Firewall rules for outbound traffic."; + description = lib.mdDoc "Firewall rules for outbound traffic."; example = [ { port = "any"; proto = "any"; host = "any"; } ]; }; firewall.inbound = mkOption { type = types.listOf types.attrs; default = []; - description = "Firewall rules for inbound traffic."; + description = lib.mdDoc "Firewall rules for inbound traffic."; example = [ { port = "any"; proto = "any"; host = "any"; } ]; }; settings = mkOption { type = format.type; default = {}; - description = '' + description = lib.mdDoc '' Nebula configuration. Refer to - <link xlink:href="https://github.com/slackhq/nebula/blob/master/examples/config.yml"/> + <https://github.com/slackhq/nebula/blob/master/examples/config.yml> for details on supported values. ''; example = literalExpression '' diff --git a/nixos/modules/services/networking/networkmanager.nix b/nixos/modules/services/networking/networkmanager.nix index 242afd548df3b..7abdf16b15346 100644 --- a/nixos/modules/services/networking/networkmanager.nix +++ b/nixos/modules/services/networking/networkmanager.nix @@ -157,10 +157,10 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to use NetworkManager to obtain an IP address and other configuration for all network interfaces that are not manually - configured. If enabled, a group <literal>networkmanager</literal> + configured. If enabled, a group `networkmanager` will be created. Add all users that should have permission to change network settings to this group. ''; @@ -243,7 +243,7 @@ in { in types.listOf networkManagerPluginPackage; default = [ ]; - description = '' + description = lib.mdDoc '' List of NetworkManager plug-ins to enable. Some plug-ins are enabled by the NetworkManager module by default. ''; @@ -252,7 +252,7 @@ in { dhcp = mkOption { type = types.enum [ "dhcpcd" "internal" ]; default = "internal"; - description = '' + description = lib.mdDoc '' Which program (or internal library) should be used for DHCP. ''; }; @@ -260,7 +260,7 @@ in { firewallBackend = mkOption { type = types.enum [ "iptables" "nftables" "none" ]; default = "iptables"; - description = '' + description = lib.mdDoc '' Which firewall backend should be used for configuring masquerading with shared mode. If set to none, NetworkManager doesn't manage the configuration at all. ''; @@ -269,7 +269,7 @@ in { logLevel = mkOption { type = types.enum [ "OFF" "ERR" "WARN" "INFO" "DEBUG" "TRACE" ]; default = "WARN"; - description = '' + description = lib.mdDoc '' Set the default logging verbosity level. ''; }; @@ -277,7 +277,7 @@ in { appendNameservers = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' A list of name servers that should be appended to the ones configured in NetworkManager or received by DHCP. ''; @@ -286,7 +286,7 @@ in { insertNameservers = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' A list of name servers that should be inserted before the ones configured in NetworkManager or received by DHCP. ''; @@ -300,16 +300,16 @@ in { backend = mkOption { type = types.enum [ "wpa_supplicant" "iwd" ]; default = "wpa_supplicant"; - description = '' + description = lib.mdDoc '' Specify the Wi-Fi backend used for the device. - Currently supported are <option>wpa_supplicant</option> or <option>iwd</option> (experimental). + Currently supported are {option}`wpa_supplicant` or {option}`iwd` (experimental). ''; }; powersave = mkOption { type = types.nullOr types.bool; default = null; - description = '' + description = lib.mdDoc '' Whether to enable Wi-Fi power saving. ''; }; @@ -317,7 +317,7 @@ in { scanRandMacAddress = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable MAC address randomization of a Wi-Fi device during scanning. ''; @@ -348,7 +348,7 @@ in { options = { source = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' Path to the hook script. ''; }; @@ -380,7 +380,7 @@ in { '''; type = "basic"; } ]''; - description = '' + description = lib.mdDoc '' A list of scripts which will be executed in response to network events. ''; }; @@ -401,10 +401,10 @@ in { enableFccUnlock = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable FCC unlock procedures. Since release 1.18.4, the ModemManager daemon no longer automatically performs the FCC unlock procedure by default. See - <link xlink:href="https://modemmanager.org/docs/modemmanager/fcc-unlock/">the docs</link> + [the docs](https://modemmanager.org/docs/modemmanager/fcc-unlock/) for more details. ''; }; diff --git a/nixos/modules/services/networking/nextdns.nix b/nixos/modules/services/networking/nextdns.nix index b070eeec894fe..697fa605049e9 100644 --- a/nixos/modules/services/networking/nextdns.nix +++ b/nixos/modules/services/networking/nextdns.nix @@ -10,13 +10,13 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the NextDNS DNS/53 to DoH Proxy service."; + description = lib.mdDoc "Whether to enable the NextDNS DNS/53 to DoH Proxy service."; }; arguments = mkOption { type = types.listOf types.str; default = []; example = [ "-config" "10.0.3.0/24=abcdef" ]; - description = "Additional arguments to be passed to nextdns run."; + description = lib.mdDoc "Additional arguments to be passed to nextdns run."; }; }; }; diff --git a/nixos/modules/services/networking/nftables.nix b/nixos/modules/services/networking/nftables.nix index b911f97491eb1..4e7d5ce59ce84 100644 --- a/nixos/modules/services/networking/nftables.nix +++ b/nixos/modules/services/networking/nftables.nix @@ -77,7 +77,7 @@ in } ''; description = - '' + lib.mdDoc '' The ruleset to be used with nftables. Should be in a format that can be loaded using "/bin/nft -f". The ruleset is updated atomically. ''; @@ -90,7 +90,7 @@ in }; defaultText = literalDocBook ''a file with the contents of <option>networking.nftables.ruleset</option>''; description = - '' + lib.mdDoc '' The ruleset file to be used with nftables. Should be in a format that can be loaded using "nft -f". The ruleset is updated atomically. ''; diff --git a/nixos/modules/services/networking/nghttpx/backend-params-submodule.nix b/nixos/modules/services/networking/nghttpx/backend-params-submodule.nix index 6523f4b8b9e0f..510dc02b5c9f8 100644 --- a/nixos/modules/services/networking/nghttpx/backend-params-submodule.nix +++ b/nixos/modules/services/networking/nghttpx/backend-params-submodule.nix @@ -3,7 +3,7 @@ proto = lib.mkOption { type = lib.types.enum [ "h2" "http/1.1" ]; default = "http/1.1"; - description = '' + description = lib.mdDoc '' This option configures the protocol the backend server expects to use. @@ -15,7 +15,7 @@ tls = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' This option determines whether nghttpx will negotiate its connection with a backend server using TLS or not. The burden is on the backend server to provide the TLS certificate! @@ -28,7 +28,7 @@ sni = lib.mkOption { type = lib.types.nullOr lib.types.str; default = null; - description = '' + description = lib.mdDoc '' Override the TLS SNI field value. This value (in nghttpx) defaults to the host value of the backend configuration. @@ -40,7 +40,7 @@ fall = lib.mkOption { type = lib.types.int; default = 0; - description = '' + description = lib.mdDoc '' If nghttpx cannot connect to the backend N times in a row, the backend is assumed to be offline and is excluded from load balancing. If N is 0 the backend is never excluded from load @@ -54,7 +54,7 @@ rise = lib.mkOption { type = lib.types.int; default = 0; - description = '' + description = lib.mdDoc '' If the backend is excluded from load balancing, nghttpx will periodically attempt to make a connection to the backend. If the connection is successful N times in a row the backend is @@ -69,7 +69,7 @@ affinity = lib.mkOption { type = lib.types.enum [ "ip" "none" ]; default = "none"; - description = '' + description = lib.mdDoc '' If "ip" is given, client IP based session affinity is enabled. If "none" is given, session affinity is disabled. @@ -91,7 +91,7 @@ dns = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Name resolution of a backends host name is done at start up, or configuration reload. If "dns" is true, name resolution takes place dynamically. @@ -108,7 +108,7 @@ redirect-if-not-tls = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' If true, a backend match requires the frontend connection be TLS encrypted. If it is not, nghttpx responds to the request with a 308 status code and https URI the client should use diff --git a/nixos/modules/services/networking/nghttpx/frontend-params-submodule.nix b/nixos/modules/services/networking/nghttpx/frontend-params-submodule.nix index 33c8572bd14fc..66c6d7efa6a0a 100644 --- a/nixos/modules/services/networking/nghttpx/frontend-params-submodule.nix +++ b/nixos/modules/services/networking/nghttpx/frontend-params-submodule.nix @@ -3,7 +3,7 @@ tls = lib.mkOption { type = lib.types.enum [ "tls" "no-tls" ]; default = "tls"; - description = '' + description = lib.mdDoc '' Enable or disable TLS. If true (enabled) the key and certificate must be configured for nghttpx. @@ -15,7 +15,7 @@ sni-fwd = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' When performing a match to select a backend server, SNI host name received from the client is used instead of the request host. See --backend option about the pattern match. @@ -28,7 +28,7 @@ api = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable API access for this frontend. This enables you to dynamically modify nghttpx at run-time therefore this feature is disabled by default and should be turned on with care. @@ -41,7 +41,7 @@ healthmon = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Make this frontend a health monitor endpoint. Any request received on this frontend is responded to with a 200 OK. @@ -53,7 +53,7 @@ proxyproto = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Accept PROXY protocol version 1 on frontend connection. Please see https://nghttp2.org/documentation/nghttpx.1.html#cmdoption-nghttpx-f diff --git a/nixos/modules/services/networking/nghttpx/server-options.nix b/nixos/modules/services/networking/nghttpx/server-options.nix index ef23bfd793c5c..48e2a30455969 100644 --- a/nixos/modules/services/networking/nghttpx/server-options.nix +++ b/nixos/modules/services/networking/nghttpx/server-options.nix @@ -3,14 +3,14 @@ host = lib.mkOption { type = lib.types.str; example = "127.0.0.1"; - description = '' + description = lib.mdDoc '' Server host address. ''; }; port = lib.mkOption { type = lib.types.int; example = 5088; - description = '' + description = lib.mdDoc '' Server host port. ''; }; diff --git a/nixos/modules/services/networking/nghttpx/tls-submodule.nix b/nixos/modules/services/networking/nghttpx/tls-submodule.nix index 8f3cdaae2c818..bb6cdae07e582 100644 --- a/nixos/modules/services/networking/nghttpx/tls-submodule.nix +++ b/nixos/modules/services/networking/nghttpx/tls-submodule.nix @@ -4,7 +4,7 @@ type = lib.types.str; example = "/etc/ssl/keys/mykeyfile.key"; default = "/etc/ssl/keys/server.key"; - description = '' + description = lib.mdDoc '' Path to the TLS key file. ''; }; @@ -13,7 +13,7 @@ type = lib.types.str; example = "/etc/ssl/certs/mycert.crt"; default = "/etc/ssl/certs/server.crt"; - description = '' + description = lib.mdDoc '' Path to the TLS certificate file. ''; }; diff --git a/nixos/modules/services/networking/ngircd.nix b/nixos/modules/services/networking/ngircd.nix index c0b9c98fb4bf5..f6c7415c1d3b5 100644 --- a/nixos/modules/services/networking/ngircd.nix +++ b/nixos/modules/services/networking/ngircd.nix @@ -23,13 +23,13 @@ in { enable = mkEnableOption "the ngircd IRC server"; config = mkOption { - description = "The ngircd configuration (see ngircd.conf(5))."; + description = lib.mdDoc "The ngircd configuration (see ngircd.conf(5))."; type = types.lines; }; package = mkOption { - description = "The ngircd package."; + description = lib.mdDoc "The ngircd package."; type = types.package; diff --git a/nixos/modules/services/networking/nix-serve.nix b/nixos/modules/services/networking/nix-serve.nix index 432938d59d90c..04cbc0c0d8f80 100644 --- a/nixos/modules/services/networking/nix-serve.nix +++ b/nixos/modules/services/networking/nix-serve.nix @@ -13,7 +13,7 @@ in port = mkOption { type = types.port; default = 5000; - description = '' + description = lib.mdDoc '' Port number where nix-serve will listen on. ''; }; @@ -21,7 +21,7 @@ in bindAddress = mkOption { type = types.str; default = "0.0.0.0"; - description = '' + description = lib.mdDoc '' IP address where nix-serve will bind its listening socket. ''; }; @@ -29,7 +29,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = "Open ports in the firewall for nix-serve."; + description = lib.mdDoc "Open ports in the firewall for nix-serve."; }; secretKeyFile = mkOption { @@ -50,7 +50,7 @@ in extraParams = mkOption { type = types.separatedString " "; default = ""; - description = '' + description = lib.mdDoc '' Extra command line parameters for nix-serve. ''; }; diff --git a/nixos/modules/services/networking/nix-store-gcs-proxy.nix b/nixos/modules/services/networking/nix-store-gcs-proxy.nix index 0012302db2e3c..531b2bde7633a 100644 --- a/nixos/modules/services/networking/nix-store-gcs-proxy.nix +++ b/nixos/modules/services/networking/nix-store-gcs-proxy.nix @@ -9,18 +9,18 @@ let default = true; type = types.bool; example = true; - description = "Whether to enable proxy for this bucket"; + description = lib.mdDoc "Whether to enable proxy for this bucket"; }; bucketName = mkOption { type = types.str; default = name; example = "my-bucket-name"; - description = "Name of Google storage bucket"; + description = lib.mdDoc "Name of Google storage bucket"; }; address = mkOption { type = types.str; example = "localhost:3000"; - description = "The address of the proxy."; + description = lib.mdDoc "The address of the proxy."; }; }; }; @@ -31,7 +31,7 @@ in options.services.nix-store-gcs-proxy = mkOption { type = types.attrsOf (types.submodule opts); default = {}; - description = '' + description = lib.mdDoc '' An attribute set describing an HTTP to GCS proxy that allows us to use GCS bucket via HTTP protocol. ''; diff --git a/nixos/modules/services/networking/nixops-dns.nix b/nixos/modules/services/networking/nixops-dns.nix index 5e33d872ea452..4abdb50d69423 100644 --- a/nixos/modules/services/networking/nixops-dns.nix +++ b/nixos/modules/services/networking/nixops-dns.nix @@ -12,7 +12,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the nixops-dns resolution of NixOps virtual machines via dnsmasq and fake domain name. ''; @@ -20,7 +20,7 @@ in user = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The user the nixops-dns daemon should run as. This should be the user, which is also used for nixops and have the .nixops directory in its home. @@ -29,7 +29,7 @@ in domain = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Fake domain name to resolve to NixOps virtual machines. For example "ops" will resolve "vm.ops". diff --git a/nixos/modules/services/networking/nntp-proxy.nix b/nixos/modules/services/networking/nntp-proxy.nix index a5973cd59334f..618ed0a93f1df 100644 --- a/nixos/modules/services/networking/nntp-proxy.nix +++ b/nixos/modules/services/networking/nntp-proxy.nix @@ -65,7 +65,7 @@ in type = types.str; default = ""; example = "ssl-eu.astraweb.com"; - description = '' + description = lib.mdDoc '' Upstream server address ''; }; @@ -73,7 +73,7 @@ in upstreamPort = mkOption { type = types.int; default = 563; - description = '' + description = lib.mdDoc '' Upstream server port ''; }; @@ -81,7 +81,7 @@ in upstreamMaxConnections = mkOption { type = types.int; default = 20; - description = '' + description = lib.mdDoc '' Upstream server maximum allowed concurrent connections ''; }; @@ -89,7 +89,7 @@ in upstreamUser = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Upstream server username ''; }; @@ -97,7 +97,7 @@ in upstreamPassword = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Upstream server password ''; }; @@ -106,7 +106,7 @@ in type = types.str; default = "127.0.0.1"; example = "[::]"; - description = '' + description = lib.mdDoc '' Proxy listen address (IPv6 literal addresses need to be enclosed in "[" and "]" characters) ''; }; @@ -114,7 +114,7 @@ in port = mkOption { type = types.int; default = 5555; - description = '' + description = lib.mdDoc '' Proxy listen port ''; }; @@ -123,7 +123,7 @@ in type = types.str; default = "key.pem"; example = "/path/to/your/key.file"; - description = '' + description = lib.mdDoc '' Proxy ssl key path ''; }; @@ -132,7 +132,7 @@ in type = types.str; default = "cert.pem"; example = "/path/to/your/cert.file"; - description = '' + description = lib.mdDoc '' Proxy ssl certificate path ''; }; @@ -140,7 +140,7 @@ in prohibitPosting = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to prohibit posting to the upstream server ''; }; @@ -149,7 +149,7 @@ in type = types.enum [ "error" "warning" "notice" "info" "debug" ]; default = "info"; example = "error"; - description = '' + description = lib.mdDoc '' Verbosity level ''; }; @@ -159,7 +159,7 @@ in options = { username = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Username ''; }; @@ -176,13 +176,13 @@ in maxConnections = mkOption { type = types.int; default = 1; - description = '' + description = lib.mdDoc '' Maximum number of concurrent connections to the proxy for this user ''; }; }; }); - description = '' + description = lib.mdDoc '' NNTP-Proxy user configuration ''; diff --git a/nixos/modules/services/networking/nomad.nix b/nixos/modules/services/networking/nomad.nix index 43333af5e2fea..73b6f13327faf 100644 --- a/nixos/modules/services/networking/nomad.nix +++ b/nixos/modules/services/networking/nomad.nix @@ -14,7 +14,7 @@ in type = types.package; default = pkgs.nomad; defaultText = literalExpression "pkgs.nomad"; - description = '' + description = lib.mdDoc '' The package used for the Nomad agent and CLI. ''; }; @@ -33,7 +33,7 @@ in dropPrivileges = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether the nomad agent should be run as a non-root nomad user. ''; }; @@ -41,7 +41,7 @@ in enableDocker = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Enable Docker support. Needed for Nomad's docker driver. Note that the docker group membership is effectively equivalent @@ -52,7 +52,7 @@ in extraSettingsPaths = mkOption { type = types.listOf types.path; default = [ ]; - description = '' + description = lib.mdDoc '' Additional settings paths used to configure nomad. These can be files or directories. ''; example = literalExpression '' @@ -63,7 +63,7 @@ in extraSettingsPlugins = mkOption { type = types.listOf (types.either types.package types.path); default = [ ]; - description = '' + description = lib.mdDoc '' Additional plugins dir used to configure nomad. ''; example = literalExpression '' @@ -75,23 +75,23 @@ in settings = mkOption { type = format.type; default = { }; - description = '' - Configuration for Nomad. See the <link xlink:href="https://www.nomadproject.io/docs/configuration">documentation</link> + description = lib.mdDoc '' + Configuration for Nomad. See the [documentation](https://www.nomadproject.io/docs/configuration) for supported values. - Notes about <literal>data_dir</literal>: + Notes about `data_dir`: - If <literal>data_dir</literal> is set to a value other than the - default value of <literal>"/var/lib/nomad"</literal> it is the Nomad + If `data_dir` is set to a value other than the + default value of `"/var/lib/nomad"` it is the Nomad cluster manager's responsibility to make sure that this directory exists and has the appropriate permissions. - Additionally, if <literal>dropPrivileges</literal> is - <literal>true</literal> then <literal>data_dir</literal> - <emphasis>cannot</emphasis> be customized. Setting - <literal>dropPrivileges</literal> to <literal>true</literal> enables - the <literal>DynamicUser</literal> feature of systemd which directly - manages and operates on <literal>StateDirectory</literal>. + Additionally, if `dropPrivileges` is + `true` then `data_dir` + *cannot* be customized. Setting + `dropPrivileges` to `true` enables + the `DynamicUser` feature of systemd which directly + manages and operates on `StateDirectory`. ''; example = literalExpression '' { diff --git a/nixos/modules/services/networking/nsd.nix b/nixos/modules/services/networking/nsd.nix index a51fc53453424..1102fc85d40a9 100644 --- a/nixos/modules/services/networking/nsd.nix +++ b/nixos/modules/services/networking/nsd.nix @@ -201,7 +201,7 @@ let allowAXFRFallback = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' If NSD as secondary server should be allowed to AXFR if the primary server does not allow IXFR. ''; @@ -243,7 +243,7 @@ let # to default values, breaking the parent inheriting function. type = types.attrsOf types.anything; default = {}; - description = '' + description = lib.mdDoc '' Children zones inherit all options of their parents. Attributes defined in a child will overwrite the ones of its parent. Only leaf zones will be actually served. This way it's possible to @@ -256,7 +256,7 @@ let data = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' The actual zone data. This is the content of your zone file. Use imports or pkgs.lib.readFile if you don't want this data in your config file. ''; @@ -268,17 +268,17 @@ let algorithm = mkOption { type = types.str; default = "RSASHA256"; - description = "Which algorithm to use for DNSSEC"; + description = lib.mdDoc "Which algorithm to use for DNSSEC"; }; keyttl = mkOption { type = types.str; default = "1h"; - description = "TTL for dnssec records"; + description = lib.mdDoc "TTL for dnssec records"; }; coverage = mkOption { type = types.str; default = "1y"; - description = '' + description = lib.mdDoc '' The length of time to ensure that keys will be correct; no action will be taken to create new keys to be activated after this time. ''; }; @@ -289,7 +289,7 @@ let postPublish = "1w"; rollPeriod = "1mo"; }; - description = "Key policy for zone signing keys"; + description = lib.mdDoc "Key policy for zone signing keys"; }; ksk = mkOption { type = keyPolicy; @@ -298,14 +298,14 @@ let postPublish = "1mo"; rollPeriod = "0"; }; - description = "Key policy for key signing keys"; + description = lib.mdDoc "Key policy for key signing keys"; }; }; maxRefreshSecs = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Limit refresh time for secondary zones. This is the timer which checks to see if the zone has to be refetched when it expires. Normally the value from the SOA record is used, but this option @@ -316,7 +316,7 @@ let minRefreshSecs = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Limit refresh time for secondary zones. ''; }; @@ -324,7 +324,7 @@ let maxRetrySecs = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Limit retry time for secondary zones. This is the timeout after a failed fetch attempt for the zone. Normally the value from the SOA record is used, but this option restricts that value. @@ -334,7 +334,7 @@ let minRetrySecs = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Limit retry time for secondary zones. ''; }; @@ -362,7 +362,7 @@ let notifyRetry = mkOption { type = types.int; default = 5; - description = '' + description = lib.mdDoc '' Specifies the number of retries for failed notifies. Set this along with notify. ''; }; @@ -371,7 +371,7 @@ let type = types.nullOr types.str; default = null; example = "2000::1@1234"; - description = '' + description = lib.mdDoc '' This address will be used for zone-transfere requests if configured as a secondary server or notifications in case of a primary server. Supply either a plain IPv4 or IPv6 address with an optional port @@ -400,7 +400,7 @@ let rrlWhitelist = mkOption { type = with types; listOf (enum [ "nxdomain" "error" "referral" "any" "rrsig" "wildcard" "nodata" "dnskey" "positive" "all" ]); default = []; - description = '' + description = lib.mdDoc '' Whitelists the given rrl-types. ''; }; @@ -409,7 +409,7 @@ let type = types.nullOr types.str; default = null; example = "%s"; - description = '' + description = lib.mdDoc '' When set to something distinct to null NSD is able to collect statistics per zone. All statistics of this zone(s) will be added to the group specified by this given name. Use "%s" to use the zones @@ -424,19 +424,19 @@ let options = { keySize = mkOption { type = types.int; - description = "Key size in bits"; + description = lib.mdDoc "Key size in bits"; }; prePublish = mkOption { type = types.str; - description = "How long in advance to publish new keys"; + description = lib.mdDoc "How long in advance to publish new keys"; }; postPublish = mkOption { type = types.str; - description = "How long after deactivation to keep a key in the zone"; + description = lib.mdDoc "How long after deactivation to keep a key in the zone"; }; rollPeriod = mkOption { type = types.str; - description = "How frequently to change keys"; + description = lib.mdDoc "How frequently to change keys"; }; }; }; @@ -486,7 +486,7 @@ in dnssecInterval = mkOption { type = types.str; default = "1h"; - description = '' + description = lib.mdDoc '' How often to check whether dnssec key rollover is required ''; }; @@ -494,7 +494,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra nsd config. ''; }; @@ -502,7 +502,7 @@ in hideVersion = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether NSD should answer VERSION.BIND and VERSION.SERVER CHAOS class queries. ''; }; @@ -510,7 +510,7 @@ in identity = mkOption { type = types.str; default = "unidentified server"; - description = '' + description = lib.mdDoc '' Identify the server (CH TXT ID.SERVER entry). ''; }; @@ -518,7 +518,7 @@ in interfaces = mkOption { type = types.listOf types.str; default = [ "127.0.0.0" "::1" ]; - description = '' + description = lib.mdDoc '' What addresses the server should listen to. ''; }; @@ -526,7 +526,7 @@ in ipFreebind = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to bind to nonlocal addresses and interfaces that are down. Similar to ip-transparent. ''; @@ -535,7 +535,7 @@ in ipTransparent = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Allow binding to non local addresses. ''; }; @@ -543,7 +543,7 @@ in ipv4 = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to listen on IPv4 connections. ''; }; @@ -551,7 +551,7 @@ in ipv4EDNSSize = mkOption { type = types.int; default = 4096; - description = '' + description = lib.mdDoc '' Preferred EDNS buffer size for IPv4. ''; }; @@ -559,7 +559,7 @@ in ipv6 = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to listen on IPv6 connections. ''; }; @@ -567,7 +567,7 @@ in ipv6EDNSSize = mkOption { type = types.int; default = 4096; - description = '' + description = lib.mdDoc '' Preferred EDNS buffer size for IPv6. ''; }; @@ -575,7 +575,7 @@ in logTimeAscii = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Log time in ascii, if false then in unix epoch seconds. ''; }; @@ -583,7 +583,7 @@ in nsid = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' NSID identity (hex string, or "ascii_somestring"). ''; }; @@ -591,7 +591,7 @@ in port = mkOption { type = types.int; default = 53; - description = '' + description = lib.mdDoc '' Port the service should bind do. ''; }; @@ -600,7 +600,7 @@ in type = types.bool; default = pkgs.stdenv.isLinux; defaultText = literalExpression "pkgs.stdenv.isLinux"; - description = '' + description = lib.mdDoc '' Whether to enable SO_REUSEPORT on all used sockets. This lets multiple processes bind to the same port. This speeds up operation especially if the server count is greater than one and makes fast restarts less @@ -611,7 +611,7 @@ in rootServer = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether this server will be a root server (a DNS root server, you usually don't want that). ''; @@ -622,7 +622,7 @@ in serverCount = mkOption { type = types.int; default = 1; - description = '' + description = lib.mdDoc '' Number of NSD servers to fork. Put the number of CPUs to use here. ''; }; @@ -630,7 +630,7 @@ in statistics = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Statistics are produced every number of seconds. Prints to log. If null no statistics are logged. ''; @@ -639,7 +639,7 @@ in tcpCount = mkOption { type = types.int; default = 100; - description = '' + description = lib.mdDoc '' Maximum number of concurrent TCP connections per server. ''; }; @@ -647,7 +647,7 @@ in tcpQueryCount = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' Maximum number of queries served on a single TCP connection. 0 means no maximum. ''; @@ -656,7 +656,7 @@ in tcpTimeout = mkOption { type = types.int; default = 120; - description = '' + description = lib.mdDoc '' TCP timeout in seconds. ''; }; @@ -664,7 +664,7 @@ in verbosity = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' Verbosity level. ''; }; @@ -672,7 +672,7 @@ in version = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The version string replied for CH TXT version.server and version.bind queries. Will use the compiled package version on null. See hideVersion for enabling/disabling this responses. @@ -682,7 +682,7 @@ in xfrdReloadTimeout = mkOption { type = types.int; default = 1; - description = '' + description = lib.mdDoc '' Number of seconds between reloads triggered by xfrd. ''; }; @@ -690,7 +690,7 @@ in zonefilesCheck = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to check mtime of all zone files on start and sighup. ''; }; @@ -703,14 +703,14 @@ in algorithm = mkOption { type = types.str; default = "hmac-sha256"; - description = '' + description = lib.mdDoc '' Authentication algorithm for this key. ''; }; keyFile = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' Path to the file which contains the actual base64 encoded key. The key will be copied into "${stateDir}/private" before NSD starts. The copied file is only accessibly by the NSD @@ -728,7 +728,7 @@ in }; } ''; - description = '' + description = lib.mdDoc '' Define your TSIG keys here. ''; }; @@ -741,7 +741,7 @@ in ipv4PrefixLength = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' IPv4 prefix length. Addresses are grouped by netblock. ''; }; @@ -749,7 +749,7 @@ in ipv6PrefixLength = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' IPv6 prefix length. Addresses are grouped by netblock. ''; }; @@ -757,7 +757,7 @@ in ratelimit = mkOption { type = types.int; default = 200; - description = '' + description = lib.mdDoc '' Max qps allowed from any query source. 0 means unlimited. With an verbosity of 2 blocked and unblocked subnets will be logged. @@ -767,7 +767,7 @@ in slip = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Number of packets that get discarded before replying a SLIP response. 0 disables SLIP responses. 1 will make every response a SLIP response. ''; @@ -776,7 +776,7 @@ in size = mkOption { type = types.int; default = 1000000; - description = '' + description = lib.mdDoc '' Size of the hashtable. More buckets use more memory but lower the chance of hash hash collisions. ''; @@ -785,7 +785,7 @@ in whitelistRatelimit = mkOption { type = types.int; default = 2000; - description = '' + description = lib.mdDoc '' Max qps allowed from whitelisted sources. 0 means unlimited. Set the rrl-whitelist option for specific queries to apply this limit instead of the default to them. @@ -802,7 +802,7 @@ in controlCertFile = mkOption { type = types.path; default = "/etc/nsd/nsd_control.pem"; - description = '' + description = lib.mdDoc '' Path to the client certificate signed with the server certificate. This file is used by nsd-control and generated by nsd-control-setup. ''; @@ -811,7 +811,7 @@ in controlKeyFile = mkOption { type = types.path; default = "/etc/nsd/nsd_control.key"; - description = '' + description = lib.mdDoc '' Path to the client private key, which is used by nsd-control but not by the server. This file is generated by nsd-control-setup. ''; @@ -820,7 +820,7 @@ in interfaces = mkOption { type = types.listOf types.str; default = [ "127.0.0.1" "::1" ]; - description = '' + description = lib.mdDoc '' Which interfaces NSD should bind to for remote control. ''; }; @@ -828,7 +828,7 @@ in port = mkOption { type = types.int; default = 8952; - description = '' + description = lib.mdDoc '' Port number for remote control operations (uses TLS over TCP). ''; }; @@ -836,7 +836,7 @@ in serverCertFile = mkOption { type = types.path; default = "/etc/nsd/nsd_server.pem"; - description = '' + description = lib.mdDoc '' Path to the server self signed certificate, which is used by the server but and by nsd-control. This file is generated by nsd-control-setup. ''; @@ -845,7 +845,7 @@ in serverKeyFile = mkOption { type = types.path; default = "/etc/nsd/nsd_server.key"; - description = '' + description = lib.mdDoc '' Path to the server private key, which is used by the server but not by nsd-control. This file is generated by nsd-control-setup. ''; @@ -887,7 +887,7 @@ in }; } ''; - description = '' + description = lib.mdDoc '' Define your zones here. Zones can cascade other zones and therefore inherit settings from parent zones. Look at the definition of children to learn about inheritance and child zones. diff --git a/nixos/modules/services/networking/ntopng.nix b/nixos/modules/services/networking/ntopng.nix index 022fc923edaa3..e6344d7ff3b34 100644 --- a/nixos/modules/services/networking/ntopng.nix +++ b/nixos/modules/services/networking/ntopng.nix @@ -43,7 +43,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable ntopng, a high-speed web-based traffic analysis and flow collection tool. @@ -63,7 +63,7 @@ in default = [ "any" ]; example = [ "eth0" "wlan0" ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' List of interfaces to monitor. Use "any" to monitor all interfaces. ''; }; @@ -71,7 +71,7 @@ in httpPort = mkOption { default = 3000; type = types.int; - description = '' + description = lib.mdDoc '' Sets the HTTP port of the embedded web server. ''; }; @@ -79,7 +79,7 @@ in redis.address = mkOption { type = types.str; example = literalExpression "config.services.redis.ntopng.unixSocket"; - description = '' + description = lib.mdDoc '' Redis address - may be a Unix socket or a network host and port. ''; }; @@ -87,10 +87,10 @@ in redis.createInstance = mkOption { type = types.nullOr types.str; default = if versionAtLeast config.system.stateVersion "22.05" then "ntopng" else ""; - description = '' - Local Redis instance name. Set to <literal>null</literal> to disable - local Redis instance. Defaults to <literal>""</literal> for - <literal>system.stateVersion</literal> older than 22.05. + description = lib.mdDoc '' + Local Redis instance name. Set to `null` to disable + local Redis instance. Defaults to `""` for + `system.stateVersion` older than 22.05. ''; }; @@ -102,7 +102,7 @@ in --disable-login ''; type = types.lines; - description = '' + description = lib.mdDoc '' Overridable configuration file contents to use for ntopng. By default, use the contents automatically generated by NixOS. ''; @@ -111,10 +111,10 @@ in extraConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Configuration lines that will be appended to the generated ntopng configuration file. Note that this mechanism does not work when the - manual <option>configText</option> option is used. + manual {option}`configText` option is used. ''; }; diff --git a/nixos/modules/services/networking/ntp/chrony.nix b/nixos/modules/services/networking/ntp/chrony.nix index 34728455a2120..a89c7769152e6 100644 --- a/nixos/modules/services/networking/ntp/chrony.nix +++ b/nixos/modules/services/networking/ntp/chrony.nix @@ -35,7 +35,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to synchronise your machine's time using chrony. Make sure you disable NTP if you enable this service. ''; @@ -45,7 +45,7 @@ in type = types.package; default = pkgs.chrony; defaultText = literalExpression "pkgs.chrony"; - description = '' + description = lib.mdDoc '' Which chrony package to use. ''; }; @@ -54,7 +54,7 @@ in default = config.networking.timeServers; defaultText = literalExpression "config.networking.timeServers"; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' The set of NTP servers from which to synchronise. ''; }; @@ -62,7 +62,7 @@ in serverOption = mkOption { default = "iburst"; type = types.enum [ "iburst" "offline" ]; - description = '' + description = lib.mdDoc '' Set option for server directives. Use "iburst" to rapidly poll on startup. Recommended if your machine @@ -76,7 +76,7 @@ in enableNTS = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable Network Time Security authentication. Make sure it is supported by your selected NTP server(s). ''; @@ -86,7 +86,7 @@ in enabled = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Allow chronyd to make a rapid measurement of the system clock error at boot time, and to correct the system clock by stepping before normal operation begins. @@ -96,7 +96,7 @@ in threshold = mkOption { type = types.either types.float types.int; default = 1000; # by default, same threshold as 'ntpd -g' (1000s) - description = '' + description = lib.mdDoc '' The threshold of system clock error (in seconds) above which the clock will be stepped. If the correction required is less than the threshold, a slew is used instead. @@ -107,15 +107,15 @@ in directory = mkOption { type = types.str; default = "/var/lib/chrony"; - description = "Directory where chrony state is stored."; + description = lib.mdDoc "Directory where chrony state is stored."; }; extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration directives that should be added to - <literal>chrony.conf</literal> + `chrony.conf` ''; }; @@ -123,7 +123,7 @@ in default = []; example = [ "-s" ]; type = types.listOf types.str; - description = "Extra flags passed to the chronyd command."; + description = lib.mdDoc "Extra flags passed to the chronyd command."; }; }; }; diff --git a/nixos/modules/services/networking/ntp/ntpd.nix b/nixos/modules/services/networking/ntp/ntpd.nix index 12be0d045a857..47922f5e1499b 100644 --- a/nixos/modules/services/networking/ntp/ntpd.nix +++ b/nixos/modules/services/networking/ntp/ntpd.nix @@ -79,7 +79,7 @@ in default = config.networking.timeServers; defaultText = literalExpression "config.networking.timeServers"; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' The set of NTP servers from which to synchronise. ''; }; @@ -90,14 +90,14 @@ in example = '' fudge 127.127.1.0 stratum 10 ''; - description = '' - Additional text appended to <filename>ntp.conf</filename>. + description = lib.mdDoc '' + Additional text appended to {file}`ntp.conf`. ''; }; extraFlags = mkOption { type = types.listOf types.str; - description = "Extra flags passed to the ntpd command."; + description = lib.mdDoc "Extra flags passed to the ntpd command."; example = literalExpression ''[ "--interface=eth0" ]''; default = []; }; diff --git a/nixos/modules/services/networking/ntp/openntpd.nix b/nixos/modules/services/networking/ntp/openntpd.nix index e86b71291f960..2a766a134f773 100644 --- a/nixos/modules/services/networking/ntp/openntpd.nix +++ b/nixos/modules/services/networking/ntp/openntpd.nix @@ -35,8 +35,8 @@ in listen on 127.0.0.1 listen on ::1 ''; - description = '' - Additional text appended to <filename>openntpd.conf</filename>. + description = lib.mdDoc '' + Additional text appended to {file}`openntpd.conf`. ''; }; @@ -44,7 +44,7 @@ in type = with types; separatedString " "; default = ""; example = "-s"; - description = '' + description = lib.mdDoc '' Extra options used when launching openntpd. ''; }; diff --git a/nixos/modules/services/networking/nullidentdmod.nix b/nixos/modules/services/networking/nullidentdmod.nix index b0d338a279410..85f5c799a3100 100644 --- a/nixos/modules/services/networking/nullidentdmod.nix +++ b/nixos/modules/services/networking/nullidentdmod.nix @@ -7,7 +7,7 @@ in { userid = mkOption { type = nullOr str; - description = "User ID to return. Set to null to return a random string each time."; + description = lib.mdDoc "User ID to return. Set to null to return a random string each time."; default = null; example = "alice"; }; diff --git a/nixos/modules/services/networking/nylon.nix b/nixos/modules/services/networking/nylon.nix index a20fa615af80b..3eb15c23bef52 100644 --- a/nixos/modules/services/networking/nylon.nix +++ b/nixos/modules/services/networking/nylon.nix @@ -29,7 +29,7 @@ let enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enables nylon as a running service upon activation. ''; }; @@ -37,13 +37,13 @@ let name = mkOption { type = types.str; default = ""; - description = "The name of this nylon instance."; + description = lib.mdDoc "The name of this nylon instance."; }; nrConnections = mkOption { type = types.int; default = 10; - description = '' + description = lib.mdDoc '' The number of allowed simultaneous connections to the daemon, default 10. ''; }; @@ -51,7 +51,7 @@ let logging = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable logging, default is no logging. ''; }; @@ -59,7 +59,7 @@ let verbosity = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable verbose output, default is to not be verbose. ''; }; @@ -67,7 +67,7 @@ let acceptInterface = mkOption { type = types.str; default = "lo"; - description = '' + description = lib.mdDoc '' Tell nylon which interface to listen for client requests on, default is "lo". ''; }; @@ -75,7 +75,7 @@ let bindInterface = mkOption { type = types.str; default = "enp3s0f0"; - description = '' + description = lib.mdDoc '' Tell nylon which interface to use as an uplink, default is "enp3s0f0". ''; }; @@ -83,7 +83,7 @@ let port = mkOption { type = types.int; default = 1080; - description = '' + description = lib.mdDoc '' What port to listen for client requests, default is 1080. ''; }; @@ -91,7 +91,7 @@ let allowedIPRanges = mkOption { type = with types; listOf str; default = [ "192.168.0.0/16" "127.0.0.1/8" "172.16.0.1/12" "10.0.0.0/8" ]; - description = '' + description = lib.mdDoc '' Allowed client IP ranges are evaluated first, defaults to ARIN IPv4 private ranges: [ "192.168.0.0/16" "127.0.0.0/8" "172.16.0.0/12" "10.0.0.0/8" ] ''; @@ -100,7 +100,7 @@ let deniedIPRanges = mkOption { type = with types; listOf str; default = [ "0.0.0.0/0" ]; - description = '' + description = lib.mdDoc '' Denied client IP ranges, these gets evaluated after the allowed IP ranges, defaults to all IPv4 addresses: [ "0.0.0.0/0" ] To block all other access than the allowed. diff --git a/nixos/modules/services/networking/ofono.nix b/nixos/modules/services/networking/ofono.nix index 460b06443c412..6192857cd3ed8 100644 --- a/nixos/modules/services/networking/ofono.nix +++ b/nixos/modules/services/networking/ofono.nix @@ -25,7 +25,7 @@ in type = types.listOf types.package; default = []; example = literalExpression "[ pkgs.modem-manager-gui ]"; - description = '' + description = lib.mdDoc '' The list of plugins to install. ''; }; diff --git a/nixos/modules/services/networking/oidentd.nix b/nixos/modules/services/networking/oidentd.nix index feb84806ba99c..7c7883c94611c 100644 --- a/nixos/modules/services/networking/oidentd.nix +++ b/nixos/modules/services/networking/oidentd.nix @@ -11,7 +11,7 @@ with lib; services.oidentd.enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable ‘oidentd’, an implementation of the Ident protocol (RFC 1413). It allows remote systems to identify the name of the user associated with a TCP connection. diff --git a/nixos/modules/services/networking/onedrive.nix b/nixos/modules/services/networking/onedrive.nix index 0256a6a411152..5a531d7a47fdc 100644 --- a/nixos/modules/services/networking/onedrive.nix +++ b/nixos/modules/services/networking/onedrive.nix @@ -29,14 +29,14 @@ in { enable = lib.mkOption { type = lib.types.bool; default = false; - description = "Enable OneDrive service"; + description = lib.mdDoc "Enable OneDrive service"; }; package = lib.mkOption { type = lib.types.package; default = pkgs.onedrive; defaultText = lib.literalExpression "pkgs.onedrive"; - description = '' + description = lib.mdDoc '' OneDrive package to use. ''; }; diff --git a/nixos/modules/services/networking/openconnect.nix b/nixos/modules/services/networking/openconnect.nix index bc873b2198bcc..c5313bb305a2d 100644 --- a/nixos/modules/services/networking/openconnect.nix +++ b/nixos/modules/services/networking/openconnect.nix @@ -11,25 +11,25 @@ let options = { autoStart = mkOption { default = true; - description = "Whether this VPN connection should be started automatically."; + description = lib.mdDoc "Whether this VPN connection should be started automatically."; type = types.bool; }; gateway = mkOption { - description = "Gateway server to connect to."; + description = lib.mdDoc "Gateway server to connect to."; example = "gateway.example.com"; type = types.str; }; protocol = mkOption { - description = "Protocol to use."; + description = lib.mdDoc "Protocol to use."; example = "anyconnect"; type = types.enum [ "anyconnect" "array" "nc" "pulse" "gp" "f5" "fortinet" ]; }; user = mkOption { - description = "Username to authenticate with."; + description = lib.mdDoc "Username to authenticate with."; example = "example-user"; type = types.nullOr types.str; }; @@ -49,14 +49,14 @@ let }; certificate = mkOption { - description = "Certificate to authenticate with."; + description = lib.mdDoc "Certificate to authenticate with."; default = null; example = "/var/lib/secrets/openconnect_certificate.pem"; type = with types; nullOr (either path pkcs11); }; privateKey = mkOption { - description = "Private key to authenticate with."; + description = lib.mdDoc "Private key to authenticate with."; example = "/var/lib/secrets/openconnect_private_key.pem"; default = null; type = with types; nullOr (either path pkcs11); @@ -118,7 +118,7 @@ in { package = mkPackageOption pkgs "openconnect" { }; interfaces = mkOption { - description = "OpenConnect interfaces."; + description = lib.mdDoc "OpenConnect interfaces."; default = { }; example = { openconnect0 = { diff --git a/nixos/modules/services/networking/openvpn.nix b/nixos/modules/services/networking/openvpn.nix index cf3f79fc578fa..752b4d67d47e6 100644 --- a/nixos/modules/services/networking/openvpn.nix +++ b/nixos/modules/services/networking/openvpn.nix @@ -130,20 +130,20 @@ in config = mkOption { type = types.lines; - description = '' + description = lib.mdDoc '' Configuration of this OpenVPN instance. See - <citerefentry><refentrytitle>openvpn</refentrytitle><manvolnum>8</manvolnum></citerefentry> + {manpage}`openvpn(8)` for details. To import an external config file, use the following definition: - <literal>config = "config /path/to/config.ovpn"</literal> + `config = "config /path/to/config.ovpn"` ''; }; up = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Shell commands executed when the instance is starting. ''; }; @@ -151,7 +151,7 @@ in down = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Shell commands executed when the instance is shutting down. ''; }; @@ -159,13 +159,13 @@ in autoStart = mkOption { default = true; type = types.bool; - description = "Whether this OpenVPN instance should be started automatically."; + description = lib.mdDoc "Whether this OpenVPN instance should be started automatically."; }; updateResolvConf = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Use the script from the update-resolv-conf package to automatically update resolv.conf with the DNS information provided by openvpn. The script will be run after the "up" commands and before the "down" commands. @@ -174,7 +174,7 @@ in authUserPass = mkOption { default = null; - description = '' + description = lib.mdDoc '' This option can be used to store the username / password credentials with the "auth-user-pass" authentication method. @@ -184,12 +184,12 @@ in options = { username = mkOption { - description = "The username to store inside the credentials file."; + description = lib.mdDoc "The username to store inside the credentials file."; type = types.str; }; password = mkOption { - description = "The password to store inside the credentials file."; + description = lib.mdDoc "The password to store inside the credentials file."; type = types.str; }; }; diff --git a/nixos/modules/services/networking/ostinato.nix b/nixos/modules/services/networking/ostinato.nix index 4da11984b9fc7..808ccdd4e0cfc 100644 --- a/nixos/modules/services/networking/ostinato.nix +++ b/nixos/modules/services/networking/ostinato.nix @@ -31,7 +31,7 @@ in port = mkOption { type = types.int; default = 7878; - description = '' + description = lib.mdDoc '' Port to listen on. ''; }; @@ -39,7 +39,7 @@ in rateAccuracy = mkOption { type = types.enum [ "High" "Low" ]; default = "High"; - description = '' + description = lib.mdDoc '' To ensure that the actual transmit rate is as close as possible to the configured transmit rate, Drone runs a busy-wait loop. While this provides the maximum accuracy possible, the CPU @@ -52,7 +52,7 @@ in address = mkOption { type = types.str; default = "0.0.0.0"; - description = '' + description = lib.mdDoc '' By default, the Drone RPC server will listen on all interfaces and local IPv4 adresses for incoming connections from clients. Specify a single IPv4 or IPv6 address if you want to restrict that. @@ -66,7 +66,7 @@ in type = types.listOf types.str; default = []; example = [ "eth*" "lo*" ]; - description = '' + description = lib.mdDoc '' For a port to pass the filter and appear on the port list managed by drone, it be allowed by this include list. ''; @@ -75,7 +75,7 @@ in type = types.listOf types.str; default = []; example = [ "usbmon*" "eth0" ]; - description = '' + description = lib.mdDoc '' A list of ports does not appear on the port list managed by drone. ''; }; diff --git a/nixos/modules/services/networking/pdns-recursor.nix b/nixos/modules/services/networking/pdns-recursor.nix index a986f83141c4d..7319793101c5d 100644 --- a/nixos/modules/services/networking/pdns-recursor.nix +++ b/nixos/modules/services/networking/pdns-recursor.nix @@ -32,7 +32,7 @@ in { dns.address = mkOption { type = oneOrMore types.str; default = [ "::" "0.0.0.0" ]; - description = '' + description = lib.mdDoc '' IP addresses Recursor DNS server will bind to. ''; }; @@ -40,7 +40,7 @@ in { dns.port = mkOption { type = types.int; default = 53; - description = '' + description = lib.mdDoc '' Port number Recursor DNS server will bind to. ''; }; @@ -53,7 +53,7 @@ in { "::1/128" "fc00::/7" "fe80::/10" ]; example = [ "0.0.0.0/0" "::/0" ]; - description = '' + description = lib.mdDoc '' IP address ranges of clients allowed to make DNS queries. ''; }; @@ -61,7 +61,7 @@ in { api.address = mkOption { type = types.str; default = "0.0.0.0"; - description = '' + description = lib.mdDoc '' IP address Recursor REST API server will bind to. ''; }; @@ -69,7 +69,7 @@ in { api.port = mkOption { type = types.int; default = 8082; - description = '' + description = lib.mdDoc '' Port number Recursor REST API server will bind to. ''; }; @@ -78,7 +78,7 @@ in { type = types.listOf types.str; default = [ "127.0.0.1" "::1" ]; example = [ "0.0.0.0/0" "::/0" ]; - description = '' + description = lib.mdDoc '' IP address ranges of clients allowed to make API requests. ''; }; @@ -86,7 +86,7 @@ in { exportHosts = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to export names and IP addresses defined in /etc/hosts. ''; }; @@ -94,7 +94,7 @@ in { forwardZones = mkOption { type = types.attrs; default = {}; - description = '' + description = lib.mdDoc '' DNS zones to be forwarded to other authoritative servers. ''; }; @@ -103,7 +103,7 @@ in { type = types.attrs; example = { eth = "[::1]:5353"; }; default = {}; - description = '' + description = lib.mdDoc '' DNS zones to be forwarded to other recursive servers. ''; }; @@ -111,7 +111,7 @@ in { dnssecValidation = mkOption { type = types.enum ["off" "process-no-validate" "process" "log-fail" "validate"]; default = "validate"; - description = '' + description = lib.mdDoc '' Controls the level of DNSSEC processing done by the PowerDNS Recursor. See https://doc.powerdns.com/md/recursor/dnssec/ for a detailed explanation. ''; @@ -120,11 +120,11 @@ in { serveRFC1918 = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to directly resolve the RFC1918 reverse-mapping domains: - <literal>10.in-addr.arpa</literal>, - <literal>168.192.in-addr.arpa</literal>, - <literal>16-31.172.in-addr.arpa</literal> + `10.in-addr.arpa`, + `168.192.in-addr.arpa`, + `16-31.172.in-addr.arpa` This saves load on the AS112 servers. ''; }; @@ -138,11 +138,11 @@ in { log-common-errors = true; } ''; - description = '' + description = lib.mdDoc '' PowerDNS Recursor settings. Use this option to configure Recursor settings not exposed in a NixOS option or to bypass one. See the full documentation at - <link xlink:href="https://doc.powerdns.com/recursor/settings.html"/> + <https://doc.powerdns.com/recursor/settings.html> for the available options. ''; }; @@ -150,9 +150,9 @@ in { luaConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' The content Lua configuration file for PowerDNS Recursor. See - <link xlink:href="https://doc.powerdns.com/recursor/lua-config/index.html"/>. + <https://doc.powerdns.com/recursor/lua-config/index.html>. ''; }; }; diff --git a/nixos/modules/services/networking/pdnsd.nix b/nixos/modules/services/networking/pdnsd.nix index 24b5bbc5104e1..03c9005413b55 100644 --- a/nixos/modules/services/networking/pdnsd.nix +++ b/nixos/modules/services/networking/pdnsd.nix @@ -29,33 +29,33 @@ in cacheDir = mkOption { type = types.str; default = "/var/cache/pdnsd"; - description = "Directory holding the pdnsd cache"; + description = lib.mdDoc "Directory holding the pdnsd cache"; }; globalConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Global configuration that should be added to the global directory - of <literal>pdnsd.conf</literal>. + of `pdnsd.conf`. ''; }; serverConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Server configuration that should be added to the server directory - of <literal>pdnsd.conf</literal>. + of `pdnsd.conf`. ''; }; extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration directives that should be added to - <literal>pdnsd.conf</literal>. + `pdnsd.conf`. ''; }; }; diff --git a/nixos/modules/services/networking/pixiecore.nix b/nixos/modules/services/networking/pixiecore.nix index d2642c82c2d37..c88081af62039 100644 --- a/nixos/modules/services/networking/pixiecore.nix +++ b/nixos/modules/services/networking/pixiecore.nix @@ -15,13 +15,13 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports (67, 69 UDP and 4011, 'port', 'statusPort' TCP) in the firewall for Pixiecore. ''; }; mode = mkOption { - description = "Which mode to use"; + description = lib.mdDoc "Which mode to use"; default = "boot"; type = types.enum [ "api" "boot" ]; }; @@ -29,61 +29,61 @@ in debug = mkOption { type = types.bool; default = false; - description = "Log more things that aren't directly related to booting a recognized client"; + description = lib.mdDoc "Log more things that aren't directly related to booting a recognized client"; }; dhcpNoBind = mkOption { type = types.bool; default = false; - description = "Handle DHCP traffic without binding to the DHCP server port"; + description = lib.mdDoc "Handle DHCP traffic without binding to the DHCP server port"; }; kernel = mkOption { type = types.str or types.path; default = ""; - description = "Kernel path. Ignored unless mode is set to 'boot'"; + description = lib.mdDoc "Kernel path. Ignored unless mode is set to 'boot'"; }; initrd = mkOption { type = types.str or types.path; default = ""; - description = "Initrd path. Ignored unless mode is set to 'boot'"; + description = lib.mdDoc "Initrd path. Ignored unless mode is set to 'boot'"; }; cmdLine = mkOption { type = types.str; default = ""; - description = "Kernel commandline arguments. Ignored unless mode is set to 'boot'"; + description = lib.mdDoc "Kernel commandline arguments. Ignored unless mode is set to 'boot'"; }; listen = mkOption { type = types.str; default = "0.0.0.0"; - description = "IPv4 address to listen on"; + description = lib.mdDoc "IPv4 address to listen on"; }; port = mkOption { type = types.port; default = 80; - description = "Port to listen on for HTTP"; + description = lib.mdDoc "Port to listen on for HTTP"; }; statusPort = mkOption { type = types.port; default = 80; - description = "HTTP port for status information (can be the same as --port)"; + description = lib.mdDoc "HTTP port for status information (can be the same as --port)"; }; apiServer = mkOption { type = types.str; example = "localhost:8080"; - description = "host:port to connect to the API. Ignored unless mode is set to 'api'"; + description = lib.mdDoc "host:port to connect to the API. Ignored unless mode is set to 'api'"; }; extraArguments = mkOption { type = types.listOf types.str; default = []; - description = "Additional command line arguments to pass to Pixiecore"; + description = lib.mdDoc "Additional command line arguments to pass to Pixiecore"; }; }; }; diff --git a/nixos/modules/services/networking/pleroma.nix b/nixos/modules/services/networking/pleroma.nix index 9b8382392c0a7..03868c8cc7694 100644 --- a/nixos/modules/services/networking/pleroma.nix +++ b/nixos/modules/services/networking/pleroma.nix @@ -10,26 +10,26 @@ in { type = types.package; default = pkgs.pleroma; defaultText = literalExpression "pkgs.pleroma"; - description = "Pleroma package to use."; + description = lib.mdDoc "Pleroma package to use."; }; user = mkOption { type = types.str; default = "pleroma"; - description = "User account under which pleroma runs."; + description = lib.mdDoc "User account under which pleroma runs."; }; group = mkOption { type = types.str; default = "pleroma"; - description = "Group account under which pleroma runs."; + description = lib.mdDoc "Group account under which pleroma runs."; }; stateDir = mkOption { type = types.str; default = "/var/lib/pleroma"; readOnly = true; - description = "Directory where the pleroma service will save the uploads and static files."; + description = lib.mdDoc "Directory where the pleroma service will save the uploads and static files."; }; configs = mkOption { @@ -59,11 +59,11 @@ in { secretConfigFile = mkOption { type = types.str; default = "/var/lib/pleroma/secrets.exs"; - description = '' + description = lib.mdDoc '' Path to the file containing your secret pleroma configuration. - <emphasis>DO NOT POINT THIS OPTION TO THE NIX - STORE</emphasis>, the store being world-readable, it'll + *DO NOT POINT THIS OPTION TO THE NIX + STORE*, the store being world-readable, it'll compromise all your secrets. ''; }; diff --git a/nixos/modules/services/networking/polipo.nix b/nixos/modules/services/networking/polipo.nix index 1ff9388346b61..d820e1b397b81 100644 --- a/nixos/modules/services/networking/polipo.nix +++ b/nixos/modules/services/networking/polipo.nix @@ -26,26 +26,26 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to run the polipo caching web proxy."; + description = lib.mdDoc "Whether to run the polipo caching web proxy."; }; proxyAddress = mkOption { type = types.str; default = "127.0.0.1"; - description = "IP address on which Polipo will listen."; + description = lib.mdDoc "IP address on which Polipo will listen."; }; proxyPort = mkOption { type = types.int; default = 8123; - description = "TCP port on which Polipo will listen."; + description = lib.mdDoc "TCP port on which Polipo will listen."; }; allowedClients = mkOption { type = types.listOf types.str; default = [ "127.0.0.1" "::1" ]; example = [ "127.0.0.1" "::1" "134.157.168.0/24" "2001:660:116::/48" ]; - description = '' + description = lib.mdDoc '' List of IP addresses or network addresses that may connect to Polipo. ''; }; @@ -54,7 +54,7 @@ in type = types.str; default = ""; example = "localhost:8124"; - description = '' + description = lib.mdDoc '' Hostname and port number of an HTTP parent proxy; it should have the form ‘host:port’. ''; @@ -64,7 +64,7 @@ in type = types.str; default = ""; example = "localhost:9050"; - description = '' + description = lib.mdDoc '' Hostname and port number of an SOCKS parent proxy; it should have the form ‘host:port’. ''; @@ -73,7 +73,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Polio configuration. Contents will be added verbatim to the configuration file. ''; diff --git a/nixos/modules/services/networking/powerdns.nix b/nixos/modules/services/networking/powerdns.nix index b035698456c05..f7c72361dfa1d 100644 --- a/nixos/modules/services/networking/powerdns.nix +++ b/nixos/modules/services/networking/powerdns.nix @@ -13,9 +13,9 @@ in { extraConfig = mkOption { type = types.lines; default = "launch=bind"; - description = '' + description = lib.mdDoc '' PowerDNS configuration. Refer to - <link xlink:href="https://doc.powerdns.com/authoritative/settings.html"/> + <https://doc.powerdns.com/authoritative/settings.html> for details on supported values. ''; }; diff --git a/nixos/modules/services/networking/pppd.nix b/nixos/modules/services/networking/pppd.nix index d1ed25b0238f4..d923b49dda290 100644 --- a/nixos/modules/services/networking/pppd.nix +++ b/nixos/modules/services/networking/pppd.nix @@ -18,12 +18,12 @@ in default = pkgs.ppp; defaultText = literalExpression "pkgs.ppp"; type = types.package; - description = "pppd package to use."; + description = lib.mdDoc "pppd package to use."; }; peers = mkOption { default = {}; - description = "pppd peers."; + description = lib.mdDoc "pppd peers."; type = types.attrsOf (types.submodule ( { name, ... }: { @@ -32,27 +32,27 @@ in type = types.str; default = name; example = "dialup"; - description = "Name of the PPP peer."; + description = lib.mdDoc "Name of the PPP peer."; }; enable = mkOption { type = types.bool; default = true; example = false; - description = "Whether to enable this PPP peer."; + description = lib.mdDoc "Whether to enable this PPP peer."; }; autostart = mkOption { type = types.bool; default = true; example = false; - description = "Whether the PPP session is automatically started at boot time."; + description = lib.mdDoc "Whether the PPP session is automatically started at boot time."; }; config = mkOption { type = types.lines; default = ""; - description = "pppd configuration for this peer, see the pppd(8) man page."; + description = lib.mdDoc "pppd configuration for this peer, see the pppd(8) man page."; }; }; })); diff --git a/nixos/modules/services/networking/pptpd.nix b/nixos/modules/services/networking/pptpd.nix index 423e14e998f85..d16496a2cb522 100644 --- a/nixos/modules/services/networking/pptpd.nix +++ b/nixos/modules/services/networking/pptpd.nix @@ -9,31 +9,31 @@ with lib; serverIp = mkOption { type = types.str; - description = "The server-side IP address."; + description = lib.mdDoc "The server-side IP address."; default = "10.124.124.1"; }; clientIpRange = mkOption { type = types.str; - description = "The range from which client IPs are drawn."; + description = lib.mdDoc "The range from which client IPs are drawn."; default = "10.124.124.2-11"; }; maxClients = mkOption { type = types.int; - description = "The maximum number of simultaneous connections."; + description = lib.mdDoc "The maximum number of simultaneous connections."; default = 10; }; extraPptpdOptions = mkOption { type = types.lines; - description = "Adds extra lines to the pptpd configuration file."; + description = lib.mdDoc "Adds extra lines to the pptpd configuration file."; default = ""; }; extraPppdOptions = mkOption { type = types.lines; - description = "Adds extra lines to the pppd options file."; + description = lib.mdDoc "Adds extra lines to the pppd options file."; default = ""; example = '' ms-dns 8.8.8.8 diff --git a/nixos/modules/services/networking/prayer.nix b/nixos/modules/services/networking/prayer.nix index 513509eaca3ab..01e961997a77e 100644 --- a/nixos/modules/services/networking/prayer.nix +++ b/nixos/modules/services/networking/prayer.nix @@ -46,7 +46,7 @@ in port = mkOption { default = 2080; type = types.port; - description = '' + description = lib.mdDoc '' Port the prayer http server is listening to. ''; }; @@ -54,7 +54,7 @@ in extraConfig = mkOption { type = types.lines; default = "" ; - description = '' + description = lib.mdDoc '' Extra configuration. Contents will be added verbatim to the configuration file. ''; }; diff --git a/nixos/modules/services/networking/privoxy.nix b/nixos/modules/services/networking/privoxy.nix index 7bc964d5f34ae..1ad5b155feb25 100644 --- a/nixos/modules/services/networking/privoxy.nix +++ b/nixos/modules/services/networking/privoxy.nix @@ -58,7 +58,7 @@ in enableTor = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to configure Privoxy to use Tor's faster SOCKS port, suitable for HTTP. ''; @@ -106,8 +106,8 @@ in userActions = mkOption { type = types.lines; default = ""; - description = '' - Actions to be included in a <literal>user.action</literal> file. This + description = lib.mdDoc '' + Actions to be included in a `user.action` file. This will have a higher priority and can be used to override all other actions. ''; @@ -116,8 +116,8 @@ in userFilters = mkOption { type = types.lines; default = ""; - description = '' - Filters to be included in a <literal>user.filter</literal> file. This + description = lib.mdDoc '' + Filters to be included in a `user.filter` file. This will have a higher priority and can be used to override all other filters definitions. ''; @@ -130,13 +130,13 @@ in options.listen-address = mkOption { type = types.str; default = "127.0.0.1:8118"; - description = "Pair of address:port the proxy server is listening to."; + description = lib.mdDoc "Pair of address:port the proxy server is listening to."; }; options.enable-edit-actions = mkOption { type = types.bool; default = false; - description = "Whether the web-based actions file editor may be used."; + description = lib.mdDoc "Whether the web-based actions file editor may be used."; }; options.actionsfile = mkOption { @@ -146,7 +146,7 @@ in apply = x: x ++ optional (cfg.userActions != "") (toString (pkgs.writeText "user.actions" cfg.userActions)); default = [ "match-all.action" "default.action" ]; - description = '' + description = lib.mdDoc '' List of paths to Privoxy action files. These paths may either be absolute or relative to the privoxy configuration directory. ''; @@ -157,7 +157,7 @@ in default = [ "default.filter" ]; apply = x: x ++ optional (cfg.userFilters != "") (toString (pkgs.writeText "user.filter" cfg.userFilters)); - description = '' + description = lib.mdDoc '' List of paths to Privoxy filter files. These paths may either be absolute or relative to the privoxy configuration directory. ''; diff --git a/nixos/modules/services/networking/prosody.nix b/nixos/modules/services/networking/prosody.nix index 9e8db04e62241..f32c7adbd2c37 100644 --- a/nixos/modules/services/networking/prosody.nix +++ b/nixos/modules/services/networking/prosody.nix @@ -10,19 +10,19 @@ let key = mkOption { type = types.path; - description = "Path to the key file."; + description = lib.mdDoc "Path to the key file."; }; # TODO: rename to certificate to match the prosody config cert = mkOption { type = types.path; - description = "Path to the certificate file."; + description = lib.mdDoc "Path to the certificate file."; }; extraOptions = mkOption { type = types.attrs; default = {}; - description = "Extra SSL configuration options."; + description = lib.mdDoc "Extra SSL configuration options."; }; }; @@ -32,11 +32,11 @@ let options = { url = mkOption { type = types.str; - description = "URL of the endpoint you want to make discoverable"; + description = lib.mdDoc "URL of the endpoint you want to make discoverable"; }; description = mkOption { type = types.str; - description = "A short description of the endpoint you want to advertise"; + description = lib.mdDoc "A short description of the endpoint you want to advertise"; }; }; }; @@ -46,216 +46,216 @@ let roster = mkOption { type = types.bool; default = true; - description = "Allow users to have a roster"; + description = lib.mdDoc "Allow users to have a roster"; }; saslauth = mkOption { type = types.bool; default = true; - description = "Authentication for clients and servers. Recommended if you want to log in."; + description = lib.mdDoc "Authentication for clients and servers. Recommended if you want to log in."; }; tls = mkOption { type = types.bool; default = true; - description = "Add support for secure TLS on c2s/s2s connections"; + description = lib.mdDoc "Add support for secure TLS on c2s/s2s connections"; }; dialback = mkOption { type = types.bool; default = true; - description = "s2s dialback support"; + description = lib.mdDoc "s2s dialback support"; }; disco = mkOption { type = types.bool; default = true; - description = "Service discovery"; + description = lib.mdDoc "Service discovery"; }; # Not essential, but recommended carbons = mkOption { type = types.bool; default = true; - description = "Keep multiple clients in sync"; + description = lib.mdDoc "Keep multiple clients in sync"; }; csi = mkOption { type = types.bool; default = true; - description = "Implements the CSI protocol that allows clients to report their active/inactive state to the server"; + description = lib.mdDoc "Implements the CSI protocol that allows clients to report their active/inactive state to the server"; }; cloud_notify = mkOption { type = types.bool; default = true; - description = "Push notifications to inform users of new messages or other pertinent information even when they have no XMPP clients online"; + description = lib.mdDoc "Push notifications to inform users of new messages or other pertinent information even when they have no XMPP clients online"; }; pep = mkOption { type = types.bool; default = true; - description = "Enables users to publish their mood, activity, playing music and more"; + description = lib.mdDoc "Enables users to publish their mood, activity, playing music and more"; }; private = mkOption { type = types.bool; default = true; - description = "Private XML storage (for room bookmarks, etc.)"; + description = lib.mdDoc "Private XML storage (for room bookmarks, etc.)"; }; blocklist = mkOption { type = types.bool; default = true; - description = "Allow users to block communications with other users"; + description = lib.mdDoc "Allow users to block communications with other users"; }; vcard = mkOption { type = types.bool; default = false; - description = "Allow users to set vCards"; + description = lib.mdDoc "Allow users to set vCards"; }; vcard_legacy = mkOption { type = types.bool; default = true; - description = "Converts users profiles and Avatars between old and new formats"; + description = lib.mdDoc "Converts users profiles and Avatars between old and new formats"; }; bookmarks = mkOption { type = types.bool; default = true; - description = "Allows interop between older clients that use XEP-0048: Bookmarks in its 1.0 version and recent clients which use it in PEP"; + description = lib.mdDoc "Allows interop between older clients that use XEP-0048: Bookmarks in its 1.0 version and recent clients which use it in PEP"; }; # Nice to have version = mkOption { type = types.bool; default = true; - description = "Replies to server version requests"; + description = lib.mdDoc "Replies to server version requests"; }; uptime = mkOption { type = types.bool; default = true; - description = "Report how long server has been running"; + description = lib.mdDoc "Report how long server has been running"; }; time = mkOption { type = types.bool; default = true; - description = "Let others know the time here on this server"; + description = lib.mdDoc "Let others know the time here on this server"; }; ping = mkOption { type = types.bool; default = true; - description = "Replies to XMPP pings with pongs"; + description = lib.mdDoc "Replies to XMPP pings with pongs"; }; register = mkOption { type = types.bool; default = true; - description = "Allow users to register on this server using a client and change passwords"; + description = lib.mdDoc "Allow users to register on this server using a client and change passwords"; }; mam = mkOption { type = types.bool; default = true; - description = "Store messages in an archive and allow users to access it"; + description = lib.mdDoc "Store messages in an archive and allow users to access it"; }; smacks = mkOption { type = types.bool; default = true; - description = "Allow a client to resume a disconnected session, and prevent message loss"; + description = lib.mdDoc "Allow a client to resume a disconnected session, and prevent message loss"; }; # Admin interfaces admin_adhoc = mkOption { type = types.bool; default = true; - description = "Allows administration via an XMPP client that supports ad-hoc commands"; + description = lib.mdDoc "Allows administration via an XMPP client that supports ad-hoc commands"; }; http_files = mkOption { type = types.bool; default = true; - description = "Serve static files from a directory over HTTP"; + description = lib.mdDoc "Serve static files from a directory over HTTP"; }; proxy65 = mkOption { type = types.bool; default = true; - description = "Enables a file transfer proxy service which clients behind NAT can use"; + description = lib.mdDoc "Enables a file transfer proxy service which clients behind NAT can use"; }; admin_telnet = mkOption { type = types.bool; default = false; - description = "Opens telnet console interface on localhost port 5582"; + description = lib.mdDoc "Opens telnet console interface on localhost port 5582"; }; # HTTP modules bosh = mkOption { type = types.bool; default = false; - description = "Enable BOSH clients, aka 'Jabber over HTTP'"; + description = lib.mdDoc "Enable BOSH clients, aka 'Jabber over HTTP'"; }; websocket = mkOption { type = types.bool; default = false; - description = "Enable WebSocket support"; + description = lib.mdDoc "Enable WebSocket support"; }; # Other specific functionality limits = mkOption { type = types.bool; default = false; - description = "Enable bandwidth limiting for XMPP connections"; + description = lib.mdDoc "Enable bandwidth limiting for XMPP connections"; }; groups = mkOption { type = types.bool; default = false; - description = "Shared roster support"; + description = lib.mdDoc "Shared roster support"; }; server_contact_info = mkOption { type = types.bool; default = false; - description = "Publish contact information for this service"; + description = lib.mdDoc "Publish contact information for this service"; }; announce = mkOption { type = types.bool; default = false; - description = "Send announcement to all online users"; + description = lib.mdDoc "Send announcement to all online users"; }; welcome = mkOption { type = types.bool; default = false; - description = "Welcome users who register accounts"; + description = lib.mdDoc "Welcome users who register accounts"; }; watchregistrations = mkOption { type = types.bool; default = false; - description = "Alert admins of registrations"; + description = lib.mdDoc "Alert admins of registrations"; }; motd = mkOption { type = types.bool; default = false; - description = "Send a message to users when they log in"; + description = lib.mdDoc "Send a message to users when they log in"; }; legacyauth = mkOption { type = types.bool; default = false; - description = "Legacy authentication. Only used by some old clients and bots"; + description = lib.mdDoc "Legacy authentication. Only used by some old clients and bots"; }; }; @@ -279,27 +279,27 @@ let options = { domain = mkOption { type = types.str; - description = "Domain name of the MUC"; + description = lib.mdDoc "Domain name of the MUC"; }; name = mkOption { type = types.str; - description = "The name to return in service discovery responses for the MUC service itself"; + description = lib.mdDoc "The name to return in service discovery responses for the MUC service itself"; default = "Prosody Chatrooms"; }; restrictRoomCreation = mkOption { type = types.enum [ true false "admin" "local" ]; default = false; - description = "Restrict room creation to server admins"; + description = lib.mdDoc "Restrict room creation to server admins"; }; maxHistoryMessages = mkOption { type = types.int; default = 20; - description = "Specifies a limit on what each room can be configured to keep"; + description = lib.mdDoc "Specifies a limit on what each room can be configured to keep"; }; roomLocking = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Enables room locking, which means that a room must be configured before it can be used. Locked rooms are invisible and cannot be entered by anyone but the creator @@ -308,7 +308,7 @@ let roomLockTimeout = mkOption { type = types.int; default = 300; - description = '' + description = lib.mdDoc '' Timout after which the room is destroyed or unlocked if not configured, in seconds ''; @@ -316,7 +316,7 @@ let tombstones = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' When a room is destroyed, it leaves behind a tombstone which prevents the room being entered or recreated. It also allows anyone who was not in the room at the time it was destroyed @@ -329,7 +329,7 @@ let tombstoneExpiry = mkOption { type = types.int; default = 2678400; - description = '' + description = lib.mdDoc '' This settings controls how long a tombstone is considered valid. It defaults to 31 days. After this time, the room in question can be created again. @@ -339,7 +339,7 @@ let vcard_muc = mkOption { type = types.bool; default = true; - description = "Adds the ability to set vCard for Multi User Chat rooms"; + description = lib.mdDoc "Adds the ability to set vCard for Multi User Chat rooms"; }; # Extra parameters. Defaulting to prosody default values. @@ -350,42 +350,42 @@ let roomDefaultPublic = mkOption { type = types.bool; default = true; - description = "If set, the MUC rooms will be public by default."; + description = lib.mdDoc "If set, the MUC rooms will be public by default."; }; roomDefaultMembersOnly = mkOption { type = types.bool; default = false; - description = "If set, the MUC rooms will only be accessible to the members by default."; + description = lib.mdDoc "If set, the MUC rooms will only be accessible to the members by default."; }; roomDefaultModerated = mkOption { type = types.bool; default = false; - description = "If set, the MUC rooms will be moderated by default."; + description = lib.mdDoc "If set, the MUC rooms will be moderated by default."; }; roomDefaultPublicJids = mkOption { type = types.bool; default = false; - description = "If set, the MUC rooms will display the public JIDs by default."; + description = lib.mdDoc "If set, the MUC rooms will display the public JIDs by default."; }; roomDefaultChangeSubject = mkOption { type = types.bool; default = false; - description = "If set, the rooms will display the public JIDs by default."; + description = lib.mdDoc "If set, the rooms will display the public JIDs by default."; }; roomDefaultHistoryLength = mkOption { type = types.int; default = 20; - description = "Number of history message sent to participants by default."; + description = lib.mdDoc "Number of history message sent to participants by default."; }; roomDefaultLanguage = mkOption { type = types.str; default = "en"; - description = "Default room language."; + description = lib.mdDoc "Default room language."; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Additional MUC specific configuration"; + description = lib.mdDoc "Additional MUC specific configuration"; }; }; }; @@ -394,30 +394,30 @@ let options = { domain = mkOption { type = types.nullOr types.str; - description = "Domain name for the http-upload service"; + description = lib.mdDoc "Domain name for the http-upload service"; }; uploadFileSizeLimit = mkOption { type = types.str; default = "50 * 1024 * 1024"; - description = "Maximum file size, in bytes. Defaults to 50MB."; + description = lib.mdDoc "Maximum file size, in bytes. Defaults to 50MB."; }; uploadExpireAfter = mkOption { type = types.str; default = "60 * 60 * 24 * 7"; - description = "Max age of a file before it gets deleted, in seconds."; + description = lib.mdDoc "Max age of a file before it gets deleted, in seconds."; }; userQuota = mkOption { type = types.nullOr types.int; default = null; example = 1234; - description = '' + description = lib.mdDoc '' Maximum size of all uploaded files per user, in bytes. There will be no quota if this option is set to null. ''; }; httpUploadPath = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Directory where the uploaded files will be stored. By default, uploaded files are put in a sub-directory of the default Prosody storage path (usually /var/lib/prosody). @@ -434,25 +434,25 @@ let # TODO: require attribute domain = mkOption { type = types.str; - description = "Domain name"; + description = lib.mdDoc "Domain name"; }; enabled = mkOption { type = types.bool; default = false; - description = "Whether to enable the virtual host"; + description = lib.mdDoc "Whether to enable the virtual host"; }; ssl = mkOption { type = types.nullOr (types.submodule sslOpts); default = null; - description = "Paths to SSL files"; + description = lib.mdDoc "Paths to SSL files"; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Additional virtual host specific configuration"; + description = lib.mdDoc "Additional virtual host specific configuration"; }; }; @@ -472,13 +472,13 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the prosody server"; + description = lib.mdDoc "Whether to enable the prosody server"; }; xmppComplianceSuite = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' The XEP-0423 defines a set of recommended XEPs to implement for a server. It's generally a good idea to implement this set of extensions if you want to provide your users with a @@ -498,7 +498,7 @@ in package = mkOption { type = types.package; - description = "Prosody package to use"; + description = lib.mdDoc "Prosody package to use"; default = pkgs.prosody; defaultText = literalExpression "pkgs.prosody"; example = literalExpression '' @@ -512,7 +512,7 @@ in dataDir = mkOption { type = types.path; default = "/var/lib/prosody"; - description = '' + description = lib.mdDoc '' The prosody home directory used to store all data. If left as the default value this directory will automatically be created before the prosody server starts, otherwise you are responsible for ensuring the directory exists with appropriate ownership @@ -523,7 +523,7 @@ in disco_items = mkOption { type = types.listOf (types.submodule discoOpts); default = []; - description = "List of discoverable items you want to advertise."; + description = lib.mdDoc "List of discoverable items you want to advertise."; }; user = mkOption { @@ -557,38 +557,38 @@ in allowRegistration = mkOption { type = types.bool; default = false; - description = "Allow account creation"; + description = lib.mdDoc "Allow account creation"; }; # HTTP server-related options httpPorts = mkOption { type = types.listOf types.int; - description = "Listening HTTP ports list for this service."; + description = lib.mdDoc "Listening HTTP ports list for this service."; default = [ 5280 ]; }; httpInterfaces = mkOption { type = types.listOf types.str; default = [ "*" "::" ]; - description = "Interfaces on which the HTTP server will listen on."; + description = lib.mdDoc "Interfaces on which the HTTP server will listen on."; }; httpsPorts = mkOption { type = types.listOf types.int; - description = "Listening HTTPS ports list for this service."; + description = lib.mdDoc "Listening HTTPS ports list for this service."; default = [ 5281 ]; }; httpsInterfaces = mkOption { type = types.listOf types.str; default = [ "*" "::" ]; - description = "Interfaces on which the HTTPS server will listen on."; + description = lib.mdDoc "Interfaces on which the HTTPS server will listen on."; }; c2sRequireEncryption = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Force clients to use encrypted connections? This option will prevent clients from authenticating unless they are using encryption. ''; @@ -597,7 +597,7 @@ in s2sRequireEncryption = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Force servers to use encrypted connections? This option will prevent servers from authenticating unless they are using encryption. Note that this is different from authentication. @@ -607,7 +607,7 @@ in s2sSecureAuth = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Force certificate authentication for server-to-server connections? This provides ideal security, but requires servers you communicate with to support encryption AND present valid, trusted certificates. @@ -619,7 +619,7 @@ in type = types.listOf types.str; default = []; example = [ "insecure.example.com" ]; - description = '' + description = lib.mdDoc '' Some servers have invalid or self-signed certificates. You can list remote domains here that will not be required to authenticate using certificates. They will be authenticated using DNS instead, even @@ -631,7 +631,7 @@ in type = types.listOf types.str; default = []; example = [ "jabber.org" ]; - description = '' + description = lib.mdDoc '' Even if you leave s2s_secure_auth disabled, you can still require valid certificates for some domains by specifying a list here. ''; @@ -643,17 +643,17 @@ in extraModules = mkOption { type = types.listOf types.str; default = []; - description = "Enable custom modules"; + description = lib.mdDoc "Enable custom modules"; }; extraPluginPaths = mkOption { type = types.listOf types.path; default = []; - description = "Addtional path in which to look find plugins/modules"; + description = lib.mdDoc "Addtional path in which to look find plugins/modules"; }; uploadHttp = mkOption { - description = '' + description = lib.mdDoc '' Configures the Prosody builtin HTTP server to handle user uploads. ''; type = types.nullOr (types.submodule uploadHttpOpts); @@ -669,12 +669,12 @@ in example = [ { domain = "conference.my-xmpp-example-host.org"; } ]; - description = "Multi User Chat (MUC) configuration"; + description = lib.mdDoc "Multi User Chat (MUC) configuration"; }; virtualHosts = mkOption { - description = "Define the virtual hosts"; + description = lib.mdDoc "Define the virtual hosts"; type = with types; attrsOf (submodule vHostOpts); @@ -697,27 +697,27 @@ in ssl = mkOption { type = types.nullOr (types.submodule sslOpts); default = null; - description = "Paths to SSL files"; + description = lib.mdDoc "Paths to SSL files"; }; admins = mkOption { type = types.listOf types.str; default = []; example = [ "admin1@example.com" "admin2@example.com" ]; - description = "List of administrators of the current host"; + description = lib.mdDoc "List of administrators of the current host"; }; authentication = mkOption { type = types.enum [ "internal_plain" "internal_hashed" "cyrus" "anonymous" ]; default = "internal_hashed"; example = "internal_plain"; - description = "Authentication mechanism used for logins."; + description = lib.mdDoc "Authentication mechanism used for logins."; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Additional prosody configuration"; + description = lib.mdDoc "Additional prosody configuration"; }; }; diff --git a/nixos/modules/services/networking/quassel.nix b/nixos/modules/services/networking/quassel.nix index 844c9a6b8b352..a4b203ea00184 100644 --- a/nixos/modules/services/networking/quassel.nix +++ b/nixos/modules/services/networking/quassel.nix @@ -22,7 +22,7 @@ in certificateFile = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Path to the certificate used for SSL connections with clients. ''; }; @@ -30,7 +30,7 @@ in requireSSL = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Require SSL for connections from clients. ''; }; @@ -39,7 +39,7 @@ in type = types.package; default = pkgs.quasselDaemon; defaultText = literalExpression "pkgs.quasselDaemon"; - description = '' + description = lib.mdDoc '' The package of the quassel daemon. ''; }; @@ -57,7 +57,7 @@ in portNumber = mkOption { type = types.port; default = 4242; - description = '' + description = lib.mdDoc '' The port number the Quassel daemon will be listening to. ''; }; @@ -68,7 +68,7 @@ in "/home/''${config.${opt.user}}/.config/quassel-irc.org" ''; type = types.str; - description = '' + description = lib.mdDoc '' The directory holding configuration files, the SQlite database and the SSL Cert. ''; }; @@ -76,7 +76,7 @@ in user = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The existing user the Quassel daemon should run as. If left empty, a default "quassel" user will be created. ''; }; diff --git a/nixos/modules/services/networking/quicktun.nix b/nixos/modules/services/networking/quicktun.nix index 438e67d5ebb65..e2282b9aaf7c3 100644 --- a/nixos/modules/services/networking/quicktun.nix +++ b/nixos/modules/services/networking/quicktun.nix @@ -13,7 +13,7 @@ with lib; services.quicktun = mkOption { default = { }; - description = "QuickTun tunnels"; + description = lib.mdDoc "QuickTun tunnels"; type = types.attrsOf (types.submodule { options = { tunMode = mkOption { diff --git a/nixos/modules/services/networking/quorum.nix b/nixos/modules/services/networking/quorum.nix index bddcd18c7fbe1..67027ae3f8573 100644 --- a/nixos/modules/services/networking/quorum.nix +++ b/nixos/modules/services/networking/quorum.nix @@ -18,82 +18,82 @@ in { user = mkOption { type = types.str; default = "quorum"; - description = "The user as which to run quorum."; + description = lib.mdDoc "The user as which to run quorum."; }; group = mkOption { type = types.str; default = cfg.user; defaultText = literalExpression "config.${opt.user}"; - description = "The group as which to run quorum."; + description = lib.mdDoc "The group as which to run quorum."; }; port = mkOption { type = types.port; default = 21000; - description = "Override the default port on which to listen for connections."; + description = lib.mdDoc "Override the default port on which to listen for connections."; }; nodekeyFile = mkOption { type = types.path; default = "${dataDir}/nodekey"; - description = "Path to the nodekey."; + description = lib.mdDoc "Path to the nodekey."; }; staticNodes = mkOption { type = types.listOf types.str; default = []; example = [ "enode://dd333ec28f0a8910c92eb4d336461eea1c20803eed9cf2c056557f986e720f8e693605bba2f4e8f289b1162e5ac7c80c914c7178130711e393ca76abc1d92f57@0.0.0.0:30303?discport=0" ]; - description = "List of validator nodes."; + description = lib.mdDoc "List of validator nodes."; }; privateconfig = mkOption { type = types.str; default = "ignore"; - description = "Configuration of privacy transaction manager."; + description = lib.mdDoc "Configuration of privacy transaction manager."; }; syncmode = mkOption { type = types.enum [ "fast" "full" "light" ]; default = "full"; - description = "Blockchain sync mode."; + description = lib.mdDoc "Blockchain sync mode."; }; blockperiod = mkOption { type = types.int; default = 5; - description = "Default minimum difference between two consecutive block's timestamps in seconds."; + description = lib.mdDoc "Default minimum difference between two consecutive block's timestamps in seconds."; }; permissioned = mkOption { type = types.bool; default = true; - description = "Allow only a defined list of nodes to connect."; + description = lib.mdDoc "Allow only a defined list of nodes to connect."; }; rpc = { enable = mkOption { type = types.bool; default = true; - description = "Enable RPC interface."; + description = lib.mdDoc "Enable RPC interface."; }; address = mkOption { type = types.str; default = "0.0.0.0"; - description = "Listening address for RPC connections."; + description = lib.mdDoc "Listening address for RPC connections."; }; port = mkOption { type = types.port; default = 22004; - description = "Override the default port on which to listen for RPC connections."; + description = lib.mdDoc "Override the default port on which to listen for RPC connections."; }; api = mkOption { type = types.str; default = "admin,db,eth,debug,miner,net,shh,txpool,personal,web3,quorum,istanbul"; - description = "API's offered over the HTTP-RPC interface."; + description = lib.mdDoc "API's offered over the HTTP-RPC interface."; }; }; @@ -101,31 +101,31 @@ in { enable = mkOption { type = types.bool; default = true; - description = "Enable WS-RPC interface."; + description = lib.mdDoc "Enable WS-RPC interface."; }; address = mkOption { type = types.str; default = "0.0.0.0"; - description = "Listening address for WS-RPC connections."; + description = lib.mdDoc "Listening address for WS-RPC connections."; }; port = mkOption { type = types.port; default = 8546; - description = "Override the default port on which to listen for WS-RPC connections."; + description = lib.mdDoc "Override the default port on which to listen for WS-RPC connections."; }; api = mkOption { type = types.str; default = "admin,db,eth,debug,miner,net,shh,txpool,personal,web3,quorum,istanbul"; - description = "API's offered over the WS-RPC interface."; + description = lib.mdDoc "API's offered over the WS-RPC interface."; }; origins = mkOption { type = types.str; default = "*"; - description = "Origins from which to accept websockets requests"; + description = lib.mdDoc "Origins from which to accept websockets requests"; }; }; @@ -160,7 +160,7 @@ in { parentHash = "0x0000000000000000000000000000000000000000000000000000000000000000"; timestamp = "0x00"; }''; - description = "Blockchain genesis settings."; + description = lib.mdDoc "Blockchain genesis settings."; }; }; }; diff --git a/nixos/modules/services/networking/r53-ddns.nix b/nixos/modules/services/networking/r53-ddns.nix index a8839762d530d..77738c755313b 100644 --- a/nixos/modules/services/networking/r53-ddns.nix +++ b/nixos/modules/services/networking/r53-ddns.nix @@ -15,22 +15,22 @@ in interval = mkOption { type = types.str; default = "15min"; - description = "How often to update the entry"; + description = lib.mdDoc "How often to update the entry"; }; zoneID = mkOption { type = types.str; - description = "The ID of your zone in Route53"; + description = lib.mdDoc "The ID of your zone in Route53"; }; domain = mkOption { type = types.str; - description = "The name of your domain in Route53"; + description = lib.mdDoc "The name of your domain in Route53"; }; hostname = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Manually specify the hostname. Otherwise the tool will try to use the name returned by the OS (Call to gethostname) ''; @@ -38,7 +38,7 @@ in environmentFile = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' File containing the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY in the format of an EnvironmentFile as described by systemd.exec(5) ''; diff --git a/nixos/modules/services/networking/radicale.nix b/nixos/modules/services/networking/radicale.nix index 227bafc1d0e8c..687cf206e1450 100644 --- a/nixos/modules/services/networking/radicale.nix +++ b/nixos/modules/services/networking/radicale.nix @@ -28,7 +28,7 @@ in { enable = mkEnableOption "Radicale CalDAV and CardDAV server"; package = mkOption { - description = "Radicale package to use."; + description = lib.mdDoc "Radicale package to use."; # Default cannot be pkgs.radicale because non-null values suppress # warnings about incompatible configuration and storage formats. type = with types; nullOr package // { inherit (package) description; }; @@ -39,21 +39,21 @@ in { config = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Radicale configuration, this will set the service configuration file. - This option is mutually exclusive with <option>settings</option>. - This option is deprecated. Use <option>settings</option> instead. + This option is mutually exclusive with {option}`settings`. + This option is deprecated. Use {option}`settings` instead. ''; }; settings = mkOption { type = format.type; default = { }; - description = '' + description = lib.mdDoc '' Configuration for Radicale. See - <link xlink:href="https://radicale.org/3.0.html#documentation/configuration" />. - This option is mutually exclusive with <option>config</option>. + <https://radicale.org/3.0.html#documentation/configuration>. + This option is mutually exclusive with {option}`config`. ''; example = literalExpression '' server = { @@ -72,12 +72,12 @@ in { rights = mkOption { type = format.type; - description = '' + description = lib.mdDoc '' Configuration for Radicale's rights file. See - <link xlink:href="https://radicale.org/3.0.html#documentation/authentication-and-rights" />. - This option only works in conjunction with <option>settings</option>. - Setting this will also set <option>settings.rights.type</option> and - <option>settings.rights.file</option> to approriate values. + <https://radicale.org/3.0.html#documentation/authentication-and-rights>. + This option only works in conjunction with {option}`settings`. + Setting this will also set {option}`settings.rights.type` and + {option}`settings.rights.file` to approriate values. ''; default = { }; example = literalExpression '' @@ -102,7 +102,7 @@ in { extraArgs = mkOption { type = types.listOf types.str; default = []; - description = "Extra arguments passed to the Radicale daemon."; + description = lib.mdDoc "Extra arguments passed to the Radicale daemon."; }; }; diff --git a/nixos/modules/services/networking/radvd.nix b/nixos/modules/services/networking/radvd.nix index fb3eb71a8ce19..72590eda4ee68 100644 --- a/nixos/modules/services/networking/radvd.nix +++ b/nixos/modules/services/networking/radvd.nix @@ -22,9 +22,9 @@ in type = types.bool; default = false; description = - '' + lib.mdDoc '' Whether to enable the Router Advertisement Daemon - (<command>radvd</command>), which provides link-local + ({command}`radvd`), which provides link-local advertisements of IPv6 router addresses and prefixes using the Neighbor Discovery Protocol (NDP). This enables stateless address autoconfiguration in IPv6 clients on the @@ -36,7 +36,7 @@ in type = types.package; default = pkgs.radvd; defaultText = literalExpression "pkgs.radvd"; - description = '' + description = lib.mdDoc '' The RADVD package to use for the RADVD service. ''; }; @@ -51,7 +51,7 @@ in }; ''; description = - '' + lib.mdDoc '' The contents of the radvd configuration file. ''; }; diff --git a/nixos/modules/services/networking/rdnssd.nix b/nixos/modules/services/networking/rdnssd.nix index fd04bb8108f0c..c63356e734683 100644 --- a/nixos/modules/services/networking/rdnssd.nix +++ b/nixos/modules/services/networking/rdnssd.nix @@ -21,10 +21,10 @@ in default = false; #default = config.networking.enableIPv6; description = - '' + lib.mdDoc '' Whether to enable the RDNSS daemon - (<command>rdnssd</command>), which configures DNS servers in - <filename>/etc/resolv.conf</filename> from RDNSS + ({command}`rdnssd`), which configures DNS servers in + {file}`/etc/resolv.conf` from RDNSS advertisements sent by IPv6 routers. ''; }; diff --git a/nixos/modules/services/networking/redsocks.nix b/nixos/modules/services/networking/redsocks.nix index 8481f9debf39c..5aa9f003bad5f 100644 --- a/nixos/modules/services/networking/redsocks.nix +++ b/nixos/modules/services/networking/redsocks.nix @@ -11,19 +11,19 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable redsocks."; + description = lib.mdDoc "Whether to enable redsocks."; }; log_debug = mkOption { type = types.bool; default = false; - description = "Log connection progress."; + description = lib.mdDoc "Log connection progress."; }; log_info = mkOption { type = types.bool; default = false; - description = "Log start and end of client sessions."; + description = lib.mdDoc "Log start and end of client sessions."; }; log = mkOption { @@ -45,7 +45,7 @@ in type = with types; nullOr str; default = null; description = - '' + lib.mdDoc '' Chroot under which to run redsocks. Log file is opened before chroot, but if logging to syslog /etc/localtime may be required. ''; @@ -53,7 +53,7 @@ in redsocks = mkOption { description = - '' + lib.mdDoc '' Local port to proxy associations to be performed. The example shows how to configure a proxy to handle port 80 as HTTP @@ -74,7 +74,7 @@ in type = types.str; default = "127.0.0.1"; description = - '' + lib.mdDoc '' IP on which redsocks should listen. Defaults to 127.0.0.1 for security reasons. ''; @@ -83,13 +83,13 @@ in port = mkOption { type = types.int; default = 12345; - description = "Port on which redsocks should listen."; + description = lib.mdDoc "Port on which redsocks should listen."; }; proxy = mkOption { type = types.str; description = - '' + lib.mdDoc '' Proxy through which redsocks should forward incoming traffic. Example: "example.org:8080" ''; @@ -97,20 +97,20 @@ in type = mkOption { type = types.enum [ "socks4" "socks5" "http-connect" "http-relay" ]; - description = "Type of proxy."; + description = lib.mdDoc "Type of proxy."; }; login = mkOption { type = with types; nullOr str; default = null; - description = "Login to send to proxy."; + description = lib.mdDoc "Login to send to proxy."; }; password = mkOption { type = with types; nullOr str; default = null; description = - '' + lib.mdDoc '' Password to send to proxy. WARNING, this will end up world-readable in the store! Awaiting https://github.com/NixOS/nix/issues/8 to be able to fix. @@ -135,14 +135,14 @@ in redirectInternetOnly = mkOption { type = types.bool; default = true; - description = "Exclude all non-globally-routable IPs from redsocks"; + description = lib.mdDoc "Exclude all non-globally-routable IPs from redsocks"; }; doNotRedirect = mkOption { type = with types; listOf str; default = []; description = - '' + lib.mdDoc '' Iptables filters that if matched will get the packet off of redsocks. ''; @@ -153,7 +153,7 @@ in type = with types; either bool str; default = false; description = - '' + lib.mdDoc '' Conditions to make outbound packets go through this redsocks instance. diff --git a/nixos/modules/services/networking/resilio.nix b/nixos/modules/services/networking/resilio.nix index 891278506417d..05798a2c83eea 100644 --- a/nixos/modules/services/networking/resilio.nix +++ b/nixos/modules/services/networking/resilio.nix @@ -47,7 +47,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If enabled, start the Resilio Sync daemon. Once enabled, you can interact with the service through the Web UI, or configure it in your NixOS configuration. @@ -59,7 +59,7 @@ in example = "Voltron"; default = config.networking.hostName; defaultText = literalExpression "config.networking.hostName"; - description = '' + description = lib.mdDoc '' Name of the Resilio Sync device. ''; }; @@ -68,7 +68,7 @@ in type = types.int; default = 0; example = 44444; - description = '' + description = lib.mdDoc '' Listening port. Defaults to 0 which randomizes the port. ''; }; @@ -76,7 +76,7 @@ in checkForUpdates = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Determines whether to check for updates and alert the user about them in the UI. ''; @@ -85,7 +85,7 @@ in useUpnp = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Use Universal Plug-n-Play (UPnP) ''; }; @@ -94,7 +94,7 @@ in type = types.int; default = 0; example = 1024; - description = '' + description = lib.mdDoc '' Download speed limit. 0 is unlimited (default). ''; }; @@ -103,7 +103,7 @@ in type = types.int; default = 0; example = 1024; - description = '' + description = lib.mdDoc '' Upload speed limit. 0 is unlimited (default). ''; }; @@ -112,7 +112,7 @@ in type = types.str; default = "[::1]"; example = "0.0.0.0"; - description = '' + description = lib.mdDoc '' HTTP address to bind to. ''; }; @@ -120,7 +120,7 @@ in httpListenPort = mkOption { type = types.int; default = 9000; - description = '' + description = lib.mdDoc '' HTTP port to bind on. ''; }; @@ -129,7 +129,7 @@ in type = types.str; example = "allyourbase"; default = ""; - description = '' + description = lib.mdDoc '' HTTP web login username. ''; }; @@ -138,7 +138,7 @@ in type = types.str; example = "arebelongtous"; default = ""; - description = '' + description = lib.mdDoc '' HTTP web login password. ''; }; @@ -146,23 +146,23 @@ in encryptLAN = mkOption { type = types.bool; default = true; - description = "Encrypt LAN data."; + description = lib.mdDoc "Encrypt LAN data."; }; enableWebUI = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable Web UI for administration. Bound to the specified - <literal>httpListenAddress</literal> and - <literal>httpListenPort</literal>. + `httpListenAddress` and + `httpListenPort`. ''; }; storagePath = mkOption { type = types.path; default = "/var/lib/resilio-sync/"; - description = '' + description = lib.mdDoc '' Where BitTorrent Sync will store it's database files (containing things like username info and licenses). Generally, you should not need to ever change this. @@ -172,14 +172,14 @@ in apiKey = mkOption { type = types.str; default = ""; - description = "API key, which enables the developer API."; + description = lib.mdDoc "API key, which enables the developer API."; }; directoryRoot = mkOption { type = types.str; default = ""; example = "/media"; - description = "Default directory to add folders in the web UI."; + description = lib.mdDoc "Default directory to add folders in the web UI."; }; sharedFolders = mkOption { diff --git a/nixos/modules/services/networking/robustirc-bridge.nix b/nixos/modules/services/networking/robustirc-bridge.nix index 255af79ec04b2..c5afbaf8ea189 100644 --- a/nixos/modules/services/networking/robustirc-bridge.nix +++ b/nixos/modules/services/networking/robustirc-bridge.nix @@ -13,7 +13,7 @@ in extraFlags = mkOption { type = types.listOf types.str; default = []; - description = ''Extra flags passed to the <command>robustirc-bridge</command> command. See <link xlink:href="https://robustirc.net/docs/adminguide.html#_bridge">RobustIRC Documentation</link> or robustirc-bridge(1) for details.''; + description = lib.mdDoc ''Extra flags passed to the {command}`robustirc-bridge` command. See [RobustIRC Documentation](https://robustirc.net/docs/adminguide.html#_bridge) or robustirc-bridge(1) for details.''; example = [ "-network robustirc.net" ]; diff --git a/nixos/modules/services/networking/routedns.nix b/nixos/modules/services/networking/routedns.nix index e0f5eedd2c8e5..6f3d769e8644b 100644 --- a/nixos/modules/services/networking/routedns.nix +++ b/nixos/modules/services/networking/routedns.nix @@ -38,8 +38,8 @@ in }; } ''; - description = '' - Configuration for RouteDNS, see <link xlink:href="https://github.com/folbricht/routedns/blob/master/doc/configuration.md"/> + description = lib.mdDoc '' + Configuration for RouteDNS, see <https://github.com/folbricht/routedns/blob/master/doc/configuration.md> for more information. ''; }; @@ -49,14 +49,14 @@ in defaultText = "A RouteDNS configuration file automatically generated by values from services.routedns.*"; type = types.path; example = literalExpression ''"''${pkgs.routedns}/cmd/routedns/example-config/use-case-1.toml"''; - description = "Path to RouteDNS TOML configuration file."; + description = lib.mdDoc "Path to RouteDNS TOML configuration file."; }; package = mkOption { default = pkgs.routedns; defaultText = literalExpression "pkgs.routedns"; type = types.package; - description = "RouteDNS package to use."; + description = lib.mdDoc "RouteDNS package to use."; }; }; diff --git a/nixos/modules/services/networking/sabnzbd.nix b/nixos/modules/services/networking/sabnzbd.nix index 54eeba1a9ec17..18e1d9f48b25a 100644 --- a/nixos/modules/services/networking/sabnzbd.nix +++ b/nixos/modules/services/networking/sabnzbd.nix @@ -21,25 +21,25 @@ in type = types.package; default = pkgs.sabnzbd; defaultText = "pkgs.sabnzbd"; - description = "The sabnzbd executable package run by the service."; + description = lib.mdDoc "The sabnzbd executable package run by the service."; }; configFile = mkOption { type = types.path; default = "/var/lib/sabnzbd/sabnzbd.ini"; - description = "Path to config file."; + description = lib.mdDoc "Path to config file."; }; user = mkOption { default = "sabnzbd"; type = types.str; - description = "User to run the service as"; + description = lib.mdDoc "User to run the service as"; }; group = mkOption { type = types.str; default = "sabnzbd"; - description = "Group to run the service as"; + description = lib.mdDoc "Group to run the service as"; }; }; }; diff --git a/nixos/modules/services/networking/seafile.nix b/nixos/modules/services/networking/seafile.nix index 16cea1cfbbfae..7cda71458dd1b 100644 --- a/nixos/modules/services/networking/seafile.nix +++ b/nixos/modules/services/networking/seafile.nix @@ -48,7 +48,7 @@ in { SERVICE_URL = mkOption { type = types.str; example = "https://www.example.com"; - description = '' + description = lib.mdDoc '' Seahub public URL. ''; }; @@ -56,9 +56,9 @@ in { }; }; default = { }; - description = '' + description = lib.mdDoc '' Configuration for ccnet, see - <link xlink:href="https://manual.seafile.com/config/ccnet-conf/"/> + <https://manual.seafile.com/config/ccnet-conf/> for supported values. ''; }; @@ -72,7 +72,7 @@ in { port = mkOption { type = types.port; default = 8082; - description = '' + description = lib.mdDoc '' The tcp port used by seafile fileserver. ''; }; @@ -80,7 +80,7 @@ in { type = types.str; default = "127.0.0.1"; example = "0.0.0.0"; - description = '' + description = lib.mdDoc '' The binding address used by seafile fileserver. ''; }; @@ -88,9 +88,9 @@ in { }; }; default = { }; - description = '' + description = lib.mdDoc '' Configuration for seafile-server, see - <link xlink:href="https://manual.seafile.com/config/seafile-conf/"/> + <https://manual.seafile.com/config/seafile-conf/> for supported values. ''; }; @@ -99,7 +99,7 @@ in { type = types.int; default = 4; example = 10; - description = '' + description = lib.mdDoc '' The number of gunicorn worker processes for handling requests. ''; }; @@ -107,7 +107,7 @@ in { adminEmail = mkOption { example = "john@example.com"; type = types.str; - description = '' + description = lib.mdDoc '' Seafile Seahub Admin Account Email. ''; }; @@ -115,7 +115,7 @@ in { initialAdminPassword = mkOption { example = "someStrongPass"; type = types.str; - description = '' + description = lib.mdDoc '' Seafile Seahub Admin Account initial password. Should be change via Seahub web front-end. ''; @@ -123,7 +123,7 @@ in { seafilePackage = mkOption { type = types.package; - description = "Which package to use for the seafile server."; + description = lib.mdDoc "Which package to use for the seafile server."; default = pkgs.seafile-server; defaultText = literalExpression "pkgs.seafile-server"; }; diff --git a/nixos/modules/services/networking/searx.nix b/nixos/modules/services/networking/searx.nix index 10dc27da70098..238479864f880 100644 --- a/nixos/modules/services/networking/searx.nix +++ b/nixos/modules/services/networking/searx.nix @@ -51,14 +51,14 @@ in type = types.bool; default = false; relatedPackages = [ "searx" ]; - description = "Whether to enable Searx, the meta search engine."; + description = lib.mdDoc "Whether to enable Searx, the meta search engine."; }; environmentFile = mkOption { type = types.nullOr types.path; default = null; - description = '' - Environment file (see <literal>systemd.exec(5)</literal> + description = lib.mdDoc '' + Environment file (see `systemd.exec(5)` "EnvironmentFile=" section for the syntax) to define variables for Searx. This option can be used to safely include secret keys into the Searx configuration. @@ -117,7 +117,7 @@ in type = types.package; default = pkgs.searx; defaultText = literalExpression "pkgs.searx"; - description = "searx package to use."; + description = lib.mdDoc "searx package to use."; }; runInUwsgi = mkOption { @@ -146,7 +146,7 @@ in chmod-socket = "660"; # allow the searx group to read/write to the socket } ''; - description = '' + description = lib.mdDoc '' Additional configuration of the uWSGI vassal running searx. It should notably specify on which interfaces and ports the vassal should listen. diff --git a/nixos/modules/services/networking/shadowsocks.nix b/nixos/modules/services/networking/shadowsocks.nix index 7bea269a9ed0b..8eee40711a6d2 100644 --- a/nixos/modules/services/networking/shadowsocks.nix +++ b/nixos/modules/services/networking/shadowsocks.nix @@ -34,7 +34,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to run shadowsocks-libev shadowsocks server. ''; }; @@ -42,7 +42,7 @@ in localAddress = mkOption { type = types.coercedTo types.str singleton (types.listOf types.str); default = [ "[::0]" "0.0.0.0" ]; - description = '' + description = lib.mdDoc '' Local addresses to which the server binds. ''; }; @@ -50,7 +50,7 @@ in port = mkOption { type = types.int; default = 8388; - description = '' + description = lib.mdDoc '' Port which the server uses. ''; }; @@ -58,7 +58,7 @@ in password = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Password for connecting clients. ''; }; @@ -66,7 +66,7 @@ in passwordFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Password file with a password for connecting clients. ''; }; @@ -74,7 +74,7 @@ in mode = mkOption { type = types.enum [ "tcp_only" "tcp_and_udp" "udp_only" ]; default = "tcp_and_udp"; - description = '' + description = lib.mdDoc '' Relay protocols. ''; }; @@ -82,7 +82,7 @@ in fastOpen = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' use TCP fast-open ''; }; @@ -90,8 +90,8 @@ in encryptionMethod = mkOption { type = types.str; default = "chacha20-ietf-poly1305"; - description = '' - Encryption method. See <link xlink:href="https://github.com/shadowsocks/shadowsocks-org/wiki/AEAD-Ciphers"/>. + description = lib.mdDoc '' + Encryption method. See <https://github.com/shadowsocks/shadowsocks-org/wiki/AEAD-Ciphers>. ''; }; @@ -99,7 +99,7 @@ in type = types.nullOr types.str; default = null; example = literalExpression ''"''${pkgs.shadowsocks-v2ray-plugin}/bin/v2ray-plugin"''; - description = '' + description = lib.mdDoc '' SIP003 plugin for shadowsocks ''; }; @@ -108,7 +108,7 @@ in type = types.str; default = ""; example = "server;host=example.com"; - description = '' + description = lib.mdDoc '' Options to pass to the plugin if one was specified ''; }; @@ -119,13 +119,13 @@ in example = { nameserver = "8.8.8.8"; }; - description = '' + description = lib.mdDoc '' Additional configuration for shadowsocks that is not covered by the provided options. The provided attrset will be serialized to JSON and has to contain valid shadowsocks options. Unfortunately most additional options are undocumented but it's easy to find out what is available by looking into the source code of - <link xlink:href="https://github.com/shadowsocks/shadowsocks-libev/blob/master/src/jconf.c"/> + <https://github.com/shadowsocks/shadowsocks-libev/blob/master/src/jconf.c> ''; }; }; diff --git a/nixos/modules/services/networking/shairport-sync.nix b/nixos/modules/services/networking/shairport-sync.nix index eb61663e4d922..75684eea3ad18 100644 --- a/nixos/modules/services/networking/shairport-sync.nix +++ b/nixos/modules/services/networking/shairport-sync.nix @@ -19,7 +19,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the shairport-sync daemon. Running with a local system-wide or remote pulseaudio server @@ -30,7 +30,7 @@ in arguments = mkOption { type = types.str; default = "-v -o pa"; - description = '' + description = lib.mdDoc '' Arguments to pass to the daemon. Defaults to a local pulseaudio server. ''; @@ -39,7 +39,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to automatically open ports in the firewall. ''; }; @@ -47,7 +47,7 @@ in user = mkOption { type = types.str; default = "shairport"; - description = '' + description = lib.mdDoc '' User account name under which to run shairport-sync. The account will be created. ''; @@ -56,7 +56,7 @@ in group = mkOption { type = types.str; default = "shairport"; - description = '' + description = lib.mdDoc '' Group account name under which to run shairport-sync. The account will be created. ''; diff --git a/nixos/modules/services/networking/shellhub-agent.nix b/nixos/modules/services/networking/shellhub-agent.nix index 57825945d9f76..c13f183d4fe06 100644 --- a/nixos/modules/services/networking/shellhub-agent.nix +++ b/nixos/modules/services/networking/shellhub-agent.nix @@ -19,7 +19,7 @@ in preferredHostname = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Set the device preferred hostname. This provides a hint to the server to use this as hostname if it is available. ''; @@ -28,7 +28,7 @@ in keepAliveInterval = mkOption { type = types.int; default = 30; - description = '' + description = lib.mdDoc '' Determine the interval to send the keep alive message to the server. This has a direct impact of the bandwidth used by the device. @@ -38,7 +38,7 @@ in tenantId = mkOption { type = types.str; example = "ba0a880c-2ada-11eb-a35e-17266ef329d6"; - description = '' + description = lib.mdDoc '' The tenant ID to use when connecting to the ShellHub Gateway. ''; @@ -47,7 +47,7 @@ in server = mkOption { type = types.str; default = "https://cloud.shellhub.io"; - description = '' + description = lib.mdDoc '' Server address of ShellHub Gateway to connect. ''; }; @@ -55,7 +55,7 @@ in privateKey = mkOption { type = types.path; default = "/var/lib/shellhub-agent/private.key"; - description = '' + description = lib.mdDoc '' Location where to store the ShellHub Agent private key. ''; diff --git a/nixos/modules/services/networking/shorewall.nix b/nixos/modules/services/networking/shorewall.nix index ac732d4b12e48..795295d1628f1 100644 --- a/nixos/modules/services/networking/shorewall.nix +++ b/nixos/modules/services/networking/shorewall.nix @@ -23,12 +23,12 @@ in { type = types.package; default = pkgs.shorewall; defaultText = lib.literalExpression "pkgs.shorewall"; - description = "The shorewall package to use."; + description = lib.mdDoc "The shorewall package to use."; }; configs = lib.mkOption { type = types.attrsOf types.lines; default = {}; - description = '' + description = lib.mdDoc '' This option defines the Shorewall configs. The attribute name defines the name of the config, and the attribute value defines the content of the config. diff --git a/nixos/modules/services/networking/shorewall6.nix b/nixos/modules/services/networking/shorewall6.nix index 4235c74a3f80c..1d6d84eb89b3d 100644 --- a/nixos/modules/services/networking/shorewall6.nix +++ b/nixos/modules/services/networking/shorewall6.nix @@ -23,12 +23,12 @@ in { type = types.package; default = pkgs.shorewall; defaultText = lib.literalExpression "pkgs.shorewall"; - description = "The shorewall package to use."; + description = lib.mdDoc "The shorewall package to use."; }; configs = lib.mkOption { type = types.attrsOf types.lines; default = {}; - description = '' + description = lib.mdDoc '' This option defines the Shorewall configs. The attribute name defines the name of the config, and the attribute value defines the content of the config. diff --git a/nixos/modules/services/networking/shout.nix b/nixos/modules/services/networking/shout.nix index cca03a8f88a1b..1ef21ad5bf8fa 100644 --- a/nixos/modules/services/networking/shout.nix +++ b/nixos/modules/services/networking/shout.nix @@ -28,32 +28,32 @@ in { private = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Make your shout instance private. You will need to configure user - accounts by adding entries in <filename>${shoutHome}/users</filename>. + accounts by adding entries in {file}`${shoutHome}/users`. ''; }; listenAddress = mkOption { type = types.str; default = "0.0.0.0"; - description = "IP interface to listen on for http connections."; + description = lib.mdDoc "IP interface to listen on for http connections."; }; port = mkOption { type = types.port; default = 9000; - description = "TCP port to listen on for http connections."; + description = lib.mdDoc "TCP port to listen on for http connections."; }; configFile = mkOption { type = types.nullOr types.lines; default = null; - description = '' - Contents of Shout's <filename>config.js</filename> file. + description = lib.mdDoc '' + Contents of Shout's {file}`config.js` file. Used for backward compatibility, recommended way is now to use - the <literal>config</literal> option. + the `config` option. Documentation: http://shout-irc.com/docs/server/configuration.html ''; @@ -70,8 +70,8 @@ in { port = 6697; }; }; - description = '' - Shout <filename>config.js</filename> contents as attribute set (will be + description = lib.mdDoc '' + Shout {file}`config.js` contents as attribute set (will be converted to JSON to generate the configuration file). The options defined here will be merged to the default configuration file. diff --git a/nixos/modules/services/networking/skydns.nix b/nixos/modules/services/networking/skydns.nix index dea60a3862a38..f73a8718841ae 100644 --- a/nixos/modules/services/networking/skydns.nix +++ b/nixos/modules/services/networking/skydns.nix @@ -13,45 +13,45 @@ in { machines = mkOption { default = [ "http://127.0.0.1:2379" ]; type = types.listOf types.str; - description = "Skydns list of etcd endpoints to connect to."; + description = lib.mdDoc "Skydns list of etcd endpoints to connect to."; }; tlsKey = mkOption { default = null; type = types.nullOr types.path; - description = "Skydns path of TLS client certificate - private key."; + description = lib.mdDoc "Skydns path of TLS client certificate - private key."; }; tlsPem = mkOption { default = null; type = types.nullOr types.path; - description = "Skydns path of TLS client certificate - public key."; + description = lib.mdDoc "Skydns path of TLS client certificate - public key."; }; caCert = mkOption { default = null; type = types.nullOr types.path; - description = "Skydns path of TLS certificate authority public key."; + description = lib.mdDoc "Skydns path of TLS certificate authority public key."; }; }; address = mkOption { default = "0.0.0.0:53"; type = types.str; - description = "Skydns address to bind to."; + description = lib.mdDoc "Skydns address to bind to."; }; domain = mkOption { default = "skydns.local."; type = types.str; - description = "Skydns default domain if not specified by etcd config."; + description = lib.mdDoc "Skydns default domain if not specified by etcd config."; }; nameservers = mkOption { default = map (n: n + ":53") config.networking.nameservers; defaultText = literalExpression ''map (n: n + ":53") config.networking.nameservers''; type = types.listOf types.str; - description = "Skydns list of nameservers to forward DNS requests to when not authoritative for a domain."; + description = lib.mdDoc "Skydns list of nameservers to forward DNS requests to when not authoritative for a domain."; example = ["8.8.8.8:53" "8.8.4.4:53"]; }; @@ -59,13 +59,13 @@ in { default = pkgs.skydns; defaultText = literalExpression "pkgs.skydns"; type = types.package; - description = "Skydns package to use."; + description = lib.mdDoc "Skydns package to use."; }; extraConfig = mkOption { default = {}; type = types.attrsOf types.str; - description = "Skydns attribute set of extra config options passed as environment variables."; + description = lib.mdDoc "Skydns attribute set of extra config options passed as environment variables."; }; }; diff --git a/nixos/modules/services/networking/smartdns.nix b/nixos/modules/services/networking/smartdns.nix index 7f9df42ce9c18..aa132747885d0 100644 --- a/nixos/modules/services/networking/smartdns.nix +++ b/nixos/modules/services/networking/smartdns.nix @@ -25,7 +25,7 @@ in { bindPort = mkOption { type = types.port; default = 53; - description = "DNS listening port number."; + description = lib.mdDoc "DNS listening port number."; }; settings = mkOption { @@ -42,9 +42,9 @@ in { speed-check-mode = "ping,tcp:80"; }; ''; - description = '' - A set that will be generated into configuration file, see the <link xlink:href="https://github.com/pymumu/smartdns/blob/master/ReadMe_en.md#configuration-parameter">SmartDNS README</link> for details of configuration parameters. - You could override the options here like <option>services.smartdns.bindPort</option> by writing <literal>settings.bind = ":5353 -no-rule -group example";</literal>. + description = lib.mdDoc '' + A set that will be generated into configuration file, see the [SmartDNS README](https://github.com/pymumu/smartdns/blob/master/ReadMe_en.md#configuration-parameter) for details of configuration parameters. + You could override the options here like {option}`services.smartdns.bindPort` by writing `settings.bind = ":5353 -no-rule -group example";`. ''; }; }; diff --git a/nixos/modules/services/networking/smokeping.nix b/nixos/modules/services/networking/smokeping.nix index bd71b158dbe32..217c16c8f37be 100644 --- a/nixos/modules/services/networking/smokeping.nix +++ b/nixos/modules/services/networking/smokeping.nix @@ -52,7 +52,7 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable the smokeping service"; + description = lib.mdDoc "Enable the smokeping service"; }; alertConfig = mkOption { type = types.lines; @@ -70,14 +70,14 @@ in pattern = >0%,*12*,>0%,*12*,>0% comment = loss 3 times in a row; ''; - description = "Configuration for alerts."; + description = lib.mdDoc "Configuration for alerts."; }; cgiUrl = mkOption { type = types.str; default = "http://${cfg.hostName}:${toString cfg.port}/smokeping.cgi"; defaultText = literalExpression ''"http://''${hostName}:''${toString port}/smokeping.cgi"''; example = "https://somewhere.example.com/smokeping.cgi"; - description = "URL to the smokeping cgi."; + description = lib.mdDoc "URL to the smokeping cgi."; }; config = mkOption { type = types.nullOr types.lines; @@ -113,28 +113,28 @@ in MAX 0.5 144 7200 MIN 0.5 144 7200 ''; - description = ''Configure the ping frequency and retention of the rrd files. + description = lib.mdDoc ''Configure the ping frequency and retention of the rrd files. Once set, changing the interval will require deletion or migration of all the collected data.''; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Any additional customization not already included."; + description = lib.mdDoc "Any additional customization not already included."; }; hostName = mkOption { type = types.str; default = config.networking.fqdn; defaultText = literalExpression "config.networking.fqdn"; example = "somewhere.example.com"; - description = "DNS name for the urls generated in the cgi."; + description = lib.mdDoc "DNS name for the urls generated in the cgi."; }; imgUrl = mkOption { type = types.str; default = "cache"; defaultText = literalExpression ''"cache"''; example = "https://somewhere.example.com/cache"; - description = '' + description = lib.mdDoc '' Base url for images generated in the cgi. The default is a relative URL to ensure it works also when e.g. forwarding @@ -145,48 +145,48 @@ in type = types.enum ["original" "absolute" "relative"]; default = "relative"; example = "absolute"; - description = "DNS name for the urls generated in the cgi."; + description = lib.mdDoc "DNS name for the urls generated in the cgi."; }; mailHost = mkOption { type = types.str; default = ""; example = "localhost"; - description = "Use this SMTP server to send alerts"; + description = lib.mdDoc "Use this SMTP server to send alerts"; }; owner = mkOption { type = types.str; default = "nobody"; example = "Joe Admin"; - description = "Real name of the owner of the instance"; + description = lib.mdDoc "Real name of the owner of the instance"; }; ownerEmail = mkOption { type = types.str; default = "no-reply@${cfg.hostName}"; defaultText = literalExpression ''"no-reply@''${hostName}"''; example = "no-reply@yourdomain.com"; - description = "Email contact for owner"; + description = lib.mdDoc "Email contact for owner"; }; package = mkOption { type = types.package; default = pkgs.smokeping; defaultText = literalExpression "pkgs.smokeping"; - description = "Specify a custom smokeping package"; + description = lib.mdDoc "Specify a custom smokeping package"; }; host = mkOption { type = types.nullOr types.str; default = "localhost"; example = "192.0.2.1"; # rfc5737 example IP for documentation - description = '' + description = lib.mdDoc '' Host/IP to bind to for the web server. - Setting it to <literal>null</literal> skips passing the -h option to thttpd, + Setting it to `null` skips passing the -h option to thttpd, which makes it bind to all interfaces. ''; }; port = mkOption { type = types.int; default = 8081; - description = "TCP port to use for the web server."; + description = lib.mdDoc "TCP port to use for the web server."; }; presentationConfig = mkOption { type = types.lines; @@ -227,13 +227,13 @@ in "Last 10 Days" 10d "Last 360 Days" 360d ''; - description = "presentation graph style"; + description = lib.mdDoc "presentation graph style"; }; presentationTemplate = mkOption { type = types.str; default = "${pkgs.smokeping}/etc/basepage.html.dist"; defaultText = literalExpression ''"''${pkgs.smokeping}/etc/basepage.html.dist"''; - description = "Default page layout for the web UI."; + description = lib.mdDoc "Default page layout for the web UI."; }; probeConfig = mkOption { type = types.lines; @@ -247,19 +247,19 @@ in binary = ''${config.security.wrapperDir}/fping ''' ''; - description = "Probe configuration"; + description = lib.mdDoc "Probe configuration"; }; sendmail = mkOption { type = types.nullOr types.path; default = null; example = "/run/wrappers/bin/sendmail"; - description = "Use this sendmail compatible script to deliver alerts"; + description = lib.mdDoc "Use this sendmail compatible script to deliver alerts"; }; smokeMailTemplate = mkOption { type = types.str; default = "${cfg.package}/etc/smokemail.dist"; defaultText = literalExpression ''"''${package}/etc/smokemail.dist"''; - description = "Specify the smokemail template for alerts."; + description = lib.mdDoc "Specify the smokemail template for alerts."; }; targetConfig = mkOption { type = types.lines; @@ -277,17 +277,17 @@ in title = This host host = localhost ''; - description = "Target configuration"; + description = lib.mdDoc "Target configuration"; }; user = mkOption { type = types.str; default = "smokeping"; - description = "User that runs smokeping and (optionally) thttpd. A group of the same name will be created as well."; + description = lib.mdDoc "User that runs smokeping and (optionally) thttpd. A group of the same name will be created as well."; }; webService = mkOption { type = types.bool; default = true; - description = "Enable a smokeping web interface"; + description = lib.mdDoc "Enable a smokeping web interface"; }; }; diff --git a/nixos/modules/services/networking/sniproxy.nix b/nixos/modules/services/networking/sniproxy.nix index adca5398e4abf..dedeb96f73690 100644 --- a/nixos/modules/services/networking/sniproxy.nix +++ b/nixos/modules/services/networking/sniproxy.nix @@ -23,19 +23,19 @@ in user = mkOption { type = types.str; default = "sniproxy"; - description = "User account under which sniproxy runs."; + description = lib.mdDoc "User account under which sniproxy runs."; }; group = mkOption { type = types.str; default = "sniproxy"; - description = "Group under which sniproxy runs."; + description = lib.mdDoc "Group under which sniproxy runs."; }; config = mkOption { type = types.lines; default = ""; - description = "sniproxy.conf configuration excluding the daemon username and pid file."; + description = lib.mdDoc "sniproxy.conf configuration excluding the daemon username and pid file."; example = '' error_log { filename /var/log/sniproxy/error.log diff --git a/nixos/modules/services/networking/snowflake-proxy.nix b/nixos/modules/services/networking/snowflake-proxy.nix index 2124644ed9b5e..d759b07e8bf0d 100644 --- a/nixos/modules/services/networking/snowflake-proxy.nix +++ b/nixos/modules/services/networking/snowflake-proxy.nix @@ -11,25 +11,25 @@ in enable = mkEnableOption "System to defeat internet censorship"; broker = mkOption { - description = "Broker URL (default \"https://snowflake-broker.torproject.net/\")"; + description = lib.mdDoc "Broker URL (default \"https://snowflake-broker.torproject.net/\")"; type = with types; nullOr str; default = null; }; capacity = mkOption { - description = "Limits the amount of maximum concurrent clients allowed."; + description = lib.mdDoc "Limits the amount of maximum concurrent clients allowed."; type = with types; nullOr int; default = null; }; relay = mkOption { - description = "websocket relay URL (default \"wss://snowflake.bamsoftware.com/\")"; + description = lib.mdDoc "websocket relay URL (default \"wss://snowflake.bamsoftware.com/\")"; type = with types; nullOr str; default = null; }; stun = mkOption { - description = "STUN broker URL (default \"stun:stun.stunprotocol.org:3478\")"; + description = lib.mdDoc "STUN broker URL (default \"stun:stun.stunprotocol.org:3478\")"; type = with types; nullOr str; default = null; }; diff --git a/nixos/modules/services/networking/softether.nix b/nixos/modules/services/networking/softether.nix index 5405f56871e92..47d10bf64ca3a 100644 --- a/nixos/modules/services/networking/softether.nix +++ b/nixos/modules/services/networking/softether.nix @@ -22,7 +22,7 @@ in type = types.package; default = pkgs.softether; defaultText = literalExpression "pkgs.softether"; - description = '' + description = lib.mdDoc '' softether derivation to use. ''; }; @@ -36,14 +36,14 @@ in up = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Shell commands executed when the Virtual Network Adapter(s) is/are starting. ''; }; down = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Shell commands executed when the Virtual Network Adapter(s) is/are shutting down. ''; }; @@ -52,7 +52,7 @@ in dataDir = mkOption { type = types.path; default = "/var/lib/softether"; - description = '' + description = lib.mdDoc '' Data directory for SoftEther VPN. ''; }; diff --git a/nixos/modules/services/networking/soju.nix b/nixos/modules/services/networking/soju.nix index cb0acf4765ff1..a92d274aea281 100644 --- a/nixos/modules/services/networking/soju.nix +++ b/nixos/modules/services/networking/soju.nix @@ -44,25 +44,25 @@ in type = types.str; default = config.networking.hostName; defaultText = literalExpression "config.networking.hostName"; - description = "Server hostname."; + description = lib.mdDoc "Server hostname."; }; tlsCertificate = mkOption { type = types.nullOr types.path; example = "/var/host.cert"; - description = "Path to server TLS certificate."; + description = lib.mdDoc "Path to server TLS certificate."; }; tlsCertificateKey = mkOption { type = types.nullOr types.path; example = "/var/host.key"; - description = "Path to server TLS certificate key."; + description = lib.mdDoc "Path to server TLS certificate key."; }; enableMessageLogging = mkOption { type = types.bool; default = true; - description = "Whether to enable message logging."; + description = lib.mdDoc "Whether to enable message logging."; }; httpOrigins = mkOption { @@ -90,7 +90,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = "Lines added verbatim to the configuration file."; + description = lib.mdDoc "Lines added verbatim to the configuration file."; }; }; diff --git a/nixos/modules/services/networking/solanum.nix b/nixos/modules/services/networking/solanum.nix index dc066a245494d..daa3650fc99aa 100644 --- a/nixos/modules/services/networking/solanum.nix +++ b/nixos/modules/services/networking/solanum.nix @@ -44,16 +44,16 @@ in default_split_user_count = 0; }; ''; - description = '' + description = lib.mdDoc '' Solanum IRC daemon configuration file. - check <link xlink:href="https://github.com/solanum-ircd/solanum/blob/main/doc/reference.conf"/> for all options. + check <https://github.com/solanum-ircd/solanum/blob/main/doc/reference.conf> for all options. ''; }; openFilesLimit = mkOption { type = types.int; default = 1024; - description = '' + description = lib.mdDoc '' Maximum number of open files. Limits the clients and server connections. ''; }; @@ -61,10 +61,10 @@ in motd = mkOption { type = types.nullOr types.lines; default = null; - description = '' + description = lib.mdDoc '' Solanum MOTD text. - Solanum will read its MOTD from <literal>/etc/solanum/ircd.motd</literal>. + Solanum will read its MOTD from `/etc/solanum/ircd.motd`. If set, the value of this option will be written to this path. ''; }; diff --git a/nixos/modules/services/networking/spacecookie.nix b/nixos/modules/services/networking/spacecookie.nix index 400f3e26cc9a1..4aa76de6f41a5 100644 --- a/nixos/modules/services/networking/spacecookie.nix +++ b/nixos/modules/services/networking/spacecookie.nix @@ -32,7 +32,7 @@ in { default = pkgs.spacecookie; defaultText = literalExpression "pkgs.spacecookie"; example = literalExpression "pkgs.haskellPackages.spacecookie"; - description = '' + description = lib.mdDoc '' The spacecookie derivation to use. This can be used to override the used package or to use another version. ''; @@ -41,7 +41,7 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to open the necessary port in the firewall for spacecookie. ''; }; @@ -49,7 +49,7 @@ in { port = mkOption { type = types.port; default = 70; - description = '' + description = lib.mdDoc '' Port the gopher service should be exposed on. ''; }; @@ -57,10 +57,10 @@ in { address = mkOption { type = types.str; default = "[::]"; - description = '' + description = lib.mdDoc '' Address to listen on. Must be in the - <literal>ListenStream=</literal> syntax of - <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.socket.html">systemd.socket(5)</link>. + `ListenStream=` syntax of + [systemd.socket(5)](https://www.freedesktop.org/software/systemd/man/systemd.socket.html). ''; }; @@ -71,7 +71,7 @@ in { options.hostname = mkOption { type = types.str; default = "localhost"; - description = '' + description = lib.mdDoc '' The hostname the service is reachable via. Clients will use this hostname for further requests after loading the initial gopher menu. @@ -81,11 +81,11 @@ in { options.root = mkOption { type = types.path; default = "/srv/gopher"; - description = '' + description = lib.mdDoc '' The directory spacecookie should serve via gopher. Files in there need to be world-readable since the spacecookie service file sets - <literal>DynamicUser=true</literal>. + `DynamicUser=true`. ''; }; @@ -96,7 +96,7 @@ in { hide-ips = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' If enabled, spacecookie will hide personal information of users like IP addresses from log output. @@ -110,7 +110,7 @@ in { # journald will add timestamps, so no need # to double up. default = true; - description = '' + description = lib.mdDoc '' If enabled, spacecookie will not print timestamps at the beginning of every log line. ''; @@ -123,18 +123,18 @@ in { "error" ]; default = "info"; - description = '' + description = lib.mdDoc '' Log level for the spacecookie service. ''; }; }; }; - description = '' + description = lib.mdDoc '' Settings for spacecookie. The settings set here are directly translated to the spacecookie JSON config file. See - <link xlink:href="https://sternenseemann.github.io/spacecookie/spacecookie.json.5.html">spacecookie.json(5)</link> + [spacecookie.json(5)](https://sternenseemann.github.io/spacecookie/spacecookie.json.5.html) for explanations of all options. ''; }; diff --git a/nixos/modules/services/networking/spiped.nix b/nixos/modules/services/networking/spiped.nix index 3c229ecfc72eb..3e01ace54ad17 100644 --- a/nixos/modules/services/networking/spiped.nix +++ b/nixos/modules/services/networking/spiped.nix @@ -11,7 +11,7 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable the spiped service module."; + description = lib.mdDoc "Enable the spiped service module."; }; config = mkOption { @@ -21,32 +21,32 @@ in encrypt = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Take unencrypted connections from the - <literal>source</literal> socket and send encrypted - connections to the <literal>target</literal> socket. + `source` socket and send encrypted + connections to the `target` socket. ''; }; decrypt = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Take encrypted connections from the - <literal>source</literal> socket and send unencrypted - connections to the <literal>target</literal> socket. + `source` socket and send unencrypted + connections to the `target` socket. ''; }; source = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Address on which spiped should listen for incoming connections. Must be in one of the following formats: - <literal>/absolute/path/to/unix/socket</literal>, - <literal>host.name:port</literal>, - <literal>[ip.v4.ad.dr]:port</literal> or - <literal>[ipv6::addr]:port</literal> - note that + `/absolute/path/to/unix/socket`, + `host.name:port`, + `[ip.v4.ad.dr]:port` or + `[ipv6::addr]:port` - note that hostnames are resolved when spiped is launched and are not re-resolved later; thus if DNS entries change spiped will continue to connect to the expired @@ -56,24 +56,24 @@ in target = mkOption { type = types.str; - description = "Address to which spiped should connect."; + description = lib.mdDoc "Address to which spiped should connect."; }; keyfile = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' Name of a file containing the spiped key. As the - daemon runs as the <literal>spiped</literal> user, the + daemon runs as the `spiped` user, the key file must be somewhere owned by that user. By default, we recommend putting the keys for any spipe - services in <literal>/var/lib/spiped</literal>. + services in `/var/lib/spiped`. ''; }; timeout = mkOption { type = types.int; default = 5; - description = '' + description = lib.mdDoc '' Timeout, in seconds, after which an attempt to connect to the target or a protocol handshake will be aborted (and the connection dropped) if not completed @@ -83,7 +83,7 @@ in maxConns = mkOption { type = types.int; default = 100; - description = '' + description = lib.mdDoc '' Limit on the number of simultaneous connections allowed. ''; }; @@ -91,14 +91,14 @@ in waitForDNS = mkOption { type = types.bool; default = false; - description = '' - Wait for DNS. Normally when <literal>spiped</literal> is + description = lib.mdDoc '' + Wait for DNS. Normally when `spiped` is launched it resolves addresses and binds to its source socket before the parent process returns; with this option it will daemonize first and retry failed DNS lookups until - they succeed. This allows <literal>spiped</literal> to + they succeed. This allows `spiped` to launch even if DNS isn't set up yet, but at the expense of - losing the guarantee that once <literal>spiped</literal> has + losing the guarantee that once `spiped` has finished launching it will be ready to create pipes. ''; }; @@ -106,13 +106,13 @@ in disableKeepalives = mkOption { type = types.bool; default = false; - description = "Disable transport layer keep-alives."; + description = lib.mdDoc "Disable transport layer keep-alives."; }; weakHandshake = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Use fast/weak handshaking: This reduces the CPU time spent in the initial connection setup, at the expense of losing perfect forward secrecy. @@ -122,7 +122,7 @@ in resolveRefresh = mkOption { type = types.int; default = 60; - description = '' + description = lib.mdDoc '' Resolution refresh time for the target socket, in seconds. ''; }; @@ -130,7 +130,7 @@ in disableReresolution = mkOption { type = types.bool; default = false; - description = "Disable target address re-resolution."; + description = lib.mdDoc "Disable target address re-resolution."; }; }; } @@ -155,11 +155,11 @@ in } ''; - description = '' + description = lib.mdDoc '' Configuration for a secure pipe daemon. The daemon can be started, stopped, or examined using - <literal>systemctl</literal>, under the name - <literal>spiped@foo</literal>. + `systemctl`, under the name + `spiped@foo`. ''; }; }; diff --git a/nixos/modules/services/networking/squid.nix b/nixos/modules/services/networking/squid.nix index db4f0d26b6f4a..914cd7f320c9b 100644 --- a/nixos/modules/services/networking/squid.nix +++ b/nixos/modules/services/networking/squid.nix @@ -108,32 +108,32 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to run squid web proxy."; + description = lib.mdDoc "Whether to run squid web proxy."; }; package = mkOption { default = pkgs.squid; defaultText = literalExpression "pkgs.squid"; type = types.package; - description = "Squid package to use."; + description = lib.mdDoc "Squid package to use."; }; proxyAddress = mkOption { type = types.nullOr types.str; default = null; - description = "IP address on which squid will listen."; + description = lib.mdDoc "IP address on which squid will listen."; }; proxyPort = mkOption { type = types.int; default = 3128; - description = "TCP port on which squid will listen."; + description = lib.mdDoc "TCP port on which squid will listen."; }; extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Squid configuration. Contents will be added verbatim to the configuration file. ''; @@ -142,7 +142,7 @@ in configText = mkOption { type = types.nullOr types.lines; default = null; - description = '' + description = lib.mdDoc '' Verbatim contents of squid.conf. If null (default), use the autogenerated file from NixOS instead. ''; diff --git a/nixos/modules/services/networking/ssh/lshd.nix b/nixos/modules/services/networking/ssh/lshd.nix index 862ff7df05407..41c4ec2d2951e 100644 --- a/nixos/modules/services/networking/ssh/lshd.nix +++ b/nixos/modules/services/networking/ssh/lshd.nix @@ -21,7 +21,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the GNU lshd SSH2 daemon, which allows secure remote login. ''; @@ -30,7 +30,7 @@ in portNumber = mkOption { default = 22; type = types.port; - description = '' + description = lib.mdDoc '' The port on which to listen for connections. ''; }; @@ -38,7 +38,7 @@ in interfaces = mkOption { default = []; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' List of network interfaces where listening for connections. When providing the empty list, `[]', lshd listens on all network interfaces. @@ -49,7 +49,7 @@ in hostKey = mkOption { default = "/etc/lsh/host-key"; type = types.str; - description = '' + description = lib.mdDoc '' Path to the server's private key. Note that this key must have been created, e.g., using "lsh-keygen --server | lsh-writekey --server", so that you can run lshd. @@ -59,31 +59,31 @@ in syslog = mkOption { type = types.bool; default = true; - description = "Whether to enable syslog output."; + description = lib.mdDoc "Whether to enable syslog output."; }; passwordAuthentication = mkOption { type = types.bool; default = true; - description = "Whether to enable password authentication."; + description = lib.mdDoc "Whether to enable password authentication."; }; publicKeyAuthentication = mkOption { type = types.bool; default = true; - description = "Whether to enable public key authentication."; + description = lib.mdDoc "Whether to enable public key authentication."; }; rootLogin = mkOption { type = types.bool; default = false; - description = "Whether to enable remote root login."; + description = lib.mdDoc "Whether to enable remote root login."; }; loginShell = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' If non-null, override the default login shell with the specified value. ''; @@ -93,7 +93,7 @@ in srpKeyExchange = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable SRP key exchange and user authentication. ''; }; @@ -101,18 +101,18 @@ in tcpForwarding = mkOption { type = types.bool; default = true; - description = "Whether to enable TCP/IP forwarding."; + description = lib.mdDoc "Whether to enable TCP/IP forwarding."; }; x11Forwarding = mkOption { type = types.bool; default = true; - description = "Whether to enable X11 forwarding."; + description = lib.mdDoc "Whether to enable X11 forwarding."; }; subsystems = mkOption { type = types.listOf types.path; - description = '' + description = lib.mdDoc '' List of subsystem-path pairs, where the head of the pair denotes the subsystem name, and the tail denotes the path to an executable implementing it. diff --git a/nixos/modules/services/networking/ssh/sshd.nix b/nixos/modules/services/networking/ssh/sshd.nix index 52a50b892ec61..c6386ed6823df 100644 --- a/nixos/modules/services/networking/ssh/sshd.nix +++ b/nixos/modules/services/networking/ssh/sshd.nix @@ -32,13 +32,13 @@ let keys = mkOption { type = types.listOf types.singleLineStr; default = []; - description = '' + description = lib.mdDoc '' A list of verbatim OpenSSH public keys that should be added to the user's authorized keys. The keys are added to a file that the SSH daemon reads in addition to the the user's authorized_keys file. - You can combine the <literal>keys</literal> and - <literal>keyFiles</literal> options. - Warning: If you are using <literal>NixOps</literal> then don't use this + You can combine the `keys` and + `keyFiles` options. + Warning: If you are using `NixOps` then don't use this option since it will replace the key required for deployment via ssh. ''; example = [ @@ -50,12 +50,12 @@ let keyFiles = mkOption { type = types.listOf types.path; default = []; - description = '' + description = lib.mdDoc '' A list of files each containing one OpenSSH public key that should be added to the user's authorized keys. The contents of the files are read at build time and added to a file that the SSH daemon reads in addition to the the user's authorized_keys file. You can combine the - <literal>keyFiles</literal> and <literal>keys</literal> options. + `keyFiles` and `keys` options. ''; }; }; @@ -93,7 +93,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the OpenSSH secure shell daemon, which allows secure remote logins. ''; @@ -102,8 +102,8 @@ in startWhenNeeded = mkOption { type = types.bool; default = false; - description = '' - If set, <command>sshd</command> is socket-activated; that + description = lib.mdDoc '' + If set, {command}`sshd` is socket-activated; that is, instead of having it permanently running as a daemon, systemd will start an instance for each incoming connection. ''; @@ -112,7 +112,7 @@ in forwardX11 = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to allow X11 connections to be forwarded. ''; }; @@ -120,17 +120,17 @@ in allowSFTP = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable the SFTP subsystem in the SSH daemon. This - enables the use of commands such as <command>sftp</command> and - <command>sshfs</command>. + enables the use of commands such as {command}`sftp` and + {command}`sshfs`. ''; }; sftpServerExecutable = mkOption { type = types.str; example = "internal-sftp"; - description = '' + description = lib.mdDoc '' The sftp server executable. Can be a path or "internal-sftp" to use the sftp server built into the sshd binary. ''; @@ -140,7 +140,7 @@ in type = with types; listOf str; default = []; example = [ "-f AUTHPRIV" "-l INFO" ]; - description = '' + description = lib.mdDoc '' Commandline flags to add to sftp-server. ''; }; @@ -148,7 +148,7 @@ in permitRootLogin = mkOption { default = "prohibit-password"; type = types.enum ["yes" "without-password" "prohibit-password" "forced-commands-only" "no"]; - description = '' + description = lib.mdDoc '' Whether the root user can login using ssh. ''; }; @@ -167,7 +167,7 @@ in ports = mkOption { type = types.listOf types.port; default = [22]; - description = '' + description = lib.mdDoc '' Specifies on which ports the SSH daemon listens. ''; }; @@ -175,7 +175,7 @@ in openFirewall = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to automatically open the specified ports in the firewall. ''; }; @@ -186,14 +186,14 @@ in addr = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Host, IPv4 or IPv6 address to listen to. ''; }; port = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Port to listen to. ''; }; @@ -201,10 +201,10 @@ in }); default = []; example = [ { addr = "192.168.3.1"; port = 22; } { addr = "0.0.0.0"; port = 64022; } ]; - description = '' + description = lib.mdDoc '' List of addresses and ports to listen on (ListenAddress directive in config). If port is not specified for address sshd will listen - on all ports specified by <literal>ports</literal> option. + on all ports specified by `ports` option. NOTE: this will override default listening on all local addresses and port 22. NOTE: setting this option won't automatically enable given ports in firewall configuration. @@ -214,7 +214,7 @@ in passwordAuthentication = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Specifies whether password authentication is allowed. ''; }; @@ -222,7 +222,7 @@ in kbdInteractiveAuthentication = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Specifies whether keyboard-interactive authentication is allowed. ''; }; @@ -249,7 +249,7 @@ in banner = mkOption { type = types.nullOr types.lines; default = null; - description = '' + description = lib.mdDoc '' Message to display to the remote user before authentication is allowed. ''; }; @@ -273,7 +273,7 @@ in authorizedKeysCommand = mkOption { type = types.str; default = "none"; - description = '' + description = lib.mdDoc '' Specifies a program to be used to look up the user's public keys. The program must be owned by root, not writable by group or others and specified by an absolute path. @@ -283,7 +283,7 @@ in authorizedKeysCommandUser = mkOption { type = types.str; default = "nobody"; - description = '' + description = lib.mdDoc '' Specifies the user under whose account the AuthorizedKeysCommand is run. It is recommended to use a dedicated user that has no other role on the host than running authorized keys commands. @@ -354,7 +354,7 @@ in logLevel = mkOption { type = types.enum [ "QUIET" "FATAL" "ERROR" "INFO" "VERBOSE" "DEBUG" "DEBUG1" "DEBUG2" "DEBUG3" ]; default = "INFO"; # upstream default - description = '' + description = lib.mdDoc '' Gives the verbosity level that is used when logging messages from sshd(8). The possible values are: QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3. The default is INFO. DEBUG and DEBUG1 are equivalent. DEBUG2 and DEBUG3 each specify higher levels of debugging output. Logging with a DEBUG level @@ -365,7 +365,7 @@ in useDns = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Specifies whether sshd(8) should look up the remote host name, and to check that the resolved host name for the remote IP address maps back to the very same IP address. If this option is set to no (the default) then only addresses and not host names may be used in @@ -376,16 +376,16 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = "Verbatim contents of <filename>sshd_config</filename>."; + description = lib.mdDoc "Verbatim contents of {file}`sshd_config`."; }; moduliFile = mkOption { example = "/etc/my-local-ssh-moduli;"; type = types.path; - description = '' - Path to <literal>moduli</literal> file to install in - <literal>/etc/ssh/moduli</literal>. If this option is unset, then - the <literal>moduli</literal> file shipped with OpenSSH will be used. + description = lib.mdDoc '' + Path to `moduli` file to install in + `/etc/ssh/moduli`. If this option is unset, then + the `moduli` file shipped with OpenSSH will be used. ''; }; diff --git a/nixos/modules/services/networking/sslh.nix b/nixos/modules/services/networking/sslh.nix index abe96f60f811e..03c0bd23141a0 100644 --- a/nixos/modules/services/networking/sslh.nix +++ b/nixos/modules/services/networking/sslh.nix @@ -48,37 +48,37 @@ in verbose = mkOption { type = types.bool; default = false; - description = "Verbose logs."; + description = lib.mdDoc "Verbose logs."; }; timeout = mkOption { type = types.int; default = 2; - description = "Timeout in seconds."; + description = lib.mdDoc "Timeout in seconds."; }; transparent = mkOption { type = types.bool; default = false; - description = "Will the services behind sslh (Apache, sshd and so on) see the external IP and ports as if the external world connected directly to them"; + description = lib.mdDoc "Will the services behind sslh (Apache, sshd and so on) see the external IP and ports as if the external world connected directly to them"; }; listenAddresses = mkOption { type = types.coercedTo types.str singleton (types.listOf types.str); default = [ "0.0.0.0" "[::]" ]; - description = "Listening addresses or hostnames."; + description = lib.mdDoc "Listening addresses or hostnames."; }; port = mkOption { type = types.int; default = 443; - description = "Listening port."; + description = lib.mdDoc "Listening port."; }; appendConfig = mkOption { type = types.str; default = defaultAppendConfig; - description = "Verbatim configuration file."; + description = lib.mdDoc "Verbatim configuration file."; }; }; }; diff --git a/nixos/modules/services/networking/strongswan.nix b/nixos/modules/services/networking/strongswan.nix index e3a97207be7f5..f1b0a3f0d3b8f 100644 --- a/nixos/modules/services/networking/strongswan.nix +++ b/nixos/modules/services/networking/strongswan.nix @@ -57,10 +57,10 @@ in type = types.listOf types.str; default = []; example = [ "/run/keys/ipsec-foo.secret" ]; - description = '' + description = lib.mdDoc '' A list of paths to IPSec secret files. These files will be included into the main ipsec.secrets file with - the <literal>include</literal> directive. It is safer if these + the `include` directive. It is safer if these paths are absolute. ''; }; @@ -69,9 +69,9 @@ in type = types.attrsOf types.str; default = {}; example = { cachecrls = "yes"; strictcrlpolicy = "yes"; }; - description = '' + description = lib.mdDoc '' A set of options for the ‘config setup’ section of the - <filename>ipsec.conf</filename> file. Defines general + {file}`ipsec.conf` file. Defines general configuration parameters. ''; }; @@ -94,9 +94,9 @@ in }; } ''; - description = '' + description = lib.mdDoc '' A set of connections and their options for the ‘conn xxx’ - sections of the <filename>ipsec.conf</filename> file. + sections of the {file}`ipsec.conf` file. ''; }; @@ -110,9 +110,9 @@ in crluri = "http://crl2.strongswan.org/strongswan.crl"; }; }; - description = '' + description = lib.mdDoc '' A set of CAs (certification authorities) and their options for - the ‘ca xxx’ sections of the <filename>ipsec.conf</filename> + the ‘ca xxx’ sections of the {file}`ipsec.conf` file. ''; }; @@ -120,19 +120,19 @@ in managePlugins = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If set to true, this option will disable automatic plugin loading and then tell strongSwan to enable the plugins specified in the - <option>enabledPlugins</option> option. + {option}`enabledPlugins` option. ''; }; enabledPlugins = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' A list of additional plugins to enable if - <option>managePlugins</option> is true. + {option}`managePlugins` is true. ''; }; }; diff --git a/nixos/modules/services/networking/stubby.nix b/nixos/modules/services/networking/stubby.nix index 78c13798dde2a..f9d6869ad97c6 100644 --- a/nixos/modules/services/networking/stubby.nix +++ b/nixos/modules/services/networking/stubby.nix @@ -39,20 +39,20 @@ in { }]; }; ''; - description = '' + description = lib.mdDoc '' Content of the Stubby configuration file. All Stubby settings may be set or queried here. The default settings are available at - <literal>pkgs.stubby.passthru.settingsExample</literal>. See - <link xlink:href="https://dnsprivacy.org/wiki/display/DP/Configuring+Stubby"/>. + `pkgs.stubby.passthru.settingsExample`. See + <https://dnsprivacy.org/wiki/display/DP/Configuring+Stubby>. A list of the public recursive servers can be found here: - <link xlink:href="https://dnsprivacy.org/wiki/display/DP/DNS+Privacy+Test+Servers"/>. + <https://dnsprivacy.org/wiki/display/DP/DNS+Privacy+Test+Servers>. ''; }; debugLogging = mkOption { default = false; type = types.bool; - description = "Enable or disable debug level logging."; + description = lib.mdDoc "Enable or disable debug level logging."; }; }; diff --git a/nixos/modules/services/networking/stunnel.nix b/nixos/modules/services/networking/stunnel.nix index 55fac27f92ce9..d7311a24bb37e 100644 --- a/nixos/modules/services/networking/stunnel.nix +++ b/nixos/modules/services/networking/stunnel.nix @@ -42,37 +42,37 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the stunnel TLS tunneling service."; + description = lib.mdDoc "Whether to enable the stunnel TLS tunneling service."; }; user = mkOption { type = with types; nullOr str; default = "nobody"; - description = "The user under which stunnel runs."; + description = lib.mdDoc "The user under which stunnel runs."; }; group = mkOption { type = with types; nullOr str; default = "nogroup"; - description = "The group under which stunnel runs."; + description = lib.mdDoc "The group under which stunnel runs."; }; logLevel = mkOption { type = types.enum [ "emerg" "alert" "crit" "err" "warning" "notice" "info" "debug" ]; default = "info"; - description = "Verbosity of stunnel output."; + description = lib.mdDoc "Verbosity of stunnel output."; }; fipsMode = mkOption { type = types.bool; default = false; - description = "Enable FIPS 140-2 mode required for compliance."; + description = lib.mdDoc "Enable FIPS 140-2 mode required for compliance."; }; enableInsecureSSLv3 = mkOption { type = types.bool; default = false; - description = "Enable support for the insecure SSLv3 protocol."; + description = lib.mdDoc "Enable support for the insecure SSLv3 protocol."; }; diff --git a/nixos/modules/services/networking/supplicant.nix b/nixos/modules/services/networking/supplicant.nix index e111b311d68f4..0a48e73932e82 100644 --- a/nixos/modules/services/networking/supplicant.nix +++ b/nixos/modules/services/networking/supplicant.nix @@ -74,19 +74,19 @@ in type = types.nullOr types.path; default = null; example = literalExpression "/etc/wpa_supplicant.conf"; - description = '' - External <literal>wpa_supplicant.conf</literal> configuration file. - The configuration options defined declaratively within <literal>networking.supplicant</literal> have - precedence over options defined in <literal>configFile</literal>. + description = lib.mdDoc '' + External `wpa_supplicant.conf` configuration file. + The configuration options defined declaratively within `networking.supplicant` have + precedence over options defined in `configFile`. ''; }; writable = mkOption { type = types.bool; default = false; - description = '' - Whether the configuration file at <literal>configFile.path</literal> should be written to by - <literal>wpa_supplicant</literal>. + description = lib.mdDoc '' + Whether the configuration file at `configFile.path` should be written to by + `wpa_supplicant`. ''; }; @@ -109,12 +109,12 @@ in model_name=NixOS_Unstable model_number=2015 ''; - description = '' - Configuration options for <literal>wpa_supplicant.conf</literal>. - Options defined here have precedence over options in <literal>configFile</literal>. - NOTE: Do not write sensitive data into <literal>extraConf</literal> as it will - be world-readable in the <literal>nix-store</literal>. For sensitive information - use the <literal>configFile</literal> instead. + description = lib.mdDoc '' + Configuration options for `wpa_supplicant.conf`. + Options defined here have precedence over options in `configFile`. + NOTE: Do not write sensitive data into `extraConf` as it will + be world-readable in the `nix-store`. For sensitive information + use the `configFile` instead. ''; }; @@ -123,19 +123,19 @@ in default = ""; example = "-e/run/wpa_supplicant/entropy.bin"; description = - "Command line arguments to add when executing <literal>wpa_supplicant</literal>."; + lib.mdDoc "Command line arguments to add when executing `wpa_supplicant`."; }; driver = mkOption { type = types.nullOr types.str; default = "nl80211,wext"; - description = "Force a specific wpa_supplicant driver."; + description = lib.mdDoc "Force a specific wpa_supplicant driver."; }; bridge = mkOption { type = types.str; default = ""; - description = "Name of the bridge interface that wpa_supplicant should listen at."; + description = lib.mdDoc "Name of the bridge interface that wpa_supplicant should listen at."; }; userControlled = { @@ -143,7 +143,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Allow normal users to control wpa_supplicant through wpa_gui or wpa_cli. This is useful for laptop users that switch networks a lot and don't want to depend on a large package such as NetworkManager just to pick nearby @@ -154,14 +154,14 @@ in socketDir = mkOption { type = types.str; default = "/run/wpa_supplicant"; - description = "Directory of sockets for controlling wpa_supplicant."; + description = lib.mdDoc "Directory of sockets for controlling wpa_supplicant."; }; group = mkOption { type = types.str; default = "wheel"; example = "network"; - description = "Members of this group can control wpa_supplicant."; + description = lib.mdDoc "Members of this group can control wpa_supplicant."; }; }; @@ -184,21 +184,21 @@ in } ''; - description = '' - Interfaces for which to start <command>wpa_supplicant</command>. + description = lib.mdDoc '' + Interfaces for which to start {command}`wpa_supplicant`. The supplicant is used to scan for and associate with wireless networks, or to authenticate with 802.1x capable network switches. The value of this option is an attribute set. Each attribute configures a - <command>wpa_supplicant</command> service, where the attribute name specifies - the name of the interface that <command>wpa_supplicant</command> operates on. + {command}`wpa_supplicant` service, where the attribute name specifies + the name of the interface that {command}`wpa_supplicant` operates on. The attribute name can be a space separated list of interfaces. - The attribute names <literal>WLAN</literal>, <literal>LAN</literal> and <literal>DBUS</literal> - have a special meaning. <literal>WLAN</literal> and <literal>LAN</literal> are - configurations for universal <command>wpa_supplicant</command> service that is + The attribute names `WLAN`, `LAN` and `DBUS` + have a special meaning. `WLAN` and `LAN` are + configurations for universal {command}`wpa_supplicant` service that is started for each WLAN interface or for each LAN interface, respectively. - <literal>DBUS</literal> defines a device-unrelated <command>wpa_supplicant</command> - service that can be accessed through <literal>D-Bus</literal>. + `DBUS` defines a device-unrelated {command}`wpa_supplicant` + service that can be accessed through `D-Bus`. ''; }; diff --git a/nixos/modules/services/networking/supybot.nix b/nixos/modules/services/networking/supybot.nix index 94b79c7e247ff..df7d92189a778 100644 --- a/nixos/modules/services/networking/supybot.nix +++ b/nixos/modules/services/networking/supybot.nix @@ -16,7 +16,7 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable Supybot, an IRC bot (also known as Limnoria)."; + description = lib.mdDoc "Enable Supybot, an IRC bot (also known as Limnoria)."; }; stateDir = mkOption { @@ -25,12 +25,12 @@ in then "/var/lib/supybot" else "/home/supybot"; defaultText = literalExpression "/var/lib/supybot"; - description = "The root directory, logs and plugins are stored here"; + description = lib.mdDoc "The root directory, logs and plugins are stored here"; }; configFile = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' Path to initial supybot config file. This can be generated by running supybot-wizard. @@ -42,12 +42,12 @@ in plugins = mkOption { type = types.attrsOf types.path; default = {}; - description = '' + description = lib.mdDoc '' Attribute set of additional plugins that will be symlinked to the - <filename>plugin</filename> subdirectory. + {file}`plugin` subdirectory. Please note that you still need to add the plugins to the config - file (or with <literal>!load</literal>) using their attribute name. + file (or with `!load`) using their attribute name. ''; example = literalExpression '' let diff --git a/nixos/modules/services/networking/syncplay.nix b/nixos/modules/services/networking/syncplay.nix index 7694b4bf990b8..726f65671072d 100644 --- a/nixos/modules/services/networking/syncplay.nix +++ b/nixos/modules/services/networking/syncplay.nix @@ -17,13 +17,13 @@ in enable = mkOption { type = types.bool; default = false; - description = "If enabled, start the Syncplay server."; + description = lib.mdDoc "If enabled, start the Syncplay server."; }; port = mkOption { type = types.port; default = 8999; - description = '' + description = lib.mdDoc '' TCP port to bind to. ''; }; @@ -31,7 +31,7 @@ in salt = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Salt to allow room operator passwords generated by this server instance to still work when the server is restarted. ''; @@ -40,16 +40,16 @@ in certDir = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' TLS certificates directory to use for encryption. See - <link xlink:href="https://github.com/Syncplay/syncplay/wiki/TLS-support"/>. + <https://github.com/Syncplay/syncplay/wiki/TLS-support>. ''; }; user = mkOption { type = types.str; default = "nobody"; - description = '' + description = lib.mdDoc '' User to use when running Syncplay. ''; }; @@ -57,7 +57,7 @@ in group = mkOption { type = types.str; default = "nogroup"; - description = '' + description = lib.mdDoc '' Group to use when running Syncplay. ''; }; @@ -65,9 +65,9 @@ in passwordFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Path to the file that contains the server password. If - <literal>null</literal>, the server doesn't require a password. + `null`, the server doesn't require a password. ''; }; }; diff --git a/nixos/modules/services/networking/syncthing-relay.nix b/nixos/modules/services/networking/syncthing-relay.nix index f5ca63e789304..e92557d65455e 100644 --- a/nixos/modules/services/networking/syncthing-relay.nix +++ b/nixos/modules/services/networking/syncthing-relay.nix @@ -28,7 +28,7 @@ in { type = types.str; default = ""; example = "1.2.3.4"; - description = '' + description = lib.mdDoc '' Address to listen on for relay traffic. ''; }; @@ -36,9 +36,9 @@ in { port = mkOption { type = types.port; default = 22067; - description = '' + description = lib.mdDoc '' Port to listen on for relay traffic. This port should be added to - <literal>networking.firewall.allowedTCPPorts</literal>. + `networking.firewall.allowedTCPPorts`. ''; }; @@ -46,7 +46,7 @@ in { type = types.str; default = ""; example = "1.2.3.4"; - description = '' + description = lib.mdDoc '' Address to listen on for serving the relay status API. ''; }; @@ -54,16 +54,16 @@ in { statusPort = mkOption { type = types.port; default = 22070; - description = '' + description = lib.mdDoc '' Port to listen on for serving the relay status API. This port should be - added to <literal>networking.firewall.allowedTCPPorts</literal>. + added to `networking.firewall.allowedTCPPorts`. ''; }; pools = mkOption { type = types.nullOr (types.listOf types.str); default = null; - description = '' + description = lib.mdDoc '' Relay pools to join. If null, uses the default global pool. ''; }; @@ -71,7 +71,7 @@ in { providedBy = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Human-readable description of the provider of the relay (you). ''; }; @@ -79,7 +79,7 @@ in { globalRateBps = mkOption { type = types.nullOr types.ints.positive; default = null; - description = '' + description = lib.mdDoc '' Global bandwidth rate limit in bytes per second. ''; }; @@ -87,7 +87,7 @@ in { perSessionRateBps = mkOption { type = types.nullOr types.ints.positive; default = null; - description = '' + description = lib.mdDoc '' Per session bandwidth rate limit in bytes per second. ''; }; @@ -95,7 +95,7 @@ in { extraOptions = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Extra command line arguments to pass to strelaysrv. ''; }; diff --git a/nixos/modules/services/networking/syncthing.nix b/nixos/modules/services/networking/syncthing.nix index 66b85cd9d8a9f..373fd03223d6c 100644 --- a/nixos/modules/services/networking/syncthing.nix +++ b/nixos/modules/services/networking/syncthing.nix @@ -126,7 +126,7 @@ in { name = mkOption { type = types.str; default = name; - description = '' + description = lib.mdDoc '' The name of the device. ''; }; @@ -134,7 +134,7 @@ in { addresses = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' The addresses used to connect to the device. If this is left empty, dynamic configuration is attempted. ''; @@ -204,7 +204,7 @@ in { enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to share this folder. This option is useful when you want to define all folders in one place, but not every machine should share all folders. @@ -214,7 +214,7 @@ in { path = mkOption { type = types.str; default = name; - description = '' + description = lib.mdDoc '' The path to the folder which should be shared. ''; }; @@ -222,7 +222,7 @@ in { id = mkOption { type = types.str; default = name; - description = '' + description = lib.mdDoc '' The ID of the folder. Must be the same on all devices. ''; }; @@ -230,7 +230,7 @@ in { label = mkOption { type = types.str; default = name; - description = '' + description = lib.mdDoc '' The label of the folder. ''; }; @@ -311,7 +311,7 @@ in { rescanInterval = mkOption { type = types.int; default = 3600; - description = '' + description = lib.mdDoc '' How often the folder should be rescanned for changes. ''; }; @@ -319,7 +319,7 @@ in { type = mkOption { type = types.enum [ "sendreceive" "sendonly" "receiveonly" ]; default = "sendreceive"; - description = '' + description = lib.mdDoc '' Whether to only send changes for this folder, only receive them or both. ''; @@ -328,7 +328,7 @@ in { watch = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether the folder should be watched for changes by inotify. ''; }; @@ -336,7 +336,7 @@ in { watchDelay = mkOption { type = types.int; default = 10; - description = '' + description = lib.mdDoc '' The delay after an inotify event is triggered. ''; }; @@ -344,7 +344,7 @@ in { ignorePerms = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to ignore permission changes. ''; }; @@ -377,7 +377,7 @@ in { guiAddress = mkOption { type = types.str; default = "127.0.0.1:8384"; - description = '' + description = lib.mdDoc '' The address to serve the web interface at. ''; }; @@ -385,7 +385,7 @@ in { systemService = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to auto-launch Syncthing as a system service. ''; }; @@ -426,7 +426,7 @@ in { type = types.path; default = "/var/lib/syncthing"; example = "/home/yourUser"; - description = '' + description = lib.mdDoc '' The path where synchronised directories will exist. ''; }; @@ -435,7 +435,7 @@ in { cond = versionAtLeast config.system.stateVersion "19.03"; in mkOption { type = types.path; - description = '' + description = lib.mdDoc '' The path where the settings and keys will exist. ''; default = cfg.dataDir + optionalString cond "/.config/syncthing"; @@ -453,7 +453,7 @@ in { type = types.listOf types.str; default = []; example = [ "--reset-deltas" ]; - description = '' + description = lib.mdDoc '' Extra flags passed to the syncthing command in the service definition. ''; }; @@ -462,7 +462,7 @@ in { type = types.bool; default = false; example = true; - description = '' + description = lib.mdDoc '' Whether to open the default ports in the firewall: TCP/UDP 22000 for transfers and UDP 21027 for discovery. @@ -477,7 +477,7 @@ in { type = types.package; default = pkgs.syncthing; defaultText = literalExpression "pkgs.syncthing"; - description = '' + description = lib.mdDoc '' The Syncthing package to use. ''; }; diff --git a/nixos/modules/services/networking/tailscale.nix b/nixos/modules/services/networking/tailscale.nix index 39c9c6fc5b0d1..12ac6d6da5a85 100644 --- a/nixos/modules/services/networking/tailscale.nix +++ b/nixos/modules/services/networking/tailscale.nix @@ -17,26 +17,26 @@ in { port = mkOption { type = types.port; default = 41641; - description = "The port to listen on for tunnel traffic (0=autoselect)."; + description = lib.mdDoc "The port to listen on for tunnel traffic (0=autoselect)."; }; interfaceName = mkOption { type = types.str; default = "tailscale0"; - description = ''The interface name for tunnel traffic. Use "userspace-networking" (beta) to not use TUN.''; + description = lib.mdDoc ''The interface name for tunnel traffic. Use "userspace-networking" (beta) to not use TUN.''; }; permitCertUid = mkOption { type = types.nullOr types.nonEmptyStr; default = null; - description = "Username or user ID of the user allowed to to fetch Tailscale TLS certificates for the node."; + description = lib.mdDoc "Username or user ID of the user allowed to to fetch Tailscale TLS certificates for the node."; }; package = mkOption { type = types.package; default = pkgs.tailscale; defaultText = literalExpression "pkgs.tailscale"; - description = "The package to use for tailscale"; + description = lib.mdDoc "The package to use for tailscale"; }; }; diff --git a/nixos/modules/services/networking/tcpcrypt.nix b/nixos/modules/services/networking/tcpcrypt.nix index 5a91054e1668e..f2115a6660cbf 100644 --- a/nixos/modules/services/networking/tcpcrypt.nix +++ b/nixos/modules/services/networking/tcpcrypt.nix @@ -17,7 +17,7 @@ in networking.tcpcrypt.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable opportunistic TCP encryption. If the other end speaks Tcpcrypt, then your traffic will be encrypted; otherwise it will be sent in clear text. Thus, Tcpcrypt alone provides no diff --git a/nixos/modules/services/networking/teamspeak3.nix b/nixos/modules/services/networking/teamspeak3.nix index c0ed08282aaf3..3be9fb31ec79b 100644 --- a/nixos/modules/services/networking/teamspeak3.nix +++ b/nixos/modules/services/networking/teamspeak3.nix @@ -19,7 +19,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to run the Teamspeak3 voice communication server daemon. ''; }; @@ -27,7 +27,7 @@ in dataDir = mkOption { type = types.path; default = "/var/lib/teamspeak3-server"; - description = '' + description = lib.mdDoc '' Directory to store TS3 database and other state/data files. ''; }; @@ -35,7 +35,7 @@ in logPath = mkOption { type = types.path; default = "/var/log/teamspeak3-server/"; - description = '' + description = lib.mdDoc '' Directory to store log files in. ''; }; @@ -44,7 +44,7 @@ in type = types.nullOr types.str; default = null; example = "[::]"; - description = '' + description = lib.mdDoc '' IP on which the server instance will listen for incoming voice connections. Defaults to any IP. ''; }; @@ -52,7 +52,7 @@ in defaultVoicePort = mkOption { type = types.int; default = 9987; - description = '' + description = lib.mdDoc '' Default UDP port for clients to connect to virtual servers - used for first virtual server, subsequent ones will open on incrementing port numbers by default. ''; }; @@ -61,7 +61,7 @@ in type = types.nullOr types.str; default = null; example = "[::]"; - description = '' + description = lib.mdDoc '' IP on which the server instance will listen for incoming file transfer connections. Defaults to any IP. ''; }; @@ -69,7 +69,7 @@ in fileTransferPort = mkOption { type = types.int; default = 30033; - description = '' + description = lib.mdDoc '' TCP port opened for file transfers. ''; }; @@ -78,7 +78,7 @@ in type = types.nullOr types.str; default = null; example = "0.0.0.0"; - description = '' + description = lib.mdDoc '' IP on which the server instance will listen for incoming ServerQuery connections. Defaults to any IP. ''; }; @@ -86,7 +86,7 @@ in queryPort = mkOption { type = types.int; default = 10011; - description = '' + description = lib.mdDoc '' TCP port opened for ServerQuery connections. ''; }; @@ -94,13 +94,13 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = "Open ports in the firewall for the TeamSpeak3 server."; + description = lib.mdDoc "Open ports in the firewall for the TeamSpeak3 server."; }; openFirewallServerQuery = mkOption { type = types.bool; default = false; - description = "Open ports in the firewall for the TeamSpeak3 serverquery (administration) system. Requires openFirewall."; + description = lib.mdDoc "Open ports in the firewall for the TeamSpeak3 serverquery (administration) system. Requires openFirewall."; }; }; diff --git a/nixos/modules/services/networking/tedicross.nix b/nixos/modules/services/networking/tedicross.nix index c7830289dca05..3d7f298efacd9 100644 --- a/nixos/modules/services/networking/tedicross.nix +++ b/nixos/modules/services/networking/tedicross.nix @@ -57,9 +57,9 @@ in { debug = false; } ''; - description = '' - <filename>settings.yaml</filename> configuration as a Nix attribute set. - Secret tokens should be specified using <option>environmentFile</option> + description = lib.mdDoc '' + {file}`settings.yaml` configuration as a Nix attribute set. + Secret tokens should be specified using {option}`environmentFile` instead of this world-readable file. ''; }; @@ -67,10 +67,10 @@ in { environmentFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' File containing environment variables to be passed to the TediCross service, in which secret tokens can be specified securely using the - <literal>TELEGRAM_BOT_TOKEN</literal> and <literal>DISCORD_BOT_TOKEN</literal> + `TELEGRAM_BOT_TOKEN` and `DISCORD_BOT_TOKEN` keys. ''; }; diff --git a/nixos/modules/services/networking/teleport.nix b/nixos/modules/services/networking/teleport.nix index 454791621800a..d03648df34b02 100644 --- a/nixos/modules/services/networking/teleport.nix +++ b/nixos/modules/services/networking/teleport.nix @@ -33,11 +33,11 @@ in auth_service.enabled = false; } ''; - description = '' - Contents of the <literal>teleport.yaml</literal> config file. - The <literal>--config</literal> arguments will only be passed if this set is not empty. + description = lib.mdDoc '' + Contents of the `teleport.yaml` config file. + The `--config` arguments will only be passed if this set is not empty. - See <link xlink:href="https://goteleport.com/docs/setup/reference/config/"/>. + See <https://goteleport.com/docs/setup/reference/config/>. ''; }; @@ -61,13 +61,13 @@ in addr = mkOption { type = str; default = "127.0.0.1"; - description = "Metrics and diagnostics address."; + description = lib.mdDoc "Metrics and diagnostics address."; }; port = mkOption { type = int; default = 3000; - description = "Metrics and diagnostics port."; + description = lib.mdDoc "Metrics and diagnostics port."; }; }; }; diff --git a/nixos/modules/services/networking/tftpd.nix b/nixos/modules/services/networking/tftpd.nix index c9c0a2b321d5a..a4dc137daa4c9 100644 --- a/nixos/modules/services/networking/tftpd.nix +++ b/nixos/modules/services/networking/tftpd.nix @@ -11,7 +11,7 @@ with lib; services.tftpd.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable tftpd, a Trivial File Transfer Protocol server. The server will be run as an xinetd service. ''; @@ -20,7 +20,7 @@ with lib; services.tftpd.path = mkOption { type = types.path; default = "/srv/tftp"; - description = '' + description = lib.mdDoc '' Where the tftp server files are stored. ''; }; diff --git a/nixos/modules/services/networking/thelounge.nix b/nixos/modules/services/networking/thelounge.nix index a5118fd8b3398..8db541d8072b0 100644 --- a/nixos/modules/services/networking/thelounge.nix +++ b/nixos/modules/services/networking/thelounge.nix @@ -28,11 +28,11 @@ in public = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Make your The Lounge instance public. - Setting this to <literal>false</literal> will require you to configure user - accounts by using the (<command>thelounge</command>) command or by adding - entries in <filename>${dataDir}/users</filename>. You might need to restart + Setting this to `false` will require you to configure user + accounts by using the ({command}`thelounge`) command or by adding + entries in {file}`${dataDir}/users`. You might need to restart The Lounge after making changes to the state directory. ''; }; @@ -40,7 +40,7 @@ in port = mkOption { type = types.port; default = 9000; - description = "TCP port to listen on for http connections."; + description = lib.mdDoc "TCP port to listen on for http connections."; }; extraConfig = mkOption { @@ -54,14 +54,14 @@ in port = 6697; }; }''; - description = '' - The Lounge's <filename>config.js</filename> contents as attribute set (will be + description = lib.mdDoc '' + The Lounge's {file}`config.js` contents as attribute set (will be converted to JSON to generate the configuration file). The options defined here will be merged to the default configuration file. - Note: In case of duplicate configuration, options from <option>extraConfig</option> have priority. + Note: In case of duplicate configuration, options from {option}`extraConfig` have priority. - Documentation: <link xlink:href="https://thelounge.chat/docs/server/configuration" /> + Documentation: <https://thelounge.chat/docs/server/configuration> ''; }; @@ -69,9 +69,9 @@ in default = [ ]; type = types.listOf types.package; example = literalExpression "[ pkgs.theLoungePlugins.themes.solarized ]"; - description = '' + description = lib.mdDoc '' The Lounge plugins to install. Plugins can be found in - <literal>pkgs.theLoungePlugins.plugins</literal> and <literal>pkgs.theLoungePlugins.themes</literal>. + `pkgs.theLoungePlugins.plugins` and `pkgs.theLoungePlugins.themes`. ''; }; }; diff --git a/nixos/modules/services/networking/tinc.nix b/nixos/modules/services/networking/tinc.nix index 31731b60d484d..1f93d82f96ebe 100644 --- a/nixos/modules/services/networking/tinc.nix +++ b/nixos/modules/services/networking/tinc.nix @@ -24,13 +24,13 @@ let options = { address = mkOption { type = types.str; - description = "The external IP address or hostname where the host can be reached."; + description = lib.mdDoc "The external IP address or hostname where the host can be reached."; }; port = mkOption { type = types.nullOr types.port; default = null; - description = '' + description = lib.mdDoc '' The port where the host can be reached. If no port is specified, the default Port is used. @@ -43,7 +43,7 @@ let options = { address = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The subnet of this host. Subnets can either be single MAC, IPv4 or IPv6 addresses, in which case @@ -60,7 +60,7 @@ let prefixLength = mkOption { type = with types; nullOr (addCheck int (n: n >= 0 && n <= 128)); default = null; - description = '' + description = lib.mdDoc '' The prefix length of the subnet. If null, a subnet consisting of only that single address is assumed. @@ -72,7 +72,7 @@ let weight = mkOption { type = types.ints.unsigned; default = 10; - description = '' + description = lib.mdDoc '' Indicates the priority over identical Subnets owned by different nodes. Lower values indicate higher priority. Packets will be sent to the @@ -89,9 +89,9 @@ let addresses = mkOption { type = types.listOf (types.submodule addressSubmodule); default = [ ]; - description = '' + description = lib.mdDoc '' The external address where the host can be reached. This will set this - host's <option>settings.Address</option> option. + host's {option}`settings.Address` option. This variable is only required if you want to connect to this host. ''; @@ -100,9 +100,9 @@ let subnets = mkOption { type = types.listOf (types.submodule subnetSubmodule); default = [ ]; - description = '' + description = lib.mdDoc '' The subnets which this tinc daemon will serve. This will set this - host's <option>settings.Subnet</option> option. + host's {option}`settings.Subnet` option. Tinc tries to look up which other daemon it should send a packet to by searching the appropriate subnet. If the packet matches a subnet, it @@ -114,24 +114,24 @@ let rsaPublicKey = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Legacy RSA public key of the host in PEM format, including start and end markers. This will be appended as-is in the host's configuration file. The ed25519 public key can be specified using the - <option>settings.Ed25519PublicKey</option> option instead. + {option}`settings.Ed25519PublicKey` option instead. ''; }; settings = mkOption { default = { }; type = types.submodule { freeformType = tincConfType; }; - description = '' + description = lib.mdDoc '' Configuration for this host. - See <link xlink:href="https://tinc-vpn.org/documentation-1.1/Host-configuration-variables.html"/> + See <https://tinc-vpn.org/documentation-1.1/Host-configuration-variables.html> for supported values. ''; }; @@ -167,10 +167,10 @@ in extraConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Extra lines to add to the tinc service configuration file. - Note that using the declarative <option>service.tinc.networks.<name>.settings</option> + Note that using the declarative {option}`service.tinc.networks.<name>.settings` option is preferred. ''; }; @@ -178,7 +178,7 @@ in name = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The name of the node which is used as an identifier when communicating with the remote nodes in the mesh. If null then the hostname of the system is used to derive a name (note that tinc may replace non-alphanumeric characters in @@ -189,7 +189,7 @@ in ed25519PrivateKeyFile = mkOption { default = null; type = types.nullOr types.path; - description = '' + description = lib.mdDoc '' Path of the private ed25519 keyfile. ''; }; @@ -197,7 +197,7 @@ in rsaPrivateKeyFile = mkOption { default = null; type = types.nullOr types.path; - description = '' + description = lib.mdDoc '' Path of the private RSA keyfile. ''; }; @@ -205,9 +205,9 @@ in debugLevel = mkOption { default = 0; type = types.addCheck types.int (l: l >= 0 && l <= 5); - description = '' + description = lib.mdDoc '' The amount of debugging information to add to the log. 0 means little - logging while 5 is the most logging. <command>man tincd</command> for + logging while 5 is the most logging. {command}`man tincd` for more details. ''; }; @@ -215,11 +215,11 @@ in hosts = mkOption { default = { }; type = types.attrsOf types.lines; - description = '' + description = lib.mdDoc '' The name of the host in the network as well as the configuration for that host. This name should only contain alphanumerics and underscores. - Note that using the declarative <option>service.tinc.networks.<name>.hostSettings</option> + Note that using the declarative {option}`service.tinc.networks.<name>.hostSettings` option is preferred. ''; }; @@ -249,7 +249,7 @@ in } ''; type = types.attrsOf (types.submodule hostSubmodule); - description = '' + description = lib.mdDoc '' The name of the host in the network as well as the configuration for that host. This name should only contain alphanumerics and underscores. ''; @@ -258,7 +258,7 @@ in interfaceType = mkOption { default = "tun"; type = types.enum [ "tun" "tap" ]; - description = '' + description = lib.mdDoc '' The type of virtual interface used for the network connection. ''; }; @@ -266,7 +266,7 @@ in listenAddress = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The ip address to listen on for incoming connections. ''; }; @@ -274,7 +274,7 @@ in bindToAddress = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The ip address to bind to (both listen on and send packets from). ''; }; @@ -283,7 +283,7 @@ in type = types.package; default = pkgs.tinc_pre; defaultText = literalExpression "pkgs.tinc_pre"; - description = '' + description = lib.mdDoc '' The package to use for the tinc daemon's binary. ''; }; @@ -291,7 +291,7 @@ in chroot = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Change process root directory to the directory where the config file is located (/etc/tinc/netname/), for added security. The chroot is performed after all the initialization is done, after writing pid files and opening network sockets. @@ -309,10 +309,10 @@ in Mode = "switch"; } ''; - description = '' + description = lib.mdDoc '' Configuration of the Tinc daemon for this network. - See <link xlink:href="https://tinc-vpn.org/documentation-1.1/Main-configuration-variables.html"/> + See <https://tinc-vpn.org/documentation-1.1/Main-configuration-variables.html> for supported values. ''; }; @@ -337,7 +337,7 @@ in }; })); - description = '' + description = lib.mdDoc '' Defines the tinc networks which will be started. Each network invokes a different daemon. ''; diff --git a/nixos/modules/services/networking/tinydns.nix b/nixos/modules/services/networking/tinydns.nix index 2c44ad49296d7..ea91af5f19678 100644 --- a/nixos/modules/services/networking/tinydns.nix +++ b/nixos/modules/services/networking/tinydns.nix @@ -10,19 +10,19 @@ with lib; enable = mkOption { default = false; type = types.bool; - description = "Whether to run the tinydns dns server"; + description = lib.mdDoc "Whether to run the tinydns dns server"; }; data = mkOption { type = types.lines; default = ""; - description = "The DNS data to serve, in the format described by tinydns-data(8)"; + description = lib.mdDoc "The DNS data to serve, in the format described by tinydns-data(8)"; }; ip = mkOption { default = "0.0.0.0"; type = types.str; - description = "IP address on which to listen for connections"; + description = lib.mdDoc "IP address on which to listen for connections"; }; }; }; diff --git a/nixos/modules/services/networking/tox-bootstrapd.nix b/nixos/modules/services/networking/tox-bootstrapd.nix index 7c13724e084a2..e6dc36bf9ecfc 100644 --- a/nixos/modules/services/networking/tox-bootstrapd.nix +++ b/nixos/modules/services/networking/tox-bootstrapd.nix @@ -23,7 +23,7 @@ in type = types.bool; default = false; description = - '' + lib.mdDoc '' Whether to enable the Tox DHT bootstrap daemon. ''; }; @@ -31,23 +31,23 @@ in port = mkOption { type = types.int; default = 33445; - description = "Listening port (UDP)."; + description = lib.mdDoc "Listening port (UDP)."; }; keysFile = mkOption { type = types.str; default = "${WorkingDirectory}/keys"; - description = "Node key file."; + description = lib.mdDoc "Node key file."; }; extraConfig = mkOption { type = types.lines; default = ""; description = - '' + lib.mdDoc '' Configuration for bootstrap daemon. - See <link xlink:href="https://github.com/irungentoo/toxcore/blob/master/other/bootstrap_daemon/tox-bootstrapd.conf"/> - and <link xlink:href="http://wiki.tox.im/Nodes"/>. + See <https://github.com/irungentoo/toxcore/blob/master/other/bootstrap_daemon/tox-bootstrapd.conf> + and <http://wiki.tox.im/Nodes>. ''; }; }; diff --git a/nixos/modules/services/networking/tox-node.nix b/nixos/modules/services/networking/tox-node.nix index c6e5c2d6e8190..9371066be8e2f 100644 --- a/nixos/modules/services/networking/tox-node.nix +++ b/nixos/modules/services/networking/tox-node.nix @@ -33,42 +33,42 @@ in { logType = mkOption { type = types.enum [ "Stderr" "Stdout" "Syslog" "None" ]; default = "Stderr"; - description = "Logging implementation."; + description = lib.mdDoc "Logging implementation."; }; keysFile = mkOption { type = types.str; default = "${homeDir}/keys"; - description = "Path to the file where DHT keys are stored."; + description = lib.mdDoc "Path to the file where DHT keys are stored."; }; udpAddress = mkOption { type = types.str; default = "0.0.0.0:33445"; - description = "UDP address to run DHT node."; + description = lib.mdDoc "UDP address to run DHT node."; }; tcpAddresses = mkOption { type = types.listOf types.str; default = [ "0.0.0.0:33445" ]; - description = "TCP addresses to run TCP relay."; + description = lib.mdDoc "TCP addresses to run TCP relay."; }; tcpConnectionLimit = mkOption { type = types.int; default = 8192; - description = "Maximum number of active TCP connections relay can hold"; + description = lib.mdDoc "Maximum number of active TCP connections relay can hold"; }; lanDiscovery = mkOption { type = types.bool; default = true; - description = "Enable local network discovery."; + description = lib.mdDoc "Enable local network discovery."; }; threads = mkOption { type = types.int; default = 1; - description = "Number of threads for execution"; + description = lib.mdDoc "Number of threads for execution"; }; motd = mkOption { type = types.str; default = "Hi from tox-rs! I'm up {{uptime}}. TCP: incoming {{tcp_packets_in}}, outgoing {{tcp_packets_out}}, UDP: incoming {{udp_packets_in}}, outgoing {{udp_packets_out}}"; - description = "Message of the day"; + description = lib.mdDoc "Message of the day"; }; }; diff --git a/nixos/modules/services/networking/toxvpn.nix b/nixos/modules/services/networking/toxvpn.nix index 18cf7672d5f46..618726b0640dd 100644 --- a/nixos/modules/services/networking/toxvpn.nix +++ b/nixos/modules/services/networking/toxvpn.nix @@ -10,20 +10,20 @@ with lib; localip = mkOption { type = types.str; default = "10.123.123.1"; - description = "your ip on the vpn"; + description = lib.mdDoc "your ip on the vpn"; }; port = mkOption { type = types.int; default = 33445; - description = "udp port for toxcore, port-forward to help with connectivity if you run many nodes behind one NAT"; + description = lib.mdDoc "udp port for toxcore, port-forward to help with connectivity if you run many nodes behind one NAT"; }; auto_add_peers = mkOption { type = types.listOf types.str; default = []; example = [ "toxid1" "toxid2" ]; - description = "peers to automatically connect to on startup"; + description = lib.mdDoc "peers to automatically connect to on startup"; }; }; }; diff --git a/nixos/modules/services/networking/trickster.nix b/nixos/modules/services/networking/trickster.nix index ac260a14d9a2d..0b696e412b4d9 100644 --- a/nixos/modules/services/networking/trickster.nix +++ b/nixos/modules/services/networking/trickster.nix @@ -15,7 +15,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable Trickster. ''; }; @@ -24,7 +24,7 @@ in type = types.package; default = pkgs.trickster; defaultText = literalExpression "pkgs.trickster"; - description = '' + description = lib.mdDoc '' Package that should be used for trickster. ''; }; @@ -32,7 +32,7 @@ in configFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Path to configuration file. ''; }; @@ -40,7 +40,7 @@ in instance-id = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Instance ID for when running multiple processes (default null). ''; }; @@ -48,7 +48,7 @@ in log-level = mkOption { type = types.str; default = "info"; - description = '' + description = lib.mdDoc '' Level of Logging to use (debug, info, warn, error) (default "info"). ''; }; @@ -56,7 +56,7 @@ in metrics-port = mkOption { type = types.port; default = 8082; - description = '' + description = lib.mdDoc '' Port that the /metrics endpoint will listen on. ''; }; @@ -64,7 +64,7 @@ in origin-type = mkOption { type = types.enum [ "prometheus" "influxdb" ]; default = "prometheus"; - description = '' + description = lib.mdDoc '' Type of origin (prometheus, influxdb) ''; }; @@ -72,7 +72,7 @@ in origin-url = mkOption { type = types.str; default = "http://prometheus:9090"; - description = '' + description = lib.mdDoc '' URL to the Origin. Enter it like you would in grafana, e.g., http://prometheus:9090 (default http://prometheus:9090). ''; }; @@ -80,7 +80,7 @@ in profiler-port = mkOption { type = types.nullOr types.port; default = null; - description = '' + description = lib.mdDoc '' Port that the /debug/pprof endpoint will listen on. ''; }; @@ -88,7 +88,7 @@ in proxy-port = mkOption { type = types.port; default = 9090; - description = '' + description = lib.mdDoc '' Port that the Proxy server will listen on. ''; }; diff --git a/nixos/modules/services/networking/tvheadend.nix b/nixos/modules/services/networking/tvheadend.nix index 19a10a03bd9b6..dd5fa209be6bd 100644 --- a/nixos/modules/services/networking/tvheadend.nix +++ b/nixos/modules/services/networking/tvheadend.nix @@ -13,13 +13,13 @@ in httpPort = mkOption { type = types.int; default = 9981; - description = "Port to bind HTTP to."; + description = lib.mdDoc "Port to bind HTTP to."; }; htspPort = mkOption { type = types.int; default = 9982; - description = "Port to bind HTSP to."; + description = lib.mdDoc "Port to bind HTSP to."; }; }; }; diff --git a/nixos/modules/services/networking/ucarp.nix b/nixos/modules/services/networking/ucarp.nix index 189e4f99cefec..7e8b1026db702 100644 --- a/nixos/modules/services/networking/ucarp.nix +++ b/nixos/modules/services/networking/ucarp.nix @@ -32,30 +32,30 @@ in { interface = mkOption { type = types.str; - description = "Network interface to bind to."; + description = lib.mdDoc "Network interface to bind to."; example = "eth0"; }; srcIp = mkOption { type = types.str; - description = "Source (real) IP address of this host."; + description = lib.mdDoc "Source (real) IP address of this host."; }; vhId = mkOption { type = types.ints.between 1 255; - description = "Virtual IP identifier shared between CARP hosts."; + description = lib.mdDoc "Virtual IP identifier shared between CARP hosts."; example = 1; }; passwordFile = mkOption { type = types.str; - description = "File containing shared password between CARP hosts."; + description = lib.mdDoc "File containing shared password between CARP hosts."; example = "/run/keys/ucarp-password"; }; preempt = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Enable preemptive failover. Thus, this host becomes the CARP master as soon as possible. ''; @@ -64,30 +64,30 @@ in { neutral = mkOption { type = types.bool; - description = "Do not run downscript at start if the host is the backup."; + description = lib.mdDoc "Do not run downscript at start if the host is the backup."; default = false; }; addr = mkOption { type = types.str; - description = "Virtual shared IP address."; + description = lib.mdDoc "Virtual shared IP address."; }; advBase = mkOption { type = types.ints.unsigned; - description = "Advertisement frequency in seconds."; + description = lib.mdDoc "Advertisement frequency in seconds."; default = 1; }; advSkew = mkOption { type = types.ints.unsigned; - description = "Advertisement skew in seconds."; + description = lib.mdDoc "Advertisement skew in seconds."; default = 0; }; upscript = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' Command to run after become master, the interface name, virtual address and optional extra parameters are passed as arguments. ''; @@ -101,7 +101,7 @@ in { downscript = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' Command to run after become backup, the interface name, virtual address and optional extra parameters are passed as arguments. ''; @@ -115,37 +115,37 @@ in { deadratio = mkOption { type = types.ints.unsigned; - description = "Ratio to consider a host as dead."; + description = lib.mdDoc "Ratio to consider a host as dead."; default = 3; }; shutdown = mkOption { type = types.bool; - description = "Call downscript at exit."; + description = lib.mdDoc "Call downscript at exit."; default = false; }; ignoreIfState = mkOption { type = types.bool; - description = "Ignore interface state, e.g., down or no carrier."; + description = lib.mdDoc "Ignore interface state, e.g., down or no carrier."; default = false; }; noMcast = mkOption { type = types.bool; - description = "Use broadcast instead of multicast advertisements."; + description = lib.mdDoc "Use broadcast instead of multicast advertisements."; default = false; }; extraParam = mkOption { type = types.nullOr types.str; - description = "Extra parameter to pass to the up/down scripts."; + description = lib.mdDoc "Extra parameter to pass to the up/down scripts."; default = null; }; package = mkOption { type = types.package; - description = '' + description = lib.mdDoc '' Package that should be used for ucarp. Please note that the default package, pkgs.ucarp, has not received any diff --git a/nixos/modules/services/networking/unbound.nix b/nixos/modules/services/networking/unbound.nix index 87873c8c1e83b..7460ba3df7b96 100644 --- a/nixos/modules/services/networking/unbound.nix +++ b/nixos/modules/services/networking/unbound.nix @@ -46,31 +46,31 @@ in { type = types.package; default = pkgs.unbound-with-systemd; defaultText = literalExpression "pkgs.unbound-with-systemd"; - description = "The unbound package to use"; + description = lib.mdDoc "The unbound package to use"; }; user = mkOption { type = types.str; default = "unbound"; - description = "User account under which unbound runs."; + description = lib.mdDoc "User account under which unbound runs."; }; group = mkOption { type = types.str; default = "unbound"; - description = "Group under which unbound runs."; + description = lib.mdDoc "Group under which unbound runs."; }; stateDir = mkOption { type = types.path; default = "/var/lib/unbound"; - description = "Directory holding all state for unbound to run."; + description = lib.mdDoc "Directory holding all state for unbound to run."; }; resolveLocalQueries = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether unbound should resolve local queries (i.e. add 127.0.0.1 to /etc/resolv.conf). ''; @@ -79,7 +79,7 @@ in { enableRootTrustAnchor = mkOption { default = true; type = types.bool; - description = "Use and update root trust anchor for DNSSEC validation."; + description = lib.mdDoc "Use and update root trust anchor for DNSSEC validation."; }; localControlSocketPath = mkOption { @@ -90,16 +90,16 @@ in { # but I haven't verified yet. type = types.nullOr types.str; example = "/run/unbound/unbound.ctl"; - description = '' - When not set to <literal>null</literal> this option defines the path + description = lib.mdDoc '' + When not set to `null` this option defines the path at which the unbound remote control socket should be created at. The - socket will be owned by the unbound user (<literal>unbound</literal>) - and group will be <literal>nogroup</literal>. + socket will be owned by the unbound user (`unbound`) + and group will be `nogroup`. Users that should be permitted to access the socket must be in the - <literal>config.services.unbound.group</literal> group. + `config.services.unbound.group` group. - If this option is <literal>null</literal> remote control will not be + If this option is `null` remote control will not be enabled. Unbounds default values apply. ''; }; diff --git a/nixos/modules/services/networking/unifi.nix b/nixos/modules/services/networking/unifi.nix index e88daae1fbbac..d30f7c89633b3 100644 --- a/nixos/modules/services/networking/unifi.nix +++ b/nixos/modules/services/networking/unifi.nix @@ -17,7 +17,7 @@ in services.unifi.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether or not to enable the unifi controller service. ''; }; @@ -26,7 +26,7 @@ in type = types.package; default = pkgs.jre8; defaultText = literalExpression "pkgs.jre8"; - description = '' + description = lib.mdDoc '' The JRE package to use. Check the release notes to ensure it is supported. ''; }; @@ -35,7 +35,7 @@ in type = types.package; default = pkgs.unifiLTS; defaultText = literalExpression "pkgs.unifiLTS"; - description = '' + description = lib.mdDoc '' The unifi package to use. ''; }; @@ -44,7 +44,7 @@ in type = types.package; default = pkgs.mongodb; defaultText = literalExpression "pkgs.mongodb"; - description = '' + description = lib.mdDoc '' The mongodb package to use. ''; }; @@ -52,7 +52,7 @@ in services.unifi.openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether or not to open the minimum required ports on the firewall. This is necessary to allow firmware upgrades and device discovery to @@ -65,7 +65,7 @@ in type = types.nullOr types.int; default = null; example = 1024; - description = '' + description = lib.mdDoc '' Set the initial heap size for the JVM in MB. If this option isn't set, the JVM will decide this value at runtime. ''; @@ -75,7 +75,7 @@ in type = types.nullOr types.int; default = null; example = 4096; - description = '' + description = lib.mdDoc '' Set the maximimum heap size for the JVM in MB. If this option isn't set, the JVM will decide this value at runtime. ''; diff --git a/nixos/modules/services/networking/uptermd.nix b/nixos/modules/services/networking/uptermd.nix index b845a00649eba..387478de99ebd 100644 --- a/nixos/modules/services/networking/uptermd.nix +++ b/nixos/modules/services/networking/uptermd.nix @@ -13,15 +13,15 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' - Whether to open the firewall for the port in <option>services.uptermd.port</option>. + description = lib.mdDoc '' + Whether to open the firewall for the port in {option}`services.uptermd.port`. ''; }; port = mkOption { type = types.port; default = 2222; - description = '' + description = lib.mdDoc '' Port the server will listen on. ''; }; @@ -30,7 +30,7 @@ in type = types.str; default = "[::]"; example = "127.0.0.1"; - description = '' + description = lib.mdDoc '' Address the server will listen on. ''; }; @@ -39,7 +39,7 @@ in type = types.nullOr types.path; default = null; example = "/run/keys/upterm_host_ed25519_key"; - description = '' + description = lib.mdDoc '' Path to SSH host key. If not defined, an ed25519 keypair is generated automatically. ''; }; @@ -48,7 +48,7 @@ in type = types.listOf types.str; default = []; example = [ "--debug" ]; - description = '' + description = lib.mdDoc '' Extra flags passed to the uptermd command. ''; }; diff --git a/nixos/modules/services/networking/v2ray.nix b/nixos/modules/services/networking/v2ray.nix index 95e8761ba5cc5..f063ddfed0a79 100644 --- a/nixos/modules/services/networking/v2ray.nix +++ b/nixos/modules/services/networking/v2ray.nix @@ -9,10 +9,10 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to run v2ray server. - Either <literal>configFile</literal> or <literal>config</literal> must be specified. + Either `configFile` or `config` must be specified. ''; }; @@ -20,7 +20,7 @@ with lib; type = types.package; default = pkgs.v2ray; defaultText = literalExpression "pkgs.v2ray"; - description = '' + description = lib.mdDoc '' Which v2ray package to use. ''; }; @@ -29,12 +29,12 @@ with lib; type = types.nullOr types.str; default = null; example = "/etc/v2ray/config.json"; - description = '' + description = lib.mdDoc '' The absolute path to the configuration file. - Either <literal>configFile</literal> or <literal>config</literal> must be specified. + Either `configFile` or `config` must be specified. - See <link xlink:href="https://www.v2fly.org/en_US/config/overview.html"/>. + See <https://www.v2fly.org/en_US/config/overview.html>. ''; }; diff --git a/nixos/modules/services/networking/vsftpd.nix b/nixos/modules/services/networking/vsftpd.nix index d205302051e14..b26adbf8719bb 100644 --- a/nixos/modules/services/networking/vsftpd.nix +++ b/nixos/modules/services/networking/vsftpd.nix @@ -154,18 +154,18 @@ in userlist = mkOption { default = []; type = types.listOf types.str; - description = "See <option>userlistFile</option>."; + description = lib.mdDoc "See {option}`userlistFile`."; }; userlistFile = mkOption { type = types.path; default = pkgs.writeText "userlist" (concatMapStrings (x: "${x}\n") cfg.userlist); defaultText = literalExpression ''pkgs.writeText "userlist" (concatMapStrings (x: "''${x}\n") cfg.userlist)''; - description = '' - Newline separated list of names to be allowed/denied if <option>userlistEnable</option> - is <literal>true</literal>. Meaning see <option>userlistDeny</option>. + description = lib.mdDoc '' + Newline separated list of names to be allowed/denied if {option}`userlistEnable` + is `true`. Meaning see {option}`userlistDeny`. - The default is a file containing the users from <option>userlist</option>. + The default is a file containing the users from {option}`userlist`. If explicitely set to null userlist_file will not be set in vsftpd's config file. ''; @@ -174,8 +174,8 @@ in enableVirtualUsers = mkOption { type = types.bool; default = false; - description = '' - Whether to enable the <literal>pam_userdb</literal>-based + description = lib.mdDoc '' + Whether to enable the `pam_userdb`-based virtual user system ''; }; @@ -218,7 +218,7 @@ in type = types.nullOr types.str; default = null; example = "/var/www/$USER"; - description = '' + description = lib.mdDoc '' This option represents a directory which vsftpd will try to change into after a local (i.e. non- anonymous) login. @@ -229,7 +229,7 @@ in anonymousUserHome = mkOption { type = types.path; default = "/home/ftp/"; - description = '' + description = lib.mdDoc '' Directory to consider the HOME of the anonymous user. ''; }; @@ -237,27 +237,27 @@ in rsaCertFile = mkOption { type = types.nullOr types.path; default = null; - description = "RSA certificate file."; + description = lib.mdDoc "RSA certificate file."; }; rsaKeyFile = mkOption { type = types.nullOr types.path; default = null; - description = "RSA private key file."; + description = lib.mdDoc "RSA private key file."; }; anonymousUmask = mkOption { type = types.str; default = "077"; example = "002"; - description = "Anonymous write umask."; + description = lib.mdDoc "Anonymous write umask."; }; extraConfig = mkOption { type = types.lines; default = ""; example = "ftpd_banner=Hello"; - description = "Extra configuration to add at the bottom of the generated configuration file."; + description = lib.mdDoc "Extra configuration to add at the bottom of the generated configuration file."; }; } // (listToAttrs (catAttrs "nixosOption" optionDescription)); diff --git a/nixos/modules/services/networking/wasabibackend.nix b/nixos/modules/services/networking/wasabibackend.nix index b6dcd940915a9..00d772a718c6f 100644 --- a/nixos/modules/services/networking/wasabibackend.nix +++ b/nixos/modules/services/networking/wasabibackend.nix @@ -34,32 +34,32 @@ in { dataDir = mkOption { type = types.path; default = "/var/lib/wasabibackend"; - description = "The data directory for the Wasabi backend node."; + description = lib.mdDoc "The data directory for the Wasabi backend node."; }; customConfigFile = mkOption { type = types.nullOr types.path; default = null; - description = "Defines the path to a custom configuration file that is copied to the user's directory. Overrides any config options."; + description = lib.mdDoc "Defines the path to a custom configuration file that is copied to the user's directory. Overrides any config options."; }; network = mkOption { type = types.enum [ "mainnet" "testnet" "regtest" ]; default = "mainnet"; - description = "The network to use for the Wasabi backend service."; + description = lib.mdDoc "The network to use for the Wasabi backend service."; }; endpoint = { ip = mkOption { type = types.str; default = "127.0.0.1"; - description = "IP address for P2P connection to bitcoind."; + description = lib.mdDoc "IP address for P2P connection to bitcoind."; }; port = mkOption { type = types.port; default = 8333; - description = "Port for P2P connection to bitcoind."; + description = lib.mdDoc "Port for P2P connection to bitcoind."; }; }; @@ -67,45 +67,45 @@ in { ip = mkOption { type = types.str; default = "127.0.0.1"; - description = "IP address for RPC connection to bitcoind."; + description = lib.mdDoc "IP address for RPC connection to bitcoind."; }; port = mkOption { type = types.port; default = 8332; - description = "Port for RPC connection to bitcoind."; + description = lib.mdDoc "Port for RPC connection to bitcoind."; }; user = mkOption { type = types.str; default = "bitcoin"; - description = "RPC user for the bitcoin endpoint."; + description = lib.mdDoc "RPC user for the bitcoin endpoint."; }; password = mkOption { type = types.str; default = "password"; - description = "RPC password for the bitcoin endpoint. Warning: this is stored in cleartext in the Nix store! Use <literal>configFile</literal> or <literal>passwordFile</literal> if needed."; + description = lib.mdDoc "RPC password for the bitcoin endpoint. Warning: this is stored in cleartext in the Nix store! Use `configFile` or `passwordFile` if needed."; }; passwordFile = mkOption { type = types.nullOr types.path; default = null; - description = "File that contains the password of the RPC user."; + description = lib.mdDoc "File that contains the password of the RPC user."; }; }; user = mkOption { type = types.str; default = "wasabibackend"; - description = "The user as which to run the wasabibackend node."; + description = lib.mdDoc "The user as which to run the wasabibackend node."; }; group = mkOption { type = types.str; default = cfg.user; defaultText = literalExpression "config.${opt.user}"; - description = "The group as which to run the wasabibackend node."; + description = lib.mdDoc "The group as which to run the wasabibackend node."; }; }; }; diff --git a/nixos/modules/services/networking/websockify.nix b/nixos/modules/services/networking/websockify.nix index f7e014e03efb5..45a3487bd3370 100644 --- a/nixos/modules/services/networking/websockify.nix +++ b/nixos/modules/services/networking/websockify.nix @@ -6,7 +6,7 @@ let cfg = config.services.networking.websockify; in { options = { services.networking.websockify = { enable = mkOption { - description = "Whether to enable websockify to forward websocket connections to TCP connections."; + description = lib.mdDoc "Whether to enable websockify to forward websocket connections to TCP connections."; default = false; @@ -14,19 +14,19 @@ let cfg = config.services.networking.websockify; in { }; sslCert = mkOption { - description = "Path to the SSL certificate."; + description = lib.mdDoc "Path to the SSL certificate."; type = types.path; }; sslKey = mkOption { - description = "Path to the SSL key."; + description = lib.mdDoc "Path to the SSL key."; default = cfg.sslCert; defaultText = literalExpression "config.services.networking.websockify.sslCert"; type = types.path; }; portMap = mkOption { - description = "Ports to map by default."; + description = lib.mdDoc "Ports to map by default."; default = {}; type = types.attrsOf types.int; }; diff --git a/nixos/modules/services/networking/wg-quick.nix b/nixos/modules/services/networking/wg-quick.nix index d44fad4202bb6..b43c3e8513247 100644 --- a/nixos/modules/services/networking/wg-quick.nix +++ b/nixos/modules/services/networking/wg-quick.nix @@ -15,7 +15,7 @@ let example = "/secret/wg0.conf"; default = null; type = with types; nullOr str; - description = '' + description = lib.mdDoc '' wg-quick .conf file, describing the interface. This overrides any other configuration interface configuration options. See wg-quick manpage for more details. @@ -26,11 +26,11 @@ let example = [ "192.168.2.1/24" ]; default = []; type = with types; listOf str; - description = "The IP addresses of the interface."; + description = lib.mdDoc "The IP addresses of the interface."; }; autostart = mkOption { - description = "Whether to bring up this interface automatically during boot."; + description = lib.mdDoc "Whether to bring up this interface automatically during boot."; default = true; example = false; type = types.bool; @@ -40,15 +40,15 @@ let example = [ "192.168.2.2" ]; default = []; type = with types; listOf str; - description = "The IP addresses of DNS servers to configure."; + description = lib.mdDoc "The IP addresses of DNS servers to configure."; }; privateKey = mkOption { example = "yAnz5TF+lXXJte14tji3zlMNq+hd2rYUIgJBgB3fBmk="; type = with types; nullOr str; default = null; - description = '' - Base64 private key generated by <command>wg genkey</command>. + description = lib.mdDoc '' + Base64 private key generated by {command}`wg genkey`. Warning: Consider using privateKeyFile instead if you do not want to store the key in the world-readable Nix store. @@ -59,8 +59,8 @@ let example = "/private/wireguard_key"; type = with types; nullOr str; default = null; - description = '' - Private key file as generated by <command>wg genkey</command>. + description = lib.mdDoc '' + Private key file as generated by {command}`wg genkey`. ''; }; @@ -68,7 +68,7 @@ let default = null; type = with types; nullOr int; example = 51820; - description = '' + description = lib.mdDoc '' 16-bit port for listening. Optional; if not specified, automatically generated based on interface name. ''; @@ -78,7 +78,7 @@ let example = literalExpression ''"''${pkgs.iproute2}/bin/ip netns add foo"''; default = ""; type = with types; coercedTo (listOf str) (concatStringsSep "\n") lines; - description = '' + description = lib.mdDoc '' Commands called at the start of the interface setup. ''; }; @@ -87,7 +87,7 @@ let example = literalExpression ''"''${pkgs.iproute2}/bin/ip netns del foo"''; default = ""; type = with types; coercedTo (listOf str) (concatStringsSep "\n") lines; - description = '' + description = lib.mdDoc '' Command called before the interface is taken down. ''; }; @@ -96,7 +96,7 @@ let example = literalExpression ''"''${pkgs.iproute2}/bin/ip netns add foo"''; default = ""; type = with types; coercedTo (listOf str) (concatStringsSep "\n") lines; - description = '' + description = lib.mdDoc '' Commands called after the interface setup. ''; }; @@ -105,7 +105,7 @@ let example = literalExpression ''"''${pkgs.iproute2}/bin/ip netns del foo"''; default = ""; type = with types; coercedTo (listOf str) (concatStringsSep "\n") lines; - description = '' + description = lib.mdDoc '' Command called after the interface is taken down. ''; }; @@ -114,7 +114,7 @@ let example = "main"; default = null; type = with types; nullOr str; - description = '' + description = lib.mdDoc '' The kernel routing table to add this interface's associated routes to. Setting this is useful for e.g. policy routing ("ip rule") or virtual routing and forwarding ("ip vrf"). Both @@ -127,7 +127,7 @@ let example = 1248; default = null; type = with types; nullOr int; - description = '' + description = lib.mdDoc '' If not specified, the MTU is automatically determined from the endpoint addresses or the system default route, which is usually a sane choice. However, to manually specify an MTU to override this @@ -137,7 +137,7 @@ let peers = mkOption { default = []; - description = "Peers linked to the interface."; + description = lib.mdDoc "Peers linked to the interface."; type = with types; listOf (submodule peerOpts); }; }; @@ -150,15 +150,15 @@ let publicKey = mkOption { example = "xTIBA5rboUvnH4htodjb6e697QjLERt1NAB4mZqp8Dg="; type = types.str; - description = "The base64 public key to the peer."; + description = lib.mdDoc "The base64 public key to the peer."; }; presharedKey = mkOption { default = null; example = "rVXs/Ni9tu3oDBLS4hOyAUAa1qTWVA3loR8eL20os3I="; type = with types; nullOr str; - description = '' - Base64 preshared key generated by <command>wg genpsk</command>. + description = lib.mdDoc '' + Base64 preshared key generated by {command}`wg genpsk`. Optional, and may be omitted. This option adds an additional layer of symmetric-key cryptography to be mixed into the already existing public-key cryptography, for post-quantum resistance. @@ -172,8 +172,8 @@ let default = null; example = "/private/wireguard_psk"; type = with types; nullOr str; - description = '' - File pointing to preshared key as generated by <command>wg genpsk</command>. + description = lib.mdDoc '' + File pointing to preshared key as generated by {command}`wg genpsk`. Optional, and may be omitted. This option adds an additional layer of symmetric-key cryptography to be mixed into the already existing public-key cryptography, for post-quantum resistance. @@ -183,7 +183,7 @@ let allowedIPs = mkOption { example = [ "10.192.122.3/32" "10.192.124.1/24" ]; type = with types; listOf str; - description = ''List of IP (v4 or v6) addresses with CIDR masks from + description = lib.mdDoc ''List of IP (v4 or v6) addresses with CIDR masks from which this peer is allowed to send incoming traffic and to which outgoing traffic for this peer is directed. The catch-all 0.0.0.0/0 may be specified for matching all IPv4 addresses, and ::/0 may be specified @@ -194,7 +194,7 @@ let default = null; example = "demo.wireguard.io:12913"; type = with types; nullOr str; - description = ''Endpoint IP or hostname of the peer, followed by a colon, + description = lib.mdDoc ''Endpoint IP or hostname of the peer, followed by a colon, and then a port number of the peer.''; }; @@ -202,7 +202,7 @@ let default = null; type = with types; nullOr int; example = 25; - description = ''This is optional and is by default off, because most + description = lib.mdDoc ''This is optional and is by default off, because most users will not need it. It represents, in seconds, between 1 and 65535 inclusive, how often to send an authenticated empty packet to the peer, for the purpose of keeping a stateful firewall or NAT mapping valid @@ -304,7 +304,7 @@ in { options = { networking.wg-quick = { interfaces = mkOption { - description = "Wireguard interfaces."; + description = lib.mdDoc "Wireguard interfaces."; default = {}; example = { wg0 = { diff --git a/nixos/modules/services/networking/wireguard.nix b/nixos/modules/services/networking/wireguard.nix index a3c3c245f1d7f..412e9c921f52e 100644 --- a/nixos/modules/services/networking/wireguard.nix +++ b/nixos/modules/services/networking/wireguard.nix @@ -19,15 +19,15 @@ let example = [ "192.168.2.1/24" ]; default = []; type = with types; listOf str; - description = "The IP addresses of the interface."; + description = lib.mdDoc "The IP addresses of the interface."; }; privateKey = mkOption { example = "yAnz5TF+lXXJte14tji3zlMNq+hd2rYUIgJBgB3fBmk="; type = with types; nullOr str; default = null; - description = '' - Base64 private key generated by <command>wg genkey</command>. + description = lib.mdDoc '' + Base64 private key generated by {command}`wg genkey`. Warning: Consider using privateKeyFile instead if you do not want to store the key in the world-readable Nix store. @@ -37,9 +37,9 @@ let generatePrivateKeyFile = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Automatically generate a private key with - <command>wg genkey</command>, at the privateKeyFile location. + {command}`wg genkey`, at the privateKeyFile location. ''; }; @@ -47,8 +47,8 @@ let example = "/private/wireguard_key"; type = with types; nullOr str; default = null; - description = '' - Private key file as generated by <command>wg genkey</command>. + description = lib.mdDoc '' + Private key file as generated by {command}`wg genkey`. ''; }; @@ -56,7 +56,7 @@ let default = null; type = with types; nullOr int; example = 51820; - description = '' + description = lib.mdDoc '' 16-bit port for listening. Optional; if not specified, automatically generated based on interface name. ''; @@ -66,7 +66,7 @@ let example = literalExpression ''"''${pkgs.iproute2}/bin/ip netns add foo"''; default = ""; type = with types; coercedTo (listOf str) (concatStringsSep "\n") lines; - description = '' + description = lib.mdDoc '' Commands called at the start of the interface setup. ''; }; @@ -77,20 +77,20 @@ let ''; default = ""; type = with types; coercedTo (listOf str) (concatStringsSep "\n") lines; - description = "Commands called at the end of the interface setup."; + description = lib.mdDoc "Commands called at the end of the interface setup."; }; postShutdown = mkOption { example = literalExpression ''"''${pkgs.openresolv}/bin/resolvconf -d wg0"''; default = ""; type = with types; coercedTo (listOf str) (concatStringsSep "\n") lines; - description = "Commands called after shutting down the interface."; + description = lib.mdDoc "Commands called after shutting down the interface."; }; table = mkOption { default = "main"; type = types.str; - description = '' + description = lib.mdDoc '' The kernel routing table to add this interface's associated routes to. Setting this is useful for e.g. policy routing ("ip rule") or virtual routing and forwarding ("ip vrf"). Both @@ -101,7 +101,7 @@ let peers = mkOption { default = []; - description = "Peers linked to the interface."; + description = lib.mdDoc "Peers linked to the interface."; type = with types; listOf (submodule peerOpts); }; @@ -109,7 +109,7 @@ let example = false; default = true; type = types.bool; - description = '' + description = lib.mdDoc '' Determines whether to add allowed IPs as routes or not. ''; }; @@ -152,15 +152,15 @@ let publicKey = mkOption { example = "xTIBA5rboUvnH4htodjb6e697QjLERt1NAB4mZqp8Dg="; type = types.str; - description = "The base64 public key of the peer."; + description = lib.mdDoc "The base64 public key of the peer."; }; presharedKey = mkOption { default = null; example = "rVXs/Ni9tu3oDBLS4hOyAUAa1qTWVA3loR8eL20os3I="; type = with types; nullOr str; - description = '' - Base64 preshared key generated by <command>wg genpsk</command>. + description = lib.mdDoc '' + Base64 preshared key generated by {command}`wg genpsk`. Optional, and may be omitted. This option adds an additional layer of symmetric-key cryptography to be mixed into the already existing public-key cryptography, for post-quantum resistance. @@ -174,8 +174,8 @@ let default = null; example = "/private/wireguard_psk"; type = with types; nullOr str; - description = '' - File pointing to preshared key as generated by <command>wg genpsk</command>. + description = lib.mdDoc '' + File pointing to preshared key as generated by {command}`wg genpsk`. Optional, and may be omitted. This option adds an additional layer of symmetric-key cryptography to be mixed into the already existing public-key cryptography, for post-quantum resistance. @@ -185,7 +185,7 @@ let allowedIPs = mkOption { example = [ "10.192.122.3/32" "10.192.124.1/24" ]; type = with types; listOf str; - description = ''List of IP (v4 or v6) addresses with CIDR masks from + description = lib.mdDoc ''List of IP (v4 or v6) addresses with CIDR masks from which this peer is allowed to send incoming traffic and to which outgoing traffic for this peer is directed. The catch-all 0.0.0.0/0 may be specified for matching all IPv4 addresses, and ::/0 may be specified @@ -216,12 +216,12 @@ let default = 0; example = 5; type = with types; int; - description = '' - Periodically re-execute the <literal>wg</literal> utility every + description = lib.mdDoc '' + Periodically re-execute the `wg` utility every this many seconds in order to let WireGuard notice DNS / hostname changes. - Setting this to <literal>0</literal> disables periodic reexecution. + Setting this to `0` disables periodic reexecution. ''; }; @@ -229,7 +229,7 @@ let default = null; type = with types; nullOr int; example = 25; - description = ''This is optional and is by default off, because most + description = lib.mdDoc ''This is optional and is by default off, because most users will not need it. It represents, in seconds, between 1 and 65535 inclusive, how often to send an authenticated empty packet to the peer, for the purpose of keeping a stateful firewall or NAT mapping valid @@ -437,7 +437,7 @@ in networking.wireguard = { enable = mkOption { - description = "Whether to enable WireGuard."; + description = lib.mdDoc "Whether to enable WireGuard."; type = types.bool; # 2019-05-25: Backwards compatibility. default = cfg.interfaces != {}; @@ -446,7 +446,7 @@ in }; interfaces = mkOption { - description = "WireGuard interfaces."; + description = lib.mdDoc "WireGuard interfaces."; default = {}; example = { wg0 = { diff --git a/nixos/modules/services/networking/wpa_supplicant.nix b/nixos/modules/services/networking/wpa_supplicant.nix index 5a7975ae17828..e21c25e2f78f8 100644 --- a/nixos/modules/services/networking/wpa_supplicant.nix +++ b/nixos/modules/services/networking/wpa_supplicant.nix @@ -183,7 +183,7 @@ in { driver = mkOption { type = types.str; default = "nl80211,wext"; - description = "Force a specific wpa_supplicant driver."; + description = lib.mdDoc "Force a specific wpa_supplicant driver."; }; allowAuxiliaryImperativeNetworks = mkEnableOption "support for imperative & declarative networks" // { @@ -199,7 +199,7 @@ in { scanOnLowSignal = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to periodically scan for (better) networks when the signal of the current one is low. This will make roaming between access points faster, but will consume more power. @@ -209,7 +209,7 @@ in { fallbackToWPA2 = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to fall back to WPA2 authentication protocols if WPA3 failed. This allows old wireless cards (that lack recent features required by WPA3) to connect to mixed WPA2/WPA3 access points. @@ -331,9 +331,9 @@ in { "OWE" "DPP" ]); - description = '' + description = lib.mdDoc '' The list of authentication protocols accepted by this network. - This corresponds to the <literal>key_mgmt</literal> option in wpa_supplicant. + This corresponds to the `key_mgmt` option in wpa_supplicant. ''; }; @@ -369,8 +369,8 @@ in { hidden = mkOption { type = types.bool; default = false; - description = '' - Set this to <literal>true</literal> if the SSID of the network is hidden. + description = lib.mdDoc '' + Set this to `true` if the SSID of the network is hidden. ''; example = literalExpression '' { echelon = { @@ -384,7 +384,7 @@ in { priority = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' By default, all networks will get same priority group (0). If some of the networks are more desirable, this field can be used to change the order in which wpa_supplicant goes through the networks when selecting a BSS. The @@ -414,9 +414,9 @@ in { }; }); - description = '' + description = lib.mdDoc '' The network definitions to automatically connect to when - <command>wpa_supplicant</command> is running. If this + {command}`wpa_supplicant` is running. If this parameter is left empty wpa_supplicant will use /etc/wpa_supplicant.conf as the configuration file. ''; @@ -443,7 +443,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Allow normal users to control wpa_supplicant through wpa_gui or wpa_cli. This is useful for laptop users that switch networks a lot and don't want to depend on a large package such as NetworkManager just to pick nearby @@ -458,7 +458,7 @@ in { type = types.str; default = "wheel"; example = "network"; - description = "Members of this group can control wpa_supplicant."; + description = lib.mdDoc "Members of this group can control wpa_supplicant."; }; }; @@ -466,7 +466,7 @@ in { type = types.bool; default = lib.length cfg.interfaces < 2; defaultText = literalExpression "length config.${opt.interfaces} < 2"; - description = '' + description = lib.mdDoc '' Whether to enable the DBus control interface. This is only needed when using NetworkManager or connman. ''; diff --git a/nixos/modules/services/networking/x2goserver.nix b/nixos/modules/services/networking/x2goserver.nix index d4adf6c5650e9..3c2424b6f4f91 100644 --- a/nixos/modules/services/networking/x2goserver.nix +++ b/nixos/modules/services/networking/x2goserver.nix @@ -42,7 +42,7 @@ in { nxagentDefaultOptions = mkOption { type = types.listOf types.str; default = [ "-extension GLX" "-nolisten tcp" ]; - description = '' + description = lib.mdDoc '' List of default nx agent options. ''; }; diff --git a/nixos/modules/services/networking/xandikos.nix b/nixos/modules/services/networking/xandikos.nix index 4bd45a76e673f..649e9c7a668e5 100644 --- a/nixos/modules/services/networking/xandikos.nix +++ b/nixos/modules/services/networking/xandikos.nix @@ -15,13 +15,13 @@ in type = types.package; default = pkgs.xandikos; defaultText = literalExpression "pkgs.xandikos"; - description = "The Xandikos package to use."; + description = lib.mdDoc "The Xandikos package to use."; }; address = mkOption { type = types.str; default = "localhost"; - description = '' + description = lib.mdDoc '' The IP address on which Xandikos will listen. By default listens on localhost. ''; @@ -30,13 +30,13 @@ in port = mkOption { type = types.port; default = 8080; - description = "The port of the Xandikos web application"; + description = lib.mdDoc "The port of the Xandikos web application"; }; routePrefix = mkOption { type = types.str; default = "/"; - description = '' + description = lib.mdDoc '' Path to Xandikos. Useful when Xandikos is behind a reverse proxy. ''; @@ -52,14 +52,14 @@ in "--dump-dav-xml" ] ''; - description = '' + description = lib.mdDoc '' Extra command line arguments to pass to xandikos. ''; }; nginx = mkOption { default = {}; - description = '' + description = lib.mdDoc '' Configuration for nginx reverse proxy. ''; @@ -68,14 +68,14 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Configure the nginx reverse proxy settings. ''; }; hostName = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The hostname use to setup the virtualhost configuration ''; }; diff --git a/nixos/modules/services/networking/xinetd.nix b/nixos/modules/services/networking/xinetd.nix index 2f527ab156aa7..6c633d4ead16a 100644 --- a/nixos/modules/services/networking/xinetd.nix +++ b/nixos/modules/services/networking/xinetd.nix @@ -49,14 +49,14 @@ in services.xinetd.extraDefaults = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Additional configuration lines added to the default section of xinetd's configuration. ''; }; services.xinetd.services = mkOption { default = []; - description = '' + description = lib.mdDoc '' A list of services provided by xinetd. ''; @@ -67,39 +67,39 @@ in name = mkOption { type = types.str; example = "login"; - description = "Name of the service."; + description = lib.mdDoc "Name of the service."; }; protocol = mkOption { type = types.str; default = "tcp"; description = - "Protocol of the service. Usually <literal>tcp</literal> or <literal>udp</literal>."; + lib.mdDoc "Protocol of the service. Usually `tcp` or `udp`."; }; port = mkOption { type = types.int; default = 0; example = 123; - description = "Port number of the service."; + description = lib.mdDoc "Port number of the service."; }; user = mkOption { type = types.str; default = "nobody"; - description = "User account for the service"; + description = lib.mdDoc "User account for the service"; }; server = mkOption { type = types.str; example = "/foo/bin/ftpd"; - description = "Path of the program that implements the service."; + description = lib.mdDoc "Path of the program that implements the service."; }; serverArgs = mkOption { type = types.separatedString " "; default = ""; - description = "Command-line arguments for the server program."; + description = lib.mdDoc "Command-line arguments for the server program."; }; flags = mkOption { @@ -111,9 +111,9 @@ in unlisted = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether this server is listed in - <filename>/etc/services</filename>. If so, the port + {file}`/etc/services`. If so, the port number can be omitted. ''; }; @@ -121,7 +121,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = "Extra configuration-lines added to the section of the service."; + description = lib.mdDoc "Extra configuration-lines added to the section of the service."; }; }; diff --git a/nixos/modules/services/networking/xl2tpd.nix b/nixos/modules/services/networking/xl2tpd.nix index 9418488c1e94f..c30a541d30efd 100644 --- a/nixos/modules/services/networking/xl2tpd.nix +++ b/nixos/modules/services/networking/xl2tpd.nix @@ -9,25 +9,25 @@ with lib; serverIp = mkOption { type = types.str; - description = "The server-side IP address."; + description = lib.mdDoc "The server-side IP address."; default = "10.125.125.1"; }; clientIpRange = mkOption { type = types.str; - description = "The range from which client IPs are drawn."; + description = lib.mdDoc "The range from which client IPs are drawn."; default = "10.125.125.2-11"; }; extraXl2tpOptions = mkOption { type = types.lines; - description = "Adds extra lines to the xl2tpd configuration file."; + description = lib.mdDoc "Adds extra lines to the xl2tpd configuration file."; default = ""; }; extraPppdOptions = mkOption { type = types.lines; - description = "Adds extra lines to the pppd options file."; + description = lib.mdDoc "Adds extra lines to the pppd options file."; default = ""; example = '' ms-dns 8.8.8.8 diff --git a/nixos/modules/services/networking/xrdp.nix b/nixos/modules/services/networking/xrdp.nix index 747fb7a1f9c4e..17caeab27264e 100644 --- a/nixos/modules/services/networking/xrdp.nix +++ b/nixos/modules/services/networking/xrdp.nix @@ -48,7 +48,7 @@ in type = types.package; default = pkgs.xrdp; defaultText = literalExpression "pkgs.xrdp"; - description = '' + description = lib.mdDoc '' The package to use for the xrdp daemon's binary. ''; }; @@ -56,7 +56,7 @@ in port = mkOption { type = types.int; default = 3389; - description = '' + description = lib.mdDoc '' Specifies on which port the xrdp daemon listens. ''; }; @@ -64,14 +64,14 @@ in openFirewall = mkOption { default = false; type = types.bool; - description = "Whether to open the firewall for the specified RDP port."; + description = lib.mdDoc "Whether to open the firewall for the specified RDP port."; }; sslKey = mkOption { type = types.str; default = "/etc/xrdp/key.pem"; example = "/path/to/your/key.pem"; - description = '' + description = lib.mdDoc '' ssl private key path A self-signed certificate will be generated if file not exists. ''; @@ -81,7 +81,7 @@ in type = types.str; default = "/etc/xrdp/cert.pem"; example = "/path/to/your/cert.pem"; - description = '' + description = lib.mdDoc '' ssl certificate path A self-signed certificate will be generated if file not exists. ''; @@ -91,7 +91,7 @@ in type = types.str; default = "xterm"; example = "xfce4-session"; - description = '' + description = lib.mdDoc '' The script to run when user log in, usually a window manager, e.g. "icewm", "xfce4-session" This is per-user overridable, if file ~/startwm.sh exists it will be used instead. ''; @@ -101,7 +101,7 @@ in type = types.path; default = confDir; defaultText = literalDocBook "generated from configuration"; - description = "The location of the config files for xrdp."; + description = lib.mdDoc "The location of the config files for xrdp."; }; }; }; diff --git a/nixos/modules/services/networking/yggdrasil.nix b/nixos/modules/services/networking/yggdrasil.nix index ae681988ea119..07b2e2a2daf2c 100644 --- a/nixos/modules/services/networking/yggdrasil.nix +++ b/nixos/modules/services/networking/yggdrasil.nix @@ -54,9 +54,9 @@ in { type = nullOr path; default = null; example = "/run/keys/yggdrasil.conf"; - description = '' + description = lib.mdDoc '' A file which contains JSON configuration for yggdrasil. - See the <option>config</option> option for more information. + See the {option}`config` option for more information. ''; }; @@ -86,7 +86,7 @@ in { type = listOf str; default = []; example = [ "tap*" ]; - description = '' + description = lib.mdDoc '' Disable the DHCP client for any interface whose name matches any of the shell glob patterns in this list. Use this option to prevent the DHCP client from broadcasting requests @@ -100,7 +100,7 @@ in { type = package; default = pkgs.yggdrasil; defaultText = literalExpression "pkgs.yggdrasil"; - description = "Yggdrasil package to use."; + description = lib.mdDoc "Yggdrasil package to use."; }; persistentKeys = mkEnableOption '' diff --git a/nixos/modules/services/networking/zerobin.nix b/nixos/modules/services/networking/zerobin.nix index 16db25d623045..0be694915cb16 100644 --- a/nixos/modules/services/networking/zerobin.nix +++ b/nixos/modules/services/networking/zerobin.nix @@ -17,7 +17,7 @@ in dataDir = mkOption { type = types.str; default = "/var/lib/zerobin"; - description = '' + description = lib.mdDoc '' Path to the 0bin data directory ''; }; @@ -25,7 +25,7 @@ in user = mkOption { type = types.str; default = "zerobin"; - description = '' + description = lib.mdDoc '' The user 0bin should run as ''; }; @@ -33,7 +33,7 @@ in group = mkOption { type = types.str; default = "zerobin"; - description = '' + description = lib.mdDoc '' The group 0bin should run as ''; }; @@ -42,7 +42,7 @@ in type = types.int; default = 8000; example = 1357; - description = '' + description = lib.mdDoc '' The port zerobin should listen on ''; }; @@ -51,7 +51,7 @@ in type = types.str; default = "localhost"; example = "127.0.0.1"; - description = '' + description = lib.mdDoc '' The address zerobin should listen to ''; }; @@ -65,7 +65,7 @@ in ) COMPRESSED_STATIC_FILE = True ''; - description = '' + description = lib.mdDoc '' Extra configuration to be appended to the 0bin config file (see https://0bin.readthedocs.org/en/latest/en/options.html) ''; diff --git a/nixos/modules/services/networking/zeronet.nix b/nixos/modules/services/networking/zeronet.nix index 8be6692561d28..2245204d4557c 100644 --- a/nixos/modules/services/networking/zeronet.nix +++ b/nixos/modules/services/networking/zeronet.nix @@ -23,7 +23,7 @@ in with lib; { type = types.package; default = pkgs.zeronet; defaultText = literalExpression "pkgs.zeronet"; - description = "ZeroNet package to use"; + description = lib.mdDoc "ZeroNet package to use"; }; settings = mkOption { @@ -31,9 +31,9 @@ in with lib; { default = {}; example = literalExpression "{ global.tor = enable; }"; - description = '' - <filename>zeronet.conf</filename> configuration. Refer to - <link xlink:href="https://zeronet.readthedocs.io/en/latest/faq/#is-it-possible-to-use-a-configuration-file"/> + description = lib.mdDoc '' + {file}`zeronet.conf` configuration. Refer to + <https://zeronet.readthedocs.io/en/latest/faq/#is-it-possible-to-use-a-configuration-file> for details on supported values; ''; }; @@ -41,7 +41,7 @@ in with lib; { port = mkOption { type = types.port; default = 43110; - description = "Optional zeronet web UI port."; + description = lib.mdDoc "Optional zeronet web UI port."; }; fileserverPort = mkOption { @@ -49,19 +49,19 @@ in with lib; { # read-only config file and crashes type = types.port; default = 12261; - description = "Zeronet fileserver port."; + description = lib.mdDoc "Zeronet fileserver port."; }; tor = mkOption { type = types.bool; default = false; - description = "Use TOR for zeronet traffic where possible."; + description = lib.mdDoc "Use TOR for zeronet traffic where possible."; }; torAlways = mkOption { type = types.bool; default = false; - description = "Use TOR for all zeronet traffic."; + description = lib.mdDoc "Use TOR for all zeronet traffic."; }; }; diff --git a/nixos/modules/services/networking/zerotierone.nix b/nixos/modules/services/networking/zerotierone.nix index 3bc7d3ac0db56..572ae2e929d37 100644 --- a/nixos/modules/services/networking/zerotierone.nix +++ b/nixos/modules/services/networking/zerotierone.nix @@ -12,7 +12,7 @@ in default = []; example = [ "a8a2c3c10c1a68de" ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' List of ZeroTier Network IDs to join on startup ''; }; @@ -20,7 +20,7 @@ in options.services.zerotierone.port = mkOption { default = 9993; type = types.int; - description = '' + description = lib.mdDoc '' Network port used by ZeroTier. ''; }; @@ -29,7 +29,7 @@ in default = pkgs.zerotierone; defaultText = literalExpression "pkgs.zerotierone"; type = types.package; - description = '' + description = lib.mdDoc '' ZeroTier One package to use. ''; }; diff --git a/nixos/modules/services/networking/znc/options.nix b/nixos/modules/services/networking/znc/options.nix index 0db051126e86c..830df809155a4 100644 --- a/nixos/modules/services/networking/znc/options.nix +++ b/nixos/modules/services/networking/znc/options.nix @@ -12,7 +12,7 @@ let server = mkOption { type = types.str; example = "irc.libera.chat"; - description = '' + description = lib.mdDoc '' IRC server address. ''; }; @@ -20,7 +20,7 @@ let port = mkOption { type = types.ints.u16; default = 6697; - description = '' + description = lib.mdDoc '' IRC server port. ''; }; @@ -28,7 +28,7 @@ let password = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' IRC server password, such as for a Slack gateway. ''; }; @@ -36,7 +36,7 @@ let useSSL = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to use SSL to connect to the IRC server. ''; }; @@ -45,7 +45,7 @@ let type = types.listOf types.str; default = [ "simple_away" ]; example = literalExpression ''[ "simple_away" "sasl" ]''; - description = '' + description = lib.mdDoc '' ZNC network modules to load. ''; }; @@ -54,7 +54,7 @@ let type = types.listOf types.str; default = []; example = [ "nixos" ]; - description = '' + description = lib.mdDoc '' IRC channels to join. ''; }; @@ -62,7 +62,7 @@ let hasBitlbeeControlChannel = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to add the special Bitlbee operations channel. ''; }; @@ -79,9 +79,9 @@ let JoinDelay = 0 Nick = johntron ''; - description = '' + description = lib.mdDoc '' Extra config for the network. Consider using - <option>services.znc.config</option> instead. + {option}`services.znc.config` instead. ''; }; }; @@ -137,7 +137,7 @@ in default = "znc"; example = "johntron"; type = types.str; - description = '' + description = lib.mdDoc '' The user name used to log in to the ZNC web admin interface. ''; }; @@ -145,7 +145,7 @@ in networks = mkOption { default = { }; type = with types; attrsOf (submodule networkOpts); - description = '' + description = lib.mdDoc '' IRC networks to connect the user to. ''; example = literalExpression '' @@ -164,7 +164,7 @@ in default = "znc-user"; example = "john"; type = types.str; - description = '' + description = lib.mdDoc '' The IRC nick. ''; }; @@ -190,7 +190,7 @@ in port = mkOption { default = 5000; type = types.int; - description = '' + description = lib.mdDoc '' Specifies the port on which to listen. ''; }; @@ -198,7 +198,7 @@ in useSSL = mkOption { default = true; type = types.bool; - description = '' + description = lib.mdDoc '' Indicates whether the ZNC server should use SSL when listening on the specified port. A self-signed certificate will be generated. ''; @@ -208,7 +208,7 @@ in type = types.nullOr types.str; default = null; example = "/znc/"; - description = '' + description = lib.mdDoc '' An optional URI prefix for the ZNC web interface. Can be used to make ZNC available behind a reverse proxy. ''; diff --git a/nixos/modules/services/printing/cupsd.nix b/nixos/modules/services/printing/cupsd.nix index 53091d8e2a0e0..8f1c3d9c525a6 100644 --- a/nixos/modules/services/printing/cupsd.nix +++ b/nixos/modules/services/printing/cupsd.nix @@ -129,7 +129,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable printing support through the CUPS daemon. ''; }; @@ -137,7 +137,7 @@ in startWhenNeeded = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' If set, CUPS is socket-activated; that is, instead of having it permanently running as a daemon, systemd will start it on the first incoming connection. @@ -148,7 +148,7 @@ in type = types.listOf types.str; default = [ "localhost:631" ]; example = [ "*:631" ]; - description = '' + description = lib.mdDoc '' A list of addresses and ports on which to listen. ''; }; @@ -158,7 +158,7 @@ in default = [ "localhost" ]; example = [ "all" ]; apply = concatMapStringsSep "\n" (x: "Allow ${x}"); - description = '' + description = lib.mdDoc '' From which hosts to allow unconditional access. ''; }; @@ -176,7 +176,7 @@ in defaultShared = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Specifies whether local printers are shared by default. ''; }; @@ -184,7 +184,7 @@ in browsing = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Specifies whether shared printers are advertised. ''; }; @@ -192,7 +192,7 @@ in webInterface = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Specifies whether the web interface is enabled. ''; }; @@ -201,7 +201,7 @@ in type = types.str; default = "info"; example = "debug"; - description = '' + description = lib.mdDoc '' Specifies the cupsd logging verbosity. ''; }; @@ -209,9 +209,9 @@ in extraFilesConf = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra contents of the configuration file of the CUPS daemon - (<filename>cups-files.conf</filename>). + ({file}`cups-files.conf`). ''; }; @@ -223,9 +223,9 @@ in BrowsePoll cups.example.com MaxCopies 42 ''; - description = '' + description = lib.mdDoc '' Extra contents of the configuration file of the CUPS daemon - (<filename>cupsd.conf</filename>). + ({file}`cupsd.conf`). ''; }; @@ -237,9 +237,9 @@ in ServerName server.example.com Encryption Never ''; - description = '' + description = lib.mdDoc '' The contents of the client configuration. - (<filename>client.conf</filename>) + ({file}`client.conf`) ''; }; @@ -250,9 +250,9 @@ in '' BrowsePoll cups.example.com ''; - description = '' + description = lib.mdDoc '' The contents of the configuration. file of the CUPS Browsed daemon - (<filename>cups-browsed.conf</filename>) + ({file}`cups-browsed.conf`) ''; }; @@ -261,8 +261,8 @@ in default = '' Address @LOCAL ''; - description = '' - The contents of <filename>/etc/cups/snmp.conf</filename>. See "man + description = lib.mdDoc '' + The contents of {file}`/etc/cups/snmp.conf`. See "man cups-snmp.conf" for a complete description. ''; }; @@ -271,12 +271,12 @@ in type = types.listOf types.path; default = []; example = literalExpression "with pkgs; [ gutenprint hplip splix ]"; - description = '' + description = lib.mdDoc '' CUPS drivers to use. Drivers provided by CUPS, cups-filters, Ghostscript and Samba are added unconditionally. If this list contains Gutenprint (i.e. a derivation with - <literal>meta.isGutenprint = true</literal>) the PPD files in - <filename>/var/lib/cups/ppd</filename> will be updated automatically + `meta.isGutenprint = true`) the PPD files in + {file}`/var/lib/cups/ppd` will be updated automatically to avoid errors due to incompatible versions. ''; }; @@ -285,7 +285,7 @@ in type = types.path; default = "/tmp"; example = "/tmp/cups"; - description = '' + description = lib.mdDoc '' CUPSd temporary directory. ''; }; diff --git a/nixos/modules/services/scheduling/atd.nix b/nixos/modules/services/scheduling/atd.nix index 9bb0191ee469a..235d4f348e5e3 100644 --- a/nixos/modules/services/scheduling/atd.nix +++ b/nixos/modules/services/scheduling/atd.nix @@ -19,19 +19,19 @@ in services.atd.enable = mkOption { type = types.bool; default = false; - description = '' - Whether to enable the <command>at</command> daemon, a command scheduler. + description = lib.mdDoc '' + Whether to enable the {command}`at` daemon, a command scheduler. ''; }; services.atd.allowEveryone = mkOption { type = types.bool; default = false; - description = '' - Whether to make <filename>/var/spool/at{jobs,spool}</filename> + description = lib.mdDoc '' + Whether to make {file}`/var/spool/at{jobs,spool}` writeable by everyone (and sticky). This is normally not - needed since the <command>at</command> commands are - setuid/setgid <literal>atd</literal>. + needed since the {command}`at` commands are + setuid/setgid `atd`. ''; }; diff --git a/nixos/modules/services/scheduling/cron.nix b/nixos/modules/services/scheduling/cron.nix index 1fac54003cbb5..6e8fe5d9d031e 100644 --- a/nixos/modules/services/scheduling/cron.nix +++ b/nixos/modules/services/scheduling/cron.nix @@ -40,13 +40,13 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the Vixie cron daemon."; + description = lib.mdDoc "Whether to enable the Vixie cron daemon."; }; mailto = mkOption { type = types.nullOr types.str; default = null; - description = "Email address to which job output will be mailed."; + description = lib.mdDoc "Email address to which job output will be mailed."; }; systemCronJobs = mkOption { @@ -57,11 +57,11 @@ in "* * * * * eelco echo Hello World > /home/eelco/cronout" ] ''; - description = '' + description = lib.mdDoc '' A list of Cron jobs to be appended to the system-wide crontab. See the manual page for crontab for the expected format. If you want to get the results mailed you must setuid - sendmail. See <option>security.wrappers</option> + sendmail. See {option}`security.wrappers` If neither /var/cron/cron.deny nor /var/cron/cron.allow exist only root is allowed to have its own crontab file. The /var/cron/cron.deny file @@ -76,7 +76,7 @@ in cronFiles = mkOption { type = types.listOf types.path; default = []; - description = '' + description = lib.mdDoc '' A list of extra crontab files that will be read and appended to the main crontab file when the cron service starts. ''; diff --git a/nixos/modules/services/scheduling/fcron.nix b/nixos/modules/services/scheduling/fcron.nix index acaa995f73950..f1d2f462a7554 100644 --- a/nixos/modules/services/scheduling/fcron.nix +++ b/nixos/modules/services/scheduling/fcron.nix @@ -40,40 +40,40 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the <command>fcron</command> daemon."; + description = lib.mdDoc "Whether to enable the {command}`fcron` daemon."; }; allow = mkOption { type = types.listOf types.str; default = [ "all" ]; - description = '' + description = lib.mdDoc '' Users allowed to use fcrontab and fcrondyn (one name per - line, <literal>all</literal> for everyone). + line, `all` for everyone). ''; }; deny = mkOption { type = types.listOf types.str; default = []; - description = "Users forbidden from using fcron."; + description = lib.mdDoc "Users forbidden from using fcron."; }; maxSerialJobs = mkOption { type = types.int; default = 1; - description = "Maximum number of serial jobs which can run simultaneously."; + description = lib.mdDoc "Maximum number of serial jobs which can run simultaneously."; }; queuelen = mkOption { type = types.nullOr types.int; default = null; - description = "Number of jobs the serial queue and the lavg queue can contain."; + description = lib.mdDoc "Number of jobs the serial queue and the lavg queue can contain."; }; systab = mkOption { type = types.lines; default = ""; - description = ''The "system" crontab contents.''; + description = lib.mdDoc ''The "system" crontab contents.''; }; }; diff --git a/nixos/modules/services/search/elasticsearch-curator.nix b/nixos/modules/services/search/elasticsearch-curator.nix index bb2612322bbad..da3b0dc9d7135 100644 --- a/nixos/modules/services/search/elasticsearch-curator.nix +++ b/nixos/modules/services/search/elasticsearch-curator.nix @@ -39,22 +39,22 @@ in { enable = mkEnableOption "elasticsearch curator"; interval = mkOption { - description = "The frequency to run curator, a systemd.time such as 'hourly'"; + description = lib.mdDoc "The frequency to run curator, a systemd.time such as 'hourly'"; default = "hourly"; type = types.str; }; hosts = mkOption { - description = "a list of elasticsearch hosts to connect to"; + description = lib.mdDoc "a list of elasticsearch hosts to connect to"; type = types.listOf types.str; default = ["localhost"]; }; port = mkOption { - description = "the port that elasticsearch is listening on"; + description = lib.mdDoc "the port that elasticsearch is listening on"; type = types.int; default = 9200; }; actionYAML = mkOption { - description = "curator action.yaml file contents, alternatively use curator-cli which takes a simple action command"; + description = lib.mdDoc "curator action.yaml file contents, alternatively use curator-cli which takes a simple action command"; type = types.lines; example = '' --- diff --git a/nixos/modules/services/search/elasticsearch.nix b/nixos/modules/services/search/elasticsearch.nix index 041d0b3c43fd0..4a9dd50310e20 100644 --- a/nixos/modules/services/search/elasticsearch.nix +++ b/nixos/modules/services/search/elasticsearch.nix @@ -45,50 +45,50 @@ in options.services.elasticsearch = { enable = mkOption { - description = "Whether to enable elasticsearch."; + description = lib.mdDoc "Whether to enable elasticsearch."; default = false; type = types.bool; }; package = mkOption { - description = "Elasticsearch package to use."; + description = lib.mdDoc "Elasticsearch package to use."; default = pkgs.elasticsearch; defaultText = literalExpression "pkgs.elasticsearch"; type = types.package; }; listenAddress = mkOption { - description = "Elasticsearch listen address."; + description = lib.mdDoc "Elasticsearch listen address."; default = "127.0.0.1"; type = types.str; }; port = mkOption { - description = "Elasticsearch port to listen for HTTP traffic."; + description = lib.mdDoc "Elasticsearch port to listen for HTTP traffic."; default = 9200; type = types.int; }; tcp_port = mkOption { - description = "Elasticsearch port for the node to node communication."; + description = lib.mdDoc "Elasticsearch port for the node to node communication."; default = 9300; type = types.int; }; cluster_name = mkOption { - description = "Elasticsearch name that identifies your cluster for auto-discovery."; + description = lib.mdDoc "Elasticsearch name that identifies your cluster for auto-discovery."; default = "elasticsearch"; type = types.str; }; single_node = mkOption { - description = "Start a single-node cluster"; + description = lib.mdDoc "Start a single-node cluster"; default = true; type = types.bool; }; extraConf = mkOption { - description = "Extra configuration for elasticsearch."; + description = lib.mdDoc "Extra configuration for elasticsearch."; default = ""; type = types.str; example = '' @@ -99,7 +99,7 @@ in }; logging = mkOption { - description = "Elasticsearch logging configuration."; + description = lib.mdDoc "Elasticsearch logging configuration."; default = '' logger.action.name = org.elasticsearch.action logger.action.level = info @@ -118,26 +118,26 @@ in dataDir = mkOption { type = types.path; default = "/var/lib/elasticsearch"; - description = '' + description = lib.mdDoc '' Data directory for elasticsearch. ''; }; extraCmdLineOptions = mkOption { - description = "Extra command line options for the elasticsearch launcher."; + description = lib.mdDoc "Extra command line options for the elasticsearch launcher."; default = [ ]; type = types.listOf types.str; }; extraJavaOptions = mkOption { - description = "Extra command line options for Java."; + description = lib.mdDoc "Extra command line options for Java."; default = [ ]; type = types.listOf types.str; example = [ "-Djava.net.preferIPv4Stack=true" ]; }; plugins = mkOption { - description = "Extra elasticsearch plugins"; + description = lib.mdDoc "Extra elasticsearch plugins"; default = [ ]; type = types.listOf types.package; example = lib.literalExpression "[ pkgs.elasticsearchPlugins.discovery-ec2 ]"; @@ -145,7 +145,7 @@ in restartIfChanged = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Automatically restart the service on config change. This can be set to false to defer restarts on a server or cluster. Please consider the security implications of inadvertently running an older version, diff --git a/nixos/modules/services/search/hound.nix b/nixos/modules/services/search/hound.nix index ef62175b0a3e3..c81ceee546965 100644 --- a/nixos/modules/services/search/hound.nix +++ b/nixos/modules/services/search/hound.nix @@ -8,7 +8,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the hound code search daemon. ''; }; @@ -16,7 +16,7 @@ in { user = mkOption { default = "hound"; type = types.str; - description = '' + description = lib.mdDoc '' User the hound daemon should execute under. ''; }; @@ -24,7 +24,7 @@ in { group = mkOption { default = "hound"; type = types.str; - description = '' + description = lib.mdDoc '' Group the hound daemon should execute under. ''; }; @@ -33,7 +33,7 @@ in { type = types.listOf types.str; default = [ ]; example = [ "dialout" ]; - description = '' + description = lib.mdDoc '' List of extra groups that the "hound" user should be a part of. ''; }; @@ -41,7 +41,7 @@ in { home = mkOption { default = "/var/lib/hound"; type = types.path; - description = '' + description = lib.mdDoc '' The path to use as hound's $HOME. If the default user "hound" is configured then this is the home of the "hound" user. @@ -52,14 +52,14 @@ in { default = pkgs.hound; defaultText = literalExpression "pkgs.hound"; type = types.package; - description = '' + description = lib.mdDoc '' Package for running hound. ''; }; config = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The full configuration of the Hound daemon. Note the dbpath should be an absolute path to a writable location on disk. ''; @@ -82,7 +82,7 @@ in { type = types.str; default = "0.0.0.0:6080"; example = "127.0.0.1:6080 or just :6080"; - description = '' + description = lib.mdDoc '' Listen on this IP:port / :port ''; }; diff --git a/nixos/modules/services/search/kibana.nix b/nixos/modules/services/search/kibana.nix index e4ab85be9ef15..c945ef4c89d06 100644 --- a/nixos/modules/services/search/kibana.nix +++ b/nixos/modules/services/search/kibana.nix @@ -35,50 +35,50 @@ in { enable = mkEnableOption "kibana service"; listenAddress = mkOption { - description = "Kibana listening host"; + description = lib.mdDoc "Kibana listening host"; default = "127.0.0.1"; type = types.str; }; port = mkOption { - description = "Kibana listening port"; + description = lib.mdDoc "Kibana listening port"; default = 5601; type = types.int; }; cert = mkOption { - description = "Kibana ssl certificate."; + description = lib.mdDoc "Kibana ssl certificate."; default = null; type = types.nullOr types.path; }; key = mkOption { - description = "Kibana ssl key."; + description = lib.mdDoc "Kibana ssl key."; default = null; type = types.nullOr types.path; }; index = mkOption { - description = "Elasticsearch index to use for saving kibana config."; + description = lib.mdDoc "Elasticsearch index to use for saving kibana config."; default = ".kibana"; type = types.str; }; defaultAppId = mkOption { - description = "Elasticsearch default application id."; + description = lib.mdDoc "Elasticsearch default application id."; default = "discover"; type = types.str; }; elasticsearch = { url = mkOption { - description = '' + description = lib.mdDoc '' Elasticsearch url. - Defaults to <literal>"http://localhost:9200"</literal>. + Defaults to `"http://localhost:9200"`. Don't set this when using Kibana >= 7.0.0 because it will result in a - configuration error. Use <option>services.kibana.elasticsearch.hosts</option> + configuration error. Use {option}`services.kibana.elasticsearch.hosts` instead. ''; default = null; @@ -86,11 +86,11 @@ in { }; hosts = mkOption { - description = '' + description = lib.mdDoc '' The URLs of the Elasticsearch instances to use for all your queries. All nodes listed here must be on the same cluster. - Defaults to <literal>[ "http://localhost:9200" ]</literal>. + Defaults to `[ "http://localhost:9200" ]`. This option is only valid when using kibana >= 6.6. ''; @@ -99,22 +99,22 @@ in { }; username = mkOption { - description = "Username for elasticsearch basic auth."; + description = lib.mdDoc "Username for elasticsearch basic auth."; default = null; type = types.nullOr types.str; }; password = mkOption { - description = "Password for elasticsearch basic auth."; + description = lib.mdDoc "Password for elasticsearch basic auth."; default = null; type = types.nullOr types.str; }; ca = mkOption { - description = '' + description = lib.mdDoc '' CA file to auth against elasticsearch. - It's recommended to use the <option>certificateAuthorities</option> option + It's recommended to use the {option}`certificateAuthorities` option when using kibana-5.4 or newer. ''; default = null; @@ -138,33 +138,33 @@ in { }; cert = mkOption { - description = "Certificate file to auth against elasticsearch."; + description = lib.mdDoc "Certificate file to auth against elasticsearch."; default = null; type = types.nullOr types.path; }; key = mkOption { - description = "Key file to auth against elasticsearch."; + description = lib.mdDoc "Key file to auth against elasticsearch."; default = null; type = types.nullOr types.path; }; }; package = mkOption { - description = "Kibana package to use"; + description = lib.mdDoc "Kibana package to use"; default = pkgs.kibana; defaultText = literalExpression "pkgs.kibana"; type = types.package; }; dataDir = mkOption { - description = "Kibana data directory"; + description = lib.mdDoc "Kibana data directory"; default = "/var/lib/kibana"; type = types.path; }; extraConf = mkOption { - description = "Kibana extra configuration"; + description = lib.mdDoc "Kibana extra configuration"; default = {}; type = types.attrs; }; diff --git a/nixos/modules/services/search/meilisearch.nix b/nixos/modules/services/search/meilisearch.nix index f6210f6f16e1d..9a03fc1f715b8 100644 --- a/nixos/modules/services/search/meilisearch.nix +++ b/nixos/modules/services/search/meilisearch.nix @@ -19,33 +19,33 @@ in enable = mkEnableOption "MeiliSearch - a RESTful search API"; package = mkOption { - description = "The package to use for meilisearch. Use this if you require specific features to be enabled. The default package has no features."; + description = lib.mdDoc "The package to use for meilisearch. Use this if you require specific features to be enabled. The default package has no features."; default = pkgs.meilisearch; defaultText = "pkgs.meilisearch"; type = types.package; }; listenAddress = mkOption { - description = "MeiliSearch listen address."; + description = lib.mdDoc "MeiliSearch listen address."; default = "127.0.0.1"; type = types.str; }; listenPort = mkOption { - description = "MeiliSearch port to listen on."; + description = lib.mdDoc "MeiliSearch port to listen on."; default = 7700; type = types.port; }; environment = mkOption { - description = "Defines the running environment of MeiliSearch."; + description = lib.mdDoc "Defines the running environment of MeiliSearch."; default = "development"; type = types.enum [ "development" "production" ]; }; # TODO change this to LoadCredentials once possible masterKeyEnvironmentFile = mkOption { - description = '' + description = lib.mdDoc '' Path to file which contains the master key. By doing so, all routes will be protected and will require a key to be accessed. If no master key is provided, all routes can be accessed without requiring any key. @@ -57,7 +57,7 @@ in }; noAnalytics = mkOption { - description = '' + description = lib.mdDoc '' Deactivates analytics. Analytics allow MeiliSearch to know how many users are using MeiliSearch, which versions and which platforms are used. @@ -82,7 +82,7 @@ in }; maxIndexSize = mkOption { - description = '' + description = lib.mdDoc '' Sets the maximum size of the index. Value must be given in bytes or explicitly stating a base unit. For example, the default value can be written as 107374182400, '107.7Gb', or '107374 Mb'. @@ -93,7 +93,7 @@ in }; payloadSizeLimit = mkOption { - description = '' + description = lib.mdDoc '' Sets the maximum size of accepted JSON payloads. Value must be given in bytes or explicitly stating a base unit. For example, the default value can be written as 107374182400, '107.7Gb', or '107374 Mb'. diff --git a/nixos/modules/services/search/solr.nix b/nixos/modules/services/search/solr.nix index ea76bfc9298f6..ea8a2d6f92773 100644 --- a/nixos/modules/services/search/solr.nix +++ b/nixos/modules/services/search/solr.nix @@ -17,37 +17,37 @@ in type = types.package; default = pkgs.solr; defaultText = literalExpression "pkgs.solr"; - description = "Which Solr package to use."; + description = lib.mdDoc "Which Solr package to use."; }; port = mkOption { type = types.int; default = 8983; - description = "Port on which Solr is ran."; + description = lib.mdDoc "Port on which Solr is ran."; }; stateDir = mkOption { type = types.path; default = "/var/lib/solr"; - description = "The solr home directory containing config, data, and logging files."; + description = lib.mdDoc "The solr home directory containing config, data, and logging files."; }; extraJavaOptions = mkOption { type = types.listOf types.str; default = []; - description = "Extra command line options given to the java process running Solr."; + description = lib.mdDoc "Extra command line options given to the java process running Solr."; }; user = mkOption { type = types.str; default = "solr"; - description = "User under which Solr is ran."; + description = lib.mdDoc "User under which Solr is ran."; }; group = mkOption { type = types.str; default = "solr"; - description = "Group under which Solr is ran."; + description = lib.mdDoc "Group under which Solr is ran."; }; }; }; diff --git a/nixos/modules/services/security/aesmd.nix b/nixos/modules/services/security/aesmd.nix index 8268b034a15ea..2f7deb7c84912 100644 --- a/nixos/modules/services/security/aesmd.nix +++ b/nixos/modules/services/security/aesmd.nix @@ -23,23 +23,23 @@ in debug = mkOption { type = types.bool; default = false; - description = "Whether to build the PSW package in debug mode."; + description = lib.mdDoc "Whether to build the PSW package in debug mode."; }; settings = mkOption { - description = "AESM configuration"; + description = lib.mdDoc "AESM configuration"; default = { }; type = types.submodule { options.whitelistUrl = mkOption { type = with types; nullOr str; default = null; example = "http://whitelist.trustedservices.intel.com/SGX/LCWL/Linux/sgx_white_list_cert.bin"; - description = "URL to retrieve authorized Intel SGX enclave signers."; + description = lib.mdDoc "URL to retrieve authorized Intel SGX enclave signers."; }; options.proxy = mkOption { type = with types; nullOr str; default = null; example = "http://proxy_url:1234"; - description = "HTTP network proxy."; + description = lib.mdDoc "HTTP network proxy."; }; options.proxyType = mkOption { type = with types; nullOr (enum [ "default" "direct" "manual" ]); @@ -48,18 +48,18 @@ in if (config.${opt.settings}.proxy != null) then "manual" else null ''; example = "default"; - description = '' - Type of proxy to use. The <literal>default</literal> uses the system's default proxy. - If <literal>direct</literal> is given, uses no proxy. - A value of <literal>manual</literal> uses the proxy from - <option>services.aesmd.settings.proxy</option>. + description = lib.mdDoc '' + Type of proxy to use. The `default` uses the system's default proxy. + If `direct` is given, uses no proxy. + A value of `manual` uses the proxy from + {option}`services.aesmd.settings.proxy`. ''; }; options.defaultQuotingType = mkOption { type = with types; nullOr (enum [ "ecdsa_256" "epid_linkable" "epid_unlinkable" ]); default = null; example = "ecdsa_256"; - description = "Attestation quote type."; + description = lib.mdDoc "Attestation quote type."; }; }; }; diff --git a/nixos/modules/services/security/certmgr.nix b/nixos/modules/services/security/certmgr.nix index d302a4e000209..40a566bc960d8 100644 --- a/nixos/modules/services/security/certmgr.nix +++ b/nixos/modules/services/security/certmgr.nix @@ -41,37 +41,37 @@ in type = types.package; default = pkgs.certmgr; defaultText = literalExpression "pkgs.certmgr"; - description = "Which certmgr package to use in the service."; + description = lib.mdDoc "Which certmgr package to use in the service."; }; defaultRemote = mkOption { type = types.str; default = "127.0.0.1:8888"; - description = "The default CA host:port to use."; + description = lib.mdDoc "The default CA host:port to use."; }; validMin = mkOption { default = "72h"; type = types.str; - description = "The interval before a certificate expires to start attempting to renew it."; + description = lib.mdDoc "The interval before a certificate expires to start attempting to renew it."; }; renewInterval = mkOption { default = "30m"; type = types.str; - description = "How often to check certificate expirations and how often to update the cert_next_expires metric."; + description = lib.mdDoc "How often to check certificate expirations and how often to update the cert_next_expires metric."; }; metricsAddress = mkOption { default = "127.0.0.1"; type = types.str; - description = "The address for the Prometheus HTTP endpoint."; + description = lib.mdDoc "The address for the Prometheus HTTP endpoint."; }; metricsPort = mkOption { default = 9488; type = types.ints.u16; - description = "The port for the Prometheus HTTP endpoint."; + description = lib.mdDoc "The port for the Prometheus HTTP endpoint."; }; specs = mkOption { @@ -149,9 +149,9 @@ in }; }; })); - description = '' + description = lib.mdDoc '' Certificate specs as described by: - <link xlink:href="https://github.com/cloudflare/certmgr#certificate-specs" /> + <https://github.com/cloudflare/certmgr#certificate-specs> These will be added to the Nix store, so they will be world readable. ''; }; @@ -159,11 +159,11 @@ in svcManager = mkOption { default = "systemd"; type = types.enum [ "circus" "command" "dummy" "openrc" "systemd" "sysv" ]; - description = '' + description = lib.mdDoc '' This specifies the service manager to use for restarting or reloading services. - See: <link xlink:href="https://github.com/cloudflare/certmgr#certmgryaml" />. + See: <https://github.com/cloudflare/certmgr#certmgryaml>. For how to use the "command" service manager in particular, - see: <link xlink:href="https://github.com/cloudflare/certmgr#command-svcmgr-and-how-to-use-it" />. + see: <https://github.com/cloudflare/certmgr#command-svcmgr-and-how-to-use-it>. ''; }; diff --git a/nixos/modules/services/security/cfssl.nix b/nixos/modules/services/security/cfssl.nix index 6df2343b84d22..9408a602f1376 100644 --- a/nixos/modules/services/security/cfssl.nix +++ b/nixos/modules/services/security/cfssl.nix @@ -26,49 +26,49 @@ in { address = mkOption { default = "127.0.0.1"; type = types.str; - description = "Address to bind."; + description = lib.mdDoc "Address to bind."; }; port = mkOption { default = 8888; type = types.port; - description = "Port to bind."; + description = lib.mdDoc "Port to bind."; }; ca = mkOption { defaultText = literalExpression ''"''${cfg.dataDir}/ca.pem"''; type = types.str; - description = "CA used to sign the new certificate -- accepts '[file:]fname' or 'env:varname'."; + description = lib.mdDoc "CA used to sign the new certificate -- accepts '[file:]fname' or 'env:varname'."; }; caKey = mkOption { defaultText = literalExpression ''"file:''${cfg.dataDir}/ca-key.pem"''; type = types.str; - description = "CA private key -- accepts '[file:]fname' or 'env:varname'."; + description = lib.mdDoc "CA private key -- accepts '[file:]fname' or 'env:varname'."; }; caBundle = mkOption { default = null; type = types.nullOr types.path; - description = "Path to root certificate store."; + description = lib.mdDoc "Path to root certificate store."; }; intBundle = mkOption { default = null; type = types.nullOr types.path; - description = "Path to intermediate certificate store."; + description = lib.mdDoc "Path to intermediate certificate store."; }; intDir = mkOption { default = null; type = types.nullOr types.path; - description = "Intermediates directory."; + description = lib.mdDoc "Intermediates directory."; }; metadata = mkOption { default = null; type = types.nullOr types.path; - description = '' + description = lib.mdDoc '' Metadata file for root certificate presence. The content of the file is a json dictionary (k,v): each key k is a SHA-1 digest of a root certificate while value v is a list of key @@ -79,79 +79,79 @@ in { remote = mkOption { default = null; type = types.nullOr types.str; - description = "Remote CFSSL server."; + description = lib.mdDoc "Remote CFSSL server."; }; configFile = mkOption { default = null; type = types.nullOr types.str; - description = "Path to configuration file. Do not put this in nix-store as it might contain secrets."; + description = lib.mdDoc "Path to configuration file. Do not put this in nix-store as it might contain secrets."; }; responder = mkOption { default = null; type = types.nullOr types.path; - description = "Certificate for OCSP responder."; + description = lib.mdDoc "Certificate for OCSP responder."; }; responderKey = mkOption { default = null; type = types.nullOr types.str; - description = "Private key for OCSP responder certificate. Do not put this in nix-store."; + description = lib.mdDoc "Private key for OCSP responder certificate. Do not put this in nix-store."; }; tlsKey = mkOption { default = null; type = types.nullOr types.str; - description = "Other endpoint's CA private key. Do not put this in nix-store."; + description = lib.mdDoc "Other endpoint's CA private key. Do not put this in nix-store."; }; tlsCert = mkOption { default = null; type = types.nullOr types.path; - description = "Other endpoint's CA to set up TLS protocol."; + description = lib.mdDoc "Other endpoint's CA to set up TLS protocol."; }; mutualTlsCa = mkOption { default = null; type = types.nullOr types.path; - description = "Mutual TLS - require clients be signed by this CA."; + description = lib.mdDoc "Mutual TLS - require clients be signed by this CA."; }; mutualTlsCn = mkOption { default = null; type = types.nullOr types.str; - description = "Mutual TLS - regex for whitelist of allowed client CNs."; + description = lib.mdDoc "Mutual TLS - regex for whitelist of allowed client CNs."; }; tlsRemoteCa = mkOption { default = null; type = types.nullOr types.path; - description = "CAs to trust for remote TLS requests."; + description = lib.mdDoc "CAs to trust for remote TLS requests."; }; mutualTlsClientCert = mkOption { default = null; type = types.nullOr types.path; - description = "Mutual TLS - client certificate to call remote instance requiring client certs."; + description = lib.mdDoc "Mutual TLS - client certificate to call remote instance requiring client certs."; }; mutualTlsClientKey = mkOption { default = null; type = types.nullOr types.path; - description = "Mutual TLS - client key to call remote instance requiring client certs. Do not put this in nix-store."; + description = lib.mdDoc "Mutual TLS - client key to call remote instance requiring client certs. Do not put this in nix-store."; }; dbConfig = mkOption { default = null; type = types.nullOr types.path; - description = "Certificate db configuration file. Path must be writeable."; + description = lib.mdDoc "Certificate db configuration file. Path must be writeable."; }; logLevel = mkOption { default = 1; type = types.enum [ 0 1 2 3 4 5 ]; - description = "Log level (0 = DEBUG, 5 = FATAL)."; + description = lib.mdDoc "Log level (0 = DEBUG, 5 = FATAL)."; }; }; diff --git a/nixos/modules/services/security/clamav.nix b/nixos/modules/services/security/clamav.nix index 95a0ad8770e22..1b1194d31135e 100644 --- a/nixos/modules/services/security/clamav.nix +++ b/nixos/modules/services/security/clamav.nix @@ -31,8 +31,8 @@ in settings = mkOption { type = with types; attrsOf (oneOf [ bool int str (listOf str) ]); default = { }; - description = '' - ClamAV configuration. Refer to <link xlink:href="https://linux.die.net/man/5/clamd.conf"/>, + description = lib.mdDoc '' + ClamAV configuration. Refer to <https://linux.die.net/man/5/clamd.conf>, for details on supported values. ''; }; @@ -43,7 +43,7 @@ in frequency = mkOption { type = types.int; default = 12; - description = '' + description = lib.mdDoc '' Number of database checks per day. ''; }; @@ -51,7 +51,7 @@ in interval = mkOption { type = types.str; default = "hourly"; - description = '' + description = lib.mdDoc '' How often freshclam is invoked. See systemd.time(7) for more information about the format. ''; @@ -60,8 +60,8 @@ in settings = mkOption { type = with types; attrsOf (oneOf [ bool int str (listOf str) ]); default = { }; - description = '' - freshclam configuration. Refer to <link xlink:href="https://linux.die.net/man/5/freshclam.conf"/>, + description = lib.mdDoc '' + freshclam configuration. Refer to <https://linux.die.net/man/5/freshclam.conf>, for details on supported values. ''; }; diff --git a/nixos/modules/services/security/fail2ban.nix b/nixos/modules/services/security/fail2ban.nix index 67e1026dcef4d..24c84151bc789 100644 --- a/nixos/modules/services/security/fail2ban.nix +++ b/nixos/modules/services/security/fail2ban.nix @@ -45,10 +45,10 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable the fail2ban service. - See the documentation of <option>services.fail2ban.jails</option> + See the documentation of {option}`services.fail2ban.jails` for what jails are enabled by default. ''; }; @@ -58,7 +58,7 @@ in defaultText = literalExpression "pkgs.fail2ban"; type = types.package; example = literalExpression "pkgs.fail2ban_0_11"; - description = "The fail2ban package to use for running the fail2ban service."; + description = lib.mdDoc "The fail2ban package to use for running the fail2ban service."; }; packageFirewall = mkOption { @@ -66,7 +66,7 @@ in defaultText = literalExpression "pkgs.iptables"; type = types.package; example = literalExpression "pkgs.nftables"; - description = "The firewall package used by fail2ban service."; + description = lib.mdDoc "The firewall package used by fail2ban service."; }; extraPackages = mkOption { @@ -82,14 +82,14 @@ in maxretry = mkOption { default = 3; type = types.ints.unsigned; - description = "Number of failures before a host gets banned."; + description = lib.mdDoc "Number of failures before a host gets banned."; }; banaction = mkOption { default = "iptables-multiport"; type = types.str; example = "nftables-multiport"; - description = '' + description = lib.mdDoc '' Default banning action (e.g. iptables, iptables-new, iptables-multiport, shorewall, etc) It is used to define action_* variables. Can be overridden globally or per section within jail.local file @@ -100,7 +100,7 @@ in default = "iptables-allport"; type = types.str; example = "nftables-allport"; - description = '' + description = lib.mdDoc '' Default banning action (e.g. iptables, iptables-new, iptables-multiport, shorewall, etc) It is used to define action_* variables. Can be overridden globally or per section within jail.local file @@ -110,7 +110,7 @@ in bantime-increment.enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Allows to use database for searching of previously banned ip's to increase a default ban time using special formula, default it is banTime * 1, 2, 4, 8, 16, 32... ''; @@ -120,7 +120,7 @@ in default = "4m"; type = types.str; example = "8m"; - description = '' + description = lib.mdDoc '' "bantime-increment.rndtime" is the max number of seconds using for mixing with random time to prevent "clever" botnets calculate exact time IP can be unbanned again ''; @@ -130,7 +130,7 @@ in default = "10h"; type = types.str; example = "48h"; - description = '' + description = lib.mdDoc '' "bantime-increment.maxtime" is the max number of seconds using the ban time can reach (don't grows further) ''; }; @@ -139,7 +139,7 @@ in default = "1"; type = types.str; example = "4"; - description = '' + description = lib.mdDoc '' "bantime-increment.factor" is a coefficient to calculate exponent growing of the formula or common multiplier, default value of factor is 1 and with default value of formula, the ban time grows by 1, 2, 4, 8, 16 ... ''; @@ -149,7 +149,7 @@ in default = "ban.Time * (1<<(ban.Count if ban.Count<20 else 20)) * banFactor"; type = types.str; example = "ban.Time * math.exp(float(ban.Count+1)*banFactor)/math.exp(1*banFactor)"; - description = '' + description = lib.mdDoc '' "bantime-increment.formula" used by default to calculate next value of ban time, default value bellow, the same ban time growing will be reached by multipliers 1, 2, 4, 8, 16, 32... ''; @@ -159,7 +159,7 @@ in default = "1 2 4 8 16 32 64"; type = types.str; example = "2 4 16 128"; - description = '' + description = lib.mdDoc '' "bantime-increment.multipliers" used to calculate next value of ban time instead of formula, coresponding previously ban count and given "bantime.factor" (for multipliers default is 1); following example grows ban time by 1, 2, 4, 8, 16 ... and if last ban count greater as multipliers count, @@ -171,7 +171,7 @@ in default = false; type = types.bool; example = true; - description = '' + description = lib.mdDoc '' "bantime-increment.overalljails" (if true) specifies the search of IP in the database will be executed cross over all jails, if false (dafault), only current jail of the ban IP will be searched ''; @@ -181,7 +181,7 @@ in default = [ ]; type = types.listOf types.str; example = [ "192.168.0.0/16" "2001:DB8::42" ]; - description = '' + description = lib.mdDoc '' "ignoreIP" can be a list of IP addresses, CIDR masks or DNS hosts. Fail2ban will not ban a host which matches an address in this list. Several addresses can be defined using space (and/or comma) separator. ''; @@ -196,7 +196,7 @@ in dbfile = /var/lib/fail2ban/fail2ban.sqlite3 ''; type = types.lines; - description = '' + description = lib.mdDoc '' The contents of Fail2ban's main configuration file. It's generally not necessary to change it. ''; @@ -219,22 +219,22 @@ in } ''; type = types.attrsOf types.lines; - description = '' + description = lib.mdDoc '' The configuration of each Fail2ban “jail”. A jail consists of an action (such as blocking a port using - <command>iptables</command>) that is triggered when a + {command}`iptables`) that is triggered when a filter applied to a log file triggers more than a certain number of times in a certain time period. Actions are - defined in <filename>/etc/fail2ban/action.d</filename>, + defined in {file}`/etc/fail2ban/action.d`, while filters are defined in - <filename>/etc/fail2ban/filter.d</filename>. + {file}`/etc/fail2ban/filter.d`. - NixOS comes with a default <literal>sshd</literal> jail; + NixOS comes with a default `sshd` jail; for it to work well, - <option>services.openssh.logLevel</option> should be set to - <literal>"VERBOSE"</literal> or higher so that fail2ban + {option}`services.openssh.logLevel` should be set to + `"VERBOSE"` or higher so that fail2ban can observe failed login attempts. - This module sets it to <literal>"VERBOSE"</literal> if + This module sets it to `"VERBOSE"` if not set otherwise, so enabling fail2ban can make SSH logs more verbose. ''; diff --git a/nixos/modules/services/security/fprintd.nix b/nixos/modules/services/security/fprintd.nix index 87c3f1f6f9e42..45b370009c389 100644 --- a/nixos/modules/services/security/fprintd.nix +++ b/nixos/modules/services/security/fprintd.nix @@ -24,7 +24,7 @@ in type = types.package; default = fprintdPkg; defaultText = literalExpression "if config.services.fprintd.tod.enable then pkgs.fprintd-tod else pkgs.fprintd"; - description = '' + description = lib.mdDoc '' fprintd package to use. ''; }; @@ -36,7 +36,7 @@ in driver = mkOption { type = types.package; example = literalExpression "pkgs.libfprint-2-tod1-goodix"; - description = '' + description = lib.mdDoc '' Touch OEM Drivers (TOD) package to use. ''; }; diff --git a/nixos/modules/services/security/haka.nix b/nixos/modules/services/security/haka.nix index 2cfc05f3033bb..10b7cef54d333 100644 --- a/nixos/modules/services/security/haka.nix +++ b/nixos/modules/services/security/haka.nix @@ -70,7 +70,7 @@ in default = "empty.lua"; example = "/srv/haka/myfilter.lua"; type = types.str; - description = '' + description = lib.mdDoc '' Specify which configuration file Haka uses. It can be absolute path or a path relative to the sample directory of the haka git repo. @@ -81,7 +81,7 @@ in default = [ "eth0" ]; example = [ "any" ]; type = with types; listOf str; - description = '' + description = lib.mdDoc '' Specify which interface(s) Haka listens to. Use 'any' to listen to all interfaces. ''; @@ -91,7 +91,7 @@ in default = 0; example = 4; type = types.int; - description = '' + description = lib.mdDoc '' The number of threads that will be used. All system threads are used by default. ''; @@ -100,7 +100,7 @@ in pcap = mkOption { default = true; type = types.bool; - description = "Whether to enable pcap"; + description = lib.mdDoc "Whether to enable pcap"; }; nfqueue = mkEnableOption "nfqueue"; @@ -110,14 +110,14 @@ in default = "/tmp/input.pcap"; example = "/path/to/file.pcap"; type = types.path; - description = "Path to file where incoming packets are dumped"; + description = lib.mdDoc "Path to file where incoming packets are dumped"; }; dump.output = mkOption { default = "/tmp/output.pcap"; example = "/path/to/file.pcap"; type = types.path; - description = "Path to file where outgoing packets are dumped"; + description = lib.mdDoc "Path to file where outgoing packets are dumped"; }; }; }; diff --git a/nixos/modules/services/security/haveged.nix b/nixos/modules/services/security/haveged.nix index 57cef7e44d503..c65d5ab2923e9 100644 --- a/nixos/modules/services/security/haveged.nix +++ b/nixos/modules/services/security/haveged.nix @@ -24,7 +24,7 @@ in refill_threshold = mkOption { type = types.int; default = 1024; - description = '' + description = lib.mdDoc '' The number of bits of available entropy beneath which haveged should refill the entropy pool. ''; diff --git a/nixos/modules/services/security/hockeypuck.nix b/nixos/modules/services/security/hockeypuck.nix index d0e152934f508..6fdad13f25569 100644 --- a/nixos/modules/services/security/hockeypuck.nix +++ b/nixos/modules/services/security/hockeypuck.nix @@ -12,7 +12,7 @@ in { port = lib.mkOption { default = 11371; type = lib.types.port; - description = "HKP port to listen on."; + description = lib.mdDoc "HKP port to listen on."; }; settings = lib.mkOption { diff --git a/nixos/modules/services/security/hologram-agent.nix b/nixos/modules/services/security/hologram-agent.nix index e29267e50003b..666d95b9b94a7 100644 --- a/nixos/modules/services/security/hologram-agent.nix +++ b/nixos/modules/services/security/hologram-agent.nix @@ -14,19 +14,19 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the Hologram agent for AWS instance credentials"; + description = lib.mdDoc "Whether to enable the Hologram agent for AWS instance credentials"; }; dialAddress = mkOption { type = types.str; default = "localhost:3100"; - description = "Hologram server and port."; + description = lib.mdDoc "Hologram server and port."; }; httpPort = mkOption { type = types.str; default = "80"; - description = "Port for metadata service to listen on."; + description = lib.mdDoc "Port for metadata service to listen on."; }; }; diff --git a/nixos/modules/services/security/hologram-server.nix b/nixos/modules/services/security/hologram-server.nix index 4acf6ae0e2182..e995bc79b1129 100644 --- a/nixos/modules/services/security/hologram-server.nix +++ b/nixos/modules/services/security/hologram-server.nix @@ -33,85 +33,85 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the Hologram server for AWS instance credentials"; + description = lib.mdDoc "Whether to enable the Hologram server for AWS instance credentials"; }; listenAddress = mkOption { type = types.str; default = "0.0.0.0:3100"; - description = "Address and port to listen on"; + description = lib.mdDoc "Address and port to listen on"; }; ldapHost = mkOption { type = types.str; - description = "Address of the LDAP server to use"; + description = lib.mdDoc "Address of the LDAP server to use"; }; ldapInsecure = mkOption { type = types.bool; default = false; - description = "Whether to connect to LDAP over SSL or not"; + description = lib.mdDoc "Whether to connect to LDAP over SSL or not"; }; ldapUserAttr = mkOption { type = types.str; default = "cn"; - description = "The LDAP attribute for usernames"; + description = lib.mdDoc "The LDAP attribute for usernames"; }; ldapBaseDN = mkOption { type = types.str; - description = "The base DN for your Hologram users"; + description = lib.mdDoc "The base DN for your Hologram users"; }; ldapBindDN = mkOption { type = types.str; - description = "DN of account to use to query the LDAP server"; + description = lib.mdDoc "DN of account to use to query the LDAP server"; }; ldapBindPassword = mkOption { type = types.str; - description = "Password of account to use to query the LDAP server"; + description = lib.mdDoc "Password of account to use to query the LDAP server"; }; enableLdapRoles = mkOption { type = types.bool; default = false; - description = "Whether to assign user roles based on the user's LDAP group memberships"; + description = lib.mdDoc "Whether to assign user roles based on the user's LDAP group memberships"; }; groupClassAttr = mkOption { type = types.str; default = "groupOfNames"; - description = "The objectclass attribute to search for groups when enableLdapRoles is true"; + description = lib.mdDoc "The objectclass attribute to search for groups when enableLdapRoles is true"; }; roleAttr = mkOption { type = types.str; default = "businessCategory"; - description = "Which LDAP group attribute to search for authorized role ARNs"; + description = lib.mdDoc "Which LDAP group attribute to search for authorized role ARNs"; }; awsAccount = mkOption { type = types.str; - description = "AWS account number"; + description = lib.mdDoc "AWS account number"; }; awsDefaultRole = mkOption { type = types.str; - description = "AWS default role"; + description = lib.mdDoc "AWS default role"; }; statsAddress = mkOption { type = types.str; default = ""; - description = "Address of statsd server"; + description = lib.mdDoc "Address of statsd server"; }; cacheTimeoutSeconds = mkOption { type = types.int; default = 3600; - description = "How often (in seconds) to refresh the LDAP cache"; + description = lib.mdDoc "How often (in seconds) to refresh the LDAP cache"; }; }; }; diff --git a/nixos/modules/services/security/kanidm.nix b/nixos/modules/services/security/kanidm.nix index a7c51b9a877f1..6429273705dad 100644 --- a/nixos/modules/services/security/kanidm.nix +++ b/nixos/modules/services/security/kanidm.nix @@ -63,60 +63,60 @@ in options = { bindaddress = lib.mkOption { - description = "Address/port combination the webserver binds to."; + description = lib.mdDoc "Address/port combination the webserver binds to."; example = "[::1]:8443"; type = lib.types.str; }; # Should be optional but toml does not accept null ldapbindaddress = lib.mkOption { - description = '' - Address and port the LDAP server is bound to. Setting this to <literal>null</literal> disables the LDAP interface. + description = lib.mdDoc '' + Address and port the LDAP server is bound to. Setting this to `null` disables the LDAP interface. ''; example = "[::1]:636"; default = null; type = lib.types.nullOr lib.types.str; }; origin = lib.mkOption { - description = "The origin of your Kanidm instance. Must have https as protocol."; + description = lib.mdDoc "The origin of your Kanidm instance. Must have https as protocol."; example = "https://idm.example.org"; type = lib.types.strMatching "^https://.*"; }; domain = lib.mkOption { - description = '' - The <literal>domain</literal> that Kanidm manages. Must be below or equal to the domain - specified in <literal>serverSettings.origin</literal>. - This can be left at <literal>null</literal>, only if your instance has the role <literal>ReadOnlyReplica</literal>. + description = lib.mdDoc '' + The `domain` that Kanidm manages. Must be below or equal to the domain + specified in `serverSettings.origin`. + This can be left at `null`, only if your instance has the role `ReadOnlyReplica`. While it is possible to change the domain later on, it requires extra steps! Please consider the warnings and execute the steps described - <link xlink:href="https://kanidm.github.io/kanidm/stable/administrivia.html#rename-the-domain">in the documentation</link>. + [in the documentation](https://kanidm.github.io/kanidm/stable/administrivia.html#rename-the-domain). ''; example = "example.org"; default = null; type = lib.types.nullOr lib.types.str; }; db_path = lib.mkOption { - description = "Path to Kanidm database."; + description = lib.mdDoc "Path to Kanidm database."; default = "/var/lib/kanidm/kanidm.db"; readOnly = true; type = lib.types.path; }; log_level = lib.mkOption { - description = "Log level of the server."; + description = lib.mdDoc "Log level of the server."; default = "default"; type = lib.types.enum [ "default" "verbose" "perfbasic" "perffull" ]; }; role = lib.mkOption { - description = "The role of this server. This affects the replication relationship and thereby available features."; + description = lib.mdDoc "The role of this server. This affects the replication relationship and thereby available features."; default = "WriteReplica"; type = lib.types.enum [ "WriteReplica" "WriteReplicaNoUI" "ReadOnlyReplica" ]; }; }; }; default = { }; - description = '' + description = lib.mdDoc '' Settings for Kanidm, see - <link xlink:href="https://github.com/kanidm/kanidm/blob/master/kanidm_book/src/server_configuration.md">the documentation</link> - and <link xlink:href="https://github.com/kanidm/kanidm/blob/master/examples/server.toml">example configuration</link> + [the documentation](https://github.com/kanidm/kanidm/blob/master/kanidm_book/src/server_configuration.md) + and [example configuration](https://github.com/kanidm/kanidm/blob/master/examples/server.toml) for possible values. ''; }; @@ -126,15 +126,15 @@ in freeformType = settingsFormat.type; options.uri = lib.mkOption { - description = "Address of the Kanidm server."; + description = lib.mdDoc "Address of the Kanidm server."; example = "http://127.0.0.1:8080"; type = lib.types.str; }; }; - description = '' + description = lib.mdDoc '' Configure Kanidm clients, needed for the PAM daemon. See - <link xlink:href="https://github.com/kanidm/kanidm/blob/master/kanidm_book/src/client_tools.md#kanidm-configuration">the documentation</link> - and <link xlink:href="https://github.com/kanidm/kanidm/blob/master/examples/config">example configuration</link> + [the documentation](https://github.com/kanidm/kanidm/blob/master/kanidm_book/src/client_tools.md#kanidm-configuration) + and [example configuration](https://github.com/kanidm/kanidm/blob/master/examples/config) for possible values. ''; }; @@ -144,15 +144,15 @@ in freeformType = settingsFormat.type; options.pam_allowed_login_groups = lib.mkOption { - description = "Kanidm groups that are allowed to login using PAM."; + description = lib.mdDoc "Kanidm groups that are allowed to login using PAM."; example = "my_pam_group"; type = lib.types.listOf lib.types.str; }; }; - description = '' + description = lib.mdDoc '' Configure Kanidm unix daemon. - See <link xlink:href="https://github.com/kanidm/kanidm/blob/master/kanidm_book/src/pam_and_nsswitch.md#the-unix-daemon">the documentation</link> - and <link xlink:href="https://github.com/kanidm/kanidm/blob/master/examples/unixd">example configuration</link> + See [the documentation](https://github.com/kanidm/kanidm/blob/master/kanidm_book/src/pam_and_nsswitch.md#the-unix-daemon) + and [example configuration](https://github.com/kanidm/kanidm/blob/master/examples/unixd) for possible values. ''; }; diff --git a/nixos/modules/services/security/munge.nix b/nixos/modules/services/security/munge.nix index 8917888647109..e2b0921b4bc02 100644 --- a/nixos/modules/services/security/munge.nix +++ b/nixos/modules/services/security/munge.nix @@ -20,7 +20,7 @@ in password = mkOption { default = "/etc/munge/munge.key"; type = types.path; - description = '' + description = lib.mdDoc '' The path to a daemon's secret key. ''; }; diff --git a/nixos/modules/services/security/nginx-sso.nix b/nixos/modules/services/security/nginx-sso.nix index b4de1d36edd8d..1c23c29781c0e 100644 --- a/nixos/modules/services/security/nginx-sso.nix +++ b/nixos/modules/services/security/nginx-sso.nix @@ -14,7 +14,7 @@ in { type = types.package; default = pkgs.nginx-sso; defaultText = literalExpression "pkgs.nginx-sso"; - description = '' + description = lib.mdDoc '' The nginx-sso package that should be used. ''; }; @@ -40,9 +40,9 @@ in { }; } ''; - description = '' + description = lib.mdDoc '' nginx-sso configuration - (<link xlink:href="https://github.com/Luzifer/nginx-sso/wiki/Main-Configuration">documentation</link>) + ([documentation](https://github.com/Luzifer/nginx-sso/wiki/Main-Configuration)) as a Nix attribute set. ''; }; diff --git a/nixos/modules/services/security/oauth2_proxy.nix b/nixos/modules/services/security/oauth2_proxy.nix index 5c89d58723760..8b2c7fa21402d 100644 --- a/nixos/modules/services/security/oauth2_proxy.nix +++ b/nixos/modules/services/security/oauth2_proxy.nix @@ -92,7 +92,7 @@ in type = types.package; default = pkgs.oauth2-proxy; defaultText = literalExpression "pkgs.oauth2-proxy"; - description = '' + description = lib.mdDoc '' The package that provides oauth2-proxy. ''; }; @@ -118,7 +118,7 @@ in "oidc" ]; default = "google"; - description = '' + description = lib.mdDoc '' OAuth provider. ''; }; @@ -126,14 +126,14 @@ in approvalPrompt = mkOption { type = types.enum ["force" "auto"]; default = "force"; - description = '' + description = lib.mdDoc '' OAuth approval_prompt. ''; }; clientID = mkOption { type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The OAuth Client ID. ''; example = "123456.apps.googleusercontent.com"; @@ -141,7 +141,7 @@ in clientSecret = mkOption { type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The OAuth Client Secret. ''; }; @@ -149,7 +149,7 @@ in skipAuthRegexes = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Skip authentication for requests matching any of these regular expressions. ''; @@ -169,7 +169,7 @@ in addresses = mkOption { type = types.nullOr types.lines; default = null; - description = '' + description = lib.mdDoc '' Line-separated email addresses that are allowed to authenticate. ''; }; @@ -178,7 +178,7 @@ in loginURL = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Authentication endpoint. You only need to set this if you are using a self-hosted provider (e.g. @@ -191,7 +191,7 @@ in redeemURL = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Token redemption endpoint. You only need to set this if you are using a self-hosted provider (e.g. @@ -204,7 +204,7 @@ in validateURL = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Access token validation endpoint. You only need to set this if you are using a self-hosted provider (e.g. @@ -219,7 +219,7 @@ in # doesn't require it so making it optional. type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The OAuth2 redirect URL. ''; example = "https://internalapp.yourcompany.com/oauth2/callback"; @@ -229,14 +229,14 @@ in tenant = mkOption { type = types.str; default = "common"; - description = '' + description = lib.mdDoc '' Go to a tenant-specific or common (tenant-independent) endpoint. ''; }; resource = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The resource that is protected. ''; }; @@ -245,28 +245,28 @@ in google = { adminEmail = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The Google Admin to impersonate for API calls. Only users with access to the Admin APIs can access the Admin SDK Directory API, thus the service account needs to impersonate one of those users to access the Admin SDK Directory API. - See <link xlink:href="https://developers.google.com/admin-sdk/directory/v1/guides/delegation#delegate_domain-wide_authority_to_your_service_account" />. + See <https://developers.google.com/admin-sdk/directory/v1/guides/delegation#delegate_domain-wide_authority_to_your_service_account>. ''; }; groups = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Restrict logins to members of these Google groups. ''; }; serviceAccountJSON = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' The path to the service account JSON credentials. ''; }; @@ -276,7 +276,7 @@ in org = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Restrict logins to members of this organisation. ''; }; @@ -284,7 +284,7 @@ in team = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Restrict logins to members of this team. ''; }; @@ -296,8 +296,8 @@ in upstream = mkOption { type = with types; coercedTo str (x: [x]) (listOf str); default = []; - description = '' - The http url(s) of the upstream endpoint or <literal>file://</literal> + description = lib.mdDoc '' + The http url(s) of the upstream endpoint or `file://` paths for static files. Routing is based on the path. ''; }; @@ -305,7 +305,7 @@ in passAccessToken = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Pass OAuth access_token to upstream via X-Forwarded-Access-Token header. ''; }; @@ -313,7 +313,7 @@ in passBasicAuth = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Pass HTTP Basic Auth, X-Forwarded-User and X-Forwarded-Email information to upstream. ''; }; @@ -321,7 +321,7 @@ in basicAuthPassword = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The password to set when passing the HTTP Basic Auth header. ''; }; @@ -329,7 +329,7 @@ in passHostHeader = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Pass the request Host Header to upstream. ''; }; @@ -337,7 +337,7 @@ in signatureKey = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' GAP-Signature request signature key. ''; example = "sha1:secret0"; @@ -358,7 +358,7 @@ in expire = mkOption { type = types.str; default = "168h0m0s"; - description = '' + description = lib.mdDoc '' Expire timeframe for cookie. ''; }; @@ -366,7 +366,7 @@ in httpOnly = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Set HttpOnly cookie flag. ''; }; @@ -374,7 +374,7 @@ in name = mkOption { type = types.str; default = "_oauth2_proxy"; - description = '' + description = lib.mdDoc '' The name of the cookie that the oauth_proxy creates. ''; }; @@ -383,7 +383,7 @@ in # XXX: Unclear what the behavior is when this is not specified. type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Refresh the cookie after this duration; 0 to disable. ''; example = "168h0m0s"; @@ -391,7 +391,7 @@ in secret = mkOption { type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The seed string for secure cookies. ''; }; @@ -399,7 +399,7 @@ in secure = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Set secure (HTTPS) cookie flag. ''; }; @@ -411,10 +411,10 @@ in httpAddress = mkOption { type = types.str; default = "http://127.0.0.1:4180"; - description = '' + description = lib.mdDoc '' HTTPS listening address. This module does not expose the port by default. If you want this URL to be accessible to other machines, please - add the port to <literal>networking.firewall.allowedTCPPorts</literal>. + add the port to `networking.firewall.allowedTCPPorts`. ''; }; @@ -422,16 +422,16 @@ in file = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Additionally authenticate against a htpasswd file. Entries must be - created with <literal>htpasswd -s</literal> for SHA encryption. + created with `htpasswd -s` for SHA encryption. ''; }; displayForm = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Display username / password login form if an htpasswd file is provided. ''; }; @@ -440,7 +440,7 @@ in customTemplatesDir = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Path to custom HTML templates. ''; }; @@ -448,9 +448,9 @@ in reverseProxy = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' In case when running behind a reverse proxy, controls whether headers - like <literal>X-Real-Ip</literal> are accepted. Usage behind a reverse + like `X-Real-Ip` are accepted. Usage behind a reverse proxy will require this flag to be set to avoid logging the reverse proxy IP address. ''; @@ -459,7 +459,7 @@ in proxyPrefix = mkOption { type = types.str; default = "/oauth2"; - description = '' + description = lib.mdDoc '' The url root path that this proxy should be nested under. ''; }; @@ -468,21 +468,21 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to serve over TLS. ''; }; certificate = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' Path to certificate file. ''; }; key = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' Path to private key file. ''; }; @@ -490,11 +490,11 @@ in httpsAddress = mkOption { type = types.str; default = ":443"; - description = '' - <literal>addr:port</literal> to listen on for HTTPS clients. + description = lib.mdDoc '' + `addr:port` to listen on for HTTPS clients. - Remember to add <literal>port</literal> to - <literal>allowedTCPPorts</literal> if you want other machines to be + Remember to add `port` to + `allowedTCPPorts` if you want other machines to be able to connect to it. ''; }; @@ -503,7 +503,7 @@ in requestLogging = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Log requests to stdout. ''; }; @@ -517,7 +517,7 @@ in # doesn't require it so making it optional. type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' OAuth scope specification. ''; }; @@ -525,7 +525,7 @@ in profileURL = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Profile access endpoint. ''; }; @@ -533,7 +533,7 @@ in setXauthrequest = mkOption { type = types.nullOr types.bool; default = false; - description = '' + description = lib.mdDoc '' Set X-Auth-Request-User and X-Auth-Request-Email response headers (useful in Nginx auth_request mode). Setting this to 'null' means using the upstream default (false). ''; }; @@ -541,7 +541,7 @@ in extraConfig = mkOption { default = {}; type = types.attrsOf types.anything; - description = '' + description = lib.mdDoc '' Extra config to pass to oauth2-proxy. ''; }; @@ -549,7 +549,7 @@ in keyFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' oauth2-proxy allows passing sensitive configuration via environment variables. Make a file that contains lines like OAUTH2_PROXY_CLIENT_SECRET=asdfasdfasdf.apps.googleuserscontent.com diff --git a/nixos/modules/services/security/oauth2_proxy_nginx.nix b/nixos/modules/services/security/oauth2_proxy_nginx.nix index 5853c5a123c6b..b8e45f67cf783 100644 --- a/nixos/modules/services/security/oauth2_proxy_nginx.nix +++ b/nixos/modules/services/security/oauth2_proxy_nginx.nix @@ -9,14 +9,14 @@ in type = types.str; default = config.services.oauth2_proxy.httpAddress; defaultText = literalExpression "config.services.oauth2_proxy.httpAddress"; - description = '' + description = lib.mdDoc '' The address of the reverse proxy endpoint for oauth2_proxy ''; }; virtualHosts = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' A list of nginx virtual hosts to put behind the oauth2 proxy ''; }; diff --git a/nixos/modules/services/security/opensnitch.nix b/nixos/modules/services/security/opensnitch.nix index f9b4985e19913..4558236339e5a 100644 --- a/nixos/modules/services/security/opensnitch.nix +++ b/nixos/modules/services/security/opensnitch.nix @@ -18,7 +18,7 @@ in { Address = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Unix socket path (unix:///tmp/osui.sock, the "unix:///" part is mandatory) or TCP socket (192.168.1.100:50051). ''; @@ -26,7 +26,7 @@ in { LogFile = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' File to write logs to (use /dev/stdout to write logs to standard output). ''; @@ -36,7 +36,7 @@ in { DefaultAction = mkOption { type = types.enum [ "allow" "deny" ]; - description = '' + description = lib.mdDoc '' Default action whether to block or allow application internet access. ''; @@ -46,28 +46,28 @@ in { type = types.enum [ "once" "always" "until restart" "30s" "5m" "15m" "30m" "1h" ]; - description = '' + description = lib.mdDoc '' Default duration of firewall rule. ''; }; InterceptUnknown = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Wheter to intercept spare connections. ''; }; ProcMonitorMethod = mkOption { type = types.enum [ "ebpf" "proc" "ftrace" "audit" ]; - description = '' + description = lib.mdDoc '' Which process monitoring method to use. ''; }; LogLevel = mkOption { type = types.enum [ 0 1 2 3 4 ]; - description = '' + description = lib.mdDoc '' Default log level from 0 to 4 (debug, info, important, warning, error). ''; @@ -75,7 +75,7 @@ in { Firewall = mkOption { type = types.enum [ "iptables" "nftables" ]; - description = '' + description = lib.mdDoc '' Which firewall backend to use. ''; }; @@ -84,14 +84,14 @@ in { MaxEvents = mkOption { type = types.int; - description = '' + description = lib.mdDoc '' Max events to send to the GUI. ''; }; MaxStats = mkOption { type = types.int; - description = '' + description = lib.mdDoc '' Max stats per item to keep in backlog. ''; }; @@ -99,9 +99,9 @@ in { }; }; }; - description = '' + description = lib.mdDoc '' opensnitchd configuration. Refer to - <link xlink:href="https://github.com/evilsocket/opensnitch/wiki/Configurations"/> + <https://github.com/evilsocket/opensnitch/wiki/Configurations> for details on supported values. ''; }; diff --git a/nixos/modules/services/security/pass-secret-service.nix b/nixos/modules/services/security/pass-secret-service.nix index 6ae190eb95e6b..611cea48ee6f2 100644 --- a/nixos/modules/services/security/pass-secret-service.nix +++ b/nixos/modules/services/security/pass-secret-service.nix @@ -13,7 +13,7 @@ in type = types.package; default = pkgs.pass-secret-service; defaultText = literalExpression "pkgs.pass-secret-service"; - description = "Which pass-secret-service package to use."; + description = lib.mdDoc "Which pass-secret-service package to use."; example = literalExpression "pkgs.pass-secret-service.override { python3 = pkgs.python310 }"; }; }; diff --git a/nixos/modules/services/security/physlock.nix b/nixos/modules/services/security/physlock.nix index 760e80f147f7a..3db9e0ac44586 100644 --- a/nixos/modules/services/security/physlock.nix +++ b/nixos/modules/services/security/physlock.nix @@ -17,15 +17,15 @@ in enable = mkOption { type = types.bool; default = false; - description = '' - Whether to enable the <command>physlock</command> screen locking mechanism. + description = lib.mdDoc '' + Whether to enable the {command}`physlock` screen locking mechanism. - Enable this and then run <command>systemctl start physlock</command> + Enable this and then run {command}`systemctl start physlock` to securely lock the screen. This will switch to a new virtual terminal, turn off console switching and disable SysRq mechanism (when - <option>services.physlock.disableSysRq</option> is set) + {option}`services.physlock.disableSysRq` is set) until the root or user password is given. ''; }; @@ -33,7 +33,7 @@ in allowAnyUser = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to allow any user to lock the screen. This will install a setuid wrapper to allow any user to start physlock as root, which is a minor security risk. Call the physlock binary to use this instead @@ -44,7 +44,7 @@ in disableSysRq = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to disable SysRq when locked with physlock. ''; }; @@ -52,7 +52,7 @@ in lockMessage = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Message to show on physlock login terminal. ''; }; @@ -62,7 +62,7 @@ in suspend = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to lock screen with physlock just before suspend. ''; }; @@ -70,7 +70,7 @@ in hibernate = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to lock screen with physlock just before hibernate. ''; }; @@ -79,11 +79,11 @@ in type = types.listOf types.str; default = []; example = [ "display-manager.service" ]; - description = '' + description = lib.mdDoc '' Other targets to lock the screen just before. Useful if you want to e.g. both autologin to X11 so that - your <filename>~/.xsession</filename> gets executed and + your {file}`~/.xsession` gets executed and still to have the screen locked so that the system can be booted relatively unattended. ''; diff --git a/nixos/modules/services/security/privacyidea.nix b/nixos/modules/services/security/privacyidea.nix index 1f5639d475e85..599ade003c031 100644 --- a/nixos/modules/services/security/privacyidea.nix +++ b/nixos/modules/services/security/privacyidea.nix @@ -91,7 +91,7 @@ in stateDir = mkOption { type = types.str; default = "/var/lib/privacyidea"; - description = '' + description = lib.mdDoc '' Directory where all PrivacyIDEA files will be placed by default. ''; }; @@ -99,7 +99,7 @@ in superuserRealm = mkOption { type = types.listOf types.str; default = [ "super" "administrators" ]; - description = '' + description = lib.mdDoc '' The realm where users are allowed to login as administrators. ''; }; @@ -107,7 +107,7 @@ in secretKey = mkOption { type = types.str; example = "t0p s3cr3t"; - description = '' + description = lib.mdDoc '' This is used to encrypt the auth_token. ''; }; @@ -115,7 +115,7 @@ in pepper = mkOption { type = types.str; example = "Never know..."; - description = '' + description = lib.mdDoc '' This is used to encrypt the admin passwords. ''; }; @@ -124,7 +124,7 @@ in type = types.str; default = "${cfg.stateDir}/enckey"; defaultText = literalExpression ''"''${config.${opt.stateDir}}/enckey"''; - description = '' + description = lib.mdDoc '' This is used to encrypt the token data and token passwords ''; }; @@ -133,7 +133,7 @@ in type = types.str; default = "${cfg.stateDir}/private.pem"; defaultText = literalExpression ''"''${config.${opt.stateDir}}/private.pem"''; - description = '' + description = lib.mdDoc '' Private Key for signing the audit log. ''; }; @@ -142,26 +142,26 @@ in type = types.str; default = "${cfg.stateDir}/public.pem"; defaultText = literalExpression ''"''${config.${opt.stateDir}}/public.pem"''; - description = '' + description = lib.mdDoc '' Public key for checking signatures of the audit log. ''; }; adminPasswordFile = mkOption { type = types.path; - description = "File containing password for the admin user"; + description = lib.mdDoc "File containing password for the admin user"; }; adminEmail = mkOption { type = types.str; example = "admin@example.com"; - description = "Mail address for the admin user"; + description = lib.mdDoc "Mail address for the admin user"; }; extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration options for pi.cfg. ''; }; @@ -169,13 +169,13 @@ in user = mkOption { type = types.str; default = "privacyidea"; - description = "User account under which PrivacyIDEA runs."; + description = lib.mdDoc "User account under which PrivacyIDEA runs."; }; group = mkOption { type = types.str; default = "privacyidea"; - description = "Group account under which PrivacyIDEA runs."; + description = lib.mdDoc "Group account under which PrivacyIDEA runs."; }; ldap-proxy = { @@ -184,7 +184,7 @@ in configFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Path to PrivacyIDEA LDAP Proxy configuration (proxy.ini). ''; }; @@ -192,13 +192,13 @@ in user = mkOption { type = types.str; default = "pi-ldap-proxy"; - description = "User account under which PrivacyIDEA LDAP proxy runs."; + description = lib.mdDoc "User account under which PrivacyIDEA LDAP proxy runs."; }; group = mkOption { type = types.str; default = "pi-ldap-proxy"; - description = "Group account under which PrivacyIDEA LDAP proxy runs."; + description = lib.mdDoc "Group account under which PrivacyIDEA LDAP proxy runs."; }; settings = mkOption { diff --git a/nixos/modules/services/security/shibboleth-sp.nix b/nixos/modules/services/security/shibboleth-sp.nix index fea2a855e20f0..6626ea213625b 100644 --- a/nixos/modules/services/security/shibboleth-sp.nix +++ b/nixos/modules/services/security/shibboleth-sp.nix @@ -9,31 +9,31 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the shibboleth service"; + description = lib.mdDoc "Whether to enable the shibboleth service"; }; configFile = mkOption { type = types.path; example = literalExpression ''"''${pkgs.shibboleth-sp}/etc/shibboleth/shibboleth2.xml"''; - description = "Path to shibboleth config file"; + description = lib.mdDoc "Path to shibboleth config file"; }; fastcgi.enable = mkOption { type = types.bool; default = false; - description = "Whether to include the shibauthorizer and shibresponder FastCGI processes"; + description = lib.mdDoc "Whether to include the shibauthorizer and shibresponder FastCGI processes"; }; fastcgi.shibAuthorizerPort = mkOption { type = types.int; default = 9100; - description = "Port for shibauthorizer FastCGI proccess to bind to"; + description = lib.mdDoc "Port for shibauthorizer FastCGI proccess to bind to"; }; fastcgi.shibResponderPort = mkOption { type = types.int; default = 9101; - description = "Port for shibauthorizer FastCGI proccess to bind to"; + description = lib.mdDoc "Port for shibauthorizer FastCGI proccess to bind to"; }; }; }; diff --git a/nixos/modules/services/security/sks.nix b/nixos/modules/services/security/sks.nix index f4911597564b6..e9205e4855e58 100644 --- a/nixos/modules/services/security/sks.nix +++ b/nixos/modules/services/security/sks.nix @@ -25,7 +25,7 @@ in { default = pkgs.sks; defaultText = literalExpression "pkgs.sks"; type = types.package; - description = "Which SKS derivation to use."; + description = lib.mdDoc "Which SKS derivation to use."; }; dataDir = mkOption { @@ -35,7 +35,7 @@ in { # TODO: The default might change to "/var/lib/sks" as this is more # common. There's also https://github.com/NixOS/nixpkgs/issues/26256 # and "/var/db" is not FHS compliant (seems to come from BSD). - description = '' + description = lib.mdDoc '' Data directory (-basedir) for SKS, where the database and all configuration files are located (e.g. KDB, PTree, membership and sksconf). @@ -45,7 +45,7 @@ in { extraDbConfig = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Set contents of the files "KDB/DB_CONFIG" and "PTree/DB_CONFIG" within the ''${dataDir} directory. This is used to configure options for the database for the sks key server. @@ -59,7 +59,7 @@ in { hkpAddress = mkOption { default = [ "127.0.0.1" "::1" ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Domain names, IPv4 and/or IPv6 addresses to listen on for HKP requests. ''; @@ -68,14 +68,14 @@ in { hkpPort = mkOption { default = 11371; type = types.ints.u16; - description = "HKP port to listen on."; + description = lib.mdDoc "HKP port to listen on."; }; webroot = mkOption { type = types.nullOr types.path; default = "${sksPkg.webSamples}/OpenPKG"; defaultText = literalExpression ''"''${package.webSamples}/OpenPKG"''; - description = '' + description = lib.mdDoc '' Source directory (will be symlinked, if not null) for the files the built-in webserver should serve. SKS (''${pkgs.sks.webSamples}) provides the following examples: "HTML5", "OpenPKG", and "XHTML+ES". diff --git a/nixos/modules/services/security/sshguard.nix b/nixos/modules/services/security/sshguard.nix index 3be0a8c700b9e..4e9d9571de5ef 100644 --- a/nixos/modules/services/security/sshguard.nix +++ b/nixos/modules/services/security/sshguard.nix @@ -30,13 +30,13 @@ in { enable = mkOption { default = false; type = types.bool; - description = "Whether to enable the sshguard service."; + description = lib.mdDoc "Whether to enable the sshguard service."; }; attack_threshold = mkOption { default = 30; type = types.int; - description = '' + description = lib.mdDoc '' Block attackers when their cumulative attack score exceeds threshold. Most attacks have a score of 10. ''; }; @@ -45,7 +45,7 @@ in { default = null; example = 120; type = types.nullOr types.int; - description = '' + description = lib.mdDoc '' Blacklist an attacker when its score exceeds threshold. Blacklisted addresses are loaded from and added to blacklist-file. ''; }; @@ -53,7 +53,7 @@ in { blacklist_file = mkOption { default = "/var/lib/sshguard/blacklist.db"; type = types.path; - description = '' + description = lib.mdDoc '' Blacklist an attacker when its score exceeds threshold. Blacklisted addresses are loaded from and added to blacklist-file. ''; }; @@ -61,7 +61,7 @@ in { blocktime = mkOption { default = 120; type = types.int; - description = '' + description = lib.mdDoc '' Block attackers for initially blocktime seconds after exceeding threshold. Subsequent blocks increase by a factor of 1.5. sshguard unblocks attacks at random intervals, so actual block times will be longer. @@ -71,7 +71,7 @@ in { detection_time = mkOption { default = 1800; type = types.int; - description = '' + description = lib.mdDoc '' Remember potential attackers for up to detection_time seconds before resetting their score. ''; }; @@ -80,7 +80,7 @@ in { default = [ ]; example = [ "198.51.100.56" "198.51.100.2" ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Whitelist a list of addresses, hostnames, or address blocks. ''; }; @@ -89,7 +89,7 @@ in { default = [ "sshd" ]; example = [ "sshd" "exim" ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Systemd services sshguard should receive logs of. ''; }; diff --git a/nixos/modules/services/security/step-ca.nix b/nixos/modules/services/security/step-ca.nix index 95183078d7b64..9b9b53f135166 100644 --- a/nixos/modules/services/security/step-ca.nix +++ b/nixos/modules/services/security/step-ca.nix @@ -14,22 +14,22 @@ in type = lib.types.package; default = pkgs.step-ca; defaultText = lib.literalExpression "pkgs.step-ca"; - description = "Which step-ca package to use."; + description = lib.mdDoc "Which step-ca package to use."; }; address = lib.mkOption { type = lib.types.str; example = "127.0.0.1"; - description = '' + description = lib.mdDoc '' The address (without port) the certificate authority should listen at. - This combined with <option>services.step-ca.port</option> overrides <option>services.step-ca.settings.address</option>. + This combined with {option}`services.step-ca.port` overrides {option}`services.step-ca.settings.address`. ''; }; port = lib.mkOption { type = lib.types.port; example = 8443; - description = '' + description = lib.mdDoc '' The port the certificate authority should listen on. - This combined with <option>services.step-ca.address</option> overrides <option>services.step-ca.settings.address</option>. + This combined with {option}`services.step-ca.address` overrides {option}`services.step-ca.settings.address`. ''; }; settings = lib.mkOption { diff --git a/nixos/modules/services/security/tor.nix b/nixos/modules/services/security/tor.nix index a5822c02794d9..f611fee69089e 100644 --- a/nixos/modules/services/security/tor.nix +++ b/nixos/modules/services/security/tor.nix @@ -234,7 +234,7 @@ in type = types.package; default = pkgs.tor; defaultText = literalExpression "pkgs.tor"; - description = "Tor package to use."; + description = lib.mdDoc "Tor package to use."; }; enableGeoIP = mkEnableOption ''use of GeoIP databases. @@ -255,7 +255,7 @@ in type = optionSOCKSPort false; default = {addr = "127.0.0.1"; port = 9050; IsolateDestAddr = true;}; example = {addr = "192.168.0.1"; port = 9090; IsolateDestAddr = true;}; - description = '' + description = lib.mdDoc '' Bind to this address to listen for connections from Socks-speaking applications. ''; @@ -442,20 +442,20 @@ in type = types.attrsOf (types.submodule ({name, config, ...}: { options.path = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' Path where to store the data files of the hidden service. - If the <option>secretKey</option> is null - this defaults to <literal>${stateDir}/onion/$onion</literal>, - otherwise to <literal>${runDir}/onion/$onion</literal>. + If the {option}`secretKey` is null + this defaults to `${stateDir}/onion/$onion`, + otherwise to `${runDir}/onion/$onion`. ''; }; options.secretKey = mkOption { type = with types; nullOr path; default = null; example = "/run/keys/tor/onion/expyuzz4wqqyqhjn/hs_ed25519_secret_key"; - description = '' + description = lib.mdDoc '' Secret key of the onion service. - If null, Tor reuses any preexisting secret key (in <option>path</option>) + If null, Tor reuses any preexisting secret key (in {option}`path`) or generates a new one. The associated public key and hostname are deterministically regenerated from this file if they do not exist. @@ -468,9 +468,9 @@ in options = { authType = mkOption { type = types.enum [ "basic" "stealth" ]; - description = '' - Either <literal>"basic"</literal> for a general-purpose authorization protocol - or <literal>"stealth"</literal> for a less scalable protocol + description = lib.mdDoc '' + Either `"basic"` for a general-purpose authorization protocol + or `"stealth"` for a less scalable protocol that also hides service activity from unauthorized clients. ''; }; @@ -569,8 +569,8 @@ in }; settings = mkOption { - description = '' - See <link xlink:href="https://2019.www.torproject.org/docs/tor-manual.html.en">torrc manual</link> + description = lib.mdDoc '' + See [torrc manual](https://2019.www.torproject.org/docs/tor-manual.html.en) for documentation. ''; default = {}; @@ -716,12 +716,12 @@ in options = { onion = mkOption { type = strMatching "[a-z2-7]{16}\\.onion"; - description = "Onion address."; + description = lib.mdDoc "Onion address."; example = "xxxxxxxxxxxxxxxx.onion"; }; auth = mkOption { type = strMatching "[A-Za-z0-9+/]{22}"; - description = "Authentication cookie."; + description = lib.mdDoc "Authentication cookie."; }; }; }) @@ -783,13 +783,13 @@ in type = with types; nullOr (submodule ({...}: { options = { transports = mkOption { - description = "List of pluggable transports."; + description = lib.mdDoc "List of pluggable transports."; type = listOf str; example = ["obfs2" "obfs3" "obfs4" "scramblesuit"]; }; exec = mkOption { type = types.str; - description = "Command of pluggable transport."; + description = lib.mdDoc "Command of pluggable transport."; }; }; })); diff --git a/nixos/modules/services/security/torify.nix b/nixos/modules/services/security/torify.nix index 39551190dd33f..770e445d733fe 100644 --- a/nixos/modules/services/security/torify.nix +++ b/nixos/modules/services/security/torify.nix @@ -44,7 +44,7 @@ in type = types.str; default = "localhost:9050"; example = "192.168.0.20"; - description = '' + description = lib.mdDoc '' IP address of TOR client to use. ''; }; @@ -52,7 +52,7 @@ in config = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration. Contents will be added verbatim to TSocks configuration file. ''; diff --git a/nixos/modules/services/security/torsocks.nix b/nixos/modules/services/security/torsocks.nix index fdd6ac32cc662..0647d7eb49bcd 100644 --- a/nixos/modules/services/security/torsocks.nix +++ b/nixos/modules/services/security/torsocks.nix @@ -38,8 +38,8 @@ in type = types.bool; default = config.services.tor.enable && config.services.tor.client.enable; defaultText = literalExpression "config.services.tor.enable && config.services.tor.client.enable"; - description = '' - Whether to build <literal>/etc/tor/torsocks.conf</literal> + description = lib.mdDoc '' + Whether to build `/etc/tor/torsocks.conf` containing the specified global torsocks configuration. ''; }; @@ -48,7 +48,7 @@ in type = types.str; default = "127.0.0.1:9050"; example = "192.168.0.20:1234"; - description = '' + description = lib.mdDoc '' IP/Port of the Tor SOCKS server. Currently, hostnames are NOT supported by torsocks. ''; @@ -58,7 +58,7 @@ in type = types.str; default = "127.0.0.1:9063"; example = "192.168.0.20:1234"; - description = '' + description = lib.mdDoc '' IP/Port of the Tor SOCKS server for torsocks-faster wrapper suitable for HTTP. Currently, hostnames are NOT supported by torsocks. ''; @@ -67,7 +67,7 @@ in onionAddrRange = mkOption { type = types.str; default = "127.42.42.0/24"; - description = '' + description = lib.mdDoc '' Tor hidden sites do not have real IP addresses. This specifies what range of IP addresses will be handed to the application as "cookies" for .onion names. Of course, you @@ -81,8 +81,8 @@ in type = types.nullOr types.str; default = null; example = "bob"; - description = '' - SOCKS5 username. The <literal>TORSOCKS_USERNAME</literal> + description = lib.mdDoc '' + SOCKS5 username. The `TORSOCKS_USERNAME` environment variable overrides this option if it is set. ''; }; @@ -91,8 +91,8 @@ in type = types.nullOr types.str; default = null; example = "sekret"; - description = '' - SOCKS5 password. The <literal>TORSOCKS_PASSWORD</literal> + description = lib.mdDoc '' + SOCKS5 password. The `TORSOCKS_PASSWORD` environment variable overrides this option if it is set. ''; }; @@ -100,9 +100,9 @@ in allowInbound = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Set Torsocks to accept inbound connections. If set to - <literal>true</literal>, listen() and accept() will be + `true`, listen() and accept() will be allowed to be used with non localhost address. ''; }; diff --git a/nixos/modules/services/security/usbguard.nix b/nixos/modules/services/security/usbguard.nix index 201b37f17ba58..eb3c335d97402 100644 --- a/nixos/modules/services/security/usbguard.nix +++ b/nixos/modules/services/security/usbguard.nix @@ -45,9 +45,9 @@ in type = types.package; default = pkgs.usbguard; defaultText = literalExpression "pkgs.usbguard"; - description = '' + description = lib.mdDoc '' The usbguard package to use. If you do not need the Qt GUI, use - <literal>pkgs.usbguard-nox</literal> to save disk space. + `pkgs.usbguard-nox` to save disk space. ''; }; @@ -78,7 +78,7 @@ in implictPolicyTarget = mkOption { type = policy; default = "block"; - description = '' + description = lib.mdDoc '' How to treat USB devices that don't match any rule in the policy. Target should be one of allow, block or reject (logically remove the device node from the system). @@ -88,7 +88,7 @@ in presentDevicePolicy = mkOption { type = policy; default = "apply-policy"; - description = '' + description = lib.mdDoc '' How to treat USB devices that are already connected when the daemon starts. Policy should be one of allow, block, reject, keep (keep whatever state the device is currently in) or apply-policy (evaluate @@ -99,7 +99,7 @@ in presentControllerPolicy = mkOption { type = policy; default = "keep"; - description = '' + description = lib.mdDoc '' How to treat USB controller devices that are already connected when the daemon starts. One of allow, block, reject, keep or apply-policy. ''; @@ -108,7 +108,7 @@ in insertedDevicePolicy = mkOption { type = policy; default = "apply-policy"; - description = '' + description = lib.mdDoc '' How to treat USB devices that are already connected after the daemon starts. One of block, reject, apply-policy. ''; @@ -117,7 +117,7 @@ in restoreControllerDeviceState = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' The USBGuard daemon modifies some attributes of controller devices like the default authorization state of new child device instances. Using this setting, you can controll whether the daemon @@ -130,7 +130,7 @@ in type = types.listOf types.str; default = [ "root" ]; example = [ "root" "yourusername" ]; - description = '' + description = lib.mdDoc '' A list of usernames that the daemon will accept IPC connections from. ''; }; @@ -139,7 +139,7 @@ in type = types.listOf types.str; default = [ ]; example = [ "wheel" ]; - description = '' + description = lib.mdDoc '' A list of groupnames that the daemon will accept IPC connections from. ''; @@ -148,7 +148,7 @@ in deviceRulesWithPort = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Generate device specific rules including the "via-port" attribute. ''; }; diff --git a/nixos/modules/services/security/vault.nix b/nixos/modules/services/security/vault.nix index 4942a05fe73b7..e4777910b6d39 100644 --- a/nixos/modules/services/security/vault.nix +++ b/nixos/modules/services/security/vault.nix @@ -49,13 +49,13 @@ in type = types.package; default = pkgs.vault; defaultText = literalExpression "pkgs.vault"; - description = "This option specifies the vault package to use."; + description = lib.mdDoc "This option specifies the vault package to use."; }; dev = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' In this mode, Vault runs in-memory and starts unsealed. This option is not meant production but for development and testing i.e. for nixos tests. ''; }; @@ -63,29 +63,29 @@ in devRootTokenID = mkOption { type = types.str; default = false; - description = '' - Initial root token. This only applies when <option>services.vault.dev</option> is true + description = lib.mdDoc '' + Initial root token. This only applies when {option}`services.vault.dev` is true ''; }; address = mkOption { type = types.str; default = "127.0.0.1:8200"; - description = "The name of the ip interface to listen to"; + description = lib.mdDoc "The name of the ip interface to listen to"; }; tlsCertFile = mkOption { type = types.nullOr types.str; default = null; example = "/path/to/your/cert.pem"; - description = "TLS certificate file. TLS will be disabled unless this option is set"; + description = lib.mdDoc "TLS certificate file. TLS will be disabled unless this option is set"; }; tlsKeyFile = mkOption { type = types.nullOr types.str; default = null; example = "/path/to/your/key.pem"; - description = "TLS private key file. TLS will be disabled unless this option is set"; + description = lib.mdDoc "TLS private key file. TLS will be disabled unless this option is set"; }; listenerExtraConfig = mkOption { @@ -93,13 +93,13 @@ in default = '' tls_min_version = "tls12" ''; - description = "Extra text appended to the listener section."; + description = lib.mdDoc "Extra text appended to the listener section."; }; storageBackend = mkOption { type = types.enum [ "inmem" "file" "consul" "zookeeper" "s3" "azure" "dynamodb" "etcd" "mssql" "mysql" "postgresql" "swift" "gcs" "raft" ]; default = "inmem"; - description = "The name of the type of storage backend"; + description = lib.mdDoc "The name of the type of storage backend"; }; storagePath = mkOption { @@ -110,7 +110,7 @@ in then "/var/lib/vault" else null ''; - description = "Data directory for file backend"; + description = lib.mdDoc "Data directory for file backend"; }; storageConfig = mkOption { @@ -129,13 +129,13 @@ in telemetryConfig = mkOption { type = types.lines; default = ""; - description = "Telemetry configuration"; + description = lib.mdDoc "Telemetry configuration"; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Extra text appended to <filename>vault.hcl</filename>."; + description = lib.mdDoc "Extra text appended to {file}`vault.hcl`."; }; extraSettingsPaths = mkOption { diff --git a/nixos/modules/services/security/vaultwarden/default.nix b/nixos/modules/services/security/vaultwarden/default.nix index 756e0ee93b219..7e5389d78f4b7 100644 --- a/nixos/modules/services/security/vaultwarden/default.nix +++ b/nixos/modules/services/security/vaultwarden/default.nix @@ -44,7 +44,7 @@ in { dbBackend = mkOption { type = enum [ "sqlite" "mysql" "postgresql" ]; default = "sqlite"; - description = '' + description = lib.mdDoc '' Which database backend vaultwarden will be using. ''; }; @@ -52,7 +52,7 @@ in { backupDir = mkOption { type = nullOr str; default = null; - description = '' + description = lib.mdDoc '' The directory under which vaultwarden will backup its persistent data. ''; }; @@ -159,14 +159,14 @@ ADMIN_TOKEN=...copy-paste a unique generated secret token here... type = package; default = pkgs.vaultwarden; defaultText = literalExpression "pkgs.vaultwarden"; - description = "Vaultwarden package to use."; + description = lib.mdDoc "Vaultwarden package to use."; }; webVaultPackage = mkOption { type = package; default = pkgs.vaultwarden-vault; defaultText = literalExpression "pkgs.vaultwarden-vault"; - description = "Web vault package to use."; + description = lib.mdDoc "Web vault package to use."; }; }; diff --git a/nixos/modules/services/security/yubikey-agent.nix b/nixos/modules/services/security/yubikey-agent.nix index 8be2457e1e2f2..c91ff3e69a0a4 100644 --- a/nixos/modules/services/security/yubikey-agent.nix +++ b/nixos/modules/services/security/yubikey-agent.nix @@ -21,7 +21,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to start yubikey-agent when you log in. Also sets SSH_AUTH_SOCK to point at yubikey-agent. @@ -34,7 +34,7 @@ in type = types.package; default = pkgs.yubikey-agent; defaultText = literalExpression "pkgs.yubikey-agent"; - description = '' + description = lib.mdDoc '' The package used for the yubikey-agent daemon. ''; }; diff --git a/nixos/modules/services/system/cachix-agent/default.nix b/nixos/modules/services/system/cachix-agent/default.nix index ed37c5784ce13..b730118d46d88 100644 --- a/nixos/modules/services/system/cachix-agent/default.nix +++ b/nixos/modules/services/system/cachix-agent/default.nix @@ -12,34 +12,34 @@ in { name = mkOption { type = types.str; - description = "Agent name, usually same as the hostname"; + description = lib.mdDoc "Agent name, usually same as the hostname"; default = config.networking.hostName; defaultText = "config.networking.hostName"; }; verbose = mkOption { type = types.bool; - description = "Enable verbose output"; + description = lib.mdDoc "Enable verbose output"; default = false; }; profile = mkOption { type = types.nullOr types.str; default = null; - description = "Profile name, defaults to 'system' (NixOS)."; + description = lib.mdDoc "Profile name, defaults to 'system' (NixOS)."; }; package = mkOption { type = types.package; default = pkgs.cachix; defaultText = literalExpression "pkgs.cachix"; - description = "Cachix Client package to use."; + description = lib.mdDoc "Cachix Client package to use."; }; credentialsFile = mkOption { type = types.path; default = "/etc/cachix-agent.token"; - description = '' + description = lib.mdDoc '' Required file that needs to contain CACHIX_AGENT_TOKEN=... ''; }; diff --git a/nixos/modules/services/system/cloud-init.nix b/nixos/modules/services/system/cloud-init.nix index 8c6a6e294ebb6..111cfa83c222e 100644 --- a/nixos/modules/services/system/cloud-init.nix +++ b/nixos/modules/services/system/cloud-init.nix @@ -20,7 +20,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the cloud-init service. This services reads configuration metadata in a cloud environment and configures the machine according to this metadata. @@ -55,7 +55,7 @@ in network.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Allow the cloud-init service to configure network interfaces through systemd-networkd. ''; @@ -109,7 +109,7 @@ in - final-message - power-state-change ''; - description = "cloud-init configuration."; + description = lib.mdDoc "cloud-init configuration."; }; }; diff --git a/nixos/modules/services/system/dbus.nix b/nixos/modules/services/system/dbus.nix index d4cacb85694b9..c02e0905f1ccf 100644 --- a/nixos/modules/services/system/dbus.nix +++ b/nixos/modules/services/system/dbus.nix @@ -54,13 +54,13 @@ in apparmor = mkOption { type = types.enum [ "enabled" "disabled" "required" ]; - description = '' + description = lib.mdDoc '' AppArmor mode for dbus. - <literal>enabled</literal> enables mediation when it's - supported in the kernel, <literal>disabled</literal> + `enabled` enables mediation when it's + supported in the kernel, `disabled` always disables AppArmor even with kernel support, and - <literal>required</literal> fails when AppArmor was not found + `required` fails when AppArmor was not found in the kernel. ''; default = "disabled"; diff --git a/nixos/modules/services/system/earlyoom.nix b/nixos/modules/services/system/earlyoom.nix index 6293585598907..3e361fce00f98 100644 --- a/nixos/modules/services/system/earlyoom.nix +++ b/nixos/modules/services/system/earlyoom.nix @@ -16,16 +16,16 @@ in freeMemThreshold = mkOption { type = types.ints.between 1 100; default = 10; - description = '' + description = lib.mdDoc '' Minimum available memory (in percent). If the available memory falls below this threshold (and the analog is true for - <option>freeSwapThreshold</option>) the killing begins. + {option}`freeSwapThreshold`) the killing begins. SIGTERM is sent first to the process that uses the most memory; then, if the available - memory falls below <option>freeMemKillThreshold</option> (and the analog is true for - <option>freeSwapKillThreshold</option>), SIGKILL is sent. + memory falls below {option}`freeMemKillThreshold` (and the analog is true for + {option}`freeSwapKillThreshold`), SIGKILL is sent. - See <link xlink:href="https://github.com/rfjakob/earlyoom#command-line-options">README</link> for details. + See [README](https://github.com/rfjakob/earlyoom#command-line-options) for details. ''; }; @@ -64,7 +64,7 @@ in enableDebugInfo = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable debugging messages. ''; }; @@ -95,11 +95,11 @@ in echo "Process $EARLYOOM_NAME ($EARLYOOM_PID) was killed" >> /path/to/log ''' ''; - description = '' + description = lib.mdDoc '' An absolute path to an executable to be run for each process killed. Some environment variables are available, see - <link xlink:href="https://github.com/rfjakob/earlyoom#notifications">README</link> and - <link xlink:href="https://github.com/rfjakob/earlyoom/blob/master/MANPAGE.md#-n-pathtoscript">the man page</link> + [README](https://github.com/rfjakob/earlyoom#notifications) and + [the man page](https://github.com/rfjakob/earlyoom/blob/master/MANPAGE.md#-n-pathtoscript) for details. ''; }; @@ -108,14 +108,14 @@ in type = types.int; default = 3600; example = 0; - description = "Interval (in seconds) at which a memory report is printed (set to 0 to disable)."; + description = lib.mdDoc "Interval (in seconds) at which a memory report is printed (set to 0 to disable)."; }; extraArgs = mkOption { type = types.listOf types.str; default = []; example = [ "-g" "--prefer '(^|/)(java|chromium)$'" ]; - description = "Extra command-line arguments to be passed to earlyoom."; + description = lib.mdDoc "Extra command-line arguments to be passed to earlyoom."; }; }; diff --git a/nixos/modules/services/system/localtime.nix b/nixos/modules/services/system/localtime.nix index 689453375f5ac..c80fe366453ee 100644 --- a/nixos/modules/services/system/localtime.nix +++ b/nixos/modules/services/system/localtime.nix @@ -12,8 +12,8 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' - Enable <literal>localtimed</literal>, a simple daemon for keeping the + description = lib.mdDoc '' + Enable `localtimed`, a simple daemon for keeping the system timezone up-to-date based on the current location. It uses geoclue2 to determine the current location. ''; diff --git a/nixos/modules/services/system/saslauthd.nix b/nixos/modules/services/system/saslauthd.nix index 466b0ca60a7e6..c3fa7f7aefca7 100644 --- a/nixos/modules/services/system/saslauthd.nix +++ b/nixos/modules/services/system/saslauthd.nix @@ -22,19 +22,19 @@ in default = pkgs.cyrus_sasl.bin; defaultText = literalExpression "pkgs.cyrus_sasl.bin"; type = types.package; - description = "Cyrus SASL package to use."; + description = lib.mdDoc "Cyrus SASL package to use."; }; mechanism = mkOption { type = types.str; default = "pam"; - description = "Auth mechanism to use"; + description = lib.mdDoc "Auth mechanism to use"; }; config = mkOption { type = types.lines; default = ""; - description = "Configuration to use for Cyrus SASL authentication daemon."; + description = lib.mdDoc "Configuration to use for Cyrus SASL authentication daemon."; }; }; diff --git a/nixos/modules/services/system/self-deploy.nix b/nixos/modules/services/system/self-deploy.nix index d7130a13c7316..ff56206573c19 100644 --- a/nixos/modules/services/system/self-deploy.nix +++ b/nixos/modules/services/system/self-deploy.nix @@ -30,7 +30,7 @@ in default = "/default.nix"; - description = '' + description = lib.mdDoc '' Path to nix file in repository. Leading '/' refers to root of git repository. ''; @@ -88,7 +88,7 @@ in default = null; - description = '' + description = lib.mdDoc '' Path to SSH private key used to fetch private repositories over SSH. ''; diff --git a/nixos/modules/services/system/uptimed.nix b/nixos/modules/services/system/uptimed.nix index 67a03876e19f9..df08c0f26e986 100644 --- a/nixos/modules/services/system/uptimed.nix +++ b/nixos/modules/services/system/uptimed.nix @@ -12,8 +12,8 @@ in enable = mkOption { type = types.bool; default = false; - description = '' - Enable <literal>uptimed</literal>, allowing you to track + description = lib.mdDoc '' + Enable `uptimed`, allowing you to track your highest uptimes. ''; }; diff --git a/nixos/modules/services/torrent/deluge.nix b/nixos/modules/services/torrent/deluge.nix index cb0da9e83b42e..3f4cd2ff6e01d 100644 --- a/nixos/modules/services/torrent/deluge.nix +++ b/nixos/modules/services/torrent/deluge.nix @@ -42,7 +42,7 @@ in { openFilesLimit = mkOption { default = openFilesLimit; type = types.either types.int types.str; - description = '' + description = lib.mdDoc '' Number of files to allow deluged to open. ''; }; @@ -60,12 +60,12 @@ in { listen_ports = [ ${toString listenPortsDefault} ]; } ''; - description = '' + description = lib.mdDoc '' Deluge core configuration for the core.conf file. Only has an effect - when <option>services.deluge.declarative</option> is set to - <literal>true</literal>. String values must be quoted, integer and + when {option}`services.deluge.declarative` is set to + `true`. String values must be quoted, integer and boolean values must not. See - <link xlink:href="https://git.deluge-torrent.org/deluge/tree/deluge/core/preferencesmanager.py#n41"/> + <https://git.deluge-torrent.org/deluge/tree/deluge/core/preferencesmanager.py#n41> for the availaible options. ''; }; @@ -73,12 +73,12 @@ in { declarative = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to use a declarative deluge configuration. - Only if set to <literal>true</literal>, the options - <option>services.deluge.config</option>, - <option>services.deluge.openFirewall</option> and - <option>services.deluge.authFile</option> will be + Only if set to `true`, the options + {option}`services.deluge.config`, + {option}`services.deluge.openFirewall` and + {option}`services.deluge.authFile` will be applied. ''; }; @@ -86,15 +86,15 @@ in { openFirewall = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to open the firewall for the ports in - <option>services.deluge.config.listen_ports</option>. It only takes effet if - <option>services.deluge.declarative</option> is set to - <literal>true</literal>. + {option}`services.deluge.config.listen_ports`. It only takes effet if + {option}`services.deluge.declarative` is set to + `true`. It does NOT apply to the daemon port nor the web UI port. To access those ports secuerly check the documentation - <link xlink:href="https://dev.deluge-torrent.org/wiki/UserGuide/ThinClient#CreateSSHTunnel"/> + <https://dev.deluge-torrent.org/wiki/UserGuide/ThinClient#CreateSSHTunnel> or use a VPN or configure certificates for deluge. ''; }; @@ -102,7 +102,7 @@ in { dataDir = mkOption { type = types.path; default = "/var/lib/deluge"; - description = '' + description = lib.mdDoc '' The directory where deluge will create files. ''; }; @@ -110,13 +110,13 @@ in { authFile = mkOption { type = types.path; example = "/run/keys/deluge-auth"; - description = '' + description = lib.mdDoc '' The file managing the authentication for deluge, the format of this file is straightforward, each line contains a username:password:level tuple in plaintext. It only has an effect - when <option>services.deluge.declarative</option> is set to - <literal>true</literal>. - See <link xlink:href="https://dev.deluge-torrent.org/wiki/UserGuide/Authentication"/> for + when {option}`services.deluge.declarative` is set to + `true`. + See <https://dev.deluge-torrent.org/wiki/UserGuide/Authentication> for more informations. ''; }; @@ -124,7 +124,7 @@ in { user = mkOption { type = types.str; default = "deluge"; - description = '' + description = lib.mdDoc '' User account under which deluge runs. ''; }; @@ -132,7 +132,7 @@ in { group = mkOption { type = types.str; default = "deluge"; - description = '' + description = lib.mdDoc '' Group under which deluge runs. ''; }; @@ -140,7 +140,7 @@ in { extraPackages = mkOption { type = types.listOf types.package; default = []; - description = '' + description = lib.mdDoc '' Extra packages available at runtime to enable Deluge's plugins. For example, extraction utilities are required for the built-in "Extractor" plugin. This always contains unzip, gnutar, xz and bzip2. @@ -150,7 +150,7 @@ in { package = mkOption { type = types.package; example = literalExpression "pkgs.deluge-2_x"; - description = '' + description = lib.mdDoc '' Deluge package to use. ''; }; @@ -162,7 +162,7 @@ in { port = mkOption { type = types.port; default = 8112; - description = '' + description = lib.mdDoc '' Deluge web UI port. ''; }; @@ -170,7 +170,7 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for deluge web daemon ''; }; diff --git a/nixos/modules/services/torrent/flexget.nix b/nixos/modules/services/torrent/flexget.nix index e500e02d861b2..17d77bfae5fa9 100644 --- a/nixos/modules/services/torrent/flexget.nix +++ b/nixos/modules/services/torrent/flexget.nix @@ -20,34 +20,34 @@ in { default = "deluge"; example = "some_user"; type = types.str; - description = "The user under which to run flexget."; + description = lib.mdDoc "The user under which to run flexget."; }; homeDir = mkOption { default = "/var/lib/deluge"; example = "/home/flexget"; type = types.path; - description = "Where files live."; + description = lib.mdDoc "Where files live."; }; interval = mkOption { default = "10m"; example = "1h"; type = types.str; - description = "When to perform a <command>flexget</command> run. See <command>man 7 systemd.time</command> for the format."; + description = lib.mdDoc "When to perform a {command}`flexget` run. See {command}`man 7 systemd.time` for the format."; }; systemScheduler = mkOption { default = true; example = false; type = types.bool; - description = "When true, execute the runs via the flexget-runner.timer. If false, you have to specify the settings yourself in the YML file."; + description = lib.mdDoc "When true, execute the runs via the flexget-runner.timer. If false, you have to specify the settings yourself in the YML file."; }; config = mkOption { default = ""; type = types.lines; - description = "The YAML configuration for FlexGet."; + description = lib.mdDoc "The YAML configuration for FlexGet."; }; }; }; diff --git a/nixos/modules/services/torrent/magnetico.nix b/nixos/modules/services/torrent/magnetico.nix index 3dd7b1ece768b..11f1c71e3f818 100644 --- a/nixos/modules/services/torrent/magnetico.nix +++ b/nixos/modules/services/torrent/magnetico.nix @@ -49,7 +49,7 @@ in { type = types.str; default = "0.0.0.0"; example = "1.2.3.4"; - description = '' + description = lib.mdDoc '' Address to be used for indexing DHT nodes. ''; }; @@ -57,17 +57,17 @@ in { crawler.port = mkOption { type = types.port; default = 0; - description = '' + description = lib.mdDoc '' Port to be used for indexing DHT nodes. This port should be added to - <option>networking.firewall.allowedTCPPorts</option>. + {option}`networking.firewall.allowedTCPPorts`. ''; }; crawler.maxNeighbors = mkOption { type = types.ints.positive; default = 1000; - description = '' + description = lib.mdDoc '' Maximum number of simultaneous neighbors of an indexer. Be careful changing this number: high values can very easily cause your network to be congested or even crash @@ -78,7 +78,7 @@ in { crawler.maxLeeches = mkOption { type = types.ints.positive; default = 200; - description = '' + description = lib.mdDoc '' Maximum number of simultaneous leeches. ''; }; @@ -86,7 +86,7 @@ in { crawler.extraOptions = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Extra command line arguments to pass to magneticod. ''; }; @@ -95,7 +95,7 @@ in { type = types.str; default = "localhost"; example = "1.2.3.4"; - description = '' + description = lib.mdDoc '' Address the web interface will listen to. ''; }; @@ -103,7 +103,7 @@ in { web.port = mkOption { type = types.port; default = 8080; - description = '' + description = lib.mdDoc '' Port the web interface will listen to. ''; }; @@ -159,7 +159,7 @@ in { web.extraOptions = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Extra command line arguments to pass to magneticow. ''; }; diff --git a/nixos/modules/services/torrent/opentracker.nix b/nixos/modules/services/torrent/opentracker.nix index d76d61dfe8594..20b3d35a603a9 100644 --- a/nixos/modules/services/torrent/opentracker.nix +++ b/nixos/modules/services/torrent/opentracker.nix @@ -9,7 +9,7 @@ in { package = mkOption { type = types.package; - description = '' + description = lib.mdDoc '' opentracker package to use ''; default = pkgs.opentracker; @@ -18,7 +18,7 @@ in { extraOptions = mkOption { type = types.separatedString " "; - description = '' + description = lib.mdDoc '' Configuration Arguments for opentracker See https://erdgeist.org/arts/software/opentracker/ for all params ''; diff --git a/nixos/modules/services/torrent/peerflix.nix b/nixos/modules/services/torrent/peerflix.nix index 821c829f6b4af..ea74d0f8b9c48 100644 --- a/nixos/modules/services/torrent/peerflix.nix +++ b/nixos/modules/services/torrent/peerflix.nix @@ -19,19 +19,19 @@ in { options.services.peerflix = { enable = mkOption { - description = "Whether to enable peerflix service."; + description = lib.mdDoc "Whether to enable peerflix service."; default = false; type = types.bool; }; stateDir = mkOption { - description = "Peerflix state directory."; + description = lib.mdDoc "Peerflix state directory."; default = "/var/lib/peerflix"; type = types.path; }; downloadDir = mkOption { - description = "Peerflix temporary download directory."; + description = lib.mdDoc "Peerflix temporary download directory."; default = "${cfg.stateDir}/torrents"; defaultText = literalExpression ''"''${config.${opt.stateDir}}/torrents"''; type = types.path; diff --git a/nixos/modules/services/torrent/rtorrent.nix b/nixos/modules/services/torrent/rtorrent.nix index 759dcfe2e6c50..a805e09923ff0 100644 --- a/nixos/modules/services/torrent/rtorrent.nix +++ b/nixos/modules/services/torrent/rtorrent.nix @@ -14,7 +14,7 @@ in { dataDir = mkOption { type = types.str; default = "/var/lib/rtorrent"; - description = '' + description = lib.mdDoc '' The directory where rtorrent stores its data files. ''; }; @@ -23,7 +23,7 @@ in { type = types.str; default = "${cfg.dataDir}/download"; defaultText = literalExpression ''"''${config.${opt.dataDir}}/download"''; - description = '' + description = lib.mdDoc '' Where to put downloaded files. ''; }; @@ -31,7 +31,7 @@ in { user = mkOption { type = types.str; default = "rtorrent"; - description = '' + description = lib.mdDoc '' User account under which rtorrent runs. ''; }; @@ -39,7 +39,7 @@ in { group = mkOption { type = types.str; default = "rtorrent"; - description = '' + description = lib.mdDoc '' Group under which rtorrent runs. ''; }; @@ -48,7 +48,7 @@ in { type = types.package; default = pkgs.rtorrent; defaultText = literalExpression "pkgs.rtorrent"; - description = '' + description = lib.mdDoc '' The rtorrent package to use. ''; }; @@ -56,7 +56,7 @@ in { port = mkOption { type = types.port; default = 50000; - description = '' + description = lib.mdDoc '' The rtorrent port. ''; }; @@ -64,8 +64,8 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' - Whether to open the firewall for the port in <option>services.rtorrent.port</option>. + description = lib.mdDoc '' + Whether to open the firewall for the port in {option}`services.rtorrent.port`. ''; }; @@ -73,7 +73,7 @@ in { type = types.str; readOnly = true; default = "/run/rtorrent/rpc.sock"; - description = '' + description = lib.mdDoc '' RPC socket path. ''; }; @@ -81,8 +81,8 @@ in { configText = mkOption { type = types.lines; default = ""; - description = '' - The content of <filename>rtorrent.rc</filename>. The <link xlink:href="https://rtorrent-docs.readthedocs.io/en/latest/cookbook.html#modernized-configuration-template">modernized configuration template</link> with the values specified in this module will be prepended using mkBefore. You can use mkForce to overwrite the config completly. + description = lib.mdDoc '' + The content of {file}`rtorrent.rc`. The [modernized configuration template](https://rtorrent-docs.readthedocs.io/en/latest/cookbook.html#modernized-configuration-template) with the values specified in this module will be prepended using mkBefore. You can use mkForce to overwrite the config completly. ''; }; }; diff --git a/nixos/modules/services/torrent/transmission.nix b/nixos/modules/services/torrent/transmission.nix index d12d8aa239802..9777964386c96 100644 --- a/nixos/modules/services/torrent/transmission.nix +++ b/nixos/modules/services/torrent/transmission.nix @@ -34,12 +34,12 @@ in accessible to users in the "transmission" group''; settings = mkOption { - description = '' + description = lib.mdDoc '' Settings whose options overwrite fields in - <literal>.config/transmission-daemon/settings.json</literal> + `.config/transmission-daemon/settings.json` (each time the service starts). - See <link xlink:href="https://github.com/transmission/transmission/wiki/Editing-Configuration-Files">Transmission's Wiki</link> + See [Transmission's Wiki](https://github.com/transmission/transmission/wiki/Editing-Configuration-Files) for documentation of settings not explicitely covered by this module. ''; default = {}; @@ -49,7 +49,7 @@ in type = types.path; default = "${cfg.home}/${downloadsDir}"; defaultText = literalExpression ''"''${config.${opt.home}}/${downloadsDir}"''; - description = "Directory where to download torrents."; + description = lib.mdDoc "Directory where to download torrents."; }; options.incomplete-dir = mkOption { type = types.path; @@ -72,12 +72,12 @@ in options.message-level = mkOption { type = types.ints.between 0 3; default = 2; - description = "Set verbosity of transmission messages."; + description = lib.mdDoc "Set verbosity of transmission messages."; }; options.peer-port = mkOption { type = types.port; default = 51413; - description = "The peer port to listen for incoming connections."; + description = lib.mdDoc "The peer port to listen for incoming connections."; }; options.peer-port-random-high = mkOption { type = types.port; @@ -98,7 +98,7 @@ in options.peer-port-random-on-start = mkOption { type = types.bool; default = false; - description = "Randomize the peer port."; + description = lib.mdDoc "Randomize the peer port."; }; options.rpc-bind-address = mkOption { type = types.str; @@ -112,7 +112,7 @@ in options.rpc-port = mkOption { type = types.port; default = 9091; - description = "The RPC port to listen to."; + description = lib.mdDoc "The RPC port to listen to."; }; options.script-torrent-done-enabled = mkOption { type = types.bool; @@ -126,12 +126,12 @@ in options.script-torrent-done-filename = mkOption { type = types.nullOr types.path; default = null; - description = "Executable to be run at torrent completion."; + description = lib.mdDoc "Executable to be run at torrent completion."; }; options.umask = mkOption { type = types.int; default = 2; - description = '' + description = lib.mdDoc '' Sets transmission's file mode creation mask. See the umask(2) manpage for more information. Users who want their saved torrents to be world-writable @@ -143,15 +143,15 @@ in options.utp-enabled = mkOption { type = types.bool; default = true; - description = '' - Whether to enable <link xlink:href="http://en.wikipedia.org/wiki/Micro_Transport_Protocol">Micro Transport Protocol (µTP)</link>. + description = lib.mdDoc '' + Whether to enable [Micro Transport Protocol (µTP)](http://en.wikipedia.org/wiki/Micro_Transport_Protocol). ''; }; options.watch-dir = mkOption { type = types.path; default = "${cfg.home}/${watchDir}"; defaultText = literalExpression ''"''${config.${opt.home}}/${watchDir}"''; - description = "Watch a directory for torrent files and add them to transmission."; + description = lib.mdDoc "Watch a directory for torrent files and add them to transmission."; }; options.watch-dir-enabled = mkOption { type = types.bool; @@ -200,13 +200,13 @@ in user = mkOption { type = types.str; default = "transmission"; - description = "User account under which Transmission runs."; + description = lib.mdDoc "User account under which Transmission runs."; }; group = mkOption { type = types.str; default = "transmission"; - description = "Group account under which Transmission runs."; + description = lib.mdDoc "Group account under which Transmission runs."; }; credentialsFile = mkOption { @@ -224,7 +224,7 @@ in type = types.listOf types.str; default = []; example = [ "--log-debug" ]; - description = '' + description = lib.mdDoc '' Extra flags passed to the transmission command in the service definition. ''; }; diff --git a/nixos/modules/services/tracing/tempo.nix b/nixos/modules/services/tracing/tempo.nix index 15491a51c8e9e..201f850656da1 100644 --- a/nixos/modules/services/tracing/tempo.nix +++ b/nixos/modules/services/tracing/tempo.nix @@ -13,7 +13,7 @@ in { settings = mkOption { type = settingsFormat.type; default = {}; - description = '' + description = lib.mdDoc '' Specify the configuration for Tempo in Nix. See https://grafana.com/docs/tempo/latest/configuration/ for available options. @@ -23,7 +23,7 @@ in { configFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Specify a path to a configuration file that Tempo should use. ''; }; diff --git a/nixos/modules/services/ttys/getty.nix b/nixos/modules/services/ttys/getty.nix index 7021a2c80f857..d2bebb9c245bd 100644 --- a/nixos/modules/services/ttys/getty.nix +++ b/nixos/modules/services/ttys/getty.nix @@ -34,7 +34,7 @@ in autologinUser = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Username of the account that will be automatically logged in at the console. If unspecified, a login prompt is shown as usual. ''; @@ -44,7 +44,7 @@ in type = types.path; default = "${pkgs.shadow}/bin/login"; defaultText = literalExpression ''"''${pkgs.shadow}/bin/login"''; - description = '' + description = lib.mdDoc '' Path to the login binary executed by agetty. ''; }; @@ -69,7 +69,7 @@ in extraArgs = mkOption { type = types.listOf types.str; default = [ ]; - description = '' + description = lib.mdDoc '' Additional arguments passed to agetty. ''; example = [ "--nohostname" ]; @@ -77,7 +77,7 @@ in greetingLine = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Welcome line printed by agetty. The default shows current NixOS version label, machine type and tty. ''; @@ -86,7 +86,7 @@ in helpLine = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Help line printed by agetty below the welcome line. Used by the installation CD to give some hints on how to proceed. diff --git a/nixos/modules/services/ttys/gpm.nix b/nixos/modules/services/ttys/gpm.nix index 308a6d3643a60..378f6b17732fb 100644 --- a/nixos/modules/services/ttys/gpm.nix +++ b/nixos/modules/services/ttys/gpm.nix @@ -19,7 +19,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable GPM, the General Purpose Mouse daemon, which enables mouse support in virtual consoles. ''; @@ -28,7 +28,7 @@ in protocol = mkOption { type = types.str; default = "ps/2"; - description = "Mouse protocol to use."; + description = lib.mdDoc "Mouse protocol to use."; }; }; diff --git a/nixos/modules/services/ttys/kmscon.nix b/nixos/modules/services/ttys/kmscon.nix index e02ab3cb6b323..f5a8d8b104d2f 100644 --- a/nixos/modules/services/ttys/kmscon.nix +++ b/nixos/modules/services/ttys/kmscon.nix @@ -11,7 +11,7 @@ in { options = { services.kmscon = { enable = mkOption { - description = '' + description = lib.mdDoc '' Use kmscon as the virtual console instead of gettys. kmscon is a kms/dri-based userspace virtual terminal implementation. It supports a richer feature set than the standard linux console VT, @@ -23,33 +23,33 @@ in { }; hwRender = mkOption { - description = "Whether to use 3D hardware acceleration to render the console."; + description = lib.mdDoc "Whether to use 3D hardware acceleration to render the console."; type = types.bool; default = false; }; fonts = mkOption { - description = "Fonts used by kmscon, in order of priority."; + description = lib.mdDoc "Fonts used by kmscon, in order of priority."; default = null; example = lib.literalExpression ''[ { name = "Source Code Pro"; package = pkgs.source-code-pro; } ]''; type = with types; let fontType = submodule { options = { - name = mkOption { type = str; description = "Font name, as used by fontconfig."; }; - package = mkOption { type = package; description = "Package providing the font."; }; + name = mkOption { type = str; description = lib.mdDoc "Font name, as used by fontconfig."; }; + package = mkOption { type = package; description = lib.mdDoc "Package providing the font."; }; }; }; in nullOr (nonEmptyListOf fontType); }; extraConfig = mkOption { - description = "Extra contents of the kmscon.conf file."; + description = lib.mdDoc "Extra contents of the kmscon.conf file."; type = types.lines; default = ""; example = "font-size=14"; }; extraOptions = mkOption { - description = "Extra flags to pass to kmscon."; + description = lib.mdDoc "Extra flags to pass to kmscon."; type = types.separatedString " "; default = ""; example = "--term xterm-256color"; @@ -58,7 +58,7 @@ in { autologinUser = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Username of the account that will be automatically logged in at the console. If unspecified, a login prompt is shown as usual. ''; diff --git a/nixos/modules/services/video/epgstation/default.nix b/nixos/modules/services/video/epgstation/default.nix index 191f6eb52e57e..51f71389263cd 100644 --- a/nixos/modules/services/video/epgstation/default.nix +++ b/nixos/modules/services/video/epgstation/default.nix @@ -84,17 +84,17 @@ in default = pkgs.epgstation; type = lib.types.package; defaultText = lib.literalExpression "pkgs.epgstation"; - description = "epgstation package to use"; + description = lib.mdDoc "epgstation package to use"; }; usePreconfiguredStreaming = lib.mkOption { type = lib.types.bool; default = true; - description = '' + description = lib.mdDoc '' Use preconfigured default streaming options. Upstream defaults: - <link xlink:href="https://github.com/l3tnun/EPGStation/blob/master/config/config.yml.template"/> + <https://github.com/l3tnun/EPGStation/blob/master/config/config.yml.template> ''; }; @@ -118,7 +118,7 @@ in name = lib.mkOption { type = lib.types.str; default = "epgstation"; - description = '' + description = lib.mdDoc '' Name of the MySQL database that holds EPGStation's data. ''; }; @@ -126,9 +126,9 @@ in passwordFile = lib.mkOption { type = lib.types.path; example = "/run/keys/epgstation-db-password"; - description = '' + description = lib.mdDoc '' A file containing the password for the database named - <option>database.name</option>. + {option}`database.name`. ''; }; }; @@ -144,11 +144,11 @@ in # configure them according to their needs. In these cases, the value in the # upstream template configuration should serve as a "good enough" default. settings = lib.mkOption { - description = '' + description = lib.mdDoc '' Options to add to config.yml. Documentation: - <link xlink:href="https://github.com/l3tnun/EPGStation/blob/master/doc/conf-manual.md"/> + <https://github.com/l3tnun/EPGStation/blob/master/doc/conf-manual.md> ''; default = { }; @@ -163,7 +163,7 @@ in options.port = lib.mkOption { type = lib.types.port; default = 20772; - description = '' + description = lib.mdDoc '' HTTP port for EPGStation to listen on. ''; }; @@ -172,9 +172,9 @@ in type = lib.types.port; default = cfg.settings.port + 1; defaultText = lib.literalExpression "config.${opt.settings}.port + 1"; - description = '' + description = lib.mdDoc '' Socket.io port for EPGStation to listen on. It is valid to share - ports with <option>${opt.settings}.port</option>. + ports with {option}`${opt.settings}.port`. ''; }; @@ -182,9 +182,9 @@ in type = lib.types.port; default = cfg.settings.socketioPort; defaultText = lib.literalExpression "config.${opt.settings}.socketioPort"; - description = '' + description = lib.mdDoc '' Socket.io port that the web client is going to connect to. This may - be different from <option>${opt.settings}.socketioPort</option> if + be different from {option}`${opt.settings}.socketioPort` if EPGStation is hidden behind a reverse proxy. ''; }; @@ -196,13 +196,13 @@ in "http+unix://''${lib.replaceStrings ["/"] ["%2F"] config.${option}}" ''; example = "http://localhost:40772"; - description = "URL to connect to Mirakurun."; + description = lib.mdDoc "URL to connect to Mirakurun."; }; options.encodeProcessNum = lib.mkOption { type = lib.types.ints.positive; default = 4; - description = '' + description = lib.mdDoc '' The maximum number of processes that EPGStation would allow to run at the same time for encoding or streaming videos. ''; @@ -211,7 +211,7 @@ in options.concurrentEncodeNum = lib.mkOption { type = lib.types.ints.positive; default = 1; - description = '' + description = lib.mdDoc '' The maximum number of encoding jobs that EPGStation would run at the same time. ''; @@ -219,7 +219,7 @@ in options.encode = lib.mkOption { type = with lib.types; listOf attrs; - description = "Encoding presets for recorded videos."; + description = lib.mdDoc "Encoding presets for recorded videos."; default = [ { name = "H.264"; diff --git a/nixos/modules/services/video/mirakurun.nix b/nixos/modules/services/video/mirakurun.nix index 35303b2332c67..90119361afabc 100644 --- a/nixos/modules/services/video/mirakurun.nix +++ b/nixos/modules/services/video/mirakurun.nix @@ -29,8 +29,8 @@ in port = mkOption { type = with types; nullOr port; default = 40772; - description = '' - Port to listen on. If <literal>null</literal>, it won't listen on + description = lib.mdDoc '' + Port to listen on. If `null`, it won't listen on any port. ''; }; @@ -54,8 +54,8 @@ in unixSocket = mkOption { type = with types; nullOr path; default = "/var/run/mirakurun/mirakurun.sock"; - description = '' - Path to unix socket to listen on. If <literal>null</literal>, it + description = lib.mdDoc '' + Path to unix socket to listen on. If `null`, it won't listen on any unix sockets. ''; }; @@ -63,7 +63,7 @@ in allowSmartCardAccess = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Install polkit rules to allow Mirakurun to access smart card readers which is commonly used along with tuner devices. ''; @@ -78,11 +78,11 @@ in overflowTimeLimit = 30000; }; ''; - description = '' + description = lib.mdDoc '' Options for server.yml. Documentation: - <link xlink:href="https://github.com/Chinachu/Mirakurun/blob/master/doc/Configuration.md"/> + <https://github.com/Chinachu/Mirakurun/blob/master/doc/Configuration.md> ''; }; @@ -98,12 +98,12 @@ in } ]; ''; - description = '' + description = lib.mdDoc '' Options which are added to tuners.yml. If none is specified, it will automatically be generated at runtime. Documentation: - <link xlink:href="https://github.com/Chinachu/Mirakurun/blob/master/doc/Configuration.md"/> + <https://github.com/Chinachu/Mirakurun/blob/master/doc/Configuration.md> ''; }; @@ -119,12 +119,12 @@ in } ]; ''; - description = '' + description = lib.mdDoc '' Options which are added to channels.yml. If none is specified, it will automatically be generated at runtime. Documentation: - <link xlink:href="https://github.com/Chinachu/Mirakurun/blob/master/doc/Configuration.md"/> + <https://github.com/Chinachu/Mirakurun/blob/master/doc/Configuration.md> ''; }; }; diff --git a/nixos/modules/services/video/replay-sorcery.nix b/nixos/modules/services/video/replay-sorcery.nix index abe7202a4a862..f3cecfc248cf8 100644 --- a/nixos/modules/services/video/replay-sorcery.nix +++ b/nixos/modules/services/video/replay-sorcery.nix @@ -19,13 +19,13 @@ in autoStart = mkOption { type = bool; default = false; - description = "Automatically start ReplaySorcery when graphical-session.target starts."; + description = lib.mdDoc "Automatically start ReplaySorcery when graphical-session.target starts."; }; settings = mkOption { type = attrsOf (oneOf [ str int ]); default = {}; - description = "System-wide configuration for ReplaySorcery (/etc/replay-sorcery.conf)."; + description = lib.mdDoc "System-wide configuration for ReplaySorcery (/etc/replay-sorcery.conf)."; example = literalExpression '' { videoInput = "hwaccel"; # requires `services.replay-sorcery.enableSysAdminCapability = true` diff --git a/nixos/modules/services/video/rtsp-simple-server.nix b/nixos/modules/services/video/rtsp-simple-server.nix index 644b1945a1ecb..db6f0441bbf18 100644 --- a/nixos/modules/services/video/rtsp-simple-server.nix +++ b/nixos/modules/services/video/rtsp-simple-server.nix @@ -13,9 +13,9 @@ in enable = mkEnableOption "RTSP Simple Server"; settings = mkOption { - description = '' + description = lib.mdDoc '' Settings for rtsp-simple-server. - Read more at <link xlink:href="https://github.com/aler9/rtsp-simple-server/blob/main/rtsp-simple-server.yml"/> + Read more at <https://github.com/aler9/rtsp-simple-server/blob/main/rtsp-simple-server.yml> ''; type = format.type; @@ -40,7 +40,7 @@ in env = mkOption { type = with types; attrsOf anything; - description = "Extra environment variables for RTSP Simple Server"; + description = lib.mdDoc "Extra environment variables for RTSP Simple Server"; default = {}; example = { RTSP_CONFKEY = "mykey"; diff --git a/nixos/modules/services/video/unifi-video.nix b/nixos/modules/services/video/unifi-video.nix index 11d9fe305470c..fcc3cb02a1b0e 100644 --- a/nixos/modules/services/video/unifi-video.nix +++ b/nixos/modules/services/video/unifi-video.nix @@ -98,7 +98,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether or not to enable the unifi-video service. ''; }; @@ -107,7 +107,7 @@ in type = types.package; default = pkgs.jre8; defaultText = literalExpression "pkgs.jre8"; - description = '' + description = lib.mdDoc '' The JRE package to use. Check the release notes to ensure it is supported. ''; }; @@ -116,7 +116,7 @@ in type = types.package; default = pkgs.unifi-video; defaultText = literalExpression "pkgs.unifi-video"; - description = '' + description = lib.mdDoc '' The unifi-video package to use. ''; }; @@ -125,7 +125,7 @@ in type = types.package; default = pkgs.mongodb-4_0; defaultText = literalExpression "pkgs.mongodb"; - description = '' + description = lib.mdDoc '' The mongodb package to use. ''; }; @@ -133,7 +133,7 @@ in logDir = mkOption { type = types.str; default = "${stateDir}/logs"; - description = '' + description = lib.mdDoc '' Where to store the logs. ''; }; @@ -141,7 +141,7 @@ in dataDir = mkOption { type = types.str; default = "${stateDir}/data"; - description = '' + description = lib.mdDoc '' Where to store the database and other data. ''; }; @@ -149,7 +149,7 @@ in openFirewall = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether or not to open the required ports on the firewall. ''; }; @@ -158,7 +158,7 @@ in type = types.nullOr types.int; default = 1024; example = 4096; - description = '' + description = lib.mdDoc '' Set the maximimum heap size for the JVM in MB. ''; }; @@ -167,7 +167,7 @@ in type = types.path; default = "${cfg.dataDir}/unifi-video.pid"; defaultText = literalExpression ''"''${config.${opt.dataDir}}/unifi-video.pid"''; - description = "Location of unifi-video pid file."; + description = lib.mdDoc "Location of unifi-video pid file."; }; }; diff --git a/nixos/modules/services/wayland/cage.nix b/nixos/modules/services/wayland/cage.nix index b818f5c463a91..c7accc5f9e185 100644 --- a/nixos/modules/services/wayland/cage.nix +++ b/nixos/modules/services/wayland/cage.nix @@ -10,7 +10,7 @@ in { options.services.cage.user = mkOption { type = types.str; default = "demo"; - description = '' + description = lib.mdDoc '' User to log-in as. ''; }; @@ -19,7 +19,7 @@ in { type = types.listOf types.str; default = []; defaultText = literalExpression "[]"; - description = "Additional command line arguments to pass to Cage."; + description = lib.mdDoc "Additional command line arguments to pass to Cage."; example = ["-d"]; }; @@ -27,7 +27,7 @@ in { type = types.path; default = "${pkgs.xterm}/bin/xterm"; defaultText = literalExpression ''"''${pkgs.xterm}/bin/xterm"''; - description = '' + description = lib.mdDoc '' Program to run in cage. ''; }; diff --git a/nixos/modules/services/web-apps/atlassian/confluence.nix b/nixos/modules/services/web-apps/atlassian/confluence.nix index 4aad307731ab3..6c5de3fbe4b88 100644 --- a/nixos/modules/services/web-apps/atlassian/confluence.nix +++ b/nixos/modules/services/web-apps/atlassian/confluence.nix @@ -34,38 +34,38 @@ in user = mkOption { type = types.str; default = "confluence"; - description = "User which runs confluence."; + description = lib.mdDoc "User which runs confluence."; }; group = mkOption { type = types.str; default = "confluence"; - description = "Group which runs confluence."; + description = lib.mdDoc "Group which runs confluence."; }; home = mkOption { type = types.str; default = "/var/lib/confluence"; - description = "Home directory of the confluence instance."; + description = lib.mdDoc "Home directory of the confluence instance."; }; listenAddress = mkOption { type = types.str; default = "127.0.0.1"; - description = "Address to listen on."; + description = lib.mdDoc "Address to listen on."; }; listenPort = mkOption { type = types.int; default = 8090; - description = "Port to listen on."; + description = lib.mdDoc "Port to listen on."; }; catalinaOptions = mkOption { type = types.listOf types.str; default = []; example = [ "-Xms1024m" "-Xmx2048m" "-Dconfluence.disable.peopledirectory.all=true" ]; - description = "Java options to pass to catalina/tomcat."; + description = lib.mdDoc "Java options to pass to catalina/tomcat."; }; proxy = { @@ -74,21 +74,21 @@ in name = mkOption { type = types.str; example = "confluence.example.com"; - description = "Virtual hostname at the proxy"; + description = lib.mdDoc "Virtual hostname at the proxy"; }; port = mkOption { type = types.int; default = 443; example = 80; - description = "Port used at the proxy"; + description = lib.mdDoc "Port used at the proxy"; }; scheme = mkOption { type = types.str; default = "https"; example = "http"; - description = "Protocol used at the proxy."; + description = lib.mdDoc "Protocol used at the proxy."; }; }; @@ -98,32 +98,32 @@ in crowd = mkOption { type = types.str; example = "http://localhost:8095/crowd"; - description = "Crowd Base URL without trailing slash"; + description = lib.mdDoc "Crowd Base URL without trailing slash"; }; applicationName = mkOption { type = types.str; example = "jira"; - description = "Exact name of this Confluence instance in Crowd"; + description = lib.mdDoc "Exact name of this Confluence instance in Crowd"; }; applicationPassword = mkOption { type = types.nullOr types.str; default = null; - description = "Application password of this Confluence instance in Crowd"; + description = lib.mdDoc "Application password of this Confluence instance in Crowd"; }; applicationPasswordFile = mkOption { type = types.nullOr types.str; default = null; - description = "Path to the application password for Crowd of Confluence."; + description = lib.mdDoc "Path to the application password for Crowd of Confluence."; }; validationInterval = mkOption { type = types.int; default = 2; example = 0; - description = '' + description = lib.mdDoc '' Set to 0, if you want authentication checks to occur on each request. Otherwise set to the number of minutes between request to validate if the user is logged in or out of the Crowd SSO @@ -137,14 +137,14 @@ in type = types.package; default = pkgs.atlassian-confluence; defaultText = literalExpression "pkgs.atlassian-confluence"; - description = "Atlassian Confluence package to use."; + description = lib.mdDoc "Atlassian Confluence package to use."; }; jrePackage = mkOption { type = types.package; default = pkgs.oraclejre8; defaultText = literalExpression "pkgs.oraclejre8"; - description = "Note that Atlassian only support the Oracle JRE (JRASERVER-46152)."; + description = lib.mdDoc "Note that Atlassian only support the Oracle JRE (JRASERVER-46152)."; }; }; }; diff --git a/nixos/modules/services/web-apps/atlassian/crowd.nix b/nixos/modules/services/web-apps/atlassian/crowd.nix index 9418aff12adb3..abe3a8bdb2254 100644 --- a/nixos/modules/services/web-apps/atlassian/crowd.nix +++ b/nixos/modules/services/web-apps/atlassian/crowd.nix @@ -39,50 +39,50 @@ in user = mkOption { type = types.str; default = "crowd"; - description = "User which runs Crowd."; + description = lib.mdDoc "User which runs Crowd."; }; group = mkOption { type = types.str; default = "crowd"; - description = "Group which runs Crowd."; + description = lib.mdDoc "Group which runs Crowd."; }; home = mkOption { type = types.str; default = "/var/lib/crowd"; - description = "Home directory of the Crowd instance."; + description = lib.mdDoc "Home directory of the Crowd instance."; }; listenAddress = mkOption { type = types.str; default = "127.0.0.1"; - description = "Address to listen on."; + description = lib.mdDoc "Address to listen on."; }; listenPort = mkOption { type = types.int; default = 8092; - description = "Port to listen on."; + description = lib.mdDoc "Port to listen on."; }; openidPassword = mkOption { type = types.str; default = "WILL_NEVER_BE_SET"; - description = "Application password for OpenID server."; + description = lib.mdDoc "Application password for OpenID server."; }; openidPasswordFile = mkOption { type = types.nullOr types.str; default = null; - description = "Path to the file containing the application password for OpenID server."; + description = lib.mdDoc "Path to the file containing the application password for OpenID server."; }; catalinaOptions = mkOption { type = types.listOf types.str; default = []; example = [ "-Xms1024m" "-Xmx2048m" ]; - description = "Java options to pass to catalina/tomcat."; + description = lib.mdDoc "Java options to pass to catalina/tomcat."; }; proxy = { @@ -91,27 +91,27 @@ in name = mkOption { type = types.str; example = "crowd.example.com"; - description = "Virtual hostname at the proxy"; + description = lib.mdDoc "Virtual hostname at the proxy"; }; port = mkOption { type = types.int; default = 443; example = 80; - description = "Port used at the proxy"; + description = lib.mdDoc "Port used at the proxy"; }; scheme = mkOption { type = types.str; default = "https"; example = "http"; - description = "Protocol used at the proxy."; + description = lib.mdDoc "Protocol used at the proxy."; }; secure = mkOption { type = types.bool; default = true; - description = "Whether the connections to the proxy should be considered secure."; + description = lib.mdDoc "Whether the connections to the proxy should be considered secure."; }; }; @@ -119,14 +119,14 @@ in type = types.package; default = pkgs.atlassian-crowd; defaultText = literalExpression "pkgs.atlassian-crowd"; - description = "Atlassian Crowd package to use."; + description = lib.mdDoc "Atlassian Crowd package to use."; }; jrePackage = mkOption { type = types.package; default = pkgs.oraclejre8; defaultText = literalExpression "pkgs.oraclejre8"; - description = "Note that Atlassian only support the Oracle JRE (JRASERVER-46152)."; + description = lib.mdDoc "Note that Atlassian only support the Oracle JRE (JRASERVER-46152)."; }; }; }; diff --git a/nixos/modules/services/web-apps/atlassian/jira.nix b/nixos/modules/services/web-apps/atlassian/jira.nix index fd89d763c7fb4..5d62160ffb139 100644 --- a/nixos/modules/services/web-apps/atlassian/jira.nix +++ b/nixos/modules/services/web-apps/atlassian/jira.nix @@ -34,38 +34,38 @@ in user = mkOption { type = types.str; default = "jira"; - description = "User which runs JIRA."; + description = lib.mdDoc "User which runs JIRA."; }; group = mkOption { type = types.str; default = "jira"; - description = "Group which runs JIRA."; + description = lib.mdDoc "Group which runs JIRA."; }; home = mkOption { type = types.str; default = "/var/lib/jira"; - description = "Home directory of the JIRA instance."; + description = lib.mdDoc "Home directory of the JIRA instance."; }; listenAddress = mkOption { type = types.str; default = "127.0.0.1"; - description = "Address to listen on."; + description = lib.mdDoc "Address to listen on."; }; listenPort = mkOption { type = types.int; default = 8091; - description = "Port to listen on."; + description = lib.mdDoc "Port to listen on."; }; catalinaOptions = mkOption { type = types.listOf types.str; default = []; example = [ "-Xms1024m" "-Xmx2048m" ]; - description = "Java options to pass to catalina/tomcat."; + description = lib.mdDoc "Java options to pass to catalina/tomcat."; }; proxy = { @@ -74,27 +74,27 @@ in name = mkOption { type = types.str; example = "jira.example.com"; - description = "Virtual hostname at the proxy"; + description = lib.mdDoc "Virtual hostname at the proxy"; }; port = mkOption { type = types.int; default = 443; example = 80; - description = "Port used at the proxy"; + description = lib.mdDoc "Port used at the proxy"; }; scheme = mkOption { type = types.str; default = "https"; example = "http"; - description = "Protocol used at the proxy."; + description = lib.mdDoc "Protocol used at the proxy."; }; secure = mkOption { type = types.bool; default = true; - description = "Whether the connections to the proxy should be considered secure."; + description = lib.mdDoc "Whether the connections to the proxy should be considered secure."; }; }; @@ -104,25 +104,25 @@ in crowd = mkOption { type = types.str; example = "http://localhost:8095/crowd"; - description = "Crowd Base URL without trailing slash"; + description = lib.mdDoc "Crowd Base URL without trailing slash"; }; applicationName = mkOption { type = types.str; example = "jira"; - description = "Exact name of this JIRA instance in Crowd"; + description = lib.mdDoc "Exact name of this JIRA instance in Crowd"; }; applicationPasswordFile = mkOption { type = types.str; - description = "Path to the file containing the application password of this JIRA instance in Crowd"; + description = lib.mdDoc "Path to the file containing the application password of this JIRA instance in Crowd"; }; validationInterval = mkOption { type = types.int; default = 2; example = 0; - description = '' + description = lib.mdDoc '' Set to 0, if you want authentication checks to occur on each request. Otherwise set to the number of minutes between request to validate if the user is logged in or out of the Crowd SSO @@ -136,14 +136,14 @@ in type = types.package; default = pkgs.atlassian-jira; defaultText = literalExpression "pkgs.atlassian-jira"; - description = "Atlassian JIRA package to use."; + description = lib.mdDoc "Atlassian JIRA package to use."; }; jrePackage = mkOption { type = types.package; default = pkgs.oraclejre8; defaultText = literalExpression "pkgs.oraclejre8"; - description = "Note that Atlassian only support the Oracle JRE (JRASERVER-46152)."; + description = lib.mdDoc "Note that Atlassian only support the Oracle JRE (JRASERVER-46152)."; }; }; }; diff --git a/nixos/modules/services/web-apps/baget.nix b/nixos/modules/services/web-apps/baget.nix index 3007dd4fbb267..dd70d462d57db 100644 --- a/nixos/modules/services/web-apps/baget.nix +++ b/nixos/modules/services/web-apps/baget.nix @@ -58,7 +58,7 @@ in apiKeyFile = mkOption { type = types.path; example = "/root/baget.key"; - description = '' + description = lib.mdDoc '' Private API key for BaGet. ''; }; @@ -112,8 +112,8 @@ in }; } ''; - description = '' - Extra configuration options for BaGet. Refer to <link xlink:href="https://loic-sharma.github.io/BaGet/configuration/"/> for details. + description = lib.mdDoc '' + Extra configuration options for BaGet. Refer to <https://loic-sharma.github.io/BaGet/configuration/> for details. Default value is merged with values from here. ''; }; diff --git a/nixos/modules/services/web-apps/calibre-web.nix b/nixos/modules/services/web-apps/calibre-web.nix index 2bc817343a9b7..6bcf733452b96 100644 --- a/nixos/modules/services/web-apps/calibre-web.nix +++ b/nixos/modules/services/web-apps/calibre-web.nix @@ -14,7 +14,7 @@ in ip = mkOption { type = types.str; default = "::1"; - description = '' + description = lib.mdDoc '' IP address that Calibre-Web should listen on. ''; }; @@ -22,7 +22,7 @@ in port = mkOption { type = types.port; default = 8083; - description = '' + description = lib.mdDoc '' Listen port for Calibre-Web. ''; }; @@ -31,27 +31,27 @@ in dataDir = mkOption { type = types.str; default = "calibre-web"; - description = '' - The directory below <filename>/var/lib</filename> where Calibre-Web stores its data. + description = lib.mdDoc '' + The directory below {file}`/var/lib` where Calibre-Web stores its data. ''; }; user = mkOption { type = types.str; default = "calibre-web"; - description = "User account under which Calibre-Web runs."; + description = lib.mdDoc "User account under which Calibre-Web runs."; }; group = mkOption { type = types.str; default = "calibre-web"; - description = "Group account under which Calibre-Web runs."; + description = lib.mdDoc "Group account under which Calibre-Web runs."; }; openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for the server. ''; }; @@ -60,7 +60,7 @@ in calibreLibrary = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Path to Calibre library. ''; }; @@ -68,7 +68,7 @@ in enableBookConversion = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Configure path to the Calibre's ebook-convert in the DB. ''; }; @@ -76,7 +76,7 @@ in enableBookUploading = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Allow books to be uploaded via Calibre-Web UI. ''; }; @@ -85,7 +85,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable authorization using auth proxy. ''; }; @@ -93,7 +93,7 @@ in header = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Auth proxy header name. ''; }; diff --git a/nixos/modules/services/web-apps/code-server.nix b/nixos/modules/services/web-apps/code-server.nix index 474e9140ae87b..84fc03deabffd 100644 --- a/nixos/modules/services/web-apps/code-server.nix +++ b/nixos/modules/services/web-apps/code-server.nix @@ -16,13 +16,13 @@ in { package = mkOption { default = pkgs.code-server; defaultText = "pkgs.code-server"; - description = "Which code-server derivation to use."; + description = lib.mdDoc "Which code-server derivation to use."; type = types.package; }; extraPackages = mkOption { default = [ ]; - description = "Packages that are available in the PATH of code-server."; + description = lib.mdDoc "Packages that are available in the PATH of code-server."; example = "[ pkgs.go ]"; type = types.listOf types.package; }; @@ -30,49 +30,49 @@ in { extraEnvironment = mkOption { type = types.attrsOf types.str; description = - "Additional environment variables to passed to code-server."; + lib.mdDoc "Additional environment variables to passed to code-server."; default = { }; example = { PKG_CONFIG_PATH = "/run/current-system/sw/lib/pkgconfig"; }; }; extraArguments = mkOption { default = [ "--disable-telemetry" ]; - description = "Additional arguments that passed to code-server"; + description = lib.mdDoc "Additional arguments that passed to code-server"; example = ''[ "--verbose" ]''; type = types.listOf types.str; }; host = mkOption { default = "127.0.0.1"; - description = "The host-ip to bind to."; + description = lib.mdDoc "The host-ip to bind to."; type = types.str; }; port = mkOption { default = 4444; - description = "The port where code-server runs."; + description = lib.mdDoc "The port where code-server runs."; type = types.port; }; auth = mkOption { default = "password"; - description = "The type of authentication to use."; + description = lib.mdDoc "The type of authentication to use."; type = types.enum [ "none" "password" ]; }; hashedPassword = mkOption { default = ""; description = - "Create the password with: 'echo -n 'thisismypassword' | npx argon2-cli -e'."; + lib.mdDoc "Create the password with: 'echo -n 'thisismypassword' | npx argon2-cli -e'."; type = types.str; }; user = mkOption { default = defaultUser; example = "yourUser"; - description = '' + description = lib.mdDoc '' The user to run code-server as. - By default, a user named <literal>${defaultUser}</literal> will be created. + By default, a user named `${defaultUser}` will be created. ''; type = types.str; }; @@ -80,9 +80,9 @@ in { group = mkOption { default = defaultGroup; example = "yourGroup"; - description = '' + description = lib.mdDoc '' The group to run code-server under. - By default, a group named <literal>${defaultGroup}</literal> will be created. + By default, a group named `${defaultGroup}` will be created. ''; type = types.str; }; @@ -90,7 +90,7 @@ in { extraGroups = mkOption { default = [ ]; description = - "An array of additional groups for the <literal>${defaultUser}</literal> user."; + lib.mdDoc "An array of additional groups for the `${defaultUser}` user."; example = [ "docker" ]; type = types.listOf types.str; }; diff --git a/nixos/modules/services/web-apps/convos.nix b/nixos/modules/services/web-apps/convos.nix index 8be11eec9f31d..120481c640170 100644 --- a/nixos/modules/services/web-apps/convos.nix +++ b/nixos/modules/services/web-apps/convos.nix @@ -12,21 +12,21 @@ in type = types.port; default = 3000; example = 8080; - description = "Port the web interface should listen on"; + description = lib.mdDoc "Port the web interface should listen on"; }; listenAddress = mkOption { type = types.str; default = "*"; example = "127.0.0.1"; - description = "Address or host the web interface should listen on"; + description = lib.mdDoc "Address or host the web interface should listen on"; }; reverseProxy = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enables reverse proxy support. This will allow Convos to automatically - pick up the <literal>X-Forwarded-For</literal> and - <literal>X-Request-Base</literal> HTTP headers set in your reverse proxy + pick up the `X-Forwarded-For` and + `X-Request-Base` HTTP headers set in your reverse proxy web server. Note that enabling this option without a reverse proxy in front will be a security issue. ''; diff --git a/nixos/modules/services/web-apps/dex.nix b/nixos/modules/services/web-apps/dex.nix index 4d4689a4cf24a..eebf4b740c77e 100644 --- a/nixos/modules/services/web-apps/dex.nix +++ b/nixos/modules/services/web-apps/dex.nix @@ -45,9 +45,9 @@ in ]; } ''; - description = '' + description = lib.mdDoc '' The available options can be found in - <link xlink:href="https://github.com/dexidp/dex/blob/v${pkgs.dex.version}/config.yaml.dist">the example configuration</link>. + [the example configuration](https://github.com/dexidp/dex/blob/v${pkgs.dex.version}/config.yaml.dist). ''; }; }; diff --git a/nixos/modules/services/web-apps/discourse.nix b/nixos/modules/services/web-apps/discourse.nix index 7dbbf4a12fe5b..20ad653429a51 100644 --- a/nixos/modules/services/web-apps/discourse.nix +++ b/nixos/modules/services/web-apps/discourse.nix @@ -35,7 +35,7 @@ in plugins = lib.unique (p.enabledPlugins ++ cfg.plugins); }; defaultText = lib.literalExpression "pkgs.discourse"; - description = '' + description = lib.mdDoc '' The discourse package to use. ''; }; @@ -48,7 +48,7 @@ in config.networking.hostName; defaultText = lib.literalExpression "config.networking.fqdn"; example = "discourse.example.com"; - description = '' + description = lib.mdDoc '' The hostname to serve Discourse on. ''; }; @@ -81,7 +81,7 @@ in type = with lib.types; nullOr path; default = null; example = "/run/keys/ssl.cert"; - description = '' + description = lib.mdDoc '' The path to the server SSL certificate. Set this to enable SSL. ''; @@ -91,7 +91,7 @@ in type = with lib.types; nullOr path; default = null; example = "/run/keys/ssl.key"; - description = '' + description = lib.mdDoc '' The path to the server SSL certificate key. Set this to enable SSL. ''; @@ -104,7 +104,7 @@ in <literal>true</literal>, unless <option>services.discourse.sslCertificate</option> and <option>services.discourse.sslCertificateKey</option> are set. ''; - description = '' + description = lib.mdDoc '' Whether an ACME certificate should be used to secure connections to the server. ''; @@ -151,26 +151,26 @@ in }; }; ''; - description = '' + description = lib.mdDoc '' Discourse site settings. These are the settings that can be changed from the UI. This only defines their default values: they can still be overridden from the UI. Available settings can be found by looking in the - <link xlink:href="https://github.com/discourse/discourse/blob/master/config/site_settings.yml">site_settings.yml</link> + [site_settings.yml](https://github.com/discourse/discourse/blob/master/config/site_settings.yml) file of the upstream distribution. To find a setting's path, you only need to care about the first two levels; i.e. its category and name. See the example. Settings containing secret data should be set to an attribute set containing the attribute - <literal>_secret</literal> - a string pointing to a file + `_secret` - a string pointing to a file containing the value the option should be set to. See the example to get a better picture of this: in the resulting - <filename>config/nixos_site_settings.json</filename> file, - the <literal>login.github_client_secret</literal> key will + {file}`config/nixos_site_settings.json` file, + the `login.github_client_secret` key will be set to the contents of the - <filename>/run/keys/discourse_github_client_secret</filename> + {file}`/run/keys/discourse_github_client_secret` file. ''; }; @@ -179,7 +179,7 @@ in skipCreate = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Do not create the admin account, instead rely on other existing admin accounts. ''; @@ -188,7 +188,7 @@ in email = lib.mkOption { type = lib.types.str; example = "admin@example.com"; - description = '' + description = lib.mdDoc '' The admin user email address. ''; }; @@ -196,21 +196,21 @@ in username = lib.mkOption { type = lib.types.str; example = "admin"; - description = '' + description = lib.mdDoc '' The admin user username. ''; }; fullName = lib.mkOption { type = lib.types.str; - description = '' + description = lib.mdDoc '' The admin user's full name. ''; }; passwordFile = lib.mkOption { type = lib.types.path; - description = '' + description = lib.mdDoc '' A path to a file containing the admin user's password. This should be a string, not a nix path, since nix paths are @@ -222,8 +222,8 @@ in nginx.enable = lib.mkOption { type = lib.types.bool; default = true; - description = '' - Whether an <literal>nginx</literal> virtual host should be + description = lib.mdDoc '' + Whether an `nginx` virtual host should be set up to serve Discourse. Only disable if you're planning to use a different web server, which is not recommended. ''; @@ -233,7 +233,7 @@ in pool = lib.mkOption { type = lib.types.int; default = 8; - description = '' + description = lib.mdDoc '' Database connection pool size. ''; }; @@ -250,7 +250,7 @@ in passwordFile = lib.mkOption { type = with lib.types; nullOr path; default = null; - description = '' + description = lib.mdDoc '' File containing the Discourse database user password. This should be a string, not a nix path, since nix paths are @@ -261,18 +261,18 @@ in createLocally = lib.mkOption { type = lib.types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether a database should be automatically created on the - local host. Set this to <literal>false</literal> if you plan + local host. Set this to `false` if you plan on provisioning a local database yourself. This has no effect - if <option>services.discourse.database.host</option> is customized. + if {option}`services.discourse.database.host` is customized. ''; }; name = lib.mkOption { type = lib.types.str; default = "discourse"; - description = '' + description = lib.mdDoc '' Discourse database name. ''; }; @@ -280,7 +280,7 @@ in username = lib.mkOption { type = lib.types.str; default = "discourse"; - description = '' + description = lib.mdDoc '' Discourse database user. ''; }; @@ -288,10 +288,10 @@ in ignorePostgresqlVersion = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to allow other versions of PostgreSQL than the recommended one. Only effective when - <option>services.discourse.database.createLocally</option> + {option}`services.discourse.database.createLocally` is enabled. ''; }; @@ -301,7 +301,7 @@ in host = lib.mkOption { type = lib.types.str; default = "localhost"; - description = '' + description = lib.mdDoc '' Redis server hostname. ''; }; @@ -309,7 +309,7 @@ in passwordFile = lib.mkOption { type = with lib.types; nullOr path; default = null; - description = '' + description = lib.mdDoc '' File containing the Redis password. This should be a string, not a nix path, since nix paths are @@ -320,7 +320,7 @@ in dbNumber = lib.mkOption { type = lib.types.int; default = 0; - description = '' + description = lib.mdDoc '' Redis database number. ''; }; @@ -329,7 +329,7 @@ in type = lib.types.bool; default = cfg.redis.host != "localhost"; defaultText = lib.literalExpression ''config.${opt.redis.host} != "localhost"''; - description = '' + description = lib.mdDoc '' Connect to Redis with SSL. ''; }; @@ -342,8 +342,8 @@ in defaultText = lib.literalExpression '' "''${if config.services.discourse.mail.incoming.enable then "notifications" else "noreply"}@''${config.services.discourse.hostname}" ''; - description = '' - The <literal>from:</literal> email address used when + description = lib.mdDoc '' + The `from:` email address used when sending all essential system emails. The domain specified here must have SPF, DKIM and reverse PTR records set correctly for email to arrive. @@ -353,10 +353,10 @@ in contactEmailAddress = lib.mkOption { type = lib.types.str; default = ""; - description = '' + description = lib.mdDoc '' Email address of key contact responsible for this site. Used for critical notifications, as well as on the - <literal>/about</literal> contact form for urgent matters. + `/about` contact form for urgent matters. ''; }; @@ -364,7 +364,7 @@ in serverAddress = lib.mkOption { type = lib.types.str; default = "localhost"; - description = '' + description = lib.mdDoc '' The address of the SMTP server Discourse should use to send email. ''; @@ -373,7 +373,7 @@ in port = lib.mkOption { type = lib.types.port; default = 25; - description = '' + description = lib.mdDoc '' The port of the SMTP server Discourse should use to send email. ''; @@ -382,7 +382,7 @@ in username = lib.mkOption { type = with lib.types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' The username of the SMTP server. ''; }; @@ -390,7 +390,7 @@ in passwordFile = lib.mkOption { type = lib.types.nullOr lib.types.path; default = null; - description = '' + description = lib.mdDoc '' A file containing the password of the SMTP server account. This should be a string, not a nix path, since nix paths @@ -402,7 +402,7 @@ in type = lib.types.str; default = cfg.hostname; defaultText = lib.literalExpression "config.${opt.hostname}"; - description = '' + description = lib.mdDoc '' HELO domain to use for outgoing mail. ''; }; @@ -410,7 +410,7 @@ in authentication = lib.mkOption { type = with lib.types; nullOr (enum ["plain" "login" "cram_md5"]); default = null; - description = '' + description = lib.mdDoc '' Authentication type to use, see http://api.rubyonrails.org/classes/ActionMailer/Base.html ''; }; @@ -418,7 +418,7 @@ in enableStartTLSAuto = lib.mkOption { type = lib.types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to try to use StartTLS. ''; }; @@ -426,7 +426,7 @@ in opensslVerifyMode = lib.mkOption { type = lib.types.str; default = "peer"; - description = '' + description = lib.mdDoc '' How OpenSSL checks the certificate, see http://api.rubyonrails.org/classes/ActionMailer/Base.html ''; }; @@ -434,7 +434,7 @@ in forceTLS = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Force implicit TLS as per RFC 8314 3.3. ''; }; @@ -444,7 +444,7 @@ in enable = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to set up Postfix to receive incoming mail. ''; }; @@ -453,7 +453,7 @@ in type = lib.types.str; default = "%{reply_key}@${cfg.hostname}"; defaultText = lib.literalExpression ''"%{reply_key}@''${config.services.discourse.hostname}"''; - description = '' + description = lib.mdDoc '' Template for reply by email incoming email address, for example: %{reply_key}@reply.example.com or replies+%{reply_key}@example.com @@ -464,7 +464,7 @@ in type = lib.types.package; default = pkgs.discourse-mail-receiver; defaultText = lib.literalExpression "pkgs.discourse-mail-receiver"; - description = '' + description = lib.mdDoc '' The discourse-mail-receiver package to use. ''; }; @@ -472,10 +472,10 @@ in apiKeyFile = lib.mkOption { type = lib.types.nullOr lib.types.path; default = null; - description = '' + description = lib.mdDoc '' A file containing the Discourse API key used to add posts and messages from mail. If left at its default - value <literal>null</literal>, one will be automatically + value `null`, one will be automatically generated. This should be a string, not a nix path, since nix paths @@ -504,7 +504,7 @@ in sidekiqProcesses = lib.mkOption { type = lib.types.int; default = 1; - description = '' + description = lib.mdDoc '' How many Sidekiq processes should be spawned. ''; }; @@ -512,7 +512,7 @@ in unicornTimeout = lib.mkOption { type = lib.types.int; default = 30; - description = '' + description = lib.mdDoc '' Time in seconds before a request to Unicorn times out. This can be raised if the system Discourse is running on is diff --git a/nixos/modules/services/web-apps/documize.nix b/nixos/modules/services/web-apps/documize.nix index 7f2ed82ee33e4..4353e3c24453a 100644 --- a/nixos/modules/services/web-apps/documize.nix +++ b/nixos/modules/services/web-apps/documize.nix @@ -17,8 +17,8 @@ in { stateDirectoryName = mkOption { type = types.str; default = "documize"; - description = '' - The name of the directory below <filename>/var/lib/private</filename> + description = lib.mdDoc '' + The name of the directory below {file}`/var/lib/private` where documize runs in and stores, for example, backups. ''; }; @@ -27,7 +27,7 @@ in { type = types.package; default = pkgs.documize-community; defaultText = literalExpression "pkgs.documize-community"; - description = '' + description = lib.mdDoc '' Which package to use for documize. ''; }; @@ -36,7 +36,7 @@ in { type = types.nullOr types.str; default = null; example = "3edIYV6c8B28b19fh"; - description = '' + description = lib.mdDoc '' The salt string used to encode JWT tokens, if not set a random value will be generated. ''; }; @@ -44,23 +44,23 @@ in { cert = mkOption { type = types.nullOr types.str; default = null; - description = '' - The <filename>cert.pem</filename> file used for https. + description = lib.mdDoc '' + The {file}`cert.pem` file used for https. ''; }; key = mkOption { type = types.nullOr types.str; default = null; - description = '' - The <filename>key.pem</filename> file used for https. + description = lib.mdDoc '' + The {file}`key.pem` file used for https. ''; }; port = mkOption { type = types.port; default = 5001; - description = '' + description = lib.mdDoc '' The http/https port number. ''; }; @@ -68,7 +68,7 @@ in { forcesslport = mkOption { type = types.nullOr types.port; default = null; - description = '' + description = lib.mdDoc '' Redirect given http port number to TLS. ''; }; @@ -76,8 +76,8 @@ in { offline = mkOption { type = types.bool; default = false; - description = '' - Set <literal>true</literal> for offline mode. + description = lib.mdDoc '' + Set `true` for offline mode. ''; apply = v: if true == v then 1 else 0; }; @@ -122,7 +122,7 @@ in { location = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' reserved ''; }; diff --git a/nixos/modules/services/web-apps/dokuwiki.nix b/nixos/modules/services/web-apps/dokuwiki.nix index d8fc978774e48..49865b962d108 100644 --- a/nixos/modules/services/web-apps/dokuwiki.nix +++ b/nixos/modules/services/web-apps/dokuwiki.nix @@ -66,21 +66,21 @@ let type = types.package; default = pkgs.dokuwiki; defaultText = literalExpression "pkgs.dokuwiki"; - description = "Which DokuWiki package to use."; + description = lib.mdDoc "Which DokuWiki package to use."; }; stateDir = mkOption { type = types.path; default = "/var/lib/dokuwiki/${name}/data"; - description = "Location of the DokuWiki state directory."; + description = lib.mdDoc "Location of the DokuWiki state directory."; }; acl = mkOption { type = types.nullOr types.lines; default = null; example = "* @ALL 8"; - description = '' - Access Control Lists: see <link xlink:href="https://www.dokuwiki.org/acl"/> + description = lib.mdDoc '' + Access Control Lists: see <https://www.dokuwiki.org/acl> Mutually exclusive with services.dokuwiki.aclFile Set this to a value other than null to take precedence over aclFile option. @@ -92,11 +92,11 @@ let aclFile = mkOption { type = with types; nullOr str; default = if (config.aclUse && config.acl == null) then "/var/lib/dokuwiki/${name}/acl.auth.php" else null; - description = '' + description = lib.mdDoc '' Location of the dokuwiki acl rules. Mutually exclusive with services.dokuwiki.acl Mutually exclusive with services.dokuwiki.acl which is preferred. - Consult documentation <link xlink:href="https://www.dokuwiki.org/acl"/> for further instructions. - Example: <link xlink:href="https://github.com/splitbrain/dokuwiki/blob/master/conf/acl.auth.php.dist"/> + Consult documentation <https://www.dokuwiki.org/acl> for further instructions. + Example: <https://github.com/splitbrain/dokuwiki/blob/master/conf/acl.auth.php.dist> ''; example = "/var/lib/dokuwiki/${name}/acl.auth.php"; }; @@ -104,7 +104,7 @@ let aclUse = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Necessary for users to log in into the system. Also limits anonymous users. When disabled, everyone is able to create and edit content. @@ -119,7 +119,7 @@ let $plugins['authmysql'] = 0; $plugins['authpgsql'] = 0; ''; - description = '' + description = lib.mdDoc '' List of the dokuwiki (un)loaded plugins. ''; }; @@ -127,10 +127,10 @@ let superUser = mkOption { type = types.nullOr types.str; default = "@admin"; - description = '' + description = lib.mdDoc '' You can set either a username, a list of usernames (“admin1,admin2”), or the name of a group by prepending an @ char to the groupname - Consult documentation <link xlink:href="https://www.dokuwiki.org/config:superuser"/> for further instructions. + Consult documentation <https://www.dokuwiki.org/config:superuser> for further instructions. ''; }; @@ -150,9 +150,9 @@ let type = types.nullOr types.str; default = ""; example = "search,register"; - description = '' + description = lib.mdDoc '' Disable individual action modes. Refer to - <link xlink:href="https://www.dokuwiki.org/config:action_modes"/> + <https://www.dokuwiki.org/config:action_modes> for details on supported values. ''; }; @@ -222,8 +222,8 @@ let "pm.max_spare_servers" = 4; "pm.max_requests" = 500; }; - description = '' - Options for the DokuWiki PHP pool. See the documentation on <literal>php-fpm.conf</literal> + description = lib.mdDoc '' + Options for the DokuWiki PHP pool. See the documentation on `php-fpm.conf` for details on configuration directives. ''; }; @@ -235,9 +235,9 @@ let $conf['title'] = 'My Wiki'; $conf['userewrite'] = 1; ''; - description = '' + description = lib.mdDoc '' DokuWiki configuration. Refer to - <link xlink:href="https://www.dokuwiki.org/config"/> + <https://www.dokuwiki.org/config> for details on supported values. ''; }; @@ -254,7 +254,7 @@ in sites = mkOption { type = types.attrsOf (types.submodule siteOpts); default = {}; - description = "Specification of one or more DokuWiki sites to serve"; + description = lib.mdDoc "Specification of one or more DokuWiki sites to serve"; }; webserver = mkOption { diff --git a/nixos/modules/services/web-apps/engelsystem.nix b/nixos/modules/services/web-apps/engelsystem.nix index 06c3c6dfc3d7d..f1d71f1744715 100644 --- a/nixos/modules/services/web-apps/engelsystem.nix +++ b/nixos/modules/services/web-apps/engelsystem.nix @@ -9,7 +9,7 @@ in { enable = mkOption { default = false; example = true; - description = '' + description = lib.mdDoc '' Whether to enable engelsystem, an online tool for coordinating volunteers and shifts on large events. ''; @@ -19,12 +19,12 @@ in { domain = mkOption { type = types.str; example = "engelsystem.example.com"; - description = "Domain to serve on."; + description = lib.mdDoc "Domain to serve on."; }; package = mkOption { type = types.package; - description = "Engelsystem package used for the service."; + description = lib.mdDoc "Engelsystem package used for the service."; default = pkgs.engelsystem; defaultText = literalExpression "pkgs.engelsystem"; }; @@ -32,9 +32,9 @@ in { createDatabase = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to create a local database automatically. - This will override every database setting in <option>services.engelsystem.config</option>. + This will override every database setting in {option}`services.engelsystem.config`. ''; }; }; @@ -70,7 +70,7 @@ in { min_password_length = 6; default_locale = "de_DE"; }; - description = '' + description = lib.mdDoc '' Options to be added to config.php, as a nix attribute set. Options containing secret data should be set to an attribute set containing the attribute _secret - a string pointing to a file containing the value the option should be set to. See the example to get a better diff --git a/nixos/modules/services/web-apps/ethercalc.nix b/nixos/modules/services/web-apps/ethercalc.nix index d74def59c6c3e..a5be86a34aa6d 100644 --- a/nixos/modules/services/web-apps/ethercalc.nix +++ b/nixos/modules/services/web-apps/ethercalc.nix @@ -10,11 +10,11 @@ in { enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' ethercalc, an online collaborative spreadsheet server. Persistent state will be maintained under - <filename>/var/lib/ethercalc</filename>. Upstream supports using a + {file}`/var/lib/ethercalc`. Upstream supports using a redis server for storage and recommends the redis backend for intensive use; however, the Nix module doesn't currently support redis. @@ -28,19 +28,19 @@ in { default = pkgs.ethercalc; defaultText = literalExpression "pkgs.ethercalc"; type = types.package; - description = "Ethercalc package to use."; + description = lib.mdDoc "Ethercalc package to use."; }; host = mkOption { type = types.str; default = "0.0.0.0"; - description = "Address to listen on (use 0.0.0.0 to allow access from any address)."; + description = lib.mdDoc "Address to listen on (use 0.0.0.0 to allow access from any address)."; }; port = mkOption { type = types.port; default = 8000; - description = "Port to bind to."; + description = lib.mdDoc "Port to bind to."; }; }; }; diff --git a/nixos/modules/services/web-apps/galene.nix b/nixos/modules/services/web-apps/galene.nix index 38c3392014f5c..2fef43753d799 100644 --- a/nixos/modules/services/web-apps/galene.nix +++ b/nixos/modules/services/web-apps/galene.nix @@ -17,7 +17,7 @@ in stateDir = mkOption { default = defaultstateDir; type = types.str; - description = '' + description = lib.mdDoc '' The directory where Galene stores its internal state. If left as the default value this directory will automatically be created before the Galene server starts, otherwise the sysadmin is responsible for ensuring the directory @@ -28,19 +28,19 @@ in user = mkOption { type = types.str; default = "galene"; - description = "User account under which galene runs."; + description = lib.mdDoc "User account under which galene runs."; }; group = mkOption { type = types.str; default = "galene"; - description = "Group under which galene runs."; + description = lib.mdDoc "Group under which galene runs."; }; insecure = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether Galene should listen in http or in https. If left as the default value (false), Galene needs to be fed a private key and a certificate. ''; @@ -50,7 +50,7 @@ in type = types.nullOr types.str; default = null; example = "/path/to/your/cert.pem"; - description = '' + description = lib.mdDoc '' Path to the server's certificate. The file is copied at runtime to Galene's data directory where it needs to reside. ''; @@ -60,7 +60,7 @@ in type = types.nullOr types.str; default = null; example = "/path/to/your/key.pem"; - description = '' + description = lib.mdDoc '' Path to the server's private key. The file is copied at runtime to Galene's data directory where it needs to reside. ''; @@ -69,13 +69,13 @@ in httpAddress = mkOption { type = types.str; default = ""; - description = "HTTP listen address for galene."; + description = lib.mdDoc "HTTP listen address for galene."; }; httpPort = mkOption { type = types.port; default = 8443; - description = "HTTP listen port."; + description = lib.mdDoc "HTTP listen port."; }; staticDir = mkOption { @@ -83,7 +83,7 @@ in default = "${cfg.package.static}/static"; defaultText = literalExpression ''"''${package.static}/static"''; example = "/var/lib/galene/static"; - description = "Web server directory."; + description = lib.mdDoc "Web server directory."; }; recordingsDir = mkOption { @@ -91,7 +91,7 @@ in default = defaultrecordingsDir; defaultText = literalExpression ''"''${config.${opt.stateDir}}/recordings"''; example = "/var/lib/galene/recordings"; - description = "Recordings directory."; + description = lib.mdDoc "Recordings directory."; }; dataDir = mkOption { @@ -99,7 +99,7 @@ in default = defaultdataDir; defaultText = literalExpression ''"''${config.${opt.stateDir}}/data"''; example = "/var/lib/galene/data"; - description = "Data directory."; + description = lib.mdDoc "Data directory."; }; groupsDir = mkOption { @@ -107,14 +107,14 @@ in default = defaultgroupsDir; defaultText = literalExpression ''"''${config.${opt.stateDir}}/groups"''; example = "/var/lib/galene/groups"; - description = "Web server directory."; + description = lib.mdDoc "Web server directory."; }; package = mkOption { default = pkgs.galene; defaultText = literalExpression "pkgs.galene"; type = types.package; - description = '' + description = lib.mdDoc '' Package for running Galene. ''; }; diff --git a/nixos/modules/services/web-apps/gerrit.nix b/nixos/modules/services/web-apps/gerrit.nix index 6bfc67368dd5f..5b36204ff0539 100644 --- a/nixos/modules/services/web-apps/gerrit.nix +++ b/nixos/modules/services/web-apps/gerrit.nix @@ -65,14 +65,14 @@ in type = types.package; default = pkgs.gerrit; defaultText = literalExpression "pkgs.gerrit"; - description = "Gerrit package to use"; + description = lib.mdDoc "Gerrit package to use"; }; jvmPackage = mkOption { type = types.package; default = pkgs.jre_headless; defaultText = literalExpression "pkgs.jre_headless"; - description = "Java Runtime Environment package to use"; + description = lib.mdDoc "Java Runtime Environment package to use"; }; jvmOpts = mkOption { @@ -81,13 +81,13 @@ in "-Dflogger.backend_factory=com.google.common.flogger.backend.log4j.Log4jBackendFactory#getInstance" "-Dflogger.logging_context=com.google.gerrit.server.logging.LoggingContext#getInstance" ]; - description = "A list of JVM options to start gerrit with."; + description = lib.mdDoc "A list of JVM options to start gerrit with."; }; jvmHeapLimit = mkOption { type = types.str; default = "1024m"; - description = '' + description = lib.mdDoc '' How much memory to allocate to the JVM heap ''; }; @@ -95,8 +95,8 @@ in listenAddress = mkOption { type = types.str; default = "[::]:8080"; - description = '' - <literal>hostname:port</literal> to listen for HTTP traffic. + description = lib.mdDoc '' + `hostname:port` to listen for HTTP traffic. This is bound using the systemd socket activation. ''; @@ -105,25 +105,25 @@ in settings = mkOption { type = gitIniType; default = {}; - description = '' + description = lib.mdDoc '' Gerrit configuration. This will be generated to the - <literal>etc/gerrit.config</literal> file. + `etc/gerrit.config` file. ''; }; replicationSettings = mkOption { type = gitIniType; default = {}; - description = '' + description = lib.mdDoc '' Replication configuration. This will be generated to the - <literal>etc/replication.config</literal> file. + `etc/replication.config` file. ''; }; plugins = mkOption { type = types.listOf types.package; default = []; - description = '' + description = lib.mdDoc '' List of plugins to add to Gerrit. Each derivation is a jar file itself where the name of the derivation is the name of plugin. ''; @@ -132,19 +132,19 @@ in builtinPlugins = mkOption { type = types.listOf (types.enum cfg.package.passthru.plugins); default = []; - description = '' + description = lib.mdDoc '' List of builtins plugins to install. Those are shipped in the - <literal>gerrit.war</literal> file. + `gerrit.war` file. ''; }; serverId = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Set a UUID that uniquely identifies the server. This can be generated with - <literal>nix-shell -p util-linux --run uuidgen</literal>. + `nix-shell -p util-linux --run uuidgen`. ''; }; }; diff --git a/nixos/modules/services/web-apps/gotify-server.nix b/nixos/modules/services/web-apps/gotify-server.nix index 03e01f46a9441..9e278b41ad152 100644 --- a/nixos/modules/services/web-apps/gotify-server.nix +++ b/nixos/modules/services/web-apps/gotify-server.nix @@ -11,7 +11,7 @@ in { port = mkOption { type = types.port; - description = '' + description = lib.mdDoc '' Port the server listens to. ''; }; @@ -19,8 +19,8 @@ in { stateDirectoryName = mkOption { type = types.str; default = "gotify-server"; - description = '' - The name of the directory below <filename>/var/lib</filename> where + description = lib.mdDoc '' + The name of the directory below {file}`/var/lib` where gotify stores its runtime data. ''; }; diff --git a/nixos/modules/services/web-apps/grocy.nix b/nixos/modules/services/web-apps/grocy.nix index a77fddf1f2f45..173dd63ddaa1f 100644 --- a/nixos/modules/services/web-apps/grocy.nix +++ b/nixos/modules/services/web-apps/grocy.nix @@ -10,7 +10,7 @@ in { hostName = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' FQDN for the grocy instance. ''; }; @@ -18,7 +18,7 @@ in { nginx.enableSSL = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether or not to enable SSL (with ACME and let's encrypt) for the grocy vhost. ''; @@ -39,7 +39,7 @@ in { "pm.max_requests" = "500"; }; - description = '' + description = lib.mdDoc '' Options for grocy's PHPFPM pool. ''; }; @@ -47,8 +47,8 @@ in { dataDir = mkOption { type = types.str; default = "/var/lib/grocy"; - description = '' - Home directory of the <literal>grocy</literal> user which contains + description = lib.mdDoc '' + Home directory of the `grocy` user which contains the application's state. ''; }; @@ -58,7 +58,7 @@ in { type = types.str; default = "USD"; example = "EUR"; - description = '' + description = lib.mdDoc '' ISO 4217 code for the currency to display. ''; }; @@ -66,7 +66,7 @@ in { culture = mkOption { type = types.enum [ "de" "en" "da" "en_GB" "es" "fr" "hu" "it" "nl" "no" "pl" "pt_BR" "ru" "sk_SK" "sv_SE" "tr" ]; default = "en"; - description = '' + description = lib.mdDoc '' Display language of the frontend. ''; }; @@ -75,14 +75,14 @@ in { showWeekNumber = mkOption { default = true; type = types.bool; - description = '' + description = lib.mdDoc '' Show the number of the weeks in the calendar views. ''; }; firstDayOfWeek = mkOption { default = null; type = types.nullOr (types.enum (range 0 6)); - description = '' + description = lib.mdDoc '' Which day of the week (0=Sunday, 1=Monday etc.) should be the first day. ''; diff --git a/nixos/modules/services/web-apps/healthchecks.nix b/nixos/modules/services/web-apps/healthchecks.nix index be025e7dd5518..e58cc6f202bef 100644 --- a/nixos/modules/services/web-apps/healthchecks.nix +++ b/nixos/modules/services/web-apps/healthchecks.nix @@ -37,7 +37,7 @@ in default = pkgs.healthchecks; defaultText = literalExpression "pkgs.healthchecks"; type = types.package; - description = "healthchecks package to use."; + description = lib.mdDoc "healthchecks package to use."; }; user = mkOption { @@ -71,13 +71,13 @@ in listenAddress = mkOption { type = types.str; default = "localhost"; - description = "Address the server will listen on."; + description = lib.mdDoc "Address the server will listen on."; }; port = mkOption { type = types.port; default = 8000; - description = "Port the server will listen on."; + description = lib.mdDoc "Port the server will listen on."; }; dataDir = mkOption { @@ -114,26 +114,26 @@ in ALLOWED_HOSTS = lib.mkOption { type = types.listOf types.str; default = [ "*" ]; - description = "The host/domain names that this site can serve."; + description = lib.mdDoc "The host/domain names that this site can serve."; apply = lib.concatStringsSep ","; }; SECRET_KEY_FILE = mkOption { type = types.path; - description = "Path to a file containing the secret key."; + description = lib.mdDoc "Path to a file containing the secret key."; }; DEBUG = mkOption { type = types.bool; default = false; - description = "Enable debug mode."; + description = lib.mdDoc "Enable debug mode."; apply = boolToPython; }; REGISTRATION_OPEN = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' A boolean that controls whether site visitors can create new accounts. Set it to false if you are setting up a private Healthchecks instance, but it needs to be publicly accessible (so, for example, your cloud diff --git a/nixos/modules/services/web-apps/hedgedoc.nix b/nixos/modules/services/web-apps/hedgedoc.nix index f0e4f753eb70d..b8d83984ca7dc 100644 --- a/nixos/modules/services/web-apps/hedgedoc.nix +++ b/nixos/modules/services/web-apps/hedgedoc.nix @@ -37,7 +37,7 @@ in groups = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Groups to which the service user should be added. ''; }; @@ -45,7 +45,7 @@ in workDir = mkOption { type = types.path; default = "/var/lib/${name}"; - description = '' + description = lib.mdDoc '' Working directory for the HedgeDoc service. ''; }; @@ -56,7 +56,7 @@ in type = types.nullOr types.str; default = null; example = "hedgedoc.org"; - description = '' + description = lib.mdDoc '' Domain name for the HedgeDoc instance. ''; }; @@ -64,14 +64,14 @@ in type = types.nullOr types.str; default = null; example = "/url/path/to/hedgedoc"; - description = '' + description = lib.mdDoc '' Path under which HedgeDoc is accessible. ''; }; host = mkOption { type = types.str; default = "localhost"; - description = '' + description = lib.mdDoc '' Address to listen on. ''; }; @@ -79,7 +79,7 @@ in type = types.int; default = 3000; example = 80; - description = '' + description = lib.mdDoc '' Port to listen on. ''; }; @@ -87,7 +87,7 @@ in type = types.nullOr types.str; default = null; example = "/run/hedgedoc.sock"; - description = '' + description = lib.mdDoc '' Specify where a UNIX domain socket should be placed. ''; }; @@ -95,44 +95,44 @@ in type = types.listOf types.str; default = []; example = [ "localhost" "hedgedoc.org" ]; - description = '' + description = lib.mdDoc '' List of domains to whitelist. ''; }; useSSL = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable to use SSL server. This will also enable - <option>protocolUseSSL</option>. + {option}`protocolUseSSL`. ''; }; hsts = { enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable HSTS if HTTPS is also enabled. ''; }; maxAgeSeconds = mkOption { type = types.int; default = 31536000; - description = '' + description = lib.mdDoc '' Max duration for clients to keep the HSTS status. ''; }; includeSubdomains = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to include subdomains in HSTS. ''; }; preload = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to allow preloading of the site's HSTS status. ''; }; @@ -159,31 +159,31 @@ in protocolUseSSL = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable to use TLS for resource paths. - This only applies when <option>domain</option> is set. + This only applies when {option}`domain` is set. ''; }; urlAddPort = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable to add the port to callback URLs. - This only applies when <option>domain</option> is set + This only applies when {option}`domain` is set and only for ports other than 80 and 443. ''; }; useCDN = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to use CDN resources or not. ''; }; allowAnonymous = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to allow anonymous usage. ''; }; @@ -198,21 +198,21 @@ in allowFreeURL = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to allow note creation by accessing a nonexistent note URL. ''; }; requireFreeURLAuthentication = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to require authentication for FreeURL mode style note creation. ''; }; defaultPermission = mkOption { type = types.enum [ "freely" "editable" "limited" "locked" "private" ]; default = "editable"; - description = '' + description = lib.mdDoc '' Default permissions for notes. This only applies for signed-in users. ''; @@ -223,12 +223,12 @@ in example = '' postgres://user:pass@host:5432/dbname ''; - description = '' + description = lib.mdDoc '' Specify which database to use. HedgeDoc supports mysql, postgres, sqlite and mssql. - See <link xlink:href="https://sequelize.readthedocs.io/en/v3/"> - https://sequelize.readthedocs.io/en/v3/</link> for more information. - Note: This option overrides <option>db</option>. + See [ + https://sequelize.readthedocs.io/en/v3/](https://sequelize.readthedocs.io/en/v3/) for more information. + Note: This option overrides {option}`db`. ''; }; db = mkOption { @@ -240,52 +240,52 @@ in storage = "/var/lib/${name}/db.${name}.sqlite"; } ''; - description = '' + description = lib.mdDoc '' Specify the configuration for sequelize. HedgeDoc supports mysql, postgres, sqlite and mssql. - See <link xlink:href="https://sequelize.readthedocs.io/en/v3/"> - https://sequelize.readthedocs.io/en/v3/</link> for more information. - Note: This option overrides <option>db</option>. + See [ + https://sequelize.readthedocs.io/en/v3/](https://sequelize.readthedocs.io/en/v3/) for more information. + Note: This option overrides {option}`db`. ''; }; sslKeyPath= mkOption { type = types.nullOr types.str; default = null; example = "/var/lib/hedgedoc/hedgedoc.key"; - description = '' - Path to the SSL key. Needed when <option>useSSL</option> is enabled. + description = lib.mdDoc '' + Path to the SSL key. Needed when {option}`useSSL` is enabled. ''; }; sslCertPath = mkOption { type = types.nullOr types.str; default = null; example = "/var/lib/hedgedoc/hedgedoc.crt"; - description = '' - Path to the SSL cert. Needed when <option>useSSL</option> is enabled. + description = lib.mdDoc '' + Path to the SSL cert. Needed when {option}`useSSL` is enabled. ''; }; sslCAPath = mkOption { type = types.listOf types.str; default = []; example = [ "/var/lib/hedgedoc/ca.crt" ]; - description = '' - SSL ca chain. Needed when <option>useSSL</option> is enabled. + description = lib.mdDoc '' + SSL ca chain. Needed when {option}`useSSL` is enabled. ''; }; dhParamPath = mkOption { type = types.nullOr types.str; default = null; example = "/var/lib/hedgedoc/dhparam.pem"; - description = '' - Path to the SSL dh params. Needed when <option>useSSL</option> is enabled. + description = lib.mdDoc '' + Path to the SSL dh params. Needed when {option}`useSSL` is enabled. ''; }; tmpPath = mkOption { type = types.str; default = "/tmp"; - description = '' + description = lib.mdDoc '' Path to the temp directory HedgeDoc should use. - Note that <option>serviceConfig.PrivateTmp</option> is enabled for + Note that {option}`serviceConfig.PrivateTmp` is enabled for the HedgeDoc systemd service by default. (Non-canonical paths are relative to HedgeDoc's base directory) ''; @@ -293,7 +293,7 @@ in defaultNotePath = mkOption { type = types.nullOr types.str; default = "./public/default.md"; - description = '' + description = lib.mdDoc '' Path to the default Note file. (Non-canonical paths are relative to HedgeDoc's base directory) ''; @@ -301,7 +301,7 @@ in docsPath = mkOption { type = types.nullOr types.str; default = "./public/docs"; - description = '' + description = lib.mdDoc '' Path to the docs directory. (Non-canonical paths are relative to HedgeDoc's base directory) ''; @@ -309,7 +309,7 @@ in indexPath = mkOption { type = types.nullOr types.str; default = "./public/views/index.ejs"; - description = '' + description = lib.mdDoc '' Path to the index template file. (Non-canonical paths are relative to HedgeDoc's base directory) ''; @@ -317,7 +317,7 @@ in hackmdPath = mkOption { type = types.nullOr types.str; default = "./public/views/hackmd.ejs"; - description = '' + description = lib.mdDoc '' Path to the hackmd template file. (Non-canonical paths are relative to HedgeDoc's base directory) ''; @@ -326,7 +326,7 @@ in type = types.nullOr types.str; default = null; defaultText = literalExpression "./public/views/error.ejs"; - description = '' + description = lib.mdDoc '' Path to the error template file. (Non-canonical paths are relative to HedgeDoc's base directory) ''; @@ -335,7 +335,7 @@ in type = types.nullOr types.str; default = null; defaultText = literalExpression "./public/views/pretty.ejs"; - description = '' + description = lib.mdDoc '' Path to the pretty template file. (Non-canonical paths are relative to HedgeDoc's base directory) ''; @@ -344,7 +344,7 @@ in type = types.nullOr types.str; default = null; defaultText = literalExpression "./public/views/slide.hbs"; - description = '' + description = lib.mdDoc '' Path to the slide template file. (Non-canonical paths are relative to HedgeDoc's base directory) ''; @@ -353,21 +353,21 @@ in type = types.str; default = "${cfg.workDir}/uploads"; defaultText = literalExpression "/var/lib/${name}/uploads"; - description = '' + description = lib.mdDoc '' Path under which uploaded files are saved. ''; }; sessionName = mkOption { type = types.str; default = "connect.sid"; - description = '' + description = lib.mdDoc '' Specify the name of the session cookie. ''; }; sessionSecret = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Specify the secret used to sign the session cookie. If unset, one will be generated on startup. ''; @@ -375,56 +375,56 @@ in sessionLife = mkOption { type = types.int; default = 1209600000; - description = '' + description = lib.mdDoc '' Session life time in milliseconds. ''; }; heartbeatInterval = mkOption { type = types.int; default = 5000; - description = '' + description = lib.mdDoc '' Specify the socket.io heartbeat interval. ''; }; heartbeatTimeout = mkOption { type = types.int; default = 10000; - description = '' + description = lib.mdDoc '' Specify the socket.io heartbeat timeout. ''; }; documentMaxLength = mkOption { type = types.int; default = 100000; - description = '' + description = lib.mdDoc '' Specify the maximum document length. ''; }; email = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable email sign-in. ''; }; allowEmailRegister = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable email registration. ''; }; allowGravatar = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to use gravatar as profile picture source. ''; }; imageUploadType = mkOption { type = types.enum [ "imgur" "s3" "minio" "filesystem" ]; default = "filesystem"; - description = '' + description = lib.mdDoc '' Specify where to upload images. ''; }; @@ -433,85 +433,85 @@ in options = { accessKey = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Minio access key. ''; }; secretKey = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Minio secret key. ''; }; endPoint = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Minio endpoint. ''; }; port = mkOption { type = types.int; default = 9000; - description = '' + description = lib.mdDoc '' Minio listen port. ''; }; secure = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to use HTTPS for Minio. ''; }; }; }); default = null; - description = "Configure the minio third-party integration."; + description = lib.mdDoc "Configure the minio third-party integration."; }; s3 = mkOption { type = types.nullOr (types.submodule { options = { accessKeyId = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' AWS access key id. ''; }; secretAccessKey = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' AWS access key. ''; }; region = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' AWS S3 region. ''; }; }; }); default = null; - description = "Configure the s3 third-party integration."; + description = lib.mdDoc "Configure the s3 third-party integration."; }; s3bucket = mkOption { type = types.nullOr types.str; default = null; - description = '' - Specify the bucket name for upload types <literal>s3</literal> and <literal>minio</literal>. + description = lib.mdDoc '' + Specify the bucket name for upload types `s3` and `minio`. ''; }; allowPDFExport = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable PDF exports. ''; }; imgur.clientId = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Imgur API client ID. ''; }; @@ -520,13 +520,13 @@ in options = { connectionString = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Azure Blob Storage connection string. ''; }; container = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Azure Blob Storage container name. It will be created if non-existent. ''; @@ -534,162 +534,162 @@ in }; }); default = null; - description = "Configure the azure third-party integration."; + description = lib.mdDoc "Configure the azure third-party integration."; }; oauth2 = mkOption { type = types.nullOr (types.submodule { options = { authorizationURL = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Specify the OAuth authorization URL. ''; }; tokenURL = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Specify the OAuth token URL. ''; }; baseURL = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Specify the OAuth base URL. ''; }; userProfileURL = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Specify the OAuth userprofile URL. ''; }; userProfileUsernameAttr = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Specify the name of the attribute for the username from the claim. ''; }; userProfileDisplayNameAttr = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Specify the name of the attribute for the display name from the claim. ''; }; userProfileEmailAttr = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Specify the name of the attribute for the email from the claim. ''; }; scope = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Specify the OAuth scope. ''; }; providerName = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Specify the name to be displayed for this strategy. ''; }; rolesClaim = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Specify the role claim name. ''; }; accessRole = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Specify role which should be included in the ID token roles claim to grant access ''; }; clientID = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Specify the OAuth client ID. ''; }; clientSecret = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Specify the OAuth client secret. ''; }; }; }); default = null; - description = "Configure the OAuth integration."; + description = lib.mdDoc "Configure the OAuth integration."; }; facebook = mkOption { type = types.nullOr (types.submodule { options = { clientID = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Facebook API client ID. ''; }; clientSecret = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Facebook API client secret. ''; }; }; }); default = null; - description = "Configure the facebook third-party integration"; + description = lib.mdDoc "Configure the facebook third-party integration"; }; twitter = mkOption { type = types.nullOr (types.submodule { options = { consumerKey = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Twitter API consumer key. ''; }; consumerSecret = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Twitter API consumer secret. ''; }; }; }); default = null; - description = "Configure the Twitter third-party integration."; + description = lib.mdDoc "Configure the Twitter third-party integration."; }; github = mkOption { type = types.nullOr (types.submodule { options = { clientID = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' GitHub API client ID. ''; }; clientSecret = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Github API client secret. ''; }; }; }); default = null; - description = "Configure the GitHub third-party integration."; + description = lib.mdDoc "Configure the GitHub third-party integration."; }; gitlab = mkOption { type = types.nullOr (types.submodule { @@ -697,27 +697,27 @@ in baseURL = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' GitLab API authentication endpoint. Only needed for other endpoints than gitlab.com. ''; }; clientID = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' GitLab API client ID. ''; }; clientSecret = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' GitLab API client secret. ''; }; scope = mkOption { type = types.enum [ "api" "read_user" ]; default = "api"; - description = '' + description = lib.mdDoc '' GitLab API requested scope. GitLab snippet import/export requires api scope. ''; @@ -725,79 +725,79 @@ in }; }); default = null; - description = "Configure the GitLab third-party integration."; + description = lib.mdDoc "Configure the GitLab third-party integration."; }; mattermost = mkOption { type = types.nullOr (types.submodule { options = { baseURL = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Mattermost authentication endpoint. ''; }; clientID = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Mattermost API client ID. ''; }; clientSecret = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Mattermost API client secret. ''; }; }; }); default = null; - description = "Configure the Mattermost third-party integration."; + description = lib.mdDoc "Configure the Mattermost third-party integration."; }; dropbox = mkOption { type = types.nullOr (types.submodule { options = { clientID = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Dropbox API client ID. ''; }; clientSecret = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Dropbox API client secret. ''; }; appKey = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Dropbox app key. ''; }; }; }); default = null; - description = "Configure the Dropbox third-party integration."; + description = lib.mdDoc "Configure the Dropbox third-party integration."; }; google = mkOption { type = types.nullOr (types.submodule { options = { clientID = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Google API client ID. ''; }; clientSecret = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Google API client secret. ''; }; }; }); default = null; - description = "Configure the Google third-party integration."; + description = lib.mdDoc "Configure the Google third-party integration."; }; ldap = mkOption { type = types.nullOr (types.submodule { @@ -805,40 +805,40 @@ in providerName = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Optional name to be displayed at login form, indicating the LDAP provider. ''; }; url = mkOption { type = types.str; example = "ldap://localhost"; - description = '' + description = lib.mdDoc '' URL of LDAP server. ''; }; bindDn = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Bind DN for LDAP access. ''; }; bindCredentials = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Bind credentials for LDAP access. ''; }; searchBase = mkOption { type = types.str; example = "o=users,dc=example,dc=com"; - description = '' + description = lib.mdDoc '' LDAP directory to begin search from. ''; }; searchFilter = mkOption { type = types.str; example = "(uid={{username}})"; - description = '' + description = lib.mdDoc '' LDAP filter to search with. ''; }; @@ -846,22 +846,22 @@ in type = types.nullOr (types.listOf types.str); default = null; example = [ "displayName" "mail" ]; - description = '' + description = lib.mdDoc '' LDAP attributes to search with. ''; }; userNameField = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' LDAP field which is used as the username on HedgeDoc. - By default <option>useridField</option> is used. + By default {option}`useridField` is used. ''; }; useridField = mkOption { type = types.str; example = "uid"; - description = '' + description = lib.mdDoc '' LDAP field which is a unique identifier for users on HedgeDoc. ''; }; @@ -869,14 +869,14 @@ in type = types.str; default = "/etc/ssl/certs/ca-certificates.crt"; example = "server-cert.pem,root.pem"; - description = '' + description = lib.mdDoc '' Root CA for LDAP TLS in PEM format. ''; }; }; }); default = null; - description = "Configure the LDAP integration."; + description = lib.mdDoc "Configure the LDAP integration."; }; saml = mkOption { type = types.nullOr (types.submodule { @@ -884,21 +884,21 @@ in idpSsoUrl = mkOption { type = types.str; example = "https://idp.example.com/sso"; - description = '' + description = lib.mdDoc '' IdP authentication endpoint. ''; }; idpCert = mkOption { type = types.path; example = "/path/to/cert.pem"; - description = '' + description = lib.mdDoc '' Path to IdP certificate file in PEM format. ''; }; issuer = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Optional identity of the service provider. This defaults to the server URL. ''; @@ -906,7 +906,7 @@ in identifierFormat = mkOption { type = types.str; default = "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"; - description = '' + description = lib.mdDoc '' Optional name identifier format. ''; }; @@ -914,7 +914,7 @@ in type = types.str; default = ""; example = "memberOf"; - description = '' + description = lib.mdDoc '' Optional attribute name for group list. ''; }; @@ -922,7 +922,7 @@ in type = types.listOf types.str; default = []; example = [ "Temporary-staff" "External-users" ]; - description = '' + description = lib.mdDoc '' Excluded group names. ''; }; @@ -930,7 +930,7 @@ in type = types.listOf types.str; default = []; example = [ "Hedgedoc-Users" ]; - description = '' + description = lib.mdDoc '' Required group names. ''; }; @@ -965,16 +965,16 @@ in }; }); default = null; - description = "Configure the SAML integration."; + description = lib.mdDoc "Configure the SAML integration."; }; }; in lib.mkOption { type = lib.types.submodule { freeformType = settingsFormat.type; inherit options; }; - description = '' + description = lib.mdDoc '' HedgeDoc configuration, see - <link xlink:href="https://docs.hedgedoc.org/configuration/"/> + <https://docs.hedgedoc.org/configuration/> for documentation. ''; }; @@ -1013,7 +1013,7 @@ in type = types.package; default = pkgs.hedgedoc; defaultText = literalExpression "pkgs.hedgedoc"; - description = '' + description = lib.mdDoc '' Package that provides HedgeDoc. ''; }; diff --git a/nixos/modules/services/web-apps/hledger-web.nix b/nixos/modules/services/web-apps/hledger-web.nix index 4f6a34e6d2fe5..4f02a637cdd87 100644 --- a/nixos/modules/services/web-apps/hledger-web.nix +++ b/nixos/modules/services/web-apps/hledger-web.nix @@ -12,7 +12,7 @@ in { host = mkOption { type = types.str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' Address to listen on. ''; }; @@ -21,7 +21,7 @@ in { type = types.port; default = 5000; example = 80; - description = '' + description = lib.mdDoc '' Port to listen on. ''; }; @@ -30,21 +30,21 @@ in { view = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Enable the view capability. ''; }; add = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the add capability. ''; }; manage = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the manage capability. ''; }; @@ -53,7 +53,7 @@ in { stateDir = mkOption { type = types.path; default = "/var/lib/hledger-web"; - description = '' + description = lib.mdDoc '' Path the service has access to. If left as the default value this directory will automatically be created before the hledger-web server starts, otherwise the sysadmin is responsible for ensuring the @@ -64,8 +64,8 @@ in { journalFiles = mkOption { type = types.listOf types.str; default = [ ".hledger.journal" ]; - description = '' - Paths to journal files relative to <option>services.hledger-web.stateDir</option>. + description = lib.mdDoc '' + Paths to journal files relative to {option}`services.hledger-web.stateDir`. ''; }; @@ -73,7 +73,7 @@ in { type = with types; nullOr str; default = null; example = "https://example.org"; - description = '' + description = lib.mdDoc '' Base URL, when sharing over a network. ''; }; @@ -82,7 +82,7 @@ in { type = types.listOf types.str; default = []; example = [ "--forecast" ]; - description = '' + description = lib.mdDoc '' Extra command line arguments to pass to hledger-web. ''; }; diff --git a/nixos/modules/services/web-apps/icingaweb2/icingaweb2.nix b/nixos/modules/services/web-apps/icingaweb2/icingaweb2.nix index b9761061aaaeb..b96baaec76787 100644 --- a/nixos/modules/services/web-apps/icingaweb2/icingaweb2.nix +++ b/nixos/modules/services/web-apps/icingaweb2/icingaweb2.nix @@ -17,7 +17,7 @@ in { pool = mkOption { type = str; default = poolName; - description = '' + description = lib.mdDoc '' Name of existing PHP-FPM pool that is used to run Icingaweb2. If not specified, a pool will automatically created with default values. ''; @@ -26,7 +26,7 @@ in { libraryPaths = mkOption { type = attrsOf package; default = { }; - description = '' + description = lib.mdDoc '' Libraries to add to the Icingaweb2 library path. The name of the attribute is the name of the library, the value is the package to add. @@ -36,7 +36,7 @@ in { virtualHost = mkOption { type = nullOr str; default = "icingaweb2"; - description = '' + description = lib.mdDoc '' Name of the nginx virtualhost to use and setup. If null, no virtualhost is set up. ''; }; @@ -45,7 +45,7 @@ in { type = str; default = "UTC"; example = "Europe/Berlin"; - description = "PHP-compliant timezone specification"; + description = lib.mdDoc "PHP-compliant timezone specification"; }; modules = { @@ -64,7 +64,7 @@ in { "snow" = icingaweb2Modules.theme-snow; } ''; - description = '' + description = lib.mdDoc '' Name-package attrset of Icingaweb 2 modules packages to enable. If you enable modules manually (e.g. via the web ui), they will not be touched. @@ -84,7 +84,7 @@ in { level = "CRITICAL"; }; }; - description = '' + description = lib.mdDoc '' config.ini contents. Will automatically be converted to a .ini file. If you don't set global.module_path, the module will take care of it. @@ -108,7 +108,7 @@ in { dbname = "icingaweb2"; }; }; - description = '' + description = lib.mdDoc '' resources.ini contents. Will automatically be converted to a .ini file. @@ -127,7 +127,7 @@ in { resource = "icingaweb_db"; }; }; - description = '' + description = lib.mdDoc '' authentication.ini contents. Will automatically be converted to a .ini file. @@ -145,7 +145,7 @@ in { resource = "icingaweb_db"; }; }; - description = '' + description = lib.mdDoc '' groups.ini contents. Will automatically be converted to a .ini file. @@ -163,7 +163,7 @@ in { permissions = "*"; }; }; - description = '' + description = lib.mdDoc '' roles.ini contents. Will automatically be converted to a .ini file. diff --git a/nixos/modules/services/web-apps/icingaweb2/module-monitoring.nix b/nixos/modules/services/web-apps/icingaweb2/module-monitoring.nix index e9c1d4ffe5eab..0579c602216d6 100644 --- a/nixos/modules/services/web-apps/icingaweb2/module-monitoring.nix +++ b/nixos/modules/services/web-apps/icingaweb2/module-monitoring.nix @@ -34,32 +34,32 @@ in { enable = mkOption { type = bool; default = true; - description = "Whether to enable the icingaweb2 monitoring module."; + description = lib.mdDoc "Whether to enable the icingaweb2 monitoring module."; }; generalConfig = { mutable = mkOption { type = bool; default = false; - description = "Make config.ini of the monitoring module mutable (e.g. via the web interface)."; + description = lib.mdDoc "Make config.ini of the monitoring module mutable (e.g. via the web interface)."; }; protectedVars = mkOption { type = listOf str; default = [ "*pw*" "*pass*" "community" ]; - description = "List of string patterns for custom variables which should be excluded from user’s view."; + description = lib.mdDoc "List of string patterns for custom variables which should be excluded from user’s view."; }; }; mutableBackends = mkOption { type = bool; default = false; - description = "Make backends.ini of the monitoring module mutable (e.g. via the web interface)."; + description = lib.mdDoc "Make backends.ini of the monitoring module mutable (e.g. via the web interface)."; }; backends = mkOption { default = { icinga = { resource = "icinga_ido"; }; }; - description = "Monitoring backends to define"; + description = lib.mdDoc "Monitoring backends to define"; type = attrsOf (submodule ({ name, ... }: { options = { name = mkOption { @@ -71,13 +71,13 @@ in { resource = mkOption { type = str; - description = "Name of the IDO resource"; + description = lib.mdDoc "Name of the IDO resource"; }; disabled = mkOption { type = bool; default = false; - description = "Disable this backend"; + description = lib.mdDoc "Disable this backend"; }; }; })); @@ -86,12 +86,12 @@ in { mutableTransports = mkOption { type = bool; default = true; - description = "Make commandtransports.ini of the monitoring module mutable (e.g. via the web interface)."; + description = lib.mdDoc "Make commandtransports.ini of the monitoring module mutable (e.g. via the web interface)."; }; transports = mkOption { default = {}; - description = "Command transports to define"; + description = lib.mdDoc "Command transports to define"; type = attrsOf (submodule ({ name, ... }: { options = { name = mkOption { @@ -104,44 +104,44 @@ in { type = mkOption { type = enum [ "api" "local" "remote" ]; default = "api"; - description = "Type of this transport"; + description = lib.mdDoc "Type of this transport"; }; instance = mkOption { type = nullOr str; default = null; - description = "Assign a icinga instance to this transport"; + description = lib.mdDoc "Assign a icinga instance to this transport"; }; path = mkOption { type = str; - description = "Path to the socket for local or remote transports"; + description = lib.mdDoc "Path to the socket for local or remote transports"; }; host = mkOption { type = str; - description = "Host for the api or remote transport"; + description = lib.mdDoc "Host for the api or remote transport"; }; port = mkOption { type = nullOr str; default = null; - description = "Port to connect to for the api or remote transport"; + description = lib.mdDoc "Port to connect to for the api or remote transport"; }; username = mkOption { type = str; - description = "Username for the api or remote transport"; + description = lib.mdDoc "Username for the api or remote transport"; }; password = mkOption { type = str; - description = "Password for the api transport"; + description = lib.mdDoc "Password for the api transport"; }; resource = mkOption { type = str; - description = "SSH identity resource for the remote transport"; + description = lib.mdDoc "SSH identity resource for the remote transport"; }; }; })); diff --git a/nixos/modules/services/web-apps/ihatemoney/default.nix b/nixos/modules/services/web-apps/ihatemoney/default.nix index ad314c885ba8d..c771f0afa2315 100644 --- a/nixos/modules/services/web-apps/ihatemoney/default.nix +++ b/nixos/modules/services/web-apps/ihatemoney/default.nix @@ -51,42 +51,42 @@ in backend = mkOption { type = types.enum [ "sqlite" "postgresql" ]; default = "sqlite"; - description = '' + description = lib.mdDoc '' The database engine to use for ihatemoney. - If <literal>postgresql</literal> is selected, then a database called - <literal>${db}</literal> will be created. If you disable this option, + If `postgresql` is selected, then a database called + `${db}` will be created. If you disable this option, it will however not be removed. ''; }; adminHashedPassword = mkOption { type = types.nullOr types.str; default = null; - description = "The hashed password of the administrator. To obtain it, run <literal>ihatemoney generate_password_hash</literal>"; + description = lib.mdDoc "The hashed password of the administrator. To obtain it, run `ihatemoney generate_password_hash`"; }; uwsgiConfig = mkOption { type = types.attrs; example = { http = ":8000"; }; - description = "Additionnal configuration of the UWSGI vassal running ihatemoney. It should notably specify on which interfaces and ports the vassal should listen."; + description = lib.mdDoc "Additionnal configuration of the UWSGI vassal running ihatemoney. It should notably specify on which interfaces and ports the vassal should listen."; }; defaultSender = { name = mkOption { type = types.str; default = "Budget manager"; - description = "The display name of the sender of ihatemoney emails"; + description = lib.mdDoc "The display name of the sender of ihatemoney emails"; }; email = mkOption { type = types.str; default = "ihatemoney@${config.networking.hostName}"; defaultText = literalExpression ''"ihatemoney@''${config.networking.hostName}"''; - description = "The email of the sender of ihatemoney emails"; + description = lib.mdDoc "The email of the sender of ihatemoney emails"; }; }; secureCookie = mkOption { type = types.bool; default = true; - description = "Use secure cookies. Disable this when ihatemoney is served via http instead of https"; + description = lib.mdDoc "Use secure cookies. Disable this when ihatemoney is served via http instead of https"; }; enableDemoProject = mkEnableOption "access to the demo project in ihatemoney"; enablePublicProjectCreation = mkEnableOption "permission to create projects in ihatemoney by anyone"; @@ -95,12 +95,12 @@ in legalLink = mkOption { type = types.nullOr types.str; default = null; - description = "The URL to a page explaining legal statements about your service, eg. GDPR-related information."; + description = lib.mdDoc "The URL to a page explaining legal statements about your service, eg. GDPR-related information."; }; extraConfig = mkOption { type = types.str; default = ""; - description = "Extra configuration appended to ihatemoney's configuration file. It is a python file, so pay attention to indentation."; + description = lib.mdDoc "Extra configuration appended to ihatemoney's configuration file. It is a python file, so pay attention to indentation."; }; }; config = mkIf cfg.enable { diff --git a/nixos/modules/services/web-apps/invidious.nix b/nixos/modules/services/web-apps/invidious.nix index 10b30bf1fd1d7..0b9d9b03c6aea 100644 --- a/nixos/modules/services/web-apps/invidious.nix +++ b/nixos/modules/services/web-apps/invidious.nix @@ -152,27 +152,27 @@ in type = types.package; default = pkgs.invidious; defaultText = "pkgs.invidious"; - description = "The Invidious package to use."; + description = lib.mdDoc "The Invidious package to use."; }; settings = lib.mkOption { type = settingsFormat.type; default = { }; - description = '' + description = lib.mdDoc '' The settings Invidious should use. - See <link xlink:href="https://github.com/iv-org/invidious/blob/master/config/config.example.yml">config.example.yml</link> for a list of all possible options. + See [config.example.yml](https://github.com/iv-org/invidious/blob/master/config/config.example.yml) for a list of all possible options. ''; }; extraSettingsFile = lib.mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' A file including Invidious settings. - It gets merged with the setttings specified in <option>services.invidious.settings</option> - and can be used to store secrets like <literal>hmac_key</literal> outside of the nix store. + It gets merged with the setttings specified in {option}`services.invidious.settings` + and can be used to store secrets like `hmac_key` outside of the nix store. ''; }; @@ -182,7 +182,7 @@ in domain = lib.mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The FQDN Invidious is reachable on. This is used to configure nginx and for building absolute URLs. @@ -193,12 +193,12 @@ in type = types.port; # Default from https://docs.invidious.io/Configuration.md default = 3000; - description = '' + description = lib.mdDoc '' The port Invidious should listen on. To allow access from outside, - you can use either <option>services.invidious.nginx</option> - or add <literal>config.services.invidious.port</literal> to <option>networking.firewall.allowedTCPPorts</option>. + you can use either {option}`services.invidious.nginx` + or add `config.services.invidious.port` to {option}`networking.firewall.allowedTCPPorts`. ''; }; @@ -206,7 +206,7 @@ in createLocally = lib.mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to create a local database with PostgreSQL. ''; }; @@ -214,10 +214,10 @@ in host = lib.mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The database host Invidious should use. - If <literal>null</literal>, the local unix socket is used. Otherwise + If `null`, the local unix socket is used. Otherwise TCP is used. ''; }; @@ -226,7 +226,7 @@ in type = types.port; default = options.services.postgresql.port.default; defaultText = lib.literalExpression "options.services.postgresql.port.default"; - description = '' + description = lib.mdDoc '' The port of the database Invidious should use. Defaults to the the default postgresql port. @@ -237,7 +237,7 @@ in type = types.nullOr types.str; apply = lib.mapNullable toString; default = null; - description = '' + description = lib.mdDoc '' Path to file containing the database password. ''; }; diff --git a/nixos/modules/services/web-apps/invoiceplane.nix b/nixos/modules/services/web-apps/invoiceplane.nix index 527e248f65b0b..2a936027bd47b 100644 --- a/nixos/modules/services/web-apps/invoiceplane.nix +++ b/nixos/modules/services/web-apps/invoiceplane.nix @@ -72,7 +72,7 @@ let stateDir = mkOption { type = types.path; default = "/var/lib/invoiceplane/${name}"; - description = '' + description = lib.mdDoc '' This directory is used for uploads of attachements and cache. The directory passed here is automatically created and permissions adjusted as required. @@ -83,41 +83,41 @@ let host = mkOption { type = types.str; default = "localhost"; - description = "Database host address."; + description = lib.mdDoc "Database host address."; }; port = mkOption { type = types.port; default = 3306; - description = "Database host port."; + description = lib.mdDoc "Database host port."; }; name = mkOption { type = types.str; default = "invoiceplane"; - description = "Database name."; + description = lib.mdDoc "Database name."; }; user = mkOption { type = types.str; default = "invoiceplane"; - description = "Database user."; + description = lib.mdDoc "Database user."; }; passwordFile = mkOption { type = types.nullOr types.path; default = null; example = "/run/keys/invoiceplane-dbpassword"; - description = '' + description = lib.mdDoc '' A file containing the password corresponding to - <option>database.user</option>. + {option}`database.user`. ''; }; createLocally = mkOption { type = types.bool; default = true; - description = "Create the database and database user locally."; + description = lib.mdDoc "Create the database and database user locally."; }; }; @@ -160,8 +160,8 @@ let "pm.max_spare_servers" = 4; "pm.max_requests" = 500; }; - description = '' - Options for the InvoicePlane PHP pool. See the documentation on <literal>php-fpm.conf</literal> + description = lib.mdDoc '' + Options for the InvoicePlane PHP pool. See the documentation on `php-fpm.conf` for details on configuration directives. ''; }; @@ -174,9 +174,9 @@ let DISABLE_SETUP=true IP_URL=https://invoice.example.com ''; - description = '' + description = lib.mdDoc '' InvoicePlane configuration. Refer to - <link xlink:href="https://github.com/InvoicePlane/InvoicePlane/blob/master/ipconfig.php.example"/> + <https://github.com/InvoicePlane/InvoicePlane/blob/master/ipconfig.php.example> for details on supported values. ''; }; @@ -194,20 +194,20 @@ in options.sites = mkOption { type = types.attrsOf (types.submodule siteOpts); default = {}; - description = "Specification of one or more WordPress sites to serve"; + description = lib.mdDoc "Specification of one or more WordPress sites to serve"; }; options.webserver = mkOption { type = types.enum [ "caddy" ]; default = "caddy"; - description = '' + description = lib.mdDoc '' Which webserver to use for virtual host management. Currently only caddy is supported. ''; }; }; default = {}; - description = "InvoicePlane configuration."; + description = lib.mdDoc "InvoicePlane configuration."; }; }; diff --git a/nixos/modules/services/web-apps/jitsi-meet.nix b/nixos/modules/services/web-apps/jitsi-meet.nix index 8ad92706b0647..b38a510bb87e1 100644 --- a/nixos/modules/services/web-apps/jitsi-meet.nix +++ b/nixos/modules/services/web-apps/jitsi-meet.nix @@ -51,7 +51,7 @@ in hostName = mkOption { type = str; example = "meet.example.org"; - description = '' + description = lib.mdDoc '' FQDN of the Jitsi Meet instance. ''; }; @@ -65,10 +65,10 @@ in defaultLang = "fi"; } ''; - description = '' - Client-side web application settings that override the defaults in <filename>config.js</filename>. + description = lib.mdDoc '' + Client-side web application settings that override the defaults in {file}`config.js`. - See <link xlink:href="https://github.com/jitsi/jitsi-meet/blob/master/config.js" /> for default + See <https://github.com/jitsi/jitsi-meet/blob/master/config.js> for default configuration with comments. ''; }; @@ -76,8 +76,8 @@ in extraConfig = mkOption { type = lines; default = ""; - description = '' - Text to append to <filename>config.js</filename> web application config file. + description = lib.mdDoc '' + Text to append to {file}`config.js` web application config file. Can be used to insert JavaScript logic to determine user's region in cascading bridges setup. ''; @@ -92,10 +92,10 @@ in SHOW_WATERMARK_FOR_GUESTS = false; } ''; - description = '' - Client-side web-app interface settings that override the defaults in <filename>interface_config.js</filename>. + description = lib.mdDoc '' + Client-side web-app interface settings that override the defaults in {file}`interface_config.js`. - See <link xlink:href="https://github.com/jitsi/jitsi-meet/blob/master/interface_config.js" /> for + See <https://github.com/jitsi/jitsi-meet/blob/master/interface_config.js> for default configuration with comments. ''; }; @@ -104,10 +104,10 @@ in enable = mkOption { type = bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable Jitsi Videobridge instance and configure it to connect to Prosody. - Additional configuration is possible with <option>services.jitsi-videobridge</option>. + Additional configuration is possible with {option}`services.jitsi-videobridge`. ''; }; @@ -115,10 +115,10 @@ in type = nullOr str; default = null; example = "/run/keys/videobridge"; - description = '' + description = lib.mdDoc '' File containing password to the Prosody account for videobridge. - If <literal>null</literal>, a file with password will be generated automatically. Setting + If `null`, a file with password will be generated automatically. Setting this option is useful if you plan to connect additional videobridges to the XMPP server. ''; }; @@ -127,35 +127,35 @@ in jicofo.enable = mkOption { type = bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable JiCoFo instance and configure it to connect to Prosody. - Additional configuration is possible with <option>services.jicofo</option>. + Additional configuration is possible with {option}`services.jicofo`. ''; }; jibri.enable = mkOption { type = bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable a Jibri instance and configure it to connect to Prosody. - Additional configuration is possible with <option>services.jibri</option>, and - <option>services.jibri.finalizeScript</option> is especially useful. + Additional configuration is possible with {option}`services.jibri`, and + {option}`services.jibri.finalizeScript` is especially useful. ''; }; nginx.enable = mkOption { type = bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable nginx virtual host that will serve the javascript application and act as a proxy for the XMPP server. Further nginx configuration can be done by adapting - <option>services.nginx.virtualHosts.<hostName></option>. + {option}`services.nginx.virtualHosts.<hostName>`. When this is enabled, ACME will be used to retrieve a TLS certificate by default. To disable - this, set the <option>services.nginx.virtualHosts.<hostName>.enableACME</option> to - <literal>false</literal> and if appropriate do the same for - <option>services.nginx.virtualHosts.<hostName>.forceSSL</option>. + this, set the {option}`services.nginx.virtualHosts.<hostName>.enableACME` to + `false` and if appropriate do the same for + {option}`services.nginx.virtualHosts.<hostName>.forceSSL`. ''; }; @@ -164,7 +164,7 @@ in prosody.enable = mkOption { type = bool; default = true; - description = '' + description = lib.mdDoc '' Whether to configure Prosody to relay XMPP messages between Jitsi Meet components. Turn this off if you want to configure it manually. ''; diff --git a/nixos/modules/services/web-apps/keycloak.nix b/nixos/modules/services/web-apps/keycloak.nix index a1855e1c1a791..de76babbaedd9 100644 --- a/nixos/modules/services/web-apps/keycloak.nix +++ b/nixos/modules/services/web-apps/keycloak.nix @@ -98,7 +98,7 @@ in type = bool; default = false; example = true; - description = '' + description = lib.mdDoc '' Whether to enable the Keycloak identity and access management server. ''; @@ -109,7 +109,7 @@ in default = null; example = "/run/keys/ssl_cert"; apply = assertStringPath "sslCertificate"; - description = '' + description = lib.mdDoc '' The path to a PEM formatted certificate to use for TLS/SSL connections. ''; @@ -120,7 +120,7 @@ in default = null; example = "/run/keys/ssl_key"; apply = assertStringPath "sslCertificateKey"; - description = '' + description = lib.mdDoc '' The path to a PEM formatted private key to use for TLS/SSL connections. ''; @@ -129,10 +129,10 @@ in plugins = lib.mkOption { type = lib.types.listOf lib.types.path; default = [ ]; - description = '' + description = lib.mdDoc '' Keycloak plugin jar, ear files or derivations containing them. Packaged plugins are available through - <literal>pkgs.keycloak.plugins</literal>. + `pkgs.keycloak.plugins`. ''; }; @@ -141,7 +141,7 @@ in type = enum [ "mysql" "mariadb" "postgresql" ]; default = "postgresql"; example = "mariadb"; - description = '' + description = lib.mdDoc '' The type of database Keycloak should connect to. ''; }; @@ -149,7 +149,7 @@ in host = mkOption { type = str; default = "localhost"; - description = '' + description = lib.mdDoc '' Hostname of the database to connect to. ''; }; @@ -166,7 +166,7 @@ in type = port; default = dbPorts.${cfg.database.type}; defaultText = literalDocBook "default port of selected database"; - description = '' + description = lib.mdDoc '' Port of the database to connect to. ''; }; @@ -175,7 +175,7 @@ in type = bool; default = cfg.database.host != "localhost"; defaultText = literalExpression ''config.${opt.database.host} != "localhost"''; - description = '' + description = lib.mdDoc '' Whether the database connection should be secured by SSL / TLS. ''; @@ -184,13 +184,13 @@ in caCert = mkOption { type = nullOr path; default = null; - description = '' + description = lib.mdDoc '' The SSL / TLS CA certificate that verifies the identity of the database server. Required when PostgreSQL is used and SSL is turned on. - For MySQL, if left at <literal>null</literal>, the default + For MySQL, if left at `null`, the default Java keystore is used, which should suffice if the server certificate is issued by an official CA. ''; @@ -199,7 +199,7 @@ in createLocally = mkOption { type = bool; default = true; - description = '' + description = lib.mdDoc '' Whether a database should be automatically created on the local host. Set this to false if you plan on provisioning a local database yourself. This has no effect if @@ -241,7 +241,7 @@ in type = path; example = "/run/keys/db_password"; apply = assertStringPath "passwordFile"; - description = '' + description = lib.mdDoc '' The path to a file containing the database password. ''; }; @@ -251,7 +251,7 @@ in type = package; default = pkgs.keycloak; defaultText = literalExpression "pkgs.keycloak"; - description = '' + description = lib.mdDoc '' Keycloak package to use. ''; }; @@ -259,8 +259,8 @@ in initialAdminPassword = mkOption { type = str; default = "changeme"; - description = '' - Initial password set for the <literal>admin</literal> + description = lib.mdDoc '' + Initial password set for the `admin` user. The password is not stored safely and should be changed immediately in the admin panel. ''; @@ -269,13 +269,13 @@ in themes = mkOption { type = attrsOf package; default = { }; - description = '' + description = lib.mdDoc '' Additional theme packages for Keycloak. Each theme is linked into subdirectory with a corresponding attribute name. Theme packages consist of several subdirectories which provide - different theme types: for example, <literal>account</literal>, - <literal>login</literal> etc. After adding a theme to this option you + different theme types: for example, `account`, + `login` etc. After adding a theme to this option you can select it by its name in Keycloak administration console. ''; }; @@ -289,7 +289,7 @@ in type = str; default = "0.0.0.0"; example = "127.0.0.1"; - description = '' + description = lib.mdDoc '' On which address Keycloak should accept new connections. ''; }; @@ -298,7 +298,7 @@ in type = port; default = 80; example = 8080; - description = '' + description = lib.mdDoc '' On which port Keycloak should listen for new HTTP connections. ''; }; @@ -307,7 +307,7 @@ in type = port; default = 443; example = 8443; - description = '' + description = lib.mdDoc '' On which port Keycloak should listen for new HTTPS connections. ''; }; @@ -341,11 +341,11 @@ in hostname = mkOption { type = str; example = "keycloak.example.com"; - description = '' + description = lib.mdDoc '' The hostname part of the public URL used as base for all frontend requests. - See <link xlink:href="https://www.keycloak.org/server/hostname" /> + See <https://www.keycloak.org/server/hostname> for more information about hostname configuration. ''; }; @@ -354,14 +354,14 @@ in type = bool; default = false; example = true; - description = '' + description = lib.mdDoc '' Whether Keycloak should force all requests to go through the frontend URL. By default, Keycloak allows backend requests to instead use its local hostname or IP address and may also advertise it to clients through its OpenID Connect Discovery endpoint. - See <link xlink:href="https://www.keycloak.org/server/hostname" /> + See <https://www.keycloak.org/server/hostname> for more information about hostname configuration. ''; }; diff --git a/nixos/modules/services/web-apps/lemmy.nix b/nixos/modules/services/web-apps/lemmy.nix index 15e616c5d5ec1..3e726149e93d3 100644 --- a/nixos/modules/services/web-apps/lemmy.nix +++ b/nixos/modules/services/web-apps/lemmy.nix @@ -16,14 +16,14 @@ in jwtSecretPath = mkOption { type = types.path; - description = "Path to read the jwt secret from."; + description = lib.mdDoc "Path to read the jwt secret from."; }; ui = { port = mkOption { type = types.port; default = 1234; - description = "Port where lemmy-ui should listen for incoming requests."; + description = lib.mdDoc "Port where lemmy-ui should listen for incoming requests."; }; }; @@ -31,7 +31,7 @@ in settings = mkOption { default = { }; - description = "Lemmy configuration"; + description = lib.mdDoc "Lemmy configuration"; type = types.submodule { freeformType = settingsFormat.type; @@ -39,13 +39,13 @@ in options.hostname = mkOption { type = types.str; default = null; - description = "The domain name of your instance (eg 'lemmy.ml')."; + description = lib.mdDoc "The domain name of your instance (eg 'lemmy.ml')."; }; options.port = mkOption { type = types.port; default = 8536; - description = "Port where lemmy should listen for incoming requests."; + description = lib.mdDoc "Port where lemmy should listen for incoming requests."; }; options.federation = { @@ -56,12 +56,12 @@ in enabled = mkOption { type = types.bool; default = true; - description = "Enable Captcha."; + description = lib.mdDoc "Enable Captcha."; }; difficulty = mkOption { type = types.enum [ "easy" "medium" "hard" ]; default = "medium"; - description = "The difficultly of the captcha to solve."; + description = lib.mdDoc "The difficultly of the captcha to solve."; }; }; diff --git a/nixos/modules/services/web-apps/mastodon.nix b/nixos/modules/services/web-apps/mastodon.nix index 03adaadff93d0..f3f0fb7cb5342 100644 --- a/nixos/modules/services/web-apps/mastodon.nix +++ b/nixos/modules/services/web-apps/mastodon.nix @@ -148,7 +148,7 @@ in { }; group = lib.mkOption { - description = '' + description = lib.mdDoc '' Group under which mastodon runs. ''; type = lib.types.str; @@ -156,12 +156,12 @@ in { }; streamingPort = lib.mkOption { - description = "TCP port used by the mastodon-streaming service."; + description = lib.mdDoc "TCP port used by the mastodon-streaming service."; type = lib.types.port; default = 55000; }; streamingProcesses = lib.mkOption { - description = '' + description = lib.mdDoc '' Processes used by the mastodon-streaming service. Defaults to the number of CPU cores minus one. ''; @@ -170,28 +170,28 @@ in { }; webPort = lib.mkOption { - description = "TCP port used by the mastodon-web service."; + description = lib.mdDoc "TCP port used by the mastodon-web service."; type = lib.types.port; default = 55001; }; webProcesses = lib.mkOption { - description = "Processes used by the mastodon-web service."; + description = lib.mdDoc "Processes used by the mastodon-web service."; type = lib.types.int; default = 2; }; webThreads = lib.mkOption { - description = "Threads per process used by the mastodon-web service."; + description = lib.mdDoc "Threads per process used by the mastodon-web service."; type = lib.types.int; default = 5; }; sidekiqPort = lib.mkOption { - description = "TCP port used by the mastodon-sidekiq service."; + description = lib.mdDoc "TCP port used by the mastodon-sidekiq service."; type = lib.types.port; default = 55002; }; sidekiqThreads = lib.mkOption { - description = "Worker threads used by the mastodon-sidekiq service."; + description = lib.mdDoc "Worker threads used by the mastodon-sidekiq service."; type = lib.types.int; default = 25; }; @@ -212,7 +212,7 @@ in { }; localDomain = lib.mkOption { - description = "The domain serving your Mastodon instance."; + description = lib.mdDoc "The domain serving your Mastodon instance."; example = "social.example.org"; type = lib.types.str; }; @@ -259,7 +259,7 @@ in { }; trustedProxy = lib.mkOption { - description = '' + description = lib.mdDoc '' You need to set it to the IP from which your reverse proxy sends requests to Mastodon's web process, otherwise Mastodon will record the reverse proxy's own IP as the IP of all requests, which would be bad because IP addresses are used for important rate limits and security functions. @@ -269,7 +269,7 @@ in { }; enableUnixSocket = lib.mkOption { - description = '' + description = lib.mdDoc '' Instead of binding to an IP address like 127.0.0.1, you may bind to a Unix socket. This variable is process-specific, e.g. you need different values for every process, and it works for both web (Puma) processes and streaming API (Node.js) processes. @@ -280,19 +280,19 @@ in { redis = { createLocally = lib.mkOption { - description = "Configure local Redis server for Mastodon."; + description = lib.mdDoc "Configure local Redis server for Mastodon."; type = lib.types.bool; default = true; }; host = lib.mkOption { - description = "Redis host."; + description = lib.mdDoc "Redis host."; type = lib.types.str; default = "127.0.0.1"; }; port = lib.mkOption { - description = "Redis port."; + description = lib.mdDoc "Redis port."; type = lib.types.port; default = 31637; }; @@ -300,7 +300,7 @@ in { database = { createLocally = lib.mkOption { - description = "Configure local PostgreSQL database server for Mastodon."; + description = lib.mdDoc "Configure local PostgreSQL database server for Mastodon."; type = lib.types.bool; default = true; }; @@ -309,75 +309,75 @@ in { type = lib.types.str; default = "/run/postgresql"; example = "192.168.23.42"; - description = "Database host address or unix socket."; + description = lib.mdDoc "Database host address or unix socket."; }; port = lib.mkOption { type = lib.types.int; default = 5432; - description = "Database host port."; + description = lib.mdDoc "Database host port."; }; name = lib.mkOption { type = lib.types.str; default = "mastodon"; - description = "Database name."; + description = lib.mdDoc "Database name."; }; user = lib.mkOption { type = lib.types.str; default = "mastodon"; - description = "Database user."; + description = lib.mdDoc "Database user."; }; passwordFile = lib.mkOption { type = lib.types.nullOr lib.types.path; default = "/var/lib/mastodon/secrets/db-password"; example = "/run/keys/mastodon-db-password"; - description = '' + description = lib.mdDoc '' A file containing the password corresponding to - <option>database.user</option>. + {option}`database.user`. ''; }; }; smtp = { createLocally = lib.mkOption { - description = "Configure local Postfix SMTP server for Mastodon."; + description = lib.mdDoc "Configure local Postfix SMTP server for Mastodon."; type = lib.types.bool; default = true; }; authenticate = lib.mkOption { - description = "Authenticate with the SMTP server using username and password."; + description = lib.mdDoc "Authenticate with the SMTP server using username and password."; type = lib.types.bool; default = false; }; host = lib.mkOption { - description = "SMTP host used when sending emails to users."; + description = lib.mdDoc "SMTP host used when sending emails to users."; type = lib.types.str; default = "127.0.0.1"; }; port = lib.mkOption { - description = "SMTP port used when sending emails to users."; + description = lib.mdDoc "SMTP port used when sending emails to users."; type = lib.types.port; default = 25; }; fromAddress = lib.mkOption { - description = ''"From" address used when sending Emails to users.''; + description = lib.mdDoc ''"From" address used when sending Emails to users.''; type = lib.types.str; }; user = lib.mkOption { - description = "SMTP login name."; + description = lib.mdDoc "SMTP login name."; type = lib.types.str; }; passwordFile = lib.mkOption { - description = '' + description = lib.mdDoc '' Path to file containing the SMTP password. ''; default = "/var/lib/mastodon/secrets/smtp-password"; @@ -388,7 +388,7 @@ in { elasticsearch = { host = lib.mkOption { - description = '' + description = lib.mdDoc '' Elasticsearch host. If it is not null, Elasticsearch full text search will be enabled. ''; @@ -397,7 +397,7 @@ in { }; port = lib.mkOption { - description = "Elasticsearch port."; + description = lib.mdDoc "Elasticsearch port."; type = lib.types.port; default = 9200; }; @@ -407,13 +407,13 @@ in { type = lib.types.package; default = pkgs.mastodon; defaultText = lib.literalExpression "pkgs.mastodon"; - description = "Mastodon package to use."; + description = lib.mdDoc "Mastodon package to use."; }; extraConfig = lib.mkOption { type = lib.types.attrs; default = {}; - description = '' + description = lib.mdDoc '' Extra environment variables to pass to all mastodon services. ''; }; @@ -421,7 +421,7 @@ in { automaticMigrations = lib.mkOption { type = lib.types.bool; default = true; - description = '' + description = lib.mdDoc '' Do automatic database migrations. ''; }; diff --git a/nixos/modules/services/web-apps/mattermost.nix b/nixos/modules/services/web-apps/mattermost.nix index 2901f307dc5ac..6e9e2abcaa8ca 100644 --- a/nixos/modules/services/web-apps/mattermost.nix +++ b/nixos/modules/services/web-apps/mattermost.nix @@ -107,19 +107,19 @@ in type = types.package; default = pkgs.mattermost; defaultText = "pkgs.mattermost"; - description = "Mattermost derivation to use."; + description = lib.mdDoc "Mattermost derivation to use."; }; statePath = mkOption { type = types.str; default = "/var/lib/mattermost"; - description = "Mattermost working directory"; + description = lib.mdDoc "Mattermost working directory"; }; siteUrl = mkOption { type = types.str; example = "https://chat.example.com"; - description = '' + description = lib.mdDoc '' URL this Mattermost instance is reachable under, without trailing slash. ''; }; @@ -127,14 +127,14 @@ in siteName = mkOption { type = types.str; default = "Mattermost"; - description = "Name of this Mattermost site."; + description = lib.mdDoc "Name of this Mattermost site."; }; listenAddress = mkOption { type = types.str; default = ":8065"; example = "[::1]:8065"; - description = '' + description = lib.mdDoc '' Address and port this Mattermost instance listens to. ''; }; @@ -142,7 +142,7 @@ in mutableConfig = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether the Mattermost config.json is writeable by Mattermost. Most of the settings can be edited in the system console of @@ -159,7 +159,7 @@ in preferNixConfig = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If both mutableConfig and this option are set, the Nix configuration will take precedence over any settings configured in the server console. @@ -169,7 +169,7 @@ in extraConfig = mkOption { type = types.attrs; default = { }; - description = '' + description = lib.mdDoc '' Addtional configuration options as Nix attribute set in config.json schema. ''; }; @@ -178,7 +178,7 @@ in type = types.listOf (types.oneOf [types.path types.package]); default = []; example = "[ ./com.github.moussetc.mattermost.plugin.giphy-2.0.0.tar.gz ]"; - description = '' + description = lib.mdDoc '' Plugins to add to the configuration. Overrides any installed if non-null. This is a list of paths to .tar.gz files or derivations evaluating to .tar.gz files. @@ -188,7 +188,7 @@ in localDatabaseCreate = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Create a local PostgreSQL database for Mattermost automatically. ''; }; @@ -196,7 +196,7 @@ in localDatabaseName = mkOption { type = types.str; default = "mattermost"; - description = '' + description = lib.mdDoc '' Local Mattermost database name. ''; }; @@ -204,7 +204,7 @@ in localDatabaseUser = mkOption { type = types.str; default = "mattermost"; - description = '' + description = lib.mdDoc '' Local Mattermost database username. ''; }; @@ -212,7 +212,7 @@ in localDatabasePassword = mkOption { type = types.str; default = "mmpgsecret"; - description = '' + description = lib.mdDoc '' Password for local Mattermost database user. ''; }; @@ -220,7 +220,7 @@ in user = mkOption { type = types.str; default = "mattermost"; - description = '' + description = lib.mdDoc '' User which runs the Mattermost service. ''; }; @@ -228,7 +228,7 @@ in group = mkOption { type = types.str; default = "mattermost"; - description = '' + description = lib.mdDoc '' Group which runs the Mattermost service. ''; }; @@ -239,13 +239,13 @@ in type = types.package; default = pkgs.matterircd; defaultText = "pkgs.matterircd"; - description = "matterircd derivation to use."; + description = lib.mdDoc "matterircd derivation to use."; }; parameters = mkOption { type = types.listOf types.str; default = [ ]; example = [ "-mmserver chat.example.com" "-bind [::]:6667" ]; - description = '' + description = lib.mdDoc '' Set commandline parameters to pass to matterircd. See https://github.com/42wim/matterircd#usage for more information. ''; diff --git a/nixos/modules/services/web-apps/miniflux.nix b/nixos/modules/services/web-apps/miniflux.nix index 641c9be85d8cb..55e3664bee682 100644 --- a/nixos/modules/services/web-apps/miniflux.nix +++ b/nixos/modules/services/web-apps/miniflux.nix @@ -29,9 +29,9 @@ in LISTEN_ADDR = "localhost:8080"; } ''; - description = '' + description = lib.mdDoc '' Configuration for Miniflux, refer to - <link xlink:href="https://miniflux.app/docs/configuration.html"/> + <https://miniflux.app/docs/configuration.html> for documentation on the supported values. Correct configuration for the database is already provided. @@ -41,7 +41,7 @@ in adminCredentialsFile = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' File containing the ADMIN_USERNAME and ADMIN_PASSWORD (length >= 6) in the format of an EnvironmentFile=, as described by systemd.exec(5). diff --git a/nixos/modules/services/web-apps/netbox.nix b/nixos/modules/services/web-apps/netbox.nix index a7d8bede74b4b..2826e57f2c776 100644 --- a/nixos/modules/services/web-apps/netbox.nix +++ b/nixos/modules/services/web-apps/netbox.nix @@ -59,18 +59,18 @@ in { enable = mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable Netbox. - This module requires a reverse proxy that serves <literal>/static</literal> separately. - See this <link xlink:href="https://github.com/netbox-community/netbox/blob/develop/contrib/nginx.conf/">example</link> on how to configure this. + This module requires a reverse proxy that serves `/static` separately. + See this [example](https://github.com/netbox-community/netbox/blob/develop/contrib/nginx.conf/) on how to configure this. ''; }; listenAddress = mkOption { type = types.str; default = "[::1]"; - description = '' + description = lib.mdDoc '' Address the server will listen on. ''; }; @@ -78,7 +78,7 @@ in { port = mkOption { type = types.port; default = 8001; - description = '' + description = lib.mdDoc '' Port the server will listen on. ''; }; @@ -89,7 +89,7 @@ in { defaultText = literalExpression '' python3Packages: with python3Packages; []; ''; - description = '' + description = lib.mdDoc '' List of plugin packages to install. ''; }; @@ -97,14 +97,14 @@ in { dataDir = mkOption { type = types.str; default = "/var/lib/netbox"; - description = '' + description = lib.mdDoc '' Storage path of netbox. ''; }; secretKeyFile = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' Path to a file containing the secret key. ''; }; @@ -112,28 +112,28 @@ in { extraConfig = mkOption { type = types.lines; default = ""; - description = '' - Additional lines of configuration appended to the <literal>configuration.py</literal>. - See the <link xlink:href="https://netbox.readthedocs.io/en/stable/configuration/optional-settings/">documentation</link> for more possible options. + description = lib.mdDoc '' + Additional lines of configuration appended to the `configuration.py`. + See the [documentation](https://netbox.readthedocs.io/en/stable/configuration/optional-settings/) for more possible options. ''; }; enableLdap = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable LDAP-Authentication for Netbox. - This requires a configuration file being pass through <literal>ldapConfigPath</literal>. + This requires a configuration file being pass through `ldapConfigPath`. ''; }; ldapConfigPath = mkOption { type = types.path; default = ""; - description = '' - Path to the Configuration-File for LDAP-Authentification, will be loaded as <literal>ldap_config.py</literal>. - See the <link xlink:href="https://netbox.readthedocs.io/en/stable/installation/6-ldap/#configuration">documentation</link> for possible options. + description = lib.mdDoc '' + Path to the Configuration-File for LDAP-Authentification, will be loaded as `ldap_config.py`. + See the [documentation](https://netbox.readthedocs.io/en/stable/installation/6-ldap/#configuration) for possible options. ''; }; }; diff --git a/nixos/modules/services/web-apps/nextcloud.nix b/nixos/modules/services/web-apps/nextcloud.nix index f8082d7544c12..618ad85b8605c 100644 --- a/nixos/modules/services/web-apps/nextcloud.nix +++ b/nixos/modules/services/web-apps/nextcloud.nix @@ -82,12 +82,12 @@ in { enable = mkEnableOption "nextcloud"; hostName = mkOption { type = types.str; - description = "FQDN for the nextcloud instance."; + description = lib.mdDoc "FQDN for the nextcloud instance."; }; home = mkOption { type = types.str; default = "/var/lib/nextcloud"; - description = "Storage path of nextcloud."; + description = lib.mdDoc "Storage path of nextcloud."; }; datadir = mkOption { type = types.str; @@ -146,23 +146,23 @@ in { logLevel = mkOption { type = types.ints.between 0 4; default = 2; - description = "Log level value between 0 (DEBUG) and 4 (FATAL)."; + description = lib.mdDoc "Log level value between 0 (DEBUG) and 4 (FATAL)."; }; https = mkOption { type = types.bool; default = false; - description = "Use https for generated links."; + description = lib.mdDoc "Use https for generated links."; }; package = mkOption { type = types.package; - description = "Which package to use for the Nextcloud instance."; + description = lib.mdDoc "Which package to use for the Nextcloud instance."; relatedPackages = [ "nextcloud23" "nextcloud24" ]; }; phpPackage = mkOption { type = types.package; relatedPackages = [ "php80" "php81" ]; defaultText = "pkgs.php"; - description = '' + description = lib.mdDoc '' PHP package to use for Nextcloud. ''; }; @@ -170,7 +170,7 @@ in { maxUploadSize = mkOption { default = "512M"; type = types.str; - description = '' + description = lib.mdDoc '' Defines the upload limit for files. This changes the relevant options in php.ini and nginx if enabled. ''; @@ -179,7 +179,7 @@ in { skeletonDirectory = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' The directory where the skeleton files are located. These files will be copied to the data directory of new users. Leave empty to not copy any skeleton files. @@ -189,7 +189,7 @@ in { webfinger = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable this option if you plan on using the webfinger plugin. The appropriate nginx rewrite rules will be added to your configuration. ''; @@ -199,7 +199,7 @@ in { type = with types; functionTo (listOf package); default = all: []; defaultText = literalExpression "all: []"; - description = '' + description = lib.mdDoc '' Additional PHP extensions to use for nextcloud. By default, only extensions necessary for a vanilla nextcloud installation are enabled, but you may choose from the list of available extensions and add further ones. @@ -226,7 +226,7 @@ in { "openssl.cafile" = "/etc/ssl/certs/ca-certificates.crt"; catch_workers_output = "yes"; }; - description = '' + description = lib.mdDoc '' Options for PHP's php.ini file for nextcloud. ''; }; @@ -241,16 +241,16 @@ in { "pm.max_spare_servers" = "4"; "pm.max_requests" = "500"; }; - description = '' - Options for nextcloud's PHP pool. See the documentation on <literal>php-fpm.conf</literal> for details on configuration directives. + description = lib.mdDoc '' + Options for nextcloud's PHP pool. See the documentation on `php-fpm.conf` for details on configuration directives. ''; }; poolConfig = mkOption { type = types.nullOr types.lines; default = null; - description = '' - Options for nextcloud's PHP pool. See the documentation on <literal>php-fpm.conf</literal> for details on configuration directives. + description = lib.mdDoc '' + Options for nextcloud's PHP pool. See the documentation on `php-fpm.conf` for details on configuration directives. ''; }; @@ -259,7 +259,7 @@ in { createLocally = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Create the database and database user locally. Only available for mysql database. Note that this option will use the latest version of MariaDB which @@ -275,72 +275,72 @@ in { dbtype = mkOption { type = types.enum [ "sqlite" "pgsql" "mysql" ]; default = "sqlite"; - description = "Database type."; + description = lib.mdDoc "Database type."; }; dbname = mkOption { type = types.nullOr types.str; default = "nextcloud"; - description = "Database name."; + description = lib.mdDoc "Database name."; }; dbuser = mkOption { type = types.nullOr types.str; default = "nextcloud"; - description = "Database user."; + description = lib.mdDoc "Database user."; }; dbpassFile = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The full path to a file that contains the database password. ''; }; dbhost = mkOption { type = types.nullOr types.str; default = "localhost"; - description = '' + description = lib.mdDoc '' Database host. Note: for using Unix authentication with PostgreSQL, this should be - set to <literal>/run/postgresql</literal>. + set to `/run/postgresql`. ''; }; dbport = mkOption { type = with types; nullOr (either int str); default = null; - description = "Database port."; + description = lib.mdDoc "Database port."; }; dbtableprefix = mkOption { type = types.nullOr types.str; default = null; - description = "Table prefix in Nextcloud database."; + description = lib.mdDoc "Table prefix in Nextcloud database."; }; adminuser = mkOption { type = types.str; default = "root"; - description = "Admin username."; + description = lib.mdDoc "Admin username."; }; adminpassFile = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The full path to a file that contains the admin's password. Must be - readable by user <literal>nextcloud</literal>. + readable by user `nextcloud`. ''; }; extraTrustedDomains = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Trusted domains, from which the nextcloud installation will be acessible. You don't need to add - <literal>services.nextcloud.hostname</literal> here. + `services.nextcloud.hostname` here. ''; }; trustedProxies = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Trusted proxies, to provide if the nextcloud installation is being proxied to secure against e.g. spoofing. ''; @@ -351,10 +351,10 @@ in { default = null; example = "https"; - description = '' + description = lib.mdDoc '' Force Nextcloud to always use HTTPS i.e. for link generation. Nextcloud uses the currently used protocol by default, but when behind a reverse-proxy, - it may use <literal>http</literal> for everything although Nextcloud + it may use `http` for everything although Nextcloud may be served via HTTPS. ''; }; @@ -391,50 +391,50 @@ in { bucket = mkOption { type = types.str; example = "nextcloud"; - description = '' + description = lib.mdDoc '' The name of the S3 bucket. ''; }; autocreate = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Create the objectstore if it does not exist. ''; }; key = mkOption { type = types.str; example = "EJ39ITYZEUH5BGWDRUFY"; - description = '' + description = lib.mdDoc '' The access key for the S3 bucket. ''; }; secretFile = mkOption { type = types.str; example = "/var/nextcloud-objectstore-s3-secret"; - description = '' + description = lib.mdDoc '' The full path to a file that contains the access secret. Must be - readable by user <literal>nextcloud</literal>. + readable by user `nextcloud`. ''; }; hostname = mkOption { type = types.nullOr types.str; default = null; example = "example.com"; - description = '' + description = lib.mdDoc '' Required for some non-Amazon implementations. ''; }; port = mkOption { type = types.nullOr types.port; default = null; - description = '' + description = lib.mdDoc '' Required for some non-Amazon implementations. ''; }; useSsl = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Use SSL for objectstore access. ''; }; @@ -442,20 +442,20 @@ in { type = types.nullOr types.str; default = null; example = "REGION"; - description = '' + description = lib.mdDoc '' Required for some non-Amazon implementations. ''; }; usePathStyle = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Required for some non-Amazon S3 implementations. Ordinarily, requests will be made with - <literal>http://bucket.hostname.domain/</literal>, but with path style + `http://bucket.hostname.domain/`, but with path style enabled requests are made with - <literal>http://hostname.domain/bucket</literal> instead. + `http://hostname.domain/bucket` instead. ''; }; }; @@ -476,14 +476,14 @@ in { apcu = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to load the APCu module into PHP. ''; }; redis = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to load the Redis module into PHP. You still need to enable Redis in your config.php. See https://docs.nextcloud.com/server/14/admin_manual/configuration_server/caching_configuration.html @@ -492,7 +492,7 @@ in { memcached = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to load the Memcached module into PHP. You still need to enable Memcached in your config.php. See https://docs.nextcloud.com/server/14/admin_manual/configuration_server/caching_configuration.html @@ -503,7 +503,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Run regular auto update of all apps installed from the nextcloud app store. ''; }; @@ -552,7 +552,7 @@ in { extraOptions = mkOption { type = jsonFormat.type; default = {}; - description = '' + description = lib.mdDoc '' Extra options which should be appended to nextcloud's config.php file. ''; example = literalExpression '' { @@ -580,7 +580,7 @@ in { recommendedHttpHeaders = mkOption { type = types.bool; default = true; - description = "Enable additional recommended HTTP response headers"; + description = lib.mdDoc "Enable additional recommended HTTP response headers"; }; hstsMaxAge = mkOption { type = types.ints.positive; diff --git a/nixos/modules/services/web-apps/nexus.nix b/nixos/modules/services/web-apps/nexus.nix index dc50a06705f36..cfa137e77d25f 100644 --- a/nixos/modules/services/web-apps/nexus.nix +++ b/nixos/modules/services/web-apps/nexus.nix @@ -17,37 +17,37 @@ in type = types.package; default = pkgs.nexus; defaultText = literalExpression "pkgs.nexus"; - description = "Package which runs Nexus3"; + description = lib.mdDoc "Package which runs Nexus3"; }; user = mkOption { type = types.str; default = "nexus"; - description = "User which runs Nexus3."; + description = lib.mdDoc "User which runs Nexus3."; }; group = mkOption { type = types.str; default = "nexus"; - description = "Group which runs Nexus3."; + description = lib.mdDoc "Group which runs Nexus3."; }; home = mkOption { type = types.str; default = "/var/lib/sonatype-work"; - description = "Home directory of the Nexus3 instance."; + description = lib.mdDoc "Home directory of the Nexus3 instance."; }; listenAddress = mkOption { type = types.str; default = "127.0.0.1"; - description = "Address to listen on."; + description = lib.mdDoc "Address to listen on."; }; listenPort = mkOption { type = types.int; default = 8081; - description = "Port to listen on."; + description = lib.mdDoc "Port to listen on."; }; jvmOpts = mkOption { diff --git a/nixos/modules/services/web-apps/nifi.nix b/nixos/modules/services/web-apps/nifi.nix index 21a631272641a..e3f30c710e0c3 100644 --- a/nixos/modules/services/web-apps/nifi.nix +++ b/nixos/modules/services/web-apps/nifi.nix @@ -33,25 +33,25 @@ in { type = lib.types.package; default = pkgs.nifi; defaultText = lib.literalExpression "pkgs.nifi"; - description = "Apache NiFi package to use."; + description = lib.mdDoc "Apache NiFi package to use."; }; user = lib.mkOption { type = lib.types.str; default = "nifi"; - description = "User account where Apache NiFi runs."; + description = lib.mdDoc "User account where Apache NiFi runs."; }; group = lib.mkOption { type = lib.types.str; default = "nifi"; - description = "Group account where Apache NiFi runs."; + description = lib.mdDoc "Group account where Apache NiFi runs."; }; enableHTTPS = lib.mkOption { type = lib.types.bool; default = true; - description = "Enable HTTPS protocol. Don`t use in production."; + description = lib.mdDoc "Enable HTTPS protocol. Don`t use in production."; }; listenHost = lib.mkOption { @@ -62,7 +62,7 @@ in { then "0.0.0.0" else "127.0.0.1" ''; - description = "Bind to an ip for Apache NiFi web-ui."; + description = lib.mdDoc "Bind to an ip for Apache NiFi web-ui."; }; listenPort = lib.mkOption { @@ -73,7 +73,7 @@ in { then "8443" else "8000" ''; - description = "Bind to a port for Apache NiFi web-ui."; + description = lib.mdDoc "Bind to a port for Apache NiFi web-ui."; }; proxyHost = lib.mkOption { @@ -84,7 +84,7 @@ in { then "0.0.0.0" else null ''; - description = "Allow requests from a specific host."; + description = lib.mdDoc "Allow requests from a specific host."; }; proxyPort = lib.mkOption { @@ -95,34 +95,34 @@ in { then "8443" else null ''; - description = "Allow requests from a specific port."; + description = lib.mdDoc "Allow requests from a specific port."; }; initUser = lib.mkOption { type = lib.types.nullOr lib.types.str; default = null; - description = "Initial user account for Apache NiFi. Username must be at least 4 characters."; + description = lib.mdDoc "Initial user account for Apache NiFi. Username must be at least 4 characters."; }; initPasswordFile = lib.mkOption { type = lib.types.nullOr lib.types.path; default = null; example = "/run/keys/nifi/password-nifi"; - description = "nitial password for Apache NiFi. Password must be at least 12 characters."; + description = lib.mdDoc "nitial password for Apache NiFi. Password must be at least 12 characters."; }; initJavaHeapSize = lib.mkOption { type = lib.types.nullOr lib.types.int; default = null; example = 1024; - description = "Set the initial heap size for the JVM in MB."; + description = lib.mdDoc "Set the initial heap size for the JVM in MB."; }; maxJavaHeapSize = lib.mkOption { type = lib.types.nullOr lib.types.int; default = null; example = 2048; - description = "Set the initial heap size for the JVM in MB."; + description = lib.mdDoc "Set the initial heap size for the JVM in MB."; }; }; }; diff --git a/nixos/modules/services/web-apps/node-red.nix b/nixos/modules/services/web-apps/node-red.nix index 4512907f027b5..1b9d14ecf4ff4 100644 --- a/nixos/modules/services/web-apps/node-red.nix +++ b/nixos/modules/services/web-apps/node-red.nix @@ -23,13 +23,13 @@ in default = pkgs.nodePackages.node-red; defaultText = literalExpression "pkgs.nodePackages.node-red"; type = types.package; - description = "Node-RED package to use."; + description = lib.mdDoc "Node-RED package to use."; }; openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for the server. ''; }; @@ -37,7 +37,7 @@ in withNpmAndGcc = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Give Node-RED access to NPM and GCC at runtime, so 'Nodes' can be downloaded and managed imperatively via the 'Palette Manager'. ''; @@ -58,13 +58,13 @@ in port = mkOption { type = types.port; default = 1880; - description = "Listening port."; + description = lib.mdDoc "Listening port."; }; user = mkOption { type = types.str; default = defaultUser; - description = '' + description = lib.mdDoc '' User under which Node-RED runs.If left as the default value this user will automatically be created on system activation, otherwise the sysadmin is responsible for ensuring the user exists. @@ -74,7 +74,7 @@ in group = mkOption { type = types.str; default = defaultUser; - description = '' + description = lib.mdDoc '' Group under which Node-RED runs.If left as the default value this group will automatically be created on system activation, otherwise the sysadmin is responsible for ensuring the group exists. @@ -84,7 +84,7 @@ in userDir = mkOption { type = types.path; default = "/var/lib/node-red"; - description = '' + description = lib.mdDoc '' The directory to store all user data, such as flow and credential files and all library data. If left as the default value this directory will automatically be created before the node-red service starts, otherwise the sysadmin is responsible for ensuring the directory exists with appropriate ownership @@ -95,13 +95,13 @@ in safe = mkOption { type = types.bool; default = false; - description = "Whether to launch Node-RED in --safe mode."; + description = lib.mdDoc "Whether to launch Node-RED in --safe mode."; }; define = mkOption { type = types.attrs; default = {}; - description = "List of settings.js overrides to pass via -D to Node-RED."; + description = lib.mdDoc "List of settings.js overrides to pass via -D to Node-RED."; example = literalExpression '' { "logging.console.level" = "trace"; diff --git a/nixos/modules/services/web-apps/onlyoffice.nix b/nixos/modules/services/web-apps/onlyoffice.nix index ce6a3e835e3b3..15fc3b03a8349 100644 --- a/nixos/modules/services/web-apps/onlyoffice.nix +++ b/nixos/modules/services/web-apps/onlyoffice.nix @@ -14,13 +14,13 @@ in hostname = mkOption { type = types.str; default = "localhost"; - description = "FQDN for the onlyoffice instance."; + description = lib.mdDoc "FQDN for the onlyoffice instance."; }; jwtSecretFile = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Path to a file that contains the secret to sign web requests using JSON Web Tokens. If left at the default value null signing is disabled. ''; @@ -30,37 +30,37 @@ in type = types.package; default = pkgs.onlyoffice-documentserver; defaultText = "pkgs.onlyoffice-documentserver"; - description = "Which package to use for the OnlyOffice instance."; + description = lib.mdDoc "Which package to use for the OnlyOffice instance."; }; port = mkOption { type = types.port; default = 8000; - description = "Port the OnlyOffice DocumentServer should listens on."; + description = lib.mdDoc "Port the OnlyOffice DocumentServer should listens on."; }; examplePort = mkOption { type = types.port; default = null; - description = "Port the OnlyOffice Example server should listens on."; + description = lib.mdDoc "Port the OnlyOffice Example server should listens on."; }; postgresHost = mkOption { type = types.str; default = "/run/postgresql"; - description = "The Postgresql hostname or socket path OnlyOffice should connect to."; + description = lib.mdDoc "The Postgresql hostname or socket path OnlyOffice should connect to."; }; postgresName = mkOption { type = types.str; default = "onlyoffice"; - description = "The name of databse OnlyOffice should user."; + description = lib.mdDoc "The name of databse OnlyOffice should user."; }; postgresPasswordFile = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Path to a file that contains the password OnlyOffice should use to connect to Postgresql. Unused when using socket authentication. ''; @@ -69,7 +69,7 @@ in postgresUser = mkOption { type = types.str; default = "onlyoffice"; - description = '' + description = lib.mdDoc '' The username OnlyOffice should use to connect to Postgresql. Unused when using socket authentication. ''; @@ -78,7 +78,7 @@ in rabbitmqUrl = mkOption { type = types.str; default = "amqp://guest:guest@localhost:5672"; - description = "The Rabbitmq in amqp URI style OnlyOffice should connect to."; + description = lib.mdDoc "The Rabbitmq in amqp URI style OnlyOffice should connect to."; }; }; diff --git a/nixos/modules/services/web-apps/openwebrx.nix b/nixos/modules/services/web-apps/openwebrx.nix index 8a7972a3fc6ec..c409adbc71068 100644 --- a/nixos/modules/services/web-apps/openwebrx.nix +++ b/nixos/modules/services/web-apps/openwebrx.nix @@ -10,7 +10,7 @@ in type = types.package; default = pkgs.openwebrx; defaultText = literalExpression "pkgs.openwebrx"; - description = "OpenWebRX package to use for the service"; + description = lib.mdDoc "OpenWebRX package to use for the service"; }; }; diff --git a/nixos/modules/services/web-apps/peertube.nix b/nixos/modules/services/web-apps/peertube.nix index e6b6aa273e7fb..2fb05209c5c8e 100644 --- a/nixos/modules/services/web-apps/peertube.nix +++ b/nixos/modules/services/web-apps/peertube.nix @@ -73,51 +73,51 @@ in { user = lib.mkOption { type = lib.types.str; default = "peertube"; - description = "User account under which Peertube runs."; + description = lib.mdDoc "User account under which Peertube runs."; }; group = lib.mkOption { type = lib.types.str; default = "peertube"; - description = "Group under which Peertube runs."; + description = lib.mdDoc "Group under which Peertube runs."; }; localDomain = lib.mkOption { type = lib.types.str; example = "peertube.example.com"; - description = "The domain serving your PeerTube instance."; + description = lib.mdDoc "The domain serving your PeerTube instance."; }; listenHttp = lib.mkOption { type = lib.types.int; default = 9000; - description = "listen port for HTTP server."; + description = lib.mdDoc "listen port for HTTP server."; }; listenWeb = lib.mkOption { type = lib.types.int; default = 9000; - description = "listen port for WEB server."; + description = lib.mdDoc "listen port for WEB server."; }; enableWebHttps = lib.mkOption { type = lib.types.bool; default = false; - description = "Enable or disable HTTPS protocol."; + description = lib.mdDoc "Enable or disable HTTPS protocol."; }; dataDirs = lib.mkOption { type = lib.types.listOf lib.types.path; default = [ ]; example = [ "/opt/peertube/storage" "/var/cache/peertube" ]; - description = "Allow access to custom data locations."; + description = lib.mdDoc "Allow access to custom data locations."; }; serviceEnvironmentFile = lib.mkOption { type = lib.types.nullOr lib.types.path; default = null; example = "/run/keys/peertube/password-init-root"; - description = '' + description = lib.mdDoc '' Set environment variables for the service. Mainly useful for setting the initial root password. For example write to file: PT_INITIAL_ROOT_PASSWORD=changeme @@ -141,14 +141,14 @@ in { }; } ''; - description = "Configuration for peertube."; + description = lib.mdDoc "Configuration for peertube."; }; database = { createLocally = lib.mkOption { type = lib.types.bool; default = false; - description = "Configure local PostgreSQL database server for PeerTube."; + description = lib.mdDoc "Configure local PostgreSQL database server for PeerTube."; }; host = lib.mkOption { @@ -160,32 +160,32 @@ in { else null ''; example = "192.168.15.47"; - description = "Database host address or unix socket."; + description = lib.mdDoc "Database host address or unix socket."; }; port = lib.mkOption { type = lib.types.int; default = 5432; - description = "Database host port."; + description = lib.mdDoc "Database host port."; }; name = lib.mkOption { type = lib.types.str; default = "peertube"; - description = "Database name."; + description = lib.mdDoc "Database name."; }; user = lib.mkOption { type = lib.types.str; default = "peertube"; - description = "Database user."; + description = lib.mdDoc "Database user."; }; passwordFile = lib.mkOption { type = lib.types.nullOr lib.types.path; default = null; example = "/run/keys/peertube/password-posgressql-db"; - description = "Password for PostgreSQL database."; + description = lib.mdDoc "Password for PostgreSQL database."; }; }; @@ -193,7 +193,7 @@ in { createLocally = lib.mkOption { type = lib.types.bool; default = false; - description = "Configure local Redis server for PeerTube."; + description = lib.mdDoc "Configure local Redis server for PeerTube."; }; host = lib.mkOption { @@ -204,7 +204,7 @@ in { then "127.0.0.1" else null ''; - description = "Redis host."; + description = lib.mdDoc "Redis host."; }; port = lib.mkOption { @@ -215,21 +215,21 @@ in { then null else 6379 ''; - description = "Redis port."; + description = lib.mdDoc "Redis port."; }; passwordFile = lib.mkOption { type = lib.types.nullOr lib.types.path; default = null; example = "/run/keys/peertube/password-redis-db"; - description = "Password for redis database."; + description = lib.mdDoc "Password for redis database."; }; enableUnixSocket = lib.mkOption { type = lib.types.bool; default = cfg.redis.createLocally; defaultText = lib.literalExpression "config.${opt.redis.createLocally}"; - description = "Use Unix socket."; + description = lib.mdDoc "Use Unix socket."; }; }; @@ -237,14 +237,14 @@ in { createLocally = lib.mkOption { type = lib.types.bool; default = false; - description = "Configure local Postfix SMTP server for PeerTube."; + description = lib.mdDoc "Configure local Postfix SMTP server for PeerTube."; }; passwordFile = lib.mkOption { type = lib.types.nullOr lib.types.path; default = null; example = "/run/keys/peertube/password-smtp"; - description = "Password for smtp server."; + description = lib.mdDoc "Password for smtp server."; }; }; @@ -252,7 +252,7 @@ in { type = lib.types.package; default = pkgs.peertube; defaultText = lib.literalExpression "pkgs.peertube"; - description = "Peertube package to use."; + description = lib.mdDoc "Peertube package to use."; }; }; diff --git a/nixos/modules/services/web-apps/phylactery.nix b/nixos/modules/services/web-apps/phylactery.nix index f0e97da1f2023..d512b48539b8f 100644 --- a/nixos/modules/services/web-apps/phylactery.nix +++ b/nixos/modules/services/web-apps/phylactery.nix @@ -9,24 +9,24 @@ in { host = mkOption { type = types.str; default = "localhost"; - description = "Listen host for Phylactery"; + description = lib.mdDoc "Listen host for Phylactery"; }; port = mkOption { type = types.port; - description = "Listen port for Phylactery"; + description = lib.mdDoc "Listen port for Phylactery"; }; library = mkOption { type = types.path; - description = "Path to CBZ library"; + description = lib.mdDoc "Path to CBZ library"; }; package = mkOption { type = types.package; default = pkgs.phylactery; defaultText = literalExpression "pkgs.phylactery"; - description = "The Phylactery package to use"; + description = lib.mdDoc "The Phylactery package to use"; }; }; diff --git a/nixos/modules/services/web-apps/pict-rs.nix b/nixos/modules/services/web-apps/pict-rs.nix index e1847fbd5314c..ab5a9ed073561 100644 --- a/nixos/modules/services/web-apps/pict-rs.nix +++ b/nixos/modules/services/web-apps/pict-rs.nix @@ -14,21 +14,21 @@ in dataDir = mkOption { type = types.path; default = "/var/lib/pict-rs"; - description = '' + description = lib.mdDoc '' The directory where to store the uploaded images. ''; }; address = mkOption { type = types.str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' The IPv4 address to deploy the service to. ''; }; port = mkOption { type = types.port; default = 8080; - description = '' + description = lib.mdDoc '' The port which to bind the service to. ''; }; diff --git a/nixos/modules/services/web-apps/plantuml-server.nix b/nixos/modules/services/web-apps/plantuml-server.nix index 9ea37b8a4cad4..acd9292ceb45c 100644 --- a/nixos/modules/services/web-apps/plantuml-server.nix +++ b/nixos/modules/services/web-apps/plantuml-server.nix @@ -17,7 +17,7 @@ in type = types.package; default = pkgs.plantuml-server; defaultText = literalExpression "pkgs.plantuml-server"; - description = "PlantUML server package to use"; + description = lib.mdDoc "PlantUML server package to use"; }; packages = { @@ -25,75 +25,75 @@ in type = types.package; default = pkgs.jdk; defaultText = literalExpression "pkgs.jdk"; - description = "JDK package to use for the server"; + description = lib.mdDoc "JDK package to use for the server"; }; jetty = mkOption { type = types.package; default = pkgs.jetty; defaultText = literalExpression "pkgs.jetty"; - description = "Jetty package to use for the server"; + description = lib.mdDoc "Jetty package to use for the server"; }; }; user = mkOption { type = types.str; default = "plantuml"; - description = "User which runs PlantUML server."; + description = lib.mdDoc "User which runs PlantUML server."; }; group = mkOption { type = types.str; default = "plantuml"; - description = "Group which runs PlantUML server."; + description = lib.mdDoc "Group which runs PlantUML server."; }; home = mkOption { type = types.str; default = "/var/lib/plantuml"; - description = "Home directory of the PlantUML server instance."; + description = lib.mdDoc "Home directory of the PlantUML server instance."; }; listenHost = mkOption { type = types.str; default = "127.0.0.1"; - description = "Host to listen on."; + description = lib.mdDoc "Host to listen on."; }; listenPort = mkOption { type = types.int; default = 8080; - description = "Port to listen on."; + description = lib.mdDoc "Port to listen on."; }; plantumlLimitSize = mkOption { type = types.int; default = 4096; - description = "Limits image width and height."; + description = lib.mdDoc "Limits image width and height."; }; graphvizPackage = mkOption { type = types.package; default = pkgs.graphviz; defaultText = literalExpression "pkgs.graphviz"; - description = "Package containing the dot executable."; + description = lib.mdDoc "Package containing the dot executable."; }; plantumlStats = mkOption { type = types.bool; default = false; - description = "Set it to on to enable statistics report (https://plantuml.com/statistics-report)."; + description = lib.mdDoc "Set it to on to enable statistics report (https://plantuml.com/statistics-report)."; }; httpAuthorization = mkOption { type = types.nullOr types.str; default = null; - description = "When calling the proxy endpoint, the value of HTTP_AUTHORIZATION will be used to set the HTTP Authorization header."; + description = lib.mdDoc "When calling the proxy endpoint, the value of HTTP_AUTHORIZATION will be used to set the HTTP Authorization header."; }; allowPlantumlInclude = mkOption { type = types.bool; default = false; - description = "Enables !include processing which can read files from the server into diagrams. Files are read relative to the current working directory."; + description = lib.mdDoc "Enables !include processing which can read files from the server into diagrams. Files are read relative to the current working directory."; }; }; }; diff --git a/nixos/modules/services/web-apps/plausible.nix b/nixos/modules/services/web-apps/plausible.nix index 5d550ae5ca86a..6f098134c9226 100644 --- a/nixos/modules/services/web-apps/plausible.nix +++ b/nixos/modules/services/web-apps/plausible.nix @@ -11,7 +11,7 @@ in { releaseCookiePath = mkOption { type = with types; either str path; - description = '' + description = lib.mdDoc '' The path to the file with release cookie. (used for remote connection to the running node). ''; }; @@ -20,7 +20,7 @@ in { name = mkOption { default = "admin"; type = types.str; - description = '' + description = lib.mdDoc '' Name of the admin user that plausible will created on initial startup. ''; }; @@ -28,14 +28,14 @@ in { email = mkOption { type = types.str; example = "admin@localhost"; - description = '' + description = lib.mdDoc '' Email-address of the admin-user. ''; }; passwordFile = mkOption { type = types.either types.str types.path; - description = '' + description = lib.mdDoc '' Path to the file which contains the password of the admin user. ''; }; @@ -59,7 +59,7 @@ in { dbname = mkOption { default = "plausible"; type = types.str; - description = '' + description = lib.mdDoc '' Name of the database to use. ''; }; @@ -77,35 +77,35 @@ in { disableRegistration = mkOption { default = true; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to prohibit creating an account in plausible's UI. ''; }; secretKeybaseFile = mkOption { type = types.either types.path types.str; - description = '' - Path to the secret used by the <literal>phoenix</literal>-framework. Instructions + description = lib.mdDoc '' + Path to the secret used by the `phoenix`-framework. Instructions how to generate one are documented in the - <link xlink:href="https://hexdocs.pm/phoenix/Mix.Tasks.Phx.Gen.Secret.html#content"> - framework docs</link>. + [ + framework docs](https://hexdocs.pm/phoenix/Mix.Tasks.Phx.Gen.Secret.html#content). ''; }; port = mkOption { default = 8000; type = types.port; - description = '' + description = lib.mdDoc '' Port where the service should be available. ''; }; baseUrl = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Public URL where plausible is available. - Note that <literal>/path</literal> components are currently ignored: - <link xlink:href="https://github.com/plausible/analytics/issues/1182"> + Note that `/path` components are currently ignored: + [ https://github.com/plausible/analytics/issues/1182 - </link>. + ](https://github.com/plausible/analytics/issues/1182). ''; }; }; @@ -114,8 +114,8 @@ in { email = mkOption { default = "hello@plausible.local"; type = types.str; - description = '' - The email id to use for as <emphasis>from</emphasis> address of all communications + description = lib.mdDoc '' + The email id to use for as *from* address of all communications from Plausible. ''; }; @@ -123,28 +123,28 @@ in { hostAddr = mkOption { default = "localhost"; type = types.str; - description = '' + description = lib.mdDoc '' The host address of your smtp server. ''; }; hostPort = mkOption { default = 25; type = types.port; - description = '' + description = lib.mdDoc '' The port of your smtp server. ''; }; user = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The username/email in case SMTP auth is enabled. ''; }; passwordFile = mkOption { default = null; type = with types; nullOr (either str path); - description = '' + description = lib.mdDoc '' The path to the file with the password in case SMTP auth is enabled. ''; }; @@ -152,7 +152,7 @@ in { retries = mkOption { type = types.ints.unsigned; default = 2; - description = '' + description = lib.mdDoc '' Number of retries to make until mailer gives up. ''; }; diff --git a/nixos/modules/services/web-apps/powerdns-admin.nix b/nixos/modules/services/web-apps/powerdns-admin.nix index 4661ba80c5d68..c2d65f59e4dc5 100644 --- a/nixos/modules/services/web-apps/powerdns-admin.nix +++ b/nixos/modules/services/web-apps/powerdns-admin.nix @@ -27,7 +27,7 @@ in example = literalExpression '' [ "-b" "127.0.0.1:8000" ] ''; - description = '' + description = lib.mdDoc '' Extra arguments passed to powerdns-admin. ''; }; @@ -40,9 +40,9 @@ in PORT = 8000 SQLALCHEMY_DATABASE_URI = 'postgresql://powerdnsadmin@/powerdnsadmin?host=/run/postgresql' ''; - description = '' + description = lib.mdDoc '' Configuration python file. - See <link xlink:href="https://github.com/ngoduykhanh/PowerDNS-Admin/blob/v${pkgs.powerdns-admin.version}/configs/development.py">the example configuration</link> + See [the example configuration](https://github.com/ngoduykhanh/PowerDNS-Admin/blob/v${pkgs.powerdns-admin.version}/configs/development.py) for options. ''; }; @@ -50,7 +50,7 @@ in secretKeyFile = mkOption { type = types.nullOr types.path; example = "/etc/powerdns-admin/secret"; - description = '' + description = lib.mdDoc '' The secret used to create cookies. This needs to be set, otherwise the default is used and everyone can forge valid login cookies. Set this to null to ignore this setting and configure it through another way. @@ -60,7 +60,7 @@ in saltFile = mkOption { type = types.nullOr types.path; example = "/etc/powerdns-admin/salt"; - description = '' + description = lib.mdDoc '' The salt used for serialization. This should be set, otherwise the default is used. Set this to null to ignore this setting and configure it through another way. diff --git a/nixos/modules/services/web-apps/prosody-filer.nix b/nixos/modules/services/web-apps/prosody-filer.nix index a901a95fd5f92..1d40809c420cb 100644 --- a/nixos/modules/services/web-apps/prosody-filer.nix +++ b/nixos/modules/services/web-apps/prosody-filer.nix @@ -14,9 +14,9 @@ in { enable = mkEnableOption "Prosody Filer XMPP upload file server"; settings = mkOption { - description = '' + description = lib.mdDoc '' Configuration for Prosody Filer. - Refer to <link xlink:href="https://github.com/ThomasLeister/prosody-filer#configure-prosody-filer"/> for details on supported values. + Refer to <https://github.com/ThomasLeister/prosody-filer#configure-prosody-filer> for details on supported values. ''; type = settingsFormat.type; diff --git a/nixos/modules/services/web-apps/restya-board.nix b/nixos/modules/services/web-apps/restya-board.nix index 1a8199ab3b37b..ae80a7866a166 100644 --- a/nixos/modules/services/web-apps/restya-board.nix +++ b/nixos/modules/services/web-apps/restya-board.nix @@ -30,7 +30,7 @@ in dataDir = mkOption { type = types.path; default = "/var/lib/restya-board"; - description = '' + description = lib.mdDoc '' Data of the application. ''; }; @@ -38,7 +38,7 @@ in user = mkOption { type = types.str; default = "restya-board"; - description = '' + description = lib.mdDoc '' User account under which the web-application runs. ''; }; @@ -46,7 +46,7 @@ in group = mkOption { type = types.str; default = "nginx"; - description = '' + description = lib.mdDoc '' Group account under which the web-application runs. ''; }; @@ -55,7 +55,7 @@ in serverName = mkOption { type = types.str; default = "restya.board"; - description = '' + description = lib.mdDoc '' Name of the nginx virtualhost to use. ''; }; @@ -63,7 +63,7 @@ in listenHost = mkOption { type = types.str; default = "localhost"; - description = '' + description = lib.mdDoc '' Listen address for the virtualhost to use. ''; }; @@ -71,7 +71,7 @@ in listenPort = mkOption { type = types.int; default = 3000; - description = '' + description = lib.mdDoc '' Listen port for the virtualhost to use. ''; }; @@ -81,7 +81,7 @@ in host = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Host of the database. Leave 'null' to use a local PostgreSQL database. A local PostgreSQL database is initialized automatically. ''; @@ -90,7 +90,7 @@ in port = mkOption { type = types.nullOr types.int; default = 5432; - description = '' + description = lib.mdDoc '' The database's port. ''; }; @@ -98,7 +98,7 @@ in name = mkOption { type = types.str; default = "restya_board"; - description = '' + description = lib.mdDoc '' Name of the database. The database must exist. ''; }; @@ -106,7 +106,7 @@ in user = mkOption { type = types.str; default = "restya_board"; - description = '' + description = lib.mdDoc '' The database user. The user must exist and have access to the specified database. ''; @@ -115,7 +115,7 @@ in passwordFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' The database user's password. 'null' if no password is set. ''; }; @@ -126,7 +126,7 @@ in type = types.nullOr types.str; default = null; example = "localhost"; - description = '' + description = lib.mdDoc '' Hostname to send outgoing mail. Null to use the system MTA. ''; }; @@ -134,7 +134,7 @@ in port = mkOption { type = types.int; default = 25; - description = '' + description = lib.mdDoc '' Port used to connect to SMTP server. ''; }; @@ -142,7 +142,7 @@ in login = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' SMTP authentication login used when sending outgoing mail. ''; }; @@ -150,7 +150,7 @@ in password = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' SMTP authentication password used when sending outgoing mail. ATTENTION: The password is stored world-readable in the nix-store! @@ -161,7 +161,7 @@ in timezone = mkOption { type = types.lines; default = "GMT"; - description = '' + description = lib.mdDoc '' Timezone the web-app runs in. ''; }; diff --git a/nixos/modules/services/web-apps/rss-bridge.nix b/nixos/modules/services/web-apps/rss-bridge.nix index f2b6d9559823b..b1a3907d1964e 100644 --- a/nixos/modules/services/web-apps/rss-bridge.nix +++ b/nixos/modules/services/web-apps/rss-bridge.nix @@ -16,7 +16,7 @@ in user = mkOption { type = types.str; default = "nginx"; - description = '' + description = lib.mdDoc '' User account under which both the service and the web-application run. ''; }; @@ -24,7 +24,7 @@ in group = mkOption { type = types.str; default = "nginx"; - description = '' + description = lib.mdDoc '' Group under which the web-application run. ''; }; @@ -32,7 +32,7 @@ in pool = mkOption { type = types.str; default = poolName; - description = '' + description = lib.mdDoc '' Name of existing phpfpm pool that is used to run web-application. If not specified a pool will be created automatically with default values. @@ -42,16 +42,16 @@ in dataDir = mkOption { type = types.str; default = "/var/lib/rss-bridge"; - description = '' + description = lib.mdDoc '' Location in which cache directory will be created. - You can put <literal>config.ini.php</literal> in here. + You can put `config.ini.php` in here. ''; }; virtualHost = mkOption { type = types.nullOr types.str; default = "rss-bridge"; - description = '' + description = lib.mdDoc '' Name of the nginx virtualhost to use and setup. If null, do not setup any virtualhost. ''; }; diff --git a/nixos/modules/services/web-apps/selfoss.nix b/nixos/modules/services/web-apps/selfoss.nix index 899976ac696c8..016e053c802bd 100644 --- a/nixos/modules/services/web-apps/selfoss.nix +++ b/nixos/modules/services/web-apps/selfoss.nix @@ -35,7 +35,7 @@ in user = mkOption { type = types.str; default = "nginx"; - description = '' + description = lib.mdDoc '' User account under which both the service and the web-application run. ''; }; @@ -43,7 +43,7 @@ in pool = mkOption { type = types.str; default = "${poolName}"; - description = '' + description = lib.mdDoc '' Name of existing phpfpm pool that is used to run web-application. If not specified a pool will be created automatically with default values. @@ -54,7 +54,7 @@ in type = mkOption { type = types.enum ["pgsql" "mysql" "sqlite"]; default = "sqlite"; - description = '' + description = lib.mdDoc '' Database to store feeds. Supported are sqlite, pgsql and mysql. ''; }; @@ -62,7 +62,7 @@ in host = mkOption { type = types.str; default = "localhost"; - description = '' + description = lib.mdDoc '' Host of the database (has no effect if type is "sqlite"). ''; }; @@ -70,7 +70,7 @@ in name = mkOption { type = types.str; default = "tt_rss"; - description = '' + description = lib.mdDoc '' Name of the existing database (has no effect if type is "sqlite"). ''; }; @@ -78,7 +78,7 @@ in user = mkOption { type = types.str; default = "tt_rss"; - description = '' + description = lib.mdDoc '' The database user. The user must exist and has access to the specified database (has no effect if type is "sqlite"). ''; @@ -87,7 +87,7 @@ in password = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The database user's password (has no effect if type is "sqlite"). ''; }; @@ -95,7 +95,7 @@ in port = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' The database's port. If not set, the default ports will be provided (5432 and 3306 for pgsql and mysql respectively) (has no effect if type is "sqlite"). @@ -105,7 +105,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration added to config.ini ''; }; diff --git a/nixos/modules/services/web-apps/shiori.nix b/nixos/modules/services/web-apps/shiori.nix index bb2fc684e83b1..494f8587306f4 100644 --- a/nixos/modules/services/web-apps/shiori.nix +++ b/nixos/modules/services/web-apps/shiori.nix @@ -12,13 +12,13 @@ in { type = types.package; default = pkgs.shiori; defaultText = literalExpression "pkgs.shiori"; - description = "The Shiori package to use."; + description = lib.mdDoc "The Shiori package to use."; }; address = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' The IP address on which Shiori will listen. If empty, listens on all interfaces. ''; @@ -27,7 +27,7 @@ in { port = mkOption { type = types.port; default = 8080; - description = "The port of the Shiori web application"; + description = lib.mdDoc "The port of the Shiori web application"; }; }; }; diff --git a/nixos/modules/services/web-apps/sogo.nix b/nixos/modules/services/web-apps/sogo.nix index 4610bb96cb5e4..a134282de83ad 100644 --- a/nixos/modules/services/web-apps/sogo.nix +++ b/nixos/modules/services/web-apps/sogo.nix @@ -21,31 +21,31 @@ in { enable = mkEnableOption "SOGo groupware"; vhostName = mkOption { - description = "Name of the nginx vhost"; + description = lib.mdDoc "Name of the nginx vhost"; type = str; default = "sogo"; }; timezone = mkOption { - description = "Timezone of your SOGo instance"; + description = lib.mdDoc "Timezone of your SOGo instance"; type = str; example = "America/Montreal"; }; language = mkOption { - description = "Language of SOGo"; + description = lib.mdDoc "Language of SOGo"; type = str; default = "English"; }; ealarmsCredFile = mkOption { - description = "Optional path to a credentials file for email alarms"; + description = lib.mdDoc "Optional path to a credentials file for email alarms"; type = nullOr str; default = null; }; configReplaces = mkOption { - description = '' + description = lib.mdDoc '' Replacement-filepath mapping for sogo.conf. Every key is replaced with the contents of the file specified as value. @@ -60,7 +60,7 @@ in { }; extraConfig = mkOption { - description = "Extra sogo.conf configuration lines"; + description = lib.mdDoc "Extra sogo.conf configuration lines"; type = lines; default = ""; }; diff --git a/nixos/modules/services/web-apps/trilium.nix b/nixos/modules/services/web-apps/trilium.nix index 35383c992fe86..193c7944a64d3 100644 --- a/nixos/modules/services/web-apps/trilium.nix +++ b/nixos/modules/services/web-apps/trilium.nix @@ -28,7 +28,7 @@ in dataDir = mkOption { type = types.str; default = "/var/lib/trilium"; - description = '' + description = lib.mdDoc '' The directory storing the notes database and the configuration. ''; }; @@ -36,7 +36,7 @@ in instanceName = mkOption { type = types.str; default = "Trilium"; - description = '' + description = lib.mdDoc '' Instance name used to distinguish between different instances ''; }; @@ -44,7 +44,7 @@ in noBackup = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Disable periodic database backups. ''; }; @@ -52,7 +52,7 @@ in host = mkOption { type = types.str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' The host address to bind to (defaults to localhost). ''; }; @@ -60,14 +60,14 @@ in port = mkOption { type = types.int; default = 8080; - description = '' + description = lib.mdDoc '' The port number to bind to. ''; }; nginx = mkOption { default = {}; - description = '' + description = lib.mdDoc '' Configuration for nginx reverse proxy. ''; @@ -76,14 +76,14 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Configure the nginx reverse proxy settings. ''; }; hostName = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The hostname use to setup the virtualhost configuration ''; }; diff --git a/nixos/modules/services/web-apps/tt-rss.nix b/nixos/modules/services/web-apps/tt-rss.nix index c441a2a7764e2..f105b0aa3f720 100644 --- a/nixos/modules/services/web-apps/tt-rss.nix +++ b/nixos/modules/services/web-apps/tt-rss.nix @@ -126,7 +126,7 @@ let root = mkOption { type = types.path; default = "/var/lib/tt-rss"; - description = '' + description = lib.mdDoc '' Root of the application. ''; }; @@ -134,7 +134,7 @@ let user = mkOption { type = types.str; default = "tt_rss"; - description = '' + description = lib.mdDoc '' User account under which both the update daemon and the web-application run. ''; }; @@ -142,7 +142,7 @@ let pool = mkOption { type = types.str; default = "${poolName}"; - description = '' + description = lib.mdDoc '' Name of existing phpfpm pool that is used to run web-application. If not specified a pool will be created automatically with default values. @@ -152,7 +152,7 @@ let virtualHost = mkOption { type = types.nullOr types.str; default = "tt-rss"; - description = '' + description = lib.mdDoc '' Name of the nginx virtualhost to use and setup. If null, do not setup any virtualhost. ''; }; @@ -161,7 +161,7 @@ let type = mkOption { type = types.enum ["pgsql" "mysql"]; default = "pgsql"; - description = '' + description = lib.mdDoc '' Database to store feeds. Supported are pgsql and mysql. ''; }; @@ -169,7 +169,7 @@ let host = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Host of the database. Leave null to use Unix domain socket. ''; }; @@ -177,7 +177,7 @@ let name = mkOption { type = types.str; default = "tt_rss"; - description = '' + description = lib.mdDoc '' Name of the existing database. ''; }; @@ -185,7 +185,7 @@ let user = mkOption { type = types.str; default = "tt_rss"; - description = '' + description = lib.mdDoc '' The database user. The user must exist and has access to the specified database. ''; @@ -194,7 +194,7 @@ let password = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The database user's password. ''; }; @@ -202,7 +202,7 @@ let passwordFile = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The database user's password. ''; }; @@ -210,7 +210,7 @@ let port = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' The database's port. If not set, the default ports will be provided (5432 and 3306 for pgsql and mysql respectively). ''; @@ -219,7 +219,7 @@ let createLocally = mkOption { type = types.bool; default = true; - description = "Create the database and database user locally."; + description = lib.mdDoc "Create the database and database user locally."; }; }; @@ -227,7 +227,7 @@ let autoCreate = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Allow authentication modules to auto-create users in tt-rss internal database when authenticated successfully. ''; @@ -236,7 +236,7 @@ let autoLogin = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Automatically login user on remote or other kind of externally supplied authentication, otherwise redirect to login form as normal. If set to true, users won't be able to set application language @@ -249,7 +249,7 @@ let hub = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' URL to a PubSubHubbub-compatible hub server. If defined, "Published articles" generated feed would automatically become PUSH-enabled. ''; @@ -258,7 +258,7 @@ let enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable client PubSubHubbub support in tt-rss. When disabled, tt-rss won't try to subscribe to PUSH feed updates. ''; @@ -269,7 +269,7 @@ let server = mkOption { type = types.str; default = "localhost:9312"; - description = '' + description = lib.mdDoc '' Hostname:port combination for the Sphinx server. ''; }; @@ -277,7 +277,7 @@ let index = mkOption { type = types.listOf types.str; default = ["ttrss" "delta"]; - description = '' + description = lib.mdDoc '' Index names in Sphinx configuration. Example configuration files are available on tt-rss wiki. ''; @@ -288,7 +288,7 @@ let enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Allow users to register themselves. Please be aware that allowing random people to access your tt-rss installation is a security risk and potentially might lead to data loss or server exploit. Disabled @@ -299,7 +299,7 @@ let notifyAddress = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Email address to send new user notifications to. ''; }; @@ -307,7 +307,7 @@ let maxUsers = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' Maximum amount of users which will be allowed to register on this system. 0 - no limit. ''; @@ -319,7 +319,7 @@ let type = types.str; default = ""; example = "localhost:25"; - description = '' + description = lib.mdDoc '' Hostname:port combination to send outgoing mail. Blank - use system MTA. ''; @@ -328,7 +328,7 @@ let login = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' SMTP authentication login used when sending outgoing mail. ''; }; @@ -336,7 +336,7 @@ let password = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' SMTP authentication password used when sending outgoing mail. ''; }; @@ -344,7 +344,7 @@ let security = mkOption { type = types.enum ["" "ssl" "tls"]; default = ""; - description = '' + description = lib.mdDoc '' Used to select a secure SMTP connection. Allowed values: ssl, tls, or empty. ''; @@ -353,7 +353,7 @@ let fromName = mkOption { type = types.str; default = "Tiny Tiny RSS"; - description = '' + description = lib.mdDoc '' Name for sending outgoing mail. This applies to password reset notifications, digest emails and any other mail. ''; @@ -362,7 +362,7 @@ let fromAddress = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Address for sending outgoing mail. This applies to password reset notifications, digest emails and any other mail. ''; @@ -371,7 +371,7 @@ let digestSubject = mkOption { type = types.str; default = "[tt-rss] New headlines for last 24 hours"; - description = '' + description = lib.mdDoc '' Subject line for email digests. ''; }; @@ -380,7 +380,7 @@ let sessionCookieLifetime = mkOption { type = types.int; default = 86400; - description = '' + description = lib.mdDoc '' Default lifetime of a session (e.g. login) cookie. In seconds, 0 means cookie will be deleted when browser closes. ''; @@ -388,7 +388,7 @@ let selfUrlPath = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Full URL of your tt-rss installation. This should be set to the location of tt-rss directory, e.g. http://example.org/tt-rss/ You need to set this option correctly otherwise several features @@ -400,7 +400,7 @@ let feedCryptKey = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Key used for encryption of passwords for password-protected feeds in the database. A string of 24 random characters. If left blank, encryption is not used. Requires mcrypt functions. @@ -413,7 +413,7 @@ let type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Operate in single user mode, disables all functionality related to multiple users and authentication. Enabling this assumes you have your tt-rss directory protected by other means (e.g. http auth). @@ -423,7 +423,7 @@ let simpleUpdateMode = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enables fallback update mode where tt-rss tries to update feeds in background while tt-rss is open in your browser. If you don't have a lot of feeds and don't want to or can't run @@ -437,7 +437,7 @@ let forceArticlePurge = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' When this option is not 0, users ability to control feed purging intervals is disabled and all articles (which are not starred) older than this amount of days are purged. @@ -447,7 +447,7 @@ let enableGZipOutput = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Selectively gzip output to improve wire performance. This requires PHP Zlib extension on the server. Enabling this can break tt-rss in several httpd/php configurations, @@ -459,7 +459,7 @@ let plugins = mkOption { type = types.listOf types.str; default = ["auth_internal" "note"]; - description = '' + description = lib.mdDoc '' List of plugins to load automatically for all users. System plugins have to be specified here. Please enable at least one authentication plugin here (auth_*). @@ -473,27 +473,27 @@ let pluginPackages = mkOption { type = types.listOf types.package; default = []; - description = '' + description = lib.mdDoc '' List of plugins to install. The list elements are expected to be derivations. All elements in this derivation are automatically - copied to the <literal>plugins.local</literal> directory. + copied to the `plugins.local` directory. ''; }; themePackages = mkOption { type = types.listOf types.package; default = []; - description = '' + description = lib.mdDoc '' List of themes to install. The list elements are expected to be derivations. All elements in this derivation are automatically - copied to the <literal>themes.local</literal> directory. + copied to the `themes.local` directory. ''; }; logDestination = mkOption { type = types.enum ["" "sql" "syslog"]; default = "sql"; - description = '' + description = lib.mdDoc '' Log destination to use. Possible values: sql (uses internal logging you can read in Preferences -> System), syslog - logs to system log. Setting this to blank uses PHP logging (usually to http server @@ -504,8 +504,8 @@ let extraConfig = mkOption { type = types.lines; default = ""; - description = '' - Additional lines to append to <literal>config.php</literal>. + description = lib.mdDoc '' + Additional lines to append to `config.php`. ''; }; }; diff --git a/nixos/modules/services/web-apps/vikunja.nix b/nixos/modules/services/web-apps/vikunja.nix index 7575e96ca815d..7db6101598091 100644 --- a/nixos/modules/services/web-apps/vikunja.nix +++ b/nixos/modules/services/web-apps/vikunja.nix @@ -15,18 +15,18 @@ in { default = pkgs.vikunja-api; type = types.package; defaultText = literalExpression "pkgs.vikunja-api"; - description = "vikunja-api derivation to use."; + description = lib.mdDoc "vikunja-api derivation to use."; }; package-frontend = mkOption { default = pkgs.vikunja-frontend; type = types.package; defaultText = literalExpression "pkgs.vikunja-frontend"; - description = "vikunja-frontend derivation to use."; + description = lib.mdDoc "vikunja-frontend derivation to use."; }; environmentFiles = mkOption { type = types.listOf types.path; default = [ ]; - description = '' + description = lib.mdDoc '' List of environment files set in the vikunja systemd service. For example passwords should be set in one of these files. ''; @@ -35,34 +35,34 @@ in { type = types.bool; default = config.services.nginx.enable; defaultText = literalExpression "config.services.nginx.enable"; - description = '' + description = lib.mdDoc '' Whether to setup NGINX. Further nginx configuration can be done by changing - <option>services.nginx.virtualHosts.<frontendHostname></option>. + {option}`services.nginx.virtualHosts.<frontendHostname>`. This does not enable TLS or ACME by default. To enable this, set the - <option>services.nginx.virtualHosts.<frontendHostname>.enableACME</option> to - <literal>true</literal> and if appropriate do the same for - <option>services.nginx.virtualHosts.<frontendHostname>.forceSSL</option>. + {option}`services.nginx.virtualHosts.<frontendHostname>.enableACME` to + `true` and if appropriate do the same for + {option}`services.nginx.virtualHosts.<frontendHostname>.forceSSL`. ''; }; frontendScheme = mkOption { type = types.enum [ "http" "https" ]; - description = '' + description = lib.mdDoc '' Whether the site is available via http or https. This does not configure https or ACME in nginx! ''; }; frontendHostname = mkOption { type = types.str; - description = "The Hostname under which the frontend is running."; + description = lib.mdDoc "The Hostname under which the frontend is running."; }; settings = mkOption { type = format.type; default = {}; - description = '' + description = lib.mdDoc '' Vikunja configuration. Refer to - <link xlink:href="https://vikunja.io/docs/config-options/"/> + <https://vikunja.io/docs/config-options/> for details on supported values. ''; }; @@ -71,27 +71,27 @@ in { type = types.enum [ "sqlite" "mysql" "postgres" ]; example = "postgres"; default = "sqlite"; - description = "Database engine to use."; + description = lib.mdDoc "Database engine to use."; }; host = mkOption { type = types.str; default = "localhost"; - description = "Database host address. Can also be a socket."; + description = lib.mdDoc "Database host address. Can also be a socket."; }; user = mkOption { type = types.str; default = "vikunja"; - description = "Database user."; + description = lib.mdDoc "Database user."; }; database = mkOption { type = types.str; default = "vikunja"; - description = "Database name."; + description = lib.mdDoc "Database name."; }; path = mkOption { type = types.str; default = "/var/lib/vikunja/vikunja.db"; - description = "Path to the sqlite3 database file."; + description = lib.mdDoc "Path to the sqlite3 database file."; }; }; }; diff --git a/nixos/modules/services/web-apps/virtlyst.nix b/nixos/modules/services/web-apps/virtlyst.nix index 37bdbb0e3b42b..5094367a49378 100644 --- a/nixos/modules/services/web-apps/virtlyst.nix +++ b/nixos/modules/services/web-apps/virtlyst.nix @@ -35,7 +35,7 @@ in adminPassword = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Initial admin password with which the database will be seeded. ''; }; @@ -43,7 +43,7 @@ in httpSocket = mkOption { type = types.str; default = "localhost:3000"; - description = '' + description = lib.mdDoc '' IP and/or port to which to bind the http socket. ''; }; diff --git a/nixos/modules/services/web-apps/whitebophir.nix b/nixos/modules/services/web-apps/whitebophir.nix index f9db6fe379b0b..c4dee3c6eec7d 100644 --- a/nixos/modules/services/web-apps/whitebophir.nix +++ b/nixos/modules/services/web-apps/whitebophir.nix @@ -13,19 +13,19 @@ in { default = pkgs.whitebophir; defaultText = literalExpression "pkgs.whitebophir"; type = types.package; - description = "Whitebophir package to use."; + description = lib.mdDoc "Whitebophir package to use."; }; listenAddress = mkOption { type = types.str; default = "0.0.0.0"; - description = "Address to listen on (use 0.0.0.0 to allow access from any address)."; + description = lib.mdDoc "Address to listen on (use 0.0.0.0 to allow access from any address)."; }; port = mkOption { type = types.port; default = 5001; - description = "Port to bind to."; + description = lib.mdDoc "Port to bind to."; }; }; }; diff --git a/nixos/modules/services/web-apps/wiki-js.nix b/nixos/modules/services/web-apps/wiki-js.nix index 1a6259dffeef5..474fbb8f13c31 100644 --- a/nixos/modules/services/web-apps/wiki-js.nix +++ b/nixos/modules/services/web-apps/wiki-js.nix @@ -16,7 +16,7 @@ in { type = types.nullOr types.path; default = null; example = "/root/wiki-js.env"; - description = '' + description = lib.mdDoc '' Environment fiel to inject e.g. secrets into the configuration. ''; }; @@ -24,8 +24,8 @@ in { stateDirectoryName = mkOption { default = "wiki-js"; type = types.str; - description = '' - Name of the directory in <filename>/var/lib</filename>. + description = lib.mdDoc '' + Name of the directory in {file}`/var/lib`. ''; }; @@ -37,7 +37,7 @@ in { port = mkOption { type = types.port; default = 3000; - description = '' + description = lib.mdDoc '' TCP port the process should listen to. ''; }; @@ -45,7 +45,7 @@ in { bindIP = mkOption { default = "0.0.0.0"; type = types.str; - description = '' + description = lib.mdDoc '' IPs the service should listen to. ''; }; @@ -64,14 +64,14 @@ in { host = mkOption { type = types.str; example = "/run/postgresql"; - description = '' + description = lib.mdDoc '' Hostname or socket-path to connect to. ''; }; db = mkOption { default = "wiki"; type = types.str; - description = '' + description = lib.mdDoc '' Name of the database to use. ''; }; @@ -80,7 +80,7 @@ in { logLevel = mkOption { default = "info"; type = types.enum [ "error" "warn" "info" "verbose" "debug" "silly" ]; - description = '' + description = lib.mdDoc '' Define how much detail is supposed to be logged at runtime. ''; }; diff --git a/nixos/modules/services/web-apps/youtrack.nix b/nixos/modules/services/web-apps/youtrack.nix index b83265ffeab6c..789880d61f61c 100644 --- a/nixos/modules/services/web-apps/youtrack.nix +++ b/nixos/modules/services/web-apps/youtrack.nix @@ -24,7 +24,7 @@ in enable = mkEnableOption "YouTrack service"; address = mkOption { - description = '' + description = lib.mdDoc '' The interface youtrack will listen on. ''; default = "127.0.0.1"; @@ -32,7 +32,7 @@ in }; baseUrl = mkOption { - description = '' + description = lib.mdDoc '' Base URL for youtrack. Will be auto-detected and stored in database. ''; type = types.nullOr types.str; @@ -41,7 +41,7 @@ in extraParams = mkOption { default = {}; - description = '' + description = lib.mdDoc '' Extra parameters to pass to youtrack. See https://www.jetbrains.com/help/youtrack/standalone/YouTrack-Java-Start-Parameters.html for more information. @@ -55,7 +55,7 @@ in }; package = mkOption { - description = '' + description = lib.mdDoc '' Package to use. ''; type = types.package; @@ -64,7 +64,7 @@ in }; port = mkOption { - description = '' + description = lib.mdDoc '' The port youtrack will listen on. ''; default = 8080; @@ -72,7 +72,7 @@ in }; statePath = mkOption { - description = '' + description = lib.mdDoc '' Where to keep the youtrack database. ''; type = types.path; @@ -80,7 +80,7 @@ in }; virtualHost = mkOption { - description = '' + description = lib.mdDoc '' Name of the nginx virtual host to use and setup. If null, do not setup anything. ''; @@ -89,7 +89,7 @@ in }; jvmOpts = mkOption { - description = '' + description = lib.mdDoc '' Extra options to pass to the JVM. See https://www.jetbrains.com/help/youtrack/standalone/Configure-JVM-Options.html for more information. @@ -100,7 +100,7 @@ in }; maxMemory = mkOption { - description = '' + description = lib.mdDoc '' Maximum Java heap size ''; type = types.str; @@ -108,7 +108,7 @@ in }; maxMetaspaceSize = mkOption { - description = '' + description = lib.mdDoc '' Maximum java Metaspace memory. ''; type = types.str; diff --git a/nixos/modules/services/web-servers/agate.nix b/nixos/modules/services/web-servers/agate.nix index 3afdb561c0b0a..3f7b298fa94e6 100644 --- a/nixos/modules/services/web-servers/agate.nix +++ b/nixos/modules/services/web-servers/agate.nix @@ -14,13 +14,13 @@ in type = types.package; default = pkgs.agate; defaultText = literalExpression "pkgs.agate"; - description = "The package to use"; + description = lib.mdDoc "The package to use"; }; addresses = mkOption { type = types.listOf types.str; default = [ "0.0.0.0:1965" ]; - description = '' + description = lib.mdDoc '' Addresses to listen on, IP:PORT, if you haven't disabled forwarding only set IPv4. ''; @@ -29,19 +29,19 @@ in contentDir = mkOption { default = "/var/lib/agate/content"; type = types.path; - description = "Root of the content directory."; + description = lib.mdDoc "Root of the content directory."; }; certificatesDir = mkOption { default = "/var/lib/agate/certificates"; type = types.path; - description = "Root of the certificate directory."; + description = lib.mdDoc "Root of the certificate directory."; }; hostnames = mkOption { default = [ ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Domain name of this Gemini server, enables checking hostname and port in requests. (multiple occurences means basic vhosts) ''; @@ -50,20 +50,20 @@ in language = mkOption { default = null; type = types.nullOr types.str; - description = "RFC 4646 Language code for text/gemini documents."; + description = lib.mdDoc "RFC 4646 Language code for text/gemini documents."; }; onlyTls_1_3 = mkOption { default = false; type = types.bool; - description = "Only use TLSv1.3 (default also allows TLSv1.2)."; + description = lib.mdDoc "Only use TLSv1.3 (default also allows TLSv1.2)."; }; extraArgs = mkOption { type = types.listOf types.str; default = [ "" ]; example = [ "--log-ip" ]; - description = "Extra arguments to use running agate."; + description = lib.mdDoc "Extra arguments to use running agate."; }; }; }; diff --git a/nixos/modules/services/web-servers/apache-httpd/location-options.nix b/nixos/modules/services/web-servers/apache-httpd/location-options.nix index 8ea88f94f973f..726ad2683d282 100644 --- a/nixos/modules/services/web-servers/apache-httpd/location-options.nix +++ b/nixos/modules/services/web-servers/apache-httpd/location-options.nix @@ -9,8 +9,8 @@ in type = with types; nullOr str; default = null; example = "http://www.example.org/"; - description = '' - Sets up a simple reverse proxy as described by <link xlink:href="https://httpd.apache.org/docs/2.4/howto/reverse_proxy.html#simple" />. + description = lib.mdDoc '' + Sets up a simple reverse proxy as described by <https://httpd.apache.org/docs/2.4/howto/reverse_proxy.html#simple>. ''; }; @@ -18,8 +18,8 @@ in type = with types; nullOr str; default = null; example = "index.php index.html"; - description = '' - Adds DirectoryIndex directive. See <link xlink:href="https://httpd.apache.org/docs/2.4/mod/mod_dir.html#directoryindex" />. + description = lib.mdDoc '' + Adds DirectoryIndex directive. See <https://httpd.apache.org/docs/2.4/mod/mod_dir.html#directoryindex>. ''; }; @@ -27,15 +27,15 @@ in type = with types; nullOr path; default = null; example = "/your/alias/directory"; - description = '' - Alias directory for requests. See <link xlink:href="https://httpd.apache.org/docs/2.4/mod/mod_alias.html#alias" />. + description = lib.mdDoc '' + Alias directory for requests. See <https://httpd.apache.org/docs/2.4/mod/mod_alias.html#alias>. ''; }; extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' These lines go to the end of the location verbatim. ''; }; diff --git a/nixos/modules/services/web-servers/darkhttpd.nix b/nixos/modules/services/web-servers/darkhttpd.nix index f6b693139a1ef..5663e9ca9df6d 100644 --- a/nixos/modules/services/web-servers/darkhttpd.nix +++ b/nixos/modules/services/web-servers/darkhttpd.nix @@ -20,7 +20,7 @@ in { port = mkOption { default = 80; type = types.port; - description = '' + description = lib.mdDoc '' Port to listen on. Pass 0 to let the system choose any free port for you. ''; @@ -37,7 +37,7 @@ in { rootDir = mkOption { type = path; - description = '' + description = lib.mdDoc '' Path from which to serve files. ''; }; @@ -45,7 +45,7 @@ in { hideServerId = mkOption { type = bool; default = true; - description = '' + description = lib.mdDoc '' Don't identify the server type in headers or directory listings. ''; }; @@ -53,7 +53,7 @@ in { extraArgs = mkOption { type = listOf str; default = []; - description = '' + description = lib.mdDoc '' Additional configuration passed to the executable. ''; }; diff --git a/nixos/modules/services/web-servers/fcgiwrap.nix b/nixos/modules/services/web-servers/fcgiwrap.nix index a64a187255a48..f9c91fb35db23 100644 --- a/nixos/modules/services/web-servers/fcgiwrap.nix +++ b/nixos/modules/services/web-servers/fcgiwrap.nix @@ -11,38 +11,38 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable fcgiwrap, a server for running CGI applications over FastCGI."; + description = lib.mdDoc "Whether to enable fcgiwrap, a server for running CGI applications over FastCGI."; }; preforkProcesses = mkOption { type = types.int; default = 1; - description = "Number of processes to prefork."; + description = lib.mdDoc "Number of processes to prefork."; }; socketType = mkOption { type = types.enum [ "unix" "tcp" "tcp6" ]; default = "unix"; - description = "Socket type: 'unix', 'tcp' or 'tcp6'."; + description = lib.mdDoc "Socket type: 'unix', 'tcp' or 'tcp6'."; }; socketAddress = mkOption { type = types.str; default = "/run/fcgiwrap.sock"; example = "1.2.3.4:5678"; - description = "Socket address. In case of a UNIX socket, this should be its filesystem path."; + description = lib.mdDoc "Socket address. In case of a UNIX socket, this should be its filesystem path."; }; user = mkOption { type = types.nullOr types.str; default = null; - description = "User permissions for the socket."; + description = lib.mdDoc "User permissions for the socket."; }; group = mkOption { type = types.nullOr types.str; default = null; - description = "Group permissions for the socket."; + description = lib.mdDoc "Group permissions for the socket."; }; }; }; diff --git a/nixos/modules/services/web-servers/hitch/default.nix b/nixos/modules/services/web-servers/hitch/default.nix index 1812f225b74d7..78bae1405563a 100644 --- a/nixos/modules/services/web-servers/hitch/default.nix +++ b/nixos/modules/services/web-servers/hitch/default.nix @@ -21,7 +21,7 @@ with lib; backend = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The host and port Hitch connects to when receiving a connection in the form [HOST]:PORT ''; @@ -30,7 +30,7 @@ with lib; ciphers = mkOption { type = types.str; default = "EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH"; - description = "The list of ciphers to use"; + description = lib.mdDoc "The list of ciphers to use"; }; frontend = mkOption { @@ -46,33 +46,33 @@ with lib; pem-files = mkOption { type = types.listOf types.path; default = []; - description = "PEM files to use"; + description = lib.mdDoc "PEM files to use"; }; ocsp-stapling = { enabled = mkOption { type = types.bool; default = true; - description = "Whether to enable OCSP Stapling"; + description = lib.mdDoc "Whether to enable OCSP Stapling"; }; }; user = mkOption { type = types.str; default = "hitch"; - description = "The user to run as"; + description = lib.mdDoc "The user to run as"; }; group = mkOption { type = types.str; default = "hitch"; - description = "The group to run as"; + description = lib.mdDoc "The group to run as"; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Additional configuration lines"; + description = lib.mdDoc "Additional configuration lines"; }; }; diff --git a/nixos/modules/services/web-servers/hydron.nix b/nixos/modules/services/web-servers/hydron.nix index 46f62a9119f0d..046d527b2ab85 100644 --- a/nixos/modules/services/web-servers/hydron.nix +++ b/nixos/modules/services/web-servers/hydron.nix @@ -10,7 +10,7 @@ in with lib; { type = types.path; default = "/var/lib/hydron"; example = "/home/okina/hydron"; - description = "Location where hydron runs and stores data."; + description = lib.mdDoc "Location where hydron runs and stores data."; }; interval = mkOption { @@ -30,19 +30,19 @@ in with lib; { type = types.str; default = "hydron"; example = "dumbpass"; - description = "Password for the hydron database."; + description = lib.mdDoc "Password for the hydron database."; }; passwordFile = mkOption { type = types.path; default = "/run/keys/hydron-password-file"; example = "/home/okina/hydron/keys/pass"; - description = "Password file for the hydron database."; + description = lib.mdDoc "Password file for the hydron database."; }; postgresArgs = mkOption { type = types.str; - description = "Postgresql connection arguments."; + description = lib.mdDoc "Postgresql connection arguments."; example = '' { "driver": "postgres", @@ -55,27 +55,27 @@ in with lib; { type = types.path; default = "/run/keys/hydron-postgres-args"; example = "/home/okina/hydron/keys/postgres"; - description = "Postgresql connection arguments file."; + description = lib.mdDoc "Postgresql connection arguments file."; }; listenAddress = mkOption { type = types.nullOr types.str; default = null; example = "127.0.0.1:8010"; - description = "Listen on a specific IP address and port."; + description = lib.mdDoc "Listen on a specific IP address and port."; }; importPaths = mkOption { type = types.listOf types.path; default = []; example = [ "/home/okina/Pictures" ]; - description = "Paths that hydron will recursively import."; + description = lib.mdDoc "Paths that hydron will recursively import."; }; fetchTags = mkOption { type = types.bool; default = true; - description = "Fetch tags for imported images and webm from gelbooru."; + description = lib.mdDoc "Fetch tags for imported images and webm from gelbooru."; }; }; diff --git a/nixos/modules/services/web-servers/jboss/default.nix b/nixos/modules/services/web-servers/jboss/default.nix index d243e0f3f1b78..05b354d567fe4 100644 --- a/nixos/modules/services/web-servers/jboss/default.nix +++ b/nixos/modules/services/web-servers/jboss/default.nix @@ -26,49 +26,49 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable JBoss. WARNING : this package is outdated and is known to have vulnerabilities."; + description = lib.mdDoc "Whether to enable JBoss. WARNING : this package is outdated and is known to have vulnerabilities."; }; tempDir = mkOption { default = "/tmp"; type = types.str; - description = "Location where JBoss stores its temp files"; + description = lib.mdDoc "Location where JBoss stores its temp files"; }; logDir = mkOption { default = "/var/log/jboss"; type = types.str; - description = "Location of the logfile directory of JBoss"; + description = lib.mdDoc "Location of the logfile directory of JBoss"; }; serverDir = mkOption { - description = "Location of the server instance files"; + description = lib.mdDoc "Location of the server instance files"; default = "/var/jboss/server"; type = types.str; }; deployDir = mkOption { - description = "Location of the deployment files"; + description = lib.mdDoc "Location of the deployment files"; default = "/nix/var/nix/profiles/default/server/default/deploy/"; type = types.str; }; libUrl = mkOption { default = "file:///nix/var/nix/profiles/default/server/default/lib"; - description = "Location where the shared library JARs are stored"; + description = lib.mdDoc "Location where the shared library JARs are stored"; type = types.str; }; user = mkOption { default = "nobody"; - description = "User account under which jboss runs."; + description = lib.mdDoc "User account under which jboss runs."; type = types.str; }; useJK = mkOption { type = types.bool; default = false; - description = "Whether to use to connector to the Apache HTTP server"; + description = lib.mdDoc "Whether to use to connector to the Apache HTTP server"; }; }; diff --git a/nixos/modules/services/web-servers/lighttpd/cgit.nix b/nixos/modules/services/web-servers/lighttpd/cgit.nix index 8cd6d020940bf..5042fbf1f8f29 100644 --- a/nixos/modules/services/web-servers/lighttpd/cgit.nix +++ b/nixos/modules/services/web-servers/lighttpd/cgit.nix @@ -23,7 +23,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If true, enable cgit (fast web interface for git repositories) as a sub-service in lighttpd. ''; @@ -33,7 +33,7 @@ in default = "cgit"; example = ""; type = types.str; - description = '' + description = lib.mdDoc '' The subdirectory in which to serve cgit. The web application will be accessible at http://yourserver/''${subdir} ''; @@ -50,7 +50,7 @@ in ''' ''; type = types.lines; - description = '' + description = lib.mdDoc '' Verbatim contents of the cgit runtime configuration file. Documentation (with cgitrc example file) is available in "man cgitrc". Or online: http://git.zx2c4.com/cgit/tree/cgitrc.5.txt diff --git a/nixos/modules/services/web-servers/lighttpd/collectd.nix b/nixos/modules/services/web-servers/lighttpd/collectd.nix index 5f091591daf91..270517a4e2a52 100644 --- a/nixos/modules/services/web-servers/lighttpd/collectd.nix +++ b/nixos/modules/services/web-servers/lighttpd/collectd.nix @@ -33,7 +33,7 @@ in defaultText = literalDocBook '' <literal>config.${options.services.collectd.package}</literal> configured for lighttpd ''; - description = '' + description = lib.mdDoc '' Path to collection.cgi script from (collectd sources)/contrib/collection.cgi This option allows to use a customized version ''; diff --git a/nixos/modules/services/web-servers/lighttpd/default.nix b/nixos/modules/services/web-servers/lighttpd/default.nix index 05e897c8cc946..ec847495d7414 100644 --- a/nixos/modules/services/web-servers/lighttpd/default.nix +++ b/nixos/modules/services/web-servers/lighttpd/default.nix @@ -130,7 +130,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable the lighttpd web server. ''; }; @@ -139,7 +139,7 @@ in default = pkgs.lighttpd; defaultText = "pkgs.lighttpd"; type = types.package; - description = '' + description = lib.mdDoc '' lighttpd package to use. ''; }; @@ -147,7 +147,7 @@ in port = mkOption { default = 80; type = types.port; - description = '' + description = lib.mdDoc '' TCP port number for lighttpd to bind to. ''; }; @@ -155,7 +155,7 @@ in document-root = mkOption { default = "/srv/www"; type = types.path; - description = '' + description = lib.mdDoc '' Document-root of the web server. Must be readable by the "lighttpd" user. ''; }; @@ -163,7 +163,7 @@ in mod_userdir = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If true, requests in the form /~user/page.html are rewritten to take the file public_html/page.html from the home directory of the user. ''; @@ -173,11 +173,11 @@ in type = types.listOf types.str; default = [ ]; example = [ "mod_cgi" "mod_status" ]; - description = '' + description = lib.mdDoc '' List of lighttpd modules to enable. Sub-services take care of enabling modules as needed, so this option is mainly for when you want to add custom stuff to - <option>services.lighttpd.extraConfig</option> that depends on a + {option}`services.lighttpd.extraConfig` that depends on a certain module. ''; }; @@ -185,18 +185,18 @@ in enableUpstreamMimeTypes = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to include the list of mime types bundled with lighttpd (upstream). If you disable this, no mime types will be added by NixOS and you will have to add your own mime types in - <option>services.lighttpd.extraConfig</option>. + {option}`services.lighttpd.extraConfig`. ''; }; mod_status = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Show server status overview at /server-status, statistics at /server-statistics and list of loaded modules at /server-config. ''; @@ -206,7 +206,7 @@ in default = ""; type = types.lines; example = "...verbatim config file contents..."; - description = '' + description = lib.mdDoc '' Overridable config file contents to use for lighttpd. By default, use the contents automatically generated by NixOS. ''; @@ -215,10 +215,10 @@ in extraConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' These configuration lines will be appended to the generated lighttpd config file. Note that this mechanism does not work when the manual - <option>configText</option> option is used. + {option}`configText` option is used. ''; }; diff --git a/nixos/modules/services/web-servers/lighttpd/gitweb.nix b/nixos/modules/services/web-servers/lighttpd/gitweb.nix index c494d6966a7f5..e129e8bc1666d 100644 --- a/nixos/modules/services/web-servers/lighttpd/gitweb.nix +++ b/nixos/modules/services/web-servers/lighttpd/gitweb.nix @@ -16,7 +16,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If true, enable gitweb in lighttpd. Access it at http://yourserver/gitweb ''; }; diff --git a/nixos/modules/services/web-servers/mighttpd2.nix b/nixos/modules/services/web-servers/mighttpd2.nix index f9b1a8b6cccef..523b5de2d693a 100644 --- a/nixos/modules/services/web-servers/mighttpd2.nix +++ b/nixos/modules/services/web-servers/mighttpd2.nix @@ -42,7 +42,7 @@ in { Service: 0 # 0 is HTTP only, 1 is HTTPS only, 2 is both ''; type = types.lines; - description = '' + description = lib.mdDoc '' Verbatim config file to use (see http://www.mew.org/~kazu/proj/mighttpd/en/config.html) ''; @@ -76,7 +76,7 @@ in { / -> /export/www/ ''; type = types.lines; - description = '' + description = lib.mdDoc '' Verbatim routing file to use (see http://www.mew.org/~kazu/proj/mighttpd/en/config.html) ''; @@ -85,7 +85,7 @@ in { cores = mkOption { default = null; type = types.nullOr types.int; - description = '' + description = lib.mdDoc '' How many cores to use. If null it will be determined automatically ''; diff --git a/nixos/modules/services/web-servers/minio.nix b/nixos/modules/services/web-servers/minio.nix index c345e3f2467bd..f4fca2275e77a 100644 --- a/nixos/modules/services/web-servers/minio.nix +++ b/nixos/modules/services/web-servers/minio.nix @@ -19,51 +19,51 @@ in listenAddress = mkOption { default = ":9000"; type = types.str; - description = "IP address and port of the server."; + description = lib.mdDoc "IP address and port of the server."; }; consoleAddress = mkOption { default = ":9001"; type = types.str; - description = "IP address and port of the web UI (console)."; + description = lib.mdDoc "IP address and port of the web UI (console)."; }; dataDir = mkOption { default = [ "/var/lib/minio/data" ]; type = types.listOf types.path; - description = "The list of data directories for storing the objects. Use one path for regular operation and the minimum of 4 endpoints for Erasure Code mode."; + description = lib.mdDoc "The list of data directories for storing the objects. Use one path for regular operation and the minimum of 4 endpoints for Erasure Code mode."; }; configDir = mkOption { default = "/var/lib/minio/config"; type = types.path; - description = "The config directory, for the access keys and other settings."; + description = lib.mdDoc "The config directory, for the access keys and other settings."; }; accessKey = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' Access key of 5 to 20 characters in length that clients use to access the server. This overrides the access key that is generated by minio on first startup and stored inside the - <literal>configDir</literal> directory. + `configDir` directory. ''; }; secretKey = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' Specify the Secret key of 8 to 40 characters in length that clients use to access the server. This overrides the secret key that is generated by minio on first startup and stored inside the - <literal>configDir</literal> directory. + `configDir` directory. ''; }; rootCredentialsFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' File containing the MINIO_ROOT_USER, default is "minioadmin", and MINIO_ROOT_PASSWORD (length >= 8), default is "minioadmin"; in the format of an EnvironmentFile=, as described by systemd.exec(5). @@ -74,7 +74,7 @@ in region = mkOption { default = "us-east-1"; type = types.str; - description = '' + description = lib.mdDoc '' The physical location of the server. By default it is set to us-east-1, which is same as AWS S3's and Minio's default region. ''; }; @@ -82,14 +82,14 @@ in browser = mkOption { default = true; type = types.bool; - description = "Enable or disable access to web UI."; + description = lib.mdDoc "Enable or disable access to web UI."; }; package = mkOption { default = pkgs.minio; defaultText = literalExpression "pkgs.minio"; type = types.package; - description = "Minio package to use."; + description = lib.mdDoc "Minio package to use."; }; }; diff --git a/nixos/modules/services/web-servers/molly-brown.nix b/nixos/modules/services/web-servers/molly-brown.nix index 0bd8b3316cb36..31a2e856db47e 100644 --- a/nixos/modules/services/web-servers/molly-brown.nix +++ b/nixos/modules/services/web-servers/molly-brown.nix @@ -15,7 +15,7 @@ in { port = mkOption { default = 1965; type = types.port; - description = '' + description = lib.mdDoc '' TCP port for molly-brown to bind to. ''; }; @@ -24,7 +24,7 @@ in { type = types.str; default = config.networking.hostName; defaultText = literalExpression "config.networking.hostName"; - description = '' + description = lib.mdDoc '' The hostname to respond to requests for. Requests for URLs with other hosts will result in a status 53 (PROXY REQUEST REFUSED) response. @@ -50,21 +50,21 @@ in { keyPath = mkOption { type = types.path; example = "/var/lib/acme/example.com/key.pem"; - description = "Path to TLS key. See <option>CertPath</option>."; + description = lib.mdDoc "Path to TLS key. See {option}`CertPath`."; }; docBase = mkOption { type = types.path; example = "/var/lib/molly-brown"; - description = "Base directory for Gemini content."; + description = lib.mdDoc "Base directory for Gemini content."; }; settings = mkOption { inherit (settingsFormat) type; default = { }; - description = '' + description = lib.mdDoc '' molly-brown configuration. Refer to - <link xlink:href="https://tildegit.org/solderpunk/molly-brown/src/branch/master/example.conf"/> + <https://tildegit.org/solderpunk/molly-brown/src/branch/master/example.conf> for details on supported values. ''; }; diff --git a/nixos/modules/services/web-servers/nginx/gitweb.nix b/nixos/modules/services/web-servers/nginx/gitweb.nix index db45577a46d16..ec2c432ca573e 100644 --- a/nixos/modules/services/web-servers/nginx/gitweb.nix +++ b/nixos/modules/services/web-servers/nginx/gitweb.nix @@ -17,7 +17,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If true, enable gitweb in nginx. ''; }; @@ -25,7 +25,7 @@ in location = mkOption { default = "/gitweb"; type = types.str; - description = '' + description = lib.mdDoc '' Location to serve gitweb on. ''; }; @@ -33,7 +33,7 @@ in user = mkOption { default = "nginx"; type = types.str; - description = '' + description = lib.mdDoc '' Existing user that the CGI process will belong to. (Default almost surely will do.) ''; }; @@ -41,15 +41,15 @@ in group = mkOption { default = "nginx"; type = types.str; - description = '' - Group that the CGI process will belong to. (Set to <literal>config.services.gitolite.group</literal> if you are using gitolite.) + description = lib.mdDoc '' + Group that the CGI process will belong to. (Set to `config.services.gitolite.group` if you are using gitolite.) ''; }; virtualHost = mkOption { default = "_"; type = types.str; - description = '' + description = lib.mdDoc '' VirtualHost to serve gitweb on. Default is catch-all. ''; }; diff --git a/nixos/modules/services/web-servers/phpfpm/default.nix b/nixos/modules/services/web-servers/phpfpm/default.nix index 87c68fa074a16..e24c77d056a29 100644 --- a/nixos/modules/services/web-servers/phpfpm/default.nix +++ b/nixos/modules/services/web-servers/phpfpm/default.nix @@ -51,7 +51,7 @@ let type = types.str; default = ""; example = "/path/to/unix/socket"; - description = '' + description = lib.mdDoc '' The address on which to accept FastCGI requests. ''; }; @@ -60,22 +60,22 @@ let type = types.package; default = cfg.phpPackage; defaultText = literalExpression "config.services.phpfpm.phpPackage"; - description = '' + description = lib.mdDoc '' The PHP package to use for running this PHP-FPM pool. ''; }; phpOptions = mkOption { type = types.lines; - description = '' - "Options appended to the PHP configuration file <filename>php.ini</filename> used for this PHP-FPM pool." + description = lib.mdDoc '' + "Options appended to the PHP configuration file {file}`php.ini` used for this PHP-FPM pool." ''; }; phpEnv = lib.mkOption { type = with types; attrsOf str; default = {}; - description = '' + description = lib.mdDoc '' Environment variables used for this PHP-FPM pool. ''; example = literalExpression '' @@ -90,22 +90,22 @@ let user = mkOption { type = types.str; - description = "User account under which this pool runs."; + description = lib.mdDoc "User account under which this pool runs."; }; group = mkOption { type = types.str; - description = "Group account under which this pool runs."; + description = lib.mdDoc "Group account under which this pool runs."; }; settings = mkOption { type = with types; attrsOf (oneOf [ str int bool ]); default = {}; - description = '' + description = lib.mdDoc '' PHP-FPM pool directives. Refer to the "List of pool directives" section of - <link xlink:href="https://www.php.net/manual/en/install.fpm.configuration.php"/> + <https://www.php.net/manual/en/install.fpm.configuration.php> for details. Note that settings names must be enclosed in quotes (e.g. - <literal>"pm.max_children"</literal> instead of <literal>pm.max_children</literal>). + `"pm.max_children"` instead of `pm.max_children`). ''; example = literalExpression '' { @@ -122,9 +122,9 @@ let extraConfig = mkOption { type = with types; nullOr lines; default = null; - description = '' + description = lib.mdDoc '' Extra lines that go into the pool configuration. - See the documentation on <literal>php-fpm.conf</literal> for + See the documentation on `php-fpm.conf` for details on configuration directives. ''; }; @@ -154,24 +154,24 @@ in { settings = mkOption { type = with types; attrsOf (oneOf [ str int bool ]); default = {}; - description = '' + description = lib.mdDoc '' PHP-FPM global directives. Refer to the "List of global php-fpm.conf directives" section of - <link xlink:href="https://www.php.net/manual/en/install.fpm.configuration.php"/> + <https://www.php.net/manual/en/install.fpm.configuration.php> for details. Note that settings names must be enclosed in quotes (e.g. - <literal>"pm.max_children"</literal> instead of <literal>pm.max_children</literal>). - You need not specify the options <literal>error_log</literal> or - <literal>daemonize</literal> here, since they are generated by NixOS. + `"pm.max_children"` instead of `pm.max_children`). + You need not specify the options `error_log` or + `daemonize` here, since they are generated by NixOS. ''; }; extraConfig = mkOption { type = with types; nullOr lines; default = null; - description = '' + description = lib.mdDoc '' Extra configuration that should be put in the global section of the PHP-FPM configuration file. Do not specify the options - <literal>error_log</literal> or - <literal>daemonize</literal> here, since they are generated by + `error_log` or + `daemonize` here, since they are generated by NixOS. ''; }; @@ -180,7 +180,7 @@ in { type = types.package; default = pkgs.php; defaultText = literalExpression "pkgs.php"; - description = '' + description = lib.mdDoc '' The PHP package to use for running the PHP-FPM service. ''; }; @@ -192,8 +192,8 @@ in { '' date.timezone = "CET" ''; - description = '' - Options appended to the PHP configuration file <filename>php.ini</filename>. + description = lib.mdDoc '' + Options appended to the PHP configuration file {file}`php.ini`. ''; }; @@ -216,7 +216,7 @@ in { }; } }''; - description = '' + description = lib.mdDoc '' PHP-FPM pools. If no pools are defined, the PHP-FPM service is disabled. ''; diff --git a/nixos/modules/services/web-servers/pomerium.nix b/nixos/modules/services/web-servers/pomerium.nix index 0b460755f50ef..209de55e36ef9 100644 --- a/nixos/modules/services/web-servers/pomerium.nix +++ b/nixos/modules/services/web-servers/pomerium.nix @@ -12,13 +12,13 @@ in configFile = mkOption { type = with types; nullOr path; default = null; - description = "Path to Pomerium config YAML. If set, overrides services.pomerium.settings."; + description = lib.mdDoc "Path to Pomerium config YAML. If set, overrides services.pomerium.settings."; }; useACMEHost = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' If set, use a NixOS-generated ACME certificate with the specified name. Note that this will require you to use a non-HTTP-based challenge, or @@ -32,13 +32,13 @@ in }; settings = mkOption { - description = '' + description = lib.mdDoc '' The contents of Pomerium's config.yaml, in Nix expressions. Specifying configFile will override this in its entirety. - See <link xlink:href="https://pomerium.io/reference/">the Pomerium - configuration reference</link> for more information about what to put + See [the Pomerium + configuration reference](https://pomerium.io/reference/) for more information about what to put here. ''; default = {}; @@ -48,7 +48,7 @@ in secretsFile = mkOption { type = with types; nullOr path; default = null; - description = '' + description = lib.mdDoc '' Path to file containing secrets for Pomerium, in systemd EnvironmentFile format. See the systemd.exec(5) man page. ''; diff --git a/nixos/modules/services/web-servers/tomcat.nix b/nixos/modules/services/web-servers/tomcat.nix index 877097cf37813..ec7f46e25e95a 100644 --- a/nixos/modules/services/web-servers/tomcat.nix +++ b/nixos/modules/services/web-servers/tomcat.nix @@ -26,7 +26,7 @@ in default = pkgs.tomcat9; defaultText = literalExpression "pkgs.tomcat9"; example = lib.literalExpression "pkgs.tomcat9"; - description = '' + description = lib.mdDoc '' Which tomcat package to use. ''; }; @@ -56,57 +56,57 @@ in logDirs = mkOption { default = []; type = types.listOf types.path; - description = "Directories to create in baseDir/logs/"; + description = lib.mdDoc "Directories to create in baseDir/logs/"; }; extraConfigFiles = mkOption { default = []; type = types.listOf types.path; - description = "Extra configuration files to pull into the tomcat conf directory"; + description = lib.mdDoc "Extra configuration files to pull into the tomcat conf directory"; }; extraEnvironment = mkOption { type = types.listOf types.str; default = []; example = [ "ENVIRONMENT=production" ]; - description = "Environment Variables to pass to the tomcat service"; + description = lib.mdDoc "Environment Variables to pass to the tomcat service"; }; extraGroups = mkOption { default = []; type = types.listOf types.str; example = [ "users" ]; - description = "Defines extra groups to which the tomcat user belongs."; + description = lib.mdDoc "Defines extra groups to which the tomcat user belongs."; }; user = mkOption { type = types.str; default = "tomcat"; - description = "User account under which Apache Tomcat runs."; + description = lib.mdDoc "User account under which Apache Tomcat runs."; }; group = mkOption { type = types.str; default = "tomcat"; - description = "Group account under which Apache Tomcat runs."; + description = lib.mdDoc "Group account under which Apache Tomcat runs."; }; javaOpts = mkOption { type = types.either (types.listOf types.str) types.str; default = ""; - description = "Parameters to pass to the Java Virtual Machine which spawns Apache Tomcat"; + description = lib.mdDoc "Parameters to pass to the Java Virtual Machine which spawns Apache Tomcat"; }; catalinaOpts = mkOption { type = types.either (types.listOf types.str) types.str; default = ""; - description = "Parameters to pass to the Java Virtual Machine which spawns the Catalina servlet container"; + description = lib.mdDoc "Parameters to pass to the Java Virtual Machine which spawns the Catalina servlet container"; }; sharedLibs = mkOption { type = types.listOf types.str; default = []; - description = "List containing JAR files or directories with JAR files which are libraries shared by the web applications"; + description = lib.mdDoc "List containing JAR files or directories with JAR files which are libraries shared by the web applications"; }; serverXml = mkOption { @@ -121,14 +121,14 @@ in commonLibs = mkOption { type = types.listOf types.str; default = []; - description = "List containing JAR files or directories with JAR files which are libraries shared by the web applications and the servlet container"; + description = lib.mdDoc "List containing JAR files or directories with JAR files which are libraries shared by the web applications and the servlet container"; }; webapps = mkOption { type = types.listOf types.path; default = [ tomcat.webapps ]; defaultText = literalExpression "[ config.services.tomcat.package.webapps ]"; - description = "List containing WAR files or directories with WAR files which are web applications to be deployed on Tomcat"; + description = lib.mdDoc "List containing WAR files or directories with WAR files which are web applications to be deployed on Tomcat"; }; virtualHosts = mkOption { @@ -136,16 +136,16 @@ in options = { name = mkOption { type = types.str; - description = "name of the virtualhost"; + description = lib.mdDoc "name of the virtualhost"; }; aliases = mkOption { type = types.listOf types.str; - description = "aliases of the virtualhost"; + description = lib.mdDoc "aliases of the virtualhost"; default = []; }; webapps = mkOption { type = types.listOf types.path; - description = '' + description = lib.mdDoc '' List containing web application WAR files and/or directories containing web applications and configuration files for the virtual host. ''; @@ -154,20 +154,20 @@ in }; }); default = []; - description = "List consisting of a virtual host name and a list of web applications to deploy on each virtual host"; + description = lib.mdDoc "List consisting of a virtual host name and a list of web applications to deploy on each virtual host"; }; logPerVirtualHost = mkOption { type = types.bool; default = false; - description = "Whether to enable logging per virtual host."; + description = lib.mdDoc "Whether to enable logging per virtual host."; }; jdk = mkOption { type = types.package; default = pkgs.jdk; defaultText = literalExpression "pkgs.jdk"; - description = "Which JDK to use."; + description = lib.mdDoc "Which JDK to use."; }; axis2 = { @@ -175,13 +175,13 @@ in enable = mkOption { default = false; type = types.bool; - description = "Whether to enable an Apache Axis2 container"; + description = lib.mdDoc "Whether to enable an Apache Axis2 container"; }; services = mkOption { default = []; type = types.listOf types.str; - description = "List containing AAR files or directories with AAR files which are web services to be deployed on Axis2"; + description = lib.mdDoc "List containing AAR files or directories with AAR files which are web services to be deployed on Axis2"; }; }; diff --git a/nixos/modules/services/web-servers/traefik.nix b/nixos/modules/services/web-servers/traefik.nix index eb7fd0995de08..abef963201e54 100644 --- a/nixos/modules/services/web-servers/traefik.nix +++ b/nixos/modules/services/web-servers/traefik.nix @@ -56,14 +56,14 @@ in { default = null; example = literalExpression "/path/to/static_config.toml"; type = types.nullOr types.path; - description = '' + description = lib.mdDoc '' Path to traefik's static configuration to use. - (Using that option has precedence over <literal>staticConfigOptions</literal> and <literal>dynamicConfigOptions</literal>) + (Using that option has precedence over `staticConfigOptions` and `dynamicConfigOptions`) ''; }; staticConfigOptions = mkOption { - description = '' + description = lib.mdDoc '' Static configuration for Traefik. ''; type = jsonValue; @@ -80,14 +80,14 @@ in { default = null; example = literalExpression "/path/to/dynamic_config.toml"; type = types.nullOr types.path; - description = '' + description = lib.mdDoc '' Path to traefik's dynamic configuration to use. - (Using that option has precedence over <literal>dynamicConfigOptions</literal>) + (Using that option has precedence over `dynamicConfigOptions`) ''; }; dynamicConfigOptions = mkOption { - description = '' + description = lib.mdDoc '' Dynamic configuration for Traefik. ''; type = jsonValue; @@ -106,7 +106,7 @@ in { dataDir = mkOption { default = "/var/lib/traefik"; type = types.path; - description = '' + description = lib.mdDoc '' Location for any persistent data traefik creates, ie. acme ''; }; @@ -115,9 +115,9 @@ in { default = "traefik"; type = types.str; example = "docker"; - description = '' + description = lib.mdDoc '' Set the group that traefik runs under. - For the docker backend this needs to be set to <literal>docker</literal> instead. + For the docker backend this needs to be set to `docker` instead. ''; }; @@ -125,7 +125,7 @@ in { default = pkgs.traefik; defaultText = literalExpression "pkgs.traefik"; type = types.package; - description = "Traefik package to use."; + description = lib.mdDoc "Traefik package to use."; }; }; diff --git a/nixos/modules/services/web-servers/trafficserver/default.nix b/nixos/modules/services/web-servers/trafficserver/default.nix index b52087fa038c1..beb5e437c5b11 100644 --- a/nixos/modules/services/web-servers/trafficserver/default.nix +++ b/nixos/modules/services/web-servers/trafficserver/default.nix @@ -39,11 +39,11 @@ in type = types.lines; default = ""; example = "dest_domain=example.com suffix=js action=never-cache"; - description = '' + description = lib.mdDoc '' Caching rules that overrule the origin's caching policy. - Consult the <link xlink:href="${getManualUrl "cache.config"}">upstream - documentation</link> for more details. + Consult the [upstream + documentation](${getManualUrl "cache.config"}) for more details. ''; }; @@ -51,11 +51,11 @@ in type = types.lines; default = ""; example = "domain=example.com volume=1"; - description = '' + description = lib.mdDoc '' Partition the cache according to origin server or domain - Consult the <link xlink:href="${getManualUrl "hosting.config"}"> - upstream documentation</link> for more details. + Consult the [ + upstream documentation](${getManualUrl "hosting.config"}) for more details. ''; }; @@ -73,12 +73,12 @@ in }]; } ''; - description = '' + description = lib.mdDoc '' Control client access to Traffic Server and Traffic Server connections to upstream servers. - Consult the <link xlink:href="${getManualUrl "ip_allow.yaml"}">upstream - documentation</link> for more details. + Consult the [upstream + documentation](${getManualUrl "ip_allow.yaml"}) for more details. ''; }; @@ -87,11 +87,11 @@ in default = lib.importJSON ./logging.json; defaultText = literalDocBook "upstream defaults"; example = { }; - description = '' + description = lib.mdDoc '' Configure logs. - Consult the <link xlink:href="${getManualUrl "logging.yaml"}">upstream - documentation</link> for more details. + Consult the [upstream + documentation](${getManualUrl "logging.yaml"}) for more details. ''; }; @@ -101,23 +101,23 @@ in example = '' dest_domain=. method=get parent="p1.example:8080; p2.example:8080" round_robin=true ''; - description = '' + description = lib.mdDoc '' Identify the parent proxies used in an cache hierarchy. - Consult the <link xlink:href="${getManualUrl "parent.config"}">upstream - documentation</link> for more details. + Consult the [upstream + documentation](${getManualUrl "parent.config"}) for more details. ''; }; plugins = mkOption { default = [ ]; - description = '' + description = lib.mdDoc '' Controls run-time loadable plugins available to Traffic Server, as well as their configuration. - Consult the <link xlink:href="${getManualUrl "plugin.config"}">upstream - documentation</link> for more details. + Consult the [upstream + documentation](${getManualUrl "plugin.config"}) for more details. ''; type = with types; @@ -125,7 +125,7 @@ in options.path = mkOption { type = str; example = "xdebug.so"; - description = '' + description = lib.mdDoc '' Path to plugin. The path can either be absolute, or relative to the plugin directory. ''; @@ -134,7 +134,7 @@ in type = str; default = ""; example = "--header=ATS-My-Debug"; - description = "arguments to pass to the plugin"; + description = lib.mdDoc "arguments to pass to the plugin"; }; }); }; @@ -148,11 +148,11 @@ in valueType; default = { }; example = { proxy.config.proxy_name = "my_server"; }; - description = '' + description = lib.mdDoc '' List of configurable variables used by Traffic Server. - Consult the <link xlink:href="${getManualUrl "records.config"}"> - upstream documentation</link> for more details. + Consult the [ + upstream documentation](${getManualUrl "records.config"}) for more details. ''; }; @@ -160,11 +160,11 @@ in type = types.lines; default = ""; example = "map http://from.example http://origin.example"; - description = '' + description = lib.mdDoc '' URL remapping rules used by Traffic Server. - Consult the <link xlink:href="${getManualUrl "remap.config"}"> - upstream documentation</link> for more details. + Consult the [ + upstream documentation](${getManualUrl "remap.config"}) for more details. ''; }; @@ -175,12 +175,12 @@ in dest_domain=internal.corp.example named="255.255.255.255:212 255.255.255.254" def_domain=corp.example search_list="corp.example corp1.example" dest_domain=!internal.corp.example named=255.255.255.253 ''; - description = '' + description = lib.mdDoc '' Specify the DNS server that Traffic Server should use under specific conditions. - Consult the <link xlink:href="${getManualUrl "splitdns.config"}"> - upstream documentation</link> for more details. + Consult the [ + upstream documentation](${getManualUrl "splitdns.config"}) for more details. ''; }; @@ -188,11 +188,11 @@ in type = types.lines; default = ""; example = "dest_ip=* ssl_cert_name=default.pem"; - description = '' + description = lib.mdDoc '' Configure SSL server certificates to terminate the SSL sessions. - Consult the <link xlink:href="${getManualUrl "ssl_multicert.config"}"> - upstream documentation</link> for more details. + Consult the [ + upstream documentation](${getManualUrl "ssl_multicert.config"}) for more details. ''; }; @@ -207,12 +207,12 @@ in }]; } ''; - description = '' + description = lib.mdDoc '' Configure aspects of TLS connection handling for both inbound and outbound connections. - Consult the <link xlink:href="${getManualUrl "sni.yaml"}">upstream - documentation</link> for more details. + Consult the [upstream + documentation](${getManualUrl "sni.yaml"}) for more details. ''; }; @@ -220,23 +220,23 @@ in type = types.lines; default = "/var/cache/trafficserver 256M"; example = "/dev/disk/by-id/XXXXX volume=1"; - description = '' + description = lib.mdDoc '' List all the storage that make up the Traffic Server cache. - Consult the <link xlink:href="${getManualUrl "storage.config"}"> - upstream documentation</link> for more details. + Consult the [ + upstream documentation](${getManualUrl "storage.config"}) for more details. ''; }; strategies = mkOption { type = types.nullOr yaml.type; default = null; - description = '' + description = lib.mdDoc '' Specify the next hop proxies used in an cache hierarchy and the algorithms used to select the next proxy. - Consult the <link xlink:href="${getManualUrl "strategies.yaml"}"> - upstream documentation</link> for more details. + Consult the [ + upstream documentation](${getManualUrl "strategies.yaml"}) for more details. ''; }; @@ -244,12 +244,12 @@ in type = types.nullOr yaml.type; default = ""; example = "volume=1 scheme=http size=20%"; - description = '' + description = lib.mdDoc '' Manage cache space more efficiently and restrict disk usage by creating cache volumes of different sizes. - Consult the <link xlink:href="${getManualUrl "volume.config"}"> - upstream documentation</link> for more details. + Consult the [ + upstream documentation](${getManualUrl "volume.config"}) for more details. ''; }; }; diff --git a/nixos/modules/services/web-servers/ttyd.nix b/nixos/modules/services/web-servers/ttyd.nix index 431509f7fd560..0c47d9583cda4 100644 --- a/nixos/modules/services/web-servers/ttyd.nix +++ b/nixos/modules/services/web-servers/ttyd.nix @@ -35,44 +35,44 @@ in port = mkOption { type = types.port; default = 7681; - description = "Port to listen on (use 0 for random port)"; + description = lib.mdDoc "Port to listen on (use 0 for random port)"; }; socket = mkOption { type = types.nullOr types.path; default = null; example = "/var/run/ttyd.sock"; - description = "UNIX domain socket path to bind."; + description = lib.mdDoc "UNIX domain socket path to bind."; }; interface = mkOption { type = types.nullOr types.str; default = null; example = "eth0"; - description = "Network interface to bind."; + description = lib.mdDoc "Network interface to bind."; }; username = mkOption { type = types.nullOr types.str; default = null; - description = "Username for basic authentication."; + description = lib.mdDoc "Username for basic authentication."; }; passwordFile = mkOption { type = types.nullOr types.path; default = null; apply = value: if value == null then null else toString value; - description = '' + description = lib.mdDoc '' File containing the password to use for basic authentication. For insecurely putting the password in the globally readable store use - <literal>pkgs.writeText "ttydpw" "MyPassword"</literal>. + `pkgs.writeText "ttydpw" "MyPassword"`. ''; }; signal = mkOption { type = types.ints.u8; default = 1; - description = "Signal to send to the command on session close."; + description = lib.mdDoc "Signal to send to the command on session close."; }; clientOptions = mkOption { @@ -83,75 +83,75 @@ in fontFamily = "Fira Code"; }''; - description = '' + description = lib.mdDoc '' Attribute set of client options for xtermjs. - <link xlink:href="https://xtermjs.org/docs/api/terminal/interfaces/iterminaloptions/"/> + <https://xtermjs.org/docs/api/terminal/interfaces/iterminaloptions/> ''; }; terminalType = mkOption { type = types.str; default = "xterm-256color"; - description = "Terminal type to report."; + description = lib.mdDoc "Terminal type to report."; }; checkOrigin = mkOption { type = types.bool; default = false; - description = "Whether to allow a websocket connection from a different origin."; + description = lib.mdDoc "Whether to allow a websocket connection from a different origin."; }; maxClients = mkOption { type = types.int; default = 0; - description = "Maximum clients to support (0, no limit)"; + description = lib.mdDoc "Maximum clients to support (0, no limit)"; }; indexFile = mkOption { type = types.nullOr types.path; default = null; - description = "Custom index.html path"; + description = lib.mdDoc "Custom index.html path"; }; enableIPv6 = mkOption { type = types.bool; default = false; - description = "Whether or not to enable IPv6 support."; + description = lib.mdDoc "Whether or not to enable IPv6 support."; }; enableSSL = mkOption { type = types.bool; default = false; - description = "Whether or not to enable SSL (https) support."; + description = lib.mdDoc "Whether or not to enable SSL (https) support."; }; certFile = mkOption { type = types.nullOr types.path; default = null; - description = "SSL certificate file path."; + description = lib.mdDoc "SSL certificate file path."; }; keyFile = mkOption { type = types.nullOr types.path; default = null; apply = value: if value == null then null else toString value; - description = '' + description = lib.mdDoc '' SSL key file path. For insecurely putting the keyFile in the globally readable store use - <literal>pkgs.writeText "ttydKeyFile" "SSLKEY"</literal>. + `pkgs.writeText "ttydKeyFile" "SSLKEY"`. ''; }; caFile = mkOption { type = types.nullOr types.path; default = null; - description = "SSL CA file path for client certificate verification."; + description = lib.mdDoc "SSL CA file path for client certificate verification."; }; logLevel = mkOption { type = types.int; default = 7; - description = "Set log level."; + description = lib.mdDoc "Set log level."; }; }; }; diff --git a/nixos/modules/services/web-servers/unit/default.nix b/nixos/modules/services/web-servers/unit/default.nix index b2eecdbb53eec..5ad4a240bec25 100644 --- a/nixos/modules/services/web-servers/unit/default.nix +++ b/nixos/modules/services/web-servers/unit/default.nix @@ -15,27 +15,27 @@ in { type = types.package; default = pkgs.unit; defaultText = literalExpression "pkgs.unit"; - description = "Unit package to use."; + description = lib.mdDoc "Unit package to use."; }; user = mkOption { type = types.str; default = "unit"; - description = "User account under which unit runs."; + description = lib.mdDoc "User account under which unit runs."; }; group = mkOption { type = types.str; default = "unit"; - description = "Group account under which unit runs."; + description = lib.mdDoc "Group account under which unit runs."; }; stateDir = mkOption { type = types.path; default = "/var/spool/unit"; - description = "Unit data directory."; + description = lib.mdDoc "Unit data directory."; }; logDir = mkOption { type = types.path; default = "/var/log/unit"; - description = "Unit log directory."; + description = lib.mdDoc "Unit log directory."; }; config = mkOption { type = types.str; @@ -75,7 +75,7 @@ in { } } ''; - description = "Unit configuration in JSON format. More details here https://unit.nginx.org/configuration"; + description = lib.mdDoc "Unit configuration in JSON format. More details here https://unit.nginx.org/configuration"; }; }; }; diff --git a/nixos/modules/services/web-servers/uwsgi.nix b/nixos/modules/services/web-servers/uwsgi.nix index 1b3474f2f521a..c76eb795a9ed6 100644 --- a/nixos/modules/services/web-servers/uwsgi.nix +++ b/nixos/modules/services/web-servers/uwsgi.nix @@ -75,13 +75,13 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Enable uWSGI"; + description = lib.mdDoc "Enable uWSGI"; }; runDir = mkOption { type = types.path; default = "/run/uwsgi"; - description = "Where uWSGI communication sockets can live"; + description = lib.mdDoc "Where uWSGI communication sockets can live"; }; package = mkOption { @@ -124,37 +124,37 @@ in { }; } ''; - description = '' - uWSGI configuration. It awaits an attribute <literal>type</literal> inside which can be either - <literal>normal</literal> or <literal>emperor</literal>. + description = lib.mdDoc '' + uWSGI configuration. It awaits an attribute `type` inside which can be either + `normal` or `emperor`. - For <literal>normal</literal> mode you can specify <literal>pythonPackages</literal> as a function - from libraries set into a list of libraries. <literal>pythonpath</literal> will be set accordingly. + For `normal` mode you can specify `pythonPackages` as a function + from libraries set into a list of libraries. `pythonpath` will be set accordingly. - For <literal>emperor</literal> mode, you should use <literal>vassals</literal> attribute + For `emperor` mode, you should use `vassals` attribute which should be either a set of names and configurations or a path to a directory. Other attributes will be used in configuration file as-is. Notice that you can redefine - <literal>plugins</literal> setting here. + `plugins` setting here. ''; }; plugins = mkOption { type = types.listOf types.str; default = []; - description = "Plugins used with uWSGI"; + description = lib.mdDoc "Plugins used with uWSGI"; }; user = mkOption { type = types.str; default = "uwsgi"; - description = "User account under which uWSGI runs."; + description = lib.mdDoc "User account under which uWSGI runs."; }; group = mkOption { type = types.str; default = "uwsgi"; - description = "Group account under which uWSGI runs."; + description = lib.mdDoc "Group account under which uWSGI runs."; }; capabilities = mkOption { diff --git a/nixos/modules/services/web-servers/varnish/default.nix b/nixos/modules/services/web-servers/varnish/default.nix index fe817313a993b..39ebe63387288 100644 --- a/nixos/modules/services/web-servers/varnish/default.nix +++ b/nixos/modules/services/web-servers/varnish/default.nix @@ -19,7 +19,7 @@ in type = types.package; default = pkgs.varnish; defaultText = literalExpression "pkgs.varnish"; - description = '' + description = lib.mdDoc '' The package to use ''; }; diff --git a/nixos/modules/services/web-servers/zope2.nix b/nixos/modules/services/web-servers/zope2.nix index 922109160228a..a80fe882f1a74 100644 --- a/nixos/modules/services/web-servers/zope2.nix +++ b/nixos/modules/services/web-servers/zope2.nix @@ -12,31 +12,31 @@ let name = mkOption { default = "${name}"; type = types.str; - description = "The name of the zope2 instance. If undefined, the name of the attribute set will be used."; + description = lib.mdDoc "The name of the zope2 instance. If undefined, the name of the attribute set will be used."; }; threads = mkOption { default = 2; type = types.int; - description = "Specify the number of threads that Zope's ZServer web server will use to service requests. "; + description = lib.mdDoc "Specify the number of threads that Zope's ZServer web server will use to service requests. "; }; http_address = mkOption { default = "localhost:8080"; type = types.str; - description = "Give a port and address for the HTTP server."; + description = lib.mdDoc "Give a port and address for the HTTP server."; }; user = mkOption { default = "zope2"; type = types.str; - description = "The name of the effective user for the Zope process."; + description = lib.mdDoc "The name of the effective user for the Zope process."; }; clientHome = mkOption { default = "/var/lib/zope2/${name}"; type = types.path; - description = "Home directory of zope2 instance."; + description = lib.mdDoc "Home directory of zope2 instance."; }; extra = mkOption { default = @@ -53,12 +53,12 @@ let </zodb_db> ''; type = types.lines; - description = "Extra zope.conf"; + description = lib.mdDoc "Extra zope.conf"; }; packages = mkOption { type = types.listOf types.package; - description = "The list of packages you want to make available to the zope2 instance."; + description = lib.mdDoc "The list of packages you want to make available to the zope2 instance."; }; }; @@ -95,7 +95,7 @@ in }; } ''; - description = "zope2 instances to be created automaticaly by the system."; + description = lib.mdDoc "zope2 instances to be created automaticaly by the system."; }; }; diff --git a/nixos/modules/services/x11/clight.nix b/nixos/modules/services/x11/clight.nix index d994a658cbaa5..8a17b7e801e54 100644 --- a/nixos/modules/services/x11/clight.nix +++ b/nixos/modules/services/x11/clight.nix @@ -31,7 +31,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable clight or not. ''; }; @@ -40,17 +40,17 @@ in { day = mkOption { type = types.int; default = 5500; - description = '' + description = lib.mdDoc '' Colour temperature to use during the day, between - <literal>1000</literal> and <literal>25000</literal> K. + `1000` and `25000` K. ''; }; night = mkOption { type = types.int; default = 3700; - description = '' + description = lib.mdDoc '' Colour temperature to use at night, between - <literal>1000</literal> and <literal>25000</literal> K. + `1000` and `25000` K. ''; }; }; @@ -62,9 +62,9 @@ in { type = with types; attrsOf (nullOr (either collectionTypes (attrsOf collectionTypes))); default = {}; example = { captures = 20; gamma_long_transition = true; ac_capture_timeouts = [ 120 300 60 ]; }; - description = '' + description = lib.mdDoc '' Additional configuration to extend clight.conf. See - <link xlink:href="https://github.com/FedeDP/Clight/blob/master/Extra/clight.conf"/> for a + <https://github.com/FedeDP/Clight/blob/master/Extra/clight.conf> for a sample configuration file. ''; }; diff --git a/nixos/modules/services/x11/desktop-managers/cde.nix b/nixos/modules/services/x11/desktop-managers/cde.nix index 6c7105729cfd4..05cf011f62c55 100644 --- a/nixos/modules/services/x11/desktop-managers/cde.nix +++ b/nixos/modules/services/x11/desktop-managers/cde.nix @@ -19,7 +19,7 @@ in { xclock bitmap xlsfonts xfd xrefresh xload xwininfo xdpyinfo xwd xwud ] ''; - description = '' + description = lib.mdDoc '' Extra packages to be installed system wide. ''; }; diff --git a/nixos/modules/services/x11/desktop-managers/cinnamon.nix b/nixos/modules/services/x11/desktop-managers/cinnamon.nix index 705dbec5e7428..d54f99c2cd5c7 100644 --- a/nixos/modules/services/x11/desktop-managers/cinnamon.nix +++ b/nixos/modules/services/x11/desktop-managers/cinnamon.nix @@ -27,7 +27,7 @@ in default = []; type = types.listOf types.package; example = literalExpression "[ pkgs.gnome.gpaste ]"; - description = '' + description = lib.mdDoc '' Additional list of packages to be added to the session search path. Useful for GSettings-conditional autostart. @@ -38,13 +38,13 @@ in extraGSettingsOverrides = mkOption { default = ""; type = types.lines; - description = "Additional gsettings overrides."; + description = lib.mdDoc "Additional gsettings overrides."; }; extraGSettingsOverridePackages = mkOption { default = []; type = types.listOf types.path; - description = "List of packages for which gsettings are overridden."; + description = lib.mdDoc "List of packages for which gsettings are overridden."; }; }; @@ -52,7 +52,7 @@ in default = []; example = literalExpression "[ pkgs.cinnamon.blueberry ]"; type = types.listOf types.package; - description = "Which packages cinnamon should exclude from the default environment"; + description = lib.mdDoc "Which packages cinnamon should exclude from the default environment"; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/enlightenment.nix b/nixos/modules/services/x11/desktop-managers/enlightenment.nix index 991616bd192d5..2de5d845d68b4 100644 --- a/nixos/modules/services/x11/desktop-managers/enlightenment.nix +++ b/nixos/modules/services/x11/desktop-managers/enlightenment.nix @@ -29,7 +29,7 @@ in services.xserver.desktopManager.enlightenment.enable = mkOption { type = types.bool; default = false; - description = "Enable the Enlightenment desktop environment."; + description = lib.mdDoc "Enable the Enlightenment desktop environment."; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/gnome.nix b/nixos/modules/services/x11/desktop-managers/gnome.nix index ff9d08ea99701..bbecd2796aee3 100644 --- a/nixos/modules/services/x11/desktop-managers/gnome.nix +++ b/nixos/modules/services/x11/desktop-managers/gnome.nix @@ -176,14 +176,14 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable GNOME desktop manager."; + description = lib.mdDoc "Enable GNOME desktop manager."; }; sessionPath = mkOption { default = []; type = types.listOf types.package; example = literalExpression "[ pkgs.gnome.gpaste ]"; - description = '' + description = lib.mdDoc '' Additional list of packages to be added to the session search path. Useful for GNOME Shell extensions or GSettings-conditional autostart. @@ -207,13 +207,13 @@ in extraGSettingsOverrides = mkOption { default = ""; type = types.lines; - description = "Additional gsettings overrides."; + description = lib.mdDoc "Additional gsettings overrides."; }; extraGSettingsOverridePackages = mkOption { default = []; type = types.listOf types.path; - description = "List of packages for which gsettings are overridden."; + description = lib.mdDoc "List of packages for which gsettings are overridden."; }; debug = mkEnableOption "gnome-session debug messages"; @@ -226,19 +226,19 @@ in options = { wmName = mkOption { type = types.strMatching "[a-zA-Z0-9_-]+"; - description = "A unique identifier for the window manager."; + description = lib.mdDoc "A unique identifier for the window manager."; example = "xmonad"; }; wmLabel = mkOption { type = types.str; - description = "The name of the window manager to show in the session chooser."; + description = lib.mdDoc "The name of the window manager to show in the session chooser."; example = "XMonad"; }; wmCommand = mkOption { type = types.str; - description = "The executable of the window manager to use."; + description = lib.mdDoc "The executable of the window manager to use."; example = literalExpression ''"''${pkgs.haskellPackages.xmonad}/bin/xmonad"''; }; @@ -246,22 +246,22 @@ in type = types.bool; default = true; example = false; - description = "Whether to enable the GNOME panel in this session."; + description = lib.mdDoc "Whether to enable the GNOME panel in this session."; }; }; }); default = []; - description = "Other GNOME Flashback sessions to enable."; + description = lib.mdDoc "Other GNOME Flashback sessions to enable."; }; panelModulePackages = mkOption { default = [ pkgs.gnome.gnome-applets ]; defaultText = literalExpression "[ pkgs.gnome.gnome-applets ]"; type = types.listOf types.path; - description = '' - Packages containing modules that should be made available to <literal>gnome-panel</literal> (usually for applets). + description = lib.mdDoc '' + Packages containing modules that should be made available to `gnome-panel` (usually for applets). - If you're packaging something to use here, please install the modules in <literal>$out/lib/gnome-panel/modules</literal>. + If you're packaging something to use here, please install the modules in `$out/lib/gnome-panel/modules`. ''; }; }; @@ -271,7 +271,7 @@ in default = []; example = literalExpression "[ pkgs.gnome.totem ]"; type = types.listOf types.package; - description = "Which packages gnome should exclude from the default environment"; + description = lib.mdDoc "Which packages gnome should exclude from the default environment"; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/kodi.nix b/nixos/modules/services/x11/desktop-managers/kodi.nix index b853c94d6fd47..43904cd00e840 100644 --- a/nixos/modules/services/x11/desktop-managers/kodi.nix +++ b/nixos/modules/services/x11/desktop-managers/kodi.nix @@ -12,7 +12,7 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable the kodi multimedia center."; + description = lib.mdDoc "Enable the kodi multimedia center."; }; package = mkOption { @@ -20,7 +20,7 @@ in default = pkgs.kodi; defaultText = literalExpression "pkgs.kodi"; example = literalExpression "pkgs.kodi.withPackages (p: with p; [ jellyfin pvr-iptvsimple vfs-sftp ])"; - description = '' + description = lib.mdDoc '' Package that should be used for Kodi. ''; }; diff --git a/nixos/modules/services/x11/desktop-managers/lumina.nix b/nixos/modules/services/x11/desktop-managers/lumina.nix index faa83b8bc54a5..7b694106bf7ee 100644 --- a/nixos/modules/services/x11/desktop-managers/lumina.nix +++ b/nixos/modules/services/x11/desktop-managers/lumina.nix @@ -19,7 +19,7 @@ in services.xserver.desktopManager.lumina.enable = mkOption { type = types.bool; default = false; - description = "Enable the Lumina desktop manager"; + description = lib.mdDoc "Enable the Lumina desktop manager"; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/lxqt.nix b/nixos/modules/services/x11/desktop-managers/lxqt.nix index 2aa9e5ab331de..b69da41c9fc9c 100644 --- a/nixos/modules/services/x11/desktop-managers/lxqt.nix +++ b/nixos/modules/services/x11/desktop-managers/lxqt.nix @@ -18,14 +18,14 @@ in services.xserver.desktopManager.lxqt.enable = mkOption { type = types.bool; default = false; - description = "Enable the LXQt desktop manager"; + description = lib.mdDoc "Enable the LXQt desktop manager"; }; environment.lxqt.excludePackages = mkOption { default = []; example = literalExpression "[ pkgs.lxqt.qterminal ]"; type = types.listOf types.package; - description = "Which LXQt packages to exclude from the default environment"; + description = lib.mdDoc "Which LXQt packages to exclude from the default environment"; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/mate.nix b/nixos/modules/services/x11/desktop-managers/mate.nix index b63510475ec5f..1ca47313adc39 100644 --- a/nixos/modules/services/x11/desktop-managers/mate.nix +++ b/nixos/modules/services/x11/desktop-managers/mate.nix @@ -16,7 +16,7 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable the MATE desktop environment"; + description = lib.mdDoc "Enable the MATE desktop environment"; }; debug = mkEnableOption "mate-session debug messages"; @@ -26,7 +26,7 @@ in default = []; example = literalExpression "[ pkgs.mate.mate-terminal pkgs.mate.pluma ]"; type = types.listOf types.package; - description = "Which MATE packages to exclude from the default environment"; + description = lib.mdDoc "Which MATE packages to exclude from the default environment"; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/pantheon.nix b/nixos/modules/services/x11/desktop-managers/pantheon.nix index d04e565f7d310..2ada36c12a469 100644 --- a/nixos/modules/services/x11/desktop-managers/pantheon.nix +++ b/nixos/modules/services/x11/desktop-managers/pantheon.nix @@ -37,14 +37,14 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable the pantheon desktop manager"; + description = lib.mdDoc "Enable the pantheon desktop manager"; }; sessionPath = mkOption { default = []; type = types.listOf types.package; example = literalExpression "[ pkgs.gnome.gpaste ]"; - description = '' + description = lib.mdDoc '' Additional list of packages to be added to the session search path. Useful for GSettings-conditional autostart. @@ -55,25 +55,25 @@ in extraWingpanelIndicators = mkOption { default = null; type = with types; nullOr (listOf package); - description = "Indicators to add to Wingpanel."; + description = lib.mdDoc "Indicators to add to Wingpanel."; }; extraSwitchboardPlugs = mkOption { default = null; type = with types; nullOr (listOf package); - description = "Plugs to add to Switchboard."; + description = lib.mdDoc "Plugs to add to Switchboard."; }; extraGSettingsOverrides = mkOption { default = ""; type = types.lines; - description = "Additional gsettings overrides."; + description = lib.mdDoc "Additional gsettings overrides."; }; extraGSettingsOverridePackages = mkOption { default = []; type = types.listOf types.path; - description = "List of packages for which gsettings are overridden."; + description = lib.mdDoc "List of packages for which gsettings are overridden."; }; debug = mkEnableOption "gnome-session debug messages"; @@ -84,7 +84,7 @@ in default = []; example = literalExpression "[ pkgs.pantheon.elementary-camera ]"; type = types.listOf types.package; - description = "Which packages pantheon should exclude from the default environment"; + description = lib.mdDoc "Which packages pantheon should exclude from the default environment"; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/phosh.nix b/nixos/modules/services/x11/desktop-managers/phosh.nix index 5efe645d8aa24..0ff5d6fd1b110 100644 --- a/nixos/modules/services/x11/desktop-managers/phosh.nix +++ b/nixos/modules/services/x11/desktop-managers/phosh.nix @@ -132,7 +132,7 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable the Phone Shell."; + description = lib.mdDoc "Enable the Phone Shell."; }; package = mkOption { @@ -140,25 +140,25 @@ in default = pkgs.phosh; defaultText = literalExpression "pkgs.phosh"; example = literalExpression "pkgs.phosh"; - description = '' + description = lib.mdDoc '' Package that should be used for Phosh. ''; }; user = mkOption { - description = "The user to run the Phosh service."; + description = lib.mdDoc "The user to run the Phosh service."; type = types.str; example = "alice"; }; group = mkOption { - description = "The group to run the Phosh service."; + description = lib.mdDoc "The group to run the Phosh service."; type = types.str; example = "users"; }; phocConfig = mkOption { - description = '' + description = lib.mdDoc '' Configurations for the Phoc compositor. ''; type = types.oneOf [ types.lines types.path phocConfigType ]; diff --git a/nixos/modules/services/x11/desktop-managers/plasma5.nix b/nixos/modules/services/x11/desktop-managers/plasma5.nix index 0d17d136798c8..0a59999231696 100644 --- a/nixos/modules/services/x11/desktop-managers/plasma5.nix +++ b/nixos/modules/services/x11/desktop-managers/plasma5.nix @@ -157,14 +157,14 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable the Plasma 5 (KDE 5) desktop environment."; + description = lib.mdDoc "Enable the Plasma 5 (KDE 5) desktop environment."; }; phononBackend = mkOption { type = types.enum [ "gstreamer" "vlc" ]; default = "gstreamer"; example = "vlc"; - description = "Phonon audio backend to install."; + description = lib.mdDoc "Phonon audio backend to install."; }; supportDDC = mkOption { @@ -183,17 +183,17 @@ in useQtScaling = mkOption { type = types.bool; default = false; - description = "Enable HiDPI scaling in Qt."; + description = lib.mdDoc "Enable HiDPI scaling in Qt."; }; runUsingSystemd = mkOption { - description = "Use systemd to manage the Plasma session"; + description = lib.mdDoc "Use systemd to manage the Plasma session"; type = types.bool; default = false; }; excludePackages = mkOption { - description = "List of default packages to exclude from the configuration"; + description = lib.mdDoc "List of default packages to exclude from the configuration"; type = types.listOf types.package; default = []; example = literalExpression "[ pkgs.plasma5Packages.oxygen ]"; @@ -216,7 +216,7 @@ in mobile.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable support for running the Plasma Mobile shell. ''; }; @@ -224,7 +224,7 @@ in mobile.installRecommendedSoftware = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Installs software recommended for use with Plasma Mobile, but which is not strictly required for Plasma Mobile to run. ''; diff --git a/nixos/modules/services/x11/desktop-managers/retroarch.nix b/nixos/modules/services/x11/desktop-managers/retroarch.nix index d471673d45217..c5504e514915a 100644 --- a/nixos/modules/services/x11/desktop-managers/retroarch.nix +++ b/nixos/modules/services/x11/desktop-managers/retroarch.nix @@ -13,14 +13,14 @@ in { default = pkgs.retroarch; defaultText = literalExpression "pkgs.retroarch"; example = literalExpression "pkgs.retroarch-full"; - description = "RetroArch package to use."; + description = lib.mdDoc "RetroArch package to use."; }; extraArgs = mkOption { type = types.listOf types.str; default = [ ]; example = [ "--verbose" "--host" ]; - description = "Extra arguments to pass to RetroArch."; + description = lib.mdDoc "Extra arguments to pass to RetroArch."; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/surf-display.nix b/nixos/modules/services/x11/desktop-managers/surf-display.nix index 4b5a04f988ba9..7d2ad5a3f2b27 100644 --- a/nixos/modules/services/x11/desktop-managers/surf-display.nix +++ b/nixos/modules/services/x11/desktop-managers/surf-display.nix @@ -52,14 +52,14 @@ in { default = "${pkgs.surf-display}/share/surf-display/empty-page.html"; defaultText = literalExpression ''"''${pkgs.surf-display}/share/surf-display/empty-page.html"''; example = "https://www.example.com/"; - description = "Default URI to display."; + description = lib.mdDoc "Default URI to display."; }; inactivityInterval = mkOption { type = types.int; default = 300; example = 0; - description = '' + description = lib.mdDoc '' Setting for internal inactivity timer to restart surf-display if the user goes inactive/idle to get a fresh session for the next user of the kiosk. @@ -72,18 +72,18 @@ in { screensaverSettings = mkOption { type = types.separatedString " "; default = ""; - description = '' - Screensaver settings, see <literal>man 1 xset</literal> for possible options. + description = lib.mdDoc '' + Screensaver settings, see `man 1 xset` for possible options. ''; }; pointerButtonMap = mkOption { type = types.str; default = "1 0 0 4 5 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0"; - description = '' + description = lib.mdDoc '' Disable right and middle pointer device click in browser sessions while keeping scrolling wheels' functionality intact. See pointer - subcommand on <literal>man xmodmap</literal> for details. + subcommand on `man xmodmap` for details. ''; }; @@ -91,7 +91,7 @@ in { type = types.str; default = "yes"; example = "no"; - description = "Hide idle mouse pointer."; + description = lib.mdDoc "Hide idle mouse pointer."; }; extraConfig = mkOption { @@ -111,8 +111,8 @@ in { DISPLAYS['display-host-3']="www_uri=https://www.displayserver.comany.net/display-4/index.html"|res=1280x1024" DISPLAYS['display-host-local-file']="www_uri=file:///usr/share/doc/surf-display/empty-page.html" ''; - description = '' - Extra configuration options to append to <literal>/etc/default/surf-display</literal>. + description = lib.mdDoc '' + Extra configuration options to append to `/etc/default/surf-display`. ''; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/xfce.nix b/nixos/modules/services/x11/desktop-managers/xfce.nix index 3a468b550627f..eee1f63ebdccc 100644 --- a/nixos/modules/services/x11/desktop-managers/xfce.nix +++ b/nixos/modules/services/x11/desktop-managers/xfce.nix @@ -48,25 +48,25 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable the Xfce desktop environment."; + description = lib.mdDoc "Enable the Xfce desktop environment."; }; noDesktop = mkOption { type = types.bool; default = false; - description = "Don't install XFCE desktop components (xfdesktop and panel)."; + description = lib.mdDoc "Don't install XFCE desktop components (xfdesktop and panel)."; }; enableXfwm = mkOption { type = types.bool; default = true; - description = "Enable the XFWM (default) window manager."; + description = lib.mdDoc "Enable the XFWM (default) window manager."; }; enableScreensaver = mkOption { type = types.bool; default = true; - description = "Enable the XFCE screensaver."; + description = lib.mdDoc "Enable the XFCE screensaver."; }; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/xterm.nix b/nixos/modules/services/x11/desktop-managers/xterm.nix index 3424ee1b0e113..2b439effabe52 100644 --- a/nixos/modules/services/x11/desktop-managers/xterm.nix +++ b/nixos/modules/services/x11/desktop-managers/xterm.nix @@ -16,7 +16,7 @@ in type = types.bool; default = versionOlder config.system.stateVersion "19.09" && xSessionEnabled; defaultText = literalExpression ''versionOlder config.system.stateVersion "19.09" && config.services.xserver.enable;''; - description = "Enable a xterm terminal as a desktop manager."; + description = lib.mdDoc "Enable a xterm terminal as a desktop manager."; }; }; diff --git a/nixos/modules/services/x11/display-managers/default.nix b/nixos/modules/services/x11/display-managers/default.nix index a5db3dd5dd453..cc94fe7c0beff 100644 --- a/nixos/modules/services/x11/display-managers/default.nix +++ b/nixos/modules/services/x11/display-managers/default.nix @@ -154,20 +154,20 @@ in xserverBin = mkOption { type = types.path; - description = "Path to the X server used by display managers."; + description = lib.mdDoc "Path to the X server used by display managers."; }; xserverArgs = mkOption { type = types.listOf types.str; default = []; example = [ "-ac" "-logverbose" "-verbose" "-nolisten tcp" ]; - description = "List of arguments for the X server."; + description = lib.mdDoc "List of arguments for the X server."; }; setupCommands = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Shell commands executed just after the X server has started. This option is only effective for display managers for which this feature @@ -182,7 +182,7 @@ in '' xmessage "Hello World!" & ''; - description = '' + description = lib.mdDoc '' Shell commands executed just before the window or desktop manager is started. These commands are not currently sourced for Wayland sessions. ''; @@ -191,7 +191,7 @@ in hiddenUsers = mkOption { type = types.listOf types.str; default = [ "nobody" ]; - description = '' + description = lib.mdDoc '' A list of users which will not be shown in the display manager. ''; }; @@ -212,7 +212,7 @@ in ''; }); default = []; - description = '' + description = lib.mdDoc '' A list of packages containing x11 or wayland session files to be passed to the display manager. ''; }; @@ -285,7 +285,7 @@ in Taken from display manager settings or window manager settings, if either is set. ''; example = "gnome"; - description = '' + description = lib.mdDoc '' Graphical session to pre-select in the session chooser (only effective for GDM, LightDM and SDDM). On GDM, LightDM and SDDM, it will also be used as a session for auto-login. @@ -306,34 +306,34 @@ in type = types.lines; default = ""; example = "rm -f /var/log/my-display-manager.log"; - description = "Script executed before the display manager is started."; + description = lib.mdDoc "Script executed before the display manager is started."; }; execCmd = mkOption { type = types.str; example = literalExpression ''"''${pkgs.lightdm}/bin/lightdm"''; - description = "Command to start the display manager."; + description = lib.mdDoc "Command to start the display manager."; }; environment = mkOption { type = types.attrsOf types.unspecified; default = {}; - description = "Additional environment variables needed by the display manager."; + description = lib.mdDoc "Additional environment variables needed by the display manager."; }; logToFile = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether the display manager redirects the output of the - session script to <filename>~/.xsession-errors</filename>. + session script to {file}`~/.xsession-errors`. ''; }; logToJournal = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether the display manager redirects the output of the session script to the systemd journal. ''; @@ -349,15 +349,15 @@ in type = types.bool; default = config.user != null; defaultText = literalExpression "config.${options.user} != null"; - description = '' - Automatically log in as <option>autoLogin.user</option>. + description = lib.mdDoc '' + Automatically log in as {option}`autoLogin.user`. ''; }; user = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' User to be used for the automatic login. ''; }; @@ -365,7 +365,7 @@ in }); default = {}; - description = '' + description = lib.mdDoc '' Auto login configuration attrset. ''; }; diff --git a/nixos/modules/services/x11/display-managers/gdm.nix b/nixos/modules/services/x11/display-managers/gdm.nix index 45e3d84afa4af..025d572957e11 100644 --- a/nixos/modules/services/x11/display-managers/gdm.nix +++ b/nixos/modules/services/x11/display-managers/gdm.nix @@ -75,7 +75,7 @@ in autoLogin.delay = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' Seconds of inactivity after which the autologin will be performed. ''; }; @@ -83,14 +83,14 @@ in wayland = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Allow GDM to run on Wayland instead of Xserver. ''; }; autoSuspend = mkOption { default = true; - description = '' + description = lib.mdDoc '' On the GNOME Display Manager login screen, suspend the machine after inactivity. (Does not affect automatic suspend while logged in, or at lock screen.) ''; @@ -103,9 +103,9 @@ in example = { debug.enable = true; }; - description = '' + description = lib.mdDoc '' Options passed to the gdm daemon. - See <link xlink:href="https://help.gnome.org/admin/gdm/stable/configuration.html.en#daemonconfig">here</link> for supported options. + See [here](https://help.gnome.org/admin/gdm/stable/configuration.html.en#daemonconfig) for supported options. ''; }; diff --git a/nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix b/nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix index 930ee96b384d5..412bcc4091b3f 100644 --- a/nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix +++ b/nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix @@ -26,7 +26,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable enso-os-greeter as the lightdm greeter ''; }; @@ -36,7 +36,7 @@ in { type = types.package; default = pkgs.gnome.gnome-themes-extra; defaultText = literalExpression "pkgs.gnome.gnome-themes-extra"; - description = '' + description = lib.mdDoc '' The package path that contains the theme given in the name option. ''; }; @@ -44,7 +44,7 @@ in { name = mkOption { type = types.str; default = "Adwaita"; - description = '' + description = lib.mdDoc '' Name of the theme to use for the lightdm-enso-os-greeter ''; }; @@ -55,7 +55,7 @@ in { type = types.package; default = pkgs.papirus-icon-theme; defaultText = literalExpression "pkgs.papirus-icon-theme"; - description = '' + description = lib.mdDoc '' The package path that contains the icon theme given in the name option. ''; }; @@ -63,7 +63,7 @@ in { name = mkOption { type = types.str; default = "ePapirus"; - description = '' + description = lib.mdDoc '' Name of the icon theme to use for the lightdm-enso-os-greeter ''; }; @@ -74,7 +74,7 @@ in { type = types.package; default = pkgs.capitaine-cursors; defaultText = literalExpression "pkgs.capitaine-cursors"; - description = '' + description = lib.mdDoc '' The package path that contains the cursor theme given in the name option. ''; }; @@ -82,7 +82,7 @@ in { name = mkOption { type = types.str; default = "capitane-cursors"; - description = '' + description = lib.mdDoc '' Name of the cursor theme to use for the lightdm-enso-os-greeter ''; }; @@ -91,7 +91,7 @@ in { blur = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether or not to enable blur ''; }; @@ -99,7 +99,7 @@ in { brightness = mkOption { type = types.int; default = 7; - description = '' + description = lib.mdDoc '' Brightness ''; }; @@ -107,7 +107,7 @@ in { extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration that should be put in the greeter.conf configuration file ''; diff --git a/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix b/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix index debd4b568bf65..020bce8f7191f 100644 --- a/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix +++ b/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix @@ -38,7 +38,7 @@ in enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable lightdm-gtk-greeter as the lightdm greeter. ''; }; @@ -49,7 +49,7 @@ in type = types.package; default = pkgs.gnome.gnome-themes-extra; defaultText = literalExpression "pkgs.gnome.gnome-themes-extra"; - description = '' + description = lib.mdDoc '' The package path that contains the theme given in the name option. ''; }; @@ -57,7 +57,7 @@ in name = mkOption { type = types.str; default = "Adwaita"; - description = '' + description = lib.mdDoc '' Name of the theme to use for the lightdm-gtk-greeter. ''; }; @@ -70,7 +70,7 @@ in type = types.package; default = pkgs.gnome.adwaita-icon-theme; defaultText = literalExpression "pkgs.gnome.adwaita-icon-theme"; - description = '' + description = lib.mdDoc '' The package path that contains the icon theme given in the name option. ''; }; @@ -78,7 +78,7 @@ in name = mkOption { type = types.str; default = "Adwaita"; - description = '' + description = lib.mdDoc '' Name of the icon theme to use for the lightdm-gtk-greeter. ''; }; @@ -91,7 +91,7 @@ in type = types.package; default = pkgs.gnome.adwaita-icon-theme; defaultText = literalExpression "pkgs.gnome.adwaita-icon-theme"; - description = '' + description = lib.mdDoc '' The package path that contains the cursor theme given in the name option. ''; }; @@ -99,7 +99,7 @@ in name = mkOption { type = types.str; default = "Adwaita"; - description = '' + description = lib.mdDoc '' Name of the cursor theme to use for the lightdm-gtk-greeter. ''; }; @@ -107,7 +107,7 @@ in size = mkOption { type = types.int; default = 16; - description = '' + description = lib.mdDoc '' Size of the cursor theme to use for the lightdm-gtk-greeter. ''; }; @@ -117,7 +117,7 @@ in type = types.nullOr types.str; default = null; example = "%F"; - description = '' + description = lib.mdDoc '' Clock format string (as expected by strftime, e.g. "%H:%M") to use with the lightdm gtk greeter panel. @@ -129,7 +129,7 @@ in type = types.nullOr (types.listOf types.str); default = null; example = [ "~host" "~spacer" "~clock" "~spacer" "~session" "~language" "~a11y" "~power" ]; - description = '' + description = lib.mdDoc '' List of allowed indicator modules to use for the lightdm gtk greeter panel. @@ -145,7 +145,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration that should be put in the lightdm-gtk-greeter.conf configuration file. ''; diff --git a/nixos/modules/services/x11/display-managers/lightdm-greeters/mini.nix b/nixos/modules/services/x11/display-managers/lightdm-greeters/mini.nix index 16d7fdf15cf68..00a47e7814f78 100644 --- a/nixos/modules/services/x11/display-managers/lightdm-greeters/mini.nix +++ b/nixos/modules/services/x11/display-managers/lightdm-greeters/mini.nix @@ -67,7 +67,7 @@ in user = mkOption { type = types.str; default = "root"; - description = '' + description = lib.mdDoc '' The user to login as. ''; }; @@ -75,7 +75,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration that should be put in the lightdm-mini-greeter.conf configuration file. ''; diff --git a/nixos/modules/services/x11/display-managers/lightdm-greeters/pantheon.nix b/nixos/modules/services/x11/display-managers/lightdm-greeters/pantheon.nix index f18e4a914e579..10707e001e82d 100644 --- a/nixos/modules/services/x11/display-managers/lightdm-greeters/pantheon.nix +++ b/nixos/modules/services/x11/display-managers/lightdm-greeters/pantheon.nix @@ -21,7 +21,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable elementary-greeter as the lightdm greeter. ''; }; diff --git a/nixos/modules/services/x11/display-managers/lightdm-greeters/tiny.nix b/nixos/modules/services/x11/display-managers/lightdm-greeters/tiny.nix index a9ba8e6280d6c..e8f799e27295f 100644 --- a/nixos/modules/services/x11/display-managers/lightdm-greeters/tiny.nix +++ b/nixos/modules/services/x11/display-managers/lightdm-greeters/tiny.nix @@ -30,7 +30,7 @@ in user = mkOption { type = types.str; default = "Username"; - description = '' + description = lib.mdDoc '' The string to represent the user_text label. ''; }; @@ -38,7 +38,7 @@ in pass = mkOption { type = types.str; default = "Password"; - description = '' + description = lib.mdDoc '' The string to represent the pass_text label. ''; }; @@ -48,7 +48,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Section to describe style and ui. ''; }; diff --git a/nixos/modules/services/x11/display-managers/sddm.nix b/nixos/modules/services/x11/display-managers/sddm.nix index c44f24002e0b9..34239221315db 100644 --- a/nixos/modules/services/x11/display-managers/sddm.nix +++ b/nixos/modules/services/x11/display-managers/sddm.nix @@ -100,7 +100,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable sddm as the display manager. ''; }; @@ -108,7 +108,7 @@ in enableHidpi = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable automatic HiDPI mode. ''; }; @@ -122,7 +122,7 @@ in Session = "plasma.desktop"; }; }; - description = '' + description = lib.mdDoc '' Extra settings merged in and overwritting defaults in sddm.conf. ''; }; @@ -130,7 +130,7 @@ in theme = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Greeter theme to use. ''; }; @@ -138,7 +138,7 @@ in autoNumlock = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable numlock at login. ''; }; @@ -151,16 +151,16 @@ in xrandr --setprovideroutputsource modesetting NVIDIA-0 xrandr --auto ''; - description = '' + description = lib.mdDoc '' A script to execute when starting the display server. DEPRECATED, please - use <option>services.xserver.displayManager.setupCommands</option>. + use {option}`services.xserver.displayManager.setupCommands`. ''; }; stopScript = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' A script to execute when stopping the display server. ''; }; @@ -170,7 +170,7 @@ in relogin = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If true automatic login will kick in again on session exit (logout), otherwise it will only log in automatically when the display-manager is started. ''; @@ -179,7 +179,7 @@ in minimumUid = mkOption { type = types.ints.u16; default = 1000; - description = '' + description = lib.mdDoc '' Minimum user ID for auto-login user. ''; }; diff --git a/nixos/modules/services/x11/display-managers/startx.nix b/nixos/modules/services/x11/display-managers/startx.nix index a48566ae06841..f4bb7a89d03b6 100644 --- a/nixos/modules/services/x11/display-managers/startx.nix +++ b/nixos/modules/services/x11/display-managers/startx.nix @@ -17,7 +17,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the dummy "startx" pseudo-display manager, which allows users to start X manually via the "startx" command from a vt shell. The X server runs under the user's id, not as root. diff --git a/nixos/modules/services/x11/display-managers/xpra.nix b/nixos/modules/services/x11/display-managers/xpra.nix index 1566e38da0839..15b3f70d46e09 100644 --- a/nixos/modules/services/x11/display-managers/xpra.nix +++ b/nixos/modules/services/x11/display-managers/xpra.nix @@ -16,34 +16,34 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable xpra as display manager."; + description = lib.mdDoc "Whether to enable xpra as display manager."; }; bindTcp = mkOption { default = "127.0.0.1:10000"; example = "0.0.0.0:10000"; type = types.nullOr types.str; - description = "Bind xpra to TCP"; + description = lib.mdDoc "Bind xpra to TCP"; }; desktop = mkOption { type = types.nullOr types.str; default = null; example = "gnome-shell"; - description = "Start a desktop environment instead of seamless mode"; + description = lib.mdDoc "Start a desktop environment instead of seamless mode"; }; auth = mkOption { type = types.str; default = "pam"; example = "password:value=mysecret"; - description = "Authentication to use when connecting to xpra"; + description = lib.mdDoc "Authentication to use when connecting to xpra"; }; pulseaudio = mkEnableOption "pulseaudio audio streaming"; extraOptions = mkOption { - description = "Extra xpra options"; + description = lib.mdDoc "Extra xpra options"; default = []; type = types.listOf types.str; }; diff --git a/nixos/modules/services/x11/extra-layouts.nix b/nixos/modules/services/x11/extra-layouts.nix index 159bed63e137d..574657a50c82d 100644 --- a/nixos/modules/services/x11/extra-layouts.nix +++ b/nixos/modules/services/x11/extra-layouts.nix @@ -9,13 +9,13 @@ let options = { description = mkOption { type = types.str; - description = "A short description of the layout."; + description = lib.mdDoc "A short description of the layout."; }; languages = mkOption { type = types.listOf types.str; description = - '' + lib.mdDoc '' A list of languages provided by the layout. (Use ISO 639-2 codes, for example: "eng" for english) ''; @@ -24,55 +24,55 @@ let compatFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' The path to the xkb compat file. This file sets the compatibility state, used to preserve compatibility with xkb-unaware programs. - It must contain a <literal>xkb_compat "name" { ... }</literal> block. + It must contain a `xkb_compat "name" { ... }` block. ''; }; geometryFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' The path to the xkb geometry file. This (completely optional) file describes the physical layout of keyboard, which maybe be used by programs to depict it. - It must contain a <literal>xkb_geometry "name" { ... }</literal> block. + It must contain a `xkb_geometry "name" { ... }` block. ''; }; keycodesFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' The path to the xkb keycodes file. This file specifies the range and the interpretation of the raw keycodes sent by the keyboard. - It must contain a <literal>xkb_keycodes "name" { ... }</literal> block. + It must contain a `xkb_keycodes "name" { ... }` block. ''; }; symbolsFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' The path to the xkb symbols file. This is the most important file: it defines which symbol or action maps to each key and must contain a - <literal>xkb_symbols "name" { ... }</literal> block. + `xkb_symbols "name" { ... }` block. ''; }; typesFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' The path to the xkb types file. This file specifies the key types that can be associated with the various keyboard keys. - It must contain a <literal>xkb_types "name" { ... }</literal> block. + It must contain a `xkb_types "name" { ... }` block. ''; }; @@ -103,12 +103,12 @@ in }; } ''; - description = '' + description = lib.mdDoc '' Extra custom layouts that will be included in the xkb configuration. Information on how to create a new layout can be found here: - <link xlink:href="https://www.x.org/releases/current/doc/xorg-docs/input/XKB-Enhancing.html#Defining_New_Layouts"></link>. + [](https://www.x.org/releases/current/doc/xorg-docs/input/XKB-Enhancing.html#Defining_New_Layouts). For more examples see - <link xlink:href="https://wiki.archlinux.org/index.php/X_KeyBoard_extension#Basic_examples"></link> + [](https://wiki.archlinux.org/index.php/X_KeyBoard_extension#Basic_examples) ''; }; diff --git a/nixos/modules/services/x11/fractalart.nix b/nixos/modules/services/x11/fractalart.nix index 448248a58794d..f7fc1ec962287 100644 --- a/nixos/modules/services/x11/fractalart.nix +++ b/nixos/modules/services/x11/fractalart.nix @@ -8,21 +8,21 @@ in { type = types.bool; default = false; example = true; - description = "Enable FractalArt for generating colorful wallpapers on login"; + description = lib.mdDoc "Enable FractalArt for generating colorful wallpapers on login"; }; width = mkOption { type = types.nullOr types.int; default = null; example = 1920; - description = "Screen width"; + description = lib.mdDoc "Screen width"; }; height = mkOption { type = types.nullOr types.int; default = null; example = 1080; - description = "Screen height"; + description = lib.mdDoc "Screen height"; }; }; diff --git a/nixos/modules/services/x11/gdk-pixbuf.nix b/nixos/modules/services/x11/gdk-pixbuf.nix index 3fd6fed91e131..c80e2b22792aa 100644 --- a/nixos/modules/services/x11/gdk-pixbuf.nix +++ b/nixos/modules/services/x11/gdk-pixbuf.nix @@ -30,7 +30,7 @@ in services.xserver.gdk-pixbuf.modulePackages = mkOption { type = types.listOf types.package; default = [ ]; - description = "Packages providing GDK-Pixbuf modules, for cache generation."; + description = lib.mdDoc "Packages providing GDK-Pixbuf modules, for cache generation."; }; }; diff --git a/nixos/modules/services/x11/hardware/cmt.nix b/nixos/modules/services/x11/hardware/cmt.nix index 5ac824c5e4199..a44221141c3c6 100644 --- a/nixos/modules/services/x11/hardware/cmt.nix +++ b/nixos/modules/services/x11/hardware/cmt.nix @@ -15,14 +15,14 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Enable chrome multitouch input (cmt). Touchpad drivers that are configured for chromebooks."; + description = lib.mdDoc "Enable chrome multitouch input (cmt). Touchpad drivers that are configured for chromebooks."; }; models = mkOption { type = types.enum [ "atlas" "banjo" "candy" "caroline" "cave" "celes" "clapper" "cyan" "daisy" "elan" "elm" "enguarde" "eve" "expresso" "falco" "gandof" "glimmer" "gnawty" "heli" "kevin" "kip" "leon" "lulu" "orco" "pbody" "peppy" "pi" "pit" "puppy" "quawks" "rambi" "samus" "snappy" "spring" "squawks" "swanky" "winky" "wolf" "auron_paine" "auron_yuna" "daisy_skate" "nyan_big" "nyan_blaze" "veyron_jaq" "veyron_jerry" "veyron_mighty" "veyron_minnie" "veyron_speedy" ]; example = "banjo"; - description = '' + description = lib.mdDoc '' Which models to enable cmt for. Enter the Code Name for your Chromebook. - Code Name can be found at <link xlink:href="https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices" />. + Code Name can be found at <https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices>. ''; }; }; #closes services diff --git a/nixos/modules/services/x11/hardware/libinput.nix b/nixos/modules/services/x11/hardware/libinput.nix index efdb7c61dfaeb..6603498eeafab 100644 --- a/nixos/modules/services/x11/hardware/libinput.nix +++ b/nixos/modules/services/x11/hardware/libinput.nix @@ -12,8 +12,8 @@ let cfg = config.services.xserver.libinput; default = null; example = "/dev/input/event0"; description = - '' - Path for ${deviceType} device. Set to <literal>null</literal> to apply to any + lib.mdDoc '' + Path for ${deviceType} device. Set to `null` to apply to any auto-detected ${deviceType}. ''; }; @@ -23,14 +23,14 @@ let cfg = config.services.xserver.libinput; default = "adaptive"; example = "flat"; description = - '' + lib.mdDoc '' Sets the pointer acceleration profile to the given profile. - Permitted values are <literal>adaptive</literal>, <literal>flat</literal>. + Permitted values are `adaptive`, `flat`. Not all devices support this option or all profiles. If a profile is unsupported, the default profile for this is used. - <literal>flat</literal>: Pointer motion is accelerated by a constant + `flat`: Pointer motion is accelerated by a constant (device-specific) factor, depending on the current speed. - <literal>adaptive</literal>: Pointer acceleration depends on the input speed. + `adaptive`: Pointer acceleration depends on the input speed. This is the default profile for most devices. ''; }; @@ -39,7 +39,7 @@ let cfg = config.services.xserver.libinput; type = types.nullOr types.str; default = null; example = "-0.5"; - description = "Cursor acceleration (how fast speed increases from minSpeed to maxSpeed)."; + description = lib.mdDoc "Cursor acceleration (how fast speed increases from minSpeed to maxSpeed)."; }; buttonMapping = mkOption { @@ -47,7 +47,7 @@ let cfg = config.services.xserver.libinput; default = null; example = "1 6 3 4 5 0 7"; description = - '' + lib.mdDoc '' Sets the logical button mapping for this device, see XSetPointerMapping(3). The string must be a space-separated list of button mappings in the order of the logical buttons on the device, starting with button 1. The default mapping is "1 2 3 ... 32". A mapping of 0 deac‐ @@ -62,7 +62,7 @@ let cfg = config.services.xserver.libinput; default = null; example = "0.5 0 0 0 0.8 0.1 0 0 1"; description = - '' + lib.mdDoc '' A string of 9 space-separated floating point numbers. Sets the calibration matrix to the 3x3 matrix where the first row is (abc), the second row is (def) and the third row is (ghi). ''; @@ -73,9 +73,9 @@ let cfg = config.services.xserver.libinput; default = null; example = "buttonareas"; description = - '' - Enables a click method. Permitted values are <literal>none</literal>, - <literal>buttonareas</literal>, <literal>clickfinger</literal>. + lib.mdDoc '' + Enables a click method. Permitted values are `none`, + `buttonareas`, `clickfinger`. Not all devices support all methods, if an option is unsupported, the default click method for this device is used. ''; @@ -84,14 +84,14 @@ let cfg = config.services.xserver.libinput; leftHanded = mkOption { type = types.bool; default = false; - description = "Enables left-handed button orientation, i.e. swapping left and right buttons."; + description = lib.mdDoc "Enables left-handed button orientation, i.e. swapping left and right buttons."; }; middleEmulation = mkOption { type = types.bool; default = true; description = - '' + lib.mdDoc '' Enables middle button emulation. When enabled, pressing the left and right buttons simultaneously produces a middle mouse button click. ''; @@ -100,7 +100,7 @@ let cfg = config.services.xserver.libinput; naturalScrolling = mkOption { type = types.bool; default = false; - description = "Enables or disables natural scrolling behavior."; + description = lib.mdDoc "Enables or disables natural scrolling behavior."; }; scrollButton = mkOption { @@ -108,7 +108,7 @@ let cfg = config.services.xserver.libinput; default = null; example = 1; description = - '' + lib.mdDoc '' Designates a button as scroll button. If the ScrollMethod is button and the button is logically held down, x/y axis movement is converted into scroll events. ''; @@ -119,9 +119,9 @@ let cfg = config.services.xserver.libinput; default = "twofinger"; example = "edge"; description = - '' - Specify the scrolling method: <literal>twofinger</literal>, <literal>edge</literal>, - <literal>button</literal>, or <literal>none</literal> + lib.mdDoc '' + Specify the scrolling method: `twofinger`, `edge`, + `button`, or `none` ''; }; @@ -129,7 +129,7 @@ let cfg = config.services.xserver.libinput; type = types.bool; default = true; description = - '' + lib.mdDoc '' Disables horizontal scrolling. When disabled, this driver will discard any horizontal scroll events from libinput. Note that this does not disable horizontal scrolling, it merely discards the horizontal axis from any scroll events. @@ -141,9 +141,9 @@ let cfg = config.services.xserver.libinput; default = "enabled"; example = "disabled"; description = - '' - Sets the send events mode to <literal>disabled</literal>, <literal>enabled</literal>, - or <literal>disabled-on-external-mouse</literal> + lib.mdDoc '' + Sets the send events mode to `disabled`, `enabled`, + or `disabled-on-external-mouse` ''; }; @@ -151,7 +151,7 @@ let cfg = config.services.xserver.libinput; type = types.bool; default = true; description = - '' + lib.mdDoc '' Enables or disables tap-to-click behavior. ''; }; @@ -160,7 +160,7 @@ let cfg = config.services.xserver.libinput; type = types.bool; default = true; description = - '' + lib.mdDoc '' Enables or disables drag lock during tapping behavior. When enabled, a finger up during tap- and-drag will not immediately release the button. If the finger is set down again within the timeout, the draging process continues. @@ -171,7 +171,7 @@ let cfg = config.services.xserver.libinput; type = types.nullOr types.str; default = null; example = "0.5 0 0 0 0.8 0.1 0 0 1"; - description = '' + description = lib.mdDoc '' A string of 9 space-separated floating point numbers. Sets the transformation matrix to the 3x3 matrix where the first row is (abc), the second row is (def) and the third row is (ghi). ''; @@ -181,7 +181,7 @@ let cfg = config.services.xserver.libinput; type = types.bool; default = false; description = - '' + lib.mdDoc '' Disable input method while typing. ''; }; @@ -193,9 +193,9 @@ let cfg = config.services.xserver.libinput; '' Option "DragLockButtons" "L1 B1 L2 B2" ''; - description = '' + description = lib.mdDoc '' Additional options for libinput ${deviceType} driver. See - <citerefentry><refentrytitle>libinput</refentrytitle><manvolnum>4</manvolnum></citerefentry> + {manpage}`libinput(4)` for available options."; ''; }; diff --git a/nixos/modules/services/x11/hardware/synaptics.nix b/nixos/modules/services/x11/hardware/synaptics.nix index 93dd560bca407..7b45222ac64c3 100644 --- a/nixos/modules/services/x11/hardware/synaptics.nix +++ b/nixos/modules/services/x11/hardware/synaptics.nix @@ -30,7 +30,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable touchpad support. Deprecated: Consider services.xserver.libinput.enable."; + description = lib.mdDoc "Whether to enable touchpad support. Deprecated: Consider services.xserver.libinput.enable."; }; dev = mkOption { @@ -38,7 +38,7 @@ in { default = null; example = "/dev/input/event0"; description = - '' + lib.mdDoc '' Path for touchpad device. Set to null to apply to any auto-detected touchpad. ''; @@ -47,73 +47,73 @@ in { accelFactor = mkOption { type = types.nullOr types.str; default = "0.001"; - description = "Cursor acceleration (how fast speed increases from minSpeed to maxSpeed)."; + description = lib.mdDoc "Cursor acceleration (how fast speed increases from minSpeed to maxSpeed)."; }; minSpeed = mkOption { type = types.nullOr types.str; default = "0.6"; - description = "Cursor speed factor for precision finger motion."; + description = lib.mdDoc "Cursor speed factor for precision finger motion."; }; maxSpeed = mkOption { type = types.nullOr types.str; default = "1.0"; - description = "Cursor speed factor for highest-speed finger motion."; + description = lib.mdDoc "Cursor speed factor for highest-speed finger motion."; }; scrollDelta = mkOption { type = types.nullOr types.int; default = null; example = 75; - description = "Move distance of the finger for a scroll event."; + description = lib.mdDoc "Move distance of the finger for a scroll event."; }; twoFingerScroll = mkOption { type = types.bool; default = false; - description = "Whether to enable two-finger drag-scrolling. Overridden by horizTwoFingerScroll and vertTwoFingerScroll."; + description = lib.mdDoc "Whether to enable two-finger drag-scrolling. Overridden by horizTwoFingerScroll and vertTwoFingerScroll."; }; horizTwoFingerScroll = mkOption { type = types.bool; default = cfg.twoFingerScroll; defaultText = literalExpression "config.${opt.twoFingerScroll}"; - description = "Whether to enable horizontal two-finger drag-scrolling."; + description = lib.mdDoc "Whether to enable horizontal two-finger drag-scrolling."; }; vertTwoFingerScroll = mkOption { type = types.bool; default = cfg.twoFingerScroll; defaultText = literalExpression "config.${opt.twoFingerScroll}"; - description = "Whether to enable vertical two-finger drag-scrolling."; + description = lib.mdDoc "Whether to enable vertical two-finger drag-scrolling."; }; horizEdgeScroll = mkOption { type = types.bool; default = ! cfg.horizTwoFingerScroll; defaultText = literalExpression "! config.${opt.horizTwoFingerScroll}"; - description = "Whether to enable horizontal edge drag-scrolling."; + description = lib.mdDoc "Whether to enable horizontal edge drag-scrolling."; }; vertEdgeScroll = mkOption { type = types.bool; default = ! cfg.vertTwoFingerScroll; defaultText = literalExpression "! config.${opt.vertTwoFingerScroll}"; - description = "Whether to enable vertical edge drag-scrolling."; + description = lib.mdDoc "Whether to enable vertical edge drag-scrolling."; }; tapButtons = mkOption { type = types.bool; default = true; - description = "Whether to enable tap buttons."; + description = lib.mdDoc "Whether to enable tap buttons."; }; buttonsMap = mkOption { type = types.listOf types.int; default = [1 2 3]; example = [1 3 2]; - description = "Remap touchpad buttons."; + description = lib.mdDoc "Remap touchpad buttons."; apply = map toString; }; @@ -121,34 +121,34 @@ in { type = types.listOf types.int; default = [1 2 3]; example = [1 3 2]; - description = "Remap several-fingers taps."; + description = lib.mdDoc "Remap several-fingers taps."; apply = map toString; }; palmDetect = mkOption { type = types.bool; default = false; - description = "Whether to enable palm detection (hardware support required)"; + description = lib.mdDoc "Whether to enable palm detection (hardware support required)"; }; palmMinWidth = mkOption { type = types.nullOr types.int; default = null; example = 5; - description = "Minimum finger width at which touch is considered a palm"; + description = lib.mdDoc "Minimum finger width at which touch is considered a palm"; }; palmMinZ = mkOption { type = types.nullOr types.int; default = null; example = 20; - description = "Minimum finger pressure at which touch is considered a palm"; + description = lib.mdDoc "Minimum finger pressure at which touch is considered a palm"; }; horizontalScroll = mkOption { type = types.bool; default = true; - description = "Whether to enable horizontal scrolling (on touchpad)"; + description = lib.mdDoc "Whether to enable horizontal scrolling (on touchpad)"; }; additionalOptions = mkOption { @@ -158,7 +158,7 @@ in { Option "RTCornerButton" "2" Option "RBCornerButton" "3" ''; - description = '' + description = lib.mdDoc '' Additional options for synaptics touchpad driver. ''; }; diff --git a/nixos/modules/services/x11/hardware/wacom.nix b/nixos/modules/services/x11/hardware/wacom.nix index dad2b308d1b49..4994e5c1a2cc7 100644 --- a/nixos/modules/services/x11/hardware/wacom.nix +++ b/nixos/modules/services/x11/hardware/wacom.nix @@ -17,13 +17,13 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the Wacom touchscreen/digitizer/tablet. If you ever have any issues such as, try switching to terminal (ctrl-alt-F1) and back which will make Xorg reconfigure the device ? If you're not satisfied by the default behaviour you can override - <option>environment.etc."X11/xorg.conf.d/70-wacom.conf"</option> in + {option}`environment.etc."X11/xorg.conf.d/70-wacom.conf"` in configuration.nix easily. ''; }; diff --git a/nixos/modules/services/x11/imwheel.nix b/nixos/modules/services/x11/imwheel.nix index ae990141a5029..9f4fc7e90c442 100644 --- a/nixos/modules/services/x11/imwheel.nix +++ b/nixos/modules/services/x11/imwheel.nix @@ -12,9 +12,9 @@ in type = types.listOf types.str; default = [ "--buttons=45" ]; example = [ "--debug" ]; - description = '' + description = lib.mdDoc '' Additional command-line arguments to pass to - <command>imwheel</command>. + {command}`imwheel`. ''; }; @@ -33,11 +33,11 @@ in '''; } ''; - description = '' + description = lib.mdDoc '' Window class translation rules. /etc/X11/imwheelrc is generated based on this config which means this config is global for all users. - See <link xlink:href="http://imwheel.sourceforge.net/imwheel.1.html">offical man pages</link> + See [offical man pages](http://imwheel.sourceforge.net/imwheel.1.html) for more informations. ''; }; diff --git a/nixos/modules/services/x11/picom.nix b/nixos/modules/services/x11/picom.nix index 2eef71f71fcbf..99bde5e1f0ce7 100644 --- a/nixos/modules/services/x11/picom.nix +++ b/nixos/modules/services/x11/picom.nix @@ -62,7 +62,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether or not to enable Picom as the X.org composite manager. ''; }; @@ -70,7 +70,7 @@ in { experimentalBackends = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to use the unstable new reimplementation of the backends. ''; }; @@ -78,7 +78,7 @@ in { fade = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Fade windows in and out. ''; }; @@ -87,7 +87,7 @@ in { type = types.ints.positive; default = 10; example = 5; - description = '' + description = lib.mdDoc '' Time between fade animation step (in ms). ''; }; @@ -96,7 +96,7 @@ in { type = pairOf (floatBetween 0.01 1); default = [ 0.028 0.03 ]; example = [ 0.04 0.04 ]; - description = '' + description = lib.mdDoc '' Opacity change between fade steps (in and out). ''; }; @@ -109,16 +109,16 @@ in { "name ~= 'Firefox$'" "focused = 1" ]; - description = '' + description = lib.mdDoc '' List of conditions of windows that should not be faded. - See <literal>picom(1)</literal> man page for more examples. + See `picom(1)` man page for more examples. ''; }; shadow = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Draw window shadows. ''; }; @@ -127,7 +127,7 @@ in { type = pairOf types.int; default = [ (-15) (-15) ]; example = [ (-10) (-15) ]; - description = '' + description = lib.mdDoc '' Left and right offset for shadows (in pixels). ''; }; @@ -136,7 +136,7 @@ in { type = floatBetween 0 1; default = 0.75; example = 0.8; - description = '' + description = lib.mdDoc '' Window shadows opacity. ''; }; @@ -149,9 +149,9 @@ in { "name ~= 'Firefox$'" "focused = 1" ]; - description = '' + description = lib.mdDoc '' List of conditions of windows that should have no shadow. - See <literal>picom(1)</literal> man page for more examples. + See `picom(1)` man page for more examples. ''; }; @@ -159,7 +159,7 @@ in { type = floatBetween 0 1; default = 1.0; example = 0.8; - description = '' + description = lib.mdDoc '' Opacity of active windows. ''; }; @@ -168,7 +168,7 @@ in { type = floatBetween 0.1 1; default = 1.0; example = 0.8; - description = '' + description = lib.mdDoc '' Opacity of inactive windows. ''; }; @@ -177,7 +177,7 @@ in { type = floatBetween 0 1; default = 1.0; example = 0.8; - description = '' + description = lib.mdDoc '' Opacity of dropdown and popup menu. ''; }; @@ -195,7 +195,7 @@ in { } ''; example = {}; - description = '' + description = lib.mdDoc '' Rules for specific window types. ''; }; @@ -207,7 +207,7 @@ in { "95:class_g = 'URxvt' && !_NET_WM_STATE@:32a" "0:_NET_WM_STATE@:32a *= '_NET_WM_STATE_HIDDEN'" ]; - description = '' + description = lib.mdDoc '' Rules that control the opacity of windows, in format PERCENT:PATTERN. ''; }; @@ -215,8 +215,8 @@ in { backend = mkOption { type = types.enum [ "glx" "xrender" "xr_glx_hybrid" ]; default = "xrender"; - description = '' - Backend to use: <literal>glx</literal>, <literal>xrender</literal> or <literal>xr_glx_hybrid</literal>. + description = lib.mdDoc '' + Backend to use: `glx`, `xrender` or `xr_glx_hybrid`. ''; }; @@ -233,7 +233,7 @@ in { if isBool x then x else warn msg res; - description = '' + description = lib.mdDoc '' Enable vertical synchronization. Chooses the best method (drm, opengl, opengl-oml, opengl-swc, opengl-mswc) automatically. The bool value should be used, the others are just for backwards compatibility. @@ -267,10 +267,10 @@ in { deviation = 5.0; }; ''; - description = '' + description = lib.mdDoc '' Picom settings. Use this option to configure Picom settings not exposed in a NixOS option or to bypass one. For the available options see the - CONFIGURATION FILES section at <literal>picom(1)</literal>. + CONFIGURATION FILES section at `picom(1)`. ''; }; }; diff --git a/nixos/modules/services/x11/redshift.nix b/nixos/modules/services/x11/redshift.nix index cc9f964754f35..3eb9e28edae91 100644 --- a/nixos/modules/services/x11/redshift.nix +++ b/nixos/modules/services/x11/redshift.nix @@ -29,7 +29,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable Redshift to change your screen's colour temperature depending on the time of day. ''; @@ -39,17 +39,17 @@ in { day = mkOption { type = types.int; default = 5500; - description = '' + description = lib.mdDoc '' Colour temperature to use during the day, between - <literal>1000</literal> and <literal>25000</literal> K. + `1000` and `25000` K. ''; }; night = mkOption { type = types.int; default = 3700; - description = '' + description = lib.mdDoc '' Colour temperature to use at night, between - <literal>1000</literal> and <literal>25000</literal> K. + `1000` and `25000` K. ''; }; }; @@ -58,17 +58,17 @@ in { day = mkOption { type = types.str; default = "1"; - description = '' + description = lib.mdDoc '' Screen brightness to apply during the day, - between <literal>0.1</literal> and <literal>1.0</literal>. + between `0.1` and `1.0`. ''; }; night = mkOption { type = types.str; default = "1"; - description = '' + description = lib.mdDoc '' Screen brightness to apply during the night, - between <literal>0.1</literal> and <literal>1.0</literal>. + between `0.1` and `1.0`. ''; }; }; @@ -77,7 +77,7 @@ in { type = types.package; default = pkgs.redshift; defaultText = literalExpression "pkgs.redshift"; - description = '' + description = lib.mdDoc '' redshift derivation to use. ''; }; @@ -86,7 +86,7 @@ in { type = types.str; default = "/bin/redshift"; example = "/bin/redshift-gtk"; - description = '' + description = lib.mdDoc '' Redshift executable to use within the package. ''; }; @@ -95,9 +95,9 @@ in { type = types.listOf types.str; default = []; example = [ "-v" "-m randr" ]; - description = '' + description = lib.mdDoc '' Additional command-line arguments to pass to - <command>redshift</command>. + {command}`redshift`. ''; }; }; diff --git a/nixos/modules/services/x11/touchegg.nix b/nixos/modules/services/x11/touchegg.nix index 9d3678e7696df..905e8521cf77a 100644 --- a/nixos/modules/services/x11/touchegg.nix +++ b/nixos/modules/services/x11/touchegg.nix @@ -17,7 +17,7 @@ in { type = types.package; default = pkgs.touchegg; defaultText = literalExpression "pkgs.touchegg"; - description = "touchegg derivation to use."; + description = lib.mdDoc "touchegg derivation to use."; }; }; diff --git a/nixos/modules/services/x11/unclutter-xfixes.nix b/nixos/modules/services/x11/unclutter-xfixes.nix index 0b4d06f640d24..4a35176c58336 100644 --- a/nixos/modules/services/x11/unclutter-xfixes.nix +++ b/nixos/modules/services/x11/unclutter-xfixes.nix @@ -8,32 +8,32 @@ in { options.services.unclutter-xfixes = { enable = mkOption { - description = "Enable unclutter-xfixes to hide your mouse cursor when inactive."; + description = lib.mdDoc "Enable unclutter-xfixes to hide your mouse cursor when inactive."; type = types.bool; default = false; }; package = mkOption { - description = "unclutter-xfixes derivation to use."; + description = lib.mdDoc "unclutter-xfixes derivation to use."; type = types.package; default = pkgs.unclutter-xfixes; defaultText = literalExpression "pkgs.unclutter-xfixes"; }; timeout = mkOption { - description = "Number of seconds before the cursor is marked inactive."; + description = lib.mdDoc "Number of seconds before the cursor is marked inactive."; type = types.int; default = 1; }; threshold = mkOption { - description = "Minimum number of pixels considered cursor movement."; + description = lib.mdDoc "Minimum number of pixels considered cursor movement."; type = types.int; default = 1; }; extraOptions = mkOption { - description = "More arguments to pass to the unclutter-xfixes command."; + description = lib.mdDoc "More arguments to pass to the unclutter-xfixes command."; type = types.listOf types.str; default = []; example = [ "exclude-root" "ignore-scrolling" "fork" ]; diff --git a/nixos/modules/services/x11/unclutter.nix b/nixos/modules/services/x11/unclutter.nix index bdb5fa7b50cd7..039214a575a71 100644 --- a/nixos/modules/services/x11/unclutter.nix +++ b/nixos/modules/services/x11/unclutter.nix @@ -8,7 +8,7 @@ in { options.services.unclutter = { enable = mkOption { - description = "Enable unclutter to hide your mouse cursor when inactive"; + description = lib.mdDoc "Enable unclutter to hide your mouse cursor when inactive"; type = types.bool; default = false; }; @@ -17,36 +17,36 @@ in { type = types.package; default = pkgs.unclutter; defaultText = literalExpression "pkgs.unclutter"; - description = "unclutter derivation to use."; + description = lib.mdDoc "unclutter derivation to use."; }; keystroke = mkOption { - description = "Wait for a keystroke before hiding the cursor"; + description = lib.mdDoc "Wait for a keystroke before hiding the cursor"; type = types.bool; default = false; }; timeout = mkOption { - description = "Number of seconds before the cursor is marked inactive"; + description = lib.mdDoc "Number of seconds before the cursor is marked inactive"; type = types.int; default = 1; }; threshold = mkOption { - description = "Minimum number of pixels considered cursor movement"; + description = lib.mdDoc "Minimum number of pixels considered cursor movement"; type = types.int; default = 1; }; excluded = mkOption { - description = "Names of windows where unclutter should not apply"; + description = lib.mdDoc "Names of windows where unclutter should not apply"; type = types.listOf types.str; default = []; example = [ "" ]; }; extraOptions = mkOption { - description = "More arguments to pass to the unclutter command"; + description = lib.mdDoc "More arguments to pass to the unclutter command"; type = types.listOf types.str; default = []; example = [ "noevent" "grab" ]; diff --git a/nixos/modules/services/x11/urxvtd.nix b/nixos/modules/services/x11/urxvtd.nix index 0a0df447f4e16..fedcb6c7293ef 100644 --- a/nixos/modules/services/x11/urxvtd.nix +++ b/nixos/modules/services/x11/urxvtd.nix @@ -11,7 +11,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable urxvtd, the urxvt terminal daemon. To use urxvtd, run "urxvtc". ''; @@ -20,7 +20,7 @@ in { package = mkOption { default = pkgs.rxvt-unicode; defaultText = literalExpression "pkgs.rxvt-unicode"; - description = '' + description = lib.mdDoc '' Package to install. Usually pkgs.rxvt-unicode. ''; type = types.package; diff --git a/nixos/modules/services/x11/window-managers/awesome.nix b/nixos/modules/services/x11/window-managers/awesome.nix index c6c0c934f9aeb..8db7d86c72c6b 100644 --- a/nixos/modules/services/x11/window-managers/awesome.nix +++ b/nixos/modules/services/x11/window-managers/awesome.nix @@ -26,21 +26,21 @@ in luaModules = mkOption { default = []; type = types.listOf types.package; - description = "List of lua packages available for being used in the Awesome configuration."; + description = lib.mdDoc "List of lua packages available for being used in the Awesome configuration."; example = literalExpression "[ pkgs.luaPackages.vicious ]"; }; package = mkOption { default = null; type = types.nullOr types.package; - description = "Package to use for running the Awesome WM."; + description = lib.mdDoc "Package to use for running the Awesome WM."; apply = pkg: if pkg == null then pkgs.awesome else pkg; }; noArgb = mkOption { default = false; type = types.bool; - description = "Disable client transparency support, which can be greatly detrimental to performance in some setups"; + description = lib.mdDoc "Disable client transparency support, which can be greatly detrimental to performance in some setups"; }; }; diff --git a/nixos/modules/services/x11/window-managers/bspwm.nix b/nixos/modules/services/x11/window-managers/bspwm.nix index ade24061a069a..4fcd2b7c720d3 100644 --- a/nixos/modules/services/x11/window-managers/bspwm.nix +++ b/nixos/modules/services/x11/window-managers/bspwm.nix @@ -16,7 +16,7 @@ in default = pkgs.bspwm; defaultText = literalExpression "pkgs.bspwm"; example = literalExpression "pkgs.bspwm-unstable"; - description = '' + description = lib.mdDoc '' bspwm package to use. ''; }; @@ -24,7 +24,7 @@ in type = with types; nullOr path; example = literalExpression ''"''${pkgs.bspwm}/share/doc/bspwm/examples/bspwmrc"''; default = null; - description = '' + description = lib.mdDoc '' Path to the bspwm configuration file. If null, $HOME/.config/bspwm/bspwmrc will be used. ''; @@ -36,7 +36,7 @@ in default = pkgs.sxhkd; defaultText = literalExpression "pkgs.sxhkd"; example = literalExpression "pkgs.sxhkd-unstable"; - description = '' + description = lib.mdDoc '' sxhkd package to use. ''; }; @@ -44,7 +44,7 @@ in type = with types; nullOr path; example = literalExpression ''"''${pkgs.bspwm}/share/doc/bspwm/examples/sxhkdrc"''; default = null; - description = '' + description = lib.mdDoc '' Path to the sxhkd configuration file. If null, $HOME/.config/sxhkd/sxhkdrc will be used. ''; diff --git a/nixos/modules/services/x11/window-managers/clfswm.nix b/nixos/modules/services/x11/window-managers/clfswm.nix index 78772c799744e..cf8eec249c6c4 100644 --- a/nixos/modules/services/x11/window-managers/clfswm.nix +++ b/nixos/modules/services/x11/window-managers/clfswm.nix @@ -14,7 +14,7 @@ in type = types.package; default = pkgs.lispPackages.clfswm; defaultText = literalExpression "pkgs.lispPackages.clfswm"; - description = '' + description = lib.mdDoc '' clfswm package to use. ''; }; diff --git a/nixos/modules/services/x11/window-managers/exwm.nix b/nixos/modules/services/x11/window-managers/exwm.nix index b505f720f04c3..5b0a15804ef2d 100644 --- a/nixos/modules/services/x11/window-managers/exwm.nix +++ b/nixos/modules/services/x11/window-managers/exwm.nix @@ -26,7 +26,7 @@ in (require 'exwm) (exwm-enable) ''; - description = '' + description = lib.mdDoc '' Emacs lisp code to be run after loading the user's init file. If enableDefaultConfig is true, this will be run before loading the default config. @@ -35,7 +35,7 @@ in enableDefaultConfig = mkOption { default = true; type = lib.types.bool; - description = "Enable an uncustomised exwm configuration."; + description = lib.mdDoc "Enable an uncustomised exwm configuration."; }; extraPackages = mkOption { type = types.functionTo (types.listOf types.package); diff --git a/nixos/modules/services/x11/window-managers/herbstluftwm.nix b/nixos/modules/services/x11/window-managers/herbstluftwm.nix index 354d70c695cb5..af077c4d22892 100644 --- a/nixos/modules/services/x11/window-managers/herbstluftwm.nix +++ b/nixos/modules/services/x11/window-managers/herbstluftwm.nix @@ -15,7 +15,7 @@ in type = types.package; default = pkgs.herbstluftwm; defaultText = literalExpression "pkgs.herbstluftwm"; - description = '' + description = lib.mdDoc '' Herbstluftwm package to use. ''; }; @@ -23,7 +23,7 @@ in configFile = mkOption { default = null; type = with types; nullOr path; - description = '' + description = lib.mdDoc '' Path to the herbstluftwm configuration file. If left at the default value, $XDG_CONFIG_HOME/herbstluftwm/autostart will be used. diff --git a/nixos/modules/services/x11/window-managers/i3.nix b/nixos/modules/services/x11/window-managers/i3.nix index 99f9997024fe3..87479f2ac4524 100644 --- a/nixos/modules/services/x11/window-managers/i3.nix +++ b/nixos/modules/services/x11/window-managers/i3.nix @@ -13,7 +13,7 @@ in configFile = mkOption { default = null; type = with types; nullOr path; - description = '' + description = lib.mdDoc '' Path to the i3 configuration file. If left at the default value, $HOME/.i3/config will be used. ''; @@ -22,7 +22,7 @@ in extraSessionCommands = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Shell commands executed just before i3 is started. ''; }; @@ -32,7 +32,7 @@ in default = pkgs.i3; defaultText = literalExpression "pkgs.i3"; example = literalExpression "pkgs.i3-gaps"; - description = '' + description = lib.mdDoc '' i3 package to use. ''; }; @@ -47,7 +47,7 @@ in i3lock ] ''; - description = '' + description = lib.mdDoc '' Extra packages to be installed system wide. ''; }; diff --git a/nixos/modules/services/x11/window-managers/mlvwm.nix b/nixos/modules/services/x11/window-managers/mlvwm.nix index 08dd04020296d..0ee1d7b097eaf 100644 --- a/nixos/modules/services/x11/window-managers/mlvwm.nix +++ b/nixos/modules/services/x11/window-managers/mlvwm.nix @@ -13,7 +13,7 @@ in configFile = mkOption { default = null; type = with types; nullOr path; - description = '' + description = lib.mdDoc '' Path to the mlvwm configuration file. If left at the default value, $HOME/.mlvwmrc will be used. ''; diff --git a/nixos/modules/services/x11/window-managers/wmderland.nix b/nixos/modules/services/x11/window-managers/wmderland.nix index 56b6922096517..835c1b3028170 100644 --- a/nixos/modules/services/x11/window-managers/wmderland.nix +++ b/nixos/modules/services/x11/window-managers/wmderland.nix @@ -13,7 +13,7 @@ in extraSessionCommands = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Shell commands executed just before wmderland is started. ''; }; @@ -38,7 +38,7 @@ in rxvt-unicode ] ''; - description = '' + description = lib.mdDoc '' Extra packages to be installed system wide. ''; }; diff --git a/nixos/modules/services/x11/window-managers/xmonad.nix b/nixos/modules/services/x11/window-managers/xmonad.nix index 66d11131391f5..476621bad778c 100644 --- a/nixos/modules/services/x11/window-managers/xmonad.nix +++ b/nixos/modules/services/x11/window-managers/xmonad.nix @@ -76,13 +76,13 @@ in { enableContribAndExtras = mkOption { default = false; type = lib.types.bool; - description = "Enable xmonad-{contrib,extras} in Xmonad."; + description = lib.mdDoc "Enable xmonad-{contrib,extras} in Xmonad."; }; config = mkOption { default = null; type = with lib.types; nullOr (either path str); - description = '' + description = lib.mdDoc '' Configuration from which XMonad gets compiled. If no value is specified, a vanilla xmonad binary is put in PATH, which will attempt to recompile and exec your xmonad config from $HOME/.xmonad. @@ -94,17 +94,17 @@ in { "mod+q" restart key binding dysfunctional though, because that attempts to call your binary with the "--restart" command line option, unless you implement that yourself. You way mant to bind "mod+q" to - <literal>(restart "xmonad" True)</literal> instead, which will just restart + `(restart "xmonad" True)` instead, which will just restart xmonad from PATH. This allows e.g. switching to the new xmonad binary after rebuilding your system with nixos-rebuild. For the same reason, ghc is not added to the environment when this - option is set, unless <option>enableConfiguredRecompile</option> is - set to <literal>true</literal>. + option is set, unless {option}`enableConfiguredRecompile` is + set to `true`. If you actually want to run xmonad with a config specified here, but also be able to recompile and restart it from a copy of that source in - $HOME/.xmonad on the fly, set <option>enableConfiguredRecompile</option> - to <literal>true</literal> and implement something like "compileRestart" + $HOME/.xmonad on the fly, set {option}`enableConfiguredRecompile` + to `true` and implement something like "compileRestart" from the example. This should allow you to switch at will between the local xmonad and the one NixOS puts in your PATH. @@ -162,8 +162,8 @@ in { enableConfiguredRecompile = mkOption { default = false; type = lib.types.bool; - description = '' - Enable recompilation even if <option>config</option> is set to a + description = lib.mdDoc '' + Enable recompilation even if {option}`config` is set to a non-null value. This adds the necessary Haskell dependencies (GHC with packages) to the xmonad binary's environment. ''; @@ -172,7 +172,7 @@ in { xmonadCliArgs = mkOption { default = []; type = with lib.types; listOf str; - description = '' + description = lib.mdDoc '' Command line arguments passed to the xmonad binary. ''; }; @@ -180,7 +180,7 @@ in { ghcArgs = mkOption { default = []; type = with lib.types; listOf str; - description = '' + description = lib.mdDoc '' Command line arguments passed to the compiler (ghc) invocation when xmonad.config is set. ''; diff --git a/nixos/modules/services/x11/xautolock.nix b/nixos/modules/services/x11/xautolock.nix index 947d8f4edfb59..ca3909d7b80c0 100644 --- a/nixos/modules/services/x11/xautolock.nix +++ b/nixos/modules/services/x11/xautolock.nix @@ -20,7 +20,7 @@ in default = 15; type = types.int; - description = '' + description = lib.mdDoc '' Idle time (in minutes) to wait until xautolock locks the computer. ''; }; @@ -31,7 +31,7 @@ in example = literalExpression ''"''${pkgs.i3lock}/bin/i3lock -i /path/to/img"''; type = types.str; - description = '' + description = lib.mdDoc '' The script to use when automatically locking the computer. ''; }; @@ -41,8 +41,8 @@ in example = literalExpression ''"''${pkgs.i3lock}/bin/i3lock -i /path/to/img"''; type = types.nullOr types.str; - description = '' - The script to use when manually locking the computer with <command>xautolock -locknow</command>. + description = lib.mdDoc '' + The script to use when manually locking the computer with {command}`xautolock -locknow`. ''; }; @@ -50,7 +50,7 @@ in default = 10; type = types.int; - description = '' + description = lib.mdDoc '' Time (in seconds) before the actual lock when the notification about the pending lock should be published. ''; }; @@ -60,7 +60,7 @@ in example = literalExpression ''"''${pkgs.libnotify}/bin/notify-send 'Locking in 10 seconds'"''; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' Notification script to be used to warn about the pending autolock. ''; }; @@ -70,8 +70,8 @@ in example = "/run/current-system/systemd/bin/systemctl suspend"; type = types.nullOr types.str; - description = '' - The script to use when nothing has happend for as long as <option>killtime</option> + description = lib.mdDoc '' + The script to use when nothing has happend for as long as {option}`killtime` ''; }; @@ -79,8 +79,8 @@ in default = 20; # default according to `man xautolock` type = types.int; - description = '' - Minutes xautolock waits until it executes the script specified in <option>killer</option> + description = lib.mdDoc '' + Minutes xautolock waits until it executes the script specified in {option}`killer` (Has to be at least 10 minutes) ''; }; @@ -89,9 +89,9 @@ in type = types.listOf types.str; default = [ ]; example = [ "-detectsleep" ]; - description = '' + description = lib.mdDoc '' Additional command-line arguments to pass to - <command>xautolock</command>. + {command}`xautolock`. ''; }; }; diff --git a/nixos/modules/services/x11/xbanish.nix b/nixos/modules/services/x11/xbanish.nix index b95fac68f1658..f494f2054a40b 100644 --- a/nixos/modules/services/x11/xbanish.nix +++ b/nixos/modules/services/x11/xbanish.nix @@ -10,7 +10,7 @@ in { enable = mkEnableOption "xbanish"; arguments = mkOption { - description = "Arguments to pass to xbanish command"; + description = lib.mdDoc "Arguments to pass to xbanish command"; default = ""; example = "-d -i shift"; type = types.str; diff --git a/nixos/modules/services/x11/xfs.nix b/nixos/modules/services/x11/xfs.nix index ea7cfa1aa43c5..591bf461496e9 100644 --- a/nixos/modules/services/x11/xfs.nix +++ b/nixos/modules/services/x11/xfs.nix @@ -19,7 +19,7 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the X Font Server."; + description = lib.mdDoc "Whether to enable the X Font Server."; }; }; diff --git a/nixos/modules/system/activation/activation-script.nix b/nixos/modules/system/activation/activation-script.nix index c04d0fc16b24d..88b3ac1d18e83 100644 --- a/nixos/modules/system/activation/activation-script.nix +++ b/nixos/modules/system/activation/activation-script.nix @@ -123,12 +123,12 @@ in } ''; - description = '' + description = lib.mdDoc '' A set of shell script fragments that are executed when a NixOS system configuration is activated. Examples are updating /etc, creating accounts, and so on. Since these are executed every time you boot the system or run - <command>nixos-rebuild</command>, it's important that they are + {command}`nixos-rebuild`, it's important that they are idempotent and fast. ''; @@ -159,12 +159,12 @@ in } ''; - description = '' + description = lib.mdDoc '' A set of shell script fragments that are executed by a systemd user service when a NixOS system configuration is activated. Examples are rebuilding the .desktop file cache for showing applications in the menu. Since these are executed every time you run - <command>nixos-rebuild</command>, it's important that they are + {command}`nixos-rebuild`, it's important that they are idempotent and fast. ''; diff --git a/nixos/modules/system/boot/binfmt.nix b/nixos/modules/system/boot/binfmt.nix index 33748358e45bb..4d95af61ac944 100644 --- a/nixos/modules/system/boot/binfmt.nix +++ b/nixos/modules/system/boot/binfmt.nix @@ -153,7 +153,7 @@ in { registrations = mkOption { default = {}; - description = '' + description = lib.mdDoc '' Extra binary formats to register with the kernel. See https://www.kernel.org/doc/html/latest/admin-guide/binfmt-misc.html for more details. ''; @@ -162,30 +162,30 @@ in { options = { recognitionType = mkOption { default = "magic"; - description = "Whether to recognize executables by magic number or extension."; + description = lib.mdDoc "Whether to recognize executables by magic number or extension."; type = types.enum [ "magic" "extension" ]; }; offset = mkOption { default = null; - description = "The byte offset of the magic number used for recognition."; + description = lib.mdDoc "The byte offset of the magic number used for recognition."; type = types.nullOr types.int; }; magicOrExtension = mkOption { - description = "The magic number or extension to match on."; + description = lib.mdDoc "The magic number or extension to match on."; type = types.str; }; mask = mkOption { default = null; description = - "A mask to be ANDed with the byte sequence of the file before matching"; + lib.mdDoc "A mask to be ANDed with the byte sequence of the file before matching"; type = types.nullOr types.str; }; interpreter = mkOption { - description = '' + description = lib.mdDoc '' The interpreter to invoke to run the program. Note that the actual registration will point to @@ -197,7 +197,7 @@ in { preserveArgvZero = mkOption { default = false; - description = '' + description = lib.mdDoc '' Whether to pass the original argv[0] to the interpreter. See the description of the 'P' flag in the kernel docs @@ -208,7 +208,7 @@ in { openBinary = mkOption { default = config.matchCredentials; - description = '' + description = lib.mdDoc '' Whether to pass the binary to the interpreter as an open file descriptor, instead of a path. ''; @@ -217,7 +217,7 @@ in { matchCredentials = mkOption { default = false; - description = '' + description = lib.mdDoc '' Whether to launch with the credentials and security token of the binary, not the interpreter (e.g. setuid bit). @@ -232,7 +232,7 @@ in { fixBinary = mkOption { default = false; - description = '' + description = lib.mdDoc '' Whether to open the interpreter file as soon as the registration is loaded, rather than waiting for a relevant file to be invoked. @@ -245,7 +245,7 @@ in { wrapInterpreterInShell = mkOption { default = true; - description = '' + description = lib.mdDoc '' Whether to wrap the interpreter in a shell script. This allows a shell command to be set as the interpreter. @@ -268,7 +268,7 @@ in { emulatedSystems = mkOption { default = []; example = [ "wasm32-wasi" "x86_64-windows" "aarch64-linux" ]; - description = '' + description = lib.mdDoc '' List of systems to emulate. Will also configure Nix to support your new systems. Warning: the builder can execute all emulated systems within the same build, which introduces impurities in the case of cross compilation. diff --git a/nixos/modules/system/boot/emergency-mode.nix b/nixos/modules/system/boot/emergency-mode.nix index ec697bcee2680..a2163aa5ffb3d 100644 --- a/nixos/modules/system/boot/emergency-mode.nix +++ b/nixos/modules/system/boot/emergency-mode.nix @@ -11,9 +11,9 @@ with lib; systemd.enableEmergencyMode = mkOption { default = true; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable emergency mode, which is an - <command>sulogin</command> shell started on the console if + {command}`sulogin` shell started on the console if mounting a filesystem fails. Since some machines (like EC2 instances) have no console of any kind, emergency mode doesn't make sense, and it's better to continue with the boot insofar diff --git a/nixos/modules/system/boot/initrd-network.nix b/nixos/modules/system/boot/initrd-network.nix index 2a7417ed37153..43327fdd9da4b 100644 --- a/nixos/modules/system/boot/initrd-network.nix +++ b/nixos/modules/system/boot/initrd-network.nix @@ -69,7 +69,7 @@ in boot.initrd.network.flushBeforeStage2 = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to clear the configuration of the interfaces that were set up in the initrd right before stage 2 takes over. Stage 2 will do the regular network configuration based on the NixOS networking options. @@ -79,9 +79,9 @@ in boot.initrd.network.udhcpc.extraArgs = mkOption { default = []; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Additional command-line arguments passed verbatim to udhcpc if - <option>boot.initrd.network.enable</option> and <option>networking.useDHCP</option> + {option}`boot.initrd.network.enable` and {option}`networking.useDHCP` are enabled. ''; }; @@ -89,7 +89,7 @@ in boot.initrd.network.postCommands = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Shell commands to be executed after stage 1 of the boot has initialised the network. ''; diff --git a/nixos/modules/system/boot/initrd-openvpn.nix b/nixos/modules/system/boot/initrd-openvpn.nix index 9b52d4bbdb1ee..9f476e07208a7 100644 --- a/nixos/modules/system/boot/initrd-openvpn.nix +++ b/nixos/modules/system/boot/initrd-openvpn.nix @@ -15,10 +15,10 @@ in boot.initrd.network.openvpn.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Starts an OpenVPN client during initrd boot. It can be used to e.g. remotely accessing the SSH service controlled by - <option>boot.initrd.network.ssh</option> or other network services + {option}`boot.initrd.network.ssh` or other network services included. Service is killed when stage-1 boot is finished. ''; }; diff --git a/nixos/modules/system/boot/initrd-ssh.nix b/nixos/modules/system/boot/initrd-ssh.nix index 0999142de86ea..265399e562fcc 100644 --- a/nixos/modules/system/boot/initrd-ssh.nix +++ b/nixos/modules/system/boot/initrd-ssh.nix @@ -14,20 +14,20 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Start SSH service during initrd boot. It can be used to debug failing boot on a remote server, enter pasphrase for an encrypted partition etc. Service is killed when stage-1 boot is finished. The sshd configuration is largely inherited from - <option>services.openssh</option>. + {option}`services.openssh`. ''; }; port = mkOption { type = types.int; default = 22; - description = '' + description = lib.mdDoc '' Port on which SSH initrd service should listen. ''; }; @@ -35,7 +35,7 @@ in shell = mkOption { type = types.str; default = "/bin/ash"; - description = '' + description = lib.mdDoc '' Login shell of the remote user. Can be used to limit actions user can do. ''; }; @@ -79,7 +79,7 @@ in type = types.listOf types.str; default = config.users.users.root.openssh.authorizedKeys.keys; defaultText = literalExpression "config.users.users.root.openssh.authorizedKeys.keys"; - description = '' + description = lib.mdDoc '' Authorized keys for the root user on initrd. ''; }; @@ -87,7 +87,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = "Verbatim contents of <filename>sshd_config</filename>."; + description = lib.mdDoc "Verbatim contents of {file}`sshd_config`."; }; }; diff --git a/nixos/modules/system/boot/kernel.nix b/nixos/modules/system/boot/kernel.nix index b2c92a85f7abb..33e9eca62b07a 100644 --- a/nixos/modules/system/boot/kernel.nix +++ b/nixos/modules/system/boot/kernel.nix @@ -66,7 +66,7 @@ in type = types.listOf types.attrs; default = []; example = literalExpression "[ pkgs.kernelPatches.ubuntu_fan_4_4 ]"; - description = "A list of additional patches to apply to the kernel."; + description = lib.mdDoc "A list of additional patches to apply to the kernel."; }; boot.kernel.randstructSeed = mkOption { @@ -88,14 +88,14 @@ in description = "string, with spaces inside double quotes"; }); default = [ ]; - description = "Parameters added to the kernel command line."; + description = lib.mdDoc "Parameters added to the kernel command line."; }; boot.consoleLogLevel = mkOption { type = types.int; default = 4; - description = '' - The kernel console <literal>loglevel</literal>. All Kernel Messages with a log level smaller + description = lib.mdDoc '' + The kernel console `loglevel`. All Kernel Messages with a log level smaller than this setting will be printed to the console. ''; }; @@ -103,11 +103,11 @@ in boot.vesa = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' (Deprecated) This option, if set, activates the VESA 800x600 video mode on boot and disables kernel modesetting. It is equivalent to - specifying <literal>[ "vga=0x317" "nomodeset" ]</literal> in the - <option>boot.kernelParams</option> option. This option is + specifying `[ "vga=0x317" "nomodeset" ]` in the + {option}`boot.kernelParams` option. This option is deprecated as of 2020: Xorg now works better with modesetting, and you might want a different VESA vga setting, anyway. ''; @@ -117,18 +117,18 @@ in type = types.listOf types.package; default = []; example = literalExpression "[ config.boot.kernelPackages.nvidia_x11 ]"; - description = "A list of additional packages supplying kernel modules."; + description = lib.mdDoc "A list of additional packages supplying kernel modules."; }; boot.kernelModules = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' The set of kernel modules to be loaded in the second stage of the boot process. Note that modules that are needed to mount the root file system should be added to - <option>boot.initrd.availableKernelModules</option> or - <option>boot.initrd.kernelModules</option>. + {option}`boot.initrd.availableKernelModules` or + {option}`boot.initrd.kernelModules`. ''; }; @@ -136,7 +136,7 @@ in type = types.listOf types.str; default = []; example = [ "sata_nv" "ext3" ]; - description = '' + description = lib.mdDoc '' The set of kernel modules in the initial ramdisk used during the boot process. This set must include all modules necessary for mounting the root device. That is, it should include modules @@ -149,23 +149,23 @@ in loaded automatically when an ext3 filesystem is mounted, and modules for PCI devices are loaded when they match the PCI ID of a device in your system). To force a module to be loaded, - include it in <option>boot.initrd.kernelModules</option>. + include it in {option}`boot.initrd.kernelModules`. ''; }; boot.initrd.kernelModules = mkOption { type = types.listOf types.str; default = []; - description = "List of modules that are always loaded by the initrd."; + description = lib.mdDoc "List of modules that are always loaded by the initrd."; }; boot.initrd.includeDefaultModules = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' This option, if set, adds a collection of default kernel modules - to <option>boot.initrd.availableKernelModules</option> and - <option>boot.initrd.kernelModules</option>. + to {option}`boot.initrd.availableKernelModules` and + {option}`boot.initrd.kernelModules`. ''; }; diff --git a/nixos/modules/system/boot/kernel_config.nix b/nixos/modules/system/boot/kernel_config.nix index 495fe74bc21ee..448835c3e6259 100644 --- a/nixos/modules/system/boot/kernel_config.nix +++ b/nixos/modules/system/boot/kernel_config.nix @@ -25,7 +25,7 @@ let }; default = null; example = ''MMC_BLOCK_MINORS.freeform = "32";''; - description = '' + description = lib.mdDoc '' Freeform description of a kernel configuration item value. ''; }; @@ -33,7 +33,7 @@ let optional = mkOption { type = types.bool // { merge = mergeFalseByDefault; }; default = false; - description = '' + description = lib.mdDoc '' Whether option should generate a failure when unused. Upon merging values, mandatory wins over optional. ''; @@ -105,7 +105,7 @@ in USB = option yes; MMC_BLOCK_MINORS = freeform "32"; }''; - description = '' + description = lib.mdDoc '' Structured kernel configuration. ''; }; diff --git a/nixos/modules/system/boot/loader/efi.nix b/nixos/modules/system/boot/loader/efi.nix index 6043c904c4504..2661f362249db 100644 --- a/nixos/modules/system/boot/loader/efi.nix +++ b/nixos/modules/system/boot/loader/efi.nix @@ -8,13 +8,13 @@ with lib; canTouchEfiVariables = mkOption { default = false; type = types.bool; - description = "Whether the installation process is allowed to modify EFI boot variables."; + description = lib.mdDoc "Whether the installation process is allowed to modify EFI boot variables."; }; efiSysMountPoint = mkOption { default = "/boot"; type = types.str; - description = "Where the EFI System Partition is mounted."; + description = lib.mdDoc "Where the EFI System Partition is mounted."; }; }; } diff --git a/nixos/modules/system/boot/loader/grub/grub.nix b/nixos/modules/system/boot/loader/grub/grub.nix index 1f915d1f419cc..00ec3d237d532 100644 --- a/nixos/modules/system/boot/loader/grub/grub.nix +++ b/nixos/modules/system/boot/loader/grub/grub.nix @@ -103,7 +103,7 @@ in default = !config.boot.isContainer; defaultText = literalExpression "!config.boot.isContainer"; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable the GNU GRUB boot loader. ''; }; @@ -112,9 +112,9 @@ in default = 2; example = 1; type = types.int; - description = '' - The version of GRUB to use: <literal>1</literal> for GRUB - Legacy (versions 0.9x), or <literal>2</literal> (the + description = lib.mdDoc '' + The version of GRUB to use: `1` for GRUB + Legacy (versions 0.9x), or `2` (the default) for GRUB 2. ''; }; @@ -123,12 +123,12 @@ in default = ""; example = "/dev/disk/by-id/wwn-0x500001234567890a"; type = types.str; - description = '' + description = lib.mdDoc '' The device on which the GRUB boot loader will be installed. - The special value <literal>nodev</literal> means that a GRUB + The special value `nodev` means that a GRUB boot menu will be generated, but GRUB itself will not actually be installed. To install GRUB on multiple devices, - use <literal>boot.loader.grub.devices</literal>. + use `boot.loader.grub.devices`. ''; }; @@ -136,9 +136,9 @@ in default = []; example = [ "/dev/disk/by-id/wwn-0x500001234567890a" ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' The devices on which the boot loader, GRUB, will be - installed. Can be used instead of <literal>device</literal> to + installed. Can be used instead of `device` to install GRUB onto multiple devices. ''; }; @@ -148,7 +148,7 @@ in example = { root = { hashedPasswordFile = "/path/to/file"; }; }; - description = '' + description = lib.mdDoc '' User accounts for GRUB. When specified, the GRUB command line and all boot options except the default are password-protected. All passwords and hashes provided will be stored in /boot/grub/grub.cfg, @@ -163,7 +163,7 @@ in example = "/path/to/file"; default = null; type = with types; uniq (nullOr str); - description = '' + description = lib.mdDoc '' Specifies the path to a file containing the password hash for the account, generated with grub-mkpasswd-pbkdf2. This hash will be stored in /boot/grub/grub.cfg, and will @@ -174,7 +174,7 @@ in example = "grub.pbkdf2.sha512.10000.674DFFDEF76E13EA...2CC972B102CF4355"; default = null; type = with types; uniq (nullOr str); - description = '' + description = lib.mdDoc '' Specifies the password hash for the account, generated with grub-mkpasswd-pbkdf2. This hash will be copied to the Nix store, and will be visible to all local users. @@ -184,7 +184,7 @@ in example = "/path/to/file"; default = null; type = with types; uniq (nullOr str); - description = '' + description = lib.mdDoc '' Specifies the path to a file containing the clear text password for the account. This password will be stored in /boot/grub/grub.cfg, and will @@ -195,7 +195,7 @@ in example = "Pa$$w0rd!"; default = null; type = with types; uniq (nullOr str); - description = '' + description = lib.mdDoc '' Specifies the clear text password for the account. This password will be copied to the Nix store, and will be visible to all local users. ''; @@ -210,7 +210,7 @@ in { path = "/boot1"; devices = [ "/dev/disk/by-id/wwn-0x500001234567890a" ]; } { path = "/boot2"; devices = [ "/dev/disk/by-id/wwn-0x500009876543210a" ]; } ]; - description = '' + description = lib.mdDoc '' Mirror the boot configuration to multiple partitions and install grub to the respective devices corresponding to those partitions. ''; @@ -221,7 +221,7 @@ in path = mkOption { example = "/boot1"; type = types.str; - description = '' + description = lib.mdDoc '' The path to the boot directory where GRUB will be written. Generally this boot path should double as an EFI path. ''; @@ -231,7 +231,7 @@ in default = null; example = "/boot1/efi"; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The path to the efi system mount point. Usually this is the same partition as the above path and can be left as null. ''; @@ -241,10 +241,10 @@ in default = null; example = "NixOS-fsid"; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The id of the bootloader to store in efi nvram. The default is to name it NixOS and append the path or efiSysMountPoint. - This is only used if <literal>boot.loader.efi.canTouchEfiVariables</literal> is true. + This is only used if `boot.loader.efi.canTouchEfiVariables` is true. ''; }; @@ -252,7 +252,7 @@ in default = [ ]; example = [ "/dev/disk/by-id/wwn-0x500001234567890a" "/dev/disk/by-id/wwn-0x500009876543210a" ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' The path to the devices which will have the GRUB MBR written. Note these are typically device paths and not paths to partitions. ''; @@ -266,7 +266,7 @@ in default = ""; example = "Stable 2.6.21"; type = types.str; - description = '' + description = lib.mdDoc '' GRUB entry name instead of default. ''; }; @@ -274,7 +274,7 @@ in storePath = mkOption { default = "/nix/store"; type = types.str; - description = '' + description = lib.mdDoc '' Path to the Nix store when looking for kernels at boot. Only makes sense when copyKernels is false. ''; @@ -283,7 +283,7 @@ in extraPrepareConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Additional bash commands to be run at the script that prepares the GRUB menu entries. ''; @@ -297,7 +297,7 @@ in terminal_output --append serial ''; type = types.lines; - description = '' + description = lib.mdDoc '' Additional GRUB commands inserted in the configuration file just before the menu entries. ''; @@ -307,26 +307,26 @@ in default = [ ]; example = [ "--modules=nativedisk ahci pata part_gpt part_msdos diskfilter mdraid1x lvm ext2" ]; type = types.listOf types.str; - description = '' - Additional arguments passed to <literal>grub-install</literal>. + description = lib.mdDoc '' + Additional arguments passed to `grub-install`. A use case for this is to build specific GRUB2 modules directly into the GRUB2 kernel image, so that they are available - and activated even in the <literal>grub rescue</literal> shell. + and activated even in the `grub rescue` shell. They are also necessary when the BIOS/UEFI is bugged and cannot correctly read large disks (e.g. above 2 TB), so GRUB2's own - <literal>nativedisk</literal> and related modules can be used + `nativedisk` and related modules can be used to use its own disk drivers. The example shows one such case. This is also useful for booting from USB. See the - <link xlink:href="http://git.savannah.gnu.org/cgit/grub.git/tree/grub-core/commands/nativedisk.c?h=grub-2.04#n326"> + [ GRUB source code - </link> + ](http://git.savannah.gnu.org/cgit/grub.git/tree/grub-core/commands/nativedisk.c?h=grub-2.04#n326) for which disk modules are available. - The list elements are passed directly as <literal>argv</literal> - arguments to the <literal>grub-install</literal> program, in order. + The list elements are passed directly as `argv` + arguments to the `grub-install` program, in order. ''; }; @@ -344,7 +344,7 @@ in export GNUPGHOME=$old_gpg_home ''; type = types.lines; - description = '' + description = lib.mdDoc '' Additional shell commands inserted in the bootloader installer script after generating menu entries. ''; @@ -354,7 +354,7 @@ in default = ""; example = "root (hd0)"; type = types.lines; - description = '' + description = lib.mdDoc '' Additional GRUB commands inserted in the configuration file at the start of each NixOS menu entry. ''; @@ -379,7 +379,7 @@ in chainloader /efi/fedora/grubx64.efi } ''; - description = '' + description = lib.mdDoc '' Any additional entries you want added to the GRUB boot menu. ''; }; @@ -387,7 +387,7 @@ in extraEntriesBeforeNixOS = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether extraEntries are included before the default option. ''; }; @@ -398,10 +398,10 @@ in example = literalExpression '' { "memtest.bin" = "''${pkgs.memtest86plus}/memtest.bin"; } ''; - description = '' - A set of files to be copied to <filename>/boot</filename>. + description = lib.mdDoc '' + A set of files to be copied to {file}`/boot`. Each attribute name denotes the destination file name in - <filename>/boot</filename>, while the corresponding + {file}`/boot`, while the corresponding attribute value specifies the source file. ''; }; @@ -409,7 +409,7 @@ in useOSProber = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If set to true, append entries for other OSs detected by os-prober. ''; }; @@ -503,7 +503,7 @@ in type = types.nullOr types.path; default = "${realGrub}/share/grub/unicode.pf2"; defaultText = literalExpression ''"''${pkgs.grub2}/share/grub/unicode.pf2"''; - description = '' + description = lib.mdDoc '' Path to a TrueType, OpenType, or pf2 font to be used by Grub. ''; }; @@ -512,8 +512,8 @@ in type = types.nullOr types.int; example = 16; default = null; - description = '' - Font size for the grub menu. Ignored unless <literal>font</literal> + description = lib.mdDoc '' + Font size for the grub menu. Ignored unless `font` is set to a ttf or otf font. ''; }; @@ -522,7 +522,7 @@ in default = "auto"; example = "1024x768"; type = types.str; - description = '' + description = lib.mdDoc '' The gfxmode to pass to GRUB when loading a graphical boot interface under EFI. ''; }; @@ -531,7 +531,7 @@ in default = "1024x768"; example = "auto"; type = types.str; - description = '' + description = lib.mdDoc '' The gfxmode to pass to GRUB when loading a graphical boot interface under BIOS. ''; }; @@ -540,7 +540,7 @@ in default = "keep"; example = "text"; type = types.str; - description = '' + description = lib.mdDoc '' The gfxpayload to pass to GRUB when loading a graphical boot interface under EFI. ''; }; @@ -549,7 +549,7 @@ in default = "text"; example = "keep"; type = types.str; - description = '' + description = lib.mdDoc '' The gfxpayload to pass to GRUB when loading a graphical boot interface under BIOS. ''; }; @@ -558,7 +558,7 @@ in default = 100; example = 120; type = types.int; - description = '' + description = lib.mdDoc '' Maximum of configurations in boot menu. GRUB has problems when there are too many entries. ''; @@ -567,7 +567,7 @@ in copyKernels = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether the GRUB menu builder should copy kernels and initial ramdisks to /boot. This is done automatically if /boot is on a different partition than /. @@ -578,7 +578,7 @@ in default = "0"; type = types.either types.int types.str; apply = toString; - description = '' + description = lib.mdDoc '' Index of the default menu item to be booted. Can also be set to "saved", which will make GRUB select the menu item that was used at the last boot. @@ -588,13 +588,13 @@ in fsIdentifier = mkOption { default = "uuid"; type = types.enum [ "uuid" "label" "provided" ]; - description = '' + description = lib.mdDoc '' Determines how GRUB will identify devices when generating the configuration file. A value of uuid / label signifies that grub will always resolve the uuid or label of the device before using it in the configuration. A value of provided means that GRUB will - use the device name as show in <command>df</command> or - <command>mount</command>. Note, zfs zpools / datasets are ignored + use the device name as show in {command}`df` or + {command}`mount`. Note, zfs zpools / datasets are ignored and will always be mounted using their labels. ''; }; @@ -602,7 +602,7 @@ in zfsSupport = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether GRUB should be built against libzfs. ZFS support is only available for GRUB v2. This option is ignored for GRUB v1. @@ -612,7 +612,7 @@ in efiSupport = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether GRUB should be built with EFI support. EFI support is only available for GRUB v2. This option is ignored for GRUB v1. @@ -659,7 +659,7 @@ in enableCryptodisk = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable support for encrypted partitions. GRUB should automatically unlock the correct encrypted partition and look for filesystems. ''; @@ -668,7 +668,7 @@ in forceInstall = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to try and forcibly install GRUB even if problems are detected. It is not recommended to enable this unless you know what you are doing. @@ -678,7 +678,7 @@ in forcei686 = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to force the use of a ia32 boot loader on x64 systems. Required to install and run NixOS on 64bit x86 systems with 32bit (U)EFI. ''; @@ -689,7 +689,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable trusted boot. GRUB will measure all critical components during the boot process to offer TCG (TPM) support. ''; @@ -699,7 +699,7 @@ in default = ""; example = "YES_TPM_is_activated"; type = types.str; - description = '' + description = lib.mdDoc '' Assertion that the target system has an activated TPM. It is a safety check before allowing the activation of 'trustedBoot.enable'. TrustedBoot WILL FAIL TO BOOT YOUR SYSTEM if no TPM is available. @@ -709,7 +709,7 @@ in isHPLaptop = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Use a special version of TrustedGRUB that is needed by some HP laptops and works only for the HP laptops. ''; diff --git a/nixos/modules/system/boot/loader/grub/ipxe.nix b/nixos/modules/system/boot/loader/grub/ipxe.nix index ef8595592f412..adddcbee0164d 100644 --- a/nixos/modules/system/boot/loader/grub/ipxe.nix +++ b/nixos/modules/system/boot/loader/grub/ipxe.nix @@ -28,7 +28,7 @@ in { boot.loader.grub.ipxe = mkOption { type = types.attrsOf (types.either types.path types.str); description = - '' + lib.mdDoc '' Set of iPXE scripts available for booting from the GRUB boot menu. ''; diff --git a/nixos/modules/system/boot/loader/grub/memtest.nix b/nixos/modules/system/boot/loader/grub/memtest.nix index 71e50dd0577ef..150068e0e9536 100644 --- a/nixos/modules/system/boot/loader/grub/memtest.nix +++ b/nixos/modules/system/boot/loader/grub/memtest.nix @@ -18,12 +18,12 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Make Memtest86+ (or MemTest86 if EFI support is enabled), a memory testing program, available from the GRUB boot menu. MemTest86 is an unfree program, so - this requires <literal>allowUnfree</literal> to be set to - <literal>true</literal>. + this requires `allowUnfree` to be set to + `true`. ''; }; diff --git a/nixos/modules/system/boot/loader/init-script/init-script.nix b/nixos/modules/system/boot/loader/init-script/init-script.nix index 374d9524ff1ee..8287131d3213b 100644 --- a/nixos/modules/system/boot/loader/init-script/init-script.nix +++ b/nixos/modules/system/boot/loader/init-script/init-script.nix @@ -24,7 +24,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Some systems require a /sbin/init script which is started. Or having it makes starting NixOS easier. This applies to some kind of hosting services and user mode linux. diff --git a/nixos/modules/system/boot/loader/loader.nix b/nixos/modules/system/boot/loader/loader.nix index 01475f79b9c25..0e33264271bf8 100644 --- a/nixos/modules/system/boot/loader/loader.nix +++ b/nixos/modules/system/boot/loader/loader.nix @@ -12,7 +12,7 @@ with lib; boot.loader.timeout = mkOption { default = 5; type = types.nullOr types.int; - description = '' + description = lib.mdDoc '' Timeout (in seconds) until loader boots the default menu item. Use null if the loader menu should be displayed indefinitely. ''; }; diff --git a/nixos/modules/system/boot/loader/raspberrypi/raspberrypi.nix b/nixos/modules/system/boot/loader/raspberrypi/raspberrypi.nix index 367feb5e88ec8..426aa021c8bf5 100644 --- a/nixos/modules/system/boot/loader/raspberrypi/raspberrypi.nix +++ b/nixos/modules/system/boot/loader/raspberrypi/raspberrypi.nix @@ -48,10 +48,10 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to create files with the system generations in - <literal>/boot</literal>. - <literal>/boot/old</literal> will hold files from old generations. + `/boot`. + `/boot/old` will hold files from old generations. ''; }; @@ -65,7 +65,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable using uboot as bootmanager for the raspberry pi. ''; }; @@ -74,7 +74,7 @@ in default = 20; example = 10; type = types.int; - description = '' + description = lib.mdDoc '' Maximum number of configurations in the boot menu. ''; }; @@ -84,8 +84,8 @@ in firmwareConfig = mkOption { default = null; type = types.nullOr types.lines; - description = '' - Extra options that will be appended to <literal>/boot/config.txt</literal> file. + description = lib.mdDoc '' + Extra options that will be appended to `/boot/config.txt` file. For possible values, see: https://www.raspberrypi.com/documentation/computers/config_txt.html ''; }; diff --git a/nixos/modules/system/boot/loader/systemd-boot/systemd-boot.nix b/nixos/modules/system/boot/loader/systemd-boot/systemd-boot.nix index 1a1dcaea9c89a..baf0a9fe9c486 100644 --- a/nixos/modules/system/boot/loader/systemd-boot/systemd-boot.nix +++ b/nixos/modules/system/boot/loader/systemd-boot/systemd-boot.nix @@ -69,7 +69,7 @@ in { type = types.bool; - description = "Whether to enable the systemd-boot (formerly gummiboot) EFI boot manager"; + description = lib.mdDoc "Whether to enable the systemd-boot (formerly gummiboot) EFI boot manager"; }; editor = mkOption { @@ -77,7 +77,7 @@ in { type = types.bool; - description = '' + description = lib.mdDoc '' Whether to allow editing the kernel command-line before boot. It is recommended to set this to false, as it allows gaining root access by passing init=/bin/sh as a kernel @@ -90,11 +90,11 @@ in { default = null; example = 120; type = types.nullOr types.int; - description = '' + description = lib.mdDoc '' Maximum number of latest generations in the boot menu. Useful to prevent boot partition running out of disk space. - <literal>null</literal> means no limit i.e. all generations + `null` means no limit i.e. all generations that were not garbage collected yet. ''; }; @@ -134,21 +134,21 @@ in { enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Make MemTest86 available from the systemd-boot menu. MemTest86 is a program for testing memory. MemTest86 is an unfree program, so - this requires <literal>allowUnfree</literal> to be set to - <literal>true</literal>. + this requires `allowUnfree` to be set to + `true`. ''; }; entryFilename = mkOption { default = "memtest86.conf"; type = types.str; - description = '' - <literal>systemd-boot</literal> orders the menu entries by the config file names, + description = lib.mdDoc '' + `systemd-boot` orders the menu entries by the config file names, so if you want something to appear after all the NixOS entries, - it should start with <filename>o</filename> or onwards. + it should start with {file}`o` or onwards. ''; }; }; @@ -157,9 +157,9 @@ in { enable = mkOption { default = false; type = types.bool; - description = '' - Make <literal>netboot.xyz</literal> available from the - <literal>systemd-boot</literal> menu. <literal>netboot.xyz</literal> + description = lib.mdDoc '' + Make `netboot.xyz` available from the + `systemd-boot` menu. `netboot.xyz` is a menu system that allows you to boot OS installers and utilities over the network. ''; @@ -168,10 +168,10 @@ in { entryFilename = mkOption { default = "o_netbootxyz.conf"; type = types.str; - description = '' - <literal>systemd-boot</literal> orders the menu entries by the config file names, + description = lib.mdDoc '' + `systemd-boot` orders the menu entries by the config file names, so if you want something to appear after all the NixOS entries, - it should start with <filename>o</filename> or onwards. + it should start with {file}`o` or onwards. ''; }; }; @@ -185,15 +185,15 @@ in { efi /efi/memtest86/memtest86.efi '''; } ''; - description = '' - Any additional entries you want added to the <literal>systemd-boot</literal> menu. - These entries will be copied to <filename>/boot/loader/entries</filename>. + description = lib.mdDoc '' + Any additional entries you want added to the `systemd-boot` menu. + These entries will be copied to {file}`/boot/loader/entries`. Each attribute name denotes the destination file name, and the corresponding attribute value is the contents of the entry. - <literal>systemd-boot</literal> orders the menu entries by the config file names, + `systemd-boot` orders the menu entries by the config file names, so if you want something to appear after all the NixOS entries, - it should start with <filename>o</filename> or onwards. + it should start with {file}`o` or onwards. ''; }; @@ -203,10 +203,10 @@ in { example = literalExpression '' { "efi/memtest86/memtest86.efi" = "''${pkgs.memtest86-efi}/BOOTX64.efi"; } ''; - description = '' - A set of files to be copied to <filename>/boot</filename>. + description = lib.mdDoc '' + A set of files to be copied to {file}`/boot`. Each attribute name denotes the destination file name in - <filename>/boot</filename>, while the corresponding + {file}`/boot`, while the corresponding attribute value specifies the source file. ''; }; @@ -216,13 +216,13 @@ in { type = types.bool; - description = '' - Invoke <literal>bootctl install</literal> with the <literal>--graceful</literal> option, + description = lib.mdDoc '' + Invoke `bootctl install` with the `--graceful` option, which ignores errors when EFI variables cannot be written or when the EFI System Partition cannot be found. Currently only applies to random seed operations. - Only enable this option if <literal>systemd-boot</literal> otherwise fails to install, as the - scope or implication of the <literal>--graceful</literal> option may change in the future. + Only enable this option if `systemd-boot` otherwise fails to install, as the + scope or implication of the `--graceful` option may change in the future. ''; }; diff --git a/nixos/modules/system/boot/luksroot.nix b/nixos/modules/system/boot/luksroot.nix index 4103a7af57cdf..95556710bdef3 100644 --- a/nixos/modules/system/boot/luksroot.nix +++ b/nixos/modules/system/boot/luksroot.nix @@ -496,10 +496,10 @@ in boot.initrd.luks.mitigateDMAAttacks = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Unless enabled, encryption keys can be easily recovered by an attacker with physical access to any machine with PCMCIA, ExpressCard, ThunderBolt or FireWire port. - More information is available at <link xlink:href="http://en.wikipedia.org/wiki/DMA_attack"/>. + More information is available at <http://en.wikipedia.org/wiki/DMA_attack>. This option blacklists FireWire drivers, but doesn't remove them. You can manually load the drivers if you need to use a FireWire device, but don't forget to unload them! @@ -513,7 +513,7 @@ in "serpent" "cbc" "xts" "lrw" "sha1" "sha256" "sha512" "af_alg" "algif_skcipher" ]; - description = '' + description = lib.mdDoc '' A list of cryptographic kernel modules needed to decrypt the root device(s). The default includes all common modules. ''; @@ -569,14 +569,14 @@ in device = mkOption { example = "/dev/disk/by-uuid/430e9eff-d852-4f68-aa3b-2fa3599ebe08"; type = types.str; - description = "Path of the underlying encrypted block device."; + description = lib.mdDoc "Path of the underlying encrypted block device."; }; header = mkOption { default = null; example = "/root/header.img"; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The name of the file or block device that should be used as header for the encrypted device. ''; @@ -586,7 +586,7 @@ in default = null; example = "/dev/sdb1"; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The name of the file (can be a raw device or a partition) that should be used as the decryption key for the encrypted device. If not specified, you will be prompted for a passphrase instead. @@ -597,12 +597,12 @@ in default = null; example = 4096; type = types.nullOr types.int; - description = '' + description = lib.mdDoc '' The size of the key file. Use this if only the beginning of the key file should be used as a key (often the case if a raw device or partition is used as key file). If not specified, the whole - <literal>keyFile</literal> will be used decryption, instead of just - the first <literal>keyFileSize</literal> bytes. + `keyFile` will be used decryption, instead of just + the first `keyFileSize` bytes. ''; }; @@ -610,12 +610,12 @@ in default = null; example = 4096; type = types.nullOr types.int; - description = '' + description = lib.mdDoc '' The offset of the key file. Use this in combination with - <literal>keyFileSize</literal> to use part of a file as key file + `keyFileSize` to use part of a file as key file (often the case if a raw device or partition is used as a key file). If not specified, the key begins at the first byte of - <literal>keyFile</literal>. + `keyFile`. ''; }; @@ -623,13 +623,13 @@ in preLVM = mkOption { default = true; type = types.bool; - description = "Whether the luksOpen will be attempted before LVM scan or after it."; + description = lib.mdDoc "Whether the luksOpen will be attempted before LVM scan or after it."; }; allowDiscards = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to allow TRIM requests to the underlying device. This option has security implications; please read the LUKS documentation before activating it. @@ -641,10 +641,10 @@ in bypassWorkqueues = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to bypass dm-crypt's internal read and write workqueues. Enabling this should improve performance on SSDs; see - <link xlink:href="https://wiki.archlinux.org/index.php/Dm-crypt/Specialties#Disable_workqueue_for_increased_solid_state_drive_(SSD)_performance">here</link> + [here](https://wiki.archlinux.org/index.php/Dm-crypt/Specialties#Disable_workqueue_for_increased_solid_state_drive_(SSD)_performance) for more information. Needs Linux 5.9 or later. ''; }; @@ -652,7 +652,7 @@ in fallbackToPassword = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to fallback to interactive passphrase prompt if the keyfile cannot be found. This will prevent unattended boot should the keyfile go missing. @@ -661,7 +661,7 @@ in gpgCard = mkOption { default = null; - description = '' + description = lib.mdDoc '' The option to use this LUKS device with a GPG encrypted luks password by the GPG Smartcard. If null (the default), GPG-Smartcard will be disabled for this device. ''; @@ -671,17 +671,17 @@ in gracePeriod = mkOption { default = 10; type = types.int; - description = "Time in seconds to wait for the GPG Smartcard."; + description = lib.mdDoc "Time in seconds to wait for the GPG Smartcard."; }; encryptedPass = mkOption { type = types.path; - description = "Path to the GPG encrypted passphrase."; + description = lib.mdDoc "Path to the GPG encrypted passphrase."; }; publicKey = mkOption { type = types.path; - description = "Path to the Public Key."; + description = lib.mdDoc "Path to the Public Key."; }; }; }); @@ -692,29 +692,29 @@ in default = null; example = "f1d00200d8dc783f7fb1e10ace8da27f8312d72692abfca2f7e4960a73f48e82e1f7571f6ebfcee9fb434f9886ccc8fcc52a6614d8d2"; type = types.nullOr types.str; - description = "The FIDO2 credential ID."; + description = lib.mdDoc "The FIDO2 credential ID."; }; gracePeriod = mkOption { default = 10; type = types.int; - description = "Time in seconds to wait for the FIDO2 key."; + description = lib.mdDoc "Time in seconds to wait for the FIDO2 key."; }; passwordLess = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Defines whatever to use an empty string as a default salt. - Enable only when your device is PIN protected, such as <link xlink:href="https://trezor.io/">Trezor</link>. + Enable only when your device is PIN protected, such as [Trezor](https://trezor.io/). ''; }; }; yubikey = mkOption { default = null; - description = '' + description = lib.mdDoc '' The options to use for this LUKS device in YubiKey-PBA. If null (the default), YubiKey-PBA will be disabled for this device. ''; @@ -724,37 +724,37 @@ in twoFactor = mkOption { default = true; type = types.bool; - description = "Whether to use a passphrase and a YubiKey (true), or only a YubiKey (false)."; + description = lib.mdDoc "Whether to use a passphrase and a YubiKey (true), or only a YubiKey (false)."; }; slot = mkOption { default = 2; type = types.int; - description = "Which slot on the YubiKey to challenge."; + description = lib.mdDoc "Which slot on the YubiKey to challenge."; }; saltLength = mkOption { default = 16; type = types.int; - description = "Length of the new salt in byte (64 is the effective maximum)."; + description = lib.mdDoc "Length of the new salt in byte (64 is the effective maximum)."; }; keyLength = mkOption { default = 64; type = types.int; - description = "Length of the LUKS slot key derived with PBKDF2 in byte."; + description = lib.mdDoc "Length of the LUKS slot key derived with PBKDF2 in byte."; }; iterationStep = mkOption { default = 0; type = types.int; - description = "How much the iteration count for PBKDF2 is increased at each successful authentication."; + description = lib.mdDoc "How much the iteration count for PBKDF2 is increased at each successful authentication."; }; gracePeriod = mkOption { default = 10; type = types.int; - description = "Time in seconds to wait for the YubiKey."; + description = lib.mdDoc "Time in seconds to wait for the YubiKey."; }; /* TODO: Add to the documentation of the current module: @@ -765,7 +765,7 @@ in device = mkOption { default = "/dev/sda1"; type = types.path; - description = '' + description = lib.mdDoc '' An unencrypted device that will temporarily be mounted in stage-1. Must contain the current salt to create the challenge for this LUKS device. ''; @@ -774,13 +774,13 @@ in fsType = mkOption { default = "vfat"; type = types.str; - description = "The filesystem of the unencrypted device."; + description = lib.mdDoc "The filesystem of the unencrypted device."; }; path = mkOption { default = "/crypt-storage/default"; type = types.str; - description = '' + description = lib.mdDoc '' Absolute path of the salt on the unencrypted device with that device's root directory as "/". ''; @@ -797,7 +797,7 @@ in mkdir -p /tmp/persistent mount -t zfs rpool/safe/persistent /tmp/persistent ''; - description = '' + description = lib.mdDoc '' Commands that should be run right before we try to mount our LUKS device. This can be useful, if the keys needed to open the drive is on another partion. ''; @@ -809,7 +809,7 @@ in example = '' umount /tmp/persistent ''; - description = '' + description = lib.mdDoc '' Commands that should be run right after we have mounted our LUKS device. ''; }; @@ -832,7 +832,7 @@ in boot.initrd.luks.gpgSupport = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enables support for authenticating with a GPG encrypted password. ''; }; @@ -840,7 +840,7 @@ in boot.initrd.luks.yubikeySupport = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enables support for authenticating with a YubiKey on LUKS devices. See the NixOS wiki for information on how to properly setup a LUKS device and a YubiKey to work with this feature. @@ -850,7 +850,7 @@ in boot.initrd.luks.fido2Support = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enables support for authenticating with FIDO2 devices. ''; }; diff --git a/nixos/modules/system/boot/modprobe.nix b/nixos/modules/system/boot/modprobe.nix index 21be18ef866eb..4438afe4b3da2 100644 --- a/nixos/modules/system/boot/modprobe.nix +++ b/nixos/modules/system/boot/modprobe.nix @@ -12,7 +12,7 @@ with lib; type = types.listOf types.str; default = []; example = [ "cirrusfb" "i2c_piix4" ]; - description = '' + description = lib.mdDoc '' List of names of kernel modules that should not be loaded automatically by the hardware probing code. ''; diff --git a/nixos/modules/system/boot/networkd.nix b/nixos/modules/system/boot/networkd.nix index 357c2bab993b5..3511351443b71 100644 --- a/nixos/modules/system/boot/networkd.nix +++ b/nixos/modules/system/boot/networkd.nix @@ -883,8 +883,8 @@ let enable = mkOption { default = true; type = types.bool; - description = '' - Whether to manage network configuration using <command>systemd-network</command>. + description = lib.mdDoc '' + Whether to manage network configuration using {command}`systemd-network`. ''; }; @@ -892,12 +892,12 @@ let default = {}; example = { Name = "eth0"; }; type = types.attrsOf unitOption; - description = '' + description = lib.mdDoc '' Each attribute in this set specifies an option in the - <literal>[Match]</literal> section of the unit. See - <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry> - <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry> - <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> + `[Match]` section of the unit. See + {manpage}`systemd.link(5)` + {manpage}`systemd.netdev(5)` + {manpage}`systemd.network(5)` for details. ''; }; @@ -905,7 +905,7 @@ let extraConfig = mkOption { default = ""; type = types.lines; - description = "Extra configuration append to unit"; + description = lib.mdDoc "Extra configuration append to unit"; }; }; @@ -952,8 +952,8 @@ let enable = mkOption { default = true; type = types.bool; - description = '' - Whether to enable this .link unit. It's handled by udev no matter if <command>systemd-networkd</command> is enabled or not + description = lib.mdDoc '' + Whether to enable this .link unit. It's handled by udev no matter if {command}`systemd-networkd` is enabled or not ''; }; @@ -1409,7 +1409,7 @@ let name = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The name of the network interface to match against. ''; }; @@ -1417,7 +1417,7 @@ let DHCP = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Whether to enable DHCP on the interfaces matched. ''; }; @@ -1425,7 +1425,7 @@ let domains = mkOption { type = types.nullOr (types.listOf types.str); default = null; - description = '' + description = lib.mdDoc '' A list of domains to pass to the network config. ''; }; @@ -1612,7 +1612,7 @@ let default = true; example = false; type = types.bool; - description = '' + description = lib.mdDoc '' If true and routeTables are set, then the specified route tables will also be installed into /etc/iproute2/rt_tables. ''; @@ -1832,7 +1832,7 @@ in systemd.network.enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable networkd or not. ''; }; @@ -1840,25 +1840,25 @@ in systemd.network.links = mkOption { default = {}; type = with types; attrsOf (submodule [ { options = linkOptions; } ]); - description = "Definition of systemd network links."; + description = lib.mdDoc "Definition of systemd network links."; }; systemd.network.netdevs = mkOption { default = {}; type = with types; attrsOf (submodule [ { options = netdevOptions; } ]); - description = "Definition of systemd network devices."; + description = lib.mdDoc "Definition of systemd network devices."; }; systemd.network.networks = mkOption { default = {}; type = with types; attrsOf (submodule [ { options = networkOptions; } networkConfig ]); - description = "Definition of systemd networks."; + description = lib.mdDoc "Definition of systemd networks."; }; systemd.network.config = mkOption { default = {}; type = with types; submodule [ { options = networkdOptions; } networkdConfig ]; - description = "Definition of global systemd network config."; + description = lib.mdDoc "Definition of global systemd network config."; }; systemd.network.units = mkOption { @@ -1876,7 +1876,7 @@ in systemd.network.wait-online = { anyInterface = mkOption { - description = '' + description = lib.mdDoc '' Whether to consider the network online when any interface is online, as opposed to all of them. This is useful on portable machines with a wired and a wireless interface, for example. ''; @@ -1885,7 +1885,7 @@ in }; ignoredInterfaces = mkOption { - description = '' + description = lib.mdDoc '' Network interfaces to be ignored when deciding if the system is online. ''; type = with types; listOf str; @@ -1894,7 +1894,7 @@ in }; timeout = mkOption { - description = '' + description = lib.mdDoc '' Time to wait for the network to come online, in seconds. Set to 0 to disable. ''; type = types.ints.unsigned; diff --git a/nixos/modules/system/boot/plymouth.nix b/nixos/modules/system/boot/plymouth.nix index 59037d4e6b4d8..366d6ee432868 100644 --- a/nixos/modules/system/boot/plymouth.nix +++ b/nixos/modules/system/boot/plymouth.nix @@ -68,7 +68,7 @@ in default = "${pkgs.dejavu_fonts.minimal}/share/fonts/truetype/DejaVuSans.ttf"; defaultText = literalExpression ''"''${pkgs.dejavu_fonts.minimal}/share/fonts/truetype/DejaVuSans.ttf"''; type = types.path; - description = '' + description = lib.mdDoc '' Font file made available for displaying text on the splash screen. ''; }; @@ -81,7 +81,7 @@ in <literal>[ ]</literal>. ''; type = types.listOf types.package; - description = '' + description = lib.mdDoc '' Extra theme packages for plymouth. ''; }; @@ -89,7 +89,7 @@ in theme = mkOption { default = "bgrt"; type = types.str; - description = '' + description = lib.mdDoc '' Splash screen theme. ''; }; @@ -102,7 +102,7 @@ in url = "https://nixos.org/logo/nixos-hires.png"; sha256 = "1ivzgd7iz0i06y36p8m5w48fd8pjqwxhdaavc0pxs7w1g7mcy5si"; }''; - description = '' + description = lib.mdDoc '' Logo which is displayed on the splash screen. ''; }; @@ -110,8 +110,8 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' - Literal string to append to <literal>configFile</literal> + description = lib.mdDoc '' + Literal string to append to `configFile` and the config file generated by the plymouth module. ''; }; diff --git a/nixos/modules/system/boot/stage-1.nix b/nixos/modules/system/boot/stage-1.nix index e35ccff290786..f3b9d798f6148 100644 --- a/nixos/modules/system/boot/stage-1.nix +++ b/nixos/modules/system/boot/stage-1.nix @@ -488,7 +488,7 @@ in type = types.bool; default = !config.boot.isContainer; defaultText = literalExpression "!config.boot.isContainer"; - description = '' + description = lib.mdDoc '' Whether to enable the NixOS initial RAM disk (initrd). This may be needed to perform some initialisation tasks (like mounting network/encrypted file systems) before continuing the boot process. @@ -502,11 +502,11 @@ in options = { source = mkOption { type = types.package; - description = "The object to make available inside the initrd."; + description = lib.mdDoc "The object to make available inside the initrd."; }; }; }); - description = '' + description = lib.mdDoc '' Extra files to link and copy in to the initrd. ''; }; @@ -514,7 +514,7 @@ in boot.initrd.prepend = mkOption { default = [ ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Other initrd files to prepend to the final initrd we are building. ''; }; @@ -522,15 +522,15 @@ in boot.initrd.checkJournalingFS = mkOption { default = true; type = types.bool; - description = '' - Whether to run <command>fsck</command> on journaling filesystems such as ext3. + description = lib.mdDoc '' + Whether to run {command}`fsck` on journaling filesystems such as ext3. ''; }; boot.initrd.preLVMCommands = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Shell commands to be executed immediately before LVM discovery. ''; }; @@ -538,7 +538,7 @@ in boot.initrd.preDeviceCommands = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Shell commands to be executed before udev is started to create device nodes. ''; @@ -547,17 +547,17 @@ in boot.initrd.postDeviceCommands = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Shell commands to be executed immediately after stage 1 of the boot has loaded kernel modules and created device nodes in - <filename>/dev</filename>. + {file}`/dev`. ''; }; boot.initrd.postMountCommands = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Shell commands to be executed immediately after the stage 1 filesystems have been mounted. ''; @@ -566,7 +566,7 @@ in boot.initrd.preFailCommands = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Shell commands to be executed before the failure prompt is shown. ''; }; @@ -630,14 +630,14 @@ in boot.initrd.compressorArgs = mkOption { default = null; type = types.nullOr (types.listOf types.str); - description = "Arguments to pass to the compressor for the initrd image, or null to use the compressor's defaults."; + description = lib.mdDoc "Arguments to pass to the compressor for the initrd image, or null to use the compressor's defaults."; }; boot.initrd.secrets = mkOption { default = {}; type = types.attrsOf (types.nullOr types.path); description = - '' + lib.mdDoc '' Secrets to append to the initrd. The attribute name is the path the secret should have inside the initrd, the value is the path it should be copied from (or null for the same @@ -655,7 +655,7 @@ in default = [ ]; example = [ "btrfs" ]; type = types.listOf types.str; - description = "Names of supported filesystem types in the initial ramdisk."; + description = lib.mdDoc "Names of supported filesystem types in the initial ramdisk."; }; boot.initrd.verbose = mkOption { @@ -692,12 +692,12 @@ in options.neededForBoot = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If set, this file system will be mounted in the initial ramdisk. Note that the file system will always be mounted in the initial ramdisk if its mount point is one of the following: ${concatStringsSep ", " ( - forEach utils.pathsNeededForBoot (i: "<filename>${i}</filename>") + forEach utils.pathsNeededForBoot (i: "{file}`${i}`") )}. ''; }; diff --git a/nixos/modules/system/boot/stage-2.nix b/nixos/modules/system/boot/stage-2.nix index f6461daf31163..6b4193ea29674 100644 --- a/nixos/modules/system/boot/stage-2.nix +++ b/nixos/modules/system/boot/stage-2.nix @@ -37,7 +37,7 @@ in default = ""; example = "rm -f /var/log/messages"; type = types.lines; - description = '' + description = lib.mdDoc '' Shell commands to be executed just before systemd is started. ''; }; @@ -45,7 +45,7 @@ in systemdExecutable = mkOption { default = "/run/current-system/systemd/lib/systemd/systemd"; type = types.str; - description = '' + description = lib.mdDoc '' The program to execute to start systemd. ''; }; @@ -53,7 +53,7 @@ in extraSystemdUnitPaths = mkOption { default = []; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Additional paths that get appended to the SYSTEMD_UNIT_PATH environment variable that can contain mutable unit files. ''; diff --git a/nixos/modules/system/boot/systemd/coredump.nix b/nixos/modules/system/boot/systemd/coredump.nix index b6ee2cff1f9af..ea4f9f79b8d4f 100644 --- a/nixos/modules/system/boot/systemd/coredump.nix +++ b/nixos/modules/system/boot/systemd/coredump.nix @@ -10,9 +10,9 @@ in { systemd.coredump.enable = mkOption { default = true; type = types.bool; - description = '' + description = lib.mdDoc '' Whether core dumps should be processed by - <command>systemd-coredump</command>. If disabled, core dumps + {command}`systemd-coredump`. If disabled, core dumps appear in the current directory of the crashing process. ''; }; @@ -21,7 +21,7 @@ in { default = ""; type = types.lines; example = "Storage=journal"; - description = '' + description = lib.mdDoc '' Extra config options for systemd-coredump. See coredump.conf(5) man page for available options. ''; diff --git a/nixos/modules/system/boot/systemd/journald.nix b/nixos/modules/system/boot/systemd/journald.nix index 7e14c8ae4077f..773163bbcb811 100644 --- a/nixos/modules/system/boot/systemd/journald.nix +++ b/nixos/modules/system/boot/systemd/journald.nix @@ -9,13 +9,13 @@ in { services.journald.console = mkOption { default = ""; type = types.str; - description = "If non-empty, write log messages to the specified TTY device."; + description = lib.mdDoc "If non-empty, write log messages to the specified TTY device."; }; services.journald.rateLimitInterval = mkOption { default = "30s"; type = types.str; - description = '' + description = lib.mdDoc '' Configures the rate limiting interval that is applied to all messages generated on the system. This rate limiting is applied per-service, so that two services which log do not interfere with @@ -23,7 +23,7 @@ in { units: s, min, h, ms, us. To turn off any kind of rate limiting, set either value to 0. - See <option>services.journald.rateLimitBurst</option> for important + See {option}`services.journald.rateLimitBurst` for important considerations when setting this value. ''; }; @@ -31,7 +31,7 @@ in { services.journald.rateLimitBurst = mkOption { default = 10000; type = types.int; - description = '' + description = lib.mdDoc '' Configures the rate limiting burst limit (number of messages per interval) that is applied to all messages generated on the system. This rate limiting is applied per-service, so that two services @@ -39,11 +39,11 @@ in { Note that the effective rate limit is multiplied by a factor derived from the available free disk space for the journal as described on - <link xlink:href="https://www.freedesktop.org/software/systemd/man/journald.conf.html"> - journald.conf(5)</link>. + [ + journald.conf(5)](https://www.freedesktop.org/software/systemd/man/journald.conf.html). Note that the total amount of logs stored is limited by journald settings - such as <literal>SystemMaxUse</literal>, which defaults to a 4 GB cap. + such as `SystemMaxUse`, which defaults to a 4 GB cap. It is thus recommended to compute what period of time that you will be able to store logs for when an application logs at full burst rate. @@ -56,7 +56,7 @@ in { default = ""; type = types.lines; example = "Storage=volatile"; - description = '' + description = lib.mdDoc '' Extra config options for systemd-journald. See man journald.conf for available options. ''; @@ -65,7 +65,7 @@ in { services.journald.enableHttpGateway = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable the HTTP gateway to the journal. ''; }; @@ -74,7 +74,7 @@ in { default = config.services.rsyslogd.enable || config.services.syslog-ng.enable; defaultText = literalExpression "services.rsyslogd.enable || services.syslog-ng.enable"; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to forward log messages to syslog. ''; }; diff --git a/nixos/modules/system/boot/systemd/logind.nix b/nixos/modules/system/boot/systemd/logind.nix index 97ac588bce174..cb8fc448a9ef0 100644 --- a/nixos/modules/system/boot/systemd/logind.nix +++ b/nixos/modules/system/boot/systemd/logind.nix @@ -16,10 +16,10 @@ in default = ""; type = types.lines; example = "IdleAction=lock"; - description = '' + description = lib.mdDoc '' Extra config options for systemd-logind. See - <link xlink:href="https://www.freedesktop.org/software/systemd/man/logind.conf.html"> - logind.conf(5)</link> for available options. + [ + logind.conf(5)](https://www.freedesktop.org/software/systemd/man/logind.conf.html) for available options. ''; }; @@ -46,7 +46,7 @@ in example = "ignore"; type = logindHandlerType; - description = '' + description = lib.mdDoc '' Specifies what to be done when the laptop lid is closed. ''; }; @@ -56,7 +56,7 @@ in example = "suspend"; type = logindHandlerType; - description = '' + description = lib.mdDoc '' Specifies what to be done when the laptop lid is closed and another screen is added. ''; @@ -68,7 +68,7 @@ in example = "ignore"; type = logindHandlerType; - description = '' + description = lib.mdDoc '' Specifies what to do when the laptop lid is closed and the system is on external power. By default use the same action as specified in services.logind.lidSwitch. diff --git a/nixos/modules/system/boot/systemd/nspawn.nix b/nixos/modules/system/boot/systemd/nspawn.nix index da03c60db5281..c17dc951cc534 100644 --- a/nixos/modules/system/boot/systemd/nspawn.nix +++ b/nixos/modules/system/boot/systemd/nspawn.nix @@ -107,7 +107,7 @@ in { systemd.nspawn = mkOption { default = {}; type = with types; attrsOf (submodule instanceOptions); - description = "Definition of systemd-nspawn configurations."; + description = lib.mdDoc "Definition of systemd-nspawn configurations."; }; }; diff --git a/nixos/modules/system/boot/systemd/shutdown.nix b/nixos/modules/system/boot/systemd/shutdown.nix index ca4cdf827d953..cb257dce6f04d 100644 --- a/nixos/modules/system/boot/systemd/shutdown.nix +++ b/nixos/modules/system/boot/systemd/shutdown.nix @@ -11,7 +11,7 @@ in { options.systemd.shutdownRamfs = { enable = lib.mkEnableOption "pivoting back to an initramfs for shutdown" // { default = true; }; contents = lib.mkOption { - description = "Set of files that have to be linked into the shutdown ramfs"; + description = lib.mdDoc "Set of files that have to be linked into the shutdown ramfs"; example = lib.literalExpression '' { "/lib/systemd/system-shutdown/zpool-sync-shutdown".source = writeShellScript "zpool" "exec ''${zfs}/bin/zpool sync" @@ -21,7 +21,7 @@ in { }; storePaths = lib.mkOption { - description = '' + description = lib.mdDoc '' Store paths to copy into the shutdown ramfs as well. ''; type = lib.types.listOf lib.types.singleLineStr; diff --git a/nixos/modules/system/boot/systemd/tmpfiles.nix b/nixos/modules/system/boot/systemd/tmpfiles.nix index 97d60e9d6527b..eaa0ddf638782 100644 --- a/nixos/modules/system/boot/systemd/tmpfiles.nix +++ b/nixos/modules/system/boot/systemd/tmpfiles.nix @@ -12,10 +12,10 @@ in type = types.listOf types.str; default = []; example = [ "d /tmp 1777 root root 10d" ]; - description = '' + description = lib.mdDoc '' Rules for creation, deletion and cleaning of volatile and temporary files automatically. See - <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> + {manpage}`tmpfiles.d(5)` for the exact format. ''; }; diff --git a/nixos/modules/system/boot/systemd/user.nix b/nixos/modules/system/boot/systemd/user.nix index edfff5abaa9e3..3200a58d73c9c 100644 --- a/nixos/modules/system/boot/systemd/user.nix +++ b/nixos/modules/system/boot/systemd/user.nix @@ -45,14 +45,14 @@ in { default = ""; type = types.lines; example = "DefaultCPUAccounting=yes"; - description = '' + description = lib.mdDoc '' Extra config options for systemd user instances. See man systemd-user.conf for available options. ''; }; systemd.user.units = mkOption { - description = "Definition of systemd per-user units."; + description = lib.mdDoc "Definition of systemd per-user units."; default = {}; type = systemdUtils.types.units; }; @@ -60,37 +60,37 @@ in { systemd.user.paths = mkOption { default = {}; type = systemdUtils.types.paths; - description = "Definition of systemd per-user path units."; + description = lib.mdDoc "Definition of systemd per-user path units."; }; systemd.user.services = mkOption { default = {}; type = systemdUtils.types.services; - description = "Definition of systemd per-user service units."; + description = lib.mdDoc "Definition of systemd per-user service units."; }; systemd.user.slices = mkOption { default = {}; type = systemdUtils.types.slices; - description = "Definition of systemd per-user slice units."; + description = lib.mdDoc "Definition of systemd per-user slice units."; }; systemd.user.sockets = mkOption { default = {}; type = systemdUtils.types.sockets; - description = "Definition of systemd per-user socket units."; + description = lib.mdDoc "Definition of systemd per-user socket units."; }; systemd.user.targets = mkOption { default = {}; type = systemdUtils.types.targets; - description = "Definition of systemd per-user target units."; + description = lib.mdDoc "Definition of systemd per-user target units."; }; systemd.user.timers = mkOption { default = {}; type = systemdUtils.types.timers; - description = "Definition of systemd per-user timer units."; + description = lib.mdDoc "Definition of systemd per-user timer units."; }; systemd.additionalUpstreamUserUnits = mkOption { diff --git a/nixos/modules/system/boot/timesyncd.nix b/nixos/modules/system/boot/timesyncd.nix index 6279957fcd63b..a6604802c38ca 100644 --- a/nixos/modules/system/boot/timesyncd.nix +++ b/nixos/modules/system/boot/timesyncd.nix @@ -11,7 +11,7 @@ with lib; default = !config.boot.isContainer; defaultText = literalExpression "!config.boot.isContainer"; type = types.bool; - description = '' + description = lib.mdDoc '' Enables the systemd NTP client daemon. ''; }; @@ -19,7 +19,7 @@ with lib; default = config.networking.timeServers; defaultText = literalExpression "config.networking.timeServers"; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' The set of NTP servers from which to synchronise. ''; }; @@ -29,10 +29,10 @@ with lib; example = '' PollIntervalMaxSec=180 ''; - description = '' + description = lib.mdDoc '' Extra config options for systemd-timesyncd. See - <link xlink:href="https://www.freedesktop.org/software/systemd/man/timesyncd.conf.html"> - timesyncd.conf(5)</link> for available options. + [ + timesyncd.conf(5)](https://www.freedesktop.org/software/systemd/man/timesyncd.conf.html) for available options. ''; }; }; diff --git a/nixos/modules/system/build.nix b/nixos/modules/system/build.nix index 58dc3f0d41134..41c0258a5a35c 100644 --- a/nixos/modules/system/build.nix +++ b/nixos/modules/system/build.nix @@ -7,7 +7,7 @@ in system.build = mkOption { default = {}; - description = '' + description = lib.mdDoc '' Attribute set of derivations used to set up the system. ''; type = types.submoduleWith { diff --git a/nixos/modules/tasks/auto-upgrade.nix b/nixos/modules/tasks/auto-upgrade.nix index 54eee19dc771b..46a30c53ea889 100644 --- a/nixos/modules/tasks/auto-upgrade.nix +++ b/nixos/modules/tasks/auto-upgrade.nix @@ -13,10 +13,10 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to periodically upgrade NixOS to the latest version. If enabled, a systemd timer will run - <literal>nixos-rebuild switch --upgrade</literal> once a + `nixos-rebuild switch --upgrade` once a day. ''; }; @@ -36,9 +36,9 @@ in { type = types.nullOr types.str; default = null; example = "github:kloenk/nix"; - description = '' + description = lib.mdDoc '' The Flake URI of the NixOS configuration to build. - Disables the option <option>system.autoUpgrade.channel</option>. + Disables the option {option}`system.autoUpgrade.channel`. ''; }; @@ -64,11 +64,11 @@ in { "extra-binary-caches" "http://my-cache.example.org/" ]; - description = '' - Any additional flags passed to <command>nixos-rebuild</command>. + description = lib.mdDoc '' + Any additional flags passed to {command}`nixos-rebuild`. If you are using flakes and use a local repo you can add - <command>[ "--update-input" "nixpkgs" "--commit-lock-file" ]</command> + {command}`[ "--update-input" "nixpkgs" "--commit-lock-file" ]` to update nixpkgs. ''; }; @@ -90,11 +90,11 @@ in { allowReboot = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Reboot the system into the new generation instead of a switch if the new generation uses a different kernel, kernel modules or initrd than the booted system. - See <option>rebootWindow</option> for configuring the times at which a reboot is allowed. + See {option}`rebootWindow` for configuring the times at which a reboot is allowed. ''; }; @@ -112,24 +112,24 @@ in { }; rebootWindow = mkOption { - description = '' + description = lib.mdDoc '' Define a lower and upper time value (in HH:MM format) which constitute a time window during which reboots are allowed after an upgrade. - This option only has an effect when <option>allowReboot</option> is enabled. - The default value of <literal>null</literal> means that reboots are allowed at any time. + This option only has an effect when {option}`allowReboot` is enabled. + The default value of `null` means that reboots are allowed at any time. ''; default = null; example = { lower = "01:00"; upper = "05:00"; }; type = with types; nullOr (submodule { options = { lower = mkOption { - description = "Lower limit of the reboot window"; + description = lib.mdDoc "Lower limit of the reboot window"; type = types.strMatching "[[:digit:]]{2}:[[:digit:]]{2}"; example = "01:00"; }; upper = mkOption { - description = "Upper limit of the reboot window"; + description = lib.mdDoc "Upper limit of the reboot window"; type = types.strMatching "[[:digit:]]{2}:[[:digit:]]{2}"; example = "05:00"; }; @@ -141,7 +141,7 @@ in { default = true; type = types.bool; example = false; - description = '' + description = lib.mdDoc '' Takes a boolean argument. If true, the time when the service unit was last triggered is stored on disk. When the timer is activated, the service unit is triggered immediately if it diff --git a/nixos/modules/tasks/cpu-freq.nix b/nixos/modules/tasks/cpu-freq.nix index f1219c07c5013..6869ef8b79154 100644 --- a/nixos/modules/tasks/cpu-freq.nix +++ b/nixos/modules/tasks/cpu-freq.nix @@ -18,7 +18,7 @@ in type = types.nullOr types.str; default = null; example = "ondemand"; - description = '' + description = lib.mdDoc '' Configure the governor used to regulate the frequency of the available CPUs. By default, the kernel configures the performance governor, although this may be overwritten in your @@ -34,7 +34,7 @@ in type = types.nullOr types.ints.unsigned; default = null; example = 2200000; - description = '' + description = lib.mdDoc '' The maximum frequency the CPU will use. Defaults to the maximum possible. ''; }; @@ -43,7 +43,7 @@ in type = types.nullOr types.ints.unsigned; default = null; example = 800000; - description = '' + description = lib.mdDoc '' The minimum frequency the CPU will use. ''; }; diff --git a/nixos/modules/tasks/filesystems.nix b/nixos/modules/tasks/filesystems.nix index 82adc499ad0e7..c1e96e7aede77 100644 --- a/nixos/modules/tasks/filesystems.nix +++ b/nixos/modules/tasks/filesystems.nix @@ -33,27 +33,27 @@ let mountPoint = mkOption { example = "/mnt/usb"; type = nonEmptyWithoutTrailingSlash; - description = "Location of the mounted the file system."; + description = lib.mdDoc "Location of the mounted the file system."; }; device = mkOption { default = null; example = "/dev/sda"; type = types.nullOr nonEmptyStr; - description = "Location of the device."; + description = lib.mdDoc "Location of the device."; }; fsType = mkOption { default = "auto"; example = "ext3"; type = nonEmptyStr; - description = "Type of the file system."; + description = lib.mdDoc "Type of the file system."; }; options = mkOption { default = [ "defaults" ]; example = [ "data=journal" ]; - description = "Options used to mount the file system."; + description = lib.mdDoc "Options used to mount the file system."; type = types.listOf nonEmptyStr; }; @@ -61,13 +61,13 @@ let default = [ ]; example = [ "/persist" ]; type = types.listOf nonEmptyWithoutTrailingSlash; - description = '' + description = lib.mdDoc '' List of paths that should be mounted before this one. This filesystem's - <option>device</option> and <option>mountPoint</option> are always + {option}`device` and {option}`mountPoint` are always checked and do not need to be included explicitly. If a path is added to this list, any other filesystem whose mount point is a parent of the path will be mounted before this filesystem. The paths do not need - to actually be the <option>mountPoint</option> of some other filesystem. + to actually be the {option}`mountPoint` of some other filesystem. ''; }; @@ -88,25 +88,25 @@ let default = null; example = "root-partition"; type = types.nullOr nonEmptyStr; - description = "Label of the device (if any)."; + description = lib.mdDoc "Label of the device (if any)."; }; autoFormat = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If the device does not currently contain a filesystem (as - determined by <command>blkid</command>, then automatically + determined by {command}`blkid`, then automatically format it with the filesystem type specified in - <option>fsType</option>. Use with caution. + {option}`fsType`. Use with caution. ''; }; formatOptions = mkOption { default = ""; type = types.str; - description = '' - If <option>autoFormat</option> option is set specifies + description = lib.mdDoc '' + If {option}`autoFormat` option is set specifies extra options passed to mkfs. ''; }; @@ -114,7 +114,7 @@ let autoResize = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If set, the filesystem is grown to its maximum size before being mounted. (This is typically the size of the containing partition.) This is currently only supported for ext2/3/4 @@ -125,7 +125,7 @@ let noCheck = mkOption { default = false; type = types.bool; - description = "Disable running fsck on this filesystem."; + description = lib.mdDoc "Disable running fsck on this filesystem."; }; }; @@ -203,7 +203,7 @@ in default = [ ]; example = [ "btrfs" ]; type = types.listOf types.str; - description = "Names of supported filesystem types."; + description = lib.mdDoc "Names of supported filesystem types."; }; boot.specialFileSystems = mkOption { @@ -219,7 +219,7 @@ in default = "5%"; example = "32m"; type = types.str; - description = '' + description = lib.mdDoc '' Size limit for the /dev tmpfs. Look at mount(8), tmpfs size option, for the accepted syntax. ''; @@ -229,7 +229,7 @@ in default = "50%"; example = "256m"; type = types.str; - description = '' + description = lib.mdDoc '' Size limit for the /dev/shm tmpfs. Look at mount(8), tmpfs size option, for the accepted syntax. ''; @@ -239,7 +239,7 @@ in default = "25%"; example = "256m"; type = types.str; - description = '' + description = lib.mdDoc '' Size limit for the /run tmpfs. Look at mount(8), tmpfs size option, for the accepted syntax. ''; diff --git a/nixos/modules/tasks/filesystems/btrfs.nix b/nixos/modules/tasks/filesystems/btrfs.nix index b7ebc37dd5cf9..4e5180f213535 100644 --- a/nixos/modules/tasks/filesystems/btrfs.nix +++ b/nixos/modules/tasks/filesystems/btrfs.nix @@ -24,8 +24,8 @@ in fileSystems = mkOption { type = types.listOf types.path; example = [ "/" ]; - description = '' - List of paths to btrfs filesystems to regularily call <command>btrfs scrub</command> on. + description = lib.mdDoc '' + List of paths to btrfs filesystems to regularily call {command}`btrfs scrub` on. Defaults to all mount points with btrfs filesystems. If you mount a filesystem multiple times or additionally mount subvolumes, you need to manually specify this list to avoid scrubbing multiple times. diff --git a/nixos/modules/tasks/filesystems/nfs.nix b/nixos/modules/tasks/filesystems/nfs.nix index 38c3920a78ada..8c631f0772db1 100644 --- a/nixos/modules/tasks/filesystems/nfs.nix +++ b/nixos/modules/tasks/filesystems/nfs.nix @@ -30,9 +30,9 @@ in idmapd.settings = mkOption { type = format.type; default = {}; - description = '' + description = lib.mdDoc '' libnfsidmap configuration. Refer to - <link xlink:href="https://linux.die.net/man/5/idmapd.conf"/> + <https://linux.die.net/man/5/idmapd.conf> for details. ''; example = literalExpression '' @@ -49,7 +49,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra nfs-utils configuration. ''; }; diff --git a/nixos/modules/tasks/filesystems/zfs.nix b/nixos/modules/tasks/filesystems/zfs.nix index 05174e03754b6..795879c6764cd 100644 --- a/nixos/modules/tasks/filesystems/zfs.nix +++ b/nixos/modules/tasks/filesystems/zfs.nix @@ -202,7 +202,7 @@ in type = types.package; default = if config.boot.zfs.enableUnstable then pkgs.zfsUnstable else pkgs.zfs; defaultText = literalExpression "if config.boot.zfs.enableUnstable then pkgs.zfsUnstable else pkgs.zfs"; - description = "Configured ZFS userland tools package."; + description = lib.mdDoc "Configured ZFS userland tools package."; }; enabled = mkOption { @@ -210,13 +210,13 @@ in type = types.bool; default = inInitrd || inSystem; defaultText = literalDocBook "<literal>true</literal> if ZFS filesystem support is enabled"; - description = "True if ZFS filesystem support is enabled"; + description = lib.mdDoc "True if ZFS filesystem support is enabled"; }; enableUnstable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Use the unstable zfs package. This might be an option, if the latest kernel is not yet supported by a published release of ZFS. Enabling this option will install a development version of ZFS on Linux. The @@ -230,12 +230,12 @@ in type = types.listOf types.str; default = []; example = [ "tank" "data" ]; - description = '' + description = lib.mdDoc '' Name or GUID of extra ZFS pools that you wish to import during boot. Usually this is not necessary. Instead, you should set the mountpoint property - of ZFS filesystems to <literal>legacy</literal> and add the ZFS filesystems to - NixOS's <option>fileSystems</option> option, which makes NixOS automatically + of ZFS filesystems to `legacy` and add the ZFS filesystems to + NixOS's {option}`fileSystems` option, which makes NixOS automatically import the associated pool. However, in some cases (e.g. if you have many filesystems) it may be preferable @@ -248,7 +248,7 @@ in devNodes = mkOption { type = types.path; default = "/dev/disk/by-id"; - description = '' + description = lib.mdDoc '' Name of directory from which to import ZFS devices. This should be a path under /dev containing stable names for all devices needed, as @@ -259,16 +259,16 @@ in forceImportRoot = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Forcibly import the ZFS root pool(s) during early boot. This is enabled by default for backwards compatibility purposes, but it is highly recommended to disable this option, as it bypasses some of the safeguards ZFS uses to protect your ZFS pools. - If you set this option to <literal>false</literal> and NixOS subsequently fails to + If you set this option to `false` and NixOS subsequently fails to boot because it cannot import the root pool, you should boot with the - <literal>zfs_force=1</literal> option as a kernel parameter (e.g. by manually + `zfs_force=1` option as a kernel parameter (e.g. by manually editing the kernel params in grub during boot). You should only need to do this once. ''; @@ -291,7 +291,7 @@ in type = types.either types.bool (types.listOf types.str); default = true; example = [ "tank" "data" ]; - description = '' + description = lib.mdDoc '' If true on import encryption keys or passwords for all encrypted datasets are requested. To only decrypt selected datasets supply a list of dataset names instead. For root pools the encryption key can be supplied via both @@ -304,15 +304,15 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable the (OpenSolaris-compatible) ZFS auto-snapshotting service. - Note that you must set the <literal>com.sun:auto-snapshot</literal> - property to <literal>true</literal> on all datasets which you wish + Note that you must set the `com.sun:auto-snapshot` + property to `true` on all datasets which you wish to auto-snapshot. You can override a child dataset to use, or not use auto-snapshotting by setting its flag with the given interval: - <literal>zfs set com.sun:auto-snapshot:weekly=false DATASET</literal> + `zfs set com.sun:auto-snapshot:weekly=false DATASET` ''; }; @@ -320,14 +320,14 @@ in default = "-k -p"; example = "-k -p --utc"; type = types.str; - description = '' + description = lib.mdDoc '' Flags to pass to the zfs-auto-snapshot command. - Run <literal>zfs-auto-snapshot</literal> (without any arguments) to + Run `zfs-auto-snapshot` (without any arguments) to see available flags. If it's not too inconvenient for snapshots to have timestamps in UTC, - it is suggested that you append <literal>--utc</literal> to the list + it is suggested that you append `--utc` to the list of default options (see example). Otherwise, snapshot names can cause name conflicts or apparent time @@ -338,7 +338,7 @@ in frequent = mkOption { default = 4; type = types.int; - description = '' + description = lib.mdDoc '' Number of frequent (15-minute) auto-snapshots that you wish to keep. ''; }; @@ -346,7 +346,7 @@ in hourly = mkOption { default = 24; type = types.int; - description = '' + description = lib.mdDoc '' Number of hourly auto-snapshots that you wish to keep. ''; }; @@ -354,7 +354,7 @@ in daily = mkOption { default = 7; type = types.int; - description = '' + description = lib.mdDoc '' Number of daily auto-snapshots that you wish to keep. ''; }; @@ -362,7 +362,7 @@ in weekly = mkOption { default = 4; type = types.int; - description = '' + description = lib.mdDoc '' Number of weekly auto-snapshots that you wish to keep. ''; }; @@ -370,7 +370,7 @@ in monthly = mkOption { default = 12; type = types.int; - description = '' + description = lib.mdDoc '' Number of monthly auto-snapshots that you wish to keep. ''; }; @@ -378,7 +378,7 @@ in services.zfs.trim = { enable = mkOption { - description = "Whether to enable periodic TRIM on all ZFS pools."; + description = lib.mdDoc "Whether to enable periodic TRIM on all ZFS pools."; default = true; example = false; type = types.bool; @@ -417,7 +417,7 @@ in default = []; type = types.listOf types.str; example = [ "tank" ]; - description = '' + description = lib.mdDoc '' List of ZFS pools to periodically scrub. If empty, all pools will be scrubbed. ''; @@ -464,11 +464,11 @@ in ZED_SCRUB_AFTER_RESILVER = false; } ''; - description = '' + description = lib.mdDoc '' ZFS Event Daemon /etc/zfs/zed.d/zed.rc content See - <citerefentry><refentrytitle>zed</refentrytitle><manvolnum>8</manvolnum></citerefentry> + {manpage}`zed(8)` for details on ZED and the scripts in /etc/zfs/zed.d to find the possible variables ''; }; diff --git a/nixos/modules/tasks/network-interfaces.nix b/nixos/modules/tasks/network-interfaces.nix index 07bccf98f407f..e6cb2daaffca8 100644 --- a/nixos/modules/tasks/network-interfaces.nix +++ b/nixos/modules/tasks/network-interfaces.nix @@ -59,7 +59,7 @@ let { options = { address = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' IPv${toString v} address of the interface. Leave empty to configure the interface using DHCP. ''; @@ -67,9 +67,9 @@ let prefixLength = mkOption { type = types.addCheck types.int (n: n >= 0 && n <= (if v == 4 then 32 else 128)); - description = '' + description = lib.mdDoc '' Subnet mask of the interface, specified as the number of - bits in the prefix (<literal>${if v == 4 then "24" else "64"}</literal>). + bits in the prefix (`${if v == 4 then "24" else "64"}`). ''; }; }; @@ -79,14 +79,14 @@ let { options = { address = mkOption { type = types.str; - description = "IPv${toString v} address of the network."; + description = lib.mdDoc "IPv${toString v} address of the network."; }; prefixLength = mkOption { type = types.addCheck types.int (n: n >= 0 && n <= (if v == 4 then 32 else 128)); - description = '' + description = lib.mdDoc '' Subnet mask of the network, specified as the number of - bits in the prefix (<literal>${if v == 4 then "24" else "64"}</literal>). + bits in the prefix (`${if v == 4 then "24" else "64"}`). ''; }; @@ -95,34 +95,34 @@ let "unicast" "local" "broadcast" "multicast" ]); default = null; - description = '' - Type of the route. See the <literal>Route types</literal> section - in the <literal>ip-route(8)</literal> manual page for the details. + description = lib.mdDoc '' + Type of the route. See the `Route types` section + in the `ip-route(8)` manual page for the details. - Note that <literal>prohibit</literal>, <literal>blackhole</literal>, - <literal>unreachable</literal>, and <literal>throw</literal> cannot + Note that `prohibit`, `blackhole`, + `unreachable`, and `throw` cannot be configured per device, so they are not available here. Similarly, - <literal>nat</literal> hasn't been supported since kernel 2.6. + `nat` hasn't been supported since kernel 2.6. ''; }; via = mkOption { type = types.nullOr types.str; default = null; - description = "IPv${toString v} address of the next hop."; + description = lib.mdDoc "IPv${toString v} address of the next hop."; }; options = mkOption { type = types.attrsOf types.str; default = { }; example = { mtu = "1492"; window = "524288"; }; - description = '' - Other route options. See the symbol <literal>OPTIONS</literal> - in the <literal>ip-route(8)</literal> manual page for the details. - You may also specify <literal>metric</literal>, - <literal>src</literal>, <literal>protocol</literal>, - <literal>scope</literal>, <literal>from</literal> - and <literal>table</literal>, which are technically + description = lib.mdDoc '' + Other route options. See the symbol `OPTIONS` + in the `ip-route(8)` manual page for the details. + You may also specify `metric`, + `src`, `protocol`, + `scope`, `from` + and `table`, which are technically not route options, in the sense used in the manual. ''; }; @@ -138,21 +138,21 @@ let address = mkOption { type = types.str; - description = "The default gateway address."; + description = lib.mdDoc "The default gateway address."; }; interface = mkOption { type = types.nullOr types.str; default = null; example = "enp0s3"; - description = "The default gateway interface."; + description = lib.mdDoc "The default gateway interface."; }; metric = mkOption { type = types.nullOr types.int; default = null; example = 42; - description = "The default gateway metric/preference."; + description = lib.mdDoc "The default gateway metric/preference."; }; }; @@ -165,7 +165,7 @@ let name = mkOption { example = "eth0"; type = types.str; - description = "Name of the interface."; + description = lib.mdDoc "Name of the interface."; }; tempAddress = mkOption { @@ -189,7 +189,7 @@ let useDHCP = mkOption { type = types.nullOr types.bool; default = null; - description = '' + description = lib.mdDoc '' Whether this interface should be configured with dhcp. Null implies the old behavior which depends on whether ip addresses are specified or not. @@ -203,7 +203,7 @@ let { address = "192.168.1.1"; prefixLength = 24; } ]; type = with types; listOf (submodule (addrOpts 4)); - description = '' + description = lib.mdDoc '' List of IPv4 addresses that will be statically assigned to the interface. ''; }; @@ -215,7 +215,7 @@ let { address = "2001:1470:fffd:2098::e006"; prefixLength = 64; } ]; type = with types; listOf (submodule (addrOpts 6)); - description = '' + description = lib.mdDoc '' List of IPv6 addresses that will be statically assigned to the interface. ''; }; @@ -247,7 +247,7 @@ let { address = "2001:1470:fffd:2098::"; prefixLength = 64; via = "fdfd:b3f0::1"; } ]; type = with types; listOf (submodule (routeOpts 6)); - description = '' + description = lib.mdDoc '' List of extra IPv6 static routes that will be assigned to the interface. ''; }; @@ -256,7 +256,7 @@ let default = null; example = "00:11:22:33:44:55"; type = types.nullOr (types.str); - description = '' + description = lib.mdDoc '' MAC address of the interface. Leave empty to use the default. ''; }; @@ -265,7 +265,7 @@ let default = null; example = 9000; type = types.nullOr types.int; - description = '' + description = lib.mdDoc '' MTU size for packets leaving the interface. Leave empty to use the default. ''; }; @@ -273,7 +273,7 @@ let virtual = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether this interface is virtual and should be created by tunctl. This is mainly useful for creating bridges between a host and a virtual network such as VPN or a virtual machine. @@ -283,7 +283,7 @@ let virtualOwner = mkOption { default = "root"; type = types.str; - description = '' + description = lib.mdDoc '' In case of a virtual device, the user who owns it. ''; }; @@ -292,7 +292,7 @@ let default = if hasPrefix "tun" name then "tun" else "tap"; defaultText = literalExpression ''if hasPrefix "tun" name then "tun" else "tap"''; type = with types; enum [ "tun" "tap" ]; - description = '' + description = lib.mdDoc '' The type of interface to create. The default is TUN for an interface name starting with "tun", otherwise TAP. @@ -302,7 +302,7 @@ let proxyARP = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Turn on proxy_arp for this device. This is mainly useful for creating pseudo-bridges between a real interface and a virtual network such as VPN or a virtual machine for @@ -321,7 +321,7 @@ let enable = mkOption { type = types.bool; default = false; - description = "Whether to enable wol on this interface."; + description = lib.mdDoc "Whether to enable wol on this interface."; }; }; }; @@ -368,20 +368,20 @@ let options = { name = mkOption { - description = "Name of the interface"; + description = lib.mdDoc "Name of the interface"; example = "eth0"; type = types.str; }; vlan = mkOption { - description = "Vlan tag to apply to interface"; + description = lib.mdDoc "Vlan tag to apply to interface"; example = 10; type = types.nullOr types.int; default = null; }; type = mkOption { - description = "Openvswitch type to assign to interface"; + description = lib.mdDoc "Openvswitch type to assign to interface"; example = "internal"; type = types.nullOr types.str; default = null; @@ -444,7 +444,7 @@ in # reasons (as undocumented feature): type = types.strMatching "^$|^[[:alnum:]]([[:alnum:]_-]{0,61}[[:alnum:]])?$"; - description = '' + description = lib.mdDoc '' The name of the machine. Leave it empty if you want to obtain it from a DHCP server (if using DHCP). The hostname must be a valid DNS label (see RFC 1035 section 2.3.1: "Preferred name syntax", RFC 1123 section 2.1: @@ -474,7 +474,7 @@ in both networking.hostName and networking.domain are set properly. ''; defaultText = literalExpression ''"''${networking.hostName}.''${networking.domain}"''; - description = '' + description = lib.mdDoc '' The fully qualified domain name (FQDN) of this host. It is the result of combining networking.hostName and networking.domain. Using this option will result in an evaluation error if the hostname is empty or @@ -486,17 +486,17 @@ in default = null; example = "4e98920d"; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The 32-bit host ID of the machine, formatted as 8 hexadecimal characters. You should try to make this ID unique among your machines. You can generate a random 32-bit ID using the following commands: - <literal>head -c 8 /etc/machine-id</literal> + `head -c 8 /etc/machine-id` (this derives it from the machine-id that systemd generates) or - <literal>head -c4 /dev/urandom | od -A none -t x4</literal> + `head -c4 /dev/urandom | od -A none -t x4` The primary use case is to ensure when using ZFS that a pool isn't imported accidentally on a wrong machine. @@ -506,7 +506,7 @@ in networking.enableIPv6 = mkOption { default = true; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable support for IPv6. ''; }; @@ -518,7 +518,7 @@ in interface = "enp3s0"; }; type = types.nullOr (types.coercedTo types.str gatewayCoerce (types.submodule gatewayOpts)); - description = '' + description = lib.mdDoc '' The default gateway. It can be left empty if it is auto-detected through DHCP. It can be specified as a string or an option set along with a network interface. ''; @@ -531,7 +531,7 @@ in interface = "enp3s0"; }; type = types.nullOr (types.coercedTo types.str gatewayCoerce (types.submodule gatewayOpts)); - description = '' + description = lib.mdDoc '' The default ipv6 gateway. It can be left empty if it is auto-detected through DHCP. It can be specified as a string or an option set along with a network interface. ''; @@ -541,7 +541,7 @@ in default = null; example = 524288; type = types.nullOr types.int; - description = '' + description = lib.mdDoc '' The window size of the default gateway. It limits maximal data bursts that TCP peers are allowed to send to us. ''; @@ -551,7 +551,7 @@ in type = types.listOf types.str; default = []; example = ["130.161.158.4" "130.161.33.17"]; - description = '' + description = lib.mdDoc '' The list of nameservers. It can be left empty if it is auto-detected through DHCP. ''; }; @@ -560,7 +560,7 @@ in default = []; example = [ "example.com" "home.arpa" ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' The list of search paths used when resolving domain names. ''; }; @@ -569,7 +569,7 @@ in default = null; example = "home.arpa"; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The domain. It can be left empty if it is auto-detected through DHCP. ''; }; @@ -577,9 +577,9 @@ in networking.useHostResolvConf = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' In containers, whether to use the - <filename>resolv.conf</filename> supplied by the host. + {file}`resolv.conf` supplied by the host. ''; }; @@ -587,9 +587,9 @@ in type = types.lines; default = ""; example = "text=anything; echo You can put $text here."; - description = '' + description = lib.mdDoc '' Shell commands to be executed at the end of the - <literal>network-setup</literal> systemd service. Note that if + `network-setup` systemd service. Note that if you are using DHCP to obtain the network configuration, interfaces may not be fully configured yet. ''; @@ -603,9 +603,9 @@ in prefixLength = 25; } ]; }; - description = '' + description = lib.mdDoc '' The configuration for each network interface. If - <option>networking.useDHCP</option> is true, then every + {option}`networking.useDHCP` is true, then every interface not listed here will be configured using DHCP. ''; type = with types; attrsOf (submodule interfaceOpts); @@ -618,7 +618,7 @@ in vs1.interfaces = [ { name = "eth2"; } { name = "lo2"; type="internal"; } ]; }; description = - '' + lib.mdDoc '' This option allows you to define Open vSwitches that connect physical networks together. The value of this option is an attribute set. Each attribute specifies a vswitch, with the @@ -631,7 +631,7 @@ in options = { interfaces = mkOption { - description = "The physical network interfaces connected by the vSwitch."; + description = lib.mdDoc "The physical network interfaces connected by the vSwitch."; type = with types; attrsOf (submodule vswitchInterfaceOpts); }; @@ -639,8 +639,8 @@ in type = types.listOf types.str; default = []; example = [ "ptcp:6653:[::1]" ]; - description = '' - Specify the controller targets. For the allowed options see <literal>man 8 ovs-vsctl</literal>. + description = lib.mdDoc '' + Specify the controller targets. For the allowed options see `man 8 ovs-vsctl`. ''; }; @@ -650,9 +650,9 @@ in example = '' actions=normal ''; - description = '' - OpenFlow rules to insert into the Open vSwitch. All <literal>openFlowRules</literal> are - loaded with <literal>ovs-ofctl</literal> within one atomic operation. + description = lib.mdDoc '' + OpenFlow rules to insert into the Open vSwitch. All `openFlowRules` are + loaded with `ovs-ofctl` within one atomic operation. ''; }; @@ -661,7 +661,7 @@ in type = types.listOf types.str; example = [ "OpenFlow10" "OpenFlow13" "OpenFlow14" ]; default = [ "OpenFlow13" ]; - description = '' + description = lib.mdDoc '' Supported versions to enable on this switch. ''; }; @@ -670,8 +670,8 @@ in openFlowVersion = mkOption { type = types.str; default = "OpenFlow13"; - description = '' - Version of OpenFlow protocol to use when communicating with the switch internally (e.g. with <literal>openFlowRules</literal>). + description = lib.mdDoc '' + Version of OpenFlow protocol to use when communicating with the switch internally (e.g. with `openFlowRules`). ''; }; @@ -682,8 +682,8 @@ in set-fail-mode <switch_name> secure set Bridge <switch_name> stp_enable=true ''; - description = '' - Commands to manipulate the Open vSwitch database. Every line executed with <literal>ovs-vsctl</literal>. + description = lib.mdDoc '' + Commands to manipulate the Open vSwitch database. Every line executed with `ovs-vsctl`. All commands are bundled together with the operations for adding the interfaces into one atomic operation. ''; @@ -702,7 +702,7 @@ in br1.interfaces = [ "eth2" "wlan0" ]; }; description = - '' + lib.mdDoc '' This option allows you to define Ethernet bridge devices that connect physical networks together. The value of this option is an attribute set. Each attribute specifies a @@ -718,13 +718,13 @@ in example = [ "eth0" "eth1" ]; type = types.listOf types.str; description = - "The physical network interfaces connected by the bridge."; + lib.mdDoc "The physical network interfaces connected by the bridge."; }; rstp = mkOption { default = false; type = types.bool; - description = "Whether the bridge interface should enable rstp."; + description = lib.mdDoc "Whether the bridge interface should enable rstp."; }; }; @@ -752,7 +752,7 @@ in anotherBond.interfaces = [ "enp4s0f0" "enp4s0f1" "enp5s0f0" "enp5s0f1" ]; } ''; - description = '' + description = lib.mdDoc '' This option allows you to define bond devices that aggregate multiple, underlying networking interfaces together. The value of this option is an attribute set. Each attribute specifies a bond, with the attribute @@ -766,17 +766,17 @@ in interfaces = mkOption { example = [ "enp4s0f0" "enp4s0f1" "wlan0" ]; type = types.listOf types.str; - description = "The interfaces to bond together"; + description = lib.mdDoc "The interfaces to bond together"; }; driverOptions = mkOption { type = types.attrsOf types.str; default = {}; example = literalExpression driverOptionsExample; - description = '' + description = lib.mdDoc '' Options for the bonding driver. Documentation can be found in - <link xlink:href="https://www.kernel.org/doc/Documentation/networking/bonding.txt" /> + <https://www.kernel.org/doc/Documentation/networking/bonding.txt> ''; }; @@ -844,7 +844,7 @@ in }; } ''; - description = '' + description = lib.mdDoc '' This option allows you to define macvlan interfaces which should be automatically created. ''; @@ -854,14 +854,14 @@ in interface = mkOption { example = "enp4s0"; type = types.str; - description = "The interface the macvlan will transmit packets through."; + description = lib.mdDoc "The interface the macvlan will transmit packets through."; }; mode = mkOption { default = null; type = types.nullOr types.str; example = "vepa"; - description = "The mode of the macvlan device."; + description = lib.mdDoc "The mode of the macvlan device."; }; }; @@ -885,7 +885,7 @@ in options = { port = mkOption { type = port; - description = '' + description = lib.mdDoc '' Local port of the encapsulation UDP socket. ''; }; @@ -893,8 +893,8 @@ in protocol = mkOption { type = nullOr (ints.between 1 255); default = null; - description = '' - Protocol number of the encapsulated packets. Specifying <literal>null</literal> + description = lib.mdDoc '' + Protocol number of the encapsulated packets. Specifying `null` (the default) creates a GUE endpoint, specifying a protocol number will create a FOU endpoint. ''; @@ -905,11 +905,11 @@ in options = { address = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Local address to bind to. The address must be available when the FOU endpoint is created, using the scripted network setup this can be achieved - either by setting <literal>dev</literal> or adding dependency information to - <literal>systemd.services.<name>-fou-encap</literal>; it isn't supported + either by setting `dev` or adding dependency information to + `systemd.services.<name>-fou-encap`; it isn't supported when using networkd. ''; }; @@ -918,7 +918,7 @@ in type = nullOr str; default = null; example = "eth0"; - description = '' + description = lib.mdDoc '' Network device to bind to. ''; }; @@ -926,7 +926,7 @@ in }); default = null; example = { address = "203.0.113.22"; }; - description = '' + description = lib.mdDoc '' Local address (and optionally device) to bind to using the given port. ''; }; @@ -950,7 +950,7 @@ in }; } ''; - description = '' + description = lib.mdDoc '' This option allows you to define 6-to-4 interfaces which should be automatically created. ''; type = with types; attrsOf (submodule { @@ -960,7 +960,7 @@ in type = types.nullOr types.str; default = null; example = "10.0.0.1"; - description = '' + description = lib.mdDoc '' The address of the remote endpoint to forward traffic over. ''; }; @@ -969,7 +969,7 @@ in type = types.nullOr types.str; default = null; example = "10.0.0.22"; - description = '' + description = lib.mdDoc '' The address of the local endpoint which the remote side should send packets to. ''; @@ -979,7 +979,7 @@ in type = types.nullOr types.int; default = null; example = 255; - description = '' + description = lib.mdDoc '' The time-to-live of the connection to the remote tunnel endpoint. ''; }; @@ -988,7 +988,7 @@ in type = types.nullOr types.str; default = null; example = "enp4s0f0"; - description = '' + description = lib.mdDoc '' The underlying network device on which the tunnel resides. ''; }; @@ -1008,7 +1008,7 @@ in port = mkOption { type = port; example = 9001; - description = '' + description = lib.mdDoc '' Destination port for encapsulated packets. ''; }; @@ -1017,7 +1017,7 @@ in type = nullOr types.port; default = null; example = 9002; - description = '' + description = lib.mdDoc '' Source port for encapsulated packets. Will be chosen automatically by the kernel if unset. ''; @@ -1026,7 +1026,7 @@ in }); default = null; example = { type = "fou"; port = 9001; }; - description = '' + description = lib.mdDoc '' Configures encapsulation in UDP packets. ''; }; @@ -1056,7 +1056,7 @@ in }; } ''; - description = '' + description = lib.mdDoc '' This option allows you to define Generic Routing Encapsulation (GRE) tunnels. ''; type = with types; attrsOf (submodule { @@ -1066,7 +1066,7 @@ in type = types.nullOr types.str; default = null; example = "10.0.0.1"; - description = '' + description = lib.mdDoc '' The address of the remote endpoint to forward traffic over. ''; }; @@ -1075,7 +1075,7 @@ in type = types.nullOr types.str; default = null; example = "10.0.0.22"; - description = '' + description = lib.mdDoc '' The address of the local endpoint which the remote side should send packets to. ''; @@ -1085,7 +1085,7 @@ in type = types.nullOr types.str; default = null; example = "enp4s0f0"; - description = '' + description = lib.mdDoc '' The underlying network device on which the tunnel resides. ''; }; @@ -1094,7 +1094,7 @@ in type = types.nullOr types.int; default = null; example = 255; - description = '' + description = lib.mdDoc '' The time-to-live/hoplimit of the connection to the remote tunnel endpoint. ''; }; @@ -1109,7 +1109,7 @@ in tun6 = "ip6gre"; tap6 = "ip6gretap"; }.${v}; - description = '' + description = lib.mdDoc '' Whether the tunnel routes layer 2 (tap) or layer 3 (tun) traffic. ''; }; @@ -1132,7 +1132,7 @@ in } ''; description = - '' + lib.mdDoc '' This option allows you to define vlan devices that tag packets on top of a physical interface. The value of this option is an attribute set. Each attribute specifies a vlan, with the name @@ -1146,13 +1146,13 @@ in id = mkOption { example = 1; type = types.int; - description = "The vlan identifier"; + description = lib.mdDoc "The vlan identifier"; }; interface = mkOption { example = "enp4s0"; type = types.str; - description = "The interface the vlan will transmit packets through."; + description = lib.mdDoc "The interface the vlan will transmit packets through."; }; }; @@ -1184,17 +1184,17 @@ in } ''; description = - '' + lib.mdDoc '' Creating multiple WLAN interfaces on top of one physical WLAN device (NIC). The name of the WLAN interface corresponds to the name of the attribute. A NIC is referenced by the persistent device name of the WLAN interface that - <literal>udev</literal> assigns to a NIC by default. + `udev` assigns to a NIC by default. If a NIC supports multiple WLAN interfaces, then the one NIC can be used as - <literal>device</literal> for multiple WLAN interfaces. + `device` for multiple WLAN interfaces. If a NIC is used for creating WLAN interfaces, then the default WLAN interface - with a persistent device name form <literal>udev</literal> is not created. - A WLAN interface with the persistent name assigned from <literal>udev</literal> + with a persistent device name form `udev` is not created. + A WLAN interface with the persistent name assigned from `udev` would have to be created explicitly. ''; @@ -1205,14 +1205,14 @@ in device = mkOption { type = types.str; example = "wlp6s0"; - description = "The name of the underlying hardware WLAN device as assigned by <literal>udev</literal>."; + description = lib.mdDoc "The name of the underlying hardware WLAN device as assigned by `udev`."; }; type = mkOption { type = types.enum [ "managed" "ibss" "monitor" "mesh" "wds" ]; default = "managed"; example = "ibss"; - description = '' + description = lib.mdDoc '' The type of the WLAN interface. The type has to be supported by the underlying hardware of the device. ''; @@ -1221,22 +1221,22 @@ in meshID = mkOption { type = types.nullOr types.str; default = null; - description = "MeshID of interface with type <literal>mesh</literal>."; + description = lib.mdDoc "MeshID of interface with type `mesh`."; }; flags = mkOption { type = with types; nullOr (enum [ "none" "fcsfail" "control" "otherbss" "cook" "active" ]); default = null; example = "control"; - description = '' - Flags for interface of type <literal>monitor</literal>. + description = lib.mdDoc '' + Flags for interface of type `monitor`. ''; }; fourAddr = mkOption { type = types.nullOr types.bool; default = null; - description = "Whether to enable <literal>4-address mode</literal> with type <literal>managed</literal>."; + description = lib.mdDoc "Whether to enable `4-address mode` with type `managed`."; }; mac = mkOption { @@ -1266,7 +1266,7 @@ in networking.useDHCP = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to use DHCP to obtain an IP address and other configuration for all network interfaces that are not manually configured. @@ -1276,7 +1276,7 @@ in networking.useNetworkd = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether we should use networkd as the network configuration backend or the legacy script based system. Note that this option is experimental, enable at your own risk. diff --git a/nixos/modules/tasks/trackpoint.nix b/nixos/modules/tasks/trackpoint.nix index 029d8a0029556..d197a0feb337c 100644 --- a/nixos/modules/tasks/trackpoint.nix +++ b/nixos/modules/tasks/trackpoint.nix @@ -12,7 +12,7 @@ with lib; enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable sensitivity and speed configuration for trackpoints. ''; }; @@ -21,7 +21,7 @@ with lib; default = 128; example = 255; type = types.int; - description = '' + description = lib.mdDoc '' Configure the trackpoint sensitivity. By default, the kernel configures 128. ''; @@ -31,7 +31,7 @@ with lib; default = 97; example = 255; type = types.int; - description = '' + description = lib.mdDoc '' Configure the trackpoint speed. By default, the kernel configures 97. ''; @@ -40,7 +40,7 @@ with lib; emulateWheel = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable scrolling while holding the middle mouse button. ''; }; @@ -48,7 +48,7 @@ with lib; fakeButtons = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Switch to "bare" PS/2 mouse support in case Trackpoint buttons are not recognized properly. This can happen for example on models like the L430, T450, T450s, on which the Trackpoint buttons are actually a part of the Synaptics touchpad. @@ -58,7 +58,7 @@ with lib; device = mkOption { default = "TPPS/2 IBM TrackPoint"; type = types.str; - description = '' + description = lib.mdDoc '' The device name of the trackpoint. You can check with xinput. Some newer devices (example x1c6) use "TPPS/2 Elan TrackPoint". ''; diff --git a/nixos/modules/virtualisation/amazon-init.nix b/nixos/modules/virtualisation/amazon-init.nix index 9c2adb90bfd21..8b98f2e32dd5d 100644 --- a/nixos/modules/virtualisation/amazon-init.nix +++ b/nixos/modules/virtualisation/amazon-init.nix @@ -60,7 +60,7 @@ in { enable = mkOption { default = true; type = types.bool; - description = '' + description = lib.mdDoc '' Enable or disable the amazon-init service. ''; }; diff --git a/nixos/modules/virtualisation/amazon-options.nix b/nixos/modules/virtualisation/amazon-options.nix index 0465571ca9262..52c960d453d34 100644 --- a/nixos/modules/virtualisation/amazon-options.nix +++ b/nixos/modules/virtualisation/amazon-options.nix @@ -27,13 +27,13 @@ in { type = types.attrsOf (types.submodule { options = { mount = lib.mkOption { - description = "Where to mount this dataset."; + description = lib.mdDoc "Where to mount this dataset."; type = types.nullOr types.string; default = null; }; properties = lib.mkOption { - description = "Properties to set on this dataset."; + description = lib.mdDoc "Properties to set on this dataset."; type = types.attrsOf types.string; default = {}; }; diff --git a/nixos/modules/virtualisation/appvm.nix b/nixos/modules/virtualisation/appvm.nix index 24315a85d0edf..b23b321095cf9 100644 --- a/nixos/modules/virtualisation/appvm.nix +++ b/nixos/modules/virtualisation/appvm.nix @@ -13,13 +13,13 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' This enables AppVMs and related virtualisation settings. ''; }; user = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' AppVM user login. Currenly only AppVMs are supported for a single user only. ''; }; diff --git a/nixos/modules/virtualisation/containerd.nix b/nixos/modules/virtualisation/containerd.nix index ea89a994b172a..96fa6761296b0 100644 --- a/nixos/modules/virtualisation/containerd.nix +++ b/nixos/modules/virtualisation/containerd.nix @@ -23,7 +23,7 @@ in configFile = lib.mkOption { default = null; - description = '' + description = lib.mdDoc '' Path to containerd config file. Setting this option will override any configuration applied by the settings option. ''; @@ -33,14 +33,14 @@ in settings = lib.mkOption { type = settingsFormat.type; default = {}; - description = '' + description = lib.mdDoc '' Verbatim lines to add to containerd.toml ''; }; args = lib.mkOption { default = {}; - description = "extra args to append to the containerd cmdline"; + description = lib.mdDoc "extra args to append to the containerd cmdline"; type = attrsOf str; }; }; diff --git a/nixos/modules/virtualisation/cri-o.nix b/nixos/modules/virtualisation/cri-o.nix index 38766113f3916..3c9b0a061d288 100644 --- a/nixos/modules/virtualisation/cri-o.nix +++ b/nixos/modules/virtualisation/cri-o.nix @@ -25,33 +25,33 @@ in storageDriver = mkOption { type = types.enum [ "btrfs" "overlay" "vfs" ]; default = "overlay"; - description = "Storage driver to be used"; + description = lib.mdDoc "Storage driver to be used"; }; logLevel = mkOption { type = types.enum [ "trace" "debug" "info" "warn" "error" "fatal" ]; default = "info"; - description = "Log level to be used"; + description = lib.mdDoc "Log level to be used"; }; pauseImage = mkOption { type = types.nullOr types.str; default = null; - description = "Override the default pause image for pod sandboxes"; + description = lib.mdDoc "Override the default pause image for pod sandboxes"; example = "k8s.gcr.io/pause:3.2"; }; pauseCommand = mkOption { type = types.nullOr types.str; default = null; - description = "Override the default pause command"; + description = lib.mdDoc "Override the default pause command"; example = "/pause"; }; runtime = mkOption { type = types.nullOr types.str; default = null; - description = "Override the default runtime"; + description = lib.mdDoc "Override the default runtime"; example = "crun"; }; @@ -63,7 +63,7 @@ in pkgs.gvisor ] ''; - description = '' + description = lib.mdDoc '' Extra packages to be installed in the CRI-O wrapper. ''; }; @@ -87,9 +87,9 @@ in settings = mkOption { type = format.type; default = { }; - description = '' + description = lib.mdDoc '' Configuration for cri-o, see - <link xlink:href="https://github.com/cri-o/cri-o/blob/master/docs/crio.conf.5.md"/>. + <https://github.com/cri-o/cri-o/blob/master/docs/crio.conf.5.md>. ''; }; }; diff --git a/nixos/modules/virtualisation/digital-ocean-config.nix b/nixos/modules/virtualisation/digital-ocean-config.nix index 88cb0cd450e8d..754bc1a518576 100644 --- a/nixos/modules/virtualisation/digital-ocean-config.nix +++ b/nixos/modules/virtualisation/digital-ocean-config.nix @@ -10,19 +10,19 @@ with lib; type = bool; default = false; example = true; - description = "Whether to set the root password from the Digital Ocean metadata"; + description = lib.mdDoc "Whether to set the root password from the Digital Ocean metadata"; }; setSshKeys = mkOption { type = bool; default = true; example = true; - description = "Whether to fetch ssh keys from Digital Ocean"; + description = lib.mdDoc "Whether to fetch ssh keys from Digital Ocean"; }; seedEntropy = mkOption { type = bool; default = true; example = true; - description = "Whether to run the kernel RNG entropy seeding script from the Digital Ocean vendor data"; + description = lib.mdDoc "Whether to run the kernel RNG entropy seeding script from the Digital Ocean vendor data"; }; }; config = diff --git a/nixos/modules/virtualisation/docker.nix b/nixos/modules/virtualisation/docker.nix index c6eca4d6ed584..062ad7f53cf17 100644 --- a/nixos/modules/virtualisation/docker.nix +++ b/nixos/modules/virtualisation/docker.nix @@ -21,11 +21,11 @@ in type = types.bool; default = false; description = - '' + lib.mdDoc '' This option enables docker, a daemon that manages linux containers. Users in the "docker" group can interact with the daemon (e.g. to start or stop containers) using the - <command>docker</command> command line tool. + {command}`docker` command line tool. ''; }; @@ -34,7 +34,7 @@ in type = types.listOf types.str; default = ["/run/docker.sock"]; description = - '' + lib.mdDoc '' A list of unix and tcp docker should listen to. The format follows ListenStream as described in systemd.socket(5). ''; @@ -45,10 +45,10 @@ in type = types.bool; default = true; description = - '' + lib.mdDoc '' When enabled dockerd is started on boot. This is required for containers which are created with the - <literal>--restart=always</literal> flag to work. If this option is + `--restart=always` flag to work. If this option is disabled, docker might be started on demand by socket activation. ''; }; @@ -61,7 +61,7 @@ in ipv6 = true; "fixed-cidr-v6" = "fd00::/80"; }; - description = '' + description = lib.mdDoc '' Configuration for docker daemon. The attributes are serialized to JSON used as daemon.conf. See https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file ''; @@ -71,7 +71,7 @@ in mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable nvidia-docker wrapper, supporting NVIDIA GPUs inside docker containers. ''; }; @@ -81,7 +81,7 @@ in type = types.bool; default = true; description = - '' + lib.mdDoc '' Allow dockerd to be restarted without affecting running container. This option is incompatible with docker swarm. ''; @@ -92,7 +92,7 @@ in type = types.nullOr (types.enum ["aufs" "btrfs" "devicemapper" "overlay" "overlay2" "zfs"]); default = null; description = - '' + lib.mdDoc '' This option determines which Docker storage driver to use. By default it let's docker automatically choose preferred storage driver. ''; @@ -103,7 +103,7 @@ in type = types.enum ["none" "json-file" "syslog" "journald" "gelf" "fluentd" "awslogs" "splunk" "etwlogs" "gcplogs"]; default = "journald"; description = - '' + lib.mdDoc '' This option determines which Docker log driver to use. ''; }; @@ -113,9 +113,9 @@ in type = types.separatedString " "; default = ""; description = - '' + lib.mdDoc '' The extra command-line options to pass to - <command>docker</command> daemon. + {command}`docker` daemon. ''; }; @@ -123,10 +123,10 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to periodically prune Docker resources. If enabled, a - systemd timer will run <literal>docker system prune -f</literal> - as specified by the <literal>dates</literal> option. + systemd timer will run `docker system prune -f` + as specified by the `dates` option. ''; }; @@ -134,8 +134,8 @@ in type = types.listOf types.str; default = []; example = [ "--all" ]; - description = '' - Any additional flags passed to <command>docker system prune</command>. + description = lib.mdDoc '' + Any additional flags passed to {command}`docker system prune`. ''; }; @@ -155,7 +155,7 @@ in default = pkgs.docker; defaultText = literalExpression "pkgs.docker"; type = types.package; - description = '' + description = lib.mdDoc '' Docker package to be used in the module. ''; }; diff --git a/nixos/modules/virtualisation/ecs-agent.nix b/nixos/modules/virtualisation/ecs-agent.nix index aa38a02ea0889..af1736fcf0b8c 100644 --- a/nixos/modules/virtualisation/ecs-agent.nix +++ b/nixos/modules/virtualisation/ecs-agent.nix @@ -10,14 +10,14 @@ in { package = mkOption { type = types.path; - description = "The ECS agent package to use"; + description = lib.mdDoc "The ECS agent package to use"; default = pkgs.ecs-agent; defaultText = literalExpression "pkgs.ecs-agent"; }; extra-environment = mkOption { type = types.attrsOf types.str; - description = "The environment the ECS agent should run with. See the ECS agent documentation for keys that work here."; + description = lib.mdDoc "The environment the ECS agent should run with. See the ECS agent documentation for keys that work here."; default = {}; }; }; diff --git a/nixos/modules/virtualisation/hyperv-guest.nix b/nixos/modules/virtualisation/hyperv-guest.nix index fb6502644b80d..e6ba38370f22b 100644 --- a/nixos/modules/virtualisation/hyperv-guest.nix +++ b/nixos/modules/virtualisation/hyperv-guest.nix @@ -14,7 +14,7 @@ in { type = types.str; default = "1152x864"; example = "1024x768"; - description = '' + description = lib.mdDoc '' Resolution at which to initialize the video adapter. Supports screen resolution up to Full HD 1920x1080 with 32 bit color diff --git a/nixos/modules/virtualisation/kvmgt.nix b/nixos/modules/virtualisation/kvmgt.nix index 5e7a73bec902b..5ea71c3a91432 100644 --- a/nixos/modules/virtualisation/kvmgt.nix +++ b/nixos/modules/virtualisation/kvmgt.nix @@ -26,7 +26,7 @@ in { device = mkOption { type = types.str; default = "0000:00:02.0"; - description = "PCI ID of graphics card. You can figure it with <command>ls /sys/class/mdev_bus</command>."; + description = lib.mdDoc "PCI ID of graphics card. You can figure it with {command}`ls /sys/class/mdev_bus`."; }; vgpus = mkOption { default = {}; diff --git a/nixos/modules/virtualisation/libvirtd.nix b/nixos/modules/virtualisation/libvirtd.nix index 31d18ae734495..f7d0ef39c5af0 100644 --- a/nixos/modules/virtualisation/libvirtd.nix +++ b/nixos/modules/virtualisation/libvirtd.nix @@ -29,7 +29,7 @@ let enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Allows libvirtd to take advantage of OVMF when creating new QEMU VMs with UEFI boot. ''; @@ -47,7 +47,7 @@ let default = [ pkgs.OVMF.fd ]; defaultText = literalExpression "[ pkgs.OVMF.fd ]"; example = literalExpression "[ pkgs.OVMFFull.fd pkgs.pkgsCross.aarch64-multiplatform.OVMF.fd ]"; - description = '' + description = lib.mdDoc '' List of OVMF packages to use. Each listed package must contain files names FV/OVMF_CODE.fd and FV/OVMF_VARS.fd or FV/AAVMF_CODE.fd and FV/AAVMF_VARS.fd ''; }; @@ -59,7 +59,7 @@ let enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Allows libvirtd to use swtpm to create an emulated TPM. ''; }; @@ -68,7 +68,7 @@ let type = types.package; default = pkgs.swtpm; defaultText = literalExpression "pkgs.swtpm"; - description = '' + description = lib.mdDoc '' swtpm package to use. ''; }; @@ -91,7 +91,7 @@ let runAsRoot = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' If true, libvirtd runs qemu as root. If false, libvirtd runs qemu as unprivileged user qemu-libvirtd. Changing this option to false may cause file permission issues @@ -105,7 +105,7 @@ let default = '' namespaces = [] ''; - description = '' + description = lib.mdDoc '' Contents written to the qemu configuration file, qemu.conf. Make sure to include a proper namespace configuration when supplying custom configuration. @@ -115,7 +115,7 @@ let ovmf = mkOption { type = ovmfModule; default = { }; - description = '' + description = lib.mdDoc '' QEMU's OVMF options. ''; }; @@ -123,7 +123,7 @@ let swtpm = mkOption { type = swtpmModule; default = { }; - description = '' + description = lib.mdDoc '' QEMU's swtpm options. ''; }; @@ -162,11 +162,11 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' This option enables libvirtd, a daemon that manages virtual machines. Users in the "libvirtd" group can interact with the daemon (e.g. to start or stop VMs) using the - <command>virsh</command> command line tool, among others. + {command}`virsh` command line tool, among others. ''; }; @@ -174,7 +174,7 @@ in type = types.package; default = pkgs.libvirt; defaultText = literalExpression "pkgs.libvirt"; - description = '' + description = lib.mdDoc '' libvirt package to use. ''; }; @@ -182,7 +182,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra contents appended to the libvirtd configuration file, libvirtd.conf. ''; @@ -192,7 +192,7 @@ in type = types.listOf types.str; default = [ ]; example = [ "--verbose" ]; - description = '' + description = lib.mdDoc '' Extra command line arguments passed to libvirtd on startup. ''; }; @@ -200,7 +200,7 @@ in onBoot = mkOption { type = types.enum [ "start" "ignore" ]; default = "start"; - description = '' + description = lib.mdDoc '' Specifies the action to be done to / on the guests when the host boots. The "start" option starts all guests that were running prior to shutdown regardless of their autostart settings. The "ignore" option will not @@ -212,7 +212,7 @@ in onShutdown = mkOption { type = types.enum [ "shutdown" "suspend" ]; default = "suspend"; - description = '' + description = lib.mdDoc '' When shutting down / restarting the host what method should be used to gracefully halt the guests. Setting to "shutdown" will cause an ACPI shutdown of each guest. "suspend" will @@ -223,7 +223,7 @@ in allowedBridges = mkOption { type = types.listOf types.str; default = [ "virbr0" ]; - description = '' + description = lib.mdDoc '' List of bridge devices that can be used by qemu:///session ''; }; @@ -231,7 +231,7 @@ in qemu = mkOption { type = qemuModule; default = { }; - description = '' + description = lib.mdDoc '' QEMU related options. ''; }; diff --git a/nixos/modules/virtualisation/lxc.nix b/nixos/modules/virtualisation/lxc.nix index 0f8b22a45df0c..2b184960daabc 100644 --- a/nixos/modules/virtualisation/lxc.nix +++ b/nixos/modules/virtualisation/lxc.nix @@ -19,7 +19,7 @@ in type = types.bool; default = false; description = - '' + lib.mdDoc '' This enables Linux Containers (LXC), which provides tools for creating and managing system or application containers on Linux. diff --git a/nixos/modules/virtualisation/lxd.nix b/nixos/modules/virtualisation/lxd.nix index 18451b147ff53..f1eabee5ffaf3 100644 --- a/nixos/modules/virtualisation/lxd.nix +++ b/nixos/modules/virtualisation/lxd.nix @@ -36,7 +36,7 @@ in { type = types.package; default = pkgs.lxd; defaultText = literalExpression "pkgs.lxd"; - description = '' + description = lib.mdDoc '' The LXD package to use. ''; }; @@ -45,7 +45,7 @@ in { type = types.package; default = pkgs.lxc; defaultText = literalExpression "pkgs.lxc"; - description = '' + description = lib.mdDoc '' The LXC package to use with LXD (required for AppArmor profiles). ''; }; @@ -54,7 +54,7 @@ in { type = types.bool; default = config.boot.zfs.enabled; defaultText = literalExpression "config.boot.zfs.enabled"; - description = '' + description = lib.mdDoc '' Enables lxd to use zfs as a storage for containers. This option is enabled by default if a zfs pool is configured @@ -65,7 +65,7 @@ in { recommendedSysctlSettings = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enables various settings to avoid common pitfalls when running containers requiring many file operations. Fixes errors like "Too many open files" or @@ -79,7 +79,7 @@ in { type = types.int; default = 600; apply = toString; - description = '' + description = lib.mdDoc '' Time to wait (in seconds) for LXD to become ready to process requests. If LXD does not reply within the configured time, lxd.service will be considered failed and systemd will attempt to restart it. diff --git a/nixos/modules/virtualisation/nixos-containers.nix b/nixos/modules/virtualisation/nixos-containers.nix index deb9742a2c115..e2fb28ed63321 100644 --- a/nixos/modules/virtualisation/nixos-containers.nix +++ b/nixos/modules/virtualisation/nixos-containers.nix @@ -293,18 +293,18 @@ let mountPoint = mkOption { example = "/mnt/usb"; type = types.str; - description = "Mount point on the container file system."; + description = lib.mdDoc "Mount point on the container file system."; }; hostPath = mkOption { default = null; example = "/home/alice"; type = types.nullOr types.str; - description = "Location of the host path to be mounted."; + description = lib.mdDoc "Location of the host path to be mounted."; }; isReadOnly = mkOption { default = true; type = types.bool; - description = "Determine whether the mounted path will be accessed in read-only mode."; + description = lib.mdDoc "Determine whether the mounted path will be accessed in read-only mode."; }; }; @@ -319,16 +319,16 @@ let node = mkOption { example = "/dev/net/tun"; type = types.str; - description = "Path to device node"; + description = lib.mdDoc "Path to device node"; }; modifier = mkOption { example = "rw"; type = types.str; - description = '' + description = lib.mdDoc '' Device node access modifier. Takes a combination - <literal>r</literal> (read), <literal>w</literal> (write), and - <literal>m</literal> (mknod). See the - <literal>systemd.resource-control(5)</literal> man page for more + `r` (read), `w` (write), and + `m` (mknod). See the + `systemd.resource-control(5)` man page for more information.''; }; }; @@ -346,7 +346,7 @@ let type = types.nullOr types.str; default = null; example = "br0"; - description = '' + description = lib.mdDoc '' Put the host-side of the veth-pair into the named bridge. Only one of hostAddress* or hostBridge can be given. ''; @@ -358,22 +358,22 @@ let protocol = mkOption { type = types.str; default = "tcp"; - description = "The protocol specifier for port forwarding between host and container"; + description = lib.mdDoc "The protocol specifier for port forwarding between host and container"; }; hostPort = mkOption { type = types.int; - description = "Source port of the external interface on host"; + description = lib.mdDoc "Source port of the external interface on host"; }; containerPort = mkOption { type = types.nullOr types.int; default = null; - description = "Target port of container"; + description = lib.mdDoc "Target port of container"; }; }; }); default = []; example = [ { protocol = "tcp"; hostPort = 8080; containerPort = 80; } ]; - description = '' + description = lib.mdDoc '' List of forwarded ports from host to container. Each forwarded port is specified by protocol, hostPort and containerPort. By default, protocol is tcp and hostPort and containerPort are assumed to be @@ -386,7 +386,7 @@ let type = types.nullOr types.str; default = null; example = "10.231.136.1"; - description = '' + description = lib.mdDoc '' The IPv4 address assigned to the host interface. (Not used when hostBridge is set.) ''; @@ -396,7 +396,7 @@ let type = types.nullOr types.str; default = null; example = "fc00::1"; - description = '' + description = lib.mdDoc '' The IPv6 address assigned to the host interface. (Not used when hostBridge is set.) ''; @@ -406,7 +406,7 @@ let type = types.nullOr types.str; default = null; example = "10.231.136.2"; - description = '' + description = lib.mdDoc '' The IPv4 address assigned to the interface in the container. If a hostBridge is used, this should be given with netmask to access the whole network. Otherwise the default netmask is /32 and routing is @@ -418,7 +418,7 @@ let type = types.nullOr types.str; default = null; example = "fc00::2"; - description = '' + description = lib.mdDoc '' The IPv6 address assigned to the interface in the container. If a hostBridge is used, this should be given with netmask to access the whole network. Otherwise the default netmask is /128 and routing is @@ -450,7 +450,7 @@ in boot.isContainer = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether this NixOS machine is a lightweight container running in another NixOS system. ''; @@ -459,7 +459,7 @@ in boot.enableContainers = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable support for NixOS containers. Defaults to true (at no cost if containers are not actually used). ''; @@ -471,7 +471,7 @@ in { options = { config = mkOption { - description = '' + description = lib.mdDoc '' A specification of the desired configuration of this container, as a NixOS module. ''; @@ -513,9 +513,9 @@ in path = mkOption { type = types.path; example = "/nix/var/nix/profiles/per-container/webserver"; - description = '' + description = lib.mdDoc '' As an alternative to specifying - <option>config</option>, you can specify the path to + {option}`config`, you can specify the path to the evaluated NixOS system configuration, typically a symlink to a system profile. ''; @@ -525,7 +525,7 @@ in type = types.listOf types.str; default = []; example = [ "CAP_NET_ADMIN" "CAP_MKNOD" ]; - description = '' + description = lib.mdDoc '' Grant additional capabilities to the container. See the capabilities(7) and systemd-nspawn(1) man pages for more information. @@ -569,10 +569,10 @@ in enableTun = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Allows the container to create and setup tunnel interfaces - by granting the <literal>NET_ADMIN</literal> capability and - enabling access to <literal>/dev/net/tun</literal>. + by granting the `NET_ADMIN` capability and + enabling access to `/dev/net/tun`. ''; }; @@ -594,7 +594,7 @@ in type = types.listOf types.str; default = []; example = [ "eth1" "eth2" ]; - description = '' + description = lib.mdDoc '' The list of interfaces to be moved into the container. ''; }; @@ -603,7 +603,7 @@ in type = types.listOf types.str; default = []; example = [ "eth1" "eth2" ]; - description = '' + description = lib.mdDoc '' The list of host interfaces from which macvlans will be created. For each interface specified, a macvlan interface will be created and moved to the container. @@ -613,7 +613,7 @@ in extraVeths = mkOption { type = with types; attrsOf (submodule { options = networkOptions; }); default = {}; - description = '' + description = lib.mdDoc '' Extra veth-pairs to be created for the container. ''; }; @@ -621,7 +621,7 @@ in autoStart = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether the container is automatically started at boot-time. ''; }; @@ -648,7 +648,7 @@ in ''; description = - '' + lib.mdDoc '' An extra list of directories that is bound to the container. ''; }; @@ -657,7 +657,7 @@ in type = with types; listOf (submodule allowedDeviceOpts); default = []; example = [ { node = "/dev/net/tun"; modifier = "rw"; } ]; - description = '' + description = lib.mdDoc '' A list of device nodes to which the containers has access to. ''; }; @@ -666,7 +666,7 @@ in type = types.listOf types.str; default = []; example = [ "/var" ]; - description = '' + description = lib.mdDoc '' Mounts a set of tmpfs file systems into the container. Multiple paths can be specified. Valid items must conform to the --tmpfs argument @@ -678,7 +678,7 @@ in type = types.listOf types.str; default = []; example = [ "--drop-capability=CAP_SYS_CHROOT" ]; - description = '' + description = lib.mdDoc '' Extra flags passed to the systemd-nspawn command. See systemd-nspawn(1) for details. ''; diff --git a/nixos/modules/virtualisation/openstack-options.nix b/nixos/modules/virtualisation/openstack-options.nix index cbc779f27c8f8..eded418c9c91e 100644 --- a/nixos/modules/virtualisation/openstack-options.nix +++ b/nixos/modules/virtualisation/openstack-options.nix @@ -28,13 +28,13 @@ in type = types.attrsOf (types.submodule { options = { mount = lib.mkOption { - description = "Where to mount this dataset."; + description = lib.mdDoc "Where to mount this dataset."; type = types.nullOr types.string; default = null; }; properties = lib.mkOption { - description = "Properties to set on this dataset."; + description = lib.mdDoc "Properties to set on this dataset."; type = types.attrsOf types.string; default = { }; }; diff --git a/nixos/modules/virtualisation/parallels-guest.nix b/nixos/modules/virtualisation/parallels-guest.nix index 53ad2ac708b80..d3affe2b8f2c3 100644 --- a/nixos/modules/virtualisation/parallels-guest.nix +++ b/nixos/modules/virtualisation/parallels-guest.nix @@ -14,7 +14,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' This enables Parallels Tools for Linux guests, along with provided video, mouse and other hardware drivers. ''; @@ -36,7 +36,7 @@ in default = config.boot.kernelPackages.prl-tools; defaultText = "config.boot.kernelPackages.prl-tools"; example = literalExpression "config.boot.kernelPackages.prl-tools"; - description = '' + description = lib.mdDoc '' Defines which package to use for prl-tools. Override to change the version. ''; }; diff --git a/nixos/modules/virtualisation/podman/dnsname.nix b/nixos/modules/virtualisation/podman/dnsname.nix index beef19755079c..3e7d35ae1e44d 100644 --- a/nixos/modules/virtualisation/podman/dnsname.nix +++ b/nixos/modules/virtualisation/podman/dnsname.nix @@ -16,7 +16,7 @@ in defaultNetwork.dnsname.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable DNS resolution in the default podman network. ''; }; diff --git a/nixos/modules/virtualisation/qemu-guest-agent.nix b/nixos/modules/virtualisation/qemu-guest-agent.nix index 39273e523e8f3..650fb2419160f 100644 --- a/nixos/modules/virtualisation/qemu-guest-agent.nix +++ b/nixos/modules/virtualisation/qemu-guest-agent.nix @@ -10,13 +10,13 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the qemu guest agent."; + description = lib.mdDoc "Whether to enable the qemu guest agent."; }; package = mkOption { type = types.package; default = pkgs.qemu_kvm.ga; defaultText = literalExpression "pkgs.qemu_kvm.ga"; - description = "The QEMU guest agent package."; + description = lib.mdDoc "The QEMU guest agent package."; }; }; diff --git a/nixos/modules/virtualisation/spice-usb-redirection.nix b/nixos/modules/virtualisation/spice-usb-redirection.nix index 255327f2622c9..ab2b058c686f7 100644 --- a/nixos/modules/virtualisation/spice-usb-redirection.nix +++ b/nixos/modules/virtualisation/spice-usb-redirection.nix @@ -3,7 +3,7 @@ options.virtualisation.spiceUSBRedirection.enable = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Install the SPICE USB redirection helper with setuid privileges. This allows unprivileged users to pass USB devices connected to this machine to libvirt VMs, both local and diff --git a/nixos/modules/virtualisation/virtualbox-guest.nix b/nixos/modules/virtualisation/virtualbox-guest.nix index 7b55b3b9759ea..94f70c65436c1 100644 --- a/nixos/modules/virtualisation/virtualbox-guest.nix +++ b/nixos/modules/virtualisation/virtualbox-guest.nix @@ -19,13 +19,13 @@ in enable = mkOption { default = false; type = types.bool; - description = "Whether to enable the VirtualBox service and other guest additions."; + description = lib.mdDoc "Whether to enable the VirtualBox service and other guest additions."; }; x11 = mkOption { default = true; type = types.bool; - description = "Whether to enable x11 graphics"; + description = lib.mdDoc "Whether to enable x11 graphics"; }; }; diff --git a/nixos/modules/virtualisation/virtualbox-host.nix b/nixos/modules/virtualisation/virtualbox-host.nix index 2acf54aae2ef6..4e47febed1be8 100644 --- a/nixos/modules/virtualisation/virtualbox-host.nix +++ b/nixos/modules/virtualisation/virtualbox-host.nix @@ -44,7 +44,7 @@ in type = types.package; default = pkgs.virtualbox; defaultText = literalExpression "pkgs.virtualbox"; - description = '' + description = lib.mdDoc '' Which VirtualBox package to use. ''; }; @@ -52,7 +52,7 @@ in addNetworkInterface = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Automatically set up a vboxnet0 host-only network interface. ''; }; @@ -75,7 +75,7 @@ in headless = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Use VirtualBox installation without GUI and Qt dependency. Useful to enable on servers and when virtual machines are controlled only via SSH. ''; @@ -84,7 +84,7 @@ in enableWebService = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Build VirtualBox web service tool (vboxwebsrv) to allow managing VMs via other webpage frontend tools. Useful for headless servers. ''; }; diff --git a/nixos/modules/virtualisation/vmware-guest.nix b/nixos/modules/virtualisation/vmware-guest.nix index d468a2008722f..61ff9da65af16 100644 --- a/nixos/modules/virtualisation/vmware-guest.nix +++ b/nixos/modules/virtualisation/vmware-guest.nix @@ -17,7 +17,7 @@ in headless = mkOption { type = types.bool; default = false; - description = "Whether to disable X11-related features."; + description = lib.mdDoc "Whether to disable X11-related features."; }; }; diff --git a/nixos/modules/virtualisation/vmware-host.nix b/nixos/modules/virtualisation/vmware-host.nix index faa0d455c9d6b..b4869f0210dc3 100644 --- a/nixos/modules/virtualisation/vmware-host.nix +++ b/nixos/modules/virtualisation/vmware-host.nix @@ -41,18 +41,18 @@ in type = types.package; default = pkgs.vmware-workstation; defaultText = literalExpression "pkgs.vmware-workstation"; - description = "VMware host virtualisation package to use"; + description = lib.mdDoc "VMware host virtualisation package to use"; }; extraPackages = mkOption { type = with types; listOf package; default = with pkgs; [ ]; - description = "Extra packages to be used with VMware host."; + description = lib.mdDoc "Extra packages to be used with VMware host."; example = "with pkgs; [ ntfs3g ]"; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Add extra config to /etc/vmware/config"; + description = lib.mdDoc "Add extra config to /etc/vmware/config"; example = '' # Allow unsupported device's OpenGL and Vulkan acceleration for guest vGPU mks.gl.allowUnsupportedDrivers = "TRUE" diff --git a/pkgs/applications/editors/jedit/default.nix b/pkgs/applications/editors/jedit/default.nix index 1cffa831ef614..fe9284873551e 100644 --- a/pkgs/applications/editors/jedit/default.nix +++ b/pkgs/applications/editors/jedit/default.nix @@ -58,6 +58,6 @@ stdenv.mkDerivation { sourceProvenance = with sourceTypes; [ binaryBytecode ]; license = licenses.gpl2; platforms = platforms.unix; - maintainers = [ maintainers.vbgl ]; + maintainers = [ ]; }; } diff --git a/pkgs/applications/emulators/pcsx2/default.nix b/pkgs/applications/emulators/pcsx2/default.nix index a5ff1106fd688..77e69a0321311 100644 --- a/pkgs/applications/emulators/pcsx2/default.nix +++ b/pkgs/applications/emulators/pcsx2/default.nix @@ -32,14 +32,14 @@ stdenv.mkDerivation rec { pname = "pcsx2"; - version = "1.7.2731"; + version = "1.7.3128"; src = fetchFromGitHub { owner = "PCSX2"; repo = "pcsx2"; fetchSubmodules = true; rev = "v${version}"; - hash = "sha256-b3cK3ly9J44YMy/cNprlDCSsu8+DrlhRSLXv5xMouWo="; + hash = "sha256-OVKxVyUkTpyVvQ1oA8G6W77ssC1NmUAu/VanBM8Z168="; }; cmakeFlags = [ diff --git a/pkgs/applications/graphics/image-roll/default.nix b/pkgs/applications/graphics/image-roll/default.nix index 2bba3c80cd9bf..20444f5807a48 100644 --- a/pkgs/applications/graphics/image-roll/default.nix +++ b/pkgs/applications/graphics/image-roll/default.nix @@ -4,25 +4,30 @@ , glib , pkg-config , wrapGAppsHook -, gtk3 +, gtk4 }: rustPlatform.buildRustPackage rec { pname = "image-roll"; - version = "1.4.1"; + version = "2.1.0"; src = fetchFromGitHub { owner = "weclaw1"; repo = pname; rev = version; - sha256 = "sha256-SyG/syIDnyQaXUgGkXZkY98dmFs7O+OFnGL50250nJI="; + sha256 = "sha256-CC40TU38bJFnbJl2EHqeB9RBvbVUrBmRdZVS2GxqGu4="; }; - cargoSha256 = "sha256-pyeJ7WmtkbQjbek/rRh2UKFQ5o006Rf7phZ1yl2s4wA="; + cargoSha256 = "sha256-cUE2IZOunR/NIo/qytORRfNqCsf87LfpKA8o/v4Nkhk="; nativeBuildInputs = [ glib pkg-config wrapGAppsHook ]; - buildInputs = [ gtk3 ]; + buildInputs = [ gtk4 ]; + + checkFlags = [ + # fails in the sandbox + "--skip=file_list::tests" + ]; postInstall = '' install -Dm444 src/resources/com.github.weclaw1.ImageRoll.desktop -t $out/share/applications/ diff --git a/pkgs/applications/graphics/renderdoc/default.nix b/pkgs/applications/graphics/renderdoc/default.nix index e8a50dc6d8c97..aa452f8de2c75 100644 --- a/pkgs/applications/graphics/renderdoc/default.nix +++ b/pkgs/applications/graphics/renderdoc/default.nix @@ -95,7 +95,7 @@ mkDerivation rec { of any application using Vulkan, D3D11, OpenGL or D3D12 across Windows 7 - 10, Linux or Android. ''; - maintainers = [ maintainers.jansol ]; + maintainers = [ ]; platforms = [ "i686-linux" "x86_64-linux" ]; }; } diff --git a/pkgs/applications/networking/instant-messengers/gotktrix/default.nix b/pkgs/applications/networking/instant-messengers/gotktrix/default.nix index bd0da749e0961..d0f9f3d9e52ea 100644 --- a/pkgs/applications/networking/instant-messengers/gotktrix/default.nix +++ b/pkgs/applications/networking/instant-messengers/gotktrix/default.nix @@ -10,16 +10,16 @@ buildGoModule rec { pname = "gotktrix"; - version = "0.1.3"; + version = "0.1.4"; src = fetchFromGitHub { owner = "diamondburned"; repo = pname; rev = "v${version}"; - sha256 = "sha256-/UDXqN7FnFvbiXp3pID1WbNfCuKDsMrFQvL1101xxOo="; + sha256 = "sha256-ZaE7L43fA9L5WbTAsBiIxlwYgjl1hMrtfrraAROz+7k="; }; - vendorSha256 = "sha256-xA2DW4v6aT4fEW2WSa96oRr5Yrb2HoR054V1+BiWSvk="; + vendorSha256 = "sha256-k6T44aH1NogyrbUnflfEHkp0zpOOH1YFly/X2kwbMzs="; buildInputs = [ gtk4 diff --git a/pkgs/applications/networking/instant-messengers/psi-plus/default.nix b/pkgs/applications/networking/instant-messengers/psi-plus/default.nix index fe3f90346f1cc..c5e5b063c4e28 100644 --- a/pkgs/applications/networking/instant-messengers/psi-plus/default.nix +++ b/pkgs/applications/networking/instant-messengers/psi-plus/default.nix @@ -43,13 +43,13 @@ assert enablePsiMedia -> enablePlugins; mkDerivation rec { pname = "psi-plus"; - version = "1.5.1618"; + version = "1.5.1633"; src = fetchFromGitHub { owner = "psi-plus"; repo = "psi-plus-snapshots"; rev = version; - sha256 = "sha256-ueZYFOZFCPQrg9etZCrY5ZTn7PZMkcuwbXVPPbW9S/A="; + sha256 = "sha256-kXdDxpIOcwcFy+OmsqlE8a19sGPfMNI08fMy5OFuP9w="; }; cmakeFlags = [ diff --git a/pkgs/applications/networking/irc/srain/default.nix b/pkgs/applications/networking/irc/srain/default.nix index 302fe96f1eca5..1d30656854a1c 100644 --- a/pkgs/applications/networking/irc/srain/default.nix +++ b/pkgs/applications/networking/irc/srain/default.nix @@ -20,13 +20,13 @@ stdenv.mkDerivation rec { pname = "srain"; - version = "1.4.0"; + version = "1.4.1"; src = fetchFromGitHub { owner = "SrainApp"; repo = "srain"; rev = version; - sha256 = "sha256-oeC0zyDyh0lW1IMIJ9bjqryqz3Km4JJzRUxkO6LadoQ="; + sha256 = "sha256-zkSePzmbi/QnUYJO/henkxfhuN+BXTXtKGPW7M2QyBY="; }; nativeBuildInputs = [ diff --git a/pkgs/applications/science/biology/last/default.nix b/pkgs/applications/science/biology/last/default.nix index bbe661b4f0a00..031e59619005c 100644 --- a/pkgs/applications/science/biology/last/default.nix +++ b/pkgs/applications/science/biology/last/default.nix @@ -2,13 +2,13 @@ stdenv.mkDerivation rec { pname = "last"; - version = "1268"; + version = "1406"; src = fetchFromGitLab { owner = "mcfrith"; repo = "last"; rev = version; - sha256 = "sha256-9yzeLg3xporl32sZ1Ks8s63jXJNGUiI64XyQmhbQF4M="; + sha256 = "sha256-N1B9W++4SiMRMUjDi8ZexOWF/HQpN8BBPuDKYh4bCS8="; }; nativeBuildInputs = [ unzip ]; diff --git a/pkgs/applications/version-management/git-and-tools/git-machete/default.nix b/pkgs/applications/version-management/git-and-tools/git-machete/default.nix index bfa1e578fda9c..ffe5aeb7ee34d 100644 --- a/pkgs/applications/version-management/git-and-tools/git-machete/default.nix +++ b/pkgs/applications/version-management/git-and-tools/git-machete/default.nix @@ -12,13 +12,13 @@ buildPythonApplication rec { pname = "git-machete"; - version = "3.11.3"; + version = "3.11.4"; src = fetchFromGitHub { owner = "virtuslab"; repo = pname; rev = "v${version}"; - sha256 = "sha256-3DIRHvl6r/NhTEQiGqgY59xSI4Y67xRcETgyVv1DIVA="; + sha256 = "sha256-nP7TOxTvf2twfS3rLYjiR6iRTS+lA6iJttqzlj4rGm0="; }; nativeBuildInputs = [ installShellFiles ]; diff --git a/pkgs/development/interpreters/jruby/default.nix b/pkgs/development/interpreters/jruby/default.nix index fc49f2c73ff8b..d8fe3c626005d 100644 --- a/pkgs/development/interpreters/jruby/default.nix +++ b/pkgs/development/interpreters/jruby/default.nix @@ -6,11 +6,11 @@ rubyVersion = callPackage ../ruby/ruby-version.nix {} "2" "5" "7" ""; jruby = stdenv.mkDerivation rec { pname = "jruby"; - version = "9.3.4.0"; + version = "9.3.6.0"; src = fetchurl { url = "https://s3.amazonaws.com/jruby.org/downloads/${version}/jruby-bin-${version}.tar.gz"; - sha256 = "sha256-UxVE0yeocVXYyATxU6LfPPBPAYJWHLLdLJNy9IYFtlw="; + sha256 = "sha256-dHr2r5mmdPII9A2o2yLXfG2kk6gygOmQtS1SOr2UmeI="; }; nativeBuildInputs = [ makeWrapper ]; diff --git a/pkgs/development/libraries/matio/default.nix b/pkgs/development/libraries/matio/default.nix index 1805de0264cea..c92c712e1500f 100644 --- a/pkgs/development/libraries/matio/default.nix +++ b/pkgs/development/libraries/matio/default.nix @@ -11,7 +11,7 @@ stdenv.mkDerivation rec { description = "A C library for reading and writing Matlab MAT files"; homepage = "http://matio.sourceforge.net/"; license = licenses.bsd2; - maintainers = [ maintainers.vbgl ]; + maintainers = [ ]; mainProgram = "matdump"; platforms = platforms.all; }; diff --git a/pkgs/development/libraries/proj/7.nix b/pkgs/development/libraries/proj/7.nix index 25cd5179f7c79..95c02febdabc1 100644 --- a/pkgs/development/libraries/proj/7.nix +++ b/pkgs/development/libraries/proj/7.nix @@ -54,6 +54,6 @@ stdenv.mkDerivation rec { homepage = "https://proj4.org"; license = licenses.mit; platforms = platforms.unix; - maintainers = with maintainers; [ vbgl dotlambda ]; + maintainers = with maintainers; [ dotlambda ]; }; } diff --git a/pkgs/development/libraries/proj/default.nix b/pkgs/development/libraries/proj/default.nix index a5a19dc9db2ea..68b47e2a2eb3c 100644 --- a/pkgs/development/libraries/proj/default.nix +++ b/pkgs/development/libraries/proj/default.nix @@ -54,6 +54,6 @@ stdenv.mkDerivation rec { homepage = "https://proj.org/"; license = licenses.mit; platforms = platforms.unix; - maintainers = with maintainers; [ vbgl dotlambda ]; + maintainers = with maintainers; [ dotlambda ]; }; } diff --git a/pkgs/development/libraries/zxing-cpp/default.nix b/pkgs/development/libraries/zxing-cpp/default.nix index 514ebe9975adc..126ef2bc69d69 100644 --- a/pkgs/development/libraries/zxing-cpp/default.nix +++ b/pkgs/development/libraries/zxing-cpp/default.nix @@ -7,13 +7,13 @@ stdenv.mkDerivation rec { pname = "zxing-cpp"; - version = "1.2.0"; + version = "1.4.0"; src = fetchFromGitHub { owner = "nu-book"; repo = pname; rev = "v${version}"; - hash = "sha256-M565VNKhSmYFmCMEI9UFuHWNZWeHrf9qzZkMAw9LUr4="; + hash = "sha256-MTu8tvJXpo6+Z0aSIZ27nmerNtNBOwnL/jDkGedIiM8="; }; nativeBuildInputs = [ diff --git a/pkgs/development/misc/resholve/README.md b/pkgs/development/misc/resholve/README.md index 1ea8843c01ed7..28fbfbb707efd 100644 --- a/pkgs/development/misc/resholve/README.md +++ b/pkgs/development/misc/resholve/README.md @@ -53,13 +53,13 @@ Here's a simple example of how `resholve.mkDerivation` is already used in nixpkg resholve.mkDerivation rec { pname = "dgoss"; - version = "0.3.16"; + version = "0.3.18"; src = fetchFromGitHub { owner = "aelsabbahy"; repo = "goss"; rev = "v${version}"; - sha256 = "1m5w5vwmc9knvaihk61848rlq7qgdyylzpcwi64z84rkw8qdnj6p"; + sha256 = "01ssc7rnnwpyhjv96qy8drsskghbfpyxpsahk8s62lh8pxygynhv"; }; dontConfigure = true; @@ -75,8 +75,8 @@ resholve.mkDerivation rec { scripts = [ "bin/dgoss" ]; interpreter = "${bash}/bin/bash"; inputs = [ coreutils which ]; - fake = { - external = [ "docker" ]; + keep = { + "$CONTAINER_RUNTIME" = true; }; }; }; @@ -279,7 +279,7 @@ execer = [ ]; # --wrapper '${gnugrep}/bin/egrep:${gnugrep}/bin/grep' -execer = [ +wrapper = [ /* This is the same verdict binlore will come up with. It's a no-op just to demo diff --git a/pkgs/development/misc/resholve/source.nix b/pkgs/development/misc/resholve/source.nix index ee69f6c21be9c..fa3b9c80e31d0 100644 --- a/pkgs/development/misc/resholve/source.nix +++ b/pkgs/development/misc/resholve/source.nix @@ -3,7 +3,7 @@ }: rec { - version = "0.8.0"; + version = "0.8.1"; rSrc = # local build -> `make ci`; `make clean` to restore # return to remote source @@ -14,6 +14,6 @@ rec { owner = "abathur"; repo = "resholve"; rev = "v${version}"; - hash = "sha256-oWS4ZBPjgH2UvYmvHVVRcyl15r3VS964BmB89y9DGo8="; + hash = "sha256-EVrv4Lj9GQa3g18BRQjC0wCxzsfsn4Ka1iq5Ouu1cII="; }; } diff --git a/pkgs/development/python-modules/jug/default.nix b/pkgs/development/python-modules/jug/default.nix index 6e3f053e6d3ea..3de77e17095e6 100644 --- a/pkgs/development/python-modules/jug/default.nix +++ b/pkgs/development/python-modules/jug/default.nix @@ -11,7 +11,7 @@ buildPythonPackage rec { pname = "jug"; - version = "2.2.1"; + version = "2.2.2"; format = "setuptools"; disabled = pythonOlder "3.7"; @@ -19,7 +19,7 @@ buildPythonPackage rec { src = fetchPypi { pname = "Jug"; inherit version; - hash = "sha256-7yWVhvY5dAkmo29xjIUsJVy5oY43K7rcy4itGM+RIFk="; + hash = "sha256-3uK6mWaLEGPFoPuznU+OcnkjFZ+beDoIw0vOC4l5gRg="; }; propagatedBuildInputs = [ diff --git a/pkgs/development/tools/kdash/default.nix b/pkgs/development/tools/kdash/default.nix index daa07f1ceed62..7d610adb9efee 100644 --- a/pkgs/development/tools/kdash/default.nix +++ b/pkgs/development/tools/kdash/default.nix @@ -12,13 +12,13 @@ rustPlatform.buildRustPackage rec { pname = "kdash"; - version = "0.3.1"; + version = "0.3.2"; src = fetchFromGitHub { owner = "kdash-rs"; repo = pname; rev = "v${version}"; - sha256 = "08ca638kvs98xhbc9g1szw0730cjk9g01qqaja8j413n2h1pr8yq"; + sha256 = "sha256-aZjt4Xptv1R0qs1IqjTMfWYOD5ZgJR6atAUSQhY5250="; }; nativeBuildInputs = [ perl python3 pkg-config ]; @@ -26,7 +26,7 @@ rustPlatform.buildRustPackage rec { buildInputs = [ openssl xorg.xcbutil ] ++ lib.optional stdenv.isDarwin AppKit; - cargoSha256 = "0nb554y8r7gvw7ls6gnrg98xxbws0mc6zdsc6ss3p2x9z8xwx204"; + cargoSha256 = "sha256-QlQ+mqhl9Dsajc2xSZP1mKTvCEMI/IbtaNtu2r7G1aM="; meta = with lib; { description = "A simple and fast dashboard for Kubernetes"; diff --git a/pkgs/development/tools/literate-programming/nuweb/default.nix b/pkgs/development/tools/literate-programming/nuweb/default.nix index 72dc1ba21865b..d689504aca99d 100644 --- a/pkgs/development/tools/literate-programming/nuweb/default.nix +++ b/pkgs/development/tools/literate-programming/nuweb/default.nix @@ -3,11 +3,11 @@ stdenv.mkDerivation rec { pname = "nuweb"; - version = "1.60"; + version = "1.62"; src = fetchurl { url = "mirror://sourceforge/project/nuweb/${pname}-${version}.tar.gz"; - sha256 = "08xmwq48biy2c1fr8wnyknyvqs9jfsj42cb7fw638xqv35f0xxvl"; + sha256 = "sha256-JVqPYkYPXBT0xLNWuW4DV6N6ZlKuBYQGT46frhnpU64="; }; buildInputs = [ tex ]; @@ -18,8 +18,8 @@ stdenv.mkDerivation rec { # Workaround build failure on -fno-common toolchains like upstream # gcc-10. Otherwise build fails as: - # ld: global.o:/build/nuweb-1.60/global.h:91: multiple definition of - # `current_sector'; main.o:/build/nuweb-1.60/global.h:91: first defined here + # ld: global.o:/build/nuweb-1.62/global.h:91: multiple definition of + # `current_sector'; main.o:/build/nuweb-1.62/global.h:91: first defined here NIX_CFLAGS_COMPILE = "-fcommon"; buildPhase = '' diff --git a/pkgs/development/tools/misc/saleae-logic-2/default.nix b/pkgs/development/tools/misc/saleae-logic-2/default.nix index f606bc609713f..a8d4f8b28c91f 100644 --- a/pkgs/development/tools/misc/saleae-logic-2/default.nix +++ b/pkgs/development/tools/misc/saleae-logic-2/default.nix @@ -1,10 +1,10 @@ { lib, fetchurl, makeDesktopItem, appimageTools }: let name = "saleae-logic-2"; - version = "2.3.55"; + version = "2.3.56"; src = fetchurl { url = "https://downloads.saleae.com/logic2/Logic-${version}-master.AppImage"; - sha256 = "sha256-fL72KZzOh9pWrjSaXDCMz0ijqRj1Vc5Ym37onv4E7aI="; + sha256 = "sha256-dH52yIzGO5n+TwNNPu51cpNIrqG/9CXERrJvo+m6R4w="; }; desktopItem = makeDesktopItem { inherit name; diff --git a/pkgs/development/tools/wizer/default.nix b/pkgs/development/tools/wizer/default.nix new file mode 100644 index 0000000000000..f79c96f545184 --- /dev/null +++ b/pkgs/development/tools/wizer/default.nix @@ -0,0 +1,32 @@ +{ lib, stdenv, rustPlatform, fetchCrate }: + +rustPlatform.buildRustPackage rec { + pname = "wizer"; + version = "1.4.0"; + + src = fetchCrate { + inherit pname version; + + sha256 = "sha256-3Hc3KKqtbZtvD+3lb/W7+AyrwPukJyxpUe94KGQlzBI="; + }; + + cargoSha256 = "sha256-zv36/W7dNpIupYn8TS+NaF7uX+BVjrI6AW6Hrlqr8Xg="; + + cargoBuildFlags = [ "--bin" pname ]; + + buildFeatures = [ "env_logger" "structopt" ]; + + # Setting $HOME to a temporary directory is necessary to prevent checks from failing, as + # the test suite creates a cache directory at $HOME/Library/Caches/BytecodeAlliance.wasmtime. + preCheck = '' + export HOME=$(mktemp -d) + ''; + + meta = with lib; { + description = "The WebAssembly pre-initializer"; + homepage = "https://github.com/bytecodealliance/wizer"; + license = licenses.asl20; + maintainers = with maintainers; [ lucperkins ]; + broken = stdenv.isx86_64 && stdenv.isDarwin; + }; +} diff --git a/pkgs/development/tools/zprint/default.nix b/pkgs/development/tools/zprint/default.nix index f3f8bae1e8e92..8cc2e119a4bf4 100644 --- a/pkgs/development/tools/zprint/default.nix +++ b/pkgs/development/tools/zprint/default.nix @@ -2,11 +2,11 @@ buildGraalvmNativeImage rec { pname = "zprint"; - version = "1.2.2"; + version = "1.2.3"; src = fetchurl { url = "https://github.com/kkinnear/${pname}/releases/download/${version}/${pname}-filter-${version}"; - sha256 = "sha256-CaugPTfEGC0IFgYUSHcE3nsnrP5DSXS1becXChbPggQ="; + sha256 = "sha256-DIiUFHlK9NNQeUcfzp4N/+14ejZ9+LRx+5FUjtCa9RM="; }; extraNativeImageBuildArgs = [ diff --git a/pkgs/games/fishfight/default.nix b/pkgs/games/fishfight/default.nix index 422901fd98648..9e5bbde8cf72f 100644 --- a/pkgs/games/fishfight/default.nix +++ b/pkgs/games/fishfight/default.nix @@ -2,54 +2,53 @@ , rustPlatform , fetchFromGitHub , stdenv -, SDL2 +, pkg-config , alsa-lib , libGL , libX11 , libXi -, AudioToolbox +, udev , Cocoa -, CoreAudio , OpenGL }: rustPlatform.buildRustPackage rec { pname = "fishfight"; - version = "0.3"; + version = "0.4.2"; src = fetchFromGitHub { owner = "fishfight"; repo = pname; rev = "v${version}"; - sha256 = "sha256-kLdk7zTICZ8iawNttTsWUVKGvh2zykXVsMqUyYoGrBs="; + sha256 = "sha256-q1Hh4P/huoFuW/+Mb9yKUMKaky1RshGpjrObBHRCk+8="; }; - # use system sdl2 instead of bundled sdl2 - cargoPatches = [ ./use-system-sdl2.patch ]; + cargoSha256 = "sha256-PEGK95eXIHv2sxSwUU4345KtxDyRJn/+aEiJIDmkq6Y="; - cargoSha256 = "sha256-KQiqUzdsVMIjDmmreihekrrFoXeyNzd6ZbqApwH8B4Q="; + nativeBuildInputs = lib.optionals stdenv.isLinux [ + pkg-config + ]; - buildInputs = [ - SDL2 - ] ++ lib.optionals stdenv.isLinux [ + buildInputs = lib.optionals stdenv.isLinux [ alsa-lib libGL libX11 libXi + udev ] ++ lib.optionals stdenv.isDarwin [ - AudioToolbox Cocoa - CoreAudio OpenGL ]; postPatch = '' - substituteInPlace src/main.rs --replace ./assets $out/share/assets + substituteInPlace src/main.rs \ + --replace ./assets $out/share/assets \ + --replace ./mods $out/share/mods ''; postInstall = '' mkdir $out/share - cp -r assets $out/share + cp -r assets mods $out/share ''; meta = with lib; { diff --git a/pkgs/games/fishfight/use-system-sdl2.patch b/pkgs/games/fishfight/use-system-sdl2.patch deleted file mode 100644 index fcae36ce68b0e..0000000000000 --- a/pkgs/games/fishfight/use-system-sdl2.patch +++ /dev/null @@ -1,39 +0,0 @@ ---- a/Cargo.lock -+++ b/Cargo.lock -@@ -96,15 +96,6 @@ version = "1.0.0" - source = "registry+https://github.com/rust-lang/crates.io-index" - checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" - --[[package]] --name = "cmake" --version = "0.1.46" --source = "registry+https://github.com/rust-lang/crates.io-index" --checksum = "b7b858541263efe664aead4a5209a4ae5c5d2811167d4ed4ee0944503f8d2089" --dependencies = [ -- "cc", --] -- - [[package]] - name = "color_quant" - version = "1.1.0" -@@ -605,7 +596,6 @@ source = "registry+https://github.com/rust-lang/crates.io-index" - checksum = "94cb479353c0603785c834e2307440d83d196bf255f204f7f6741358de8d6a2f" - dependencies = [ - "cfg-if", -- "cmake", - "libc", - "version-compare", - ] -diff --git a/Cargo.toml b/Cargo.toml -index d2af29e..a813f30 100644 ---- a/Cargo.toml -+++ b/Cargo.toml -@@ -14,7 +14,7 @@ macroquad-profiler = "0.1" - - ff-particles = { version = "0.1", features = ["serde"] } - --fishsticks = { version = "0.2.0", features = ["bundled-sdl2"] } -+fishsticks = "0.2.0" - - stunclient = { git = "https://github.com/not-fl3/rust-stunclient", default-features = false } - diff --git a/pkgs/games/lgames/lbreakouthd/default.nix b/pkgs/games/lgames/lbreakouthd/default.nix index 59447f2d0029f..bfe8eecc95b86 100644 --- a/pkgs/games/lgames/lbreakouthd/default.nix +++ b/pkgs/games/lgames/lbreakouthd/default.nix @@ -9,11 +9,11 @@ stdenv.mkDerivation rec { pname = "lbreakouthd"; - version = "1.0.9"; + version = "1.0.10"; src = fetchurl { url = "mirror://sourceforge/lgames/${pname}-${version}.tar.gz"; - hash = "sha256-MHwK4jeDfZSS4jh///jW0/q4ntM4IuB0fQ8Bsaq0d0s="; + hash = "sha256-hlGhPa91u6pOaZoFJSDcXYQdizTFjuuTLnx9fcrXUhA="; }; buildInputs = [ diff --git a/pkgs/games/lgames/ltris/default.nix b/pkgs/games/lgames/ltris/default.nix index acf0f64d8c2bf..618e86561f031 100644 --- a/pkgs/games/lgames/ltris/default.nix +++ b/pkgs/games/lgames/ltris/default.nix @@ -2,11 +2,11 @@ stdenv.mkDerivation rec { pname = "ltris"; - version = "1.2.4"; + version = "1.2.5"; src = fetchurl { url = "mirror://sourceforge/lgames/${pname}-${version}.tar.gz"; - hash = "sha256-1ut7MBAjJ4YE2SkqkvL9L1ED7kEqdaEm0lUOLsI2j4M="; + hash = "sha256-Ksb5TdQMTEzaJfjHVhgq27dSFvZxUnNUQ6OpAU+xwzM="; }; buildInputs = [ diff --git a/pkgs/misc/wiki-tui/default.nix b/pkgs/misc/wiki-tui/default.nix index cc98cf46d0788..e5601095ebbc3 100644 --- a/pkgs/misc/wiki-tui/default.nix +++ b/pkgs/misc/wiki-tui/default.nix @@ -2,20 +2,20 @@ rustPlatform.buildRustPackage rec { pname = "wiki-tui"; - version = "0.4.8"; + version = "0.5.1"; src = fetchFromGitHub { owner = "Builditluc"; repo = pname; rev = "v${version}"; - sha256 = "sha256-/u0segKHrrtXfEjOmpnQ/iFbsM+VfsZKTpyc1IfuOU8="; + sha256 = "sha256-kcVfqj5vRfPcF6lO1Ley3ctZajNA02jUqQRlpi3MkXc="; }; buildInputs = [ ncurses openssl ] ++ lib.optional stdenv.isDarwin Security; nativeBuildInputs = [ pkg-config ]; - cargoSha256 = "sha256-3xvaEzqAz/U8CkdGYXLBnxrgW1raeKuzRsmD+0Sd4iQ="; + cargoSha256 = "sha256-OW2kutjvQC9neiguixTdJx2hUFsnmQhR9DbniBr6V8w="; # Tests fail with this error: `found argument --test-threads which was not expected` doCheck = false; diff --git a/pkgs/os-specific/darwin/apple-source-releases/default.nix b/pkgs/os-specific/darwin/apple-source-releases/default.nix index 3636b6e3763ce..df47d53514abd 100644 --- a/pkgs/os-specific/darwin/apple-source-releases/default.nix +++ b/pkgs/os-specific/darwin/apple-source-releases/default.nix @@ -293,7 +293,9 @@ developerToolsPackages_11_3_1 // macosPackages_11_0_1 // { diskdev_cmds = applePackage "diskdev_cmds" "osx-10.11.6" "1ssdyiaq5m1zfy96yy38yyknp682ki6bvabdqd5z18fa0rv3m2ar" { macosPackages_11_0_1 = macosPackages_11_0_1; }; - network_cmds = applePackage "network_cmds" "osx-10.11.6" "0lhi9wz84qr1r2ab3fb4nvmdg9gxn817n5ldg7zw9gnf3wwn42kw" {}; + network_cmds = if stdenv.isx86_64 then + applePackage "network_cmds" "osx-10.11.6" "0lhi9wz84qr1r2ab3fb4nvmdg9gxn817n5ldg7zw9gnf3wwn42kw" {} + else macosPackages_11_0_1.network_cmds; file_cmds = applePackage "file_cmds" "osx-10.11.6" "1zfxbmasps529pnfdjvc13p7ws2cfx8pidkplypkswyff0nff4wp" {}; shell_cmds = applePackage "shell_cmds" "osx-10.11.6" "0084k271v66h4jqp7q7rmjvv7w4mvhx3aq860qs8jbd30canm86n" {}; system_cmds = applePackage "system_cmds" "osx-10.11.6" "1h46j2c5v02pkv5d9fyv6cpgyg0lczvwicrx6r9s210cl03l77jl" {}; diff --git a/pkgs/os-specific/darwin/apple-source-releases/network_cmds/default.nix b/pkgs/os-specific/darwin/apple-source-releases/network_cmds/default.nix index 2c93ad38b3255..9a95eb04e6efe 100644 --- a/pkgs/os-specific/darwin/apple-source-releases/network_cmds/default.nix +++ b/pkgs/os-specific/darwin/apple-source-releases/network_cmds/default.nix @@ -1,11 +1,13 @@ -{ lib, appleDerivation, xcbuildHook +{ lib, appleDerivation, xcbuildHook, stdenv , libressl_3_4, Librpcsvc, xnu, libpcap, developer_cmds }: appleDerivation { nativeBuildInputs = [ xcbuildHook ]; buildInputs = [ libressl_3_4 xnu Librpcsvc libpcap developer_cmds ]; - NIX_CFLAGS_COMPILE = " -I./unbound -I${xnu}/Library/Frameworks/System.framework/Headers/"; + # Work around error from <stdio.h> on aarch64-darwin: + # error: 'TARGET_OS_IPHONE' is not defined, evaluates to 0 [-Werror,-Wundef-prefix=TARGET_OS_] + NIX_CFLAGS_COMPILE = "-Wno-error=undef-prefix -I./unbound -I${xnu}/Library/Frameworks/System.framework/Headers/"; # "spray" requires some files that aren't compiling correctly in xcbuild. # "rtadvd" seems to fail with some missing constants. @@ -16,6 +18,10 @@ appleDerivation { --replace "7216D34D0EE89FEC00AE70E4 /* PBXTargetDependency */," "" \ --replace "72CD1D9C0EE8C47C005F825D /* PBXTargetDependency */," "" \ --replace "7216D2C20EE89ADF00AE70E4 /* PBXTargetDependency */," "" + '' + lib.optionalString stdenv.isAarch64 '' + # "unbound" does not build on aarch64 + substituteInPlace network_cmds.xcodeproj/project.pbxproj \ + --replace "71D958C51A9455A000C9B286 /* PBXTargetDependency */," "" ''; # temporary install phase until xcodebuild has "install" support diff --git a/pkgs/os-specific/linux/libtraceevent/default.nix b/pkgs/os-specific/linux/libtraceevent/default.nix index 7fc577d0ab0eb..c81949bf39a6c 100644 --- a/pkgs/os-specific/linux/libtraceevent/default.nix +++ b/pkgs/os-specific/linux/libtraceevent/default.nix @@ -2,12 +2,12 @@ stdenv.mkDerivation rec { pname = "libtraceevent"; - version = "1.6.1"; + version = "1.6.2"; src = fetchgit { url = "git://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git"; rev = "libtraceevent-${version}"; - sha256 = "sha256-Yt7W+ouEZ/pJEKyY2Cgh+mYG0qz0lOIou5JufAD9Zd0="; + sha256 = "sha256-iLy2rEKn0UJguRcY/W8RvUq7uX+snQojb/cXOmMsjwc="; }; # Don't build and install html documentation diff --git a/pkgs/os-specific/linux/libtracefs/default.nix b/pkgs/os-specific/linux/libtracefs/default.nix index c4bec6629874c..3a973b9880d51 100644 --- a/pkgs/os-specific/linux/libtracefs/default.nix +++ b/pkgs/os-specific/linux/libtracefs/default.nix @@ -15,12 +15,12 @@ stdenv.mkDerivation rec { pname = "libtracefs"; - version = "1.4.1"; + version = "1.4.2"; src = fetchgit { url = "git://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git"; rev = "libtracefs-${version}"; - sha256 = "sha256-htif1Hty/AQkx6jALHUVMBF1wIpVwLmdINP8QUZmv/s="; + sha256 = "sha256-CmFzonPq91iLflolJaucpPWzb8MCgfuov/OQ6KUD3f4="; }; postPatch = '' diff --git a/pkgs/os-specific/linux/powercap/default.nix b/pkgs/os-specific/linux/powercap/default.nix index 24832e5fdff92..96ec83852d9db 100644 --- a/pkgs/os-specific/linux/powercap/default.nix +++ b/pkgs/os-specific/linux/powercap/default.nix @@ -2,13 +2,13 @@ stdenv.mkDerivation rec { pname = "powercap"; - version = "0.5.0"; + version = "0.6.0"; src = fetchFromGitHub { owner = "powercap"; repo = "powercap"; rev = "v${version}"; - sha256 = "sha256-VvepbABc7daRE0/sJqsCb+m2my8O3B1ICXywBqsjSO8="; + sha256 = "sha256-l+IpFqBnCYUU825++sUPySD/Ku0TEIX2kt+S0Wml6iA="; }; nativeBuildInputs = [ cmake ]; diff --git a/pkgs/servers/web-apps/nifi/default.nix b/pkgs/servers/web-apps/nifi/default.nix index b53b53aaf5c7a..d6d6ba0d5fcb6 100644 --- a/pkgs/servers/web-apps/nifi/default.nix +++ b/pkgs/servers/web-apps/nifi/default.nix @@ -2,11 +2,11 @@ stdenv.mkDerivation rec { pname = "nifi"; - version = "1.16.1"; + version = "1.16.3"; src = fetchurl { url = "https://dlcdn.apache.org/nifi/${version}/nifi-${version}-bin.tar.gz"; - sha256 = "sha256-wC+oKq8QGEKuD6B22Ny92NK0z3SBKmRoTEit3vAXJQs="; + sha256 = "sha256-57ZtgK1Z8G/nX2rtf7osmymvE4RukGi7CIvCvRQNKuE="; }; nativeBuildInputs = [ makeWrapper ]; diff --git a/pkgs/tools/misc/gpick/default.nix b/pkgs/tools/misc/gpick/default.nix index 0d39bb810b930..8edb12684cee9 100644 --- a/pkgs/tools/misc/gpick/default.nix +++ b/pkgs/tools/misc/gpick/default.nix @@ -1,4 +1,15 @@ -{ stdenv, fetchFromGitHub, cmake, glib, boost, pkg-config, gtk3, ragel, lua, lib }: +{ stdenv +, fetchFromGitHub +, cmake +, glib +, wrapGAppsHook +, boost +, pkg-config +, gtk3 +, ragel +, lua +, lib +}: stdenv.mkDerivation rec { pname = "gpick"; @@ -11,7 +22,7 @@ stdenv.mkDerivation rec { sha256 = "sha256-Z67EJRtKJZLoTUtdMttVTLkzTV2F5rKZ96vaothLiFo="; }; - nativeBuildInputs = [ cmake pkg-config ]; + nativeBuildInputs = [ cmake pkg-config wrapGAppsHook ]; NIX_CFLAGS_COMPILE = "-I${glib.dev}/include/gio-unix-2.0"; buildInputs = [ boost gtk3 ragel lua ]; diff --git a/pkgs/tools/misc/mutagen-compose/default.nix b/pkgs/tools/misc/mutagen-compose/default.nix index f5e31ed2d37bc..3147acb702597 100644 --- a/pkgs/tools/misc/mutagen-compose/default.nix +++ b/pkgs/tools/misc/mutagen-compose/default.nix @@ -2,16 +2,16 @@ buildGoModule rec { pname = "mutagen-compose"; - version = "0.14.0"; + version = "0.15.0-1"; src = fetchFromGitHub { owner = "mutagen-io"; repo = pname; rev = "v${version}"; - sha256 = "sha256-FNV4X9/BdnfFGKVJXNpCJLdr3Y29LrGi+zUuQ07xUbE="; + sha256 = "sha256-Po3AsY6IMSY6Bu51ZhV50cmB79J3Xud4svdjssKKBOU="; }; - vendorSha256 = "sha256-5nt9YHMgaRpkFdOnBTU4gSdOtB3h9Cj5CCUjx9PJ/m8="; + vendorSha256 = "sha256-lkb4+EA6UB/GysqiA8z+84Lpb93PiMb4/3LKxfltGNE="; doCheck = false; diff --git a/pkgs/tools/misc/nb/default.nix b/pkgs/tools/misc/nb/default.nix index 422e315fc9a64..1977cef48157b 100644 --- a/pkgs/tools/misc/nb/default.nix +++ b/pkgs/tools/misc/nb/default.nix @@ -2,13 +2,13 @@ stdenv.mkDerivation rec { pname = "nb"; - version = "6.10.1"; + version = "6.11.2"; src = fetchFromGitHub { owner = "xwmx"; repo = "nb"; rev = version; - sha256 = "00c0k12yc2vqx0am1mhcjbn7fh3dab2zixslyh1smzcww275rk59"; + sha256 = "sha256-FHyI9Bwci2spMz5DiSyVsJ5Vz1t/NJ3gsg13fBbanpc="; }; nativeBuildInputs = [ installShellFiles ]; diff --git a/pkgs/tools/networking/pathvector/default.nix b/pkgs/tools/networking/pathvector/default.nix index 62b3cc2aac934..4ca1504070a24 100644 --- a/pkgs/tools/networking/pathvector/default.nix +++ b/pkgs/tools/networking/pathvector/default.nix @@ -2,13 +2,13 @@ buildGoModule rec { pname = "pathvector"; - version = "6.0.1"; + version = "6.0.2"; src = fetchFromGitHub { owner = "natesales"; repo = "pathvector"; rev = "v${version}"; - sha256 = "sha256-2fCkQVpIcZjKA7URvZyt0DdMyUndLFv1BhsANThghKs="; + sha256 = "sha256-Rr7SVvi2K20qFTd4Gd2BzBTVIa/lCeBAJHLZ6iV2aSw="; }; vendorSha256 = "sha256-bqfYILEGgbnla7EUrzjIO2mMAuL6e4WI2OHUwOr6i+g="; diff --git a/pkgs/tools/security/witness/default.nix b/pkgs/tools/security/witness/default.nix index c3334875d2f05..78b7f32a61df1 100644 --- a/pkgs/tools/security/witness/default.nix +++ b/pkgs/tools/security/witness/default.nix @@ -2,15 +2,15 @@ buildGoModule rec { pname = "witness"; - version = "0.1.10"; + version = "0.1.11"; src = fetchFromGitHub { owner = "testifysec"; repo = pname; rev = "v${version}"; - sha256 = "sha256-BRYp8gp3TNZrl6fRNHOIgdhCVCN+N2lReFk+0FxCUxY="; + sha256 = "sha256-/v6dltF4oCIOtN6Fcpf+VvT+c3vTB1q/IgGUqZzbcVk="; }; - vendorSha256 = "sha256-/NniYty50dO44VUTfVq9b8dbT3le4uZ2ZoDN4IjLBto="; + vendorSha256 = "sha256-UP68YNLX+fuCvd+e3rER1icha9bS3MemJLwJOMMOVfg="; nativeBuildInputs = [ installShellFiles ]; diff --git a/pkgs/tools/text/opencc/default.nix b/pkgs/tools/text/opencc/default.nix index 193c541cfab02..631835905a1f4 100644 --- a/pkgs/tools/text/opencc/default.nix +++ b/pkgs/tools/text/opencc/default.nix @@ -2,13 +2,13 @@ stdenv.mkDerivation rec { pname = "opencc"; - version = "1.1.3"; + version = "1.1.4"; src = fetchFromGitHub { owner = "BYVoid"; repo = "OpenCC"; rev = "ver.${version}"; - sha256 = "sha256-q/y4tRov/BYCAiE4i7fT6ysTerxxOHMZUWT2Jlo/0rI="; + sha256 = "sha256-h/QKXPWHNgWf5Q9UIaNmP85YTUMN7RlRdlNI4NuBrO8="; }; nativeBuildInputs = [ cmake python3 ]; diff --git a/pkgs/top-level/all-packages.nix b/pkgs/top-level/all-packages.nix index beba531295477..536319c0da1b9 100644 --- a/pkgs/top-level/all-packages.nix +++ b/pkgs/top-level/all-packages.nix @@ -32475,7 +32475,7 @@ with pkgs; fishfight = callPackage ../games/fishfight { inherit (xorg) libX11 libXi; - inherit (darwin.apple_sdk.frameworks) AudioToolbox Cocoa CoreAudio OpenGL; + inherit (darwin.apple_sdk.frameworks) Cocoa OpenGL; }; flightgear = libsForQt5.callPackage ../games/flightgear { }; @@ -35731,6 +35731,8 @@ with pkgs; with-shell = callPackage ../applications/misc/with-shell { }; + wizer = darwin.apple_sdk_11_0.callPackage ../development/tools/wizer {}; + wmutils-core = callPackage ../tools/X11/wmutils-core { }; wmutils-libwm = callPackage ../tools/X11/wmutils-libwm { }; |