update.sh 32 KB

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