From 3abe57d09b71ad107f1653e06b5e81b4b966136d Mon Sep 17 00:00:00 2001 From: Christoph Date: Mon, 18 Nov 2024 17:23:03 +0100 Subject: [PATCH] initial commit --- .gitignore | 4 + README.Borg-Documentation | 9 + borg2-backup-nc.sh | 804 +++++++++++++++++++++++++++++++ borg2-backup.sh | 772 +++++++++++++++++++++++++++++ borg2-delete-archive.sh | 318 ++++++++++++ borg2-list-backups.sh | 287 +++++++++++ borg2-mount-archiv.sh | 320 ++++++++++++ borg2-umount-archiv.sh | 282 +++++++++++ conf/borg2-backup-nc.conf.sample | 226 +++++++++ conf/borg2-backup.conf.sample | 261 ++++++++++ 10 files changed, 3283 insertions(+) create mode 100644 .gitignore create mode 100644 README.Borg-Documentation create mode 100755 borg2-backup-nc.sh create mode 100755 borg2-backup.sh create mode 100755 borg2-delete-archive.sh create mode 100755 borg2-list-backups.sh create mode 100755 borg2-mount-archiv.sh create mode 100755 borg2-umount-archiv.sh create mode 100644 conf/borg2-backup-nc.conf.sample create mode 100644 conf/borg2-backup.conf.sample diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3b4fd2f --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +/BAK/* +*.log +/conf/*.conf +*.swp diff --git a/README.Borg-Documentation b/README.Borg-Documentation new file mode 100644 index 0000000..6c9ab90 --- /dev/null +++ b/README.Borg-Documentation @@ -0,0 +1,9 @@ +# -------------------- +# Borg Documentation: +# +# see: https://borgbackup.readthedocs.io/en/stable/ +# +# Borg Backup Home: +# +# see: https://www.borgbackup.org/ +# -------------------- diff --git a/borg2-backup-nc.sh b/borg2-backup-nc.sh new file mode 100755 index 0000000..e49da03 --- /dev/null +++ b/borg2-backup-nc.sh @@ -0,0 +1,804 @@ +#!/usr/bin/env bash + +script_name="$(basename $(realpath $0))" +working_dir="$(dirname $(realpath $0))" + +conf_file="${working_dir}/conf/${script_name%%.*}.conf" + +LOCK_DIR="/tmp/${script_name%%.*}.LOCK" +log_file="${LOCK_DIR}/${script_name%%.*}.log" + +backup_date="$(date +%Y-%m-%d-%H%M)" + +startTime=$(date +%s) +currentDate=$(date --date @"$startTime" +"%Y%m%d_%H%M%S") +currentDateReadable=$(date --date @"$startTime" +"%d.%m.%Y - %H:%M:%S") + + +# ---------- +# Base Function(s) +# ---------- + +clean_up() { + + # Perform program exit housekeeping + sudo -u ${HTTP_USER} ${PHP_COMMAND} ${NC_PATH}/occ maintenance:mode --off > /dev/null 2>&1 + rm -rf "$LOCK_DIR" + blank_line + exit $1 +} + +echononl(){ + if $terminal ; then + + echo X\\c > /tmp/shprompt$$ + if [ `wc -c /tmp/shprompt$$ | awk '{print $1}'` -eq 1 ]; then + echo -e -n " $*\\c" 1>&2 + else + echo -e -n " $*" 1>&2 + fi + rm /tmp/shprompt$$ + + fi + + if [ -d "${BORG_LOG_DIR}" ]; then + echo "" >> ${BORG_LOG_FILE} + echo -e "# $*" >> ${BORG_LOG_FILE} + echo "#" >> ${BORG_LOG_FILE} + fi + +} + +fatal(){ + echo "" + if $terminal ; then + echo -e " [ \033[31m\033[1mFatal\033[m ]: $*" + echo "" + echo -e " \033[31m\033[1mScript was interupted\033[m!" + else + echo " [ Fatal ]: $*" + echo "" + echo " Script was terminated...." + fi + echo "" + clean_up 1 +} +error (){ + echo "" + if $terminal ; then + echo -e " [ \033[31m\033[1mError\033[m ]: $*" + else + echo "[ Error ]: $*" + fi + if [ -d "${BORG_LOG_DIR}" ]; then + echo "[ Error ]: $*" >> ${BORG_LOG_FILE} + fi +} + +warn (){ + echo "" + if $terminal ; then + echo -e " [ \033[33m\033[1mWarning\033[m ]: $*" + else + echo "[ Warning ]: $*" + fi + echo "" +} + +warn_only_terminal () { + if $terminal ; then + echo "" + echo -e "\t[ \033[33m\033[1mWarning\033[m ]: $*" + echo "" + fi +} + +info (){ + if $terminal ; then + echo "" + echo -e " [ \033[32m\033[1mInfo\033[m ] $*" + echo "" + fi +} + +ok (){ + if $terminal ; then + echo "" + echo -e " [ \033[32m\033[1mOk\033[m ] $*" + echo "" + fi +} + +echo_done() { + if $terminal ; then + echo -e "\033[75G[ \033[32mdone\033[m ]" + fi +} +echo_ok() { + if $terminal ; then + echo -e "\033[75G[ \033[32mok\033[m ]" + fi +} +echo_warn() { + if $terminal ; then + echo -e "\033[75G[ \033[33mwarn\033[m ]" + fi +} +echo_failed(){ + if $terminal ; then + echo -e "\033[75G[ \033[1;31mfailed\033[m ]" + fi +} +echo_skipped() { + if $terminal ; then + echo -e "\033[75G[ \033[90m\033[1mskipped\033[m ]" + fi +} +echo_wait(){ + if $terminal ; then + echo -en "\033[75G[ \033[5m\033[1m...\033[m ]" + fi +} + +trim() { + local var="$*" + var="${var#"${var%%[![:space:]]*}"}" # remove leading whitespace characters + var="${var%"${var##*[![:space:]]}"}" # remove trailing whitespace characters + echo -n "$var" +} + +blank_line() { + if $terminal ; then + echo "" + fi +} + +# ---------- +# - Some checks .. +# ---------- + +# - Running in a terminal? +# - +if [[ -t 1 ]] ; then + terminal=true +else + terminal=false +fi + + +# ========== +# - Begin Main Script +# ========== + +# ---------- +# - Headline +# ---------- + +if $terminal ; then + echo "" + +fi + + +# ========== +# - Begin Main Script +# ========== + +# ---------- +# - Headline +# ---------- + +if $terminal ; then + echo "" + echo -e "\033[1m----------\033[m" + echo -e "\033[32m\033[1mRunning script \033[m\033[1m$script_name\033[32m .. \033[m" + echo -e "\033[1m----------\033[m" + echo "" +fi + +# ---------- +# Default values +# ---------- + +DEFAULT_HTTP_USER="www-data" + +DEFAULT_BORG_LOG_DIR="/var/log/borg/" + +DEFAULT_SSH_USER="borg" +DEFAULT_SSH_PORT=22 +DEFAULT_BORG_RSH='ssh -i /root/.ssh/id_ed25519-borg-backup' + +DEFAULT_NC_DB_BACKUP_DIR="/data/backup/sql" + +DEFAULT_BACKUP_OTHER_DIRECTORIES="/etc /home /root /var/spool/cron" + +DEFAULT_KEEP_DAILY=10 +DEFAULT_KEEP_WEEKLY=5 +DEFAULT_KEEP_MONTHLY=6 +DEFAULT_KEEP_YEARLY=1 + +DEFAULT_ADMIN_EMAIL="root" +DEFAULT_COMPANY="O.OPEN" +DEFAULT_FROM_ADDRESS="borg-backup@$(hostname -f)" + + +# ---------- +# Read Configurations from $conf_file +# ---------- + + +if [[ -f "$conf_file" ]]; then + source "$conf_file" +else + fatal "No configuration file '$conf_file' present!" +fi + + +# ------------- +# - Job is already running? +# ------------- + +[[ -z "${ADMIN_EMAIL}" ]] && ADMIN_EMAIL="${DEFAULT_ADMIN_EMAIL}" +[[ -z "${COMPANY}" ]] && COMPANY="${DEFAULT_COMPANY}" +[[ -z "${FROM_ADDRESS}" ]] && FROM_ADDRESS="${DEFAULT_FROM_ADDRESS}" + +# - If job already runs, stop execution.. +# - +if mkdir "$LOCK_DIR" 2> /dev/null ; then + + ## - Remove lockdir when the script finishes, or when it receives a signal + trap "clean_up 1" SIGHUP SIGINT SIGTERM + +else + + datum="$(date +"%d.%m.%Y %H:%M")" + + msg="[ Error ]: A previos instance of \"`basename $0`\" seems already be running.\n\n Exiting now.." + + datum="$(date +"%d.%m.%Y")" + + content_type='Content-Type: text/plain;\n charset="utf-8"' + + subject="Error Borg Backup - ${COMPANY} - ${datum}" + subject_utf8="$(echo "$subject" | iconv -t UTF8)" + subject_utf8_encoded="=?utf-8?B?$(echo $subject_utf8 | base64 --wrap=0)?=" + + echo -e "To:${ADMIN_EMAIL}\n${content_type}\nSubject:${subject_utf8_encoded}\n${msg}\n" | /usr/sbin/sendmail -F "Errors BACKUP ${COMPANY}" -f ${FROM_ADDRESS} ${ADMIN_EMAIL} + + echo "" + echo "[ Error ]: A previos instance of that script \"`basename $0`\" seems already be running." + echo "" + echo -e " Exiting now.." + echo "" + + exit 1 + +fi + + +# ---------- +# Set Parameter values +# ---------- + +if [[ -z "${BORG_PASSPHRASE}" ]] ; then + fatal "Borg Passphrase (BORG_PASSPHRASE) NOT found!" +fi + +if [[ -z "${NC_PATH}" ]] ; then + fatal "Nextcloud's DocumentRoot directory not found!" +fi +if [[ -h "${NC_PATH}" ]] ; then + BORG_NC_PATH="${NC_PATH} $(realpath "${NC_PATH}")" +else + BORG_NC_PATH="${NC_PATH}" +fi + +if [[ -z "${BORG_HOST}" ]] ; then + fatal "Backup Hosth (var BORG_HOST) not given!" +fi + +if [[ -z "${BORG_REPO}" ]] ; then + fatal "Borg Repository Path (var BORG_REPO) not given!" +fi + +[[ -z "${HTTP_USER}" ]] && HTTP_USER="${DEFAULT_HTTP_USER}" + +[[ -z "${SSH_USER}" ]] && SSH_USER="${DEFAULT_SSH_USER}" + +[[ -z "${SSH_PORT}" ]] && SSH_PORT="${DEFAULT_SSH_PORT}" + +[[ -z "${BORG_RSH}" ]] && BORG_RSH="${DEFAULT_BORG_RSH}" + +[[ -z "${KEEP_DAILY}" ]] && KEEP_DAILY=${DEFAULT_KEEP_DAILY} +[[ -z "${KEEP_WEEKLY}" ]] && KEEP_WEEKLY=${DEFAULT_KEEP_WEEKLY} +[[ -z "${KEEP_MONTHLY}" ]] && KEEP_MONTHLY=${DEFAULT_KEEP_MONTHLY} +[[ -z "${KEEP_YEARLY}" ]] && KEEP_YEARLY=${DEFAULT_KEEP_YEARLY} + + +[[ -z "${BORG_LOG_DIR}" ]] && BORG_LOG_DIR="${DEFAULT_BORG_LOG_DIR}" +BORG_LOG_FILE="${BORG_LOG_DIR}//borg-backup.log" + +[[ -z "${NC_DB_BACKUP_DIR}" ]] && NC_DB_BACKUP_DIR="${DEFAULT_NC_DB_BACKUP_DIR}" + +[[ -z "${BACKUP_OTHER_DIRECTORIES}" ]] && BACKUP_OTHER_DIRECTORIES="${DEFAULT_BACKUP_OTHER_DIRECTORIES}" + +# By default: Borg won't follow symlinks +# +BORG_BACKUP_DIRS="" +for _dir in $BACKUP_OTHER_DIRECTORIES ; do + if [[ -h "${_dir}" ]] ; then + BORG_BACKUP_DIRS="$BORG_BACKUP_DIRS $(realpath "${_dir}")" + fi + BORG_BACKUP_DIRS="$BORG_BACKUP_DIRS ${_dir}" +done + +# remove leading whitespace characters +# +BORG_BACKUP_DIRS="${BORG_BACKUP_DIRS#"${BORG_BACKUP_DIRS%%[![:space:]]*}"}" + +BORG_URL="ssh://${SSH_USER}@${BORG_HOST}:${SSH_PORT}${BORG_REPO}" + +#BORG_REPO="${BORG_URL}" + +ARCHIVE_NAME="${backup_date}" + +export BORG_PASSPHRASE + +# --- +# Some automatic 'answerers' (if set, they automatically answer confirmation questions): +# --- + +# For 'Warning: The repository at location … was previously located at ..' +# + +# This has to be set when the repository has been created by user and +# the script is called by cron +# +export BORG_RELOCATED_REPO_ACCESS_IS_OK=yes + +# For "Warning: The repository at location ... was previously located at ..." +# +export BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK=yes + + + +PHP_COMMAND="$(which php)" +if [[ -z "${PHP_COMMAND}" ]] ; then + if [[ -f "/usr/local/php/bin/php" ]] ; then + PHP_COMMAND="/usr/local/php/bin/php" + fi +fi + +if [[ -z "${PHP_COMMAND}" ]] ; then + fatal "No PHP command found!" +fi + +if [ ! -d "${BORG_LOG_DIR}" ]; then + echononl "Create borg log directory.." + mkdir -p "${BORG_LOG_DIR}" > ${log_file} 2>&1 + if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" + + fatal "No log directory '${BORG_LOG_DIR}' present!" + + else + echo_ok + echo "mkdir -p \"${BORG_LOG_DIR}\"" >> ${BORG_LOG_FILE} + echo "" >> ${BORG_LOG_FILE} + fi +fi + +if [ ! -d "${NC_DB_BACKUP_DIR}" ]; then + echononl "Create DB backup directory.." + mkdir -p "${NC_DB_BACKUP_DIR}" > ${log_file} 2>&1 + if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" + + fatal "No log directory '${NC_DB_BACKUP_DIR}' present!" + + else + echo_ok + echo "mkdir -p \"${NC_DB_BACKUP_DIR}\"" >> ${BORG_LOG_FILE} + echo "" >> ${BORG_LOG_FILE} + fi +fi + +echo "# ----------" >> ${BORG_LOG_FILE} +echo -e "# Running script '${script_name}' on $(date +%Y.%m.%d) at $(date +%H:%M) h .." >> ${BORG_LOG_FILE} +echo "# ----------" >> ${BORG_LOG_FILE} + + +echo "" >> ${BORG_LOG_FILE} +echo "# Script parameter settings:" >> ${BORG_LOG_FILE} +echo "#" >> ${BORG_LOG_FILE} + +echo "HTTP_USER=\"${HTTP_USER}\"" >> ${BORG_LOG_FILE} +echo "SSH_USER=\"${SSH_USER}\"" >> ${BORG_LOG_FILE} +echo "SSH_PORT=\"${SSH_PORT}\"" >> ${BORG_LOG_FILE} +echo "BORG_HOST=\"${BORG_HOST}\"" >> ${BORG_LOG_FILE} +echo "BORG_REPO=\"${BORG_REPO}\"" >> ${BORG_LOG_FILE} +echo "BORG_PASSPHRASE='${BORG_PASSPHRASE}'" >> ${BORG_LOG_FILE} +echo "BORG_RSH=\"${BORG_RSH}\"" >> ${BORG_LOG_FILE} +echo "BORG_LOG_DIR=\"${BORG_LOG_DIR}\"" >> ${BORG_LOG_FILE} +echo "BORG_URL=\"${BORG_URL}\"" >> ${BORG_LOG_FILE} +echo "" >> ${BORG_LOG_FILE} +echo "NC_PATH=\"${NC_PATH}\"" >> ${BORG_LOG_FILE} +echo "NC_DB_BACKUP_DIR=\"${NC_DB_BACKUP_DIR}\"" >> ${BORG_LOG_FILE} +echo "" >> ${BORG_LOG_FILE} +echo "ADMIN_EMAIL=\"${ADMIN_EMAIL}\"" >> ${BORG_LOG_FILE} +echo "COMPANY=\"${COMPANY}\"" >> ${BORG_LOG_FILE} +echo "FROM_ADDRESS=\"${FROM_ADDRESS}\"" >> ${BORG_LOG_FILE} +echo "" >> ${BORG_LOG_FILE} +echo "PHP_COMMAND=\"${PHP_COMMAND}\"" >> ${BORG_LOG_FILE} +echo "" >> ${BORG_LOG_FILE} + + + +echo "" >> ${BORG_LOG_FILE} +echo "# ---" >> ${BORG_LOG_FILE} +echo "# Gather some NC settings.." >> ${BORG_LOG_FILE} +echo "# ---" >> ${BORG_LOG_FILE} + +# Gather NC settings +# +echononl "Get NextCloud data directory .." +cat << EOF >> ${BORG_LOG_FILE} +NC_DATA_DIR="\$(sudo -u ${HTTP_USER} ${PHP_COMMAND} ${NC_PATH}/occ config:system:get datadirectory)" +EOF + +NC_DATA_DIR="$(sudo -u ${HTTP_USER} ${PHP_COMMAND} ${NC_PATH}/occ config:system:get datadirectory 2> "${log_file}")" + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" + + fatal "Cannot determin NextCloud data directory!" +else + echo_ok +fi + + +echononl "Get NextCloud DB name .." + +cat << EOF >> ${BORG_LOG_FILE} +NC_DB="\$(sudo -u ${HTTP_USER} ${PHP_COMMAND} ${NC_PATH}/occ config:system:get dbname)" +EOF + +NC_DB="$(sudo -u ${HTTP_USER} ${PHP_COMMAND} ${NC_PATH}/occ config:system:get dbname 2> "${log_file}")" + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" + + fatal "Cannot determin NextCloud DB name!" +else + echo_ok +fi + + +echononl "Get NextCloud DB user .." +cat << EOF >> ${BORG_LOG_FILE} +NC_DB_USER="\$(sudo -u ${HTTP_USER} ${PHP_COMMAND} ${NC_PATH}/occ config:system:get dbuser)" +EOF + +NC_DB_USER="$(sudo -u ${HTTP_USER} ${PHP_COMMAND} ${NC_PATH}/occ config:system:get dbuser 2> "${log_file}")" + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" + + fatal "Cannot determin NextCloud DB user!" +else + echo_ok +fi + + +echononl "Get NextCloud DB password .." + +cat << EOF >> ${BORG_LOG_FILE} +NC_DB_PASS="\$(sudo -u ${HTTP_USER} ${PHP_COMMAND} ${NC_PATH}/occ config:system:get dbpassword)" +EOF + +NC_DB_PASS="$(sudo -u ${HTTP_USER} ${PHP_COMMAND} ${NC_PATH}/occ config:system:get dbpassword 2> "${log_file}")" + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" + + fatal "Cannot determin NextCloud DB password!" +else + echo_ok +fi + + +echo "" >> ${BORG_LOG_FILE} +echo "NC_DATA_DIR=\"${NC_DATA_DIR}\"" >> ${BORG_LOG_FILE} +echo "NC_DB=\"${NC_DB}\"" >> ${BORG_LOG_FILE} +echo "NC_DB_USER=\"${NC_DB_USER}\"" >> ${BORG_LOG_FILE} +echo "NC_DB_PASS=\"${NC_DB_PASS}\"" >> ${BORG_LOG_FILE} +echo "" >> ${BORG_LOG_FILE} + +blank_line + + +# Set maintance mode on +# +echononl "Set maintance mode of NC to 'on'." + +echo "sudo -u ${HTTP_USER} ${PHP_COMMAND} ${NC_PATH}/occ maintenance:mode --on" >> ${BORG_LOG_FILE} + +sudo -u ${HTTP_USER} ${PHP_COMMAND} ${NC_PATH}/occ maintenance:mode --on > ${log_file} 2>&1 + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok +fi + +blank_line + + +# Create database backup +# +echononl "Create database backup .." + +cat << EOF >> ${BORG_LOG_FILE} +mysqldump --single-transaction --routines \\ + -h localhost \\ + -u${NC_DB_USER} \\ + -p${NC_DB_PASS} \\ + -e ${NC_DB} > ${NC_DB_BACKUP_DIR}/${NC_DB}-${backup_date}.sql +EOF + +mysqldump --single-transaction --routines \ + -h localhost \ + -u${NC_DB_USER} \ + -p${NC_DB_PASS} \ + -e ${NC_DB} > ${NC_DB_BACKUP_DIR}/${NC_DB}-${backup_date}.sql 2> ${log_file} + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok +fi + + +echononl "Create borg backup.." + +cat << EOF >> ${BORG_LOG_FILE} +borg \\ + --remote-path borg2 \\ + --repo ${BORG_URL} \\ + create \\ + --verbose \\ + --filter AME \\ + --list \\ + --stats \\ + --show-rc \\ + --compression lz4 \\ + --exclude-caches \\ + --exclude 'home/*/.cache/*' \\ + --exclude '/root/.cache/*' \\ + --exclude '/root/.config/*' \\ + --exclude '/root/.local/*' \\ + --exclude 'var/tmp/*' \\ + ${ARCHIVE_NAME} \\ + ${NC_DB_BACKUP_DIR} \\ + ${BORG_NC_PATH} \\ + ${NC_DATA_DIR} \\ + ${BORG_BACKUP_DIRS} +EOF + +borg \ + --remote-path borg2 \ + --repo ${BORG_URL} \ + create \ + --verbose \ + --filter AME \ + --list \ + --stats \ + --show-rc \ + --compression lz4 \ + --exclude-caches \ + --exclude 'home/*/.cache/*' \ + --exclude '/root/.cache/*' \ + --exclude '/root/.config/*' \ + --exclude '/root/.local/*' \ + --exclude 'var/tmp/*' \ + ${ARCHIVE_NAME} \ + ${NC_DB_BACKUP_DIR} \ + ${BORG_NC_PATH} \ + ${NC_DATA_DIR} \ + ${BORG_BACKUP_DIRS} \ + > ${log_file} 2>&1 + + + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok + cat ${log_file} >> ${BORG_LOG_FILE} +fi + + +echononl "Pruning repository.." + +cat << EOF >> ${BORG_LOG_FILE} +borg \\ + --remote-path borg2 \\ + --repo ${BORG_URL} \\ + prune \\ + --list \\ + --show-rc \\ + --keep-daily 7 \\ + --keep-weekly 4 \\ + --keep-monthly 6 \\ + --keep-yearly 1 \\ +EOF + +borg \ + --remote-path borg2 \ + --repo ${BORG_URL} \ + prune \ + --list \ + --show-rc \ + --keep-daily ${KEEP_DAILY} \ + --keep-weekly ${KEEP_WEEKLY} \ + --keep-monthly ${KEEP_MONTHLY} \ + --keep-yearly ${KEEP_YEARLY} \ + > ${log_file} 2>&1 + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok + cat ${log_file} >> ${BORG_LOG_FILE} +fi + + +echononl "Free repository space by deleting unused chunks..." + +cat << EOF >> ${BORG_LOG_FILE} +borg2 \\ + --remote-path borg2 \\ + --repo ${BORG_URL} \\ + compact +EOF + +borg2 \ + --remote-path borg2 \ + --repo ${BORG_URL} \ + compact \ + > ${log_file} 2>&1 + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok + cat ${log_file} >> ${BORG_LOG_FILE} +fi + + +blank_line + + +# Set maintance mode off +# +echononl "Set maintance mode of NC to 'off'." + +echo "sudo -u ${HTTP_USER} ${PHP_COMMAND} ${NC_PATH}/occ maintenance:mode --off" >> ${BORG_LOG_FILE} + +sudo -u ${HTTP_USER} ${PHP_COMMAND} ${NC_PATH}/occ maintenance:mode --off > ${log_file} 2>&1 + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok +fi + + +# Remove DB local backup +# +echononl "Remove local DB backup.." + +echo "rm ${NC_DB_BACKUP_DIR}/${NC_DB}-${backup_date}.sql" >> ${BORG_LOG_FILE} + +rm ${NC_DB_BACKUP_DIR}/${NC_DB}-${backup_date}.sql > ${log_file} 2>&1 + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok +fi + +# Duration of backup +endTime=$(date +%s) +endDateReadable=$(date --date @"$endTime" +"%d.%m.%Y - %H:%M:%S") +duration=$((endTime-startTime)) +durationSec=$((duration % 60)) +durationMin=$(((duration / 60) % 60)) +durationHour=$((duration / 3600)) +durationReadable=$(printf "%02d hours %02d minutes %02d seconds" $durationHour $durationMin $durationSec) + +echo -e "\n\n###### Server backup finished on ${endDateReadable} (${durationReadable}) ######\n" >> ${BORG_LOG_FILE} + + +# Send Summery +# +if $terminal ; then + echo -e -n " Send Summary.." +fi + +datum="$(date +"%d.%m.%Y %H:%M")" + +filesystem_usage="$(df -h)" + +msg_head_line="\n\n# ---\n# Server backup finished on ${endDateReadable} (${durationReadable})\n# ---\n\n" + +msg="$(cat "${BORG_LOG_FILE}")" + +datum="$(date +"%d.%m.%Y")" + +content_type='Content-Type: text/plain;\n charset="utf-8"' + +subject="Borg Backup - ${COMPANY} - ${datum}" +subject_utf8="$(echo "$subject" | iconv -t UTF8)" +subject_utf8_encoded="=?utf-8?B?$(echo $subject_utf8 | base64 --wrap=0)?=" + + +cat <> ${BORG_LOG_FILE} + +echo -e "To:${ADMIN_EMAIL}\n${content_type}\nSubject:${subject_utf8_encoded}\n\${filesystem_usage}\n\${msg_head_line}\n\${msg}\n" | /usr/sbin/sendmail -F "BACKUP ${COMPANY}" -f ${FROM_ADDRESS} ${ADMIN_EMAIL} +EOF + + +echo -e "To:${ADMIN_EMAIL}\n${content_type}\nSubject:${subject_utf8_encoded}\n${filesystem_usage}\n${msg_head_line}\n${msg}\n" | /usr/sbin/sendmail -F "BACKUP ${COMPANY}" -f ${FROM_ADDRESS} ${ADMIN_EMAIL} > ${log_file} 2>&1 + + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok +fi + +blank_line + +echononl "Create temporary logorotate configuration file 'logrotate_borg.conf'.." + +cat << EOF > ${LOCK_DIR}/logrotate_borg.conf 2> ${log_file} +$(dirname "${BORG_LOG_FILE}")/* { + daily + rotate 7 + missingok + compress + su root root +} +EOF +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok +fi + +echononl "Rotate logfile '${BORG_LOG_FILE}'.." +logrotate ${LOCK_DIR}/logrotate_borg.conf > ${log_file} 2>&1 +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok +fi + +clean_up 0 diff --git a/borg2-backup.sh b/borg2-backup.sh new file mode 100755 index 0000000..8c9b55b --- /dev/null +++ b/borg2-backup.sh @@ -0,0 +1,772 @@ +#!/usr/bin/env bash + +script_name="$(basename $(realpath $0))" +working_dir="$(dirname $(realpath $0))" + +conf_file="${working_dir}/conf/${script_name%%.*}.conf" + +LOCK_DIR="/tmp/${script_name%%.*}.LOCK" +log_file="${LOCK_DIR}/${script_name%%.*}.log" + +backup_date="$(date +%Y-%m-%d-%H%M)" + +startTime=$(date +%s) +currentDate=$(date --date @"$startTime" +"%Y%m%d_%H%M%S") +currentDateReadable=$(date --date @"$startTime" +"%d.%m.%Y - %H:%M:%S") + + +# ---------- +# Base Function(s) +# ---------- + +clean_up() { + + # Perform program exit housekeeping + rm -f ${DB_BACKUP_DIR}/*-${backup_date}.sql + rm -rf "$LOCK_DIR" + blank_line + exit $1 +} + +echononl(){ + if $terminal ; then + + echo X\\c > /tmp/shprompt$$ + if [ `wc -c /tmp/shprompt$$ | awk '{print $1}'` -eq 1 ]; then + echo -e -n " $*\\c" 1>&2 + else + echo -e -n " $*" 1>&2 + fi + rm /tmp/shprompt$$ + + fi + + if [ -d "${BORG_LOG_DIR}" ]; then + echo "" >> ${BORG_LOG_FILE} + echo -e "# $*" >> ${BORG_LOG_FILE} + echo "#" >> ${BORG_LOG_FILE} + fi + +} + +fatal(){ + echo "" + if $terminal ; then + echo -e " [ \033[31m\033[1mFatal\033[m ]: $*" + echo "" + echo -e " \033[31m\033[1mScript was interupted\033[m!" + else + echo " [ Fatal ]: $*" + echo "" + echo " Script was terminated...." + fi + echo "" + clean_up 1 +} +error (){ + echo "" + if $terminal ; then + echo -e " [ \033[31m\033[1mError\033[m ]: $*" + else + echo "[ Error ]: $*" + fi + if [ -d "${BORG_LOG_DIR}" ]; then + echo "[ Error ]: $*" >> ${BORG_LOG_FILE} + fi +} + +warn (){ + echo "" + if $terminal ; then + echo -e " [ \033[33m\033[1mWarning\033[m ]: $*" + else + echo "[ Warning ]: $*" + fi + echo "" +} + +warn_only_terminal () { + if $terminal ; then + echo "" + echo -e "\t[ \033[33m\033[1mWarning\033[m ]: $*" + echo "" + fi +} + +info (){ + if $terminal ; then + echo "" + echo -e " [ \033[32m\033[1mInfo\033[m ] $*" + echo "" + fi +} + +ok (){ + if $terminal ; then + echo "" + echo -e " [ \033[32m\033[1mOk\033[m ] $*" + echo "" + fi +} + +echo_done() { + if $terminal ; then + echo -e "\033[75G[ \033[32mdone\033[m ]" + fi +} +echo_ok() { + if $terminal ; then + echo -e "\033[75G[ \033[32mok\033[m ]" + fi +} +echo_warn() { + if $terminal ; then + echo -e "\033[75G[ \033[33mwarn\033[m ]" + fi +} +echo_failed(){ + if $terminal ; then + echo -e "\033[75G[ \033[1;31mfailed\033[m ]" + fi +} +echo_skipped() { + if $terminal ; then + echo -e "\033[75G[ \033[90m\033[1mskipped\033[m ]" + fi +} +echo_wait(){ + if $terminal ; then + echo -en "\033[75G[ \033[5m\033[1m...\033[m ]" + fi +} + +trim() { + local var="$*" + var="${var#"${var%%[![:space:]]*}"}" # remove leading whitespace characters + var="${var%"${var##*[![:space:]]}"}" # remove trailing whitespace characters + echo -n "$var" +} + +blank_line() { + if $terminal ; then + echo "" + fi +} + +# ---------- +# - Some checks .. +# ---------- + +# - Running in a terminal? +# - +if [[ -t 1 ]] ; then + terminal=true +else + terminal=false +fi + + +# ========== +# - Begin Main Script +# ========== + +# ---------- +# - Headline +# ---------- + +if $terminal ; then + echo "" + +fi + + +# ========== +# - Begin Main Script +# ========== + +# ---------- +# - Headline +# ---------- + +if $terminal ; then + echo "" + echo -e "\033[1m----------\033[m" + echo -e "\033[32m\033[1mRunning script \033[m\033[1m$script_name\033[32m .. \033[m" + echo -e "\033[1m----------\033[m" + echo "" +fi + +# ---------- +# Default values +# ---------- + +DEFAULT_BORG_LOG_DIR="/var/log/borg/" + +DEFAULT_SSH_USER="borg" +DEFAULT_SSH_PORT=22 +DEFAULT_BORG_RSH='ssh -i /root/.ssh/id_ed25519-borg-backup' + +DEFAULT_DB_BACKUP_DIR="/data/backup/sql" + +DEFAULT_BACKUP_DIRECTORIES="/etc /home /root /var/spool/cron" + +DEFAULT_KEEP_DAILY=10 +DEFAULT_KEEP_WEEKLY=5 +DEFAULT_KEEP_MONTHLY=6 +DEFAULT_KEEP_YEARLY=1 + +DEFAULT_DB_TYPE="None" +DEFAULT_MYSQL_CREDENTIALS="-u root -S /run/mysqld/mysqld.sock" + +DEFAULT_PSQL_SYSTEM_USER="postgres" + +DEFAULT_ADMIN_EMAIL="root" +DEFAULT_COMPANY="O.OPEN" +DEFAULT_FROM_ADDRESS="borg-backup@$(hostname -f)" + + +# ---------- +# Read Configurations from $conf_file +# ---------- + +if [[ -f "$conf_file" ]]; then + source "$conf_file" +else + fatal "No configuration file '$conf_file' present!" +fi + + +# ------------- +# - Job is already running? +# ------------- + +[[ -z "${ADMIN_EMAIL}" ]] && ADMIN_EMAIL="${DEFAULT_ADMIN_EMAIL}" +[[ -z "${COMPANY}" ]] && COMPANY="${DEFAULT_COMPANY}" +[[ -z "${FROM_ADDRESS}" ]] && FROM_ADDRESS="${DEFAULT_FROM_ADDRESS}" + +# - If job already runs, stop execution.. +# - +if mkdir "$LOCK_DIR" 2> /dev/null ; then + + ## - Remove lockdir when the script finishes, or when it receives a signal + trap "clean_up 1" SIGHUP SIGINT SIGTERM + +else + + datum="$(date +"%d.%m.%Y %H:%M")" + + msg="[ Error ]: A previos instance of \"`basename $0`\" seems already be running.\n\n Exiting now.." + + datum="$(date +"%d.%m.%Y")" + + content_type='Content-Type: text/plain;\n charset="utf-8"' + + subject="Error Borg Backup - ${COMPANY} - ${datum}" + subject_utf8="$(echo "$subject" | iconv -t UTF8)" + subject_utf8_encoded="=?utf-8?B?$(echo $subject_utf8 | base64 --wrap=0)?=" + + echo -e "To:${ADMIN_EMAIL}\n${content_type}\nSubject:${subject_utf8_encoded}\n${msg}\n" | /usr/sbin/sendmail -F "Errors BACKUP ${COMPANY}" -f ${FROM_ADDRESS} ${ADMIN_EMAIL} + + echo "" + echo "[ Error ]: A previos instance of that script \"`basename $0`\" seems already be running." + echo "" + echo -e " Exiting now.." + echo "" + + exit 1 + +fi + + +# ---------- +# Set Parameter values +# ---------- + +if [[ -z "${BORG_PASSPHRASE}" ]] ; then + fatal "Borg Passphrase (BORG_PASSPHRASE) NOT found!" +fi + +if [[ -z "${BORG_HOST}" ]] ; then + fatal "Backup Hosth (var BORG_HOST) not given!" +fi + +if [[ -z "${BORG_REPO}" ]] ; then + fatal "Borg Repository Path (var BORG_REPO) not given!" +fi + +[[ -z "${SSH_USER}" ]] && SSH_USER="${DEFAULT_SSH_USER}" + +[[ -z "${SSH_PORT}" ]] && SSH_PORT="${DEFAULT_SSH_PORT}" + +[[ -z "${BORG_RSH}" ]] && BORG_RSH="${DEFAULT_BORG_RSH}" + +[[ -z "${DB_BACKUP_DIR}" ]] && DB_BACKUP_DIR="${DEFAULT_DB_BACKUP_DIR}" + +[[ -z "${BORG_LOG_DIR}" ]] && BORG_LOG_DIR="${DEFAULT_BORG_LOG_DIR}" +BORG_LOG_FILE="${BORG_LOG_DIR}/borg-backup.log" + +[[ -z "${KEEP_DAILY}" ]] && KEEP_DAILY=${DEFAULT_KEEP_DAILY} +[[ -z "${KEEP_WEEKLY}" ]] && KEEP_WEEKLY=${DEFAULT_KEEP_WEEKLY} +[[ -z "${KEEP_MONTHLY}" ]] && KEEP_MONTHLY=${DEFAULT_KEEP_MONTHLY} +[[ -z "${KEEP_YEARLY}" ]] && KEEP_YEARLY=${DEFAULT_KEEP_YEARLY} + + +[[ -z "${DB_TYPE}" ]] && DB_TYPE="${DEFAULT_DB_TYPE}" +if [[ "${DB_TYPE,,}" = "mysql" ]] ; then + [[ -z "${MYSQL_CREDENTIALS}" ]] && MYSQL_CREDENTIALS="${DEFAULT_MYSQL_CREDENTIALS}" +elif [[ "${DB_TYPE,,}" = "psql" ]] || [[ "${DB_TYPE,,}" = "postgresql" ]] || [[ "${DB_TYPE,,}" = "postgres" ]] ; then + [[ -z "${PSQL_SYSTEM_USER}" ]] && PSQL_SYSTEM_USER="${DEFAULT_PSQL_SYSTEM_USER}" +fi + + + +[[ -z "${BACKUP_DIRECTORIES}" ]] && BACKUP_DIRECTORIES="${DEFAULT_BACKUP_DIRECTORIES}" + +# By default: Borg won't follow symlinks +# +BORG_BACKUP_DIRS="" +for _dir in $BACKUP_DIRECTORIES ; do + if [[ -h "${_dir}" ]] ; then + BORG_BACKUP_DIRS="$BORG_BACKUP_DIRS $(realpath "${_dir}")" + fi + BORG_BACKUP_DIRS="$BORG_BACKUP_DIRS ${_dir}" +done + +# remove leading whitespace characters +# +BORG_BACKUP_DIRS="${BORG_BACKUP_DIRS#"${BORG_BACKUP_DIRS%%[![:space:]]*}"}" + +BORG_URL="ssh://${SSH_USER}@${BORG_HOST}:${SSH_PORT}${BORG_REPO}" + +#BORG_REPO="${BORG_URL}" + +ARCHIVE_NAME="${backup_date}" + +export BORG_PASSPHRASE + +# --- +# Some automatic 'answerers' (if set, they automatically answer confirmation questions): +# --- + +# For 'Warning: The repository at location … was previously located at ..' +# + +# This has to be set when the repository has been created by user and +# the script is called by cron +# +export BORG_RELOCATED_REPO_ACCESS_IS_OK=yes + +# For "Warning: The repository at location ... was previously located at ..." +# +export BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK=yes + + +if [ ! -d "${BORG_LOG_DIR}" ]; then + echononl "Create borg log directory.." + mkdir -p "${BORG_LOG_DIR}" > ${log_file} 2>&1 + if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" + + fatal "No log directory '${BORG_LOG_DIR}' present!" + + else + echo_ok + echo "mkdir -p \"${BORG_LOG_DIR}\"" >> ${BORG_LOG_FILE} + echo "" >> ${BORG_LOG_FILE} + fi +fi + +if [ ! -d "${DB_BACKUP_DIR}" ]; then + echononl "Create DB backup directory.." + mkdir -p "${DB_BACKUP_DIR}" > ${log_file} 2>&1 + if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" + + fatal "No backup directory '${DB_BACKUP_DIR}' present!" + + else + echo_ok + echo "mkdir -p \"${DB_BACKUP_DIR}\"" >> ${BORG_LOG_FILE} + echo "" >> ${BORG_LOG_FILE} + fi +fi + +echo "# ----------" >> ${BORG_LOG_FILE} +echo -e "# Running script '${script_name}' on $(date +%Y.%m.%d) at $(date +%H:%M) h .." >> ${BORG_LOG_FILE} +echo "# ----------" >> ${BORG_LOG_FILE} + + +echo "" >> ${BORG_LOG_FILE} +echo "# Script parameter settings:" >> ${BORG_LOG_FILE} +echo "#" >> ${BORG_LOG_FILE} + +echo "SSH_USER=\"${SSH_USER}\"" >> ${BORG_LOG_FILE} +echo "SSH_PORT=\"${SSH_PORT}\"" >> ${BORG_LOG_FILE} +echo "BORG_HOST=\"${BORG_HOST}\"" >> ${BORG_LOG_FILE} +echo "BORG_REPO=\"${BORG_REPO}\"" >> ${BORG_LOG_FILE} +echo "BORG_PASSPHRASE='${BORG_PASSPHRASE}'" >> ${BORG_LOG_FILE} +echo "BORG_RSH=\"${BORG_RSH}\"" >> ${BORG_LOG_FILE} +echo "BORG_LOG_DIR=\"${BORG_LOG_DIR}\"" >> ${BORG_LOG_FILE} +echo "BORG_URL=\"${BORG_URL}\"" >> ${BORG_LOG_FILE} +echo "" >> ${BORG_LOG_FILE} +echo "DB_TYPE=\"${DB_TYPE}\"" >> ${BORG_LOG_FILE} +echo "DB_BACKUP_DIR=\"${DB_BACKUP_DIR}\"" >> ${BORG_LOG_FILE} +echo "" >> ${BORG_LOG_FILE} +echo "ADMIN_EMAIL=\"${ADMIN_EMAIL}\"" >> ${BORG_LOG_FILE} +echo "COMPANY=\"${COMPANY}\"" >> ${BORG_LOG_FILE} +echo "FROM_ADDRESS=\"${FROM_ADDRESS}\"" >> ${BORG_LOG_FILE} +echo "" >> ${BORG_LOG_FILE} + +if [[ -n "${DB_TYPE}" ]] && [[ "${DB_TYPE,,}" = "!none" ]]; then + echo "" >> ${BORG_LOG_FILE} + echo "# ---" >> ${BORG_LOG_FILE} + echo "# Create database backup .." >> ${BORG_LOG_FILE} + echo "# ---" >> ${BORG_LOG_FILE} + + blank_line +fi + +if [[ "${DB_TYPE,,}" = "mysql" ]] ; then + + echononl "Create an array of MySQL databases." + + cat <> ${BORG_LOG_FILE} +declare -a mysql_database_arr=(); +for _db_name in \$(mysql -s -r -N -e 'show databases' 2> /dev/null ) ; do + + [[ "\${_db_name}" = "information_schema" ]] && continue + [[ "\${_db_name}" = "performance_schema" ]] && continue + [[ "\${_db_name}" = "mysql" ]] && continue + [[ "\${_db_name}" = "sys" ]] && continue + + mysql_database_arr+=("\${_db_name}") + +done +EOF + + declare -a mysql_database_arr=(); + for _db_name in $(mysql -s -r -N -e 'show databases' 2> ${log_file}) ; do + + [[ "${_db_name}" = "information_schema" ]] && continue + [[ "${_db_name}" = "performance_schema" ]] && continue + [[ "${_db_name}" = "mysql" ]] && continue + [[ "${_db_name}" = "sys" ]] && continue + + mysql_database_arr+=("${_db_name}") + + done + + if [[ -s "${log_file}" ]] ; then + echo_failed + error "$(cat "${log_file}")" + else + echo_ok + fi + + for _db in ${mysql_database_arr[@]} ; do + + echononl "Dump Database '${_db}'.." + + cat <> ${BORG_LOG_FILE} +mysqldump $MYSQL_CREDENTIALS \\ + --single-transaction --routines \\ + -h localhost \\ + -e ${_db} > ${DB_BACKUP_DIR}/${_db}-${backup_date}.sql + +EOF + + mysqldump $MYSQL_CREDENTIALS \ + --single-transaction --routines \ + -h localhost \ + -e ${_db} > ${DB_BACKUP_DIR}/${_db}-${backup_date}.sql 2> ${log_file} + + if [[ -s "${log_file}" ]] ; then + echo_failed + error "$(cat "${log_file}")" + else + echo_ok + fi + + done + +elif [[ "${DB_TYPE,,}" = "psql" ]] || [[ "${DB_TYPE,,}" = "postgresql" ]] || [[ "${DB_TYPE,,}" = "postgres" ]] ; then + + echononl "Create an array of PostgreSQL databases." + + cat <> ${BORG_LOG_FILE} +declare -a psql_database_arr=(); +for _db_name in \$(su - ${PSQL_SYSTEM_USER} -c "psql -lt" 2> /dev/null | grep -v -e"^$" | awk '{print\$1}') ; do + + [[ "\${_db_name}" = ""template0 ]] && continue + [[ "\${_db_name}" = ""template1 ]] && continue + [[ "\${_db_name}" = ""postgres ]] && continue + [[ "\${_db_name}" = "|" ]] && continue + [[ "\${_db_name}" = ":" ]] && continue + + psql_database_arr+=("\${_db_name}") + +done +EOF + + declare -a psql_database_arr=(); + for _db_name in $(su - ${PSQL_SYSTEM_USER} -c "psql -lt" 2> "${log_file}" | grep -v -e"^$" | awk '{print$1}') ; do + + [[ "${_db_name}" = ""template0 ]] && continue + [[ "${_db_name}" = ""template1 ]] && continue + [[ "${_db_name}" = ""postgres ]] && continue + [[ "${_db_name}" = "|" ]] && continue + [[ "${_db_name}" = ":" ]] && continue + + psql_database_arr+=("${_db_name}") + + done + + if [[ -s "${log_file}" ]] ; then + echo_failed + error "$(cat "${log_file}")" + else + echo_ok + fi + + for _db in ${psql_database_arr[@]} ; do + + echononl "Dump Database '${_db}'.." + + cat <> ${BORG_LOG_FILE} +su - ${PSQL_SYSTEM_USER} -c "pg_dump -c ${_db}" > ${DB_BACKUP_DIR}/${_db}-${backup_date}.sql +EOF + + su - ${PSQL_SYSTEM_USER} -c "pg_dump -c ${_db}" > ${DB_BACKUP_DIR}/${_db}-${backup_date}.sql 2> ${log_file} + + if [[ -s "${log_file}" ]] ; then + echo_failed + error "$(cat "${log_file}")" + else + echo_ok + fi + + done + +fi + + +echononl "Create borg backup.." + +cat << EOF >> ${BORG_LOG_FILE} +borg2 \\ + --remote-path borg2 \\ + --repo ${BORG_URL} \\ + create \\ + --verbose \\ + --filter AME \\ + --list \\ + --stats \\ + --show-rc \\ + --compression lz4 \\ + --exclude-caches \\ + --exclude 'home/*/.cache/*' \\ + --exclude '/root/.cache/*' \\ + --exclude '/root/.config/*' \\ + --exclude '/root/.local/*' \\ + --exclude 'var/tmp/*' \\ + ${ARCHIVE_NAME} \\ + ${DB_BACKUP_DIR} \\ + ${BORG_BACKUP_DIRS} +EOF + + +borg2 \ + --remote-path borg2 \ + --repo ${BORG_URL} \ + create \ + --verbose \ + --filter AME \ + --list \ + --stats \ + --show-rc \ + --compression lz4 \ + --exclude-caches \ + --exclude 'home/*/.cache/*' \ + --exclude '/root/.cache/*' \ + --exclude '/root/.config/*' \ + --exclude '/root/.local/*' \ + --exclude 'var/tmp/*' \ + ${ARCHIVE_NAME} \ + ${DB_BACKUP_DIR} \ + ${BORG_BACKUP_DIRS} \ + > ${log_file} 2>&1 + + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok + cat ${log_file} >> ${BORG_LOG_FILE} +fi + + +echononl "Pruning repository.." + +cat << EOF >> ${BORG_LOG_FILE} +borg2 \\ + --remote-path borg2 \\ + --repo ${BORG_URL} \\ + prune \\ + --list \\ + --show-rc \\ + --keep-daily ${KEEP_DAILY} \\ + --keep-weekly ${KEEP_WEEKLY} \\ + --keep-monthly ${KEEP_MONTHLY} \\ + --keep-yearly ${KEEP_YEARLY} \\ +EOF + +borg2 \ + --remote-path borg2 \ + --repo ${BORG_URL} \ + prune \ + --list \ + --show-rc \ + --keep-daily ${KEEP_DAILY} \ + --keep-weekly ${KEEP_WEEKLY} \ + --keep-monthly ${KEEP_MONTHLY} \ + --keep-yearly ${KEEP_YEARLY} \ + > ${log_file} 2>&1 + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok + cat ${log_file} >> ${BORG_LOG_FILE} +fi + + +echononl "Free repository space by deleting unused chunks..." + +cat << EOF >> ${BORG_LOG_FILE} +borg2 \\ + --remote-path borg2 \\ + --repo ${BORG_URL} \\ + compact +EOF + +borg2 \ + --remote-path borg2 \ + --repo ${BORG_URL} \ + compact \ + > ${log_file} 2>&1 + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok + cat ${log_file} >> ${BORG_LOG_FILE} +fi + +blank_line + + +# Remove DB local backup +# +echononl "Remove local DB backups.." + +echo "rm -f ${DB_BACKUP_DIR}/*-${backup_date}.sql" >> ${BORG_LOG_FILE} + +rm -f ${DB_BACKUP_DIR}/*-${backup_date}.sql > ${log_file} 2>&1 + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok +fi + +# Duration of backup +endTime=$(date +%s) +endDateReadable=$(date --date @"$endTime" +"%d.%m.%Y - %H:%M:%S") +duration=$((endTime-startTime)) +durationSec=$((duration % 60)) +durationMin=$(((duration / 60) % 60)) +durationHour=$((duration / 3600)) +durationReadable=$(printf "%02d hours %02d minutes %02d seconds" $durationHour $durationMin $durationSec) + +echo -e "\n\n###### Server backup finished on ${endDateReadable} (${durationReadable}) ######\n" >> ${BORG_LOG_FILE} + + +blank_line + + +# Send Summery +# +if $terminal ; then + echo -e -n " Send Summary.." +fi + +datum="$(date +"%d.%m.%Y %H:%M")" + +filesystem_usage="$(df -h)" + +msg_head_line="\n\n# ---\n# Server backup finished on ${endDateReadable} (${durationReadable})\n# ---\n\n" + +msg="$(cat "${BORG_LOG_FILE}")" + +datum="$(date +"%d.%m.%Y")" + +content_type='Content-Type: text/plain;\n charset="utf-8"' + +subject="Borg Backup - ${COMPANY} - ${datum}" +subject_utf8="$(echo "$subject" | iconv -t UTF8)" +subject_utf8_encoded="=?utf-8?B?$(echo $subject_utf8 | base64 --wrap=0)?=" + + +cat <> ${BORG_LOG_FILE} + +echo -e "To:${ADMIN_EMAIL}\n${content_type}\nSubject:${subject_utf8_encoded}\n\${filesystem_usage}\n\${msg_head_line}\n\${msg}\n" | /usr/sbin/sendmail -F "BACKUP ${COMPANY}" -f ${FROM_ADDRESS} ${ADMIN_EMAIL} +EOF + + +echo -e "To:${ADMIN_EMAIL}\n${content_type}\nSubject:${subject_utf8_encoded}\n${filesystem_usage}\n${msg_head_line}\n${msg}\n" | /usr/sbin/sendmail -F "BACKUP ${COMPANY}" -f ${FROM_ADDRESS} ${ADMIN_EMAIL} > ${log_file} 2>&1 + + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok +fi + +blank_line + +echononl "Create temporary logorotate configuration file 'logrotate_borg.conf'.." + +cat << EOF > ${LOCK_DIR}/logrotate_borg.conf 2> ${log_file} +$(dirname "${BORG_LOG_FILE}")/* { + daily + rotate 7 + missingok + compress + su root root +} +EOF +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok +fi + +echononl "Rotate logfile '${BORG_LOG_FILE}'.." +logrotate ${LOCK_DIR}/logrotate_borg.conf > ${log_file} 2>&1 +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok +fi + + +clean_up 0 diff --git a/borg2-delete-archive.sh b/borg2-delete-archive.sh new file mode 100755 index 0000000..45fc118 --- /dev/null +++ b/borg2-delete-archive.sh @@ -0,0 +1,318 @@ +#!/usr/bin/env bash + +script_name="$(basename $(realpath $0))" +working_dir="$(dirname $(realpath $0))" + + +if [[ -f "${working_dir}/conf/borg2-backup-nc.conf" ]] ; then + conf_file="${working_dir}/conf/borg2-backup-nc.conf" +else + conf_file="${working_dir}/conf/borg2-backup.conf" +fi + +LOCK_DIR="/tmp/${script_name%%.*}.LOCK" +log_file="${LOCK_DIR}/${script_name%%.*}.log" + + + +# ---------- +# Base Function(s) +# ---------- + +clean_up() { + + # Perform program exit housekeeping + rm -rf "$LOCK_DIR" + blank_line + exit $1 +} + +echononl(){ + if $terminal ; then + + echo X\\c > /tmp/shprompt$$ + if [ `wc -c /tmp/shprompt$$ | awk '{print $1}'` -eq 1 ]; then + echo -e -n " $*\\c" 1>&2 + else + echo -e -n " $*" 1>&2 + fi + rm /tmp/shprompt$$ + + fi + +} + +fatal(){ + echo "" + if $terminal ; then + echo -e " [ \033[31m\033[1mFatal\033[m ]: $*" + echo "" + echo -e " \033[31m\033[1mScript was interupted\033[m!" + else + echo " [ Fatal ]: $*" + echo "" + echo " Script was terminated...." + fi + echo "" + clean_up 1 +} +error (){ + echo "" + if $terminal ; then + echo -e " [ \033[31m\033[1mError\033[m ]: $*" + else + echo "[ Error ]: $*" + fi +} + +warn (){ + echo "" + if $terminal ; then + echo -e " [ \033[33m\033[1mWarning\033[m ]: $*" + else + echo "[ Warning ]: $*" + fi + echo "" +} + +warn_only_terminal () { + if $terminal ; then + echo "" + echo -e "\t[ \033[33m\033[1mWarning\033[m ]: $*" + echo "" + fi +} + +info (){ + if $terminal ; then + echo "" + echo -e " [ \033[32m\033[1mInfo\033[m ] $*" + echo "" + fi +} + +ok (){ + if $terminal ; then + echo "" + echo -e " [ \033[32m\033[1mOk\033[m ] $*" + echo "" + fi +} + +echo_done() { + if $terminal ; then + echo -e "\033[75G[ \033[32mdone\033[m ]" + fi +} +echo_ok() { + if $terminal ; then + echo -e "\033[75G[ \033[32mok\033[m ]" + fi +} +echo_warn() { + if $terminal ; then + echo -e "\033[75G[ \033[33mwarn\033[m ]" + fi +} +echo_failed(){ + if $terminal ; then + echo -e "\033[75G[ \033[1;31mfailed\033[m ]" + fi +} +echo_skipped() { + if $terminal ; then + echo -e "\033[75G[ \033[90m\033[1mskipped\033[m ]" + fi +} +echo_wait(){ + if $terminal ; then + echo -en "\033[75G[ \033[5m\033[1m...\033[m ]" + fi +} + +trim() { + local var="$*" + var="${var#"${var%%[![:space:]]*}"}" # remove leading whitespace characters + var="${var%"${var##*[![:space:]]}"}" # remove trailing whitespace characters + echo -n "$var" +} + +blank_line() { + if $terminal ; then + echo "" + fi +} + +# ---------- +# - Some checks .. +# ---------- + +# - Running in a terminal? +# - +if [[ -t 1 ]] ; then + terminal=true +else + terminal=false +fi + + +# ------------- +# - Job is already running? +# ------------- + +# - If job already runs, stop execution.. +# - +if mkdir "$LOCK_DIR" 2> /dev/null ; then + + ## - Remove lockdir when the script finishes, or when it receives a signal + trap "clean_up 1" SIGHUP SIGINT SIGTERM + +else + + datum="$(date +"%d.%m.%Y %H:%M")" + + msg="[ Error ]: A previos instance of \"`basename $0`\" seems already be running.\n\n Exiting now.." + + echo "" + echo "[ Error ]: A previos instance of that script \"`basename $0`\" seems already be running." + echo "" + echo -e " Exiting now.." + echo "" + + for _email in ${alert_email_arr[@]} ; do + echo -e "To:${_email}\n${content_type}\nSubject:Error cronjob `basename $0` -- $datum\n${msg}\n" \ + | sendmail -F "Error `hostname -f`" -f $sender_address $_email + done + + exit 1 + +fi + + +# ========== +# - Begin Main Script +# ========== + +# ---------- +# - Headline +# ---------- + +if $terminal ; then + echo "" + echo -e "\033[1m----------\033[m" + echo -e "\033[32m\033[1mRunning script \033[m\033[1m$script_name\033[32m .. \033[m" + echo -e "\033[1m----------\033[m" + echo "" +fi + +# ---------- +# Default values +# ---------- + +DEFAULT_SSH_USER="borg" +DEFAULT_SSH_PORT=22 +DEFAULT_BORG_RSH='ssh -i /root/.ssh/id_ed25519-borg-backup' + +DEFAULT_BORG_FUSE_MOUNT_DIR="/mnt/borg-fuse-mount" + +# ---------- +# Read Configurations from $conf_file +# ---------- + + +if [[ -f "$conf_file" ]]; then + source "$conf_file" +else + fatal "No configuration file '$conf_file' present!" +fi + + +# ---------- +# Set Parameter values +# ---------- + +#if [[ -z "${BORG_PASSPHRASE}" ]] ; then +# fatal "Borg Passphrase (BORG_PASSPHRASE) NOT found!" +#fi + +if [[ -z "${BORG_HOST}" ]] ; then + fatal "Backup Hosth (var BORG_HOST) not given!" +fi + +if [[ -z "${BORG_REPO}" ]] ; then + fatal "Borg Repository Path (var BORG_REPO) not given!" +fi + +[[ -z "${HTTP_USER}" ]] && HTTP_USER="${DEFAULT_HTTP_USER}" + +[[ -z "${SSH_USER}" ]] && SSH_USER="${DEFAULT_SSH_USER}" + +[[ -z "${SSH_PORT}" ]] && SSH_PORT="${DEFAULT_SSH_PORT}" + +[[ -z "${BORG_RSH}" ]] && BORG_RSH="${DEFAULT_BORG_RSH}" + +[[ -z "${BORG_FUSE_MOUNT_DIR}" ]] && BORG_FUSE_MOUNT_DIR="${DEFAULT_BORG_FUSE_MOUNT_DIR}" + +BORG_URL="ssh://${SSH_USER}@${BORG_HOST}:${SSH_PORT}${BORG_REPO}" + +export BORG_PASSPHRASE +export BORG_REPO +export BORG_RSH + +# --- +# Some automatic “answerers” (if set, they automatically answer confirmation questions): +# --- + +# For 'Warning: The repository at location … was previously located at ..' +# +BORG_RELOCATED_REPO_ACCESS_IS_OK=yes +export BORG_RELOCATED_REPO_ACCESS_IS_OK + +echononl "Create Restore Directory '${BORG_FUSE_MOUNT_DIR}'." +if [ ! -d "${BORG_FUSE_MOUNT_DIR}" ]; then + mkdir -p "${BORG_FUSE_MOUNT_DIR}" > ${log_file} 2>&1 + if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" + + fatal "No restore directory '${BORG_FUSE_MOUNT_DIR}' present!" + + else + echo_ok + fi +else + echo_skipped +fi + +blank_line + + +# List Borg Backups +# +( + source /root/bin/borg2-backup/borg2-list-backups.sh +) + +echo "" +echo -e " \033[33m--------------------------------------------\033[m" +echo " Which Borg Archiv shoulid be cedeleted?" +echo "" +echo " Give a Borg Backup ID from above list" +echo "" +echo -n " Borg Backup ID:: " +read BORG_BACKUP_ID +echo -e " \033[33m--------------------------------------------\033[m" +echo "" + +echononl "Delete archive '${BORG_REPO}::${BORG_BACKUP_ID}''.." + +borg2 --remote-path borg2 --repo ${BORG_URL} delete -a ${BORG_BACKUP_ID} >> "${log_file}" 2>&1 + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok +fi + +clean_up 0 diff --git a/borg2-list-backups.sh b/borg2-list-backups.sh new file mode 100755 index 0000000..2660d9f --- /dev/null +++ b/borg2-list-backups.sh @@ -0,0 +1,287 @@ +#!/usr/bin/env bash + +script_name="$(basename $(realpath $0))" +working_dir="$(dirname $(realpath $0))" + +if [[ -f "${working_dir}/conf/borg2-backup-nc.conf" ]] ; then + conf_file="${working_dir}/conf/borg2-backup-nc.conf" +else + conf_file="${working_dir}/conf/borg2-backup.conf" +fi + +LOCK_DIR="/tmp/${script_name%%.*}.LOCK" +log_file="${LOCK_DIR}/${script_name%%.*}.log" + +backup_date="$(date +%Y-%m-%d-%H%M)" + + +# ---------- +# Base Function(s) +# ---------- + +clean_up() { + + # Perform program exit housekeeping + blank_line + if [[ "${BASH_SOURCE[0]}" == "${0}" ]] ; then + rm -rf "$LOCK_DIR" + exit $1 + fi +} + +echononl(){ + if $terminal ; then + + echo X\\c > /tmp/shprompt$$ + if [ `wc -c /tmp/shprompt$$ | awk '{print $1}'` -eq 1 ]; then + echo -e -n " $*\\c" 1>&2 + else + echo -e -n " $*" 1>&2 + fi + rm /tmp/shprompt$$ + + fi + +} + +fatal(){ + echo "" + if $terminal ; then + echo -e " [ \033[31m\033[1mFatal\033[m ]: $*" + echo "" + echo -e " \033[31m\033[1mScript was interupted\033[m!" + else + echo " [ Fatal ]: $*" + echo "" + echo " Script was terminated...." + fi + echo "" + clean_up 1 +} +error (){ + echo "" + if $terminal ; then + echo -e " [ \033[31m\033[1mError\033[m ]: $*" + else + echo "[ Error ]: $*" + fi +} + +warn (){ + echo "" + if $terminal ; then + echo -e " [ \033[33m\033[1mWarning\033[m ]: $*" + else + echo "[ Warning ]: $*" + fi + echo "" +} + +warn_only_terminal () { + if $terminal ; then + echo "" + echo -e "\t[ \033[33m\033[1mWarning\033[m ]: $*" + echo "" + fi +} + +info (){ + if $terminal ; then + echo "" + echo -e " [ \033[32m\033[1mInfo\033[m ] $*" + echo "" + fi +} + +ok (){ + if $terminal ; then + echo "" + echo -e " [ \033[32m\033[1mOk\033[m ] $*" + echo "" + fi +} + +echo_done() { + if $terminal ; then + echo -e "\033[75G[ \033[32mdone\033[m ]" + fi +} +echo_ok() { + if $terminal ; then + echo -e "\033[75G[ \033[32mok\033[m ]" + fi +} +echo_warn() { + if $terminal ; then + echo -e "\033[75G[ \033[33mwarn\033[m ]" + fi +} +echo_failed(){ + if $terminal ; then + echo -e "\033[75G[ \033[1;31mfailed\033[m ]" + fi +} +echo_skipped() { + if $terminal ; then + echo -e "\033[75G[ \033[90m\033[1mskipped\033[m ]" + fi +} +echo_wait(){ + if $terminal ; then + echo -en "\033[75G[ \033[5m\033[1m...\033[m ]" + fi +} + +trim() { + local var="$*" + var="${var#"${var%%[![:space:]]*}"}" # remove leading whitespace characters + var="${var%"${var##*[![:space:]]}"}" # remove trailing whitespace characters + echo -n "$var" +} + +blank_line() { + if $terminal ; then + echo "" + fi +} + +# ---------- +# - Some checks .. +# ---------- + +# - Running in a terminal? +# - +if [[ -t 1 ]] ; then + terminal=true +else + terminal=false +fi + + +# ------------- +# - Job is already running? +# ------------- + +# - If job already runs, stop execution.. +# - +if [[ "${BASH_SOURCE[0]}" == "${0}" ]] ; then + if mkdir "$LOCK_DIR" 2> /dev/null ; then + + ## - Remove lockdir when the script finishes, or when it receives a signal + trap "clean_up 1" SIGHUP SIGINT SIGTERM + + else + + datum="$(date +"%d.%m.%Y %H:%M")" + + msg="[ Error ]: A previos instance of \"`basename $0`\" seems already be running.\n\n Exiting now.." + + echo "" + echo "[ Error ]: A previos instance of that script \"`basename $0`\" seems already be running." + echo "" + echo -e " Exiting now.." + echo "" + + for _email in ${alert_email_arr[@]} ; do + echo -e "To:${_email}\n${content_type}\nSubject:Error cronjob `basename $0` -- $datum\n${msg}\n" \ + | sendmail -F "Error `hostname -f`" -f $sender_address $_email + done + + exit 1 + + fi +fi + + +# ========== +# - Begin Main Script +# ========== + +# ---------- +# - Headline +# ---------- + +if $terminal ; then + if [[ "${BASH_SOURCE[0]}" == "${0}" ]] ; then + echo "" + echo -e "\033[1m----------\033[m" + echo -e "\033[32m\033[1mRunning script \033[m\033[1m$script_name\033[32m .. \033[m" + echo -e "\033[1m----------\033[m" + echo "" + fi +fi + +# ---------- +# Default values +# ---------- + +DEFAULT_SSH_USER="borg" +DEFAULT_SSH_PORT=22 +DEFAULT_BORG_RSH='ssh -i /root/.ssh/id_ed25519-borg-backup' + + +# ---------- +# Read Configurations from $conf_file +# ---------- + + +if [[ -f "$conf_file" ]]; then + source "$conf_file" +else + fatal "No configuration file '$conf_file' present!" +fi + + +# ---------- +# Set Parameter values +# ---------- + +#if [[ -z "${BORG_PASSPHRASE}" ]] ; then +# fatal "Borg Passphrase (BORG_PASSPHRASE) NOT found!" +#fi + +if [[ -z "${BORG_HOST}" ]] ; then + fatal "Backup Hosth (var BORG_HOST) not given!" +fi + +if [[ -z "${BORG_REPO}" ]] ; then + fatal "Borg Repository Path (var BORG_REPO) not given!" +fi + +[[ -z "${HTTP_USER}" ]] && HTTP_USER="${DEFAULT_HTTP_USER}" + +[[ -z "${SSH_USER}" ]] && SSH_USER="${DEFAULT_SSH_USER}" + +[[ -z "${SSH_PORT}" ]] && SSH_PORT="${DEFAULT_SSH_PORT}" + +[[ -z "${BORG_RSH}" ]] && BORG_RSH="${DEFAULT_BORG_RSH}" + +BORG_URL="ssh://${SSH_USER}@${BORG_HOST}:${SSH_PORT}${BORG_REPO}" + +export BORG_PASSPHRASE +export BORG_REPO +export BORG_RSH + +# --- +# Some automatic “answerers” (if set, they automatically answer confirmation questions): +# --- + +# For 'Warning: The repository at location … was previously located at ..' +# +BORG_RELOCATED_REPO_ACCESS_IS_OK=yes +export BORG_RELOCATED_REPO_ACCESS_IS_OK + + + +# List Borg Backups +# + +echo -e " \033[1mDate\033[33GBorg Backup ID\033[m\n" + +while read -r _borg_id _date_weekday _date_date _date_time _time_stamp_borg_backup || [[ -n $_line ]] ; do + + echo -e " ${_date_weekday} ${_date_date} ${_date_time} [ \033[33m${_borg_id}\033[m ]" + +done < <(borg2 --remote-path borg2 --repo ${BORG_URL} rlist) + +clean_up 0 diff --git a/borg2-mount-archiv.sh b/borg2-mount-archiv.sh new file mode 100755 index 0000000..5cfc464 --- /dev/null +++ b/borg2-mount-archiv.sh @@ -0,0 +1,320 @@ +#!/usr/bin/env bash + +script_name="$(basename $(realpath $0))" +working_dir="$(dirname $(realpath $0))" + + +if [[ -f "${working_dir}/conf/borg2-backup-nc.conf" ]] ; then + conf_file="${working_dir}/conf/borg2-backup-nc.conf" +else + conf_file="${working_dir}/conf/borg2-backup.conf" +fi + +LOCK_DIR="/tmp/${script_name%%.*}.LOCK" +log_file="${LOCK_DIR}/${script_name%%.*}.log" + + + +# ---------- +# Base Function(s) +# ---------- + +clean_up() { + + # Perform program exit housekeeping + rm -rf "$LOCK_DIR" + blank_line + exit $1 +} + +echononl(){ + if $terminal ; then + + echo X\\c > /tmp/shprompt$$ + if [ `wc -c /tmp/shprompt$$ | awk '{print $1}'` -eq 1 ]; then + echo -e -n " $*\\c" 1>&2 + else + echo -e -n " $*" 1>&2 + fi + rm /tmp/shprompt$$ + + fi + +} + +fatal(){ + echo "" + if $terminal ; then + echo -e " [ \033[31m\033[1mFatal\033[m ]: $*" + echo "" + echo -e " \033[31m\033[1mScript was interupted\033[m!" + else + echo " [ Fatal ]: $*" + echo "" + echo " Script was terminated...." + fi + echo "" + clean_up 1 +} +error (){ + echo "" + if $terminal ; then + echo -e " [ \033[31m\033[1mError\033[m ]: $*" + else + echo "[ Error ]: $*" + fi +} + +warn (){ + echo "" + if $terminal ; then + echo -e " [ \033[33m\033[1mWarning\033[m ]: $*" + else + echo "[ Warning ]: $*" + fi + echo "" +} + +warn_only_terminal () { + if $terminal ; then + echo "" + echo -e "\t[ \033[33m\033[1mWarning\033[m ]: $*" + echo "" + fi +} + +info (){ + if $terminal ; then + echo "" + echo -e " [ \033[32m\033[1mInfo\033[m ] $*" + echo "" + fi +} + +ok (){ + if $terminal ; then + echo "" + echo -e " [ \033[32m\033[1mOk\033[m ] $*" + echo "" + fi +} + +echo_done() { + if $terminal ; then + echo -e "\033[75G[ \033[32mdone\033[m ]" + fi +} +echo_ok() { + if $terminal ; then + echo -e "\033[75G[ \033[32mok\033[m ]" + fi +} +echo_warn() { + if $terminal ; then + echo -e "\033[75G[ \033[33mwarn\033[m ]" + fi +} +echo_failed(){ + if $terminal ; then + echo -e "\033[75G[ \033[1;31mfailed\033[m ]" + fi +} +echo_skipped() { + if $terminal ; then + echo -e "\033[75G[ \033[90m\033[1mskipped\033[m ]" + fi +} +echo_wait(){ + if $terminal ; then + echo -en "\033[75G[ \033[5m\033[1m...\033[m ]" + fi +} + +trim() { + local var="$*" + var="${var#"${var%%[![:space:]]*}"}" # remove leading whitespace characters + var="${var%"${var##*[![:space:]]}"}" # remove trailing whitespace characters + echo -n "$var" +} + +blank_line() { + if $terminal ; then + echo "" + fi +} + +# ---------- +# - Some checks .. +# ---------- + +# - Running in a terminal? +# - +if [[ -t 1 ]] ; then + terminal=true +else + terminal=false +fi + + +# ------------- +# - Job is already running? +# ------------- + +# - If job already runs, stop execution.. +# - +if mkdir "$LOCK_DIR" 2> /dev/null ; then + + ## - Remove lockdir when the script finishes, or when it receives a signal + trap "clean_up 1" SIGHUP SIGINT SIGTERM + +else + + datum="$(date +"%d.%m.%Y %H:%M")" + + msg="[ Error ]: A previos instance of \"`basename $0`\" seems already be running.\n\n Exiting now.." + + echo "" + echo "[ Error ]: A previos instance of that script \"`basename $0`\" seems already be running." + echo "" + echo -e " Exiting now.." + echo "" + + for _email in ${alert_email_arr[@]} ; do + echo -e "To:${_email}\n${content_type}\nSubject:Error cronjob `basename $0` -- $datum\n${msg}\n" \ + | sendmail -F "Error `hostname -f`" -f $sender_address $_email + done + + exit 1 + +fi + + +# ========== +# - Begin Main Script +# ========== + +# ---------- +# - Headline +# ---------- + +if $terminal ; then + echo "" + echo -e "\033[1m----------\033[m" + echo -e "\033[32m\033[1mRunning script \033[m\033[1m$script_name\033[32m .. \033[m" + echo -e "\033[1m----------\033[m" + echo "" +fi + +# ---------- +# Default values +# ---------- + +DEFAULT_SSH_USER="borg" +DEFAULT_SSH_PORT=22 +DEFAULT_BORG_RSH='ssh -i /root/.ssh/id_ed25519-borg-backup' + +DEFAULT_BORG_FUSE_MOUNT_DIR="/mnt/borg-fuse-mount" + +# ---------- +# Read Configurations from $conf_file +# ---------- + + +if [[ -f "$conf_file" ]]; then + source "$conf_file" +else + fatal "No configuration file '$conf_file' present!" +fi + + +# ---------- +# Set Parameter values +# ---------- + +#if [[ -z "${BORG_PASSPHRASE}" ]] ; then +# fatal "Borg Passphrase (BORG_PASSPHRASE) NOT found!" +#fi + +if [[ -z "${BORG_HOST}" ]] ; then + fatal "Backup Hosth (var BORG_HOST) not given!" +fi + +if [[ -z "${BORG_REPO}" ]] ; then + fatal "Borg Repository Path (var BORG_REPO) not given!" +fi + +[[ -z "${HTTP_USER}" ]] && HTTP_USER="${DEFAULT_HTTP_USER}" + +[[ -z "${SSH_USER}" ]] && SSH_USER="${DEFAULT_SSH_USER}" + +[[ -z "${SSH_PORT}" ]] && SSH_PORT="${DEFAULT_SSH_PORT}" + +[[ -z "${BORG_RSH}" ]] && BORG_RSH="${DEFAULT_BORG_RSH}" + +[[ -z "${BORG_FUSE_MOUNT_DIR}" ]] && BORG_FUSE_MOUNT_DIR="${DEFAULT_BORG_FUSE_MOUNT_DIR}" + +BORG_URL="ssh://${SSH_USER}@${BORG_HOST}:${SSH_PORT}${BORG_REPO}" + +export BORG_PASSPHRASE +export BORG_REPO +export BORG_RSH + +# --- +# Some automatic “answerers” (if set, they automatically answer confirmation questions): +# --- + +# For 'Warning: The repository at location … was previously located at ..' +# +BORG_RELOCATED_REPO_ACCESS_IS_OK=yes +export BORG_RELOCATED_REPO_ACCESS_IS_OK + +echononl "Create Restore Directory '${BORG_FUSE_MOUNT_DIR}'." +if [ ! -d "${BORG_FUSE_MOUNT_DIR}" ]; then + mkdir -p "${BORG_FUSE_MOUNT_DIR}" > ${log_file} 2>&1 + if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" + + fatal "No restore directory '${BORG_FUSE_MOUNT_DIR}' present!" + + else + echo_ok + fi +else + echo_skipped +fi + +blank_line + + +# List Borg Backups +# +( + source /root/bin/borg2-backup/borg2-list-backups.sh +) + +echo "" +echo -e " \033[33m--------------------------------------------\033[m" +echo " Which Borg Archiv shoul be mounted?" +echo "" +echo -e " \033[33mNote:\033[m it is an read-only fuse filesystem!" +echo "" +echo " Give a Borg Backup ID from above list" +echo "" +echo -n " Borg Backup ID:: " +read BORG_BACKUP_ID +echo -e " \033[33m--------------------------------------------\033[m" +echo "" + +echononl "Mount archive '${BORG_REPO}::${BORG_BACKUP_ID}' to '${BORG_FUSE_MOUNT_DIR}'.." + +borg2 --remote-path borg2 --repo ${BORG_URL} mount -a ${BORG_BACKUP_ID} ${BORG_FUSE_MOUNT_DIR} >> "${log_file}" 2>&1 + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok +fi + +clean_up 0 diff --git a/borg2-umount-archiv.sh b/borg2-umount-archiv.sh new file mode 100755 index 0000000..22a2677 --- /dev/null +++ b/borg2-umount-archiv.sh @@ -0,0 +1,282 @@ +#!/usr/bin/env bash + +script_name="$(basename $(realpath $0))" +working_dir="$(dirname $(realpath $0))" + + +if [[ -f "${working_dir}/conf/borg2-backup-nc.conf" ]] ; then + conf_file="${working_dir}/conf/borg2-backup-nc.conf" +else + conf_file="${working_dir}/conf/borg2-backup.conf" +fi + +LOCK_DIR="/tmp/${script_name%%.*}.LOCK" +log_file="${LOCK_DIR}/${script_name%%.*}.log" + + + +# ---------- +# Base Function(s) +# ---------- + +clean_up() { + + # Perform program exit housekeeping + rm -rf "$LOCK_DIR" + blank_line + exit $1 +} + +echononl(){ + if $terminal ; then + + echo X\\c > /tmp/shprompt$$ + if [ `wc -c /tmp/shprompt$$ | awk '{print $1}'` -eq 1 ]; then + echo -e -n " $*\\c" 1>&2 + else + echo -e -n " $*" 1>&2 + fi + rm /tmp/shprompt$$ + + fi + +} + +fatal(){ + echo "" + if $terminal ; then + echo -e " [ \033[31m\033[1mFatal\033[m ]: $*" + echo "" + echo -e " \033[31m\033[1mScript was interupted\033[m!" + else + echo " [ Fatal ]: $*" + echo "" + echo " Script was terminated...." + fi + echo "" + clean_up 1 +} +error (){ + echo "" + if $terminal ; then + echo -e " [ \033[31m\033[1mError\033[m ]: $*" + else + echo "[ Error ]: $*" + fi +} + +warn (){ + echo "" + if $terminal ; then + echo -e " [ \033[33m\033[1mWarning\033[m ]: $*" + else + echo "[ Warning ]: $*" + fi + echo "" +} + +warn_only_terminal () { + if $terminal ; then + echo "" + echo -e "\t[ \033[33m\033[1mWarning\033[m ]: $*" + echo "" + fi +} + +info (){ + if $terminal ; then + echo "" + echo -e " [ \033[32m\033[1mInfo\033[m ] $*" + echo "" + fi +} + +ok (){ + if $terminal ; then + echo "" + echo -e " [ \033[32m\033[1mOk\033[m ] $*" + echo "" + fi +} + +echo_done() { + if $terminal ; then + echo -e "\033[75G[ \033[32mdone\033[m ]" + fi +} +echo_ok() { + if $terminal ; then + echo -e "\033[75G[ \033[32mok\033[m ]" + fi +} +echo_warn() { + if $terminal ; then + echo -e "\033[75G[ \033[33mwarn\033[m ]" + fi +} +echo_failed(){ + if $terminal ; then + echo -e "\033[75G[ \033[1;31mfailed\033[m ]" + fi +} +echo_skipped() { + if $terminal ; then + echo -e "\033[75G[ \033[90m\033[1mskipped\033[m ]" + fi +} +echo_wait(){ + if $terminal ; then + echo -en "\033[75G[ \033[5m\033[1m...\033[m ]" + fi +} + +trim() { + local var="$*" + var="${var#"${var%%[![:space:]]*}"}" # remove leading whitespace characters + var="${var%"${var##*[![:space:]]}"}" # remove trailing whitespace characters + echo -n "$var" +} + +blank_line() { + if $terminal ; then + echo "" + fi +} + +# ---------- +# - Some checks .. +# ---------- + +# - Running in a terminal? +# - +if [[ -t 1 ]] ; then + terminal=true +else + terminal=false +fi + + +# ------------- +# - Job is already running? +# ------------- + +# - If job already runs, stop execution.. +# - +if mkdir "$LOCK_DIR" 2> /dev/null ; then + + ## - Remove lockdir when the script finishes, or when it receives a signal + trap "clean_up 1" SIGHUP SIGINT SIGTERM + +else + + datum="$(date +"%d.%m.%Y %H:%M")" + + msg="[ Error ]: A previos instance of \"`basename $0`\" seems already be running.\n\n Exiting now.." + + echo "" + echo "[ Error ]: A previos instance of that script \"`basename $0`\" seems already be running." + echo "" + echo -e " Exiting now.." + echo "" + + for _email in ${alert_email_arr[@]} ; do + echo -e "To:${_email}\n${content_type}\nSubject:Error cronjob `basename $0` -- $datum\n${msg}\n" \ + | sendmail -F "Error `hostname -f`" -f $sender_address $_email + done + + exit 1 + +fi + + +# ========== +# - Begin Main Script +# ========== + +# ---------- +# - Headline +# ---------- + +if $terminal ; then + echo "" + echo -e "\033[1m----------\033[m" + echo -e "\033[32m\033[1mRunning script \033[m\033[1m$script_name\033[32m .. \033[m" + echo -e "\033[1m----------\033[m" + echo "" +fi + +# ---------- +# Default values +# ---------- + +DEFAULT_SSH_USER="borg" +DEFAULT_SSH_PORT=22 +DEFAULT_BORG_RSH='ssh -i /root/.ssh/id_ed25519-borg-backup' + +DEFAULT_BORG_FUSE_MOUNT_DIR="/mnt/borg-fuse-mount" + +# ---------- +# Read Configurations from $conf_file +# ---------- + + +if [[ -f "$conf_file" ]]; then + source "$conf_file" +else + fatal "No configuration file '$conf_file' present!" +fi + + +# ---------- +# Set Parameter values +# ---------- + +#if [[ -z "${BORG_PASSPHRASE}" ]] ; then +# fatal "Borg Passphrase (BORG_PASSPHRASE) NOT found!" +#fi + +if [[ -z "${BORG_HOST}" ]] ; then + fatal "Backup Hosth (var BORG_HOST) not given!" +fi + +if [[ -z "${BORG_REPO}" ]] ; then + fatal "Borg Repository Path (var BORG_REPO) not given!" +fi + +[[ -z "${HTTP_USER}" ]] && HTTP_USER="${DEFAULT_HTTP_USER}" + +[[ -z "${SSH_USER}" ]] && SSH_USER="${DEFAULT_SSH_USER}" + +[[ -z "${SSH_PORT}" ]] && SSH_PORT="${DEFAULT_SSH_PORT}" + +[[ -z "${BORG_RSH}" ]] && BORG_RSH="${DEFAULT_BORG_RSH}" + +[[ -z "${BORG_FUSE_MOUNT_DIR}" ]] && BORG_FUSE_MOUNT_DIR="${DEFAULT_BORG_FUSE_MOUNT_DIR}" + +BORG_URL="ssh://${SSH_USER}@${BORG_HOST}:${SSH_PORT}${BORG_REPO}" + +export BORG_PASSPHRASE +export BORG_REPO +export BORG_RSH + +# --- +# Some automatic “answerers” (if set, they automatically answer confirmation questions): +# --- + +# For 'Warning: The repository at location … was previously located at ..' +# +BORG_RELOCATED_REPO_ACCESS_IS_OK=yes +export BORG_RELOCATED_REPO_ACCESS_IS_OK + +echononl "Unmount fuse filesystem mounted at '${BORG_FUSE_MOUNT_DIR}'.." + +borg2 umount ${BORG_FUSE_MOUNT_DIR} >> "${log_file}" 2>&1 + +if [[ $? -gt 0 ]] ; then + echo_failed + error "$(cat "${log_file}")" +else + echo_ok +fi + +clean_up 0 diff --git a/conf/borg2-backup-nc.conf.sample b/conf/borg2-backup-nc.conf.sample new file mode 100644 index 0000000..cb9ca0e --- /dev/null +++ b/conf/borg2-backup-nc.conf.sample @@ -0,0 +1,226 @@ +#----------------------------- +# Settings for script borg2-backup-nc.sh +#----------------------------- + +# HTTP_USER +# +# User under which the webserver is running +# +# Defaults to: +# +# HTTP_USER="www-data" +# +#HTTP_USER="www-data" + + +# SSH_USER +# +# The (remote) user under which the SSH session for the +# data transfer is running. +# +# Defaults to: +# +# SSH_USER="borg" +# +#BACKUP_USER="borg" + + +# SSH_PORT +# +# The port under which the SSH service is accessible +# +# Defaults to: +# +# SSH_PORT=22 +# +#SSH_PORT=22 + + +# BORG_HOST +# +# The (remote) host on which the backups are saved. +# +# !! No Defaults - this parameter is mandatory +# +#BORG_HOST="" + + +# BORG_RSH +# +# The command, which is used instead of ssh. +# +# This can be used to specify ssh options, such as a custom identity file +# ssh -i /path/to/private/key. See man ssh for other options. +# +# Using the --rsh CMD commandline option overrides the environment variable. +# +# Defaults to: +# BORG_RSH='ssh -i /root/.ssh/id_ed25519-borg-backup' +# +#BORG_RSH='ssh -i /root/.ssh/id_ed25519-borg-backup' + + +# BORG_PASSPHRASE +# +# Password of the Borg Repository (which was used while initializing) +# +# !! No Defaults - this parameter is mandatory +# +#BORG_PASSPHRASE='borg-password>' + + +# BORG_REPO +# +# The repository location on the (remote) backup host. +# +# !! No Defaults - this parameter is mandatory +# +#BORG_REPO= + + +# BORG_LOG_DIR +# +# Log to this directory +# +# Defaults to: +# +# BORG_LOG_DIR="/var/log/borg" +# +#BORG_LOG_DIR="/var/log/borg" + + +# --- +# NC related parameters +# --- + +# NC_PATH +# +# Path to the Nextcloud (NC) installation directory (mostly the DocumenRoot +# directory) +# +# !! No Defaults - this parameter is mandatory +# +#NC_PATH="" + + +# NC_DB_BACKUP_DIR +# +# Directory in which a current database dump is stored and transferred to the repository +# +# Defaults to: +# +# NC_DB_BACKUP_DIR="/data/backup/sql" +# +#NC_DB_BACKUP_DIR="/data/backup/sql" + + +# --- +# Other Backups +# --- + +# BACKUP_OTHER_DIRECTORIES +# +# Directories other than NextCloud that should also be backed up +# +# Defaults to: +# +# BACKUP_OTHER_DIRECTORIES="/etc /home /root /var/spool/cron" +# +# - Blank separated list of directories - +# +#BACKUP_OTHER_DIRECTORIES="/etc /home /root /var/spool/cron" + + +# KEEP_DAILY +# +# Number of daily archives to keep +# +# Defaults to: +# +# KEEP_DAILY=10 +# +#KEEP_DAILY=10 + + +# KEEP_WEEKLY +# +# Number of weekly archives to keep +# +# Defaults to: +# +# KEEP_WEEKLY=5 +# +#KEEP_WEEKLY=5 + + +# KEEP_MONTHLY +# +# Number of monthly archives to keep +# +# Defaults to: +# +# KEEP_MONTHLY=6 +# +#KEEP_MONTHLY=6 + + +# KEEP_YEARLY +# +# Number of yearly archives to keep +# +# Defaults to: +# +# KEEP_YEARLY=1 +# +#KEEP_YEARLY=1 + + +# --- +# Restore Parameters +# --- + +# BORG_FUSE_MOUNT_DIR +# +# Mountpoint where to mount an borg backup archiv as a FUSE filesystem. +# +# Defaults to: +# +# BORG_MOUNT_FUSE_DIR="/mnt/borg-fuse-mount" +# +#BORG_MOUNT_FUSE_DIR="/mnt/borg-fuse-mount" + + +# --- +# Alert Parameters +# --- + +# ADMIN_EMAIL +# +# Send Informations about the backup prozess to this e-mail address +# +# Defaults to: +# +# ADMIN_EMAIL="root" +# +#ADMIN_EMAIL="root" + + +# FROM_ADDRESS +# +# Defaults to: +# +# "borg-backup@$(hostname -f)" +# +#FROM_ADDRESS="" + + +# COMPANY +# +# DEFAULTS to +# Defaults to: +# +# COMPANY="O.OPEN" +# +#COMPANY="O.OPEN" + + diff --git a/conf/borg2-backup.conf.sample b/conf/borg2-backup.conf.sample new file mode 100644 index 0000000..0a3087b --- /dev/null +++ b/conf/borg2-backup.conf.sample @@ -0,0 +1,261 @@ +#----------------------------- +# Settings for script borg2-backup-nc.sh +#----------------------------- + +# SSH_USER +# +# The (remote) user under which the SSH session for the +# data transfer is running. +# +# Defaults to: +# +# SSH_USER="borg" +# +#BACKUP_USER="borg" + + +# SSH_PORT +# +# The port under which the SSH service is accessible +# +# Defaults to: +# +# SSH_PORT=22 +# +#SSH_PORT=22 + + +# BORG_HOST +# +# The (remote) host on which the backups are saved. +# +# !! No Defaults - this parameter is mandatory +# +#BORG_HOST="" + + +# BORG_RSH +# +# The command, which is used instead of ssh. +# +# This can be used to specify ssh options, such as a custom identity file +# ssh -i /path/to/private/key. See man ssh for other options. +# +# Using the --rsh CMD commandline option overrides the environment variable. +# +# Defaults to: +# BORG_RSH='ssh -i /root/.ssh/id_ed25519-borg-backup' +# +#BORG_RSH='ssh -i /root/.ssh/id_ed25519-borg-backup' + + +# BORG_PASSPHRASE +# +# Password of the Borg Repository (which was used while initializing) +# +# !! No Defaults - this parameter is mandatory +# +#BORG_PASSPHRASE='borg-password' + + +# BORG_REPO +# +# The repository location on the (remote) backup host. +# +# !! No Defaults - this parameter is mandatory +# +#BORG_REPO= + + +# BORG_LOG_DIR +# +# Log to this directory +# +# Defaults to: +# +# BORG_LOG_DIR="/var/log/borg" +# +#BORG_LOG_DIR="/var/log/borg" + + +# --- +# DB related parameters +# --- + +# DB_TYPE +# +# Which database ist installed? +# +# possible values: +# - MySQL +# - PostgreSQL or postgres or psql +# - None +# +# Defaults to: +# +# DB_TYPE = "None" +# +# DB_TYPE = "None" + +# MYSQL_CREDENTIALS +# +# Giving password on command line is insecure an sind mysql 5.5 +# you will get a warning doing so. +# +# Reading username/password fro file ist also possible, using MySQL/MariaDB +# commandline parameter '--defaults-file'. +# +# Since Version 5.6, that method is considered as insecure. +# To avoid giving the password on command line, we use an +# encrypted option file +# +# Create (encrypted) option file: +# $ mysql_config_editor set --login-path=local --socket=/var/run/mysqld/mysqld.sock --user=backup --password +# $ Password: +# +# Use of option file: +# $ mysql --login-path=local ... +# +# Example +# MYSQL_CREDENTIALS="--login-path=local" +# MYSQL_CREDENTIALS="--defaults-file=/etc/mysql/debian.cnf" (Debian default) +# MYSQL_CREDENTIALS="--defaults-file=/usr/local/mysql/sys-maint.cnf" +# +# Defaults to: +# +# MYSQL_CREDENTIALS="-u root -S /run/mysqld/mysqld.sock" +# +#MYSQL_CREDENTIALS="-u root -S /run/mysqld/mysqld.sock" + + +# PSQL_SYSTEM_USER +# +# User who owns PostgreSQL services +# +# Defaults to: +# +# PSQL_SYSTEM_USER="postgres" +# +#PSQL_SYSTEM_USER="postgres" + + +# DB_BACKUP_DIR +# +# Directory in which current database dumps are stored (and transferred to the repository) +# +# Defaults to: +# +# DB_BACKUP_DIR="/data/backup/sql" +# +#DB_BACKUP_DIR="/data/backup/sql" + + +# --- +# Backups directories +# --- + +# BACKUP_DIRECTORIES +# +# Directories (or files) that should be backed up +# +# Defaults to: +# +# BACKUP_DIRECTORIES="/etc /home /root /var/spool/cron" +# +# - Blank separated list of directories - +# +#BACKUP_DIRECTORIES="/etc /home /root /var/spool/cron" + + +# KEEP_DAILY +# +# Number of daily archives to keep +# +# Defaults to: +# +# KEEP_DAILY=10 +# +#KEEP_DAILY=10 + + +# KEEP_WEEKLY +# +# Number of weekly archives to keep +# +# Defaults to: +# +# KEEP_WEEKLY=5 +# +#KEEP_WEEKLY=5 + + +# KEEP_MONTHLY +# +# Number of monthly archives to keep +# +# Defaults to: +# +# KEEP_MONTHLY=6 +# +#KEEP_MONTHLY=6 + + +# KEEP_YEARLY +# +# Number of yearly archives to keep +# +# Defaults to: +# +# KEEP_YEARLY=1 +# +#KEEP_YEARLY=1 + + +# --- +# Restore Parameters +# --- + +# BORG_FUSE_MOUNT_DIR +# +# Mountpoint where to mount an borg backup archiv as a FUSE filesystem. +# +# Defaults to: +# +# BORG_MOUNT_FUSE_DIR="/mnt/borg-fuse-mount" +# +#BORG_MOUNT_FUSE_DIR="/mnt/borg-fuse-mount" + + +# --- +# Alert Parameters +# --- + +# ADMIN_EMAIL +# +# Send Informations about the backup prozess to this e-mail address +# +# Defaults to: +# +# ADMIN_EMAIL="root" +# +#ADMIN_EMAIL="root" + + +# FROM_ADDRESS +# +# Defaults to: +# +# "borg-backup@$(hostname -f)" +# +#FROM_ADDRESS="" + + +# COMPANY +# +# DEFAULTS to +# Defaults to: +# +# COMPANY="O.OPEN" +# +#COMPANY="O.OPEN" +