Merge pull request #343 from github/rsync_warn_msg

Warn users if they use certain versions of rsync

Author: chuckp22

backup.config-example

@@ -42,6 +42,9 @@ GHE_NUM_SNAPSHOTS=10
 #
 #GHE_EXTRA_RSYNC_OPTS=""
 
+# If enabled and set to 'no', rsync warning message during backups will be suppressed.
+#RSYNC_WARNING=no
+
 
 # If set to 'yes', logging output will be colorized.
 #
@@ -97,4 +100,4 @@ GHE_NUM_SNAPSHOTS=10
 #EXTERNAL_DATABASE_RESTORE_SCRIPT="/bin/false"
 
 # If set to 'yes', Pages data will be included in backup and restore. Defaults to 'yes'
-#GHE_BACKUP_PAGES=no
+#GHE_BACKUP_PAGES=no

bin/ghe-host-check

@@ -213,9 +213,17 @@ DATA_TRANSFER_SIZE
     echo "rsync version $rsync_version in backup-host does not meet minimum requirements." 1>&2
     echo "Please make sure you have the minimum required version of rsync: $min_rsync installed" 1>&2
     exit 1
-  else
-    echo "rsync ${rsync_version} >= required ($min_rsync)" 1>&2
+  elif [[ $rsync_version < 3.2.5 ]] && [[ $RSYNC_WARNING != "no" ]]; then
+  cat << WARN_MSG 1>&2
+**WARNING:** rsync version $rsync_version on backup host is less than 3.2.5, which could result in performance degradation.
+
+For more details, please read documentation at https://github.com/github/backup-utils/blob/master/docs/requirements.md#april-2023-update-of-rsync-requirements
+
+You can disable this warning by changing RSYNC_WARNING to 'no' in your backup.config file.
+   
+WARN_MSG
   fi
+  echo "rsync ${rsync_version} >= required ($min_rsync)" 1>&2
 
   ssh_version=$(ssh -V 2>&1 | awk '{print $1}'|grep -oPm 1 '[\d\.]+' |head -1 | tr -cd '[:digit:].\n')
   if awk "BEGIN {exit !($ssh_version < $min_openssh)}" &> /dev/null; then