lapwat / backup-to-bucket

This Docker image let's you create different types of backup and upload it to a bucket.

Backup to bucket

This Docker image let's you create different types of backup and upload it to a bucket.

It works both ways, you can also retrieve a backup from a bucket and restore it.

Backup types

• file / folder .tar
• MySQL .sql
• PostgreSQL .sql

Transformations

• compression .gz
• encryption .age

Actions performed by [backup.sh](backup.sh):

• create the backup
• compress the backup (optional)
• encrypt the backup (optional)
• create the bucket based on BUCKET_NAME and MC_HOST_object-storage environment variables with transition and expiry lifecycle rules (if it does not exist yet)
• upload the backup to the bucket

Actions performed by [restore.sh](restore.sh):

• download the backup from the bucket
• decrypt the backup (optional)
• extract the backup (optional)
• restore the backup

Run

docker build -t ghcr.io/lapwat/sql-backup-to-bucket .\

# backup
docker run --env-file .env ghcr.io/lapwat/sql-backup-to-bucket backup

# restore
docker run --env-file .env ghcr.io/lapwat/sql-backup-to-bucket restore

Compression

Enable backup compression by setting COMPRESS environment variable to true.

Default: No compression

Encryption

Enable backup encryption by setting AGE_PUBLIC_KEY environment variable.

Default: No encryption

Decrypt the backup manually

age --decrypt -i key.txt CIPHER_NAME > BACKUP_NAME

Configuration examples

Backup a file / folder

This configuration creates a ${BACKUP_PREFIX}_YYYYmmddHHMMSS.tar.gz.age archive of a file or folder.

.env

COMPRESS=true
AGE_PUBLIC_KEY=agexxx
BACKUP_TYPE=FILE
BACKUP_FILENAME=/etc/hosts
BACKUP_PREFIX=mybackup
MC_HOST_object-storage=https://<Access Key>:<Secret Key>@<YOUR-S3-ENDPOINT>
BUCKET_NAME=mybucket
BUCKET_TRANSITION_DAYS=7
BUCKET_TRANSITION_STORAGE_CLASS=GLACIER
BUCKET_EXPIRY_DAYS=90

Backup a database

This configuration creates a ${BACKUP_PREFIX}_YYYYmmddHHMMSS.sql.gz.age archive of a mysql database.

.env

COMPRESS=true
AGE_PUBLIC_KEY=agexxx
BACKUP_TYPE=MYSQL|POSTGRES
DATABASE_HOST=localhost
DATABASE_PORT=3306
DATABASE_USER=root
DATABASE_PASSWORD=password
DATABASE_NAME=mydatabase
BACKUP_PREFIX=mybackup
MC_HOST_objectstorage=https://<Access Key>:<Secret Key>@<YOUR-S3-ENDPOINT>
BUCKET_NAME=mybucket
BUCKET_TRANSITION_DAYS=7
BUCKET_TRANSITION_STORAGE_CLASS=GLACIER
BUCKET_EXPIRY_DAYS=90

Restore a file / folder

Similarly, you can restore a file from a bucket

.env

EXTRACT=true
AGE_PRIVATE_KEY=AGE-SECRET-KEY-XXX
BACKUP_TYPE=FILE
RESTORE_DIRECTORY=/
MC_HOST_object-storage=https://<Access Key>:<Secret Key>@<YOUR-S3-ENDPOINT>
BUCKET_NAME=mybucket
BACKUP_NAME=mybackup_20221027000101.tar.gz.age