Borg Backup wrapper Version 4.0 update
* file backup borg folder has now -file name inside. Old folder must be manuall renamed * All modules have the module id name as prefix in the backup set, _borg_backup_set_prefix_cleanup.sh needs to be run before to clean up all names or prune will not correctly delete old entries New -T for one time target backup with custom prefix to have backups outside the automated prune. -D option to delete this set Add borg 1.2 support for compact which is called after delete and prune to actually clean up the space. -b borg executable and BORG_EXECUTEABLE override setting if borg is not in path or another borg executable should be used
This commit is contained in:
Clemens Schwaighofer
@@ -10,6 +10,8 @@ echo "Script version: ${VERSION}";
|
||||
# show type
|
||||
echo "Backup module : ${MODULE}";
|
||||
echo "Module version: ${MODULE_VERSION}";
|
||||
# borg version
|
||||
echo "Borg version : ${BORG_VERSION}";
|
||||
# show base folder always
|
||||
echo "Base folder : ${BASE_FOLDER}";
|
||||
|
||||
@@ -130,63 +132,71 @@ if [ ! -w "${HOME}" ] || [ "${HOME}" = '/' ]; then
|
||||
HOME=$(eval echo "$(whoami)");
|
||||
fi;
|
||||
|
||||
# build options and info string,
|
||||
# also flag BACKUP_SET check if hourly is set
|
||||
# keep optionfs (for files)
|
||||
KEEP_OPTIONS=();
|
||||
# keep info string (for files)
|
||||
KEEP_INFO="";
|
||||
BACKUP_SET_CHECK=0;
|
||||
if [ ${KEEP_LAST} -gt 0 ]; then
|
||||
KEEP_OPTIONS+=("--keep-last=${KEEP_LAST}");
|
||||
KEEP_INFO="${KEEP_INFO}, last: ${KEEP_LAST}";
|
||||
fi;
|
||||
if [ ${KEEP_HOURS} -gt 0 ]; then
|
||||
KEEP_OPTIONS+=("--keep-hourly=${KEEP_HOURS}");
|
||||
KEEP_INFO="${KEEP_INFO}, hourly: ${KEEP_HOURS}";
|
||||
BACKUP_SET_CHECK=1;
|
||||
fi;
|
||||
if [ ${KEEP_DAYS} -gt 0 ]; then
|
||||
KEEP_OPTIONS+=("--keep-daily=${KEEP_DAYS}");
|
||||
KEEP_INFO="${KEEP_INFO}, daily: ${KEEP_DAYS}";
|
||||
fi;
|
||||
if [ ${KEEP_WEEKS} -gt 0 ]; then
|
||||
KEEP_OPTIONS+=("--keep-weekly=${KEEP_WEEKS}");
|
||||
KEEP_INFO="${KEEP_INFO}, weekly: ${KEEP_WEEKS}";
|
||||
fi;
|
||||
if [ ${KEEP_MONTHS} -gt 0 ]; then
|
||||
KEEP_OPTIONS+=("--keep-monthly=${KEEP_MONTHS}");
|
||||
KEEP_INFO="${KEEP_INFO}, monthly: ${KEEP_MONTHS}";
|
||||
fi;
|
||||
if [ ${KEEP_YEARS} -gt 0 ]; then
|
||||
KEEP_OPTIONS+=("--keep-yearly=${KEEP_YEARS}");
|
||||
KEEP_INFO="${KEEP_INFO}, yearly: ${KEEP_YEARS}";
|
||||
fi;
|
||||
if [ ! -z "${KEEP_WITHIN}" ]; then
|
||||
# check for invalid string. can only be number + H|d|w|m|y
|
||||
if [[ "${KEEP_WITHIN}" =~ ^[0-9]+[Hdwmy]{1}$ ]]; then
|
||||
KEEP_OPTIONS+=("--keep-within=${KEEP_WITHIN}");
|
||||
KEEP_INFO="${KEEP_INFO}, within: ${KEEP_WITHIN}";
|
||||
if [[ "${KEEP_WITHIN}" == *"H"* ]]; then
|
||||
BACKUP_SET_CHECK=1;
|
||||
# override standard keep for tagged backups
|
||||
if [ ! -z "${ONE_TIME_TAG}" ]; then
|
||||
BACKUP_SET="{now:%Y-%m-%dT%H:%M:%S}";
|
||||
else
|
||||
# build options and info string,
|
||||
# also flag BACKUP_SET check if hourly is set
|
||||
BACKUP_SET_CHECK=0;
|
||||
if [ ${KEEP_LAST} -gt 0 ]; then
|
||||
KEEP_OPTIONS+=("--keep-last=${KEEP_LAST}");
|
||||
KEEP_INFO="${KEEP_INFO}, last: ${KEEP_LAST}";
|
||||
fi;
|
||||
if [ ${KEEP_HOURS} -gt 0 ]; then
|
||||
KEEP_OPTIONS+=("--keep-hourly=${KEEP_HOURS}");
|
||||
KEEP_INFO="${KEEP_INFO}, hourly: ${KEEP_HOURS}";
|
||||
BACKUP_SET_CHECK=1;
|
||||
fi;
|
||||
if [ ${KEEP_DAYS} -gt 0 ]; then
|
||||
KEEP_OPTIONS+=("--keep-daily=${KEEP_DAYS}");
|
||||
KEEP_INFO="${KEEP_INFO}, daily: ${KEEP_DAYS}";
|
||||
fi;
|
||||
if [ ${KEEP_WEEKS} -gt 0 ]; then
|
||||
KEEP_OPTIONS+=("--keep-weekly=${KEEP_WEEKS}");
|
||||
KEEP_INFO="${KEEP_INFO}, weekly: ${KEEP_WEEKS}";
|
||||
fi;
|
||||
if [ ${KEEP_MONTHS} -gt 0 ]; then
|
||||
KEEP_OPTIONS+=("--keep-monthly=${KEEP_MONTHS}");
|
||||
KEEP_INFO="${KEEP_INFO}, monthly: ${KEEP_MONTHS}";
|
||||
fi;
|
||||
if [ ${KEEP_YEARS} -gt 0 ]; then
|
||||
KEEP_OPTIONS+=("--keep-yearly=${KEEP_YEARS}");
|
||||
KEEP_INFO="${KEEP_INFO}, yearly: ${KEEP_YEARS}";
|
||||
fi;
|
||||
if [ ! -z "${KEEP_WITHIN}" ]; then
|
||||
# check for invalid string. can only be number + H|d|w|m|y
|
||||
if [[ "${KEEP_WITHIN}" =~ ^[0-9]+[Hdwmy]{1}$ ]]; then
|
||||
KEEP_OPTIONS+=("--keep-within=${KEEP_WITHIN}");
|
||||
KEEP_INFO="${KEEP_INFO}, within: ${KEEP_WITHIN}";
|
||||
if [[ "${KEEP_WITHIN}" == *"H"* ]]; then
|
||||
BACKUP_SET_CHECK=1;
|
||||
fi;
|
||||
else
|
||||
echo "[! $(date +'%F %T')] KEEP_WITHIN has invalid string.";
|
||||
exit 1;
|
||||
fi;
|
||||
else
|
||||
echo "[! $(date +'%F %T')] KEEP_WITHIN has invalid string.";
|
||||
fi;
|
||||
# abort if KEEP_OPTIONS is empty
|
||||
if [ -z "${KEEP_OPTIONS}" ]; then
|
||||
echo "[! $(date +'%F %T')] It seems no KEEP_* entries where set in a valid format.";
|
||||
exit 1;
|
||||
fi;
|
||||
# set BACKUP_SET if empty, set to Year-month-day
|
||||
if [ -z "${BACKUP_SET}" ]; then
|
||||
BACKUP_SET="{now:%Y-%m-%d}";
|
||||
fi;
|
||||
# backup set check, and there is no hour entry (%H) in the archive string
|
||||
# we add T%H:%M:%S in this case, before the last }
|
||||
if [ ${BACKUP_SET_CHECK} -eq 1 ] && [[ "${BACKUP_SET}" != *"%H"* ]]; then
|
||||
BACKUP_SET=$(echo "${BACKUP_SET}" | sed -e "s/}/T%H:%M:%S}/");
|
||||
fi;
|
||||
fi;
|
||||
# abort if KEEP_OPTIONS is empty
|
||||
if [ -z "${KEEP_OPTIONS}" ]; then
|
||||
echo "[! $(date +'%F %T')] It seems no KEEP_* entries where set in a valid format.";
|
||||
exit 1;
|
||||
fi;
|
||||
# set BACKUP_SET if empty, set to Year-month-day
|
||||
if [ -z "${BACKUP_SET}" ]; then
|
||||
BACKUP_SET="{now:%Y-%m-%d}";
|
||||
fi;
|
||||
# backup set check, and there is no hour entry (%H) in the archive string
|
||||
# we add T%H:%M:%S in this case, before the last }
|
||||
if [ ${BACKUP_SET_CHECK} -eq 1 ] && [[ "${BACKUP_SET}" != *"%H"* ]]; then
|
||||
BACKUP_SET=$(echo "${BACKUP_SET}" | sed -e "s/}/T%H:%M:%S}/");
|
||||
fi;
|
||||
|
||||
|
||||
# for folders list split set to "#" and keep the old setting as is
|
||||
_IFS=${IFS};
|
||||
@@ -198,8 +208,8 @@ fi;
|
||||
|
||||
# borg call, replace ##...## parts during run
|
||||
# used in all modules, except 'file'
|
||||
_BORG_CALL="borg create ${OPT_REMOTE} -v ${OPT_LIST} ${OPT_PROGRESS} ${OPT_COMPRESSION} -s --stdin-name ##FILENAME## ${REPOSITORY}::##BACKUP_SET## -";
|
||||
_BORG_PRUNE="borg prune ${OPT_REMOTE} -v -s --list ${PRUNE_DEBUG} -P ##BACKUP_SET_PREFIX## ${KEEP_OPTIONS[*]} ${REPOSITORY}";
|
||||
_BORG_CALL="${BORG_COMMAND} create ${OPT_REMOTE} -v ${OPT_LIST} ${OPT_PROGRESS} ${OPT_COMPRESSION} -s --stdin-name ##FILENAME## ${REPOSITORY}::##BACKUP_SET## -";
|
||||
_BORG_PRUNE="${BORG_COMMAND} prune ${OPT_REMOTE} -v --list ${OPT_PROGRESS} ${DRY_RUN_STATS} -P ##BACKUP_SET_PREFIX## ${KEEP_OPTIONS[*]} ${REPOSITORY}";
|
||||
|
||||
# general borg settings
|
||||
# set base path to config directory to keep cache/config separated
|
||||
@@ -216,7 +226,7 @@ if [ ${DEBUG} -eq 1 ]; then
|
||||
fi;
|
||||
# prepare debug commands only
|
||||
COMMAND_EXPORT="export BORG_BASE_DIR=\"${BASE_FOLDER}\";"
|
||||
COMMAND_INFO="${COMMAND_EXPORT}borg info ${OPT_REMOTE} ${REPOSITORY}";
|
||||
COMMAND_INFO="${COMMAND_EXPORT}${BORG_COMMAND} info ${OPT_REMOTE} ${REPOSITORY}";
|
||||
# if the is not there, call init to create it
|
||||
# if this is user@host, we need to use ssh command to check if the file is there
|
||||
# else a normal check is ok
|
||||
@@ -225,14 +235,13 @@ if [ ${CHECK} -eq 1 ] || [ ${INIT} -eq 1 ]; then
|
||||
echo "--- [CHECK : $(date +'%F %T')] --[${MODULE}]------------------------------------>";
|
||||
if [ ! -z "${TARGET_SERVER}" ]; then
|
||||
if [ ${DEBUG} -eq 1 ]; then
|
||||
echo "borg info ${OPT_REMOTE} ${REPOSITORY} 2>&1|grep \"Repository ID:\"";
|
||||
echo "${BORG_COMMAND} info ${OPT_REMOTE} ${REPOSITORY} 2>&1|grep \"Repository ID:\"";
|
||||
fi;
|
||||
# use borg info and check if it returns "Repository ID:" in the first line
|
||||
REPO_CHECK=$(borg info ${OPT_REMOTE} ${REPOSITORY} 2>&1|grep "Repository ID:");
|
||||
REPO_CHECK=$(${BORG_COMMAND} info ${OPT_REMOTE} ${REPOSITORY} 2>&1|grep "Repository ID:");
|
||||
# this is currently a hack to work round the error code in borg info
|
||||
# this checks if REPO_CHECK holds this error message and then starts init
|
||||
regex="^Some part of the script failed with an error:";
|
||||
if [[ -z "${REPO_CHECK}" ]] || [[ "${REPO_CHECK}" =~ ${regex} ]]; then
|
||||
if [[ -z "${REPO_CHECK}" ]] || [[ "${REPO_CHECK}" =~ ${REGEX_ERROR} ]]; then
|
||||
INIT_REPOSITORY=1;
|
||||
fi;
|
||||
elif [ ! -d "${REPOSITORY}" ]; then
|
||||
@@ -248,37 +257,39 @@ if [ ${CHECK} -eq 1 ] || [ ${INIT} -eq 1 ]; then
|
||||
# end if checked but repository is not here
|
||||
if [ ${CHECK} -eq 1 ] && [ ${INIT} -eq 0 ] && [ ${INIT_REPOSITORY} -eq 1 ]; then
|
||||
echo "[! $(date +'%F %T')] No repository. Please run with -I flag to initialze repository";
|
||||
. "${DIR}/borg.backup.functions.close.sh" 1;
|
||||
exit 1;
|
||||
fi;
|
||||
if [ ${EXIT} -eq 1 ] && [ ${CHECK} -eq 1 ] && [ ${INIT} -eq 0 ]; then
|
||||
echo "Repository exists";
|
||||
echo "For more information run:"
|
||||
echo "${COMMAND_INFO}";
|
||||
echo "=== [END : $(date +'%F %T')] ==[${MODULE}]====================================>";
|
||||
. "${DIR}/borg.backup.functions.close.sh";
|
||||
exit;
|
||||
fi;
|
||||
fi;
|
||||
if [ ${INIT} -eq 1 ] && [ ${INIT_REPOSITORY} -eq 1 ]; then
|
||||
echo "--- [INIT : $(date +'%F %T')] --[${MODULE}]------------------------------------>";
|
||||
if [ ${DEBUG} -eq 1 ] || [ ${DRYRUN} -eq 1 ]; then
|
||||
echo "borg init ${OPT_REMOTE} -e ${ENCRYPTION} ${OPT_VERBOSE} ${REPOSITORY}";
|
||||
echo "${BORG_COMMAND} init ${OPT_REMOTE} -e ${ENCRYPTION} ${OPT_VERBOSE} ${REPOSITORY}";
|
||||
fi
|
||||
if [ ${DRYRUN} -eq 0 ]; then
|
||||
# should trap and exit properly here
|
||||
borg init ${OPT_REMOTE} -e ${ENCRYPTION} ${OPT_VERBOSE} ${REPOSITORY};
|
||||
${BORG_COMMAND} init ${OPT_REMOTE} -e ${ENCRYPTION} ${OPT_VERBOSE} ${REPOSITORY};
|
||||
# write init file
|
||||
echo "$(date +%s)" > "${BASE_FOLDER}${BACKUP_INIT_CHECK}";
|
||||
echo "Repository initialized";
|
||||
echo "For more information run:"
|
||||
echo "${COMMAND_INFO}";
|
||||
fi
|
||||
echo "=== [END : $(date +'%F %T')] ==[${MODULE}]====================================>";
|
||||
. "${DIR}/borg.backup.functions.close.sh";
|
||||
# exit after init
|
||||
exit;
|
||||
elif [ ${INIT} -eq 1 ] && [ ${INIT_REPOSITORY} -eq 0 ]; then
|
||||
echo "[! $(date +'%F %T')] Repository already initialized";
|
||||
echo "For more information run:"
|
||||
echo "${COMMAND_INFO}";
|
||||
. "${DIR}/borg.backup.functions.close.sh" 1;
|
||||
exit 1;
|
||||
fi;
|
||||
|
||||
@@ -286,6 +297,7 @@ fi;
|
||||
if [ ! -f "${BASE_FOLDER}${BACKUP_INIT_CHECK}" ]; then
|
||||
echo "[! $(date +'%F %T')] It seems the repository has never been initialized."
|
||||
echo "Please run -I to initialize or if already initialzed run with -C for init update."
|
||||
. "${DIR}/borg.backup.functions.close.sh" 1;
|
||||
exit 1;
|
||||
fi;
|
||||
|
||||
@@ -295,7 +307,7 @@ if [ ${PRINT} -eq 1 ]; then
|
||||
FORMAT="{archive} {comment:6} {start} - {end} [{id}] ({username}@{hostname}){NL}"
|
||||
# show command on debug or dry run
|
||||
if [ ${DEBUG} -eq 1 ] || [ ${DRYRUN} -eq 1 ]; then
|
||||
echo "export BORG_BASE_DIR=\"${BASE_FOLDER}\";borg list ${OPT_REMOTE} --format ${FORMAT} ${REPOSITORY}";
|
||||
echo "export BORG_BASE_DIR=\"${BASE_FOLDER}\";${BORG_COMMAND} list ${OPT_REMOTE} --format ${FORMAT} ${REPOSITORY}";
|
||||
fi;
|
||||
# run info command if not a dry drun
|
||||
if [ ${DRYRUN} -eq 0 ]; then
|
||||
@@ -304,17 +316,60 @@ if [ ${PRINT} -eq 1 ]; then
|
||||
if [ ${VERBOSE} -eq 1 ]; then
|
||||
echo "";
|
||||
echo "Base command info:"
|
||||
echo "export BORG_BASE_DIR=\"${BASE_FOLDER}\";borg [COMMAND] ${OPT_REMOTE} ${REPOSITORY}::[BACKUP] [PATH]";
|
||||
echo "export BORG_BASE_DIR=\"${BASE_FOLDER}\";${BORG_COMMAND} [COMMAND] ${OPT_REMOTE} ${REPOSITORY}::[BACKUP] [PATH]";
|
||||
echo "Replace [COMMAND] with list for listing or extract for restoring backup data."
|
||||
echo "Replace [BACKUP] with archive name."
|
||||
echo "If no [PATH] is given then all files will be restored."
|
||||
echo "Before extracting -n (dry run) is recommended to use."
|
||||
echo "If archive size is needed the info command with archive name has to be used."
|
||||
echo "When listing (list) data the --format command can be used."
|
||||
echo "When listing files in an archive set (::SET) the --format command can be used."
|
||||
echo "Example: \"{mode} {user:6} {group:6} {size:8d} {csize:8d} {dsize:8d} {dcsize:8d} {mtime} {path}{extra} [{health}]{NL}\""
|
||||
else
|
||||
echo "export BORG_BASE_DIR=\"${BASE_FOLDER}\";borg [COMMAND] ${OPT_REMOTE} [FORMAT] ${REPOSITORY}::[BACKUP] [PATH]";
|
||||
echo "export BORG_BASE_DIR=\"${BASE_FOLDER}\";${BORG_COMMAND} [COMMAND] ${OPT_REMOTE} [FORMAT] ${REPOSITORY}::[BACKUP] [PATH]";
|
||||
fi;
|
||||
. "${DIR}/borg.backup.functions.close.sh";
|
||||
exit;
|
||||
fi;
|
||||
|
||||
# DELETE ONE TIME TAG
|
||||
if [ ! -z "${DELETE_ONE_TIME_TAG}" ]; then
|
||||
echo "--- [DELETE: $(date +'%F %T')] --[${MODULE}]------------------------------------>";
|
||||
# if a "*" is inside we don't do ONE archive, but globbing via -a option
|
||||
DELETE_ARCHIVE=""
|
||||
OPT_GLOB="";
|
||||
# this is more or less for debug only
|
||||
if [[ "${DELETE_ONE_TIME_TAG}" =~ $REGEX_GLOB ]]; then
|
||||
OPT_GLOB="-a '${DELETE_ONE_TIME_TAG}'"
|
||||
else
|
||||
DELETE_ARCHIVE="::"${DELETE_ONE_TIME_TAG};
|
||||
fi
|
||||
# if this is borg <1.2 OPT_LIST does not work
|
||||
if [ $(version $BORG_VERSION) -lt $(version "1.2.0") ]; then
|
||||
OPT_LIST="";
|
||||
fi;
|
||||
# if exists, delete and exit
|
||||
# show command on debug or dry run
|
||||
if [ ${DEBUG} -eq 1 ]; then
|
||||
echo "${BORG_COMMAND} delete ${OPT_REMOTE} ${OPT_LIST} -s ${OPT_GLOB} ${REPOSITORY}${DELETE_ARCHIVE}";
|
||||
fi;
|
||||
# run delete command if not a dry drun
|
||||
# NOTE seems to be glob is not working if wrapped into another variable
|
||||
if [[ "${DELETE_ONE_TIME_TAG}" =~ $REGEX_GLOB ]]; then
|
||||
${BORG_COMMAND} delete ${OPT_REMOTE} ${OPT_LIST} ${DRY_RUN_STATS} -a "${DELETE_ONE_TIME_TAG}" ${REPOSITORY};
|
||||
else
|
||||
${BORG_COMMAND} delete ${OPT_REMOTE} ${OPT_LIST} ${DRY_RUN_STATS} ${REPOSITORY}${DELETE_ARCHIVE};
|
||||
fi;
|
||||
# if not a dry run, compact repository after delete
|
||||
# not that compact only works on borg 1.2
|
||||
if [ $(version $BORG_VERSION) -ge $(version "1.2.0") ]; then
|
||||
if [ ${DRYRUN} -eq 0 ]; then
|
||||
${BORG_COMMAND} compact ${REPOSITORY};
|
||||
fi;
|
||||
if [ ${DEBUG} -eq 1 ]; then
|
||||
echo "${BORG_COMMAND} compact ${REPOSITORY}";
|
||||
fi;
|
||||
fi;
|
||||
. "${DIR}/borg.backup.functions.close.sh";
|
||||
exit;
|
||||
fi;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user