update.sh 51 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120
  1. #!/usr/bin/env bash
  2. ############## Begin Function Section ##############
  3. check_online_status() {
  4. CHECK_ONLINE_DOMAINS=('https://github.com' 'https://hub.docker.com')
  5. for domain in "${CHECK_ONLINE_DOMAINS[@]}"; do
  6. if timeout 6 curl --head --silent --output /dev/null ${domain}; then
  7. return 0
  8. fi
  9. done
  10. return 1
  11. }
  12. prefetch_images() {
  13. [[ -z ${BRANCH} ]] && { echo -e "\e[33m\nUnknown branch...\e[0m"; exit 1; }
  14. git fetch origin #${BRANCH}
  15. while read image; do
  16. if [[ "${image}" == "robbertkl/ipv6nat" ]]; then
  17. if ! grep -qi "ipv6nat-mailcow" docker-compose.yml || grep -qi "enable_ipv6: false" docker-compose.yml; then
  18. continue
  19. fi
  20. fi
  21. RET_C=0
  22. until docker pull "${image}"; do
  23. RET_C=$((RET_C + 1))
  24. echo -e "\e[33m\nError pulling $image, retrying...\e[0m"
  25. [ ${RET_C} -gt 3 ] && { echo -e "\e[31m\nToo many failed retries, exiting\e[0m"; exit 1; }
  26. sleep 1
  27. done
  28. done < <(git show "origin/${BRANCH}:docker-compose.yml" | grep "image:" | awk '{ gsub("image:","", $3); print $2 }')
  29. }
  30. docker_garbage() {
  31. SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
  32. IMGS_TO_DELETE=()
  33. declare -A IMAGES_INFO
  34. COMPOSE_IMAGES=($(grep -oP "image: \Kmailcow.+" "${SCRIPT_DIR}/docker-compose.yml"))
  35. for existing_image in $(docker images --format "{{.ID}}:{{.Repository}}:{{.Tag}}" | grep 'mailcow/'); do
  36. ID=$(echo "$existing_image" | cut -d ':' -f 1)
  37. REPOSITORY=$(echo "$existing_image" | cut -d ':' -f 2)
  38. TAG=$(echo "$existing_image" | cut -d ':' -f 3)
  39. if [[ " ${COMPOSE_IMAGES[@]} " =~ " ${REPOSITORY}:${TAG} " ]]; then
  40. continue
  41. else
  42. IMGS_TO_DELETE+=("$ID")
  43. IMAGES_INFO["$ID"]="$REPOSITORY:$TAG"
  44. fi
  45. done
  46. if [[ ! -z ${IMGS_TO_DELETE[*]} ]]; then
  47. echo "The following unused mailcow images were found:"
  48. for id in "${IMGS_TO_DELETE[@]}"; do
  49. echo " ${IMAGES_INFO[$id]} ($id)"
  50. done
  51. if [ ! $FORCE ]; then
  52. read -r -p "Do you want to delete them to free up some space? [y/N] " response
  53. if [[ "$response" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  54. docker rmi ${IMGS_TO_DELETE[*]}
  55. else
  56. echo "OK, skipped."
  57. fi
  58. else
  59. echo "Running in forced mode! Force removing old mailcow images..."
  60. docker rmi ${IMGS_TO_DELETE[*]}
  61. fi
  62. echo -e "\e[32mFurther cleanup...\e[0m"
  63. 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\""
  64. fi
  65. }
  66. in_array() {
  67. local e match="$1"
  68. shift
  69. for e; do [[ "$e" == "$match" ]] && return 0; done
  70. return 1
  71. }
  72. migrate_docker_nat() {
  73. NAT_CONFIG='{"ipv6":true,"fixed-cidr-v6":"fd00:dead:beef:c0::/80","experimental":true,"ip6tables":true}'
  74. # Min Docker version
  75. DOCKERV_REQ=20.10.2
  76. # Current Docker version
  77. DOCKERV_CUR=$(docker version -f '{{.Server.Version}}')
  78. if grep -qi "ipv6nat-mailcow" docker-compose.yml && grep -qi "enable_ipv6: true" docker-compose.yml; then
  79. echo -e "\e[32mNative IPv6 implementation available.\e[0m"
  80. echo "This will enable experimental features in the Docker daemon and configure Docker to do the IPv6 NATing instead of ipv6nat-mailcow."
  81. echo '!!! This step is recommended !!!'
  82. echo "mailcow will try to roll back the changes if starting Docker fails after modifying the daemon.json configuration file."
  83. read -r -p "Should we try to enable the native IPv6 implementation in Docker now (recommended)? [y/N] " dockernatresponse
  84. if [[ ! "${dockernatresponse}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  85. echo "OK, skipping this step."
  86. return 0
  87. fi
  88. fi
  89. # Sort versions and check if we are running a newer or equal version to req
  90. if [ $(printf "${DOCKERV_REQ}\n${DOCKERV_CUR}" | sort -V | tail -n1) == "${DOCKERV_CUR}" ]; then
  91. # If Dockerd daemon json exists
  92. if [ -s /etc/docker/daemon.json ]; then
  93. IFS=',' read -r -a dockerconfig <<< $(cat /etc/docker/daemon.json | tr -cd '[:alnum:],')
  94. if ! in_array ipv6true "${dockerconfig[@]}" || \
  95. ! in_array experimentaltrue "${dockerconfig[@]}" || \
  96. ! in_array ip6tablestrue "${dockerconfig[@]}" || \
  97. ! grep -qi "fixed-cidr-v6" /etc/docker/daemon.json; then
  98. 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."
  99. echo "You will need to merge your existing configuration manually or fix/delete the existing daemon.json configuration before trying the update process again."
  100. echo -e "Please merge the following content and restart the Docker daemon:\n"
  101. echo "${NAT_CONFIG}"
  102. return 1
  103. fi
  104. else
  105. echo "Working on IPv6 NAT, please wait..."
  106. echo "${NAT_CONFIG}" > /etc/docker/daemon.json
  107. ip6tables -F -t nat
  108. [[ -e /etc/rc.conf ]] && rc-service docker restart || systemctl restart docker.service
  109. if [[ $? -ne 0 ]]; then
  110. echo -e "\e[31mError:\e[0m Failed to activate IPv6 NAT! Reverting and exiting."
  111. rm /etc/docker/daemon.json
  112. if [[ -e /etc/rc.conf ]]; then
  113. rc-service docker restart
  114. else
  115. systemctl reset-failed docker.service
  116. systemctl restart docker.service
  117. fi
  118. return 1
  119. fi
  120. fi
  121. # Removing legacy container
  122. sed -i '/ipv6nat-mailcow:$/,/^$/d' docker-compose.yml
  123. if [ -s docker-compose.override.yml ]; then
  124. sed -i '/ipv6nat-mailcow:$/,/^$/d' docker-compose.override.yml
  125. if [[ "$(cat docker-compose.override.yml | sed '/^\s*$/d' | wc -l)" == "2" ]]; then
  126. mv docker-compose.override.yml docker-compose.override.yml_backup
  127. fi
  128. fi
  129. echo -e "\e[32mGreat! \e[0mNative IPv6 NAT is active.\e[0m"
  130. else
  131. echo -e "\e[31mPlease upgrade Docker to version ${DOCKERV_REQ} or above.\e[0m"
  132. return 0
  133. fi
  134. }
  135. remove_obsolete_nginx_ports() {
  136. # Removing obsolete docker-compose.override.yml
  137. for override in docker-compose.override.yml docker-compose.override.yaml; do
  138. if [ -s $override ] ; then
  139. if cat $override | grep nginx-mailcow > /dev/null 2>&1; then
  140. if cat $override | grep -E '(\[::])' > /dev/null 2>&1; then
  141. if cat $override | grep -w 80:80 > /dev/null 2>&1 && cat $override | grep -w 443:443 > /dev/null 2>&1 ; then
  142. echo -e "\e[33mBacking up ${override} to preserve custom changes...\e[0m"
  143. echo -e "\e[33m!!! Manual Merge needed (if other overrides are set) !!!\e[0m"
  144. sleep 3
  145. cp $override ${override}_backup
  146. sed -i '/nginx-mailcow:$/,/^$/d' $override
  147. echo -e "\e[33mRemoved obsolete NGINX IPv6 Bind from original override File.\e[0m"
  148. if [[ "$(cat $override | sed '/^\s*$/d' | wc -l)" == "2" ]]; then
  149. mv $override ${override}_empty
  150. echo -e "\e[31m${override} is empty. Renamed it to ensure mailcow is startable.\e[0m"
  151. fi
  152. fi
  153. fi
  154. fi
  155. fi
  156. done
  157. }
  158. detect_docker_compose_command(){
  159. if ! [[ "${DOCKER_COMPOSE_VERSION}" =~ ^(native|standalone)$ ]]; then
  160. if docker compose > /dev/null 2>&1; then
  161. if docker compose version --short | grep -e "^2." -e "^v2." > /dev/null 2>&1; then
  162. DOCKER_COMPOSE_VERSION=native
  163. COMPOSE_COMMAND="docker compose"
  164. echo -e "\e[33mFound Docker Compose Plugin (native).\e[0m"
  165. echo -e "\e[33mSetting the DOCKER_COMPOSE_VERSION Variable to native\e[0m"
  166. sed -i 's/^DOCKER_COMPOSE_VERSION=.*/DOCKER_COMPOSE_VERSION=native/' "$SCRIPT_DIR/mailcow.conf"
  167. sleep 2
  168. echo -e "\e[33mNotice: You'll have to update this Compose Version via your Package Manager manually!\e[0m"
  169. else
  170. echo -e "\e[31mCannot find Docker Compose with a Version Higher than 2.X.X.\e[0m"
  171. echo -e "\e[31mPlease update/install it manually regarding to this doc site: https://docs.mailcow.email/install/\e[0m"
  172. exit 1
  173. fi
  174. elif docker-compose > /dev/null 2>&1; then
  175. if ! [[ $(alias docker-compose 2> /dev/null) ]] ; then
  176. if docker-compose version --short | grep "^2." > /dev/null 2>&1; then
  177. DOCKER_COMPOSE_VERSION=standalone
  178. COMPOSE_COMMAND="docker-compose"
  179. echo -e "\e[33mFound Docker Compose Standalone.\e[0m"
  180. echo -e "\e[33mSetting the DOCKER_COMPOSE_VERSION Variable to standalone\e[0m"
  181. sed -i 's/^DOCKER_COMPOSE_VERSION=.*/DOCKER_COMPOSE_VERSION=standalone/' "$SCRIPT_DIR/mailcow.conf"
  182. sleep 2
  183. 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"
  184. else
  185. echo -e "\e[31mCannot find Docker Compose with a Version Higher than 2.X.X.\e[0m"
  186. echo -e "\e[31mPlease update/install regarding to this doc site: https://docs.mailcow.email/install/\e[0m"
  187. exit 1
  188. fi
  189. fi
  190. else
  191. echo -e "\e[31mCannot find Docker Compose.\e[0m"
  192. echo -e "\e[31mPlease install it regarding to this doc site: https://docs.mailcow.email/install/\e[0m"
  193. exit 1
  194. fi
  195. elif [ "${DOCKER_COMPOSE_VERSION}" == "native" ]; then
  196. COMPOSE_COMMAND="docker compose"
  197. # Check if Native Compose works and has not been deleted
  198. if ! $COMPOSE_COMMAND > /dev/null 2>&1; then
  199. # IF it not exists/work anymore try the other command
  200. COMPOSE_COMMAND="docker-compose"
  201. if ! $COMPOSE_COMMAND > /dev/null 2>&1 || ! $COMPOSE_COMMAND --version | grep "^2." > /dev/null 2>&1; then
  202. # IF it cannot find Standalone in > 2.X, then script stops
  203. echo -e "\e[31mCannot find Docker Compose or the Version is lower then 2.X.X.\e[0m"
  204. echo -e "\e[31mPlease install it regarding to this doc site: https://docs.mailcow.email/install/\e[0m"
  205. exit 1
  206. fi
  207. # If it finds the standalone Plugin it will use this instead and change the mailcow.conf Variable accordingly
  208. echo -e "\e[31mFound different Docker Compose Version then declared in mailcow.conf!\e[0m"
  209. echo -e "\e[31mSetting the DOCKER_COMPOSE_VERSION Variable from native to standalone\e[0m"
  210. sed -i 's/^DOCKER_COMPOSE_VERSION=.*/DOCKER_COMPOSE_VERSION=standalone/' "$SCRIPT_DIR/mailcow.conf"
  211. sleep 2
  212. fi
  213. elif [ "${DOCKER_COMPOSE_VERSION}" == "standalone" ]; then
  214. COMPOSE_COMMAND="docker-compose"
  215. # Check if Standalone Compose works and has not been deleted
  216. if ! $COMPOSE_COMMAND > /dev/null 2>&1 && ! $COMPOSE_COMMAND --version > /dev/null 2>&1 | grep "^2." > /dev/null 2>&1; then
  217. # IF it not exists/work anymore try the other command
  218. COMPOSE_COMMAND="docker compose"
  219. if ! $COMPOSE_COMMAND > /dev/null 2>&1; then
  220. # IF it cannot find Native in > 2.X, then script stops
  221. echo -e "\e[31mCannot find Docker Compose.\e[0m"
  222. echo -e "\e[31mPlease install it regarding to this doc site: https://docs.mailcow.email/install/\e[0m"
  223. exit 1
  224. fi
  225. # If it finds the native Plugin it will use this instead and change the mailcow.conf Variable accordingly
  226. echo -e "\e[31mFound different Docker Compose Version then declared in mailcow.conf!\e[0m"
  227. echo -e "\e[31mSetting the DOCKER_COMPOSE_VERSION Variable from standalone to native\e[0m"
  228. sed -i 's/^DOCKER_COMPOSE_VERSION=.*/DOCKER_COMPOSE_VERSION=native/' "$SCRIPT_DIR/mailcow.conf"
  229. sleep 2
  230. fi
  231. fi
  232. }
  233. detect_bad_asn() {
  234. echo -e "\e[33mDetecting if your IP is listed on Spamhaus Bad ASN List...\e[0m"
  235. response=$(curl --connect-timeout 15 --max-time 30 -s -o /dev/null -w "%{http_code}" "https://asn-check.mailcow.email")
  236. if [ "$response" -eq 503 ]; then
  237. if [ -z "$SPAMHAUS_DQS_KEY" ]; then
  238. 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"
  239. echo -e "\e[33mmailcow did not detected a value for the variable SPAMHAUS_DQS_KEY inside mailcow.conf!\e[0m"
  240. sleep 2
  241. echo ""
  242. 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"
  243. echo -e "\e[33mOnce done, enter your DQS API key in mailcow.conf and mailcow will do the rest for you!\e[0m"
  244. echo ""
  245. sleep 2
  246. else
  247. 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"
  248. 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"
  249. fi
  250. elif [ "$response" -eq 200 ]; then
  251. echo -e "\e[33mCheck completed! Your IP is \e[32mclean\e[0m"
  252. elif [ "$response" -eq 429 ]; then
  253. echo -e "\e[33mCheck completed! \e[31mYour IP seems to be rate limited on the ASN Check service... please try again later!\e[0m"
  254. else
  255. echo -e "\e[31mCheck failed! \e[0mMaybe a DNS or Network problem?\e[0m"
  256. fi
  257. }
  258. ############## End Function Section ##############
  259. # Check permissions
  260. if [ "$(id -u)" -ne "0" ]; then
  261. echo "You need to be root"
  262. exit 1
  263. fi
  264. SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
  265. # Run pre-update-hook
  266. if [ -f "${SCRIPT_DIR}/pre_update_hook.sh" ]; then
  267. bash "${SCRIPT_DIR}/pre_update_hook.sh"
  268. fi
  269. if [[ "$(uname -r)" =~ ^4\.15\.0-60 ]]; then
  270. echo "DO NOT RUN mailcow ON THIS UBUNTU KERNEL!";
  271. echo "Please update to 5.x or use another distribution."
  272. exit 1
  273. fi
  274. if [[ "$(uname -r)" =~ ^4\.4\. ]]; then
  275. if grep -q Ubuntu <<< "$(uname -a)"; then
  276. echo "DO NOT RUN mailcow ON THIS UBUNTU KERNEL!"
  277. echo "Please update to linux-generic-hwe-16.04 by running \"apt-get install --install-recommends linux-generic-hwe-16.04\""
  278. exit 1
  279. fi
  280. 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."
  281. read -p "Press any key to continue..." < /dev/tty
  282. fi
  283. # Exit on error and pipefail
  284. set -o pipefail
  285. # Setting high dc timeout
  286. export COMPOSE_HTTP_TIMEOUT=600
  287. # Add /opt/bin to PATH
  288. PATH=$PATH:/opt/bin
  289. umask 0022
  290. # Unset COMPOSE_COMMAND and DOCKER_COMPOSE_VERSION Variable to be on the newest state.
  291. unset COMPOSE_COMMAND
  292. unset DOCKER_COMPOSE_VERSION
  293. for bin in curl docker git awk sha1sum grep cut; do
  294. if [[ -z $(command -v ${bin}) ]]; then
  295. echo "Cannot find ${bin}, exiting..."
  296. exit 1;
  297. fi
  298. done
  299. # Check Docker Version (need at least 24.X)
  300. docker_version=$(docker -v | grep -oP '\d+\.\d+\.\d+' | cut -d '.' -f 1 | head -1)
  301. if [[ $docker_version -lt 24 ]]; then
  302. echo -e "\e[31mCannot find Docker with a Version higher or equals 24.0.0\e[0m"
  303. echo -e "\e[33mmailcow needs a newer Docker version to work properly... continuing on your own risk!\e[0m"
  304. echo -e "\e[31mPlease update your Docker installation... sleeping 10s\e[0m"
  305. sleep 10
  306. fi
  307. export LC_ALL=C
  308. DATE=$(date +%Y-%m-%d_%H_%M_%S)
  309. BRANCH="$(cd "${SCRIPT_DIR}"; git rev-parse --abbrev-ref HEAD)"
  310. while (($#)); do
  311. case "${1}" in
  312. --check|-c)
  313. echo "Checking remote code for updates..."
  314. LATEST_REV=$(git ls-remote --exit-code --refs --quiet https://github.com/mailcow/mailcow-dockerized "${BRANCH}" | cut -f1)
  315. if [ "$?" -ne 0 ]; then
  316. echo "A problem occurred while trying to fetch the latest revision from github."
  317. exit 99
  318. fi
  319. if [[ -z $(git log HEAD --pretty=format:"%H" | grep "${LATEST_REV}") ]]; then
  320. echo -e "Updated code is available.\nThe changes can be found here: https://github.com/mailcow/mailcow-dockerized/commits/master"
  321. git log --date=short --pretty=format:"%ad - %s" "$(git rev-parse --short HEAD)"..origin/master
  322. exit 0
  323. else
  324. echo "No updates available."
  325. exit 3
  326. fi
  327. ;;
  328. --check-tags)
  329. echo "Checking remote tags for updates..."
  330. LATEST_TAG_REV=$(git ls-remote --exit-code --quiet --tags origin | tail -1 | cut -f1)
  331. if [ "$?" -ne 0 ]; then
  332. echo "A problem occurred while trying to fetch the latest tag from github."
  333. exit 99
  334. fi
  335. if [[ -z $(git log HEAD --pretty=format:"%H" | grep "${LATEST_TAG_REV}") ]]; then
  336. echo -e "New tag is available.\nThe changes can be found here: https://github.com/mailcow/mailcow-dockerized/releases/latest"
  337. exit 0
  338. else
  339. echo "No updates available."
  340. exit 3
  341. fi
  342. ;;
  343. --ours)
  344. MERGE_STRATEGY=ours
  345. ;;
  346. --skip-start)
  347. SKIP_START=y
  348. ;;
  349. --skip-ping-check)
  350. SKIP_PING_CHECK=y
  351. ;;
  352. --stable)
  353. CURRENT_BRANCH="$(cd "${SCRIPT_DIR}"; git rev-parse --abbrev-ref HEAD)"
  354. NEW_BRANCH="master"
  355. ;;
  356. --gc)
  357. echo -e "\e[32mCollecting garbage...\e[0m"
  358. docker_garbage
  359. exit 0
  360. ;;
  361. --nightly)
  362. CURRENT_BRANCH="$(cd "${SCRIPT_DIR}"; git rev-parse --abbrev-ref HEAD)"
  363. NEW_BRANCH="nightly"
  364. ;;
  365. --prefetch)
  366. echo -e "\e[32mPrefetching images...\e[0m"
  367. prefetch_images
  368. exit 0
  369. ;;
  370. -f|--force)
  371. echo -e "\e[32mRunning in forced mode...\e[0m"
  372. FORCE=y
  373. ;;
  374. -d|--dev)
  375. echo -e "\e[32mRunning in Developer mode...\e[0m"
  376. DEV=y
  377. ;;
  378. --help|-h)
  379. echo './update.sh [-c|--check, --check-tags, --ours, --gc, --nightly, --prefetch, --skip-start, --skip-ping-check, --stable, -f|--force, -d|--dev, -h|--help]
  380. -c|--check - Check for updates and exit (exit codes => 0: update available, 3: no updates)
  381. --check-tags - Check for newer tags and exit (exit codes => 0: newer tag available, 3: no newer tag)
  382. --ours - Use merge strategy option "ours" to solve conflicts in favor of non-mailcow code (local changes over remote changes), not recommended!
  383. --gc - Run garbage collector to delete old image tags
  384. --nightly - Switch your mailcow updates to the unstable (nightly) branch. FOR TESTING PURPOSES ONLY!!!!
  385. --prefetch - Only prefetch new images and exit (useful to prepare updates)
  386. --skip-start - Do not start mailcow after update
  387. --skip-ping-check - Skip ICMP Check to public DNS resolvers (Use it only if you'\''ve blocked any ICMP Connections to your mailcow machine)
  388. --stable - Switch your mailcow updates to the stable (master) branch. Default unless you changed it with --nightly.
  389. -f|--force - Force update, do not ask questions
  390. -d|--dev - Enables Developer Mode (No Checkout of update.sh for tests)
  391. '
  392. exit 0
  393. esac
  394. shift
  395. done
  396. [[ ! -f mailcow.conf ]] && { echo -e "\e[31mmailcow.conf is missing! Is mailcow installed?\e[0m"; exit 1;}
  397. chmod 600 mailcow.conf
  398. source mailcow.conf
  399. detect_docker_compose_command
  400. DOTS=${MAILCOW_HOSTNAME//[^.]};
  401. if [ ${#DOTS} -lt 1 ]; then
  402. echo -e "\e[31mMAILCOW_HOSTNAME (${MAILCOW_HOSTNAME}) is not a FQDN!\e[0m"
  403. sleep 1
  404. echo "Please change it to a FQDN and redeploy the stack with $COMPOSE_COMMAND up -d"
  405. exit 1
  406. elif [[ "${MAILCOW_HOSTNAME: -1}" == "." ]]; then
  407. echo "MAILCOW_HOSTNAME (${MAILCOW_HOSTNAME}) is ending with a dot. This is not a valid FQDN!"
  408. exit 1
  409. elif [ ${#DOTS} -eq 1 ]; then
  410. echo -e "\e[33mMAILCOW_HOSTNAME (${MAILCOW_HOSTNAME}) does not contain a Subdomain. This is not fully tested and may cause issues.\e[0m"
  411. echo "Find more information about why this message exists here: https://github.com/mailcow/mailcow-dockerized/issues/1572"
  412. read -r -p "Do you want to proceed anyway? [y/N] " response
  413. if [[ "$response" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  414. echo "OK. Proceeding."
  415. else
  416. echo "OK. Exiting."
  417. exit 1
  418. fi
  419. fi
  420. 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
  421. # This will also cover sort
  422. 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
  423. 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
  424. CONFIG_ARRAY=(
  425. "SKIP_LETS_ENCRYPT"
  426. "SKIP_SOGO"
  427. "USE_WATCHDOG"
  428. "WATCHDOG_NOTIFY_EMAIL"
  429. "WATCHDOG_NOTIFY_WEBHOOK"
  430. "WATCHDOG_NOTIFY_WEBHOOK_BODY"
  431. "WATCHDOG_NOTIFY_BAN"
  432. "WATCHDOG_NOTIFY_START"
  433. "WATCHDOG_EXTERNAL_CHECKS"
  434. "WATCHDOG_SUBJECT"
  435. "SKIP_CLAMD"
  436. "SKIP_IP_CHECK"
  437. "ADDITIONAL_SAN"
  438. "AUTODISCOVER_SAN"
  439. "DOVEADM_PORT"
  440. "IPV4_NETWORK"
  441. "IPV6_NETWORK"
  442. "LOG_LINES"
  443. "SNAT_TO_SOURCE"
  444. "SNAT6_TO_SOURCE"
  445. "COMPOSE_PROJECT_NAME"
  446. "DOCKER_COMPOSE_VERSION"
  447. "SQL_PORT"
  448. "API_KEY"
  449. "API_KEY_READ_ONLY"
  450. "API_ALLOW_FROM"
  451. "MAILDIR_GC_TIME"
  452. "MAILDIR_SUB"
  453. "ACL_ANYONE"
  454. "SOLR_HEAP"
  455. "SKIP_SOLR"
  456. "ENABLE_SSL_SNI"
  457. "ALLOW_ADMIN_EMAIL_LOGIN"
  458. "SKIP_HTTP_VERIFICATION"
  459. "SOGO_EXPIRE_SESSION"
  460. "REDIS_PORT"
  461. "DOVECOT_MASTER_USER"
  462. "DOVECOT_MASTER_PASS"
  463. "MAILCOW_PASS_SCHEME"
  464. "ADDITIONAL_SERVER_NAMES"
  465. "ACME_CONTACT"
  466. "WATCHDOG_VERBOSE"
  467. "WEBAUTHN_ONLY_TRUSTED_VENDORS"
  468. "SPAMHAUS_DQS_KEY"
  469. "SKIP_UNBOUND_HEALTHCHECK"
  470. "DISABLE_NETFILTER_ISOLATION_RULE"
  471. )
  472. detect_bad_asn
  473. sed -i --follow-symlinks '$a\' mailcow.conf
  474. for option in "${CONFIG_ARRAY[@]}"; do
  475. if [[ ${option} == "ADDITIONAL_SAN" ]]; then
  476. if ! grep -q "${option}" mailcow.conf; then
  477. echo "Adding new option \"${option}\" to mailcow.conf"
  478. echo "${option}=" >> mailcow.conf
  479. fi
  480. elif [[ "${option}" == "COMPOSE_PROJECT_NAME" ]]; then
  481. if ! grep -q "${option}" mailcow.conf; then
  482. echo "Adding new option \"${option}\" to mailcow.conf"
  483. echo "COMPOSE_PROJECT_NAME=mailcowdockerized" >> mailcow.conf
  484. fi
  485. elif [[ "${option}" == "DOCKER_COMPOSE_VERSION" ]]; then
  486. if ! grep -q "${option}" mailcow.conf; then
  487. echo "Adding new option \"${option}\" to mailcow.conf"
  488. echo "# Used Docker Compose version" >> mailcow.conf
  489. echo "# Switch here between native (compose plugin) and standalone" >> mailcow.conf
  490. echo "# For more informations take a look at the mailcow docs regarding the configuration options." >> mailcow.conf
  491. echo "# Normally this should be untouched but if you decided to use either of those you can switch it manually here." >> mailcow.conf
  492. echo "# Please be aware that at least one of those variants should be installed on your maschine or mailcow will fail." >> mailcow.conf
  493. echo "" >> mailcow.conf
  494. echo "DOCKER_COMPOSE_VERSION=${DOCKER_COMPOSE_VERSION}" >> mailcow.conf
  495. fi
  496. elif [[ "${option}" == "DOVEADM_PORT" ]]; then
  497. if ! grep -q "${option}" mailcow.conf; then
  498. echo "Adding new option \"${option}\" to mailcow.conf"
  499. echo "DOVEADM_PORT=127.0.0.1:19991" >> mailcow.conf
  500. fi
  501. elif [[ "${option}" == "WATCHDOG_NOTIFY_EMAIL" ]]; then
  502. if ! grep -q "${option}" mailcow.conf; then
  503. echo "Adding new option \"${option}\" to mailcow.conf"
  504. echo "WATCHDOG_NOTIFY_EMAIL=" >> mailcow.conf
  505. fi
  506. elif [[ "${option}" == "LOG_LINES" ]]; then
  507. if ! grep -q "${option}" mailcow.conf; then
  508. echo "Adding new option \"${option}\" to mailcow.conf"
  509. echo '# Max log lines per service to keep in Redis logs' >> mailcow.conf
  510. echo "LOG_LINES=9999" >> mailcow.conf
  511. fi
  512. elif [[ "${option}" == "IPV4_NETWORK" ]]; then
  513. if ! grep -q "${option}" mailcow.conf; then
  514. echo "Adding new option \"${option}\" to mailcow.conf"
  515. echo '# Internal IPv4 /24 subnet, format n.n.n. (expands to n.n.n.0/24)' >> mailcow.conf
  516. echo "IPV4_NETWORK=172.22.1" >> mailcow.conf
  517. fi
  518. elif [[ "${option}" == "IPV6_NETWORK" ]]; then
  519. if ! grep -q "${option}" mailcow.conf; then
  520. echo "Adding new option \"${option}\" to mailcow.conf"
  521. echo '# Internal IPv6 subnet in fc00::/7' >> mailcow.conf
  522. echo "IPV6_NETWORK=fd4d:6169:6c63:6f77::/64" >> mailcow.conf
  523. fi
  524. elif [[ "${option}" == "SQL_PORT" ]]; then
  525. if ! grep -q "${option}" mailcow.conf; then
  526. echo "Adding new option \"${option}\" to mailcow.conf"
  527. echo '# Bind SQL to 127.0.0.1 on port 13306' >> mailcow.conf
  528. echo "SQL_PORT=127.0.0.1:13306" >> mailcow.conf
  529. fi
  530. elif [[ "${option}" == "API_KEY" ]]; then
  531. if ! grep -q "${option}" mailcow.conf; then
  532. echo "Adding new option \"${option}\" to mailcow.conf"
  533. echo '# Create or override API key for web UI' >> mailcow.conf
  534. echo "#API_KEY=" >> mailcow.conf
  535. fi
  536. elif [[ "${option}" == "API_KEY_READ_ONLY" ]]; then
  537. if ! grep -q "${option}" mailcow.conf; then
  538. echo "Adding new option \"${option}\" to mailcow.conf"
  539. echo '# Create or override read-only API key for web UI' >> mailcow.conf
  540. echo "#API_KEY_READ_ONLY=" >> mailcow.conf
  541. fi
  542. elif [[ "${option}" == "API_ALLOW_FROM" ]]; then
  543. if ! grep -q "${option}" mailcow.conf; then
  544. echo "Adding new option \"${option}\" to mailcow.conf"
  545. echo '# Must be set for API_KEY to be active' >> mailcow.conf
  546. echo '# IPs only, no networks (networks can be set via UI)' >> mailcow.conf
  547. echo "#API_ALLOW_FROM=" >> mailcow.conf
  548. fi
  549. elif [[ "${option}" == "SNAT_TO_SOURCE" ]]; then
  550. if ! grep -q "${option}" mailcow.conf; then
  551. echo "Adding new option \"${option}\" to mailcow.conf"
  552. echo '# Use this IPv4 for outgoing connections (SNAT)' >> mailcow.conf
  553. echo "#SNAT_TO_SOURCE=" >> mailcow.conf
  554. fi
  555. elif [[ "${option}" == "SNAT6_TO_SOURCE" ]]; then
  556. if ! grep -q "${option}" mailcow.conf; then
  557. echo "Adding new option \"${option}\" to mailcow.conf"
  558. echo '# Use this IPv6 for outgoing connections (SNAT)' >> mailcow.conf
  559. echo "#SNAT6_TO_SOURCE=" >> mailcow.conf
  560. fi
  561. elif [[ "${option}" == "MAILDIR_GC_TIME" ]]; then
  562. if ! grep -q "${option}" mailcow.conf; then
  563. echo "Adding new option \"${option}\" to mailcow.conf"
  564. echo '# Garbage collector cleanup' >> mailcow.conf
  565. echo '# Deleted domains and mailboxes are moved to /var/vmail/_garbage/timestamp_sanitizedstring' >> mailcow.conf
  566. echo '# How long should objects remain in the garbage until they are being deleted? (value in minutes)' >> mailcow.conf
  567. echo '# Check interval is hourly' >> mailcow.conf
  568. echo 'MAILDIR_GC_TIME=1440' >> mailcow.conf
  569. fi
  570. elif [[ "${option}" == "ACL_ANYONE" ]]; then
  571. if ! grep -q "${option}" mailcow.conf; then
  572. echo "Adding new option \"${option}\" to mailcow.conf"
  573. echo '# Set this to "allow" to enable the anyone pseudo user. Disabled by default.' >> mailcow.conf
  574. echo '# When enabled, ACL can be created, that apply to "All authenticated users"' >> mailcow.conf
  575. echo '# This should probably only be activated on mail hosts, that are used exclusivly by one organisation.' >> mailcow.conf
  576. echo '# Otherwise a user might share data with too many other users.' >> mailcow.conf
  577. echo 'ACL_ANYONE=disallow' >> mailcow.conf
  578. fi
  579. elif [[ "${option}" == "SOLR_HEAP" ]]; then
  580. if ! grep -q "${option}" mailcow.conf; then
  581. echo "Adding new option \"${option}\" to mailcow.conf"
  582. echo '# Solr heap size, there is no recommendation, please see Solr docs.' >> mailcow.conf
  583. echo '# Solr is a prone to run OOM on large systems and should be monitored. Unmonitored Solr setups are not recommended.' >> mailcow.conf
  584. echo '# Solr will refuse to start with total system memory below or equal to 2 GB.' >> mailcow.conf
  585. echo "SOLR_HEAP=1024" >> mailcow.conf
  586. fi
  587. elif [[ "${option}" == "SKIP_SOLR" ]]; then
  588. if ! grep -q "${option}" mailcow.conf; then
  589. echo "Adding new option \"${option}\" to mailcow.conf"
  590. echo '# Solr is disabled by default after upgrading from non-Solr to Solr-enabled mailcows.' >> mailcow.conf
  591. echo '# Disable Solr or if you do not want to store a readable index of your mails in solr-vol-1.' >> mailcow.conf
  592. echo "SKIP_SOLR=y" >> mailcow.conf
  593. fi
  594. elif [[ "${option}" == "ENABLE_SSL_SNI" ]]; then
  595. if ! grep -q "${option}" mailcow.conf; then
  596. echo "Adding new option \"${option}\" to mailcow.conf"
  597. echo '# Create seperate certificates for all domains - y/n' >> mailcow.conf
  598. echo '# this will allow adding more than 100 domains, but some email clients will not be able to connect with alternative hostnames' >> mailcow.conf
  599. echo '# see https://wiki.dovecot.org/SSL/SNIClientSupport' >> mailcow.conf
  600. echo "ENABLE_SSL_SNI=n" >> mailcow.conf
  601. fi
  602. elif [[ "${option}" == "SKIP_SOGO" ]]; then
  603. if ! grep -q "${option}" mailcow.conf; then
  604. echo "Adding new option \"${option}\" to mailcow.conf"
  605. echo '# Skip SOGo: Will disable SOGo integration and therefore webmail, DAV protocols and ActiveSync support (experimental, unsupported, not fully implemented) - y/n' >> mailcow.conf
  606. echo "SKIP_SOGO=n" >> mailcow.conf
  607. fi
  608. elif [[ "${option}" == "MAILDIR_SUB" ]]; then
  609. if ! grep -q "${option}" mailcow.conf; then
  610. echo "Adding new option \"${option}\" to mailcow.conf"
  611. echo '# MAILDIR_SUB defines a path in a users virtual home to keep the maildir in. Leave empty for updated setups.' >> mailcow.conf
  612. echo "#MAILDIR_SUB=Maildir" >> mailcow.conf
  613. echo "MAILDIR_SUB=" >> mailcow.conf
  614. fi
  615. elif [[ "${option}" == "WATCHDOG_NOTIFY_WEBHOOK" ]]; then
  616. if ! grep -q "${option}" mailcow.conf; then
  617. echo "Adding new option \"${option}\" to mailcow.conf"
  618. echo '# Send notifications to a webhook URL that receives a POST request with the content type "application/json".' >> mailcow.conf
  619. echo '# You can use this to send notifications to services like Discord, Slack and others.' >> mailcow.conf
  620. echo '#WATCHDOG_NOTIFY_WEBHOOK=https://discord.com/api/webhooks/XXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' >> mailcow.conf
  621. fi
  622. elif [[ "${option}" == "WATCHDOG_NOTIFY_WEBHOOK_BODY" ]]; then
  623. if ! grep -q "${option}" mailcow.conf; then
  624. echo "Adding new option \"${option}\" to mailcow.conf"
  625. echo '# JSON body included in the webhook POST request. Needs to be in single quotes.' >> mailcow.conf
  626. echo '# Following variables are available: SUBJECT, BODY' >> mailcow.conf
  627. WEBHOOK_BODY='{"username": "mailcow Watchdog", "content": "**${SUBJECT}**\n${BODY}"}'
  628. echo "#WATCHDOG_NOTIFY_WEBHOOK_BODY='${WEBHOOK_BODY}'" >> mailcow.conf
  629. fi
  630. elif [[ "${option}" == "WATCHDOG_NOTIFY_BAN" ]]; then
  631. if ! grep -q "${option}" mailcow.conf; then
  632. echo "Adding new option \"${option}\" to mailcow.conf"
  633. echo '# Notify about banned IP. Includes whois lookup.' >> mailcow.conf
  634. echo "WATCHDOG_NOTIFY_BAN=y" >> mailcow.conf
  635. fi
  636. elif [[ "${option}" == "WATCHDOG_NOTIFY_START" ]]; then
  637. if ! grep -q "${option}" mailcow.conf; then
  638. echo "Adding new option \"${option}\" to mailcow.conf"
  639. echo '# Send a notification when the watchdog is started.' >> mailcow.conf
  640. echo "WATCHDOG_NOTIFY_START=y" >> mailcow.conf
  641. fi
  642. elif [[ "${option}" == "WATCHDOG_SUBJECT" ]]; then
  643. if ! grep -q "${option}" mailcow.conf; then
  644. echo "Adding new option \"${option}\" to mailcow.conf"
  645. echo '# Subject for watchdog mails. Defaults to "Watchdog ALERT" followed by the error message.' >> mailcow.conf
  646. echo "#WATCHDOG_SUBJECT=" >> mailcow.conf
  647. fi
  648. elif [[ "${option}" == "WATCHDOG_EXTERNAL_CHECKS" ]]; then
  649. if ! grep -q "${option}" mailcow.conf; then
  650. echo "Adding new option \"${option}\" to mailcow.conf"
  651. echo '# Checks if mailcow is an open relay. Requires a SAL. More checks will follow.' >> mailcow.conf
  652. echo '# No data is collected. Opt-in and anonymous.' >> mailcow.conf
  653. echo '# Will only work with unmodified mailcow setups.' >> mailcow.conf
  654. echo "WATCHDOG_EXTERNAL_CHECKS=n" >> mailcow.conf
  655. fi
  656. elif [[ "${option}" == "SOGO_EXPIRE_SESSION" ]]; then
  657. if ! grep -q "${option}" mailcow.conf; then
  658. echo "Adding new option \"${option}\" to mailcow.conf"
  659. echo '# SOGo session timeout in minutes' >> mailcow.conf
  660. echo "SOGO_EXPIRE_SESSION=480" >> mailcow.conf
  661. fi
  662. elif [[ "${option}" == "REDIS_PORT" ]]; then
  663. if ! grep -q "${option}" mailcow.conf; then
  664. echo "Adding new option \"${option}\" to mailcow.conf"
  665. echo "REDIS_PORT=127.0.0.1:7654" >> mailcow.conf
  666. fi
  667. elif [[ "${option}" == "DOVECOT_MASTER_USER" ]]; then
  668. if ! grep -q "${option}" mailcow.conf; then
  669. echo "Adding new option \"${option}\" to mailcow.conf"
  670. echo '# DOVECOT_MASTER_USER and _PASS must _both_ be provided. No special chars.' >> mailcow.conf
  671. echo '# Empty by default to auto-generate master user and password on start.' >> mailcow.conf
  672. echo '# User expands to DOVECOT_MASTER_USER@mailcow.local' >> mailcow.conf
  673. echo '# LEAVE EMPTY IF UNSURE' >> mailcow.conf
  674. echo "DOVECOT_MASTER_USER=" >> mailcow.conf
  675. fi
  676. elif [[ "${option}" == "DOVECOT_MASTER_PASS" ]]; then
  677. if ! grep -q "${option}" mailcow.conf; then
  678. echo "Adding new option \"${option}\" to mailcow.conf"
  679. echo '# LEAVE EMPTY IF UNSURE' >> mailcow.conf
  680. echo "DOVECOT_MASTER_PASS=" >> mailcow.conf
  681. fi
  682. elif [[ "${option}" == "MAILCOW_PASS_SCHEME" ]]; then
  683. if ! grep -q "${option}" mailcow.conf; then
  684. echo "Adding new option \"${option}\" to mailcow.conf"
  685. echo '# Password hash algorithm' >> mailcow.conf
  686. echo '# Only certain password hash algorithm are supported. For a fully list of supported schemes,' >> mailcow.conf
  687. echo '# see https://docs.mailcow.email/models/model-passwd/' >> mailcow.conf
  688. echo "MAILCOW_PASS_SCHEME=BLF-CRYPT" >> mailcow.conf
  689. fi
  690. elif [[ "${option}" == "ADDITIONAL_SERVER_NAMES" ]]; then
  691. if ! grep -q "${option}" mailcow.conf; then
  692. echo "Adding new option \"${option}\" to mailcow.conf"
  693. echo '# Additional server names for mailcow UI' >> mailcow.conf
  694. echo '#' >> mailcow.conf
  695. echo '# Specify alternative addresses for the mailcow UI to respond to' >> mailcow.conf
  696. 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
  697. 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
  698. echo '# You can understand this as server_name directive in Nginx.' >> mailcow.conf
  699. echo '# Comma separated list without spaces! Example: ADDITIONAL_SERVER_NAMES=a.b.c,d.e.f' >> mailcow.conf
  700. echo 'ADDITIONAL_SERVER_NAMES=' >> mailcow.conf
  701. fi
  702. elif [[ "${option}" == "AUTODISCOVER_SAN" ]]; then
  703. if ! grep -q "${option}" mailcow.conf; then
  704. echo "Adding new option \"${option}\" to mailcow.conf"
  705. echo '# Obtain certificates for autodiscover.* and autoconfig.* domains.' >> mailcow.conf
  706. echo '# This can be useful to switch off in case you are in a scenario where a reverse proxy already handles those.' >> mailcow.conf
  707. echo '# There are mixed scenarios where ports 80,443 are occupied and you do not want to share certs' >> mailcow.conf
  708. echo '# between services. So acme-mailcow obtains for maildomains and all web-things get handled' >> mailcow.conf
  709. echo '# in the reverse proxy.' >> mailcow.conf
  710. echo 'AUTODISCOVER_SAN=y' >> mailcow.conf
  711. fi
  712. elif [[ "${option}" == "ACME_CONTACT" ]]; then
  713. if ! grep -q "${option}" mailcow.conf; then
  714. echo "Adding new option \"${option}\" to mailcow.conf"
  715. echo '# Lets Encrypt registration contact information' >> mailcow.conf
  716. echo '# Optional: Leave empty for none' >> mailcow.conf
  717. echo '# This value is only used on first order!' >> mailcow.conf
  718. echo '# Setting it at a later point will require the following steps:' >> mailcow.conf
  719. echo '# https://docs.mailcow.email/troubleshooting/debug-reset_tls/' >> mailcow.conf
  720. echo 'ACME_CONTACT=' >> mailcow.conf
  721. fi
  722. elif [[ "${option}" == "WEBAUTHN_ONLY_TRUSTED_VENDORS" ]]; then
  723. if ! grep -q "${option}" mailcow.conf; then
  724. echo "Adding new option \"${option}\" to mailcow.conf"
  725. echo "# WebAuthn device manufacturer verification" >> mailcow.conf
  726. echo '# After setting WEBAUTHN_ONLY_TRUSTED_VENDORS=y only devices from trusted manufacturers are allowed' >> mailcow.conf
  727. echo '# root certificates can be placed for validation under mailcow-dockerized/data/web/inc/lib/WebAuthn/rootCertificates' >> mailcow.conf
  728. echo 'WEBAUTHN_ONLY_TRUSTED_VENDORS=n' >> mailcow.conf
  729. fi
  730. elif [[ "${option}" == "SPAMHAUS_DQS_KEY" ]]; then
  731. if ! grep -q "${option}" mailcow.conf; then
  732. echo "Adding new option \"${option}\" to mailcow.conf"
  733. echo "# Spamhaus Data Query Service Key" >> mailcow.conf
  734. echo '# Optional: Leave empty for none' >> mailcow.conf
  735. echo '# Enter your key here if you are using a blocked ASN (OVH, AWS, Cloudflare e.g) for the unregistered Spamhaus Blocklist.' >> mailcow.conf
  736. 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
  737. echo '# Otherwise it will work as usual.' >> mailcow.conf
  738. echo 'SPAMHAUS_DQS_KEY=' >> mailcow.conf
  739. fi
  740. elif [[ "${option}" == "WATCHDOG_VERBOSE" ]]; then
  741. if ! grep -q "${option}" mailcow.conf; then
  742. echo "Adding new option \"${option}\" to mailcow.conf"
  743. echo '# Enable watchdog verbose logging' >> mailcow.conf
  744. echo 'WATCHDOG_VERBOSE=n' >> mailcow.conf
  745. fi
  746. elif [[ "${option}" == "SKIP_UNBOUND_HEALTHCHECK" ]]; then
  747. if ! grep -q "${option}" mailcow.conf; then
  748. echo "Adding new option \"${option}\" to mailcow.conf"
  749. echo '# Skip Unbound (DNS Resolver) Healthchecks (NOT Recommended!) - y/n' >> mailcow.conf
  750. echo 'SKIP_UNBOUND_HEALTHCHECK=n' >> mailcow.conf
  751. fi
  752. elif [[ "${option}" == "DISABLE_NETFILTER_ISOLATION_RULE" ]]; then
  753. if ! grep -q "${option}" mailcow.conf; then
  754. echo "Adding new option \"${option}\" to mailcow.conf"
  755. echo '# Prevent netfilter from setting an iptables/nftables rule to isolate the mailcow docker network - y/n' >> mailcow.conf
  756. 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
  757. echo 'DISABLE_NETFILTER_ISOLATION_RULE=n' >> mailcow.conf
  758. fi
  759. elif ! grep -q "${option}" mailcow.conf; then
  760. echo "Adding new option \"${option}\" to mailcow.conf"
  761. echo "${option}=n" >> mailcow.conf
  762. fi
  763. done
  764. if [[ ("${SKIP_PING_CHECK}" == "y") ]]; then
  765. echo -e "\e[32mSkipping Ping Check...\e[0m"
  766. else
  767. echo -en "Checking internet connection... "
  768. if ! check_online_status; then
  769. echo -e "\e[31mfailed\e[0m"
  770. exit 1
  771. else
  772. echo -e "\e[32mOK\e[0m"
  773. fi
  774. fi
  775. if ! [ "$NEW_BRANCH" ]; then
  776. echo -e "\e[33mDetecting which build your mailcow runs on...\e[0m"
  777. sleep 1
  778. if [ "${BRANCH}" == "master" ]; then
  779. echo -e "\e[32mYou are receiving stable updates (master).\e[0m"
  780. echo -e "\e[33mTo change that run the update.sh Script one time with the --nightly parameter to switch to nightly builds.\e[0m"
  781. elif [ "${BRANCH}" == "nightly" ]; then
  782. echo -e "\e[31mYou are receiving unstable updates (nightly). These are for testing purposes only!!!\e[0m"
  783. sleep 1
  784. echo -e "\e[33mTo change that run the update.sh Script one time with the --stable parameter to switch to stable builds.\e[0m"
  785. else
  786. echo -e "\e[33mYou are receiving updates from an unsupported branch.\e[0m"
  787. sleep 1
  788. echo -e "\e[33mThe mailcow stack might still work but it is recommended to switch to the master branch (stable builds).\e[0m"
  789. echo -e "\e[33mTo change that run the update.sh Script one time with the --stable parameter to switch to stable builds.\e[0m"
  790. fi
  791. elif [ "$FORCE" ]; then
  792. echo -e "\e[31mYou are running in forced mode!\e[0m"
  793. echo -e "\e[31mA Branch Switch can only be performed manually (monitored).\e[0m"
  794. echo -e "\e[31mPlease rerun the update.sh Script without the --force/-f parameter.\e[0m"
  795. sleep 1
  796. elif [ "$NEW_BRANCH" == "master" ] && [ "$CURRENT_BRANCH" != "master" ]; then
  797. echo -e "\e[33mYou are about to switch your mailcow updates to the stable (master) branch.\e[0m"
  798. sleep 1
  799. echo -e "\e[33mBefore you do: Please take a backup of all components to ensure that no data is lost...\e[0m"
  800. sleep 1
  801. echo -e "\e[31mWARNING: Please see on GitHub or ask in the community if a switch to master is stable or not.
  802. In some rear cases an update back to master can destroy your mailcow configuration such as database upgrade, etc.
  803. Normally an upgrade back to master should be safe during each full release.
  804. Check GitHub for Database changes and update only if there similar to the full release!\e[0m"
  805. read -r -p "Are you sure you that want to continue upgrading to the stable (master) branch? [y/N] " response
  806. if [[ ! "${response}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  807. echo "OK. If you prepared yourself for that please run the update.sh Script with the --stable parameter again to trigger this process here."
  808. exit 0
  809. fi
  810. BRANCH="$NEW_BRANCH"
  811. DIFF_DIRECTORY=update_diffs
  812. DIFF_FILE="${DIFF_DIRECTORY}/diff_before_upgrade_to_master_$(date +"%Y-%m-%d-%H-%M-%S")"
  813. mv diff_before_upgrade* "${DIFF_DIRECTORY}/" 2> /dev/null
  814. if ! git diff-index --quiet HEAD; then
  815. echo -e "\e[32mSaving diff to ${DIFF_FILE}...\e[0m"
  816. mkdir -p "${DIFF_DIRECTORY}"
  817. git diff "${BRANCH}" --stat > "${DIFF_FILE}"
  818. git diff "${BRANCH}" >> "${DIFF_FILE}"
  819. fi
  820. echo -e "\e[32mSwitching Branch to ${BRANCH}...\e[0m"
  821. git fetch origin
  822. git checkout -f "${BRANCH}"
  823. elif [ "$NEW_BRANCH" == "nightly" ] && [ "$CURRENT_BRANCH" != "nightly" ]; then
  824. echo -e "\e[33mYou are about to switch your mailcow Updates to the unstable (nightly) branch.\e[0m"
  825. sleep 1
  826. echo -e "\e[33mBefore you do: Please take a backup of all components to ensure that no Data is lost...\e[0m"
  827. sleep 1
  828. echo -e "\e[31mWARNING: A switch to nightly is possible any time. But a switch back (to master) isn't.\e[0m"
  829. read -r -p "Are you sure you that want to continue upgrading to the unstable (nightly) branch? [y/N] " response
  830. if [[ ! "${response}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  831. echo "OK. If you prepared yourself for that please run the update.sh Script with the --nightly parameter again to trigger this process here."
  832. exit 0
  833. fi
  834. BRANCH=$NEW_BRANCH
  835. DIFF_DIRECTORY=update_diffs
  836. DIFF_FILE=${DIFF_DIRECTORY}/diff_before_upgrade_to_nightly_$(date +"%Y-%m-%d-%H-%M-%S")
  837. mv diff_before_upgrade* ${DIFF_DIRECTORY}/ 2> /dev/null
  838. if ! git diff-index --quiet HEAD; then
  839. echo -e "\e[32mSaving diff to ${DIFF_FILE}...\e[0m"
  840. mkdir -p ${DIFF_DIRECTORY}
  841. git diff "${BRANCH}" --stat > "${DIFF_FILE}"
  842. git diff "${BRANCH}" >> "${DIFF_FILE}"
  843. fi
  844. git fetch origin
  845. git checkout -f "${BRANCH}"
  846. fi
  847. if [ ! "$DEV" ]; then
  848. echo -e "\e[32mChecking for newer update script...\e[0m"
  849. SHA1_1="$(sha1sum update.sh)"
  850. git fetch origin #${BRANCH}
  851. git checkout "origin/${BRANCH}" update.sh
  852. SHA1_2=$(sha1sum update.sh)
  853. if [[ "${SHA1_1}" != "${SHA1_2}" ]]; then
  854. echo "update.sh changed, please run this script again, exiting."
  855. chmod +x update.sh
  856. exit 2
  857. fi
  858. fi
  859. if [ ! "$FORCE" ]; then
  860. read -r -p "Are you sure you want to update mailcow: dockerized? All containers will be stopped. [y/N] " response
  861. if [[ ! "${response}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  862. echo "OK, exiting."
  863. exit 0
  864. fi
  865. migrate_docker_nat
  866. fi
  867. remove_obsolete_nginx_ports
  868. echo -e "\e[32mValidating docker-compose stack configuration...\e[0m"
  869. sed -i 's/HTTPS_BIND:-:/HTTPS_BIND:-/g' docker-compose.yml
  870. sed -i 's/HTTP_BIND:-:/HTTP_BIND:-/g' docker-compose.yml
  871. if ! $COMPOSE_COMMAND config -q; then
  872. echo -e "\e[31m\nOh no, something went wrong. Please check the error message above.\e[0m"
  873. exit 1
  874. fi
  875. echo -e "\e[32mChecking for conflicting bridges...\e[0m"
  876. MAILCOW_BRIDGE=$($COMPOSE_COMMAND config | grep -i com.docker.network.bridge.name | cut -d':' -f2)
  877. while read NAT_ID; do
  878. iptables -t nat -D POSTROUTING "$NAT_ID"
  879. done < <(iptables -L -vn -t nat --line-numbers | grep "$IPV4_NETWORK" | grep -E 'MASQUERADE.*all' | grep -v "${MAILCOW_BRIDGE}" | cut -d' ' -f1)
  880. DIFF_DIRECTORY=update_diffs
  881. DIFF_FILE=${DIFF_DIRECTORY}/diff_before_update_$(date +"%Y-%m-%d-%H-%M-%S")
  882. mv diff_before_update* ${DIFF_DIRECTORY}/ 2> /dev/null
  883. if ! git diff-index --quiet HEAD; then
  884. echo -e "\e[32mSaving diff to ${DIFF_FILE}...\e[0m"
  885. mkdir -p ${DIFF_DIRECTORY}
  886. git diff --stat > "${DIFF_FILE}"
  887. git diff >> "${DIFF_FILE}"
  888. fi
  889. echo -e "\e[32mPrefetching images...\e[0m"
  890. prefetch_images
  891. echo -e "\e[32mStopping mailcow...\e[0m"
  892. sleep 2
  893. MAILCOW_CONTAINERS=($($COMPOSE_COMMAND ps -q))
  894. $COMPOSE_COMMAND down
  895. echo -e "\e[32mChecking for remaining containers...\e[0m"
  896. sleep 2
  897. for container in "${MAILCOW_CONTAINERS[@]}"; do
  898. docker rm -f "$container" 2> /dev/null
  899. done
  900. [[ -f data/conf/nginx/ZZZ-ejabberd.conf ]] && rm data/conf/nginx/ZZZ-ejabberd.conf
  901. # Silently fixing remote url from andryyy to mailcow
  902. # git remote set-url origin https://github.com/mailcow/mailcow-dockerized
  903. DEFAULT_REPO="https://github.com/mailcow/mailcow-dockerized"
  904. CURRENT_REPO=$(git config --get remote.origin.url)
  905. if [ "$CURRENT_REPO" != "$DEFAULT_REPO" ]; then
  906. echo "The Repository currently used is not the default Mailcow Repository."
  907. echo "Currently Repository: $CURRENT_REPO"
  908. echo "Default Repository: $DEFAULT_REPO"
  909. if [ ! "$FORCE" ]; then
  910. read -r -p "Should it be changed back to default? [y/N] " repo_response
  911. if [[ "$repo_response" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  912. git remote set-url origin $DEFAULT_REPO
  913. fi
  914. else
  915. echo "Running in forced mode... setting Repo to default!"
  916. git remote set-url origin $DEFAULT_REPO
  917. fi
  918. fi
  919. if [ ! "$DEV" ]; then
  920. echo -e "\e[32mCommitting current status...\e[0m"
  921. [[ -z "$(git config user.name)" ]] && git config user.name moo
  922. [[ -z "$(git config user.email)" ]] && git config user.email moo@cow.moo
  923. [[ ! -z $(git ls-files data/conf/rspamd/override.d/worker-controller-password.inc) ]] && git rm data/conf/rspamd/override.d/worker-controller-password.inc
  924. git add -u
  925. git commit -am "Before update on ${DATE}" > /dev/null
  926. echo -e "\e[32mFetching updated code from remote...\e[0m"
  927. git fetch origin #${BRANCH}
  928. echo -e "\e[32mMerging local with remote code (recursive, strategy: \"${MERGE_STRATEGY:-theirs}\", options: \"patience\"...\e[0m"
  929. git config merge.defaultToUpstream true
  930. git merge -X"${MERGE_STRATEGY:-theirs}" -Xpatience -m "After update on ${DATE}"
  931. # Need to use a variable to not pass return codes of if checks
  932. MERGE_RETURN=$?
  933. if [[ ${MERGE_RETURN} == 128 ]]; then
  934. 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"
  935. exit 1
  936. elif [[ ${MERGE_RETURN} == 1 ]]; then
  937. echo -e "\e[93mPotential conflict, trying to fix...\e[0m"
  938. git status --porcelain | grep -E "UD|DU" | awk '{print $2}' | xargs rm -v
  939. git add -A
  940. git commit -m "After update on ${DATE}" > /dev/null
  941. git checkout .
  942. echo -e "\e[32mRemoved and recreated files if necessary.\e[0m"
  943. elif [[ ${MERGE_RETURN} != 0 ]]; then
  944. echo -e "\e[31m\nOh no, something went wrong. Please check the error message above.\e[0m"
  945. echo
  946. echo "Run $COMPOSE_COMMAND up -d to restart your stack without updates or try again after fixing the mentioned errors."
  947. exit 1
  948. fi
  949. elif [ "$DEV" ]; then
  950. echo -e "\e[33mDEVELOPER MODE: Not creating a git diff and commiting it to prevent development stuff within a backup diff...\e[0m"
  951. fi
  952. echo -e "\e[32mFetching new images, if any...\e[0m"
  953. sleep 2
  954. $COMPOSE_COMMAND pull
  955. # Fix missing SSL, does not overwrite existing files
  956. [[ ! -d data/assets/ssl ]] && mkdir -p data/assets/ssl
  957. cp -n -d data/assets/ssl-example/*.pem data/assets/ssl/
  958. echo -e "Checking IPv6 settings... "
  959. if grep -q 'SYSCTL_IPV6_DISABLED=1' mailcow.conf; then
  960. echo
  961. echo '!! IMPORTANT !!'
  962. echo
  963. 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".'
  964. echo "This setting will only be active after a complete shutdown of mailcow by running $COMPOSE_COMMAND down followed by $COMPOSE_COMMAND up -d."
  965. echo
  966. echo '!! IMPORTANT !!'
  967. echo
  968. read -p "Press any key to continue..." < /dev/tty
  969. fi
  970. # Checking for old project name bug
  971. sed -i --follow-symlinks 's#COMPOSEPROJECT_NAME#COMPOSE_PROJECT_NAME#g' mailcow.conf
  972. # Fix Rspamd maps
  973. if [ -f data/conf/rspamd/custom/global_from_blacklist.map ]; then
  974. mv data/conf/rspamd/custom/global_from_blacklist.map data/conf/rspamd/custom/global_smtp_from_blacklist.map
  975. fi
  976. if [ -f data/conf/rspamd/custom/global_from_whitelist.map ]; then
  977. mv data/conf/rspamd/custom/global_from_whitelist.map data/conf/rspamd/custom/global_smtp_from_whitelist.map
  978. fi
  979. # Fix deprecated metrics.conf
  980. if [ -f "data/conf/rspamd/local.d/metrics.conf" ]; then
  981. if [ ! -z "$(git diff --name-only origin/master data/conf/rspamd/local.d/metrics.conf)" ]; then
  982. 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."
  983. echo "The deprecated configuration file metrics.conf will be moved to metrics.conf_deprecated after updating mailcow."
  984. fi
  985. mv data/conf/rspamd/local.d/metrics.conf data/conf/rspamd/local.d/metrics.conf_deprecated
  986. fi
  987. # Set app_info.inc.php
  988. if [ ${BRANCH} == "master" ]; then
  989. mailcow_git_version=$(git describe --tags $(git rev-list --tags --max-count=1))
  990. elif [ ${BRANCH} == "nightly" ]; then
  991. mailcow_git_version=$(git rev-parse --short $(git rev-parse @{upstream}))
  992. mailcow_last_git_version=""
  993. else
  994. mailcow_git_version=$(git rev-parse --short HEAD)
  995. mailcow_last_git_version=""
  996. fi
  997. mailcow_git_commit=$(git rev-parse "origin/${BRANCH}")
  998. mailcow_git_commit_date=$(git log -1 --format=%ci @{upstream} )
  999. if [ $? -eq 0 ]; then
  1000. echo '<?php' > data/web/inc/app_info.inc.php
  1001. echo ' $MAILCOW_GIT_VERSION="'$mailcow_git_version'";' >> data/web/inc/app_info.inc.php
  1002. echo ' $MAILCOW_LAST_GIT_VERSION="";' >> data/web/inc/app_info.inc.php
  1003. echo ' $MAILCOW_GIT_OWNER="mailcow";' >> data/web/inc/app_info.inc.php
  1004. echo ' $MAILCOW_GIT_REPO="mailcow-dockerized";' >> data/web/inc/app_info.inc.php
  1005. echo ' $MAILCOW_GIT_URL="https://github.com/mailcow/mailcow-dockerized";' >> data/web/inc/app_info.inc.php
  1006. echo ' $MAILCOW_GIT_COMMIT="'$mailcow_git_commit'";' >> data/web/inc/app_info.inc.php
  1007. echo ' $MAILCOW_GIT_COMMIT_DATE="'$mailcow_git_commit_date'";' >> data/web/inc/app_info.inc.php
  1008. echo ' $MAILCOW_BRANCH="'$BRANCH'";' >> data/web/inc/app_info.inc.php
  1009. echo ' $MAILCOW_UPDATEDAT='$(date +%s)';' >> data/web/inc/app_info.inc.php
  1010. echo '?>' >> data/web/inc/app_info.inc.php
  1011. else
  1012. echo '<?php' > data/web/inc/app_info.inc.php
  1013. echo ' $MAILCOW_GIT_VERSION="'$mailcow_git_version'";' >> data/web/inc/app_info.inc.php
  1014. echo ' $MAILCOW_LAST_GIT_VERSION="";' >> data/web/inc/app_info.inc.php
  1015. echo ' $MAILCOW_GIT_OWNER="mailcow";' >> data/web/inc/app_info.inc.php
  1016. echo ' $MAILCOW_GIT_REPO="mailcow-dockerized";' >> data/web/inc/app_info.inc.php
  1017. echo ' $MAILCOW_GIT_URL="https://github.com/mailcow/mailcow-dockerized";' >> data/web/inc/app_info.inc.php
  1018. echo ' $MAILCOW_GIT_COMMIT="";' >> data/web/inc/app_info.inc.php
  1019. echo ' $MAILCOW_GIT_COMMIT_DATE="";' >> data/web/inc/app_info.inc.php
  1020. echo ' $MAILCOW_BRANCH="'$BRANCH'";' >> data/web/inc/app_info.inc.php
  1021. echo ' $MAILCOW_UPDATEDAT='$(date +%s)';' >> data/web/inc/app_info.inc.php
  1022. echo '?>' >> data/web/inc/app_info.inc.php
  1023. echo -e "\e[33mCannot determine current git repository version...\e[0m"
  1024. fi
  1025. if [[ ${SKIP_START} == "y" ]]; then
  1026. echo -e "\e[33mNot starting mailcow, please run \"$COMPOSE_COMMAND up -d --remove-orphans\" to start mailcow.\e[0m"
  1027. else
  1028. echo -e "\e[32mStarting mailcow...\e[0m"
  1029. sleep 2
  1030. $COMPOSE_COMMAND up -d --remove-orphans
  1031. fi
  1032. echo -e "\e[32mCollecting garbage...\e[0m"
  1033. docker_garbage
  1034. # Run post-update-hook
  1035. if [ -f "${SCRIPT_DIR}/post_update_hook.sh" ]; then
  1036. bash "${SCRIPT_DIR}/post_update_hook.sh"
  1037. fi
  1038. # echo "In case you encounter any problem, hard-reset to a state before updating mailcow:"
  1039. # echo
  1040. # git reflog --color=always | grep "Before update on "
  1041. # echo
  1042. # echo "Use \"git reset --hard hash-on-the-left\" and run $COMPOSE_COMMAND up -d afterwards."