CI deployment (.gitea/workflows/deploy.yml):
- Two jobs (build, deploy) gated on the repo variable
DEPLOY_ENABLED=true so the workflow exists but does nothing
until secrets and host are configured.
- Build pushes two image tags per run: rolling :main + the short
SHA on main, or vX.Y.Z + :latest on tag pushes. Immutable per
commit/tag tags make rollback trivial.
- Deploy SSHes to DEPLOY_HOST, runs docker compose pull && up -d
in DEPLOY_PATH, then polls HEALTH_URL for up to a minute. A
failed health check fails the workflow, which is the alert.
- Required secrets and the rollback procedure are documented in
docs/operations.md.
Backup tooling (scripts/):
- backup.sh: SQLite online .backup snapshot + tarball of the
per-tenant data dir + info.txt header, all wrapped into a
single librenotes-YYYYMMDD-HHMMSS.tar.gz. Optional BACKUP_REMOTE
triggers an rclone copy for off-site storage.
- backup-prune.sh: enforces retention "30 daily + 12 monthly".
Sorts archives by filename (date is in the name so lex order
matches chronological) and keeps the newest 30 plus the newest
archive for each of the most recent 12 months.
- backup-restore-test.sh: extracts the most recent archive into
a tmpdir, runs sqlite3 .schema (proves DB readability), and
asserts the notes tar has at least one entry. Failure is the
alert. Wired into a separate weekly timer.
- librenotes-backup.{service,timer}: systemd units for the daily
03:17 UTC run with 5min jitter; ProtectSystem=strict, only
/var/backups/librenotes is writable.
- librenotes-backup-verify.{service,timer}: weekly Monday
04:00 UTC restore test.
Closes #26 and #27.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
52 lines
1.4 KiB
Bash
Executable File
52 lines
1.4 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# backup-restore-test.sh — verify the most recent backup is usable.
|
|
#
|
|
# Failure of this script is an alert. It does NOT touch the live
|
|
# database or data dir.
|
|
#
|
|
# Steps:
|
|
# 1. Pick the newest archive in $BACKUP_DIR.
|
|
# 2. Extract into a scratch tmpdir.
|
|
# 3. Run sqlite3 ".schema" against the snapshotted DB; non-empty
|
|
# output means the file is readable as SQLite.
|
|
# 4. Run tar -tzf on notes.tar.gz; we expect at least one entry.
|
|
# 5. Print the info.txt header so logs include backup metadata.
|
|
|
|
set -euo pipefail
|
|
|
|
BACKUP_DIR="${BACKUP_DIR:-/var/backups/librenotes}"
|
|
|
|
archive="$(ls -1t "$BACKUP_DIR"/librenotes-*.tar.gz 2>/dev/null | head -n 1 || true)"
|
|
if [ -z "$archive" ]; then
|
|
echo "no archives in $BACKUP_DIR" >&2
|
|
exit 1
|
|
fi
|
|
|
|
work="$(mktemp -d)"
|
|
trap 'rm -rf "$work"' EXIT
|
|
|
|
tar -C "$work" -xzf "$archive"
|
|
|
|
if [ ! -f "$work/librenotes.db" ]; then
|
|
echo "archive missing librenotes.db: $archive" >&2
|
|
exit 1
|
|
fi
|
|
schema="$(sqlite3 "$work/librenotes.db" ".schema" || true)"
|
|
if [ -z "$schema" ]; then
|
|
echo "sqlite .schema returned empty for $archive" >&2
|
|
exit 1
|
|
fi
|
|
|
|
if [ ! -f "$work/notes.tar.gz" ]; then
|
|
echo "archive missing notes.tar.gz: $archive" >&2
|
|
exit 1
|
|
fi
|
|
n="$(tar -tzf "$work/notes.tar.gz" | wc -l)"
|
|
if [ "$n" -lt 1 ]; then
|
|
echo "notes.tar.gz contains no entries: $archive" >&2
|
|
exit 1
|
|
fi
|
|
|
|
echo "verified $archive"
|
|
[ -f "$work/info.txt" ] && cat "$work/info.txt"
|