initial commit

J15k · J15k · commit 3c5e6ed0c511 · 2024-11-21T10:35:25.000+01:00
diff --git a/README.md b/README.md
@@ -0,0 +1,82 @@
+# Rsync Backup Script
+
+For more information on the script, see the article on the [Rsync Backup Script](https://www.ditig.com/publications/rsync-backup-script).
+
+## Script File
+
+Find the script in `rsync-backup-script.sh`.
+
+
+## Step-by-Step Explanation of the Script
+
+### Preliminaries
+
+1. **Set strict error handling:**  
+   The set -euo pipefail ensures:
+   * `-e`: The script exits if any command returns a non-zero exit code.
+   * `-u`: Exiting with an error if an undefined variable is used.
+   * `-o pipefail`: The script fails if any command in a pipeline fails.
+
+1. **Define script metadata:**  
+   __ScriptVersion="1.2" defines the version of the script.
+
+1. **Define a usage function:**  
+   The usage function describes how to run the script and explains the options:
+   * `-h|help`: Ensures the backup destination is mounted.
+   * `-v|version`: Displays the script version.
+
+
+### Set Key Variables
+
+* `backuppath`: The directory to back up (`/home/user`).
+* `mountpoint`: The backup destination (`/media/user/backup`).
+* `date`: Current date in `YYYY-MM-DD` format.
+* `time`: Current time in `HH:MM:SS` format.
+
+
+### Main Logic
+
+1. **Check if the backup destination is mounted:**  
+   The script uses `mountpoint -q $mountpoint` to verify if the backup destination is mounted.
+   * If mounted:  
+     Proceed with the backup process.
+   * If not mounted:  
+     Display an error message:  
+     `"$mountpoint is not mounted"`, styled in bold, and exit with code 6.
+
+1. **Clean up old logs:**  
+   Check if any backup log files exist at the destination (`backup*.txt`).
+   * If none are found: Print `"No backup file(s) found!"`.
+   * If found: Prompt for confirmation (`y` to delete, `n` to cancel) and delete selected logs.
+
+1. **Perform the backup using rsync:**  
+   The script uses rsync with the following options:
+   * `-a`: Archive mode (preserves symbolic links, permissions, etc.).
+   * `-v`: Verbose output.
+   * `-r`: Recursively sync directories.
+   * `--delete`: Remove files from the destination that no longer exist in the source.
+   * `--progress`: Show progress for each file.
+   * `--stats`: Display transfer statistics.
+   * `--itemize-changes`: List changes made during the sync.
+   * `--exclude '.cache/'`: Exclude the .cache/ directory.
+   * Output from `rsync` is piped to `tee`, saving a log file named `backup-log_<date>-<time>.txt` at the backup destination.
+
+1. **Display a success message:**  
+   Use styled and formatted text (`\033` sequences) to indicate success.
+   Specify the synced source (`$backuppath`) and destination (`$mountpoint`).
+
+1. **Print the latest file written to the backup destination:**  
+   Use `find` to locate the most recently written file and display its timestamp.
+
+1. **Wait, clear screen, and exit:**
+   * Pause for 15 seconds (`sleep 15`).
+   * Clear the terminal (`clear`).
+   * Exit with code `0` to signal success.
+
+
+### Error Handling
+
+If the backup destination (`$mountpoint`) is not mounted:
+
+* Print an error message in bold: `"$mountpoint is not mounted"`.
+* Exit with error code `6` (No such device or address).
diff --git a/rsync-backup-script.sh b/rsync-backup-script.sh
@@ -0,0 +1,102 @@
+#!/bin/bash
+
+# ERROR HANDLING
+# e - script stops on error (return != 0)
+# u - error if undefined variable
+# o pipefail - script fails if one of piped command fails
+# x - output each line (debug)
+set -euo pipefail
+
+__ScriptVersion="1.2"
+
+#===  FUNCTION  ================================================================
+#         NAME:  Backup ~/
+#  DESCRIPTION:  Backs up the user home directory to backup mountpoint.
+#===============================================================================
+function usage ()
+{
+    echo "Usage :  $0 [options] [--]
+    Options:
+    -h|help       Make sure backup destination is mounted.
+    -v|version    Display script version"
+
+}    # ----------  end of function usage  ----------
+
+
+# Variables
+#
+# source directory to back up
+backuppath="/home/user"
+
+# back up destination location
+# Arch
+#mountpoint="/run/media/user/bckp"
+# Ubuntu
+mountpoint="/media/user/bckp"
+
+# Current date in YYYY-MM-DD
+date=$(date +%Y-%m-%d)
+
+# Current time in HH:MM:SS
+time=$(date +%T)
+
+# Check if back up disk is mounted
+if mountpoint -q $mountpoint
+then
+
+
+# Clean up previous log(s)
+if [ ! -f $mountpoint/backup*.txt ]; then
+    echo "No backup file(s) found!"
+    else
+    echo -e "Confirm deletion: press y\nCancel deletion: press n"
+    rm -i $mountpoint/backup*.txt
+fi
+
+# Rsync Back Up
+#
+rsync \
+  -avr \
+  --delete \
+  --progress \
+  --stats \
+  --itemize-changes \
+  --exclude '.cache/' \
+  $backuppath \
+  $mountpoint \
+  2>&1 | tee $mountpoint/backup-log_$date-$time.txt # writing log
+  
+  # Confirmation message
+  #
+  # echo -e - escaped strings will be interpreted
+  # \033 - beginning/ending of the style
+  # m - end of the sequence
+  # [0m - resets all attributes, e.g. colors, formatting, etc.
+  # \n - newline
+  #
+  # Sequence integers:
+  #
+  # 0 - Normal Style
+  # 1 - Bold
+  # 4 - Underlined
+  echo -e "\n\n  \033[4mSUCCESS\033[0m\n\n  \033[1m$backuppath\033[0m\n    has been synced to\n  \033[1m$mountpoint\033[0m\n\n"
+  
+  # Print latest file to back up drive (manual plausability check)
+  echo -e "Latest file written to back up drive:"
+  find $mountpoint -type f -printf '%TY-%Tm-%Td %TH:%TM: %Tz %p\n'| sort -n | tail -n1
+  
+  # Wait for 15 seconds
+  sleep 15
+
+  # Clear the screen
+  clear
+  
+  # Success exit code
+  exit 0
+
+# If $mountpoint is not mounted
+else
+   echo -e "\033[1m$mountpoint\033[0m is not mounted"   
+   # Print error exit code -  No such device or address
+  exit 6
+fi
