Reorganize repository structure and refresh READMEs

This commit is contained in:
WickedYoda committed 2026-04-08 14:57:07 -05:00
1 parent 2270530d9e
commit a8b7ccbf2a
170 files changed
+616 -1391

No files matched your search

@@ -0,0 +1,16 @@
# Docker_backup
## Overview
Docker backup automation scripts for backing up Docker data to mounted storage, repairing existing installs, and refreshing cron jobs.
## Contents
- `correct_docker-backup.sh`
- `docker-backup.sh`
- `setup_docker-backup.sh`
- `update_docker-backup.sh`
## Usage
Run the install, correction, or update scripts as root on the target system after reviewing the configured paths.
## Notes
Backups are designed around a mounted NAS path and scheduled cron execution.
+69
View File
@@ -0,0 +1,69 @@
#!/usr/bin/env bash
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
DEST_DIR="/root/docker"
DEST_SCRIPT="${DEST_DIR}/docker-backup.sh"
CRON_JOB_FILE="/etc/cron.d/docker-backup"
LOG_FILE="/var/log/docker_backup.log"
CRON_MATCH='docker-backup\.sh|docker_backup\.log|docker-backup-log'
FILES_TO_INSTALL=(
"docker-backup.sh"
"setup_docker-backup.sh"
"correct_docker-backup.sh"
"update_docker-backup.sh"
)
if [[ "${EUID}" -ne 0 ]]; then
echo "Run this script as root."
exit 1
fi
remove_legacy_cron_jobs() {
local cron_file
while IFS= read -r cron_file; do
rm -f "$cron_file"
echo "Removed legacy cron file ${cron_file}"
done < <(grep -El "${CRON_MATCH}" /etc/cron.d/* 2>/dev/null || true)
if [[ -f /etc/crontab ]] && grep -Eq "${CRON_MATCH}" /etc/crontab; then
grep -Ev "${CRON_MATCH}" /etc/crontab >/tmp/docker-backup-etc-crontab.cleaned || true
install -m 644 /tmp/docker-backup-etc-crontab.cleaned /etc/crontab
rm -f /tmp/docker-backup-etc-crontab.cleaned
echo "Removed legacy Docker backup entries from /etc/crontab"
fi
if crontab -l -u root >/tmp/docker-backup-root-crontab 2>/dev/null; then
grep -Ev "${CRON_MATCH}" /tmp/docker-backup-root-crontab >/tmp/docker-backup-root-crontab.cleaned || true
crontab -u root /tmp/docker-backup-root-crontab.cleaned
rm -f /tmp/docker-backup-root-crontab /tmp/docker-backup-root-crontab.cleaned
echo "Removed legacy Docker backup entries from root crontab"
fi
}
remove_legacy_cron_jobs
mkdir -p "${DEST_DIR}"
install_scripts() {
local file
for file in "${FILES_TO_INSTALL[@]}"; do
install -m 755 "${SCRIPT_DIR}/${file}" "${DEST_DIR}/${file}"
echo "Installed ${DEST_DIR}/${file}"
done
}
install_scripts
cat > "${CRON_JOB_FILE}" <<EOF
SHELL=/bin/bash
PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
# Run every 3 hours
0 */3 * * * root ${DEST_SCRIPT} >> ${LOG_FILE} 2>&1
EOF
chmod 644 "${CRON_JOB_FILE}"
echo "Installed ${CRON_JOB_FILE}"
echo "Docker backup scripts were updated and will run every 3 hours."
+162
View File
@@ -0,0 +1,162 @@
#!/usr/bin/env bash
set -euo pipefail
# =========================
# Docker Backup Script
# =========================
# Backup destination
NAS_ROOT="/mnt/naspublic"
HOSTNAME="$(hostname -s)"
BACKUP_BASE="${NAS_ROOT}/docker-backup/${HOSTNAME}"
# What to back up
SOURCE_PATHS=(
"/root/docker"
"/opt/docker"
"/var/lib/docker/volumes"
"/home/traver/docker"
)
# Retention in days
RETENTION_DAYS=14
# Log file
LOG_FILE="/var/log/docker_backup.log"
# Stop containers during backup? true/false
STOP_CONTAINERS="false"
# Docker compose search roots for optional stop/start
COMPOSE_DIRS=(
"/root/docker"
"/opt/docker"
"/home/traver/docker"
)
# Date/time foldering
MONTH_STAMP="$(date '+%Y-%m')"
DATE_STAMP="$(date '+%Y-%m-%d')"
TIME_STAMP="$(date '+%H-%M-%S')"
BACKUP_DIR="${BACKUP_BASE}/${MONTH_STAMP}/${DATE_STAMP}"
log() {
echo "[$(date '+%F %T')] $*" | tee -a "$LOG_FILE"
}
archive_name_for_path() {
local path="$1"
echo "${path#/}" | tr '/' '_'
}
require_backup_target() {
if command -v mountpoint >/dev/null 2>&1; then
mountpoint -q "$NAS_ROOT" || {
log "Error: ${NAS_ROOT} is not mounted. Aborting backup."
exit 1
}
return
fi
if command -v findmnt >/dev/null 2>&1; then
findmnt -rn "$NAS_ROOT" >/dev/null 2>&1 || {
log "Error: ${NAS_ROOT} is not mounted. Aborting backup."
exit 1
}
return
fi
if [[ ! -d "$NAS_ROOT" ]]; then
log "Error: ${NAS_ROOT} is not mounted. Aborting backup."
exit 1
fi
}
start_containers() {
log "Starting Docker Compose stacks..."
for dir in "${COMPOSE_DIRS[@]}"; do
if [[ -d "$dir" ]]; then
while IFS= read -r -d '' compose_file; do
compose_path="$(dirname "$compose_file")"
log "Starting stack in $compose_path"
docker compose -f "$compose_file" up -d >>"$LOG_FILE" 2>&1 || log "Warning: failed to start stack in $compose_path"
done < <(find "$dir" -type f \( -name "docker-compose.yml" -o -name "compose.yml" -o -name "docker-compose.yaml" -o -name "compose.yaml" \) -print0)
fi
done
}
stop_containers() {
log "Stopping Docker Compose stacks..."
for dir in "${COMPOSE_DIRS[@]}"; do
if [[ -d "$dir" ]]; then
while IFS= read -r -d '' compose_file; do
compose_path="$(dirname "$compose_file")"
log "Stopping stack in $compose_path"
docker compose -f "$compose_file" down >>"$LOG_FILE" 2>&1 || log "Warning: failed to stop stack in $compose_path"
done < <(find "$dir" -type f \( -name "docker-compose.yml" -o -name "compose.yml" -o -name "docker-compose.yaml" -o -name "compose.yaml" \) -print0)
fi
done
}
cleanup_old_backups() {
log "Removing backups older than ${RETENTION_DAYS} days from ${BACKUP_BASE}"
find "$BACKUP_BASE" -mindepth 2 -maxdepth 2 -type d -mtime +"$RETENTION_DAYS" -exec rm -rf {} + >>"$LOG_FILE" 2>&1 || true
find "$BACKUP_BASE" -mindepth 1 -maxdepth 1 -type d -empty -delete >>"$LOG_FILE" 2>&1 || true
}
create_archive() {
local path="$1"
local archive_name
local archive_path
local parent_dir
local base_name
if [[ ! -e "$path" ]]; then
log "Warning: source path missing: $path"
return 0
fi
archive_name="$(archive_name_for_path "$path")"
archive_path="${BACKUP_DIR}/${TIME_STAMP}_${archive_name}.tar.gz"
parent_dir="$(dirname "$path")"
base_name="$(basename "$path")"
log "Creating archive ${archive_path} from ${path}"
if command -v pigz >/dev/null 2>&1; then
tar --xattrs --acls --numeric-owner -cpf - -C "$parent_dir" "$base_name" 2>>"$LOG_FILE" | pigz 2>>"$LOG_FILE" > "$archive_path"
else
tar --xattrs --acls --numeric-owner -czpf "$archive_path" -C "$parent_dir" "$base_name" >>"$LOG_FILE" 2>&1
fi
}
main() {
log "========================================"
log "Starting Docker backup"
require_backup_target
mkdir -p "$BACKUP_BASE"
mkdir -p "$BACKUP_DIR"
if [[ "$STOP_CONTAINERS" == "true" ]]; then
stop_containers
fi
log "Creating separate compressed backups in $BACKUP_DIR"
for path in "${SOURCE_PATHS[@]}"; do
create_archive "$path"
done
log "Backup sizes:"
du -sh "$BACKUP_DIR" >>"$LOG_FILE" 2>&1 || true
if [[ "$STOP_CONTAINERS" == "true" ]]; then
start_containers
fi
cleanup_old_backups
log "Docker backup completed successfully"
log "========================================"
}
main "$@"
+68
View File
@@ -0,0 +1,68 @@
#!/usr/bin/env bash
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
DEST_DIR="/root/docker"
DEST_SCRIPT="${DEST_DIR}/docker-backup.sh"
CRON_JOB_FILE="/etc/cron.d/docker-backup"
LOG_FILE="/var/log/docker_backup.log"
CRON_MATCH='docker-backup\.sh|docker_backup\.log|docker-backup-log'
FILES_TO_INSTALL=(
"docker-backup.sh"
"setup_docker-backup.sh"
"correct_docker-backup.sh"
"update_docker-backup.sh"
)
if [[ "${EUID}" -ne 0 ]]; then
echo "Run this script as root."
exit 1
fi
remove_legacy_cron_jobs() {
local cron_file
while IFS= read -r cron_file; do
rm -f "$cron_file"
echo "Removed legacy cron file ${cron_file}"
done < <(grep -El "${CRON_MATCH}" /etc/cron.d/* 2>/dev/null || true)
if [[ -f /etc/crontab ]] && grep -Eq "${CRON_MATCH}" /etc/crontab; then
grep -Ev "${CRON_MATCH}" /etc/crontab >/tmp/docker-backup-etc-crontab.cleaned || true
install -m 644 /tmp/docker-backup-etc-crontab.cleaned /etc/crontab
rm -f /tmp/docker-backup-etc-crontab.cleaned
echo "Removed legacy Docker backup entries from /etc/crontab"
fi
if crontab -l -u root >/tmp/docker-backup-root-crontab 2>/dev/null; then
grep -Ev "${CRON_MATCH}" /tmp/docker-backup-root-crontab >/tmp/docker-backup-root-crontab.cleaned || true
crontab -u root /tmp/docker-backup-root-crontab.cleaned
rm -f /tmp/docker-backup-root-crontab /tmp/docker-backup-root-crontab.cleaned
echo "Removed legacy Docker backup entries from root crontab"
fi
}
remove_legacy_cron_jobs
mkdir -p "${DEST_DIR}"
install_scripts() {
local file
for file in "${FILES_TO_INSTALL[@]}"; do
install -m 755 "${SCRIPT_DIR}/${file}" "${DEST_DIR}/${file}"
echo "Installed ${DEST_DIR}/${file}"
done
}
install_scripts
cat > "${CRON_JOB_FILE}" <<EOF
SHELL=/bin/bash
PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
# Run every 3 hours
0 */3 * * * root ${DEST_SCRIPT} >> ${LOG_FILE} 2>&1
EOF
chmod 644 "${CRON_JOB_FILE}"
echo "Installed ${CRON_JOB_FILE}"
+71
View File
@@ -0,0 +1,71 @@
#!/usr/bin/env bash
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
DEST_DIR="/root/docker"
DEST_SCRIPT="${DEST_DIR}/docker-backup.sh"
CRON_JOB_FILE="/etc/cron.d/docker-backup"
LOG_FILE="/var/log/docker_backup.log"
CRON_MATCH='docker-backup\.sh|docker_backup\.log|docker-backup-log'
FILES_TO_INSTALL=(
"docker-backup.sh"
"setup_docker-backup.sh"
"correct_docker-backup.sh"
"update_docker-backup.sh"
)
if [[ "${EUID}" -ne 0 ]]; then
echo "Run this script as root."
exit 1
fi
remove_legacy_cron_jobs() {
local cron_file
while IFS= read -r cron_file; do
rm -f "$cron_file"
echo "Removed legacy cron file ${cron_file}"
done < <(grep -El "${CRON_MATCH}" /etc/cron.d/* 2>/dev/null || true)
if [[ -f /etc/crontab ]] && grep -Eq "${CRON_MATCH}" /etc/crontab; then
grep -Ev "${CRON_MATCH}" /etc/crontab >/tmp/docker-backup-etc-crontab.cleaned || true
install -m 644 /tmp/docker-backup-etc-crontab.cleaned /etc/crontab
rm -f /tmp/docker-backup-etc-crontab.cleaned
echo "Removed legacy Docker backup entries from /etc/crontab"
fi
if crontab -l -u root >/tmp/docker-backup-root-crontab 2>/dev/null; then
grep -Ev "${CRON_MATCH}" /tmp/docker-backup-root-crontab >/tmp/docker-backup-root-crontab.cleaned || true
crontab -u root /tmp/docker-backup-root-crontab.cleaned
rm -f /tmp/docker-backup-root-crontab /tmp/docker-backup-root-crontab.cleaned
echo "Removed legacy Docker backup entries from root crontab"
fi
}
install_scripts() {
local file
mkdir -p "${DEST_DIR}"
for file in "${FILES_TO_INSTALL[@]}"; do
install -m 755 "${SCRIPT_DIR}/${file}" "${DEST_DIR}/${file}"
echo "Installed ${DEST_DIR}/${file}"
done
}
install_cron_job() {
cat > "${CRON_JOB_FILE}" <<EOF
SHELL=/bin/bash
PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
# Run every 3 hours
0 */3 * * * root ${DEST_SCRIPT} >> ${LOG_FILE} 2>&1
EOF
chmod 644 "${CRON_JOB_FILE}"
echo "Installed ${CRON_JOB_FILE}"
}
remove_legacy_cron_jobs
install_scripts
install_cron_job
echo "Docker backup scripts were updated and the 3-hour cron job was refreshed."