mirror of
https://github.com/docker-mailserver/docker-mailserver.git
synced 2025-08-31 23:40:25 +02:00
Change 'function' style (#3364)
This commit is contained in:
Casper
GitHub
parent
cf74127f78
commit
37ca0f9ba9
60 changed files with 233 additions and 466 deletions
|
|
@ -2,14 +2,12 @@
|
|||
|
||||
declare -a FUNCS_CHECK
|
||||
|
||||
function _register_check_function
|
||||
{
|
||||
function _register_check_function() {
|
||||
FUNCS_CHECK+=("${1}")
|
||||
_log 'trace' "${1}() registered"
|
||||
}
|
||||
|
||||
function _check
|
||||
{
|
||||
function _check() {
|
||||
_log 'info' 'Checking configuration'
|
||||
for FUNC in "${FUNCS_CHECK[@]}"
|
||||
do
|
||||
|
|
@ -17,8 +15,7 @@ function _check
|
|||
done
|
||||
}
|
||||
|
||||
function _check_improper_restart
|
||||
{
|
||||
function _check_improper_restart() {
|
||||
_log 'debug' 'Checking for improper restart'
|
||||
|
||||
if [[ -f /CONTAINER_START ]]; then
|
||||
|
|
@ -27,8 +24,7 @@ function _check_improper_restart
|
|||
fi
|
||||
}
|
||||
|
||||
function _check_hostname
|
||||
{
|
||||
function _check_hostname() {
|
||||
_log 'debug' 'Checking that hostname/domainname is provided or overridden'
|
||||
|
||||
_log 'debug' "Domain has been set to ${DOMAINNAME}"
|
||||
|
|
@ -40,8 +36,7 @@ function _check_hostname
|
|||
fi
|
||||
}
|
||||
|
||||
function _check_log_level
|
||||
{
|
||||
function _check_log_level() {
|
||||
if [[ ${LOG_LEVEL} == 'trace' ]] \
|
||||
|| [[ ${LOG_LEVEL} == 'debug' ]] \
|
||||
|| [[ ${LOG_LEVEL} == 'info' ]] \
|
||||
|
|
|
|||
|
|
@ -2,14 +2,12 @@
|
|||
|
||||
declare -a DAEMONS_START
|
||||
|
||||
function _register_start_daemon
|
||||
{
|
||||
function _register_start_daemon() {
|
||||
DAEMONS_START+=("${1}")
|
||||
_log 'trace' "${1}() registered"
|
||||
}
|
||||
|
||||
function _start_daemons
|
||||
{
|
||||
function _start_daemons() {
|
||||
_log 'info' 'Starting daemons'
|
||||
|
||||
for FUNCTION in "${DAEMONS_START[@]}"
|
||||
|
|
@ -18,8 +16,7 @@ function _start_daemons
|
|||
done
|
||||
}
|
||||
|
||||
function _default_start_daemon
|
||||
{
|
||||
function _default_start_daemon() {
|
||||
_log 'debug' "Starting ${1:?}"
|
||||
|
||||
local RESULT
|
||||
|
|
@ -47,19 +44,16 @@ function _start_daemon_rspamd_redis { _default_start_daemon 'rspamd-redis' ;
|
|||
function _start_daemon_rsyslog { _default_start_daemon 'rsyslog' ; }
|
||||
function _start_daemon_update_check { _default_start_daemon 'update-check' ; }
|
||||
|
||||
function _start_daemon_saslauthd
|
||||
{
|
||||
function _start_daemon_saslauthd() {
|
||||
_default_start_daemon "saslauthd_${SASLAUTHD_MECHANISMS}"
|
||||
}
|
||||
|
||||
function _start_daemon_postfix
|
||||
{
|
||||
function _start_daemon_postfix() {
|
||||
_adjust_mtime_for_postfix_maincf
|
||||
_default_start_daemon 'postfix'
|
||||
}
|
||||
|
||||
function _start_daemon_fetchmail
|
||||
{
|
||||
function _start_daemon_fetchmail() {
|
||||
if [[ ${FETCHMAIL_PARALLEL} -eq 1 ]]; then
|
||||
local COUNTER=0
|
||||
for _ in /etc/fetchmailrc.d/fetchmail-*.rc
|
||||
|
|
|
|||
|
|
@ -2,14 +2,12 @@
|
|||
|
||||
declare -a FUNCS_SETUP
|
||||
|
||||
function _register_setup_function
|
||||
{
|
||||
function _register_setup_function() {
|
||||
FUNCS_SETUP+=("${1}")
|
||||
_log 'trace' "${1}() registered"
|
||||
}
|
||||
|
||||
function _setup
|
||||
{
|
||||
function _setup() {
|
||||
# Requires `shopt -s globstar` because of `**` which in
|
||||
# turn is required as we're decending through directories
|
||||
for FILE in /usr/local/bin/setup.d/**/*.sh
|
||||
|
|
@ -28,8 +26,7 @@ function _setup
|
|||
_prepare_for_change_detection
|
||||
}
|
||||
|
||||
function _early_supervisor_setup
|
||||
{
|
||||
function _early_supervisor_setup() {
|
||||
SUPERVISOR_LOGLEVEL="${SUPERVISOR_LOGLEVEL:-warn}"
|
||||
|
||||
if ! grep -q "loglevel = ${SUPERVISOR_LOGLEVEL}" /etc/supervisor/supervisord.conf; then
|
||||
|
|
@ -56,8 +53,7 @@ function _early_supervisor_setup
|
|||
return 0
|
||||
}
|
||||
|
||||
function _setup_timezone
|
||||
{
|
||||
function _setup_timezone() {
|
||||
[[ -n ${TZ} ]] || return 0
|
||||
_log 'debug' "Setting timezone to '${TZ}'"
|
||||
|
||||
|
|
@ -78,8 +74,7 @@ function _setup_timezone
|
|||
fi
|
||||
}
|
||||
|
||||
function _setup_apply_fixes_after_configuration
|
||||
{
|
||||
function _setup_apply_fixes_after_configuration() {
|
||||
_log 'trace' 'Removing leftover PID files from a stop/start'
|
||||
find /var/run/ -not -name 'supervisord.pid' -name '*.pid' -delete
|
||||
touch /dev/shm/supervisor.sock
|
||||
|
|
@ -93,8 +88,7 @@ function _setup_apply_fixes_after_configuration
|
|||
rm -rf /var/mail-state/spool-postfix/{dev,etc,lib,pid,usr,private/auth}
|
||||
}
|
||||
|
||||
function _run_user_patches
|
||||
{
|
||||
function _run_user_patches() {
|
||||
local USER_PATCHES='/tmp/docker-mailserver/user-patches.sh'
|
||||
|
||||
if [[ -f ${USER_PATCHES} ]]; then
|
||||
|
|
|
|||
|
|
@ -6,8 +6,7 @@
|
|||
#
|
||||
# The OpenDKIM milter must come before the OpenDMARC milter in Postfix's
|
||||
# `smtpd_milters` milters options.
|
||||
function _setup_opendkim
|
||||
{
|
||||
function _setup_opendkim() {
|
||||
if [[ ${ENABLE_OPENDKIM} -eq 1 ]]; then
|
||||
_log 'debug' 'Configuring DKIM'
|
||||
|
||||
|
|
@ -54,8 +53,7 @@ function _setup_opendkim
|
|||
#
|
||||
# The OpenDMARC milter must come after the OpenDKIM milter in Postfix's
|
||||
# `smtpd_milters` milters options.
|
||||
function _setup_opendmarc
|
||||
{
|
||||
function _setup_opendmarc() {
|
||||
if [[ ${ENABLE_OPENDMARC} -eq 1 ]]; then
|
||||
# TODO When disabling SPF is possible, add a check whether DKIM and SPF is disabled
|
||||
# for DMARC to work, you should have at least one enabled
|
||||
|
|
@ -83,8 +81,7 @@ function _setup_opendmarc
|
|||
|
||||
# Configures the SPF check inside Postfix's configuration via policyd-spf. When
|
||||
# using Rspamd, you will likely want to turn that off.
|
||||
function _setup_policyd_spf
|
||||
{
|
||||
function _setup_policyd_spf() {
|
||||
if [[ ${ENABLE_POLICYD_SPF} -eq 1 ]]; then
|
||||
_log 'debug' 'Configuring policyd-spf'
|
||||
cat >>/etc/postfix/master.cf <<EOF
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
#!/bin/bash
|
||||
|
||||
function _setup_dovecot
|
||||
{
|
||||
function _setup_dovecot() {
|
||||
_log 'debug' 'Setting up Dovecot'
|
||||
|
||||
cp -a /usr/share/dovecot/protocols.d /etc/dovecot/
|
||||
|
|
@ -46,8 +45,7 @@ function _setup_dovecot
|
|||
[[ -f /tmp/docker-mailserver/dovecot.cf ]] && cp /tmp/docker-mailserver/dovecot.cf /etc/dovecot/local.conf
|
||||
}
|
||||
|
||||
function _setup_dovecot_sieve
|
||||
{
|
||||
function _setup_dovecot_sieve() {
|
||||
mkdir -p /usr/lib/dovecot/sieve-{filter,global,pipe}
|
||||
mkdir -p /usr/lib/dovecot/sieve-global/{before,after}
|
||||
|
||||
|
|
@ -83,8 +81,7 @@ function _setup_dovecot_sieve
|
|||
find /usr/lib/dovecot/sieve-{filter,pipe} -type f -exec chmod +x {} +
|
||||
}
|
||||
|
||||
function _setup_dovecot_quota
|
||||
{
|
||||
function _setup_dovecot_quota() {
|
||||
_log 'debug' 'Setting up Dovecot quota'
|
||||
|
||||
# Dovecot quota is disabled when using LDAP or SMTP_ONLY or when explicitly disabled.
|
||||
|
|
@ -136,8 +133,7 @@ function _setup_dovecot_quota
|
|||
fi
|
||||
}
|
||||
|
||||
function _setup_dovecot_local_user
|
||||
{
|
||||
function _setup_dovecot_local_user() {
|
||||
[[ ${SMTP_ONLY} -eq 1 ]] && return 0
|
||||
[[ ${ACCOUNT_PROVISIONER} == 'FILE' ]] || return 0
|
||||
|
||||
|
|
@ -147,8 +143,7 @@ function _setup_dovecot_local_user
|
|||
_log 'trace' "No mail accounts to create - '/tmp/docker-mailserver/postfix-accounts.cf' is missing"
|
||||
fi
|
||||
|
||||
function __wait_until_an_account_is_added_or_shutdown
|
||||
{
|
||||
function __wait_until_an_account_is_added_or_shutdown() {
|
||||
local SLEEP_PERIOD='10'
|
||||
|
||||
for (( COUNTER = 11 ; COUNTER >= 0 ; COUNTER-- ))
|
||||
|
|
@ -169,8 +164,7 @@ function _setup_dovecot_local_user
|
|||
_create_accounts
|
||||
}
|
||||
|
||||
function _setup_dovecot_inet_protocols
|
||||
{
|
||||
function _setup_dovecot_inet_protocols() {
|
||||
[[ ${DOVECOT_INET_PROTOCOLS} == 'all' ]] && return 0
|
||||
|
||||
_log 'trace' 'Setting up DOVECOT_INET_PROTOCOLS option'
|
||||
|
|
@ -189,13 +183,11 @@ function _setup_dovecot_inet_protocols
|
|||
sedfile -i "s|^#listen =.*|listen = ${PROTOCOL}|g" /etc/dovecot/dovecot.conf
|
||||
}
|
||||
|
||||
function _setup_dovecot_dhparam
|
||||
{
|
||||
function _setup_dovecot_dhparam() {
|
||||
_setup_dhparam 'Dovecot' '/etc/dovecot/dh.pem'
|
||||
}
|
||||
|
||||
function _setup_dovecot_hostname
|
||||
{
|
||||
function _setup_dovecot_hostname() {
|
||||
_log 'debug' 'Applying hostname to Dovecot'
|
||||
sed -i "s|^#hostname =.*$|hostname = '${HOSTNAME}'|g" /etc/dovecot/conf.d/15-lda.conf
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
#!/bin/bash
|
||||
|
||||
function _setup_fetchmail
|
||||
{
|
||||
function _setup_fetchmail() {
|
||||
if [[ ${ENABLE_FETCHMAIL} -eq 1 ]]; then
|
||||
_log 'trace' 'Enabling and configuring Fetchmail'
|
||||
|
||||
|
|
@ -23,8 +22,7 @@ function _setup_fetchmail
|
|||
fi
|
||||
}
|
||||
|
||||
function _setup_fetchmail_parallel
|
||||
{
|
||||
function _setup_fetchmail_parallel() {
|
||||
if [[ ${FETCHMAIL_PARALLEL} -eq 1 ]]; then
|
||||
_log 'trace' 'Enabling and configuring Fetchmail parallel'
|
||||
mkdir /etc/fetchmailrc.d/
|
||||
|
|
@ -35,8 +33,7 @@ function _setup_fetchmail_parallel
|
|||
#
|
||||
# The sole purpose for this is to work around what is known
|
||||
# as the Fetchmail IMAP idle issue.
|
||||
function _fetchmailrc_split
|
||||
{
|
||||
function _fetchmailrc_split() {
|
||||
local FETCHMAILRC='/etc/fetchmailrc'
|
||||
local FETCHMAILRCD='/etc/fetchmailrc.d'
|
||||
local DEFAULT_FILE="${FETCHMAILRCD}/defaults"
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
#!/bin/bash
|
||||
|
||||
function _setup_getmail
|
||||
{
|
||||
function _setup_getmail() {
|
||||
if [[ ${ENABLE_GETMAIL} -eq 1 ]]; then
|
||||
_log 'trace' 'Preparing Getmail configuration'
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
#!/bin/bash
|
||||
|
||||
function _setup_ldap
|
||||
{
|
||||
function _setup_ldap() {
|
||||
_log 'debug' 'Setting up LDAP'
|
||||
_log 'trace' 'Checking for custom configs'
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
#!/bin/bash
|
||||
|
||||
function _setup_logs_general
|
||||
{
|
||||
function _setup_logs_general() {
|
||||
_log 'debug' 'Setting up general log files'
|
||||
|
||||
# File/folder permissions are fine when using docker volumes, but may be wrong
|
||||
|
|
@ -11,8 +10,7 @@ function _setup_logs_general
|
|||
chown syslog:root /var/log/mail
|
||||
}
|
||||
|
||||
function _setup_logrotate
|
||||
{
|
||||
function _setup_logrotate() {
|
||||
_log 'debug' 'Setting up logrotate'
|
||||
|
||||
LOGROTATE='/var/log/mail/mail.log\n{\n compress\n copytruncate\n delaycompress\n'
|
||||
|
|
@ -42,8 +40,7 @@ function _setup_logrotate
|
|||
echo -e "${LOGROTATE}}" >/etc/logrotate.d/maillog
|
||||
}
|
||||
|
||||
function _setup_mail_summary
|
||||
{
|
||||
function _setup_mail_summary() {
|
||||
local ENABLED_MESSAGE
|
||||
ENABLED_MESSAGE="Enabling Postfix log summary reports with recipient '${PFLOGSUMM_RECIPIENT}'"
|
||||
|
||||
|
|
@ -80,8 +77,7 @@ EOF
|
|||
esac
|
||||
}
|
||||
|
||||
function _setup_logwatch
|
||||
{
|
||||
function _setup_logwatch() {
|
||||
echo 'LogFile = /var/log/mail/freshclam.log' >>/etc/logwatch/conf/logfiles/clam-update.conf
|
||||
echo "MailFrom = ${LOGWATCH_SENDER}" >>/etc/logwatch/conf/logwatch.conf
|
||||
echo "Mailer = \"sendmail -t -f ${LOGWATCH_SENDER}\"" >>/etc/logwatch/conf/logwatch.conf
|
||||
|
|
|
|||
|
|
@ -2,8 +2,7 @@
|
|||
|
||||
# Consolidate all states into a single directory
|
||||
# (/var/mail-state) to allow persistence using docker volumes
|
||||
function _setup_save_states
|
||||
{
|
||||
function _setup_save_states() {
|
||||
local DEST DESTDIR STATEDIR SERVICEDIR SERVICEDIRS SERVICEFILE SERVICEFILES
|
||||
|
||||
STATEDIR='/var/mail-state'
|
||||
|
|
|
|||
|
|
@ -1,13 +1,11 @@
|
|||
#!/bin/bash
|
||||
|
||||
function _setup_mailname
|
||||
{
|
||||
function _setup_mailname() {
|
||||
_log 'debug' "Setting up mailname and creating '/etc/mailname'"
|
||||
echo "${DOMAINNAME}" >/etc/mailname
|
||||
}
|
||||
|
||||
function _setup_docker_permit
|
||||
{
|
||||
function _setup_docker_permit() {
|
||||
_log 'debug' 'Setting up PERMIT_DOCKER option'
|
||||
|
||||
local CONTAINER_IP CONTAINER_NETWORK
|
||||
|
|
@ -29,14 +27,12 @@ function _setup_docker_permit
|
|||
CONTAINER_NETWORKS+=("${IP}")
|
||||
done < <(ip -o -4 addr show type veth | grep -E -o '[0-9\.]+/[0-9]+')
|
||||
|
||||
function __clear_postfix_mynetworks
|
||||
{
|
||||
function __clear_postfix_mynetworks() {
|
||||
_log 'trace' "Clearing Postfix's 'mynetworks'"
|
||||
postconf "mynetworks ="
|
||||
}
|
||||
|
||||
function __add_to_postfix_mynetworks
|
||||
{
|
||||
function __add_to_postfix_mynetworks() {
|
||||
local NETWORK_TYPE=$1
|
||||
local NETWORK=$2
|
||||
|
||||
|
|
|
|||
|
|
@ -7,8 +7,7 @@
|
|||
# @param ${2} = message
|
||||
function __postfix__log { _log "${1:-}" "(Postfix setup) ${2:-}" ; }
|
||||
|
||||
function _setup_postfix_early
|
||||
{
|
||||
function _setup_postfix_early() {
|
||||
_log 'debug' 'Configuring Postfix (early setup)'
|
||||
|
||||
__postfix__log 'trace' 'Applying hostname and domainname'
|
||||
|
|
@ -66,8 +65,7 @@ EOF
|
|||
fi
|
||||
}
|
||||
|
||||
function _setup_postfix_late
|
||||
{
|
||||
function _setup_postfix_late() {
|
||||
_log 'debug' 'Configuring Postfix (late setup)'
|
||||
|
||||
__postfix__log 'trace' 'Configuring user access'
|
||||
|
|
@ -91,8 +89,7 @@ function _setup_postfix_late
|
|||
__postfix__setup_override_configuration
|
||||
}
|
||||
|
||||
function __postfix__setup_override_configuration
|
||||
{
|
||||
function __postfix__setup_override_configuration() {
|
||||
__postfix__log 'debug' 'Overriding / adjusting configuration with user-supplied values'
|
||||
|
||||
if [[ -f /tmp/docker-mailserver/postfix-main.cf ]]; then
|
||||
|
|
@ -122,8 +119,7 @@ function __postfix__setup_override_configuration
|
|||
fi
|
||||
}
|
||||
|
||||
function _setup_SRS
|
||||
{
|
||||
function _setup_SRS() {
|
||||
_log 'debug' 'Setting up SRS'
|
||||
|
||||
postconf 'sender_canonical_maps = tcp:localhost:10001'
|
||||
|
|
@ -131,8 +127,7 @@ function _setup_SRS
|
|||
postconf 'recipient_canonical_maps = tcp:localhost:10002'
|
||||
postconf 'recipient_canonical_classes = envelope_recipient,header_recipient'
|
||||
|
||||
function __generate_secret
|
||||
{
|
||||
function __generate_secret() {
|
||||
(
|
||||
umask 0077
|
||||
dd if=/dev/urandom bs=24 count=1 2>/dev/null | base64 -w0 >"${1}"
|
||||
|
|
|
|||
|
|
@ -1,8 +1,7 @@
|
|||
#!/bin/bash
|
||||
|
||||
|
||||
function _setup_saslauthd
|
||||
{
|
||||
function _setup_saslauthd() {
|
||||
_log 'debug' 'Setting up SASLAUTHD'
|
||||
|
||||
if [[ ! -f /etc/saslauthd.conf ]]; then
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
#!/bin/bash
|
||||
|
||||
function _setup_security_stack
|
||||
{
|
||||
function _setup_security_stack() {
|
||||
_log 'debug' 'Setting up Security Stack'
|
||||
|
||||
__setup__security__postgrey
|
||||
|
|
@ -23,8 +22,7 @@ function _setup_security_stack
|
|||
__setup__security__amavis
|
||||
}
|
||||
|
||||
function __setup__security__postgrey
|
||||
{
|
||||
function __setup__security__postgrey() {
|
||||
if [[ ${ENABLE_POSTGREY} -eq 1 ]]; then
|
||||
_log 'debug' 'Enabling and configuring Postgrey'
|
||||
|
||||
|
|
@ -52,8 +50,7 @@ function __setup__security__postgrey
|
|||
fi
|
||||
}
|
||||
|
||||
function __setup__security__postscreen
|
||||
{
|
||||
function __setup__security__postscreen() {
|
||||
_log 'debug' 'Configuring Postscreen'
|
||||
sed -i \
|
||||
-e "s|postscreen_dnsbl_action = enforce|postscreen_dnsbl_action = ${POSTSCREEN_ACTION}|" \
|
||||
|
|
@ -69,8 +66,7 @@ function __setup__security__postscreen
|
|||
fi
|
||||
}
|
||||
|
||||
function __setup__security__spamassassin
|
||||
{
|
||||
function __setup__security__spamassassin() {
|
||||
if [[ ${ENABLE_SPAMASSASSIN} -eq 1 ]]; then
|
||||
_log 'debug' 'Enabling and configuring SpamAssassin'
|
||||
|
||||
|
|
@ -157,8 +153,7 @@ EOF
|
|||
fi
|
||||
}
|
||||
|
||||
function __setup__security__clamav
|
||||
{
|
||||
function __setup__security__clamav() {
|
||||
if [[ ${ENABLE_CLAMAV} -eq 1 ]]; then
|
||||
_log 'debug' 'Enabling and configuring ClamAV'
|
||||
|
||||
|
|
@ -197,8 +192,7 @@ function __setup__security__clamav
|
|||
fi
|
||||
}
|
||||
|
||||
function __setup__security__fail2ban
|
||||
{
|
||||
function __setup__security__fail2ban() {
|
||||
if [[ ${ENABLE_FAIL2BAN} -eq 1 ]]; then
|
||||
_log 'debug' 'Enabling and configuring Fail2Ban'
|
||||
|
||||
|
|
@ -221,8 +215,7 @@ function __setup__security__fail2ban
|
|||
fi
|
||||
}
|
||||
|
||||
function __setup__security__amavis
|
||||
{
|
||||
function __setup__security__amavis() {
|
||||
if [[ ${ENABLE_AMAVIS} -eq 1 ]]; then
|
||||
_log 'debug' 'Configuring Amavis'
|
||||
if [[ -f /tmp/docker-mailserver/amavis.cf ]]; then
|
||||
|
|
@ -257,8 +250,7 @@ function __setup__security__amavis
|
|||
}
|
||||
|
||||
# We can use Sieve to move spam emails to the "Junk" folder.
|
||||
function _setup_spam_to_junk
|
||||
{
|
||||
function _setup_spam_to_junk() {
|
||||
if [[ ${MOVE_SPAM_TO_JUNK} -eq 1 ]]; then
|
||||
_log 'debug' 'Spam emails will be moved to the Junk folder'
|
||||
cat >/usr/lib/dovecot/sieve-global/after/spam_to_junk.sieve << EOF
|
||||
|
|
|
|||
|
|
@ -1,8 +1,7 @@
|
|||
#!/bin/bash
|
||||
|
||||
# Function called during global setup to handle the complete setup of Rspamd.
|
||||
function _setup_rspamd
|
||||
{
|
||||
function _setup_rspamd() {
|
||||
if _env_var_expect_zero_or_one 'ENABLE_RSPAMD' && [[ ${ENABLE_RSPAMD} -eq 1 ]]; then
|
||||
_log 'debug' 'Enabling and configuring Rspamd'
|
||||
__rspamd__log 'trace' '---------- Setup started ----------'
|
||||
|
|
@ -36,8 +35,7 @@ function __rspamd__log { _log "${1:-}" "(Rspamd setup) ${2:-}" ; }
|
|||
# @param ${2} = `true` when you want to enable the module (default),
|
||||
# `false` when you want to disable the module [OPTIONAL]
|
||||
# @param ${3} = whether to use `local` (default) or `override` [OPTIONAL]
|
||||
function __rspamd__helper__enable_disable_module
|
||||
{
|
||||
function __rspamd__helper__enable_disable_module() {
|
||||
local MODULE=${1:?Module name must be provided}
|
||||
local ENABLE_MODULE=${2:-true}
|
||||
local LOCAL_OR_OVERRIDE=${3:-local}
|
||||
|
|
@ -61,8 +59,7 @@ EOF
|
|||
|
||||
# Run miscellaneous early setup tasks and checks, such as creating files needed at runtime
|
||||
# or checking for other anti-spam/anti-virus software.
|
||||
function __rspamd__run_early_setup_and_checks
|
||||
{
|
||||
function __rspamd__run_early_setup_and_checks() {
|
||||
# Note: Variables not marked with `local` are
|
||||
# used in other functions as well.
|
||||
RSPAMD_LOCAL_D='/etc/rspamd/local.d'
|
||||
|
|
@ -105,8 +102,7 @@ function __rspamd__run_early_setup_and_checks
|
|||
|
||||
# Sets up Redis. In case the user does not use a dedicated Redis instance, we
|
||||
# supply a configuration for our local Redis instance which is started later.
|
||||
function __rspamd__setup_redis
|
||||
{
|
||||
function __rspamd__setup_redis() {
|
||||
if _env_var_expect_zero_or_one 'ENABLE_RSPAMD_REDIS' && [[ ${ENABLE_RSPAMD_REDIS} -eq 1 ]]; then
|
||||
__rspamd__log 'debug' 'Internal Redis is enabled, adding configuration'
|
||||
cat >"${RSPAMD_LOCAL_D}/redis.conf" << "EOF"
|
||||
|
|
@ -136,8 +132,7 @@ EOF
|
|||
|
||||
# Adjust Postfix's configuration files. We only need to append Rspamd at the end of
|
||||
# `smtpd_milters` in `/etc/postfix/main.cf`.
|
||||
function __rspamd__setup_postfix
|
||||
{
|
||||
function __rspamd__setup_postfix() {
|
||||
__rspamd__log 'debug' "Adjusting Postfix's configuration"
|
||||
|
||||
postconf 'rspamd_milter = inet:localhost:11332'
|
||||
|
|
@ -146,8 +141,7 @@ function __rspamd__setup_postfix
|
|||
}
|
||||
|
||||
# If ClamAV is enabled, we will integrate it into Rspamd.
|
||||
function __rspamd__setup_clamav
|
||||
{
|
||||
function __rspamd__setup_clamav() {
|
||||
if _env_var_expect_zero_or_one 'ENABLE_CLAMAV' && [[ ${ENABLE_CLAMAV} -eq 1 ]]; then
|
||||
__rspamd__log 'debug' 'Enabling ClamAV integration'
|
||||
sedfile -i -E 's|^(enabled).*|\1 = true;|g' "${RSPAMD_LOCAL_D}/antivirus.conf"
|
||||
|
|
@ -169,8 +163,7 @@ function __rspamd__setup_clamav
|
|||
# We disable the modules listed in `DISABLE_MODULES` as we believe these modules
|
||||
# are not commonly used and the average user does not need them. As a consequence,
|
||||
# disabling them saves resources.
|
||||
function __rspamd__setup_default_modules
|
||||
{
|
||||
function __rspamd__setup_default_modules() {
|
||||
__rspamd__log 'debug' 'Disabling default modules'
|
||||
|
||||
# This array contains all the modules we disable by default. They
|
||||
|
|
@ -197,8 +190,7 @@ function __rspamd__setup_default_modules
|
|||
# 1. enabling auto-learn for the classifier-bayes module
|
||||
# 2. setting up sieve scripts that detect when a user is moving e-mail
|
||||
# from or to the "Junk" folder, and learning them as ham or spam.
|
||||
function __rspamd__setup_learning
|
||||
{
|
||||
function __rspamd__setup_learning() {
|
||||
if _env_var_expect_zero_or_one 'RSPAMD_LEARN' && [[ ${RSPAMD_LEARN} -eq 1 ]]; then
|
||||
__rspamd__log 'debug' 'Setting up intelligent learning of spam and ham'
|
||||
|
||||
|
|
@ -241,8 +233,7 @@ EOF
|
|||
|
||||
# Sets up greylisting with the greylisting module (see
|
||||
# https://rspamd.com/doc/modules/greylisting.html).
|
||||
function __rspamd__setup_greylisting
|
||||
{
|
||||
function __rspamd__setup_greylisting() {
|
||||
if _env_var_expect_zero_or_one 'RSPAMD_GREYLISTING' && [[ ${RSPAMD_GREYLISTING} -eq 1 ]]; then
|
||||
__rspamd__log 'debug' 'Enabling greylisting'
|
||||
sedfile -i -E "s|(enabled =).*|\1 true;|g" "${RSPAMD_LOCAL_D}/greylist.conf"
|
||||
|
|
@ -255,8 +246,7 @@ function __rspamd__setup_greylisting
|
|||
# https://www.rspamd.com/doc/modules/hfilter.html). This module is mainly
|
||||
# used for hostname checks, and whether or not a reverse-DNS check
|
||||
# succeeds.
|
||||
function __rspamd__setup_hfilter_group
|
||||
{
|
||||
function __rspamd__setup_hfilter_group() {
|
||||
local MODULE_FILE="${RSPAMD_LOCAL_D}/hfilter_group.conf"
|
||||
if _env_var_expect_zero_or_one 'RSPAMD_HFILTER' && [[ ${RSPAMD_HFILTER} -eq 1 ]]; then
|
||||
__rspamd__log 'debug' 'Hfilter (group) module is enabled'
|
||||
|
|
@ -278,8 +268,7 @@ function __rspamd__setup_hfilter_group
|
|||
# Parses `RSPAMD_CUSTOM_COMMANDS_FILE` and executed the directives given by the file.
|
||||
# To get a detailed explanation of the commands and how the file works, visit
|
||||
# https://docker-mailserver.github.io/docker-mailserver/edge/config/security/rspamd/#with-the-help-of-a-custom-file
|
||||
function __rspamd__handle_user_modules_adjustments
|
||||
{
|
||||
function __rspamd__handle_user_modules_adjustments() {
|
||||
# Adds an option with a corresponding value to a module, or, in case the option
|
||||
# is already present, overwrites it.
|
||||
#
|
||||
|
|
@ -293,8 +282,7 @@ function __rspamd__handle_user_modules_adjustments
|
|||
# While this function is currently bound to the scope of `__rspamd__handle_user_modules_adjustments`,
|
||||
# it is written in a versatile way (taking 4 arguments instead of assuming `ARGUMENT2` / `ARGUMENT3`
|
||||
# are set) so that it may be used elsewhere if needed.
|
||||
function __add_or_replace
|
||||
{
|
||||
function __add_or_replace() {
|
||||
local MODULE_FILE=${1:?Module file name must be provided}
|
||||
local MODULE_LOG_NAME=${2:?Module log name must be provided}
|
||||
local OPTION=${3:?Option name must be provided}
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
#!/bin/bash
|
||||
|
||||
function _setup_spoof_protection
|
||||
{
|
||||
function _setup_spoof_protection() {
|
||||
if [[ ${SPOOF_PROTECTION} -eq 1 ]]; then
|
||||
_log 'trace' 'Enabling and configuring spoof protection'
|
||||
|
||||
|
|
|
|||
|
|
@ -3,8 +3,7 @@
|
|||
# shellcheck disable=SC2034
|
||||
declare -A VARS
|
||||
|
||||
function _early_variables_setup
|
||||
{
|
||||
function _early_variables_setup() {
|
||||
_obtain_hostname_and_domainname
|
||||
__environment_variables_backwards_compatibility
|
||||
__environment_variables_general_setup
|
||||
|
|
@ -13,8 +12,7 @@ function _early_variables_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
|
||||
{
|
||||
function __environment_variables_backwards_compatibility() {
|
||||
if [[ ${ENABLE_LDAP:-0} -eq 1 ]]; then
|
||||
_log 'warn' "'ENABLE_LDAP=1' is deprecated (and will be removed in v13.0.0) => use 'ACCOUNT_PROVISIONER=LDAP' instead"
|
||||
ACCOUNT_PROVISIONER='LDAP'
|
||||
|
|
@ -32,8 +30,7 @@ function __environment_variables_backwards_compatibility
|
|||
# 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
|
||||
{
|
||||
function __environment_variables_general_setup() {
|
||||
_log 'debug' 'Handling general environment variable setup'
|
||||
|
||||
# these variables must be defined first
|
||||
|
|
@ -143,8 +140,7 @@ function __environment_variables_general_setup
|
|||
}
|
||||
|
||||
# This function handles environment variables related to LDAP.
|
||||
function _environment_variables_ldap
|
||||
{
|
||||
function _environment_variables_ldap() {
|
||||
_log 'debug' 'Setting LDAP-related environment variables now'
|
||||
|
||||
VARS[LDAP_BIND_DN]="${LDAP_BIND_DN:=}"
|
||||
|
|
@ -156,8 +152,7 @@ function _environment_variables_ldap
|
|||
|
||||
# This function handles environment variables related to SASLAUTHD
|
||||
# and, if activated, variables related to SASLAUTHD and LDAP.
|
||||
function _environment_variables_saslauthd
|
||||
{
|
||||
function _environment_variables_saslauthd() {
|
||||
_log 'debug' 'Setting SASLAUTHD-related environment variables now'
|
||||
|
||||
VARS[SASLAUTHD_MECHANISMS]="${SASLAUTHD_MECHANISMS:=pam}"
|
||||
|
|
@ -210,8 +205,7 @@ function _environment_variables_saslauthd
|
|||
# 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
|
||||
{
|
||||
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
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue