1
0
mirror of https://github.com/Mailu/Mailu.git synced 2024-12-14 10:53:30 +02:00
Mailu/setup/flavors/compose/mailu.env

195 lines
6.1 KiB
Bash
Raw Normal View History

2018-04-22 11:53:18 +02:00
# Mailu main configuration file
2018-10-18 16:23:25 +02:00
#
2019-02-15 12:06:01 +02:00
# This file is autogenerated by the configuration management wizard for {{ flavor }} flavor.
2018-04-22 11:53:18 +02:00
# For a detailed list of configuration variables, see the documentation at
# https://mailu.io
###################################
# Common configuration variables
###################################
# Set to a randomly generated 16 bytes string
SECRET_KEY={{ secret(16) }}
# Subnet of the docker network. This should not conflict with any networks to which your system is connected. (Internal and external!)
2018-10-23 15:39:22 +02:00
SUBNET={{ subnet }}
2019-01-17 16:24:52 +02:00
{% if ipv6_enabled %}
SUBNET6={{ subnet6 }}
{% endif %}
2018-10-16 15:12:42 +02:00
# Main mail domain
2018-10-17 15:46:20 +02:00
DOMAIN={{ domain }}
2018-10-16 15:12:42 +02:00
2023-05-05 20:09:31 +02:00
# Hostnames for this server, separated with commas
HOSTNAMES={{ hostnames }}
# Postmaster local part (will append the main mail domain)
POSTMASTER={{ postmaster }}
2018-10-16 15:12:42 +02:00
# Choose how secure connections will behave (value: letsencrypt, cert, notls, mail, mail-letsencrypt)
TLS_FLAVOR={{ tls_flavor }}
2018-04-22 11:53:18 +02:00
2023-02-09 12:24:06 +02:00
# Authentication rate limit per IP (per /24 on ipv4 and /48 on ipv6)
{% if auth_ratelimit_ip > '0' %}
AUTH_RATELIMIT_IP={{ auth_ratelimit_ip }}/hour
{% endif %}
2021-09-24 13:35:41 +02:00
# Authentication rate limit per user (regardless of the source-IP)
{% if auth_ratelimit_user > '0' %}
AUTH_RATELIMIT_USER={{ auth_ratelimit_user }}/day
2018-10-17 14:11:55 +02:00
{% endif %}
2018-04-22 11:53:18 +02:00
# Opt-out of statistics, replace with "True" to opt out
{% if statistics_enabled %}
DISABLE_STATISTICS=False
{% else %}
DISABLE_STATISTICS=True
{% endif %}
2018-10-16 15:12:42 +02:00
###################################
# Optional features
###################################
# Expose the admin interface (value: true, false)
ADMIN={{ admin_enabled or 'false' }}
2018-10-16 15:12:42 +02:00
2023-10-12 20:42:16 +02:00
# Choose which webmail to run if any (values: roundcube, snappymail, none). To enable this feature, recreate the docker-compose.yml file via setup.
2018-10-17 15:46:20 +02:00
WEBMAIL={{ webmail_type }}
2018-10-16 15:12:42 +02:00
# Expose the API interface (value: true, false)
API={{ api_enabled or 'false' }}
2023-10-12 20:42:16 +02:00
# Dav server implementation (value: radicale, none). To enable this feature, recreate the docker-compose.yml file via setup.
WEBDAV={{ webdav_enabled or 'none' }}
2023-10-12 20:42:16 +02:00
# Antivirus solution (value: clamav, none). To enable this feature, recreate the docker-compose.yml file via setup.
ANTIVIRUS={{ antivirus_enabled or 'none' }}
2018-10-16 15:12:42 +02:00
2023-10-12 20:42:16 +02:00
# Scan Macros solution (value: true, false). To enable this feature, recreate the docker-compose.yml file via setup.
2022-12-19 12:53:05 +02:00
SCAN_MACROS={{ oletools_enabled or 'false' }}
2018-04-22 11:53:18 +02:00
###################################
# Mail settings
2018-04-22 11:53:18 +02:00
###################################
# Message size limit in bytes
# Default: accept messages up to 50MB
2018-12-07 13:37:40 +02:00
# Max attachment size will be 33% smaller
2018-10-17 14:38:51 +02:00
MESSAGE_SIZE_LIMIT={{ message_size_limit or '50000000' }}
2018-04-22 11:53:18 +02:00
2021-08-08 09:21:14 +02:00
# Message rate limit (per user)
{% if message_ratelimit_pd > '0' %}
MESSAGE_RATELIMIT={{ message_ratelimit_pd }}/day
{% endif %}
# Networks granted relay permissions
# Use this with care, all hosts in this networks will be able to send mail without authentication!
RELAYNETS=
2018-04-22 11:53:18 +02:00
# Will relay all outgoing mails if configured
RELAYHOST={{ relayhost }}
2023-01-25 13:20:17 +02:00
# Enable fetchmail
2022-10-20 13:41:35 +02:00
FETCHMAIL_ENABLED={{ fetchmail_enabled or 'False' }}
2018-04-22 11:53:18 +02:00
# Fetchmail delay
2018-10-17 14:38:51 +02:00
FETCHMAIL_DELAY={{ fetchmail_delay or '600' }}
2018-04-22 11:53:18 +02:00
# Recipient delimiter, character used to delimiter localpart from custom address part
2018-10-17 14:38:51 +02:00
RECIPIENT_DELIMITER={{ recipient_delimiter or '+' }}
2018-04-22 11:53:18 +02:00
# DMARC rua and ruf email
DMARC_RUA={{ dmarc_rua or postmaster }}
DMARC_RUF={{ dmarc_ruf or postmaster }}
2018-04-22 11:53:18 +02:00
# Welcome email, enable and set a topic and body if you wish to send welcome
# emails to all users.
WELCOME={{ welcome_enable or 'false' }}
WELCOME_SUBJECT={{ welcome_subject or 'Welcome to your new email account' }}
2018-10-19 13:09:58 +02:00
WELCOME_BODY={{ welcome_body or 'Welcome to your new email account, if you can read this, then it is configured properly!' }}
2018-04-22 11:53:18 +02:00
2018-10-17 14:38:51 +02:00
# Maildir Compression
2023-04-22 08:24:36 +02:00
# choose compression-method, default: none (value: gz, bz2, zstd)
2018-10-17 14:38:51 +02:00
COMPRESSION={{ compression }}
# change compression-level, default: 6 (value: 1-9)
COMPRESSION_LEVEL={{ compression_level }}
2023-10-09 17:38:15 +02:00
# IMAP full-text search is enabled by default.
# Set the following variable to off in order to disable the feature
# or a comma separated list of language codes to support
2023-10-11 14:37:27 +02:00
FULL_TEXT_SEARCH=en
2018-04-22 11:53:18 +02:00
###################################
# Web settings
###################################
# Path to redirect / to
{% if webmail_type != 'none' %}
WEBROOT_REDIRECT=/webmail
{% elif admin_enabled %}
WEBROOT_REDIRECT=/admin
{% else %}
WEBROOT_REDIRECT=
{% endif %}
2018-04-22 11:53:18 +02:00
# Path to the admin interface if enabled
WEB_ADMIN=/admin
2018-04-22 11:53:18 +02:00
# Path to the webmail if enabled
WEB_WEBMAIL=/webmail
2018-04-22 11:53:18 +02:00
# Path to the API interface if enabled
WEB_API=/api
2018-04-22 11:53:18 +02:00
# Website name
2018-10-16 11:34:55 +02:00
SITENAME={{ site_name }}
2018-04-22 11:53:18 +02:00
# Linked Website URL
WEBSITE={{ website }}
2018-04-22 11:53:18 +02:00
{% if recaptcha_public_key and recaptcha_private_key %}
# Registration reCaptcha settings (warning, this has some privacy impact)
# RECAPTCHA_PUBLIC_KEY={{ recaptcha_public_key }}
# RECAPTCHA_PRIVATE_KEY={{ recaptcha_private_key }}
{% endif %}
{% if domain_registration %}
# Domain registration (remove to disable)
DOMAIN_REGISTRATION=true
{% endif %}
2018-04-22 11:53:18 +02:00
###################################
# Advanced settings
###################################
# Docker-compose project name, this will prepended to containers names.
COMPOSE_PROJECT_NAME={{ compose_project_name or 'mailu' }}
2021-09-24 13:37:00 +02:00
# Number of rounds used by the password hashing scheme
CREDENTIAL_ROUNDS=12
2018-04-22 11:53:18 +02:00
# Header to take the real ip from
REAL_IP_HEADER={{ real_ip_header }}
# IPs for nginx set_real_ip_from (CIDR list separated by commas)
REAL_IP_FROM={{ real_ip_from }}
2018-10-17 14:38:51 +02:00
# choose wether mailu bounces (no) or rejects (yes) mail when recipient is unknown (value: yes, no)
REJECT_UNLISTED_RECIPIENT={{ reject_unlisted_recipient }}
2018-11-27 15:11:46 +02:00
2019-01-08 00:58:01 +02:00
# Log level threshold in start.py (value: CRITICAL, ERROR, WARNING, INFO, DEBUG, NOTSET)
2024-04-20 23:19:59 +02:00
LOG_LEVEL=INFO
2021-11-05 15:44:12 +02:00
# Timezone for the Mailu containers. See this link for all possible values https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
TZ=Etc/UTC
# Default spam threshold used for new users
DEFAULT_SPAM_THRESHOLD=80
# API token required for authenticating to the RESTful API.
# This is a mandatory setting for using the RESTful API.
API_TOKEN={{ api_token }}
2023-10-12 20:42:16 +02:00
# Whether tika should be enabled (scan/OCR email attachements). To enable this feature, recreate the docker-compose.yml file via setup.
2023-10-11 14:37:27 +02:00
FULL_TEXT_SEARCH_ATTACHMENTS={{ tika_enabled }}