diff options
Diffstat (limited to 'nixos/modules/services/mail/mailman.nix')
| -rw-r--r-- | nixos/modules/services/mail/mailman.nix | 54 |
1 files changed, 27 insertions, 27 deletions
diff --git a/nixos/modules/services/mail/mailman.nix b/nixos/modules/services/mail/mailman.nix index f08605218a535..eb24f73c1da82 100644 --- a/nixos/modules/services/mail/mailman.nix +++ b/nixos/modules/services/mail/mailman.nix @@ -90,7 +90,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Enable Mailman on this host. Requires an active MTA on the host (e.g. Postfix)."; + description = lib.mdDoc "Enable Mailman on this host. Requires an active MTA on the host (e.g. Postfix)."; }; ldap = { @@ -98,14 +98,14 @@ in { serverUri = mkOption { type = types.str; example = "ldaps://ldap.host"; - description = '' + description = lib.mdDoc '' LDAP host to connect against. ''; }; bindDn = mkOption { type = types.str; example = "cn=root,dc=nixos,dc=org"; - description = '' + description = lib.mdDoc '' Service account to bind against. ''; }; @@ -121,7 +121,7 @@ in { type = types.nullOr types.str; default = null; example = "cn=admin,ou=groups,dc=nixos,dc=org"; - description = '' + description = lib.mdDoc '' Group where a user must be a member of to gain superuser rights. ''; }; @@ -129,14 +129,14 @@ in { query = mkOption { type = types.str; example = "(&(objectClass=inetOrgPerson)(|(uid=%(user)s)(mail=%(user)s)))"; - description = '' + description = lib.mdDoc '' Query to find a user in the LDAP database. ''; }; ou = mkOption { type = types.str; example = "ou=users,dc=nixos,dc=org"; - description = '' + description = lib.mdDoc '' Organizational unit to look up a user. ''; }; @@ -150,21 +150,21 @@ in { ]; default = "posixGroup"; apply = v: "${toUpper (substring 0 1 v)}${substring 1 (stringLength v) v}Type"; - description = '' + description = lib.mdDoc '' Type of group to perform a group search against. ''; }; query = mkOption { type = types.str; example = "(objectClass=groupOfNames)"; - description = '' + description = lib.mdDoc '' Query to find a group associated to a user in the LDAP database. ''; }; ou = mkOption { type = types.str; example = "ou=groups,dc=nixos,dc=org"; - description = '' + description = lib.mdDoc '' Organizational unit to look up a group. ''; }; @@ -173,29 +173,29 @@ in { username = mkOption { default = "uid"; type = types.str; - description = '' - LDAP-attribute that corresponds to the <literal>username</literal>-attribute in mailman. + description = lib.mdDoc '' + LDAP-attribute that corresponds to the `username`-attribute in mailman. ''; }; firstName = mkOption { default = "givenName"; type = types.str; - description = '' - LDAP-attribute that corresponds to the <literal>firstName</literal>-attribute in mailman. + description = lib.mdDoc '' + LDAP-attribute that corresponds to the `firstName`-attribute in mailman. ''; }; lastName = mkOption { default = "sn"; type = types.str; - description = '' - LDAP-attribute that corresponds to the <literal>lastName</literal>-attribute in mailman. + description = lib.mdDoc '' + LDAP-attribute that corresponds to the `lastName`-attribute in mailman. ''; }; email = mkOption { default = "mail"; type = types.str; - description = '' - LDAP-attribute that corresponds to the <literal>email</literal>-attribute in mailman. + description = lib.mdDoc '' + LDAP-attribute that corresponds to the `email`-attribute in mailman. ''; }; }; @@ -205,7 +205,7 @@ in { type = types.bool; default = true; example = false; - description = '' + description = lib.mdDoc '' Enable Postfix integration. Requires an active Postfix installation. If you want to use another MTA, set this option to false and configure @@ -218,7 +218,7 @@ in { siteOwner = mkOption { type = types.str; example = "postmaster@example.org"; - description = '' + description = lib.mdDoc '' Certain messages that must be delivered to a human, but which can't be delivered to a list owner (e.g. a bounce from a list owner), will be sent to this address. It should point to a human. @@ -228,7 +228,7 @@ in { webHosts = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' The list of hostnames and/or IP addresses from which the Mailman Web UI will accept requests. By default, "localhost" and "127.0.0.1" are enabled. All additional names under which your web server accepts @@ -240,7 +240,7 @@ in { webUser = mkOption { type = types.str; default = "mailman-web"; - description = '' + description = lib.mdDoc '' User to run mailman-web as ''; }; @@ -248,7 +248,7 @@ in { webSettings = mkOption { type = types.attrs; default = {}; - description = '' + description = lib.mdDoc '' Overrides for the default mailman-web Django settings. ''; }; @@ -256,8 +256,8 @@ in { restApiPassFile = mkOption { default = null; type = types.nullOr types.str; - description = '' - Path to the file containing the value for <literal>MAILMAN_REST_API_PASS</literal>. + description = lib.mdDoc '' + Path to the file containing the value for `MAILMAN_REST_API_PASS`. ''; }; @@ -266,13 +266,13 @@ in { }; extraPythonPackages = mkOption { - description = "Packages to add to the python environment used by mailman and mailman-web"; + description = lib.mdDoc "Packages to add to the python environment used by mailman and mailman-web"; type = types.listOf types.package; default = []; }; settings = mkOption { - description = "Settings for mailman.cfg"; + description = lib.mdDoc "Settings for mailman.cfg"; type = types.attrsOf (types.attrsOf types.str); default = {}; }; @@ -283,7 +283,7 @@ in { baseUrl = mkOption { type = types.str; default = "http://localhost:18507/archives/"; - description = '' + description = lib.mdDoc '' Where can Mailman connect to Hyperkitty's internal API, preferably on localhost? ''; |