diff options
author | Alyssa Ross <hi@alyssa.is> | 2024-05-03 15:14:25 +0200 |
---|---|---|
committer | Alyssa Ross <hi@alyssa.is> | 2024-05-07 11:19:19 +0200 |
commit | d92b2b6a1bbd322dd65a8b6f51019610d350046e (patch) | |
tree | 7f7c21927b9cc05676501f297c51eb76b49e326c /nixpkgs/nixos/modules/services/mail/dovecot.nix | |
parent | 93c9e56b40530cc627d921cfc255c05b495d4017 (diff) | |
parent | 49050352f602fe87d16ff7b2b6a05b79eb20dc6f (diff) | |
download | nixlib-d92b2b6a1bbd322dd65a8b6f51019610d350046e.tar nixlib-d92b2b6a1bbd322dd65a8b6f51019610d350046e.tar.gz nixlib-d92b2b6a1bbd322dd65a8b6f51019610d350046e.tar.bz2 nixlib-d92b2b6a1bbd322dd65a8b6f51019610d350046e.tar.lz nixlib-d92b2b6a1bbd322dd65a8b6f51019610d350046e.tar.xz nixlib-d92b2b6a1bbd322dd65a8b6f51019610d350046e.tar.zst nixlib-d92b2b6a1bbd322dd65a8b6f51019610d350046e.zip |
Merge remote-tracking branch 'nixpkgs/nixos-unstable-small'
Conflicts: nixpkgs/nixos/modules/services/mail/mailman.nix nixpkgs/nixos/modules/services/mail/public-inbox.nix nixpkgs/pkgs/build-support/go/module.nix
Diffstat (limited to 'nixpkgs/nixos/modules/services/mail/dovecot.nix')
-rw-r--r-- | nixpkgs/nixos/modules/services/mail/dovecot.nix | 68 |
1 files changed, 34 insertions, 34 deletions
diff --git a/nixpkgs/nixos/modules/services/mail/dovecot.nix b/nixpkgs/nixos/modules/services/mail/dovecot.nix index 71baa2bb1852..b2a6b3ab6784 100644 --- a/nixpkgs/nixos/modules/services/mail/dovecot.nix +++ b/nixpkgs/nixos/modules/services/mail/dovecot.nix @@ -195,25 +195,25 @@ let example = "Spam"; default = name; readOnly = true; - description = lib.mdDoc "The name of the mailbox."; + description = "The name of the mailbox."; }; auto = mkOption { type = types.enum [ "no" "create" "subscribe" ]; default = "no"; example = "subscribe"; - description = lib.mdDoc "Whether to automatically create or create and subscribe to the mailbox or not."; + description = "Whether to automatically create or create and subscribe to the mailbox or not."; }; specialUse = mkOption { type = types.nullOr (types.enum [ "All" "Archive" "Drafts" "Flagged" "Junk" "Sent" "Trash" ]); default = null; example = "Junk"; - description = lib.mdDoc "Null if no special use flag is set. Other than that every use flag mentioned in the RFC is valid."; + description = "Null if no special use flag is set. Other than that every use flag mentioned in the RFC is valid."; }; autoexpunge = mkOption { type = types.nullOr types.str; default = null; example = "60d"; - description = lib.mdDoc '' + description = '' To automatically remove all email from the mailbox which is older than the specified time. ''; @@ -228,37 +228,37 @@ in ]; options.services.dovecot2 = { - enable = mkEnableOption (lib.mdDoc "the dovecot 2.x POP3/IMAP server"); + enable = mkEnableOption "the dovecot 2.x POP3/IMAP server"; - enablePop3 = mkEnableOption (lib.mdDoc "starting the POP3 listener (when Dovecot is enabled)"); + enablePop3 = mkEnableOption "starting the POP3 listener (when Dovecot is enabled)"; - enableImap = mkEnableOption (lib.mdDoc "starting the IMAP listener (when Dovecot is enabled)") // { default = true; }; + enableImap = mkEnableOption "starting the IMAP listener (when Dovecot is enabled)" // { default = true; }; - enableLmtp = mkEnableOption (lib.mdDoc "starting the LMTP listener (when Dovecot is enabled)"); + enableLmtp = mkEnableOption "starting the LMTP listener (when Dovecot is enabled)"; protocols = mkOption { type = types.listOf types.str; default = []; - description = lib.mdDoc "Additional listeners to start when Dovecot is enabled."; + description = "Additional listeners to start when Dovecot is enabled."; }; user = mkOption { type = types.str; default = "dovecot2"; - description = lib.mdDoc "Dovecot user name."; + description = "Dovecot user name."; }; group = mkOption { type = types.str; default = "dovecot2"; - description = lib.mdDoc "Dovecot group name."; + description = "Dovecot group name."; }; extraConfig = mkOption { type = types.lines; default = ""; example = "mail_debug = yes"; - description = lib.mdDoc "Additional entries to put verbatim into Dovecot's config file."; + description = "Additional entries to put verbatim into Dovecot's config file."; }; mailPlugins = @@ -268,7 +268,7 @@ in enable = mkOption { type = types.listOf types.str; default = []; - description = lib.mdDoc "mail plugins to enable as a list of strings to append to the ${hint} `$mail_plugins` configuration variable"; + description = "mail plugins to enable as a list of strings to append to the ${hint} `$mail_plugins` configuration variable"; }; }; }; @@ -277,20 +277,20 @@ in type = with types; submodule { options = { globally = mkOption { - description = lib.mdDoc "Additional entries to add to the mail_plugins variable for all protocols"; + description = "Additional entries to add to the mail_plugins variable for all protocols"; type = plugins "top-level"; example = { enable = [ "virtual" ]; }; default = { enable = []; }; }; perProtocol = mkOption { - description = lib.mdDoc "Additional entries to add to the mail_plugins variable, per protocol"; + description = "Additional entries to add to the mail_plugins variable, per protocol"; type = attrsOf (plugins "corresponding per-protocol"); default = {}; example = { imap = [ "imap_acl" ]; }; }; }; }; - description = lib.mdDoc "Additional entries to add to the mail_plugins variable, globally and per protocol"; + description = "Additional entries to add to the mail_plugins variable, globally and per protocol"; example = { globally.enable = [ "acl" ]; perProtocol.imap.enable = [ "imap_acl" ]; @@ -301,7 +301,7 @@ in configFile = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc "Config file used for the whole dovecot configuration."; + description = "Config file used for the whole dovecot configuration."; apply = v: if v != null then v else pkgs.writeText "dovecot.conf" dovecotConf; }; @@ -309,7 +309,7 @@ in type = types.str; default = "maildir:/var/spool/mail/%u"; /* Same as inbox, as postfix */ example = "maildir:~/mail:INBOX=/var/spool/mail/%u"; - description = lib.mdDoc '' + description = '' Location that dovecot will use for mail folders. Dovecot mail_location option. ''; }; @@ -317,24 +317,24 @@ in mailUser = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc "Default user to store mail for virtual users."; + description = "Default user to store mail for virtual users."; }; mailGroup = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc "Default group to store mail for virtual users."; + description = "Default group to store mail for virtual users."; }; - createMailUser = mkEnableOption (lib.mdDoc ''automatically creating the user + createMailUser = mkEnableOption ''automatically creating the user given in {option}`services.dovecot.user` and the group - given in {option}`services.dovecot.group`.'') // { default = true; }; + given in {option}`services.dovecot.group`.'' // { default = true; }; modules = mkOption { type = types.listOf types.package; default = []; example = literalExpression "[ pkgs.dovecot_pigeonhole ]"; - description = lib.mdDoc '' + description = '' Symlinks the contents of lib/dovecot of every given package into /etc/dovecot/modules. This will make the given modules available if a dovecot package with the module_dir patch applied is being used. @@ -344,26 +344,26 @@ in sslCACert = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc "Path to the server's CA certificate key."; + description = "Path to the server's CA certificate key."; }; sslServerCert = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc "Path to the server's public key."; + description = "Path to the server's public key."; }; sslServerKey = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc "Path to the server's private key."; + description = "Path to the server's private key."; }; - enablePAM = mkEnableOption (lib.mdDoc "creating a own Dovecot PAM service and configure PAM user logins") // { default = true; }; + enablePAM = mkEnableOption "creating a own Dovecot PAM service and configure PAM user logins" // { default = true; }; - enableDHE = mkEnableOption (lib.mdDoc "ssl_dh and generation of primes for the key exchange") // { default = true; }; + enableDHE = mkEnableOption "ssl_dh and generation of primes for the key exchange" // { default = true; }; - showPAMFailure = mkEnableOption (lib.mdDoc "showing the PAM failure message on authentication error (useful for OTPW)"); + showPAMFailure = mkEnableOption "showing the PAM failure message on authentication error (useful for OTPW)"; mailboxes = mkOption { type = with types; coercedTo @@ -376,15 +376,15 @@ in Spam = { specialUse = "Junk"; auto = "create"; }; } ''; - description = lib.mdDoc "Configure mailboxes and auto create or subscribe them."; + description = "Configure mailboxes and auto create or subscribe them."; }; - enableQuota = mkEnableOption (lib.mdDoc "the dovecot quota service"); + enableQuota = mkEnableOption "the dovecot quota service"; quotaPort = mkOption { type = types.str; default = "12340"; - description = lib.mdDoc '' + description = '' The Port the dovecot quota service binds to. If using postfix, add check_policy_service inet:localhost:12340 to your smtpd_recipient_restrictions in your postfix config. ''; @@ -393,7 +393,7 @@ in type = types.str; default = "100G"; example = "10G"; - description = lib.mdDoc "Quota limit for the user in bytes. Supports suffixes b, k, M, G, T and %."; + description = "Quota limit for the user in bytes. Supports suffixes b, k, M, G, T and %."; }; @@ -505,7 +505,7 @@ in scripts = mkOption { type = types.attrsOf types.path; default = {}; - description = lib.mdDoc "Sieve scripts to be executed. Key is a sequence, e.g. 'before2', 'after' etc."; + description = "Sieve scripts to be executed. Key is a sequence, e.g. 'before2', 'after' etc."; }; pipeBins = mkOption { |