feature(version): add param to display version
- as per user request
This commit is contained in:
parent
1ac614ee60
commit
8d10a1a3b9
|
|
@ -0,0 +1,15 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="GitToolBoxProjectSettings">
|
||||
<option name="commitMessageIssueKeyValidationOverride">
|
||||
<BoolValueOverride>
|
||||
<option name="enabled" value="true" />
|
||||
</BoolValueOverride>
|
||||
</option>
|
||||
<option name="commitMessageValidationEnabledOverride">
|
||||
<BoolValueOverride>
|
||||
<option name="enabled" value="true" />
|
||||
</BoolValueOverride>
|
||||
</option>
|
||||
</component>
|
||||
</project>
|
||||
|
|
@ -8,7 +8,6 @@
|
|||
### 3. remote repo already set-up and configured
|
||||
#######
|
||||
|
||||
|
||||
### text formatting presents
|
||||
if command -v tput >/dev/null; then
|
||||
bold=$(tput bold)
|
||||
|
|
@ -32,11 +31,9 @@ else
|
|||
yellow=""
|
||||
fi
|
||||
|
||||
|
||||
### trap
|
||||
trap trapExit 1 2 3 6
|
||||
|
||||
|
||||
### functions
|
||||
|
||||
# bad configuration value passed in details file
|
||||
|
|
@ -251,12 +248,12 @@ trapExit() {
|
|||
|
||||
### end of functions
|
||||
|
||||
|
||||
### default variable values
|
||||
|
||||
## script related
|
||||
# store logfile in the same directory as this script file using the same file
|
||||
# name as the script but with the extension '.log'
|
||||
scriptVersion="4.0"
|
||||
scriptPath="$(CDPATH='' \cd -- "$(dirname -- "$0")" && pwd -P)"
|
||||
scriptName="$(basename "$0")"
|
||||
logFile="$scriptPath/${scriptName%.*}.log"
|
||||
|
|
@ -283,7 +280,6 @@ mcDockerCompose="/opt/mailcow-dockerized/docker-compose.yml"
|
|||
dockerStartTimeout=180
|
||||
dockerStopTimeout=120
|
||||
|
||||
|
||||
### process startup parameters
|
||||
while [ $# -gt 0 ]; do
|
||||
case "$1" in
|
||||
|
|
@ -292,6 +288,11 @@ while [ $# -gt 0 ]; do
|
|||
scriptHelp
|
||||
exit 0
|
||||
;;
|
||||
--version)
|
||||
# display script version
|
||||
printf "\nMailcowBackup - Backup Mailcow using borgbackup to a remote SSH server : Version %s\n\n" ${scriptVersion}
|
||||
exit 0
|
||||
;;
|
||||
-l | --log)
|
||||
# set log file location
|
||||
if [ -n "$2" ]; then
|
||||
|
|
@ -423,7 +424,6 @@ while [ $# -gt 0 ]; do
|
|||
shift
|
||||
done
|
||||
|
||||
|
||||
### check pre-requisites and default values
|
||||
# check if running as root, otherwise exit
|
||||
if [ "$(id -u)" -ne 0 ]; then
|
||||
|
|
@ -477,14 +477,12 @@ fi
|
|||
export PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
|
||||
export COMPOSE_HTTP_TIMEOUT="$dockerStartTimeout"
|
||||
|
||||
|
||||
### start logging
|
||||
printf "%s[%s] --- Start %s execution ---%s\n" \
|
||||
"$magenta" "$(stamp)" "$scriptName" "$norm" >>"$logFile"
|
||||
printf "%s[%s] -- [INFO] Log located at %s%s%s --%s\n" \
|
||||
"$cyan" "$(stamp)" "$yellow" "$logFile" "$cyan" "$norm" >>"$logFile"
|
||||
|
||||
|
||||
### get location of docker volumes
|
||||
dockerVolumeMail=$(docker volume inspect -f '{{ .Mountpoint }}' ${COMPOSE_PROJECT_NAME}_vmail-vol-1)
|
||||
printf "%s[%s] -- [INFO] Using MAIL volume: %s --%s\n" \
|
||||
|
|
@ -502,7 +500,6 @@ dockerVolumeCrypt=$(docker volume inspect -f '{{ .Mountpoint }}' ${COMPOSE_PROJE
|
|||
printf "%s[%s] -- [INFO] Using MAILCRYPT volume: %s --%s\n" \
|
||||
"$cyan" "$(stamp)" "$dockerVolumeCrypt" "$norm" >>"$logFile"
|
||||
|
||||
|
||||
### read details file to get variables needed run borg
|
||||
# check if config details file was provided as a relative or absolute path
|
||||
case "${configDetails}" in
|
||||
|
|
@ -520,7 +517,6 @@ esac
|
|||
printf "%s[%s] -- [INFO] %s%s%s imported --%s\n" \
|
||||
"$cyan" "$(stamp)" "$yellow" "$configDetails" "$cyan" "$norm" >>"$logFile"
|
||||
|
||||
|
||||
### Run borg variable checks
|
||||
printf "%s[%s] -- [INFO] Verifying supplied borg details --%s\n" \
|
||||
"$cyan" "$(stamp)" "$norm" >>"$logFile"
|
||||
|
|
@ -624,7 +620,6 @@ 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
|
||||
|
|
@ -636,7 +631,6 @@ else
|
|||
"$cyan" "$(stamp)" "$sqlDumpDir/$sqlDumpFile" "$norm" >>"$logFile"
|
||||
fi
|
||||
|
||||
|
||||
### create borg temp dir:
|
||||
## python requires a writable temporary directory when unpacking borg and
|
||||
## executing commands. This defaults to /tmp but many systems mount /tmp with
|
||||
|
|
@ -655,14 +649,12 @@ if [ ! -d "${borgBaseDir}/tmp" ]; then
|
|||
fi
|
||||
export TMPDIR="${borgBaseDir}/tmp"
|
||||
|
||||
|
||||
### 503 functionality
|
||||
if [ "$use503" -eq 1 ]; then
|
||||
printf "%s[%s] -- [INFO] Copying 503 error page to " \
|
||||
"$cyan" "$(stamp)" >>"$logFile"
|
||||
printf "webroot -- %s\n" "$norm" >>"$logFile"
|
||||
if ! \cp --force "${err503Path}" "${webroot}/${err503File}" 2>> "$logFile"
|
||||
then
|
||||
if ! \cp --force "${err503Path}" "${webroot}/${err503File}" 2>>"$logFile"; then
|
||||
printf "%s[%s] -- [WARNING] Failed to copy 503 error page. " \
|
||||
"$warn" "$(stamp)" >>"$logFile"
|
||||
printf "Web users will NOT be notified --%s\n" "$norm" >>"$logFile"
|
||||
|
|
@ -694,7 +686,6 @@ 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"
|
||||
|
|
@ -708,7 +699,6 @@ 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
|
||||
|
|
@ -726,7 +716,6 @@ 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"
|
||||
|
||||
|
|
@ -783,7 +772,6 @@ else
|
|||
warnCount=$((warnCount + 1))
|
||||
fi
|
||||
|
||||
|
||||
### 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" \
|
||||
|
|
@ -822,7 +810,6 @@ if [ -n "${borgPruneResult}" ]; then
|
|||
fi
|
||||
fi
|
||||
|
||||
|
||||
### all processes successfully completed, cleanup and exit gracefully
|
||||
|
||||
# note successful completion of borg commands
|
||||
|
|
@ -844,7 +831,6 @@ else
|
|||
fi
|
||||
exit 0
|
||||
|
||||
|
||||
### error codes
|
||||
# 1: parameter error
|
||||
# 2: not run as root
|
||||
|
|
|
|||
Loading…
Reference in New Issue