update.sh 30 KB

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