update.sh 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741
  1. #!/usr/bin/env bash
  2. # Check permissions
  3. if [ "$(id -u)" -ne "0" ]; then
  4. echo "You need to be root"
  5. exit 1
  6. fi
  7. SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
  8. # Run pre-update-hook
  9. if [ -f "${SCRIPT_DIR}/pre_update_hook.sh" ]; then
  10. bash "${SCRIPT_DIR}/pre_update_hook.sh"
  11. fi
  12. if [[ "$(uname -r)" =~ ^4\.15\.0-60 ]]; then
  13. echo "DO NOT RUN mailcow ON THIS UBUNTU KERNEL!";
  14. echo "Please update to 5.x or use another distribution."
  15. exit 1
  16. fi
  17. if [[ "$(uname -r)" =~ ^4\.4\. ]]; then
  18. if grep -q Ubuntu <<< $(uname -a); then
  19. echo "DO NOT RUN mailcow ON THIS UBUNTU KERNEL!"
  20. echo "Please update to linux-generic-hwe-16.04 by running \"apt-get install --install-recommends linux-generic-hwe-16.04\""
  21. exit 1
  22. fi
  23. 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."
  24. read -p "Press any key to continue..." < /dev/tty
  25. fi
  26. # Exit on error and pipefail
  27. set -o pipefail
  28. # Setting high dc timeout
  29. export COMPOSE_HTTP_TIMEOUT=600
  30. # Add /opt/bin to PATH
  31. PATH=$PATH:/opt/bin
  32. umask 0022
  33. for bin in curl docker git awk sha1sum; do
  34. if [[ -z $(which ${bin}) ]]; then echo "Cannot find ${bin}, exiting..."; exit 1; fi
  35. done
  36. echo "checking docker compose version...";
  37. if docker --help | grep compose then
  38. COMPOSE_COMMAND="docker compose"
  39. elif docker-compose version --short | grep -m1 "^1" > /dev/null 2>&1 then
  40. >&2 echo -e "\e[31mWARN: Your machine is using Docker-Compose v1!\e[0m"
  41. >&2 echo -e "\e[31mmailcow will drop the Docker-Compose v1 Support in December 2022\e[0m"
  42. >&2 echo -e "\e[31mPlease consider a upgrade to Docker-Compose v2.\e[0m"
  43. >&2 echo
  44. >&2 echo
  45. >&2 echo -e "\e[33mContinuing...\e[0m"
  46. sleep 3
  47. COMPOSE_COMMAND="docker-compose"
  48. else
  49. >&2 echo -e "\e[31mCannot find Docker-Compose v1 or v2 on your System. Please install Docker-Compose v2 and re-run the Script.\e[0m"
  50. exit 1
  51. fi
  52. export LC_ALL=C
  53. DATE=$(date +%Y-%m-%d_%H_%M_%S)
  54. BRANCH=$(cd ${SCRIPT_DIR}; git rev-parse --abbrev-ref HEAD)
  55. check_online_status() {
  56. CHECK_ONLINE_IPS=(1.1.1.1 9.9.9.9 8.8.8.8)
  57. for ip in "${CHECK_ONLINE_IPS[@]}"; do
  58. if timeout 3 ping -c 1 ${ip} > /dev/null; then
  59. return 0
  60. fi
  61. done
  62. return 1
  63. }
  64. prefetch_images() {
  65. [[ -z ${BRANCH} ]] && { echo -e "\e[33m\nUnknown branch...\e[0m"; exit 1; }
  66. git fetch origin #${BRANCH}
  67. while read image; do
  68. if [[ "${image}" == "robbertkl/ipv6nat" ]]; then
  69. if ! grep -qi "ipv6nat-mailcow" docker-compose.yml || grep -qi "enable_ipv6: false" docker-compose.yml; then
  70. continue
  71. fi
  72. fi
  73. RET_C=0
  74. until docker pull ${image}; do
  75. RET_C=$((RET_C + 1))
  76. echo -e "\e[33m\nError pulling $image, retrying...\e[0m"
  77. [ ${RET_C} -gt 3 ] && { echo -e "\e[31m\nToo many failed retries, exiting\e[0m"; exit 1; }
  78. sleep 1
  79. done
  80. done < <(git show origin/${BRANCH}:docker-compose.yml | grep "image:" | awk '{ gsub("image:","", $3); print $2 }')
  81. }
  82. docker_garbage() {
  83. IMGS_TO_DELETE=()
  84. for container in $(grep -oP "image: \Kmailcow.+" "${SCRIPT_DIR}/docker-compose.yml"); do
  85. REPOSITORY=${container/:*}
  86. TAG=${container/*:}
  87. V_MAIN=${container/*.}
  88. V_SUB=${container/*.}
  89. EXISTING_TAGS=$(docker images | grep ${REPOSITORY} | awk '{ print $2 }')
  90. for existing_tag in ${EXISTING_TAGS[@]}; do
  91. V_MAIN_EXISTING=${existing_tag/*.}
  92. V_SUB_EXISTING=${existing_tag/*.}
  93. # Not an integer
  94. [[ ! $V_MAIN_EXISTING =~ ^[0-9]+$ ]] && continue
  95. [[ ! $V_SUB_EXISTING =~ ^[0-9]+$ ]] && continue
  96. if [[ $V_MAIN_EXISTING == "latest" ]]; then
  97. echo "Found deprecated label \"latest\" for repository $REPOSITORY, it should be deleted."
  98. IMGS_TO_DELETE+=($REPOSITORY:$existing_tag)
  99. elif [[ $V_MAIN_EXISTING -lt $V_MAIN ]]; then
  100. echo "Found tag $existing_tag for $REPOSITORY, which is older than the current tag $TAG and should be deleted."
  101. IMGS_TO_DELETE+=($REPOSITORY:$existing_tag)
  102. elif [[ $V_SUB_EXISTING -lt $V_SUB ]]; then
  103. echo "Found tag $existing_tag for $REPOSITORY, which is older than the current tag $TAG and should be deleted."
  104. IMGS_TO_DELETE+=($REPOSITORY:$existing_tag)
  105. fi
  106. done
  107. done
  108. if [[ ! -z ${IMGS_TO_DELETE[*]} ]]; then
  109. echo "Run the following command to delete unused image tags:"
  110. echo
  111. echo " docker rmi ${IMGS_TO_DELETE[*]}"
  112. echo
  113. if [ ! $FORCE ]; then
  114. read -r -p "Do you want to delete old image tags right now? [y/N] " response
  115. if [[ "$response" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  116. docker rmi ${IMGS_TO_DELETE[*]}
  117. else
  118. echo "OK, skipped."
  119. fi
  120. else
  121. echo "Running image removal without extra confirmation due to force mode."
  122. docker rmi ${IMGS_TO_DELETE[*]}
  123. fi
  124. echo -e "\e[32mFurther cleanup...\e[0m"
  125. 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\""
  126. fi
  127. }
  128. in_array() {
  129. local e match="$1"
  130. shift
  131. for e; do [[ "$e" == "$match" ]] && return 0; done
  132. return 1
  133. }
  134. migrate_docker_nat() {
  135. NAT_CONFIG='{"ipv6":true,"fixed-cidr-v6":"fd00:dead:beef:c0::/80","experimental":true,"ip6tables":true}'
  136. # Min Docker version
  137. DOCKERV_REQ=20.10.2
  138. # Current Docker version
  139. DOCKERV_CUR=$(docker version -f '{{.Server.Version}}')
  140. if grep -qi "ipv6nat-mailcow" docker-compose.yml && grep -qi "enable_ipv6: true" docker-compose.yml; then
  141. echo -e "\e[32mNative IPv6 implementation available.\e[0m"
  142. echo "This will enable experimental features in the Docker daemon and configure Docker to do the IPv6 NATing instead of ipv6nat-mailcow."
  143. echo '!!! This step is recommended !!!'
  144. echo "mailcow will try to roll back the changes if starting Docker fails after modifying the daemon.json configuration file."
  145. read -r -p "Should we try to enable the native IPv6 implementation in Docker now (recommended)? [y/N] " dockernatresponse
  146. if [[ ! "${dockernatresponse}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  147. echo "OK, skipping this step."
  148. return 0
  149. fi
  150. fi
  151. # Sort versions and check if we are running a newer or equal version to req
  152. if [ $(printf "${DOCKERV_REQ}\n${DOCKERV_CUR}" | sort -V | tail -n1) == "${DOCKERV_CUR}" ]; then
  153. # If Dockerd daemon json exists
  154. if [ -s /etc/docker/daemon.json ]; then
  155. IFS=',' read -r -a dockerconfig <<< $(cat /etc/docker/daemon.json | tr -cd '[:alnum:],')
  156. if ! in_array ipv6true "${dockerconfig[@]}" || \
  157. ! in_array experimentaltrue "${dockerconfig[@]}" || \
  158. ! in_array ip6tablestrue "${dockerconfig[@]}" || \
  159. ! grep -qi "fixed-cidr-v6" /etc/docker/daemon.json; then
  160. 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."
  161. echo "You will need to merge your existing configuration manually or fix/delete the existing daemon.json configuration before trying the update process again."
  162. echo -e "Please merge the following content and restart the Docker daemon:\n"
  163. echo ${NAT_CONFIG}
  164. return 1
  165. fi
  166. else
  167. echo "Working on IPv6 NAT, please wait..."
  168. echo ${NAT_CONFIG} > /etc/docker/daemon.json
  169. ip6tables -F -t nat
  170. [[ -e /etc/alpine-release ]] && rc-service docker restart || systemctl restart docker.service
  171. if [[ $? -ne 0 ]]; then
  172. echo -e "\e[31mError:\e[0m Failed to activate IPv6 NAT! Reverting and exiting."
  173. rm /etc/docker/daemon.json
  174. if [[ -e /etc/alpine-release ]]; then
  175. rc-service docker restart
  176. else
  177. systemctl reset-failed docker.service
  178. systemctl restart docker.service
  179. fi
  180. return 1
  181. fi
  182. fi
  183. # Removing legacy container
  184. sed -i '/ipv6nat-mailcow:$/,/^$/d' docker-compose.yml
  185. if [ -s docker-compose.override.yml ]; then
  186. sed -i '/ipv6nat-mailcow:$/,/^$/d' docker-compose.override.yml
  187. if [[ "$(cat docker-compose.override.yml | sed '/^\s*$/d' | wc -l)" == "2" ]]; then
  188. mv docker-compose.override.yml docker-compose.override.yml_backup
  189. fi
  190. fi
  191. echo -e "\e[32mGreat! \e[0mNative IPv6 NAT is active.\e[0m"
  192. else
  193. echo -e "\e[31mPlease upgrade Docker to version ${DOCKERV_REQ} or above.\e[0m"
  194. return 0
  195. fi
  196. }
  197. while (($#)); do
  198. case "${1}" in
  199. --check|-c)
  200. echo "Checking remote code for updates..."
  201. LATEST_REV=$(git ls-remote --exit-code --refs --quiet https://github.com/mailcow/mailcow-dockerized ${BRANCH} | cut -f1)
  202. if [ $? -ne 0 ]; then
  203. echo "A problem occurred while trying to fetch the latest revision from github."
  204. exit 99
  205. fi
  206. if [[ -z $(git log HEAD --pretty=format:"%H" | grep "${LATEST_REV}") ]]; then
  207. echo -e "Updated code is available.\nThe changes can be found here: https://github.com/mailcow/mailcow-dockerized/commits/master"
  208. git log --date=short --pretty=format:"%ad - %s" $(git rev-parse --short HEAD)..origin/master
  209. exit 0
  210. else
  211. echo "No updates available."
  212. exit 3
  213. fi
  214. ;;
  215. --ours)
  216. MERGE_STRATEGY=ours
  217. ;;
  218. --skip-start)
  219. SKIP_START=y
  220. ;;
  221. --gc)
  222. echo -e "\e[32mCollecting garbage...\e[0m"
  223. docker_garbage
  224. exit 0
  225. ;;
  226. --prefetch)
  227. echo -e "\e[32mPrefetching images...\e[0m"
  228. prefetch_images
  229. exit 0
  230. ;;
  231. -f|--force)
  232. echo -e "\e[32mRunning in forced mode...\e[0m"
  233. FORCE=y
  234. ;;
  235. --skip-ping-check)
  236. SKIP_PING_CHECK=y
  237. ;;
  238. --help|-h)
  239. echo './update.sh [-c|--check, --ours, --gc, --no-update-compose, --prefetch, --skip-start, --skip-ping-check, -f|--force, -h|--help]
  240. -c|--check - Check for updates and exit (exit codes => 0: update available, 3: no updates)
  241. --ours - Use merge strategy option "ours" to solve conflicts in favor of non-mailcow code (local changes over remote changes), not recommended!
  242. --gc - Run garbage collector to delete old image tags
  243. --prefetch - Only prefetch new images and exit (useful to prepare updates)
  244. --skip-start - Do not start mailcow after update
  245. --skip-ping-check - Skip ICMP Check to public DNS resolvers (Use it only if you´ve blocked any ICMP Connections to your mailcow machine).
  246. -f|--force - Force update, do not ask questions
  247. '
  248. exit 1
  249. esac
  250. shift
  251. done
  252. [[ ! -f mailcow.conf ]] && { echo "mailcow.conf is missing"; exit 1;}
  253. chmod 600 mailcow.conf
  254. source mailcow.conf
  255. DOTS=${MAILCOW_HOSTNAME//[^.]};
  256. if [ ${#DOTS} -lt 2 ]; then
  257. echo "MAILCOW_HOSTNAME (${MAILCOW_HOSTNAME}) is not a FQDN!"
  258. echo "Please change it to a FQDN and run ${COMPOSE_COMMAND} down followed by ${COMPOSE_COMMAND} up -d"
  259. exit 1
  260. fi
  261. 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
  262. # This will also cover sort
  263. 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
  264. 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
  265. CONFIG_ARRAY=(
  266. "SKIP_LETS_ENCRYPT"
  267. "SKIP_SOGO"
  268. "USE_WATCHDOG"
  269. "WATCHDOG_NOTIFY_EMAIL"
  270. "WATCHDOG_NOTIFY_BAN"
  271. "WATCHDOG_EXTERNAL_CHECKS"
  272. "WATCHDOG_SUBJECT"
  273. "SKIP_CLAMD"
  274. "SKIP_IP_CHECK"
  275. "ADDITIONAL_SAN"
  276. "DOVEADM_PORT"
  277. "IPV4_NETWORK"
  278. "IPV6_NETWORK"
  279. "LOG_LINES"
  280. "SNAT_TO_SOURCE"
  281. "SNAT6_TO_SOURCE"
  282. "COMPOSE_PROJECT_NAME"
  283. "SQL_PORT"
  284. "API_KEY"
  285. "API_KEY_READ_ONLY"
  286. "API_ALLOW_FROM"
  287. "MAILDIR_GC_TIME"
  288. "MAILDIR_SUB"
  289. "ACL_ANYONE"
  290. "SOLR_HEAP"
  291. "SKIP_SOLR"
  292. "ENABLE_SSL_SNI"
  293. "ALLOW_ADMIN_EMAIL_LOGIN"
  294. "SKIP_HTTP_VERIFICATION"
  295. "SOGO_EXPIRE_SESSION"
  296. "REDIS_PORT"
  297. "DOVECOT_MASTER_USER"
  298. "DOVECOT_MASTER_PASS"
  299. "MAILCOW_PASS_SCHEME"
  300. "ADDITIONAL_SERVER_NAMES"
  301. "ACME_CONTACT"
  302. "WATCHDOG_VERBOSE"
  303. "WEBAUTHN_ONLY_TRUSTED_VENDORS"
  304. )
  305. sed -i --follow-symlinks '$a\' mailcow.conf
  306. for option in ${CONFIG_ARRAY[@]}; do
  307. if [[ ${option} == "ADDITIONAL_SAN" ]]; then
  308. if ! grep -q ${option} mailcow.conf; then
  309. echo "Adding new option \"${option}\" to mailcow.conf"
  310. echo "${option}=" >> mailcow.conf
  311. fi
  312. elif [[ ${option} == "COMPOSE_PROJECT_NAME" ]]; then
  313. if ! grep -q ${option} mailcow.conf; then
  314. echo "Adding new option \"${option}\" to mailcow.conf"
  315. echo "COMPOSE_PROJECT_NAME=mailcowdockerized" >> mailcow.conf
  316. fi
  317. elif [[ ${option} == "DOVEADM_PORT" ]]; then
  318. if ! grep -q ${option} mailcow.conf; then
  319. echo "Adding new option \"${option}\" to mailcow.conf"
  320. echo "DOVEADM_PORT=127.0.0.1:19991" >> mailcow.conf
  321. fi
  322. elif [[ ${option} == "WATCHDOG_NOTIFY_EMAIL" ]]; then
  323. if ! grep -q ${option} mailcow.conf; then
  324. echo "Adding new option \"${option}\" to mailcow.conf"
  325. echo "WATCHDOG_NOTIFY_EMAIL=" >> mailcow.conf
  326. fi
  327. elif [[ ${option} == "LOG_LINES" ]]; then
  328. if ! grep -q ${option} mailcow.conf; then
  329. echo "Adding new option \"${option}\" to mailcow.conf"
  330. echo '# Max log lines per service to keep in Redis logs' >> mailcow.conf
  331. echo "LOG_LINES=9999" >> mailcow.conf
  332. fi
  333. elif [[ ${option} == "IPV4_NETWORK" ]]; then
  334. if ! grep -q ${option} mailcow.conf; then
  335. echo "Adding new option \"${option}\" to mailcow.conf"
  336. echo '# Internal IPv4 /24 subnet, format n.n.n. (expands to n.n.n.0/24)' >> mailcow.conf
  337. echo "IPV4_NETWORK=172.22.1" >> mailcow.conf
  338. fi
  339. elif [[ ${option} == "IPV6_NETWORK" ]]; then
  340. if ! grep -q ${option} mailcow.conf; then
  341. echo "Adding new option \"${option}\" to mailcow.conf"
  342. echo '# Internal IPv6 subnet in fc00::/7' >> mailcow.conf
  343. echo "IPV6_NETWORK=fd4d:6169:6c63:6f77::/64" >> mailcow.conf
  344. fi
  345. elif [[ ${option} == "SQL_PORT" ]]; then
  346. if ! grep -q ${option} mailcow.conf; then
  347. echo "Adding new option \"${option}\" to mailcow.conf"
  348. echo '# Bind SQL to 127.0.0.1 on port 13306' >> mailcow.conf
  349. echo "SQL_PORT=127.0.0.1:13306" >> mailcow.conf
  350. fi
  351. elif [[ ${option} == "API_KEY" ]]; then
  352. if ! grep -q ${option} mailcow.conf; then
  353. echo "Adding new option \"${option}\" to mailcow.conf"
  354. echo '# Create or override API key for web UI' >> mailcow.conf
  355. echo "#API_KEY=" >> mailcow.conf
  356. fi
  357. elif [[ ${option} == "API_KEY_READ_ONLY" ]]; then
  358. if ! grep -q ${option} mailcow.conf; then
  359. echo "Adding new option \"${option}\" to mailcow.conf"
  360. echo '# Create or override read-only API key for web UI' >> mailcow.conf
  361. echo "#API_KEY_READ_ONLY=" >> mailcow.conf
  362. fi
  363. elif [[ ${option} == "API_ALLOW_FROM" ]]; then
  364. if ! grep -q ${option} mailcow.conf; then
  365. echo "Adding new option \"${option}\" to mailcow.conf"
  366. echo '# Must be set for API_KEY to be active' >> mailcow.conf
  367. echo '# IPs only, no networks (networks can be set via UI)' >> mailcow.conf
  368. echo "#API_ALLOW_FROM=" >> mailcow.conf
  369. fi
  370. elif [[ ${option} == "SNAT_TO_SOURCE" ]]; then
  371. if ! grep -q ${option} mailcow.conf; then
  372. echo "Adding new option \"${option}\" to mailcow.conf"
  373. echo '# Use this IPv4 for outgoing connections (SNAT)' >> mailcow.conf
  374. echo "#SNAT_TO_SOURCE=" >> mailcow.conf
  375. fi
  376. elif [[ ${option} == "SNAT6_TO_SOURCE" ]]; then
  377. if ! grep -q ${option} mailcow.conf; then
  378. echo "Adding new option \"${option}\" to mailcow.conf"
  379. echo '# Use this IPv6 for outgoing connections (SNAT)' >> mailcow.conf
  380. echo "#SNAT6_TO_SOURCE=" >> mailcow.conf
  381. fi
  382. elif [[ ${option} == "MAILDIR_GC_TIME" ]]; then
  383. if ! grep -q ${option} mailcow.conf; then
  384. echo "Adding new option \"${option}\" to mailcow.conf"
  385. echo '# Garbage collector cleanup' >> mailcow.conf
  386. echo '# Deleted domains and mailboxes are moved to /var/vmail/_garbage/timestamp_sanitizedstring' >> mailcow.conf
  387. echo '# How long should objects remain in the garbage until they are being deleted? (value in minutes)' >> mailcow.conf
  388. echo '# Check interval is hourly' >> mailcow.conf
  389. echo 'MAILDIR_GC_TIME=1440' >> mailcow.conf
  390. fi
  391. elif [[ ${option} == "ACL_ANYONE" ]]; then
  392. if ! grep -q ${option} mailcow.conf; then
  393. echo "Adding new option \"${option}\" to mailcow.conf"
  394. echo '# Set this to "allow" to enable the anyone pseudo user. Disabled by default.' >> mailcow.conf
  395. echo '# When enabled, ACL can be created, that apply to "All authenticated users"' >> mailcow.conf
  396. echo '# This should probably only be activated on mail hosts, that are used exclusivly by one organisation.' >> mailcow.conf
  397. echo '# Otherwise a user might share data with too many other users.' >> mailcow.conf
  398. echo 'ACL_ANYONE=disallow' >> mailcow.conf
  399. fi
  400. elif [[ ${option} == "SOLR_HEAP" ]]; then
  401. if ! grep -q ${option} mailcow.conf; then
  402. echo "Adding new option \"${option}\" to mailcow.conf"
  403. echo '# Solr heap size, there is no recommendation, please see Solr docs.' >> mailcow.conf
  404. echo '# Solr is a prone to run OOM on large systems and should be monitored. Unmonitored Solr setups are not recommended.' >> mailcow.conf
  405. echo '# Solr will refuse to start with total system memory below or equal to 2 GB.' >> mailcow.conf
  406. echo "SOLR_HEAP=1024" >> mailcow.conf
  407. fi
  408. elif [[ ${option} == "SKIP_SOLR" ]]; then
  409. if ! grep -q ${option} mailcow.conf; then
  410. echo "Adding new option \"${option}\" to mailcow.conf"
  411. echo '# Solr is disabled by default after upgrading from non-Solr to Solr-enabled mailcows.' >> mailcow.conf
  412. echo '# Disable Solr or if you do not want to store a readable index of your mails in solr-vol-1.' >> mailcow.conf
  413. echo "SKIP_SOLR=y" >> mailcow.conf
  414. fi
  415. elif [[ ${option} == "ENABLE_SSL_SNI" ]]; then
  416. if ! grep -q ${option} mailcow.conf; then
  417. echo "Adding new option \"${option}\" to mailcow.conf"
  418. echo '# Create seperate certificates for all domains - y/n' >> mailcow.conf
  419. echo '# this will allow adding more than 100 domains, but some email clients will not be able to connect with alternative hostnames' >> mailcow.conf
  420. echo '# see https://wiki.dovecot.org/SSL/SNIClientSupport' >> mailcow.conf
  421. echo "ENABLE_SSL_SNI=n" >> mailcow.conf
  422. fi
  423. elif [[ ${option} == "SKIP_SOGO" ]]; then
  424. if ! grep -q ${option} mailcow.conf; then
  425. echo "Adding new option \"${option}\" to mailcow.conf"
  426. echo '# Skip SOGo: Will disable SOGo integration and therefore webmail, DAV protocols and ActiveSync support (experimental, unsupported, not fully implemented) - y/n' >> mailcow.conf
  427. echo "SKIP_SOGO=n" >> mailcow.conf
  428. fi
  429. elif [[ ${option} == "MAILDIR_SUB" ]]; then
  430. if ! grep -q ${option} mailcow.conf; then
  431. echo "Adding new option \"${option}\" to mailcow.conf"
  432. echo '# MAILDIR_SUB defines a path in a users virtual home to keep the maildir in. Leave empty for updated setups.' >> mailcow.conf
  433. echo "#MAILDIR_SUB=Maildir" >> mailcow.conf
  434. echo "MAILDIR_SUB=" >> mailcow.conf
  435. fi
  436. elif [[ ${option} == "WATCHDOG_NOTIFY_BAN" ]]; then
  437. if ! grep -q ${option} mailcow.conf; then
  438. echo "Adding new option \"${option}\" to mailcow.conf"
  439. echo '# Notify about banned IP. Includes whois lookup.' >> mailcow.conf
  440. echo "WATCHDOG_NOTIFY_BAN=y" >> mailcow.conf
  441. fi
  442. elif [[ ${option} == "WATCHDOG_SUBJECT" ]]; then
  443. if ! grep -q ${option} mailcow.conf; then
  444. echo "Adding new option \"${option}\" to mailcow.conf"
  445. echo '# Subject for watchdog mails. Defaults to "Watchdog ALERT" followed by the error message.' >> mailcow.conf
  446. echo "#WATCHDOG_SUBJECT=" >> mailcow.conf
  447. fi
  448. elif [[ ${option} == "WATCHDOG_EXTERNAL_CHECKS" ]]; then
  449. if ! grep -q ${option} mailcow.conf; then
  450. echo "Adding new option \"${option}\" to mailcow.conf"
  451. echo '# Checks if mailcow is an open relay. Requires a SAL. More checks will follow.' >> mailcow.conf
  452. echo '# No data is collected. Opt-in and anonymous.' >> mailcow.conf
  453. echo '# Will only work with unmodified mailcow setups.' >> mailcow.conf
  454. echo "WATCHDOG_EXTERNAL_CHECKS=n" >> mailcow.conf
  455. fi
  456. elif [[ ${option} == "SOGO_EXPIRE_SESSION" ]]; then
  457. if ! grep -q ${option} mailcow.conf; then
  458. echo "Adding new option \"${option}\" to mailcow.conf"
  459. echo '# SOGo session timeout in minutes' >> mailcow.conf
  460. echo "SOGO_EXPIRE_SESSION=480" >> mailcow.conf
  461. fi
  462. elif [[ ${option} == "REDIS_PORT" ]]; then
  463. if ! grep -q ${option} mailcow.conf; then
  464. echo "Adding new option \"${option}\" to mailcow.conf"
  465. echo "REDIS_PORT=127.0.0.1:7654" >> mailcow.conf
  466. fi
  467. elif [[ ${option} == "DOVECOT_MASTER_USER" ]]; then
  468. if ! grep -q ${option} mailcow.conf; then
  469. echo "Adding new option \"${option}\" to mailcow.conf"
  470. echo '# DOVECOT_MASTER_USER and _PASS must _both_ be provided. No special chars.' >> mailcow.conf
  471. echo '# Empty by default to auto-generate master user and password on start.' >> mailcow.conf
  472. echo '# User expands to DOVECOT_MASTER_USER@mailcow.local' >> mailcow.conf
  473. echo '# LEAVE EMPTY IF UNSURE' >> mailcow.conf
  474. echo "DOVECOT_MASTER_USER=" >> mailcow.conf
  475. fi
  476. elif [[ ${option} == "DOVECOT_MASTER_PASS" ]]; then
  477. if ! grep -q ${option} mailcow.conf; then
  478. echo "Adding new option \"${option}\" to mailcow.conf"
  479. echo '# LEAVE EMPTY IF UNSURE' >> mailcow.conf
  480. echo "DOVECOT_MASTER_PASS=" >> mailcow.conf
  481. fi
  482. elif [[ ${option} == "MAILCOW_PASS_SCHEME" ]]; then
  483. if ! grep -q ${option} mailcow.conf; then
  484. echo "Adding new option \"${option}\" to mailcow.conf"
  485. echo '# Password hash algorithm' >> mailcow.conf
  486. echo '# Only certain password hash algorithm are supported. For a fully list of supported schemes,' >> mailcow.conf
  487. echo '# see https://mailcow.github.io/mailcow-dockerized-docs/models/model-passwd/' >> mailcow.conf
  488. echo "MAILCOW_PASS_SCHEME=BLF-CRYPT" >> mailcow.conf
  489. fi
  490. elif [[ ${option} == "ADDITIONAL_SERVER_NAMES" ]]; then
  491. if ! grep -q ${option} mailcow.conf; then
  492. echo '# Additional server names for mailcow UI' >> mailcow.conf
  493. echo '#' >> mailcow.conf
  494. echo '# Specify alternative addresses for the mailcow UI to respond to' >> mailcow.conf
  495. 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
  496. 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
  497. echo '# You can understand this as server_name directive in Nginx.' >> mailcow.conf
  498. echo '# Comma separated list without spaces! Example: ADDITIONAL_SERVER_NAMES=a.b.c,d.e.f' >> mailcow.conf
  499. echo 'ADDITIONAL_SERVER_NAMES=' >> mailcow.conf
  500. fi
  501. elif [[ ${option} == "ACME_CONTACT" ]]; then
  502. if ! grep -q ${option} mailcow.conf; then
  503. echo '# Lets Encrypt registration contact information' >> mailcow.conf
  504. echo '# Optional: Leave empty for none' >> mailcow.conf
  505. echo '# This value is only used on first order!' >> mailcow.conf
  506. echo '# Setting it at a later point will require the following steps:' >> mailcow.conf
  507. echo '# https://mailcow.github.io/mailcow-dockerized-docs/troubleshooting/debug-reset_tls/' >> mailcow.conf
  508. echo 'ACME_CONTACT=' >> mailcow.conf
  509. fi
  510. elif [[ ${option} == "WEBAUTHN_ONLY_TRUSTED_VENDORS" ]]; then
  511. if ! grep -q ${option} mailcow.conf; then
  512. echo "# WebAuthn device manufacturer verification" >> mailcow.conf
  513. echo '# After setting WEBAUTHN_ONLY_TRUSTED_VENDORS=y only devices from trusted manufacturers are allowed' >> mailcow.conf
  514. echo '# root certificates can be placed for validation under mailcow-dockerized/data/web/inc/lib/WebAuthn/rootCertificates' >> mailcow.conf
  515. echo 'WEBAUTHN_ONLY_TRUSTED_VENDORS=n' >> mailcow.conf
  516. fi
  517. elif [[ ${option} == "WATCHDOG_VERBOSE" ]]; then
  518. if ! grep -q ${option} mailcow.conf; then
  519. echo '# Enable watchdog verbose logging' >> mailcow.conf
  520. echo 'WATCHDOG_VERBOSE=n' >> mailcow.conf
  521. fi
  522. elif ! grep -q ${option} mailcow.conf; then
  523. echo "Adding new option \"${option}\" to mailcow.conf"
  524. echo "${option}=n" >> mailcow.conf
  525. fi
  526. done
  527. if [[( ${SKIP_PING_CHECK} == "y")]]; then
  528. echo -e "\e[32mSkipping Ping Check...\e[0m"
  529. else
  530. echo -en "Checking internet connection... "
  531. if ! check_online_status; then
  532. echo -e "\e[31mfailed\e[0m"
  533. exit 1
  534. else
  535. echo -e "\e[32mOK\e[0m"
  536. fi
  537. fi
  538. echo -e "\e[32mChecking for newer update script...\e[0m"
  539. SHA1_1=$(sha1sum update.sh)
  540. git fetch origin #${BRANCH}
  541. git checkout origin/${BRANCH} update.sh
  542. SHA1_2=$(sha1sum update.sh)
  543. if [[ ${SHA1_1} != ${SHA1_2} ]]; then
  544. echo "update.sh changed, please run this script again, exiting."
  545. chmod +x update.sh
  546. exit 2
  547. fi
  548. if [[ -f mailcow.conf ]]; then
  549. source mailcow.conf
  550. else
  551. echo -e "\e[31mNo mailcow.conf - is mailcow installed?\e[0m"
  552. exit 1
  553. fi
  554. if [ ! $FORCE ]; then
  555. read -r -p "Are you sure you want to update mailcow: dockerized? All containers will be stopped. [y/N] " response
  556. if [[ ! "${response}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  557. echo "OK, exiting."
  558. exit 0
  559. fi
  560. migrate_docker_nat
  561. fi
  562. echo -e "\e[32mValidating docker-compose stack configuration...\e[0m"
  563. if ! ${COMPOSE_COMMAND} config -q; then
  564. echo -e "\e[31m\nOh no, something went wrong. Please check the error message above.\e[0m"
  565. exit 1
  566. fi
  567. echo -e "\e[32mChecking for conflicting bridges...\e[0m"
  568. MAILCOW_BRIDGE=$(${COMPOSE_COMMAND} config | grep -i com.docker.network.bridge.name | cut -d':' -f2)
  569. while read NAT_ID; do
  570. iptables -t nat -D POSTROUTING $NAT_ID
  571. done < <(iptables -L -vn -t nat --line-numbers | grep $IPV4_NETWORK | grep -E 'MASQUERADE.*all' | grep -v ${MAILCOW_BRIDGE} | cut -d' ' -f1)
  572. DIFF_DIRECTORY=update_diffs
  573. DIFF_FILE=${DIFF_DIRECTORY}/diff_before_update_$(date +"%Y-%m-%d-%H-%M-%S")
  574. mv diff_before_update* ${DIFF_DIRECTORY}/ 2> /dev/null
  575. if ! git diff-index --quiet HEAD; then
  576. echo -e "\e[32mSaving diff to ${DIFF_FILE}...\e[0m"
  577. mkdir -p ${DIFF_DIRECTORY}
  578. git diff --stat > ${DIFF_FILE}
  579. git diff >> ${DIFF_FILE}
  580. fi
  581. echo -e "\e[32mPrefetching images...\e[0m"
  582. prefetch_images
  583. echo -e "\e[32mStopping mailcow...\e[0m"
  584. sleep 2
  585. MAILCOW_CONTAINERS=($(${COMPOSE_COMMAND} ps -q))
  586. ${COMPOSE_COMMAND} down
  587. echo -e "\e[32mChecking for remaining containers...\e[0m"
  588. sleep 2
  589. for container in "${MAILCOW_CONTAINERS[@]}"; do
  590. docker rm -f "$container" 2> /dev/null
  591. done
  592. [[ -f data/conf/nginx/ZZZ-ejabberd.conf ]] && rm data/conf/nginx/ZZZ-ejabberd.conf
  593. # Silently fixing remote url from andryyy to mailcow
  594. git remote set-url origin https://github.com/mailcow/mailcow-dockerized
  595. echo -e "\e[32mCommitting current status...\e[0m"
  596. [[ -z "$(git config user.name)" ]] && git config user.name moo
  597. [[ -z "$(git config user.email)" ]] && git config user.email moo@cow.moo
  598. [[ ! -z $(git ls-files data/conf/rspamd/override.d/worker-controller-password.inc) ]] && git rm data/conf/rspamd/override.d/worker-controller-password.inc
  599. git add -u
  600. git commit -am "Before update on ${DATE}" > /dev/null
  601. echo -e "\e[32mFetching updated code from remote...\e[0m"
  602. git fetch origin #${BRANCH}
  603. echo -e "\e[32mMerging local with remote code (recursive, strategy: \"${MERGE_STRATEGY:-theirs}\", options: \"patience\"...\e[0m"
  604. git config merge.defaultToUpstream true
  605. git merge -X${MERGE_STRATEGY:-theirs} -Xpatience -m "After update on ${DATE}"
  606. # Need to use a variable to not pass return codes of if checks
  607. MERGE_RETURN=$?
  608. if [[ ${MERGE_RETURN} == 128 ]]; then
  609. 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"
  610. exit 1
  611. elif [[ ${MERGE_RETURN} == 1 ]]; then
  612. echo -e "\e[93mPotenial conflict, trying to fix...\e[0m"
  613. git status --porcelain | grep -E "UD|DU" | awk '{print $2}' | xargs rm -v
  614. git add -A
  615. git commit -m "After update on ${DATE}" > /dev/null
  616. git checkout .
  617. echo -e "\e[32mRemoved and recreated files if necessary.\e[0m"
  618. elif [[ ${MERGE_RETURN} != 0 ]]; then
  619. echo -e "\e[31m\nOh no, something went wrong. Please check the error message above.\e[0m"
  620. echo
  621. echo "Run ${COMPOSE_COMMAND} up -d to restart your stack without updates or try again after fixing the mentioned errors."
  622. exit 1
  623. fi
  624. echo -e "\e[33mNot fetching latest docker-compose, please check for updates manually!\e[0m"
  625. sleep 3
  626. echo -e "\e[32mFetching new images, if any...\e[0m"
  627. sleep 2
  628. ${COMPOSE_COMMAND} pull
  629. # Fix missing SSL, does not overwrite existing files
  630. [[ ! -d data/assets/ssl ]] && mkdir -p data/assets/ssl
  631. cp -n -d data/assets/ssl-example/*.pem data/assets/ssl/
  632. echo -e "Checking IPv6 settings... "
  633. if grep -q 'SYSCTL_IPV6_DISABLED=1' mailcow.conf; then
  634. echo
  635. echo '!! IMPORTANT !!'
  636. echo
  637. 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".'
  638. echo 'This setting will only be active after a complete shutdown of mailcow by running "docker-compose down" followed by "docker-compose up -d".'
  639. echo
  640. echo '!! IMPORTANT !!'
  641. echo
  642. read -p "Press any key to continue..." < /dev/tty
  643. fi
  644. # Checking for old project name bug
  645. sed -i --follow-symlinks 's#COMPOSEPROJECT_NAME#COMPOSE_PROJECT_NAME#g' mailcow.conf
  646. # Fix Rspamd maps
  647. if [ -f data/conf/rspamd/custom/global_from_blacklist.map ]; then
  648. mv data/conf/rspamd/custom/global_from_blacklist.map data/conf/rspamd/custom/global_smtp_from_blacklist.map
  649. fi
  650. if [ -f data/conf/rspamd/custom/global_from_whitelist.map ]; then
  651. mv data/conf/rspamd/custom/global_from_whitelist.map data/conf/rspamd/custom/global_smtp_from_whitelist.map
  652. fi
  653. # Fix deprecated metrics.conf
  654. if [ -f "data/conf/rspamd/local.d/metrics.conf" ]; then
  655. if [ ! -z "$(git diff --name-only origin/master data/conf/rspamd/local.d/metrics.conf)" ]; then
  656. 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."
  657. echo "The deprecated configuration file metrics.conf will be moved to metrics.conf_deprecated after updating mailcow."
  658. fi
  659. mv data/conf/rspamd/local.d/metrics.conf data/conf/rspamd/local.d/metrics.conf_deprecated
  660. fi
  661. # Set app_info.inc.php
  662. mailcow_git_version=$(git describe --tags `git rev-list --tags --max-count=1`)
  663. if [ $? -eq 0 ]; then
  664. echo '<?php' > data/web/inc/app_info.inc.php
  665. echo ' $MAILCOW_GIT_VERSION="'$mailcow_git_version'";' >> data/web/inc/app_info.inc.php
  666. echo ' $MAILCOW_GIT_URL="https://github.com/mailcow/mailcow-dockerized";' >> data/web/inc/app_info.inc.php
  667. echo '?>' >> data/web/inc/app_info.inc.php
  668. else
  669. echo '<?php' > data/web/inc/app_info.inc.php
  670. echo ' $MAILCOW_GIT_VERSION="";' >> data/web/inc/app_info.inc.php
  671. echo ' $MAILCOW_GIT_URL="";' >> data/web/inc/app_info.inc.php
  672. echo '?>' >> data/web/inc/app_info.inc.php
  673. echo -e "\e[33mCannot determine current git repository version...\e[0m"
  674. fi
  675. if [[ ${SKIP_START} == "y" ]]; then
  676. echo -e "\e[33mNot starting mailcow, please run \"${COMPOSE_COMMAND} up -d --remove-orphans\" to start mailcow.\e[0m"
  677. else
  678. echo -e "\e[32mStarting mailcow...\e[0m"
  679. sleep 2
  680. ${COMPOSE_COMMAND} up -d --remove-orphans
  681. fi
  682. echo -e "\e[32mCollecting garbage...\e[0m"
  683. docker_garbage
  684. # Run post-update-hook
  685. if [ -f "${SCRIPT_DIR}/post_update_hook.sh" ]; then
  686. bash "${SCRIPT_DIR}/post_update_hook.sh"
  687. fi
  688. #echo "In case you encounter any problem, hard-reset to a state before updating mailcow:"
  689. #echo
  690. #git reflog --color=always | grep "Before update on "
  691. #echo
  692. #echo "Use \"git reset --hard hash-on-the-left\" and run ${COMPOSE_COMMAND} up -d afterwards."