Release 4.0.19 - See CHANGELOG.md

Update 10-db-backup msmtp -C

CHANGELOG.md

@@ -1,3 +1,46 @@
+## 4.0.19 2023-11-20 <dave at tiredofit dot ca>
+
+   ### Changed
+      - Make adjustments to cron scheduling feature to be able to handle whitespace properly"
+
+
+## 4.0.18 2023-11-18 <joergmschulz@github>
+
+   ### Changed
+      - Fix loading msmtp configuration
+
+
+## 4.0.17 2023-11-17 <dave at tiredofit dot ca>
+
+   ### Changed
+      - Provide more details when notifying via instant messages
+
+
+## 4.0.16 2023-11-17 <dave at tiredofit dot ca>
+
+   ### Changed
+      - Switch to using msmtp instead of s-mail for notify()
+
+
+## 4.0.15 2023-11-16 <dave at tiredofit dot ca>
+
+   ### Changed
+      - Fix cleanup of old backups
+
+
+## 4.0.14 2023-11-13 <dave at tiredofit dot ca>
+
+   ### Changed
+      - Bugfix when PRE/POST scripts found not giving legacy warning
+      - Run pre / post scripts as root
+
+
+## 4.0.13 2023-11-12 <dave at tiredofit dot ca>
+
+   ### Changed
+      - Check for any quotes if using MONGO_CUSTOM_URI and remove
+
+
 ## 4.0.12 2023-11-12 <dave at tiredofit dot ca>
 
    ### Changed

Dockerfile

@@ -10,7 +10,7 @@ ENV INFLUX1_CLIENT_VERSION=1.8.0 \
     MSODBC_VERSION=18.3.2.1-1 \
     MSSQL_VERSION=18.3.1.1-1 \
     AWS_CLI_VERSION=1.29.78 \
-    CONTAINER_ENABLE_MESSAGING=FALSE \
+    CONTAINER_ENABLE_MESSAGING=TRUE \
     CONTAINER_ENABLE_MONITORING=TRUE \
     IMAGE_NAME="tiredofit/db-backup" \
     IMAGE_REPO_URL="https://github.com/tiredofit/docker-db-backup/"
@@ -76,7 +76,7 @@ RUN source /assets/functions/00-container && \
         *) sleep 0.1 ;; \
     esac; \
     \
-    if [ $mssql = "true" ] ; then curl -O https://download.microsoft.com/download/3/5/5/355d7943-a338-41a7-858d-53b259ea33f5/msodbcsql18_${MSODBC_VERSION}_${mssql_arch}.apk ; curl -O https://download.microsoft.com/download/3/5/5/355d7943-a338-41a7-858d-53b259ea33f5/mssql-tools18_${MSSQL_VERSION}_${mssql_arch}.apk ; ls -l ; echo y | apk add --allow-untrusted msodbcsql18_${MSODBC_VERSION}_${mssql_arch}.apk mssql-tools18_${MSSQL_VERSION}_${mssql_arch}.apk ; else echo >&2 "Detected non x86_64 or ARM64 build variant, skipping MSSQL installation" ; fi; \
+    if [ $mssql = "true" ] ; then curl -O https://download.microsoft.com/download/3/5/5/355d7943-a338-41a7-858d-53b259ea33f5/msodbcsql18_${MSODBC_VERSION}_${mssql_arch}.apk ; curl -O https://download.microsoft.com/download/3/5/5/355d7943-a338-41a7-858d-53b259ea33f5/mssql-tools18_${MSSQL_VERSION}_${mssql_arch}.apk ; echo y | apk add --allow-untrusted msodbcsql18_${MSODBC_VERSION}_${mssql_arch}.apk mssql-tools18_${MSSQL_VERSION}_${mssql_arch}.apk ; else echo >&2 "Detected non x86_64 or ARM64 build variant, skipping MSSQL installation" ; fi; \
     if [ $influx2 = "true" ] ; then curl -sSL https://dl.influxdata.com/influxdb/releases/influxdb2-client-${INFLUX2_CLIENT_VERSION}-linux-${influx_arch}.tar.gz | tar xvfz - --strip=1 -C /usr/src/ ; chmod +x /usr/src/influx ; mv /usr/src/influx /usr/sbin/ ; else echo >&2 "Unable to build Influx 2 on this system" ; fi ; \
     clone_git_repo https://github.com/aws/aws-cli "${AWS_CLI_VERSION}" && \
     python3 setup.py install --prefix=/usr && \

README.md

@@ -601,13 +601,13 @@ Options that are related to the value of `DB01_BACKUP_LOCATION`
 
 If `DB01_BACKUP_LOCTION` = `FILESYSTEM` then the following options are used:
 
-| Variable                          | Description                                                                                           | Default                           |
-| --------------------------------- | ----------------------------------------------------------------------------------------------------- | --------------------------------- |
-| `DB01_CREATE_LATEST_SYMLINK`      | Create a symbolic link pointing to last backup in this format: `latest-(DB_TYPE)-(DB_NAME)-(DB_HOST)` | `TRUE`                            |
-| `DB01_FILESYSTEM_PATH`            | Directory where the database dumps are kept.                                                          | `/backup`                         |
-| `DB01_FILESYSTEM_PATH_PERMISSION` | Permissions to apply to backup directory                                                              | `700`                             |
-| `DB01_FILESYSTEM_ARCHIVE_PATH`    | Optional Directory where the database dumps archives are kept                                         | `${DB01_FILESYSTEM_PATH/archive/` |
-| `DB01_FILESYSTEM_PERMISSION`      | Directory and File permissions to apply to files.                                                     | `600`                             |
+| Variable                          | Description                                                                                           | Default                            |
+| --------------------------------- | ----------------------------------------------------------------------------------------------------- | ---------------------------------- |
+| `DB01_CREATE_LATEST_SYMLINK`      | Create a symbolic link pointing to last backup in this format: `latest-(DB_TYPE)-(DB_NAME)-(DB_HOST)` | `TRUE`                             |
+| `DB01_FILESYSTEM_PATH`            | Directory where the database dumps are kept.                                                          | `/backup`                          |
+| `DB01_FILESYSTEM_PATH_PERMISSION` | Permissions to apply to backup directory                                                              | `700`                              |
+| `DB01_FILESYSTEM_ARCHIVE_PATH`    | Optional Directory where the database dumps archives are kept                                         | `${DB01_FILESYSTEM_PATH}/archive/` |
+| `DB01_FILESYSTEM_PERMISSION`      | Directory and File permissions to apply to files.                                                     | `600`                              |
 
 ###### S3
 
@@ -742,6 +742,9 @@ $5 body/error message
 
 
 ##### Email Notifications
+
+See more details in the base image listed above for more mail environment variables.
+
 | Parameter   | Description                                                                               | Default | `_FILE` |
 | ----------- | ----------------------------------------------------------------------------------------- | ------- | ------- |
 | `MAIL_FROM` | What email address to send mail from for errors                                           |         |         |

install/assets/dbbackup/template-dbbackup/run

@@ -34,9 +34,12 @@ else
     elif [[ "${backup_job_backup_begin}" =~ ([0-9]{4})-([0-9]{2})-([0-9]{2})[[:space:]]([0-9]{2}):([0-9]{2}):([0-9]{2}) ]]; then
         print_debug "BACKUP_BEGIN is a full date timestamp"
         timer datetime
+    #elif echo "${backup_job_backup_begin//\*/#}" | grep -qP "^(.*((\d+,)+\d+|(\d+(\/|-)\d+)|\d+|#) ?){5}$" ; then # Allow slashes, yet not supporting advanced cron yet
     elif echo "${backup_job_backup_begin//\*/#}" | grep -qP "^(((\d+,)+\d+|(\d+(\/|-)\d+)|\d+|#) ?){5}$" ; then
         print_debug "BACKUP_BEGIN is a cron expression"
         time_last_run=$(date +"%s")
+        backup_job_backup_begin=${backup_job_backup_begin//\"/}
+        backup_job_backup_begin=${backup_job_backup_begin//\'/}
         timer cron "${backup_job_backup_begin}" "${time_current}" "${time_last_run}"
     else
         print_error "_BACKUP_BEGIN is invalid - Unable to perform scheduling"
@@ -87,6 +90,7 @@ while true; do
     fi
 
     symlink_log
+    cleanup_old_data
 
     if var_false "${persist}" ; then
         print_debug "Exiting due to manual mode"

install/assets/functions/10-db-backup

@@ -158,6 +158,11 @@ bootstrap_variables() {
             sed -i "s|_PASS='\(.*\)'|_PASS=\1|g" "${backup_instance_vars}"
         fi
 
+        if grep -qo "MONGO_CUSTOM_URI='.*'" "${backup_instance_vars}"; then
+            print_debug "[bootstrap_variables] [backup_init] Found _MONGO_CUSTOM_URI variable with quotes"
+            sed -i "s|MONGO_CUSTOM_URI='\(.*\)'|MONGO_CUSTOM_URI=\1|g" "${backup_instance_vars}"
+        fi
+
         transform_backup_instance_variable() {
             if grep -q "^DB${1}_${2}=" "${backup_instance_vars}" && [ "$(grep "^DB${1}_${2}=" "${backup_instance_vars}" | cut -d = -f2)" != "unset" ]; then
                 export "$3"="$(grep "^DB${1}_${2}=" "${backup_instance_vars}" | cut -d = -f2-)"
@@ -1358,18 +1363,20 @@ notify() {
         if [ -z "${SMTP_HOST}" ] ; then write_log error "[notifications] No SMTP_HOST variable set - Skipping sending Email notifications" ; skip_mail=true ; fi
         if [ -z "${SMTP_PORT}" ] ; then write_log error "[notifications] No SMTP_PORT variable set - Skipping sending Email notifications" ; skip_mail=true ; fi
         if var_nottrue "${skip_mail}" ; then
+            if ! grep -q ^from /etc/msmptrc ; then
+                echo "from ${MAIL_FROM}" >> /etc/msmtprc
+            fi
             mail_recipients=$(echo "${MAIL_TO}" | tr "," "\n")
             for mail_recipient in $mail_recipients ; do
-                cat <<EOF | s-nail -v \
-                                        -r "${MAIL_FROM}" \
-                                        -s "[db-backup] [${DOMAIN}] ${3}" \
-                                        -S smtp="${SMTP_HOST}":"${SMTP_PORT}" \
-                                        "${mail_recipient}"
+                cat <<EOF | msmtp -t "${mail_recipient}" -C /etc/msmtprc
+To: ${mail_recipient}
+Subject: [db-backup] ${4}
+
 Time: ${1}
 Log File: {2}
 Error Code: ${3}
 
-${4}
+${5}
 EOF
             done
         fi
@@ -1385,7 +1392,7 @@ EOF
         if [ -z "${MATTERMOST_WEBHOOK_URL}" ] ; then write_log error "[notifications] No MATTERMOST_WEBHOOK_URL variable set - Skipping sending Mattermost notifications" ; skip_mattermost=true ; fi
         if var_nottrue "${skip_mattermost}" ; then
         emoji=":bomb:"
-        message="*[db-backup] ${3}*\n${4}\n*Timestamp:* ${1}\n*Logfile:* ${2}\n*Error Code: ${3}"
+        message="*[db-backup] ${4}*\n${5}\n*Timestamp:* ${1}\n*Logfile:* ${2}\n*Error Code: ${3}"
         mattermost_recipients=$(echo "${MATTERMOST_RECIPIENT}" | tr "," "\n")
             for mattermost_recipient in $mattermost_recipients ; do
                 payload="payload={\"channel\": \"${mattermost_recipient//\"/\\\"}\", \"username\": \"${MATTERMOST_USERNAME//\"/\\\"}\", \"text\": \"${message//\"/\\\"}\", \"icon_emoji\": \"${emoji}\"}"
@@ -1410,7 +1417,7 @@ EOF
             for matrix_room in $matrix_rooms ; do
                 curl \
                         -XPOST \
-                        -d "{\"msgtype\":\"m.text\", \"body\":\"*[db-backup] ${3}*\n${4}\n*Timestamp:* ${1}\n*Logfile:* ${2}\n*Error Code: ${3}*\"}" \
+                        -d "{\"msgtype\":\"m.text\", \"body\":\"*[db-backup] ${4}*\n${5}\n*Timestamp:* ${1}\n*Logfile:* ${2}\n*Error Code: ${3}*\"}" \
                         "${MATRIX_HOST}/_matrix/client/r0/rooms/${matrix_room}/send/m.room.message?access_token=${MATRIX_ACCESS_TOKEN}"
             done
         fi
@@ -1426,7 +1433,7 @@ EOF
         if [ -z "${ROCKETCHAT_WEBHOOK_URL}" ] ; then write_log error "[notifications] No ROCKETCHAT_WEBHOOK_URL variable set - Skipping sending Rocket.Chat notifications" ; skip_rocketchat=true ; fi
         if var_nottrue "${skip_rocketchat}" ; then
             emoji=":bomb:"
-            message="*[db-backup] ${3}*\n${4}\n*Timestamp:* ${1}\n*Logfile:* ${2}\n*Error Code: ${3}"
+            message="*[db-backup] ${4}*\n${5}\n*Timestamp:* ${1}\n*Logfile:* ${2}\n*Error Code: ${3}"
             rocketchat_recipients=$(echo "${ROCKETCHAT_RECIPIENT}" | tr "," "\n")
             for rocketchat_recipient in $rocketchat_recipients ; do
                 payload="payload={\"channel\": \"${rocketchat_recipient//\"/\\\"}\", \"username\": \"${ROCKETCHAT_USERNAME//\"/\\\"}\", \"text\": \"${message//\"/\\\"}\", \"icon_emoji\": \"${emoji}\"}"
@@ -1626,20 +1633,20 @@ pre_dbbackup() {
 
     ### Pre Backup Custom Script Support
     if [ -d "/assets/custom-scripts/pre" ] && dir_notempty "/assets/custom-scripts/pre" ; then
-        write_log warning "Found Custom Post Scripts in /assets/custom-scripts/pre - Automatically moving them to '${backup_job_script_location_pre}'"
-        run_as_user mkdir -p "${backup_job_script_location_pre}"
-        silent run_as_user cp /assets/custom-scripts/pre/* "${backup_job_script_location_pre}"
+        write_log warn "Found Custom Post Scripts in /assets/custom-scripts/pre - Automatically moving them to '${backup_job_script_location_pre}'"
+        mkdir -p "${backup_job_script_location_pre}"
+        silent cp -aR /assets/custom-scripts/pre/* "${backup_job_script_location_pre}"
     fi
 
     if [ -d "${backup_job_script_location_pre}" ] && dir_notempty "${backup_job_script_location_pre}" ; then
         for f in $(find ${backup_job_script_location_pre} -name \*.sh -type f); do
             if var_true "${backup_job_pre_script_x_verify}" ; then
-                run_as_user ${f} "${dbtype}" "${backup_job_db_host}" "${1}" "${dbbackup_start_time}" "${backup_job_filename}"
+                ${f} "${dbtype}" "${backup_job_db_host}" "${1}" "${dbbackup_start_time}" "${backup_job_filename}"
             else
                 if [ -x "${f}" ] ; then
                     write_log notice "Executing pre backup custom script : '${f}'"
                     ## script DB_TYPE DB_HOST DB_NAME STARTEPOCH BACKUP_FILENAME
-                    run_as_user ${f} "${dbtype}" "${backup_job_db_host}" "${1}" "${dbbackup_start_time}" "${backup_job_filename}"
+                    ${f} "${dbtype}" "${backup_job_db_host}" "${1}" "${dbbackup_start_time}" "${backup_job_filename}"
                 else
                     write_log error "Can't run pre backup custom script: '${f}' as its filesystem bit is not executible!"
                 fi
@@ -1682,11 +1689,11 @@ EOZP
     ### Post Script Support
     if [ -n "${backup_job_post_script}" ] ; then
         if var_true "${backup_job_post_script_x_verify}" ; then
-            run_as_user eval "${backup_job_post_script}" "${exit_code}" "${dbtype}" "${backup_job_db_host}" "${1}" "${dbbackup_start_time}" "${dbbackup_finish_time}" "${dbbackup_total_time}" "${backup_job_filename}" "${filesize}" "${checksum_value}" "${move_exit_code}"
+            eval "${backup_job_post_script}" "${exit_code}" "${dbtype}" "${backup_job_db_host}" "${1}" "${dbbackup_start_time}" "${dbbackup_finish_time}" "${dbbackup_total_time}" "${backup_job_filename}" "${filesize}" "${checksum_value}" "${move_exit_code}"
         else
             if [ -x "${backup_job_post_script}" ] ; then
                 write_log notice "Found POST_SCRIPT environment variable. Executing '${backup_job_post_script}"
-                run_as_user eval "${backup_job_post_script}" "${exit_code}" "${dbtype}" "${backup_job_db_host}" "${1}" "${dbbackup_start_time}" "${dbbackup_finish_time}" "${dbbackup_total_time}" "${backup_job_filename}" "${filesize}" "${checksum_value}" "${move_exit_code}"
+                eval "${backup_job_post_script}" "${exit_code}" "${dbtype}" "${backup_job_db_host}" "${1}" "${dbbackup_start_time}" "${dbbackup_finish_time}" "${dbbackup_total_time}" "${backup_job_filename}" "${filesize}" "${checksum_value}" "${move_exit_code}"
             else
                 write_log error "Can't execute POST_SCRIPT environment variable '${backup_job_post_script}' as its filesystem bit is not executible!"
             fi
@@ -1695,20 +1702,20 @@ EOZP
 
     ### Post Backup Custom Script Support
     if [ -d "/assets/custom-scripts/" ] && dir_notempty "/assets/custom-scripts" ; then
-        write_log warning "Found Custom Post Scripts in /assets/custom-scripts/ - Automatically moving them to '${backup_job_script_location_post}'"
-        run_as_user mkdir -p "${backup_job_script_location_post}"
-        silent run_as_user cp /assets/custom-scripts/* "${backup_job_script_location_post}"
+        write_log warn "Found Custom Post Scripts in /assets/custom-scripts/ - Automatically moving them to '${backup_job_script_location_post}'"
+        mkdir -p "${backup_job_script_location_post}"
+        cp -aR /assets/custom-scripts/* "${backup_job_script_location_post}"
     fi
 
     if [ -d "${backup_job_script_location_post}" ] && dir_notempty "${backup_job_script_location_post}" ; then
         for f in $(run_as_user find "${backup_job_script_location_post}" -name \*.sh -type f); do
             if var_true "${backup_job_post_script_x_verify}" ; then
-                run_as_user ${f} "${exit_code}" "${dbtype}" "${backup_job_db_host}" "${1}" "${dbbackup_start_time}" "${dbbackup_finish_time}" "${dbbackup_total_time}" "${backup_job_filename}" "${filesize}" "${checksum_value}" "${move_exit_code}"
+                ${f} "${exit_code}" "${dbtype}" "${backup_job_db_host}" "${1}" "${dbbackup_start_time}" "${dbbackup_finish_time}" "${dbbackup_total_time}" "${backup_job_filename}" "${filesize}" "${checksum_value}" "${move_exit_code}"
             else
                 if [ -x "${f}" ] ; then
                     write_log notice "Executing post backup custom script : '${f}'"
                     ## script EXIT_CODE DB_TYPE DB_HOST DB_NAME STARTEPOCH FINISHEPOCH DURATIONEPOCH BACKUP_FILENAME FILESIZE CHECKSUMVALUE
-                    run_as_user ${f} "${exit_code}" "${dbtype}" "${backup_job_db_host}" "${1}" "${dbbackup_start_time}" "${dbbackup_finish_time}" "${dbbackup_total_time}" "${backup_job_filename}" "${filesize}" "${checksum_value}" "${move_exit_code}"
+                    ${f} "${exit_code}" "${dbtype}" "${backup_job_db_host}" "${1}" "${dbbackup_start_time}" "${dbbackup_finish_time}" "${dbbackup_total_time}" "${backup_job_filename}" "${filesize}" "${checksum_value}" "${move_exit_code}"
                 else
                     write_log error "Can't run post backup custom script: '${f}' as its filesystem bit is not executible!"
                 fi
@@ -1836,7 +1843,7 @@ timer() {
                     if [ "${expression_step}" != "${expression}" ]; then
                         for step in ${validate_temp}; do
                             if [ $(( ( step - expression_start ) % expression_step )) -eq 0 ]; then
-                              validate_all="$validate_all ${step}"
+                              validate_all="${validate_all} ${step}"
                             fi
                         done
                     else
@@ -1846,13 +1853,14 @@ timer() {
 
                 validate_all=$(echo "${validate_all}" | tr ' ' '\n' | sort -n -u | tr '\n' ' ')
                 for entry in $validate_all; do
-                    if [ "${entry}" -ge "${3}" ]; then
+                    if [ ${entry} -ge ${3} ]; then
                       echo "${entry}"
                       return 0
                     fi
                 done
 
-                echo "${validate_all%% *}"
+                echo "${validate_all// /}"
+                #echo "${validate_all%% *}"
             }
 
             local cron_compare="${3}"
@@ -1871,7 +1879,10 @@ timer() {
             local cron_minute="$(echo -n "${2}" | awk '{print $1}')"
             local cron_hour="$(echo -n "${2}" | awk '{print $2}')"
             local cron_day_of_month="$(echo -n "${2}" | awk '{print $3}')"
-            local cron_month="$(echo -n "${2}" | awk '{print $4}')"Generating
+            local cron_month="$(echo -n "${2}" | awk '{print $4}')"
+            local cron_day_of_week="$(echo -n "${2}" | awk '{print $5}')"
+
+            local cron_next_minute="$(date --date=@"${cron_compare}" +"%-M")"
             local cron_next_hour="$(date --date=@"${cron_compare}" +"%-H")"
             local cron_next_day_of_month="$(date --date=@"${cron_compare}" +"%-d")"
             local cron_next_month="$(date --date=@"${cron_compare}" +"%-m")"
@@ -1880,8 +1891,10 @@ timer() {
             local cron_next_year="$(date --date=@"${cron_compare}" +"%-Y")"
 
             local cron_next=
+            local cron_parsed=1
 
-            while [ "$cron_parsed" != "0" ]; do
+            while [ "${cron_parsed}" != "0" ]; do
+                print_debug "[timer] [cron] Parse Minute"
                 cron_next=$(parse_expression "${cron_minute}" 59 "${cron_next_minute}")
                 if [ "${cron_next}" != "${cron_next_minute}" ]; then
                     if [ "${cron_next_minute}" -gt "${cron_next}" ]; then
@@ -1891,20 +1904,22 @@ timer() {
                     cron_next_minute="${cron_next}"
                 fi
 
+                print_debug "[timer] [cron] Parse Hour"
                 cron_next=$(parse_expression "${cron_hour}" 23 "${cron_next_hour}")
                 if [ "${cron_next}" != "${cron_next_hour}" ]; then
                     if [ "${cron_next_hour}" -gt "${cron_next}" ]; then
                         cron_next_day_of_month=$(( cron_next_day_of_month + 1 ))
                     fi
+
                     cron_next_hour="${cron_next}"
-                    #cron_next_minute=0
                 fi
 
+                print_debug "[timer] [cron] Parse Day of Week"
                 cron_next=$(parse_expression "${cron_day_of_week}" 6 "${cron_next_day_of_week}")
                 if [ "${cron_next}" != "${cron_next_day_of_week}" ]; then
-                    day_of_week_difference=$(( ${cron_next} - ${cron_next_day_of_week} ))
+                    day_of_week_difference=$(( cron_next - cron_next_day_of_week ))
 
-                    if [ "${day_of_week_difference}" -lt "0" ]; then
+                    if [ "${day_of_week_difference}" -lt 0 ]; then
                         day_of_week_difference=$(( day_of_week_difference + 7 ))
                     fi
 
@@ -1913,6 +1928,7 @@ timer() {
                     cron_next_minute=0
                 fi
 
+                print_debug "[timer] [cron] Parse day of month"
                 case "${cron_next_month}" in
                     1|3|5|7|8|10|12)
                         last_day_of_month="31"
@@ -1952,6 +1968,7 @@ timer() {
                     cron_next_day_of_month=$cron_next
                 fi
 
+                print_debug "[timer] [cron] Parse Next Month"
                 cron_next=$(parse_expression "${cron_month}" 12 "${cron_next_month}")
                 if [ "${cron_next}" != "${cron_next_month}" ]; then
                     if [ "${cron_next}" -gt "12" ]; then
@@ -2063,4 +2080,4 @@ write_log() {
     print_${_arg_log_level} "${_arg_log_message}"
     output_on
     if var_true "${DEBUG_WRITE_LOG}" ; then debug off; fi
-}
+}