Mailu/docs/compose/.env

# WARNING: this file is being deprecated over the new setup utility, found at https://setup.mailu.io

# Mailu main configuration file
## Most configuration variables can be modified through the Web interface,
# these few settings must however be configured before starting the mail
# server and require a restart upon change.

###################################
# Common configuration variables
###################################

# Set this to the path where Mailu data and configuration is stored
ROOT=/mailu

# Mailu version to run (1.0, 1.1, etc. or master)
VERSION=master

# Set to a randomly generated 16 bytes string
SECRET_KEY=ChangeMeChangeMe

# Address where listening ports should bind
BIND_ADDRESS4=127.0.0.1
BIND_ADDRESS6=::1

# Subnet of the docker network. This should not conflict with any networks to which your system is connected. (Internal and external!)
SUBNET=192.168.203.0/24

# Main mail domain
DOMAIN=mailu.io

# Hostnames for this server, separated with comas
HOSTNAMES=mail.mailu.io,alternative.mailu.io,yetanother.mailu.io

# Postmaster local part (will append the main mail domain)
POSTMASTER=admin

# Choose how secure connections will behave (value: letsencrypt, cert, notls, mail, mail-letsencrypt)
TLS_FLAVOR=cert

# Authentication rate limit (per source IP address)
AUTH_RATELIMIT=10/minute

# Opt-out of statistics, replace with "True" to opt out
DISABLE_STATISTICS=False

###################################
# Optional features
###################################

# Expose the admin interface (value: true, false)
ADMIN=false

# Choose which webmail to run if any (values: roundcube, rainloop, none)
WEBMAIL=none

# Dav server implementation (value: radicale, none)
WEBDAV=none

# Antivirus solution (value: clamav, none)
ANTIVIRUS=none

###################################
# Mail settings
###################################

# Message size limit in bytes
# Default: accept messages up to 50MB
# Max attachment size will be 33% smaller
MESSAGE_SIZE_LIMIT=50000000

# Message rate limit for outgoing messages
# This limit is per user
MESSAGE_RATELIMIT=100/day

# Networks granted relay permissions
# Use this with care, all hosts in this networks will be able to send mail without authentication!
RELAYNETS=

# Will relay all outgoing mails if configured
RELAYHOST=

# Fetchmail delay
FETCHMAIL_DELAY=600

# Recipient delimiter, character used to delimiter localpart from custom address part
# e.g. localpart+custom@domain;tld
RECIPIENT_DELIMITER=+

# DMARC rua and ruf email
DMARC_RUA=admin
DMARC_RUF=admin

# Welcome email, enable and set a topic and body if you wish to send welcome
# emails to all users.
WELCOME=false
WELCOME_SUBJECT=Welcome to your new email account
WELCOME_BODY=Welcome to your new email account, if you can read this, then it is configured properly!

# Maildir Compression
# choose compression-method, default: none (value: gz, bz2, lz4, zstd)
COMPRESSION=
# change compression-level, default: 6 (value: 1-9)
COMPRESSION_LEVEL=

# IMAP full-text search is enabled by default. Set the following variable to off in order to disable the feature.
# FULL_TEXT_SEARCH=off

###################################
# Web settings
###################################

# Path to redirect / to
WEBROOT_REDIRECT=/webmail

# Path to the admin interface if enabled
WEB_ADMIN=/admin

# Path to the webmail if enabled
WEB_WEBMAIL=/webmail

# Website name
SITENAME=Mailu

# Linked Website URL
WEBSITE=https://mailu.io

# Registration reCaptcha settings (warning, this has some privacy impact)
# RECAPTCHA_PUBLIC_KEY=
# RECAPTCHA_PRIVATE_KEY=

# Domain registration, uncomment to enable
# DOMAIN_REGISTRATION=true

###################################
# Advanced settings
###################################

# Log driver for front service. Possible values:
# json-file (default)
# journald (On systemd platforms, useful for Fail2Ban integration)
# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker-compose log` for front!)
LOG_DRIVER=json-file

# Docker-compose project name, this will prepended to containers names.
COMPOSE_PROJECT_NAME=mailu

# Number of rounds used by the password hashing scheme
CREDENTIAL_ROUNDS=12

# Header to take the real ip from
REAL_IP_HEADER=

# IPs for nginx set_real_ip_from (CIDR list separated by commas)
REAL_IP_FROM=

# choose wether mailu bounces (no) or rejects (yes) mail when recipient is unknown (value: yes, no)
REJECT_UNLISTED_RECIPIENT=

# Log level threshold in start.py (value: CRITICAL, ERROR, WARNING, INFO, DEBUG, NOTSET)
LOG_LEVEL=WARNING
Make docs refer to the setup utility 2019-01-16 21:01:09 +02:00			`# WARNING: this file is being deprecated over the new setup utility, found at https://setup.mailu.io`

Rename .env to .env.dist and fix freeposte refs Ensure people can have their own config and adopt the new name in the default settings. 2016-10-28 00:41:27 +02:00			`# Mailu main configuration file`
Move the Mailu Docker network to a fixed subnet. This will make network configuration and host based authentication more robust, across different deployment platforms. The options `RELAYNETS` and`POD_ADDRESS_RANGE` are kept for compatibility. However, their usage have become optional. 2018-12-03 03:16:53 +02:00			`## Most configuration variables can be modified through the Web interface,`
Switch to env_file and deploy amavis 2016-03-02 22:25:56 +02:00			`# these few settings must however be configured before starting the mail`
			`# server and require a restart upon change.`

Split the environment file into sections 2016-08-21 15:53:00 +02:00			`###################################`
			`# Common configuration variables`
			`###################################`
Move the configuration file to .env to support global variables 2016-08-20 16:32:10 +02:00
Rename .env to .env.dist and fix freeposte refs Ensure people can have their own config and adopt the new name in the default settings. 2016-10-28 00:41:27 +02:00			`# Set this to the path where Mailu data and configuration is stored`
			`ROOT=/mailu`
Move the configuration file to .env to support global variables 2016-08-20 16:32:10 +02:00
Update the version in .env 2017-11-07 17:07:58 +02:00			`# Mailu version to run (1.0, 1.1, etc. or master)`
			`VERSION=master`
Add a VERSION variable to avoid modifying the docker-compose file 2016-08-20 16:52:44 +02:00
Switch to env_file and deploy amavis 2016-03-02 22:25:56 +02:00			`# Set to a randomly generated 16 bytes string`
Disable debug and set an explicit default secret key 2016-08-20 14:35:42 +02:00			`SECRET_KEY=ChangeMeChangeMe`
Switch to env_file and deploy amavis 2016-03-02 22:25:56 +02:00
Default listen on localhost only 2016-08-20 17:01:12 +02:00			`# Address where listening ports should bind`
Make it possible to serve Mailu over ipv6 2017-10-22 16:13:13 +02:00			`BIND_ADDRESS4=127.0.0.1`
			`BIND_ADDRESS6=::1`
Default listen on localhost only 2016-08-20 17:01:12 +02:00
Move the Mailu Docker network to a fixed subnet. This will make network configuration and host based authentication more robust, across different deployment platforms. The options `RELAYNETS` and`POD_ADDRESS_RANGE` are kept for compatibility. However, their usage have become optional. 2018-12-03 03:16:53 +02:00			`# Subnet of the docker network. This should not conflict with any networks to which your system is connected. (Internal and external!)`
			`SUBNET=192.168.203.0/24`

Switch to env_file and deploy amavis 2016-03-02 22:25:56 +02:00			`# Main mail domain`
Rename .env to .env.dist and fix freeposte refs Ensure people can have their own config and adopt the new name in the default settings. 2016-10-28 00:41:27 +02:00			`DOMAIN=mailu.io`
Switch to env_file and deploy amavis 2016-03-02 22:25:56 +02:00
Support specifyin multiple hostnames 2017-09-24 17:49:39 +02:00			`# Hostnames for this server, separated with comas`
Switch to rule-based hosts for certificate generation 2017-09-17 12:09:08 +02:00			`HOSTNAMES=mail.mailu.io,alternative.mailu.io,yetanother.mailu.io`
Switch to env_file and deploy amavis 2016-03-02 22:25:56 +02:00
			`# Postmaster local part (will append the main mail domain)`
			`POSTMASTER=admin`

Adding options for mail-letsencrypt 2017-12-05 01:21:58 +02:00			`# Choose how secure connections will behave (value: letsencrypt, cert, notls, mail, mail-letsencrypt)`
Fix remaining migration scripts and remove initdb/flushdb from manage.py 2017-09-17 11:55:12 +02:00			`TLS_FLAVOR=cert`
Configurable default password scheme used for passwords 2017-09-02 17:36:22 +02:00
Implement authentication rate limit, fixes #116 2017-10-29 19:42:35 +02:00			`# Authentication rate limit (per source IP address)`
Refactor the rate limiting code Rate limiting was already redesigned to use Python limits. This introduced some unexpected behavior, including the fact that only one criteria is supported per limiter. Docs and setup utility are updated with this in mind. Also, the code was made more generic, so limiters can be delivered for something else than authentication. Authentication-specific code was moved directly to the authentication routine. 2020-02-09 18:38:18 +02:00			`AUTH_RATELIMIT=10/minute`
Implement authentication rate limit, fixes #116 2017-10-29 19:42:35 +02:00
Make it possible to opt out of statistics 2017-11-05 19:30:53 +02:00			`# Opt-out of statistics, replace with "True" to opt out`
			`DISABLE_STATISTICS=False`

Split the environment file into sections 2016-08-21 15:53:00 +02:00			`###################################`
			`# Optional features`
			`###################################`

Prepare the docker compose configuration for nginx as a uninque frontend 2017-09-24 14:01:26 +02:00			`# Expose the admin interface (value: true, false)`
			`ADMIN=false`
Disable the frontend Web server by default 2016-08-21 14:17:00 +02:00
Add a rainloop Webmail image, fixes #58 2016-09-03 14:10:42 +02:00			`# Choose which webmail to run if any (values: roundcube, rainloop, none)`
Add a dynamic Webmail option with a 'none' container 2016-08-20 16:48:29 +02:00			`WEBMAIL=none`

Add a dav server, related to #68 2016-11-30 15:02:36 +02:00			`# Dav server implementation (value: radicale, none)`
			`WEBDAV=none`

Fix remaining migration scripts and remove initdb/flushdb from manage.py 2017-09-17 11:55:12 +02:00			`# Antivirus solution (value: clamav, none)`
			`ANTIVIRUS=none`
Added parameter checking in rmilter image, added parameter in docker-compose, added parameter in .env 2017-06-25 18:15:47 +02:00
Split the environment file into sections 2016-08-21 15:53:00 +02:00			`###################################`
			`# Mail settings`
			`###################################`

Default message_size_limit to 50MB Add MESSAGE_SIZE_LIMIT variable in .env to allow setting the message size limit for postfix. 2016-09-25 01:46:10 +02:00			`# Message size limit in bytes`
			`# Default: accept messages up to 50MB`
Dynamic attachment size 2018-12-07 13:37:40 +02:00			`# Max attachment size will be 33% smaller`
Remove unnecessary spaces in env file 2016-10-02 09:48:52 +02:00			`MESSAGE_SIZE_LIMIT=50000000`
Default message_size_limit to 50MB Add MESSAGE_SIZE_LIMIT variable in .env to allow setting the message size limit for postfix. 2016-09-25 01:46:10 +02:00
Refactor the rate limiting code Rate limiting was already redesigned to use Python limits. This introduced some unexpected behavior, including the fact that only one criteria is supported per limiter. Docs and setup utility are updated with this in mind. Also, the code was made more generic, so limiters can be delivered for something else than authentication. Authentication-specific code was moved directly to the authentication routine. 2020-02-09 18:38:18 +02:00			`# Message rate limit for outgoing messages`
			`# This limit is per user`
			`MESSAGE_RATELIMIT=100/day`

Move the Mailu Docker network to a fixed subnet. This will make network configuration and host based authentication more robust, across different deployment platforms. The options `RELAYNETS` and`POD_ADDRESS_RANGE` are kept for compatibility. However, their usage have become optional. 2018-12-03 03:16:53 +02:00			`# Networks granted relay permissions`
			`# Use this with care, all hosts in this networks will be able to send mail without authentication!`
			`RELAYNETS=`
Define the fetchmail delay in the global configuration 2016-05-29 15:57:21 +02:00
Add a RELAYHOST configuration value, fixes #27 2016-08-18 16:08:36 +02:00			`# Will relay all outgoing mails if configured`
			`RELAYHOST=`

Define the fetchmail delay in the global configuration 2016-05-29 15:57:21 +02:00			`# Fetchmail delay`
Add a RELAYHOST configuration value, fixes #27 2016-08-18 16:08:36 +02:00			`FETCHMAIL_DELAY=600`
Split the environment file into sections 2016-08-21 15:53:00 +02:00
Make the recipient delimiter customizeable, fixes #233 and #164 2017-09-10 14:09:16 +02:00			`# Recipient delimiter, character used to delimiter localpart from custom address part`
			`# e.g. localpart+custom@domain;tld`
			`RECIPIENT_DELIMITER=+`

Move settings to the email section 2017-09-10 19:28:59 +02:00			`# DMARC rua and ruf email`
			`DMARC_RUA=admin`
			`DMARC_RUF=admin`

Update .env Fixed typo 2018-04-04 11:21:37 +02:00			`# Welcome email, enable and set a topic and body if you wish to send welcome`
Implement welcome emails, fixes #107 2017-11-10 12:56:43 +02:00			`# emails to all users.`
			`WELCOME=false`
			`WELCOME_SUBJECT=Welcome to your new email account`
			`WELCOME_BODY=Welcome to your new email account, if you can read this, then it is configured properly!`

add optional Maildir-Compression 2018-08-05 19:48:24 +02:00			`# Maildir Compression`
fix comment in compose .env 2021-06-16 15:03:09 +02:00			`# choose compression-method, default: none (value: gz, bz2, lz4, zstd)`
add optional Maildir-Compression 2018-08-05 19:48:24 +02:00			`COMPRESSION=`
			`# change compression-level, default: 6 (value: 1-9)`
			`COMPRESSION_LEVEL=`

add bits of documentation for new environment variable 2020-07-12 21:26:22 +02:00			`# IMAP full-text search is enabled by default. Set the following variable to off in order to disable the feature.`
			`# FULL_TEXT_SEARCH=off`

Make path to admin and webmail configurable, related to #236 2017-09-24 18:16:36 +02:00			`###################################`
			`# Web settings`
			`###################################`

nginx: Allow extending config with overrides To facilitate this, the default redirect at / can be disabled, even if the default remains at redirecting to the webmailer. The extensions are within the host scope and are read from $ROOT/overrides/nginx/*.conf. 2018-11-27 01:12:12 +02:00			`# Path to redirect / to`
Correct variable naming in .env 2018-12-07 15:22:01 +02:00			`WEBROOT_REDIRECT=/webmail`
nginx: Allow extending config with overrides To facilitate this, the default redirect at / can be disabled, even if the default remains at redirecting to the webmailer. The extensions are within the host scope and are read from $ROOT/overrides/nginx/*.conf. 2018-11-27 01:12:12 +02:00
Make path to admin and webmail configurable, related to #236 2017-09-24 18:16:36 +02:00			`# Path to the admin interface if enabled`
Remove spaces around = sign in .env 2017-09-28 21:47:01 +02:00			`WEB_ADMIN=/admin`
Make path to admin and webmail configurable, related to #236 2017-09-24 18:16:36 +02:00
			`# Path to the webmail if enabled`
Remove spaces around = sign in .env 2017-09-28 21:47:01 +02:00			`WEB_WEBMAIL=/webmail`
Make path to admin and webmail configurable, related to #236 2017-09-24 18:16:36 +02:00
Improve the sidebar, display site title and website link 2017-10-29 19:13:59 +02:00			`# Website name`
			`SITENAME=Mailu`

			`# Linked Website URL`
			`WEBSITE=https://mailu.io`

Add support for recaptcha upon signup 2018-04-11 21:08:44 +02:00			`# Registration reCaptcha settings (warning, this has some privacy impact)`
			`# RECAPTCHA_PUBLIC_KEY=`
			`# RECAPTCHA_PRIVATE_KEY=`

Add the domain registration option in .env 2018-04-18 20:34:08 +02:00			`# Domain registration, uncomment to enable`
			`# DOMAIN_REGISTRATION=true`

Create and use ssl dhparam file if not existing (mounted), NGINX_SSL_DHPARAM_BITS variable in .env.dist file 2017-02-25 10:55:00 +02:00			`###################################`
Fix remaining migration scripts and remove initdb/flushdb from manage.py 2017-09-17 11:55:12 +02:00			`# Advanced settings`
Create and use ssl dhparam file if not existing (mounted), NGINX_SSL_DHPARAM_BITS variable in .env.dist file 2017-02-25 10:55:00 +02:00			`###################################`

Option to send logs to journald or syslog 2018-10-16 11:38:17 +02:00			`# Log driver for front service. Possible values:`
			`# json-file (default)`
			`# journald (On systemd platforms, useful for Fail2Ban integration)`
			# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker-compose log` for front!)
			`LOG_DRIVER=json-file`

Fix remaining migration scripts and remove initdb/flushdb from manage.py 2017-09-17 11:55:12 +02:00			`# Docker-compose project name, this will prepended to containers names.`
			`COMPOSE_PROJECT_NAME=mailu`

Misc improvements to PASSWORD_SCHEME - remove PASSWORD_SCHEME altogether - introduce CREDENTIAL_ROUNDS - migrate all old hashes to the current format - auto-detect/enable all hash types that passlib supports - upgrade passlib to 1.7.4 (see #1706: ldap_salted_sha512 support) 2021-02-02 21:10:18 +02:00			`# Number of rounds used by the password hashing scheme`
			`CREDENTIAL_ROUNDS=12`
Adding options for mail-letsencrypt 2017-12-05 01:21:58 +02:00
			`# Header to take the real ip from`
			`REAL_IP_HEADER=`

			`# IPs for nginx set_real_ip_from (CIDR list separated by commas)`
			`REAL_IP_FROM=`
Add REJECT_UNLISTED_RECIPIENT variable in .env file 2018-10-04 20:44:27 +02:00
			`# choose wether mailu bounces (no) or rejects (yes) mail when recipient is unknown (value: yes, no)`
			`REJECT_UNLISTED_RECIPIENT=`
LOG_LEVEL docs and changelog entry 2019-01-08 00:58:01 +02:00
			`# Log level threshold in start.py (value: CRITICAL, ERROR, WARNING, INFO, DEBUG, NOTSET)`
			`LOG_LEVEL=WARNING`