update.sh 77 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648
  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. SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
  32. IMGS_TO_DELETE=()
  33. declare -A IMAGES_INFO
  34. COMPOSE_IMAGES=($(grep -oP "image: \K(ghcr\.io/)?mailcow.+" "${SCRIPT_DIR}/docker-compose.yml"))
  35. for existing_image in $(docker images --format "{{.ID}}:{{.Repository}}:{{.Tag}}" | grep -E '(mailcow/|ghcr\.io/mailcow/)'); do
  36. ID=$(echo "$existing_image" | cut -d ':' -f 1)
  37. REPOSITORY=$(echo "$existing_image" | cut -d ':' -f 2)
  38. TAG=$(echo "$existing_image" | cut -d ':' -f 3)
  39. if [[ "$REPOSITORY" == "mailcow/backup" || "$REPOSITORY" == "ghcr.io/mailcow/backup" ]]; then
  40. if [[ "$TAG" != "<none>" ]]; then
  41. continue
  42. fi
  43. fi
  44. if [[ " ${COMPOSE_IMAGES[@]} " =~ " ${REPOSITORY}:${TAG} " ]]; then
  45. continue
  46. else
  47. IMGS_TO_DELETE+=("$ID")
  48. IMAGES_INFO["$ID"]="$REPOSITORY:$TAG"
  49. fi
  50. done
  51. if [[ ! -z ${IMGS_TO_DELETE[*]} ]]; then
  52. echo "The following unused mailcow images were found:"
  53. for id in "${IMGS_TO_DELETE[@]}"; do
  54. echo " ${IMAGES_INFO[$id]} ($id)"
  55. done
  56. if [ -z "$FORCE" ]; then
  57. read -r -p "Do you want to delete them to free up some space? [y/N] " response
  58. if [[ "$response" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  59. docker rmi ${IMGS_TO_DELETE[*]}
  60. else
  61. echo "OK, skipped."
  62. fi
  63. else
  64. echo "Running in forced mode! Force removing old mailcow images..."
  65. docker rmi ${IMGS_TO_DELETE[*]}
  66. fi
  67. echo -e "\e[32mFurther cleanup...\e[0m"
  68. 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\""
  69. fi
  70. }
  71. in_array() {
  72. local e match="$1"
  73. shift
  74. for e; do [[ "$e" == "$match" ]] && return 0; done
  75. return 1
  76. }
  77. migrate_docker_nat() {
  78. NAT_CONFIG='{"ipv6":true,"fixed-cidr-v6":"fd00:dead:beef:c0::/80","experimental":true,"ip6tables":true}'
  79. # Min Docker version
  80. DOCKERV_REQ=20.10.2
  81. # Current Docker version
  82. DOCKERV_CUR=$(docker version -f '{{.Server.Version}}')
  83. if grep -qi "ipv6nat-mailcow" docker-compose.yml && grep -qi "enable_ipv6: true" docker-compose.yml; then
  84. echo -e "\e[32mNative IPv6 implementation available.\e[0m"
  85. echo "This will enable experimental features in the Docker daemon and configure Docker to do the IPv6 NATing instead of ipv6nat-mailcow."
  86. echo '!!! This step is recommended !!!'
  87. echo "mailcow will try to roll back the changes if starting Docker fails after modifying the daemon.json configuration file."
  88. read -r -p "Should we try to enable the native IPv6 implementation in Docker now (recommended)? [y/N] " dockernatresponse
  89. if [[ ! "${dockernatresponse}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  90. echo "OK, skipping this step."
  91. return 0
  92. fi
  93. fi
  94. # Sort versions and check if we are running a newer or equal version to req
  95. if [ $(printf "${DOCKERV_REQ}\n${DOCKERV_CUR}" | sort -V | tail -n1) == "${DOCKERV_CUR}" ]; then
  96. # If Dockerd daemon json exists
  97. if [ -s /etc/docker/daemon.json ]; then
  98. IFS=',' read -r -a dockerconfig <<< $(cat /etc/docker/daemon.json | tr -cd '[:alnum:],')
  99. if ! in_array ipv6true "${dockerconfig[@]}" || \
  100. ! in_array experimentaltrue "${dockerconfig[@]}" || \
  101. ! in_array ip6tablestrue "${dockerconfig[@]}" || \
  102. ! grep -qi "fixed-cidr-v6" /etc/docker/daemon.json; then
  103. 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."
  104. echo "You will need to merge your existing configuration manually or fix/delete the existing daemon.json configuration before trying the update process again."
  105. echo -e "Please merge the following content and restart the Docker daemon:\n"
  106. echo "${NAT_CONFIG}"
  107. return 1
  108. fi
  109. else
  110. echo "Working on IPv6 NAT, please wait..."
  111. echo "${NAT_CONFIG}" > /etc/docker/daemon.json
  112. ip6tables -F -t nat
  113. [[ -e /etc/rc.conf ]] && rc-service docker restart || systemctl restart docker.service
  114. if [[ $? -ne 0 ]]; then
  115. echo -e "\e[31mError:\e[0m Failed to activate IPv6 NAT! Reverting and exiting."
  116. rm /etc/docker/daemon.json
  117. if [[ -e /etc/rc.conf ]]; then
  118. rc-service docker restart
  119. else
  120. systemctl reset-failed docker.service
  121. systemctl restart docker.service
  122. fi
  123. return 1
  124. fi
  125. fi
  126. # Removing legacy container
  127. sed -i '/ipv6nat-mailcow:$/,/^$/d' docker-compose.yml
  128. if [ -s docker-compose.override.yml ]; then
  129. sed -i '/ipv6nat-mailcow:$/,/^$/d' docker-compose.override.yml
  130. if [[ "$(cat docker-compose.override.yml | sed '/^\s*$/d' | wc -l)" == "2" ]]; then
  131. mv docker-compose.override.yml docker-compose.override.yml_backup
  132. fi
  133. fi
  134. echo -e "\e[32mGreat! \e[0mNative IPv6 NAT is active.\e[0m"
  135. else
  136. echo -e "\e[31mPlease upgrade Docker to version ${DOCKERV_REQ} or above.\e[0m"
  137. return 0
  138. fi
  139. }
  140. remove_obsolete_nginx_ports() {
  141. # Removing obsolete docker-compose.override.yml
  142. for override in docker-compose.override.yml docker-compose.override.yaml; do
  143. if [ -s $override ] ; then
  144. if cat $override | grep nginx-mailcow > /dev/null 2>&1; then
  145. if cat $override | grep -E '(\[::])' > /dev/null 2>&1; then
  146. if cat $override | grep -w 80:80 > /dev/null 2>&1 && cat $override | grep -w 443:443 > /dev/null 2>&1 ; then
  147. echo -e "\e[33mBacking up ${override} to preserve custom changes...\e[0m"
  148. echo -e "\e[33m!!! Manual Merge needed (if other overrides are set) !!!\e[0m"
  149. sleep 3
  150. cp $override ${override}_backup
  151. sed -i '/nginx-mailcow:$/,/^$/d' $override
  152. echo -e "\e[33mRemoved obsolete NGINX IPv6 Bind from original override File.\e[0m"
  153. if [[ "$(cat $override | sed '/^\s*$/d' | wc -l)" == "2" ]]; then
  154. mv $override ${override}_empty
  155. echo -e "\e[31m${override} is empty. Renamed it to ensure mailcow is startable.\e[0m"
  156. fi
  157. fi
  158. fi
  159. fi
  160. fi
  161. done
  162. }
  163. detect_docker_compose_command(){
  164. if ! [[ "${DOCKER_COMPOSE_VERSION}" =~ ^(native|standalone)$ ]]; then
  165. if docker compose > /dev/null 2>&1; then
  166. if docker compose version --short | grep -e "^2." -e "^v2." > /dev/null 2>&1; then
  167. DOCKER_COMPOSE_VERSION=native
  168. COMPOSE_COMMAND="docker compose"
  169. echo -e "\e[33mFound Docker Compose Plugin (native).\e[0m"
  170. echo -e "\e[33mSetting the DOCKER_COMPOSE_VERSION Variable to native\e[0m"
  171. sed -i 's/^DOCKER_COMPOSE_VERSION=.*/DOCKER_COMPOSE_VERSION=native/' "$SCRIPT_DIR/mailcow.conf"
  172. sleep 2
  173. echo -e "\e[33mNotice: You'll have to update this Compose Version via your Package Manager manually!\e[0m"
  174. else
  175. echo -e "\e[31mCannot find Docker Compose with a Version Higher than 2.X.X.\e[0m"
  176. echo -e "\e[31mPlease update/install it manually regarding to this doc site: https://docs.mailcow.email/install/\e[0m"
  177. exit 1
  178. fi
  179. elif docker-compose > /dev/null 2>&1; then
  180. if ! [[ $(alias docker-compose 2> /dev/null) ]] ; then
  181. if docker-compose version --short | grep "^2." > /dev/null 2>&1; then
  182. DOCKER_COMPOSE_VERSION=standalone
  183. COMPOSE_COMMAND="docker-compose"
  184. echo -e "\e[33mFound Docker Compose Standalone.\e[0m"
  185. echo -e "\e[33mSetting the DOCKER_COMPOSE_VERSION Variable to standalone\e[0m"
  186. sed -i 's/^DOCKER_COMPOSE_VERSION=.*/DOCKER_COMPOSE_VERSION=standalone/' "$SCRIPT_DIR/mailcow.conf"
  187. sleep 2
  188. 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"
  189. else
  190. echo -e "\e[31mCannot find Docker Compose with a Version Higher than 2.X.X.\e[0m"
  191. echo -e "\e[31mPlease update/install regarding to this doc site: https://docs.mailcow.email/install/\e[0m"
  192. exit 1
  193. fi
  194. fi
  195. else
  196. echo -e "\e[31mCannot find Docker Compose.\e[0m"
  197. echo -e "\e[31mPlease install it regarding to this doc site: https://docs.mailcow.email/install/\e[0m"
  198. exit 1
  199. fi
  200. elif [ "${DOCKER_COMPOSE_VERSION}" == "native" ]; then
  201. COMPOSE_COMMAND="docker compose"
  202. # Check if Native Compose works and has not been deleted
  203. if ! $COMPOSE_COMMAND > /dev/null 2>&1; then
  204. # IF it not exists/work anymore try the other command
  205. COMPOSE_COMMAND="docker-compose"
  206. if ! $COMPOSE_COMMAND > /dev/null 2>&1 || ! $COMPOSE_COMMAND --version | grep "^2." > /dev/null 2>&1; then
  207. # IF it cannot find Standalone in > 2.X, then script stops
  208. echo -e "\e[31mCannot find Docker Compose or the Version is lower then 2.X.X.\e[0m"
  209. echo -e "\e[31mPlease install it regarding to this doc site: https://docs.mailcow.email/install/\e[0m"
  210. exit 1
  211. fi
  212. # If it finds the standalone Plugin it will use this instead and change the mailcow.conf Variable accordingly
  213. echo -e "\e[31mFound different Docker Compose Version then declared in mailcow.conf!\e[0m"
  214. echo -e "\e[31mSetting the DOCKER_COMPOSE_VERSION Variable from native to standalone\e[0m"
  215. sed -i 's/^DOCKER_COMPOSE_VERSION=.*/DOCKER_COMPOSE_VERSION=standalone/' "$SCRIPT_DIR/mailcow.conf"
  216. sleep 2
  217. fi
  218. elif [ "${DOCKER_COMPOSE_VERSION}" == "standalone" ]; then
  219. COMPOSE_COMMAND="docker-compose"
  220. # Check if Standalone Compose works and has not been deleted
  221. if ! $COMPOSE_COMMAND > /dev/null 2>&1 && ! $COMPOSE_COMMAND --version > /dev/null 2>&1 | grep "^2." > /dev/null 2>&1; then
  222. # IF it not exists/work anymore try the other command
  223. COMPOSE_COMMAND="docker compose"
  224. if ! $COMPOSE_COMMAND > /dev/null 2>&1; then
  225. # IF it cannot find Native in > 2.X, then script stops
  226. echo -e "\e[31mCannot find Docker Compose.\e[0m"
  227. echo -e "\e[31mPlease install it regarding to this doc site: https://docs.mailcow.email/install/\e[0m"
  228. exit 1
  229. fi
  230. # If it finds the native Plugin it will use this instead and change the mailcow.conf Variable accordingly
  231. echo -e "\e[31mFound different Docker Compose Version then declared in mailcow.conf!\e[0m"
  232. echo -e "\e[31mSetting the DOCKER_COMPOSE_VERSION Variable from standalone to native\e[0m"
  233. sed -i 's/^DOCKER_COMPOSE_VERSION=.*/DOCKER_COMPOSE_VERSION=native/' "$SCRIPT_DIR/mailcow.conf"
  234. sleep 2
  235. fi
  236. fi
  237. }
  238. detect_bad_asn() {
  239. echo -e "\e[33mDetecting if your IP is listed on Spamhaus Bad ASN List...\e[0m"
  240. response=$(curl --connect-timeout 15 --max-time 30 -s -o /dev/null -w "%{http_code}" "https://asn-check.mailcow.email")
  241. if [ "$response" -eq 503 ]; then
  242. if [ -z "$SPAMHAUS_DQS_KEY" ]; then
  243. 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"
  244. echo -e "\e[33mmailcow did not detected a value for the variable SPAMHAUS_DQS_KEY inside mailcow.conf!\e[0m"
  245. sleep 2
  246. echo ""
  247. 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"
  248. echo -e "\e[33mOnce done, enter your DQS API key in mailcow.conf and mailcow will do the rest for you!\e[0m"
  249. echo ""
  250. sleep 2
  251. else
  252. 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"
  253. 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"
  254. fi
  255. elif [ "$response" -eq 200 ]; then
  256. echo -e "\e[33mCheck completed! Your IP is \e[32mclean\e[0m"
  257. elif [ "$response" -eq 429 ]; then
  258. echo -e "\e[33mCheck completed! \e[31mYour IP seems to be rate limited on the ASN Check service... please try again later!\e[0m"
  259. else
  260. echo -e "\e[31mCheck failed! \e[0mMaybe a DNS or Network problem?\e[0m"
  261. fi
  262. }
  263. fix_broken_dnslist_conf() {
  264. # Fixing issue: #6143. To be removed in a later patch
  265. local file="${SCRIPT_DIR}/data/conf/postfix/dns_blocklists.cf"
  266. # Check if the file exists
  267. if [[ ! -f "$file" ]]; then
  268. return 1
  269. fi
  270. # Check if the file contains the autogenerated comment
  271. if grep -q "# Autogenerated by mailcow" "$file"; then
  272. # Ask the user if custom changes were made
  273. echo -e "\e[91mWARNING!!! \e[31mAn old version of dns_blocklists.cf has been detected which may cause a broken postfix upon startup (see: https://github.com/mailcow/mailcow-dockerized/issues/6143)...\e[0m"
  274. echo -e "\e[31mIf you have any custom settings in there you might copy it away and adapt the changes after the file is regenerated...\e[0m"
  275. read -p "Do you want to delete the file now and let mailcow regenerate it properly? [y/n]" response
  276. if [[ "${response}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  277. rm "$file"
  278. echo -e "\e[32mdns_blocklists.cf has been deleted and will be properly regenerated"
  279. return 0
  280. else
  281. echo -e "\e[35mOk, not deleting it! Please make sure you take a look at postfix upon start then..."
  282. return 2
  283. fi
  284. fi
  285. }
  286. adapt_new_options() {
  287. CONFIG_ARRAY=(
  288. "SKIP_LETS_ENCRYPT"
  289. "SKIP_SOGO"
  290. "USE_WATCHDOG"
  291. "WATCHDOG_NOTIFY_EMAIL"
  292. "WATCHDOG_NOTIFY_WEBHOOK"
  293. "WATCHDOG_NOTIFY_WEBHOOK_BODY"
  294. "WATCHDOG_NOTIFY_BAN"
  295. "WATCHDOG_NOTIFY_START"
  296. "WATCHDOG_EXTERNAL_CHECKS"
  297. "WATCHDOG_SUBJECT"
  298. "SKIP_CLAMD"
  299. "SKIP_OLEFY"
  300. "SKIP_IP_CHECK"
  301. "ADDITIONAL_SAN"
  302. "DOVEADM_PORT"
  303. "IPV4_NETWORK"
  304. "IPV6_NETWORK"
  305. "LOG_LINES"
  306. "SNAT_TO_SOURCE"
  307. "SNAT6_TO_SOURCE"
  308. "COMPOSE_PROJECT_NAME"
  309. "DOCKER_COMPOSE_VERSION"
  310. "SQL_PORT"
  311. "API_KEY"
  312. "API_KEY_READ_ONLY"
  313. "API_ALLOW_FROM"
  314. "MAILDIR_GC_TIME"
  315. "MAILDIR_SUB"
  316. "ACL_ANYONE"
  317. "FTS_HEAP"
  318. "FTS_PROCS"
  319. "SKIP_FTS"
  320. "ENABLE_SSL_SNI"
  321. "ALLOW_ADMIN_EMAIL_LOGIN"
  322. "SKIP_HTTP_VERIFICATION"
  323. "SOGO_EXPIRE_SESSION"
  324. "REDIS_PORT"
  325. "DOVECOT_MASTER_USER"
  326. "DOVECOT_MASTER_PASS"
  327. "MAILCOW_PASS_SCHEME"
  328. "ADDITIONAL_SERVER_NAMES"
  329. "ACME_CONTACT"
  330. "WATCHDOG_VERBOSE"
  331. "WEBAUTHN_ONLY_TRUSTED_VENDORS"
  332. "SPAMHAUS_DQS_KEY"
  333. "SKIP_UNBOUND_HEALTHCHECK"
  334. "DISABLE_NETFILTER_ISOLATION_RULE"
  335. "HTTP_REDIRECT"
  336. )
  337. sed -i --follow-symlinks '$a\' mailcow.conf
  338. for option in ${CONFIG_ARRAY[@]}; do
  339. if [[ ${option} == "ADDITIONAL_SAN" ]]; then
  340. if ! grep -q ${option} mailcow.conf; then
  341. echo "Adding new option \"${option}\" to mailcow.conf"
  342. echo "${option}=" >> mailcow.conf
  343. fi
  344. elif [[ ${option} == "COMPOSE_PROJECT_NAME" ]]; then
  345. if ! grep -q ${option} mailcow.conf; then
  346. echo "Adding new option \"${option}\" to mailcow.conf"
  347. echo "COMPOSE_PROJECT_NAME=mailcowdockerized" >> mailcow.conf
  348. fi
  349. elif [[ ${option} == "DOCKER_COMPOSE_VERSION" ]]; then
  350. if ! grep -q ${option} mailcow.conf; then
  351. echo "Adding new option \"${option}\" to mailcow.conf"
  352. echo "# Used Docker Compose version" >> mailcow.conf
  353. echo "# Switch here between native (compose plugin) and standalone" >> mailcow.conf
  354. echo "# For more informations take a look at the mailcow docs regarding the configuration options." >> mailcow.conf
  355. echo "# Normally this should be untouched but if you decided to use either of those you can switch it manually here." >> mailcow.conf
  356. echo "# Please be aware that at least one of those variants should be installed on your maschine or mailcow will fail." >> mailcow.conf
  357. echo "" >> mailcow.conf
  358. echo "DOCKER_COMPOSE_VERSION=${DOCKER_COMPOSE_VERSION}" >> mailcow.conf
  359. fi
  360. elif [[ ${option} == "DOVEADM_PORT" ]]; then
  361. if ! grep -q ${option} mailcow.conf; then
  362. echo "Adding new option \"${option}\" to mailcow.conf"
  363. echo "DOVEADM_PORT=127.0.0.1:19991" >> mailcow.conf
  364. fi
  365. elif [[ ${option} == "WATCHDOG_NOTIFY_EMAIL" ]]; then
  366. if ! grep -q ${option} mailcow.conf; then
  367. echo "Adding new option \"${option}\" to mailcow.conf"
  368. echo "WATCHDOG_NOTIFY_EMAIL=" >> mailcow.conf
  369. fi
  370. elif [[ ${option} == "LOG_LINES" ]]; then
  371. if ! grep -q ${option} mailcow.conf; then
  372. echo "Adding new option \"${option}\" to mailcow.conf"
  373. echo '# Max log lines per service to keep in Redis logs' >> mailcow.conf
  374. echo "LOG_LINES=9999" >> mailcow.conf
  375. fi
  376. elif [[ ${option} == "IPV4_NETWORK" ]]; then
  377. if ! grep -q ${option} mailcow.conf; then
  378. echo "Adding new option \"${option}\" to mailcow.conf"
  379. echo '# Internal IPv4 /24 subnet, format n.n.n. (expands to n.n.n.0/24)' >> mailcow.conf
  380. echo "IPV4_NETWORK=172.22.1" >> mailcow.conf
  381. fi
  382. elif [[ ${option} == "IPV6_NETWORK" ]]; then
  383. if ! grep -q ${option} mailcow.conf; then
  384. echo "Adding new option \"${option}\" to mailcow.conf"
  385. echo '# Internal IPv6 subnet in fc00::/7' >> mailcow.conf
  386. echo "IPV6_NETWORK=fd4d:6169:6c63:6f77::/64" >> mailcow.conf
  387. fi
  388. elif [[ ${option} == "SQL_PORT" ]]; then
  389. if ! grep -q ${option} mailcow.conf; then
  390. echo "Adding new option \"${option}\" to mailcow.conf"
  391. echo '# Bind SQL to 127.0.0.1 on port 13306' >> mailcow.conf
  392. echo "SQL_PORT=127.0.0.1:13306" >> mailcow.conf
  393. fi
  394. elif [[ ${option} == "API_KEY" ]]; then
  395. if ! grep -q ${option} mailcow.conf; then
  396. echo "Adding new option \"${option}\" to mailcow.conf"
  397. echo '# Create or override API key for web UI' >> mailcow.conf
  398. echo "#API_KEY=" >> mailcow.conf
  399. fi
  400. elif [[ ${option} == "API_KEY_READ_ONLY" ]]; then
  401. if ! grep -q ${option} mailcow.conf; then
  402. echo "Adding new option \"${option}\" to mailcow.conf"
  403. echo '# Create or override read-only API key for web UI' >> mailcow.conf
  404. echo "#API_KEY_READ_ONLY=" >> mailcow.conf
  405. fi
  406. elif [[ ${option} == "API_ALLOW_FROM" ]]; then
  407. if ! grep -q ${option} mailcow.conf; then
  408. echo "Adding new option \"${option}\" to mailcow.conf"
  409. echo '# Must be set for API_KEY to be active' >> mailcow.conf
  410. echo '# IPs only, no networks (networks can be set via UI)' >> mailcow.conf
  411. echo "#API_ALLOW_FROM=" >> mailcow.conf
  412. fi
  413. elif [[ ${option} == "SNAT_TO_SOURCE" ]]; then
  414. if ! grep -q ${option} mailcow.conf; then
  415. echo "Adding new option \"${option}\" to mailcow.conf"
  416. echo '# Use this IPv4 for outgoing connections (SNAT)' >> mailcow.conf
  417. echo "#SNAT_TO_SOURCE=" >> mailcow.conf
  418. fi
  419. elif [[ ${option} == "SNAT6_TO_SOURCE" ]]; then
  420. if ! grep -q ${option} mailcow.conf; then
  421. echo "Adding new option \"${option}\" to mailcow.conf"
  422. echo '# Use this IPv6 for outgoing connections (SNAT)' >> mailcow.conf
  423. echo "#SNAT6_TO_SOURCE=" >> mailcow.conf
  424. fi
  425. elif [[ ${option} == "MAILDIR_GC_TIME" ]]; then
  426. if ! grep -q ${option} mailcow.conf; then
  427. echo "Adding new option \"${option}\" to mailcow.conf"
  428. echo '# Garbage collector cleanup' >> mailcow.conf
  429. echo '# Deleted domains and mailboxes are moved to /var/vmail/_garbage/timestamp_sanitizedstring' >> mailcow.conf
  430. echo '# How long should objects remain in the garbage until they are being deleted? (value in minutes)' >> mailcow.conf
  431. echo '# Check interval is hourly' >> mailcow.conf
  432. echo 'MAILDIR_GC_TIME=1440' >> mailcow.conf
  433. fi
  434. elif [[ ${option} == "ACL_ANYONE" ]]; then
  435. if ! grep -q ${option} mailcow.conf; then
  436. echo "Adding new option \"${option}\" to mailcow.conf"
  437. echo '# Set this to "allow" to enable the anyone pseudo user. Disabled by default.' >> mailcow.conf
  438. echo '# When enabled, ACL can be created, that apply to "All authenticated users"' >> mailcow.conf
  439. echo '# This should probably only be activated on mail hosts, that are used exclusivly by one organisation.' >> mailcow.conf
  440. echo '# Otherwise a user might share data with too many other users.' >> mailcow.conf
  441. echo 'ACL_ANYONE=disallow' >> mailcow.conf
  442. fi
  443. elif [[ ${option} == "FTS_HEAP" ]]; then
  444. if ! grep -q ${option} mailcow.conf; then
  445. echo "Adding new option \"${option}\" to mailcow.conf"
  446. echo '# Dovecot Indexing (FTS) Process maximum heap size in MB, there is no recommendation, please see Dovecot docs.' >> mailcow.conf
  447. echo '# Flatcurve is used as FTS Engine. It is supposed to be pretty efficient in CPU and RAM consumption.' >> mailcow.conf
  448. echo '# Please always monitor your Resource consumption!' >> mailcow.conf
  449. echo "FTS_HEAP=128" >> mailcow.conf
  450. fi
  451. elif [[ ${option} == "SKIP_FTS" ]]; then
  452. if ! grep -q ${option} mailcow.conf; then
  453. echo "Adding new option \"${option}\" to mailcow.conf"
  454. echo '# Skip FTS (Fulltext Search) for Dovecot on low-memory, low-threaded systems or if you simply want to disable it.' >> mailcow.conf
  455. echo "# Dovecot inside mailcow use Flatcurve as FTS Backend." >> mailcow.conf
  456. echo "SKIP_FTS=y" >> mailcow.conf
  457. fi
  458. elif [[ ${option} == "FTS_PROCS" ]]; then
  459. if ! grep -q ${option} mailcow.conf; then
  460. echo "Adding new option \"${option}\" to mailcow.conf"
  461. echo '# Controls how many processes the Dovecot indexing process can spawn at max.' >> mailcow.conf
  462. echo '# Too many indexing processes can use a lot of CPU and Disk I/O' >> mailcow.conf
  463. echo '# Please visit: https://doc.dovecot.org/configuration_manual/service_configuration/#indexer-worker for more informations' >> mailcow.conf
  464. echo "FTS_PROCS=1" >> mailcow.conf
  465. fi
  466. elif [[ ${option} == "ENABLE_SSL_SNI" ]]; then
  467. if ! grep -q ${option} mailcow.conf; then
  468. echo "Adding new option \"${option}\" to mailcow.conf"
  469. echo '# Create seperate certificates for all domains - y/n' >> mailcow.conf
  470. echo '# this will allow adding more than 100 domains, but some email clients will not be able to connect with alternative hostnames' >> mailcow.conf
  471. echo '# see https://wiki.dovecot.org/SSL/SNIClientSupport' >> mailcow.conf
  472. echo "ENABLE_SSL_SNI=n" >> mailcow.conf
  473. fi
  474. elif [[ ${option} == "SKIP_SOGO" ]]; then
  475. if ! grep -q ${option} mailcow.conf; then
  476. echo "Adding new option \"${option}\" to mailcow.conf"
  477. echo '# Skip SOGo: Will disable SOGo integration and therefore webmail, DAV protocols and ActiveSync support (experimental, unsupported, not fully implemented) - y/n' >> mailcow.conf
  478. echo "SKIP_SOGO=n" >> mailcow.conf
  479. fi
  480. elif [[ ${option} == "MAILDIR_SUB" ]]; then
  481. if ! grep -q ${option} mailcow.conf; then
  482. echo "Adding new option \"${option}\" to mailcow.conf"
  483. echo '# MAILDIR_SUB defines a path in a users virtual home to keep the maildir in. Leave empty for updated setups.' >> mailcow.conf
  484. echo "#MAILDIR_SUB=Maildir" >> mailcow.conf
  485. echo "MAILDIR_SUB=" >> mailcow.conf
  486. fi
  487. elif [[ ${option} == "WATCHDOG_NOTIFY_WEBHOOK" ]]; then
  488. if ! grep -q ${option} mailcow.conf; then
  489. echo "Adding new option \"${option}\" to mailcow.conf"
  490. echo '# Send notifications to a webhook URL that receives a POST request with the content type "application/json".' >> mailcow.conf
  491. echo '# You can use this to send notifications to services like Discord, Slack and others.' >> mailcow.conf
  492. echo '#WATCHDOG_NOTIFY_WEBHOOK=https://discord.com/api/webhooks/XXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' >> mailcow.conf
  493. fi
  494. elif [[ ${option} == "WATCHDOG_NOTIFY_WEBHOOK_BODY" ]]; then
  495. if ! grep -q ${option} mailcow.conf; then
  496. echo "Adding new option \"${option}\" to mailcow.conf"
  497. echo '# JSON body included in the webhook POST request. Needs to be in single quotes.' >> mailcow.conf
  498. echo '# Following variables are available: SUBJECT, BODY' >> mailcow.conf
  499. WEBHOOK_BODY='{"username": "mailcow Watchdog", "content": "**${SUBJECT}**\n${BODY}"}'
  500. echo "#WATCHDOG_NOTIFY_WEBHOOK_BODY='${WEBHOOK_BODY}'" >> mailcow.conf
  501. fi
  502. elif [[ ${option} == "WATCHDOG_NOTIFY_BAN" ]]; then
  503. if ! grep -q ${option} mailcow.conf; then
  504. echo "Adding new option \"${option}\" to mailcow.conf"
  505. echo '# Notify about banned IP. Includes whois lookup.' >> mailcow.conf
  506. echo "WATCHDOG_NOTIFY_BAN=y" >> mailcow.conf
  507. fi
  508. elif [[ ${option} == "WATCHDOG_NOTIFY_START" ]]; then
  509. if ! grep -q ${option} mailcow.conf; then
  510. echo "Adding new option \"${option}\" to mailcow.conf"
  511. echo '# Send a notification when the watchdog is started.' >> mailcow.conf
  512. echo "WATCHDOG_NOTIFY_START=y" >> mailcow.conf
  513. fi
  514. elif [[ ${option} == "WATCHDOG_SUBJECT" ]]; then
  515. if ! grep -q ${option} mailcow.conf; then
  516. echo "Adding new option \"${option}\" to mailcow.conf"
  517. echo '# Subject for watchdog mails. Defaults to "Watchdog ALERT" followed by the error message.' >> mailcow.conf
  518. echo "#WATCHDOG_SUBJECT=" >> mailcow.conf
  519. fi
  520. elif [[ ${option} == "WATCHDOG_EXTERNAL_CHECKS" ]]; then
  521. if ! grep -q ${option} mailcow.conf; then
  522. echo "Adding new option \"${option}\" to mailcow.conf"
  523. echo '# Checks if mailcow is an open relay. Requires a SAL. More checks will follow.' >> mailcow.conf
  524. echo '# No data is collected. Opt-in and anonymous.' >> mailcow.conf
  525. echo '# Will only work with unmodified mailcow setups.' >> mailcow.conf
  526. echo "WATCHDOG_EXTERNAL_CHECKS=n" >> mailcow.conf
  527. fi
  528. elif [[ ${option} == "SOGO_EXPIRE_SESSION" ]]; then
  529. if ! grep -q ${option} mailcow.conf; then
  530. echo "Adding new option \"${option}\" to mailcow.conf"
  531. echo '# SOGo session timeout in minutes' >> mailcow.conf
  532. echo "SOGO_EXPIRE_SESSION=480" >> mailcow.conf
  533. fi
  534. elif [[ ${option} == "REDIS_PORT" ]]; then
  535. if ! grep -q ${option} mailcow.conf; then
  536. echo "Adding new option \"${option}\" to mailcow.conf"
  537. echo "REDIS_PORT=127.0.0.1:7654" >> mailcow.conf
  538. fi
  539. elif [[ ${option} == "DOVECOT_MASTER_USER" ]]; then
  540. if ! grep -q ${option} mailcow.conf; then
  541. echo "Adding new option \"${option}\" to mailcow.conf"
  542. echo '# DOVECOT_MASTER_USER and _PASS must _both_ be provided. No special chars.' >> mailcow.conf
  543. echo '# Empty by default to auto-generate master user and password on start.' >> mailcow.conf
  544. echo '# User expands to DOVECOT_MASTER_USER@mailcow.local' >> mailcow.conf
  545. echo '# LEAVE EMPTY IF UNSURE' >> mailcow.conf
  546. echo "DOVECOT_MASTER_USER=" >> mailcow.conf
  547. fi
  548. elif [[ ${option} == "DOVECOT_MASTER_PASS" ]]; then
  549. if ! grep -q ${option} mailcow.conf; then
  550. echo "Adding new option \"${option}\" to mailcow.conf"
  551. echo '# LEAVE EMPTY IF UNSURE' >> mailcow.conf
  552. echo "DOVECOT_MASTER_PASS=" >> mailcow.conf
  553. fi
  554. elif [[ ${option} == "MAILCOW_PASS_SCHEME" ]]; then
  555. if ! grep -q ${option} mailcow.conf; then
  556. echo "Adding new option \"${option}\" to mailcow.conf"
  557. echo '# Password hash algorithm' >> mailcow.conf
  558. echo '# Only certain password hash algorithm are supported. For a fully list of supported schemes,' >> mailcow.conf
  559. echo '# see https://docs.mailcow.email/models/model-passwd/' >> mailcow.conf
  560. echo "MAILCOW_PASS_SCHEME=BLF-CRYPT" >> mailcow.conf
  561. fi
  562. elif [[ ${option} == "ADDITIONAL_SERVER_NAMES" ]]; then
  563. if ! grep -q ${option} mailcow.conf; then
  564. echo "Adding new option \"${option}\" to mailcow.conf"
  565. echo '# Additional server names for mailcow UI' >> mailcow.conf
  566. echo '#' >> mailcow.conf
  567. echo '# Specify alternative addresses for the mailcow UI to respond to' >> mailcow.conf
  568. 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
  569. 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
  570. echo '# You can understand this as server_name directive in Nginx.' >> mailcow.conf
  571. echo '# Comma separated list without spaces! Example: ADDITIONAL_SERVER_NAMES=a.b.c,d.e.f' >> mailcow.conf
  572. echo 'ADDITIONAL_SERVER_NAMES=' >> mailcow.conf
  573. fi
  574. elif [[ ${option} == "ACME_CONTACT" ]]; then
  575. if ! grep -q ${option} mailcow.conf; then
  576. echo "Adding new option \"${option}\" to mailcow.conf"
  577. echo '# Lets Encrypt registration contact information' >> mailcow.conf
  578. echo '# Optional: Leave empty for none' >> mailcow.conf
  579. echo '# This value is only used on first order!' >> mailcow.conf
  580. echo '# Setting it at a later point will require the following steps:' >> mailcow.conf
  581. echo '# https://docs.mailcow.email/troubleshooting/debug-reset_tls/' >> mailcow.conf
  582. echo 'ACME_CONTACT=' >> mailcow.conf
  583. fi
  584. elif [[ ${option} == "WEBAUTHN_ONLY_TRUSTED_VENDORS" ]]; then
  585. if ! grep -q ${option} mailcow.conf; then
  586. echo "Adding new option \"${option}\" to mailcow.conf"
  587. echo "# WebAuthn device manufacturer verification" >> mailcow.conf
  588. echo '# After setting WEBAUTHN_ONLY_TRUSTED_VENDORS=y only devices from trusted manufacturers are allowed' >> mailcow.conf
  589. echo '# root certificates can be placed for validation under mailcow-dockerized/data/web/inc/lib/WebAuthn/rootCertificates' >> mailcow.conf
  590. echo 'WEBAUTHN_ONLY_TRUSTED_VENDORS=n' >> mailcow.conf
  591. fi
  592. elif [[ ${option} == "SPAMHAUS_DQS_KEY" ]]; then
  593. if ! grep -q ${option} mailcow.conf; then
  594. echo "Adding new option \"${option}\" to mailcow.conf"
  595. echo "# Spamhaus Data Query Service Key" >> mailcow.conf
  596. echo '# Optional: Leave empty for none' >> mailcow.conf
  597. echo '# Enter your key here if you are using a blocked ASN (OVH, AWS, Cloudflare e.g) for the unregistered Spamhaus Blocklist.' >> mailcow.conf
  598. 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
  599. echo '# Otherwise it will work as usual.' >> mailcow.conf
  600. echo 'SPAMHAUS_DQS_KEY=' >> mailcow.conf
  601. fi
  602. elif [[ ${option} == "WATCHDOG_VERBOSE" ]]; then
  603. if ! grep -q ${option} mailcow.conf; then
  604. echo "Adding new option \"${option}\" to mailcow.conf"
  605. echo '# Enable watchdog verbose logging' >> mailcow.conf
  606. echo 'WATCHDOG_VERBOSE=n' >> mailcow.conf
  607. fi
  608. elif [[ ${option} == "SKIP_UNBOUND_HEALTHCHECK" ]]; then
  609. if ! grep -q ${option} mailcow.conf; then
  610. echo "Adding new option \"${option}\" to mailcow.conf"
  611. echo '# Skip Unbound (DNS Resolver) Healthchecks (NOT Recommended!) - y/n' >> mailcow.conf
  612. echo 'SKIP_UNBOUND_HEALTHCHECK=n' >> mailcow.conf
  613. fi
  614. elif [[ ${option} == "DISABLE_NETFILTER_ISOLATION_RULE" ]]; then
  615. if ! grep -q ${option} mailcow.conf; then
  616. echo "Adding new option \"${option}\" to mailcow.conf"
  617. echo '# Prevent netfilter from setting an iptables/nftables rule to isolate the mailcow docker network - y/n' >> mailcow.conf
  618. echo '# CAUTION: Disabling this may expose container ports to other neighbors on the same subnet, even if the ports are bound to localhost' >> mailcow.conf
  619. echo 'DISABLE_NETFILTER_ISOLATION_RULE=n' >> mailcow.conf
  620. fi
  621. elif [[ ${option} == "HTTP_REDIRECT" ]]; then
  622. if ! grep -q ${option} mailcow.conf; then
  623. echo "Adding new option \"${option}\" to mailcow.conf"
  624. echo '# Redirect HTTP connections to HTTPS - y/n' >> mailcow.conf
  625. echo 'HTTP_REDIRECT=n' >> mailcow.conf
  626. fi
  627. elif ! grep -q ${option} mailcow.conf; then
  628. echo "Adding new option \"${option}\" to mailcow.conf"
  629. echo "${option}=n" >> mailcow.conf
  630. fi
  631. done
  632. }
  633. migrate_solr_config_options() {
  634. sed -i --follow-symlinks '$a\' mailcow.conf
  635. if grep -q "SOLR_HEAP" mailcow.conf; then
  636. echo "Removing SOLR_HEAP in mailcow.conf"
  637. sed -i '/# Solr heap size in MB\b/d' mailcow.conf
  638. sed -i '/# Solr is a prone to run\b/d' mailcow.conf
  639. sed -i '/SOLR_HEAP\b/d' mailcow.conf
  640. fi
  641. if grep -q "SKIP_SOLR" mailcow.conf; then
  642. echo "Removing SKIP_SOLR in mailcow.conf"
  643. sed -i '/\bSkip Solr on low-memory\b/d' mailcow.conf
  644. sed -i '/\bSolr is disabled by default\b/d' mailcow.conf
  645. sed -i '/\bDisable Solr or\b/d' mailcow.conf
  646. sed -i '/\bSKIP_SOLR\b/d' mailcow.conf
  647. fi
  648. if grep -q "SOLR_PORT" mailcow.conf; then
  649. echo "Removing SOLR_PORT in mailcow.conf"
  650. sed -i '/\bSOLR_PORT\b/d' mailcow.conf
  651. fi
  652. if grep -q "FLATCURVE_EXPERIMENTAL" mailcow.conf; then
  653. echo "Removing FLATCURVE_EXPERIMENTAL in mailcow.conf"
  654. sed -i '/\bFLATCURVE_EXPERIMENTAL\b/d' mailcow.conf
  655. fi
  656. solr_volume=$(docker volume ls -qf name=^${COMPOSE_PROJECT_NAME}_solr-vol-1)
  657. if [[ -n $solr_volume ]]; then
  658. echo -e "\e[34mSolr has been replaced within mailcow since 2025-01.\nThe volume $solr_volume is unused.\e[0m"
  659. sleep 1
  660. if [ ! "$FORCE" ]; then
  661. read -r -p "Remove $solr_volume? [y/N] " response
  662. if [[ "$response" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  663. echo -e "\e[33mRemoving $solr_volume...\e[0m"
  664. docker volume rm $solr_volume || echo -e "\e[31mFailed to remove. Remove it manually!\e[0m"
  665. echo -e "\e[32mSuccessfully removed $solr_volume!\e[0m"
  666. else
  667. echo -e "Not removing $solr_volume. Run \`docker volume rm $solr_volume\` manually if needed."
  668. fi
  669. else
  670. echo -e "\e[33mForce removing $solr_volume...\e[0m"
  671. docker volume rm $solr_volume || echo -e "\e[31mFailed to remove. Remove it manually!\e[0m"
  672. echo -e "\e[32mSuccessfully removed $solr_volume!\e[0m"
  673. fi
  674. fi
  675. # Delete old fts.conf before forced switch to flatcurve to ensure update is working properly
  676. FTS_CONF_PATH="${SCRIPT_DIR}/data/conf/dovecot/conf.d/fts.conf"
  677. if [[ -f "$FTS_CONF_PATH" ]]; then
  678. if grep -q "Autogenerated by mailcow" "$FTS_CONF_PATH"; then
  679. rm -rf $FTS_CONF_PATH
  680. fi
  681. fi
  682. }
  683. detect_major_update() {
  684. if [ ${BRANCH} == "master" ]; then
  685. # Array with major versions
  686. # Add major versions here
  687. MAJOR_VERSIONS=(
  688. "2025-02"
  689. "2025-03"
  690. )
  691. current_version=""
  692. if [[ -f "${SCRIPT_DIR}/data/web/inc/app_info.inc.php" ]]; then
  693. current_version=$(grep 'MAILCOW_GIT_VERSION' ${SCRIPT_DIR}/data/web/inc/app_info.inc.php | sed -E 's/.*MAILCOW_GIT_VERSION="([^"]+)".*/\1/')
  694. fi
  695. if [[ -z "$current_version" ]]; then
  696. return 1
  697. fi
  698. release_url="https://github.com/mailcow/mailcow-dockerized/releases/tag"
  699. updates_to_apply=()
  700. for version in "${MAJOR_VERSIONS[@]}"; do
  701. if [[ "$current_version" < "$version" ]]; then
  702. updates_to_apply+=("$version")
  703. fi
  704. done
  705. if [[ ${#updates_to_apply[@]} -gt 0 ]]; then
  706. echo -e "\e[33m\nMAJOR UPDATES to be applied:\e[0m"
  707. for update in "${updates_to_apply[@]}"; do
  708. echo "$update - $release_url/$update"
  709. done
  710. echo -e "\nPlease read the release notes before proceeding."
  711. read -p "Do you want to proceed with the update? [y/n] " response
  712. if [[ "${response}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  713. echo "Proceeding with the update..."
  714. else
  715. echo "Update canceled. Exiting."
  716. exit 1
  717. fi
  718. fi
  719. fi
  720. }
  721. ############## End Function Section ##############
  722. # Check permissions
  723. if [ "$(id -u)" -ne "0" ]; then
  724. echo "You need to be root"
  725. exit 1
  726. fi
  727. SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
  728. # Run pre-update-hook
  729. if [ -f "${SCRIPT_DIR}/pre_update_hook.sh" ]; then
  730. bash "${SCRIPT_DIR}/pre_update_hook.sh"
  731. fi
  732. if [[ "$(uname -r)" =~ ^4\.15\.0-60 ]]; then
  733. echo "DO NOT RUN mailcow ON THIS UBUNTU KERNEL!";
  734. echo "Please update to 5.x or use another distribution."
  735. exit 1
  736. fi
  737. if [[ "$(uname -r)" =~ ^4\.4\. ]]; then
  738. if grep -q Ubuntu <<< "$(uname -a)"; then
  739. echo "DO NOT RUN mailcow ON THIS UBUNTU KERNEL!"
  740. echo "Please update to linux-generic-hwe-16.04 by running \"apt-get install --install-recommends linux-generic-hwe-16.04\""
  741. exit 1
  742. fi
  743. 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."
  744. read -p "Press any key to continue..." < /dev/tty
  745. fi
  746. # Exit on error and pipefail
  747. set -o pipefail
  748. # Setting high dc timeout
  749. export COMPOSE_HTTP_TIMEOUT=600
  750. # Add /opt/bin to PATH
  751. PATH=$PATH:/opt/bin
  752. umask 0022
  753. # Unset COMPOSE_COMMAND and DOCKER_COMPOSE_VERSION Variable to be on the newest state.
  754. unset COMPOSE_COMMAND
  755. unset DOCKER_COMPOSE_VERSION
  756. for bin in curl docker git awk sha1sum grep cut; do
  757. if [[ -z $(command -v ${bin}) ]]; then
  758. echo "Cannot find ${bin}, exiting..."
  759. exit 1;
  760. fi
  761. done
  762. # Check Docker Version (need at least 24.X)
  763. docker_version=$(docker -v | grep -oP '\d+\.\d+\.\d+' | cut -d '.' -f 1 | head -1)
  764. if [[ $docker_version -lt 24 ]]; then
  765. echo -e "\e[31mCannot find Docker with a Version higher or equals 24.0.0\e[0m"
  766. echo -e "\e[33mmailcow needs a newer Docker version to work properly... continuing on your own risk!\e[0m"
  767. echo -e "\e[31mPlease update your Docker installation... sleeping 10s\e[0m"
  768. sleep 10
  769. fi
  770. export LC_ALL=C
  771. DATE=$(date +%Y-%m-%d_%H_%M_%S)
  772. BRANCH="$(cd "${SCRIPT_DIR}"; git rev-parse --abbrev-ref HEAD)"
  773. while (($#)); do
  774. case "${1}" in
  775. --check|-c)
  776. echo "Checking remote code for updates..."
  777. LATEST_REV=$(git ls-remote --exit-code --refs --quiet https://github.com/mailcow/mailcow-dockerized "${BRANCH}" | cut -f1)
  778. if [ "$?" -ne 0 ]; then
  779. echo "A problem occurred while trying to fetch the latest revision from github."
  780. exit 99
  781. fi
  782. if [[ -z $(git log HEAD --pretty=format:"%H" | grep "${LATEST_REV}") ]]; then
  783. echo -e "Updated code is available.\nThe changes can be found here: https://github.com/mailcow/mailcow-dockerized/commits/master"
  784. git log --date=short --pretty=format:"%ad - %s" "$(git rev-parse --short HEAD)"..origin/master
  785. exit 0
  786. else
  787. echo "No updates available."
  788. exit 3
  789. fi
  790. ;;
  791. --check-tags)
  792. echo "Checking remote tags for updates..."
  793. LATEST_TAG_REV=$(git ls-remote --exit-code --quiet --tags origin | tail -1 | cut -f1)
  794. if [ "$?" -ne 0 ]; then
  795. echo "A problem occurred while trying to fetch the latest tag from github."
  796. exit 99
  797. fi
  798. if [[ -z $(git log HEAD --pretty=format:"%H" | grep "${LATEST_TAG_REV}") ]]; then
  799. echo -e "New tag is available.\nThe changes can be found here: https://github.com/mailcow/mailcow-dockerized/releases/latest"
  800. exit 0
  801. else
  802. echo "No updates available."
  803. exit 3
  804. fi
  805. ;;
  806. --ours)
  807. MERGE_STRATEGY=ours
  808. ;;
  809. --skip-start)
  810. SKIP_START=y
  811. ;;
  812. --skip-ping-check)
  813. SKIP_PING_CHECK=y
  814. ;;
  815. --stable)
  816. CURRENT_BRANCH="$(cd "${SCRIPT_DIR}"; git rev-parse --abbrev-ref HEAD)"
  817. NEW_BRANCH="master"
  818. ;;
  819. --gc)
  820. echo -e "\e[32mCollecting garbage...\e[0m"
  821. docker_garbage
  822. exit 0
  823. ;;
  824. --nightly)
  825. CURRENT_BRANCH="$(cd "${SCRIPT_DIR}"; git rev-parse --abbrev-ref HEAD)"
  826. NEW_BRANCH="nightly"
  827. ;;
  828. --prefetch)
  829. echo -e "\e[32mPrefetching images...\e[0m"
  830. prefetch_images
  831. exit 0
  832. ;;
  833. -f|--force)
  834. echo -e "\e[32mRunning in forced mode...\e[0m"
  835. FORCE=y
  836. ;;
  837. -d|--dev)
  838. echo -e "\e[32mRunning in Developer mode...\e[0m"
  839. DEV=y
  840. ;;
  841. --legacy)
  842. CURRENT_BRANCH="$(cd "${SCRIPT_DIR}"; git rev-parse --abbrev-ref HEAD)"
  843. NEW_BRANCH="legacy"
  844. ;;
  845. --help|-h)
  846. echo './update.sh [-c|--check, --check-tags, --ours, --gc, --nightly, --prefetch, --skip-start, --skip-ping-check, --stable, --legacy, -f|--force, -d|--dev, -h|--help]
  847. -c|--check - Check for updates and exit (exit codes => 0: update available, 3: no updates)
  848. --check-tags - Check for newer tags and exit (exit codes => 0: newer tag available, 3: no newer tag)
  849. --ours - Use merge strategy option "ours" to solve conflicts in favor of non-mailcow code (local changes over remote changes), not recommended!
  850. --gc - Run garbage collector to delete old image tags
  851. --nightly - Switch your mailcow updates to the unstable (nightly) branch. FOR TESTING PURPOSES ONLY!!!!
  852. --prefetch - Only prefetch new images and exit (useful to prepare updates)
  853. --skip-start - Do not start mailcow after update
  854. --skip-ping-check - Skip ICMP Check to public DNS resolvers (Use it only if you'\''ve blocked any ICMP Connections to your mailcow machine)
  855. --stable - Switch your mailcow updates to the stable (master) branch. Default unless you changed it with --nightly or --legacy.
  856. --legacy - Switch your mailcow updates to the legacy branch. The legacy branch will only receive security updates until February 2026.
  857. -f|--force - Force update, do not ask questions
  858. -d|--dev - Enables Developer Mode (No Checkout of update.sh for tests)
  859. '
  860. exit 0
  861. esac
  862. shift
  863. done
  864. [[ ! -f mailcow.conf ]] && { echo -e "\e[31mmailcow.conf is missing! Is mailcow installed?\e[0m"; exit 1;}
  865. chmod 600 mailcow.conf
  866. source mailcow.conf
  867. detect_docker_compose_command
  868. fix_broken_dnslist_conf
  869. DOTS=${MAILCOW_HOSTNAME//[^.]};
  870. if [ ${#DOTS} -lt 1 ]; then
  871. echo -e "\e[31mMAILCOW_HOSTNAME (${MAILCOW_HOSTNAME}) is not a FQDN!\e[0m"
  872. sleep 1
  873. echo "Please change it to a FQDN and redeploy the stack with $COMPOSE_COMMAND up -d"
  874. exit 1
  875. elif [[ "${MAILCOW_HOSTNAME: -1}" == "." ]]; then
  876. echo "MAILCOW_HOSTNAME (${MAILCOW_HOSTNAME}) is ending with a dot. This is not a valid FQDN!"
  877. exit 1
  878. elif [ ${#DOTS} -eq 1 ]; then
  879. echo -e "\e[33mMAILCOW_HOSTNAME (${MAILCOW_HOSTNAME}) does not contain a Subdomain. This is not fully tested and may cause issues.\e[0m"
  880. echo "Find more information about why this message exists here: https://github.com/mailcow/mailcow-dockerized/issues/1572"
  881. read -r -p "Do you want to proceed anyway? [y/N] " response
  882. if [[ "$response" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  883. echo "OK. Proceeding."
  884. else
  885. echo "OK. Exiting."
  886. exit 1
  887. fi
  888. fi
  889. 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
  890. # This will also cover sort
  891. 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
  892. 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
  893. CONFIG_ARRAY=(
  894. "SKIP_LETS_ENCRYPT"
  895. "SKIP_SOGO"
  896. "USE_WATCHDOG"
  897. "WATCHDOG_NOTIFY_EMAIL"
  898. "WATCHDOG_NOTIFY_WEBHOOK"
  899. "WATCHDOG_NOTIFY_WEBHOOK_BODY"
  900. "WATCHDOG_NOTIFY_BAN"
  901. "WATCHDOG_NOTIFY_START"
  902. "WATCHDOG_EXTERNAL_CHECKS"
  903. "WATCHDOG_SUBJECT"
  904. "SKIP_CLAMD"
  905. "SKIP_OLEFY"
  906. "SKIP_IP_CHECK"
  907. "ADDITIONAL_SAN"
  908. "AUTODISCOVER_SAN"
  909. "DOVEADM_PORT"
  910. "IPV4_NETWORK"
  911. "IPV6_NETWORK"
  912. "LOG_LINES"
  913. "SNAT_TO_SOURCE"
  914. "SNAT6_TO_SOURCE"
  915. "COMPOSE_PROJECT_NAME"
  916. "DOCKER_COMPOSE_VERSION"
  917. "SQL_PORT"
  918. "API_KEY"
  919. "API_KEY_READ_ONLY"
  920. "API_ALLOW_FROM"
  921. "MAILDIR_GC_TIME"
  922. "MAILDIR_SUB"
  923. "ACL_ANYONE"
  924. "ENABLE_SSL_SNI"
  925. "ALLOW_ADMIN_EMAIL_LOGIN"
  926. "SKIP_HTTP_VERIFICATION"
  927. "SOGO_EXPIRE_SESSION"
  928. "REDIS_PORT"
  929. "DOVECOT_MASTER_USER"
  930. "DOVECOT_MASTER_PASS"
  931. "MAILCOW_PASS_SCHEME"
  932. "ADDITIONAL_SERVER_NAMES"
  933. "ACME_CONTACT"
  934. "WATCHDOG_VERBOSE"
  935. "WEBAUTHN_ONLY_TRUSTED_VENDORS"
  936. "SPAMHAUS_DQS_KEY"
  937. "SKIP_UNBOUND_HEALTHCHECK"
  938. "DISABLE_NETFILTER_ISOLATION_RULE"
  939. "REDISPASS"
  940. )
  941. detect_bad_asn
  942. sed -i --follow-symlinks '$a\' mailcow.conf
  943. for option in "${CONFIG_ARRAY[@]}"; do
  944. if [[ ${option} == "ADDITIONAL_SAN" ]]; then
  945. if ! grep -q "${option}" mailcow.conf; then
  946. echo "Adding new option \"${option}\" to mailcow.conf"
  947. echo "${option}=" >> mailcow.conf
  948. fi
  949. elif [[ "${option}" == "COMPOSE_PROJECT_NAME" ]]; then
  950. if ! grep -q "${option}" mailcow.conf; then
  951. echo "Adding new option \"${option}\" to mailcow.conf"
  952. echo "COMPOSE_PROJECT_NAME=mailcowdockerized" >> mailcow.conf
  953. fi
  954. elif [[ "${option}" == "DOCKER_COMPOSE_VERSION" ]]; then
  955. if ! grep -q "${option}" mailcow.conf; then
  956. echo "Adding new option \"${option}\" to mailcow.conf"
  957. echo "# Used Docker Compose version" >> mailcow.conf
  958. echo "# Switch here between native (compose plugin) and standalone" >> mailcow.conf
  959. echo "# For more informations take a look at the mailcow docs regarding the configuration options." >> mailcow.conf
  960. echo "# Normally this should be untouched but if you decided to use either of those you can switch it manually here." >> mailcow.conf
  961. echo "# Please be aware that at least one of those variants should be installed on your maschine or mailcow will fail." >> mailcow.conf
  962. echo "" >> mailcow.conf
  963. echo "DOCKER_COMPOSE_VERSION=${DOCKER_COMPOSE_VERSION}" >> mailcow.conf
  964. fi
  965. elif [[ "${option}" == "DOVEADM_PORT" ]]; then
  966. if ! grep -q "${option}" mailcow.conf; then
  967. echo "Adding new option \"${option}\" to mailcow.conf"
  968. echo "DOVEADM_PORT=127.0.0.1:19991" >> mailcow.conf
  969. fi
  970. elif [[ "${option}" == "WATCHDOG_NOTIFY_EMAIL" ]]; then
  971. if ! grep -q "${option}" mailcow.conf; then
  972. echo "Adding new option \"${option}\" to mailcow.conf"
  973. echo "WATCHDOG_NOTIFY_EMAIL=" >> mailcow.conf
  974. fi
  975. elif [[ "${option}" == "LOG_LINES" ]]; then
  976. if ! grep -q "${option}" mailcow.conf; then
  977. echo "Adding new option \"${option}\" to mailcow.conf"
  978. echo '# Max log lines per service to keep in Redis logs' >> mailcow.conf
  979. echo "LOG_LINES=9999" >> mailcow.conf
  980. fi
  981. elif [[ "${option}" == "IPV4_NETWORK" ]]; then
  982. if ! grep -q "${option}" mailcow.conf; then
  983. echo "Adding new option \"${option}\" to mailcow.conf"
  984. echo '# Internal IPv4 /24 subnet, format n.n.n. (expands to n.n.n.0/24)' >> mailcow.conf
  985. echo "IPV4_NETWORK=172.22.1" >> mailcow.conf
  986. fi
  987. elif [[ "${option}" == "IPV6_NETWORK" ]]; then
  988. if ! grep -q "${option}" mailcow.conf; then
  989. echo "Adding new option \"${option}\" to mailcow.conf"
  990. echo '# Internal IPv6 subnet in fc00::/7' >> mailcow.conf
  991. echo "IPV6_NETWORK=fd4d:6169:6c63:6f77::/64" >> mailcow.conf
  992. fi
  993. elif [[ "${option}" == "SQL_PORT" ]]; then
  994. if ! grep -q "${option}" mailcow.conf; then
  995. echo "Adding new option \"${option}\" to mailcow.conf"
  996. echo '# Bind SQL to 127.0.0.1 on port 13306' >> mailcow.conf
  997. echo "SQL_PORT=127.0.0.1:13306" >> mailcow.conf
  998. fi
  999. elif [[ "${option}" == "API_KEY" ]]; then
  1000. if ! grep -q "${option}" mailcow.conf; then
  1001. echo "Adding new option \"${option}\" to mailcow.conf"
  1002. echo '# Create or override API key for web UI' >> mailcow.conf
  1003. echo "#API_KEY=" >> mailcow.conf
  1004. fi
  1005. elif [[ "${option}" == "API_KEY_READ_ONLY" ]]; then
  1006. if ! grep -q "${option}" mailcow.conf; then
  1007. echo "Adding new option \"${option}\" to mailcow.conf"
  1008. echo '# Create or override read-only API key for web UI' >> mailcow.conf
  1009. echo "#API_KEY_READ_ONLY=" >> mailcow.conf
  1010. fi
  1011. elif [[ "${option}" == "API_ALLOW_FROM" ]]; then
  1012. if ! grep -q "${option}" mailcow.conf; then
  1013. echo "Adding new option \"${option}\" to mailcow.conf"
  1014. echo '# Must be set for API_KEY to be active' >> mailcow.conf
  1015. echo '# IPs only, no networks (networks can be set via UI)' >> mailcow.conf
  1016. echo "#API_ALLOW_FROM=" >> mailcow.conf
  1017. fi
  1018. elif [[ "${option}" == "SNAT_TO_SOURCE" ]]; then
  1019. if ! grep -q "${option}" mailcow.conf; then
  1020. echo "Adding new option \"${option}\" to mailcow.conf"
  1021. echo '# Use this IPv4 for outgoing connections (SNAT)' >> mailcow.conf
  1022. echo "#SNAT_TO_SOURCE=" >> mailcow.conf
  1023. fi
  1024. elif [[ "${option}" == "SNAT6_TO_SOURCE" ]]; then
  1025. if ! grep -q "${option}" mailcow.conf; then
  1026. echo "Adding new option \"${option}\" to mailcow.conf"
  1027. echo '# Use this IPv6 for outgoing connections (SNAT)' >> mailcow.conf
  1028. echo "#SNAT6_TO_SOURCE=" >> mailcow.conf
  1029. fi
  1030. elif [[ "${option}" == "MAILDIR_GC_TIME" ]]; then
  1031. if ! grep -q "${option}" mailcow.conf; then
  1032. echo "Adding new option \"${option}\" to mailcow.conf"
  1033. echo '# Garbage collector cleanup' >> mailcow.conf
  1034. echo '# Deleted domains and mailboxes are moved to /var/vmail/_garbage/timestamp_sanitizedstring' >> mailcow.conf
  1035. echo '# How long should objects remain in the garbage until they are being deleted? (value in minutes)' >> mailcow.conf
  1036. echo '# Check interval is hourly' >> mailcow.conf
  1037. echo 'MAILDIR_GC_TIME=1440' >> mailcow.conf
  1038. fi
  1039. elif [[ "${option}" == "ACL_ANYONE" ]]; then
  1040. if ! grep -q "${option}" mailcow.conf; then
  1041. echo "Adding new option \"${option}\" to mailcow.conf"
  1042. echo '# Set this to "allow" to enable the anyone pseudo user. Disabled by default.' >> mailcow.conf
  1043. echo '# When enabled, ACL can be created, that apply to "All authenticated users"' >> mailcow.conf
  1044. echo '# This should probably only be activated on mail hosts, that are used exclusivly by one organisation.' >> mailcow.conf
  1045. echo '# Otherwise a user might share data with too many other users.' >> mailcow.conf
  1046. echo 'ACL_ANYONE=disallow' >> mailcow.conf
  1047. fi
  1048. elif [[ "${option}" == "ENABLE_SSL_SNI" ]]; then
  1049. if ! grep -q "${option}" mailcow.conf; then
  1050. echo "Adding new option \"${option}\" to mailcow.conf"
  1051. echo '# Create seperate certificates for all domains - y/n' >> mailcow.conf
  1052. echo '# this will allow adding more than 100 domains, but some email clients will not be able to connect with alternative hostnames' >> mailcow.conf
  1053. echo '# see https://wiki.dovecot.org/SSL/SNIClientSupport' >> mailcow.conf
  1054. echo "ENABLE_SSL_SNI=n" >> mailcow.conf
  1055. fi
  1056. elif [[ "${option}" == "SKIP_SOGO" ]]; then
  1057. if ! grep -q "${option}" mailcow.conf; then
  1058. echo "Adding new option \"${option}\" to mailcow.conf"
  1059. echo '# Skip SOGo: Will disable SOGo integration and therefore webmail, DAV protocols and ActiveSync support (experimental, unsupported, not fully implemented) - y/n' >> mailcow.conf
  1060. echo "SKIP_SOGO=n" >> mailcow.conf
  1061. fi
  1062. elif [[ "${option}" == "MAILDIR_SUB" ]]; then
  1063. if ! grep -q "${option}" mailcow.conf; then
  1064. echo "Adding new option \"${option}\" to mailcow.conf"
  1065. echo '# MAILDIR_SUB defines a path in a users virtual home to keep the maildir in. Leave empty for updated setups.' >> mailcow.conf
  1066. echo "#MAILDIR_SUB=Maildir" >> mailcow.conf
  1067. echo "MAILDIR_SUB=" >> mailcow.conf
  1068. fi
  1069. elif [[ "${option}" == "WATCHDOG_NOTIFY_WEBHOOK" ]]; then
  1070. if ! grep -q "${option}" mailcow.conf; then
  1071. echo "Adding new option \"${option}\" to mailcow.conf"
  1072. echo '# Send notifications to a webhook URL that receives a POST request with the content type "application/json".' >> mailcow.conf
  1073. echo '# You can use this to send notifications to services like Discord, Slack and others.' >> mailcow.conf
  1074. echo '#WATCHDOG_NOTIFY_WEBHOOK=https://discord.com/api/webhooks/XXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' >> mailcow.conf
  1075. fi
  1076. elif [[ "${option}" == "WATCHDOG_NOTIFY_WEBHOOK_BODY" ]]; then
  1077. if ! grep -q "${option}" mailcow.conf; then
  1078. echo "Adding new option \"${option}\" to mailcow.conf"
  1079. echo '# JSON body included in the webhook POST request. Needs to be in single quotes.' >> mailcow.conf
  1080. echo '# Following variables are available: SUBJECT, BODY' >> mailcow.conf
  1081. WEBHOOK_BODY='{"username": "mailcow Watchdog", "content": "**${SUBJECT}**\n${BODY}"}'
  1082. echo "#WATCHDOG_NOTIFY_WEBHOOK_BODY='${WEBHOOK_BODY}'" >> mailcow.conf
  1083. fi
  1084. elif [[ "${option}" == "WATCHDOG_NOTIFY_BAN" ]]; then
  1085. if ! grep -q "${option}" mailcow.conf; then
  1086. echo "Adding new option \"${option}\" to mailcow.conf"
  1087. echo '# Notify about banned IP. Includes whois lookup.' >> mailcow.conf
  1088. echo "WATCHDOG_NOTIFY_BAN=y" >> mailcow.conf
  1089. fi
  1090. elif [[ "${option}" == "WATCHDOG_NOTIFY_START" ]]; then
  1091. if ! grep -q "${option}" mailcow.conf; then
  1092. echo "Adding new option \"${option}\" to mailcow.conf"
  1093. echo '# Send a notification when the watchdog is started.' >> mailcow.conf
  1094. echo "WATCHDOG_NOTIFY_START=y" >> mailcow.conf
  1095. fi
  1096. elif [[ "${option}" == "WATCHDOG_SUBJECT" ]]; then
  1097. if ! grep -q "${option}" mailcow.conf; then
  1098. echo "Adding new option \"${option}\" to mailcow.conf"
  1099. echo '# Subject for watchdog mails. Defaults to "Watchdog ALERT" followed by the error message.' >> mailcow.conf
  1100. echo "#WATCHDOG_SUBJECT=" >> mailcow.conf
  1101. fi
  1102. elif [[ "${option}" == "WATCHDOG_EXTERNAL_CHECKS" ]]; then
  1103. if ! grep -q "${option}" mailcow.conf; then
  1104. echo "Adding new option \"${option}\" to mailcow.conf"
  1105. echo '# Checks if mailcow is an open relay. Requires a SAL. More checks will follow.' >> mailcow.conf
  1106. echo '# No data is collected. Opt-in and anonymous.' >> mailcow.conf
  1107. echo '# Will only work with unmodified mailcow setups.' >> mailcow.conf
  1108. echo "WATCHDOG_EXTERNAL_CHECKS=n" >> mailcow.conf
  1109. fi
  1110. elif [[ "${option}" == "SOGO_EXPIRE_SESSION" ]]; then
  1111. if ! grep -q "${option}" mailcow.conf; then
  1112. echo "Adding new option \"${option}\" to mailcow.conf"
  1113. echo '# SOGo session timeout in minutes' >> mailcow.conf
  1114. echo "SOGO_EXPIRE_SESSION=480" >> mailcow.conf
  1115. fi
  1116. elif [[ "${option}" == "REDIS_PORT" ]]; then
  1117. if ! grep -q "${option}" mailcow.conf; then
  1118. echo "Adding new option \"${option}\" to mailcow.conf"
  1119. echo "REDIS_PORT=127.0.0.1:7654" >> mailcow.conf
  1120. fi
  1121. elif [[ "${option}" == "DOVECOT_MASTER_USER" ]]; then
  1122. if ! grep -q "${option}" mailcow.conf; then
  1123. echo "Adding new option \"${option}\" to mailcow.conf"
  1124. echo '# DOVECOT_MASTER_USER and _PASS must _both_ be provided. No special chars.' >> mailcow.conf
  1125. echo '# Empty by default to auto-generate master user and password on start.' >> mailcow.conf
  1126. echo '# User expands to DOVECOT_MASTER_USER@mailcow.local' >> mailcow.conf
  1127. echo '# LEAVE EMPTY IF UNSURE' >> mailcow.conf
  1128. echo "DOVECOT_MASTER_USER=" >> mailcow.conf
  1129. fi
  1130. elif [[ "${option}" == "DOVECOT_MASTER_PASS" ]]; then
  1131. if ! grep -q "${option}" mailcow.conf; then
  1132. echo "Adding new option \"${option}\" to mailcow.conf"
  1133. echo '# LEAVE EMPTY IF UNSURE' >> mailcow.conf
  1134. echo "DOVECOT_MASTER_PASS=" >> mailcow.conf
  1135. fi
  1136. elif [[ "${option}" == "MAILCOW_PASS_SCHEME" ]]; then
  1137. if ! grep -q "${option}" mailcow.conf; then
  1138. echo "Adding new option \"${option}\" to mailcow.conf"
  1139. echo '# Password hash algorithm' >> mailcow.conf
  1140. echo '# Only certain password hash algorithm are supported. For a fully list of supported schemes,' >> mailcow.conf
  1141. echo '# see https://docs.mailcow.email/models/model-passwd/' >> mailcow.conf
  1142. echo "MAILCOW_PASS_SCHEME=BLF-CRYPT" >> mailcow.conf
  1143. fi
  1144. elif [[ "${option}" == "ADDITIONAL_SERVER_NAMES" ]]; then
  1145. if ! grep -q "${option}" mailcow.conf; then
  1146. echo "Adding new option \"${option}\" to mailcow.conf"
  1147. echo '# Additional server names for mailcow UI' >> mailcow.conf
  1148. echo '#' >> mailcow.conf
  1149. echo '# Specify alternative addresses for the mailcow UI to respond to' >> mailcow.conf
  1150. 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
  1151. 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
  1152. echo '# You can understand this as server_name directive in Nginx.' >> mailcow.conf
  1153. echo '# Comma separated list without spaces! Example: ADDITIONAL_SERVER_NAMES=a.b.c,d.e.f' >> mailcow.conf
  1154. echo 'ADDITIONAL_SERVER_NAMES=' >> mailcow.conf
  1155. fi
  1156. elif [[ "${option}" == "AUTODISCOVER_SAN" ]]; then
  1157. if ! grep -q "${option}" mailcow.conf; then
  1158. echo "Adding new option \"${option}\" to mailcow.conf"
  1159. echo '# Obtain certificates for autodiscover.* and autoconfig.* domains.' >> mailcow.conf
  1160. echo '# This can be useful to switch off in case you are in a scenario where a reverse proxy already handles those.' >> mailcow.conf
  1161. echo '# There are mixed scenarios where ports 80,443 are occupied and you do not want to share certs' >> mailcow.conf
  1162. echo '# between services. So acme-mailcow obtains for maildomains and all web-things get handled' >> mailcow.conf
  1163. echo '# in the reverse proxy.' >> mailcow.conf
  1164. echo 'AUTODISCOVER_SAN=y' >> mailcow.conf
  1165. fi
  1166. elif [[ "${option}" == "ACME_CONTACT" ]]; then
  1167. if ! grep -q "${option}" mailcow.conf; then
  1168. echo "Adding new option \"${option}\" to mailcow.conf"
  1169. echo '# Lets Encrypt registration contact information' >> mailcow.conf
  1170. echo '# Optional: Leave empty for none' >> mailcow.conf
  1171. echo '# This value is only used on first order!' >> mailcow.conf
  1172. echo '# Setting it at a later point will require the following steps:' >> mailcow.conf
  1173. echo '# https://docs.mailcow.email/troubleshooting/debug-reset_tls/' >> mailcow.conf
  1174. echo 'ACME_CONTACT=' >> mailcow.conf
  1175. fi
  1176. elif [[ "${option}" == "WEBAUTHN_ONLY_TRUSTED_VENDORS" ]]; then
  1177. if ! grep -q "${option}" mailcow.conf; then
  1178. echo "Adding new option \"${option}\" to mailcow.conf"
  1179. echo "# WebAuthn device manufacturer verification" >> mailcow.conf
  1180. echo '# After setting WEBAUTHN_ONLY_TRUSTED_VENDORS=y only devices from trusted manufacturers are allowed' >> mailcow.conf
  1181. echo '# root certificates can be placed for validation under mailcow-dockerized/data/web/inc/lib/WebAuthn/rootCertificates' >> mailcow.conf
  1182. echo 'WEBAUTHN_ONLY_TRUSTED_VENDORS=n' >> mailcow.conf
  1183. fi
  1184. elif [[ "${option}" == "SPAMHAUS_DQS_KEY" ]]; then
  1185. if ! grep -q "${option}" mailcow.conf; then
  1186. echo "Adding new option \"${option}\" to mailcow.conf"
  1187. echo "# Spamhaus Data Query Service Key" >> mailcow.conf
  1188. echo '# Optional: Leave empty for none' >> mailcow.conf
  1189. echo '# Enter your key here if you are using a blocked ASN (OVH, AWS, Cloudflare e.g) for the unregistered Spamhaus Blocklist.' >> mailcow.conf
  1190. 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
  1191. echo '# Otherwise it will work as usual.' >> mailcow.conf
  1192. echo 'SPAMHAUS_DQS_KEY=' >> mailcow.conf
  1193. fi
  1194. elif [[ "${option}" == "WATCHDOG_VERBOSE" ]]; then
  1195. if ! grep -q "${option}" mailcow.conf; then
  1196. echo "Adding new option \"${option}\" to mailcow.conf"
  1197. echo '# Enable watchdog verbose logging' >> mailcow.conf
  1198. echo 'WATCHDOG_VERBOSE=n' >> mailcow.conf
  1199. fi
  1200. elif [[ "${option}" == "SKIP_UNBOUND_HEALTHCHECK" ]]; then
  1201. if ! grep -q "${option}" mailcow.conf; then
  1202. echo "Adding new option \"${option}\" to mailcow.conf"
  1203. echo '# Skip Unbound (DNS Resolver) Healthchecks (NOT Recommended!) - y/n' >> mailcow.conf
  1204. echo 'SKIP_UNBOUND_HEALTHCHECK=n' >> mailcow.conf
  1205. fi
  1206. elif [[ "${option}" == "DISABLE_NETFILTER_ISOLATION_RULE" ]]; then
  1207. if ! grep -q "${option}" mailcow.conf; then
  1208. echo "Adding new option \"${option}\" to mailcow.conf"
  1209. echo '# Prevent netfilter from setting an iptables/nftables rule to isolate the mailcow docker network - y/n' >> mailcow.conf
  1210. echo '# CAUTION: Disabling this may expose container ports to other neighbors on the same subnet, even if the ports are bound to localhost' >> mailcow.conf
  1211. echo 'DISABLE_NETFILTER_ISOLATION_RULE=n' >> mailcow.conf
  1212. fi
  1213. elif [[ "${option}" == "SKIP_CLAMD" ]]; then
  1214. if ! grep -q "${option}" mailcow.conf; then
  1215. echo "Adding new option \"${option}\" to mailcow.conf"
  1216. echo '# Skip ClamAV (clamd-mailcow) anti-virus (Rspamd will auto-detect a missing ClamAV container) - y/n' >> mailcow.conf
  1217. echo 'SKIP_CLAMD=n' >> mailcow.conf
  1218. fi
  1219. elif [[ "${option}" == "SKIP_OLEFY" ]]; then
  1220. if ! grep -q "${option}" mailcow.conf; then
  1221. echo "Adding new option \"${option}\" to mailcow.conf"
  1222. echo '# Skip Olefy (olefy-mailcow) anti-virus for Office documents (Rspamd will auto-detect a missing Olefy container) - y/n' >> mailcow.conf
  1223. echo 'SKIP_OLEFY=n' >> mailcow.conf
  1224. fi
  1225. elif [[ "${option}" == "REDISPASS" ]]; then
  1226. if ! grep -q "${option}" mailcow.conf; then
  1227. echo "Adding new option \"${option}\" to mailcow.conf"
  1228. echo -e '\n# ------------------------------' >> mailcow.conf
  1229. echo '# REDIS configuration' >> mailcow.conf
  1230. echo -e '# ------------------------------\n' >> mailcow.conf
  1231. echo "REDISPASS=$(LC_ALL=C </dev/urandom tr -dc A-Za-z0-9 2> /dev/null | head -c 28)" >> mailcow.conf
  1232. fi
  1233. elif ! grep -q "${option}" mailcow.conf; then
  1234. echo "Adding new option \"${option}\" to mailcow.conf"
  1235. echo "${option}=n" >> mailcow.conf
  1236. fi
  1237. done
  1238. if [[ ("${SKIP_PING_CHECK}" == "y") ]]; then
  1239. echo -e "\e[32mSkipping Ping Check...\e[0m"
  1240. else
  1241. echo -en "Checking internet connection... "
  1242. if ! check_online_status; then
  1243. echo -e "\e[31mfailed\e[0m"
  1244. exit 1
  1245. else
  1246. echo -e "\e[32mOK\e[0m"
  1247. fi
  1248. fi
  1249. if ! [ "$NEW_BRANCH" ]; then
  1250. echo -e "\e[33mDetecting which build your mailcow runs on...\e[0m"
  1251. sleep 1
  1252. if [ "${BRANCH}" == "master" ]; then
  1253. echo -e "\e[32mYou are receiving stable updates (master).\e[0m"
  1254. echo -e "\e[33mTo change that run the update.sh Script one time with the --nightly parameter to switch to nightly builds.\e[0m"
  1255. elif [ "${BRANCH}" == "nightly" ]; then
  1256. echo -e "\e[31mYou are receiving unstable updates (nightly). These are for testing purposes only!!!\e[0m"
  1257. sleep 1
  1258. echo -e "\e[33mTo change that run the update.sh Script one time with the --stable parameter to switch to stable builds.\e[0m"
  1259. elif [ "${BRANCH}" == "legacy" ]; then
  1260. echo -e "\e[31mYou are receiving legacy updates. The legacy branch will only receive security updates until February 2026.\e[0m"
  1261. sleep 1
  1262. echo -e "\e[33mTo change that run the update.sh Script one time with the --stable parameter to switch to stable builds.\e[0m"
  1263. else
  1264. echo -e "\e[33mYou are receiving updates from an unsupported branch.\e[0m"
  1265. sleep 1
  1266. echo -e "\e[33mThe mailcow stack might still work but it is recommended to switch to the master branch (stable builds).\e[0m"
  1267. echo -e "\e[33mTo change that run the update.sh Script one time with the --stable parameter to switch to stable builds.\e[0m"
  1268. fi
  1269. elif [ "$FORCE" ]; then
  1270. echo -e "\e[31mYou are running in forced mode!\e[0m"
  1271. echo -e "\e[31mA Branch Switch can only be performed manually (monitored).\e[0m"
  1272. echo -e "\e[31mPlease rerun the update.sh Script without the --force/-f parameter.\e[0m"
  1273. sleep 1
  1274. elif [ "$NEW_BRANCH" == "master" ] && [ "$CURRENT_BRANCH" != "master" ]; then
  1275. echo -e "\e[33mYou are about to switch your mailcow updates to the stable (master) branch.\e[0m"
  1276. sleep 1
  1277. echo -e "\e[33mBefore you do: Please take a backup of all components to ensure that no data is lost...\e[0m"
  1278. sleep 1
  1279. echo -e "\e[31mWARNING: Please see on GitHub or ask in the community if a switch to master is stable or not.
  1280. In some rear cases an update back to master can destroy your mailcow configuration such as database upgrade, etc.
  1281. Normally an upgrade back to master should be safe during each full release.
  1282. Check GitHub for Database changes and update only if there similar to the full release!\e[0m"
  1283. read -r -p "Are you sure you that want to continue upgrading to the stable (master) branch? [y/N] " response
  1284. if [[ ! "${response}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  1285. echo "OK. If you prepared yourself for that please run the update.sh Script with the --stable parameter again to trigger this process here."
  1286. exit 0
  1287. fi
  1288. BRANCH="$NEW_BRANCH"
  1289. DIFF_DIRECTORY=update_diffs
  1290. DIFF_FILE="${DIFF_DIRECTORY}/diff_before_upgrade_to_master_$(date +"%Y-%m-%d-%H-%M-%S")"
  1291. mv diff_before_upgrade* "${DIFF_DIRECTORY}/" 2> /dev/null
  1292. if ! git diff-index --quiet HEAD; then
  1293. echo -e "\e[32mSaving diff to ${DIFF_FILE}...\e[0m"
  1294. mkdir -p "${DIFF_DIRECTORY}"
  1295. git diff "${BRANCH}" --stat > "${DIFF_FILE}"
  1296. git diff "${BRANCH}" >> "${DIFF_FILE}"
  1297. fi
  1298. echo -e "\e[32mSwitching Branch to ${BRANCH}...\e[0m"
  1299. git fetch origin
  1300. git checkout -f "${BRANCH}"
  1301. elif [ "$NEW_BRANCH" == "nightly" ] && [ "$CURRENT_BRANCH" != "nightly" ]; then
  1302. echo -e "\e[33mYou are about to switch your mailcow Updates to the unstable (nightly) branch.\e[0m"
  1303. sleep 1
  1304. echo -e "\e[33mBefore you do: Please take a backup of all components to ensure that no Data is lost...\e[0m"
  1305. sleep 1
  1306. echo -e "\e[31mWARNING: A switch to nightly is possible any time. But a switch back (to master) isn't.\e[0m"
  1307. read -r -p "Are you sure you that want to continue upgrading to the unstable (nightly) branch? [y/N] " response
  1308. if [[ ! "${response}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  1309. echo "OK. If you prepared yourself for that please run the update.sh Script with the --nightly parameter again to trigger this process here."
  1310. exit 0
  1311. fi
  1312. BRANCH=$NEW_BRANCH
  1313. DIFF_DIRECTORY=update_diffs
  1314. DIFF_FILE=${DIFF_DIRECTORY}/diff_before_upgrade_to_nightly_$(date +"%Y-%m-%d-%H-%M-%S")
  1315. mv diff_before_upgrade* ${DIFF_DIRECTORY}/ 2> /dev/null
  1316. if ! git diff-index --quiet HEAD; then
  1317. echo -e "\e[32mSaving diff to ${DIFF_FILE}...\e[0m"
  1318. mkdir -p ${DIFF_DIRECTORY}
  1319. git diff "${BRANCH}" --stat > "${DIFF_FILE}"
  1320. git diff "${BRANCH}" >> "${DIFF_FILE}"
  1321. fi
  1322. git fetch origin
  1323. git checkout -f "${BRANCH}"
  1324. elif [ "$NEW_BRANCH" == "legacy" ] && [ "$CURRENT_BRANCH" != "legacy" ]; then
  1325. echo -e "\e[33mYou are about to switch your mailcow Updates to the legacy branch.\e[0m"
  1326. sleep 1
  1327. echo -e "\e[33mBefore you do: Please take a backup of all components to ensure that no Data is lost...\e[0m"
  1328. sleep 1
  1329. echo -e "\e[31mWARNING: A switch to stable or nightly is possible any time.\e[0m"
  1330. read -r -p "Are you sure you want to continue upgrading to the legacy branch? [y/N] " response
  1331. if [[ ! "${response}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  1332. echo "OK. If you prepared yourself for that please run the update.sh Script with the --legacy parameter again to trigger this process here."
  1333. exit 0
  1334. fi
  1335. BRANCH=$NEW_BRANCH
  1336. DIFF_DIRECTORY=update_diffs
  1337. DIFF_FILE=${DIFF_DIRECTORY}/diff_before_upgrade_to_legacy_$(date +"%Y-%m-%d-%H-%M-%S")
  1338. mv diff_before_upgrade* ${DIFF_DIRECTORY}/ 2> /dev/null
  1339. if ! git diff-index --quiet HEAD; then
  1340. echo -e "\e[32mSaving diff to ${DIFF_FILE}...\e[0m"
  1341. mkdir -p ${DIFF_DIRECTORY}
  1342. git diff "${BRANCH}" --stat > "${DIFF_FILE}"
  1343. git diff "${BRANCH}" >> "${DIFF_FILE}"
  1344. fi
  1345. git fetch origin
  1346. git checkout -f "${BRANCH}"
  1347. fi
  1348. if [ ! "$DEV" ]; then
  1349. echo -e "\e[32mChecking for newer update script...\e[0m"
  1350. SHA1_1="$(sha1sum update.sh)"
  1351. git fetch origin #${BRANCH}
  1352. git checkout "origin/${BRANCH}" update.sh
  1353. SHA1_2=$(sha1sum update.sh)
  1354. if [[ "${SHA1_1}" != "${SHA1_2}" ]]; then
  1355. echo "update.sh changed, please run this script again, exiting."
  1356. chmod +x update.sh
  1357. exit 2
  1358. fi
  1359. fi
  1360. if [ ! "$FORCE" ]; then
  1361. read -r -p "Are you sure you want to update mailcow: dockerized? All containers will be stopped. [y/N] " response
  1362. if [[ ! "${response}" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  1363. echo "OK, exiting."
  1364. exit 0
  1365. fi
  1366. detect_major_update
  1367. migrate_docker_nat
  1368. fi
  1369. remove_obsolete_nginx_ports
  1370. echo -e "\e[32mValidating docker-compose stack configuration...\e[0m"
  1371. sed -i 's/HTTPS_BIND:-:/HTTPS_BIND:-/g' docker-compose.yml
  1372. sed -i 's/HTTP_BIND:-:/HTTP_BIND:-/g' docker-compose.yml
  1373. if ! $COMPOSE_COMMAND config -q; then
  1374. echo -e "\e[31m\nOh no, something went wrong. Please check the error message above.\e[0m"
  1375. exit 1
  1376. fi
  1377. echo -e "\e[32mChecking for conflicting bridges...\e[0m"
  1378. MAILCOW_BRIDGE=$($COMPOSE_COMMAND config | grep -i com.docker.network.bridge.name | cut -d':' -f2)
  1379. while read NAT_ID; do
  1380. iptables -t nat -D POSTROUTING "$NAT_ID"
  1381. done < <(iptables -L -vn -t nat --line-numbers | grep "$IPV4_NETWORK" | grep -E 'MASQUERADE.*all' | grep -v "${MAILCOW_BRIDGE}" | cut -d' ' -f1)
  1382. DIFF_DIRECTORY=update_diffs
  1383. DIFF_FILE=${DIFF_DIRECTORY}/diff_before_update_$(date +"%Y-%m-%d-%H-%M-%S")
  1384. mv diff_before_update* ${DIFF_DIRECTORY}/ 2> /dev/null
  1385. if ! git diff-index --quiet HEAD; then
  1386. echo -e "\e[32mSaving diff to ${DIFF_FILE}...\e[0m"
  1387. mkdir -p ${DIFF_DIRECTORY}
  1388. git diff --stat > "${DIFF_FILE}"
  1389. git diff >> "${DIFF_FILE}"
  1390. fi
  1391. echo -e "\e[32mPrefetching images...\e[0m"
  1392. prefetch_images
  1393. echo -e "\e[32mStopping mailcow...\e[0m"
  1394. sleep 2
  1395. MAILCOW_CONTAINERS=($($COMPOSE_COMMAND ps -q))
  1396. $COMPOSE_COMMAND down
  1397. echo -e "\e[32mChecking for remaining containers...\e[0m"
  1398. sleep 2
  1399. for container in "${MAILCOW_CONTAINERS[@]}"; do
  1400. docker rm -f "$container" 2> /dev/null
  1401. done
  1402. [[ -f data/conf/nginx/ZZZ-ejabberd.conf ]] && rm data/conf/nginx/ZZZ-ejabberd.conf
  1403. migrate_solr_config_options
  1404. adapt_new_options
  1405. # Silently fixing remote url from andryyy to mailcow
  1406. # git remote set-url origin https://github.com/mailcow/mailcow-dockerized
  1407. DEFAULT_REPO="https://github.com/mailcow/mailcow-dockerized"
  1408. CURRENT_REPO=$(git config --get remote.origin.url)
  1409. if [ "$CURRENT_REPO" != "$DEFAULT_REPO" ]; then
  1410. echo "The Repository currently used is not the default Mailcow Repository."
  1411. echo "Currently Repository: $CURRENT_REPO"
  1412. echo "Default Repository: $DEFAULT_REPO"
  1413. if [ ! "$FORCE" ]; then
  1414. read -r -p "Should it be changed back to default? [y/N] " repo_response
  1415. if [[ "$repo_response" =~ ^([yY][eE][sS]|[yY])+$ ]]; then
  1416. git remote set-url origin $DEFAULT_REPO
  1417. fi
  1418. else
  1419. echo "Running in forced mode... setting Repo to default!"
  1420. git remote set-url origin $DEFAULT_REPO
  1421. fi
  1422. fi
  1423. if [ ! "$DEV" ]; then
  1424. echo -e "\e[32mCommitting current status...\e[0m"
  1425. [[ -z "$(git config user.name)" ]] && git config user.name moo
  1426. [[ -z "$(git config user.email)" ]] && git config user.email moo@cow.moo
  1427. [[ ! -z $(git ls-files data/conf/rspamd/override.d/worker-controller-password.inc) ]] && git rm data/conf/rspamd/override.d/worker-controller-password.inc
  1428. git add -u
  1429. git commit -am "Before update on ${DATE}" > /dev/null
  1430. echo -e "\e[32mFetching updated code from remote...\e[0m"
  1431. git fetch origin #${BRANCH}
  1432. echo -e "\e[32mMerging local with remote code (recursive, strategy: \"${MERGE_STRATEGY:-theirs}\", options: \"patience\"...\e[0m"
  1433. git config merge.defaultToUpstream true
  1434. git merge -X"${MERGE_STRATEGY:-theirs}" -Xpatience -m "After update on ${DATE}"
  1435. # Need to use a variable to not pass return codes of if checks
  1436. MERGE_RETURN=$?
  1437. if [[ ${MERGE_RETURN} == 128 ]]; then
  1438. 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"
  1439. exit 1
  1440. elif [[ ${MERGE_RETURN} == 1 ]]; then
  1441. echo -e "\e[93mPotential conflict, trying to fix...\e[0m"
  1442. git status --porcelain | grep -E "UD|DU" | awk '{print $2}' | xargs rm -v
  1443. git add -A
  1444. git commit -m "After update on ${DATE}" > /dev/null
  1445. git checkout .
  1446. echo -e "\e[32mRemoved and recreated files if necessary.\e[0m"
  1447. elif [[ ${MERGE_RETURN} != 0 ]]; then
  1448. echo -e "\e[31m\nOh no, something went wrong. Please check the error message above.\e[0m"
  1449. echo
  1450. echo "Run $COMPOSE_COMMAND up -d to restart your stack without updates or try again after fixing the mentioned errors."
  1451. exit 1
  1452. fi
  1453. elif [ "$DEV" ]; then
  1454. echo -e "\e[33mDEVELOPER MODE: Not creating a git diff and commiting it to prevent development stuff within a backup diff...\e[0m"
  1455. fi
  1456. echo -e "\e[32mFetching new images, if any...\e[0m"
  1457. sleep 2
  1458. $COMPOSE_COMMAND pull
  1459. # Fix missing SSL, does not overwrite existing files
  1460. [[ ! -d data/assets/ssl ]] && mkdir -p data/assets/ssl
  1461. cp -n -d data/assets/ssl-example/*.pem data/assets/ssl/
  1462. echo -e "Checking IPv6 settings... "
  1463. if grep -q 'SYSCTL_IPV6_DISABLED=1' mailcow.conf; then
  1464. echo
  1465. echo '!! IMPORTANT !!'
  1466. echo
  1467. 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".'
  1468. echo "This setting will only be active after a complete shutdown of mailcow by running $COMPOSE_COMMAND down followed by $COMPOSE_COMMAND up -d."
  1469. echo
  1470. echo '!! IMPORTANT !!'
  1471. echo
  1472. read -p "Press any key to continue..." < /dev/tty
  1473. fi
  1474. # Checking for old project name bug
  1475. sed -i --follow-symlinks 's#COMPOSEPROJECT_NAME#COMPOSE_PROJECT_NAME#g' mailcow.conf
  1476. # Fix Rspamd maps
  1477. if [ -f data/conf/rspamd/custom/global_from_blacklist.map ]; then
  1478. mv data/conf/rspamd/custom/global_from_blacklist.map data/conf/rspamd/custom/global_smtp_from_blacklist.map
  1479. fi
  1480. if [ -f data/conf/rspamd/custom/global_from_whitelist.map ]; then
  1481. mv data/conf/rspamd/custom/global_from_whitelist.map data/conf/rspamd/custom/global_smtp_from_whitelist.map
  1482. fi
  1483. # Fix deprecated metrics.conf
  1484. if [ -f "data/conf/rspamd/local.d/metrics.conf" ]; then
  1485. if [ ! -z "$(git diff --name-only origin/master data/conf/rspamd/local.d/metrics.conf)" ]; then
  1486. 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."
  1487. echo "The deprecated configuration file metrics.conf will be moved to metrics.conf_deprecated after updating mailcow."
  1488. fi
  1489. mv data/conf/rspamd/local.d/metrics.conf data/conf/rspamd/local.d/metrics.conf_deprecated
  1490. fi
  1491. # Set app_info.inc.php
  1492. if [ ${BRANCH} == "master" ]; then
  1493. mailcow_git_version=$(git describe --tags $(git rev-list --tags --max-count=1))
  1494. elif [ ${BRANCH} == "nightly" ]; then
  1495. mailcow_git_version=$(git rev-parse --short $(git rev-parse @{upstream}))
  1496. mailcow_last_git_version=""
  1497. else
  1498. mailcow_git_version=$(git rev-parse --short HEAD)
  1499. mailcow_last_git_version=""
  1500. fi
  1501. mailcow_git_commit=$(git rev-parse "origin/${BRANCH}")
  1502. mailcow_git_commit_date=$(git log -1 --format=%ci @{upstream} )
  1503. if [ $? -eq 0 ]; then
  1504. echo '<?php' > data/web/inc/app_info.inc.php
  1505. echo ' $MAILCOW_GIT_VERSION="'$mailcow_git_version'";' >> data/web/inc/app_info.inc.php
  1506. echo ' $MAILCOW_LAST_GIT_VERSION="";' >> data/web/inc/app_info.inc.php
  1507. echo ' $MAILCOW_GIT_OWNER="mailcow";' >> data/web/inc/app_info.inc.php
  1508. echo ' $MAILCOW_GIT_REPO="mailcow-dockerized";' >> data/web/inc/app_info.inc.php
  1509. echo ' $MAILCOW_GIT_URL="https://github.com/mailcow/mailcow-dockerized";' >> data/web/inc/app_info.inc.php
  1510. echo ' $MAILCOW_GIT_COMMIT="'$mailcow_git_commit'";' >> data/web/inc/app_info.inc.php
  1511. echo ' $MAILCOW_GIT_COMMIT_DATE="'$mailcow_git_commit_date'";' >> data/web/inc/app_info.inc.php
  1512. echo ' $MAILCOW_BRANCH="'$BRANCH'";' >> data/web/inc/app_info.inc.php
  1513. echo ' $MAILCOW_UPDATEDAT='$(date +%s)';' >> data/web/inc/app_info.inc.php
  1514. echo '?>' >> data/web/inc/app_info.inc.php
  1515. else
  1516. echo '<?php' > data/web/inc/app_info.inc.php
  1517. echo ' $MAILCOW_GIT_VERSION="'$mailcow_git_version'";' >> data/web/inc/app_info.inc.php
  1518. echo ' $MAILCOW_LAST_GIT_VERSION="";' >> data/web/inc/app_info.inc.php
  1519. echo ' $MAILCOW_GIT_OWNER="mailcow";' >> data/web/inc/app_info.inc.php
  1520. echo ' $MAILCOW_GIT_REPO="mailcow-dockerized";' >> data/web/inc/app_info.inc.php
  1521. echo ' $MAILCOW_GIT_URL="https://github.com/mailcow/mailcow-dockerized";' >> data/web/inc/app_info.inc.php
  1522. echo ' $MAILCOW_GIT_COMMIT="";' >> data/web/inc/app_info.inc.php
  1523. echo ' $MAILCOW_GIT_COMMIT_DATE="";' >> data/web/inc/app_info.inc.php
  1524. echo ' $MAILCOW_BRANCH="'$BRANCH'";' >> data/web/inc/app_info.inc.php
  1525. echo ' $MAILCOW_UPDATEDAT='$(date +%s)';' >> data/web/inc/app_info.inc.php
  1526. echo '?>' >> data/web/inc/app_info.inc.php
  1527. echo -e "\e[33mCannot determine current git repository version...\e[0m"
  1528. fi
  1529. if [[ ${SKIP_START} == "y" ]]; then
  1530. echo -e "\e[33mNot starting mailcow, please run \"$COMPOSE_COMMAND up -d --remove-orphans\" to start mailcow.\e[0m"
  1531. else
  1532. echo -e "\e[32mStarting mailcow...\e[0m"
  1533. sleep 2
  1534. $COMPOSE_COMMAND up -d --remove-orphans
  1535. fi
  1536. echo -e "\e[32mCollecting garbage...\e[0m"
  1537. docker_garbage
  1538. # Run post-update-hook
  1539. if [ -f "${SCRIPT_DIR}/post_update_hook.sh" ]; then
  1540. bash "${SCRIPT_DIR}/post_update_hook.sh"
  1541. fi
  1542. # echo "In case you encounter any problem, hard-reset to a state before updating mailcow:"
  1543. # echo
  1544. # git reflog --color=always | grep "Before update on "
  1545. # echo
  1546. # echo "Use \"git reset --hard hash-on-the-left\" and run $COMPOSE_COMMAND up -d afterwards."