super-productivity/packages/super-sync-server/scripts/backup.sh
Johannes Millan a01a511c25 feat(sync): add backup strategy with accounts-only dump and disaster recovery docs
- Add accounts-only pg_dump (users + passkeys) to backup script for
  lightweight disaster recovery when clients still have data
- Add pipefail to backup script to catch silent dump failures
- Add test endpoint to simulate partial server revert (ops-after/:serverSeq)
- Add 6 e2e tests covering all disaster recovery scenarios:
  complete data loss, partial revert, accounts-only restore (API + SQL),
  full dump restore + reset account, and all-clients-lost recovery
- Add backup-and-recovery.md with setup, recovery procedures, and
  decision tree
2026-03-18 20:15:45 +01:00

111 lines
3.5 KiB
Bash
Executable file

#!/bin/bash
# SuperSync Server Backup Script
#
# Usage:
# ./scripts/backup.sh [--upload]
#
# This script:
# 1. Creates a PostgreSQL dump
# 2. Compresses it with gzip
# 3. Optionally uploads to remote storage (requires rclone)
# 4. Cleans up old backups (keeps 14 days)
#
# Options:
# --upload Upload to remote storage via rclone
#
# Setup for cron (daily at 3 AM):
# (crontab -l; echo "0 3 * * * /opt/supersync/packages/super-sync-server/scripts/backup.sh") | crontab -
#
# Rclone setup for offsite backup:
# 1. Install: curl https://rclone.org/install.sh | sudo bash
# 2. Configure: rclone config (follow prompts for B2/S3)
# 3. Set RCLONE_REMOTE below
set -eo pipefail
# Configuration
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
SERVER_DIR="$(dirname "$SCRIPT_DIR")"
BACKUP_DIR="${BACKUP_DIR:-$SERVER_DIR/backups}"
RETENTION_DAYS="${RETENTION_DAYS:-14}"
# Rclone remote name (e.g., "b2:supersync-backups" or "s3:my-bucket/supersync")
RCLONE_REMOTE="${RCLONE_REMOTE:-}"
# Database container name
DB_CONTAINER="${DB_CONTAINER:-supersync-postgres}"
DB_USER="${POSTGRES_USER:-supersync}"
DB_NAME="${POSTGRES_DB:-supersync}"
# Parse arguments
UPLOAD=false
if [ "$1" = "--upload" ]; then
UPLOAD=true
fi
# Create backup directory
mkdir -p "$BACKUP_DIR"
# Generate filename with timestamp
DATE=$(date +%Y%m%d_%H%M%S)
BACKUP_FILE="$BACKUP_DIR/supersync_$DATE.sql.gz"
echo "==> SuperSync Backup"
echo " Date: $DATE"
echo " Output: $BACKUP_FILE"
echo ""
# Step 1: Create full PostgreSQL dump
echo "==> Creating full database dump..."
docker exec "$DB_CONTAINER" pg_dump -U "$DB_USER" "$DB_NAME" | gzip > "$BACKUP_FILE"
# Get file size
SIZE=$(du -h "$BACKUP_FILE" | cut -f1)
echo " Full backup size: $SIZE"
# Step 1b: Create minimal accounts-only dump (users + passkeys)
# This is tiny and sufficient for disaster recovery when clients still have data.
# Recovery: restore accounts, wipe sync data, let clients re-upload.
ACCOUNTS_FILE="$BACKUP_DIR/supersync_accounts_$DATE.sql.gz"
echo ""
echo "==> Creating accounts-only dump (users + passkeys)..."
docker exec "$DB_CONTAINER" pg_dump -U "$DB_USER" "$DB_NAME" \
--table=users --table=passkeys | gzip > "$ACCOUNTS_FILE"
ACCOUNTS_SIZE=$(du -h "$ACCOUNTS_FILE" | cut -f1)
echo " Accounts backup size: $ACCOUNTS_SIZE"
# Step 2: Upload to remote (if enabled)
if [ "$UPLOAD" = true ]; then
if [ -z "$RCLONE_REMOTE" ]; then
echo ""
echo "Warning: --upload specified but RCLONE_REMOTE not set"
echo " Set RCLONE_REMOTE environment variable to enable uploads"
elif command -v rclone &> /dev/null; then
echo ""
echo "==> Uploading to $RCLONE_REMOTE..."
rclone copy "$BACKUP_FILE" "$RCLONE_REMOTE/"
rclone copy "$ACCOUNTS_FILE" "$RCLONE_REMOTE/"
echo " Upload complete"
else
echo ""
echo "Warning: rclone not installed, skipping upload"
echo " Install with: curl https://rclone.org/install.sh | sudo bash"
fi
fi
# Step 3: Clean up old backups
echo ""
echo "==> Cleaning up backups older than $RETENTION_DAYS days..."
DELETED=$(find "$BACKUP_DIR" \( -name "supersync_*.sql.gz" -o -name "supersync_accounts_*.sql.gz" \) -mtime +"$RETENTION_DAYS" -delete -print | wc -l)
echo " Deleted $DELETED old backup(s)"
# List current backups
echo ""
echo "==> Current backups:"
ls -lh "$BACKUP_DIR"/supersync_*.sql.gz "$BACKUP_DIR"/supersync_accounts_*.sql.gz 2>/dev/null | tail -10 || echo " (none)"
echo ""
echo "==> Backup complete:"
echo " Full: $BACKUP_FILE"
echo " Accounts: $ACCOUNTS_FILE"