fix(script): fix dockerCmd quoting error

- if doDocker throws an error, cleanup is called which again calls doDocker
- resolve this loop by passing a variable from cleanup

.gitattributes

@@ -10,17 +10,17 @@
 
 # Documents
 *.bibtex   text diff=bibtex
-*.doc	        diff=astextplain
-*.DOC	        diff=astextplain
-*.docx          diff=astextplain
-*.DOCX          diff=astextplain
-*.dot           diff=astextplain
-*.DOT           diff=astextplain
-*.pdf           diff=astextplain
-*.PDF           diff=astextplain
-*.rtf           diff=astextplain
-*.RTF	        diff=astextplain
-*.md       text
+*.doc      diff=astextplain
+*.DOC      diff=astextplain
+*.docx     diff=astextplain
+*.DOCX     diff=astextplain
+*.dot      diff=astextplain
+*.DOT      diff=astextplain
+*.pdf      diff=astextplain
+*.PDF      diff=astextplain
+*.rtf      diff=astextplain
+*.RTF      diff=astextplain
+*.md       text diff=markdown
 *.tex      text diff=tex
 *.adoc     text
 *.textile  text
@@ -30,6 +30,7 @@
 *.tsv      text
 *.txt      text
 *.sql      text
+*.ps1      text eol=crlf
 
 # Graphics
 *.png      binary
@@ -48,11 +49,28 @@
 
 # Scripts
 *.bash     text eol=lf
+*.fish     text eol=lf
 *.sh       text eol=lf
 # These are explicitly windows files and should use crlf
 *.bat      text eol=crlf
 *.cmd      text eol=crlf
-*.ps1      text eol=crlf
+
+# web frontend stack -- force LF so SRI hashes are always correct
+*.html     text eol=lf
+*.htm      text eol=lf
+*.css      text eol=lf
+*.min.css  text eol=lf
+*.js       text eol=lf
+*.min.js   text eol=lf
+*.php      text eol=lf
+
+# Visual Studio projects (Rider also)
+*.cs     diff=csharp
+*.sln    merge=union
+*.csproj merge=union
+*.vbproj merge=union
+*.fsproj merge=union
+*.dbproj merge=union
 
 # Serialisation
 *.json     text
@@ -65,12 +83,18 @@
 *.7z       binary
 *.gz       binary
 *.tar      binary
+*.tgz      binary
 *.zip      binary
 
+# Text files where line endings should be preserved
+*.patch    -text
+
 #
 # Exclude files from exporting
 #
 
 .gitattributes  export-ignore
 .gitignore      export-ignore
+.gitkeep        export-ignore
+.idea           export-ignore
 .vscode         export-ignore

.gitignore

@@ -1,10 +1,27 @@
-# ignore all vscode config files
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-!.vscode/numbered-bookmarks.json
+#
+# JetBrains exclusions
+#
 
-# ignore all generated logfiles
-*.log
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# modules
+.idea_modules/
+
+# Editor-based Rest Client
+.idea/httpRequests

.idea/.idea.MailcowBackup.dir/.idea/git_toolbox_prj.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="GitToolBoxProjectSettings">
+    <option name="commitMessageIssueKeyValidationOverride">
+      <BoolValueOverride>
+        <option name="enabled" value="true" />
+      </BoolValueOverride>
+    </option>
+    <option name="commitMessageValidationEnabledOverride">
+      <BoolValueOverride>
+        <option name="enabled" value="true" />
+      </BoolValueOverride>
+    </option>
+  </component>
+</project>

.idea/.idea.MailcowBackup.dir/.idea/indexLayout.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
-  <component name="ContentModelUserStore">
+  <component name="UserContentModel">
     <attachedFolders />
     <explicitIncludes />
     <explicitExcludes />

.idea/.idea.MailcowBackup.dir/.idea/riderModule.iml

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="RIDER_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$/../.." />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

.idea/.idea.MailcowBackup.dir/.idea/vcs.xml

@@ -4,9 +4,19 @@
     <profile version="1.0">
       <inspection_tool class="BodyLimit" enabled="true" level="ERROR" enabled_by_default="true" />
       <inspection_tool class="SubjectBodySeparation" enabled="true" level="ERROR" enabled_by_default="true" />
-      <inspection_tool class="SubjectLimit" enabled="true" level="ERROR" enabled_by_default="true" />
+      <inspection_tool class="SubjectLimit" enabled="true" level="WARNING" enabled_by_default="true">
+        <option name="RIGHT_MARGIN" value="50" />
+      </inspection_tool>
     </profile>
   </component>
+  <component name="GitSharedSettings">
+    <option name="FORCE_PUSH_PROHIBITED_PATTERNS">
+      <list>
+        <option value="master" />
+        <option value="main" />
+      </list>
+    </option>
+  </component>
   <component name="VcsDirectoryMappings">
     <mapping directory="$PROJECT_DIR$" vcs="Git" />
   </component>

.vscode/numbered-bookmarks.json

@@ -1,3 +0,0 @@
-{
-	"bookmarks": []
-}

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Asif Bacchus
+Copyright (c) 2020-2022 Asif Bacchus (asif@asifbacchus.dev)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

backup/backup.details

@@ -18,17 +18,19 @@
 # base configuration directory for borg, all borg parameters use this directory
 # as their 'root'.  I recommend setups with this being "/var/borgbackup", the
 # default is "$HOME" or "~$USER" in that order.  If you're unsure, try "$HOME"
-borgBaseDir = "/var/borgbackup"
+borgBaseDir="/var/borgbackup"
 
-# SSH port on which your borg server listens. By default, this is port 22.
-borgSSHPort = 22
+# SSH port on which your borg server listens. To connect on a custom port,
+# uncomment the line below and change the port number as required.
+# If you leave this line commented, the default (port 22) will be used.
+#borgSSHPort=22
 
 # full path to the SSH key used to connect to your remote backup server
-borgSSHKey = "/var/borgbackup/private.key"
+borgSSHKey="/var/borgbackup/private.key"
 
 # connection string to access the borg repo on your remote backup server
 # this is usually in the form user@servername.tld:repoName/
-borgConnectRepo = "jdoe123@borg.server.net:mailcow/"
+borgConnectRepo="jdoe123@borg.server.net:mailcow/"
 
 # password to access repo
 # this was set when the repo was initialized and, while optional, is HIGHLY

backup/backup.sh

@@ -8,9 +8,8 @@
 ###     3. remote repo already set-up and configured
 #######
 
-
 ### text formatting presents
-if command -v tput > /dev/null; then
+if command -v tput >/dev/null; then
     bold=$(tput bold)
     cyan=$(tput setaf 6)
     err=$(tput bold)$(tput setaf 1)
@@ -32,11 +31,9 @@ else
     yellow=""
 fi
 
-
 ### trap
 trap trapExit 1 2 3 6
 
-
 ### functions
 
 # bad configuration value passed in details file
@@ -73,73 +70,74 @@ badParam() {
 cleanup() {
     # cleanup 503 if copied
     if [ "$err503Copied" -eq 1 ]; then
+        # shellcheck disable=SC2129
         if ! rm -f "$webroot/$err503File" 2>>"$logFile"; then
             printf "%s[%s] -- [WARNING] Could not remove 503 error page." \
-                "$warn" "$(stamp)" >> "$logFile"
+                "$warn" "$(stamp)" >>"$logFile"
             printf " Web interface will not function until this file is " \
-                >> "$logFile"
-            printf "removed --%s\n" "$norm" >> "$logFile"
-            warnCount=$((warnCount+1))
+                >>"$logFile"
+            printf "removed --%s\n" "$norm" >>"$logFile"
+            warnCount=$((warnCount + 1))
         else
             printf "%s[%s] -- [INFO] 503 error page removed --%s\n" \
-                "$cyan" "$(stamp)" "$norm" >> "$logFile"
+                "$cyan" "$(stamp)" "$norm" >>"$logFile"
         fi
     fi
     # cleanup SQL dump directory if created
     if [ "$sqlDumpDirCreated" -eq 1 ]; then
         if ! rm -rf "$sqlDumpDir" 2>>"$logFile"; then
             printf "%s[%s] -- [WARNING] Could not remove temporary SQL-dump directory. Sorry for the mess. --%s\n" \
-                "$warn" "$(stamp)" "$norm" >> "$logFile"
+                "$warn" "$(stamp)" "$norm" >>"$logFile"
         else
             printf "%s[%s] -- [INFO] Temporary SQL-dump directory removed successfully --%s\n" \
-                "$cyan" "$(stamp)" "$norm" >> "$logFile"
+                "$cyan" "$(stamp)" "$norm" >>"$logFile"
         fi
     fi
     # start docker containers (no harm if they are already running)
     doDocker start postfix
     if [ "$dockerResultState" = "true" ]; then
         printf "%s[%s] -- [INFO] POSTFIX container is running --%s\n" \
-            "$cyan" "$(stamp)" "$norm" >> "$logFile"
+            "$cyan" "$(stamp)" "$norm" >>"$logFile"
     else
-        exitError 102 'Could not start POSTFIX container.'
+        exitError 102 'Could not start POSTFIX container.' 'final'
     fi
     doDocker start dovecot
     if [ "$dockerResultState" = "true" ]; then
         printf "%s[%s] -- [INFO] DOVECOT container is running --%s\n" \
-            "$cyan" "$(stamp)" "$norm" >> "$logFile"
+            "$cyan" "$(stamp)" "$norm" >>"$logFile"
     else
-        exitError 102 'Could not start DOVECOT container.'
+        exitError 102 'Could not start DOVECOT container.' 'final'
     fi
 }
 
 doDocker() {
-    containerName="$( docker ps -a --format '{{ .Names }}' --filter name=${COMPOSE_PROJECT_NAME}_${2}-mailcow_1 )"
+    containerName="$(docker ps -a --format '{{ .Names }}' --filter "name=${COMPOSE_PROJECT_NAME}_${2}-mailcow_1" --filter "name=${COMPOSE_PROJECT_NAME}-${2}-mailcow-1")"
 
     # determine action to take
     if [ "$1" = "stop" ]; then
         printf "%s[%s] -- [INFO] Stopping %s-mailcow container --%s\n" \
-            "$cyan" "$(stamp)" "$2" "$norm" >> "$logFile"
-        docker-compose -f "$mcDockerCompose" stop --timeout "$dockerStopTimeout" "$2-mailcow" 2>> "$logFile"
+            "$cyan" "$(stamp)" "$2" "$norm" >>"$logFile"
+        ${dockerCmd} -f "$mcDockerCompose" stop --timeout "$dockerStopTimeout" "$2-mailcow" 2>>"$logFile"
         # set result vars
-        dockerResultState="$( docker inspect -f '{{ .State.Running }}' $containerName )"
-        dockerResultExit="$( docker inspect -f '{{ .State.ExitCode }}' $containerName )"
+        dockerResultState="$(docker inspect -f '{{ .State.Running }}' "$containerName")"
+        dockerResultExit="$(docker inspect -f '{{ .State.ExitCode }}' "$containerName")"
     elif [ "$1" = "start" ]; then
         printf "%s[%s] -- [INFO] Starting %s-mailcow container --%s\n" \
-            "$cyan" "$(stamp)" "$2" "$norm" >> "$logFile"
-        docker-compose -f "$mcDockerCompose" start "$2-mailcow" 2>> "$logFile"
+            "$cyan" "$(stamp)" "$2" "$norm" >>"$logFile"
+        ${dockerCmd} -f "$mcDockerCompose" start "$2-mailcow" 2>>"$logFile"
         # set result vars
-        dockerResultState="$( docker inspect -f '{{ .State.Running }}' $containerName )"
+        dockerResultState="$(docker inspect -f '{{ .State.Running }}' "$containerName")"
     fi
 }
 
 # call cleanup and then exit with error report
 exitError() {
     printf "%s[%s] -- [ERROR] %s: %s --%s\n" \
-            "$err" "$(stamp)" "$1" "$2" "$norm" >> "$logFile"
-    cleanup
+        "$err" "$(stamp)" "$1" "$2" "$norm" >>"$logFile"
+    if [ ! "$3" = "final" ]; then cleanup; fi
     # note script completion with error
     printf "%s[%s] --- %s execution completed with error ---%s\n" \
-        "$err" "$(stamp)" "$scriptName" "$norm" >> "$logFile"
+        "$err" "$(stamp)" "$scriptName" "$norm" >>"$logFile"
     exit "$1"
 }
 
@@ -147,7 +145,8 @@ exitError() {
 scriptHelp() {
     newline
     printf "%sUsage: %s [parameters]%s\n\n" "$bold" "$scriptName" "$norm"
-    textblock "There are NO mandatory parameters. If a parameter is not supplied, its default value will be used. In the case of a switch parameter, it will remain DEactivated if NOT specified."
+    textblock "There are NO mandatory parameters. If a parameter is not supplied, its default value will be used. In 
+    the case of a switch parameter, it will remain *deactivated* if NOT specified."
     newline
     textblock "Parameters are listed then followed by a description of their effect on the following line. Finally, if a default value exists, it will be listed on the next line in (parentheses)."
     newline
@@ -197,7 +196,7 @@ scriptHelp() {
     textblock "${magenta}--- mailcow related ---${norm}"
     newline
     switchTextblock "-d | --docker-compose"
-    textblock "Path to mailcow's 'docker-compose.yml' file."
+    textblock "Path to the mailcow 'docker-compose.yml' file."
     defaultsTextblock "(/opt/mailcow-dockerized/docker-compose.yml)"
     newline
     switchTextblock "-m | --mailcow-config"
@@ -241,24 +240,24 @@ newline() {
 # same as exitError but for signal captures
 trapExit() {
     printf "%s[%s] -- [ERROR] 99: Caught signal --%s\n" \
-            "$err" "$(stamp)" "$norm" >> "$logFile"
+        "$err" "$(stamp)" "$norm" >>"$logFile"
     cleanup
     # note script completion with error
     printf "%s[%s] --- %s execution was terminated via signal ---%s\n" \
-        "$err" "$(stamp)" "$scriptName" "$norm" >> "$logFile"
+        "$err" "$(stamp)" "$scriptName" "$norm" >>"$logFile"
     exit 99
 }
 
 ### end of functions
 
-
 ### default variable values
 
 ## script related
 # store logfile in the same directory as this script file using the same file
 # name as the script but with the extension '.log'
-scriptPath="$( CDPATH='' \cd -- "$( dirname -- "$0" )" && pwd -P )"
-scriptName="$( basename "$0" )"
+scriptVersion="4.0"
+scriptPath="$(CDPATH='' \cd -- "$(dirname -- "$0")" && pwd -P)"
+scriptName="$(basename "$0")"
 logFile="$scriptPath/${scriptName%.*}.log"
 colourizeLogFile=1
 warnCount=0
@@ -266,6 +265,7 @@ configDetails="$scriptPath/${scriptName%.*}.details"
 err503Copied=0
 sqlDumpDirCreated=0
 exclusions=0
+dockerCmd="docker compose"
 borgPath="/usr/bin/borg"
 # borg output verbosity -- normal
 borgCreateParams='--stats'
@@ -283,161 +283,172 @@ mcDockerCompose="/opt/mailcow-dockerized/docker-compose.yml"
 dockerStartTimeout=180
 dockerStopTimeout=120
 
-
 ### process startup parameters
 while [ $# -gt 0 ]; do
     case "$1" in
-        -h|-\?|--help)
-            # display help
-            scriptHelp
-            exit 0
-            ;;
-        -l|--log)
-            # set log file location
-            if [ -n "$2" ]; then
-                logFile="${2%/}"
+    -h | -\? | --help)
+        # display help
+        scriptHelp
+        exit 0
+        ;;
+    --version)
+        # display script version
+        printf "\nMailcowBackup - Backup Mailcow using borgbackup to a remote SSH server : Version %s\n\n" ${scriptVersion}
+        exit 0
+        ;;
+    -l | --log)
+        # set log file location
+        if [ -n "$2" ]; then
+            logFile="${2%/}"
+            shift
+        else
+            badParam empty "$@"
+        fi
+        ;;
+    --nc | --no-color | --no-colour)
+        # do NOT colourize log file
+        colourizeLogFile=0
+        ;;
+    -b | --borg)
+        # specify non-default borg path
+        if [ -n "$2" ]; then
+            borgPath="${2%/}"
+            shift
+        else
+            badParam empty "$@"
+        fi
+        ;;
+    -c | --config | --details)
+        # location of config details file
+        if [ -n "$2" ]; then
+            if [ -f "$2" ]; then
+                configDetails="${2%/}"
                 shift
             else
-                badParam empty "$@"
+                badParam dne "$@"
             fi
-            ;;
-        --nc|--no-color|--no-colour)
-            # do NOT colourize log file
-            colourizeLogFile=0
-            ;;
-        -b|--borg)
-            # specify non-default borg path
-            if [ -n "$2" ]; then
-                borgPath="${2%/}"
+        else
+            badParam empty "$@"
+        fi
+        ;;
+    --compression)
+        # set borg archive compression
+        if [ -n "$2" ]; then
+            borgCompression="$2"
+            shift
+        else
+            badParam empty "$@"
+        fi
+        ;;
+    -v | --verbose)
+        # set verbose logging from borg
+        borgCreateParams='--list --stats'
+        borgPruneParams='--list'
+        ;;
+    -5 | --use-503)
+        # enable copying 503 error page to webroot
+        use503=1
+        ;;
+    --503-path)
+        # FULL path to 503 file
+        if [ -n "$2" ]; then
+            if [ -f "$2" ]; then
+                err503Path="${2%/}"
+                err503File="${2##*/}"
                 shift
             else
-                badParam empty "$@"
+                badParam dne "$@"
             fi
-            ;;
-        -c|--config|--details)
-            # location of config details file
-            if [ -n "$2" ]; then
-                if [ -f "$2" ]; then
-                    configDetails="${2%/}"
-                    shift
-                else
-                    badParam dne "$@"
-                fi
-            else
-                badParam empty "$@"
-            fi
-            ;;
-        --compression)
-            # set borg archive compression
-            if [ -n "$2" ]; then
-                borgCompression="$2"
+        else
+            badParam empty "$@"
+        fi
+        ;;
+    -w | --webroot)
+        # path to webroot (copy 503)
+        if [ -n "$2" ]; then
+            if [ -d "$2" ]; then
+                webroot="${2%/}"
                 shift
             else
-                badParam empty "$@"
+                badParam dne "$@"
             fi
-            ;;
-        -v|--verbose)
-            # set verbose logging from borg
-            borgCreateParams='--list --stats'
-            borgPruneParams='--list'
-            ;;
-        -5|--use-503)
-            # enable copying 503 error page to webroot
-            use503=1
-            ;;
-        --503-path)
-            # FULL path to 503 file
-            if [ -n "$2" ]; then
-                if [ -f "$2" ]; then
-                    err503Path="${2%/}"
-                    err503File="${2##*/}"
-                    shift
-                else
-                    badParam dne "$@"
-                fi
-            else
-                badParam empty "$@"
-            fi
-            ;;
-        -w|--webroot)
-            # path to webroot (copy 503)
-            if [ -n "$2" ]; then
-                if [ -d "$2" ]; then
-                    webroot="${2%/}"
-                    shift
-                else
-                    badParam dne "$@"
-                fi
-            else
-                badParam empty "$@"
-            fi
-            ;;
-        -d|--docker-compose)
-            # FULL path to mailcow docker-compose file
-            if [ -n "$2" ]; then
-                if [ -f "$2" ]; then
-                    mcDockerCompose="$2"
-                    shift
-                else
-                    badParam dne "$@"
-                fi
-            else
-                badParam empty "$@"
-            fi
-            ;;
-        -m|--mailcow-config)
-            # FULL path to mailcow configuration file
-            if [ -n "$2" ]; then
-                if [ -f "$2" ]; then
-                    mcConfig="$2"
-                    shift
-                else
-                    badParam dne "$@"
-                fi
-            else
-                badParam empty "$@"
-            fi
-            ;;
-        -t1|--timeout-start)
-            if [ -z "$2" ]; then
-                badParam empty "$@"
-            else
-                dockerStartTimeout="$2"
+        else
+            badParam empty "$@"
+        fi
+        ;;
+    -d | --docker-compose)
+        # FULL path to mailcow docker-compose file
+        if [ -n "$2" ]; then
+            if [ -f "$2" ]; then
+                mcDockerCompose="$2"
                 shift
-            fi
-            ;;
-        -t2|--timeout-stop)
-            if [ -z "$2" ]; then
-                badParam empty "$@"
             else
-                dockerStopTimeout="$2"
-                shift
+                badParam dne "$@"
             fi
-            ;;
-        *)
-            printf "\n%sUnknown option: %s\n" "$err" "$1"
-            printf "%sUse '--help' for valid options.%s\n\n" "$cyan" "$norm"
-            exit 1
-            ;;
+        else
+            badParam empty "$@"
+        fi
+        ;;
+    -m | --mailcow-config)
+        # FULL path to mailcow configuration file
+        if [ -n "$2" ]; then
+            if [ -f "$2" ]; then
+                mcConfig="$2"
+                shift
+            else
+                badParam dne "$@"
+            fi
+        else
+            badParam empty "$@"
+        fi
+        ;;
+    -t1 | --timeout-start)
+        if [ -z "$2" ]; then
+            badParam empty "$@"
+        else
+            dockerStartTimeout="$2"
+            shift
+        fi
+        ;;
+    -t2 | --timeout-stop)
+        if [ -z "$2" ]; then
+            badParam empty "$@"
+        else
+            dockerStopTimeout="$2"
+            shift
+        fi
+        ;;
+    *)
+        printf "\n%sUnknown option: %s\n" "$err" "$1"
+        printf "%sUse '--help' for valid options.%s\n\n" "$cyan" "$norm"
+        exit 1
+        ;;
     esac
     shift
 done
 
-
 ### check pre-requisites and default values
 # check if running as root, otherwise exit
-if [ "$( id -u )" -ne 0 ]; then
+if [ "$(id -u)" -ne 0 ]; then
     printf "\n%sERROR: script MUST be run as ROOT%s\n\n" "$err" "$norm"
     exit 2
 fi
+# verify compose installed and set proper commands based on version
+if ! (docker compose version >/dev/null 2>&1); then
+    if ! (docker-compose --version >/dev/null 2>&1); then
+        printf "\n%sERROR: Docker Compose not installed or not functioning%s\n\n" "$err" "$norm"
+        exit 3
+    fi
+    dockerCmd="docker-compose"
+fi
 # does the details file exist?
 if [ ! -f "$configDetails" ]; then
     badParam dne "(--details default)" "$configDetails"
 fi
 # is borg installed?
-if ! find "$borgPath" -type f -executable > /dev/null 2>&1; then
+if ! find "$borgPath" -type f -executable >/dev/null 2>&1; then
     printf "\n%sERROR: BORG cannot be found in the specified or default location on this system!%s\n\n" "$err" "$norm"
-    exit 3
+    exit 4
 fi
 # if 503 functionality is enabled, do 503 related files exist?
 if [ "$use503" -eq 1 ]; then
@@ -477,53 +488,49 @@ fi
 export PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
 export COMPOSE_HTTP_TIMEOUT="$dockerStartTimeout"
 
-
 ### start logging
 printf "%s[%s] --- Start %s execution ---%s\n" \
-    "$magenta" "$(stamp)" "$scriptName" "$norm" >> "$logFile"
+    "$magenta" "$(stamp)" "$scriptName" "$norm" >>"$logFile"
 printf "%s[%s] -- [INFO] Log located at %s%s%s --%s\n" \
-    "$cyan" "$(stamp)" "$yellow" "$logFile" "$cyan" "$norm" >> "$logFile"
-
+    "$cyan" "$(stamp)" "$yellow" "$logFile" "$cyan" "$norm" >>"$logFile"
 
 ### get location of docker volumes
 dockerVolumeMail=$(docker volume inspect -f '{{ .Mountpoint }}' ${COMPOSE_PROJECT_NAME}_vmail-vol-1)
 printf "%s[%s] -- [INFO] Using MAIL volume: %s --%s\n" \
-    "$cyan" "$(stamp)" "$dockerVolumeMail" "$norm" >> "$logFile"
+    "$cyan" "$(stamp)" "$dockerVolumeMail" "$norm" >>"$logFile"
 dockerVolumeRspamd=$(docker volume inspect -f '{{ .Mountpoint }}' ${COMPOSE_PROJECT_NAME}_rspamd-vol-1)
 printf "%s[%s] -- [INFO] Using RSPAMD volume: %s --%s\n" \
-    "$cyan" "$(stamp)" "$dockerVolumeRspamd" "$norm" >> "$logFile"
+    "$cyan" "$(stamp)" "$dockerVolumeRspamd" "$norm" >>"$logFile"
 dockerVolumePostfix=$(docker volume inspect -f '{{ .Mountpoint }}' ${COMPOSE_PROJECT_NAME}_postfix-vol-1)
 printf "%s[%s] -- [INFO] Using POSTFIX volume: %s --%s\n" \
-    "$cyan" "$(stamp)" "$dockerVolumePostfix" "$norm" >> "$logFile"
+    "$cyan" "$(stamp)" "$dockerVolumePostfix" "$norm" >>"$logFile"
 dockerVolumeRedis=$(docker volume inspect -f '{{ .Mountpoint }}' ${COMPOSE_PROJECT_NAME}_redis-vol-1)
 printf "%s[%s] -- [INFO] Using REDIS volume: %s --%s\n" \
-    "$cyan" "$(stamp)" "$dockerVolumeRedis" "$norm" >> "$logFile"
+    "$cyan" "$(stamp)" "$dockerVolumeRedis" "$norm" >>"$logFile"
 dockerVolumeCrypt=$(docker volume inspect -f '{{ .Mountpoint }}' ${COMPOSE_PROJECT_NAME}_crypt-vol-1)
 printf "%s[%s] -- [INFO] Using MAILCRYPT volume: %s --%s\n" \
-    "$cyan" "$(stamp)" "$dockerVolumeCrypt" "$norm" >> "$logFile"
-
+    "$cyan" "$(stamp)" "$dockerVolumeCrypt" "$norm" >>"$logFile"
 
 ### read details file to get variables needed run borg
 # check if config details file was provided as a relative or absolute path
 case "${configDetails}" in
-    /*)
-        # absolute path, no need to rewrite variable
-        # shellcheck source=./backup.details
-        . "${configDetails}"
-        ;;
-    *)
-        # relative path, prepend './' to create absolute path
-        # shellcheck source=./backup.details
-        . "./${configDetails}"
-        ;;
+/*)
+    # absolute path, no need to rewrite variable
+    # shellcheck source=./backup.details
+    . "${configDetails}"
+    ;;
+*)
+    # relative path, prepend './' to create absolute path
+    # shellcheck source=./backup.details
+    . "./${configDetails}"
+    ;;
 esac
 printf "%s[%s] -- [INFO] %s%s%s imported --%s\n" \
-    "$cyan" "$(stamp)" "$yellow" "$configDetails" "$cyan" "$norm" >> "$logFile"
-
+    "$cyan" "$(stamp)" "$yellow" "$configDetails" "$cyan" "$norm" >>"$logFile"
 
 ### Run borg variable checks
 printf "%s[%s] -- [INFO] Verifying supplied borg details --%s\n" \
-    "$cyan" "$(stamp)" "$norm" >> "$logFile"
+    "$cyan" "$(stamp)" "$norm" >>"$logFile"
 
 ## verify borg base directory
 if [ -z "${borgBaseDir}" ]; then
@@ -532,7 +539,7 @@ elif [ ! -d "${borgBaseDir}" ]; then
     badDetails dne 'borgBaseDir'
 fi
 printf "%sdetails:borgBaseDir %s-- %s[OK]%s\n" \
-    "$magenta" "$norm" "$ok" "$norm" >> "$logFile"
+    "$magenta" "$norm" "$ok" "$norm" >>"$logFile"
 export BORG_BASE_DIR="${borgBaseDir%/}"
 
 ## check path to SSH keyfile
@@ -542,15 +549,15 @@ elif [ ! -f "${borgSSHKey}" ]; then
     badDetails dne 'borgSSHKey'
 fi
 printf "%sdetails:borgSSHKey %s-- %s[OK]%s\n" \
-    "$magenta" "$norm" "$ok" "$norm" >> "$logFile"
+    "$magenta" "$norm" "$ok" "$norm" >>"$logFile"
 ## check SSH port
 if [ -z "${borgSSHPort}" ]; then
     borgSSHPort=22
     printf "%sdetails:borgSSHPort %s-- %s[DEFAULT]%s\n" \
-        "$magenta" "$norm" "$ok" "$norm" >> "$logFile"
+        "$magenta" "$norm" "$ok" "$norm" >>"$logFile"
 else
     printf "%sdetails:borgSSHPort %s-- %s[CUSTOM]%s\n" \
-        "$magenta" "$norm" "$ok" "$norm" >> "$logFile"
+        "$magenta" "$norm" "$ok" "$norm" >>"$logFile"
 fi
 export BORG_RSH="ssh -i ${borgSSHKey} -p ${borgSSHPort}"
 
@@ -559,20 +566,20 @@ if [ -z "${borgConnectRepo}" ]; then
     badDetails empty 'borgConnectRepo'
 fi
 printf "%sdetails:borgConnectRepo %s-- %s[OK]%s\n" \
-    "$magenta" "$norm" "$ok" "$norm" >> "$logFile"
+    "$magenta" "$norm" "$ok" "$norm" >>"$logFile"
 export BORG_REPO="${borgConnectRepo}"
 
 ## check borg repo password
 if [ -n "${borgRepoPassphrase}" ]; then
     printf "%sdetails:borgRepoPassphrase %s-- %s[OK]%s\n" \
-    "$magenta" "$norm" "$ok" "$norm" >> "$logFile"
+        "$magenta" "$norm" "$ok" "$norm" >>"$logFile"
     export BORG_PASSPHRASE="${borgRepoPassphrase}"
 else
     # if passwd is blank intentionally, this is insecure
     printf "%s-- [WARNING] Using a borg repo without a password is an " \
-        "$warn" >> "$logFile"
-    printf "insecure configuration --%s\n" "$norm">> "$logFile"
-    warnCount=$((warnCount+1))
+        "$warn" >>"$logFile"
+    printf "insecure configuration --%s\n" "$norm" >>"$logFile"
+    warnCount=$((warnCount + 1))
     # if this was an accident, we need to provide a bogus passwd so borg fails
     # otherwise it will sit forever just waiting for input
     export BORG_PASSPHRASE="DummyPasswordSoBorgFails"
@@ -580,13 +587,13 @@ fi
 
 ## check borg repository keyfile location
 if [ -z "${borgKeyfileLocation}" ]; then
-    printf "%sdetails:borgKeyfileLocation %s-- %s[DEFAULT]%s\n" "$magenta" "$norm" "$ok" "$norm" >> "$logFile"
+    printf "%sdetails:borgKeyfileLocation %s-- %s[DEFAULT]%s\n" "$magenta" "$norm" "$ok" "$norm" >>"$logFile"
 else
     # check if keyfile location exists
     if [ ! -f "${borgKeyfileLocation}" ]; then
         badDetails dne 'borgKeyfileLocation'
     fi
-    printf "%sdetails:borgKeyfileLocation %s-- %s[OK]%s\n" "$magenta" "$norm" "$ok" "$norm" >> "$logFile"
+    printf "%sdetails:borgKeyfileLocation %s-- %s[OK]%s\n" "$magenta" "$norm" "$ok" "$norm" >>"$logFile"
     export BORG_KEY_FILE="${borgKeyfileLocation}"
 fi
 
@@ -599,7 +606,7 @@ if [ -n "${borgExcludeListPath}" ]; then
     if [ ! -f "${borgExcludeListPath}" ]; then
         badDetails dne 'borgExcludeListPath'
     fi
-exclusions=1
+    exclusions=1
 fi
 
 ## read additional files
@@ -618,25 +625,23 @@ else
             xtraList="${xtraList} ${xtraItem}"
         fi
     done <<EOF
-    $( sed -e '/^\s*#.*$/d' -e '/^\s*$/d' "${borgXtraListPath}" )
+    $(sed -e '/^\s*#.*$/d' -e '/^\s*$/d' "${borgXtraListPath}")
 EOF
-printf "%sdetails:borgXtraListPath %s-- %s[OK]%s\n" \
-    "$magenta" "$norm" "$ok" "$norm" >> "$logFile"
+    printf "%sdetails:borgXtraListPath %s-- %s[OK]%s\n" \
+        "$magenta" "$norm" "$ok" "$norm" >>"$logFile"
 fi
 
-
 ### set location of sql dump
 # this is done before resetting default TMP dir for borg
-if ! sqlDumpDir=$( mktemp -d 2>/dev/null ); then
+if ! sqlDumpDir=$(mktemp -d 2>/dev/null); then
     exitError 115 'Unable to create temp directory for SQL dump.'
 else
-    sqlDumpFile="backup-$( date +%Y%m%d_%H%M%S ).sql"
+    sqlDumpFile="backup-$(date +%Y%m%d_%H%M%S).sql"
     sqlDumpDirCreated=1
     printf "%s[%s] -- [INFO] SQL dump file will be stored at: %s --%s\n" \
-        "$cyan" "$(stamp)" "$sqlDumpDir/$sqlDumpFile" "$norm" >> "$logFile"
+        "$cyan" "$(stamp)" "$sqlDumpDir/$sqlDumpFile" "$norm" >>"$logFile"
 fi
 
-
 ### create borg temp dir:
 ## python requires a writable temporary directory when unpacking borg and
 ## executing commands.  This defaults to /tmp but many systems mount /tmp with
@@ -649,27 +654,25 @@ if [ ! -d "${borgBaseDir}/tmp" ]; then
         exitError 132 "Unable to create borg ${borgBaseDir}/tmp directory"
     else
         printf "%s[%s] -- [INFO] Created %s%s/tmp " \
-            "$cyan" "$(stamp)" "$yellow" "${borgBaseDir}" >> "$logFile"
-        printf "%s--%s\n" "$cyan" "$norm">> "$logFile"
+            "$cyan" "$(stamp)" "$yellow" "${borgBaseDir}" >>"$logFile"
+        printf "%s--%s\n" "$cyan" "$norm" >>"$logFile"
     fi
 fi
 export TMPDIR="${borgBaseDir}/tmp"
 
-
 ### 503 functionality
 if [ "$use503" -eq 1 ]; then
     printf "%s[%s] -- [INFO] Copying 503 error page to " \
-        "$cyan" "$(stamp)" >> "$logFile"
-    printf "webroot -- %s\n" "$norm">> "$logFile"
-    if ! \cp --force "${err503Path}" "${webroot}/${err503File}" 2>> "$logFile"
-        then
+        "$cyan" "$(stamp)" >>"$logFile"
+    printf "webroot -- %s\n" "$norm" >>"$logFile"
+    if ! \cp --force "${err503Path}" "${webroot}/${err503File}" 2>>"$logFile"; then
         printf "%s[%s] -- [WARNING] Failed to copy 503 error page. " \
-            "$warn" "$(stamp)" >> "$logFile"
-        printf "Web users will NOT be notified --%s\n" "$norm" >> "$logFile"
-        warnCount=$((warnCount+1))
+            "$warn" "$(stamp)" >>"$logFile"
+        printf "Web users will NOT be notified --%s\n" "$norm" >>"$logFile"
+        warnCount=$((warnCount + 1))
     else
         printf "%s[%s] -- [SUCCESS] 503 error page copied --%s\n" \
-            "$ok" "$(stamp)" "$norm" >> "$logFile"
+            "$ok" "$(stamp)" "$norm" >>"$logFile"
         # set cleanup flag
         err503Copied=1
     fi
@@ -682,33 +685,31 @@ fi
 doDocker stop postfix
 if [ "$dockerResultState" = "false" ] && [ "$dockerResultExit" -eq 0 ]; then
     printf "%s[%s] -- [INFO] POSTFIX container stopped --%s\n" \
-        "$cyan" "$(stamp)" "$norm" >> "$logFile"
+        "$cyan" "$(stamp)" "$norm" >>"$logFile"
 else
     exitError 101 'Could not stop POSTFIX container.'
 fi
 doDocker stop dovecot
 if [ "$dockerResultState" = "false" ] && [ "$dockerResultExit" -eq 0 ]; then
     printf "%s[%s] -- [INFO] DOVECOT container stopped --%s\n" \
-        "$cyan" "$(stamp)" "$norm" >> "$logFile"
+        "$cyan" "$(stamp)" "$norm" >>"$logFile"
 else
     exitError 101 'Could not stop DOVECOT container.'
 fi
 
-
 ### dump SQL
 printf "%s[%s] -- [INFO] Dumping mailcow SQL database --%s\n" \
-    "$cyan" "$(stamp)" "$norm" >> "$logFile"
-docker-compose exec -T mysql-mailcow mysqldump --default-character-set=utf8mb4 \
-    -u${DBUSER} -p${DBPASS} ${DBNAME} > "$sqlDumpDir/$sqlDumpFile" 2>> "$logFile"
-dumpResult=$( docker-compose exec -T mysql-mailcow echo "$?" )
+    "$cyan" "$(stamp)" "$norm" >>"$logFile"
+${dockerCmd} exec -T mysql-mailcow mysqldump --default-character-set=utf8mb4 \
+    -u${DBUSER} -p${DBPASS} ${DBNAME} >"$sqlDumpDir/$sqlDumpFile" 2>>"$logFile"
+dumpResult=$(${dockerCmd} exec -T mysql-mailcow echo "$?")
 if [ "$dumpResult" -eq 0 ]; then
     printf "%s[%s] -- [INFO] SQL database dumped successfully --%s\n" \
-        "$cyan" "$(stamp)" "$norm" >> "$logFile"
+        "$cyan" "$(stamp)" "$norm" >>"$logFile"
 else
     exitError 118 'There was an error dumping the mailcow SQL database.'
 fi
 
-
 ### dump redis inside container
 # delete old redis dump if it exists
 if [ -f "$dockerVolumeRedis/dump.rdb" ]; then
@@ -716,19 +717,18 @@ if [ -f "$dockerVolumeRedis/dump.rdb" ]; then
 fi
 # dump redis
 printf "%s[%s] -- [INFO] Dumping mailcow redis database --%s\n" \
-    "$cyan" "$(stamp)" "$norm" >> "$logFile"
-docker-compose exec -T redis-mailcow redis-cli save >> "$logFile" 2>&1
-rdumpResult=$( docker-compose exec -T redis-mailcow echo "$?" )
+    "$cyan" "$(stamp)" "$norm" >>"$logFile"
+${dockerCmd} exec -T redis-mailcow redis-cli save >>"$logFile" 2>&1
+rdumpResult=$(${dockerCmd} exec -T redis-mailcow echo "$?")
 if [ "$rdumpResult" -eq 0 ]; then
     printf "%s[%s] -- [INFO] mailcow redis dumped successfully --%s\n" \
-        "$cyan" "$(stamp)" "$norm" >> "$logFile"
+        "$cyan" "$(stamp)" "$norm" >>"$logFile"
 else
     exitError 119 'There was an error dumping the mailcow redis database.'
 fi
 
-
 ### execute borg depending on whether exclusions are defined
-printf "%s[%s] -- [INFO] Pre-backup tasks completed, calling borgbackup --%s\n" "$cyan" "$(stamp)" "$norm" >> "$logFile"
+printf "%s[%s] -- [INFO] Pre-backup tasks completed, calling borgbackup --%s\n" "$cyan" "$(stamp)" "$norm" >>"$logFile"
 
 ## construct the proper borg commandline
 # base command
@@ -759,96 +759,95 @@ fi
 
 # execute borg
 printf "%s[%s] -- [INFO] Executing borg backup operation --%s\n" \
-    "$cyan" "$(stamp)" "$norm" >> "$logFile"
-${borgCMD} 2>> "$logFile"
+    "$cyan" "$(stamp)" "$norm" >>"$logFile"
+${borgCMD} 2>>"$logFile"
 borgResult="$?"
 
 ## check borg exit status
 if [ "$borgResult" -eq 0 ]; then
     printf "%s[%s] -- [SUCCESS] Borg backup completed --%s\n" \
-        "$ok" "$(stamp)" "$norm" >> "$logFile"
+        "$ok" "$(stamp)" "$norm" >>"$logFile"
 elif [ "$borgResult" -eq 1 ]; then
     printf "%s[%s] -- [WARNING] Borg completed with warnings. " \
-        "$warn" "$(stamp)" >> "$logFile"
-    printf "Review this logfile for details --%s\n" "$norm">> "$logFile"
-    warnCount=$((warnCount+1))
+        "$warn" "$(stamp)" >>"$logFile"
+    printf "Review this logfile for details --%s\n" "$norm" >>"$logFile"
+    warnCount=$((warnCount + 1))
 elif [ "$borgResult" -ge 2 ]; then
     err_1="Borg exited with a critical error. Please review this log file"
     err_2="for details."
     exitError 138 "$err_1 $err_2"
 else
     printf "%s[%s] -- [WARNING] Borg exited with unknown return code. " \
-        "$warn" "$(stamp)" >> "$logFile"
-    printf "Review this logfile for details --%s\n" "$norm">> "$logFile"
-    warnCount=$((warnCount+1))
+        "$warn" "$(stamp)" >>"$logFile"
+    printf "Review this logfile for details --%s\n" "$norm" >>"$logFile"
+    warnCount=$((warnCount + 1))
 fi
 
-
-### execute borg prune if paramters are provided, otherwise skip with a warning
+### execute borg prune if parameters are provided, otherwise skip with a warning
 if [ -n "${borgPruneSettings}" ]; then
     printf "%s[%s] -- [INFO] Executing borg prune operation --%s\n" \
-        "$cyan" "$(stamp)" "$norm" >> "$logFile"
+        "$cyan" "$(stamp)" "$norm" >>"$logFile"
+    # shellcheck disable=SC2086
     "${borgPath}" prune --show-rc -v ${borgPruneParams} ${borgPruneSettings} \
-        2>> "$logFile"
+        2>>"$logFile"
     borgPruneResult="$?"
 else
     printf "%s[%s] -- [WARNING] No prune parameters provided. " \
-        "$warn" "$(stamp)" >> "$logFile"
+        "$warn" "$(stamp)" >>"$logFile"
     printf "Your archive will continue growing with each backup --%s\n" \
-        "$norm" >> "$logFile"
-    warnCount=$((warnCount+1))
+        "$norm" >>"$logFile"
+    warnCount=$((warnCount + 1))
 fi
 
 ## report on prune operation if executed
 if [ -n "${borgPruneResult}" ]; then
     if [ "${borgPruneResult}" -eq 0 ]; then
         printf "%s[%s] -- [SUCCESS] Borg prune completed --%s\n" \
-            "$ok" "$(stamp)" "$norm" >> "$logFile"
+            "$ok" "$(stamp)" "$norm" >>"$logFile"
     elif [ "$borgPruneResult" -eq 1 ]; then
         printf "%s[%s] -- [WARNING] Borg prune completed with warnings. " \
-        "$warn" "$(stamp)" >> "$logFile"
-        printf "Review this logfile for details --%s\n" "$norm" >> "$logFile"
-        warnCount=$((warnCount+1))
+            "$warn" "$(stamp)" >>"$logFile"
+        printf "Review this logfile for details --%s\n" "$norm" >>"$logFile"
+        warnCount=$((warnCount + 1))
     elif [ "$borgPruneResult" -ge 2 ]; then
         err_1="Borg prune exited with a critical error. Please review this"
         err_2="log file for details."
         exitError 139 "$err_1 $err_2"
     else
         printf "%s[%s] -- [WARNING] Borg prune exited with an unknown " \
-            "$warn" "$(stamp)" >> "$logFile"
+            "$warn" "$(stamp)" >>"$logFile"
         printf "return code. Review this logfile for details --%s\n" \
-            "$norm" >> "$logFile"
-        warnCount=$((warnCount+1))
+            "$norm" >>"$logFile"
+        warnCount=$((warnCount + 1))
     fi
 fi
 
-
 ### all processes successfully completed, cleanup and exit gracefully
 
 # note successful completion of borg commands
 printf "%s[%s] -- [SUCCESS] Backup operations completed --%s\n" \
-    "$ok" "$(stamp)" "$norm" >> "$logFile"
+    "$ok" "$(stamp)" "$norm" >>"$logFile"
 
 # cleanup
 cleanup
 
 # note complete success, tally warnings and exit
 printf "%s[%s] -- [SUCCESS] All processes completed --%s\n" \
-    "$ok" "$(stamp)" "$norm" >> "$logFile"
+    "$ok" "$(stamp)" "$norm" >>"$logFile"
 printf "%s[%s] --- %s execution completed ---%s\n" \
-    "$magenta" "$(stamp)" "$scriptName" "$norm" >> "$logFile"
+    "$magenta" "$(stamp)" "$scriptName" "$norm" >>"$logFile"
 if [ "$warnCount" -gt 0 ]; then
-    printf "%s%s warnings issued!%s\n" "$warn" "${warnCount}" "$norm" >> "$logFile"
+    printf "%s%s warnings issued!%s\n" "$warn" "${warnCount}" "$norm" >>"$logFile"
 else
-    printf "%s0 warnings issued.%s\n" "$ok" "$norm" >> "$logFile"
+    printf "%s0 warnings issued.%s\n" "$ok" "$norm" >>"$logFile"
 fi
 exit 0
 
-
 ### error codes
 # 1: parameter error
 # 2: not run as root
-# 3: borg not installed
+# 3: docker compose not installed or not functioning
+# 4: borg not installed
 # 99: TERM signal trapped
 # 100: could not change to mailcow-dockerized directory
 # 101: could not stop container(s)

backup/restore.sh

@@ -43,7 +43,7 @@ consoleError() {
 }
 
 exitError() {
-    printf "%s[%s] --- %s execution completed with error ---\n%s" "$err" "$(stamp)" "$scriptName" "$norm" >> "$logfile"
+    printf "%s[%s] --- %s execution completed with error ---\n%s" "$err" "$(stamp)" "$scriptName" "$norm" >>"$logfile"
     exit "$1"
 }
 
@@ -51,13 +51,13 @@ doRestore() {
     sourceFiles=$(find "${backupLocation}" -iname "${1}" -type d)
     if [ -n "$sourceFiles" ]; then
         if [ "$verbose" -eq 1 ]; then
-            if (! (cd "$sourceFiles/_data" && tar -cf - .) | (cd "${2}" && tar xvf -) >> "$logfile" ); then
+            if ( ! (cd "$sourceFiles/_data" && tar -cf - .) | (cd "${2}" && tar xvf -) >>"$logfile"); then
                 return 1
             else
                 return 0
             fi
         else
-            if (! (cd "$sourceFiles/_data" && tar -cf - .) | (cd "${2}" && tar xvf -) > /dev/null 2>&1 ); then
+            if ( ! (cd "$sourceFiles/_data" && tar -cf - .) | (cd "${2}" && tar xvf -) >/dev/null 2>&1); then
                 return 1
             else
                 return 0
@@ -146,35 +146,36 @@ textNewline() {
 }
 
 trapExit() {
-    printf "%s[%s] -- [ERROR] 99: Caught signal --%s\n" "$err" "$(stamp)" "$norm" >> "$logfile"
-    printf "%s[%s] --- %s execution terminated via signal ---\n%s" "$err" "$(stamp)" "$scriptName" "$norm" >> "$logfile"
+    printf "%s[%s] -- [ERROR] 99: Caught signal --%s\n" "$err" "$(stamp)" "$norm" >>"$logfile"
+    printf "%s[%s] --- %s execution terminated via signal ---\n%s" "$err" "$(stamp)" "$scriptName" "$norm" >>"$logfile"
     exit 99
 }
 
 writeLog() {
     if [ "$1" = "task" ]; then
-        printf "%s[%s] -- [INFO] %s... " "$info" "$(stamp)" "$2" >> "$logfile"
+        printf "%s[%s] -- [INFO] %s... " "$info" "$(stamp)" "$2" >>"$logfile"
     elif [ "$1" = "done" ]; then
         if [ -z "$2" ]; then
-            printf "%sdone%s --\n%s" "$ok" "$info" "$norm" >> "$logfile"
+            printf "%sdone%s --\n%s" "$ok" "$info" "$norm" >>"$logfile"
         elif [ "$2" = "error" ]; then
-            printf "%sERROR%s --\n%s" "$err" "$info" "$norm" >> "$logfile"
+            printf "%sERROR%s --\n%s" "$err" "$info" "$norm" >>"$logfile"
         elif [ "$2" = "warn" ]; then
-            printf "%swarning%s --\n%s" "$yellow" "$info" "$norm" >> "$logfile"
+            printf "%swarning%s --\n%s" "$yellow" "$info" "$norm" >>"$logfile"
         fi
     elif [ "$1" = "error" ]; then
-        printf "%s[%s] -- [ERROR] %s: %s --\n%s" "$err" "$(stamp)" "$2" "$3" "$norm" >> "$logfile"
+        printf "%s[%s] -- [ERROR] %s: %s --\n%s" "$err" "$(stamp)" "$2" "$3" "$norm" >>"$logfile"
     elif [ "$1" = "warn" ]; then
-        printf "%s[%s] -- [WARNING] %s --\n%s" "$yellow" "$(stamp)" "$2" "$norm" >> "$logfile"
+        printf "%s[%s] -- [WARNING] %s --\n%s" "$yellow" "$(stamp)" "$2" "$norm" >>"$logfile"
     elif [ "$1" = "info" ]; then
-        printf "%s[%s] -- [INFO] %s --\n%s" "$info" "$(stamp)" "$2" "$norm" >> "$logfile"
+        printf "%s[%s] -- [INFO] %s --\n%s" "$info" "$(stamp)" "$2" "$norm" >>"$logfile"
     elif [ "$1" = "success" ]; then
-        printf "%s[%s] -- [SUCCESS] %s --\n%s" "$ok" "$(stamp)" "$2" "$norm" >> "$logfile"
+        printf "%s[%s] -- [SUCCESS] %s --\n%s" "$ok" "$(stamp)" "$2" "$norm" >>"$logfile"
     fi
 }
 
 ### parameter defaults
 # script related
+scriptVersion="4.0"
 scriptPath="$(CDPATH='' cd -- "$(dirname -- "$0")" && pwd -P)"
 scriptName="$(basename "$0")"
 errorCount=0
@@ -195,6 +196,7 @@ mcDockerCompose='/opt/mailcow-dockerized/docker-compose.yml'
 sqlRunning=0
 dockerStartTimeout=180
 dockerStopTimeout=120
+dockerCmd="docker compose"
 
 ### check if user is root
 if [ "$(id -u)" -ne 0 ]; then
@@ -204,11 +206,16 @@ fi
 ### process startup parameters
 while [ $# -gt 0 ]; do
     case "$1" in
-    -h|-\?|--help)
+    -h | -\? | --help)
         # display help
         scriptHelp
         ;;
-    -l|--log)
+    --version)
+        # display script version
+        printf "\nMailcowRestore - Restore Mailcow from a borgbackup repo : Version %s\n\n" ${scriptVersion}
+        exit 0
+        ;;
+    -l | --log)
         # set logfile location
         if [ -z "$2" ]; then
             consoleError '1' "Log file path cannot be null. Leave unspecified to save log in the same directory as this script."
@@ -216,10 +223,10 @@ while [ $# -gt 0 ]; do
         logfile="$2"
         shift
         ;;
-    -v|--verbose)
+    -v | --verbose)
         verbose=1
         ;;
-    -d|--docker-compose)
+    -d | --docker-compose)
         # FULL path to docker-compose file
         if [ -n "$2" ]; then
             if [ -f "$2" ]; then
@@ -232,8 +239,8 @@ while [ $# -gt 0 ]; do
             consoleError '1' "$1: cannot be blank/empty."
         fi
         ;;
-    -m|--mailcow-config)
-    # FULL path to mailcow configuration file file
+    -m | --mailcow-config)
+        # FULL path to mailcow configuration file file
         if [ -n "$2" ]; then
             if [ -f "$2" ]; then
                 mcConfig="$2"
@@ -245,7 +252,7 @@ while [ $# -gt 0 ]; do
             consoleError '1' "$1: cannot be blank/empty."
         fi
         ;;
-    -t1|--timeout-start)
+    -t1 | --timeout-start)
         if [ -z "$2" ]; then
             consoleError '1' "$1: cannot be blank/empty."
         else
@@ -253,7 +260,7 @@ while [ $# -gt 0 ]; do
             shift
         fi
         ;;
-    -t2|--timeout-stop)
+    -t2 | --timeout-stop)
         if [ -z "$2" ]; then
             consoleError '1' "$1: cannot be blank/empty."
         else
@@ -261,9 +268,9 @@ while [ $# -gt 0 ]; do
             shift
         fi
         ;;
-    -b|--backup-location)
+    -b | --backup-location)
         if [ -n "$2" ]; then
-            if [ -d "$2" ] && [ -n "$( ls -A "$2" )" ]; then
+            if [ -d "$2" ] && [ -n "$(ls -A "$2")" ]; then
                 backupLocation="${2%/}"
                 shift
             else
@@ -309,6 +316,14 @@ export PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
 if ! command -v docker >/dev/null; then
     consoleError '3' 'docker does not seem to be installed!'
 fi
+# verify compose installed and set proper commands based on version
+if ! (docker compose version >/dev/null 2>&1); then
+    if ! (docker-compose --version >/dev/null 2>&1); then
+        printf "\n%sERROR: Docker Compose not installed or not functioning%s\n\n" "$err" "$norm"
+        exit 3
+    fi
+    dockerCmd="docker-compose"
+fi
 # mailcow.conf?
 if [ ! -f "$mcConfig" ]; then
     consoleError '1' "mailcow configuration file ($mcConfig) cannot be found."
@@ -353,7 +368,7 @@ else
     fi
 fi
 # write initial log entries
-if ! printf "%s[%s] --- Start %s execution ---\n%s" "$magenta" "$(stamp)" "$scriptName" "$norm" 2>/dev/null >> "$logfile"; then
+if ! printf "%s[%s] --- Start %s execution ---\n%s" "$magenta" "$(stamp)" "$scriptName" "$norm" 2>/dev/null >>"$logfile"; then
     consoleError '1' "Unable to write to log file ($logfile)"
 fi
 writeLog 'info' "Log located at $logfile"
@@ -383,14 +398,14 @@ if [ "$restoreSQL" -eq 1 ]; then
     sqlBackup=$(find "${backupLocation}/tmp" -iname "*.sql")
     if [ -n "$sqlBackup" ]; then
         # start mysql container if not already running
-        if ! docker container inspect -f '{{ .State.Running }}' ${COMPOSE_PROJECT_NAME}_mysql-mailcow_1 > /dev/null 2>&1; then
-            docker-compose up -d mysql-mailcow > /dev/null 2>&1
-            if docker container inspect -f '{{ .State.Running }}' ${COMPOSE_PROJECT_NAME}_mysql-mailcow_1 > /dev/null 2>&1; then
+        if ! docker container inspect -f '{{ .State.Running }}' ${COMPOSE_PROJECT_NAME}_mysql-mailcow_1 >/dev/null 2>&1; then
+            ${dockerCmd} up -d mysql-mailcow >/dev/null 2>&1
+            if docker container inspect -f '{{ .State.Running }}' ${COMPOSE_PROJECT_NAME}_mysql-mailcow_1 >/dev/null 2>&1; then
                 sqlRunning=1
             else
                 writeLog 'done' 'error'
                 writeLog 'error' '12' "Cannot start mysql-mailcow container -- cannot restore mailcow database!"
-                errorCount=$((errorCount+1))
+                errorCount=$((errorCount + 1))
             fi
         else
             sqlRunning=1
@@ -398,29 +413,29 @@ if [ "$restoreSQL" -eq 1 ]; then
     else
         writeLog 'done' 'error'
         writeLog 'error' '11' "Cannot locate SQL backup -- cannot restore mailcow database!"
-        errorCount=$((errorCount+1))
+        errorCount=$((errorCount + 1))
     fi
 
     # restore sql
     if [ "$sqlRunning" -eq 1 ]; then
-        if docker exec -i "$(docker-compose ps -q mysql-mailcow)" mysql -u${DBUSER} -p${DBPASS} ${DBNAME} < "${sqlBackup}" > /dev/null 2>&1; then
+        if docker exec -i "$(${dockerCmd} ps -q mysql-mailcow)" mysql -u${DBUSER} -p${DBPASS} ${DBNAME} <"${sqlBackup}" >/dev/null 2>&1; then
             writeLog 'done'
         else
             writeLog 'done' 'error'
             writeLog 'error' '13' "Something went wrong while trying to restore SQL database. Perhaps try again?"
-            errorCount=$((errorCount+1))
+            errorCount=$((errorCount + 1))
         fi
     fi
 fi
 
 ### stop containers (necessary for all restore operations except SQL)
 writeLog 'task' "Stopping mailcow"
-if ! docker-compose down --timeout "${dockerStopTimeout}" > /dev/null 2>&1; then
+if ! ${dockerCmd} down --timeout "${dockerStopTimeout}" >/dev/null 2>&1; then
     writeLog 'done' 'error'
     writeLog 'error' '20' "Unable to bring mailcow containers down -- cannot reliably restore. Aborting."
     exitError 20
 fi
-if [ "$( docker ps --filter "name=${COMPOSE_PROJECT_NAME}" -q | wc -l )" -gt 0 ]; then
+if [ "$(docker ps --filter "name=${COMPOSE_PROJECT_NAME}" -q | wc -l)" -gt 0 ]; then
     writeLog 'done' 'error'
     writeLog 'error' '20' "Unable to bring mailcow containers down -- cannot reliably restore. Aborting."
     exitError 20
@@ -436,59 +451,61 @@ if [ "$restoreMail" -eq 1 ]; then
     fi
 
     # restore email messages
-    doRestore "${COMPOSE_PROJECT_NAME}_vmail-vol-1" "$dockerVolumeMail"; ec="$?"
+    doRestore "${COMPOSE_PROJECT_NAME}_vmail-vol-1" "$dockerVolumeMail"
+    ec="$?"
     case "$ec" in
-        0)
-            if [ "$verbose" -eq 1 ]; then
-                writeLog 'success' "Email messages restored"
-            else
-                writeLog 'done'
-            fi
-            ;;
-        1)
-            if [ "$verbose" -eq 1 ]; then
-                writeLog 'error' '52' "There was an error restoring one or more email messages."
-            else
-                writeLog 'done' 'error'
-                writeLog 'error' '52' "There was an error restoring one or more email messages."
-            fi
-            ;;
-        2)
-            if [ "$verbose" -eq 1 ]; then
-                writeLog 'error' '51' "Cannot locate email message backups!"
-            else
-                writeLog 'done' 'error'
-                writeLog 'error' '51' "Cannot locate email message backups!"
-            fi
-            ;;
+    0)
+        if [ "$verbose" -eq 1 ]; then
+            writeLog 'success' "Email messages restored"
+        else
+            writeLog 'done'
+        fi
+        ;;
+    1)
+        if [ "$verbose" -eq 1 ]; then
+            writeLog 'error' '52' "There was an error restoring one or more email messages."
+        else
+            writeLog 'done' 'error'
+            writeLog 'error' '52' "There was an error restoring one or more email messages."
+        fi
+        ;;
+    2)
+        if [ "$verbose" -eq 1 ]; then
+            writeLog 'error' '51' "Cannot locate email message backups!"
+        else
+            writeLog 'done' 'error'
+            writeLog 'error' '51' "Cannot locate email message backups!"
+        fi
+        ;;
     esac
 
     # restore encryption key
-    doRestore "${COMPOSE_PROJECT_NAME}_crypt-vol-1" "$dockerVolumeCrypt"; ec="$?"
+    doRestore "${COMPOSE_PROJECT_NAME}_crypt-vol-1" "$dockerVolumeCrypt"
+    ec="$?"
     case "$ec" in
-        0)
-            if [ "$verbose" -eq 1 ]; then
-                writeLog 'success' "Encryption key restored"
-            else
-                writeLog 'done'
-            fi
-            ;;
-        1)
-            if [ "$verbose" -eq 1 ]; then
-                writeLog 'error' '52' "There was an error restoring the encryption key! Any restored messages are likely *not* readable!"
-            else
-                writeLog 'done' 'error'
-                writeLog 'error' '52' "There was an error restoring the encryption key! Any restored messages are likely *not* readable!"
-            fi
-            ;;
-        2)
-            if [ "$verbose" -eq 1 ]; then
-                writeLog 'error' '51' "Cannot locate encryption key backup!"
-            else
-                writeLog 'done' 'error'
-                writeLog 'error' '51' "Cannot locate encryption key backup!"
-            fi
-            ;;
+    0)
+        if [ "$verbose" -eq 1 ]; then
+            writeLog 'success' "Encryption key restored"
+        else
+            writeLog 'done'
+        fi
+        ;;
+    1)
+        if [ "$verbose" -eq 1 ]; then
+            writeLog 'error' '52' "There was an error restoring the encryption key! Any restored messages are likely *not* readable!"
+        else
+            writeLog 'done' 'error'
+            writeLog 'error' '52' "There was an error restoring the encryption key! Any restored messages are likely *not* readable!"
+        fi
+        ;;
+    2)
+        if [ "$verbose" -eq 1 ]; then
+            writeLog 'error' '51' "Cannot locate encryption key backup!"
+        else
+            writeLog 'done' 'error'
+            writeLog 'error' '51' "Cannot locate encryption key backup!"
+        fi
+        ;;
     esac
 fi
 
@@ -500,31 +517,32 @@ if [ "$restorePostfix" -eq 1 ]; then
         writeLog 'task' "Restoring postfix files"
     fi
 
-    doRestore "${COMPOSE_PROJECT_NAME}_postfix-vol-1" "$dockerVolumePostfix"; ec="$?"
+    doRestore "${COMPOSE_PROJECT_NAME}_postfix-vol-1" "$dockerVolumePostfix"
+    ec="$?"
     case "$ec" in
-        0)
-            if [ "$verbose" -eq 1 ]; then
-                writeLog 'success' "Postfix files restored"
-            else
-                writeLog 'done'
-            fi
-            ;;
-        1)
-            if [ "$verbose" -eq 1 ]; then
-                writeLog 'error' '52' "There was an error restoring one or more postfix files."
-            else
-                writeLog 'done' 'error'
-                writeLog 'error' '52' "There was an error restoring one or more postfix files."
-            fi
-            ;;
-        2)
-            if [ "$verbose" -eq 1 ]; then
-                writeLog 'error' '51' "Cannot locate postfix backups!"
-            else
-                writeLog 'done' 'error'
-                writeLog 'error' '51' "Cannot locate postfix backups!"
-            fi
-            ;;
+    0)
+        if [ "$verbose" -eq 1 ]; then
+            writeLog 'success' "Postfix files restored"
+        else
+            writeLog 'done'
+        fi
+        ;;
+    1)
+        if [ "$verbose" -eq 1 ]; then
+            writeLog 'error' '52' "There was an error restoring one or more postfix files."
+        else
+            writeLog 'done' 'error'
+            writeLog 'error' '52' "There was an error restoring one or more postfix files."
+        fi
+        ;;
+    2)
+        if [ "$verbose" -eq 1 ]; then
+            writeLog 'error' '51' "Cannot locate postfix backups!"
+        else
+            writeLog 'done' 'error'
+            writeLog 'error' '51' "Cannot locate postfix backups!"
+        fi
+        ;;
     esac
 fi
 
@@ -536,31 +554,32 @@ if [ "$restoreRspamd" -eq 1 ]; then
         writeLog 'task' "Restoring Rspamd files"
     fi
 
-    doRestore "${COMPOSE_PROJECT_NAME}_rspamd-vol-1" "$dockerVolumeRspamd"; ec="$?"
+    doRestore "${COMPOSE_PROJECT_NAME}_rspamd-vol-1" "$dockerVolumeRspamd"
+    ec="$?"
     case "$ec" in
-        0)
-            if [ "$verbose" -eq 1 ]; then
-                writeLog 'success' "Rspamd files restored"
-            else
-                writeLog 'done'
-            fi
-            ;;
-        1)
-            if [ "$verbose" -eq 1 ]; then
-                writeLog 'error' '52' "There was an error restoring one or more Rspamd files."
-            else
-                writeLog 'done' 'error'
-                writeLog 'error' '52' "There was an error restoring one or more Rspamd files."
-            fi
-            ;;
-        2)
-            if [ "$verbose" -eq 1 ]; then
-                writeLog 'error' '51' "Cannot locate Rspamd backups!"
-            else
-                writeLog 'done' 'error'
-                writeLog 'error' '51' "Cannot locate Rspamd backups!"
-            fi
-            ;;
+    0)
+        if [ "$verbose" -eq 1 ]; then
+            writeLog 'success' "Rspamd files restored"
+        else
+            writeLog 'done'
+        fi
+        ;;
+    1)
+        if [ "$verbose" -eq 1 ]; then
+            writeLog 'error' '52' "There was an error restoring one or more Rspamd files."
+        else
+            writeLog 'done' 'error'
+            writeLog 'error' '52' "There was an error restoring one or more Rspamd files."
+        fi
+        ;;
+    2)
+        if [ "$verbose" -eq 1 ]; then
+            writeLog 'error' '51' "Cannot locate Rspamd backups!"
+        else
+            writeLog 'done' 'error'
+            writeLog 'error' '51' "Cannot locate Rspamd backups!"
+        fi
+        ;;
     esac
 fi
 
@@ -572,54 +591,55 @@ if [ "$restoreRedis" -eq 1 ]; then
         writeLog 'task' "Restoring redis database"
     fi
 
-    doRestore "${COMPOSE_PROJECT_NAME}_redis-vol-1" "$dockerVolumeRedis"; ec="$?"
+    doRestore "${COMPOSE_PROJECT_NAME}_redis-vol-1" "$dockerVolumeRedis"
+    ec="$?"
     case "$ec" in
-        0)
-            if [ "$verbose" -eq 1 ]; then
-                writeLog 'success' "Redis database restored"
-            else
-                writeLog 'done'
-            fi
-            ;;
-        1)
-            if [ "$verbose" -eq 1 ]; then
-                writeLog 'error' '52' "There was an error restoring the redis database. This is usually *not* a serious issue."
-            else
-                writeLog 'done' 'error'
-                writeLog 'error' '52' "There was an error restoring the redis database. This is usually *not* a serious issue."
-            fi
-            ;;
-        2)
-            if [ "$verbose" -eq 1 ]; then
-                writeLog 'error' '51' "Cannot locate redis database backups!"
-            else
-                writeLog 'done' 'error'
-                writeLog 'error' '51' "Cannot locate redis database backups!"
-            fi
-            ;;
+    0)
+        if [ "$verbose" -eq 1 ]; then
+            writeLog 'success' "Redis database restored"
+        else
+            writeLog 'done'
+        fi
+        ;;
+    1)
+        if [ "$verbose" -eq 1 ]; then
+            writeLog 'error' '52' "There was an error restoring the redis database. This is usually *not* a serious issue."
+        else
+            writeLog 'done' 'error'
+            writeLog 'error' '52' "There was an error restoring the redis database. This is usually *not* a serious issue."
+        fi
+        ;;
+    2)
+        if [ "$verbose" -eq 1 ]; then
+            writeLog 'error' '51' "Cannot locate redis database backups!"
+        else
+            writeLog 'done' 'error'
+            writeLog 'error' '51' "Cannot locate redis database backups!"
+        fi
+        ;;
     esac
 fi
 
 ### restart mailcow
 writeLog 'task' "Starting mailcow"
-if ! docker-compose up -d > /dev/null 2>&1; then
+if ! ${dockerCmd} up -d >/dev/null 2>&1; then
     writeLog 'done' 'warn'
     writeLog 'warn' '21' "Unable to automatically start mailcow containers. Please attempt a manual start and note any errors."
-    warnCount=$((warnCount+1))
+    warnCount=$((warnCount + 1))
 fi
 writeLog 'done'
 
 ### exit gracefully
 if [ "$errorCount" -gt 0 ]; then
     # note non-terminating errors
-    printf "%s[%s] --- %s execution completed with %s error(s) ---\n%s" "$err" "$(stamp)" "$scriptName" "$errorCount" "$norm" >> "$logfile"
+    printf "%s[%s] --- %s execution completed with %s error(s) ---\n%s" "$err" "$(stamp)" "$scriptName" "$errorCount" "$norm" >>"$logfile"
     exit 98
 elif [ "$warnCount" -gt 0 ]; then
-    printf "%s[%s] --- %s execution completed with %s warning(s) ---\n%s" "$yellow" "$(stamp)" "$scriptName" "$warnCount" "$norm" >> "$logfile"
+    printf "%s[%s] --- %s execution completed with %s warning(s) ---\n%s" "$yellow" "$(stamp)" "$scriptName" "$warnCount" "$norm" >>"$logfile"
     exit 97
 else
     writeLog 'success' "All processes completed"
-    printf "%s[%s] --- %s execution completed ---\n%s" "$magenta" "$(stamp)" "$scriptName" "$norm" >> "$logfile"
+    printf "%s[%s] --- %s execution completed ---\n%s" "$magenta" "$(stamp)" "$scriptName" "$norm" >>"$logfile"
     exit 0
 fi