mirror of
https://github.com/Mailu/Mailu.git
synced 2024-12-14 10:53:30 +02:00
823b01041a
Setup is meant for the standard use case where you don't change WEB_*. WEB_* can still be changed via mailu.env
195 lines
6.1 KiB
Bash
195 lines
6.1 KiB
Bash
# Mailu main configuration file
|
|
#
|
|
# This file is autogenerated by the configuration management wizard for {{ flavor }} flavor.
|
|
# 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!)
|
|
SUBNET={{ subnet }}
|
|
{% if ipv6_enabled %}
|
|
SUBNET6={{ subnet6 }}
|
|
{% endif %}
|
|
|
|
# Main mail domain
|
|
DOMAIN={{ domain }}
|
|
|
|
# Hostnames for this server, separated with commas
|
|
HOSTNAMES={{ hostnames }}
|
|
|
|
# Postmaster local part (will append the main mail domain)
|
|
POSTMASTER={{ postmaster }}
|
|
|
|
# Choose how secure connections will behave (value: letsencrypt, cert, notls, mail, mail-letsencrypt)
|
|
TLS_FLAVOR={{ tls_flavor }}
|
|
|
|
# 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 %}
|
|
|
|
# Authentication rate limit per user (regardless of the source-IP)
|
|
{% if auth_ratelimit_user > '0' %}
|
|
AUTH_RATELIMIT_USER={{ auth_ratelimit_user }}/day
|
|
{% endif %}
|
|
|
|
# Opt-out of statistics, replace with "True" to opt out
|
|
{% if statistics_enabled %}
|
|
DISABLE_STATISTICS=False
|
|
{% else %}
|
|
DISABLE_STATISTICS=True
|
|
{% endif %}
|
|
|
|
###################################
|
|
# Optional features
|
|
###################################
|
|
|
|
# Expose the admin interface (value: true, false)
|
|
ADMIN={{ admin_enabled or 'false' }}
|
|
|
|
# Choose which webmail to run if any (values: roundcube, snappymail, none). To enable this feature, recreate the docker-compose.yml file via setup.
|
|
WEBMAIL={{ webmail_type }}
|
|
|
|
# Expose the API interface (value: true, false)
|
|
API={{ api_enabled or 'false' }}
|
|
|
|
# Dav server implementation (value: radicale, none). To enable this feature, recreate the docker-compose.yml file via setup.
|
|
WEBDAV={{ webdav_enabled or 'none' }}
|
|
|
|
# Antivirus solution (value: clamav, none). To enable this feature, recreate the docker-compose.yml file via setup.
|
|
ANTIVIRUS={{ antivirus_enabled or 'none' }}
|
|
|
|
# Scan Macros solution (value: true, false). To enable this feature, recreate the docker-compose.yml file via setup.
|
|
SCAN_MACROS={{ oletools_enabled or 'false' }}
|
|
|
|
###################################
|
|
# Mail settings
|
|
###################################
|
|
|
|
# Message size limit in bytes
|
|
# Default: accept messages up to 50MB
|
|
# Max attachment size will be 33% smaller
|
|
MESSAGE_SIZE_LIMIT={{ message_size_limit or '50000000' }}
|
|
|
|
# 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=
|
|
|
|
# Will relay all outgoing mails if configured
|
|
RELAYHOST={{ relayhost }}
|
|
|
|
# Enable fetchmail
|
|
FETCHMAIL_ENABLED={{ fetchmail_enabled or 'False' }}
|
|
|
|
# Fetchmail delay
|
|
FETCHMAIL_DELAY={{ fetchmail_delay or '600' }}
|
|
|
|
# Recipient delimiter, character used to delimiter localpart from custom address part
|
|
RECIPIENT_DELIMITER={{ recipient_delimiter or '+' }}
|
|
|
|
# DMARC rua and ruf email
|
|
DMARC_RUA={{ dmarc_rua or postmaster }}
|
|
DMARC_RUF={{ dmarc_ruf or postmaster }}
|
|
|
|
# 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' }}
|
|
WELCOME_BODY={{ welcome_body or '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, zstd)
|
|
COMPRESSION={{ compression }}
|
|
# change compression-level, default: 6 (value: 1-9)
|
|
COMPRESSION_LEVEL={{ compression_level }}
|
|
|
|
# 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
|
|
FULL_TEXT_SEARCH=en
|
|
|
|
###################################
|
|
# Web settings
|
|
###################################
|
|
|
|
# Path to redirect / to
|
|
{% if webmail_type != 'none' %}
|
|
WEBROOT_REDIRECT=/webmail
|
|
{% elif admin_enabled %}
|
|
WEBROOT_REDIRECT=/admin
|
|
{% else %}
|
|
WEBROOT_REDIRECT=
|
|
{% endif %}
|
|
|
|
# Path to the admin interface if enabled
|
|
WEB_ADMIN=/admin
|
|
|
|
# Path to the webmail if enabled
|
|
WEB_WEBMAIL=/webmail
|
|
|
|
# Path to the API interface if enabled
|
|
WEB_API=/api
|
|
|
|
# Website name
|
|
SITENAME={{ site_name }}
|
|
|
|
# Linked Website URL
|
|
WEBSITE={{ website }}
|
|
|
|
{% 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 %}
|
|
|
|
###################################
|
|
# Advanced settings
|
|
###################################
|
|
|
|
# Docker-compose project name, this will prepended to containers names.
|
|
COMPOSE_PROJECT_NAME={{ compose_project_name or 'mailu' }}
|
|
|
|
# Number of rounds used by the password hashing scheme
|
|
CREDENTIAL_ROUNDS=12
|
|
|
|
# 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 }}
|
|
|
|
# choose wether mailu bounces (no) or rejects (yes) mail when recipient is unknown (value: yes, no)
|
|
REJECT_UNLISTED_RECIPIENT={{ reject_unlisted_recipient }}
|
|
|
|
# Log level threshold in start.py (value: CRITICAL, ERROR, WARNING, INFO, DEBUG, NOTSET)
|
|
LOG_LEVEL=WARNING
|
|
|
|
# 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 }}
|
|
|
|
# Whether tika should be enabled (scan/OCR email attachements). To enable this feature, recreate the docker-compose.yml file via setup.
|
|
FULL_TEXT_SEARCH_ATTACHMENTS={{ tika_enabled }}
|