update.sh 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046
  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[31mFound Docker Compose Plugin (native).\e[0m"
  175. echo -e "\e[31mSetting 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[31mFound Docker Compose Standalone.\e[0m"
  190. echo -e "\e[31mSetting 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_NOTIFY_START"
  417. "WATCHDOG_EXTERNAL_CHECKS"
  418. "WATCHDOG_SUBJECT"
  419. "SKIP_CLAMD"
  420. "SKIP_IP_CHECK"
  421. "ADDITIONAL_SAN"
  422. "DOVEADM_PORT"
  423. "IPV4_NETWORK"
  424. "IPV6_NETWORK"
  425. "LOG_LINES"
  426. "SNAT_TO_SOURCE"
  427. "SNAT6_TO_SOURCE"
  428. "COMPOSE_PROJECT_NAME"
  429. "DOCKER_COMPOSE_VERSION"
  430. "SQL_PORT"
  431. "API_KEY"
  432. "API_KEY_READ_ONLY"
  433. "API_ALLOW_FROM"
  434. "MAILDIR_GC_TIME"
  435. "MAILDIR_SUB"
  436. "ACL_ANYONE"
  437. "SOLR_HEAP"
  438. "SKIP_SOLR"
  439. "ENABLE_SSL_SNI"
  440. "ALLOW_ADMIN_EMAIL_LOGIN"
  441. "SKIP_HTTP_VERIFICATION"
  442. "SOGO_EXPIRE_SESSION"
  443. "REDIS_PORT"
  444. "DOVECOT_MASTER_USER"
  445. "DOVECOT_MASTER_PASS"
  446. "MAILCOW_PASS_SCHEME"
  447. "ADDITIONAL_SERVER_NAMES"
  448. "ACME_CONTACT"
  449. "WATCHDOG_VERBOSE"
  450. "WEBAUTHN_ONLY_TRUSTED_VENDORS"
  451. "SPAMHAUS_DQS_KEY"
  452. )
  453. detect_bad_asn
  454. sed -i --follow-symlinks '$a\' mailcow.conf
  455. for option in ${CONFIG_ARRAY[@]}; do
  456. if [[ ${option} == "ADDITIONAL_SAN" ]]; then
  457. if ! grep -q ${option} mailcow.conf; then
  458. echo "Adding new option \"${option}\" to mailcow.conf"
  459. echo "${option}=" >> mailcow.conf
  460. fi
  461. elif [[ ${option} == "COMPOSE_PROJECT_NAME" ]]; then
  462. if ! grep -q ${option} mailcow.conf; then
  463. echo "Adding new option \"${option}\" to mailcow.conf"
  464. echo "COMPOSE_PROJECT_NAME=mailcowdockerized" >> mailcow.conf
  465. fi
  466. elif [[ ${option} == "DOCKER_COMPOSE_VERSION" ]]; then
  467. if ! grep -q ${option} mailcow.conf; then
  468. echo "Adding new option \"${option}\" to mailcow.conf"
  469. echo "# Used Docker Compose version" >> mailcow.conf
  470. echo "# Switch here between native (compose plugin) and standalone" >> mailcow.conf
  471. echo "# For more informations take a look at the mailcow docs regarding the configuration options." >> mailcow.conf
  472. echo "# Normally this should be untouched but if you decided to use either of those you can switch it manually here." >> mailcow.conf
  473. echo "# Please be aware that at least one of those variants should be installed on your maschine or mailcow will fail." >> mailcow.conf
  474. echo "" >> mailcow.conf
  475. echo "DOCKER_COMPOSE_VERSION=${DOCKER_COMPOSE_VERSION}" >> mailcow.conf
  476. fi
  477. elif [[ ${option} == "DOVEADM_PORT" ]]; then
  478. if ! grep -q ${option} mailcow.conf; then
  479. echo "Adding new option \"${option}\" to mailcow.conf"
  480. echo "DOVEADM_PORT=127.0.0.1:19991" >> mailcow.conf
  481. fi
  482. elif [[ ${option} == "WATCHDOG_NOTIFY_EMAIL" ]]; then
  483. if ! grep -q ${option} mailcow.conf; then
  484. echo "Adding new option \"${option}\" to mailcow.conf"
  485. echo "WATCHDOG_NOTIFY_EMAIL=" >> mailcow.conf
  486. fi
  487. elif [[ ${option} == "LOG_LINES" ]]; then
  488. if ! grep -q ${option} mailcow.conf; then
  489. echo "Adding new option \"${option}\" to mailcow.conf"
  490. echo '# Max log lines per service to keep in Redis logs' >> mailcow.conf
  491. echo "LOG_LINES=9999" >> mailcow.conf
  492. fi
  493. elif [[ ${option} == "IPV4_NETWORK" ]]; then
  494. if ! grep -q ${option} mailcow.conf; then
  495. echo "Adding new option \"${option}\" to mailcow.conf"
  496. echo '# Internal IPv4 /24 subnet, format n.n.n. (expands to n.n.n.0/24)' >> mailcow.conf
  497. echo "IPV4_NETWORK=172.22.1" >> mailcow.conf
  498. fi
  499. elif [[ ${option} == "IPV6_NETWORK" ]]; then
  500. if ! grep -q ${option} mailcow.conf; then
  501. echo "Adding new option \"${option}\" to mailcow.conf"
  502. echo '# Internal IPv6 subnet in fc00::/7' >> mailcow.conf
  503. echo "IPV6_NETWORK=fd4d:6169:6c63:6f77::/64" >> mailcow.conf
  504. fi
  505. elif [[ ${option} == "SQL_PORT" ]]; then
  506. if ! grep -q ${option} mailcow.conf; then
  507. echo "Adding new option \"${option}\" to mailcow.conf"
  508. echo '# Bind SQL to 127.0.0.1 on port 13306' >> mailcow.conf
  509. echo "SQL_PORT=127.0.0.1:13306" >> mailcow.conf
  510. fi
  511. elif [[ ${option} == "API_KEY" ]]; then
  512. if ! grep -q ${option} mailcow.conf; then
  513. echo "Adding new option \"${option}\" to mailcow.conf"
  514. echo '# Create or override API key for web UI' >> mailcow.conf
  515. echo "#API_KEY=" >> mailcow.conf
  516. fi
  517. elif [[ ${option} == "API_KEY_READ_ONLY" ]]; then
  518. if ! grep -q ${option} mailcow.conf; then
  519. echo "Adding new option \"${option}\" to mailcow.conf"
  520. echo '# Create or override read-only API key for web UI' >> mailcow.conf
  521. echo "#API_KEY_READ_ONLY=" >> mailcow.conf
  522. fi
  523. elif [[ ${option} == "API_ALLOW_FROM" ]]; then
  524. if ! grep -q ${option} mailcow.conf; then
  525. echo "Adding new option \"${option}\" to mailcow.conf"
  526. echo '# Must be set for API_KEY to be active' >> mailcow.conf
  527. echo '# IPs only, no networks (networks can be set via UI)' >> mailcow.conf
  528. echo "#API_ALLOW_FROM=" >> mailcow.conf
  529. fi
  530. elif [[ ${option} == "SNAT_TO_SOURCE" ]]; then
  531. if ! grep -q ${option} mailcow.conf; then
  532. echo "Adding new option \"${option}\" to mailcow.conf"
  533. echo '# Use this IPv4 for outgoing connections (SNAT)' >> mailcow.conf
  534. echo "#SNAT_TO_SOURCE=" >> mailcow.conf
  535. fi
  536. elif [[ ${option} == "SNAT6_TO_SOURCE" ]]; then
  537. if ! grep -q ${option} mailcow.conf; then
  538. echo "Adding new option \"${option}\" to mailcow.conf"
  539. echo '# Use this IPv6 for outgoing connections (SNAT)' >> mailcow.conf
  540. echo "#SNAT6_TO_SOURCE=" >> mailcow.conf
  541. fi
  542. elif [[ ${option} == "MAILDIR_GC_TIME" ]]; then
  543. if ! grep -q ${option} mailcow.conf; then
  544. echo "Adding new option \"${option}\" to mailcow.conf"
  545. echo '# Garbage collector cleanup' >> mailcow.conf
  546. echo '# Deleted domains and mailboxes are moved to /var/vmail/_garbage/timestamp_sanitizedstring' >> mailcow.conf
  547. echo '# How long should objects remain in the garbage until they are being deleted? (value in minutes)' >> mailcow.conf
  548. echo '# Check interval is hourly' >> mailcow.conf
  549. echo 'MAILDIR_GC_TIME=1440' >> mailcow.conf
  550. fi
  551. elif [[ ${option} == "ACL_ANYONE" ]]; then
  552. if ! grep -q ${option} mailcow.conf; then
  553. echo "Adding new option \"${option}\" to mailcow.conf"
  554. echo '# Set this to "allow" to enable the anyone pseudo user. Disabled by default.' >> mailcow.conf
  555. echo '# When enabled, ACL can be created, that apply to "All authenticated users"' >> mailcow.conf
  556. echo '# This should probably only be activated on mail hosts, that are used exclusivly by one organisation.' >> mailcow.conf
  557. echo '# Otherwise a user might share data with too many other users.' >> mailcow.conf
  558. echo 'ACL_ANYONE=disallow' >> mailcow.conf
  559. fi
  560. elif [[ ${option} == "SOLR_HEAP" ]]; then
  561. if ! grep -q ${option} mailcow.conf; then
  562. echo "Adding new option \"${option}\" to mailcow.conf"
  563. echo '# Solr heap size, there is no recommendation, please see Solr docs.' >> mailcow.conf
  564. echo '# Solr is a prone to run OOM on large systems and should be monitored. Unmonitored Solr setups are not recommended.' >> mailcow.conf
  565. echo '# Solr will refuse to start with total system memory below or equal to 2 GB.' >> mailcow.conf
  566. echo "SOLR_HEAP=1024" >> mailcow.conf
  567. fi
  568. elif [[ ${option} == "SKIP_SOLR" ]]; then
  569. if ! grep -q ${option} mailcow.conf; then
  570. echo "Adding new option \"${option}\" to mailcow.conf"
  571. echo '# Solr is disabled by default after upgrading from non-Solr to Solr-enabled mailcows.' >> mailcow.conf
  572. echo '# Disable Solr or if you do not want to store a readable index of your mails in solr-vol-1.' >> mailcow.conf
  573. echo "SKIP_SOLR=y" >> mailcow.conf
  574. fi
  575. elif [[ ${option} == "ENABLE_SSL_SNI" ]]; then
  576. if ! grep -q ${option} mailcow.conf; then
  577. echo "Adding new option \"${option}\" to mailcow.conf"
  578. echo '# Create seperate certificates for all domains - y/n' >> mailcow.conf
  579. echo '# this will allow adding more than 100 domains, but some email clients will not be able to connect with alternative hostnames' >> mailcow.conf
  580. echo '# see https://wiki.dovecot.org/SSL/SNIClientSupport' >> mailcow.conf
  581. echo "ENABLE_SSL_SNI=n" >> mailcow.conf
  582. fi
  583. elif [[ ${option} == "SKIP_SOGO" ]]; then
  584. if ! grep -q ${option} mailcow.conf; then
  585. echo "Adding new option \"${option}\" to mailcow.conf"
  586. echo '# Skip SOGo: Will disable SOGo integration and therefore webmail, DAV protocols and ActiveSync support (experimental, unsupported, not fully implemented) - y/n' >> mailcow.conf
  587. echo "SKIP_SOGO=n" >> mailcow.conf
  588. fi
  589. elif [[ ${option} == "MAILDIR_SUB" ]]; then
  590. if ! grep -q ${option} mailcow.conf; then
  591. echo "Adding new option \"${option}\" to mailcow.conf"
  592. echo '# MAILDIR_SUB defines a path in a users virtual home to keep the maildir in. Leave empty for updated setups.' >> mailcow.conf
  593. echo "#MAILDIR_SUB=Maildir" >> mailcow.conf
  594. echo "MAILDIR_SUB=" >> mailcow.conf
  595. fi
  596. elif [[ ${option} == "WATCHDOG_NOTIFY_BAN" ]]; then
  597. if ! grep -q ${option} mailcow.conf; then
  598. echo "Adding new option \"${option}\" to mailcow.conf"
  599. echo '# Notify about banned IP. Includes whois lookup.' >> mailcow.conf
  600. echo "WATCHDOG_NOTIFY_BAN=y" >> mailcow.conf
  601. fi
  602. elif [[ ${option} == "WATCHDOG_NOTIFY_START" ]]; then
  603. if ! grep -q ${option} mailcow.conf; then
  604. echo "Adding new option \"${option}\" to mailcow.conf"
  605. echo '# Send a notification when the watchdog is started.' >> mailcow.conf
  606. echo "WATCHDOG_NOTIFY_START=y" >> mailcow.conf
  607. fi
  608. elif [[ ${option} == "WATCHDOG_SUBJECT" ]]; then
  609. if ! grep -q ${option} mailcow.conf; then
  610. echo "Adding new option \"${option}\" to mailcow.conf"
  611. echo '# Subject for watchdog mails. Defaults to "Watchdog ALERT" followed by the error message.' >> mailcow.conf
  612. echo "#WATCHDOG_SUBJECT=" >> mailcow.conf
  613. fi
  614. elif [[ ${option} == "WATCHDOG_EXTERNAL_CHECKS" ]]; then
  615. if ! grep -q ${option} mailcow.conf; then
  616. echo "Adding new option \"${option}\" to mailcow.conf"
  617. echo '# Checks if mailcow is an open relay. Requires a SAL. More checks will follow.' >> mailcow.conf
  618. echo '# No data is collected. Opt-in and anonymous.' >> mailcow.conf
  619. echo '# Will only work with unmodified mailcow setups.' >> mailcow.conf
  620. echo "WATCHDOG_EXTERNAL_CHECKS=n" >> mailcow.conf
  621. fi
  622. elif [[ ${option} == "SOGO_EXPIRE_SESSION" ]]; then
  623. if ! grep -q ${option} mailcow.conf; then
  624. echo "Adding new option \"${option}\" to mailcow.conf"
  625. echo '# SOGo session timeout in minutes' >> mailcow.conf
  626. echo "SOGO_EXPIRE_SESSION=480" >> mailcow.conf
  627. fi
  628. elif [[ ${option} == "REDIS_PORT" ]]; then
  629. if ! grep -q ${option} mailcow.conf; then
  630. echo "Adding new option \"${option}\" to mailcow.conf"
  631. echo "REDIS_PORT=127.0.0.1:7654" >> mailcow.conf
  632. fi
  633. elif [[ ${option} == "DOVECOT_MASTER_USER" ]]; then
  634. if ! grep -q ${option} mailcow.conf; then
  635. echo "Adding new option \"${option}\" to mailcow.conf"
  636. echo '# DOVECOT_MASTER_USER and _PASS must _both_ be provided. No special chars.' >> mailcow.conf
  637. echo '# Empty by default to auto-generate master user and password on start.' >> mailcow.conf
  638. echo '# User expands to DOVECOT_MASTER_USER@mailcow.local' >> mailcow.conf
  639. echo '# LEAVE EMPTY IF UNSURE' >> mailcow.conf
  640. echo "DOVECOT_MASTER_USER=" >> mailcow.conf
  641. fi
  642. elif [[ ${option} == "DOVECOT_MASTER_PASS" ]]; then
  643. if ! grep -q ${option} mailcow.conf; then
  644. echo "Adding new option \"${option}\" to mailcow.conf"
  645. echo '# LEAVE EMPTY IF UNSURE' >> mailcow.conf
  646. echo "DOVECOT_MASTER_PASS=" >> mailcow.conf
  647. fi
  648. elif [[ ${option} == "MAILCOW_PASS_SCHEME" ]]; then
  649. if ! grep -q ${option} mailcow.conf; then
  650. echo "Adding new option \"${option}\" to mailcow.conf"
  651. echo '# Password hash algorithm' >> mailcow.conf
  652. echo '# Only certain password hash algorithm are supported. For a fully list of supported schemes,' >> mailcow.conf
  653. echo '# see https://docs.mailcow.email/models/model-passwd/' >> mailcow.conf
  654. echo "MAILCOW_PASS_SCHEME=BLF-CRYPT" >> mailcow.conf
  655. fi
  656. elif [[ ${option} == "ADDITIONAL_SERVER_NAMES" ]]; then
  657. if ! grep -q ${option} mailcow.conf; then
  658. echo "Adding new option \"${option}\" to mailcow.conf"
  659. echo '# Additional server names for mailcow UI' >> mailcow.conf
  660. echo '#' >> mailcow.conf
  661. echo '# Specify alternative addresses for the mailcow UI to respond to' >> mailcow.conf
  662. 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
  663. 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
  664. echo '# You can understand this as server_name directive in Nginx.' >> mailcow.conf
  665. echo '# Comma separated list without spaces! Example: ADDITIONAL_SERVER_NAMES=a.b.c,d.e.f' >> mailcow.conf
  666. echo 'ADDITIONAL_SERVER_NAMES=' >> mailcow.conf
  667. fi
  668. elif [[ ${option} == "ACME_CONTACT" ]]; then
  669. if ! grep -q ${option} mailcow.conf; then
  670. echo "Adding new option \"${option}\" to mailcow.conf"
  671. echo '# Lets Encrypt registration contact information' >> mailcow.conf
  672. echo '# Optional: Leave empty for none' >> mailcow.conf
  673. echo '# This value is only used on first order!' >> mailcow.conf
  674. echo '# Setting it at a later point will require the following steps:' >> mailcow.conf
  675. echo '# https://docs.mailcow.email/troubleshooting/debug-reset_tls/' >> mailcow.conf
  676. echo 'ACME_CONTACT=' >> mailcow.conf
  677. fi
  678. elif [[ ${option} == "WEBAUTHN_ONLY_TRUSTED_VENDORS" ]]; then
  679. if ! grep -q ${option} mailcow.conf; then
  680. echo "Adding new option \"${option}\" to mailcow.conf"
  681. echo "# WebAuthn device manufacturer verification" >> mailcow.conf
  682. echo '# After setting WEBAUTHN_ONLY_TRUSTED_VENDORS=y only devices from trusted manufacturers are allowed' >> mailcow.conf
  683. echo '# root certificates can be placed for validation under mailcow-dockerized/data/web/inc/lib/WebAuthn/rootCertificates' >> mailcow.conf
  684. echo 'WEBAUTHN_ONLY_TRUSTED_VENDORS=n' >> mailcow.conf
  685. fi
  686. elif [[ ${option} == "SPAMHAUS_DQS_KEY" ]]; then
  687. if ! grep -q ${option} mailcow.conf; then
  688. echo "Adding new option \"${option}\" to mailcow.conf"
  689. echo "# Spamhaus Data Query Service Key" >> mailcow.conf
  690. echo '# Optional: Leave empty for none' >> mailcow.conf
  691. echo '# Enter your key here if you are using a blocked ASN (OVH, AWS, Cloudflare e.g) for the unregistered Spamhaus Blocklist.' >> mailcow.conf
  692. 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
  693. echo '# Otherwise it will work as usual.' >> mailcow.conf
  694. echo 'SPAMHAUS_DQS_KEY=' >> mailcow.conf
  695. fi
  696. elif [[ ${option} == "WATCHDOG_VERBOSE" ]]; then
  697. if ! grep -q ${option} mailcow.conf; then
  698. echo "Adding new option \"${option}\" to mailcow.conf"
  699. echo '# Enable watchdog verbose logging' >> mailcow.conf
  700. echo 'WATCHDOG_VERBOSE=n' >> mailcow.conf
  701. fi
  702. elif ! grep -q ${option} mailcow.conf; then
  703. echo "Adding new option \"${option}\" to mailcow.conf"
  704. echo "${option}=n" >> mailcow.conf
  705. fi
  706. done
  707. if [[( ${SKIP_PING_CHECK} == "y")]]; then
  708. echo -e "\e[32mSkipping Ping Check...\e[0m"
  709. else
  710. echo -en "Checking internet connection... "
  711. if ! check_online_status; then
  712. echo -e "\e[31mfailed\e[0m"
  713. exit 1
  714. else
  715. echo -e "\e[32mOK\e[0m"
  716. fi
  717. fi
  718. if ! [ $NEW_BRANCH ]; then
  719. echo -e "\e[33mDetecting which build your mailcow runs on...\e[0m"
  720. sleep 1
  721. if [ ${BRANCH} == "master" ]; then
  722. echo -e "\e[32mYou are receiving stable updates (master).\e[0m"
  723. echo -e "\e[33mTo change that run the update.sh Script one time with the --nightly parameter to switch to nightly builds.\e[0m"
  724. elif [ ${BRANCH} == "nightly" ]; then
  725. echo -e "\e[31mYou are receiving unstable updates (nightly). These are for testing purposes only!!!\e[0m"
  726. sleep 1
  727. echo -e "\e[33mTo change that run the update.sh Script one time with the --stable parameter to switch to stable builds.\e[0m"
  728. else
  729. echo -e "\e[33mYou are receiving updates from a unsupported branch.\e[0m"
  730. sleep 1
  731. echo -e "\e[33mThe mailcow stack might still work but it is recommended to switch to the master branch (stable builds).\e[0m"
  732. echo -e "\e[33mTo change that run the update.sh Script one time with the --stable parameter to switch to stable builds.\e[0m"
  733. fi
  734. elif [ $FORCE ]; then
  735. echo -e "\e[31mYou are running in forced mode!\e[0m"
  736. echo -e "\e[31mA Branch Switch can only be performed manually (monitored).\e[0m"
  737. echo -e "\e[31mPlease rerun the update.sh Script without the --force/-f parameter.\e[0m"
  738. sleep 1
  739. elif [ $NEW_BRANCH == "master" ] && [ $CURRENT_BRANCH != "master" ]; then
  740. echo -e "\e[33mYou are about to switch your mailcow Updates to the stable (master) branch.\e[0m"
  741. sleep 1
  742. echo -e "\e[33mBefore you do: Please take a backup of all components to ensure that no Data is lost...\e[0m"
  743. sleep 1
  744. echo -e "\e[31mWARNING: Please see on GitHub or ask in the communitys if a switch to master is stable or not.
  745. In some rear cases a Update back to master can destroy your mailcow configuration in case of Database Upgrades etc.
  746. Normally a upgrade back to master should be safe during each full release.
  747. Check GitHub for Database Changes and Update only if there similar to the full release!\e[0m"
  748. read -r -p "Are you sure you that want to continue upgrading to the stable (master) branch? [y/N] " response
  749. if [[ ! "${response}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  750. echo "OK. If you prepared yourself for that please run the update.sh Script with the --stable parameter again to trigger this process here."
  751. exit 0
  752. fi
  753. BRANCH=$NEW_BRANCH
  754. DIFF_DIRECTORY=update_diffs
  755. DIFF_FILE=${DIFF_DIRECTORY}/diff_before_upgrade_to_master_$(date +"%Y-%m-%d-%H-%M-%S")
  756. mv diff_before_upgrade* ${DIFF_DIRECTORY}/ 2> /dev/null
  757. if ! git diff-index --quiet HEAD; then
  758. echo -e "\e[32mSaving diff to ${DIFF_FILE}...\e[0m"
  759. mkdir -p ${DIFF_DIRECTORY}
  760. git diff ${BRANCH} --stat > ${DIFF_FILE}
  761. git diff ${BRANCH} >> ${DIFF_FILE}
  762. fi
  763. echo -e "\e[32mSwitching Branch to ${BRANCH}...\e[0m"
  764. git fetch origin
  765. git checkout -f ${BRANCH}
  766. elif [ $NEW_BRANCH == "nightly" ] && [ $CURRENT_BRANCH != "nightly" ]; then
  767. echo -e "\e[33mYou are about to switch your mailcow Updates to the unstable (nightly) branch.\e[0m"
  768. sleep 1
  769. echo -e "\e[33mBefore you do: Please take a backup of all components to ensure that no Data is lost...\e[0m"
  770. sleep 1
  771. echo -e "\e[31mWARNING: A switch to nightly is possible any time. But a switch back (to master) isn't.\e[0m"
  772. read -r -p "Are you sure you that want to continue upgrading to the unstable (nightly) branch? [y/N] " response
  773. if [[ ! "${response}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  774. echo "OK. If you prepared yourself for that please run the update.sh Script with the --nightly parameter again to trigger this process here."
  775. exit 0
  776. fi
  777. BRANCH=$NEW_BRANCH
  778. DIFF_DIRECTORY=update_diffs
  779. DIFF_FILE=${DIFF_DIRECTORY}/diff_before_upgrade_to_nightly_$(date +"%Y-%m-%d-%H-%M-%S")
  780. mv diff_before_upgrade* ${DIFF_DIRECTORY}/ 2> /dev/null
  781. if ! git diff-index --quiet HEAD; then
  782. echo -e "\e[32mSaving diff to ${DIFF_FILE}...\e[0m"
  783. mkdir -p ${DIFF_DIRECTORY}
  784. git diff ${BRANCH} --stat > ${DIFF_FILE}
  785. git diff ${BRANCH} >> ${DIFF_FILE}
  786. fi
  787. git fetch origin
  788. git checkout -f ${BRANCH}
  789. fi
  790. if [ ! $DEV ]; then
  791. echo -e "\e[32mChecking for newer update script...\e[0m"
  792. SHA1_1=$(sha1sum update.sh)
  793. git fetch origin #${BRANCH}
  794. git checkout origin/${BRANCH} update.sh
  795. SHA1_2=$(sha1sum update.sh)
  796. if [[ ${SHA1_1} != ${SHA1_2} ]]; then
  797. echo "update.sh changed, please run this script again, exiting."
  798. chmod +x update.sh
  799. exit 2
  800. fi
  801. fi
  802. if [ ! $FORCE ]; then
  803. read -r -p "Are you sure you want to update mailcow: dockerized? All containers will be stopped. [y/N] " response
  804. if [[ ! "${response}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  805. echo "OK, exiting."
  806. exit 0
  807. fi
  808. migrate_docker_nat
  809. fi
  810. remove_obsolete_nginx_ports
  811. echo -e "\e[32mValidating docker-compose stack configuration...\e[0m"
  812. sed -i 's/HTTPS_BIND:-:/HTTPS_BIND:-/g' docker-compose.yml
  813. sed -i 's/HTTP_BIND:-:/HTTP_BIND:-/g' docker-compose.yml
  814. if ! $COMPOSE_COMMAND config -q; then
  815. echo -e "\e[31m\nOh no, something went wrong. Please check the error message above.\e[0m"
  816. exit 1
  817. fi
  818. echo -e "\e[32mChecking for conflicting bridges...\e[0m"
  819. MAILCOW_BRIDGE=$($COMPOSE_COMMAND config | grep -i com.docker.network.bridge.name | cut -d':' -f2)
  820. while read NAT_ID; do
  821. iptables -t nat -D POSTROUTING $NAT_ID
  822. done < <(iptables -L -vn -t nat --line-numbers | grep $IPV4_NETWORK | grep -E 'MASQUERADE.*all' | grep -v ${MAILCOW_BRIDGE} | cut -d' ' -f1)
  823. DIFF_DIRECTORY=update_diffs
  824. DIFF_FILE=${DIFF_DIRECTORY}/diff_before_update_$(date +"%Y-%m-%d-%H-%M-%S")
  825. mv diff_before_update* ${DIFF_DIRECTORY}/ 2> /dev/null
  826. if ! git diff-index --quiet HEAD; then
  827. echo -e "\e[32mSaving diff to ${DIFF_FILE}...\e[0m"
  828. mkdir -p ${DIFF_DIRECTORY}
  829. git diff --stat > ${DIFF_FILE}
  830. git diff >> ${DIFF_FILE}
  831. fi
  832. echo -e "\e[32mPrefetching images...\e[0m"
  833. prefetch_images
  834. echo -e "\e[32mStopping mailcow...\e[0m"
  835. sleep 2
  836. MAILCOW_CONTAINERS=($($COMPOSE_COMMAND ps -q))
  837. $COMPOSE_COMMAND down
  838. echo -e "\e[32mChecking for remaining containers...\e[0m"
  839. sleep 2
  840. for container in "${MAILCOW_CONTAINERS[@]}"; do
  841. docker rm -f "$container" 2> /dev/null
  842. done
  843. [[ -f data/conf/nginx/ZZZ-ejabberd.conf ]] && rm data/conf/nginx/ZZZ-ejabberd.conf
  844. # Silently fixing remote url from andryyy to mailcow
  845. # git remote set-url origin https://github.com/mailcow/mailcow-dockerized
  846. DEFAULT_REPO=https://github.com/mailcow/mailcow-dockerized
  847. CURRENT_REPO=$(git remote get-url origin)
  848. if [ "$CURRENT_REPO" != "$DEFAULT_REPO" ]; then
  849. echo "The Repository currently used is not the default Mailcow Repository."
  850. echo "Currently Repository: $CURRENT_REPO"
  851. echo "Default Repository: $DEFAULT_REPO"
  852. read -r -p "Should it be changed back to default? [y/N] " repo_response
  853. if [[ "$repo_response" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  854. git remote set-url origin $DEFAULT_REPO
  855. fi
  856. fi
  857. echo -e "\e[32mCommitting current status...\e[0m"
  858. [[ -z "$(git config user.name)" ]] && git config user.name moo
  859. [[ -z "$(git config user.email)" ]] && git config user.email moo@cow.moo
  860. [[ ! -z $(git ls-files data/conf/rspamd/override.d/worker-controller-password.inc) ]] && git rm data/conf/rspamd/override.d/worker-controller-password.inc
  861. git add -u
  862. git commit -am "Before update on ${DATE}" > /dev/null
  863. echo -e "\e[32mFetching updated code from remote...\e[0m"
  864. git fetch origin #${BRANCH}
  865. echo -e "\e[32mMerging local with remote code (recursive, strategy: \"${MERGE_STRATEGY:-theirs}\", options: \"patience\"...\e[0m"
  866. git config merge.defaultToUpstream true
  867. git merge -X${MERGE_STRATEGY:-theirs} -Xpatience -m "After update on ${DATE}"
  868. # Need to use a variable to not pass return codes of if checks
  869. MERGE_RETURN=$?
  870. if [[ ${MERGE_RETURN} == 128 ]]; then
  871. 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"
  872. exit 1
  873. elif [[ ${MERGE_RETURN} == 1 ]]; then
  874. echo -e "\e[93mPotenial conflict, trying to fix...\e[0m"
  875. git status --porcelain | grep -E "UD|DU" | awk '{print $2}' | xargs rm -v
  876. git add -A
  877. git commit -m "After update on ${DATE}" > /dev/null
  878. git checkout .
  879. echo -e "\e[32mRemoved and recreated files if necessary.\e[0m"
  880. elif [[ ${MERGE_RETURN} != 0 ]]; then
  881. echo -e "\e[31m\nOh no, something went wrong. Please check the error message above.\e[0m"
  882. echo
  883. echo "Run $COMPOSE_COMMAND up -d to restart your stack without updates or try again after fixing the mentioned errors."
  884. exit 1
  885. fi
  886. echo -e "\e[32mFetching new images, if any...\e[0m"
  887. sleep 2
  888. $COMPOSE_COMMAND pull
  889. # Fix missing SSL, does not overwrite existing files
  890. [[ ! -d data/assets/ssl ]] && mkdir -p data/assets/ssl
  891. cp -n -d data/assets/ssl-example/*.pem data/assets/ssl/
  892. echo -e "Checking IPv6 settings... "
  893. if grep -q 'SYSCTL_IPV6_DISABLED=1' mailcow.conf; then
  894. echo
  895. echo '!! IMPORTANT !!'
  896. echo
  897. 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".'
  898. echo "This setting will only be active after a complete shutdown of mailcow by running $COMPOSE_COMMAND down followed by $COMPOSE_COMMAND up -d."
  899. echo
  900. echo '!! IMPORTANT !!'
  901. echo
  902. read -p "Press any key to continue..." < /dev/tty
  903. fi
  904. # Checking for old project name bug
  905. sed -i --follow-symlinks 's#COMPOSEPROJECT_NAME#COMPOSE_PROJECT_NAME#g' mailcow.conf
  906. # Fix Rspamd maps
  907. if [ -f data/conf/rspamd/custom/global_from_blacklist.map ]; then
  908. mv data/conf/rspamd/custom/global_from_blacklist.map data/conf/rspamd/custom/global_smtp_from_blacklist.map
  909. fi
  910. if [ -f data/conf/rspamd/custom/global_from_whitelist.map ]; then
  911. mv data/conf/rspamd/custom/global_from_whitelist.map data/conf/rspamd/custom/global_smtp_from_whitelist.map
  912. fi
  913. # Fix deprecated metrics.conf
  914. if [ -f "data/conf/rspamd/local.d/metrics.conf" ]; then
  915. if [ ! -z "$(git diff --name-only origin/master data/conf/rspamd/local.d/metrics.conf)" ]; then
  916. 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."
  917. echo "The deprecated configuration file metrics.conf will be moved to metrics.conf_deprecated after updating mailcow."
  918. fi
  919. mv data/conf/rspamd/local.d/metrics.conf data/conf/rspamd/local.d/metrics.conf_deprecated
  920. fi
  921. # Set app_info.inc.php
  922. if [ ${BRANCH} == "master" ]; then
  923. mailcow_git_version=$(git describe --tags `git rev-list --tags --max-count=1`)
  924. elif [ ${BRANCH} == "nightly" ]; then
  925. mailcow_git_version=$(git rev-parse --short $(git rev-parse @{upstream}))
  926. mailcow_last_git_version=""
  927. else
  928. mailcow_git_version=$(git rev-parse --short HEAD)
  929. mailcow_last_git_version=""
  930. fi
  931. mailcow_git_commit=$(git rev-parse origin/${BRANCH})
  932. mailcow_git_commit_date=$(git log -1 --format=%ci @{upstream} )
  933. if [ $? -eq 0 ]; then
  934. echo '<?php' > data/web/inc/app_info.inc.php
  935. echo ' $MAILCOW_GIT_VERSION="'$mailcow_git_version'";' >> data/web/inc/app_info.inc.php
  936. echo ' $MAILCOW_LAST_GIT_VERSION="";' >> data/web/inc/app_info.inc.php
  937. echo ' $MAILCOW_GIT_OWNER="mailcow";' >> data/web/inc/app_info.inc.php
  938. echo ' $MAILCOW_GIT_REPO="mailcow-dockerized";' >> data/web/inc/app_info.inc.php
  939. echo ' $MAILCOW_GIT_URL="https://github.com/mailcow/mailcow-dockerized";' >> data/web/inc/app_info.inc.php
  940. echo ' $MAILCOW_GIT_COMMIT="'$mailcow_git_commit'";' >> data/web/inc/app_info.inc.php
  941. echo ' $MAILCOW_GIT_COMMIT_DATE="'$mailcow_git_commit_date'";' >> data/web/inc/app_info.inc.php
  942. echo ' $MAILCOW_BRANCH="'$BRANCH'";' >> data/web/inc/app_info.inc.php
  943. echo ' $MAILCOW_UPDATEDAT='$(date +%s)';' >> data/web/inc/app_info.inc.php
  944. echo '?>' >> data/web/inc/app_info.inc.php
  945. else
  946. echo '<?php' > data/web/inc/app_info.inc.php
  947. echo ' $MAILCOW_GIT_VERSION="'$mailcow_git_version'";' >> data/web/inc/app_info.inc.php
  948. echo ' $MAILCOW_LAST_GIT_VERSION="";' >> data/web/inc/app_info.inc.php
  949. echo ' $MAILCOW_GIT_OWNER="mailcow";' >> data/web/inc/app_info.inc.php
  950. echo ' $MAILCOW_GIT_REPO="mailcow-dockerized";' >> data/web/inc/app_info.inc.php
  951. echo ' $MAILCOW_GIT_URL="https://github.com/mailcow/mailcow-dockerized";' >> data/web/inc/app_info.inc.php
  952. echo ' $MAILCOW_GIT_COMMIT="";' >> data/web/inc/app_info.inc.php
  953. echo ' $MAILCOW_GIT_COMMIT_DATE="";' >> data/web/inc/app_info.inc.php
  954. echo ' $MAILCOW_BRANCH="'$BRANCH'";' >> data/web/inc/app_info.inc.php
  955. echo ' $MAILCOW_UPDATEDAT='$(date +%s)';' >> data/web/inc/app_info.inc.php
  956. echo '?>' >> data/web/inc/app_info.inc.php
  957. echo -e "\e[33mCannot determine current git repository version...\e[0m"
  958. fi
  959. if [[ ${SKIP_START} == "y" ]]; then
  960. echo -e "\e[33mNot starting mailcow, please run \"$COMPOSE_COMMAND up -d --remove-orphans\" to start mailcow.\e[0m"
  961. else
  962. echo -e "\e[32mStarting mailcow...\e[0m"
  963. sleep 2
  964. $COMPOSE_COMMAND up -d --remove-orphans
  965. fi
  966. echo -e "\e[32mCollecting garbage...\e[0m"
  967. docker_garbage
  968. # Run post-update-hook
  969. if [ -f "${SCRIPT_DIR}/post_update_hook.sh" ]; then
  970. bash "${SCRIPT_DIR}/post_update_hook.sh"
  971. fi
  972. # echo "In case you encounter any problem, hard-reset to a state before updating mailcow:"
  973. # echo
  974. # git reflog --color=always | grep "Before update on "
  975. # echo
  976. # echo "Use \"git reset --hard hash-on-the-left\" and run $COMPOSE_COMMAND up -d afterwards."