update.sh 30 KB

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