update.sh 47 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039
  1. #!/usr/bin/env bash
  2. ############## Begin Function Section ##############
  3. check_online_status() {
  4. CHECK_ONLINE_DOMAINS=('https://github.com' 'https://hub.docker.com')
  5. for domain in "${CHECK_ONLINE_DOMAINS[@]}"; do
  6. if timeout 6 curl --head --silent --output /dev/null ${domain}; then
  7. return 0
  8. fi
  9. done
  10. return 1
  11. }
  12. prefetch_images() {
  13. [[ -z ${BRANCH} ]] && { echo -e "\e[33m\nUnknown branch...\e[0m"; exit 1; }
  14. git fetch origin #${BRANCH}
  15. while read image; do
  16. if [[ "${image}" == "robbertkl/ipv6nat" ]]; then
  17. if ! grep -qi "ipv6nat-mailcow" docker-compose.yml || grep -qi "enable_ipv6: false" docker-compose.yml; then
  18. continue
  19. fi
  20. fi
  21. RET_C=0
  22. until docker pull ${image}; do
  23. RET_C=$((RET_C + 1))
  24. echo -e "\e[33m\nError pulling $image, retrying...\e[0m"
  25. [ ${RET_C} -gt 3 ] && { echo -e "\e[31m\nToo many failed retries, exiting\e[0m"; exit 1; }
  26. sleep 1
  27. done
  28. done < <(git show origin/${BRANCH}:docker-compose.yml | grep "image:" | awk '{ gsub("image:","", $3); print $2 }')
  29. }
  30. docker_garbage() {
  31. IMGS_TO_DELETE=()
  32. for container in $(grep -oP "image: \Kmailcow.+" "${SCRIPT_DIR}/docker-compose.yml"); do
  33. REPOSITORY=${container/:*}
  34. TAG=${container/*:}
  35. V_MAIN=${container/*.}
  36. V_SUB=${container/*.}
  37. EXISTING_TAGS=$(docker images | grep ${REPOSITORY} | awk '{ print $2 }')
  38. for existing_tag in ${EXISTING_TAGS[@]}; do
  39. V_MAIN_EXISTING=${existing_tag/*.}
  40. V_SUB_EXISTING=${existing_tag/*.}
  41. # Not an integer
  42. [[ ! $V_MAIN_EXISTING =~ ^[0-9]+$ ]] && continue
  43. [[ ! $V_SUB_EXISTING =~ ^[0-9]+$ ]] && continue
  44. if [[ $V_MAIN_EXISTING == "latest" ]]; then
  45. echo "Found deprecated label \"latest\" for repository $REPOSITORY, it should be deleted."
  46. IMGS_TO_DELETE+=($REPOSITORY:$existing_tag)
  47. elif [[ $V_MAIN_EXISTING -lt $V_MAIN ]]; then
  48. echo "Found tag $existing_tag for $REPOSITORY, which is older than the current tag $TAG and should be deleted."
  49. IMGS_TO_DELETE+=($REPOSITORY:$existing_tag)
  50. elif [[ $V_SUB_EXISTING -lt $V_SUB ]]; then
  51. echo "Found tag $existing_tag for $REPOSITORY, which is older than the current tag $TAG and should be deleted."
  52. IMGS_TO_DELETE+=($REPOSITORY:$existing_tag)
  53. fi
  54. done
  55. done
  56. if [[ ! -z ${IMGS_TO_DELETE[*]} ]]; then
  57. echo "Run the following command to delete unused image tags:"
  58. echo
  59. echo " docker rmi ${IMGS_TO_DELETE[*]}"
  60. echo
  61. if [ ! $FORCE ]; then
  62. read -r -p "Do you want to delete old image tags right now? [y/N] " response
  63. if [[ "$response" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  64. docker rmi ${IMGS_TO_DELETE[*]}
  65. else
  66. echo "OK, skipped."
  67. fi
  68. else
  69. echo "Running image removal without extra confirmation due to force mode."
  70. docker rmi ${IMGS_TO_DELETE[*]}
  71. fi
  72. echo -e "\e[32mFurther cleanup...\e[0m"
  73. 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\""
  74. fi
  75. }
  76. in_array() {
  77. local e match="$1"
  78. shift
  79. for e; do [[ "$e" == "$match" ]] && return 0; done
  80. return 1
  81. }
  82. migrate_docker_nat() {
  83. NAT_CONFIG='{"ipv6":true,"fixed-cidr-v6":"fd00:dead:beef:c0::/80","experimental":true,"ip6tables":true}'
  84. # Min Docker version
  85. DOCKERV_REQ=20.10.2
  86. # Current Docker version
  87. DOCKERV_CUR=$(docker version -f '{{.Server.Version}}')
  88. if grep -qi "ipv6nat-mailcow" docker-compose.yml && grep -qi "enable_ipv6: true" docker-compose.yml; then
  89. echo -e "\e[32mNative IPv6 implementation available.\e[0m"
  90. echo "This will enable experimental features in the Docker daemon and configure Docker to do the IPv6 NATing instead of ipv6nat-mailcow."
  91. echo '!!! This step is recommended !!!'
  92. echo "mailcow will try to roll back the changes if starting Docker fails after modifying the daemon.json configuration file."
  93. read -r -p "Should we try to enable the native IPv6 implementation in Docker now (recommended)? [y/N] " dockernatresponse
  94. if [[ ! "${dockernatresponse}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  95. echo "OK, skipping this step."
  96. return 0
  97. fi
  98. fi
  99. # Sort versions and check if we are running a newer or equal version to req
  100. if [ $(printf "${DOCKERV_REQ}\n${DOCKERV_CUR}" | sort -V | tail -n1) == "${DOCKERV_CUR}" ]; then
  101. # If Dockerd daemon json exists
  102. if [ -s /etc/docker/daemon.json ]; then
  103. IFS=',' read -r -a dockerconfig <<< $(cat /etc/docker/daemon.json | tr -cd '[:alnum:],')
  104. if ! in_array ipv6true "${dockerconfig[@]}" || \
  105. ! in_array experimentaltrue "${dockerconfig[@]}" || \
  106. ! in_array ip6tablestrue "${dockerconfig[@]}" || \
  107. ! grep -qi "fixed-cidr-v6" /etc/docker/daemon.json; then
  108. 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."
  109. echo "You will need to merge your existing configuration manually or fix/delete the existing daemon.json configuration before trying the update process again."
  110. echo -e "Please merge the following content and restart the Docker daemon:\n"
  111. echo ${NAT_CONFIG}
  112. return 1
  113. fi
  114. else
  115. echo "Working on IPv6 NAT, please wait..."
  116. echo ${NAT_CONFIG} > /etc/docker/daemon.json
  117. ip6tables -F -t nat
  118. [[ -e /etc/alpine-release ]] && rc-service docker restart || systemctl restart docker.service
  119. if [[ $? -ne 0 ]]; then
  120. echo -e "\e[31mError:\e[0m Failed to activate IPv6 NAT! Reverting and exiting."
  121. rm /etc/docker/daemon.json
  122. if [[ -e /etc/alpine-release ]]; then
  123. rc-service docker restart
  124. else
  125. systemctl reset-failed docker.service
  126. systemctl restart docker.service
  127. fi
  128. return 1
  129. fi
  130. fi
  131. # Removing legacy container
  132. sed -i '/ipv6nat-mailcow:$/,/^$/d' docker-compose.yml
  133. if [ -s docker-compose.override.yml ]; then
  134. sed -i '/ipv6nat-mailcow:$/,/^$/d' docker-compose.override.yml
  135. if [[ "$(cat docker-compose.override.yml | sed '/^\s*$/d' | wc -l)" == "2" ]]; then
  136. mv docker-compose.override.yml docker-compose.override.yml_backup
  137. fi
  138. fi
  139. echo -e "\e[32mGreat! \e[0mNative IPv6 NAT is active.\e[0m"
  140. else
  141. echo -e "\e[31mPlease upgrade Docker to version ${DOCKERV_REQ} or above.\e[0m"
  142. return 0
  143. fi
  144. }
  145. remove_obsolete_nginx_ports() {
  146. # Removing obsolete docker-compose.override.yml
  147. for override in docker-compose.override.yml docker-compose.override.yaml; do
  148. if [ -s $override ] ; then
  149. if cat $override | grep nginx-mailcow > /dev/null 2>&1; then
  150. if cat $override | grep -E '(\[::])' > /dev/null 2>&1; then
  151. if cat $override | grep -w 80:80 > /dev/null 2>&1 && cat $override | grep -w 443:443 > /dev/null 2>&1 ; then
  152. echo -e "\e[33mBacking up ${override} to preserve custom changes...\e[0m"
  153. echo -e "\e[33m!!! Manual Merge needed (if other overrides are set) !!!\e[0m"
  154. sleep 3
  155. cp $override ${override}_backup
  156. sed -i '/nginx-mailcow:$/,/^$/d' $override
  157. echo -e "\e[33mRemoved obsolete NGINX IPv6 Bind from original override File.\e[0m"
  158. if [[ "$(cat $override | sed '/^\s*$/d' | wc -l)" == "2" ]]; then
  159. mv $override ${override}_empty
  160. echo -e "\e[31m${override} is empty. Renamed it to ensure mailcow is startable.\e[0m"
  161. fi
  162. fi
  163. fi
  164. fi
  165. fi
  166. done
  167. }
  168. detect_docker_compose_command(){
  169. if ! [[ "${DOCKER_COMPOSE_VERSION}" =~ ^(native|standalone)$ ]]; then
  170. if docker compose > /dev/null 2>&1; then
  171. if docker compose version --short | grep "2." > /dev/null 2>&1; then
  172. DOCKER_COMPOSE_VERSION=native
  173. COMPOSE_COMMAND="docker compose"
  174. echo -e "\e[33mFound Docker Compose Plugin (native).\e[0m"
  175. echo -e "\e[33mSetting the DOCKER_COMPOSE_VERSION Variable to native\e[0m"
  176. sed -i 's/^DOCKER_COMPOSE_VERSION=.*/DOCKER_COMPOSE_VERSION=native/' $SCRIPT_DIR/mailcow.conf
  177. sleep 2
  178. echo -e "\e[33mNotice: You'll have to update this Compose Version via your Package Manager manually!\e[0m"
  179. else
  180. echo -e "\e[31mCannot find Docker Compose with a Version Higher than 2.X.X.\e[0m"
  181. echo -e "\e[31mPlease update/install it manually regarding to this doc site: https://docs.mailcow.email/i_u_m/i_u_m_install/\e[0m"
  182. exit 1
  183. fi
  184. elif docker-compose > /dev/null 2>&1; then
  185. if ! [[ $(alias docker-compose 2> /dev/null) ]] ; then
  186. if docker-compose version --short | grep "^2." > /dev/null 2>&1; then
  187. DOCKER_COMPOSE_VERSION=standalone
  188. COMPOSE_COMMAND="docker-compose"
  189. echo -e "\e[33mFound Docker Compose Standalone.\e[0m"
  190. echo -e "\e[33mSetting the DOCKER_COMPOSE_VERSION Variable to standalone\e[0m"
  191. sed -i 's/^DOCKER_COMPOSE_VERSION=.*/DOCKER_COMPOSE_VERSION=standalone/' $SCRIPT_DIR/mailcow.conf
  192. sleep 2
  193. echo -e "\e[33mNotice: For an automatic update of docker-compose please use the update_compose.sh scripts located at the helper-scripts folder.\e[0m"
  194. else
  195. echo -e "\e[31mCannot find Docker Compose with a Version Higher than 2.X.X.\e[0m"
  196. echo -e "\e[31mPlease update/install regarding to this doc site: https://docs.mailcow.email/i_u_m/i_u_m_install/\e[0m"
  197. exit 1
  198. fi
  199. fi
  200. else
  201. echo -e "\e[31mCannot find Docker Compose.\e[0m"
  202. echo -e "\e[31mPlease install it regarding to this doc site: https://docs.mailcow.email/i_u_m/i_u_m_install/\e[0m"
  203. exit 1
  204. fi
  205. elif [ "${DOCKER_COMPOSE_VERSION}" == "native" ]; then
  206. COMPOSE_COMMAND="docker compose"
  207. # Check if Native Compose works and has not been deleted
  208. if ! $COMPOSE_COMMAND > /dev/null 2>&1; then
  209. # IF it not exists/work anymore try the other command
  210. COMPOSE_COMMAND="docker-compose"
  211. if ! $COMPOSE_COMMAND > /dev/null 2>&1 || ! $COMPOSE_COMMAND --version | grep "^2." > /dev/null 2>&1; then
  212. # IF it cannot find Standalone in > 2.X, then script stops
  213. echo -e "\e[31mCannot find Docker Compose or the Version is lower then 2.X.X.\e[0m"
  214. echo -e "\e[31mPlease install it regarding to this doc site: https://docs.mailcow.email/i_u_m/i_u_m_install/\e[0m"
  215. exit 1
  216. fi
  217. # If it finds the standalone Plugin it will use this instead and change the mailcow.conf Variable accordingly
  218. echo -e "\e[31mFound different Docker Compose Version then declared in mailcow.conf!\e[0m"
  219. echo -e "\e[31mSetting the DOCKER_COMPOSE_VERSION Variable from native to standalone\e[0m"
  220. sed -i 's/^DOCKER_COMPOSE_VERSION=.*/DOCKER_COMPOSE_VERSION=standalone/' $SCRIPT_DIR/mailcow.conf
  221. sleep 2
  222. fi
  223. elif [ "${DOCKER_COMPOSE_VERSION}" == "standalone" ]; then
  224. COMPOSE_COMMAND="docker-compose"
  225. # Check if Standalone Compose works and has not been deleted
  226. if ! $COMPOSE_COMMAND > /dev/null 2>&1 && ! $COMPOSE_COMMAND --version > /dev/null 2>&1 | grep "^2." > /dev/null 2>&1; then
  227. # IF it not exists/work anymore try the other command
  228. COMPOSE_COMMAND="docker compose"
  229. if ! $COMPOSE_COMMAND > /dev/null 2>&1; then
  230. # IF it cannot find Native in > 2.X, then script stops
  231. echo -e "\e[31mCannot find Docker Compose.\e[0m"
  232. echo -e "\e[31mPlease install it regarding to this doc site: https://docs.mailcow.email/i_u_m/i_u_m_install/\e[0m"
  233. exit 1
  234. fi
  235. # If it finds the native Plugin it will use this instead and change the mailcow.conf Variable accordingly
  236. echo -e "\e[31mFound different Docker Compose Version then declared in mailcow.conf!\e[0m"
  237. echo -e "\e[31mSetting the DOCKER_COMPOSE_VERSION Variable from standalone to native\e[0m"
  238. sed -i 's/^DOCKER_COMPOSE_VERSION=.*/DOCKER_COMPOSE_VERSION=native/' $SCRIPT_DIR/mailcow.conf
  239. sleep 2
  240. fi
  241. fi
  242. }
  243. detect_bad_asn() {
  244. echo -e "\e[33mDetecting if your IP is listed on Spamhaus Bad ASN List...\e[0m"
  245. response=$(curl --connect-timeout 15 --max-time 30 -s -o /dev/null -w "%{http_code}" "https://asn-check.mailcow.email")
  246. if [ "$response" -eq 503 ]; then
  247. if [ -z "$SPAMHAUS_DQS_KEY" ]; then
  248. echo -e "\e[33mYour server's public IP uses an AS that is blocked by Spamhaus to use their DNS public blocklists for Postfix.\e[0m"
  249. echo -e "\e[33mmailcow did not detected a value for the variable SPAMHAUS_DQS_KEY inside mailcow.conf!\e[0m"
  250. sleep 2
  251. echo ""
  252. echo -e "\e[33mTo use the Spamhaus DNS Blocklists again, you will need to create a FREE account for their Data Query Service (DQS) at: https://www.spamhaus.com/free-trial/sign-up-for-a-free-data-query-service-account\e[0m"
  253. echo -e "\e[33mOnce done, enter your DQS API key in mailcow.conf and mailcow will do the rest for you!\e[0m"
  254. echo ""
  255. sleep 2
  256. else
  257. echo -e "\e[33mYour server's public IP uses an AS that is blocked by Spamhaus to use their DNS public blocklists for Postfix.\e[0m"
  258. echo -e "\e[32mmailcow detected a Value for the variable SPAMHAUS_DQS_KEY inside mailcow.conf. Postfix will use DQS with the given API key...\e[0m"
  259. fi
  260. elif [ "$response" -eq 200 ]; then
  261. echo -e "\e[33mCheck completed! Your IP is \e[32mclean\e[0m"
  262. elif [ "$response" -eq 429 ]; then
  263. echo -e "\e[33mCheck completed! \e[31mYour IP seems to be rate limited on the ASN Check service... please try again later!\e[0m"
  264. else
  265. echo -e "\e[31mCheck failed! \e[0mMaybe a DNS or Network problem?\e[0m"
  266. fi
  267. }
  268. ############## End Function Section ##############
  269. # Check permissions
  270. if [ "$(id -u)" -ne "0" ]; then
  271. echo "You need to be root"
  272. exit 1
  273. fi
  274. SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
  275. # Run pre-update-hook
  276. if [ -f "${SCRIPT_DIR}/pre_update_hook.sh" ]; then
  277. bash "${SCRIPT_DIR}/pre_update_hook.sh"
  278. fi
  279. if [[ "$(uname -r)" =~ ^4\.15\.0-60 ]]; then
  280. echo "DO NOT RUN mailcow ON THIS UBUNTU KERNEL!";
  281. echo "Please update to 5.x or use another distribution."
  282. exit 1
  283. fi
  284. if [[ "$(uname -r)" =~ ^4\.4\. ]]; then
  285. if grep -q Ubuntu <<< $(uname -a); then
  286. echo "DO NOT RUN mailcow ON THIS UBUNTU KERNEL!"
  287. echo "Please update to linux-generic-hwe-16.04 by running \"apt-get install --install-recommends linux-generic-hwe-16.04\""
  288. exit 1
  289. fi
  290. 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."
  291. read -p "Press any key to continue..." < /dev/tty
  292. fi
  293. # Exit on error and pipefail
  294. set -o pipefail
  295. # Setting high dc timeout
  296. export COMPOSE_HTTP_TIMEOUT=600
  297. # Add /opt/bin to PATH
  298. PATH=$PATH:/opt/bin
  299. umask 0022
  300. # Unset COMPOSE_COMMAND and DOCKER_COMPOSE_VERSION Variable to be on the newest state.
  301. unset COMPOSE_COMMAND
  302. unset DOCKER_COMPOSE_VERSION
  303. for bin in curl docker git awk sha1sum grep cut; do
  304. if [[ -z $(command -v ${bin}) ]]; then
  305. echo "Cannot find ${bin}, exiting..."
  306. exit 1;
  307. fi
  308. done
  309. export LC_ALL=C
  310. DATE=$(date +%Y-%m-%d_%H_%M_%S)
  311. BRANCH=$(cd ${SCRIPT_DIR}; git rev-parse --abbrev-ref HEAD)
  312. while (($#)); do
  313. case "${1}" in
  314. --check|-c)
  315. echo "Checking remote code for updates..."
  316. LATEST_REV=$(git ls-remote --exit-code --refs --quiet https://github.com/mailcow/mailcow-dockerized ${BRANCH} | cut -f1)
  317. if [ $? -ne 0 ]; then
  318. echo "A problem occurred while trying to fetch the latest revision from github."
  319. exit 99
  320. fi
  321. if [[ -z $(git log HEAD --pretty=format:"%H" | grep "${LATEST_REV}") ]]; then
  322. echo -e "Updated code is available.\nThe changes can be found here: https://github.com/mailcow/mailcow-dockerized/commits/master"
  323. git log --date=short --pretty=format:"%ad - %s" $(git rev-parse --short HEAD)..origin/master
  324. exit 0
  325. else
  326. echo "No updates available."
  327. exit 3
  328. fi
  329. ;;
  330. --ours)
  331. MERGE_STRATEGY=ours
  332. ;;
  333. --skip-start)
  334. SKIP_START=y
  335. ;;
  336. --skip-ping-check)
  337. SKIP_PING_CHECK=y
  338. ;;
  339. --stable)
  340. CURRENT_BRANCH="$(cd ${SCRIPT_DIR}; git rev-parse --abbrev-ref HEAD)"
  341. NEW_BRANCH="master"
  342. ;;
  343. --gc)
  344. echo -e "\e[32mCollecting garbage...\e[0m"
  345. docker_garbage
  346. exit 0
  347. ;;
  348. --nightly)
  349. CURRENT_BRANCH="$(cd ${SCRIPT_DIR}; git rev-parse --abbrev-ref HEAD)"
  350. NEW_BRANCH="nightly"
  351. ;;
  352. --prefetch)
  353. echo -e "\e[32mPrefetching images...\e[0m"
  354. prefetch_images
  355. exit 0
  356. ;;
  357. -f|--force)
  358. echo -e "\e[32mRunning in forced mode...\e[0m"
  359. FORCE=y
  360. ;;
  361. -d|--dev)
  362. echo -e "\e[32mRunning in Developer mode...\e[0m"
  363. DEV=y
  364. ;;
  365. --help|-h)
  366. echo './update.sh [-c|--check, --ours, --gc, --nightly, --prefetch, --skip-start, --skip-ping-check, --stable, -f|--force, -d|--dev, -h|--help]
  367. -c|--check - Check for updates and exit (exit codes => 0: update available, 3: no updates)
  368. --ours - Use merge strategy option "ours" to solve conflicts in favor of non-mailcow code (local changes over remote changes), not recommended!
  369. --gc - Run garbage collector to delete old image tags
  370. --nightly - Switch your mailcow updates to the unstable (nightly) branch. FOR TESTING PURPOSES ONLY!!!!
  371. --prefetch - Only prefetch new images and exit (useful to prepare updates)
  372. --skip-start - Do not start mailcow after update
  373. --skip-ping-check - Skip ICMP Check to public DNS resolvers (Use it only if you´ve blocked any ICMP Connections to your mailcow machine)
  374. --stable - Switch your mailcow updates to the stable (master) branch. Default unless you changed it with --nightly.
  375. -f|--force - Force update, do not ask questions
  376. -d|--dev - Enables Developer Mode (No Checkout of update.sh for tests)
  377. '
  378. exit 1
  379. esac
  380. shift
  381. done
  382. chmod 600 mailcow.conf
  383. source mailcow.conf
  384. detect_docker_compose_command
  385. [[ ! -f mailcow.conf ]] && { echo "mailcow.conf is missing! Is mailcow installed?"; exit 1;}
  386. DOTS=${MAILCOW_HOSTNAME//[^.]};
  387. if [ ${#DOTS} -lt 1 ]; then
  388. echo -e "\e[31mMAILCOW_HOSTNAME (${MAILCOW_HOSTNAME}) is not a FQDN!\e[0m"
  389. sleep 1
  390. echo "Please change it to a FQDN and redeploy the stack with $COMPOSE_COMMAND up -d"
  391. exit 1
  392. elif [[ "${MAILCOW_HOSTNAME: -1}" == "." ]]; then
  393. echo "MAILCOW_HOSTNAME (${MAILCOW_HOSTNAME}) is ending with a dot. This is not a valid FQDN!"
  394. exit 1
  395. elif [ ${#DOTS} -eq 1 ]; then
  396. echo -e "\e[33mMAILCOW_HOSTNAME (${MAILCOW_HOSTNAME}) does not contain a Subdomain. This is not fully tested and may cause issues.\e[0m"
  397. echo "Find more information about why this message exists here: https://github.com/mailcow/mailcow-dockerized/issues/1572"
  398. read -r -p "Do you want to proceed anyway? [y/N] " response
  399. if [[ "$response" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  400. echo "OK. Procceding."
  401. else
  402. echo "OK. Exiting."
  403. exit 1
  404. fi
  405. fi
  406. 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
  407. # This will also cover sort
  408. 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
  409. 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
  410. CONFIG_ARRAY=(
  411. "SKIP_LETS_ENCRYPT"
  412. "SKIP_SOGO"
  413. "USE_WATCHDOG"
  414. "WATCHDOG_NOTIFY_EMAIL"
  415. "WATCHDOG_NOTIFY_BAN"
  416. "WATCHDOG_EXTERNAL_CHECKS"
  417. "WATCHDOG_SUBJECT"
  418. "SKIP_CLAMD"
  419. "SKIP_IP_CHECK"
  420. "ADDITIONAL_SAN"
  421. "DOVEADM_PORT"
  422. "IPV4_NETWORK"
  423. "IPV6_NETWORK"
  424. "LOG_LINES"
  425. "SNAT_TO_SOURCE"
  426. "SNAT6_TO_SOURCE"
  427. "COMPOSE_PROJECT_NAME"
  428. "DOCKER_COMPOSE_VERSION"
  429. "SQL_PORT"
  430. "API_KEY"
  431. "API_KEY_READ_ONLY"
  432. "API_ALLOW_FROM"
  433. "MAILDIR_GC_TIME"
  434. "MAILDIR_SUB"
  435. "ACL_ANYONE"
  436. "SOLR_HEAP"
  437. "SKIP_SOLR"
  438. "ENABLE_SSL_SNI"
  439. "ALLOW_ADMIN_EMAIL_LOGIN"
  440. "SKIP_HTTP_VERIFICATION"
  441. "SOGO_EXPIRE_SESSION"
  442. "REDIS_PORT"
  443. "DOVECOT_MASTER_USER"
  444. "DOVECOT_MASTER_PASS"
  445. "MAILCOW_PASS_SCHEME"
  446. "ADDITIONAL_SERVER_NAMES"
  447. "ACME_CONTACT"
  448. "WATCHDOG_VERBOSE"
  449. "WEBAUTHN_ONLY_TRUSTED_VENDORS"
  450. "SPAMHAUS_DQS_KEY"
  451. )
  452. detect_bad_asn
  453. sed -i --follow-symlinks '$a\' mailcow.conf
  454. for option in ${CONFIG_ARRAY[@]}; do
  455. if [[ ${option} == "ADDITIONAL_SAN" ]]; then
  456. if ! grep -q ${option} mailcow.conf; then
  457. echo "Adding new option \"${option}\" to mailcow.conf"
  458. echo "${option}=" >> mailcow.conf
  459. fi
  460. elif [[ ${option} == "COMPOSE_PROJECT_NAME" ]]; then
  461. if ! grep -q ${option} mailcow.conf; then
  462. echo "Adding new option \"${option}\" to mailcow.conf"
  463. echo "COMPOSE_PROJECT_NAME=mailcowdockerized" >> mailcow.conf
  464. fi
  465. elif [[ ${option} == "DOCKER_COMPOSE_VERSION" ]]; then
  466. if ! grep -q ${option} mailcow.conf; then
  467. echo "Adding new option \"${option}\" to mailcow.conf"
  468. echo "# Used Docker Compose version" >> mailcow.conf
  469. echo "# Switch here between native (compose plugin) and standalone" >> mailcow.conf
  470. echo "# For more informations take a look at the mailcow docs regarding the configuration options." >> mailcow.conf
  471. echo "# Normally this should be untouched but if you decided to use either of those you can switch it manually here." >> mailcow.conf
  472. echo "# Please be aware that at least one of those variants should be installed on your maschine or mailcow will fail." >> mailcow.conf
  473. echo "" >> mailcow.conf
  474. echo "DOCKER_COMPOSE_VERSION=${DOCKER_COMPOSE_VERSION}" >> mailcow.conf
  475. fi
  476. elif [[ ${option} == "DOVEADM_PORT" ]]; then
  477. if ! grep -q ${option} mailcow.conf; then
  478. echo "Adding new option \"${option}\" to mailcow.conf"
  479. echo "DOVEADM_PORT=127.0.0.1:19991" >> mailcow.conf
  480. fi
  481. elif [[ ${option} == "WATCHDOG_NOTIFY_EMAIL" ]]; then
  482. if ! grep -q ${option} mailcow.conf; then
  483. echo "Adding new option \"${option}\" to mailcow.conf"
  484. echo "WATCHDOG_NOTIFY_EMAIL=" >> mailcow.conf
  485. fi
  486. elif [[ ${option} == "LOG_LINES" ]]; then
  487. if ! grep -q ${option} mailcow.conf; then
  488. echo "Adding new option \"${option}\" to mailcow.conf"
  489. echo '# Max log lines per service to keep in Redis logs' >> mailcow.conf
  490. echo "LOG_LINES=9999" >> mailcow.conf
  491. fi
  492. elif [[ ${option} == "IPV4_NETWORK" ]]; then
  493. if ! grep -q ${option} mailcow.conf; then
  494. echo "Adding new option \"${option}\" to mailcow.conf"
  495. echo '# Internal IPv4 /24 subnet, format n.n.n. (expands to n.n.n.0/24)' >> mailcow.conf
  496. echo "IPV4_NETWORK=172.22.1" >> mailcow.conf
  497. fi
  498. elif [[ ${option} == "IPV6_NETWORK" ]]; then
  499. if ! grep -q ${option} mailcow.conf; then
  500. echo "Adding new option \"${option}\" to mailcow.conf"
  501. echo '# Internal IPv6 subnet in fc00::/7' >> mailcow.conf
  502. echo "IPV6_NETWORK=fd4d:6169:6c63:6f77::/64" >> mailcow.conf
  503. fi
  504. elif [[ ${option} == "SQL_PORT" ]]; then
  505. if ! grep -q ${option} mailcow.conf; then
  506. echo "Adding new option \"${option}\" to mailcow.conf"
  507. echo '# Bind SQL to 127.0.0.1 on port 13306' >> mailcow.conf
  508. echo "SQL_PORT=127.0.0.1:13306" >> mailcow.conf
  509. fi
  510. elif [[ ${option} == "API_KEY" ]]; then
  511. if ! grep -q ${option} mailcow.conf; then
  512. echo "Adding new option \"${option}\" to mailcow.conf"
  513. echo '# Create or override API key for web UI' >> mailcow.conf
  514. echo "#API_KEY=" >> mailcow.conf
  515. fi
  516. elif [[ ${option} == "API_KEY_READ_ONLY" ]]; then
  517. if ! grep -q ${option} mailcow.conf; then
  518. echo "Adding new option \"${option}\" to mailcow.conf"
  519. echo '# Create or override read-only API key for web UI' >> mailcow.conf
  520. echo "#API_KEY_READ_ONLY=" >> mailcow.conf
  521. fi
  522. elif [[ ${option} == "API_ALLOW_FROM" ]]; then
  523. if ! grep -q ${option} mailcow.conf; then
  524. echo "Adding new option \"${option}\" to mailcow.conf"
  525. echo '# Must be set for API_KEY to be active' >> mailcow.conf
  526. echo '# IPs only, no networks (networks can be set via UI)' >> mailcow.conf
  527. echo "#API_ALLOW_FROM=" >> mailcow.conf
  528. fi
  529. elif [[ ${option} == "SNAT_TO_SOURCE" ]]; then
  530. if ! grep -q ${option} mailcow.conf; then
  531. echo "Adding new option \"${option}\" to mailcow.conf"
  532. echo '# Use this IPv4 for outgoing connections (SNAT)' >> mailcow.conf
  533. echo "#SNAT_TO_SOURCE=" >> mailcow.conf
  534. fi
  535. elif [[ ${option} == "SNAT6_TO_SOURCE" ]]; then
  536. if ! grep -q ${option} mailcow.conf; then
  537. echo "Adding new option \"${option}\" to mailcow.conf"
  538. echo '# Use this IPv6 for outgoing connections (SNAT)' >> mailcow.conf
  539. echo "#SNAT6_TO_SOURCE=" >> mailcow.conf
  540. fi
  541. elif [[ ${option} == "MAILDIR_GC_TIME" ]]; then
  542. if ! grep -q ${option} mailcow.conf; then
  543. echo "Adding new option \"${option}\" to mailcow.conf"
  544. echo '# Garbage collector cleanup' >> mailcow.conf
  545. echo '# Deleted domains and mailboxes are moved to /var/vmail/_garbage/timestamp_sanitizedstring' >> mailcow.conf
  546. echo '# How long should objects remain in the garbage until they are being deleted? (value in minutes)' >> mailcow.conf
  547. echo '# Check interval is hourly' >> mailcow.conf
  548. echo 'MAILDIR_GC_TIME=1440' >> mailcow.conf
  549. fi
  550. elif [[ ${option} == "ACL_ANYONE" ]]; then
  551. if ! grep -q ${option} mailcow.conf; then
  552. echo "Adding new option \"${option}\" to mailcow.conf"
  553. echo '# Set this to "allow" to enable the anyone pseudo user. Disabled by default.' >> mailcow.conf
  554. echo '# When enabled, ACL can be created, that apply to "All authenticated users"' >> mailcow.conf
  555. echo '# This should probably only be activated on mail hosts, that are used exclusivly by one organisation.' >> mailcow.conf
  556. echo '# Otherwise a user might share data with too many other users.' >> mailcow.conf
  557. echo 'ACL_ANYONE=disallow' >> mailcow.conf
  558. fi
  559. elif [[ ${option} == "SOLR_HEAP" ]]; then
  560. if ! grep -q ${option} mailcow.conf; then
  561. echo "Adding new option \"${option}\" to mailcow.conf"
  562. echo '# Solr heap size, there is no recommendation, please see Solr docs.' >> mailcow.conf
  563. echo '# Solr is a prone to run OOM on large systems and should be monitored. Unmonitored Solr setups are not recommended.' >> mailcow.conf
  564. echo '# Solr will refuse to start with total system memory below or equal to 2 GB.' >> mailcow.conf
  565. echo "SOLR_HEAP=1024" >> mailcow.conf
  566. fi
  567. elif [[ ${option} == "SKIP_SOLR" ]]; then
  568. if ! grep -q ${option} mailcow.conf; then
  569. echo "Adding new option \"${option}\" to mailcow.conf"
  570. echo '# Solr is disabled by default after upgrading from non-Solr to Solr-enabled mailcows.' >> mailcow.conf
  571. echo '# Disable Solr or if you do not want to store a readable index of your mails in solr-vol-1.' >> mailcow.conf
  572. echo "SKIP_SOLR=y" >> mailcow.conf
  573. fi
  574. elif [[ ${option} == "ENABLE_SSL_SNI" ]]; then
  575. if ! grep -q ${option} mailcow.conf; then
  576. echo "Adding new option \"${option}\" to mailcow.conf"
  577. echo '# Create seperate certificates for all domains - y/n' >> mailcow.conf
  578. echo '# this will allow adding more than 100 domains, but some email clients will not be able to connect with alternative hostnames' >> mailcow.conf
  579. echo '# see https://wiki.dovecot.org/SSL/SNIClientSupport' >> mailcow.conf
  580. echo "ENABLE_SSL_SNI=n" >> mailcow.conf
  581. fi
  582. elif [[ ${option} == "SKIP_SOGO" ]]; then
  583. if ! grep -q ${option} mailcow.conf; then
  584. echo "Adding new option \"${option}\" to mailcow.conf"
  585. echo '# Skip SOGo: Will disable SOGo integration and therefore webmail, DAV protocols and ActiveSync support (experimental, unsupported, not fully implemented) - y/n' >> mailcow.conf
  586. echo "SKIP_SOGO=n" >> mailcow.conf
  587. fi
  588. elif [[ ${option} == "MAILDIR_SUB" ]]; then
  589. if ! grep -q ${option} mailcow.conf; then
  590. echo "Adding new option \"${option}\" to mailcow.conf"
  591. echo '# MAILDIR_SUB defines a path in a users virtual home to keep the maildir in. Leave empty for updated setups.' >> mailcow.conf
  592. echo "#MAILDIR_SUB=Maildir" >> mailcow.conf
  593. echo "MAILDIR_SUB=" >> mailcow.conf
  594. fi
  595. elif [[ ${option} == "WATCHDOG_NOTIFY_BAN" ]]; then
  596. if ! grep -q ${option} mailcow.conf; then
  597. echo "Adding new option \"${option}\" to mailcow.conf"
  598. echo '# Notify about banned IP. Includes whois lookup.' >> mailcow.conf
  599. echo "WATCHDOG_NOTIFY_BAN=y" >> mailcow.conf
  600. fi
  601. elif [[ ${option} == "WATCHDOG_SUBJECT" ]]; then
  602. if ! grep -q ${option} mailcow.conf; then
  603. echo "Adding new option \"${option}\" to mailcow.conf"
  604. echo '# Subject for watchdog mails. Defaults to "Watchdog ALERT" followed by the error message.' >> mailcow.conf
  605. echo "#WATCHDOG_SUBJECT=" >> mailcow.conf
  606. fi
  607. elif [[ ${option} == "WATCHDOG_EXTERNAL_CHECKS" ]]; then
  608. if ! grep -q ${option} mailcow.conf; then
  609. echo "Adding new option \"${option}\" to mailcow.conf"
  610. echo '# Checks if mailcow is an open relay. Requires a SAL. More checks will follow.' >> mailcow.conf
  611. echo '# No data is collected. Opt-in and anonymous.' >> mailcow.conf
  612. echo '# Will only work with unmodified mailcow setups.' >> mailcow.conf
  613. echo "WATCHDOG_EXTERNAL_CHECKS=n" >> mailcow.conf
  614. fi
  615. elif [[ ${option} == "SOGO_EXPIRE_SESSION" ]]; then
  616. if ! grep -q ${option} mailcow.conf; then
  617. echo "Adding new option \"${option}\" to mailcow.conf"
  618. echo '# SOGo session timeout in minutes' >> mailcow.conf
  619. echo "SOGO_EXPIRE_SESSION=480" >> mailcow.conf
  620. fi
  621. elif [[ ${option} == "REDIS_PORT" ]]; then
  622. if ! grep -q ${option} mailcow.conf; then
  623. echo "Adding new option \"${option}\" to mailcow.conf"
  624. echo "REDIS_PORT=127.0.0.1:7654" >> mailcow.conf
  625. fi
  626. elif [[ ${option} == "DOVECOT_MASTER_USER" ]]; then
  627. if ! grep -q ${option} mailcow.conf; then
  628. echo "Adding new option \"${option}\" to mailcow.conf"
  629. echo '# DOVECOT_MASTER_USER and _PASS must _both_ be provided. No special chars.' >> mailcow.conf
  630. echo '# Empty by default to auto-generate master user and password on start.' >> mailcow.conf
  631. echo '# User expands to DOVECOT_MASTER_USER@mailcow.local' >> mailcow.conf
  632. echo '# LEAVE EMPTY IF UNSURE' >> mailcow.conf
  633. echo "DOVECOT_MASTER_USER=" >> mailcow.conf
  634. fi
  635. elif [[ ${option} == "DOVECOT_MASTER_PASS" ]]; then
  636. if ! grep -q ${option} mailcow.conf; then
  637. echo "Adding new option \"${option}\" to mailcow.conf"
  638. echo '# LEAVE EMPTY IF UNSURE' >> mailcow.conf
  639. echo "DOVECOT_MASTER_PASS=" >> mailcow.conf
  640. fi
  641. elif [[ ${option} == "MAILCOW_PASS_SCHEME" ]]; then
  642. if ! grep -q ${option} mailcow.conf; then
  643. echo "Adding new option \"${option}\" to mailcow.conf"
  644. echo '# Password hash algorithm' >> mailcow.conf
  645. echo '# Only certain password hash algorithm are supported. For a fully list of supported schemes,' >> mailcow.conf
  646. echo '# see https://docs.mailcow.email/models/model-passwd/' >> mailcow.conf
  647. echo "MAILCOW_PASS_SCHEME=BLF-CRYPT" >> mailcow.conf
  648. fi
  649. elif [[ ${option} == "ADDITIONAL_SERVER_NAMES" ]]; then
  650. if ! grep -q ${option} mailcow.conf; then
  651. echo "Adding new option \"${option}\" to mailcow.conf"
  652. echo '# Additional server names for mailcow UI' >> mailcow.conf
  653. echo '#' >> mailcow.conf
  654. echo '# Specify alternative addresses for the mailcow UI to respond to' >> mailcow.conf
  655. 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
  656. 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
  657. echo '# You can understand this as server_name directive in Nginx.' >> mailcow.conf
  658. echo '# Comma separated list without spaces! Example: ADDITIONAL_SERVER_NAMES=a.b.c,d.e.f' >> mailcow.conf
  659. echo 'ADDITIONAL_SERVER_NAMES=' >> mailcow.conf
  660. fi
  661. elif [[ ${option} == "ACME_CONTACT" ]]; then
  662. if ! grep -q ${option} mailcow.conf; then
  663. echo "Adding new option \"${option}\" to mailcow.conf"
  664. echo '# Lets Encrypt registration contact information' >> mailcow.conf
  665. echo '# Optional: Leave empty for none' >> mailcow.conf
  666. echo '# This value is only used on first order!' >> mailcow.conf
  667. echo '# Setting it at a later point will require the following steps:' >> mailcow.conf
  668. echo '# https://docs.mailcow.email/troubleshooting/debug-reset_tls/' >> mailcow.conf
  669. echo 'ACME_CONTACT=' >> mailcow.conf
  670. fi
  671. elif [[ ${option} == "WEBAUTHN_ONLY_TRUSTED_VENDORS" ]]; then
  672. if ! grep -q ${option} mailcow.conf; then
  673. echo "Adding new option \"${option}\" to mailcow.conf"
  674. echo "# WebAuthn device manufacturer verification" >> mailcow.conf
  675. echo '# After setting WEBAUTHN_ONLY_TRUSTED_VENDORS=y only devices from trusted manufacturers are allowed' >> mailcow.conf
  676. echo '# root certificates can be placed for validation under mailcow-dockerized/data/web/inc/lib/WebAuthn/rootCertificates' >> mailcow.conf
  677. echo 'WEBAUTHN_ONLY_TRUSTED_VENDORS=n' >> mailcow.conf
  678. fi
  679. elif [[ ${option} == "SPAMHAUS_DQS_KEY" ]]; then
  680. if ! grep -q ${option} mailcow.conf; then
  681. echo "Adding new option \"${option}\" to mailcow.conf"
  682. echo "# Spamhaus Data Query Service Key" >> mailcow.conf
  683. echo '# Optional: Leave empty for none' >> mailcow.conf
  684. echo '# Enter your key here if you are using a blocked ASN (OVH, AWS, Cloudflare e.g) for the unregistered Spamhaus Blocklist.' >> mailcow.conf
  685. echo '# If empty, it will completely disable Spamhaus blocklists if it detects that you are running on a server using a blocked AS.' >> mailcow.conf
  686. echo '# Otherwise it will work as usual.' >> mailcow.conf
  687. echo 'SPAMHAUS_DQS_KEY=' >> mailcow.conf
  688. fi
  689. elif [[ ${option} == "WATCHDOG_VERBOSE" ]]; then
  690. if ! grep -q ${option} mailcow.conf; then
  691. echo "Adding new option \"${option}\" to mailcow.conf"
  692. echo '# Enable watchdog verbose logging' >> mailcow.conf
  693. echo 'WATCHDOG_VERBOSE=n' >> mailcow.conf
  694. fi
  695. elif ! grep -q ${option} mailcow.conf; then
  696. echo "Adding new option \"${option}\" to mailcow.conf"
  697. echo "${option}=n" >> mailcow.conf
  698. fi
  699. done
  700. if [[( ${SKIP_PING_CHECK} == "y")]]; then
  701. echo -e "\e[32mSkipping Ping Check...\e[0m"
  702. else
  703. echo -en "Checking internet connection... "
  704. if ! check_online_status; then
  705. echo -e "\e[31mfailed\e[0m"
  706. exit 1
  707. else
  708. echo -e "\e[32mOK\e[0m"
  709. fi
  710. fi
  711. if ! [ $NEW_BRANCH ]; then
  712. echo -e "\e[33mDetecting which build your mailcow runs on...\e[0m"
  713. sleep 1
  714. if [ ${BRANCH} == "master" ]; then
  715. echo -e "\e[32mYou are receiving stable updates (master).\e[0m"
  716. echo -e "\e[33mTo change that run the update.sh Script one time with the --nightly parameter to switch to nightly builds.\e[0m"
  717. elif [ ${BRANCH} == "nightly" ]; then
  718. echo -e "\e[31mYou are receiving unstable updates (nightly). These are for testing purposes only!!!\e[0m"
  719. sleep 1
  720. echo -e "\e[33mTo change that run the update.sh Script one time with the --stable parameter to switch to stable builds.\e[0m"
  721. else
  722. echo -e "\e[33mYou are receiving updates from a unsupported branch.\e[0m"
  723. sleep 1
  724. echo -e "\e[33mThe mailcow stack might still work but it is recommended to switch to the master branch (stable builds).\e[0m"
  725. echo -e "\e[33mTo change that run the update.sh Script one time with the --stable parameter to switch to stable builds.\e[0m"
  726. fi
  727. elif [ $FORCE ]; then
  728. echo -e "\e[31mYou are running in forced mode!\e[0m"
  729. echo -e "\e[31mA Branch Switch can only be performed manually (monitored).\e[0m"
  730. echo -e "\e[31mPlease rerun the update.sh Script without the --force/-f parameter.\e[0m"
  731. sleep 1
  732. elif [ $NEW_BRANCH == "master" ] && [ $CURRENT_BRANCH != "master" ]; then
  733. echo -e "\e[33mYou are about to switch your mailcow Updates to the stable (master) branch.\e[0m"
  734. sleep 1
  735. echo -e "\e[33mBefore you do: Please take a backup of all components to ensure that no Data is lost...\e[0m"
  736. sleep 1
  737. echo -e "\e[31mWARNING: Please see on GitHub or ask in the communitys if a switch to master is stable or not.
  738. In some rear cases a Update back to master can destroy your mailcow configuration in case of Database Upgrades etc.
  739. Normally a upgrade back to master should be safe during each full release.
  740. Check GitHub for Database Changes and Update only if there similar to the full release!\e[0m"
  741. read -r -p "Are you sure you that want to continue upgrading to the stable (master) branch? [y/N] " response
  742. if [[ ! "${response}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  743. echo "OK. If you prepared yourself for that please run the update.sh Script with the --stable parameter again to trigger this process here."
  744. exit 0
  745. fi
  746. BRANCH=$NEW_BRANCH
  747. DIFF_DIRECTORY=update_diffs
  748. DIFF_FILE=${DIFF_DIRECTORY}/diff_before_upgrade_to_master_$(date +"%Y-%m-%d-%H-%M-%S")
  749. mv diff_before_upgrade* ${DIFF_DIRECTORY}/ 2> /dev/null
  750. if ! git diff-index --quiet HEAD; then
  751. echo -e "\e[32mSaving diff to ${DIFF_FILE}...\e[0m"
  752. mkdir -p ${DIFF_DIRECTORY}
  753. git diff ${BRANCH} --stat > ${DIFF_FILE}
  754. git diff ${BRANCH} >> ${DIFF_FILE}
  755. fi
  756. echo -e "\e[32mSwitching Branch to ${BRANCH}...\e[0m"
  757. git fetch origin
  758. git checkout -f ${BRANCH}
  759. elif [ $NEW_BRANCH == "nightly" ] && [ $CURRENT_BRANCH != "nightly" ]; then
  760. echo -e "\e[33mYou are about to switch your mailcow Updates to the unstable (nightly) branch.\e[0m"
  761. sleep 1
  762. echo -e "\e[33mBefore you do: Please take a backup of all components to ensure that no Data is lost...\e[0m"
  763. sleep 1
  764. echo -e "\e[31mWARNING: A switch to nightly is possible any time. But a switch back (to master) isn't.\e[0m"
  765. read -r -p "Are you sure you that want to continue upgrading to the unstable (nightly) branch? [y/N] " response
  766. if [[ ! "${response}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  767. echo "OK. If you prepared yourself for that please run the update.sh Script with the --nightly parameter again to trigger this process here."
  768. exit 0
  769. fi
  770. BRANCH=$NEW_BRANCH
  771. DIFF_DIRECTORY=update_diffs
  772. DIFF_FILE=${DIFF_DIRECTORY}/diff_before_upgrade_to_nightly_$(date +"%Y-%m-%d-%H-%M-%S")
  773. mv diff_before_upgrade* ${DIFF_DIRECTORY}/ 2> /dev/null
  774. if ! git diff-index --quiet HEAD; then
  775. echo -e "\e[32mSaving diff to ${DIFF_FILE}...\e[0m"
  776. mkdir -p ${DIFF_DIRECTORY}
  777. git diff ${BRANCH} --stat > ${DIFF_FILE}
  778. git diff ${BRANCH} >> ${DIFF_FILE}
  779. fi
  780. git fetch origin
  781. git checkout -f ${BRANCH}
  782. fi
  783. if [ ! $DEV ]; then
  784. echo -e "\e[32mChecking for newer update script...\e[0m"
  785. SHA1_1=$(sha1sum update.sh)
  786. git fetch origin #${BRANCH}
  787. git checkout origin/${BRANCH} update.sh
  788. SHA1_2=$(sha1sum update.sh)
  789. if [[ ${SHA1_1} != ${SHA1_2} ]]; then
  790. echo "update.sh changed, please run this script again, exiting."
  791. chmod +x update.sh
  792. exit 2
  793. fi
  794. fi
  795. if [ ! $FORCE ]; then
  796. read -r -p "Are you sure you want to update mailcow: dockerized? All containers will be stopped. [y/N] " response
  797. if [[ ! "${response}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  798. echo "OK, exiting."
  799. exit 0
  800. fi
  801. migrate_docker_nat
  802. fi
  803. remove_obsolete_nginx_ports
  804. echo -e "\e[32mValidating docker-compose stack configuration...\e[0m"
  805. sed -i 's/HTTPS_BIND:-:/HTTPS_BIND:-/g' docker-compose.yml
  806. sed -i 's/HTTP_BIND:-:/HTTP_BIND:-/g' docker-compose.yml
  807. if ! $COMPOSE_COMMAND config -q; then
  808. echo -e "\e[31m\nOh no, something went wrong. Please check the error message above.\e[0m"
  809. exit 1
  810. fi
  811. echo -e "\e[32mChecking for conflicting bridges...\e[0m"
  812. MAILCOW_BRIDGE=$($COMPOSE_COMMAND config | grep -i com.docker.network.bridge.name | cut -d':' -f2)
  813. while read NAT_ID; do
  814. iptables -t nat -D POSTROUTING $NAT_ID
  815. done < <(iptables -L -vn -t nat --line-numbers | grep $IPV4_NETWORK | grep -E 'MASQUERADE.*all' | grep -v ${MAILCOW_BRIDGE} | cut -d' ' -f1)
  816. DIFF_DIRECTORY=update_diffs
  817. DIFF_FILE=${DIFF_DIRECTORY}/diff_before_update_$(date +"%Y-%m-%d-%H-%M-%S")
  818. mv diff_before_update* ${DIFF_DIRECTORY}/ 2> /dev/null
  819. if ! git diff-index --quiet HEAD; then
  820. echo -e "\e[32mSaving diff to ${DIFF_FILE}...\e[0m"
  821. mkdir -p ${DIFF_DIRECTORY}
  822. git diff --stat > ${DIFF_FILE}
  823. git diff >> ${DIFF_FILE}
  824. fi
  825. echo -e "\e[32mPrefetching images...\e[0m"
  826. prefetch_images
  827. echo -e "\e[32mStopping mailcow...\e[0m"
  828. sleep 2
  829. MAILCOW_CONTAINERS=($($COMPOSE_COMMAND ps -q))
  830. $COMPOSE_COMMAND down
  831. echo -e "\e[32mChecking for remaining containers...\e[0m"
  832. sleep 2
  833. for container in "${MAILCOW_CONTAINERS[@]}"; do
  834. docker rm -f "$container" 2> /dev/null
  835. done
  836. [[ -f data/conf/nginx/ZZZ-ejabberd.conf ]] && rm data/conf/nginx/ZZZ-ejabberd.conf
  837. # Silently fixing remote url from andryyy to mailcow
  838. # git remote set-url origin https://github.com/mailcow/mailcow-dockerized
  839. DEFAULT_REPO=https://github.com/mailcow/mailcow-dockerized
  840. CURRENT_REPO=$(git remote get-url origin)
  841. if [ "$CURRENT_REPO" != "$DEFAULT_REPO" ]; then
  842. echo "The Repository currently used is not the default Mailcow Repository."
  843. echo "Currently Repository: $CURRENT_REPO"
  844. echo "Default Repository: $DEFAULT_REPO"
  845. read -r -p "Should it be changed back to default? [y/N] " repo_response
  846. if [[ "$repo_response" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  847. git remote set-url origin $DEFAULT_REPO
  848. fi
  849. fi
  850. echo -e "\e[32mCommitting current status...\e[0m"
  851. [[ -z "$(git config user.name)" ]] && git config user.name moo
  852. [[ -z "$(git config user.email)" ]] && git config user.email moo@cow.moo
  853. [[ ! -z $(git ls-files data/conf/rspamd/override.d/worker-controller-password.inc) ]] && git rm data/conf/rspamd/override.d/worker-controller-password.inc
  854. git add -u
  855. git commit -am "Before update on ${DATE}" > /dev/null
  856. echo -e "\e[32mFetching updated code from remote...\e[0m"
  857. git fetch origin #${BRANCH}
  858. echo -e "\e[32mMerging local with remote code (recursive, strategy: \"${MERGE_STRATEGY:-theirs}\", options: \"patience\"...\e[0m"
  859. git config merge.defaultToUpstream true
  860. git merge -X${MERGE_STRATEGY:-theirs} -Xpatience -m "After update on ${DATE}"
  861. # Need to use a variable to not pass return codes of if checks
  862. MERGE_RETURN=$?
  863. if [[ ${MERGE_RETURN} == 128 ]]; then
  864. 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"
  865. exit 1
  866. elif [[ ${MERGE_RETURN} == 1 ]]; then
  867. echo -e "\e[93mPotenial conflict, trying to fix...\e[0m"
  868. git status --porcelain | grep -E "UD|DU" | awk '{print $2}' | xargs rm -v
  869. git add -A
  870. git commit -m "After update on ${DATE}" > /dev/null
  871. git checkout .
  872. echo -e "\e[32mRemoved and recreated files if necessary.\e[0m"
  873. elif [[ ${MERGE_RETURN} != 0 ]]; then
  874. echo -e "\e[31m\nOh no, something went wrong. Please check the error message above.\e[0m"
  875. echo
  876. echo "Run $COMPOSE_COMMAND up -d to restart your stack without updates or try again after fixing the mentioned errors."
  877. exit 1
  878. fi
  879. echo -e "\e[32mFetching new images, if any...\e[0m"
  880. sleep 2
  881. $COMPOSE_COMMAND pull
  882. # Fix missing SSL, does not overwrite existing files
  883. [[ ! -d data/assets/ssl ]] && mkdir -p data/assets/ssl
  884. cp -n -d data/assets/ssl-example/*.pem data/assets/ssl/
  885. echo -e "Checking IPv6 settings... "
  886. if grep -q 'SYSCTL_IPV6_DISABLED=1' mailcow.conf; then
  887. echo
  888. echo '!! IMPORTANT !!'
  889. echo
  890. 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".'
  891. echo "This setting will only be active after a complete shutdown of mailcow by running $COMPOSE_COMMAND down followed by $COMPOSE_COMMAND up -d."
  892. echo
  893. echo '!! IMPORTANT !!'
  894. echo
  895. read -p "Press any key to continue..." < /dev/tty
  896. fi
  897. # Checking for old project name bug
  898. sed -i --follow-symlinks 's#COMPOSEPROJECT_NAME#COMPOSE_PROJECT_NAME#g' mailcow.conf
  899. # Fix Rspamd maps
  900. if [ -f data/conf/rspamd/custom/global_from_blacklist.map ]; then
  901. mv data/conf/rspamd/custom/global_from_blacklist.map data/conf/rspamd/custom/global_smtp_from_blacklist.map
  902. fi
  903. if [ -f data/conf/rspamd/custom/global_from_whitelist.map ]; then
  904. mv data/conf/rspamd/custom/global_from_whitelist.map data/conf/rspamd/custom/global_smtp_from_whitelist.map
  905. fi
  906. # Fix deprecated metrics.conf
  907. if [ -f "data/conf/rspamd/local.d/metrics.conf" ]; then
  908. if [ ! -z "$(git diff --name-only origin/master data/conf/rspamd/local.d/metrics.conf)" ]; then
  909. 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."
  910. echo "The deprecated configuration file metrics.conf will be moved to metrics.conf_deprecated after updating mailcow."
  911. fi
  912. mv data/conf/rspamd/local.d/metrics.conf data/conf/rspamd/local.d/metrics.conf_deprecated
  913. fi
  914. # Set app_info.inc.php
  915. if [ ${BRANCH} == "master" ]; then
  916. mailcow_git_version=$(git describe --tags `git rev-list --tags --max-count=1`)
  917. elif [ ${BRANCH} == "nightly" ]; then
  918. mailcow_git_version=$(git rev-parse --short $(git rev-parse @{upstream}))
  919. mailcow_last_git_version=""
  920. else
  921. mailcow_git_version=$(git rev-parse --short HEAD)
  922. mailcow_last_git_version=""
  923. fi
  924. mailcow_git_commit=$(git rev-parse origin/${BRANCH})
  925. mailcow_git_commit_date=$(git log -1 --format=%ci @{upstream} )
  926. if [ $? -eq 0 ]; then
  927. echo '<?php' > data/web/inc/app_info.inc.php
  928. echo ' $MAILCOW_GIT_VERSION="'$mailcow_git_version'";' >> data/web/inc/app_info.inc.php
  929. echo ' $MAILCOW_LAST_GIT_VERSION="";' >> data/web/inc/app_info.inc.php
  930. echo ' $MAILCOW_GIT_OWNER="mailcow";' >> data/web/inc/app_info.inc.php
  931. echo ' $MAILCOW_GIT_REPO="mailcow-dockerized";' >> data/web/inc/app_info.inc.php
  932. echo ' $MAILCOW_GIT_URL="https://github.com/mailcow/mailcow-dockerized";' >> data/web/inc/app_info.inc.php
  933. echo ' $MAILCOW_GIT_COMMIT="'$mailcow_git_commit'";' >> data/web/inc/app_info.inc.php
  934. echo ' $MAILCOW_GIT_COMMIT_DATE="'$mailcow_git_commit_date'";' >> data/web/inc/app_info.inc.php
  935. echo ' $MAILCOW_BRANCH="'$BRANCH'";' >> data/web/inc/app_info.inc.php
  936. echo ' $MAILCOW_UPDATEDAT='$(date +%s)';' >> data/web/inc/app_info.inc.php
  937. echo '?>' >> data/web/inc/app_info.inc.php
  938. else
  939. echo '<?php' > data/web/inc/app_info.inc.php
  940. echo ' $MAILCOW_GIT_VERSION="'$mailcow_git_version'";' >> data/web/inc/app_info.inc.php
  941. echo ' $MAILCOW_LAST_GIT_VERSION="";' >> data/web/inc/app_info.inc.php
  942. echo ' $MAILCOW_GIT_OWNER="mailcow";' >> data/web/inc/app_info.inc.php
  943. echo ' $MAILCOW_GIT_REPO="mailcow-dockerized";' >> data/web/inc/app_info.inc.php
  944. echo ' $MAILCOW_GIT_URL="https://github.com/mailcow/mailcow-dockerized";' >> data/web/inc/app_info.inc.php
  945. echo ' $MAILCOW_GIT_COMMIT="";' >> data/web/inc/app_info.inc.php
  946. echo ' $MAILCOW_GIT_COMMIT_DATE="";' >> data/web/inc/app_info.inc.php
  947. echo ' $MAILCOW_BRANCH="'$BRANCH'";' >> data/web/inc/app_info.inc.php
  948. echo ' $MAILCOW_UPDATEDAT='$(date +%s)';' >> data/web/inc/app_info.inc.php
  949. echo '?>' >> data/web/inc/app_info.inc.php
  950. echo -e "\e[33mCannot determine current git repository version...\e[0m"
  951. fi
  952. if [[ ${SKIP_START} == "y" ]]; then
  953. echo -e "\e[33mNot starting mailcow, please run \"$COMPOSE_COMMAND up -d --remove-orphans\" to start mailcow.\e[0m"
  954. else
  955. echo -e "\e[32mStarting mailcow...\e[0m"
  956. sleep 2
  957. $COMPOSE_COMMAND up -d --remove-orphans
  958. fi
  959. echo -e "\e[32mCollecting garbage...\e[0m"
  960. docker_garbage
  961. # Run post-update-hook
  962. if [ -f "${SCRIPT_DIR}/post_update_hook.sh" ]; then
  963. bash "${SCRIPT_DIR}/post_update_hook.sh"
  964. fi
  965. # echo "In case you encounter any problem, hard-reset to a state before updating mailcow:"
  966. # echo
  967. # git reflog --color=always | grep "Before update on "
  968. # echo
  969. # echo "Use \"git reset --hard hash-on-the-left\" and run $COMPOSE_COMMAND up -d afterwards."