LibrePortal/scripts/backup/system/backup_system.sh
librelad 038d1c0729 fix(backup): system config in scheduled backups + retention (review findings)
Final-review gaps in the system-config backup:

1. Scheduled (cron) backups skipped it — backupScheduleEnabledApps only queued
   per-app backups, so the daily schedule never refreshed the system config (and
   thus the backup-location creds could go stale). Now it queues a
   `libreportal backup system` task (or runs inline on terminal-only installs),
   and skips the reproducible libreportal app for consistency with backupAllApps.

2. No retention on system snapshots — they bypass backupAppStart's per-app forget,
   so they accumulated unbounded. Add resticForgetSystem (tag system=config,
   respects append-only + the same keep-* policy) + engineForgetSystem dispatcher;
   backupSystemConfig now applies retention across all locations after snapshotting.

Verified with stubs: backupSystemConfig snapshots AND prunes on every location;
engineForgetSystem pairs with resticForgetSystem; scheduled createTaskFile call
matches the existing 3-arg signature.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Signed-off-by: librelad <librelad@digitalangels.vip>
2026-05-26 00:48:18 +01:00

83 lines
3.0 KiB
Bash

#!/bin/bash
# System-config backup.
#
# Snapshots the system config tree (<system>/configs — global settings, WebUI
# credentials, and crucially the BACKUP-LOCATION credentials) to every enabled
# backup location, so a bare-metal restore is self-sufficient. Without this the
# location creds live only on the box: lose it and you can't even reach your own
# remote backups (chicken-and-egg). It is a lightweight, static-dir snapshot — no
# container quiescing or DB dumps (those are per-app concerns), so it does NOT go
# through backupAppStart. The install tree (code) is reproducible from the release
# and is deliberately NOT included; per-app data is handled by backupAppStart.
backupSystemConfig()
{
local source_path="${configs_dir%/}"
if [[ ! -d "$source_path" ]]; then
isNotice "System config dir not found ($source_path) — skipping system backup"
return 0
fi
if [[ -z "$(resticEnabledLocations)" ]]; then
isNotice "No backup locations enabled — skipping system config backup"
return 0
fi
isHeader "Backing up system config"
engineEnsureAllLocationsReady
local idx ok=0 fail=0
while IFS= read -r idx; do
[[ -z "$idx" ]] && continue
if engineBackupSystem "$idx" >/dev/null; then
ok=$((ok + 1))
else
fail=$((fail + 1))
fi
done < <(resticEnabledLocations)
if [[ $ok -eq 0 ]]; then
isError "System config backup failed on all locations"
return 1
fi
# Apply retention so system snapshots don't accumulate (respects append-only
# locations; bypasses backupAppStart's per-app forget, so do it here).
while IFS= read -r idx; do
[[ -z "$idx" ]] && continue
engineForgetSystem "$idx" >/dev/null 2>&1 || true
done < <(resticEnabledLocations)
if [[ $fail -gt 0 ]]; then
isNotice "System config backed up to $ok location(s), failed on $fail"
else
isSuccessful "System config backed up to $ok location(s)"
fi
return 0
}
# Restore the latest system-config snapshot from a location into a STAGING dir.
# Deliberately does NOT overwrite live config — recovering creds/settings is a
# review-then-copy step, never an automatic blast over a running control plane.
backupRestoreSystemConfig()
{
local idx="${1:-}"
[[ -z "$idx" ]] && idx=$(resticEnabledLocations | head -1)
if [[ -z "$idx" ]]; then
isError "No enabled backup location to restore the system config from"
return 1
fi
local staging="${restore_dir%/}/system-config"
runFileOp mkdir -p "$staging"
isHeader "Restoring system config (to staging — live config is untouched)"
if engineRestoreSystemLatest "$idx" "$staging"; then
isSuccessful "System config restored to: $staging"
isNotice "Review it, then copy what you need into ${configs_dir} (backup-location creds, logins, settings). Live config was NOT overwritten."
return 0
fi
isError "System config restore failed"
return 1
}