65 lines
2.0 KiB
Bash
65 lines
2.0 KiB
Bash
# Backup Configuration for docker-volume-backup
|
|
# Documentation: https://offen.github.io/docker-volume-backup/reference/
|
|
|
|
# --- SCHEDULE ---
|
|
# Backup runs daily at 3:00 AM (cron format)
|
|
BACKUP_CRON_EXPRESSION=0 3 * * *
|
|
|
|
# --- BACKUP NAMING ---
|
|
# Backup filename pattern (timestamp format)
|
|
BACKUP_FILENAME=backup-%Y-%m-%dT%H-%M-%S.tar.gz
|
|
|
|
# --- RETENTION ---
|
|
# Keep backups for 7 days locally
|
|
BACKUP_RETENTION_DAYS=7
|
|
|
|
# --- COMPRESSION ---
|
|
# Use gzip compression (options: gz, zst)
|
|
BACKUP_COMPRESSION=gz
|
|
|
|
# --- STOP CONTAINERS ---
|
|
# Timeout for stopping containers (in seconds)
|
|
BACKUP_STOP_CONTAINER_TIMEOUT=30
|
|
|
|
# --- LOCAL ARCHIVE ---
|
|
# Backups are stored in /archive (mounted from ./backups)
|
|
BACKUP_ARCHIVE=/archive
|
|
|
|
# --- ENCRYPTION (optional) ---
|
|
# Uncomment and set a passphrase to enable GPG encryption
|
|
# GPG_PASSPHRASE=your-secure-passphrase
|
|
|
|
# --- S3 REMOTE BACKUP (optional) ---
|
|
# Uncomment to enable S3/MinIO backup target
|
|
# AWS_S3_BUCKET_NAME=your-bucket-name
|
|
# AWS_S3_PATH=jmp-server
|
|
# AWS_ACCESS_KEY_ID=your-access-key
|
|
# AWS_SECRET_ACCESS_KEY=your-secret-key
|
|
# AWS_ENDPOINT=s3.amazonaws.com
|
|
# AWS_ENDPOINT_PROTO=https
|
|
|
|
# --- SSH REMOTE BACKUP (optional) ---
|
|
# Uncomment to enable SSH/SFTP backup target
|
|
# SSH_HOST_NAME=backup.example.com
|
|
# SSH_PORT=22
|
|
# SSH_USER=backup
|
|
# SSH_REMOTE_PATH=/backups/jmp-server
|
|
# SSH_IDENTITY_FILE=/root/.ssh/id_rsa
|
|
|
|
# --- NOTIFICATIONS (optional) ---
|
|
# Email notification on backup failure
|
|
# NOTIFICATION_URLS=smtp://user:password@smtp.example.com:587/?from=backup@example.com&to=admin@example.com
|
|
|
|
# Discord webhook notification
|
|
# NOTIFICATION_URLS=discord://token@channel
|
|
|
|
# Notification level: error, info (default: error)
|
|
# NOTIFICATION_LEVEL=error
|
|
|
|
# --- EXEC LABELS (optional) ---
|
|
# Run commands inside containers before/after backup
|
|
# Example: dump database before backup
|
|
# Use labels on containers:
|
|
# docker-volume-backup.exec-pre=/bin/sh -c 'pg_dump -U $POSTGRES_USER $POSTGRES_DB > /backup.sql'
|
|
# docker-volume-backup.exec-post=/bin/sh -c 'rm /backup.sql'
|