207 lines
8.9 KiB
Bash
207 lines
8.9 KiB
Bash
#!/bin/bash
|
|
|
|
# shellcheck disable=SC2034
|
|
declare -A VARS
|
|
|
|
function _early_variables_setup() {
|
|
_obtain_hostname_and_domainname
|
|
__environment_variables_backwards_compatibility
|
|
__environment_variables_general_setup
|
|
}
|
|
|
|
# This function handles variables that are deprecated. This allows a
|
|
# smooth transition period, without the need of removing a variable
|
|
# completely with a single version.
|
|
function __environment_variables_backwards_compatibility() {
|
|
if [[ ${ENABLE_LDAP:-0} -eq 1 ]]; then
|
|
_log 'error' "'ENABLE_LDAP=1' has been changed to 'ACCOUNT_PROVISIONER=LDAP' since DMS v13"
|
|
fi
|
|
|
|
# Dovecot and SASLAuthd have applied an 'ldap://' fallback for compatibility since v10 (June 2021)
|
|
# This was silently applied, but users should be explicit:
|
|
if [[ ${LDAP_SERVER_HOST:-'://'} != *'://'* ]] \
|
|
|| [[ ${DOVECOT_URIS:-'://'} != *'://'* ]] \
|
|
|| [[ ${SASLAUTHD_LDAP_SERVER:-'://'} != *'://'* ]]; then
|
|
_log 'error' "The ENV for which LDAP host to connect to must include the URI scheme ('ldap://', 'ldaps://', 'ldapi://')"
|
|
fi
|
|
|
|
if [[ -n ${SA_SPAM_SUBJECT:-} ]]; then
|
|
_log 'warn' "'SA_SPAM_SUBJECT' has been renamed to 'SPAM_SUBJECT' - this warning will block startup on v15.0.0"
|
|
_log 'info' "Copying value of 'SA_SPAM_SUBJECT' into 'SPAM_SUBJECT' if 'SPAM_SUBJECT' has not been set explicitly"
|
|
SPAM_SUBJECT=${SPAM_SUBJECT:-${SA_SPAM_SUBJECT}}
|
|
fi
|
|
|
|
# TODO this can be uncommented in a PR handling the HOSTNAME/DOMAINNAME issue
|
|
# TODO see check_for_changes.sh and dns.sh
|
|
# if [[ -n ${OVERRIDE_HOSTNAME:-} ]]
|
|
# then
|
|
# _log 'warn' "'OVERRIDE_HOSTNAME' is deprecated (and will be removed in v13.0.0) => use 'DMS_FQDN' instead"
|
|
# [[ -z ${DMS_FQDN} ]] && DMS_FQDN=${OVERRIDE_HOSTNAME}
|
|
# fi
|
|
}
|
|
|
|
# This function sets almost all environment variables. This involves setting
|
|
# a default if no value was provided and writing the variable and its value
|
|
# to the VARS map.
|
|
function __environment_variables_general_setup() {
|
|
_log 'debug' 'Handling general environment variable setup'
|
|
|
|
# these variables must be defined first
|
|
# they are used as default values for other variables
|
|
|
|
VARS[POSTMASTER_ADDRESS]="${POSTMASTER_ADDRESS:=postmaster@${DOMAINNAME}}"
|
|
VARS[REPORT_RECIPIENT]="${REPORT_RECIPIENT:=${POSTMASTER_ADDRESS}}"
|
|
VARS[REPORT_SENDER]="${REPORT_SENDER:=mailserver-report@${HOSTNAME}}"
|
|
VARS[DMS_VMAIL_UID]="${DMS_VMAIL_UID:=5000}"
|
|
VARS[DMS_VMAIL_GID]="${DMS_VMAIL_GID:=5000}"
|
|
|
|
_log 'trace' 'Setting anti-spam & anti-virus environment variables'
|
|
|
|
VARS[AMAVIS_LOGLEVEL]="${AMAVIS_LOGLEVEL:=0}"
|
|
VARS[CLAMAV_MESSAGE_SIZE_LIMIT]="${CLAMAV_MESSAGE_SIZE_LIMIT:=25M}"
|
|
VARS[FAIL2BAN_BLOCKTYPE]="${FAIL2BAN_BLOCKTYPE:=drop}"
|
|
VARS[MOVE_SPAM_TO_JUNK]="${MOVE_SPAM_TO_JUNK:=1}"
|
|
VARS[MARK_SPAM_AS_READ]="${MARK_SPAM_AS_READ:=0}"
|
|
VARS[POSTGREY_AUTO_WHITELIST_CLIENTS]="${POSTGREY_AUTO_WHITELIST_CLIENTS:=5}"
|
|
VARS[POSTGREY_DELAY]="${POSTGREY_DELAY:=300}"
|
|
VARS[POSTGREY_MAX_AGE]="${POSTGREY_MAX_AGE:=35}"
|
|
VARS[POSTGREY_TEXT]="${POSTGREY_TEXT:=Delayed by Postgrey}"
|
|
VARS[POSTSCREEN_ACTION]="${POSTSCREEN_ACTION:=enforce}"
|
|
VARS[RSPAMD_CHECK_AUTHENTICATED]="${RSPAMD_CHECK_AUTHENTICATED:=0}"
|
|
VARS[RSPAMD_GREYLISTING]="${RSPAMD_GREYLISTING:=0}"
|
|
VARS[RSPAMD_HFILTER]="${RSPAMD_HFILTER:=1}"
|
|
VARS[RSPAMD_HFILTER_HOSTNAME_UNKNOWN_SCORE]="${RSPAMD_HFILTER_HOSTNAME_UNKNOWN_SCORE:=6}"
|
|
VARS[RSPAMD_NEURAL]="${RSPAMD_NEURAL:=0}"
|
|
VARS[RSPAMD_LEARN]="${RSPAMD_LEARN:=0}"
|
|
VARS[SA_KILL]=${SA_KILL:="10.0"}
|
|
VARS[SPAM_SUBJECT]=${SPAM_SUBJECT:=}
|
|
VARS[SA_TAG]=${SA_TAG:="2.0"}
|
|
VARS[SA_TAG2]=${SA_TAG2:="6.31"}
|
|
VARS[SPAMASSASSIN_SPAM_TO_INBOX]="${SPAMASSASSIN_SPAM_TO_INBOX:=1}"
|
|
VARS[SPOOF_PROTECTION]="${SPOOF_PROTECTION:=0}"
|
|
VARS[VIRUSMAILS_DELETE_DELAY]="${VIRUSMAILS_DELETE_DELAY:=7}"
|
|
|
|
_log 'trace' 'Setting service-enabling environment variables'
|
|
|
|
VARS[ENABLE_AMAVIS]="${ENABLE_AMAVIS:=1}"
|
|
VARS[ENABLE_CLAMAV]="${ENABLE_CLAMAV:=0}"
|
|
VARS[ENABLE_DNSBL]="${ENABLE_DNSBL:=0}"
|
|
VARS[ENABLE_FAIL2BAN]="${ENABLE_FAIL2BAN:=0}"
|
|
VARS[ENABLE_FETCHMAIL]="${ENABLE_FETCHMAIL:=0}"
|
|
VARS[ENABLE_GETMAIL]="${ENABLE_GETMAIL:=0}"
|
|
VARS[ENABLE_MANAGESIEVE]="${ENABLE_MANAGESIEVE:=0}"
|
|
VARS[ENABLE_OAUTH2]="${ENABLE_OAUTH2:=0}"
|
|
VARS[ENABLE_OPENDKIM]="${ENABLE_OPENDKIM:=1}"
|
|
VARS[ENABLE_OPENDMARC]="${ENABLE_OPENDMARC:=1}"
|
|
VARS[ENABLE_POLICYD_SPF]="${ENABLE_POLICYD_SPF:=1}"
|
|
VARS[ENABLE_POP3]="${ENABLE_POP3:=0}"
|
|
VARS[ENABLE_IMAP]="${ENABLE_IMAP:=1}"
|
|
VARS[ENABLE_POSTGREY]="${ENABLE_POSTGREY:=0}"
|
|
VARS[ENABLE_QUOTAS]="${ENABLE_QUOTAS:=1}"
|
|
VARS[ENABLE_RSPAMD]="${ENABLE_RSPAMD:=0}"
|
|
VARS[ENABLE_RSPAMD_REDIS]="${ENABLE_RSPAMD_REDIS:=${ENABLE_RSPAMD}}"
|
|
VARS[ENABLE_SASLAUTHD]="${ENABLE_SASLAUTHD:=0}"
|
|
VARS[ENABLE_SPAMASSASSIN]="${ENABLE_SPAMASSASSIN:=0}"
|
|
VARS[ENABLE_SPAMASSASSIN_KAM]="${ENABLE_SPAMASSASSIN_KAM:=0}"
|
|
VARS[ENABLE_SRS]="${ENABLE_SRS:=0}"
|
|
VARS[ENABLE_UPDATE_CHECK]="${ENABLE_UPDATE_CHECK:=1}"
|
|
|
|
_log 'trace' 'Setting IP, DNS and SSL environment variables'
|
|
|
|
VARS[DEFAULT_RELAY_HOST]="${DEFAULT_RELAY_HOST:=}"
|
|
# VARS[DMS_FQDN]="${DMS_FQDN:=}"
|
|
# VARS[DMS_DOMAINNAME]="${DMS_DOMAINNAME:=}"
|
|
# VARS[DMS_HOSTNAME]="${DMS_HOSTNAME:=}"
|
|
VARS[NETWORK_INTERFACE]="${NETWORK_INTERFACE:=eth0}"
|
|
VARS[OVERRIDE_HOSTNAME]="${OVERRIDE_HOSTNAME:-}"
|
|
VARS[RELAY_HOST]="${RELAY_HOST:=}"
|
|
VARS[SSL_TYPE]="${SSL_TYPE:=}"
|
|
VARS[TLS_LEVEL]="${TLS_LEVEL:=modern}"
|
|
|
|
_log 'trace' 'Setting Dovecot- and Postfix-specific environment variables'
|
|
|
|
VARS[DOVECOT_INET_PROTOCOLS]="${DOVECOT_INET_PROTOCOLS:=all}"
|
|
VARS[DOVECOT_MAILBOX_FORMAT]="${DOVECOT_MAILBOX_FORMAT:=maildir}"
|
|
VARS[DOVECOT_TLS]="${DOVECOT_TLS:=no}"
|
|
|
|
VARS[POSTFIX_DAGENT]="${POSTFIX_DAGENT:=}"
|
|
VARS[POSTFIX_INET_PROTOCOLS]="${POSTFIX_INET_PROTOCOLS:=all}"
|
|
VARS[POSTFIX_MAILBOX_SIZE_LIMIT]="${POSTFIX_MAILBOX_SIZE_LIMIT:=0}"
|
|
VARS[POSTFIX_MESSAGE_SIZE_LIMIT]="${POSTFIX_MESSAGE_SIZE_LIMIT:=10240000}" # ~10 MB
|
|
VARS[POSTFIX_REJECT_UNKNOWN_CLIENT_HOSTNAME]="${POSTFIX_REJECT_UNKNOWN_CLIENT_HOSTNAME:=0}"
|
|
|
|
_log 'trace' 'Setting SRS specific environment variables'
|
|
|
|
VARS[SRS_DOMAINNAME]="${SRS_DOMAINNAME:=${DOMAINNAME}}"
|
|
VARS[SRS_EXCLUDE_DOMAINS]="${SRS_EXCLUDE_DOMAINS:=}"
|
|
VARS[SRS_SECRET]="${SRS_SECRET:=}"
|
|
VARS[SRS_SENDER_CLASSES]="${SRS_SENDER_CLASSES:=envelope_sender}"
|
|
|
|
_log 'trace' 'Setting miscellaneous environment variables'
|
|
|
|
VARS[ACCOUNT_PROVISIONER]="${ACCOUNT_PROVISIONER:=FILE}"
|
|
VARS[FETCHMAIL_PARALLEL]="${FETCHMAIL_PARALLEL:=0}"
|
|
VARS[FETCHMAIL_POLL]="${FETCHMAIL_POLL:=300}"
|
|
VARS[GETMAIL_POLL]="${GETMAIL_POLL:=5}"
|
|
VARS[LOG_LEVEL]="${LOG_LEVEL:=info}"
|
|
VARS[LOGROTATE_INTERVAL]="${LOGROTATE_INTERVAL:=weekly}"
|
|
VARS[LOGROTATE_COUNT]="${LOGROTATE_COUNT:=4}"
|
|
VARS[LOGWATCH_INTERVAL]="${LOGWATCH_INTERVAL:=none}"
|
|
VARS[LOGWATCH_RECIPIENT]="${LOGWATCH_RECIPIENT:=${REPORT_RECIPIENT}}"
|
|
VARS[LOGWATCH_SENDER]="${LOGWATCH_SENDER:=${REPORT_SENDER}}"
|
|
VARS[PERMIT_DOCKER]="${PERMIT_DOCKER:=none}"
|
|
VARS[PFLOGSUMM_RECIPIENT]="${PFLOGSUMM_RECIPIENT:=${REPORT_RECIPIENT}}"
|
|
VARS[PFLOGSUMM_SENDER]="${PFLOGSUMM_SENDER:=${REPORT_SENDER}}"
|
|
VARS[PFLOGSUMM_TRIGGER]="${PFLOGSUMM_TRIGGER:=none}"
|
|
VARS[SMTP_ONLY]="${SMTP_ONLY:=0}"
|
|
VARS[SUPERVISOR_LOGLEVEL]="${SUPERVISOR_LOGLEVEL:=warn}"
|
|
VARS[TZ]="${TZ:=}"
|
|
VARS[UPDATE_CHECK_INTERVAL]="${UPDATE_CHECK_INTERVAL:=1d}"
|
|
}
|
|
|
|
function _environment_variables_oauth2() {
|
|
_log 'debug' 'Setting OAUTH2-related environment variables now'
|
|
|
|
VARS[OAUTH2_INTROSPECTION_URL]="${OAUTH2_INTROSPECTION_URL:=}"
|
|
}
|
|
|
|
# This function handles environment variables related to LDAP.
|
|
# NOTE: SASLAuthd and Dovecot LDAP support inherit these common ENV.
|
|
function _environment_variables_ldap() {
|
|
_log 'debug' 'Setting LDAP-related environment variables now'
|
|
|
|
VARS[LDAP_BIND_DN]="${LDAP_BIND_DN:=}"
|
|
VARS[LDAP_BIND_PW]="${LDAP_BIND_PW:=}"
|
|
VARS[LDAP_SEARCH_BASE]="${LDAP_SEARCH_BASE:=}"
|
|
VARS[LDAP_SERVER_HOST]="${LDAP_SERVER_HOST:=}"
|
|
VARS[LDAP_START_TLS]="${LDAP_START_TLS:=no}"
|
|
}
|
|
|
|
# This function handles environment variables related to SASLAUTHD
|
|
# LDAP specific ENV handled in: `startup/setup.d/saslauthd.sh:_setup_saslauthd()`
|
|
function _environment_variables_saslauthd() {
|
|
_log 'debug' 'Setting SASLAUTHD-related environment variables now'
|
|
|
|
# Only used by the supervisor service command (upstream default: `/etc/default/saslauthd`)
|
|
VARS[SASLAUTHD_MECHANISMS]="${SASLAUTHD_MECHANISMS:=pam}"
|
|
}
|
|
|
|
# This function Writes the contents of the `VARS` map (associative array)
|
|
# to locations where they can be sourced from (e.g. `/etc/dms-settings`)
|
|
# or where they can be used by Bash directly (e.g. `/root/.bashrc`).
|
|
function _environment_variables_export() {
|
|
_log 'debug' "Exporting environment variables now (creating '/etc/dms-settings')"
|
|
|
|
: >/root/.bashrc # make DMS variables available in login shells and their subprocesses
|
|
: >/etc/dms-settings # this file can be sourced by other scripts
|
|
|
|
local VAR
|
|
for VAR in "${!VARS[@]}"; do
|
|
echo "export ${VAR}='${VARS[${VAR}]}'" >>/root/.bashrc
|
|
echo "${VAR}='${VARS[${VAR}]}'" >>/etc/dms-settings
|
|
done
|
|
|
|
sort -o /root/.bashrc /root/.bashrc
|
|
sort -o /etc/dms-settings /etc/dms-settings
|
|
}
|