Compare commits
No commits in common. "main" and "MailcowBackupV3.5.1" have entirely different histories.
main
...
MailcowBac
28
.gitattributes
vendored
28
.gitattributes
vendored
@ -20,7 +20,7 @@
|
|||||||
*.PDF diff=astextplain
|
*.PDF diff=astextplain
|
||||||
*.rtf diff=astextplain
|
*.rtf diff=astextplain
|
||||||
*.RTF diff=astextplain
|
*.RTF diff=astextplain
|
||||||
*.md text diff=markdown
|
*.md text
|
||||||
*.tex text diff=tex
|
*.tex text diff=tex
|
||||||
*.adoc text
|
*.adoc text
|
||||||
*.textile text
|
*.textile text
|
||||||
@ -30,7 +30,6 @@
|
|||||||
*.tsv text
|
*.tsv text
|
||||||
*.txt text
|
*.txt text
|
||||||
*.sql text
|
*.sql text
|
||||||
*.ps1 text eol=crlf
|
|
||||||
|
|
||||||
# Graphics
|
# Graphics
|
||||||
*.png binary
|
*.png binary
|
||||||
@ -49,28 +48,11 @@
|
|||||||
|
|
||||||
# Scripts
|
# Scripts
|
||||||
*.bash text eol=lf
|
*.bash text eol=lf
|
||||||
*.fish text eol=lf
|
|
||||||
*.sh text eol=lf
|
*.sh text eol=lf
|
||||||
# These are explicitly windows files and should use crlf
|
# These are explicitly windows files and should use crlf
|
||||||
*.bat text eol=crlf
|
*.bat text eol=crlf
|
||||||
*.cmd 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
|
# Serialisation
|
||||||
*.json text
|
*.json text
|
||||||
@ -83,18 +65,12 @@
|
|||||||
*.7z binary
|
*.7z binary
|
||||||
*.gz binary
|
*.gz binary
|
||||||
*.tar binary
|
*.tar binary
|
||||||
*.tgz binary
|
|
||||||
*.zip binary
|
*.zip binary
|
||||||
|
|
||||||
# Text files where line endings should be preserved
|
|
||||||
*.patch -text
|
|
||||||
|
|
||||||
#
|
#
|
||||||
# Exclude files from exporting
|
# Exclude files from exporting
|
||||||
#
|
#
|
||||||
|
|
||||||
.gitattributes export-ignore
|
.gitattributes export-ignore
|
||||||
.gitignore export-ignore
|
.gitignore export-ignore
|
||||||
.gitkeep export-ignore
|
|
||||||
.idea export-ignore
|
|
||||||
.vscode export-ignore
|
.vscode export-ignore
|
||||||
|
35
.gitignore
vendored
35
.gitignore
vendored
@ -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
|
|
||||||
|
@ -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"?>
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
<project version="4">
|
<project version="4">
|
||||||
<component name="UserContentModel">
|
<component name="ContentModelUserStore">
|
||||||
<attachedFolders />
|
<attachedFolders />
|
||||||
<explicitIncludes />
|
<explicitIncludes />
|
||||||
<explicitExcludes />
|
<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">
|
<profile version="1.0">
|
||||||
<inspection_tool class="BodyLimit" enabled="true" level="ERROR" enabled_by_default="true" />
|
<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="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>
|
</profile>
|
||||||
</component>
|
</component>
|
||||||
<component name="GitSharedSettings">
|
|
||||||
<option name="FORCE_PUSH_PROHIBITED_PATTERNS">
|
|
||||||
<list>
|
|
||||||
<option value="master" />
|
|
||||||
<option value="main" />
|
|
||||||
</list>
|
|
||||||
</option>
|
|
||||||
</component>
|
|
||||||
<component name="VcsDirectoryMappings">
|
<component name="VcsDirectoryMappings">
|
||||||
<mapping directory="$PROJECT_DIR$" vcs="Git" />
|
<mapping directory="$PROJECT_DIR$" vcs="Git" />
|
||||||
</component>
|
</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
|
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
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
@ -8,6 +8,7 @@
|
|||||||
### 3. remote repo already set-up and configured
|
### 3. remote repo already set-up and configured
|
||||||
#######
|
#######
|
||||||
|
|
||||||
|
|
||||||
### text formatting presents
|
### text formatting presents
|
||||||
if command -v tput > /dev/null; then
|
if command -v tput > /dev/null; then
|
||||||
bold=$(tput bold)
|
bold=$(tput bold)
|
||||||
@ -31,9 +32,11 @@ else
|
|||||||
yellow=""
|
yellow=""
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
||||||
### trap
|
### trap
|
||||||
trap trapExit 1 2 3 6
|
trap trapExit 1 2 3 6
|
||||||
|
|
||||||
|
|
||||||
### functions
|
### functions
|
||||||
|
|
||||||
# bad configuration value passed in details file
|
# bad configuration value passed in details file
|
||||||
@ -70,7 +73,6 @@ badParam() {
|
|||||||
cleanup() {
|
cleanup() {
|
||||||
# cleanup 503 if copied
|
# cleanup 503 if copied
|
||||||
if [ "$err503Copied" -eq 1 ]; then
|
if [ "$err503Copied" -eq 1 ]; then
|
||||||
# shellcheck disable=SC2129
|
|
||||||
if ! rm -f "$webroot/$err503File" 2>>"$logFile"; then
|
if ! rm -f "$webroot/$err503File" 2>>"$logFile"; then
|
||||||
printf "%s[%s] -- [WARNING] Could not remove 503 error page." \
|
printf "%s[%s] -- [WARNING] Could not remove 503 error page." \
|
||||||
"$warn" "$(stamp)" >> "$logFile"
|
"$warn" "$(stamp)" >> "$logFile"
|
||||||
@ -99,34 +101,34 @@ cleanup() {
|
|||||||
printf "%s[%s] -- [INFO] POSTFIX container is running --%s\n" \
|
printf "%s[%s] -- [INFO] POSTFIX container is running --%s\n" \
|
||||||
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
||||||
else
|
else
|
||||||
exitError 102 'Could not start POSTFIX container.' 'final'
|
exitError 102 'Could not start POSTFIX container.'
|
||||||
fi
|
fi
|
||||||
doDocker start dovecot
|
doDocker start dovecot
|
||||||
if [ "$dockerResultState" = "true" ]; then
|
if [ "$dockerResultState" = "true" ]; then
|
||||||
printf "%s[%s] -- [INFO] DOVECOT container is running --%s\n" \
|
printf "%s[%s] -- [INFO] DOVECOT container is running --%s\n" \
|
||||||
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
||||||
else
|
else
|
||||||
exitError 102 'Could not start DOVECOT container.' 'final'
|
exitError 102 'Could not start DOVECOT container.'
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
doDocker() {
|
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
|
# determine action to take
|
||||||
if [ "$1" = "stop" ]; then
|
if [ "$1" = "stop" ]; then
|
||||||
printf "%s[%s] -- [INFO] Stopping %s-mailcow container --%s\n" \
|
printf "%s[%s] -- [INFO] Stopping %s-mailcow container --%s\n" \
|
||||||
"$cyan" "$(stamp)" "$2" "$norm" >> "$logFile"
|
"$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
|
# 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
|
elif [ "$1" = "start" ]; then
|
||||||
printf "%s[%s] -- [INFO] Starting %s-mailcow container --%s\n" \
|
printf "%s[%s] -- [INFO] Starting %s-mailcow container --%s\n" \
|
||||||
"$cyan" "$(stamp)" "$2" "$norm" >> "$logFile"
|
"$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
|
# set result vars
|
||||||
dockerResultState="$(docker inspect -f '{{ .State.Running }}' "$containerName")"
|
dockerResultState="$( docker inspect -f '{{ .State.Running }}' $containerName )"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -134,7 +136,7 @@ doDocker() {
|
|||||||
exitError() {
|
exitError() {
|
||||||
printf "%s[%s] -- [ERROR] %s: %s --%s\n" \
|
printf "%s[%s] -- [ERROR] %s: %s --%s\n" \
|
||||||
"$err" "$(stamp)" "$1" "$2" "$norm" >> "$logFile"
|
"$err" "$(stamp)" "$1" "$2" "$norm" >> "$logFile"
|
||||||
if [ ! "$3" = "final" ]; then cleanup; fi
|
cleanup
|
||||||
# note script completion with error
|
# note script completion with error
|
||||||
printf "%s[%s] --- %s execution completed with error ---%s\n" \
|
printf "%s[%s] --- %s execution completed with error ---%s\n" \
|
||||||
"$err" "$(stamp)" "$scriptName" "$norm" >> "$logFile"
|
"$err" "$(stamp)" "$scriptName" "$norm" >> "$logFile"
|
||||||
@ -145,8 +147,7 @@ exitError() {
|
|||||||
scriptHelp() {
|
scriptHelp() {
|
||||||
newline
|
newline
|
||||||
printf "%sUsage: %s [parameters]%s\n\n" "$bold" "$scriptName" "$norm"
|
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
|
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)."
|
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
|
newline
|
||||||
@ -196,7 +197,7 @@ scriptHelp() {
|
|||||||
textblock "${magenta}--- mailcow related ---${norm}"
|
textblock "${magenta}--- mailcow related ---${norm}"
|
||||||
newline
|
newline
|
||||||
switchTextblock "-d | --docker-compose"
|
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)"
|
defaultsTextblock "(/opt/mailcow-dockerized/docker-compose.yml)"
|
||||||
newline
|
newline
|
||||||
switchTextblock "-m | --mailcow-config"
|
switchTextblock "-m | --mailcow-config"
|
||||||
@ -250,12 +251,12 @@ trapExit() {
|
|||||||
|
|
||||||
### end of functions
|
### end of functions
|
||||||
|
|
||||||
|
|
||||||
### default variable values
|
### default variable values
|
||||||
|
|
||||||
## script related
|
## script related
|
||||||
# store logfile in the same directory as this script file using the same file
|
# store logfile in the same directory as this script file using the same file
|
||||||
# name as the script but with the extension '.log'
|
# 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" )"
|
scriptName="$( basename "$0" )"
|
||||||
logFile="$scriptPath/${scriptName%.*}.log"
|
logFile="$scriptPath/${scriptName%.*}.log"
|
||||||
@ -265,7 +266,6 @@ configDetails="$scriptPath/${scriptName%.*}.details"
|
|||||||
err503Copied=0
|
err503Copied=0
|
||||||
sqlDumpDirCreated=0
|
sqlDumpDirCreated=0
|
||||||
exclusions=0
|
exclusions=0
|
||||||
dockerCmd="docker compose"
|
|
||||||
borgPath="/usr/bin/borg"
|
borgPath="/usr/bin/borg"
|
||||||
# borg output verbosity -- normal
|
# borg output verbosity -- normal
|
||||||
borgCreateParams='--stats'
|
borgCreateParams='--stats'
|
||||||
@ -283,6 +283,7 @@ mcDockerCompose="/opt/mailcow-dockerized/docker-compose.yml"
|
|||||||
dockerStartTimeout=180
|
dockerStartTimeout=180
|
||||||
dockerStopTimeout=120
|
dockerStopTimeout=120
|
||||||
|
|
||||||
|
|
||||||
### process startup parameters
|
### process startup parameters
|
||||||
while [ $# -gt 0 ]; do
|
while [ $# -gt 0 ]; do
|
||||||
case "$1" in
|
case "$1" in
|
||||||
@ -291,11 +292,6 @@ while [ $# -gt 0 ]; do
|
|||||||
scriptHelp
|
scriptHelp
|
||||||
exit 0
|
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)
|
-l|--log)
|
||||||
# set log file location
|
# set log file location
|
||||||
if [ -n "$2" ]; then
|
if [ -n "$2" ]; then
|
||||||
@ -427,20 +423,13 @@ while [ $# -gt 0 ]; do
|
|||||||
shift
|
shift
|
||||||
done
|
done
|
||||||
|
|
||||||
|
|
||||||
### check pre-requisites and default values
|
### check pre-requisites and default values
|
||||||
# check if running as root, otherwise exit
|
# 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"
|
printf "\n%sERROR: script MUST be run as ROOT%s\n\n" "$err" "$norm"
|
||||||
exit 2
|
exit 2
|
||||||
fi
|
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?
|
# does the details file exist?
|
||||||
if [ ! -f "$configDetails" ]; then
|
if [ ! -f "$configDetails" ]; then
|
||||||
badParam dne "(--details default)" "$configDetails"
|
badParam dne "(--details default)" "$configDetails"
|
||||||
@ -448,7 +437,7 @@ fi
|
|||||||
# is borg installed?
|
# is borg installed?
|
||||||
if ! find "$borgPath" -type f -executable > /dev/null 2>&1; then
|
if ! find "$borgPath" -type f -executable > /dev/null 2>&1; then
|
||||||
printf "\n%sERROR: BORG cannot be found in the specified or default location on this system!%s\n\n" "$err" "$norm"
|
printf "\n%sERROR: BORG cannot be found in the specified or default location on this system!%s\n\n" "$err" "$norm"
|
||||||
exit 4
|
exit 3
|
||||||
fi
|
fi
|
||||||
# if 503 functionality is enabled, do 503 related files exist?
|
# if 503 functionality is enabled, do 503 related files exist?
|
||||||
if [ "$use503" -eq 1 ]; then
|
if [ "$use503" -eq 1 ]; then
|
||||||
@ -488,12 +477,14 @@ fi
|
|||||||
export PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
|
export PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
|
||||||
export COMPOSE_HTTP_TIMEOUT="$dockerStartTimeout"
|
export COMPOSE_HTTP_TIMEOUT="$dockerStartTimeout"
|
||||||
|
|
||||||
|
|
||||||
### start logging
|
### start logging
|
||||||
printf "%s[%s] --- Start %s execution ---%s\n" \
|
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" \
|
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
|
### get location of docker volumes
|
||||||
dockerVolumeMail=$(docker volume inspect -f '{{ .Mountpoint }}' ${COMPOSE_PROJECT_NAME}_vmail-vol-1)
|
dockerVolumeMail=$(docker volume inspect -f '{{ .Mountpoint }}' ${COMPOSE_PROJECT_NAME}_vmail-vol-1)
|
||||||
printf "%s[%s] -- [INFO] Using MAIL volume: %s --%s\n" \
|
printf "%s[%s] -- [INFO] Using MAIL volume: %s --%s\n" \
|
||||||
@ -511,6 +502,7 @@ dockerVolumeCrypt=$(docker volume inspect -f '{{ .Mountpoint }}' ${COMPOSE_PROJE
|
|||||||
printf "%s[%s] -- [INFO] Using MAILCRYPT volume: %s --%s\n" \
|
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
|
### read details file to get variables needed run borg
|
||||||
# check if config details file was provided as a relative or absolute path
|
# check if config details file was provided as a relative or absolute path
|
||||||
case "${configDetails}" in
|
case "${configDetails}" in
|
||||||
@ -528,6 +520,7 @@ esac
|
|||||||
printf "%s[%s] -- [INFO] %s%s%s imported --%s\n" \
|
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
|
### Run borg variable checks
|
||||||
printf "%s[%s] -- [INFO] Verifying supplied borg details --%s\n" \
|
printf "%s[%s] -- [INFO] Verifying supplied borg details --%s\n" \
|
||||||
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
||||||
@ -631,6 +624,7 @@ EOF
|
|||||||
"$magenta" "$norm" "$ok" "$norm" >> "$logFile"
|
"$magenta" "$norm" "$ok" "$norm" >> "$logFile"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
||||||
### set location of sql dump
|
### set location of sql dump
|
||||||
# this is done before resetting default TMP dir for borg
|
# 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
|
||||||
@ -642,6 +636,7 @@ else
|
|||||||
"$cyan" "$(stamp)" "$sqlDumpDir/$sqlDumpFile" "$norm" >> "$logFile"
|
"$cyan" "$(stamp)" "$sqlDumpDir/$sqlDumpFile" "$norm" >> "$logFile"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
||||||
### create borg temp dir:
|
### create borg temp dir:
|
||||||
## python requires a writable temporary directory when unpacking borg and
|
## python requires a writable temporary directory when unpacking borg and
|
||||||
## executing commands. This defaults to /tmp but many systems mount /tmp with
|
## executing commands. This defaults to /tmp but many systems mount /tmp with
|
||||||
@ -660,12 +655,14 @@ if [ ! -d "${borgBaseDir}/tmp" ]; then
|
|||||||
fi
|
fi
|
||||||
export TMPDIR="${borgBaseDir}/tmp"
|
export TMPDIR="${borgBaseDir}/tmp"
|
||||||
|
|
||||||
|
|
||||||
### 503 functionality
|
### 503 functionality
|
||||||
if [ "$use503" -eq 1 ]; then
|
if [ "$use503" -eq 1 ]; then
|
||||||
printf "%s[%s] -- [INFO] Copying 503 error page to " \
|
printf "%s[%s] -- [INFO] Copying 503 error page to " \
|
||||||
"$cyan" "$(stamp)" >> "$logFile"
|
"$cyan" "$(stamp)" >> "$logFile"
|
||||||
printf "webroot -- %s\n" "$norm">> "$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. " \
|
printf "%s[%s] -- [WARNING] Failed to copy 503 error page. " \
|
||||||
"$warn" "$(stamp)" >> "$logFile"
|
"$warn" "$(stamp)" >> "$logFile"
|
||||||
printf "Web users will NOT be notified --%s\n" "$norm" >> "$logFile"
|
printf "Web users will NOT be notified --%s\n" "$norm" >> "$logFile"
|
||||||
@ -697,12 +694,13 @@ else
|
|||||||
exitError 101 'Could not stop DOVECOT container.'
|
exitError 101 'Could not stop DOVECOT container.'
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
||||||
### dump SQL
|
### dump SQL
|
||||||
printf "%s[%s] -- [INFO] Dumping mailcow SQL database --%s\n" \
|
printf "%s[%s] -- [INFO] Dumping mailcow SQL database --%s\n" \
|
||||||
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
"$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"
|
-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
|
if [ "$dumpResult" -eq 0 ]; then
|
||||||
printf "%s[%s] -- [INFO] SQL database dumped successfully --%s\n" \
|
printf "%s[%s] -- [INFO] SQL database dumped successfully --%s\n" \
|
||||||
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
||||||
@ -710,6 +708,7 @@ else
|
|||||||
exitError 118 'There was an error dumping the mailcow SQL database.'
|
exitError 118 'There was an error dumping the mailcow SQL database.'
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
||||||
### dump redis inside container
|
### dump redis inside container
|
||||||
# delete old redis dump if it exists
|
# delete old redis dump if it exists
|
||||||
if [ -f "$dockerVolumeRedis/dump.rdb" ]; then
|
if [ -f "$dockerVolumeRedis/dump.rdb" ]; then
|
||||||
@ -718,8 +717,8 @@ fi
|
|||||||
# dump redis
|
# dump redis
|
||||||
printf "%s[%s] -- [INFO] Dumping mailcow redis database --%s\n" \
|
printf "%s[%s] -- [INFO] Dumping mailcow redis database --%s\n" \
|
||||||
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
"$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
|
if [ "$rdumpResult" -eq 0 ]; then
|
||||||
printf "%s[%s] -- [INFO] mailcow redis dumped successfully --%s\n" \
|
printf "%s[%s] -- [INFO] mailcow redis dumped successfully --%s\n" \
|
||||||
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
||||||
@ -727,6 +726,7 @@ else
|
|||||||
exitError 119 'There was an error dumping the mailcow redis database.'
|
exitError 119 'There was an error dumping the mailcow redis database.'
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
||||||
### execute borg depending on whether exclusions are defined
|
### 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"
|
||||||
|
|
||||||
@ -783,11 +783,11 @@ else
|
|||||||
warnCount=$((warnCount+1))
|
warnCount=$((warnCount+1))
|
||||||
fi
|
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
|
if [ -n "${borgPruneSettings}" ]; then
|
||||||
printf "%s[%s] -- [INFO] Executing borg prune operation --%s\n" \
|
printf "%s[%s] -- [INFO] Executing borg prune operation --%s\n" \
|
||||||
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
||||||
# shellcheck disable=SC2086
|
|
||||||
"${borgPath}" prune --show-rc -v ${borgPruneParams} ${borgPruneSettings} \
|
"${borgPath}" prune --show-rc -v ${borgPruneParams} ${borgPruneSettings} \
|
||||||
2>> "$logFile"
|
2>> "$logFile"
|
||||||
borgPruneResult="$?"
|
borgPruneResult="$?"
|
||||||
@ -822,6 +822,7 @@ if [ -n "${borgPruneResult}" ]; then
|
|||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
||||||
### all processes successfully completed, cleanup and exit gracefully
|
### all processes successfully completed, cleanup and exit gracefully
|
||||||
|
|
||||||
# note successful completion of borg commands
|
# note successful completion of borg commands
|
||||||
@ -843,11 +844,11 @@ else
|
|||||||
fi
|
fi
|
||||||
exit 0
|
exit 0
|
||||||
|
|
||||||
|
|
||||||
### error codes
|
### error codes
|
||||||
# 1: parameter error
|
# 1: parameter error
|
||||||
# 2: not run as root
|
# 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
|
# 99: TERM signal trapped
|
||||||
# 100: could not change to mailcow-dockerized directory
|
# 100: could not change to mailcow-dockerized directory
|
||||||
# 101: could not stop container(s)
|
# 101: could not stop container(s)
|
||||||
|
@ -175,7 +175,6 @@ writeLog() {
|
|||||||
|
|
||||||
### parameter defaults
|
### parameter defaults
|
||||||
# script related
|
# script related
|
||||||
scriptVersion="4.0"
|
|
||||||
scriptPath="$(CDPATH='' cd -- "$(dirname -- "$0")" && pwd -P)"
|
scriptPath="$(CDPATH='' cd -- "$(dirname -- "$0")" && pwd -P)"
|
||||||
scriptName="$(basename "$0")"
|
scriptName="$(basename "$0")"
|
||||||
errorCount=0
|
errorCount=0
|
||||||
@ -196,7 +195,6 @@ mcDockerCompose='/opt/mailcow-dockerized/docker-compose.yml'
|
|||||||
sqlRunning=0
|
sqlRunning=0
|
||||||
dockerStartTimeout=180
|
dockerStartTimeout=180
|
||||||
dockerStopTimeout=120
|
dockerStopTimeout=120
|
||||||
dockerCmd="docker compose"
|
|
||||||
|
|
||||||
### check if user is root
|
### check if user is root
|
||||||
if [ "$(id -u)" -ne 0 ]; then
|
if [ "$(id -u)" -ne 0 ]; then
|
||||||
@ -210,11 +208,6 @@ while [ $# -gt 0 ]; do
|
|||||||
# display help
|
# display help
|
||||||
scriptHelp
|
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
|
# set logfile location
|
||||||
if [ -z "$2" ]; then
|
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
|
if ! command -v docker >/dev/null; then
|
||||||
consoleError '3' 'docker does not seem to be installed!'
|
consoleError '3' 'docker does not seem to be installed!'
|
||||||
fi
|
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?
|
# mailcow.conf?
|
||||||
if [ ! -f "$mcConfig" ]; then
|
if [ ! -f "$mcConfig" ]; then
|
||||||
consoleError '1' "mailcow configuration file ($mcConfig) cannot be found."
|
consoleError '1' "mailcow configuration file ($mcConfig) cannot be found."
|
||||||
@ -399,7 +384,7 @@ if [ "$restoreSQL" -eq 1 ]; then
|
|||||||
if [ -n "$sqlBackup" ]; then
|
if [ -n "$sqlBackup" ]; then
|
||||||
# start mysql container if not already running
|
# 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
|
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
|
if docker container inspect -f '{{ .State.Running }}' ${COMPOSE_PROJECT_NAME}_mysql-mailcow_1 > /dev/null 2>&1; then
|
||||||
sqlRunning=1
|
sqlRunning=1
|
||||||
else
|
else
|
||||||
@ -418,7 +403,7 @@ if [ "$restoreSQL" -eq 1 ]; then
|
|||||||
|
|
||||||
# restore sql
|
# restore sql
|
||||||
if [ "$sqlRunning" -eq 1 ]; then
|
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'
|
writeLog 'done'
|
||||||
else
|
else
|
||||||
writeLog 'done' 'error'
|
writeLog 'done' 'error'
|
||||||
@ -430,7 +415,7 @@ fi
|
|||||||
|
|
||||||
### stop containers (necessary for all restore operations except SQL)
|
### stop containers (necessary for all restore operations except SQL)
|
||||||
writeLog 'task' "Stopping mailcow"
|
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 'done' 'error'
|
||||||
writeLog 'error' '20' "Unable to bring mailcow containers down -- cannot reliably restore. Aborting."
|
writeLog 'error' '20' "Unable to bring mailcow containers down -- cannot reliably restore. Aborting."
|
||||||
exitError 20
|
exitError 20
|
||||||
@ -451,8 +436,7 @@ if [ "$restoreMail" -eq 1 ]; then
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
# restore email messages
|
# restore email messages
|
||||||
doRestore "${COMPOSE_PROJECT_NAME}_vmail-vol-1" "$dockerVolumeMail"
|
doRestore "${COMPOSE_PROJECT_NAME}_vmail-vol-1" "$dockerVolumeMail"; ec="$?"
|
||||||
ec="$?"
|
|
||||||
case "$ec" in
|
case "$ec" in
|
||||||
0)
|
0)
|
||||||
if [ "$verbose" -eq 1 ]; then
|
if [ "$verbose" -eq 1 ]; then
|
||||||
@ -480,8 +464,7 @@ if [ "$restoreMail" -eq 1 ]; then
|
|||||||
esac
|
esac
|
||||||
|
|
||||||
# restore encryption key
|
# restore encryption key
|
||||||
doRestore "${COMPOSE_PROJECT_NAME}_crypt-vol-1" "$dockerVolumeCrypt"
|
doRestore "${COMPOSE_PROJECT_NAME}_crypt-vol-1" "$dockerVolumeCrypt"; ec="$?"
|
||||||
ec="$?"
|
|
||||||
case "$ec" in
|
case "$ec" in
|
||||||
0)
|
0)
|
||||||
if [ "$verbose" -eq 1 ]; then
|
if [ "$verbose" -eq 1 ]; then
|
||||||
@ -517,8 +500,7 @@ if [ "$restorePostfix" -eq 1 ]; then
|
|||||||
writeLog 'task' "Restoring postfix files"
|
writeLog 'task' "Restoring postfix files"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
doRestore "${COMPOSE_PROJECT_NAME}_postfix-vol-1" "$dockerVolumePostfix"
|
doRestore "${COMPOSE_PROJECT_NAME}_postfix-vol-1" "$dockerVolumePostfix"; ec="$?"
|
||||||
ec="$?"
|
|
||||||
case "$ec" in
|
case "$ec" in
|
||||||
0)
|
0)
|
||||||
if [ "$verbose" -eq 1 ]; then
|
if [ "$verbose" -eq 1 ]; then
|
||||||
@ -554,8 +536,7 @@ if [ "$restoreRspamd" -eq 1 ]; then
|
|||||||
writeLog 'task' "Restoring Rspamd files"
|
writeLog 'task' "Restoring Rspamd files"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
doRestore "${COMPOSE_PROJECT_NAME}_rspamd-vol-1" "$dockerVolumeRspamd"
|
doRestore "${COMPOSE_PROJECT_NAME}_rspamd-vol-1" "$dockerVolumeRspamd"; ec="$?"
|
||||||
ec="$?"
|
|
||||||
case "$ec" in
|
case "$ec" in
|
||||||
0)
|
0)
|
||||||
if [ "$verbose" -eq 1 ]; then
|
if [ "$verbose" -eq 1 ]; then
|
||||||
@ -591,8 +572,7 @@ if [ "$restoreRedis" -eq 1 ]; then
|
|||||||
writeLog 'task' "Restoring redis database"
|
writeLog 'task' "Restoring redis database"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
doRestore "${COMPOSE_PROJECT_NAME}_redis-vol-1" "$dockerVolumeRedis"
|
doRestore "${COMPOSE_PROJECT_NAME}_redis-vol-1" "$dockerVolumeRedis"; ec="$?"
|
||||||
ec="$?"
|
|
||||||
case "$ec" in
|
case "$ec" in
|
||||||
0)
|
0)
|
||||||
if [ "$verbose" -eq 1 ]; then
|
if [ "$verbose" -eq 1 ]; then
|
||||||
@ -622,7 +602,7 @@ fi
|
|||||||
|
|
||||||
### restart mailcow
|
### restart mailcow
|
||||||
writeLog 'task' "Starting 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 'done' 'warn'
|
||||||
writeLog 'warn' '21' "Unable to automatically start mailcow containers. Please attempt a manual start and note any errors."
|
writeLog 'warn' '21' "Unable to automatically start mailcow containers. Please attempt a manual start and note any errors."
|
||||||
warnCount=$((warnCount+1))
|
warnCount=$((warnCount+1))
|
||||||
|
Loading…
Reference in New Issue
Block a user