diff --git a/nixos/lib/make-options-doc/default.nix b/nixos/lib/make-options-doc/default.nix
index e039bc4a9b73..6649fc41d41a 100644
--- a/nixos/lib/make-options-doc/default.nix
+++ b/nixos/lib/make-options-doc/default.nix
@@ -99,14 +99,6 @@ 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;
@@ -124,20 +116,17 @@ in rec {
optionsJSON = pkgs.runCommand "options.json"
{ meta.description = "List of NixOS options in JSON format";
- buildInputs = [ pkgs.brotli pythonMD ];
+ buildInputs = [
+ pkgs.brotli
+ (let
+ self = (pkgs.python3Minimal.override {
+ inherit self;
+ includeSiteCustomize = true;
+ });
+ in self.withPackages (p: [ p.mistune_2_0 ]))
+ ];
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.
@@ -154,7 +143,7 @@ in rec {
else ''
python ${./mergeJSON.py} \
${lib.optionalString warningsAreErrors "--warnings-are-errors"} \
- $baseJSON $options \
+ ${baseOptionsJSON} $options \
> $dst/options.json
''
}
diff --git a/nixos/lib/make-options-doc/mergeJSON.py b/nixos/lib/make-options-doc/mergeJSON.py
index e95352f4fe6f..d7dc6ca30074 100644
--- a/nixos/lib/make-options-doc/mergeJSON.py
+++ b/nixos/lib/make-options-doc/mergeJSON.py
@@ -3,6 +3,11 @@ import json
import sys
from typing import Any, Dict, List
+# for MD conversion
+import mistune
+import re
+from xml.sax.saxutils import escape, quoteattr
+
JSON = Dict[str, Any]
class Key:
@@ -41,137 +46,135 @@ def unpivot(options: Dict[Key, Option]) -> Dict[str, JSON]:
result[opt.name] = opt.value
return result
+admonitions = {
+ '.warning': 'warning',
+ '.important': 'important',
+ '.note': 'note'
+}
+class Renderer(mistune.renderers.BaseRenderer):
+ 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)
+ return not_supported
+
+ def text(self, text):
+ return escape(text)
+ def paragraph(self, text):
+ return text + "\n\n"
+ def newline(self):
+ return "\n"
+ def codespan(self, text):
+ return f"{escape(text)}"
+ def block_code(self, text, info=None):
+ info = f" language={quoteattr(info)}" if info is not None else ""
+ return f"\n{escape(text)}"
+ def link(self, link, text=None, title=None):
+ tag = "link"
+ if link[0:1] == '#':
+ if text == "":
+ tag = "xref"
+ attr = "linkend"
+ link = quoteattr(link[1:])
+ else:
+ # try to faithfully reproduce links that were of the form
+ # in docbook format
+ if text == link:
+ text = ""
+ attr = "xlink:href"
+ link = quoteattr(link)
+ return f"<{tag} {attr}={link}>{text}{tag}>"
+ def list(self, text, ordered, level, start=None):
+ if ordered:
+ raise NotImplementedError("ordered lists not supported yet")
+ return f"\n{text}\n"
+ def list_item(self, text, level):
+ return f"{text}\n"
+ def block_text(self, text):
+ return text
+ def emphasis(self, text):
+ return f"{text}"
+ def strong(self, text):
+ return f"{text}"
+ def admonition(self, text, kind):
+ if kind not in admonitions:
+ raise NotImplementedError(f"admonition {kind} not supported yet")
+ tag = admonitions[kind]
+ # we don't keep whitespace here because usually we'll contain only
+ # a single paragraph and the original docbook string is no longer
+ # available to restore the trailer.
+ return f"<{tag}>{text.rstrip()}{tag}>"
+ def block_quote(self, text):
+ return f"
{text}
"
+ def command(self, text):
+ return f"{escape(text)}"
+ def option(self, text):
+ return f""
+ def file(self, text):
+ return f"{escape(text)}"
+ def manpage(self, page, section):
+ title = f"{escape(page)}"
+ vol = f"{escape(section)}"
+ return f"{title}{vol}"
+
+ def finalize(self, data):
+ return "".join(data)
+
+def p_command(md):
+ COMMAND_PATTERN = r'\{command\}`(.*?)`'
+ def parse(self, m, state):
+ return ('command', m.group(1))
+ md.inline.register_rule('command', COMMAND_PATTERN, parse)
+ md.inline.rules.append('command')
+
+def p_file(md):
+ FILE_PATTERN = r'\{file\}`(.*?)`'
+ def parse(self, m, state):
+ return ('file', m.group(1))
+ md.inline.register_rule('file', FILE_PATTERN, parse)
+ md.inline.rules.append('file')
+
+def p_option(md):
+ OPTION_PATTERN = r'\{option\}`(.*?)`'
+ def parse(self, m, state):
+ return ('option', m.group(1))
+ md.inline.register_rule('option', OPTION_PATTERN, parse)
+ md.inline.rules.append('option')
+
+def p_manpage(md):
+ MANPAGE_PATTERN = r'\{manpage\}`(.*?)\((.+?)\)`'
+ def parse(self, m, state):
+ return ('manpage', m.group(1), m.group(2))
+ md.inline.register_rule('manpage', MANPAGE_PATTERN, parse)
+ md.inline.rules.append('manpage')
+
+def p_admonition(md):
+ ADMONITION_PATTERN = re.compile(r'^::: \{([^\n]*?)\}\n(.*?)^:::\n', flags=re.MULTILINE|re.DOTALL)
+ def parse(self, m, state):
+ return {
+ 'type': 'admonition',
+ 'children': self.parse(m.group(2), state),
+ 'params': [ m.group(1) ],
+ }
+ md.block.register_rule('admonition', ADMONITION_PATTERN, parse)
+ md.block.rules.append('admonition')
+
+md = mistune.create_markdown(renderer=Renderer(), plugins=[
+ p_command, p_file, p_option, p_manpage, p_admonition
+])
+
# converts in-place!
def convertMD(options: Dict[str, Any]) -> str:
- import mistune
- import re
- from xml.sax.saxutils import escape, quoteattr
-
- admonitions = {
- '.warning': 'warning',
- '.important': 'important',
- '.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", self.path, name, args, **kwargs)
- return not_supported
-
- def text(self, text):
- return escape(text)
- def paragraph(self, text):
- return text + "\n\n"
- def newline(self):
- return "\n"
- def codespan(self, text):
- return f"{escape(text)}"
- def block_code(self, text, info=None):
- info = f" language={quoteattr(info)}" if info is not None else ""
- return f"\n{escape(text)}"
- def link(self, link, text=None, title=None):
- if link[0:1] == '#':
- attr = "linkend"
- link = quoteattr(link[1:])
- else:
- # try to faithfully reproduce links that were of the form
- # in docbook format
- if text == link:
- text = ""
- attr = "xlink:href"
- link = quoteattr(link)
- return f"{text}"
- def list(self, text, ordered, level, start=None):
- if ordered:
- raise NotImplementedError("ordered lists not supported yet")
- return f"\n{text}\n"
- def list_item(self, text, level):
- return f"{text}\n"
- def block_text(self, text):
- return text
- def emphasis(self, text):
- return f"{text}"
- def strong(self, text):
- return f"{text}"
- def admonition(self, text, kind):
- if kind not in admonitions:
- raise NotImplementedError(f"admonition {kind} not supported yet")
- tag = admonitions[kind]
- # we don't keep whitespace here because usually we'll contain only
- # a single paragraph and the original docbook string is no longer
- # available to restore the trailer.
- return f"<{tag}>{text.rstrip()}{tag}>"
- def block_quote(self, text):
- return f"
{text}
"
- def command(self, text):
- return f"{escape(text)}"
- def option(self, text):
- return f""
- def file(self, text):
- return f"{escape(text)}"
- def manpage(self, page, section):
- title = f"{escape(page)}"
- vol = f"{escape(section)}"
- return f"{title}{vol}"
-
- def finalize(self, data):
- return "".join(data)
-
- plugins = []
-
- COMMAND_PATTERN = r'\{command\}`(.*?)`'
- def command(md):
- def parse(self, m, state):
- return ('command', m.group(1))
- md.inline.register_rule('command', COMMAND_PATTERN, parse)
- md.inline.rules.append('command')
- plugins.append(command)
-
- FILE_PATTERN = r'\{file\}`(.*?)`'
- def file(md):
- def parse(self, m, state):
- return ('file', m.group(1))
- md.inline.register_rule('file', FILE_PATTERN, parse)
- md.inline.rules.append('file')
- plugins.append(file)
-
- OPTION_PATTERN = r'\{option\}`(.*?)`'
- def option(md):
- def parse(self, m, state):
- return ('option', m.group(1))
- md.inline.register_rule('option', OPTION_PATTERN, parse)
- md.inline.rules.append('option')
- plugins.append(option)
-
- MANPAGE_PATTERN = r'\{manpage\}`(.*?)\((.+?)\)`'
- def manpage(md):
- def parse(self, m, state):
- return ('manpage', m.group(1), m.group(2))
- md.inline.register_rule('manpage', MANPAGE_PATTERN, parse)
- md.inline.rules.append('manpage')
- plugins.append(manpage)
-
- ADMONITION_PATTERN = re.compile(r'^::: \{([^\n]*?)\}\n(.*?)^:::\n', flags=re.MULTILINE|re.DOTALL)
- def admonition(md):
- def parse(self, m, state):
- return {
- 'type': 'admonition',
- 'children': self.parse(m.group(2), state),
- 'params': [ m.group(1) ],
- }
- md.block.register_rule('admonition', ADMONITION_PATTERN, parse)
- md.block.rules.append('admonition')
- plugins.append(admonition)
-
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()):]
+ try:
+ rendered = md(text)
+ # keep trailing spaces so we can diff the generated XML to check for conversion bugs.
+ return rendered.rstrip() + text[len(text.rstrip()):]
+ except:
+ print(f"error in {path}")
+ raise
def optionIs(option: Dict[str, Any], key: str, typ: str) -> bool:
if key not in option: return False
diff --git a/nixos/modules/config/i18n.nix b/nixos/modules/config/i18n.nix
index 80ef515fbfe2..f73f10f0f369 100644
--- a/nixos/modules/config/i18n.nix
+++ b/nixos/modules/config/i18n.nix
@@ -71,12 +71,11 @@ with lib;
))
'';
example = ["en_US.UTF-8/UTF-8" "nl_NL.UTF-8/UTF-8" "nl_NL/ISO-8859-1"];
- description = ''
+ description = lib.mdDoc ''
List of locales that the system should support. The value
- "all" means that all locales supported by
+ `"all"` means that all locales supported by
Glibc will be installed. A full list of supported locales
- can be found at .
+ can be found at .
'';
};
diff --git a/nixos/modules/config/resolvconf.nix b/nixos/modules/config/resolvconf.nix
index cdc40d2c810b..76605a063a47 100644
--- a/nixos/modules/config/resolvconf.nix
+++ b/nixos/modules/config/resolvconf.nix
@@ -83,9 +83,9 @@ in
dnsExtensionMechanism = mkOption {
type = types.bool;
default = true;
- description = ''
- Enable the edns0 option in resolv.conf. With
- that option set, glibc supports use of the extension mechanisms for
+ description = lib.mdDoc ''
+ Enable the `edns0` option in {file}`resolv.conf`. With
+ that option set, `glibc` supports use of the extension mechanisms for
DNS (EDNS) specified in RFC 2671. The most popular user of that feature is DNSSEC,
which does not work without it.
'';
diff --git a/nixos/modules/config/shells-environment.nix b/nixos/modules/config/shells-environment.nix
index 660b2e1fa4bf..2fda71749c09 100644
--- a/nixos/modules/config/shells-environment.nix
+++ b/nixos/modules/config/shells-environment.nix
@@ -109,11 +109,11 @@ in
environment.shellAliases = mkOption {
example = { l = null; ll = "ls -l"; };
- description = ''
+ description = lib.mdDoc ''
An attribute set that maps aliases (the top level attribute names in
this option) to command strings or directly to build outputs. The
aliases are added to all users' shells.
- Aliases mapped to null are ignored.
+ Aliases mapped to `null` are ignored.
'';
type = with types; attrsOf (nullOr (either str path));
};
diff --git a/nixos/modules/config/system-environment.nix b/nixos/modules/config/system-environment.nix
index d2a66b8d932d..1e05ab7d0f2b 100644
--- a/nixos/modules/config/system-environment.nix
+++ b/nixos/modules/config/system-environment.nix
@@ -16,7 +16,7 @@ in
environment.sessionVariables = mkOption {
default = {};
- description = ''
+ description = lib.mdDoc ''
A set of environment variables used in the global environment.
These variables will be set by PAM early in the login process.
@@ -25,12 +25,12 @@ in
colon characters.
Note, due to limitations in the PAM format values may not
- contain the " character.
+ contain the `"` character.
Also, these variables are merged into
- and it is
+ [](#opt-environment.variables) and it is
therefore not possible to use PAM style variables such as
- @{HOME}.
+ `@{HOME}`.
'';
type = with types; attrsOf (either str (listOf str));
apply = mapAttrs (n: v: if isList v then concatStringsSep ":" v else v);
@@ -58,7 +58,7 @@ in
Also, these variables are merged into
and it is
therefore not possible to use PAM style variables such as
- @{HOME}.
+ @{HOME}.
'';
};
diff --git a/nixos/modules/config/users-groups.nix b/nixos/modules/config/users-groups.nix
index 466e3f6138a5..915687d1799a 100644
--- a/nixos/modules/config/users-groups.nix
+++ b/nixos/modules/config/users-groups.nix
@@ -100,17 +100,17 @@ let
isNormalUser = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Indicates whether this is an account for a “real” user. This
- automatically sets to
- users, to
- true, to
- /home/username,
- to true,
- and to
- false.
- Exactly one of isNormalUser and
- isSystemUser must be true.
+ automatically sets {option}`group` to
+ `users`, {option}`createHome` to
+ `true`, {option}`home` to
+ {file}`/home/«username»`,
+ {option}`useDefaultShell` to `true`,
+ and {option}`isSystemUser` to
+ `false`.
+ Exactly one of `isNormalUser` and
+ `isSystemUser` must be true.
'';
};
@@ -151,13 +151,12 @@ let
pamMount = mkOption {
type = with types; attrsOf str;
default = {};
- description = ''
+ description = lib.mdDoc ''
Attributes for user's entry in
- pam_mount.conf.xml.
- Useful attributes might include path,
- options, fstype, and server.
- See
+ {file}`pam_mount.conf.xml`.
+ Useful attributes might include `path`,
+ `options`, `fstype`, and `server`.
+ See
for more information.
'';
};
@@ -167,12 +166,12 @@ let
default = pkgs.shadow;
defaultText = literalExpression "pkgs.shadow";
example = literalExpression "pkgs.bashInteractive";
- description = ''
+ description = lib.mdDoc ''
The path to the user's shell. Can use shell derivations,
- like pkgs.bashInteractive. Don’t
+ like `pkgs.bashInteractive`. Don’t
forget to enable your shell in
- programs if necessary,
- like programs.zsh.enable = true;.
+ `programs` if necessary,
+ like `programs.zsh.enable = true;`.
'';
};
diff --git a/nixos/modules/config/xdg/portal.nix b/nixos/modules/config/xdg/portal.nix
index 1e6ddd7c4a26..689abf267f09 100644
--- a/nixos/modules/config/xdg/portal.nix
+++ b/nixos/modules/config/xdg/portal.nix
@@ -33,7 +33,7 @@ in
options.xdg.portal = {
enable =
- mkEnableOption "xdg desktop integration" // {
+ mkEnableOption ''xdg desktop integration'' // {
default = false;
};
diff --git a/nixos/modules/hardware/logitech.nix b/nixos/modules/hardware/logitech.nix
index 2e3a71c04158..70ca59a7dd3f 100644
--- a/nixos/modules/hardware/logitech.nix
+++ b/nixos/modules/hardware/logitech.nix
@@ -32,10 +32,9 @@ in
devices = mkOption {
type = types.listOf types.str;
default = [ "0a07" "c222" "c225" "c227" "c251" ];
- description = ''
+ description = lib.mdDoc ''
List of USB device ids supported by g15daemon.
-
-
+
You most likely do not need to change this.
'';
};
diff --git a/nixos/modules/hardware/tuxedo-keyboard.nix b/nixos/modules/hardware/tuxedo-keyboard.nix
index 97af7c61f3c9..7bcabde48900 100644
--- a/nixos/modules/hardware/tuxedo-keyboard.nix
+++ b/nixos/modules/hardware/tuxedo-keyboard.nix
@@ -13,7 +13,7 @@ in
To configure the driver, pass the options to the configuration.
There are several parameters you can change. It's best to check at the source code description which options are supported.
- You can find all the supported parameters at:
+ You can find all the supported parameters at:
In order to use the custom lighting with the maximumg brightness and a color of 0xff0a0a one would put pass like this:
diff --git a/nixos/modules/hardware/video/uvcvideo/default.nix b/nixos/modules/hardware/video/uvcvideo/default.nix
index bb59e2f2ed2b..6cfb8cc6ad29 100644
--- a/nixos/modules/hardware/video/uvcvideo/default.nix
+++ b/nixos/modules/hardware/video/uvcvideo/default.nix
@@ -34,15 +34,15 @@ in
packages = mkOption {
type = types.listOf types.path;
example = literalExpression "[ pkgs.tiscamera ]";
- description = ''
- List of packages containing uvcvideo dynamic controls
+ description = lib.mdDoc ''
+ List of packages containing {command}`uvcvideo` dynamic controls
rules. All files found in
- pkg/share/uvcdynctrl/data
+ {file}`«pkg»/share/uvcdynctrl/data`
will be included.
- Note that these will serve as input to the libwebcam
- package which through its own udev rule will register
- the dynamic controls from specified packages to the uvcvideo
+ Note that these will serve as input to the {command}`libwebcam`
+ package which through its own {command}`udev` rule will register
+ the dynamic controls from specified packages to the {command}`uvcvideo`
driver.
'';
apply = map getBin;
diff --git a/nixos/modules/installer/cd-dvd/iso-image.nix b/nixos/modules/installer/cd-dvd/iso-image.nix
index 9309fe70a861..cefe252e2e9a 100644
--- a/nixos/modules/installer/cd-dvd/iso-image.nix
+++ b/nixos/modules/installer/cd-dvd/iso-image.nix
@@ -618,7 +618,7 @@ in
This will be directly appended (without whitespace) to the NixOS version
string, like for example if it is set to XXX:
- NixOS 99.99-pre666XXX
+ NixOS 99.99-pre666XXX
'';
};
diff --git a/nixos/modules/misc/nixpkgs.nix b/nixos/modules/misc/nixpkgs.nix
index e991ff42028d..bb21e31ec979 100644
--- a/nixos/modules/misc/nixpkgs.nix
+++ b/nixos/modules/misc/nixpkgs.nix
@@ -119,11 +119,11 @@ in
example = literalExpression "import {}";
description = ''
If set, the pkgs argument to all NixOS modules is the value of
- this option, extended with nixpkgs.overlays, if
- that is also set. Either nixpkgs.crossSystem or
- nixpkgs.localSystem will be used in an assertion
+ this option, extended with nixpkgs.overlays, if
+ that is also set. Either nixpkgs.crossSystem or
+ nixpkgs.localSystem will be used in an assertion
to check that the NixOS and Nixpkgs architectures match. Any
- other options in nixpkgs.*, notably config,
+ other options in nixpkgs.*, notably config,
will be ignored.
If unset, the pkgs argument to all NixOS modules is determined
@@ -132,18 +132,18 @@ in
The default value imports the Nixpkgs source files
relative to the location of this NixOS module, because
NixOS and Nixpkgs are distributed together for consistency,
- so the nixos in the default value is in fact a
- relative path. The config, overlays,
- localSystem, and crossSystem come
+ so the nixos in the default value is in fact a
+ relative path. The config, overlays,
+ localSystem, and crossSystem come
from this option's siblings.
This option can be used by applications like NixOps to increase
the performance of evaluation, or to create packages that depend
on a container that should be built with the exact same evaluation
of Nixpkgs, for example. Applications like this should set
- their default value using lib.mkDefault, so
+ their default value using lib.mkDefault, so
user-provided configuration can override it without using
- lib.
+ lib.
Note that using a distinct version of Nixpkgs with NixOS may
be an unexpected source of problems. Use this option with care.
@@ -162,7 +162,7 @@ in
details, see the Nixpkgs documentation.) It allows you to set
package configuration options.
- Ignored when nixpkgs.pkgs is set.
+ Ignored when nixpkgs.pkgs is set.
'';
};
@@ -188,9 +188,9 @@ in
The first argument should be used for finding dependencies, and
the second should be used for overriding recipes.
- If nixpkgs.pkgs is set, overlays specified here
+ If nixpkgs.pkgs is set, overlays specified here
will be applied after the overlays that were already present
- in nixpkgs.pkgs.
+ in nixpkgs.pkgs.
'';
};
@@ -205,9 +205,9 @@ in
description = ''
Specifies the platform where the NixOS configuration will run.
- To cross-compile, set also nixpkgs.buildPlatform.
+ To cross-compile, set also nixpkgs.buildPlatform.
- Ignored when nixpkgs.pkgs is set.
+ Ignored when nixpkgs.pkgs is set.
'';
};
@@ -230,7 +230,7 @@ in
or if you're building machines, you can set this to match your
development system and/or build farm.
- Ignored when nixpkgs.pkgs is set.
+ Ignored when nixpkgs.pkgs is set.
'';
};
@@ -253,7 +253,7 @@ in
use the old options.
Specifies the platform on which NixOS should be built. When
- nixpkgs.crossSystem is unset, it also specifies
+ nixpkgs.crossSystem is unset, it also specifies
the platform for which NixOS should be
built. If this option is unset, it defaults to the platform
type of the machine where evaluation happens. Specifying this
@@ -261,7 +261,7 @@ in
deployment, or when building virtual machines. See its
description in the Nixpkgs manual for more details.
- Ignored when nixpkgs.pkgs or hostPlatform is set.
+ Ignored when nixpkgs.pkgs or hostPlatform is set.
'';
};
@@ -279,13 +279,13 @@ in
Specifies the platform for which NixOS should be
built. Specify this only if it is different from
- nixpkgs.localSystem, the platform
+ nixpkgs.localSystem, the platform
on which NixOS should be built. In other
words, specify this to cross-compile NixOS. Otherwise it
should be set as null, the default. See its description in the
Nixpkgs manual for more details.
- Ignored when nixpkgs.pkgs or hostPlatform is set.
+ Ignored when nixpkgs.pkgs or hostPlatform is set.
'';
};
@@ -316,7 +316,7 @@ in
with a recently generated hardware-configuration.nix.
Specifies the Nix platform type on which NixOS should be built.
- It is better to specify nixpkgs.localSystem instead.
+ It is better to specify nixpkgs.localSystem instead.
{
nixpkgs.system = ..;
@@ -328,9 +328,9 @@ in
nixpkgs.localSystem.system = ..;
}
- See nixpkgs.localSystem for more information.
+ See nixpkgs.localSystem for more information.
- Ignored when nixpkgs.pkgs, nixpkgs.localSystem or nixpkgs.hostPlatform is set.
+ Ignored when nixpkgs.pkgs, nixpkgs.localSystem or nixpkgs.hostPlatform is set.
'';
};
};
diff --git a/nixos/modules/programs/adb.nix b/nixos/modules/programs/adb.nix
index 9e9e37f92a87..e5b0abd9fcfe 100644
--- a/nixos/modules/programs/adb.nix
+++ b/nixos/modules/programs/adb.nix
@@ -11,10 +11,10 @@ with lib;
enable = mkOption {
default = false;
type = types.bool;
- description = ''
+ description = lib.mdDoc ''
Whether to configure system to use Android Debug Bridge (adb).
To grant access to a user, it must be part of adbusers group:
- users.users.alice.extraGroups = ["adbusers"];
+ `users.users.alice.extraGroups = ["adbusers"];`
'';
};
};
diff --git a/nixos/modules/programs/firejail.nix b/nixos/modules/programs/firejail.nix
index 76b42168c198..417eff91d3c7 100644
--- a/nixos/modules/programs/firejail.nix
+++ b/nixos/modules/programs/firejail.nix
@@ -69,13 +69,12 @@ in {
};
}
'';
- description = ''
+ description = lib.mdDoc ''
Wrap the binaries in firejail and place them in the global path.
-
-
+
You will get file collisions if you put the actual application binary in
the global environment (such as by adding the application package to
- environment.systemPackages), and applications started via
+ `environment.systemPackages`), and applications started via
.desktop files are not wrapped if they specify the absolute path to the
binary.
'';
diff --git a/nixos/modules/programs/gphoto2.nix b/nixos/modules/programs/gphoto2.nix
index 93923ff3133c..f31b1863963d 100644
--- a/nixos/modules/programs/gphoto2.nix
+++ b/nixos/modules/programs/gphoto2.nix
@@ -11,11 +11,11 @@ with lib;
enable = mkOption {
default = false;
type = types.bool;
- description = ''
+ description = lib.mdDoc ''
Whether to configure system to use gphoto2.
To grant digital camera access to a user, the user must
be part of the camera group:
- users.users.alice.extraGroups = ["camera"];
+ `users.users.alice.extraGroups = ["camera"];`
'';
};
};
diff --git a/nixos/modules/programs/kdeconnect.nix b/nixos/modules/programs/kdeconnect.nix
index aa4302404ad4..1f326c9e9219 100644
--- a/nixos/modules/programs/kdeconnect.nix
+++ b/nixos/modules/programs/kdeconnect.nix
@@ -8,7 +8,7 @@ with lib;
Note that it will open the TCP and UDP port from
1714 to 1764 as they are needed for it to function properly.
You can use the to use
- gnomeExtensions.gsconnect as an alternative
+ gnomeExtensions.gsconnect as an alternative
implementation if you use Gnome.
'';
package = mkOption {
diff --git a/nixos/modules/programs/neovim.nix b/nixos/modules/programs/neovim.nix
index b1dbcd181309..85963159a725 100644
--- a/nixos/modules/programs/neovim.nix
+++ b/nixos/modules/programs/neovim.nix
@@ -72,9 +72,9 @@ in {
};
}
'';
- description = ''
+ description = lib.mdDoc ''
Generate your init file from your list of plugins and custom commands.
- Neovim will then be wrapped to load nvim -u /nix/store/hash-vimrc
+ Neovim will then be wrapped to load {command}`nvim -u /nix/store/«hash»-vimrc`
'';
};
diff --git a/nixos/modules/programs/nncp.nix b/nixos/modules/programs/nncp.nix
index f40e888dad8c..a58748d2fe62 100644
--- a/nixos/modules/programs/nncp.nix
+++ b/nixos/modules/programs/nncp.nix
@@ -33,24 +33,24 @@ in {
secrets = mkOption {
type = with types; listOf str;
example = [ "/run/keys/nncp.hjson" ];
- description = ''
+ description = lib.mdDoc ''
A list of paths to NNCP configuration files that should not be
in the Nix store. These files are layered on top of the values at
- .
+ [](#opt-programs.nncp.settings).
'';
};
settings = mkOption {
type = settingsFormat.type;
- description = ''
+ description = lib.mdDoc ''
NNCP configuration, see
- .
+ .
At runtime these settings will be overlayed by the contents of
- into the file
- ${nncpCfgFile}. Node keypairs go in
- secrets, do not specify them in
- settings as they will be leaked into
- /nix/store!
+ [](#opt-programs.nncp.secrets) into the file
+ `${nncpCfgFile}`. Node keypairs go in
+ `secrets`, do not specify them in
+ `settings` as they will be leaked into
+ `/nix/store`!
'';
default = { };
};
diff --git a/nixos/modules/programs/ssh.nix b/nixos/modules/programs/ssh.nix
index e0da6ef3b3ad..9c4a95ef22c6 100644
--- a/nixos/modules/programs/ssh.nix
+++ b/nixos/modules/programs/ssh.nix
@@ -95,7 +95,7 @@ in
default = "";
description = ''
Extra configuration text prepended to ssh_config. Other generated
- options will be added after a Host * pattern.
+ options will be added after a Host * pattern.
See ssh_config5
for help.
'';
diff --git a/nixos/modules/programs/sway.nix b/nixos/modules/programs/sway.nix
index decae1b4d2da..af2b261d3c5f 100644
--- a/nixos/modules/programs/sway.nix
+++ b/nixos/modules/programs/sway.nix
@@ -39,7 +39,7 @@ in {
Sway, the i3-compatible tiling Wayland compositor. You can manually launch
Sway by executing "exec sway" on a TTY. Copy /etc/sway/config to
~/.config/sway/config to modify the default configuration. See
- and
+ and
"man 5 sway" for more information'';
wrapperFeatures = mkOption {
diff --git a/nixos/modules/programs/turbovnc.nix b/nixos/modules/programs/turbovnc.nix
index e6f8836aa367..a0e4a36cfd99 100644
--- a/nixos/modules/programs/turbovnc.nix
+++ b/nixos/modules/programs/turbovnc.nix
@@ -15,14 +15,14 @@ in
ensureHeadlessSoftwareOpenGL = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to set up NixOS such that TurboVNC's built-in software OpenGL
implementation works.
- This will enable so that OpenGL
+ This will enable {option}`hardware.opengl.enable` so that OpenGL
programs can find Mesa's llvmpipe drivers.
- Setting this option to false does not mean that software
+ Setting this option to `false` does not mean that software
OpenGL won't work; it may still work depending on your system
configuration.
diff --git a/nixos/modules/security/acme/default.nix b/nixos/modules/security/acme/default.nix
index 54b44dcab62b..a1d8c533304a 100644
--- a/nixos/modules/security/acme/default.nix
+++ b/nixos/modules/security/acme/default.nix
@@ -504,8 +504,8 @@ let
reloadServices = mkOption {
type = types.listOf types.str;
inherit (defaultAndText "reloadServices" []) default defaultText;
- description = ''
- The list of systemd services to call systemctl try-reload-or-restart
+ description = lib.mdDoc ''
+ The list of systemd services to call `systemctl try-reload-or-restart`
on.
'';
};
@@ -581,8 +581,8 @@ let
Turns on the OCSP Must-Staple TLS extension.
Make sure you know what you're doing! See:
-
-
+
+
'';
};
diff --git a/nixos/modules/security/dhparams.nix b/nixos/modules/security/dhparams.nix
index 720936e68d72..b3fce7e83aff 100644
--- a/nixos/modules/security/dhparams.nix
+++ b/nixos/modules/security/dhparams.nix
@@ -61,7 +61,7 @@ in {
The value is the size (in bits) of the DH params to generate. The
generated DH params path can be found in
- config.security.dhparams.params.name.path.
+ config.security.dhparams.params.«name».path.
The name of the DH params is taken as being the name of
the service it serves and the params will be generated before the
diff --git a/nixos/modules/security/doas.nix b/nixos/modules/security/doas.nix
index d4b51b406e28..4d15ed9a8025 100644
--- a/nixos/modules/security/doas.nix
+++ b/nixos/modules/security/doas.nix
@@ -62,19 +62,19 @@ in
wheelNeedsPassword = mkOption {
type = with types; bool;
default = true;
- description = ''
- Whether users of the wheel group must provide a password to
- run commands as super user via doas.
+ description = lib.mdDoc ''
+ Whether users of the `wheel` group must provide a password to
+ run commands as super user via {command}`doas`.
'';
};
extraRules = mkOption {
default = [];
- description = ''
+ description = lib.mdDoc ''
Define specific rules to be set in the
- /etc/doas.conf file. More specific rules should
+ {file}`/etc/doas.conf` file. More specific rules should
come after more general ones in order to yield the expected behavior.
- You can use mkBefore and/or mkAfter to ensure
+ You can use `mkBefore` and/or `mkAfter` to ensure
this is the case when configuration options are merged.
'';
example = literalExpression ''
@@ -113,8 +113,8 @@ in
noPass = mkOption {
type = with types; bool;
default = false;
- description = ''
- If true, the user is not required to enter a
+ description = lib.mdDoc ''
+ If `true`, the user is not required to enter a
password.
'';
};
@@ -122,18 +122,18 @@ in
noLog = mkOption {
type = with types; bool;
default = false;
- description = ''
- If true, successful executions will not be logged
+ description = lib.mdDoc ''
+ If `true`, successful executions will not be logged
to
- syslogd8.
+ {manpage}`syslogd(8)`.
'';
};
persist = mkOption {
type = with types; bool;
default = false;
- description = ''
- If true, do not ask for a password again for some
+ description = lib.mdDoc ''
+ If `true`, do not ask for a password again for some
time after the user successfully authenticates.
'';
};
@@ -141,10 +141,10 @@ in
keepEnv = mkOption {
type = with types; bool;
default = false;
- description = ''
- If true, environment variables other than those
+ description = lib.mdDoc ''
+ If `true`, environment variables other than those
listed in
- doas1
+ {manpage}`doas(1)`
are kept when creating the environment for the new process.
'';
};
@@ -152,18 +152,18 @@ in
setEnv = mkOption {
type = with types; listOf str;
default = [];
- description = ''
+ description = lib.mdDoc ''
Keep or set the specified variables. Variables may also be
removed with a leading '-' or set using
- variable=value. If the first character of
- value is a '$', the value to be set is taken from
+ `variable=value`. If the first character of
+ `value` is a '$', the value to be set is taken from
the existing environment variable of the indicated name. This
option is processed after the default environment has been
created.
- NOTE: All rules have setenv { SSH_AUTH_SOCK } by
- default. To prevent SSH_AUTH_SOCK from being
- inherited, add "-SSH_AUTH_SOCK" anywhere in this
+ NOTE: All rules have `setenv { SSH_AUTH_SOCK }` by
+ default. To prevent `SSH_AUTH_SOCK` from being
+ inherited, add `"-SSH_AUTH_SOCK"` anywhere in this
list.
'';
};
@@ -183,23 +183,23 @@ in
runAs = mkOption {
type = with types; nullOr str;
default = null;
- description = ''
+ description = lib.mdDoc ''
Which user or group the specified command is allowed to run as.
- When set to null (the default), all users are
+ When set to `null` (the default), all users are
allowed.
A user can be specified using just the username:
- "foo". It is also possible to only allow running as
- a specific group with ":bar".
+ `"foo"`. It is also possible to only allow running as
+ a specific group with `":bar"`.
'';
};
cmd = mkOption {
type = with types; nullOr str;
default = null;
- description = ''
+ description = lib.mdDoc ''
The command the user is allowed to run. When set to
- null (the default), all commands are allowed.
+ `null` (the default), all commands are allowed.
NOTE: It is best practice to specify absolute paths. If a
relative path is specified, only a restricted PATH will be
@@ -210,9 +210,9 @@ in
args = mkOption {
type = with types; nullOr (listOf str);
default = null;
- description = ''
+ description = lib.mdDoc ''
Arguments that must be provided to the command. When set to
- [], the command must be run without any arguments.
+ `[]`, the command must be run without any arguments.
'';
};
};
diff --git a/nixos/modules/security/misc.nix b/nixos/modules/security/misc.nix
index 3c83ff8d7739..6833452a570e 100644
--- a/nixos/modules/security/misc.nix
+++ b/nixos/modules/security/misc.nix
@@ -52,7 +52,7 @@ with lib;
security.allowSimultaneousMultithreading = mkOption {
type = types.bool;
default = true;
- description = ''
+ description = lib.mdDoc ''
Whether to allow SMT/hyperthreading. Disabling SMT means that only
physical CPU cores will be usable at runtime, potentially at
significant performance cost.
@@ -62,7 +62,7 @@ with lib;
e.g., shared caches). This attack vector is unproven.
Disabling SMT is a supplement to the L1 data cache flushing mitigation
- (see )
+ (see [](#opt-security.virtualisation.flushL1DataCache))
versus malicious VM guests (SMT could "bring back" previously flushed
data).
'';
diff --git a/nixos/modules/security/pam.nix b/nixos/modules/security/pam.nix
index 7903d333411b..2d0f25689784 100644
--- a/nixos/modules/security/pam.nix
+++ b/nixos/modules/security/pam.nix
@@ -807,14 +807,14 @@ in
default = config.krb5.enable;
defaultText = literalExpression "config.krb5.enable";
type = types.bool;
- description = ''
- Enables Kerberos PAM modules (pam-krb5,
- pam-ccreds).
+ description = lib.mdDoc ''
+ Enables Kerberos PAM modules (`pam-krb5`,
+ `pam-ccreds`).
If set, users can authenticate with their Kerberos password.
This requires a valid Kerberos configuration
- (config.krb5.enable should be set to
- true).
+ (`config.krb5.enable` should be set to
+ `true`).
Note that the Kerberos PAM modules are not necessary when using SSS
to handle Kerberos authentication.
@@ -826,13 +826,12 @@ in
enable = mkOption {
default = false;
type = types.bool;
- description = ''
- Enables P11 PAM (pam_p11) module.
+ description = lib.mdDoc ''
+ Enables P11 PAM (`pam_p11`) module.
If set, users can log in with SSH keys and PKCS#11 tokens.
- More information can be found here.
+ More information can be found [here](https://github.com/OpenSC/pam_p11).
'';
};
@@ -859,77 +858,71 @@ in
enable = mkOption {
default = false;
type = types.bool;
- description = ''
- Enables U2F PAM (pam-u2f) module.
+ description = lib.mdDoc ''
+ Enables U2F PAM (`pam-u2f`) module.
If set, users listed in
- $XDG_CONFIG_HOME/Yubico/u2f_keys (or
- $HOME/.config/Yubico/u2f_keys 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. The path can
- be changed using option.
+ be changed using {option}`security.pam.u2f.authFile` option.
File format is:
- username:first_keyHandle,first_public_key: second_keyHandle,second_public_key
- This file can be generated using pamu2fcfg command.
+ `username:first_keyHandle,first_public_key: second_keyHandle,second_public_key`
+ This file can be generated using {command}`pamu2fcfg` command.
- More information can be found here.
+ More information can be found [here](https://developers.yubico.com/pam-u2f/).
'';
};
authFile = mkOption {
default = null;
type = with types; nullOr path;
- description = ''
- By default pam-u2f module reads the keys from
- $XDG_CONFIG_HOME/Yubico/u2f_keys (or
- $HOME/.config/Yubico/u2f_keys if XDG variable is
+ description = lib.mdDoc ''
+ By default `pam-u2f` module reads the keys from
+ {file}`$XDG_CONFIG_HOME/Yubico/u2f_keys` (or
+ {file}`$HOME/.config/Yubico/u2f_keys` if XDG variable is
not set).
If you want to change auth file locations or centralize database (for
- example use /etc/u2f-mappings) you can set this
+ example use {file}`/etc/u2f-mappings`) you can set this
option.
File format is:
- username:first_keyHandle,first_public_key: second_keyHandle,second_public_key
- This file can be generated using pamu2fcfg command.
+ `username:first_keyHandle,first_public_key: second_keyHandle,second_public_key`
+ This file can be generated using {command}`pamu2fcfg` command.
- More information can be found here.
+ More information can be found [here](https://developers.yubico.com/pam-u2f/).
'';
};
appId = mkOption {
default = null;
type = with types; nullOr str;
- description = ''
- By default pam-u2f module sets the application
- ID to pam://$HOSTNAME.
+ description = lib.mdDoc ''
+ By default `pam-u2f` module sets the application
+ ID to `pam://$HOSTNAME`.
- When using pamu2fcfg, you can specify your
- application ID with the -i flag.
+ When using {command}`pamu2fcfg`, you can specify your
+ application ID with the `-i` flag.
- More information can be found
- here
+ More information can be found [here](https://developers.yubico.com/pam-u2f/Manuals/pam_u2f.8.html)
'';
};
origin = mkOption {
default = null;
type = with types; nullOr str;
- description = ''
- By default pam-u2f module sets the origin
- to pam://$HOSTNAME.
+ description = lib.mdDoc ''
+ By default `pam-u2f` module sets the origin
+ to `pam://$HOSTNAME`.
Setting origin to an host independent value will allow you to
reuse credentials across machines
- When using pamu2fcfg, you can specify your
- application ID with the -o flag.
+ When using {command}`pamu2fcfg`, you can specify your
+ application ID with the `-o` flag.
- More information can be found
- here
+ More information can be found [here](https://developers.yubico.com/pam-u2f/Manuals/pam_u2f.8.html)
'';
};
@@ -985,18 +978,17 @@ in
enable = mkOption {
default = false;
type = types.bool;
- description = ''
- Enables Uber's USSH PAM (pam-ussh) module.
+ description = lib.mdDoc ''
+ Enables Uber's USSH PAM (`pam-ussh`) module.
- This is similar to pam-ssh-agent, except that
+ This is similar to `pam-ssh-agent`, except that
the presence of a CA-signed SSH key with a valid principal is checked
instead.
Note that this module must both be enabled using this option and on a
- per-PAM-service level as well (using usshAuth).
+ per-PAM-service level as well (using `usshAuth`).
- More information can be found here.
+ More information can be found [here](https://github.com/uber/pam-ussh).
'';
};
@@ -1075,17 +1067,16 @@ in
enable = mkOption {
default = false;
type = types.bool;
- description = ''
- Enables Yubico PAM (yubico-pam) module.
+ description = lib.mdDoc ''
+ Enables Yubico PAM (`yubico-pam`) module.
If set, users listed in
- ~/.yubico/authorized_yubikeys
+ {file}`~/.yubico/authorized_yubikeys`
are able to log in with the associated Yubikey tokens.
The file must have only one line:
- username:yubikey_token_id1:yubikey_token_id2
- More information can be found here.
+ `username:yubikey_token_id1:yubikey_token_id2`
+ More information can be found [here](https://developers.yubico.com/yubico-pam/).
'';
};
control = mkOption {
@@ -1120,7 +1111,7 @@ in
mode = mkOption {
default = "client";
type = types.enum [ "client" "challenge-response" ];
- description = ''
+ description = lib.mdDoc ''
Mode of operation.
Use "client" for online validation with a YubiKey validation service such as
@@ -1130,18 +1121,16 @@ in
Challenge-Response configurations. See the man-page ykpamcfg(1) for further
details on how to configure offline Challenge-Response validation.
- More information can be found here.
+ More information can be found [here](https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html).
'';
};
challengeResponsePath = mkOption {
default = null;
type = types.nullOr types.path;
- description = ''
+ description = lib.mdDoc ''
If not null, set the path used by yubico pam module where the challenge expected response is stored.
- More information can be found here.
+ More information can be found [here](https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html).
'';
};
};
diff --git a/nixos/modules/security/pam_mount.nix b/nixos/modules/security/pam_mount.nix
index e159a73b66a4..11cc13a8cbeb 100644
--- a/nixos/modules/security/pam_mount.nix
+++ b/nixos/modules/security/pam_mount.nix
@@ -31,10 +31,9 @@ in
extraVolumes = mkOption {
type = types.listOf types.str;
default = [];
- description = ''
+ description = lib.mdDoc ''
List of volume definitions for pam_mount.
- For more information, visit .
+ For more information, visit .
'';
};
@@ -64,22 +63,20 @@ in
type = types.int;
default = 0;
example = 1;
- description = ''
+ description = lib.mdDoc ''
Sets the Debug-Level. 0 disables debugging, 1 enables pam_mount tracing,
and 2 additionally enables tracing in mount.crypt. The default is 0.
- For more information, visit .
+ For more information, visit .
'';
};
logoutWait = mkOption {
type = types.int;
default = 0;
- description = ''
+ description = lib.mdDoc ''
Amount of microseconds to wait until killing remaining processes after
final logout.
- For more information, visit .
+ For more information, visit .
'';
};
diff --git a/nixos/modules/security/pam_usb.nix b/nixos/modules/security/pam_usb.nix
index 51d81e823f86..4275c26c6bda 100644
--- a/nixos/modules/security/pam_usb.nix
+++ b/nixos/modules/security/pam_usb.nix
@@ -17,10 +17,9 @@ in
enable = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Enable USB login for all login systems that support it. For
- more information, visit .
+ more information, visit .
'';
};
diff --git a/nixos/modules/security/sudo.nix b/nixos/modules/security/sudo.nix
index 2e30a8915d86..faa99a31a6d6 100644
--- a/nixos/modules/security/sudo.nix
+++ b/nixos/modules/security/sudo.nix
@@ -55,19 +55,19 @@ in
type = types.bool;
default = true;
description =
- ''
- Whether users of the wheel group must
- provide a password to run commands as super user via sudo.
+ lib.mdDoc ''
+ Whether users of the `wheel` group must
+ provide a password to run commands as super user via {command}`sudo`.
'';
};
security.sudo.execWheelOnly = mkOption {
type = types.bool;
default = false;
- description = ''
- Only allow members of the wheel group to execute sudo by
+ description = lib.mdDoc ''
+ Only allow members of the `wheel` group to execute sudo by
setting the executable's permissions accordingly.
- This prevents users that are not members of wheel from
+ This prevents users that are not members of `wheel` from
exploiting vulnerabilities in sudo such as CVE-2021-3156.
'';
};
@@ -139,12 +139,12 @@ in
runAs = mkOption {
type = with types; str;
default = "ALL:ALL";
- description = ''
+ description = lib.mdDoc ''
Under which user/group the specified command is allowed to run.
- A user can be specified using just the username: "foo".
- It is also possible to specify a user/group combination using "foo:bar"
- or to only allow running as a specific group with ":bar".
+ A user can be specified using just the username: `"foo"`.
+ It is also possible to specify a user/group combination using `"foo:bar"`
+ or to only allow running as a specific group with `":bar"`.
'';
};
@@ -159,7 +159,7 @@ in
type = with types; str;
description = ''
A command being either just a path to a binary to allow any arguments,
- the full command with arguments pre-set or with "" used as the argument,
+ the full command with arguments pre-set or with "" used as the argument,
not allowing arguments to the command at all.
'';
};
diff --git a/nixos/modules/services/backup/duplicity.nix b/nixos/modules/services/backup/duplicity.nix
index 8c4105955569..765afd43d638 100644
--- a/nixos/modules/services/backup/duplicity.nix
+++ b/nixos/modules/services/backup/duplicity.nix
@@ -63,9 +63,9 @@ in
systemd.exec5. For example:
- PASSPHRASE=...
- AWS_ACCESS_KEY_ID=...
- AWS_SECRET_ACCESS_KEY=...
+ PASSPHRASE=«...»
+ AWS_ACCESS_KEY_ID=«...»
+ AWS_SECRET_ACCESS_KEY=«...»
'';
};
diff --git a/nixos/modules/services/backup/restic.nix b/nixos/modules/services/backup/restic.nix
index 76d7f093f21c..56958bf949d6 100644
--- a/nixos/modules/services/backup/restic.nix
+++ b/nixos/modules/services/backup/restic.nix
@@ -227,7 +227,7 @@ in
type = types.package;
default = pkgs.restic;
defaultText = literalExpression "pkgs.restic";
- description = ''
+ description = lib.mdDoc ''
Restic package to use.
'';
};
diff --git a/nixos/modules/services/backup/syncoid.nix b/nixos/modules/services/backup/syncoid.nix
index e53528fb66fc..cbfbc59bf5b2 100644
--- a/nixos/modules/services/backup/syncoid.nix
+++ b/nixos/modules/services/backup/syncoid.nix
@@ -192,10 +192,10 @@ in
target = mkOption {
type = types.str;
example = "user@server:pool/dataset";
- description = ''
+ description = lib.mdDoc ''
Target ZFS dataset. Can be either local
- (pool/dataset) or remote
- (user@server:pool/dataset).
+ («pool/dataset») or remote
+ («user@server:pool/dataset»).
'';
};
diff --git a/nixos/modules/services/backup/zrepl.nix b/nixos/modules/services/backup/zrepl.nix
index e3a900912645..ea858a8b77db 100644
--- a/nixos/modules/services/backup/zrepl.nix
+++ b/nixos/modules/services/backup/zrepl.nix
@@ -22,9 +22,8 @@ in
settings = mkOption {
default = { };
- description = ''
- Configuration for zrepl. See
+ description = lib.mdDoc ''
+ Configuration for zrepl. See
for more information.
'';
type = types.submodule {
diff --git a/nixos/modules/services/continuous-integration/github-runner.nix b/nixos/modules/services/continuous-integration/github-runner.nix
index 2da18bbdb396..540033823687 100644
--- a/nixos/modules/services/continuous-integration/github-runner.nix
+++ b/nixos/modules/services/continuous-integration/github-runner.nix
@@ -18,12 +18,11 @@ in
enable = mkOption {
default = false;
example = true;
- description = ''
+ description = lib.mdDoc ''
Whether to enable GitHub Actions runner.
Note: GitHub recommends using self-hosted runners with private repositories only. Learn more here:
- About self-hosted runners.
+ [About self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners).
'';
type = lib.types.bool;
};
diff --git a/nixos/modules/services/continuous-integration/gitlab-runner.nix b/nixos/modules/services/continuous-integration/gitlab-runner.nix
index 03d3d2d16e3b..9f076e2d7a23 100644
--- a/nixos/modules/services/continuous-integration/gitlab-runner.nix
+++ b/nixos/modules/services/continuous-integration/gitlab-runner.nix
@@ -113,15 +113,15 @@ in
configFile = mkOption {
type = types.nullOr types.path;
default = null;
- description = ''
+ description = lib.mdDoc ''
Configuration file for gitlab-runner.
- takes precedence over .
- and will be ignored too.
+ {option}`configFile` takes precedence over {option}`services`.
+ {option}`checkInterval` and {option}`concurrent` will be ignored too.
- This option is deprecated, please use instead.
- You can use and
-
+ This option is deprecated, please use {option}`services` instead.
+ You can use {option}`registrationConfigFile` and
+ {option}`registrationFlags`
for settings not covered by this module.
'';
};
@@ -130,16 +130,16 @@ in
freeformType = (pkgs.formats.json { }).type;
};
default = { };
- description = ''
+ description = lib.mdDoc ''
Global gitlab-runner configuration. See
-
+
for supported values.
'';
};
gracefulTermination = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Finish all remaining jobs before stopping.
If not set gitlab-runner will stop immediatly without waiting
for jobs to finish, which will lead to failed builds.
@@ -149,7 +149,7 @@ in
type = types.str;
default = "infinity";
example = "5min 20s";
- description = ''
+ description = lib.mdDoc ''
Time to wait until a graceful shutdown is turned into a forceful one.
'';
};
@@ -158,17 +158,17 @@ in
default = pkgs.gitlab-runner;
defaultText = literalExpression "pkgs.gitlab-runner";
example = literalExpression "pkgs.gitlab-runner_1_11";
- description = "Gitlab Runner package to use.";
+ description = lib.mdDoc "Gitlab Runner package to use.";
};
extraPackages = mkOption {
type = types.listOf types.package;
default = [ ];
- description = ''
+ description = lib.mdDoc ''
Extra packages to add to PATH for the gitlab-runner process.
'';
};
services = mkOption {
- description = "GitLab Runner services.";
+ description = lib.mdDoc "GitLab Runner services.";
default = { };
example = literalExpression ''
{
@@ -250,17 +250,17 @@ in
options = {
registrationConfigFile = mkOption {
type = types.path;
- description = ''
+ description = lib.mdDoc ''
Absolute path to a file with environment variables
used for gitlab-runner registration.
A list of all supported environment variables can be found in
- gitlab-runner register --help.
+ `gitlab-runner register --help`.
Ones that you probably want to set is
- CI_SERVER_URL=<CI server URL>
+ `CI_SERVER_URL=`
- REGISTRATION_TOKEN=<registration secret>
+ `REGISTRATION_TOKEN=`
WARNING: make sure to use quoted absolute path,
or it is going to be copied to Nix Store.
@@ -270,10 +270,10 @@ in
type = types.listOf types.str;
default = [ ];
example = [ "--docker-helper-image my/gitlab-runner-helper" ];
- description = ''
+ description = lib.mdDoc ''
Extra command-line flags passed to
- gitlab-runner register.
- Execute gitlab-runner register --help
+ `gitlab-runner register`.
+ Execute `gitlab-runner register --help`
for a list of supported flags.
'';
};
@@ -281,32 +281,32 @@ in
type = types.attrsOf types.str;
default = { };
example = { NAME = "value"; };
- description = ''
+ description = lib.mdDoc ''
Custom environment variables injected to build environment.
- For secrets you can use
- with RUNNER_ENV variable set.
+ For secrets you can use {option}`registrationConfigFile`
+ with `RUNNER_ENV` variable set.
'';
};
description = mkOption {
type = types.nullOr types.str;
default = null;
- description = ''
+ description = lib.mdDoc ''
Name/description of the runner.
'';
};
executor = mkOption {
type = types.str;
default = "docker";
- description = ''
+ description = lib.mdDoc ''
Select executor, eg. shell, docker, etc.
- See runner documentation for more information.
+ See [runner documentation](https://docs.gitlab.com/runner/executors/README.html) for more information.
'';
};
buildsDir = mkOption {
type = types.nullOr types.path;
default = null;
example = "/var/lib/gitlab-runner/builds";
- description = ''
+ description = lib.mdDoc ''
Absolute path to a directory where builds will be stored
in context of selected executor (Locally, Docker, SSH).
'';
@@ -315,14 +315,14 @@ in
type = types.nullOr types.str;
default = null;
example = "http://gitlab.example.local";
- description = ''
+ description = lib.mdDoc ''
Overwrite the URL for the GitLab instance. Used if the Runner can’t connect to GitLab on the URL GitLab exposes itself.
'';
};
dockerImage = mkOption {
type = types.nullOr types.str;
default = null;
- description = ''
+ description = lib.mdDoc ''
Docker image to be used.
'';
};
@@ -330,7 +330,7 @@ in
type = types.listOf types.str;
default = [ ];
example = [ "/var/run/docker.sock:/var/run/docker.sock" ];
- description = ''
+ description = lib.mdDoc ''
Bind-mount a volume and create it
if it doesn't exist prior to mounting.
'';
@@ -338,14 +338,14 @@ in
dockerDisableCache = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Disable all container caching.
'';
};
dockerPrivileged = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Give extended privileges to container.
'';
};
@@ -353,7 +353,7 @@ in
type = types.listOf types.str;
default = [ ];
example = [ "other-host:127.0.0.1" ];
- description = ''
+ description = lib.mdDoc ''
Add a custom host-to-IP mapping.
'';
};
@@ -361,7 +361,7 @@ in
type = types.listOf types.str;
default = [ ];
example = [ "ruby:*" "python:*" "php:*" "my.registry.tld:5000/*:*" ];
- description = ''
+ description = lib.mdDoc ''
Whitelist allowed images.
'';
};
@@ -369,21 +369,21 @@ in
type = types.listOf types.str;
default = [ ];
example = [ "postgres:9" "redis:*" "mysql:*" ];
- description = ''
+ description = lib.mdDoc ''
Whitelist allowed services.
'';
};
preCloneScript = mkOption {
type = types.nullOr types.path;
default = null;
- description = ''
+ description = lib.mdDoc ''
Runner-specific command script executed before code is pulled.
'';
};
preBuildScript = mkOption {
type = types.nullOr types.path;
default = null;
- description = ''
+ description = lib.mdDoc ''
Runner-specific command script executed after code is pulled,
just before build executes.
'';
@@ -391,7 +391,7 @@ in
postBuildScript = mkOption {
type = types.nullOr types.path;
default = null;
- description = ''
+ description = lib.mdDoc ''
Runner-specific command script executed after code is pulled
and just after build executes.
'';
@@ -399,22 +399,22 @@ in
tagList = mkOption {
type = types.listOf types.str;
default = [ ];
- description = ''
+ description = lib.mdDoc ''
Tag list.
'';
};
runUntagged = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Register to run untagged builds; defaults to
- true when is empty.
+ `true` when {option}`tagList` is empty.
'';
};
limit = mkOption {
type = types.int;
default = 0;
- description = ''
+ description = lib.mdDoc ''
Limit how many jobs can be handled concurrently by this service.
0 (default) simply means don't limit.
'';
@@ -422,14 +422,14 @@ in
requestConcurrency = mkOption {
type = types.int;
default = 0;
- description = ''
+ description = lib.mdDoc ''
Limit number of concurrent requests for new jobs from GitLab.
'';
};
maximumTimeout = mkOption {
type = types.int;
default = 0;
- description = ''
+ description = lib.mdDoc ''
What is the maximum timeout (in seconds) that will be set for
job when using this Runner. 0 (default) simply means don't limit.
'';
@@ -437,7 +437,7 @@ in
protected = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
When set to true Runner will only run on pipelines
triggered on protected branches.
'';
@@ -445,9 +445,9 @@ in
debugTraceDisabled = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
When set to true Runner will disable the possibility of
- using the CI_DEBUG_TRACE feature.
+ using the `CI_DEBUG_TRACE` feature.
'';
};
};
diff --git a/nixos/modules/services/databases/firebird.nix b/nixos/modules/services/databases/firebird.nix
index 3a7ebd6bbd09..4aaf4ca12aa6 100644
--- a/nixos/modules/services/databases/firebird.nix
+++ b/nixos/modules/services/databases/firebird.nix
@@ -47,9 +47,9 @@ in
defaultText = literalExpression "pkgs.firebird";
type = types.package;
example = literalExpression "pkgs.firebird_3";
- description = ''
- Which Firebird package to be installed: pkgs.firebird_3
- For SuperServer use override: pkgs.firebird_3.override { superServer = true; };
+ description = lib.mdDoc ''
+ Which Firebird package to be installed: `pkgs.firebird_3`
+ For SuperServer use override: `pkgs.firebird_3.override { superServer = true; };`
'';
};
diff --git a/nixos/modules/services/databases/mysql.nix b/nixos/modules/services/databases/mysql.nix
index b7a55900c122..1a096d2a88a4 100644
--- a/nixos/modules/services/databases/mysql.nix
+++ b/nixos/modules/services/databases/mysql.nix
@@ -201,7 +201,7 @@ in
ensurePermissions = mkOption {
type = types.attrsOf types.str;
default = {};
- description = ''
+ description = lib.mdDoc ''
Permissions to ensure for the user, specified as attribute set.
The attribute names specify the database and tables to grant the permissions for,
separated by a dot. You may use wildcards here.
@@ -210,8 +210,8 @@ in
For more information on how to specify the target
and on which privileges exist, see the
- GRANT syntax.
- The attributes are used as GRANT ''${attrName} ON ''${attrValue}.
+ [GRANT syntax](https://mariadb.com/kb/en/library/grant/).
+ The attributes are used as `GRANT ''${attrName} ON ''${attrValue}`.
'';
example = literalExpression ''
{
diff --git a/nixos/modules/services/databases/neo4j.nix b/nixos/modules/services/databases/neo4j.nix
index dbbb79f01ebb..d1be4034ddac 100644
--- a/nixos/modules/services/databases/neo4j.nix
+++ b/nixos/modules/services/databases/neo4j.nix
@@ -139,15 +139,14 @@ in {
constrainLoadCsv = mkOption {
type = types.bool;
default = true;
- description = ''
+ description = lib.mdDoc ''
Sets the root directory for file URLs used with the Cypher
- LOAD CSV clause to be that defined by
- . It restricts
+ `LOAD CSV` clause to be that defined by
+ {option}`directories.imports`. It restricts
access to only those files within that directory and its
subdirectories.
-
-
- Setting this option to false introduces
+
+ Setting this option to `false` introduces
possible security problems.
'';
};
@@ -155,15 +154,14 @@ in {
defaultListenAddress = mkOption {
type = types.str;
default = "127.0.0.1";
- description = ''
+ description = lib.mdDoc ''
Default network interface to listen for incoming connections. To
listen for connections on all interfaces, use "0.0.0.0".
-
-
+
Specifies the default IP address and address part of connector
- specific options. To bind specific
+ specific {option}`listenAddress` options. To bind specific
connectors to a specific network interfaces, specify the entire
- option for that connector.
+ {option}`listenAddress` option for that connector.
'';
};
@@ -227,20 +225,18 @@ in {
sslPolicy = mkOption {
type = types.str;
default = "legacy";
- description = ''
+ description = lib.mdDoc ''
Neo4j SSL policy for BOLT traffic.
-
-
+
The legacy policy is a special policy which is not defined in
the policy configuration section, but rather derives from
- and
- associated files (by default: neo4j.key and
- neo4j.cert). Its use will be deprecated.
-
-
+ {option}`directories.certificates` and
+ associated files (by default: {file}`neo4j.key` and
+ {file}`neo4j.cert`). Its use will be deprecated.
+
Note: This connector must be configured to support/require
SSL/TLS for the legacy policy to actually be utilized. See
- .
+ {option}`bolt.tlsLevel`.
'';
};
@@ -258,21 +254,19 @@ in {
type = types.path;
default = "${cfg.directories.home}/certificates";
defaultText = literalExpression ''"''${config.${opt.directories.home}}/certificates"'';
- description = ''
+ description = lib.mdDoc ''
Directory for storing certificates to be used by Neo4j for
TLS connections.
-
-
+
When setting this directory to something other than its default,
ensure the directory's existence, and that read/write permissions are
- given to the Neo4j daemon user neo4j.
-
-
+ given to the Neo4j daemon user `neo4j`.
+
Note that changing this directory from its default will prevent
the directory structure required for each SSL policy from being
automatically generated. A policy's directory structure as defined by
- its , and
- must then be setup manually. The
+ its {option}`baseDirectory`,{option}`revokedDir` and
+ {option}`trustedDir` must then be setup manually. The
existence of these directories is mandatory, as well as the presence
of the certificate file and the private key. Ensure the correct
permissions are set on these directories and files.
@@ -283,14 +277,13 @@ in {
type = types.path;
default = "${cfg.directories.home}/data";
defaultText = literalExpression ''"''${config.${opt.directories.home}}/data"'';
- description = ''
+ description = lib.mdDoc ''
Path of the data directory. You must not configure more than one
Neo4j installation to use the same data directory.
-
-
+
When setting this directory to something other than its default,
ensure the directory's existence, and that read/write permissions are
- given to the Neo4j daemon user neo4j.
+ given to the Neo4j daemon user `neo4j`.
'';
};
@@ -309,16 +302,15 @@ in {
type = types.path;
default = "${cfg.directories.home}/import";
defaultText = literalExpression ''"''${config.${opt.directories.home}}/import"'';
- description = ''
+ description = lib.mdDoc ''
The root directory for file URLs used with the Cypher
- LOAD CSV clause. Only meaningful when
- is set to
- true.
-
-
+ `LOAD CSV` clause. Only meaningful when
+ {option}`constrainLoadCvs` is set to
+ `true`.
+
When setting this directory to something other than its default,
ensure the directory's existence, and that read permission is
- given to the Neo4j daemon user neo4j.
+ given to the Neo4j daemon user `neo4j`.
'';
};
@@ -326,15 +318,14 @@ in {
type = types.path;
default = "${cfg.directories.home}/plugins";
defaultText = literalExpression ''"''${config.${opt.directories.home}}/plugins"'';
- description = ''
+ description = lib.mdDoc ''
Path of the database plugin directory. Compiled Java JAR files that
contain database procedures will be loaded if they are placed in
this directory.
-
-
+
When setting this directory to something other than its default,
ensure the directory's existence, and that read permission is
- given to the Neo4j daemon user neo4j.
+ given to the Neo4j daemon user `neo4j`.
'';
};
};
@@ -386,15 +377,14 @@ in {
sslPolicy = mkOption {
type = types.str;
default = "legacy";
- description = ''
+ description = lib.mdDoc ''
Neo4j SSL policy for HTTPS traffic.
-
-
+
The legacy policy is a special policy which is not defined in the
policy configuration section, but rather derives from
- and
- associated files (by default: neo4j.key and
- neo4j.cert). Its use will be deprecated.
+ {option}`directories.certificates` and
+ associated files (by default: {file}`neo4j.key` and
+ {file}`neo4j.cert`). Its use will be deprecated.
'';
};
};
@@ -417,18 +407,16 @@ in {
allowKeyGeneration = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Allows the generation of a private key and associated self-signed
certificate. Only performed when both objects cannot be found for
this policy. It is recommended to turn this off again after keys
have been generated.
-
-
+
The public certificate is required to be duplicated to the
directory holding trusted certificates as defined by the
- option.
-
-
+ {option}`trustedDir` option.
+
Keys should in general be generated and distributed offline by a
trusted certificate authority and not by utilizing this mode.
'';
@@ -438,17 +426,16 @@ in {
type = types.path;
default = "${cfg.directories.certificates}/${name}";
defaultText = literalExpression ''"''${config.${opt.directories.certificates}}/''${name}"'';
- description = ''
+ description = lib.mdDoc ''
The mandatory base directory for cryptographic objects of this
policy. This path is only automatically generated when this
- option as well as are
+ option as well as {option}`directories.certificates` are
left at their default. Ensure read/write permissions are given
- to the Neo4j daemon user neo4j.
-
-
+ to the Neo4j daemon user `neo4j`.
+
It is also possible to override each individual
configuration with absolute paths. See the
- and
+ {option}`privateKey` and {option}`publicCertificate`
policy options.
'';
};
@@ -483,16 +470,15 @@ in {
publicCertificate = mkOption {
type = types.str;
default = "public.crt";
- description = ''
+ description = lib.mdDoc ''
The name of public X.509 certificate (chain) file in PEM format
- for this policy to be found in the ,
+ for this policy to be found in the {option}`baseDirectory`,
or the absolute path to the certificate file. It is mandatory
that a certificate can be found or generated.
-
-
+
The public certificate is required to be duplicated to the
directory holding trusted certificates as defined by the
- option.
+ {option}`trustedDir` option.
'';
};
@@ -536,19 +522,18 @@ in {
type = types.path;
default = "${config.baseDirectory}/trusted";
defaultText = literalExpression ''"''${config.${options.baseDirectory}}/trusted"'';
- description = ''
+ description = lib.mdDoc ''
Path to directory of X.509 certificates in PEM format for
trusted parties. 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 or
- 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 neo4j.
-
-
+ Neo4j daemon user `neo4j`.
+
The public certificate as defined by
- is required to be duplicated
+ {option}`publicCertificate` is required to be duplicated
to this directory.
'';
};
diff --git a/nixos/modules/services/databases/openldap.nix b/nixos/modules/services/databases/openldap.nix
index 94fc155000e2..7a59de372f24 100644
--- a/nixos/modules/services/databases/openldap.nix
+++ b/nixos/modules/services/databases/openldap.nix
@@ -88,7 +88,7 @@ in {
enable = mkOption {
type = types.bool;
default = false;
- description = "Whether to enable the ldap server.";
+ description = lib.mdDoc "Whether to enable the ldap server.";
};
package = mkOption {
@@ -173,9 +173,9 @@ in {
configDir = mkOption {
type = types.nullOr types.path;
default = null;
- description = ''
+ description = lib.mdDoc ''
Use this config directory instead of generating one from the
- settings option. Overrides all NixOS settings.
+ `settings` option. Overrides all NixOS settings.
'';
example = "/var/lib/openldap/slapd.d";
};
@@ -183,9 +183,9 @@ in {
mutableConfig = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to allow writable on-line configuration. If
- true, the NixOS settings will only be used to
+ `true`, the NixOS settings will only be used to
initialize the OpenLDAP configuration if it does not exist, and are
subsequently ignored.
'';
diff --git a/nixos/modules/services/databases/pgmanage.nix b/nixos/modules/services/databases/pgmanage.nix
index f50e7244ee11..9ce2265a4dee 100644
--- a/nixos/modules/services/databases/pgmanage.nix
+++ b/nixos/modules/services/databases/pgmanage.nix
@@ -62,12 +62,12 @@ in {
nuc-server = "hostaddr=192.168.0.100 port=5432 dbname=postgres";
mini-server = "hostaddr=127.0.0.1 port=5432 dbname=postgres sslmode=require";
};
- description = ''
+ description = lib.mdDoc ''
pgmanage requires at least one PostgreSQL server be defined.
-
+
Detailed information about PostgreSQL connection strings is available at:
-
-
+
+
Note that you should not specify your user name or password. That
information will be entered on the login screen. If you specify a
username or password, it will be removed by pgmanage before attempting to
diff --git a/nixos/modules/services/databases/postgresql.nix b/nixos/modules/services/databases/postgresql.nix
index e27f4518dfad..d0135647d6af 100644
--- a/nixos/modules/services/databases/postgresql.nix
+++ b/nixos/modules/services/databases/postgresql.nix
@@ -81,8 +81,7 @@ in
default = "";
description = ''
Defines how users authenticate themselves to the server. See the
-
- PostgreSQL documentation for pg_hba.conf
+ PostgreSQL documentation for pg_hba.conf
for details on the expected format of this option. By default,
peer based authentication will be used for users connecting
via the Unix socket, and md5 password authentication will be
@@ -150,7 +149,7 @@ in
ensurePermissions = mkOption {
type = types.attrsOf types.str;
default = {};
- description = ''
+ description = lib.mdDoc ''
Permissions to ensure for the user, specified as an attribute set.
The attribute names specify the database and tables to grant the permissions for.
The attribute values specify the permissions to grant. You may specify one or
@@ -158,8 +157,8 @@ in
For more information on how to specify the target
and on which privileges exist, see the
- GRANT syntax.
- The attributes are used as GRANT ''${attrValue} ON ''${attrName}.
+ [GRANT syntax](https://www.postgresql.org/docs/current/sql-grant.html).
+ The attributes are used as `GRANT ''${attrValue} ON ''${attrName}`.
'';
example = literalExpression ''
{
diff --git a/nixos/modules/services/databases/victoriametrics.nix b/nixos/modules/services/databases/victoriametrics.nix
index 28a6ccfd5e20..f87a5862f641 100644
--- a/nixos/modules/services/databases/victoriametrics.nix
+++ b/nixos/modules/services/databases/victoriametrics.nix
@@ -28,10 +28,10 @@ let cfg = config.services.victoriametrics; in
extraOptions = mkOption {
type = types.listOf types.str;
default = [];
- description = ''
- Extra options to pass to VictoriaMetrics. See the README:
- or victoriametrics -help for more
+ description = lib.mdDoc ''
+ Extra options to pass to VictoriaMetrics. See the README:
+
+ or {command}`victoriametrics -help` for more
information.
'';
};
diff --git a/nixos/modules/services/development/zammad.nix b/nixos/modules/services/development/zammad.nix
index 503f54aee2c7..e81eef3c0a51 100644
--- a/nixos/modules/services/development/zammad.nix
+++ b/nixos/modules/services/development/zammad.nix
@@ -139,7 +139,7 @@ in
'';
description = ''
The database.yml configuration file as key value set.
- See
+ See
for list of configuration parameters.
'';
};
diff --git a/nixos/modules/services/games/asf.nix b/nixos/modules/services/games/asf.nix
index 37247e195a78..b7892900376f 100644
--- a/nixos/modules/services/games/asf.nix
+++ b/nixos/modules/services/games/asf.nix
@@ -136,7 +136,9 @@ in
};
settings = mkOption {
type = types.attrs;
- description = "Additional settings that are documented here.";
+ description = lib.mdDoc ''
+ Additional settings that are documented [here](https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#bot-config).
+ '';
default = { };
};
};
diff --git a/nixos/modules/services/hardware/kanata.nix b/nixos/modules/services/hardware/kanata.nix
index f8250afa4a00..c7cd3c9d2eb9 100644
--- a/nixos/modules/services/hardware/kanata.nix
+++ b/nixos/modules/services/hardware/kanata.nix
@@ -10,7 +10,7 @@ let
device = mkOption {
type = types.str;
example = "/dev/input/by-id/usb-0000_0000-event-kbd";
- description = "Path to the keyboard device.";
+ description = lib.mdDoc "Path to the keyboard device.";
};
config = mkOption {
type = types.lines;
@@ -33,18 +33,18 @@ let
;; tap within 100ms for capslk, hold more than 100ms for lctl
cap (tap-hold 100 100 caps lctl))
'';
- description = ''
+ description = lib.mdDoc ''
Configuration other than defcfg.
- See for more information.
+ See for more information.
'';
};
extraDefCfg = mkOption {
type = types.lines;
default = "";
example = "danger-enable-cmd yes";
- description = ''
+ description = lib.mdDoc ''
Configuration of defcfg other than linux-dev.
- See for more information.
+ See for more information.
'';
};
};
@@ -131,7 +131,7 @@ in
default = pkgs.kanata;
defaultText = lib.literalExpression "pkgs.kanata";
example = lib.literalExpression "pkgs.kanata-with-cmd";
- description = ''
+ description = lib.mdDoc ''
kanata package to use.
If you enable danger-enable-cmd, pkgs.kanata-with-cmd should be used.
'';
@@ -139,7 +139,7 @@ in
keyboards = mkOption {
type = types.attrsOf (types.submodule keyboard);
default = { };
- description = "Keyboard configurations.";
+ description = lib.mdDoc "Keyboard configurations.";
};
};
diff --git a/nixos/modules/services/hardware/lcd.nix b/nixos/modules/services/hardware/lcd.nix
index ec4b27bd8482..c817225c1f21 100644
--- a/nixos/modules/services/hardware/lcd.nix
+++ b/nixos/modules/services/hardware/lcd.nix
@@ -63,8 +63,7 @@ in with lib; {
default = false;
description = ''
Set group-write permissions on a USB device.
-
-
+
A USB connected LCD panel will most likely require having its
permissions modified for lcdd to write to it. Enabling this option
sets group-write permissions on the device identified by
@@ -72,13 +71,11 @@ in with lib; {
. In order to find the
values, you can run the lsusb command. Example
output:
-
-
+
Bus 005 Device 002: ID 0403:c630 Future Technology Devices International, Ltd lcd2usb interface
-
-
+
In this case the vendor id is 0403 and the product id is c630.
'';
};
diff --git a/nixos/modules/services/hardware/udev.nix b/nixos/modules/services/hardware/udev.nix
index 514763e409a1..1723cb508485 100644
--- a/nixos/modules/services/hardware/udev.nix
+++ b/nixos/modules/services/hardware/udev.nix
@@ -209,11 +209,11 @@ in
packages = mkOption {
type = types.listOf types.path;
default = [];
- description = ''
- List of packages containing udev rules.
+ description = lib.mdDoc ''
+ List of packages containing {command}`udev` rules.
All files found in
- pkg/etc/udev/rules.d and
- pkg/lib/udev/rules.d
+ {file}`«pkg»/etc/udev/rules.d` and
+ {file}`«pkg»/lib/udev/rules.d`
will be included.
'';
apply = map getBin;
@@ -281,16 +281,15 @@ in
networking.usePredictableInterfaceNames = mkOption {
default = true;
type = types.bool;
- description = ''
- Whether to assign predictable
- names to network interfaces. If enabled, interfaces
+ description = lib.mdDoc ''
+ Whether to assign [predictable names to network interfaces](http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames).
+ If enabled, interfaces
are assigned names that contain topology information
- (e.g. wlp3s0) and thus should be stable
+ (e.g. `wlp3s0`) and thus should be stable
across reboots. If disabled, names depend on the order in
which interfaces are discovered by the kernel, which may
change randomly across reboots; for instance, you may find
- eth0 and eth1 flipping
+ `eth0` and `eth1` flipping
unpredictably.
'';
};
@@ -306,8 +305,8 @@ in
List of packages containing udev rules that will be copied to stage 1.
All files found in
- pkg/etc/udev/rules.d and
- pkg/lib/udev/rules.d
+ «pkg»/etc/udev/rules.d and
+ «pkg»/lib/udev/rules.d
will be included.
'';
};
diff --git a/nixos/modules/services/logging/filebeat.nix b/nixos/modules/services/logging/filebeat.nix
index ec8df0a7b87d..3dc9df372ac5 100644
--- a/nixos/modules/services/logging/filebeat.nix
+++ b/nixos/modules/services/logging/filebeat.nix
@@ -31,20 +31,20 @@ in
};
inputs = mkOption {
- description = ''
+ description = lib.mdDoc ''
Inputs specify how Filebeat locates and processes input data.
- This is like services.filebeat.settings.filebeat.inputs,
+ This is like `services.filebeat.settings.filebeat.inputs`,
but structured as an attribute set. This has the benefit
that multiple NixOS modules can contribute settings to a
single filebeat input.
An input type can be specified multiple times by choosing a
- different <name> for each, but setting
-
+ different `` for each, but setting
+ [](#opt-services.filebeat.inputs._name_.type)
to the same value.
- See .
+ See .
'';
default = {};
type = types.attrsOf (types.submodule ({ name, ... }: {
@@ -77,24 +77,24 @@ in
};
modules = mkOption {
- description = ''
+ description = lib.mdDoc ''
Filebeat modules provide a quick way to get started
processing common log formats. They contain default
configurations, Elasticsearch ingest pipeline definitions,
and Kibana dashboards to help you implement and deploy a log
monitoring solution.
- This is like services.filebeat.settings.filebeat.modules,
+ This is like `services.filebeat.settings.filebeat.modules`,
but structured as an attribute set. This has the benefit
that multiple NixOS modules can contribute settings to a
single filebeat module.
A module can be specified multiple times by choosing a
- different <name> for each, but setting
-
+ different `` for each, but setting
+ [](#opt-services.filebeat.modules._name_.module)
to the same value.
- See .
+ See .
'';
default = {};
type = types.attrsOf (types.submodule ({ name, ... }: {
@@ -161,8 +161,7 @@ in
internal = true;
description = ''
Inputs specify how Filebeat locates and processes
- input data. Use instead.
+ input data. Use instead.
See .
'';
diff --git a/nixos/modules/services/logging/logrotate.nix b/nixos/modules/services/logging/logrotate.nix
index a6eb08ac5eac..53230cc51e59 100644
--- a/nixos/modules/services/logging/logrotate.nix
+++ b/nixos/modules/services/logging/logrotate.nix
@@ -276,9 +276,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 .
+ NixOS generates one automatically from [](#opt-services.logrotate.settings).
'';
example = literalExpression ''
pkgs.writeText "logrotate.conf" '''
@@ -346,11 +346,11 @@ in
extraConfig = mkOption {
default = "";
type = types.lines;
- description = ''
+ description = lib.mdDoc ''
Extra contents to append to the logrotate configuration file. Refer to
- for details.
+ for details.
This setting has been deprecated in favor of
- logrotate settings.
+ [logrotate settings](#opt-services.logrotate.settings).
'';
};
};
diff --git a/nixos/modules/services/mail/mailman.nix b/nixos/modules/services/mail/mailman.nix
index eb24f73c1da8..c76d40a68c3c 100644
--- a/nixos/modules/services/mail/mailman.nix
+++ b/nixos/modules/services/mail/mailman.nix
@@ -112,9 +112,9 @@ in {
bindPasswordFile = mkOption {
type = types.str;
example = "/run/secrets/ldap-bind";
- description = ''
+ description = lib.mdDoc ''
Path to the file containing the bind password of the servie account
- defined by .
+ defined by [](#opt-services.mailman.ldap.bindDn).
'';
};
superUserGroup = mkOption {
diff --git a/nixos/modules/services/mail/nullmailer.nix b/nixos/modules/services/mail/nullmailer.nix
index 59329667f7ad..336c76c98508 100644
--- a/nixos/modules/services/mail/nullmailer.nix
+++ b/nixos/modules/services/mail/nullmailer.nix
@@ -38,11 +38,11 @@ with lib;
remotesFile = mkOption {
type = types.nullOr types.str;
default = null;
- description = ''
- Path to the remotes control file. This file contains a
+ description = lib.mdDoc ''
+ Path to the `remotes` control file. This file contains a
list of remote servers to which to send each message.
- See man 8 nullmailer-send for syntax and available
+ See `man 8 nullmailer-send` for syntax and available
options.
'';
};
@@ -153,17 +153,17 @@ with lib;
remotes = mkOption {
type = types.nullOr types.str;
default = null;
- description = ''
+ description = lib.mdDoc ''
A list of remote servers to which to send each message. Each line
contains a remote host name or address followed by an optional
protocol string, separated by white space.
- See man 8 nullmailer-send for syntax and available
+ See `man 8 nullmailer-send` for syntax and available
options.
WARNING: This is stored world-readable in the nix store. If you need
to specify any secret credentials here, consider using the
- remotesFile option instead.
+ `remotesFile` option instead.
'';
};
diff --git a/nixos/modules/services/mail/postfixadmin.nix b/nixos/modules/services/mail/postfixadmin.nix
index 27b5c60ec072..b86428770cb2 100644
--- a/nixos/modules/services/mail/postfixadmin.nix
+++ b/nixos/modules/services/mail/postfixadmin.nix
@@ -13,12 +13,12 @@ in
enable = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to enable postfixadmin.
Also enables nginx virtual host management.
- Further nginx configuration can be done by adapting services.nginx.virtualHosts.<name>.
- See for further information.
+ Further nginx configuration can be done by adapting `services.nginx.virtualHosts.`.
+ See [](#opt-services.nginx.virtualHosts) for further information.
'';
};
diff --git a/nixos/modules/services/mail/public-inbox.nix b/nixos/modules/services/mail/public-inbox.nix
index bb835881ba0a..a81dd1cdb37b 100644
--- a/nixos/modules/services/mail/public-inbox.nix
+++ b/nixos/modules/services/mail/public-inbox.nix
@@ -23,10 +23,10 @@ let
port = mkOption {
type = with types; nullOr (either str port);
default = defaultPort;
- description = ''
+ description = lib.mdDoc ''
Listening port.
Beware that public-inbox uses well-known ports number to decide whether to enable TLS or not.
- Set to null and use systemd.sockets.public-inbox-${proto}d.listenStreams
+ Set to null and use `systemd.sockets.public-inbox-${proto}d.listenStreams`
if you need a more advanced listening.
'';
};
@@ -239,11 +239,11 @@ in
type = with types; nullOr (either str port);
default = 80;
example = "/run/public-inbox-httpd.sock";
- description = ''
+ description = lib.mdDoc ''
Listening port or systemd's ListenStream= entry
to be used as a reverse proxy, eg. in nginx:
- locations."/inbox".proxyPass = "http://unix:''${config.services.public-inbox.http.port}:/inbox";
- Set to null and use systemd.sockets.public-inbox-httpd.listenStreams
+ `locations."/inbox".proxyPass = "http://unix:''${config.services.public-inbox.http.port}:/inbox";`
+ Set to null and use `systemd.sockets.public-inbox-httpd.listenStreams`
if you need a more advanced listening.
'';
};
diff --git a/nixos/modules/services/mail/roundcube.nix b/nixos/modules/services/mail/roundcube.nix
index 3b6c06d19e86..d8adf53e48a9 100644
--- a/nixos/modules/services/mail/roundcube.nix
+++ b/nixos/modules/services/mail/roundcube.nix
@@ -14,12 +14,12 @@ in
enable = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to enable roundcube.
Also enables nginx virtual host management.
- Further nginx configuration can be done by adapting services.nginx.virtualHosts.<name>.
- See for further information.
+ Further nginx configuration can be done by adapting `services.nginx.virtualHosts.`.
+ See [](#opt-services.nginx.virtualHosts) for further information.
'';
};
@@ -99,11 +99,11 @@ in
maxAttachmentSize = mkOption {
type = types.int;
default = 18;
- description = ''
+ description = lib.mdDoc ''
The maximum attachment size in MB.
Note: Since roundcube only uses 70% of max upload values configured in php
- 30% is added automatically to .
+ 30% is added automatically to [](#opt-services.roundcube.maxAttachmentSize).
'';
apply = configuredMaxAttachmentSize: "${toString (configuredMaxAttachmentSize * 1.3)}M";
};
diff --git a/nixos/modules/services/mail/sympa.nix b/nixos/modules/services/mail/sympa.nix
index 1d46b090cd84..0014701d5831 100644
--- a/nixos/modules/services/mail/sympa.nix
+++ b/nixos/modules/services/mail/sympa.nix
@@ -86,9 +86,9 @@ in
type = str;
default = "en_US";
example = "cs";
- description = ''
+ description = lib.mdDoc ''
Default Sympa language.
- See
+ See
for available options.
'';
};
@@ -136,9 +136,9 @@ in
example = {
default_max_list_members = 3;
};
- description = ''
- The robot.conf configuration file as key value set.
- See
+ description = lib.mdDoc ''
+ The {file}`robot.conf` configuration file as key value set.
+ See
for list of configuration parameters.
'';
};
@@ -242,7 +242,7 @@ in
description = ''
The webserver used for the Sympa web interface. Set it to `none` if you want to configure it yourself.
Further nginx configuration can be done by adapting
- .
+ .
'';
};
@@ -285,9 +285,9 @@ in
viewlogs_page_size = 50;
}
'';
- description = ''
- The sympa.conf configuration file as key value set.
- See
+ description = lib.mdDoc ''
+ The {file}`sympa.conf` configuration file as key value set.
+ See
for list of configuration parameters.
'';
};
diff --git a/nixos/modules/services/matrix/appservice-discord.nix b/nixos/modules/services/matrix/appservice-discord.nix
index fa55b3c5de70..c72a2123a923 100644
--- a/nixos/modules/services/matrix/appservice-discord.nix
+++ b/nixos/modules/services/matrix/appservice-discord.nix
@@ -40,23 +40,16 @@ in {
};
}
'';
- description = ''
- config.yaml 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
-
- config.sample.yaml.
-
+ [config.sample.yaml](https://github.com/Half-Shot/matrix-appservice-discord/blob/master/config/config.sample.yaml).
-
- and
+ {option}`config.bridge.domain` and {option}`config.bridge.homeserverUrl`
should be set to match the public host name of the Matrix homeserver for webhooks and avatars to work.
-
-
- Secret tokens should be specified using
+ Secret tokens should be specified using {option}`environmentFile`
instead of this world-readable attribute set.
'';
};
diff --git a/nixos/modules/services/matrix/mautrix-facebook.nix b/nixos/modules/services/matrix/mautrix-facebook.nix
index 55067abaa52a..dfdf6e250215 100644
--- a/nixos/modules/services/matrix/mautrix-facebook.nix
+++ b/nixos/modules/services/matrix/mautrix-facebook.nix
@@ -75,15 +75,12 @@ in {
};
}
'';
- description = ''
- config.yaml 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
-
- example-config.yaml.
-
+ [example-config.yaml](https://github.com/mautrix/facebook/blob/master/mautrix_facebook/example-config.yaml).
-
- Secret tokens should be specified using
+ Secret tokens should be specified using {option}`environmentFile`
instead of this world-readable attribute set.
'';
};
diff --git a/nixos/modules/services/matrix/mautrix-telegram.nix b/nixos/modules/services/matrix/mautrix-telegram.nix
index c6527be5263c..196100a531ad 100644
--- a/nixos/modules/services/matrix/mautrix-telegram.nix
+++ b/nixos/modules/services/matrix/mautrix-telegram.nix
@@ -78,15 +78,12 @@ in {
};
}
'';
- description = ''
- config.yaml 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
-
- example-config.yaml.
-
+ [example-config.yaml](https://github.com/tulir/mautrix-telegram/blob/master/example-config.yaml).
-
- Secret tokens should be specified using
+ Secret tokens should be specified using {option}`environmentFile`
instead of this world-readable attribute set.
'';
};
diff --git a/nixos/modules/services/misc/autorandr.nix b/nixos/modules/services/misc/autorandr.nix
index 11dc915c2afa..036bb4f41bef 100644
--- a/nixos/modules/services/misc/autorandr.nix
+++ b/nixos/modules/services/misc/autorandr.nix
@@ -27,9 +27,9 @@ let
options = {
fingerprint = mkOption {
type = types.attrsOf types.str;
- description = ''
+ description = lib.mdDoc ''
Output name to EDID mapping.
- Use autorandr --fingerprint to get current setup values.
+ Use `autorandr --fingerprint` to get current setup values.
'';
default = { };
};
@@ -154,7 +154,7 @@ let
});
description = ''
Output scale configuration.
-
+
Either configure by pixels or a scaling factor. When using pixel method the
xrandr
@@ -165,7 +165,7 @@ let
will be used; when using factor method the option
--scale
will be used.
-
+
This option is a shortcut version of the transform option and they are mutually
exclusive.
'';
diff --git a/nixos/modules/services/misc/bees.nix b/nixos/modules/services/misc/bees.nix
index 1b4923150266..37f90c682221 100644
--- a/nixos/modules/services/misc/bees.nix
+++ b/nixos/modules/services/misc/bees.nix
@@ -11,14 +11,13 @@ let
fsOptions = with types; {
options.spec = mkOption {
type = str;
- description = ''
+ description = lib.mdDoc ''
Description of how to identify the filesystem to be duplicated by this
instance of bees. Note that deduplication crosses subvolumes; one must
not configure multiple instances for subvolumes of the same filesystem
(or block devices which are part of the same filesystem), but only for
completely independent btrfs filesystems.
-
-
+
This must be in a format usable by findmnt; that could be a key=value
pair, or a bare path to a mount point.
Using bare paths will allow systemd to start the beesd service only
@@ -29,14 +28,12 @@ let
options.hashTableSizeMB = mkOption {
type = types.addCheck types.int (n: mod n 16 == 0);
default = 1024; # 1GB; default from upstream beesd script
- description = ''
+ description = lib.mdDoc ''
Hash table size in MB; must be a multiple of 16.
-
-
+
A larger ratio of index size to storage size means smaller blocks of
duplicate content are recognized.
-
-
+
If you have 1TB of data, a 4GB hash table (which is to say, a value of
4096) will permit 4KB extents (the smallest possible size) to be
recognized, whereas a value of 1024 -- creating a 1GB hash table --
diff --git a/nixos/modules/services/misc/etcd.nix b/nixos/modules/services/misc/etcd.nix
index d589ad780c1b..3343e94778a2 100644
--- a/nixos/modules/services/misc/etcd.nix
+++ b/nixos/modules/services/misc/etcd.nix
@@ -125,9 +125,9 @@ in {
};
extraConf = mkOption {
- description = ''
+ description = lib.mdDoc ''
Etcd extra configuration. See
-
+
'';
type = types.attrsOf types.str;
default = {};
diff --git a/nixos/modules/services/misc/etebase-server.nix b/nixos/modules/services/misc/etebase-server.nix
index 24be9e8e2692..1359c265c8f1 100644
--- a/nixos/modules/services/misc/etebase-server.nix
+++ b/nixos/modules/services/misc/etebase-server.nix
@@ -135,8 +135,8 @@ in
default = {};
description = ''
Configuration for etebase-server. Refer to
-
- and
+
+ and
for details on supported values.
'';
example = {
diff --git a/nixos/modules/services/misc/geoipupdate.nix b/nixos/modules/services/misc/geoipupdate.nix
index 20bbba0aad9a..98d470412142 100644
--- a/nixos/modules/services/misc/geoipupdate.nix
+++ b/nixos/modules/services/misc/geoipupdate.nix
@@ -40,7 +40,7 @@ in
description = ''
geoipupdate configuration
options. See
-
+
for a full list of available options.
Settings containing secret data should be set to an
@@ -92,8 +92,7 @@ in
Always handled as a secret whether the value is
wrapped in a { _secret = ...; }
- attrset or not (refer to for
+ attrset or not (refer to for
details).
'';
apply = x: if isAttrs x then x else { _secret = x; };
diff --git a/nixos/modules/services/misc/klipper.nix b/nixos/modules/services/misc/klipper.nix
index 52913369bbcd..b34ca6f8c5d2 100644
--- a/nixos/modules/services/misc/klipper.nix
+++ b/nixos/modules/services/misc/klipper.nix
@@ -71,7 +71,7 @@ in
};
firmwares = mkOption {
- description = "Firmwares klipper should manage";
+ description = lib.mdDoc "Firmwares klipper should manage";
default = { };
type = with types; attrsOf
(submodule {
diff --git a/nixos/modules/services/misc/nix-daemon.nix b/nixos/modules/services/misc/nix-daemon.nix
index c76aaaa559bf..93ff5fcfb863 100644
--- a/nixos/modules/services/misc/nix-daemon.nix
+++ b/nixos/modules/services/misc/nix-daemon.nix
@@ -636,12 +636,10 @@ in
5
for avalaible options.
The value declared here will be translated directly to the key-value pairs Nix expects.
-
-
+
You can use nix-instantiate --eval --strict '<nixpkgs/nixos>' -A config.nix.settings
to view the current value. By default it is empty.
-
-
+
Nix configurations defined under will be translated and applied to this
option. In addition, configuration specified in which will be appended
verbatim to the resulting config file.
diff --git a/nixos/modules/services/misc/persistent-evdev.nix b/nixos/modules/services/misc/persistent-evdev.nix
index 401d20010b12..fd6e298ef651 100644
--- a/nixos/modules/services/misc/persistent-evdev.nix
+++ b/nixos/modules/services/misc/persistent-evdev.nix
@@ -22,8 +22,8 @@ in
Physical devices should already exist in /dev/input/by-id/.
Proxy devices will be automatically given a uinput- prefix.
- See the
- project page for example configuration of virtual devices with libvirt
+ See the project page
+ for example configuration of virtual devices with libvirt
and remember to add uinput-* devices to the qemu
cgroup_device_acl list (see ).
'';
diff --git a/nixos/modules/services/misc/sourcehut/default.nix b/nixos/modules/services/misc/sourcehut/default.nix
index 3ff2837900ec..de04797a800c 100644
--- a/nixos/modules/services/misc/sourcehut/default.nix
+++ b/nixos/modules/services/misc/sourcehut/default.nix
@@ -180,7 +180,7 @@ in
network-key = mkOption {
description = ''
An absolute file path (which should be outside the Nix-store)
- to a secret key to encrypt internal messages with. Use srht-keygen network to
+ to a secret key to encrypt internal messages with. Use srht-keygen network to
generate this key. It must be consistent between all services and nodes.
'';
type = types.path;
@@ -209,7 +209,7 @@ in
service-key = mkOption {
description = ''
An absolute file path (which should be outside the Nix-store)
- to a key used for encrypting session cookies. Use srht-keygen service to
+ to a key used for encrypting session cookies. Use srht-keygen service to
generate the service key. This must be shared between each node of the same
service (e.g. git1.sr.ht and git2.sr.ht), but different services may use
different keys. If you configure all of your services with the same
@@ -252,8 +252,8 @@ in
Your PGP key information (DO NOT mix up pub and priv here)
You must remove the password from your secret key, if present.
- You can do this with gpg --edit-key [key-id],
- then use the passwd command and do not enter a new password.
+ You can do this with gpg --edit-key [key-id],
+ then use the passwd command and do not enter a new password.
'';
};
pgp-pubkey = mkOption {
@@ -294,7 +294,7 @@ in
This should be consistent for all *.sr.ht sites,
as this key will be used to verify signatures
from other sites in your network.
- Use the srht-keygen webhook command to generate a key.
+ Use the srht-keygen webhook command to generate a key.
'';
type = types.path;
apply = s: "<" + toString s;
diff --git a/nixos/modules/services/misc/sssd.nix b/nixos/modules/services/misc/sssd.nix
index 3f6b96258f16..70afbe0433ae 100644
--- a/nixos/modules/services/misc/sssd.nix
+++ b/nixos/modules/services/misc/sssd.nix
@@ -42,7 +42,7 @@ in {
kcm = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to use SSS as a Kerberos Cache Manager (KCM).
Kerberos will be configured to cache credentials in SSS.
'';
diff --git a/nixos/modules/services/misc/zoneminder.nix b/nixos/modules/services/misc/zoneminder.nix
index ab24372037e6..ef3f6c1a0fd9 100644
--- a/nixos/modules/services/misc/zoneminder.nix
+++ b/nixos/modules/services/misc/zoneminder.nix
@@ -68,7 +68,7 @@ in {
services.zoneminder = with lib; {
enable = lib.mkEnableOption ''
ZoneMinder
-
+
If you intend to run the database locally, you should set
`config.services.zoneminder.database.createLocally` to true. Otherwise,
when set to `false` (the default), you will have to create the database
@@ -82,8 +82,6 @@ in {
default = "nginx";
description = ''
The webserver to configure for the PHP frontend.
-
-
Set it to `none` if you want to configure it yourself. PRs are welcome
for support for other web servers.
diff --git a/nixos/modules/services/monitoring/cadvisor.nix b/nixos/modules/services/monitoring/cadvisor.nix
index c844b1599dd4..d5e440310162 100644
--- a/nixos/modules/services/monitoring/cadvisor.nix
+++ b/nixos/modules/services/monitoring/cadvisor.nix
@@ -66,16 +66,16 @@ in {
storageDriverPasswordFile = mkOption {
type = types.str;
- description = ''
+ description = lib.mdDoc ''
File that contains the cadvisor storage driver password.
- takes precedence over
+ {option}`storageDriverPasswordFile` takes precedence over {option}`storageDriverPassword`
- Warning: when is non-empty this defaults to a file in the
- world-readable Nix store that contains the value of .
+ Warning: when {option}`storageDriverPassword` is non-empty this defaults to a file in the
+ world-readable Nix store that contains the value of {option}`storageDriverPassword`.
It's recommended to override this with a path not in the Nix store.
- Tip: use nixops key management
+ Tip: use [nixops key management](https://nixos.org/nixops/manual/#idm140737318306400)
'';
};
@@ -88,10 +88,10 @@ in {
extraOptions = mkOption {
type = types.listOf types.str;
default = [];
- description = ''
+ description = lib.mdDoc ''
Additional cadvisor options.
- See for available options.
+ See for available options.
'';
};
};
diff --git a/nixos/modules/services/monitoring/grafana-image-renderer.nix b/nixos/modules/services/monitoring/grafana-image-renderer.nix
index 97488f2653a5..4820b1946987 100644
--- a/nixos/modules/services/monitoring/grafana-image-renderer.nix
+++ b/nixos/modules/services/monitoring/grafana-image-renderer.nix
@@ -92,7 +92,7 @@ in {
description = ''
Configuration attributes for grafana-image-renderer.
- See
+ See
for supported values.
'';
};
diff --git a/nixos/modules/services/monitoring/graphite.nix b/nixos/modules/services/monitoring/graphite.nix
index 73b509202df6..8edb2ca09974 100644
--- a/nixos/modules/services/monitoring/graphite.nix
+++ b/nixos/modules/services/monitoring/graphite.nix
@@ -251,9 +251,9 @@ in {
extraConfig = mkOption {
default = {};
- description = ''
+ description = lib.mdDoc ''
Extra seyren configuration. See
-
+
'';
type = types.attrsOf types.str;
example = literalExpression ''
diff --git a/nixos/modules/services/monitoring/metricbeat.nix b/nixos/modules/services/monitoring/metricbeat.nix
index 0968d25c2ad2..14066da1be81 100644
--- a/nixos/modules/services/monitoring/metricbeat.nix
+++ b/nixos/modules/services/monitoring/metricbeat.nix
@@ -32,17 +32,17 @@ in
};
modules = mkOption {
- description = ''
+ description = lib.mdDoc ''
Metricbeat modules are responsible for reading metrics from the various sources.
- This is like services.metricbeat.settings.metricbeat.modules,
+ This is like `services.metricbeat.settings.metricbeat.modules`,
but structured as an attribute set. This has the benefit that multiple
NixOS modules can contribute settings to a single metricbeat module.
- A module can be specified multiple times by choosing a different <name>
- for each, but setting to the same value.
+ A module can be specified multiple times by choosing a different ``
+ for each, but setting [](#opt-services.metricbeat.modules._name_.module) to the same value.
- See .
+ See .
'';
default = {};
type = types.attrsOf (types.submodule ({ name, ... }: {
diff --git a/nixos/modules/services/monitoring/munin.nix b/nixos/modules/services/monitoring/munin.nix
index c77ae7b3b6eb..9461bd3f35b8 100644
--- a/nixos/modules/services/monitoring/munin.nix
+++ b/nixos/modules/services/monitoring/munin.nix
@@ -138,29 +138,29 @@ in
enable = mkOption {
default = false;
type = types.bool;
- description = ''
+ description = lib.mdDoc ''
Enable Munin Node agent. Munin node listens on 0.0.0.0 and
by default accepts connections only from 127.0.0.1 for security reasons.
- See .
+ See .
'';
};
extraConfig = mkOption {
default = "";
type = types.lines;
- description = ''
- munin-node.conf extra configuration. See
-
+ description = lib.mdDoc ''
+ {file}`munin-node.conf` extra configuration. See
+
'';
};
extraPluginConfig = mkOption {
default = "";
type = types.lines;
- description = ''
- plugin-conf.d extra plugin configuration. See
-
+ description = lib.mdDoc ''
+ {file}`plugin-conf.d` extra plugin configuration. See
+
'';
example = ''
[fail2ban_*]
@@ -266,11 +266,11 @@ in
extraGlobalConfig = mkOption {
default = "";
type = types.lines;
- description = ''
- munin.conf extra global configuration.
- See .
+ description = lib.mdDoc ''
+ {file}`munin.conf` extra global configuration.
+ See .
Useful to setup notifications, see
-
+
'';
example = ''
contact.email.command mail -s "Munin notification for ''${var:host}" someone@example.com
@@ -280,10 +280,10 @@ in
hosts = mkOption {
default = "";
type = types.lines;
- description = ''
+ description = lib.mdDoc ''
Definitions of hosts of nodes to collect data from. Needs at least one
host for cron to succeed. See
-
+
'';
example = literalExpression ''
'''
diff --git a/nixos/modules/services/monitoring/nagios.nix b/nixos/modules/services/monitoring/nagios.nix
index 69173ce4e44e..a17797f682f8 100644
--- a/nixos/modules/services/monitoring/nagios.nix
+++ b/nixos/modules/services/monitoring/nagios.nix
@@ -88,7 +88,7 @@ in
options = {
services.nagios = {
- enable = mkEnableOption "Nagios to monitor your system or network.";
+ enable = mkEnableOption ''Nagios to monitor your system or network.'';
objectDefs = mkOption {
description = "
diff --git a/nixos/modules/services/monitoring/netdata.nix b/nixos/modules/services/monitoring/netdata.nix
index 4fd07a4ba143..e20eaf3b1440 100644
--- a/nixos/modules/services/monitoring/netdata.nix
+++ b/nixos/modules/services/monitoring/netdata.nix
@@ -114,14 +114,14 @@ in {
example = literalExpression ''
[ "/path/to/plugins.d" ]
'';
- description = ''
+ description = lib.mdDoc ''
Extra paths to add to the netdata global "plugins directory"
option. Useful for when you want to include your own
collection scripts.
-
+
Details about writing a custom netdata plugin are available at:
-
-
+
+
Cannot be combined with configText.
'';
};
diff --git a/nixos/modules/services/monitoring/parsedmarc.nix b/nixos/modules/services/monitoring/parsedmarc.nix
index 736718c25359..b0858184b5fc 100644
--- a/nixos/modules/services/monitoring/parsedmarc.nix
+++ b/nixos/modules/services/monitoring/parsedmarc.nix
@@ -29,11 +29,11 @@ in
enable = lib.mkOption {
type = lib.types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether Postfix and Dovecot should be set up to receive
mail locally. parsedmarc will be configured to watch the
local inbox as the automatically created user specified in
-
+ [](#opt-services.parsedmarc.provision.localMail.recipientName)
'';
};
@@ -68,15 +68,13 @@ in
geoIp = lib.mkOption {
type = lib.types.bool;
default = true;
- description = ''
- Whether to enable and configure the geoipupdate
+ description = lib.mdDoc ''
+ Whether to enable and configure the [geoipupdate](#opt-services.geoipupdate.enable)
service to automatically fetch GeoIP databases. Not crucial,
but recommended for full functionality.
- To finish the setup, you need to manually set the and
-
+ To finish the setup, you need to manually set the [](#opt-services.geoipupdate.settings.AccountID) and
+ [](#opt-services.geoipupdate.settings.LicenseKey)
options.
'';
};
@@ -97,11 +95,11 @@ in
config.${opt.provision.elasticsearch} && config.${options.services.grafana.enable}
'';
apply = x: x && cfg.provision.elasticsearch;
- description = ''
+ description = lib.mdDoc ''
Whether the automatically provisioned Elasticsearch
instance should be added as a grafana datasource. Has no
effect unless
-
+ [](#opt-services.parsedmarc.provision.elasticsearch)
is also enabled.
'';
};
@@ -208,13 +206,12 @@ in
password = lib.mkOption {
type = with lib.types; nullOr (either path (attrsOf path));
default = null;
- description = ''
+ description = lib.mdDoc ''
The IMAP server password.
Always handled as a secret whether the value is
- wrapped in a { _secret = ...; }
- attrset or not (refer to for
+ wrapped in a `{ _secret = ...; }`
+ attrset or not (refer to [](#opt-services.parsedmarc.settings) for
details).
'';
apply = x: if isAttrs x || x == null then x else { _secret = x; };
@@ -273,13 +270,12 @@ in
password = lib.mkOption {
type = with lib.types; nullOr (either path (attrsOf path));
default = null;
- description = ''
+ description = lib.mdDoc ''
The SMTP server password.
Always handled as a secret whether the value is
- wrapped in a { _secret = ...; }
- attrset or not (refer to for
+ wrapped in a `{ _secret = ...; }`
+ attrset or not (refer to [](#opt-services.parsedmarc.settings) for
details).
'';
apply = x: if isAttrs x || x == null then x else { _secret = x; };
@@ -326,14 +322,13 @@ in
password = lib.mkOption {
type = with lib.types; nullOr (either path (attrsOf path));
default = null;
- description = ''
+ description = lib.mdDoc ''
The password to use when connecting to Elasticsearch,
if required.
Always handled as a secret whether the value is
- wrapped in a { _secret = ...; }
- attrset or not (refer to for
+ wrapped in a `{ _secret = ...; }`
+ attrset or not (refer to [](#opt-services.parsedmarc.settings) for
details).
'';
apply = x: if isAttrs x || x == null then x else { _secret = x; };
diff --git a/nixos/modules/services/monitoring/prometheus/default.nix b/nixos/modules/services/monitoring/prometheus/default.nix
index db4286b66a5d..3bc61fba158f 100644
--- a/nixos/modules/services/monitoring/prometheus/default.nix
+++ b/nixos/modules/services/monitoring/prometheus/default.nix
@@ -379,9 +379,8 @@ let
gce_sd_configs = mkOpt (types.listOf promTypes.gce_sd_config) ''
List of Google Compute Engine service discovery configurations.
- See the
- relevant Prometheus configuration docs for more detail.
+ See the relevant Prometheus configuration docs
+ for more detail.
'';
hetzner_sd_configs = mkOpt (types.listOf promTypes.hetzner_sd_config) ''
@@ -807,9 +806,7 @@ let
filter = mkOpt types.str ''
Filter can be used optionally to filter the instance list by other
criteria Syntax of this filter string is described here in the filter
- query parameter section: .
+ query parameter section: .
'';
refresh_interval = mkDefOpt types.str "60s" ''
@@ -825,7 +822,7 @@ let
The tag separator used to separate concatenated GCE instance network tags.
See the GCP documentation on network tags for more information:
-
+
'';
};
};
@@ -1033,13 +1030,13 @@ let
auth_token = mkOpt types.str ''
Optional authentication information for token-based authentication:
-
+
It is mutually exclusive with auth_token_file and other authentication mechanisms.
'';
auth_token_file = mkOpt types.str ''
Optional authentication information for token-based authentication:
-
+
It is mutually exclusive with auth_token and other authentication mechanisms.
'';
};
diff --git a/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix b/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix
index 092ac6fea7d7..4e7aae0b34b5 100644
--- a/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix
+++ b/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix
@@ -33,10 +33,10 @@ in
work with this exporter:
{
- = true;
- = "/var/run/dovecot2/old-stats";
- = [ "old_stats" ];
- = '''
+ = true;
+ = "/var/run/dovecot2/old-stats";
+ = [ "old_stats" ];
+ = '''
service old-stats {
unix_listener old-stats {
user = dovecot-exporter
diff --git a/nixos/modules/services/monitoring/prometheus/exporters/process.nix b/nixos/modules/services/monitoring/prometheus/exporters/process.nix
index 1e9c402fb55b..666116991b5a 100644
--- a/nixos/modules/services/monitoring/prometheus/exporters/process.nix
+++ b/nixos/modules/services/monitoring/prometheus/exporters/process.nix
@@ -22,7 +22,7 @@ in
All settings expressed as an Nix attrset.
Check the official documentation for the corresponding YAML
- settings that can all be used here:
+ settings that can all be used here:
'';
};
};
diff --git a/nixos/modules/services/monitoring/prometheus/exporters/script.nix b/nixos/modules/services/monitoring/prometheus/exporters/script.nix
index a805a0ad335d..2a43fbcab3a1 100644
--- a/nixos/modules/services/monitoring/prometheus/exporters/script.nix
+++ b/nixos/modules/services/monitoring/prometheus/exporters/script.nix
@@ -41,7 +41,7 @@ in
All settings expressed as an Nix attrset.
Check the official documentation for the corresponding YAML
- settings that can all be used here:
+ settings that can all be used here:
'';
};
};
diff --git a/nixos/modules/services/networking/biboumi.nix b/nixos/modules/services/networking/biboumi.nix
index 7e6033008832..24e0c0328fe6 100644
--- a/nixos/modules/services/networking/biboumi.nix
+++ b/nixos/modules/services/networking/biboumi.nix
@@ -83,13 +83,13 @@ in
};
options.password = mkOption {
type = with types; nullOr str;
- description = ''
+ description = lib.mdDoc ''
The password used to authenticate the XMPP component to your XMPP server.
This password must be configured in the XMPP server,
associated with the external component on
- hostname.
+ [hostname](#opt-services.biboumi.settings.hostname).
- Set it to null and use credentialsFile
+ Set it to null and use [credentialsFile](#opt-services.biboumi.credentialsFile)
if you do not want this password to go into the Nix store.
'';
};
@@ -155,12 +155,12 @@ in
credentialsFile = mkOption {
type = types.path;
- description = ''
+ description = lib.mdDoc ''
Path to a configuration file to be merged with the settings.
Beware not to surround "=" with spaces when setting biboumi's options in this file.
Useful to merge a file which is better kept out of the Nix store
because it contains sensible data like
- password.
+ [password](#opt-services.biboumi.settings.password).
'';
default = "/dev/null";
example = "/run/keys/biboumi.cfg";
diff --git a/nixos/modules/services/networking/bird-lg.nix b/nixos/modules/services/networking/bird-lg.nix
index db4a4140dd40..1440deb62b44 100644
--- a/nixos/modules/services/networking/bird-lg.nix
+++ b/nixos/modules/services/networking/bird-lg.nix
@@ -136,9 +136,9 @@ in
extraArgs = mkOption {
type = types.lines;
default = "";
- description = "
- Extra parameters documented here.
- ";
+ description = lib.mdDoc ''
+ Extra parameters documented [here](https://github.com/xddxdd/bird-lg-go#frontend).
+ '';
};
};
@@ -183,9 +183,9 @@ in
extraArgs = mkOption {
type = types.lines;
default = "";
- description = "
- Extra parameters documented here.
- ";
+ description = lib.mdDoc ''
+ Extra parameters documented [here](https://github.com/xddxdd/bird-lg-go#proxy).
+ '';
};
};
};
diff --git a/nixos/modules/services/networking/bird.nix b/nixos/modules/services/networking/bird.nix
index d409f0602289..7708aaa476f6 100644
--- a/nixos/modules/services/networking/bird.nix
+++ b/nixos/modules/services/networking/bird.nix
@@ -13,18 +13,18 @@ in
enable = mkEnableOption "BIRD Internet Routing Daemon";
config = mkOption {
type = types.lines;
- description = ''
+ description = lib.mdDoc ''
BIRD Internet Routing Daemon configuration file.
-
+
'';
};
checkConfig = mkOption {
type = types.bool;
default = true;
- description = ''
+ description = lib.mdDoc ''
Whether the config should be checked at build time.
When the config can't be checked during build time, for example when it includes
- other files, either disable this option or use preCheckConfig to create
+ other files, either disable this option or use `preCheckConfig` to create
the included files before checking.
'';
};
@@ -34,9 +34,9 @@ in
example = ''
echo "cost 100;" > include.conf
'';
- description = ''
+ description = lib.mdDoc ''
Commands to execute before the config file check. The file to be checked will be
- available as bird2.conf in the current directory.
+ available as `bird2.conf` in the current directory.
Files created with this option will not be available at service runtime, only during
build time checking.
diff --git a/nixos/modules/services/networking/coredns.nix b/nixos/modules/services/networking/coredns.nix
index 9a4140e9d58a..deaba69e99fa 100644
--- a/nixos/modules/services/networking/coredns.nix
+++ b/nixos/modules/services/networking/coredns.nix
@@ -17,7 +17,10 @@ in {
}
'';
type = types.lines;
- description = "Verbatim Corefile to use. See for details.";
+ description = lib.mdDoc ''
+ Verbatim Corefile to use.
+ See for details.
+ '';
};
package = mkOption {
diff --git a/nixos/modules/services/networking/ghostunnel.nix b/nixos/modules/services/networking/ghostunnel.nix
index 6cac6a69b067..79cf80e57bef 100644
--- a/nixos/modules/services/networking/ghostunnel.nix
+++ b/nixos/modules/services/networking/ghostunnel.nix
@@ -40,37 +40,37 @@ let
description = ''
Path to keystore (combined PEM with cert/key, or PKCS12 keystore).
- NB: storepass is not supported because it would expose credentials via /proc/*/cmdline.
+ NB: storepass is not supported because it would expose credentials via /proc/*/cmdline.
- Specify this or cert and key.
+ Specify this or cert and key.
'';
type = types.nullOr types.str;
default = null;
};
cert = mkOption {
- description = ''
+ description = lib.mdDoc ''
Path to certificate (PEM with certificate chain).
- Not required if keystore is set.
+ Not required if `keystore` is set.
'';
type = types.nullOr types.str;
default = null;
};
key = mkOption {
- description = ''
+ description = lib.mdDoc ''
Path to certificate private key (PEM with private key).
- Not required if keystore is set.
+ Not required if `keystore` is set.
'';
type = types.nullOr types.str;
default = null;
};
cacert = mkOption {
- description = ''
- Path to CA bundle file (PEM/X509). Uses system trust store if null.
+ description = lib.mdDoc ''
+ Path to CA bundle file (PEM/X509). Uses system trust store if `null`.
'';
type = types.nullOr types.str;
};
@@ -124,7 +124,7 @@ let
};
extraArguments = mkOption {
- description = "Extra arguments to pass to ghostunnel server";
+ description = lib.mdDoc "Extra arguments to pass to `ghostunnel server`";
type = types.separatedString " ";
default = "";
};
diff --git a/nixos/modules/services/networking/hans.nix b/nixos/modules/services/networking/hans.nix
index f74d602be933..ffb2ee841c64 100644
--- a/nixos/modules/services/networking/hans.nix
+++ b/nixos/modules/services/networking/hans.nix
@@ -19,12 +19,12 @@ in
services.hans = {
clients = mkOption {
default = {};
- description = ''
+ description = lib.mdDoc ''
Each attribute of this option defines a systemd service that
runs hans. Many or none may be defined.
The name of each service is
- hans-name
- where name is the name of the
+ `hans-«name»`
+ where «name» is the name of the
corresponding attribute name.
'';
example = literalExpression ''
diff --git a/nixos/modules/services/networking/iodine.nix b/nixos/modules/services/networking/iodine.nix
index c24f118ce898..ea2fa3ac4be4 100644
--- a/nixos/modules/services/networking/iodine.nix
+++ b/nixos/modules/services/networking/iodine.nix
@@ -28,12 +28,12 @@ in
services.iodine = {
clients = mkOption {
default = {};
- description = ''
+ description = lib.mdDoc ''
Each attribute of this option defines a systemd service that
runs iodine. Many or none may be defined.
The name of each service is
- iodine-name
- where name is the name of the
+ `iodine-«name»`
+ where «name» is the name of the
corresponding attribute name.
'';
example = literalExpression ''
diff --git a/nixos/modules/services/networking/kea.nix b/nixos/modules/services/networking/kea.nix
index d9d6e3f42ceb..d674a97391c9 100644
--- a/nixos/modules/services/networking/kea.nix
+++ b/nixos/modules/services/networking/kea.nix
@@ -54,11 +54,11 @@ in
configFile = mkOption {
type = nullOr path;
default = null;
- description = ''
- Kea Control Agent configuration as a path, see .
+ description = lib.mdDoc ''
+ Kea Control Agent configuration as a path, see .
- Takes preference over settings.
- Most users should prefer using settings instead.
+ Takes preference over [settings](#opt-services.kea.ctrl-agent.settings).
+ Most users should prefer using [settings](#opt-services.kea.ctrl-agent.settings) instead.
'';
};
@@ -93,11 +93,11 @@ in
configFile = mkOption {
type = nullOr path;
default = null;
- description = ''
- Kea DHCP4 configuration as a path, see .
+ description = lib.mdDoc ''
+ Kea DHCP4 configuration as a path, see .
- Takes preference over settings.
- Most users should prefer using settings instead.
+ Takes preference over [settings](#opt-services.kea.dhcp4.settings).
+ Most users should prefer using [settings](#opt-services.kea.dhcp4.settings) instead.
'';
};
@@ -153,11 +153,11 @@ in
configFile = mkOption {
type = nullOr path;
default = null;
- description = ''
- Kea DHCP6 configuration as a path, see .
+ description = lib.mdDoc ''
+ Kea DHCP6 configuration as a path, see .
- Takes preference over settings.
- Most users should prefer using settings instead.
+ Takes preference over [settings](#opt-services.kea.dhcp6.settings).
+ Most users should prefer using [settings](#opt-services.kea.dhcp6.settings) instead.
'';
};
@@ -214,11 +214,11 @@ in
configFile = mkOption {
type = nullOr path;
default = null;
- description = ''
- Kea DHCP-DDNS configuration as a path, see .
+ description = lib.mdDoc ''
+ Kea DHCP-DDNS configuration as a path, see .
- Takes preference over settings.
- Most users should prefer using settings instead.
+ Takes preference over [settings](#opt-services.kea.dhcp-ddns.settings).
+ Most users should prefer using [settings](#opt-services.kea.dhcp-ddns.settings) instead.
'';
};
diff --git a/nixos/modules/services/networking/ncdns.nix b/nixos/modules/services/networking/ncdns.nix
index 3527b9e18575..958231963c68 100644
--- a/nixos/modules/services/networking/ncdns.nix
+++ b/nixos/modules/services/networking/ncdns.nix
@@ -176,10 +176,10 @@ in
certstore.nssdbdir = "../../home/alice/.pki/nssdb";
}
'';
- description = ''
+ description = lib.mdDoc ''
ncdns settings. Use this option to configure ncds
settings not exposed in a NixOS option or to bypass one.
- See the example ncdns.conf file at
+ See the example ncdns.conf file at
for the available options.
'';
};
diff --git a/nixos/modules/services/networking/networkmanager.nix b/nixos/modules/services/networking/networkmanager.nix
index 7abdf16b1534..e77fa97d240e 100644
--- a/nixos/modules/services/networking/networkmanager.nix
+++ b/nixos/modules/services/networking/networkmanager.nix
@@ -329,8 +329,7 @@ in {
default = "default";
description = ''
Set the DNS (resolv.conf) processing mode.
-
-
+
A description of these modes can be found in the main section of
https://developer.gnome.org/NetworkManager/stable/NetworkManager.conf.html
@@ -388,12 +387,12 @@ in {
enableStrongSwan = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Enable the StrongSwan plugin.
-
+
If you enable this option the
- networkmanager_strongswan plugin will be added to
- the option
+ `networkmanager_strongswan` plugin will be added to
+ the {option}`networking.networkmanager.plugins` option
so you don't need to to that yourself.
'';
};
diff --git a/nixos/modules/services/networking/nntp-proxy.nix b/nixos/modules/services/networking/nntp-proxy.nix
index 618ed0a93f1d..4dd2922e83f1 100644
--- a/nixos/modules/services/networking/nntp-proxy.nix
+++ b/nixos/modules/services/networking/nntp-proxy.nix
@@ -167,9 +167,9 @@ in
passwordHash = mkOption {
type = types.str;
example = "$6$GtzE7FrpE$wwuVgFYU.TZH4Rz.Snjxk9XGua89IeVwPQ/fEUD8eujr40q5Y021yhn0aNcsQ2Ifw.BLclyzvzgegopgKcneL0";
- description = ''
+ description = lib.mdDoc ''
SHA-512 password hash (can be generated by
- mkpasswd -m sha-512 <password>)
+ `mkpasswd -m sha-512 `)
'';
};
diff --git a/nixos/modules/services/networking/nsd.nix b/nixos/modules/services/networking/nsd.nix
index 1102fc85d40a..cf2afcacc528 100644
--- a/nixos/modules/services/networking/nsd.nix
+++ b/nixos/modules/services/networking/nsd.nix
@@ -392,8 +392,8 @@ let
requestXFR = mkOption {
type = types.listOf types.str;
default = [];
- description = ''
- Format: [AXFR|UDP] <ip-address> <key-name | NOKEY>
+ description = lib.mdDoc ''
+ Format: `[AXFR|UDP] `
'';
};
diff --git a/nixos/modules/services/networking/ntp/ntpd.nix b/nixos/modules/services/networking/ntp/ntpd.nix
index 47922f5e1499..a9dae2c8667a 100644
--- a/nixos/modules/services/networking/ntp/ntpd.nix
+++ b/nixos/modules/services/networking/ntp/ntpd.nix
@@ -40,21 +40,19 @@ in
enable = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to synchronise your machine's time using ntpd, as a peer in
the NTP network.
-
-
- Disables systemd.timesyncd if enabled.
+
+ Disables `systemd.timesyncd` if enabled.
'';
};
restrictDefault = mkOption {
type = types.listOf types.str;
- description = ''
+ description = lib.mdDoc ''
The restriction flags to be set by default.
-
-
+
The default flags prevent external hosts from using ntpd as a DDoS
reflector, setting system time, and querying OS/ntpd version. As
recommended in section 6.5.1.1.3, answer "No" of
@@ -65,10 +63,9 @@ in
restrictSource = mkOption {
type = types.listOf types.str;
- description = ''
+ description = lib.mdDoc ''
The restriction flags to be set on source.
-
-
+
The default flags allow peers to be added by ntpd from configured
pool(s), but not by other means.
'';
diff --git a/nixos/modules/services/networking/openconnect.nix b/nixos/modules/services/networking/openconnect.nix
index c5313bb305a2..469f0a3bc3bb 100644
--- a/nixos/modules/services/networking/openconnect.nix
+++ b/nixos/modules/services/networking/openconnect.nix
@@ -38,10 +38,10 @@ let
# set an authentication cookie, because they have to be requested
# for every new connection and would only work once.
passwordFile = mkOption {
- description = ''
+ description = lib.mdDoc ''
File containing the password to authenticate with. This
- is passed to openconnect via the
- --passwd-on-stdin option.
+ is passed to `openconnect` via the
+ `--passwd-on-stdin` option.
'';
default = null;
example = "/var/lib/secrets/openconnect-passwd";
@@ -63,13 +63,13 @@ let
};
extraOptions = mkOption {
- description = ''
+ description = lib.mdDoc ''
Extra config to be appended to the interface config. It should
contain long-format options as would be accepted on the command
- line by openconnect
+ line by `openconnect`
(see https://www.infradead.org/openconnect/manual.html).
- Non-key-value options like deflate can be used by
- declaring them as booleans, i. e. deflate = true;.
+ Non-key-value options like `deflate` can be used by
+ declaring them as booleans, i. e. `deflate = true;`.
'';
default = { };
example = {
diff --git a/nixos/modules/services/networking/openvpn.nix b/nixos/modules/services/networking/openvpn.nix
index 752b4d67d47e..492a0936fdbb 100644
--- a/nixos/modules/services/networking/openvpn.nix
+++ b/nixos/modules/services/networking/openvpn.nix
@@ -115,12 +115,12 @@ in
}
'';
- description = ''
+ description = lib.mdDoc ''
Each attribute of this option defines a systemd service that
runs an OpenVPN instance. These can be OpenVPN servers or
clients. The name of each systemd service is
- openvpn-name.service,
- where name is the corresponding
+ `openvpn-«name».service`,
+ where «name» is the corresponding
attribute name.
'';
diff --git a/nixos/modules/services/networking/pleroma.nix b/nixos/modules/services/networking/pleroma.nix
index 03868c8cc769..de9d0821c63a 100644
--- a/nixos/modules/services/networking/pleroma.nix
+++ b/nixos/modules/services/networking/pleroma.nix
@@ -34,7 +34,7 @@ in {
configs = mkOption {
type = with types; listOf str;
- description = ''
+ description = lib.mdDoc ''
Pleroma public configuration.
This list gets appended from left to
@@ -42,9 +42,9 @@ in {
configuration imperatively, meaning you can override a
setting by appending a new str to this NixOS option list.
- DO NOT STORE ANY PLEROMA SECRET
- HERE, use
- services.pleroma.secretConfigFile
+ *DO NOT STORE ANY PLEROMA SECRET
+ HERE*, use
+ [services.pleroma.secretConfigFile](#opt-services.pleroma.secretConfigFile)
instead.
This setting is going to be stored in a file part of
diff --git a/nixos/modules/services/networking/seafile.nix b/nixos/modules/services/networking/seafile.nix
index 7cda71458dd1..d9617952ea59 100644
--- a/nixos/modules/services/networking/seafile.nix
+++ b/nixos/modules/services/networking/seafile.nix
@@ -133,7 +133,7 @@ in {
type = types.lines;
description = ''
Extra config to append to `seahub_settings.py` file.
- Refer to
+ Refer to
for all available options.
'';
};
diff --git a/nixos/modules/services/networking/ssh/sshd.nix b/nixos/modules/services/networking/ssh/sshd.nix
index c6386ed6823d..6da83eb7de10 100644
--- a/nixos/modules/services/networking/ssh/sshd.nix
+++ b/nixos/modules/services/networking/ssh/sshd.nix
@@ -257,12 +257,12 @@ in
authorizedKeysFiles = mkOption {
type = types.listOf types.str;
default = [];
- description = ''
+ description = lib.mdDoc ''
Specify the rules for which files to read on the host.
This is an advanced option. If you're looking to configure user
- keys, you can generally use
- or .
+ keys, you can generally use [](#opt-users.users._name_.openssh.authorizedKeys.keys)
+ or [](#opt-users.users._name_.openssh.authorizedKeys.keyFiles).
These are paths relative to the host root file system or home
directories and they are subject to certain token expansion rules.
@@ -298,14 +298,13 @@ in
"curve25519-sha256@libssh.org"
"diffie-hellman-group-exchange-sha256"
];
- description = ''
+ description = lib.mdDoc ''
Allowed key exchange algorithms
-
-
+
Uses the lower bound recommended in both
-
+
and
-
+
'';
};
@@ -319,14 +318,13 @@ in
"aes192-ctr"
"aes128-ctr"
];
- description = ''
+ description = lib.mdDoc ''
Allowed ciphers
-
-
+
Defaults to recommended settings from both
-
+
and
-
+
'';
};
@@ -340,14 +338,13 @@ in
"hmac-sha2-256"
"umac-128@openssh.com"
];
- description = ''
+ description = lib.mdDoc ''
Allowed MACs
-
-
+
Defaults to recommended settings from both
-
+
and
-
+
'';
};
diff --git a/nixos/modules/services/networking/strongswan-swanctl/param-constructors.nix b/nixos/modules/services/networking/strongswan-swanctl/param-constructors.nix
index dfdfc50d8ae2..d5a8daf98ec6 100644
--- a/nixos/modules/services/networking/strongswan-swanctl/param-constructors.nix
+++ b/nixos/modules/services/networking/strongswan-swanctl/param-constructors.nix
@@ -59,7 +59,8 @@ rec {
if strongswanDefault == null
then description
else description + ''
-
+
+
StrongSwan default:
'';
diff --git a/nixos/modules/services/networking/strongswan-swanctl/swanctl-params.nix b/nixos/modules/services/networking/strongswan-swanctl/swanctl-params.nix
index cca61b9ce930..737d0331f195 100644
--- a/nixos/modules/services/networking/strongswan-swanctl/swanctl-params.nix
+++ b/nixos/modules/services/networking/strongswan-swanctl/swanctl-params.nix
@@ -15,14 +15,14 @@ let
file = mkOptionalStrParam ''
Absolute path to the certificate to load. Passed as-is to the daemon, so
it must be readable by it.
-
+
Configure either this or , but not both, in one section.
'';
handle = mkOptionalHexParam ''
Hex-encoded CKA_ID or handle of the certificate on a token or TPM,
respectively.
-
+
Configure either this or , but not both, in one section.
'';
@@ -40,7 +40,7 @@ in {
cacert = mkOptionalStrParam ''
The certificates may use a relative path from the swanctl
x509ca directory or an absolute path.
-
+
Configure one of ,
, or
per section.
@@ -82,11 +82,11 @@ in {
local_addrs = mkCommaSepListParam [] ''
Local address(es) to use for IKE communication. Takes
single IPv4/IPv6 addresses, DNS names, CIDR subnets or IP address ranges.
-
+
As initiator, the first non-range/non-subnet is used to initiate the
connection from. As responder, the local destination address must match at
least to one of the specified addresses, subnets or ranges.
-
+
If FQDNs are assigned they are resolved every time a configuration lookup
is done. If DNS resolution times out, the lookup is delayed for that time.
'';
@@ -94,11 +94,11 @@ in {
remote_addrs = mkCommaSepListParam [] ''
Remote address(es) to use for IKE communication. Takes
single IPv4/IPv6 addresses, DNS names, CIDR subnets or IP address ranges.
-
+
As initiator, the first non-range/non-subnet is used to initiate the
connection to. As responder, the initiator source address must match at
least to one of the specified addresses, subnets or ranges.
-
+
If FQDNs are assigned they are resolved every time a configuration lookup
is done. If DNS resolution times out, the lookup is delayed for that time.
To initiate a connection, at least one specific address or DNS name must
@@ -110,7 +110,7 @@ in {
backend is used, which is usually 500. If port
500 is used, automatic IKE port floating to port
4500 is used to work around NAT issues.
-
+
Using a non-default local IKE port requires support from the socket
backend in use (socket-dynamic).
'';
@@ -126,13 +126,13 @@ in {
for IKE an encryption algorithm, an integrity algorithm, a pseudo random
function and a Diffie-Hellman group. For AEAD algorithms, instead of
encryption and integrity algorithms, a combined algorithm is used.
-
+
In IKEv2, multiple algorithms of the same kind can be specified in a
single proposal, from which one gets selected. In IKEv1, only one
algorithm per kind is allowed per proposal, more algorithms get implicitly
stripped. Use multiple proposals to offer different algorithms
combinations in IKEv1.
-
+
Algorithm keywords get separated using dashes. Multiple proposals may be
specified in a list. The special value default forms a
default proposal of supported algorithms considered safe, and is usually a
@@ -159,7 +159,7 @@ in {
If the default of yes is used, Mode Config works in pull mode, where the
initiator actively requests a virtual IP. With no, push mode is used,
where the responder pushes down a virtual IP to the initiating peer.
-
+
Push mode is currently supported for IKEv1, but not in IKEv2. It is used
by a few implementations only, pull mode is recommended.
'';
@@ -174,7 +174,7 @@ in {
To enforce UDP encapsulation of ESP packets, the IKE daemon can fake the
NAT detection payloads. This makes the peer believe that NAT takes place
on the path, forcing it to encapsulate ESP packets in UDP.
-
+
Usually this is not required, but it can help to work around connectivity
issues with too restrictive intermediary firewalls.
'';
@@ -183,7 +183,7 @@ in {
Enables MOBIKE on IKEv2 connections. MOBIKE is enabled by default on IKEv2
connections, and allows mobility of clients and multi-homing on servers by
migrating active IPsec tunnels.
-
+
Usually keeping MOBIKE enabled is unproblematic, as it is not used if the
peer does not indicate support for it. However, due to the design of
MOBIKE, IKEv2 always floats to port 4500 starting from the second
@@ -222,7 +222,7 @@ in {
Finally, setting the option to no will disable announcing
support for this feature.
-
+
Note that fragmented IKE messages sent by a peer are always processed
irrespective of the value of this option (even when set to no).
'';
@@ -284,7 +284,7 @@ in {
unique = mkEnumParam ["no" "never" "keep" "replace"] "no" ''
Connection uniqueness policy to enforce. To avoid multiple connections
from the same user, a uniqueness policy can be enforced.
-
+
The value never does never enforce such a policy, even
@@ -306,7 +306,7 @@ in {
To compare connections for uniqueness, the remote IKE identity is used. If
EAP or XAuth authentication is involved, the EAP-Identity or XAuth
username is used to enforce the uniqueness policy instead.
-
+
On initiators this setting specifies whether an INITIAL_CONTACT notify is
sent during IKE_AUTH if no existing connection is found with the remote
peer (determined by the identities of the first authentication
@@ -320,7 +320,7 @@ in {
possible to actively reauthenticate as responder. The IKEv2
reauthentication lifetime negotiation can instruct the client to perform
reauthentication.
-
+
Reauthentication is disabled by default. Enabling it usually may lead to
small connection interruptions, as strongSwan uses a break-before-make
policy with IKEv2 to avoid any conflicts with associated tunnel resources.
@@ -330,7 +330,7 @@ in {
IKE rekeying refreshes key material using a Diffie-Hellman exchange, but
does not re-check associated credentials. It is supported in IKEv2 only,
IKEv1 performs a reauthentication procedure instead.
-
+
With the default value IKE rekeying is scheduled every 4 hours, minus the
configured rand_time. If a reauth_time is configured, rekey_time defaults
to zero, disabling rekeying; explicitly set both to enforce rekeying and
@@ -343,10 +343,10 @@ in {
perpetually, a maximum hard lifetime may be specified. If the IKE_SA fails
to rekey or reauthenticate within the specified time, the IKE_SA gets
closed.
-
+
In contrast to CHILD_SA rekeying, over_time is relative in time to the
rekey_time and reauth_time values, as it applies to both.
-
+
The default is 10% of the longer of and
.
'';
@@ -356,7 +356,7 @@ in {
rekey/reauth times. To avoid having both peers initiating the rekey/reauth
procedure simultaneously, a random time gets subtracted from the
rekey/reauth times.
-
+
The default is equal to the configured .
'';
@@ -410,7 +410,7 @@ in {
List of certificate candidates to use for
authentication. The certificates may use a relative path from the
swanctl x509 directory or an absolute path.
-
+
The certificate used for authentication is selected based on the
received certificate request payloads. If no appropriate CA can be
located, the first certificate is used.
@@ -426,7 +426,7 @@ in {
List of raw public key candidates to use for
authentication. The public keys may use a relative path from the swanctl
pubkey directory or an absolute path.
-
+
Even though multiple local public keys could be defined in principle,
only the first public key in the list is used for authentication.
'';
@@ -504,7 +504,7 @@ in {
authentication. This identity may differ from the IKE identity,
especially when EAP authentication is delegated from the IKE responder
to an AAA backend.
-
+
For EAP-(T)TLS, this defines the identity for which the server must
provide a certificate in the TLS exchange.
'';
@@ -518,7 +518,7 @@ in {
defines the rules how authentication is performed for the local
peer. Multiple rounds may be defined to use IKEv2 RFC 4739 Multiple
Authentication or IKEv1 XAuth.
-
+
Each round is defined in a section having local as
prefix, and an optional unique suffix. To define a single authentication
round, the suffix may be omitted.
@@ -620,7 +620,7 @@ in {
Authentication to expect from remote. See the
section's keyword description about the details of
supported mechanisms.
-
+
Since 5.4.0, to require a trustchain public key strength for the remote
side, specify the key type followed by the minimum strength in bits (for
example ecdsa-384 or
@@ -641,7 +641,7 @@ in {
pubkey or rsa constraints are
configured RSASSA-PSS signatures will only be accepted if enabled in
strongswan.conf(5).
-
+
To specify trust chain constraints for EAP-(T)TLS, append a colon to the
EAP method, followed by the key type/size and hash algorithm as
discussed above (e.g. eap-tls:ecdsa-384-sha384).
@@ -652,7 +652,7 @@ in {
defines the constraints how the peers must authenticate to use this
connection. Multiple rounds may be defined to use IKEv2 RFC 4739 Multiple
Authentication or IKEv1 XAuth.
-
+
Each round is defined in a section having remote as
prefix, and an optional unique suffix. To define a single authentication
round, the suffix may be omitted.
@@ -665,13 +665,13 @@ in {
Diffie-Hellman group. If a DH group is specified, CHILD_SA/Quick Mode
rekeying and initial negotiation uses a separate Diffie-Hellman exchange
using the specified group (refer to esp_proposals for details).
-
+
In IKEv2, multiple algorithms of the same kind can be specified in a
single proposal, from which one gets selected. In IKEv1, only one
algorithm per kind is allowed per proposal, more algorithms get
implicitly stripped. Use multiple proposals to offer different algorithms
combinations in IKEv1.
-
+
Algorithm keywords get separated using dashes. Multiple proposals may be
specified in a list. The special value default forms
a default proposal of supported algorithms considered safe, and is
@@ -686,7 +686,7 @@ in {
an optional Extended Sequence Number Mode indicator. For AEAD proposals,
a combined mode algorithm is used instead of the separate
encryption/integrity algorithms.
-
+
If a DH group is specified, CHILD_SA/Quick Mode rekeying and initial
negotiation use a separate Diffie-Hellman exchange using the specified
group. However, for IKEv2, the keys of the CHILD_SA created implicitly
@@ -695,18 +695,18 @@ in {
rekeyed or is created with a separate CREATE_CHILD_SA exchange. A
proposal mismatch might, therefore, not immediately be noticed when the
SA is established, but may later cause rekeying to fail.
-
+
Extended Sequence Number support may be indicated with the
esn and noesn values, both may be
included to indicate support for both modes. If omitted,
noesn is assumed.
-
+
In IKEv2, multiple algorithms of the same kind can be specified in a
single proposal, from which one gets selected. In IKEv1, only one
algorithm per kind is allowed per proposal, more algorithms get
implicitly stripped. Use multiple proposals to offer different algorithms
combinations in IKEv1.
-
+
Algorithm keywords get separated using dashes. Multiple proposals may be
specified as a list. The special value default forms
a default proposal of supported algorithms considered safe, and is
@@ -729,7 +729,7 @@ in {
selector. The special value dynamic may be used
instead of a subnet definition, which gets replaced by the tunnel outer
address or the virtual IP, if negotiated. This is the default.
-
+
A protocol/port selector is surrounded by opening and closing square
brackets. Between these brackets, a numeric or getservent(3) protocol
name may be specified. After the optional protocol restriction, an
@@ -738,7 +738,7 @@ in {
special value opaque for RFC 4301 OPAQUE
selectors. Port ranges may be specified as well, none of the kernel
backends currently support port ranges, though.
-
+
When IKEv1 is used only the first selector is interpreted, except if the
Cisco Unity extension plugin is used. This is due to a limitation of the
IKEv1 protocol, which only allows a single pair of selectors per
@@ -761,7 +761,7 @@ in {
specified in the proposal. To avoid rekey collisions initiated by both
ends simultaneously, a value in the range of
gets subtracted to form the effective soft lifetime.
-
+
By default CHILD_SA rekeying is scheduled every hour, minus
.
'';
@@ -783,11 +783,11 @@ in {
Number of bytes processed before initiating CHILD_SA rekeying. CHILD_SA
rekeying refreshes key material, optionally using a Diffie-Hellman
exchange if a group is specified in the proposal.
-
+
To avoid rekey collisions initiated by both ends simultaneously, a value
in the range of gets subtracted to form the
effective soft volume limit.
-
+
Volume based CHILD_SA rekeying is disabled by default.
'';
@@ -808,11 +808,11 @@ in {
Number of packets processed before initiating CHILD_SA rekeying. CHILD_SA
rekeying refreshes key material, optionally using a Diffie-Hellman
exchange if a group is specified in the proposal.
-
+
To avoid rekey collisions initiated by both ends simultaneously, a value
in the range of gets subtracted to form
the effective soft packet count limit.
-
+
Packet count based CHILD_SA rekeying is disabled by default.
'';
@@ -821,7 +821,7 @@ in {
this hard packets limit is never reached, because the CHILD_SA gets
rekeyed before. If that fails for whatever reason, this limit closes the
CHILD_SA.
-
+
The default is 10% more than .
'';
@@ -936,7 +936,7 @@ in {
%unique sets a unique mark on each CHILD_SA instance,
beyond that the value %unique-dir assigns a different
unique mark for each
-
+
An additional mask may be appended to the mark, separated by
/. The default mask if omitted is
0xffffffff.
@@ -960,7 +960,7 @@ in {
value %unique sets a unique mark on each CHILD_SA
instance, beyond that the value %unique-dir assigns a
different unique mark for each CHILD_SA direction (in/out).
-
+
An additional mask may be appended to the mark, separated by
/. The default mask if omitted is
0xffffffff.
@@ -1102,7 +1102,7 @@ in {
start tries to re-create the CHILD_SA.
-
+
does not provide any guarantee that the
CHILD_SA is kept alive. It acts on explicit close messages only, but not
on negotiation failures. Use trap policies to reliably re-create failed
diff --git a/nixos/modules/services/networking/wireguard.nix b/nixos/modules/services/networking/wireguard.nix
index 412e9c921f52..9017c53f4e56 100644
--- a/nixos/modules/services/networking/wireguard.nix
+++ b/nixos/modules/services/networking/wireguard.nix
@@ -118,12 +118,11 @@ let
default = null;
type = with types; nullOr str;
example = "container";
- description = ''The pre-existing network namespace in which the
+ description = lib.mdDoc ''The pre-existing network namespace in which the
WireGuard interface is created, and which retains the socket even if the
- interface is moved via . When
- null, the interface is created in the init namespace.
- See documentation.
+ interface is moved via {option}`interfaceNamespace`. When
+ `null`, the interface is created in the init namespace.
+ See [documentation](https://www.wireguard.com/netns/).
'';
};
@@ -131,12 +130,11 @@ let
default = null;
type = with types; nullOr str;
example = "init";
- description = ''The pre-existing network namespace the WireGuard
- interface is moved to. The special value init means
- the init namespace. When null, the interface is not
+ description = lib.mdDoc ''The pre-existing network namespace the WireGuard
+ interface is moved to. The special value `init` means
+ the init namespace. When `null`, the interface is not
moved.
- See documentation.
+ See [documentation](https://www.wireguard.com/netns/).
'';
};
};
diff --git a/nixos/modules/services/networking/wpa_supplicant.nix b/nixos/modules/services/networking/wpa_supplicant.nix
index e21c25e2f78f..ac5f597b4752 100644
--- a/nixos/modules/services/networking/wpa_supplicant.nix
+++ b/nixos/modules/services/networking/wpa_supplicant.nix
@@ -190,7 +190,7 @@ in {
description = ''
Whether to allow configuring networks "imperatively" (e.g. via
wpa_supplicant_gui) and declaratively via
- .
+ .
Please note that this adds a custom patch to wpa_supplicant.
'';
diff --git a/nixos/modules/services/networking/yggdrasil.nix b/nixos/modules/services/networking/yggdrasil.nix
index 07b2e2a2daf2..266149cf2211 100644
--- a/nixos/modules/services/networking/yggdrasil.nix
+++ b/nixos/modules/services/networking/yggdrasil.nix
@@ -44,8 +44,8 @@ in {
are supplied, they will be combined, with values from
taking precedence.
- You can use the command nix-shell -p yggdrasil --run
- "yggdrasil -genconf" to generate default
+ You can use the command nix-shell -p yggdrasil --run
+ "yggdrasil -genconf" to generate default
configuration values with documentation.
'';
};
@@ -64,21 +64,21 @@ in {
type = types.nullOr types.str;
default = null;
example = "wheel";
- description = "Group to grant access to the Yggdrasil control socket. If null, only root can access the socket.";
+ description = lib.mdDoc "Group to grant access to the Yggdrasil control socket. If `null`, only root can access the socket.";
};
openMulticastPort = mkOption {
type = bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to open the UDP port used for multicast peer
discovery. The NixOS firewall blocks link-local
communication, so in order to make local peering work you
- will also need to set LinkLocalTCPPort in your
- yggdrasil configuration ( or
- ) to a port number other than 0,
+ will also need to set `LinkLocalTCPPort` in your
+ yggdrasil configuration ({option}`config` or
+ {option}`configFile`) to a port number other than 0,
and then add that port to
- .
+ {option}`networking.firewall.allowedTCPPorts`.
'';
};
diff --git a/nixos/modules/services/networking/znc/default.nix b/nixos/modules/services/networking/znc/default.nix
index a98f92d2d710..42a332d6bf03 100644
--- a/nixos/modules/services/networking/znc/default.nix
+++ b/nixos/modules/services/networking/znc/default.nix
@@ -156,22 +156,18 @@ in
format ZNC expects. This is much more flexible than the legacy options
under , but also can't do
any type checking.
-
-
+
You can use nix-instantiate --eval --strict '<nixpkgs/nixos>' -A config.services.znc.config
to view the current value. By default it contains a listener for port
5000 with SSL enabled.
-
-
+
Nix attributes called extraConfig will be inserted
verbatim into the resulting config file.
-
-
+
If is turned on, the
option values in will be
gracefully be applied to this option.
-
-
+
If you intend to update the configuration through this option, be sure
to enable , otherwise none of the
changes here will be applied after the initial deploy.
@@ -184,8 +180,7 @@ in
description = ''
Configuration file for ZNC. It is recommended to use the
option instead.
-
-
+
Setting this option will override any auto-generated config file
through the or
options.
@@ -208,13 +203,11 @@ in
Indicates whether to allow the contents of the
dataDir directory to be changed by the user at
run-time.
-
-
+
If enabled, modifications to the ZNC configuration after its initial
creation are not overwritten by a NixOS rebuild. If disabled, the
ZNC configuration is rebuilt on every NixOS rebuild.
-
-
+
If the user wants to manage the ZNC service using the web admin
interface, this option should be enabled.
'';
diff --git a/nixos/modules/services/networking/znc/options.nix b/nixos/modules/services/networking/znc/options.nix
index 830df809155a..021fea9819a7 100644
--- a/nixos/modules/services/networking/znc/options.nix
+++ b/nixos/modules/services/networking/znc/options.nix
@@ -106,8 +106,7 @@ in
options.
You can use nix-instantiate --eval --strict '<nixpkgs/nixos>' -A config.services.znc.config
to view the current value of the config.
-
-
+
In any case, if you need more flexibility,
can be used to override/add to
all of the legacy options.
diff --git a/nixos/modules/services/security/privacyidea.nix b/nixos/modules/services/security/privacyidea.nix
index 599ade003c03..29c499e33ab5 100644
--- a/nixos/modules/services/security/privacyidea.nix
+++ b/nixos/modules/services/security/privacyidea.nix
@@ -78,7 +78,7 @@ in
using envsubst which is helpful for specifying
secrets:
- { = "$SECRET"; }
+ { = "$SECRET"; }
The environment-file can now specify the actual secret key:
@@ -207,7 +207,7 @@ in
description = ''
Attribute-set containing the settings for privacyidea-ldap-proxy.
It's possible to pass secrets using env-vars as substitutes and
- use the option
+ use the option
to inject them via envsubst.
'';
};
@@ -215,9 +215,9 @@ in
environmentFile = mkOption {
default = null;
type = types.nullOr types.str;
- description = ''
+ description = lib.mdDoc ''
Environment file containing secrets to be substituted into
- .
+ [](#opt-services.privacyidea.ldap-proxy.settings).
'';
};
};
diff --git a/nixos/modules/services/security/step-ca.nix b/nixos/modules/services/security/step-ca.nix
index 9b9b53f13516..1afcf659632e 100644
--- a/nixos/modules/services/security/step-ca.nix
+++ b/nixos/modules/services/security/step-ca.nix
@@ -36,8 +36,8 @@ in
type = with lib.types; attrsOf anything;
description = ''
Settings that go into ca.json. See
-
- the step-ca manual for more information. The easiest way to
+ the step-ca manual
+ for more information. The easiest way to
configure this module would be to run step ca init
to generate ca.json and then import it using
builtins.fromJSON.
diff --git a/nixos/modules/services/security/tor.nix b/nixos/modules/services/security/tor.nix
index f611fee69089..84f577c3853b 100644
--- a/nixos/modules/services/security/tor.nix
+++ b/nixos/modules/services/security/tor.nix
@@ -287,7 +287,7 @@ in
relay = {
enable = mkEnableOption ''relaying of Tor traffic for others.
- See
+ See
for details.
Setting this to true requires setting
@@ -348,7 +348,7 @@ in
See
-
+
for more info.
@@ -366,7 +366,7 @@ in
Using this option will make Tor advertise your bridge
to users through various mechanisms like
- , though.
+ , though.
@@ -384,7 +384,7 @@ in
- See
+ See
for more info.
@@ -419,7 +419,7 @@ in
- See
+ See
for more info.
@@ -476,11 +476,11 @@ in
};
clientNames = mkOption {
type = with types; nonEmptyListOf (strMatching "[A-Za-z0-9+-_]+");
- description = ''
+ description = lib.mdDoc ''
Only clients that are listed here are authorized to access the hidden service.
- Generated authorization data can be found in ${stateDir}/onion/$name/hostname.
+ Generated authorization data can be found in {file}`${stateDir}/onion/$name/hostname`.
Clients need to put this authorization data in their configuration file using
- .
+ [](#opt-services.tor.settings.HidServAuth).
'';
};
};
diff --git a/nixos/modules/services/security/vault.nix b/nixos/modules/services/security/vault.nix
index e4777910b6d3..ef9829630296 100644
--- a/nixos/modules/services/security/vault.nix
+++ b/nixos/modules/services/security/vault.nix
@@ -116,13 +116,13 @@ in
storageConfig = mkOption {
type = types.nullOr types.lines;
default = null;
- description = ''
+ description = lib.mdDoc ''
HCL configuration to insert in the storageBackend section.
Confidential values should not be specified here because this option's
value is written to the Nix store, which is publicly readable.
Provide credentials and such in a separate file using
- .
+ [](#opt-services.vault.extraSettingsPaths).
'';
};
diff --git a/nixos/modules/services/security/vaultwarden/default.nix b/nixos/modules/services/security/vaultwarden/default.nix
index 7e5389d78f4b..1433438ba009 100644
--- a/nixos/modules/services/security/vaultwarden/default.nix
+++ b/nixos/modules/services/security/vaultwarden/default.nix
@@ -116,7 +116,7 @@ in {
The available configuration options can be found in
the environment template file.
- See for how
+ See for how
to set up access to the Admin UI to invite initial users.
'';
};
diff --git a/nixos/modules/services/system/dbus.nix b/nixos/modules/services/system/dbus.nix
index c02e0905f1cc..def04d944f05 100644
--- a/nixos/modules/services/system/dbus.nix
+++ b/nixos/modules/services/system/dbus.nix
@@ -38,17 +38,17 @@ in
packages = mkOption {
type = types.listOf types.path;
default = [ ];
- description = ''
+ description = lib.mdDoc ''
Packages whose D-Bus configuration files should be included in
the configuration of the D-Bus system-wide or session-wide
message bus. Specifically, files in the following directories
will be included into their respective DBus configuration paths:
- pkg/etc/dbus-1/system.d
- pkg/share/dbus-1/system.d
- pkg/share/dbus-1/system-services
- pkg/etc/dbus-1/session.d
- pkg/share/dbus-1/session.d
- pkg/share/dbus-1/services
+ {file}`«pkg»/etc/dbus-1/system.d`
+ {file}`«pkg»/share/dbus-1/system.d`
+ {file}`«pkg»/share/dbus-1/system-services`
+ {file}`«pkg»/etc/dbus-1/session.d`
+ {file}`«pkg»/share/dbus-1/session.d`
+ {file}`«pkg»/share/dbus-1/services`
'';
};
diff --git a/nixos/modules/services/system/earlyoom.nix b/nixos/modules/services/system/earlyoom.nix
index 3e361fce00f9..b2e2d21002ce 100644
--- a/nixos/modules/services/system/earlyoom.nix
+++ b/nixos/modules/services/system/earlyoom.nix
@@ -32,32 +32,32 @@ in
freeMemKillThreshold = mkOption {
type = types.nullOr (types.ints.between 1 100);
default = null;
- description = ''
+ description = lib.mdDoc ''
Minimum available memory (in percent) before sending SIGKILL.
- If unset, this defaults to half of .
+ If unset, this defaults to half of {option}`freeMemThreshold`.
- See the description of .
+ See the description of [](#opt-services.earlyoom.freeMemThreshold).
'';
};
freeSwapThreshold = mkOption {
type = types.ints.between 1 100;
default = 10;
- description = ''
+ description = lib.mdDoc ''
Minimum free swap space (in percent) before sending SIGTERM.
- See the description of .
+ See the description of [](#opt-services.earlyoom.freeMemThreshold).
'';
};
freeSwapKillThreshold = mkOption {
type = types.nullOr (types.ints.between 1 100);
default = null;
- description = ''
+ description = lib.mdDoc ''
Minimum free swap space (in percent) before sending SIGKILL.
- If unset, this defaults to half of .
+ If unset, this defaults to half of {option}`freeSwapThreshold`.
- See the description of .
+ See the description of [](#opt-services.earlyoom.freeMemThreshold).
'';
};
diff --git a/nixos/modules/services/torrent/transmission.nix b/nixos/modules/services/torrent/transmission.nix
index 9777964386c9..6a038dc0a32c 100644
--- a/nixos/modules/services/torrent/transmission.nix
+++ b/nixos/modules/services/torrent/transmission.nix
@@ -55,13 +55,13 @@ in
type = types.path;
default = "${cfg.home}/${incompleteDir}";
defaultText = literalExpression ''"''${config.${opt.home}}/${incompleteDir}"'';
- description = ''
+ description = lib.mdDoc ''
When enabled with
services.transmission.home
- ,
+ [](#opt-services.transmission.settings.incomplete-dir-enabled),
new torrents will download the files to this directory.
When complete, the files will be moved to download-dir
- .
+ [](#opt-services.transmission.settings.download-dir).
'';
};
options.incomplete-dir-enabled = mkOption {
@@ -82,17 +82,17 @@ in
options.peer-port-random-high = mkOption {
type = types.port;
default = 65535;
- description = ''
+ description = lib.mdDoc ''
The maximum peer port to listen to for incoming connections
- when is enabled.
+ when [](#opt-services.transmission.settings.peer-port-random-on-start) is enabled.
'';
};
options.peer-port-random-low = mkOption {
type = types.port;
default = 65535;
- description = ''
+ description = lib.mdDoc ''
The minimal peer port to listen to for incoming connections
- when is enabled.
+ when [](#opt-services.transmission.settings.peer-port-random-on-start) is enabled.
'';
};
options.peer-port-random-on-start = mkOption {
@@ -117,9 +117,9 @@ in
options.script-torrent-done-enabled = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to run
-
+ [](#opt-services.transmission.settings.script-torrent-done-filename)
at torrent completion.
'';
};
@@ -156,15 +156,15 @@ in
options.watch-dir-enabled = mkOption {
type = types.bool;
default = false;
- description = ''Whether to enable the
- .
+ description = lib.mdDoc ''Whether to enable the
+ [](#opt-services.transmission.settings.watch-dir).
'';
};
options.trash-original-torrent-files = mkOption {
type = types.bool;
default = false;
- description = ''Whether to delete torrents added from the
- .
+ description = lib.mdDoc ''Whether to delete torrents added from the
+ [](#opt-services.transmission.settings.watch-dir).
'';
};
};
@@ -174,26 +174,26 @@ in
type = with types; nullOr str;
default = null;
example = "770";
- description = ''
- If not null, is used as the permissions
- set by systemd.activationScripts.transmission-daemon
- on the directories ,
- .
- and .
+ description = lib.mdDoc ''
+ If not `null`, is used as the permissions
+ set by `systemd.activationScripts.transmission-daemon`
+ on the directories [](#opt-services.transmission.settings.download-dir),
+ [](#opt-services.transmission.settings.incomplete-dir).
+ and [](#opt-services.transmission.settings.watch-dir).
Note that you may also want to change
- .
+ [](#opt-services.transmission.settings.umask).
'';
};
home = mkOption {
type = types.path;
default = "/var/lib/transmission";
- description = ''
- The directory where Transmission will create ${settingsDir}.
- as well as ${downloadsDir}/ unless
- is changed,
- and ${incompleteDir}/ unless
- is changed.
+ description = lib.mdDoc ''
+ The directory where Transmission will create `${settingsDir}`.
+ as well as `${downloadsDir}/` unless
+ [](#opt-services.transmission.settings.download-dir) is changed,
+ and `${incompleteDir}/` unless
+ [](#opt-services.transmission.settings.incomplete-dir) is changed.
'';
};
@@ -211,10 +211,10 @@ in
credentialsFile = mkOption {
type = types.path;
- description = ''
+ description = lib.mdDoc ''
Path to a JSON file to be merged with the settings.
Useful to merge a file which is better kept out of the Nix store
- to set secret config parameters like rpc-password.
+ to set secret config parameters like `rpc-password`.
'';
default = "/dev/null";
example = "/var/lib/secrets/transmission/settings.json";
@@ -237,7 +237,7 @@ in
to open many more connections at the same time.
Note that you may also want to increase
- peer-limit-global".
+ peer-limit-global".
And be aware that these settings are quite aggressive
and might not suite your regular desktop use.
For instance, SSH sessions may time out more easily'';
diff --git a/nixos/modules/services/web-apps/bookstack.nix b/nixos/modules/services/web-apps/bookstack.nix
index 64a2767fab6e..5d22a3b9a8d6 100644
--- a/nixos/modules/services/web-apps/bookstack.nix
+++ b/nixos/modules/services/web-apps/bookstack.nix
@@ -52,7 +52,7 @@ in {
description = ''
A file containing the Laravel APP_KEY - a 32 character long,
base64 encoded key used for encryption where needed. Can be
- generated with head -c 32 /dev/urandom | base64.
+ generated with head -c 32 /dev/urandom | base64.
'';
example = "/run/keys/bookstack-appkey";
type = types.path;
@@ -74,7 +74,7 @@ in {
appURL = mkOption {
description = ''
The root URL that you want to host BookStack on. All URLs in BookStack will be generated using this value.
- If you change this in the future you may need to run a command to update stored URLs in the database. Command example: php artisan bookstack:update-url https://old.example.com https://new.example.com
+ If you change this in the future you may need to run a command to update stored URLs in the database. Command example: php artisan bookstack:update-url https://old.example.com https://new.example.com
'';
default = "http${lib.optionalString tlsEnabled "s"}://${cfg.hostname}";
defaultText = ''http''${lib.optionalString tlsEnabled "s"}://''${cfg.hostname}'';
diff --git a/nixos/modules/services/web-apps/dokuwiki.nix b/nixos/modules/services/web-apps/dokuwiki.nix
index 49865b962d10..a148dec8199a 100644
--- a/nixos/modules/services/web-apps/dokuwiki.nix
+++ b/nixos/modules/services/web-apps/dokuwiki.nix
@@ -260,14 +260,14 @@ in
webserver = mkOption {
type = types.enum [ "nginx" "caddy" ];
default = "nginx";
- description = ''
+ description = lib.mdDoc ''
Whether to use nginx or caddy for virtual host management.
- Further nginx configuration can be done by adapting services.nginx.virtualHosts.<name>.
- See for further information.
+ Further nginx configuration can be done by adapting `services.nginx.virtualHosts.`.
+ See [](#opt-services.nginx.virtualHosts) for further information.
- Further apache2 configuration can be done by adapting services.httpd.virtualHosts.<name>.
- See for further information.
+ Further apache2 configuration can be done by adapting `services.httpd.virtualHosts.`.
+ See [](#opt-services.httpd.virtualHosts) for further information.
'';
};
diff --git a/nixos/modules/services/web-apps/hedgedoc.nix b/nixos/modules/services/web-apps/hedgedoc.nix
index b8d83984ca7d..6f579b365cfe 100644
--- a/nixos/modules/services/web-apps/hedgedoc.nix
+++ b/nixos/modules/services/web-apps/hedgedoc.nix
@@ -150,10 +150,9 @@ in
addDefaults = true;
}
'';
- description = ''
+ description = lib.mdDoc ''
Specify the Content Security Policy which is passed to Helmet.
- For configuration details see https://helmetjs.github.io/docs/csp/.
+ For configuration details see .
'';
};
protocolUseSSL = mkOption {
diff --git a/nixos/modules/services/web-apps/keycloak.nix b/nixos/modules/services/web-apps/keycloak.nix
index de76babbaedd..c1091bc09a06 100644
--- a/nixos/modules/services/web-apps/keycloak.nix
+++ b/nixos/modules/services/web-apps/keycloak.nix
@@ -210,14 +210,13 @@ in
name = mkOption {
type = str;
default = "keycloak";
- description = ''
+ description = lib.mdDoc ''
Database name to use when connecting to an external or
manually provisioned database; has no effect when a local
database is automatically provisioned.
- To use this with a local database, set to
- false and create the database and user
+ To use this with a local database, set [](#opt-services.keycloak.database.createLocally) to
+ `false` and create the database and user
manually.
'';
};
@@ -225,14 +224,13 @@ in
username = mkOption {
type = str;
default = "keycloak";
- description = ''
+ description = lib.mdDoc ''
Username to use when connecting to an external or manually
provisioned database; has no effect when a local database is
automatically provisioned.
- To use this with a local database, set to
- false and create the database and user
+ To use this with a local database, set [](#opt-services.keycloak.database.createLocally) to
+ `false` and create the database and user
manually.
'';
};
@@ -329,10 +327,8 @@ in
want to set this to /auth to
keep compatibility with your clients.
- See for more information on migrating from Wildfly
- to Quarkus.
+ See
+ for more information on migrating from Wildfly to Quarkus.
'';
@@ -404,9 +400,7 @@ in
- See for more information.
+ See for more information.
'';
};
};
@@ -421,22 +415,21 @@ in
}
'';
- description = ''
+ description = lib.mdDoc ''
Configuration options corresponding to parameters set in
- conf/keycloak.conf.
+ {file}`conf/keycloak.conf`.
- Most available options are documented at .
+ Most available options are documented at .
Options containing secret data should be set to an attribute
- set containing the attribute _secret - a
+ 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
- conf/keycloak.conf file, the
- https-key-store-password key will be set
+ {file}`conf/keycloak.conf` file, the
+ `https-key-store-password` key will be set
to the contents of the
- /run/keys/store_password file.
+ {file}`/run/keys/store_password` file.
'';
};
};
diff --git a/nixos/modules/services/web-apps/mastodon.nix b/nixos/modules/services/web-apps/mastodon.nix
index f3f0fb7cb534..d0594ff74192 100644
--- a/nixos/modules/services/web-apps/mastodon.nix
+++ b/nixos/modules/services/web-apps/mastodon.nix
@@ -113,17 +113,17 @@ in {
affect other virtualHosts running on your nginx instance, if any.
Alternatively you can configure a reverse-proxy of your choice to serve these paths:
- / -> $(nix-instantiate --eval '<nixpkgs>' -A mastodon.outPath)/public
+ / -> $(nix-instantiate --eval '<nixpkgs>' -A mastodon.outPath)/public
- / -> 127.0.0.1:{{ webPort }} (If there was no file in the directory above.)
+ / -> 127.0.0.1:{{ webPort }} (If there was no file in the directory above.)
- /system/ -> /var/lib/mastodon/public-system/
+ /system/ -> /var/lib/mastodon/public-system/
- /api/v1/streaming/ -> 127.0.0.1:{{ streamingPort }}
+ /api/v1/streaming/ -> 127.0.0.1:{{ streamingPort }}
Make sure that websockets are forwarded properly. You might want to set up caching
of some requests. Take a look at mastodon's provided nginx configuration at
- https://github.com/mastodon/mastodon/blob/master/dist/nginx.conf.
+ https://github.com/mastodon/mastodon/blob/master/dist/nginx.conf.
'';
type = lib.types.bool;
default = false;
@@ -135,13 +135,13 @@ in {
that user will be created, otherwise it should be set to the
name of a user created elsewhere. In both cases,
mastodon and a package containing only
- the shell script mastodon-env will be added to
+ the shell script mastodon-env will be added to
the user's package set. To run a command from
- mastodon such as tootctl
+ mastodon such as tootctl
with the environment configured by this module use
- mastodon-env, as in:
+ mastodon-env, as in:
- mastodon-env tootctl accounts create newuser --email newuser@example.com
+ mastodon-env tootctl accounts create newuser --email newuser@example.com
'';
type = lib.types.str;
default = "mastodon";
@@ -197,14 +197,14 @@ in {
};
vapidPublicKeyFile = lib.mkOption {
- description = ''
+ description = lib.mdDoc ''
Path to file containing the public key used for Web Push
Voluntary Application Server Identification. A new keypair can
be generated by running:
- nix build -f '<nixpkgs>' mastodon; cd result; bin/rake webpush:generate_keys
+ `nix build -f '' mastodon; cd result; bin/rake webpush:generate_keys`
- If does not
+ If {option}`mastodon.vapidPrivateKeyFile`does not
exist, it and this file will be created with a new keypair.
'';
default = "/var/lib/mastodon/secrets/vapid-public-key";
@@ -218,11 +218,11 @@ in {
};
secretKeyBaseFile = lib.mkOption {
- description = ''
+ description = lib.mdDoc ''
Path to file containing the secret key base.
A new secret key base can be generated by running:
- nix build -f '<nixpkgs>' mastodon; cd result; bin/rake secret
+ `nix build -f '' mastodon; cd result; bin/rake secret`
If this file does not exist, it will be created with a new secret key base.
'';
@@ -231,11 +231,11 @@ in {
};
otpSecretFile = lib.mkOption {
- description = ''
+ description = lib.mdDoc ''
Path to file containing the OTP secret.
A new OTP secret can be generated by running:
- nix build -f '<nixpkgs>' mastodon; cd result; bin/rake secret
+ `nix build -f '' mastodon; cd result; bin/rake secret`
If this file does not exist, it will be created with a new OTP secret.
'';
@@ -244,12 +244,12 @@ in {
};
vapidPrivateKeyFile = lib.mkOption {
- description = ''
+ description = lib.mdDoc ''
Path to file containing the private key used for Web Push
Voluntary Application Server Identification. A new keypair can
be generated by running:
- nix build -f '<nixpkgs>' mastodon; cd result; bin/rake webpush:generate_keys
+ `nix build -f '' mastodon; cd result; bin/rake webpush:generate_keys`
If this file does not exist, it will be created with a new
private key.
diff --git a/nixos/modules/services/web-apps/mediawiki.nix b/nixos/modules/services/web-apps/mediawiki.nix
index 977b6f60b230..71154555942e 100644
--- a/nixos/modules/services/web-apps/mediawiki.nix
+++ b/nixos/modules/services/web-apps/mediawiki.nix
@@ -280,7 +280,7 @@ in
one version of MediaWiki, or have other applications that also use the
database, you can give the table names a unique prefix to stop any naming
conflicts or confusion.
- See .
+ See .
'';
};
diff --git a/nixos/modules/services/web-apps/nextcloud.nix b/nixos/modules/services/web-apps/nextcloud.nix
index 618ad85b8605..feee7494a71a 100644
--- a/nixos/modules/services/web-apps/nextcloud.nix
+++ b/nixos/modules/services/web-apps/nextcloud.nix
@@ -93,8 +93,8 @@ in {
type = types.str;
default = config.services.nextcloud.home;
defaultText = literalExpression "config.services.nextcloud.home";
- description = ''
- Data storage path of nextcloud. Will be by default.
+ description = lib.mdDoc ''
+ Data storage path of nextcloud. Will be [](#opt-services.nextcloud.home) by default.
This folder will be populated with a config.php and data folder which contains the state of the instance (excl the database).";
'';
example = "/mnt/nextcloud-file";
@@ -102,10 +102,10 @@ in {
extraApps = mkOption {
type = types.attrsOf types.package;
default = { };
- description = ''
+ description = lib.mdDoc ''
Extra apps to install. Should be an attrSet of appid to packages generated by fetchNextcloudApp.
The appid must be identical to the "id" value in the apps appinfo/info.xml.
- Using this will disable the appstore to prevent Nextcloud from updating these apps (see ).
+ Using this will disable the appstore to prevent Nextcloud from updating these apps (see [](#opt-services.nextcloud.appstoreEnable)).
'';
example = literalExpression ''
{
@@ -127,8 +127,8 @@ in {
extraAppsEnable = mkOption {
type = types.bool;
default = true;
- description = ''
- Automatically enable the apps in every time nextcloud starts.
+ description = lib.mdDoc ''
+ Automatically enable the apps in [](#opt-services.nextcloud.extraApps) every time nextcloud starts.
If set to false, apps need to be enabled in the Nextcloud user interface or with nextcloud-occ app:enable.
'';
};
@@ -136,10 +136,10 @@ in {
type = types.nullOr types.bool;
default = null;
example = true;
- description = ''
+ description = lib.mdDoc ''
Allow the installation of apps and app updates from the store.
- Enabled by default unless there are packages in .
- Set to true to force enable the store even if is used.
+ Enabled by default unless there are packages in [](#opt-services.nextcloud.extraApps).
+ Set to true to force enable the store even if [](#opt-services.nextcloud.extraApps) is used.
Set to false to disable the installation of apps from the global appstore. App management is always enabled regardless of this setting.
'';
};
@@ -467,7 +467,7 @@ in {
This is used by the theming app and for generating previews of certain images (e.g. SVG and HEIF).
You may want to disable it for increased security. In that case, previews will still be available
for some images (e.g. JPEG and PNG).
- See .
+ See .
'' // {
default = true;
};
@@ -585,9 +585,9 @@ in {
hstsMaxAge = mkOption {
type = types.ints.positive;
default = 15552000;
- description = ''
- Value for the max-age directive of the HTTP
- Strict-Transport-Security header.
+ description = lib.mdDoc ''
+ Value for the `max-age` directive of the HTTP
+ `Strict-Transport-Security` header.
See section 6.1.1 of IETF RFC 6797 for detailed information on this
directive and header.
diff --git a/nixos/modules/services/web-apps/node-red.nix b/nixos/modules/services/web-apps/node-red.nix
index 1b9d14ecf4ff..e5b0998d3c41 100644
--- a/nixos/modules/services/web-apps/node-red.nix
+++ b/nixos/modules/services/web-apps/node-red.nix
@@ -47,10 +47,9 @@ in
type = types.path;
default = "${cfg.package}/lib/node_modules/node-red/settings.js";
defaultText = literalExpression ''"''${package}/lib/node_modules/node-red/settings.js"'';
- description = ''
+ description = lib.mdDoc ''
Path to the JavaScript configuration file.
- See
+ See
for a configuration example.
'';
};
diff --git a/nixos/modules/services/web-apps/snipe-it.nix b/nixos/modules/services/web-apps/snipe-it.nix
index 842e0715c025..3059e67cb43b 100644
--- a/nixos/modules/services/web-apps/snipe-it.nix
+++ b/nixos/modules/services/web-apps/snipe-it.nix
@@ -46,7 +46,7 @@ in {
description = ''
A file containing the Laravel APP_KEY - a 32 character long,
base64 encoded key used for encryption where needed. Can be
- generated with head -c 32 /dev/urandom | base64.
+ generated with head -c 32 /dev/urandom | base64.
'';
example = "/run/keys/snipe-it/appkey";
type = types.path;
@@ -69,7 +69,7 @@ in {
description = ''
The root URL that you want to host Snipe-IT on. All URLs in Snipe-IT will be generated using this value.
If you change this in the future you may need to run a command to update stored URLs in the database.
- Command example: snipe-it snipe-it:update-url https://old.example.com https://new.example.com
+ Command example: snipe-it snipe-it:update-url https://old.example.com https://new.example.com
'';
default = "http${lib.optionalString tlsEnabled "s"}://${cfg.hostName}";
defaultText = ''
diff --git a/nixos/modules/services/web-apps/trilium.nix b/nixos/modules/services/web-apps/trilium.nix
index 75464b21fd41..bb1061cf278e 100644
--- a/nixos/modules/services/web-apps/trilium.nix
+++ b/nixos/modules/services/web-apps/trilium.nix
@@ -53,7 +53,7 @@ in
noAuthentication = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
If set to true, no password is required to access the web frontend.
'';
};
diff --git a/nixos/modules/services/web-apps/wiki-js.nix b/nixos/modules/services/web-apps/wiki-js.nix
index 474fbb8f13c3..5dc0bb73259b 100644
--- a/nixos/modules/services/web-apps/wiki-js.nix
+++ b/nixos/modules/services/web-apps/wiki-js.nix
@@ -95,12 +95,11 @@ in {
};
description = ''
Settings to configure wiki-js. This directly
- corresponds to the upstream
- configuration options.
+ corresponds to the upstream configuration options.
Secrets can be injected via the environment by
- specifying
+ specifying
to contain secretsand setting sensitive values to $(ENVIRONMENT_VAR)
with this value defined in the environment-file.
diff --git a/nixos/modules/services/web-apps/wordpress.nix b/nixos/modules/services/web-apps/wordpress.nix
index 59471a739cbb..b1ae4deb2761 100644
--- a/nixos/modules/services/web-apps/wordpress.nix
+++ b/nixos/modules/services/web-apps/wordpress.nix
@@ -192,7 +192,7 @@ let
prefix. Typically this is changed if you are installing multiple WordPress blogs
in the same database.
- See .
+ See .
'';
};
@@ -246,7 +246,7 @@ let
description = ''
Any additional text to be appended to the wp-config.php
configuration file. This is a PHP script. For configuration
- settings, see .
+ settings, see .
'';
example = ''
define( 'AUTOSAVE_INTERVAL', 60 ); // Seconds
diff --git a/nixos/modules/services/web-servers/apache-httpd/vhost-options.nix b/nixos/modules/services/web-servers/apache-httpd/vhost-options.nix
index c52ab2c596e0..559210a1418c 100644
--- a/nixos/modules/services/web-servers/apache-httpd/vhost-options.nix
+++ b/nixos/modules/services/web-servers/apache-httpd/vhost-options.nix
@@ -233,7 +233,7 @@ in
default = false;
description = ''
Whether to enable serving ~/public_html as
- /~username.
+ /~«username».
'';
};
@@ -261,8 +261,7 @@ in
default = "";
example = "Disallow: /foo/";
description = ''
- Specification of pages to be ignored by web crawlers. See for details.
+ Specification of pages to be ignored by web crawlers. See for details.
'';
};
@@ -280,8 +279,7 @@ in
};
'';
description = ''
- Declarative location config. See for details.
+ Declarative location config. See for details.
'';
};
diff --git a/nixos/modules/services/web-servers/nginx/default.nix b/nixos/modules/services/web-servers/nginx/default.nix
index 5ccbaf77481b..166f38f9ea28 100644
--- a/nixos/modules/services/web-servers/nginx/default.nix
+++ b/nixos/modules/services/web-servers/nginx/default.nix
@@ -504,16 +504,16 @@ in
This is mutually exclusive to any other config option for
nginx.conf except for
-
+
-
+
-
+
If additional verbatim config in addition to other options is needed,
- should be used instead.
+ should be used instead.
'';
};
diff --git a/nixos/modules/services/web-servers/uwsgi.nix b/nixos/modules/services/web-servers/uwsgi.nix
index c76eb795a9ed..af6c6c066124 100644
--- a/nixos/modules/services/web-servers/uwsgi.nix
+++ b/nixos/modules/services/web-servers/uwsgi.nix
@@ -179,8 +179,7 @@ in {
When in Emperor mode, any capability to be inherited by a vassal must
be specified again in the vassal configuration using cap.
- See the uWSGI docs
+ See the uWSGI docs
for more information.
diff --git a/nixos/modules/services/x11/desktop-managers/plasma5.nix b/nixos/modules/services/x11/desktop-managers/plasma5.nix
index 0a5999923169..5c39de0dde74 100644
--- a/nixos/modules/services/x11/desktop-managers/plasma5.nix
+++ b/nixos/modules/services/x11/desktop-managers/plasma5.nix
@@ -170,10 +170,9 @@ in
supportDDC = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Support setting monitor brightness via DDC.
-
-
+
This is not needed for controlling brightness of the internal monitor
of a laptop and as it is considered experimental by upstream, it is
disabled by default.
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 00a47e7814f7..f4195c4c2dc3 100644
--- a/nixos/modules/services/x11/display-managers/lightdm-greeters/mini.nix
+++ b/nixos/modules/services/x11/display-managers/lightdm-greeters/mini.nix
@@ -55,12 +55,12 @@ in
enable = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to enable lightdm-mini-greeter as the lightdm greeter.
Note that this greeter starts only the default X session.
You can configure the default X session using
- .
+ [](#opt-services.xserver.displayManager.defaultSession).
'';
};
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 e8f799e27295..8d6bfa98a7e4 100644
--- a/nixos/modules/services/x11/display-managers/lightdm-greeters/tiny.nix
+++ b/nixos/modules/services/x11/display-managers/lightdm-greeters/tiny.nix
@@ -17,12 +17,12 @@ in
enable = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to enable lightdm-tiny-greeter as the lightdm greeter.
Note that this greeter starts only the default X session.
You can configure the default X session using
- .
+ [](#opt-services.xserver.displayManager.defaultSession).
'';
};
diff --git a/nixos/modules/services/x11/window-managers/fvwm2.nix b/nixos/modules/services/x11/window-managers/fvwm2.nix
index 909b3a475a9c..b5ef36f58d54 100644
--- a/nixos/modules/services/x11/window-managers/fvwm2.nix
+++ b/nixos/modules/services/x11/window-managers/fvwm2.nix
@@ -24,7 +24,7 @@ in
gestures = mkOption {
default = false;
type = types.bool;
- description = "Whether or not to enable libstroke for gesture support";
+ description = lib.mdDoc "Whether or not to enable libstroke for gesture support";
};
};
};
diff --git a/nixos/modules/system/activation/top-level.nix b/nixos/modules/system/activation/top-level.nix
index 84f560691fc4..87ff1d97d8fa 100644
--- a/nixos/modules/system/activation/top-level.nix
+++ b/nixos/modules/system/activation/top-level.nix
@@ -335,7 +335,7 @@ in
'';
description = ''
The name of the system used in the derivation.
-
+
That derivation has the following name:
"nixos-system-''${config.system.name}-''${config.system.nixos.label}"
'';
diff --git a/nixos/modules/system/boot/initrd-network.nix b/nixos/modules/system/boot/initrd-network.nix
index 43327fdd9da4..a1017c3e2420 100644
--- a/nixos/modules/system/boot/initrd-network.nix
+++ b/nixos/modules/system/boot/initrd-network.nix
@@ -50,18 +50,17 @@ in
boot.initrd.network.enable = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Add network connectivity support to initrd. The network may be
- configured using the ip kernel parameter,
- as described in the
- kernel documentation. Otherwise, if
- is enabled, an IP address
+ configured using the `ip` kernel parameter,
+ as described in [the kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/nfs/nfsroot.txt).
+ Otherwise, if
+ {option}`networking.useDHCP` is enabled, an IP address
is acquired using DHCP.
You should add the module(s) required for your network card to
boot.initrd.availableKernelModules.
- lspci -v | grep -iA8 'network\|ethernet'
+ `lspci -v | grep -iA8 'network\|ethernet'`
will tell you which.
'';
};
diff --git a/nixos/modules/system/boot/loader/grub/grub.nix b/nixos/modules/system/boot/loader/grub/grub.nix
index 00ec3d237d53..1ad7cd810948 100644
--- a/nixos/modules/system/boot/loader/grub/grub.nix
+++ b/nixos/modules/system/boot/loader/grub/grub.nix
@@ -624,9 +624,9 @@ in
type = types.bool;
description = ''
Whether to invoke grub-install with
- --removable.
+ --removable.
- Unless you turn this on, GRUB will install itself somewhere in
+ Unless you turn this on, GRUB will install itself somewhere in
boot.loader.efi.efiSysMountPoint (exactly where
depends on other config variables). If you've set
boot.loader.efi.canTouchEfiVariables *AND* you
@@ -637,14 +637,14 @@ in
NVRAM will not be modified, and your system will not find GRUB at
boot time. However, GRUB will still return success so you may miss
the warning that gets printed ("efibootmgr: EFI variables
- are not supported on this system.").
+ are not supported on this system.").
- If you turn this feature on, GRUB will install itself in a
+ If you turn this feature on, GRUB will install itself in a
special location within efiSysMountPoint (namely
EFI/boot/boot$arch.efi) which the firmwares
- are hardcoded to try first, regardless of NVRAM EFI variables.
+ are hardcoded to try first, regardless of NVRAM EFI variables.
- To summarize, turn this on if:
+ To summarize, turn this on if:
You are installing NixOS and want it to boot in UEFI mode,
but you are currently booted in legacy mode
diff --git a/nixos/modules/system/boot/luksroot.nix b/nixos/modules/system/boot/luksroot.nix
index a48cc5ec489b..78301a57bd97 100644
--- a/nixos/modules/system/boot/luksroot.nix
+++ b/nixos/modules/system/boot/luksroot.nix
@@ -548,11 +548,11 @@ in
boot.initrd.luks.devices = mkOption {
default = { };
example = { luksroot.device = "/dev/disk/by-uuid/430e9eff-d852-4f68-aa3b-2fa3599ebe08"; };
- description = ''
+ description = lib.mdDoc ''
The encrypted disk that should be opened before the root
filesystem is mounted. Both LVM-over-LUKS and LUKS-over-LVM
setups are supported. The unencrypted devices can be accessed as
- /dev/mapper/name.
+ {file}`/dev/mapper/«name»`.
'';
type = with types; attrsOf (submodule (
diff --git a/nixos/modules/system/boot/networkd.nix b/nixos/modules/system/boot/networkd.nix
index ba335bcd7695..dd4c63ab7256 100644
--- a/nixos/modules/system/boot/networkd.nix
+++ b/nixos/modules/system/boot/networkd.nix
@@ -1170,8 +1170,7 @@ let
systemd.netdev5 for details.
A detailed explanation about how VRFs work can be found in the
- kernel
- docs.
+ kernel docs.
'';
};
@@ -1905,13 +1904,11 @@ in
};
extraArgs = mkOption {
- description = ''
+ description = lib.mdDoc ''
Extra command-line arguments to pass to systemd-networkd-wait-online.
- These also affect per-interface systemd-network-wait-online@ services.
+ These also affect per-interface `systemd-network-wait-online@` services.
- See
- systemd-networkd-wait-online.service8
- for all available options.
+ See [{manpage}`systemd-networkd-wait-online.service(8)`](https://www.freedesktop.org/software/systemd/man/systemd-networkd-wait-online.service.html) for all available options.
'';
type = with types; listOf str;
default = [];
diff --git a/nixos/modules/system/boot/stage-1.nix b/nixos/modules/system/boot/stage-1.nix
index f3b9d798f614..ec2f3d18c685 100644
--- a/nixos/modules/system/boot/stage-1.nix
+++ b/nixos/modules/system/boot/stage-1.nix
@@ -480,7 +480,7 @@ in
if you want to resume from file. If left empty, the swap partitions are used.
Specify here the device where the file resides.
You should also use boot.kernelParams to specify
- resume_offset.
+ «resume_offset».
'';
};
diff --git a/nixos/modules/system/boot/systemd/logind.nix b/nixos/modules/system/boot/systemd/logind.nix
index cb8fc448a9ef..598016032136 100644
--- a/nixos/modules/system/boot/systemd/logind.nix
+++ b/nixos/modules/system/boot/systemd/logind.nix
@@ -26,17 +26,14 @@ in
services.logind.killUserProcesses = mkOption {
default = false;
type = types.bool;
- description = ''
+ description = lib.mdDoc ''
Specifies whether the processes of a user should be killed
when the user logs out. If true, the scope unit corresponding
to the session and all processes inside that scope will be
terminated. If false, the scope is "abandoned" (see
-
- systemd.scope(5)), and processes are not killed.
-
+ [systemd.scope(5)](https://www.freedesktop.org/software/systemd/man/systemd.scope.html#)), and processes are not killed.
-
- See logind.conf(5)
+ See [logind.conf(5)](https://www.freedesktop.org/software/systemd/man/logind.conf.html#KillUserProcesses=)
for more details.
'';
};
diff --git a/nixos/modules/system/boot/systemd/tmpfiles.nix b/nixos/modules/system/boot/systemd/tmpfiles.nix
index eaa0ddf63878..e990e953b057 100644
--- a/nixos/modules/system/boot/systemd/tmpfiles.nix
+++ b/nixos/modules/system/boot/systemd/tmpfiles.nix
@@ -25,16 +25,16 @@ in
default = [];
example = literalExpression "[ pkgs.lvm2 ]";
apply = map getLib;
- description = ''
- List of packages containing systemd-tmpfiles rules.
+ description = lib.mdDoc ''
+ List of packages containing {command}`systemd-tmpfiles` rules.
All files ending in .conf found in
- pkg/lib/tmpfiles.d
+ {file}`«pkg»/lib/tmpfiles.d`
will be included.
If this folder does not exist or does not contain any files an error will be returned instead.
- If a lib output is available, rules are searched there and only there.
- If there is no lib output it will fall back to out
+ If a {file}`lib` output is available, rules are searched there and only there.
+ If there is no {file}`lib` output it will fall back to {file}`out`
and if that does not exist either, the default output will be used.
'';
};
diff --git a/nixos/modules/tasks/auto-upgrade.nix b/nixos/modules/tasks/auto-upgrade.nix
index 46a30c53ea88..ca2690167830 100644
--- a/nixos/modules/tasks/auto-upgrade.nix
+++ b/nixos/modules/tasks/auto-upgrade.nix
@@ -25,10 +25,10 @@ in {
type = types.enum ["switch" "boot"];
default = "switch";
example = "boot";
- description = ''
+ description = lib.mdDoc ''
Whether to run
- nixos-rebuild switch --upgrade or run
- nixos-rebuild boot --upgrade
+ `nixos-rebuild switch --upgrade` or run
+ `nixos-rebuild boot --upgrade`
'';
};
diff --git a/nixos/modules/tasks/network-interfaces.nix b/nixos/modules/tasks/network-interfaces.nix
index e6cb2daaffca..a46203532948 100644
--- a/nixos/modules/tasks/network-interfaces.nix
+++ b/nixos/modules/tasks/network-interfaces.nix
@@ -1292,7 +1292,7 @@ in
description = ''
Whether to enable IPv6 Privacy Extensions for interfaces not
configured explicitly in
- .
+ .
This sets the ipv6.conf.*.use_tempaddr sysctl for all
interfaces. Possible values are:
diff --git a/nixos/modules/tasks/scsi-link-power-management.nix b/nixos/modules/tasks/scsi-link-power-management.nix
index a9d987780ee1..a5395657e992 100644
--- a/nixos/modules/tasks/scsi-link-power-management.nix
+++ b/nixos/modules/tasks/scsi-link-power-management.nix
@@ -25,10 +25,10 @@ in
powerManagement.scsiLinkPolicy = mkOption {
default = null;
type = types.nullOr (types.enum allowedValues);
- description = ''
+ description = lib.mdDoc ''
SCSI link power management policy. The kernel default is
"max_performance".
-
+
"med_power_with_dipm" is supported by kernel versions
4.15 and newer.
'';
diff --git a/nixos/modules/virtualisation/nixos-containers.nix b/nixos/modules/virtualisation/nixos-containers.nix
index e2fb28ed6332..6b8c21336c6b 100644
--- a/nixos/modules/virtualisation/nixos-containers.nix
+++ b/nixos/modules/virtualisation/nixos-containers.nix
@@ -579,11 +579,11 @@ in
privateNetwork = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to give the container its own private virtual
Ethernet interface. The interface is called
- eth0, and is hooked up to the interface
- ve-container-name
+ `eth0`, and is hooked up to the interface
+ `ve-«container-name»`
on the host. If this option is not set, then the
container shares the network interfaces of the host,
and can bind to any port on any interface.
@@ -728,12 +728,12 @@ in
};
}
'';
- description = ''
+ description = lib.mdDoc ''
A set of NixOS system configurations to be run as lightweight
containers. Each container appears as a service
- container-name
+ `container-«name»`
on the host system, allowing it to be started and stopped via
- systemctl.
+ {command}`systemctl`.
'';
};
diff --git a/nixos/modules/virtualisation/podman/default.nix b/nixos/modules/virtualisation/podman/default.nix
index 361caeff70be..1e2f8a7fae64 100644
--- a/nixos/modules/virtualisation/podman/default.nix
+++ b/nixos/modules/virtualisation/podman/default.nix
@@ -74,7 +74,7 @@ in
Podman implements the Docker API.
- Users must be in the podman group in order to connect. As
+ Users must be in the podman group in order to connect. As
with Docker, members of this group can gain root access.
'';
};
diff --git a/nixos/modules/virtualisation/podman/network-socket.nix b/nixos/modules/virtualisation/podman/network-socket.nix
index 94d8da9d2b61..5f6ce493558b 100644
--- a/nixos/modules/virtualisation/podman/network-socket.nix
+++ b/nixos/modules/virtualisation/podman/network-socket.nix
@@ -22,7 +22,7 @@ in
with TLS client certificate authentication.
This allows Docker clients to connect with the equivalents of the Docker
- CLI -H and --tls* family of options.
+ CLI -H and --tls* family of options.
For certificate setup, see https://docs.docker.com/engine/security/protect-access/
diff --git a/nixos/modules/virtualisation/qemu-vm.nix b/nixos/modules/virtualisation/qemu-vm.nix
index 5b2d81eeb68f..98617a397a59 100644
--- a/nixos/modules/virtualisation/qemu-vm.nix
+++ b/nixos/modules/virtualisation/qemu-vm.nix
@@ -516,12 +516,12 @@ in
description =
''
Virtual networks to which the VM is connected. Each
- number N in this list causes
+ number «N» in this list causes
the VM to have a virtual Ethernet interface attached to a
separate virtual network on which it will be assigned IP
address
- 192.168.N.M,
- where M is the index of this VM
+ 192.168.«N».«M»,
+ where «M» is the index of this VM
in the list of VMs.
'';
};