Skynet/misc_nixos-mailserver
7
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

docs: option docs improvements

Browse source 
- add missing description and defaultText fields
- add dmarcReporting option group
- render examples
This commit is contained in:
Naïm Favier 2022-11-30 12:30:29 +01:00
parent fe36e7ae0d
commit 694e7d34f6
No known key found for this signature in database
GPG key ID: 95AFCE8211908325
3 changed files with 420 additions and 276 deletions
Download patch file Download diff file Expand all files Collapse all files

6
default.nix
View file

@ -662,8 +662,11 @@ in
email = mkOption {
type = types.str;
default = with cfg.dmarcReporting; "${localpart}@${domain}";
example = "dmarc-noreply@example.com";
defaultText = literalExpression ''"''${localpart}@''${domain}"'';
readOnly = true;
description = ''
The email address used for outgoing DMARC reports. Read-only.
'';
};
organizationName = mkOption {
@ -678,6 +681,7 @@ in
fromName = mkOption {
type = types.str;
default = cfg.dmarcReporting.organizationName;
defaultText = literalExpression "organizationName";
description = ''
The sender name for DMARC reports. Defaults to the organization name.
'';