mirror of
https://github.com/NixOS/nixpkgs.git
synced 2025-07-13 21:50:33 +03:00
nixos/*: automatically convert option docs to MD
once again using nix-doc-munge (69d080323a)
This commit is contained in:
pennae
parent
645cfa59ac
commit
61e93df189
101 changed files with 628 additions and 628 deletions
|
|
@ -66,16 +66,16 @@ in {
|
|||
|
||||
storageDriverPasswordFile = mkOption {
|
||||
type = types.str;
|
||||
description = ''
|
||||
description = lib.mdDoc ''
|
||||
File that contains the cadvisor storage driver password.
|
||||
|
||||
<option>storageDriverPasswordFile</option> takes precedence over <option>storageDriverPassword</option>
|
||||
{option}`storageDriverPasswordFile` takes precedence over {option}`storageDriverPassword`
|
||||
|
||||
Warning: when <option>storageDriverPassword</option> is non-empty this defaults to a file in the
|
||||
world-readable Nix store that contains the value of <option>storageDriverPassword</option>.
|
||||
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 <link xlink:href="https://nixos.org/nixops/manual/#idm140737318306400">nixops key management</link>
|
||||
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 <link xlink:href="https://github.com/google/cadvisor/blob/master/docs/runtime_options.md"/> for available options.
|
||||
See <https://github.com/google/cadvisor/blob/master/docs/runtime_options.md> for available options.
|
||||
'';
|
||||
};
|
||||
};
|
||||
|
|
|
|||
|
|
@ -251,9 +251,9 @@ in {
|
|||
|
||||
extraConfig = mkOption {
|
||||
default = {};
|
||||
description = ''
|
||||
description = lib.mdDoc ''
|
||||
Extra seyren configuration. See
|
||||
<link xlink:href="https://github.com/scobal/seyren#config"/>
|
||||
<https://github.com/scobal/seyren#config>
|
||||
'';
|
||||
type = types.attrsOf types.str;
|
||||
example = literalExpression ''
|
||||
|
|
|
|||
|
|
@ -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 <literal>services.metricbeat.settings.metricbeat.modules</literal>,
|
||||
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 <literal><name></literal>
|
||||
for each, but setting <xref linkend="opt-services.metricbeat.modules._name_.module"/> to the same value.
|
||||
A module can be specified multiple times by choosing a different `<name>`
|
||||
for each, but setting [](#opt-services.metricbeat.modules._name_.module) to the same value.
|
||||
|
||||
See <link xlink:href="https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-modules.html"/>.
|
||||
See <https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-modules.html>.
|
||||
'';
|
||||
default = {};
|
||||
type = types.attrsOf (types.submodule ({ name, ... }: {
|
||||
|
|
|
|||
|
|
@ -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 <link xlink:href="http://guide.munin-monitoring.org/en/latest/architecture/index.html"/>.
|
||||
See <http://guide.munin-monitoring.org/en/latest/architecture/index.html>.
|
||||
'';
|
||||
};
|
||||
|
||||
extraConfig = mkOption {
|
||||
default = "";
|
||||
type = types.lines;
|
||||
description = ''
|
||||
<filename>munin-node.conf</filename> extra configuration. See
|
||||
<link xlink:href="http://guide.munin-monitoring.org/en/latest/reference/munin-node.conf.html"/>
|
||||
description = lib.mdDoc ''
|
||||
{file}`munin-node.conf` extra configuration. See
|
||||
<http://guide.munin-monitoring.org/en/latest/reference/munin-node.conf.html>
|
||||
'';
|
||||
};
|
||||
|
||||
extraPluginConfig = mkOption {
|
||||
default = "";
|
||||
type = types.lines;
|
||||
description = ''
|
||||
<filename>plugin-conf.d</filename> extra plugin configuration. See
|
||||
<link xlink:href="http://guide.munin-monitoring.org/en/latest/plugin/use.html"/>
|
||||
description = lib.mdDoc ''
|
||||
{file}`plugin-conf.d` extra plugin configuration. See
|
||||
<http://guide.munin-monitoring.org/en/latest/plugin/use.html>
|
||||
'';
|
||||
example = ''
|
||||
[fail2ban_*]
|
||||
|
|
@ -266,11 +266,11 @@ in
|
|||
extraGlobalConfig = mkOption {
|
||||
default = "";
|
||||
type = types.lines;
|
||||
description = ''
|
||||
<filename>munin.conf</filename> extra global configuration.
|
||||
See <link xlink:href="http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html"/>.
|
||||
description = lib.mdDoc ''
|
||||
{file}`munin.conf` extra global configuration.
|
||||
See <http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html>.
|
||||
Useful to setup notifications, see
|
||||
<link xlink:href="http://guide.munin-monitoring.org/en/latest/tutorial/alert.html"/>
|
||||
<http://guide.munin-monitoring.org/en/latest/tutorial/alert.html>
|
||||
'';
|
||||
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
|
||||
<link xlink:href="http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html"/>
|
||||
<http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html>
|
||||
'';
|
||||
example = literalExpression ''
|
||||
'''
|
||||
|
|
|
|||
|
|
@ -114,13 +114,13 @@ 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:
|
||||
<link xlink:href="https://docs.netdata.cloud/collectors/plugins.d/"/>
|
||||
<https://docs.netdata.cloud/collectors/plugins.d/>
|
||||
|
||||
Cannot be combined with configText.
|
||||
'';
|
||||
|
|
|
|||
|
|
@ -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
|
||||
<xref linkend="opt-services.parsedmarc.provision.localMail.recipientName" />
|
||||
[](#opt-services.parsedmarc.provision.localMail.recipientName)
|
||||
'';
|
||||
};
|
||||
|
||||
|
|
@ -68,13 +68,13 @@ in
|
|||
geoIp = lib.mkOption {
|
||||
type = lib.types.bool;
|
||||
default = true;
|
||||
description = ''
|
||||
Whether to enable and configure the <link linkend="opt-services.geoipupdate.enable">geoipupdate</link>
|
||||
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 <xref linkend="opt-services.geoipupdate.settings.AccountID"/> and
|
||||
<xref linkend="opt-services.geoipupdate.settings.LicenseKey"/>
|
||||
To finish the setup, you need to manually set the [](#opt-services.geoipupdate.settings.AccountID) and
|
||||
[](#opt-services.geoipupdate.settings.LicenseKey)
|
||||
options.
|
||||
'';
|
||||
};
|
||||
|
|
@ -95,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
|
||||
<xref linkend="opt-services.parsedmarc.provision.elasticsearch"/>
|
||||
[](#opt-services.parsedmarc.provision.elasticsearch)
|
||||
is also enabled.
|
||||
'';
|
||||
};
|
||||
|
|
@ -206,12 +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 <literal>{ _secret = ...; }</literal>
|
||||
attrset or not (refer to <xref linkend="opt-services.parsedmarc.settings"/> 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; };
|
||||
|
|
@ -270,12 +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 <literal>{ _secret = ...; }</literal>
|
||||
attrset or not (refer to <xref linkend="opt-services.parsedmarc.settings"/> 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; };
|
||||
|
|
@ -322,13 +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 <literal>{ _secret = ...; }</literal>
|
||||
attrset or not (refer to <xref linkend="opt-services.parsedmarc.settings"/> 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; };
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue