Set proper default values for core settings.

If nothing set in the settings file some entries need to be default set:
COMPRESSION
COMPRESSION_LEVEL
ENCRYPTION
FORCE_CHECK
KEEP_LAST
KEEP_HOURS
KEEP_DAYS
KEEP_WEEKS
KEEP_MONTHS
KEEP_YEARS

If these variables are empty after settings file is ready they are set
to the default value. After that the sub configs override those settings

Readme.md

@@ -35,6 +35,18 @@ eg:
 
 If `FILE_REPOSITORY_COMPATIBLE` is set to `false` in the borg.backup.file.settings then the file borg name will have `-file` added too. Currently this is not added to stay compatible with older scripts
 
+All below have default values if not set in the main settings file
+ * COMPRESSION: zstd
+ * COMPRESSION_LEVEL: 3
+ * ENCRYPTION: none
+ * FORCE_CHECK: false
+ * KEEP_LAST: 0
+ * KEEP_HOURS: 0
+ * KEEP_DAYS: 7
+ * KEEP_WEEKS: 4
+ * KEEP_MONTHS: 6
+ * KEEP_YEARS: 1
+
 All module settings files can have the following prefixed with `SUB_` to override master settings:
  * SUB_BACKUP_FILE
  * SUB_COMPRESSION

borg.backup.functions.check.sh

@@ -77,6 +77,7 @@ REPOSITORY="${TARGET_SERVER}${TARGET_FOLDER}${BACKUP_FILE}";
 echo "Repository    : ${REPOSITORY}";
 
 # check compression if given is valid and check compression level is valid if given
+OPT_COMPRESSION='';
 if [ ! -z "${COMPRESSION}" ]; then
 	# valid compression
 	if [ "${COMPRESSION}" = "lz4" ] || [ "${COMPRESSION}" = "zlib" ] || [ "${COMPRESSION}" = "lzma" ] || [ "${COMPRESSION}" = "zstd" ]; then

borg.backup.functions.init.sh

@@ -15,7 +15,7 @@ cleanup() {
 trap "unset BORG_BASE_DIR BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK BORG_RELOCATED_REPO_ACCESS_IS_OK" EXIT;
 
 # version for all general files
-VERSION="3.0.0";
+VERSION="3.0.2";
 
 # default log folder if none are set in config or option
 _LOG_FOLDER="/var/log/borg.backup/";
@@ -78,14 +78,18 @@ TARGET_FOLDER="";
 BACKUP_FILE="";
 SUB_BACKUP_FILE="";
 # lz4, zstd 1-22 (3), zlib 0-9 (6), lzma 0-9 (6)
-COMPRESSION="zstd";
-COMPRESSION_LEVEL=3;
+DEFAULT_COMPRESSION="zstd";
+DEFAULT_COMPRESSION_LEVEL=3;
+COMPRESSION="";
+COMPRESSION_LEVEL="";
 SUB_COMPRESSION="";
 SUB_COMPRESSION_LEVEL="";
 # encryption settings
-ENCRYPTION="none";
+DEFAULT_ENCRYPTION="none";
+ENCRYPTION="";
 # force check always
-FORCE_CHECK="false";
+DEFAULT_FORCE_CHECK="false";
+FORCE_CHECK="";
 BACKUP_SET="";
 SUB_BACKUP_SET="";
 # for database backup only
@@ -113,12 +117,18 @@ OPT_ZABBIX_UNKNOWN_TABLES="";
 # BACKUP SET that includes hour and minute information
 # IF BACKUP_SET is empty, this is automatically added
 # general keep last, if only this is set only last n will be kept
-KEEP_LAST=0;
-KEEP_HOURS=0;
-KEEP_DAYS=7;
-KEEP_WEEKS=4;
-KEEP_MONTHS=6;
-KEEP_YEARS=1;
+DEFAULT_KEEP_LAST=0;
+DEFAULT_KEEP_HOURS=0;
+DEFAULT_KEEP_DAYS=7;
+DEFAULT_KEEP_WEEKS=4;
+DEFAULT_KEEP_MONTHS=6;
+DEFAULT_KEEP_YEARS=1;
+KEEP_LAST="";
+KEEP_HOURS="";
+KEEP_DAYS="";
+KEEP_WEEKS="";
+KEEP_MONTHS="";
+KEEP_YEARS="";
 # in the format of nY|M|d|h|m|s
 KEEP_WITHIN="";
 # sub override init to empty
@@ -254,6 +264,37 @@ fi;
 
 # read config file
 . "${BASE_FOLDER}${SETTINGS_FILE}";
+# load default settings for fileds not set
+if [ -z "${COMPRESSION}" ]; then
+	COMPRESSION="${DEFAULT_COMPRESSION}";
+fi;
+if [ -z "${COMPRESSION_LEVEL}" ]; then
+	COMPRESSION_LEVEL="${DEFAULT_COMPRESSION_LEVEL}";
+fi;
+if [ -z "${ENCRYPTION}" ]; then
+	ENCRYPTION="${DEFAULT_ENCRYPTION}";
+fi;
+if [ -z "${FORCE_CHECK}" ]; then
+	FORCE_CHECK="${DEFAULT_FORCE_CHECK}";
+fi;
+if [ -z "${KEEP_LAST}" ]; then
+	KEEP_LAST="${DEFAULT_KEEP_LAST}";
+fi;
+if [ -z "${KEEP_HOURS}" ]; then
+	KEEP_HOURS="${DEFAULT_KEEP_HOURS}";
+fi;
+if [ -z "${KEEP_DAYS}" ]; then
+	KEEP_DAYS="${DEFAULT_KEEP_DAYS}";
+fi;
+if [ -z "${KEEP_WEEKS}" ]; then
+	KEEP_WEEKS="${DEFAULT_KEEP_WEEKS}";
+fi;
+if [ -z "${KEEP_MONTHS}" ]; then
+	KEEP_MONTHS="${DEFAULT_KEEP_MONTHS}";
+fi;
+if [ -z "${KEEP_YEARS}" ]; then
+	KEEP_YEARS="${DEFAULT_KEEP_YEARS}";
+fi;
 # ** SUB LOAD
 # a settings file always end in .settings, replace that with lower case MODULE.settings
 SETTINGS_FILE_SUB=$(echo "${SETTINGS_FILE}" | sed -e "s/\.settings/\.${MODULE,,}\.settings/");
@@ -288,12 +329,12 @@ if [ -f "${BASE_FOLDER}${SETTINGS_FILE_SUB}" ]; then
 	if [ ! -z "${SUB_KEEP_WEEKS}" ]; then
 		KEEP_WEEKS=${SUB_KEEP_WEEKS};
 	fi;
+	if [ ! -z "${SUB_KEEP_MONTHS}" ]; then
+		KEEP_MONTHS=${SUB_KEEP_MONTHS};
+	fi;
 	if [ ! -z "${SUB_KEEP_YEARS}" ]; then
 		KEEP_YEARS=${SUB_KEEP_YEARS};
 	fi;
-	if [ ! -z "${SUB_KEEP_LAST}" ]; then
-		KEEP_LAST=${SUB_KEEP_LAST};
-	fi;
 	if [ ! -z "${SUB_KEEP_WITHIN}" ]; then
 		KEEP_WITHIN=${SUB_KEEP_WITHIN};
 	fi;
@@ -365,11 +406,13 @@ if [[ -f "${LOG}" && ! -w "${LOG}" ]] || [[ ! -f "${LOG}" && ! -w "${LOG_FOLDER}
 fi;
 
 # if ENCRYPTION is empty or not in the valid list fall back to none
-if [ -z "${ENCRYPTION}" ]; then
-	ENCRYPTION="none";
+# NOTE This is currently set in default and doesn't need to be set on empty
+# only ivalid should be checked
+#if [ -z "${ENCRYPTION}" ]; then
+#	ENCRYPTION="none";
 #else
 	# TODO check for invalid encryption string
-fi;
+#fi;
 
 ## FUNCTIONS
 

borg.backup.gitea.sh

@@ -44,13 +44,11 @@ fi;
 # Filename
 FILENAME="gitea.backup.zip";
 # backup set and prefix
-BACKUP_SET_NAME="gitea-${BACKUP_SET}";
 BACKUP_SET_PREFIX="gitea-";
+BACKUP_SET_NAME="${BACKUP_SET_PREFIX}${BACKUP_SET}";
 
 # borg call
-# BORG_CALL=$(echo "${_BORG_CALL}" | sed -e "s/##FILENAME##/${FILENAME}/" | sed -e "s|##REPOSITORY##|${REPOSITORY}|" | sed -e "s/##BACKUP_SET##/${BACKUP_SET}/");
-BORG_CALL=$(echo "${_BORG_CALL}" | sed -e "s/##FILENAME##/${FILENAME}/" | sed -e "s/##BACKUP_SET##/${BACKUP_SET}/");
-# BORG_PRUNE=$(echo "${_BORG_PRUNE}" | sed -e "s|##REPOSITORY##|${REPOSITORY}|" | sed -e "s/##BACKUP_SET_PREFIX##/${BACKUP_SET_PREFIX}/");
+BORG_CALL=$(echo "${_BORG_CALL}" | sed -e "s/##FILENAME##/${FILENAME}/" | sed -e "s/##BACKUP_SET##/${BACKUP_SET_NAME}/");
 BORG_PRUNE=$(echo "${_BORG_PRUNE}" | sed -e "s/##BACKUP_SET_PREFIX##/${BACKUP_SET_PREFIX}/");
 echo "--- [git data and database: $(date +'%F %T')] --[${MODULE}]------------------------------------>";
 if [ ${DEBUG} -eq 1 ] || [ ${DRYRUN} -eq 1 ]; then
@@ -69,7 +67,7 @@ if [ ${DRYRUN} -eq 0 ]; then
 		# this needs to be run in a folder that can be stat by git user
 		cd "${GITEA_TMP}";
 		sudo -u ${GIT_USER} ${GITEA_BIN} dump -c ${GITEA_CONFIG} -w ${GITEA_TMP} -L -f - | ${BORG_CALL};
-	)
+	) | sed 's/\x1B\[[0-9;]\{1,\}[A-Za-z]//g' # remove all ESC strings
 fi;
 echo "Prune repository with keep${KEEP_INFO:1}";
 ${BORG_PRUNE};

borg.backup.mysql.sh

@@ -94,8 +94,8 @@ if [ ! -z "${DATABASE_FULL_DUMP}" ]; then
 	# Filename
 	FILENAME="all-${schema_flag}-${DB_TYPE}_${DB_VERSION}_${DB_HOST}_${DB_PORT}.sql"
 	# backup set:
-	BACKUP_SET_NAME="all-${schema_flag}-${BACKUP_SET}";
 	BACKUP_SET_PREFIX="all-";
+	BACKUP_SET_NAME="${BACKUP_SET_PREFIX}${schema_flag}-${BACKUP_SET}";
 	# borg call
 	BORG_CALL=$(echo "${_BORG_CALL}" | sed -e "s/##FILENAME##/${FILENAME}/" | sed -e "s/##BACKUP_SET##/${BACKUP_SET_NAME}/");
 	BORG_PRUNE=$(echo "${_BORG_PRUNE}" | sed -e "s/##BACKUP_SET_PREFIX##/${BACKUP_SET_PREFIX}/");
@@ -174,8 +174,8 @@ else
 			# prepare borg calls
 			FILENAME="${db}-${schema_flag}-${DB_TYPE}_${DB_VERSION}_${DB_HOST}_${DB_PORT}.sql"
 			# backup set:
-			BACKUP_SET_NAME="${db}-${schema_flag}-${BACKUP_SET}";
 			BACKUP_SET_PREFIX="${db}-"
+			BACKUP_SET_NAME="${BACKUP_SET_PREFIX}${schema_flag}-${BACKUP_SET}";
 			# borg call
 			BORG_CALL=$(echo "${_BORG_CALL}" | sed -e "s/##FILENAME##/${FILENAME}/" | sed -e "s/##BACKUP_SET##/${BACKUP_SET_NAME}/");
 			BORG_PRUNE=$(echo "${_BORG_PRUNE}" | sed -e "s/##BACKUP_SET_PREFIX##/${BACKUP_SET_PREFIX}/");

borg.backup.pgsql.sh

@@ -10,7 +10,7 @@
 
 # set last edit date + time
 MODULE="pgsql"
-MODULE_VERSION="0.1.0";
+MODULE_VERSION="1.0.1";
 
 
 DIR="${BASH_SOURCE%/*}"
@@ -99,8 +99,8 @@ if [ ! -z "${DATABASE_FULL_DUMP}" ]; then
 	# Filename
 	FILENAME-"all.${DB_USER}.NONE.${schema_flag}-${DB_VERSION}_${DB_HOST}_${DB_PORT}.c.sql"
 	# backup set:
-	BACKUP_SET_NAME="all-${schema_flag}-${BACKUP_SET}";
 	BACKUP_SET_PREFIX="all-";
+	BACKUP_SET_NAME="${BACKUP_SET_PREFIX}${schema_flag}-${BACKUP_SET}";
 	# borg call
 	BORG_CALL=$(echo "${_BORG_CALL}" | sed -e "s/##FILENAME##/${FILENAME}/" | sed -e "s/##BACKUP_SET##/${BACKUP_SET_NAME}/");
 	BORG_PRUNE=$(echo "${_BORG_PRUNE}" | sed -e "s/##BACKUP_SET_PREFIX##/${BACKUP_SET_PREFIX}/");
@@ -127,8 +127,8 @@ else
 	# Filename
 	FILENAME="${db}.${DB_USER}.NONE.${schema_flag}-${DB_VERSION}_${DB_HOST}_${DB_PORT}.c.sql"
 	# backup set:
-	BACKUP_SET_NAME="${db}-${schema_flag}-${BACKUP_SET}";
 	BACKUP_SET_PREFIX="${db}-";
+	BACKUP_SET_NAME="${BACKUP_SET_PREFIX}${schema_flag}-${BACKUP_SET}";
 	# borg call
 	BORG_CALL=$(echo "${_BORG_CALL}" | sed -e "s/##FILENAME##/${FILENAME}/" | sed -e "s/##BACKUP_SET##/${BACKUP_SET_NAME}/");
 	BORG_PRUNE=$(echo "${_BORG_PRUNE}" | sed -e "s/##BACKUP_SET_PREFIX##/${BACKUP_SET_PREFIX}/");

borg.backup.zabbix.sh

@@ -3,7 +3,7 @@
 # Backup zabbix config and settings only
 
 MODULE="zabbix"
-MODULE_VERSION="1.0.0";
+MODULE_VERSION="1.0.1";
 
 DIR="${BASH_SOURCE%/*}"
 if [[ ! -d "$DIR" ]]; then DIR="$PWD"; fi
@@ -50,11 +50,11 @@ fi;
 # Filename
 FILENAME="zabbix-config.c.sql";
 # backup set:
-BACKUP_SET="zabbix-settings-${BACKUP_SET}";
 BACKUP_SET_PREFIX="zabbix-settings-";
+BACKUP_SET_NAME="${BACKUP_SET_PREFIX}${BACKUP_SET}";
 
 # borg call
-BORG_CALL=$(echo "${_BORG_CALL}" | sed -e "s/##FILENAME##/${FILENAME}/" | sed -e "s/##BACKUP_SET##/${BACKUP_SET}/");
+BORG_CALL=$(echo "${_BORG_CALL}" | sed -e "s/##FILENAME##/${FILENAME}/" | sed -e "s/##BACKUP_SET##/${BACKUP_SET_NAME}/");
 BORG_PRUNE=$(echo "${_BORG_PRUNE}" | sed -e "s/##BACKUP_SET_PREFIX##/${BACKUP_SET_PREFIX}/");
 # if prefix is emtpy remote "-P"
 if [ -z "${BACKUP_SET_PREFIX}" ]; then