Files
SysAdminAutomation/restore.sh
T
jcoffey-dev 466aa69533 docs: bring the README in line with what the scripts now do
The old README was a flat list of one-line descriptions, several of
which no longer described the script: log_rotate gained flags and no
longer purges by default, restore and process_monitor now confirm before
acting, rsync_magic changed a default, and disk_cleanup grew guards.

Rewritten around the conventions that are now consistent across the
collection -- --dry-run, a confirmation before anything destructive, an
unattended escape hatch, and a refusal rather than a guess when there is
no tty to ask on. That last one is the part worth knowing before putting
any of these in cron.

Groups the scripts by what they are for rather than listing them
alphabetically, and states the things a reader would otherwise have to
discover by reading source: that security_audit as an ordinary user
proves very little, that log_rotate is not a logrotate replacement and
why, that update_system is unattended on every branch, and that
restore's tar options matter because an archive picks its own ownership
and modes.

Also updated three script headers that had gained ASSUME_YES/FORCE
escapes without documenting them, so the headers and the README agree.

Every flag, environment variable and behaviour claimed here was checked
against the scripts rather than written from memory.
2026-08-22 22:27:40 -07:00

74 lines
2.7 KiB
Bash

#!/bin/bash
# restore.sh - Restore files from a backup archive
#
# Copyright (C) 2025 LINUXexpert.org
#
# 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, version 3 of the License.
#
# 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 <https://www.gnu.org/licenses/>.
#
# Usage: restore.sh <backup_archive.tar.gz> [target_directory]
# Description: Extracts the tar.gz archive into the target directory (current dir if not specified).
# Lists the archive contents and asks before extracting, since it
# overwrites whatever is already there. Set ASSUME_YES=1 to skip the
# prompt for unattended use.
#
# Extraction options are deliberately conservative -- see the tar call.
set -euo pipefail
ARCHIVE="${1:-}"
TARGET="${2:-}"
if [ -z "$ARCHIVE" ]; then
echo "Usage: $0 <archive.tar.gz> [target_directory]"
exit 1
fi
if [ ! -f "$ARCHIVE" ]; then
echo "Backup archive '$ARCHIVE' not found!"; exit 1
fi
if [ -z "$TARGET" ]; then
TARGET="."
else
if [ ! -d "$TARGET" ]; then
mkdir -p "$TARGET" || { echo "Failed to create target directory '$TARGET'"; exit 1; }
fi
fi
# An archive is untrusted input: whoever produced it chooses the paths,
# the ownership and the modes inside it.
# --no-same-owner do not let the archive pick uid/gid. Extracting
# as root previously handed files to whatever
# owner the tarball named.
# --no-same-permissions apply the umask rather than restoring setuid
# bits straight out of the archive.
# -P is NOT used, so tar strips leading "/" and refuses ".." members.
echo "Contents to be extracted into $TARGET:"
tar -tzf "$ARCHIVE" | head -n 20
total="$(tar -tzf "$ARCHIVE" | grep -c . || true)"
[ "$total" -gt 20 ] && echo " ... and $((total - 20)) more entries"
if [ "${ASSUME_YES:-}" != "1" ]; then
if [ ! -t 0 ]; then
echo "Refusing to extract without confirmation; set ASSUME_YES=1 for unattended use." >&2
exit 1
fi
read -r -p "Extract $total entries into $TARGET, overwriting existing files? (yes/NO): " reply
[ "$reply" = "yes" ] || { echo "Cancelled."; exit 0; }
fi
if tar -xzf "$ARCHIVE" -C "$TARGET" --no-same-owner --no-same-permissions; then
echo "Restore successful to directory: $TARGET"
else
echo "Restore failed" >&2
exit 1
fi