2022-01-26 12:16:25 +02:00
#!/usr/bin/env bash
2022-07-05 12:07:10 +02:00
############## Begin Function Section ##############
2022-01-26 12:16:25 +02:00
check_online_status( ) {
2022-11-30 18:37:33 +02:00
CHECK_ONLINE_DOMAINS = ( 'https://github.com' 'https://hub.docker.com' )
2022-11-13 08:34:18 +02:00
for domain in " ${ CHECK_ONLINE_DOMAINS [@] } " ; do
2022-12-13 12:52:04 +02:00
if timeout 6 curl --head --silent --output /dev/null ${ domain } ; then
2022-01-26 12:16:25 +02:00
return 0
fi
done
return 1
}
prefetch_images( ) {
[ [ -z ${ BRANCH } ] ] && { echo -e "\e[33m\nUnknown branch...\e[0m" ; exit 1; }
git fetch origin #${BRANCH}
while read image; do
if [ [ " ${ image } " = = "robbertkl/ipv6nat" ] ] ; then
if ! grep -qi "ipv6nat-mailcow" docker-compose.yml || grep -qi "enable_ipv6: false" docker-compose.yml; then
continue
fi
fi
RET_C = 0
until docker pull ${ image } ; do
RET_C = $(( RET_C + 1 ))
echo -e " \e[33m\nError pulling $image , retrying...\e[0m "
[ ${ RET_C } -gt 3 ] && { echo -e "\e[31m\nToo many failed retries, exiting\e[0m" ; exit 1; }
sleep 1
done
done < <( git show origin/${ BRANCH } :docker-compose.yml | grep "image:" | awk '{ gsub("image:","", $3); print $2 }' )
}
docker_garbage( ) {
2023-10-19 12:31:13 +02:00
SCRIPT_DIR = " $( cd " $( dirname " ${ BASH_SOURCE [0] } " ) " && pwd ) "
2022-01-26 12:16:25 +02:00
IMGS_TO_DELETE = ( )
2023-10-19 12:31:13 +02:00
declare -A IMAGES_INFO
COMPOSE_IMAGES = ( $( grep -oP "image: \Kmailcow.+" " ${ SCRIPT_DIR } /docker-compose.yml " ) )
for existing_image in $( docker images --format "{{.ID}}:{{.Repository}}:{{.Tag}}" | grep 'mailcow/' ) ; do
ID = $( echo $existing_image | cut -d ':' -f 1)
REPOSITORY = $( echo $existing_image | cut -d ':' -f 2)
TAG = $( echo $existing_image | cut -d ':' -f 3)
if [ [ " ${ COMPOSE_IMAGES [@] } " = ~ " ${ REPOSITORY } : ${ TAG } " ] ] ; then
continue
else
IMGS_TO_DELETE += ( " $ID " )
IMAGES_INFO[ " $ID " ] = " $REPOSITORY : $TAG "
2022-01-26 12:16:25 +02:00
fi
done
if [ [ ! -z ${ IMGS_TO_DELETE [*] } ] ] ; then
2023-10-19 12:31:13 +02:00
echo "The following unused mailcow images were found:"
for id in " ${ IMGS_TO_DELETE [@] } " ; do
echo " ${ IMAGES_INFO [ $id ] } ( $id ) "
done
if [ ! $FORCE ] ; then
read -r -p "Do you want to delete them to free up some space? [y/N] " response
if [ [ " $response " = ~ ^( [ yY] [ eE] [ sS] | [ yY] ) +$ ] ] ; then
docker rmi ${ IMGS_TO_DELETE [*] }
else
echo "OK, skipped."
fi
2022-01-26 12:16:25 +02:00
else
2023-10-19 12:31:13 +02:00
echo "Running in forced mode! Force removing old mailcow images..."
docker rmi ${ IMGS_TO_DELETE [*] }
2022-01-26 12:16:25 +02:00
fi
2023-10-19 12:31:13 +02:00
echo -e "\e[32mFurther cleanup...\e[0m"
echo "If you want to cleanup further garbage collected by Docker, please make sure all containers are up and running before cleaning your system by executing \"docker system prune\""
2022-01-26 12:16:25 +02:00
fi
}
in_array( ) {
local e match = " $1 "
shift
for e; do [ [ " $e " = = " $match " ] ] && return 0; done
return 1
}
migrate_docker_nat( ) {
NAT_CONFIG = '{"ipv6":true,"fixed-cidr-v6":"fd00:dead:beef:c0::/80","experimental":true,"ip6tables":true}'
# Min Docker version
DOCKERV_REQ = 20.10.2
# Current Docker version
DOCKERV_CUR = $( docker version -f '{{.Server.Version}}' )
if grep -qi "ipv6nat-mailcow" docker-compose.yml && grep -qi "enable_ipv6: true" docker-compose.yml; then
echo -e "\e[32mNative IPv6 implementation available.\e[0m"
echo "This will enable experimental features in the Docker daemon and configure Docker to do the IPv6 NATing instead of ipv6nat-mailcow."
echo '!!! This step is recommended !!!'
echo "mailcow will try to roll back the changes if starting Docker fails after modifying the daemon.json configuration file."
read -r -p "Should we try to enable the native IPv6 implementation in Docker now (recommended)? [y/N] " dockernatresponse
if [ [ ! " ${ dockernatresponse } " = ~ ^( [ yY] [ eE] [ sS] | [ yY] ) +$ ] ] ; then
echo "OK, skipping this step."
return 0
fi
fi
# Sort versions and check if we are running a newer or equal version to req
if [ $( printf " ${ DOCKERV_REQ } \n ${ DOCKERV_CUR } " | sort -V | tail -n1) = = " ${ DOCKERV_CUR } " ] ; then
# If Dockerd daemon json exists
if [ -s /etc/docker/daemon.json ] ; then
IFS = ',' read -r -a dockerconfig <<< $( cat /etc/docker/daemon.json | tr -cd '[:alnum:],' )
if ! in_array ipv6true " ${ dockerconfig [@] } " || \
! in_array experimentaltrue " ${ dockerconfig [@] } " || \
! in_array ip6tablestrue " ${ dockerconfig [@] } " || \
! grep -qi "fixed-cidr-v6" /etc/docker/daemon.json; then
echo -e "\e[33mWarning:\e[0m You seem to have modified the /etc/docker/daemon.json configuration by yourself and not fully/correctly activated the native IPv6 NAT implementation."
echo "You will need to merge your existing configuration manually or fix/delete the existing daemon.json configuration before trying the update process again."
echo -e "Please merge the following content and restart the Docker daemon:\n"
echo ${ NAT_CONFIG }
return 1
fi
else
echo "Working on IPv6 NAT, please wait..."
echo ${ NAT_CONFIG } > /etc/docker/daemon.json
ip6tables -F -t nat
2024-01-22 10:50:24 +02:00
[ [ -e /etc/rc.conf ] ] && rc-service docker restart || systemctl restart docker.service
2022-01-26 12:16:25 +02:00
if [ [ $? -ne 0 ] ] ; then
echo -e "\e[31mError:\e[0m Failed to activate IPv6 NAT! Reverting and exiting."
rm /etc/docker/daemon.json
2024-01-22 10:50:24 +02:00
if [ [ -e /etc/rc.conf ] ] ; then
2022-01-26 12:16:25 +02:00
rc-service docker restart
else
systemctl reset-failed docker.service
systemctl restart docker.service
fi
return 1
fi
fi
# Removing legacy container
sed -i '/ipv6nat-mailcow:$/,/^$/d' docker-compose.yml
if [ -s docker-compose.override.yml ] ; then
sed -i '/ipv6nat-mailcow:$/,/^$/d' docker-compose.override.yml
if [ [ " $( cat docker-compose.override.yml | sed '/^\s*$/d' | wc -l) " = = "2" ] ] ; then
mv docker-compose.override.yml docker-compose.override.yml_backup
fi
fi
echo -e "\e[32mGreat! \e[0mNative IPv6 NAT is active.\e[0m"
else
echo -e " \e[31mPlease upgrade Docker to version ${ DOCKERV_REQ } or above.\e[0m "
return 0
fi
}
2022-06-23 10:05:09 +02:00
remove_obsolete_nginx_ports( ) {
# Removing obsolete docker-compose.override.yml
2022-06-23 10:55:12 +02:00
for override in docker-compose.override.yml docker-compose.override.yaml; do
if [ -s $override ] ; then
if cat $override | grep nginx-mailcow > /dev/null 2>& 1; then
2022-06-24 23:10:00 +02:00
if cat $override | grep -E '(\[::])' > /dev/null 2>& 1; then
2022-06-23 10:55:12 +02:00
if cat $override | grep -w 80:80 > /dev/null 2>& 1 && cat $override | grep -w 443:443 > /dev/null 2>& 1 ; then
2022-06-24 23:10:00 +02:00
echo -e " \e[33mBacking up ${ override } to preserve custom changes...\e[0m "
echo -e "\e[33m!!! Manual Merge needed (if other overrides are set) !!!\e[0m"
sleep 3
cp $override ${ override } _backup
2022-06-23 10:55:12 +02:00
sed -i '/nginx-mailcow:$/,/^$/d' $override
2022-06-24 23:10:00 +02:00
echo -e "\e[33mRemoved obsolete NGINX IPv6 Bind from original override File.\e[0m"
2022-06-23 10:55:12 +02:00
if [ [ " $( cat $override | sed '/^\s*$/d' | wc -l) " = = "2" ] ] ; then
2022-07-08 10:54:50 +02:00
mv $override ${ override } _empty
2022-06-23 10:55:12 +02:00
echo -e " \e[31m ${ override } is empty. Renamed it to ensure mailcow is startable.\e[0m "
2022-06-23 10:05:09 +02:00
fi
fi
fi
fi
2022-06-23 10:55:12 +02:00
fi
done
2022-06-23 10:05:09 +02:00
}
2022-08-19 15:55:24 +02:00
detect_docker_compose_command( ) {
2023-03-20 13:05:11 +02:00
if ! [ [ " ${ DOCKER_COMPOSE_VERSION } " = ~ ^( native| standalone) $ ] ] ; then
2023-01-19 16:57:49 +02:00
if docker compose > /dev/null 2>& 1; then
2023-11-28 09:29:54 +02:00
if docker compose version --short | grep -e "^2." -e "^v2." > /dev/null 2>& 1; then
2023-01-19 16:57:49 +02:00
DOCKER_COMPOSE_VERSION = native
COMPOSE_COMMAND = "docker compose"
2023-10-13 15:37:37 +02:00
echo -e "\e[33mFound Docker Compose Plugin (native).\e[0m"
echo -e "\e[33mSetting the DOCKER_COMPOSE_VERSION Variable to native\e[0m"
2023-03-20 13:05:11 +02:00
sed -i 's/^DOCKER_COMPOSE_VERSION=.*/DOCKER_COMPOSE_VERSION=native/' $SCRIPT_DIR /mailcow.conf
2022-08-19 15:55:24 +02:00
sleep 2
2023-01-19 16:57:49 +02:00
echo -e "\e[33mNotice: You'll have to update this Compose Version via your Package Manager manually!\e[0m"
2022-08-19 15:55:24 +02:00
else
echo -e "\e[31mCannot find Docker Compose with a Version Higher than 2.X.X.\e[0m"
2023-04-26 10:37:20 +02:00
echo -e "\e[31mPlease update/install it manually regarding to this doc site: https://docs.mailcow.email/install/\e[0m"
2022-08-19 15:55:24 +02:00
exit 1
fi
2023-01-19 16:57:49 +02:00
elif docker-compose > /dev/null 2>& 1; then
if ! [ [ $( alias docker-compose 2> /dev/null) ] ] ; then
if docker-compose version --short | grep "^2." > /dev/null 2>& 1; then
DOCKER_COMPOSE_VERSION = standalone
COMPOSE_COMMAND = "docker-compose"
2023-10-13 15:37:37 +02:00
echo -e "\e[33mFound Docker Compose Standalone.\e[0m"
echo -e "\e[33mSetting the DOCKER_COMPOSE_VERSION Variable to standalone\e[0m"
2023-03-20 13:05:11 +02:00
sed -i 's/^DOCKER_COMPOSE_VERSION=.*/DOCKER_COMPOSE_VERSION=standalone/' $SCRIPT_DIR /mailcow.conf
2022-08-19 15:55:24 +02:00
sleep 2
2022-09-25 00:47:09 +02:00
echo -e "\e[33mNotice: For an automatic update of docker-compose please use the update_compose.sh scripts located at the helper-scripts folder.\e[0m"
2022-08-19 15:55:24 +02:00
else
echo -e "\e[31mCannot find Docker Compose with a Version Higher than 2.X.X.\e[0m"
2023-04-26 10:37:20 +02:00
echo -e "\e[31mPlease update/install regarding to this doc site: https://docs.mailcow.email/install/\e[0m"
2022-08-19 15:55:24 +02:00
exit 1
fi
2023-01-19 16:57:49 +02:00
fi
2022-08-19 15:55:24 +02:00
else
echo -e "\e[31mCannot find Docker Compose.\e[0m"
2023-04-26 10:37:20 +02:00
echo -e "\e[31mPlease install it regarding to this doc site: https://docs.mailcow.email/install/\e[0m"
2022-08-19 15:55:24 +02:00
exit 1
fi
elif [ " ${ DOCKER_COMPOSE_VERSION } " = = "native" ] ; then
COMPOSE_COMMAND = "docker compose"
2023-03-20 13:05:11 +02:00
# Check if Native Compose works and has not been deleted
if ! $COMPOSE_COMMAND > /dev/null 2>& 1; then
# IF it not exists/work anymore try the other command
COMPOSE_COMMAND = "docker-compose"
if ! $COMPOSE_COMMAND > /dev/null 2>& 1 || ! $COMPOSE_COMMAND --version | grep "^2." > /dev/null 2>& 1; then
# IF it cannot find Standalone in > 2.X, then script stops
echo -e "\e[31mCannot find Docker Compose or the Version is lower then 2.X.X.\e[0m"
2023-04-26 10:37:20 +02:00
echo -e "\e[31mPlease install it regarding to this doc site: https://docs.mailcow.email/install/\e[0m"
2023-03-20 13:05:11 +02:00
exit 1
fi
# If it finds the standalone Plugin it will use this instead and change the mailcow.conf Variable accordingly
echo -e "\e[31mFound different Docker Compose Version then declared in mailcow.conf!\e[0m"
echo -e "\e[31mSetting the DOCKER_COMPOSE_VERSION Variable from native to standalone\e[0m"
sed -i 's/^DOCKER_COMPOSE_VERSION=.*/DOCKER_COMPOSE_VERSION=standalone/' $SCRIPT_DIR /mailcow.conf
sleep 2
fi
2022-08-19 15:55:24 +02:00
elif [ " ${ DOCKER_COMPOSE_VERSION } " = = "standalone" ] ; then
COMPOSE_COMMAND = "docker-compose"
2023-03-20 13:05:11 +02:00
# Check if Standalone Compose works and has not been deleted
if ! $COMPOSE_COMMAND > /dev/null 2>& 1 && ! $COMPOSE_COMMAND --version > /dev/null 2>& 1 | grep "^2." > /dev/null 2>& 1; then
# IF it not exists/work anymore try the other command
COMPOSE_COMMAND = "docker compose"
if ! $COMPOSE_COMMAND > /dev/null 2>& 1; then
# IF it cannot find Native in > 2.X, then script stops
echo -e "\e[31mCannot find Docker Compose.\e[0m"
2023-04-26 10:37:20 +02:00
echo -e "\e[31mPlease install it regarding to this doc site: https://docs.mailcow.email/install/\e[0m"
2023-03-20 13:05:11 +02:00
exit 1
fi
# If it finds the native Plugin it will use this instead and change the mailcow.conf Variable accordingly
echo -e "\e[31mFound different Docker Compose Version then declared in mailcow.conf!\e[0m"
echo -e "\e[31mSetting the DOCKER_COMPOSE_VERSION Variable from standalone to native\e[0m"
sed -i 's/^DOCKER_COMPOSE_VERSION=.*/DOCKER_COMPOSE_VERSION=native/' $SCRIPT_DIR /mailcow.conf
sleep 2
fi
2022-08-19 15:55:24 +02:00
fi
}
2023-06-23 12:26:57 +02:00
detect_bad_asn( ) {
2023-07-28 20:27:38 +02:00
echo -e "\e[33mDetecting if your IP is listed on Spamhaus Bad ASN List...\e[0m"
2023-07-31 12:01:34 +02:00
response = $( curl --connect-timeout 15 --max-time 30 -s -o /dev/null -w "%{http_code}" "https://asn-check.mailcow.email" )
if [ " $response " -eq 503 ] ; then
2023-06-23 12:26:57 +02:00
if [ -z " $SPAMHAUS_DQS_KEY " ] ; then
2023-06-23 15:48:13 +02:00
echo -e "\e[33mYour server's public IP uses an AS that is blocked by Spamhaus to use their DNS public blocklists for Postfix.\e[0m"
echo -e "\e[33mmailcow did not detected a value for the variable SPAMHAUS_DQS_KEY inside mailcow.conf!\e[0m"
sleep 2
echo ""
echo -e "\e[33mTo use the Spamhaus DNS Blocklists again, you will need to create a FREE account for their Data Query Service (DQS) at: https://www.spamhaus.com/free-trial/sign-up-for-a-free-data-query-service-account\e[0m"
echo -e "\e[33mOnce done, enter your DQS API key in mailcow.conf and mailcow will do the rest for you!\e[0m"
2023-06-23 12:26:57 +02:00
echo ""
sleep 2
else
2023-06-23 15:48:13 +02:00
echo -e "\e[33mYour server's public IP uses an AS that is blocked by Spamhaus to use their DNS public blocklists for Postfix.\e[0m"
echo -e "\e[32mmailcow detected a Value for the variable SPAMHAUS_DQS_KEY inside mailcow.conf. Postfix will use DQS with the given API key...\e[0m"
2023-06-23 12:26:57 +02:00
fi
2023-07-28 20:27:38 +02:00
elif [ " $response " -eq 200 ] ; then
echo -e "\e[33mCheck completed! Your IP is \e[32mclean\e[0m"
elif [ " $response " -eq 429 ] ; then
echo -e "\e[33mCheck completed! \e[31mYour IP seems to be rate limited on the ASN Check service... please try again later!\e[0m"
else
echo -e "\e[31mCheck failed! \e[0mMaybe a DNS or Network problem?\e[0m"
2023-06-23 12:26:57 +02:00
fi
}
2022-07-05 12:07:10 +02:00
############## End Function Section ##############
2022-07-08 13:48:31 +02:00
# Check permissions
if [ " $( id -u) " -ne "0" ] ; then
echo "You need to be root"
exit 1
fi
SCRIPT_DIR = " $( cd " $( dirname " ${ BASH_SOURCE [0] } " ) " && pwd ) "
# Run pre-update-hook
if [ -f " ${ SCRIPT_DIR } /pre_update_hook.sh " ] ; then
bash " ${ SCRIPT_DIR } /pre_update_hook.sh "
fi
if [ [ " $( uname -r) " = ~ ^4\. 15\. 0-60 ] ] ; then
echo "DO NOT RUN mailcow ON THIS UBUNTU KERNEL!" ;
echo "Please update to 5.x or use another distribution."
exit 1
fi
if [ [ " $( uname -r) " = ~ ^4\. 4\. ] ] ; then
if grep -q Ubuntu <<< $( uname -a) ; then
echo "DO NOT RUN mailcow ON THIS UBUNTU KERNEL!"
echo "Please update to linux-generic-hwe-16.04 by running \"apt-get install --install-recommends linux-generic-hwe-16.04\""
exit 1
fi
echo "mailcow on a 4.4.x kernel is not supported. It may or may not work, please upgrade your kernel or continue at your own risk."
read -p "Press any key to continue..." < /dev/tty
fi
# Exit on error and pipefail
set -o pipefail
# Setting high dc timeout
export COMPOSE_HTTP_TIMEOUT = 600
# Add /opt/bin to PATH
PATH = $PATH :/opt/bin
umask 0022
2022-08-19 15:55:24 +02:00
# Unset COMPOSE_COMMAND and DOCKER_COMPOSE_VERSION Variable to be on the newest state.
unset COMPOSE_COMMAND
unset DOCKER_COMPOSE_VERSION
2023-07-28 20:27:38 +02:00
for bin in curl docker git awk sha1sum grep cut; do
2022-07-15 10:30:01 +02:00
if [ [ -z $( command -v ${ bin } ) ] ] ; then
2022-07-05 12:07:10 +02:00
echo " Cannot find ${ bin } , exiting... "
exit 1;
2022-07-15 10:30:01 +02:00
fi
done
2022-07-05 12:07:10 +02:00
export LC_ALL = C
DATE = $( date +%Y-%m-%d_%H_%M_%S)
BRANCH = $( cd ${ SCRIPT_DIR } ; git rev-parse --abbrev-ref HEAD)
2022-01-26 12:16:25 +02:00
while ( ( $# ) ) ; do
case " ${ 1 } " in
--check| -c)
echo "Checking remote code for updates..."
LATEST_REV = $( git ls-remote --exit-code --refs --quiet https://github.com/mailcow/mailcow-dockerized ${ BRANCH } | cut -f1)
if [ $? -ne 0 ] ; then
echo "A problem occurred while trying to fetch the latest revision from github."
exit 99
fi
if [ [ -z $( git log HEAD --pretty= format:"%H" | grep " ${ LATEST_REV } " ) ] ] ; then
echo -e "Updated code is available.\nThe changes can be found here: https://github.com/mailcow/mailcow-dockerized/commits/master"
git log --date= short --pretty= format:"%ad - %s" $( git rev-parse --short HEAD) ..origin/master
exit 0
else
echo "No updates available."
exit 3
fi
; ;
--ours)
MERGE_STRATEGY = ours
; ;
--skip-start)
SKIP_START = y
; ;
2022-08-23 14:04:40 +02:00
--skip-ping-check)
SKIP_PING_CHECK = y
; ;
--stable)
CURRENT_BRANCH = " $( cd ${ SCRIPT_DIR } ; git rev-parse --abbrev-ref HEAD) "
NEW_BRANCH = "master"
; ;
2022-01-26 12:16:25 +02:00
--gc)
echo -e "\e[32mCollecting garbage...\e[0m"
docker_garbage
exit 0
; ;
2022-08-23 14:04:40 +02:00
--nightly)
CURRENT_BRANCH = " $( cd ${ SCRIPT_DIR } ; git rev-parse --abbrev-ref HEAD) "
NEW_BRANCH = "nightly"
; ;
2022-01-26 12:16:25 +02:00
--prefetch)
echo -e "\e[32mPrefetching images...\e[0m"
prefetch_images
exit 0
; ;
-f| --force)
echo -e "\e[32mRunning in forced mode...\e[0m"
FORCE = y
; ;
2023-03-20 13:05:11 +02:00
-d| --dev)
echo -e "\e[32mRunning in Developer mode...\e[0m"
DEV = y
; ;
2022-01-26 12:16:25 +02:00
--help| -h)
2023-03-20 13:05:11 +02:00
echo ' ./update.sh [ -c| --check, --ours, --gc, --nightly, --prefetch, --skip-start, --skip-ping-check, --stable, -f| --force, -d| --dev, -h| --help]
2022-01-26 12:16:25 +02:00
-c| --check - Check for updates and exit ( exit codes = > 0: update available, 3: no updates)
--ours - Use merge strategy option "ours" to solve conflicts in favor of non-mailcow code ( local changes over remote changes) , not recommended!
--gc - Run garbage collector to delete old image tags
2022-08-23 14:04:40 +02:00
--nightly - Switch your mailcow updates to the unstable ( nightly) branch. FOR TESTING PURPOSES ONLY!!!!
2022-01-26 12:16:25 +02:00
--prefetch - Only prefetch new images and exit ( useful to prepare updates)
--skip-start - Do not start mailcow after update
2022-07-14 11:29:38 +02:00
--skip-ping-check - Skip ICMP Check to public DNS resolvers ( Use it only if you´ve blocked any ICMP Connections to your mailcow machine)
2022-08-23 14:04:40 +02:00
--stable - Switch your mailcow updates to the stable ( master) branch. Default unless you changed it with --nightly.
2022-01-26 12:16:25 +02:00
-f| --force - Force update, do not ask questions
2023-03-20 13:05:11 +02:00
-d| --dev - Enables Developer Mode ( No Checkout of update.sh for tests)
2022-01-26 12:16:25 +02:00
'
exit 1
esac
shift
done
2024-08-06 16:12:54 +02:00
[ [ ! -f mailcow.conf ] ] && { echo "mailcow.conf is missing! Is mailcow installed?" ; exit 1; }
2022-08-25 10:32:33 +02:00
chmod 600 mailcow.conf
source mailcow.conf
2022-08-25 10:27:46 +02:00
detect_docker_compose_command
2022-01-26 12:16:25 +02:00
DOTS = ${ MAILCOW_HOSTNAME //[^.] } ;
2023-09-02 02:53:55 +02:00
if [ ${# DOTS } -lt 1 ] ; then
2023-10-05 16:21:57 +02:00
echo -e " \e[31mMAILCOW_HOSTNAME ( ${ MAILCOW_HOSTNAME } ) is not a FQDN!\e[0m "
sleep 1
echo " Please change it to a FQDN and redeploy the stack with $COMPOSE_COMMAND up -d "
2022-01-26 12:16:25 +02:00
exit 1
2023-09-02 02:53:55 +02:00
elif [ [ " ${ MAILCOW_HOSTNAME : -1 } " = = "." ] ] ; then
echo " MAILCOW_HOSTNAME ( ${ MAILCOW_HOSTNAME } ) is ending with a dot. This is not a valid FQDN! "
exit 1
elif [ ${# DOTS } -eq 1 ] ; then
2023-10-05 16:21:57 +02:00
echo -e " \e[33mMAILCOW_HOSTNAME ( ${ MAILCOW_HOSTNAME } ) does not contain a Subdomain. This is not fully tested and may cause issues.\e[0m "
2023-09-02 02:53:55 +02:00
echo "Find more information about why this message exists here: https://github.com/mailcow/mailcow-dockerized/issues/1572"
read -r -p "Do you want to proceed anyway? [y/N] " response
if [ [ " $response " = ~ ^( [ yY] [ eE] [ sS] | [ yY] ) +$ ] ] ; then
echo "OK. Procceding."
else
echo "OK. Exiting."
exit 1
fi
2022-01-26 12:16:25 +02:00
fi
if grep --help 2>& 1 | head -n 1 | grep -q -i "busybox" ; then echo "BusyBox grep detected, please install gnu grep, \"apk add --no-cache --upgrade grep\"" ; exit 1; fi
# This will also cover sort
if cp --help 2>& 1 | head -n 1 | grep -q -i "busybox" ; then echo "BusyBox cp detected, please install coreutils, \"apk add --no-cache --upgrade coreutils\"" ; exit 1; fi
if sed --help 2>& 1 | head -n 1 | grep -q -i "busybox" ; then echo "BusyBox sed detected, please install gnu sed, \"apk add --no-cache --upgrade sed\"" ; exit 1; fi
CONFIG_ARRAY = (
"SKIP_LETS_ENCRYPT"
"SKIP_SOGO"
"USE_WATCHDOG"
"WATCHDOG_NOTIFY_EMAIL"
2023-01-07 17:29:43 +02:00
"WATCHDOG_NOTIFY_WEBHOOK"
"WATCHDOG_NOTIFY_WEBHOOK_BODY"
2022-01-26 12:16:25 +02:00
"WATCHDOG_NOTIFY_BAN"
2023-10-12 12:46:02 +02:00
"WATCHDOG_NOTIFY_START"
2022-01-26 12:16:25 +02:00
"WATCHDOG_EXTERNAL_CHECKS"
"WATCHDOG_SUBJECT"
"SKIP_CLAMD"
"SKIP_IP_CHECK"
"ADDITIONAL_SAN"
2024-06-10 12:33:02 +02:00
"AUTODISCOVER_SAN"
2022-01-26 12:16:25 +02:00
"DOVEADM_PORT"
"IPV4_NETWORK"
"IPV6_NETWORK"
"LOG_LINES"
"SNAT_TO_SOURCE"
"SNAT6_TO_SOURCE"
"COMPOSE_PROJECT_NAME"
2022-08-17 16:00:58 +02:00
"DOCKER_COMPOSE_VERSION"
2022-01-26 12:16:25 +02:00
"SQL_PORT"
"API_KEY"
"API_KEY_READ_ONLY"
"API_ALLOW_FROM"
"MAILDIR_GC_TIME"
"MAILDIR_SUB"
"ACL_ANYONE"
"SOLR_HEAP"
"SKIP_SOLR"
"ENABLE_SSL_SNI"
"ALLOW_ADMIN_EMAIL_LOGIN"
"SKIP_HTTP_VERIFICATION"
"SOGO_EXPIRE_SESSION"
"REDIS_PORT"
"DOVECOT_MASTER_USER"
"DOVECOT_MASTER_PASS"
"MAILCOW_PASS_SCHEME"
"ADDITIONAL_SERVER_NAMES"
"ACME_CONTACT"
"WATCHDOG_VERBOSE"
"WEBAUTHN_ONLY_TRUSTED_VENDORS"
2023-06-23 12:26:57 +02:00
"SPAMHAUS_DQS_KEY"
2024-01-18 18:07:51 +02:00
"SKIP_UNBOUND_HEALTHCHECK"
2024-01-30 11:15:33 +02:00
"DISABLE_NETFILTER_ISOLATION_RULE"
2022-01-26 12:16:25 +02:00
)
2023-06-23 12:26:57 +02:00
detect_bad_asn
2022-01-26 12:16:25 +02:00
sed -i --follow-symlinks '$a\' mailcow.conf
for option in ${ CONFIG_ARRAY [@] } ; do
if [ [ ${ option } = = "ADDITIONAL_SAN" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo " ${ option } = " >> mailcow.conf
fi
elif [ [ ${ option } = = "COMPOSE_PROJECT_NAME" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo "COMPOSE_PROJECT_NAME=mailcowdockerized" >> mailcow.conf
fi
2022-08-17 16:00:58 +02:00
elif [ [ ${ option } = = "DOCKER_COMPOSE_VERSION" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo "# Used Docker Compose version" >> mailcow.conf
echo "# Switch here between native (compose plugin) and standalone" >> mailcow.conf
echo "# For more informations take a look at the mailcow docs regarding the configuration options." >> mailcow.conf
2022-08-22 15:44:01 +02:00
echo "# Normally this should be untouched but if you decided to use either of those you can switch it manually here." >> mailcow.conf
echo "# Please be aware that at least one of those variants should be installed on your maschine or mailcow will fail." >> mailcow.conf
2022-08-17 16:00:58 +02:00
echo "" >> mailcow.conf
2022-08-19 15:55:24 +02:00
echo " DOCKER_COMPOSE_VERSION= ${ DOCKER_COMPOSE_VERSION } " >> mailcow.conf
2022-08-17 16:00:58 +02:00
fi
2022-01-26 12:16:25 +02:00
elif [ [ ${ option } = = "DOVEADM_PORT" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo "DOVEADM_PORT=127.0.0.1:19991" >> mailcow.conf
fi
elif [ [ ${ option } = = "WATCHDOG_NOTIFY_EMAIL" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo "WATCHDOG_NOTIFY_EMAIL=" >> mailcow.conf
fi
elif [ [ ${ option } = = "LOG_LINES" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Max log lines per service to keep in Redis logs' >> mailcow.conf
echo "LOG_LINES=9999" >> mailcow.conf
fi
elif [ [ ${ option } = = "IPV4_NETWORK" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Internal IPv4 /24 subnet, format n.n.n. (expands to n.n.n.0/24)' >> mailcow.conf
echo "IPV4_NETWORK=172.22.1" >> mailcow.conf
fi
elif [ [ ${ option } = = "IPV6_NETWORK" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Internal IPv6 subnet in fc00::/7' >> mailcow.conf
echo "IPV6_NETWORK=fd4d:6169:6c63:6f77::/64" >> mailcow.conf
fi
elif [ [ ${ option } = = "SQL_PORT" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Bind SQL to 127.0.0.1 on port 13306' >> mailcow.conf
echo "SQL_PORT=127.0.0.1:13306" >> mailcow.conf
fi
elif [ [ ${ option } = = "API_KEY" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Create or override API key for web UI' >> mailcow.conf
echo "#API_KEY=" >> mailcow.conf
fi
elif [ [ ${ option } = = "API_KEY_READ_ONLY" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Create or override read-only API key for web UI' >> mailcow.conf
echo "#API_KEY_READ_ONLY=" >> mailcow.conf
fi
elif [ [ ${ option } = = "API_ALLOW_FROM" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Must be set for API_KEY to be active' >> mailcow.conf
echo '# IPs only, no networks (networks can be set via UI)' >> mailcow.conf
echo "#API_ALLOW_FROM=" >> mailcow.conf
fi
elif [ [ ${ option } = = "SNAT_TO_SOURCE" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Use this IPv4 for outgoing connections (SNAT)' >> mailcow.conf
echo "#SNAT_TO_SOURCE=" >> mailcow.conf
fi
elif [ [ ${ option } = = "SNAT6_TO_SOURCE" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Use this IPv6 for outgoing connections (SNAT)' >> mailcow.conf
echo "#SNAT6_TO_SOURCE=" >> mailcow.conf
fi
elif [ [ ${ option } = = "MAILDIR_GC_TIME" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Garbage collector cleanup' >> mailcow.conf
echo '# Deleted domains and mailboxes are moved to /var/vmail/_garbage/timestamp_sanitizedstring' >> mailcow.conf
echo '# How long should objects remain in the garbage until they are being deleted? (value in minutes)' >> mailcow.conf
echo '# Check interval is hourly' >> mailcow.conf
echo 'MAILDIR_GC_TIME=1440' >> mailcow.conf
fi
elif [ [ ${ option } = = "ACL_ANYONE" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Set this to "allow" to enable the anyone pseudo user. Disabled by default.' >> mailcow.conf
echo '# When enabled, ACL can be created, that apply to "All authenticated users"' >> mailcow.conf
echo '# This should probably only be activated on mail hosts, that are used exclusivly by one organisation.' >> mailcow.conf
echo '# Otherwise a user might share data with too many other users.' >> mailcow.conf
echo 'ACL_ANYONE=disallow' >> mailcow.conf
fi
elif [ [ ${ option } = = "SOLR_HEAP" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Solr heap size, there is no recommendation, please see Solr docs.' >> mailcow.conf
echo '# Solr is a prone to run OOM on large systems and should be monitored. Unmonitored Solr setups are not recommended.' >> mailcow.conf
echo '# Solr will refuse to start with total system memory below or equal to 2 GB.' >> mailcow.conf
echo "SOLR_HEAP=1024" >> mailcow.conf
fi
elif [ [ ${ option } = = "SKIP_SOLR" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Solr is disabled by default after upgrading from non-Solr to Solr-enabled mailcows.' >> mailcow.conf
echo '# Disable Solr or if you do not want to store a readable index of your mails in solr-vol-1.' >> mailcow.conf
echo "SKIP_SOLR=y" >> mailcow.conf
fi
elif [ [ ${ option } = = "ENABLE_SSL_SNI" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Create seperate certificates for all domains - y/n' >> mailcow.conf
echo '# this will allow adding more than 100 domains, but some email clients will not be able to connect with alternative hostnames' >> mailcow.conf
echo '# see https://wiki.dovecot.org/SSL/SNIClientSupport' >> mailcow.conf
echo "ENABLE_SSL_SNI=n" >> mailcow.conf
fi
elif [ [ ${ option } = = "SKIP_SOGO" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Skip SOGo: Will disable SOGo integration and therefore webmail, DAV protocols and ActiveSync support (experimental, unsupported, not fully implemented) - y/n' >> mailcow.conf
echo "SKIP_SOGO=n" >> mailcow.conf
fi
elif [ [ ${ option } = = "MAILDIR_SUB" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# MAILDIR_SUB defines a path in a users virtual home to keep the maildir in. Leave empty for updated setups.' >> mailcow.conf
echo "#MAILDIR_SUB=Maildir" >> mailcow.conf
echo "MAILDIR_SUB=" >> mailcow.conf
fi
2023-01-07 17:29:43 +02:00
elif [ [ ${ option } = = "WATCHDOG_NOTIFY_WEBHOOK" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Send notifications to a webhook URL that receives a POST request with the content type "application/json".' >> mailcow.conf
echo '# You can use this to send notifications to services like Discord, Slack and others.' >> mailcow.conf
echo '#WATCHDOG_NOTIFY_WEBHOOK=https://discord.com/api/webhooks/XXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' >> mailcow.conf
fi
elif [ [ ${ option } = = "WATCHDOG_NOTIFY_WEBHOOK_BODY" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# JSON body included in the webhook POST request. Needs to be in single quotes.' >> mailcow.conf
echo '# Following variables are available: SUBJECT, BODY' >> mailcow.conf
2023-12-12 12:10:10 +02:00
WEBHOOK_BODY = '{"username": "mailcow Watchdog", "content": "**${SUBJECT}**\n${BODY}"}'
echo " #WATCHDOG_NOTIFY_WEBHOOK_BODY=' ${ WEBHOOK_BODY } ' " >> mailcow.conf
2023-01-07 17:29:43 +02:00
fi
2022-01-26 12:16:25 +02:00
elif [ [ ${ option } = = "WATCHDOG_NOTIFY_BAN" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Notify about banned IP. Includes whois lookup.' >> mailcow.conf
echo "WATCHDOG_NOTIFY_BAN=y" >> mailcow.conf
fi
2023-10-12 12:46:02 +02:00
elif [ [ ${ option } = = "WATCHDOG_NOTIFY_START" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Send a notification when the watchdog is started.' >> mailcow.conf
echo "WATCHDOG_NOTIFY_START=y" >> mailcow.conf
fi
2022-01-26 12:16:25 +02:00
elif [ [ ${ option } = = "WATCHDOG_SUBJECT" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Subject for watchdog mails. Defaults to "Watchdog ALERT" followed by the error message.' >> mailcow.conf
echo "#WATCHDOG_SUBJECT=" >> mailcow.conf
fi
elif [ [ ${ option } = = "WATCHDOG_EXTERNAL_CHECKS" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Checks if mailcow is an open relay. Requires a SAL. More checks will follow.' >> mailcow.conf
echo '# No data is collected. Opt-in and anonymous.' >> mailcow.conf
echo '# Will only work with unmodified mailcow setups.' >> mailcow.conf
echo "WATCHDOG_EXTERNAL_CHECKS=n" >> mailcow.conf
fi
elif [ [ ${ option } = = "SOGO_EXPIRE_SESSION" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# SOGo session timeout in minutes' >> mailcow.conf
echo "SOGO_EXPIRE_SESSION=480" >> mailcow.conf
fi
elif [ [ ${ option } = = "REDIS_PORT" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo "REDIS_PORT=127.0.0.1:7654" >> mailcow.conf
fi
elif [ [ ${ option } = = "DOVECOT_MASTER_USER" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# DOVECOT_MASTER_USER and _PASS must _both_ be provided. No special chars.' >> mailcow.conf
echo '# Empty by default to auto-generate master user and password on start.' >> mailcow.conf
echo '# User expands to DOVECOT_MASTER_USER@mailcow.local' >> mailcow.conf
echo '# LEAVE EMPTY IF UNSURE' >> mailcow.conf
echo "DOVECOT_MASTER_USER=" >> mailcow.conf
fi
elif [ [ ${ option } = = "DOVECOT_MASTER_PASS" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# LEAVE EMPTY IF UNSURE' >> mailcow.conf
echo "DOVECOT_MASTER_PASS=" >> mailcow.conf
fi
elif [ [ ${ option } = = "MAILCOW_PASS_SCHEME" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Password hash algorithm' >> mailcow.conf
echo '# Only certain password hash algorithm are supported. For a fully list of supported schemes,' >> mailcow.conf
2023-03-20 13:05:11 +02:00
echo '# see https://docs.mailcow.email/models/model-passwd/' >> mailcow.conf
2022-01-26 12:16:25 +02:00
echo "MAILCOW_PASS_SCHEME=BLF-CRYPT" >> mailcow.conf
fi
elif [ [ ${ option } = = "ADDITIONAL_SERVER_NAMES" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
2023-06-23 14:20:06 +02:00
echo " Adding new option \" ${ option } \" to mailcow.conf "
2022-01-26 12:16:25 +02:00
echo '# Additional server names for mailcow UI' >> mailcow.conf
echo '#' >> mailcow.conf
echo '# Specify alternative addresses for the mailcow UI to respond to' >> mailcow.conf
echo '# This is useful when you set mail.* as ADDITIONAL_SAN and want to make sure mail.maildomain.com will always point to the mailcow UI.' >> mailcow.conf
echo '# If the server name does not match a known site, Nginx decides by best-guess and may redirect users to the wrong web root.' >> mailcow.conf
echo '# You can understand this as server_name directive in Nginx.' >> mailcow.conf
echo '# Comma separated list without spaces! Example: ADDITIONAL_SERVER_NAMES=a.b.c,d.e.f' >> mailcow.conf
echo 'ADDITIONAL_SERVER_NAMES=' >> mailcow.conf
fi
2024-06-10 12:33:02 +02:00
elif [ [ ${ option } = = "AUTODISCOVER_SAN" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Obtain certificates for autodiscover.* and autoconfig.* domains.' >> mailcow.conf
echo '# This can be useful to switch off in case you are in a scenario where a reverse proxy already handles those.' >> mailcow.conf
echo '# There are mixed scenarios where ports 80,443 are occupied and you do not want to share certs' >> mailcow.conf
echo '# between services. So acme-mailcow obtains for maildomains and all web-things get handled' >> mailcow.conf
echo '# in the reverse proxy.' >> mailcow.conf
echo 'AUTODISCOVER_SAN=y' >> mailcow.conf
fi
2022-01-26 12:16:25 +02:00
elif [ [ ${ option } = = "ACME_CONTACT" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
2023-06-23 14:20:06 +02:00
echo " Adding new option \" ${ option } \" to mailcow.conf "
2022-01-26 12:16:25 +02:00
echo '# Lets Encrypt registration contact information' >> mailcow.conf
echo '# Optional: Leave empty for none' >> mailcow.conf
echo '# This value is only used on first order!' >> mailcow.conf
echo '# Setting it at a later point will require the following steps:' >> mailcow.conf
2023-03-20 13:05:11 +02:00
echo '# https://docs.mailcow.email/troubleshooting/debug-reset_tls/' >> mailcow.conf
2022-01-26 12:16:25 +02:00
echo 'ACME_CONTACT=' >> mailcow.conf
2023-06-23 12:26:57 +02:00
fi
2022-01-26 12:16:25 +02:00
elif [ [ ${ option } = = "WEBAUTHN_ONLY_TRUSTED_VENDORS" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
2023-06-23 14:20:06 +02:00
echo " Adding new option \" ${ option } \" to mailcow.conf "
2022-01-26 12:16:25 +02:00
echo "# WebAuthn device manufacturer verification" >> mailcow.conf
echo '# After setting WEBAUTHN_ONLY_TRUSTED_VENDORS=y only devices from trusted manufacturers are allowed' >> mailcow.conf
echo '# root certificates can be placed for validation under mailcow-dockerized/data/web/inc/lib/WebAuthn/rootCertificates' >> mailcow.conf
echo 'WEBAUTHN_ONLY_TRUSTED_VENDORS=n' >> mailcow.conf
fi
2023-06-23 12:26:57 +02:00
elif [ [ ${ option } = = "SPAMHAUS_DQS_KEY" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
2023-06-23 14:20:06 +02:00
echo " Adding new option \" ${ option } \" to mailcow.conf "
2023-06-23 12:26:57 +02:00
echo "# Spamhaus Data Query Service Key" >> mailcow.conf
2023-06-23 14:20:06 +02:00
echo '# Optional: Leave empty for none' >> mailcow.conf
2023-06-23 12:26:57 +02:00
echo '# Enter your key here if you are using a blocked ASN (OVH, AWS, Cloudflare e.g) for the unregistered Spamhaus Blocklist.' >> mailcow.conf
echo '# If empty, it will completely disable Spamhaus blocklists if it detects that you are running on a server using a blocked AS.' >> mailcow.conf
echo '# Otherwise it will work as usual.' >> mailcow.conf
echo 'SPAMHAUS_DQS_KEY=' >> mailcow.conf
fi
elif [ [ ${ option } = = "WATCHDOG_VERBOSE" ] ] ; then
2022-01-26 12:16:25 +02:00
if ! grep -q ${ option } mailcow.conf; then
2023-06-23 14:20:06 +02:00
echo " Adding new option \" ${ option } \" to mailcow.conf "
2022-01-26 12:16:25 +02:00
echo '# Enable watchdog verbose logging' >> mailcow.conf
echo 'WATCHDOG_VERBOSE=n' >> mailcow.conf
2023-06-23 12:26:57 +02:00
fi
2024-01-18 18:07:51 +02:00
elif [ [ ${ option } = = "SKIP_UNBOUND_HEALTHCHECK" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Skip Unbound (DNS Resolver) Healthchecks (NOT Recommended!) - y/n' >> mailcow.conf
echo 'SKIP_UNBOUND_HEALTHCHECK=n' >> mailcow.conf
fi
2024-01-30 11:15:33 +02:00
elif [ [ ${ option } = = "DISABLE_NETFILTER_ISOLATION_RULE" ] ] ; then
if ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo '# Prevent netfilter from setting an iptables/nftables rule to isolate the mailcow docker network - y/n' >> mailcow.conf
echo '# CAUTION: Disabling this may expose container ports to other neighbors on the same subnet, even if the ports are bound to localhost' >> mailcow.conf
echo 'DISABLE_NETFILTER_ISOLATION_RULE=n' >> mailcow.conf
fi
2022-01-26 12:16:25 +02:00
elif ! grep -q ${ option } mailcow.conf; then
echo " Adding new option \" ${ option } \" to mailcow.conf "
echo " ${ option } =n " >> mailcow.conf
fi
done
2022-04-26 10:17:47 +02:00
if [ [ ( ${ SKIP_PING_CHECK } = = "y" ) ] ] ; then
echo -e "\e[32mSkipping Ping Check...\e[0m"
2022-01-26 12:16:25 +02:00
else
2022-04-26 10:17:47 +02:00
echo -en "Checking internet connection... "
if ! check_online_status; then
echo -e "\e[31mfailed\e[0m"
exit 1
else
echo -e "\e[32mOK\e[0m"
fi
2022-01-26 12:16:25 +02:00
fi
2022-08-24 15:00:39 +02:00
if ! [ $NEW_BRANCH ] ; then
2022-08-23 14:04:40 +02:00
echo -e "\e[33mDetecting which build your mailcow runs on...\e[0m"
sleep 1
if [ ${ BRANCH } = = "master" ] ; then
echo -e "\e[32mYou are receiving stable updates (master).\e[0m"
echo -e "\e[33mTo change that run the update.sh Script one time with the --nightly parameter to switch to nightly builds.\e[0m"
elif [ ${ BRANCH } = = "nightly" ] ; then
echo -e "\e[31mYou are receiving unstable updates (nightly). These are for testing purposes only!!!\e[0m"
sleep 1
echo -e "\e[33mTo change that run the update.sh Script one time with the --stable parameter to switch to stable builds.\e[0m"
else
echo -e "\e[33mYou are receiving updates from a unsupported branch.\e[0m"
sleep 1
echo -e "\e[33mThe mailcow stack might still work but it is recommended to switch to the master branch (stable builds).\e[0m"
echo -e "\e[33mTo change that run the update.sh Script one time with the --stable parameter to switch to stable builds.\e[0m"
fi
2022-08-24 15:05:14 +02:00
elif [ $FORCE ] ; then
2022-08-24 15:00:39 +02:00
echo -e "\e[31mYou are running in forced mode!\e[0m"
echo -e "\e[31mA Branch Switch can only be performed manually (monitored).\e[0m"
echo -e "\e[31mPlease rerun the update.sh Script without the --force/-f parameter.\e[0m"
sleep 1
2022-08-24 14:42:31 +02:00
elif [ $NEW_BRANCH = = "master" ] && [ $CURRENT_BRANCH != "master" ] ; then
2022-08-23 14:04:40 +02:00
echo -e "\e[33mYou are about to switch your mailcow Updates to the stable (master) branch.\e[0m"
sleep 1
echo -e "\e[33mBefore you do: Please take a backup of all components to ensure that no Data is lost...\e[0m"
sleep 1
echo -e " \e[31mWARNING: Please see on GitHub or ask in the communitys if a switch to master is stable or not.
In some rear cases a Update back to master can destroy your mailcow configuration in case of Database Upgrades etc.
2022-08-24 15:00:39 +02:00
Normally a upgrade back to master should be safe during each full release.
Check GitHub for Database Changes and Update only if there similar to the full release!\e [ 0m"
2022-08-23 14:04:40 +02:00
read -r -p "Are you sure you that want to continue upgrading to the stable (master) branch? [y/N] " response
if [ [ ! " ${ response } " = ~ ^( [ yY] [ eE] [ sS] | [ yY] ) +$ ] ] ; then
echo "OK. If you prepared yourself for that please run the update.sh Script with the --stable parameter again to trigger this process here."
exit 0
fi
2022-08-24 15:56:02 +02:00
BRANCH = $NEW_BRANCH
2022-08-23 14:04:40 +02:00
DIFF_DIRECTORY = update_diffs
DIFF_FILE = ${ DIFF_DIRECTORY } /diff_before_upgrade_to_master_$( date +"%Y-%m-%d-%H-%M-%S" )
mv diff_before_upgrade* ${ DIFF_DIRECTORY } / 2> /dev/null
if ! git diff-index --quiet HEAD; then
echo -e " \e[32mSaving diff to ${ DIFF_FILE } ...\e[0m "
mkdir -p ${ DIFF_DIRECTORY }
git diff ${ BRANCH } --stat > ${ DIFF_FILE }
git diff ${ BRANCH } >> ${ DIFF_FILE }
fi
echo -e " \e[32mSwitching Branch to ${ BRANCH } ...\e[0m "
2022-08-24 16:16:38 +02:00
git fetch origin
2022-08-24 15:56:02 +02:00
git checkout -f ${ BRANCH }
2022-08-23 14:04:40 +02:00
2022-08-24 14:42:31 +02:00
elif [ $NEW_BRANCH = = "nightly" ] && [ $CURRENT_BRANCH != "nightly" ] ; then
2022-08-23 14:04:40 +02:00
echo -e "\e[33mYou are about to switch your mailcow Updates to the unstable (nightly) branch.\e[0m"
sleep 1
echo -e "\e[33mBefore you do: Please take a backup of all components to ensure that no Data is lost...\e[0m"
sleep 1
2022-08-24 15:00:39 +02:00
echo -e "\e[31mWARNING: A switch to nightly is possible any time. But a switch back (to master) isn't.\e[0m"
2022-08-23 14:04:40 +02:00
read -r -p "Are you sure you that want to continue upgrading to the unstable (nightly) branch? [y/N] " response
if [ [ ! " ${ response } " = ~ ^( [ yY] [ eE] [ sS] | [ yY] ) +$ ] ] ; then
echo "OK. If you prepared yourself for that please run the update.sh Script with the --nightly parameter again to trigger this process here."
exit 0
fi
2022-08-24 15:56:02 +02:00
BRANCH = $NEW_BRANCH
2022-08-23 14:04:40 +02:00
DIFF_DIRECTORY = update_diffs
DIFF_FILE = ${ DIFF_DIRECTORY } /diff_before_upgrade_to_nightly_$( date +"%Y-%m-%d-%H-%M-%S" )
mv diff_before_upgrade* ${ DIFF_DIRECTORY } / 2> /dev/null
if ! git diff-index --quiet HEAD; then
echo -e " \e[32mSaving diff to ${ DIFF_FILE } ...\e[0m "
mkdir -p ${ DIFF_DIRECTORY }
git diff ${ BRANCH } --stat > ${ DIFF_FILE }
git diff ${ BRANCH } >> ${ DIFF_FILE }
fi
2022-08-24 16:16:38 +02:00
git fetch origin
2022-08-24 15:56:02 +02:00
git checkout -f ${ BRANCH }
2022-08-23 14:04:40 +02:00
fi
2023-03-20 13:05:11 +02:00
if [ ! $DEV ] ; then
echo -e "\e[32mChecking for newer update script...\e[0m"
SHA1_1 = $( sha1sum update.sh)
git fetch origin #${BRANCH}
git checkout origin/${ BRANCH } update.sh
SHA1_2 = $( sha1sum update.sh)
if [ [ ${ SHA1_1 } != ${ SHA1_2 } ] ] ; then
echo "update.sh changed, please run this script again, exiting."
chmod +x update.sh
exit 2
fi
2022-08-25 14:48:38 +02:00
fi
2022-01-26 12:16:25 +02:00
if [ ! $FORCE ] ; then
read -r -p "Are you sure you want to update mailcow: dockerized? All containers will be stopped. [y/N] " response
if [ [ ! " ${ response } " = ~ ^( [ yY] [ eE] [ sS] | [ yY] ) +$ ] ] ; then
echo "OK, exiting."
exit 0
fi
migrate_docker_nat
fi
2022-06-23 10:05:09 +02:00
remove_obsolete_nginx_ports
2022-01-26 12:16:25 +02:00
echo -e "\e[32mValidating docker-compose stack configuration...\e[0m"
2022-06-23 15:41:48 +02:00
sed -i 's/HTTPS_BIND:-:/HTTPS_BIND:-/g' docker-compose.yml
sed -i 's/HTTP_BIND:-:/HTTP_BIND:-/g' docker-compose.yml
2022-08-17 16:00:58 +02:00
if ! $COMPOSE_COMMAND config -q; then
2022-01-26 12:16:25 +02:00
echo -e "\e[31m\nOh no, something went wrong. Please check the error message above.\e[0m"
exit 1
fi
echo -e "\e[32mChecking for conflicting bridges...\e[0m"
2022-08-17 16:00:58 +02:00
MAILCOW_BRIDGE = $( $COMPOSE_COMMAND config | grep -i com.docker.network.bridge.name | cut -d':' -f2)
2022-01-26 12:16:25 +02:00
while read NAT_ID; do
iptables -t nat -D POSTROUTING $NAT_ID
done < <( iptables -L -vn -t nat --line-numbers | grep $IPV4_NETWORK | grep -E 'MASQUERADE.*all' | grep -v ${ MAILCOW_BRIDGE } | cut -d' ' -f1)
DIFF_DIRECTORY = update_diffs
DIFF_FILE = ${ DIFF_DIRECTORY } /diff_before_update_$( date +"%Y-%m-%d-%H-%M-%S" )
mv diff_before_update* ${ DIFF_DIRECTORY } / 2> /dev/null
if ! git diff-index --quiet HEAD; then
echo -e " \e[32mSaving diff to ${ DIFF_FILE } ...\e[0m "
mkdir -p ${ DIFF_DIRECTORY }
git diff --stat > ${ DIFF_FILE }
git diff >> ${ DIFF_FILE }
fi
echo -e "\e[32mPrefetching images...\e[0m"
prefetch_images
echo -e "\e[32mStopping mailcow...\e[0m"
sleep 2
2022-08-17 16:00:58 +02:00
MAILCOW_CONTAINERS = ( $( $COMPOSE_COMMAND ps -q) )
$COMPOSE_COMMAND down
2022-01-26 12:16:25 +02:00
echo -e "\e[32mChecking for remaining containers...\e[0m"
sleep 2
for container in " ${ MAILCOW_CONTAINERS [@] } " ; do
docker rm -f " $container " 2> /dev/null
done
[ [ -f data/conf/nginx/ZZZ-ejabberd.conf ] ] && rm data/conf/nginx/ZZZ-ejabberd.conf
2023-09-11 21:39:07 +02:00
2022-01-26 12:16:25 +02:00
# Silently fixing remote url from andryyy to mailcow
2023-09-11 20:08:42 +02:00
# git remote set-url origin https://github.com/mailcow/mailcow-dockerized
2023-09-11 21:39:07 +02:00
DEFAULT_REPO = https://github.com/mailcow/mailcow-dockerized
2023-10-12 15:55:53 +02:00
CURRENT_REPO = $( git config --get remote.origin.url)
2023-09-11 21:43:52 +02:00
if [ " $CURRENT_REPO " != " $DEFAULT_REPO " ] ; then
2023-09-11 21:39:07 +02:00
echo "The Repository currently used is not the default Mailcow Repository."
echo " Currently Repository: $CURRENT_REPO "
echo " Default Repository: $DEFAULT_REPO "
2023-11-21 16:37:53 +02:00
if [ ! $FORCE ] ; then
read -r -p "Should it be changed back to default? [y/N] " repo_response
if [ [ " $repo_response " = ~ ^( [ yY] [ eE] [ sS] | [ yY] ) +$ ] ] ; then
git remote set-url origin $DEFAULT_REPO
fi
else
echo "Running in forced mode... setting Repo to default!"
git remote set-url origin $DEFAULT_REPO
2023-09-11 21:39:07 +02:00
fi
fi
2023-10-19 12:14:27 +02:00
if [ ! $DEV ] ; then
echo -e "\e[32mCommitting current status...\e[0m"
[ [ -z " $( git config user.name) " ] ] && git config user.name moo
[ [ -z " $( git config user.email) " ] ] && git config user.email moo@cow.moo
[ [ ! -z $( git ls-files data/conf/rspamd/override.d/worker-controller-password.inc) ] ] && git rm data/conf/rspamd/override.d/worker-controller-password.inc
git add -u
git commit -am " Before update on ${ DATE } " > /dev/null
echo -e "\e[32mFetching updated code from remote...\e[0m"
git fetch origin #${BRANCH}
echo -e " \e[32mMerging local with remote code (recursive, strategy: \" ${ MERGE_STRATEGY :- theirs } \", options: \"patience\"...\e[0m "
git config merge.defaultToUpstream true
git merge -X${ MERGE_STRATEGY :- theirs } -Xpatience -m " After update on ${ DATE } "
# Need to use a variable to not pass return codes of if checks
MERGE_RETURN = $?
if [ [ ${ MERGE_RETURN } = = 128 ] ] ; then
echo -e "\e[31m\nOh no, what happened?\n=> You most likely added files to your local mailcow instance that were now added to the official mailcow repository. Please move them to another location before updating mailcow.\e[0m"
exit 1
elif [ [ ${ MERGE_RETURN } = = 1 ] ] ; then
echo -e "\e[93mPotenial conflict, trying to fix...\e[0m"
git status --porcelain | grep -E "UD|DU" | awk '{print $2}' | xargs rm -v
git add -A
git commit -m " After update on ${ DATE } " > /dev/null
git checkout .
echo -e "\e[32mRemoved and recreated files if necessary.\e[0m"
elif [ [ ${ MERGE_RETURN } != 0 ] ] ; then
echo -e "\e[31m\nOh no, something went wrong. Please check the error message above.\e[0m"
echo
echo " Run $COMPOSE_COMMAND up -d to restart your stack without updates or try again after fixing the mentioned errors. "
exit 1
fi
elif [ $DEV ] ; then
echo -e "\e[33mDEVELOPER MODE: Not creating a git diff and commiting it to prevent development stuff within a backup diff...\e[0m"
2022-01-26 12:16:25 +02:00
fi
echo -e "\e[32mFetching new images, if any...\e[0m"
sleep 2
2022-08-17 16:00:58 +02:00
$COMPOSE_COMMAND pull
2022-01-26 12:16:25 +02:00
# Fix missing SSL, does not overwrite existing files
[ [ ! -d data/assets/ssl ] ] && mkdir -p data/assets/ssl
cp -n -d data/assets/ssl-example/*.pem data/assets/ssl/
echo -e "Checking IPv6 settings... "
if grep -q 'SYSCTL_IPV6_DISABLED=1' mailcow.conf; then
echo
echo '!! IMPORTANT !!'
echo
echo 'SYSCTL_IPV6_DISABLED was removed due to complications. IPv6 can be disabled by editing "docker-compose.yml" and setting "enable_ipv6: true" to "enable_ipv6: false".'
2023-06-01 15:27:00 +02:00
echo " This setting will only be active after a complete shutdown of mailcow by running $COMPOSE_COMMAND down followed by $COMPOSE_COMMAND up -d. "
2022-01-26 12:16:25 +02:00
echo
echo '!! IMPORTANT !!'
echo
read -p "Press any key to continue..." < /dev/tty
fi
# Checking for old project name bug
sed -i --follow-symlinks 's#COMPOSEPROJECT_NAME#COMPOSE_PROJECT_NAME#g' mailcow.conf
# Fix Rspamd maps
if [ -f data/conf/rspamd/custom/global_from_blacklist.map ] ; then
mv data/conf/rspamd/custom/global_from_blacklist.map data/conf/rspamd/custom/global_smtp_from_blacklist.map
fi
if [ -f data/conf/rspamd/custom/global_from_whitelist.map ] ; then
mv data/conf/rspamd/custom/global_from_whitelist.map data/conf/rspamd/custom/global_smtp_from_whitelist.map
fi
# Fix deprecated metrics.conf
if [ -f "data/conf/rspamd/local.d/metrics.conf" ] ; then
if [ ! -z " $( git diff --name-only origin/master data/conf/rspamd/local.d/metrics.conf) " ] ; then
echo -e "\e[33mWARNING\e[0m - Please migrate your customizations of data/conf/rspamd/local.d/metrics.conf to actions.conf and groups.conf after this update."
echo "The deprecated configuration file metrics.conf will be moved to metrics.conf_deprecated after updating mailcow."
fi
mv data/conf/rspamd/local.d/metrics.conf data/conf/rspamd/local.d/metrics.conf_deprecated
fi
# Set app_info.inc.php
2022-08-23 14:04:40 +02:00
if [ ${ BRANCH } = = "master" ] ; then
mailcow_git_version = $( git describe --tags ` git rev-list --tags --max-count= 1` )
elif [ ${ BRANCH } = = "nightly" ] ; then
2022-08-24 16:26:07 +02:00
mailcow_git_version = $( git rev-parse --short $( git rev-parse @{ upstream} ) )
2022-08-24 14:31:32 +02:00
mailcow_last_git_version = ""
2022-08-23 14:04:40 +02:00
else
mailcow_git_version = $( git rev-parse --short HEAD)
2022-08-24 14:31:32 +02:00
mailcow_last_git_version = ""
2022-08-23 14:04:40 +02:00
fi
2022-08-24 16:12:36 +02:00
mailcow_git_commit = $( git rev-parse origin/${ BRANCH } )
2022-08-25 10:07:42 +02:00
mailcow_git_commit_date = $( git log -1 --format= %ci @{ upstream} )
2022-08-23 14:04:40 +02:00
2022-01-26 12:16:25 +02:00
if [ $? -eq 0 ] ; then
echo '<?php' > data/web/inc/app_info.inc.php
echo ' $MAILCOW_GIT_VERSION="' $mailcow_git_version '";' >> data/web/inc/app_info.inc.php
2022-08-23 14:04:40 +02:00
echo ' $MAILCOW_LAST_GIT_VERSION="";' >> data/web/inc/app_info.inc.php
echo ' $MAILCOW_GIT_OWNER="mailcow";' >> data/web/inc/app_info.inc.php
echo ' $MAILCOW_GIT_REPO="mailcow-dockerized";' >> data/web/inc/app_info.inc.php
2022-03-06 00:27:36 +02:00
echo ' $MAILCOW_GIT_URL="https://github.com/mailcow/mailcow-dockerized";' >> data/web/inc/app_info.inc.php
2022-08-23 14:04:40 +02:00
echo ' $MAILCOW_GIT_COMMIT="' $mailcow_git_commit '";' >> data/web/inc/app_info.inc.php
echo ' $MAILCOW_GIT_COMMIT_DATE="' $mailcow_git_commit_date '";' >> data/web/inc/app_info.inc.php
echo ' $MAILCOW_BRANCH="' $BRANCH '";' >> data/web/inc/app_info.inc.php
echo ' $MAILCOW_UPDATEDAT=' $( date +%s) ';' >> data/web/inc/app_info.inc.php
2022-01-26 12:16:25 +02:00
echo '?>' >> data/web/inc/app_info.inc.php
else
echo '<?php' > data/web/inc/app_info.inc.php
2022-08-23 14:04:40 +02:00
echo ' $MAILCOW_GIT_VERSION="' $mailcow_git_version '";' >> data/web/inc/app_info.inc.php
echo ' $MAILCOW_LAST_GIT_VERSION="";' >> data/web/inc/app_info.inc.php
echo ' $MAILCOW_GIT_OWNER="mailcow";' >> data/web/inc/app_info.inc.php
echo ' $MAILCOW_GIT_REPO="mailcow-dockerized";' >> data/web/inc/app_info.inc.php
echo ' $MAILCOW_GIT_URL="https://github.com/mailcow/mailcow-dockerized";' >> data/web/inc/app_info.inc.php
echo ' $MAILCOW_GIT_COMMIT="";' >> data/web/inc/app_info.inc.php
echo ' $MAILCOW_GIT_COMMIT_DATE="";' >> data/web/inc/app_info.inc.php
echo ' $MAILCOW_BRANCH="' $BRANCH '";' >> data/web/inc/app_info.inc.php
echo ' $MAILCOW_UPDATEDAT=' $( date +%s) ';' >> data/web/inc/app_info.inc.php
2022-01-26 12:16:25 +02:00
echo '?>' >> data/web/inc/app_info.inc.php
echo -e "\e[33mCannot determine current git repository version...\e[0m"
fi
if [ [ ${ SKIP_START } = = "y" ] ] ; then
2022-08-17 16:00:58 +02:00
echo -e " \e[33mNot starting mailcow, please run \" $COMPOSE_COMMAND up -d --remove-orphans\" to start mailcow.\e[0m "
2022-01-26 12:16:25 +02:00
else
echo -e "\e[32mStarting mailcow...\e[0m"
sleep 2
2022-08-17 16:00:58 +02:00
$COMPOSE_COMMAND up -d --remove-orphans
2022-01-26 12:16:25 +02:00
fi
echo -e "\e[32mCollecting garbage...\e[0m"
docker_garbage
# Run post-update-hook
if [ -f " ${ SCRIPT_DIR } /post_update_hook.sh " ] ; then
bash " ${ SCRIPT_DIR } /post_update_hook.sh "
fi
2022-08-24 16:26:07 +02:00
# echo "In case you encounter any problem, hard-reset to a state before updating mailcow:"
# echo
# git reflog --color=always | grep "Before update on "
# echo
2023-09-11 20:08:42 +02:00
# echo "Use \"git reset --hard hash-on-the-left\" and run $COMPOSE_COMMAND up -d afterwards."