.gitattributes

@@ -20,7 +20,7 @@
 *.PDF           diff=astextplain
 *.rtf           diff=astextplain
 *.RTF	        diff=astextplain
-*.md       text diff=markdown
+*.md       text
 *.tex      text diff=tex
 *.adoc     text
 *.textile  text
@@ -30,7 +30,6 @@
 *.tsv      text
 *.txt      text
 *.sql      text
-*.ps1      text eol=crlf
 
 # Graphics
 *.png      binary
@@ -49,28 +48,11 @@
 
 # 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
@@ -83,18 +65,12 @@
 *.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,27 +1,10 @@
-#
+# ignore all vscode config files
-# JetBrains exclusions
+.vscode/*
-#
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/numbered-bookmarks.json
 
-# User-specific stuff
+# ignore all generated logfiles
-.idea/**/workspace.xml
+*.log
-.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

@@ -1,15 +0,0 @@
-<?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="UserContentModel">
+  <component name="ContentModelUserStore">
     <attachedFolders />
     <explicitIncludes />
     <explicitExcludes />

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

@@ -0,0 +1,7 @@
+<?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,19 +4,9 @@
     <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="WARNING" enabled_by_default="true">
+      <inspection_tool class="SubjectLimit" enabled="true" level="ERROR" 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

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

LICENSE

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

README.md

@@ -1,4 +1,4 @@
-# Mailcow Backup Using borgbackup
+# Mailcow Backup Using borgbackup <!-- omit in toc -->
 
 This script automates backing up your Mailcow installation using borgbackup and a remote ssh-capable storage system.  I suggest using rsync.net since they
 have great speeds and a special pricing structure for borgbackup/attic users ([details here](https://www.rsync.net/products/attic.html)).
@@ -14,19 +14,14 @@ # Mailcow Backup Using borgbackup
 - Runs 'borg prune' to make sure you are trimming old backups on your schedule
 - Creates a clear, easy to parse log file so you can keep an eye on your backups and any errors/warnings
 
-## contents
+## Contents <!-- omit in toc -->
-
-<!-- toc -->
 
 - [quick start](#quick-start)
 - [configuration file](#configuration-file)
 - [running the script](#running-the-script)
 - [scheduling your backup via cron](#scheduling-your-backup-via-cron)
-- [restoring backups](#restoring-backups)
 - [final notes](#final-notes)
 
-<!-- tocstop -->
-
 ## quick start
 
 Clone this repo or download a release file into a directory of your choosing. For all examples in this document, I will assume you will run the script from */scripts/backup*. Make sure the script file is executable and you protect the *.details* file since it contains things like your repo password:
@@ -116,10 +111,6 @@ ## scheduling your backup via cron
 7 1 * * * /scripts/backup/backup.sh -l /var/log/mailcow_backup.log > /dev/null 2>&1
 ```
 
-## restoring backups
-
-Starting with version 3.0, a *restore.sh* file has been included to semi-automate restoring your backups to a clean mailcow instance. There are a few steps required and they are better explained in the wiki than would be possible in a short write-up like this. Please check out the [restore process overview](https://git.asifbacchus.app/asif/MailcowBackup/wiki/8.0-Restore-overview) for more information.
-
 ## final notes
 
 I think that's everything. For detailed information, please review the [wiki](https://git.asifbacchus.app/asif/MailcowBackup/wiki/_pages). If I've forgotten to document something there, please let me know. I know the wiki is long but, I hate how much stuff for Linux and open-source programs/scripts in general are so poorly documented especially for newbies and I didn't want to make that same mistake.

backup/backup.details

@@ -20,11 +20,6 @@
 # default is "$HOME" or "~$USER" in that order.  If you're unsure, try "$HOME"
 borgBaseDir="/var/borgbackup"
 
-# 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"
 
@@ -41,13 +36,12 @@ borgRepoPassphrase="p@ssW0rd"
 # FULL PATH where the associated keyfile for your repo is located -- relevant
 # only if your repo requires a keyfile (i.e. 'keyfile' vs 'repokey') and if you
 # are not using the default keyfile location
-#borgKeyfileLocation="/var/borgbackup/.config/borg/keys/server_address__repo_name"
+borgKeyfileLocation="/var/borgbackup/.config/borg/keys/server_address__repo_name"
 
-# additional files to backup
+# REQUIRED: path to text file containing a list (one per line) of files/
-# by default, the script will only backup your mailcow program directory
+# directories to include in your backup. Since this is a generic backup script,
-# (e.g. /opt/mailcow-dockerized) and your mailcow data volumes. If you would
+# nothing is defined by default. Therefore, ONLY files specified in this file
-# like additional files included (perhaps certificates, system configuration,
+# will be backed up!
-# etc.) include those locations listed one item per line in the file below
 # see repo wiki for more details
 borgXtraListPath="/scripts/backup/xtraLocations.borg"
 

backup/backup.sh

@@ -8,6 +8,7 @@
 ###     3. remote repo already set-up and configured
 #######
 
+
 ### text formatting presents
 if command -v tput > /dev/null; then
     bold=$(tput bold)
@@ -31,9 +32,11 @@ else
     yellow=""
 fi
 
+
 ### trap
 trap trapExit 1 2 3 6
 
+
 ### functions
 
 # bad configuration value passed in details file
@@ -70,7 +73,6 @@ 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"
@@ -99,34 +101,34 @@ cleanup() {
         printf "%s[%s] -- [INFO] POSTFIX container is running --%s\n" \
             "$cyan" "$(stamp)" "$norm" >> "$logFile"
     else
-        exitError 102 'Could not start POSTFIX container.' 'final'
+        exitError 102 'Could not start POSTFIX container.'
     fi
     doDocker start dovecot
     if [ "$dockerResultState" = "true" ]; then
         printf "%s[%s] -- [INFO] DOVECOT container is running --%s\n" \
             "$cyan" "$(stamp)" "$norm" >> "$logFile"
     else
-        exitError 102 'Could not start DOVECOT container.' 'final'
+        exitError 102 'Could not start DOVECOT container.'
     fi
 }
 
 doDocker() {
-    containerName="$(docker ps -a --format '{{ .Names }}' --filter "name=${COMPOSE_PROJECT_NAME}_${2}-mailcow_1" --filter "name=${COMPOSE_PROJECT_NAME}-${2}-mailcow-1")"
+    containerName="$( docker ps -a --format '{{ .Names }}' --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"
-        ${dockerCmd} -f "$mcDockerCompose" stop --timeout "$dockerStopTimeout" "$2-mailcow" 2>>"$logFile"
+        docker-compose -f "$mcDockerCompose" stop --timeout "$dockerStopTimeout" "$2-mailcow" 2>> "$logFile"
         # set result vars
-        dockerResultState="$(docker inspect -f '{{ .State.Running }}' "$containerName")"
+        dockerResultState="$( docker inspect -f '{{ .State.Running }}' $containerName )"
-        dockerResultExit="$(docker inspect -f '{{ .State.ExitCode }}' "$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"
-        ${dockerCmd} -f "$mcDockerCompose" start "$2-mailcow" 2>>"$logFile"
+        docker-compose -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
 }
 
@@ -134,7 +136,7 @@ doDocker() {
 exitError() {
     printf "%s[%s] -- [ERROR] %s: %s --%s\n" \
             "$err" "$(stamp)" "$1" "$2" "$norm" >> "$logFile"
-    if [ ! "$3" = "final" ]; then cleanup; fi
+    cleanup
     # note script completion with error
     printf "%s[%s] --- %s execution completed with error ---%s\n" \
         "$err" "$(stamp)" "$scriptName" "$norm" >> "$logFile"
@@ -145,17 +147,12 @@ 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 
+    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."
-    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
     textblock "${magenta}--- script related parameters ---${norm}"
     newline
-    switchTextblock "-b | --borg"
-    textblock "FULL path to borg executable file if not in the default location."
-    defaultsTextblock "(/usr/bin/borg)"
-    newline
     switchTextblock "-c | --config | --details"
     textblock "Path to the configuration key/value-pair file for this script."
     defaultsTextblock "(scriptPath/scriptName.details)"
@@ -167,10 +164,6 @@ scriptHelp() {
     textblock "Path to write log file"
     defaultsTextblock "(scriptPath/scriptName.log)"
     newline
-    switchTextblock "[SWITCH] --nc | --no-color | --no-colour"
-    textblock "Do NOT use ANSI colourization in the log file (in case your preferred log viewer does not support it)."
-    defaultsTextblock "(use ANSI colourization to make log file look good)"
-    newline
     switchTextblock "--compression"
     textblock "Compression algorithm(s) that borg should use. Please run 'borg help compression' for details."
     defaultsTextblock "(not specified, use borg default of lz4)"
@@ -196,7 +189,7 @@ scriptHelp() {
     textblock "${magenta}--- mailcow related ---${norm}"
     newline
     switchTextblock "-d | --docker-compose"
-    textblock "Path to the mailcow 'docker-compose.yml' file."
+    textblock "Path to mailcow's 'docker-compose.yml' file."
     defaultsTextblock "(/opt/mailcow-dockerized/docker-compose.yml)"
     newline
     switchTextblock "-m | --mailcow-config"
@@ -250,23 +243,20 @@ trapExit() {
 
 ### 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'
-scriptVersion="4.0"
+scriptPath="$( CDPATH='' cd -- "$( dirname -- "$0" )" && pwd -P )"
-scriptPath="$(CDPATH='' \cd -- "$(dirname -- "$0")" && pwd -P)"
 scriptName="$( basename "$0" )"
 logFile="$scriptPath/${scriptName%.*}.log"
-colourizeLogFile=1
 warnCount=0
 configDetails="$scriptPath/${scriptName%.*}.details"
 err503Copied=0
 sqlDumpDirCreated=0
 exclusions=0
-dockerCmd="docker compose"
-borgPath="/usr/bin/borg"
 # borg output verbosity -- normal
 borgCreateParams='--stats'
 borgPruneParams='--list'
@@ -283,6 +273,7 @@ mcDockerCompose="/opt/mailcow-dockerized/docker-compose.yml"
 dockerStartTimeout=180
 dockerStopTimeout=120
 
+
 ### process startup parameters
 while [ $# -gt 0 ]; do
     case "$1" in
@@ -291,11 +282,6 @@ while [ $# -gt 0 ]; do
             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
@@ -305,19 +291,6 @@ while [ $# -gt 0 ]; do
                 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
@@ -427,28 +400,21 @@ while [ $# -gt 0 ]; do
     shift
 done
 
+
 ### check pre-requisites and default values
 # check if running as root, otherwise exit
 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 ! command -v borg > /dev/null; then
-    printf "\n%sERROR: BORG cannot be found in the specified or default location on this system!%s\n\n" "$err" "$norm"
+    printf "\n%sERROR: BORG is not installed on this system!%s\n\n" "$err" "$norm"
-    exit 4
+    exit 3
 fi
 # if 503 functionality is enabled, do 503 related files exist?
 if [ "$use503" -eq 1 ]; then
@@ -470,17 +436,6 @@ fi
 if [ -n "$borgCompression" ]; then
     borgCreateParams="${borgCreateParams} --compression ${borgCompression}"
 fi
-# remove colourization if parameter specified
-if [ "$colourizeLogFile" -eq 0 ]; then
-    bold=""
-    cyan=""
-    err=""
-    magenta=""
-    norm=""
-    ok=""
-    warn=""
-    yellow=""
-fi
 
 ### read mailcow.conf and set vars as needed
 # shellcheck source=./mailcow.conf.shellcheck
@@ -488,12 +443,14 @@ 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"
 printf "%s[%s] -- [INFO] Log located at %s%s%s --%s\n" \
     "$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" \
@@ -511,6 +468,7 @@ dockerVolumeCrypt=$(docker volume inspect -f '{{ .Mountpoint }}' ${COMPOSE_PROJE
 printf "%s[%s] -- [INFO] Using MAILCRYPT volume: %s --%s\n" \
     "$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
@@ -528,6 +486,7 @@ esac
 printf "%s[%s] -- [INFO] %s%s%s imported --%s\n" \
     "$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"
@@ -550,16 +509,7 @@ elif [ ! -f "${borgSSHKey}" ]; then
 fi
 printf "%sdetails:borgSSHKey %s-- %s[OK]%s\n" \
     "$magenta" "$norm" "$ok" "$norm" >> "$logFile"
-## check SSH port
+export BORG_RSH="ssh -i ${borgSSHKey}"
-if [ -z "${borgSSHPort}" ]; then
-    borgSSHPort=22
-    printf "%sdetails:borgSSHPort %s-- %s[DEFAULT]%s\n" \
-        "$magenta" "$norm" "$ok" "$norm" >>"$logFile"
-else
-    printf "%sdetails:borgSSHPort %s-- %s[CUSTOM]%s\n" \
-        "$magenta" "$norm" "$ok" "$norm" >>"$logFile"
-fi
-export BORG_RSH="ssh -i ${borgSSHKey} -p ${borgSSHPort}"
 
 ## check borg repo connect string
 if [ -z "${borgConnectRepo}" ]; then
@@ -600,7 +550,7 @@ fi
 ## export borg remote path, if specified
 if [ -n "${borgRemote}" ]; then export BORG_REMOTE_PATH="${borgRemote}"; fi
 
-## check if exclusion list file is specified
+## check if exlusion list file is specified
 if [ -n "${borgExcludeListPath}" ]; then
     # check if the file actually exists
     if [ ! -f "${borgExcludeListPath}" ]; then
@@ -631,6 +581,7 @@ EOF
     "$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
@@ -642,6 +593,7 @@ else
         "$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
@@ -660,12 +612,14 @@ if [ ! -d "${borgBaseDir}/tmp" ]; then
 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
+    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"
@@ -697,19 +651,21 @@ 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"
-${dockerCmd} exec -T mysql-mailcow mysqldump --default-character-set=utf8mb4 \
+docker-compose 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 "$?")
+dumpResult=$( docker-compose 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
@@ -718,22 +674,23 @@ fi
 # dump redis
 printf "%s[%s] -- [INFO] Dumping mailcow redis database --%s\n" \
     "$cyan" "$(stamp)" "$norm" >> "$logFile"
-${dockerCmd} exec -T redis-mailcow redis-cli save >>"$logFile" 2>&1
+docker-compose exec -T redis-mailcow redis-cli save >> "$logFile" 2>&1
-rdumpResult=$(${dockerCmd} exec -T redis-mailcow echo "$?")
+rdumpResult=$( docker-compose 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"
 
 ## construct the proper borg commandline
 # base command
 if [ "$exclusions" -eq 0 ]; then
-    borgCMD="${borgPath} create --show-rc ${borgCreateParams} \
+    borgCMD="borg --show-rc create ${borgCreateParams} \
         ::$(date +%Y-%m-%d_%H%M%S) \
         ${mcConfig%/*} \
         ${sqlDumpDir} \
@@ -744,7 +701,7 @@ if [ "$exclusions" -eq 0 ]; then
         ${dockerVolumeCrypt} \
         ${xtraList}"
 elif [ "$exclusions" -eq 1 ]; then
-    borgCMD="${borgPath} create --show-rc ${borgCreateParams} \
+    borgCMD="borg --show-rc create ${borgCreateParams} \
         --exclude-from ${borgExcludeListPath} \
         ::$(date +%Y-%m-%d_%H%M%S) \
         ${mcConfig%/*} \
@@ -783,12 +740,12 @@ else
     warnCount=$((warnCount+1))
 fi
 
-### execute borg prune if parameters are provided, otherwise skip with a warning
+
+### execute borg prune if paramters 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"
-    # shellcheck disable=SC2086
+    borg prune --show-rc -v ${borgPruneParams} ${borgPruneSettings} \
-    "${borgPath}" prune --show-rc -v ${borgPruneParams} ${borgPruneSettings} \
         2>> "$logFile"
     borgPruneResult="$?"
 else
@@ -822,6 +779,7 @@ if [ -n "${borgPruneResult}" ]; then
     fi
 fi
 
+
 ### all processes successfully completed, cleanup and exit gracefully
 
 # note successful completion of borg commands
@@ -843,11 +801,11 @@ else
 fi
 exit 0
 
+
 ### error codes
 # 1: parameter error
 # 2: not run as root
-# 3: docker compose not installed or not functioning
+# 3: borg not installed
-# 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

@@ -175,7 +175,6 @@ writeLog() {
 
 ### parameter defaults
 # script related
-scriptVersion="4.0"
 scriptPath="$(CDPATH='' cd -- "$(dirname -- "$0")" && pwd -P)"
 scriptName="$(basename "$0")"
 errorCount=0
@@ -196,7 +195,6 @@ 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
@@ -210,11 +208,6 @@ while [ $# -gt 0 ]; do
         # display help
         scriptHelp
         ;;
-    --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
@@ -316,14 +309,6 @@ 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."
@@ -399,7 +384,7 @@ if [ "$restoreSQL" -eq 1 ]; then
     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
-            ${dockerCmd} up -d mysql-mailcow >/dev/null 2>&1
+            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
                 sqlRunning=1
             else
@@ -418,7 +403,7 @@ if [ "$restoreSQL" -eq 1 ]; then
 
     # restore sql
     if [ "$sqlRunning" -eq 1 ]; then
-        if docker exec -i "$(${dockerCmd} ps -q mysql-mailcow)" mysql -u${DBUSER} -p${DBPASS} ${DBNAME} <"${sqlBackup}" >/dev/null 2>&1; then
+        if docker exec -i "$(docker-compose ps -q mysql-mailcow)" mysql -u${DBUSER} -p${DBPASS} ${DBNAME} < "${sqlBackup}" > /dev/null 2>&1; then
             writeLog 'done'
         else
             writeLog 'done' 'error'
@@ -430,7 +415,7 @@ fi
 
 ### stop containers (necessary for all restore operations except SQL)
 writeLog 'task' "Stopping mailcow"
-if ! ${dockerCmd} down --timeout "${dockerStopTimeout}" >/dev/null 2>&1; then
+if ! docker-compose 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
@@ -451,8 +436,7 @@ if [ "$restoreMail" -eq 1 ]; then
     fi
 
     # restore email messages
-    doRestore "${COMPOSE_PROJECT_NAME}_vmail-vol-1" "$dockerVolumeMail"
+    doRestore "${COMPOSE_PROJECT_NAME}_vmail-vol-1" "$dockerVolumeMail"; ec="$?"
-    ec="$?"
     case "$ec" in
         0)
             if [ "$verbose" -eq 1 ]; then
@@ -480,8 +464,7 @@ if [ "$restoreMail" -eq 1 ]; then
     esac
 
     # restore encryption key
-    doRestore "${COMPOSE_PROJECT_NAME}_crypt-vol-1" "$dockerVolumeCrypt"
+    doRestore "${COMPOSE_PROJECT_NAME}_crypt-vol-1" "$dockerVolumeCrypt"; ec="$?"
-    ec="$?"
     case "$ec" in
         0)
             if [ "$verbose" -eq 1 ]; then
@@ -517,8 +500,7 @@ if [ "$restorePostfix" -eq 1 ]; then
         writeLog 'task' "Restoring postfix files"
     fi
 
-    doRestore "${COMPOSE_PROJECT_NAME}_postfix-vol-1" "$dockerVolumePostfix"
+    doRestore "${COMPOSE_PROJECT_NAME}_postfix-vol-1" "$dockerVolumePostfix"; ec="$?"
-    ec="$?"
     case "$ec" in
         0)
             if [ "$verbose" -eq 1 ]; then
@@ -554,8 +536,7 @@ if [ "$restoreRspamd" -eq 1 ]; then
         writeLog 'task' "Restoring Rspamd files"
     fi
 
-    doRestore "${COMPOSE_PROJECT_NAME}_rspamd-vol-1" "$dockerVolumeRspamd"
+    doRestore "${COMPOSE_PROJECT_NAME}_rspamd-vol-1" "$dockerVolumeRspamd"; ec="$?"
-    ec="$?"
     case "$ec" in
         0)
             if [ "$verbose" -eq 1 ]; then
@@ -591,8 +572,7 @@ if [ "$restoreRedis" -eq 1 ]; then
         writeLog 'task' "Restoring redis database"
     fi
 
-    doRestore "${COMPOSE_PROJECT_NAME}_redis-vol-1" "$dockerVolumeRedis"
+    doRestore "${COMPOSE_PROJECT_NAME}_redis-vol-1" "$dockerVolumeRedis"; ec="$?"
-    ec="$?"
     case "$ec" in
         0)
             if [ "$verbose" -eq 1 ]; then
@@ -622,7 +602,7 @@ fi
 
 ### restart mailcow
 writeLog 'task' "Starting mailcow"
-if ! ${dockerCmd} up -d >/dev/null 2>&1; then
+if ! docker-compose 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))

backup/xtraLocations.borg

@@ -49,12 +49,12 @@
 # include the paths to important configuration files/directories and/or
 # data directories
 
-# mailcow configuration
+# mailcow configuration (example)
-# already backed-up by the script by default based on mailcow.conf location
+/opt/mailcow-dockerized/
 
-# NGINX (if this host is a reverse proxy, for example)
+# NGINX (example)
 /etc/nginx/
 /usr/share/nginx/html/
 
-# LetsEncrypt
+# LetsEncrypt (example)
 /etc/letsencrypt/

etc/logwatch/scripts/services/backup

@@ -3,8 +3,8 @@
 #############################################################################
 # $Id$
 #############################################################################
-# Log: mailcow backup
+# Log: Backup script (backup)
-# Revision 1.1  2019/07/20
+# Revision 1.0  2018/10/16
 # Written by Asif Bacchus
 #############################################################################
 
@@ -34,7 +34,7 @@ if ($detailLevel == 0) {
         elsif ($ThisLine =~ /\-- \[WARNING\] /) {
             $summaryWarn++;
         }
-        elsif ($ThisLine =~ /All processes completed/) {
+        elsif ($ThisLine =~ /All processes completed successfully/) {
             $summarySuccess++;
         }
     }