Compare commits
No commits in common. "main" and "MailcowBackupV3.0" have entirely different histories.
main
...
MailcowBac
48
.gitattributes
vendored
48
.gitattributes
vendored
@ -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 diff=markdown
|
||||
*.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
|
||||
*.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
|
||||
|
||||
# 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
|
||||
*.ps1 text eol=crlf
|
||||
|
||||
# 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
|
||||
|
||||
35
.gitignore
vendored
35
.gitignore
vendored
@ -1,27 +1,10 @@
|
||||
#
|
||||
# JetBrains exclusions
|
||||
#
|
||||
# ignore all vscode config files
|
||||
.vscode/*
|
||||
!.vscode/settings.json
|
||||
!.vscode/tasks.json
|
||||
!.vscode/launch.json
|
||||
!.vscode/extensions.json
|
||||
!.vscode/numbered-bookmarks.json
|
||||
|
||||
# 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
|
||||
# ignore all generated logfiles
|
||||
*.log
|
||||
|
||||
@ -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>
|
||||
@ -1,6 +1,6 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="UserContentModel">
|
||||
<component name="ContentModelUserStore">
|
||||
<attachedFolders />
|
||||
<explicitIncludes />
|
||||
<explicitExcludes />
|
||||
|
||||
7
.idea/.idea.MailcowBackup.dir/.idea/riderModule.iml
Normal file
7
.idea/.idea.MailcowBackup.dir/.idea/riderModule.iml
Normal file
@ -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>
|
||||
@ -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">
|
||||
<option name="RIGHT_MARGIN" value="50" />
|
||||
</inspection_tool>
|
||||
<inspection_tool class="SubjectLimit" enabled="true" level="ERROR" enabled_by_default="true" />
|
||||
</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>
|
||||
|
||||
3
.vscode/numbered-bookmarks.json
vendored
Normal file
3
.vscode/numbered-bookmarks.json
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
{
|
||||
"bookmarks": []
|
||||
}
|
||||
2
LICENSE
2
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
|
||||
|
||||
13
README.md
13
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
|
||||
|
||||
<!-- toc -->
|
||||
## Contents <!-- omit in 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.
|
||||
|
||||
@ -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
|
||||
# by default, the script will only backup your mailcow program directory
|
||||
# (e.g. /opt/mailcow-dockerized) and your mailcow data volumes. If you would
|
||||
# like additional files included (perhaps certificates, system configuration,
|
||||
# etc.) include those locations listed one item per line in the file below
|
||||
# REQUIRED: path to text file containing a list (one per line) of files/
|
||||
# directories to include in your backup. Since this is a generic backup script,
|
||||
# nothing is defined by default. Therefore, ONLY files specified in this file
|
||||
# will be backed up!
|
||||
# see repo wiki for more details
|
||||
borgXtraListPath="/scripts/backup/xtraLocations.borg"
|
||||
|
||||
|
||||
540
backup/backup.sh
540
backup/backup.sh
@ -8,8 +8,9 @@
|
||||
### 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)
|
||||
@ -31,9 +32,11 @@ else
|
||||
yellow=""
|
||||
fi
|
||||
|
||||
|
||||
### trap
|
||||
trap trapExit 1 2 3 6
|
||||
|
||||
|
||||
### functions
|
||||
|
||||
# bad configuration value passed in details file
|
||||
@ -70,74 +73,73 @@ 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.' '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"
|
||||
"$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"
|
||||
"$cyan" "$(stamp)" "$2" "$norm" >> "$logFile"
|
||||
docker-compose -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"
|
||||
${dockerCmd} -f "$mcDockerCompose" start "$2-mailcow" 2>>"$logFile"
|
||||
"$cyan" "$(stamp)" "$2" "$norm" >> "$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
|
||||
}
|
||||
|
||||
# call cleanup and then exit with error report
|
||||
exitError() {
|
||||
printf "%s[%s] -- [ERROR] %s: %s --%s\n" \
|
||||
"$err" "$(stamp)" "$1" "$2" "$norm" >>"$logFile"
|
||||
if [ ! "$3" = "final" ]; then cleanup; fi
|
||||
"$err" "$(stamp)" "$1" "$2" "$norm" >> "$logFile"
|
||||
cleanup
|
||||
# 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"
|
||||
}
|
||||
|
||||
@ -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
|
||||
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
|
||||
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"
|
||||
@ -240,33 +233,30 @@ 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'
|
||||
scriptVersion="4.0"
|
||||
scriptPath="$(CDPATH='' \cd -- "$(dirname -- "$0")" && pwd -P)"
|
||||
scriptName="$(basename "$0")"
|
||||
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,172 +273,148 @@ 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
|
||||
;;
|
||||
--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%/}"
|
||||
-h|-\?|--help)
|
||||
# display help
|
||||
scriptHelp
|
||||
exit 0
|
||||
;;
|
||||
-l|--log)
|
||||
# set log file location
|
||||
if [ -n "$2" ]; then
|
||||
logFile="${2%/}"
|
||||
shift
|
||||
else
|
||||
badParam dne "$@"
|
||||
badParam empty "$@"
|
||||
fi
|
||||
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##*/}"
|
||||
;;
|
||||
-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"
|
||||
shift
|
||||
else
|
||||
badParam dne "$@"
|
||||
badParam empty "$@"
|
||||
fi
|
||||
else
|
||||
badParam empty "$@"
|
||||
fi
|
||||
;;
|
||||
-w | --webroot)
|
||||
# path to webroot (copy 503)
|
||||
if [ -n "$2" ]; then
|
||||
if [ -d "$2" ]; then
|
||||
webroot="${2%/}"
|
||||
shift
|
||||
;;
|
||||
-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 dne "$@"
|
||||
badParam empty "$@"
|
||||
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
|
||||
;;
|
||||
-w|--webroot)
|
||||
# path to webroot (copy 503)
|
||||
if [ -n "$2" ]; then
|
||||
if [ -d "$2" ]; then
|
||||
webroot="${2%/}"
|
||||
shift
|
||||
else
|
||||
badParam dne "$@"
|
||||
fi
|
||||
else
|
||||
badParam dne "$@"
|
||||
badParam empty "$@"
|
||||
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
|
||||
;;
|
||||
-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 dne "$@"
|
||||
badParam empty "$@"
|
||||
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
|
||||
;;
|
||||
;;
|
||||
-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
|
||||
printf "\n%sERROR: BORG cannot be found in the specified or default location on this system!%s\n\n" "$err" "$norm"
|
||||
exit 4
|
||||
if ! command -v borg > /dev/null; then
|
||||
printf "\n%sERROR: BORG is not installed on this system!%s\n\n" "$err" "$norm"
|
||||
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,49 +443,53 @@ 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
|
||||
@ -539,7 +498,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
|
||||
@ -549,37 +508,28 @@ elif [ ! -f "${borgSSHKey}" ]; then
|
||||
badDetails dne 'borgSSHKey'
|
||||
fi
|
||||
printf "%sdetails:borgSSHKey %s-- %s[OK]%s\n" \
|
||||
"$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"
|
||||
else
|
||||
printf "%sdetails:borgSSHPort %s-- %s[CUSTOM]%s\n" \
|
||||
"$magenta" "$norm" "$ok" "$norm" >>"$logFile"
|
||||
fi
|
||||
export BORG_RSH="ssh -i ${borgSSHKey} -p ${borgSSHPort}"
|
||||
"$magenta" "$norm" "$ok" "$norm" >> "$logFile"
|
||||
export BORG_RSH="ssh -i ${borgSSHKey}"
|
||||
|
||||
## check borg repo connect string
|
||||
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"
|
||||
@ -587,26 +537,26 @@ 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
|
||||
|
||||
## 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
|
||||
badDetails dne 'borgExcludeListPath'
|
||||
fi
|
||||
exclusions=1
|
||||
exclusions=1
|
||||
fi
|
||||
|
||||
## read additional files
|
||||
@ -625,23 +575,25 @@ 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
|
||||
@ -654,25 +606,27 @@ 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
|
||||
@ -685,31 +639,33 @@ 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"
|
||||
${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 "$?")
|
||||
"$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 "$?" )
|
||||
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
|
||||
@ -717,23 +673,24 @@ if [ -f "$dockerVolumeRedis/dump.rdb" ]; then
|
||||
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
|
||||
rdumpResult=$(${dockerCmd} exec -T redis-mailcow echo "$?")
|
||||
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
||||
docker-compose exec -T redis-mailcow redis-cli save >> "$logFile" 2>&1
|
||||
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"
|
||||
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%/*} \
|
||||
@ -759,95 +716,96 @@ 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 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
|
||||
"${borgPath}" prune --show-rc -v ${borgPruneParams} ${borgPruneSettings} \
|
||||
2>>"$logFile"
|
||||
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
||||
borg prune --show-rc -v ${borgPruneParams} ${borgPruneSettings} \
|
||||
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: docker compose not installed or not functioning
|
||||
# 4: borg not installed
|
||||
# 3: borg not installed
|
||||
# 99: TERM signal trapped
|
||||
# 100: could not change to mailcow-dockerized directory
|
||||
# 101: could not stop container(s)
|
||||
|
||||
@ -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,36 +146,35 @@ 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
|
||||
@ -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
|
||||
@ -206,16 +204,11 @@ fi
|
||||
### process startup parameters
|
||||
while [ $# -gt 0 ]; do
|
||||
case "$1" in
|
||||
-h | -\? | --help)
|
||||
-h|-\?|--help)
|
||||
# display help
|
||||
scriptHelp
|
||||
;;
|
||||
--version)
|
||||
# display script version
|
||||
printf "\nMailcowRestore - Restore Mailcow from a borgbackup repo : Version %s\n\n" ${scriptVersion}
|
||||
exit 0
|
||||
;;
|
||||
-l | --log)
|
||||
-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."
|
||||
@ -223,10 +216,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
|
||||
@ -239,8 +232,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"
|
||||
@ -252,7 +245,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
|
||||
@ -260,7 +253,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
|
||||
@ -268,9 +261,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
|
||||
@ -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."
|
||||
@ -368,7 +353,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"
|
||||
@ -398,14 +383,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
|
||||
${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
|
||||
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
|
||||
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
|
||||
@ -413,29 +398,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 "$(${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'
|
||||
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 ! ${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
|
||||
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
|
||||
@ -451,61 +436,59 @@ 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
|
||||
|
||||
@ -517,32 +500,31 @@ 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
|
||||
|
||||
@ -554,32 +536,31 @@ 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
|
||||
|
||||
@ -591,55 +572,54 @@ 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 ! ${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))
|
||||
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
|
||||
|
||||
|
||||
@ -49,12 +49,12 @@
|
||||
# include the paths to important configuration files/directories and/or
|
||||
# data directories
|
||||
|
||||
# mailcow configuration
|
||||
# already backed-up by the script by default based on mailcow.conf location
|
||||
# mailcow configuration (example)
|
||||
/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/
|
||||
|
||||
@ -3,8 +3,8 @@
|
||||
#############################################################################
|
||||
# $Id$
|
||||
#############################################################################
|
||||
# Log: mailcow backup
|
||||
# Revision 1.1 2019/07/20
|
||||
# Log: Backup script (backup)
|
||||
# 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++;
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user