ForkMaster/nixos-mailserver
1
0
Fork 0
mirror of https://gitlab.com/simple-nixos-mailserver/nixos-mailserver.git synced 2024-11-14 21:08:34 +05:00
Code Issues Packages Projects Releases Wiki Activity
4ed684481b
nixos-mailserver/docs/options.rst

1166 lines
26 KiB
ReStructuredText
Raw Blame History

Mailserver Options
==================
mailserver
~~~~~~~~~~
mailserver.debug
----------------
Whether to enable verbose logging for mailserver related services. This
intended be used for development purposes only, you probably don't want
to enable this unless you're hacking on nixos-mailserver.
- Type: ``boolean``
- Default: ``False``
mailserver.domains
------------------
The domains that this mail server serves.
- Type: ``list of strings``
- Default: ``[]``
mailserver.enable
-----------------
Whether to enable nixos-mailserver.
- Type: ``boolean``
- Default: ``False``
mailserver.enableImap
---------------------
Whether to enable IMAP with STARTTLS on port 143.
- Type: ``boolean``
- Default: ``True``
mailserver.enableImapSsl
------------------------
Whether to enable IMAP with TLS in wrapper-mode on port 993.
- Type: ``boolean``
- Default: ``True``
mailserver.enableManageSieve
----------------------------
Whether to enable ManageSieve, setting this option to true will open
port 4190 in the firewall.
The ManageSieve protocol allows users to manage their Sieve scripts on
a remote server with a supported client, including Thunderbird.
- Type: ``boolean``
- Default: ``False``
mailserver.enablePop3
---------------------
Whether to enable POP3 with STARTTLS on port on port 110.
- Type: ``boolean``
- Default: ``False``
mailserver.enablePop3Ssl
------------------------
Whether to enable POP3 with TLS in wrapper-mode on port 995.
- Type: ``boolean``
- Default: ``False``
mailserver.enableSubmission
---------------------------
Whether to enable SMTP with STARTTLS on port 587.
- Type: ``boolean``
- Default: ``True``
mailserver.enableSubmissionSsl
------------------------------
Whether to enable SMTP with TLS in wrapper-mode on port 465.
- Type: ``boolean``
- Default: ``True``
mailserver.extraVirtualAliases
------------------------------
Virtual Aliases. A virtual alias `"info@example.com" = "user1@example.com"` means that
all mail to `info@example.com` is forwarded to `user1@example.com`. Note
that it is expected that `postmaster@example.com` and `abuse@example.com` is
forwarded to some valid email address. (Alternatively you can create login
accounts for `postmaster` and (or) `abuse`). Furthermore, it also allows
the user `user1@example.com` to send emails as `info@example.com`.
It's also possible to create an alias for multiple accounts. In this
example all mails for `multi@example.com` will be forwarded to both
`user1@example.com` and `user2@example.com`.
- Type: ``attribute set of Login Account or non-empty list of Login Accountss``
- Default: ``{}``
mailserver.forwards
-------------------
To forward mails to an external address. For instance,
the value {`"user@example.com" = "user@elsewhere.com";}`
means that mails to `user@example.com` are forwarded to
`user@elsewhere.com`. The difference with the
`extraVirtualAliases` option is that `user@elsewhere.com`
can't send mail as `user@example.com`. Also, this option
allows to forward mails to external addresses.
- Type: ``attribute set of list of strings or strings``
- Default: ``{}``
mailserver.fqdn
---------------
The fully qualified domain name of the mail server.
- Type: ``string``
mailserver.hierarchySeparator
-----------------------------
The hierarchy separator for mailboxes used by dovecot for the namespace 'inbox'.
Dovecot defaults to "." but recommends "/".
This affects how mailboxes appear to mail clients and sieve scripts.
For instance when using "." then in a sieve script "example.com" would refer to the mailbox "com" in the parent mailbox "example".
This does not determine the way your mails are stored on disk.
See https://wiki.dovecot.org/Namespaces for details.
- Type: ``string``
- Default: ``.``
mailserver.indexDir
-------------------
Folder to store search indices. If null, indices are stored
along with email, which could not necessarily be desirable,
especially when the fullTextSearch option is enable since
indices it creates are voluminous and do not need to be backed
up.
Be careful when changing this option value since all indices
would be recreated at the new location (and clients would need
to resynchronize).
Note the some variables can be used in the file path. See
https://doc.dovecot.org/configuration_manual/mail_location/#variables
for details.
- Type: ``null or string``
- Default: ``None``
mailserver.keyFile
------------------
Scheme 1)
Location of the key file
- Type: ``path``
mailserver.lmtpSaveToDetailMailbox
----------------------------------
If an email address is delimited by a "+", should it be filed into a
mailbox matching the string after the "+"? For example,
user1+test@example.com would be filed into the mailbox "test".
- Type: ``one of "yes", "no"``
- Default: ``yes``
mailserver.localDnsResolver
---------------------------
Runs a local DNS resolver (kresd) as recommended when running rspamd. This prevents your log file from filling up with rspamd_monitored_dns_mon entries.
- Type: ``boolean``
- Default: ``True``
mailserver.mailDirectory
------------------------
Where to store the mail.
- Type: ``path``
- Default: ``/var/vmail``
mailserver.mailboxes
--------------------
The mailboxes for dovecot.
Depending on the mail client used it might be necessary to change some mailbox's name.
- Type: ``unspecified``
- Default: ``{'Drafts': {'auto': 'subscribe', 'specialUse': 'Drafts'}, 'Junk': {'auto': 'subscribe', 'specialUse': 'Junk'}, 'Sent': {'auto': 'subscribe', 'specialUse': 'Sent'}, 'Trash': {'auto': 'no', 'specialUse': 'Trash'}}``
mailserver.maxConnectionsPerUser
--------------------------------
Maximum number of IMAP/POP3 connections allowed for a user from each IP address.
E.g. a value of 50 allows for 50 IMAP and 50 POP3 connections at the same
time for a single user.
- Type: ``signed integer``
- Default: ``100``
mailserver.messageSizeLimit
---------------------------
Message size limit enforced by Postfix.
- Type: ``signed integer``
- Default: ``20971520``
mailserver.openFirewall
-----------------------
Automatically open ports in the firewall.
- Type: ``boolean``
- Default: ``True``
mailserver.policydSPFExtraConfig
--------------------------------
Extra configuration options for policyd-spf. This can be use to among
other things skip spf checking for some IP addresses.
- Type: ``strings concatenated with "\n"``
- Default: ``""``
mailserver.rebootAfterKernelUpgrade.enable
------------------------------------------
Whether to enable automatic reboot after kernel upgrades.
This is to be used in conjunction with system.autoUpgrade.enable = true"
- Type: ``boolean``
- Default: ``False``
mailserver.rebootAfterKernelUpgrade.method
------------------------------------------
Whether to issue a full "reboot" or just a "systemctl kexec"-only reboot.
It is recommended to use the default value because the quicker kexec reboot has a number of problems.
Also if your server is running in a virtual machine the regular reboot will already be very quick.
- Type: ``one of "reboot", "systemctl kexec"``
- Default: ``reboot``
mailserver.recipientDelimiter
-----------------------------
Configure the recipient delimiter.
- Type: ``string``
- Default: ``+``
mailserver.rejectRecipients
---------------------------
Reject emails addressed to these local addresses from unauthorized senders.
Use if a spammer has found email addresses in a catchall domain but you do
not want to disable the catchall.
- Type: ``list of strings``
- Default: ``[]``
mailserver.rejectSender
-----------------------
Reject emails from these addresses from unauthorized senders.
Use if a spammer is using the same domain or the same sender over and over.
- Type: ``list of strings``
- Default: ``[]``
mailserver.rewriteMessageId
---------------------------
Rewrites the Message-ID's hostname-part of outgoing emails to the FQDN.
Please be aware that this may cause problems with some mail clients
relying on the original Message-ID.
- Type: ``boolean``
- Default: ``False``
mailserver.sendingFqdn
----------------------
The fully qualified domain name of the mail server used to
identify with remote servers.
If this server's IP serves purposes other than a mail server,
it may be desirable for the server to have a name other than
that to which the user will connect. For example, the user
might connect to mx.example.com, but the server's IP has
reverse DNS that resolves to myserver.example.com; in this
scenario, some mail servers may reject or penalize the
message.
This setting allows the server to identify as
myserver.example.com when forwarding mail, independently of
`fqdn` (which, for SSL reasons, should generally be the name
to which the user connects).
Set this to the name to which the sending IP's reverse DNS
resolves.
- Type: ``string``
- Default: ``config.mailserver.fqdn``
mailserver.sieveDirectory
-------------------------
Where to store the sieve scripts.
- Type: ``path``
- Default: ``/var/sieve``
mailserver.useFsLayout
----------------------
Sets whether dovecot should organize mail in subdirectories:
- /var/vmail/example.com/user/.folder.subfolder/ (default layout)
- /var/vmail/example.com/user/folder/subfolder/ (FS layout)
See https://wiki2.dovecot.org/MailboxFormat/Maildir for details.
- Type: ``boolean``
- Default: ``False``
mailserver.virusScanning
------------------------
Whether to activate virus scanning. Note that virus scanning is _very_
expensive memory wise.
- Type: ``boolean``
- Default: ``False``
mailserver.vmailGroupName
-------------------------
The user name and group name of the user that owns the directory where all
the mail is stored.
- Type: ``string``
- Default: ``virtualMail``
mailserver.vmailUID
-------------------
The unix UID of the virtual mail user. Be mindful that if this is
changed, you will need to manually adjust the permissions of
mailDirectory.
- Type: ``signed integer``
- Default: ``5000``
mailserver.vmailUserName
------------------------
The user name and group name of the user that owns the directory where all
the mail is stored.
- Type: ``string``
- Default: ``virtualMail``
mailserver.loginAccount
~~~~~~~~~~~~~~~~~~~~~~~
mailserver.loginAccounts
------------------------
The login account of the domain. Every account is mapped to a unix user,
e.g. `user1@example.com`. To generate the passwords use `htpasswd` as
follows
```
nix run nixpkgs.apacheHttpd -c htpasswd -nbB "" "super secret password" | cut -d: -f2
```
- Type: ``attribute set of submodules``
- Default: ``{}``
mailserver.loginAccounts.<name>.aliases
---------------------------------------
A list of aliases of this login account.
Note: Use list entries like "@example.com" to create a catchAll
that allows sending from all email addresses in these domain.
- Type: ``list of strings``
- Default: ``[]``
mailserver.loginAccounts.<name>.catchAll
----------------------------------------
For which domains should this account act as a catch all?
Note: Does not allow sending from all addresses of these domains.
- Type: ``list of impossible (empty enum)s``
- Default: ``[]``
mailserver.loginAccounts.<name>.hashedPassword
----------------------------------------------
The user's hashed password. Use `htpasswd` as follows
```
nix run nixpkgs.apacheHttpd -c htpasswd -nbB "" "super secret password" | cut -d: -f2
```
Warning: this is stored in plaintext in the Nix store!
Use `hashedPasswordFile` instead.
- Type: ``null or string``
- Default: ``None``
mailserver.loginAccounts.<name>.hashedPasswordFile
--------------------------------------------------
A file containing the user's hashed password. Use `htpasswd` as follows
```
nix run nixpkgs.apacheHttpd -c htpasswd -nbB "" "super secret password" | cut -d: -f2
```
- Type: ``null or path``
- Default: ``None``
mailserver.loginAccounts.<name>.name
------------------------------------
Username
- Type: ``string``
mailserver.loginAccounts.<name>.quota
-------------------------------------
Per user quota rules. Accepted sizes are `xx k/M/G/T` with the
obvious meaning. Leave blank for the standard quota `100G`.
- Type: ``null or string``
- Default: ``None``
mailserver.loginAccounts.<name>.sendOnly
----------------------------------------
Specifies if the account should be a send-only account.
Emails sent to send-only accounts will be rejected from
unauthorized senders with the sendOnlyRejectMessage
stating the reason.
- Type: ``boolean``
- Default: ``False``
mailserver.loginAccounts.<name>.sendOnlyRejectMessage
-----------------------------------------------------
The message that will be returned to the sender when an email is
sent to a send-only account. Only used if the account is marked
as send-only.
- Type: ``string``
- Default: ``This account cannot receive emails.``
mailserver.loginAccounts.<name>.sieveScript
-------------------------------------------
Per-user sieve script.
- Type: ``null or strings concatenated with "\n"``
- Default: ``None``
mailserver.certificate
~~~~~~~~~~~~~~~~~~~~~~
mailserver.certificateDirectory
-------------------------------
Scheme 2)
This is the folder where the certificate will be created. The name is
hardcoded to "cert-<domain>.pem" and "key-<domain>.pem" and the
certificate is valid for 10 years.
- Type: ``path``
- Default: ``/var/certs``
mailserver.certificateDomains
-----------------------------
Secondary domains and subdomains for which it is necessary to generate a certificate.
- Type: ``list of strings``
- Default: ``[]``
mailserver.certificateFile
--------------------------
Scheme 1)
Location of the certificate
- Type: ``path``
mailserver.certificateScheme
----------------------------
Certificate Files. There are three options for these.
1) You specify locations and manually copy certificates there.
2) You let the server create new (self signed) certificates on the fly.
3) You let the server create a certificate via `Let's Encrypt`. Note that
this implies that a stripped down webserver has to be started. This also
implies that the FQDN must be set as an `A` record to point to the IP of
the server. In particular port 80 on the server will be opened. For details
on how to set up the domain records, see the guide in the readme.
- Type: ``one of 1, 2, 3``
- Default: ``2``
mailserver.dkim
~~~~~~~~~~~~~~~
mailserver.dkimBodyCanonicalization
-----------------------------------
DKIM canonicalization algorithm for message bodies.
See https://datatracker.ietf.org/doc/html/rfc6376/#section-3.4 for details.
- Type: ``one of "relaxed", "simple"``
- Default: ``relaxed``
mailserver.dkimHeaderCanonicalization
-------------------------------------
DKIM canonicalization algorithm for message headers.
See https://datatracker.ietf.org/doc/html/rfc6376/#section-3.4 for details.
- Type: ``one of "relaxed", "simple"``
- Default: ``relaxed``
mailserver.dkimKeyBits
----------------------
How many bits in generated DKIM keys. RFC6376 advises minimum 1024-bit keys.
If you have already deployed a key with a different number of bits than specified
here, then you should use a different selector (dkimSelector). In order to get
this package to generate a key with the new number of bits, you will either have to
change the selector or delete the old key file.
- Type: ``signed integer``
- Default: ``1024``
mailserver.dkimKeyDirectory
---------------------------
- Type: ``path``
- Default: ``/var/dkim``
mailserver.dkimSelector
-----------------------
- Type: ``string``
- Default: ``mail``
mailserver.dkimSigning
----------------------
Whether to activate dkim signing.
- Type: ``boolean``
- Default: ``True``
mailserver.fullTextSearch
~~~~~~~~~~~~~~~~~~~~~~~~~
mailserver.fullTextSearch.autoIndex
-----------------------------------
Enable automatic indexing of messages as they are received or modified.
- Type: ``boolean``
- Default: ``True``
mailserver.fullTextSearch.autoIndexExclude
------------------------------------------
Mailboxes to exclude from automatic indexing.
- Type: ``list of strings``
- Default: ``[]``
mailserver.fullTextSearch.enable
--------------------------------
Whether to enable Full text search indexing with xapian. This has significant performance and disk space cost..
- Type: ``boolean``
- Default: ``False``
mailserver.fullTextSearch.enforced
----------------------------------
Fail searches when no index is available. If set to
<literal>body</literal>, then only body searches (as opposed to
header) are affected. If set to <literal>no<literal>, searches may
fall back to a very slow brute force search.
- Type: ``one of "yes", "no", "body"``
- Default: ``no``
mailserver.fullTextSearch.indexAttachments
------------------------------------------
Also index text-only attachements. Binary attachements are never indexed.
- Type: ``boolean``
- Default: ``False``
mailserver.fullTextSearch.maintenance.enable
--------------------------------------------
Regularly optmize indices, as recommended by upstream.
- Type: ``boolean``
- Default: ``True``
mailserver.fullTextSearch.maintenance.onCalendar
------------------------------------------------
When to run the maintenance job. See systemd.time(7) for more information about the format.
- Type: ``string``
- Default: ``daily``
mailserver.fullTextSearch.maintenance.randomizedDelaySec
--------------------------------------------------------
Run the maintenance job not exactly at the time specified with <literal>onCalendar</literal>, but plus or minus this many seconds.
- Type: ``signed integer``
- Default: ``1000``
mailserver.fullTextSearch.maxSize
---------------------------------
Size of the largest n-gram to index.
- Type: ``signed integer``
- Default: ``20``
mailserver.fullTextSearch.memoryLimit
-------------------------------------
Memory limit for the indexer process, in MiB. If null, leaves the default (which is rather low), and if 0, no limit.
- Type: ``null or signed integer``
- Default: ``None``
mailserver.fullTextSearch.minSize
---------------------------------
Size of the smallest n-gram to index.
- Type: ``signed integer``
- Default: ``2``
mailserver.redis
~~~~~~~~~~~~~~~~
mailserver.redis.address
------------------------
Address that rspamd should use to contact redis. The default value
is read from <literal>config.services.redis.bind</literal>.
- Type: ``string``
- Default: ``127.0.0.1``
mailserver.redis.password
-------------------------
Password that rspamd should use to contact redis, or null if not
required. The default value is read from
<literal>config.services.redis.requirePass<literal>.
- Type: ``null or string``
- Default: ``None``
mailserver.redis.port
---------------------
Port that rspamd should use to contact redis. The default value is
read from <literal>config.services.redis.port<literal>.
- Type: ``16 bit unsigned integer; between 0 and 65535 (both inclusive)``
- Default: ``6379``
mailserver.monitoring
~~~~~~~~~~~~~~~~~~~~~
mailserver.monitoring.alertAddress
----------------------------------
The email address to send alerts to.
- Type: ``string``
mailserver.monitoring.config
----------------------------
The configuration used for monitoring via monit.
Use a mail address that you actively check and set it via 'set alert ...'.
- Type: ``string``
- Default: ``set daemon 120 with start delay 60
set mailserver
localhost
set httpd port 2812 and use address localhost
allow localhost
allow admin:obwjoawijerfoijsiwfj29jf2f2jd
check filesystem root with path /
if space usage > 80% then alert
if inode usage > 80% then alert
check system $HOST
if cpu usage > 95% for 10 cycles then alert
if memory usage > 75% for 5 cycles then alert
if swap usage > 20% for 10 cycles then alert
if loadavg (1min) > 90 for 15 cycles then alert
if loadavg (5min) > 80 for 10 cycles then alert
if loadavg (15min) > 70 for 8 cycles then alert
check process sshd with pidfile /var/run/sshd.pid
start program "<OUTPUT-PATH>/bin/systemctl start sshd"
stop program "<OUTPUT-PATH>/bin/systemctl stop sshd"
if failed port 22 protocol ssh for 2 cycles then restart
check process postfix with pidfile /var/lib/postfix/queue/pid/master.pid
start program = "<OUTPUT-PATH>/bin/systemctl start postfix"
stop program = "<OUTPUT-PATH>/bin/systemctl stop postfix"
if failed port 25 protocol smtp for 5 cycles then restart
check process dovecot with pidfile /var/run/dovecot2/master.pid
start program = "<OUTPUT-PATH>/bin/systemctl start dovecot2"
stop program = "<OUTPUT-PATH>/bin/systemctl stop dovecot2"
if failed host mx.example.com port 993 type tcpssl sslauto protocol imap for 5 cycles then restart
check process rspamd with pidfile /var/run/rspamd.pid
start program = "<OUTPUT-PATH>/bin/systemctl start rspamd"
stop program = "<OUTPUT-PATH>/bin/systemctl stop rspamd"
``
mailserver.monitoring.enable
----------------------------
Whether to enable monitoring via monit.
- Type: ``boolean``
- Default: ``False``
mailserver.backup
~~~~~~~~~~~~~~~~~
mailserver.backup.cmdPostexec
-----------------------------
The command to be executed after each backup operation. This is wrapped in a shell script to be called by rsnapshot.
- Type: ``null or string``
- Default: ``None``
mailserver.backup.cmdPreexec
----------------------------
The command to be executed before each backup operation. This is wrapped in a shell script to be called by rsnapshot.
- Type: ``null or string``
- Default: ``None``
mailserver.backup.cronIntervals
-------------------------------
Periodicity at which intervals should be run by cron.
Note that the intervals also have to exist in configuration
as retain options.
- Type: ``attribute set of strings``
- Default: ``{'daily': '30 3 * * *', 'hourly': ' 0 * * * *', 'weekly': ' 0 5 * * 0'}``
mailserver.backup.enable
------------------------
Whether to enable backup via rsnapshot.
- Type: ``boolean``
- Default: ``False``
mailserver.backup.retain.daily
------------------------------
How many daily snapshots are retained.
- Type: ``signed integer``
- Default: ``7``
mailserver.backup.retain.hourly
-------------------------------
How many hourly snapshots are retained.
- Type: ``signed integer``
- Default: ``24``
mailserver.backup.retain.weekly
-------------------------------
How many weekly snapshots are retained.
- Type: ``signed integer``
- Default: ``54``
mailserver.backup.snapshotRoot
------------------------------
The directory where rsnapshot stores the backup.
- Type: ``path``
- Default: ``/var/rsnapshot``
mailserver.borg
~~~~~~~~~~~~~~~
mailserver.borgbackup.cmdPostexec
---------------------------------
The command to be executed after each backup operation.
This is called after borg create completed successfully and in the same script that runs
cmdPreexec, borg init and create.
- Type: ``null or string``
- Default: ``None``
mailserver.borgbackup.cmdPreexec
--------------------------------
The command to be executed before each backup operation.
This is called prior to borg init in the same script that runs borg init and create and cmdPostexec.
Example:
export BORG_RSH="ssh -i /path/to/private/key"
- Type: ``null or string``
- Default: ``None``
mailserver.borgbackup.compression.auto
--------------------------------------
Leaves it to borg to determine whether an individual file should be compressed.
- Type: ``boolean``
- Default: ``False``
mailserver.borgbackup.compression.level
---------------------------------------
Denotes the level of compression used by borg.
Most methods accept levels from 0 to 9 but zstd which accepts values from 1 to 22.
If null the decision is left up to borg.
- Type: ``null or signed integer``
- Default: ``None``
mailserver.borgbackup.compression.method
----------------------------------------
Leaving this unset allows borg to choose. The default for borg 1.1.4 is lz4.
- Type: ``null or one of "none", "lz4", "zstd", "zlib", "lzma"``
- Default: ``None``
mailserver.borgbackup.enable
----------------------------
Whether to enable backup via borgbackup.
- Type: ``boolean``
- Default: ``False``
mailserver.borgbackup.encryption.method
---------------------------------------
The backup can be encrypted by choosing any other value than 'none'.
When using encryption the password / passphrase must be provided in passphraseFile.
- Type: ``one of "none", "authenticated", "authenticated-blake2", "repokey", "keyfile", "repokey-blake2", "keyfile-blake2"``
- Default: ``none``
mailserver.borgbackup.encryption.passphraseFile
-----------------------------------------------
This option has no description.
- Type: ``null or path``
- Default: ``None``
mailserver.borgbackup.extraArgumentsForCreate
---------------------------------------------
Additional arguments to add to the borg create command line e.g. '--stats'.
- Type: ``list of strings``
- Default: ``[]``
mailserver.borgbackup.extraArgumentsForInit
-------------------------------------------
Additional arguments to add to the borg init command line.
- Type: ``list of strings``
- Default: ``['--critical']``
mailserver.borgbackup.group
---------------------------
The group borg and its launch script is run as.
- Type: ``string``
- Default: ``virtualMail``
mailserver.borgbackup.locations
-------------------------------
The locations that are to be backed up by borg.
- Type: ``list of paths``
- Default: ``['/var/vmail']``
mailserver.borgbackup.name
--------------------------
The name of the individual backups as used by borg.
Certain placeholders will be replaced by borg.
- Type: ``string``
- Default: ``{hostname}-{user}-{now}``
mailserver.borgbackup.repoLocation
----------------------------------
The location where borg saves the backups.
This can be a local path or a remote location such as user@host:/path/to/repo.
It is exported and thus available as an environment variable to cmdPreexec and cmdPostexec.
- Type: ``string``
- Default: ``/var/borgbackup``
mailserver.borgbackup.startAt
-----------------------------
When or how often the backup should run. Must be in the format described in systemd.time 7.
- Type: ``string``
- Default: ``hourly``
mailserver.borgbackup.user
--------------------------
The user borg and its launch script is run as.
- Type: ``string``
- Default: ``virtualMail``
Reference in New Issue View Git Blame Copy Permalink