christian
/
nixos-mailserver
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

make option documentation compatible with nixos-search

This commit is contained in:
Naïm Favier 2021-12-26 19:15:06 +01:00
parent 11ad4742aa
commit ef03562eba
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
default.nix
View File

@ -243,7 +243,7 @@ in
description = '' description = ''
Fail searches when no index is available. If set to Fail searches when no index is available. If set to
<literal>body</literal>, then only body searches (as opposed to <literal>body</literal>, then only body searches (as opposed to
header) are affected. If set to <literal>no<literal>, searches may header) are affected. If set to <literal>no</literal>, searches may
fall back to a very slow brute force search. fall back to a very slow brute force search.
''; '';
}; };
@ -488,7 +488,7 @@ in
description = '' description = ''
Scheme 2) Scheme 2)
This is the folder where the certificate will be created. The name is This is the folder where the certificate will be created. The name is
hardcoded to "cert-<domain>.pem" and "key-<domain>.pem" and the hardcoded to "cert-DOMAIN.pem" and "key-DOMAIN.pem" and the
certificate is valid for 10 years. certificate is valid for 10 years.
''; '';
}; };
@ -677,28 +677,27 @@ in
if (ip == "0.0.0.0" || ip == "::") if (ip == "0.0.0.0" || ip == "::")
then "127.0.0.1" then "127.0.0.1"
else if isIpv6 ip then "[${ip}]" else ip; else if isIpv6 ip then "[${ip}]" else ip;
defaultText = lib.literalDocBook "computed from <option>config.services.redis.bind</option>";
description = '' description = ''
Address that rspamd should use to contact redis. The default value Address that rspamd should use to contact redis.
is read from <literal>config.services.redis.bind</literal>.
''; '';
}; };
port = mkOption { port = mkOption {
type = types.port; type = types.port;
default = config.services.redis.port; default = config.services.redis.port;
defaultText = lib.literalExpression "config.services.redis.port";
description = '' description = ''
Port that rspamd should use to contact redis. The default value is Port that rspamd should use to contact redis.
read from <literal>config.services.redis.port<literal>.
''; '';
}; };
password = mkOption { password = mkOption {
type = types.nullOr types.str; type = types.nullOr types.str;
default = config.services.redis.requirePass; default = config.services.redis.requirePass;
defaultText = lib.literalExpression "config.services.redis.requirePass";
description = '' description = ''
Password that rspamd should use to contact redis, or null if not Password that rspamd should use to contact redis, or null if not required.
required. The default value is read from
<literal>config.services.redis.requirePass<literal>.
''; '';
}; };
}; };
@ -804,6 +803,7 @@ in
start program = "${pkgs.systemd}/bin/systemctl start rspamd" start program = "${pkgs.systemd}/bin/systemctl start rspamd"
stop program = "${pkgs.systemd}/bin/systemctl stop rspamd" stop program = "${pkgs.systemd}/bin/systemctl stop rspamd"
''; '';
defaultText = lib.literalDocBook "see source";
description = '' description = ''
The configuration used for monitoring via monit. The configuration used for monitoring via monit.
Use a mail address that you actively check and set it via 'set alert ...'. Use a mail address that you actively check and set it via 'set alert ...'.
@ -887,6 +887,7 @@ in
passphraseFile = mkOption { passphraseFile = mkOption {
type = types.nullOr types.path; type = types.nullOr types.path;
default = null; default = null;
description = "Path to a file containing the encryption password or passphrase.";
}; };
}; };