update.sh 31 KB

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