raspiBackupAndClone.sh

#!/bin/bash
#
#######################################################################################################################
#
#  Sample script which calls raspiBackup.sh to create a backup and restores the backup to a device (e.g. SD card or USB disk) afterwards
#  That way a cold backup, also called clone, is available all the time just in case the system breaks for some reasons
#
#  NOTE: Backup can be synced to speed up the restore when rsync partition oriented mode and new option -00 introduced in raspiBackup release 0.7 is used
#        Just restore once a -P backup and then define the USE_RSYNC variable
#
#  Visit http://www.linux-tips-and-tricks.de/raspiBackup for details about raspiBackup
#
#  NOTE: This is sample code how to extend functionality of raspiBackup and is provided as is with no support.
#
#######################################################################################################################
#
#   Copyright (c) 2024-2025 framp at linux-tips-and-tricks dot de
#
#   This program is free software: you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation, either version 3 of the License, or
#   (at your option) any later version.
#
#   This program is distributed in the hope that it will be useful,
#   but WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#   GNU General Public License for more details.
#
#   You should have received a copy of the GNU General Public License
#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
#######################################################################################################################

set -euf -o pipefail

MYSELF=${0##*/}
VERSION="v0.2.1"

#
# Enable this option if rsync and option -00 should be used to speed up the restore
#
USE_RSYNC=1

set +u
#shellcheck disable=SC2154
#(warning): Date is referenced but not assigned
GIT_DATE="$Date$"
set -u
GIT_DATE_ONLY=${GIT_DATE/: /}
GIT_DATE_ONLY=$(cut -f 2 -d ' ' <<< "$GIT_DATE")
GIT_TIME_ONLY=$(cut -f 3 -d ' ' <<< "$GIT_DATE")
set +u
#shellcheck disable=SC2154
#(warning): Sha1 is referenced but not assigned
GIT_COMMIT="$Sha1$"
set -u
GIT_COMMIT_ONLY=$(cut -f 2 -d ' ' <<< "$GIT_COMMIT" | sed 's/\$//')

GIT_CODEVERSION="$MYSELF $VERSION, $GIT_DATE_ONLY/$GIT_TIME_ONLY - $GIT_COMMIT_ONLY"

if (( UID != 0 )); then
      echo "--- Call me as root or with sudo"
      exit 1
fi

echo "$GIT_CODEVERSION"

# add pathes if not already set (usually not set in crontab)

if [[ -e /bin/grep ]]; then
   PATHES="/bin /sbin /usr/bin /usr/sbin /usr/local/bin /usr/local/sbin"
   for p in $PATHES; do
      # shellcheck disable=SC1087
      # (error): Use braces when expanding arrays, e.g. ${array[idx]} (or ${var}[.. to quiet).
      if ! /bin/grep -E -q "[\^:]$p[:$]" <<< "$PATH"; then
         if [[ -z $PATH ]]; then 
            export PATH=$p
         else
            export PATH="$p:$PATH"
         fi
      fi
   done
fi

function readVars() {
   if [[ -f /tmp/raspiBackup.vars ]]; then
      # shellcheck disable=SC1091
      # (info) Not following: /usr/local/etc/raspiBackup.conf was not specified as input (see shellcheck -x).
      source /tmp/raspiBackup.vars                 # retrieve some variables from raspiBackup for further processing
# now following variables are available for further backup processing
# BACKUP_TARGETDIR refers to the backupdirectory just created
# BACKUP_TARGETFILE refers to the dd backup file just created
# MSG_FILE refers to message file just created
# LOG_FILE referes to logfile just created
   else
      echo "??? /tmp/raspiBackup.vars not found"
      exit 42
   fi
}

# main program

if ! which raspiBackup &>/dev/null; then
   echo "??? Missing raspiBackup.sh"
   exit 1
fi

if (( $# < 1 )); then
   echo "??? Missing clone device"
   exit 1
fi

CLONE_DEVICE="$1"

if [[ ! -b $CLONE_DEVICE ]]; then
   echo "??? $CLONE_DEVICE (e.g. /dev/sda or /dev/nvme0n1) does not exist"
   exit 1
fi

echo "--- Creating backup and restore backup afterwards to $CLONE_DEVICE ..."

if (( USE_RSYNC )); then
    raspiBackup.sh -t rsync -P
else
    raspiBackup.sh
fi  
#shellcheck disable= SC2181
#(style): Check exit code directly with e.g. 'if ! mycmd;', not indirectly with $?.
if (( ! $? )); then
   readVars
   # BACKUP_TARGETDIR now refers to the just created backup
   # now restore backup to device
   f=$(mktemp)
   echo "DEFAULT_YES_NO_RESTORE_DEVICE=$CLONE_DEVICE" > "$f"
   # shellcheck disable=SC1091
   # (info) Not following: /usr/local/etc/raspiBackup.conf was not specified as input (see shellcheck -x).
   source /usr/local/etc/raspiBackup.conf
   mounted=0
   if ! mount | grep "$DEFAULT_BACKUPPATH"; then
        sudo mount "$DEFAULT_BACKUPPATH"
        mounted=1
   fi
if (( USE_RSYNC )); then
   raspiBackup.sh -Y -d "$CLONE_DEVICE" -f "$f" -00 "$BACKUP_TARGETDIR"
else
   raspiBackup.sh -Y -d "$CLONE_DEVICE" -f "$f" "$BACKUP_TARGETDIR"
fi   
   rm "$f"
   if (( mounted )); then
        sudo umount "$DEFAULT_BACKUPPATH"
   fi   
fi