A Docker image for automated MySQL and PostgreSQL database backups to S3-compatible storage with configurable retention policies.
docker run -d \
--name mysql-backup \
-e DB_TYPE=mysql \
-e MYSQL_HOST=your-mysql-host \
-e MYSQL_USER=backup_user \
-e MYSQL_PASSWORD=your_password \
-e S3_BUCKET=your-backup-bucket \
-e AWS_ENDPOINT_URL=https://s3.amazonaws.com \
-e AWS_ACCESS_KEY_ID=your_access_key \
-e AWS_SECRET_ACCESS_KEY=your_secret_key \
kadiiski/mysql-s3-backup
docker run -d \
--name postgres-backup \
-e DB_TYPE=postgres \
-e POSTGRES_HOST=your-postgres-host \
-e POSTGRES_USER=backup_user \
-e POSTGRES_PASSWORD=your_password \
-e S3_BUCKET=your-backup-bucket \
-e AWS_ENDPOINT_URL=https://s3.amazonaws.com \
-e AWS_ACCESS_KEY_ID=your_access_key \
-e AWS_SECRET_ACCESS_KEY=your_secret_key \
kadiiski/mysql-s3-backup
| Variable | Description | Default | Required |
|---|---|---|---|
DB_TYPE | Database type: mysql or postgres | mysql | No |
| Variable | Description | Default | Required |
|---|---|---|---|
MYSQL_HOST | MySQL server hostname | - | Yes (for MySQL) |
MYSQL_PORT | MySQL port | 3306 | No |
MYSQL_USER | MySQL username | - | Yes (for MySQL) |
MYSQL_PASSWORD | MySQL password | - | Yes (for MySQL) |
MYSQL_DATABASE | Specific database to backup (optional) | - | No |
| Variable | Description | Default | Required |
|---|---|---|---|
POSTGRES_HOST | PostgreSQL server hostname | - | Yes (for PostgreSQL) |
POSTGRES_PORT | PostgreSQL port | 5432 | No |
POSTGRES_USER | PostgreSQL username | - | Yes (for PostgreSQL) |
POSTGRES_PASSWORD | PostgreSQL password | - | Yes (for PostgreSQL) |
POSTGRES_DATABASE | Specific database to backup (optional) | - | No |
| Variable | Description | Default | Required |
|---|---|---|---|
S3_BUCKET | S3 bucket name | - | Yes |
S3_PREFIX | S3 prefix/path | backups | No |
AWS_ENDPOINT_URL | S3 endpoint URL | - | Yes |
AWS_ACCESS_KEY_ID | AWS access key | - | Yes |
AWS_SECRET_ACCESS_KEY | AWS secret key | - | Yes |
| Variable | Description | Default | Required |
|---|---|---|---|
CRON_SCHEDULE | Cron schedule for backups | 0 0 * * * (daily at midnight) | No |
RETENTION_COUNT | Number of backups to keep | 7 | No |
TZ | Timezone for cron jobs | Europe/Sofia | No |
The container runs automated backups based on the CRON_SCHEDULE. Default is daily at midnight (0 0 * * *).
You can run manual operations using the backup command:
# List available backups
docker exec mysql-backup backup list
# Create manual backup
docker exec mysql-backup backup backup
# Restore from specific backup
docker exec mysql-backup backup restore backup-2024-05-21_10-30-00.sql.gz
docker run -d \
--name mysql-app-backup \
-e DB_TYPE=mysql \
-e MYSQL_HOST=db.example.com \
-e MYSQL_USER=backup_user \
-e MYSQL_PASSWORD=secure_password \
-e MYSQL_DATABASE=myapp \
-e S3_BUCKET=backups \
-e S3_PREFIX=mysql/myapp \
-e AWS_ENDPOINT_URL=https://s3.amazonaws.com \
-e AWS_ACCESS_KEY_ID=AKIA... \
-e AWS_SECRET_ACCESS_KEY=xxx \
-e CRON_SCHEDULE="0 2 * * *" \
kadiiski/mysql-s3-backup
docker run -d \
--name postgres-full-backup \
-e DB_TYPE=postgres \
-e POSTGRES_HOST=postgres.example.com \
-e POSTGRES_USER=postgres \
-e POSTGRES_PASSWORD=secure_password \
-e S3_BUCKET=backups \
-e S3_PREFIX=postgres/full \
-e RETENTION_COUNT=14 \
-e AWS_ENDPOINT_URL=https://minio.example.com \
-e AWS_ACCESS_KEY_ID=minioadmin \
-e AWS_SECRET_ACCESS_KEY=minioadmin \
-e CRON_SCHEDULE="0 3 * * *" \
kadiiski/mysql-s3-backup
version: '3.8'
services:
mysql-backup:
image: kadiiski/mysql-s3-backup
environment:
DB_TYPE: mysql
MYSQL_HOST: mysql
MYSQL_USER: backup_user
MYSQL_PASSWORD: backup_password
S3_BUCKET: mysql-backups
S3_PREFIX: production
AWS_ENDPOINT_URL: https://s3.amazonaws.com
AWS_ACCESS_KEY_ID: your_access_key
AWS_SECRET_ACCESS_KEY: your_secret_key
CRON_SCHEDULE: "0 2 * * *"
RETENTION_COUNT: 7
restart: unless-stopped
version: '3.8'
services:
postgres-backup:
image: kadiiski/mysql-s3-backup
environment:
DB_TYPE: postgres
POSTGRES_HOST: postgres
POSTGRES_USER: backup_user
POSTGRES_PASSWORD: backup_password
S3_BUCKET: postgres-backups
S3_PREFIX: production
AWS_ENDPOINT_URL: https://s3.amazonaws.com
AWS_ACCESS_KEY_ID: your_access_key
AWS_SECRET_ACCESS_KEY: your_secret_key
CRON_SCHEDULE: "0 3 * * *"
RETENTION_COUNT: 14
restart: unless-stopped
mysqldump --all-databases --add-drop-database when no specific database is setmysqldump --databases <db_name> --add-drop-database when MYSQL_DATABASE is specifiedpg_dumpall --clean to backup all databases and rolespg_dump --clean --create --if-exists for single database backupspostgres maintenance database to allow DROP/CREATE DATABASE commands to work properlyExisting MySQL setups continue to work unchanged! If you're upgrading from version 1.x:
./backup.sh script still works and automatically sets DB_TYPE=mysqlmysql when using the legacy backup.sh scriptBackups are stored with the following naming convention:
backup-YYYY-MM-DD_HH-MM-SS.sql.gz
Examples:
backup-2024-05-21_14-30-45.sql.gzbackup-2024-05-22_02-00-12.sql.gzdocker logs mysql-backup
# Test MySQL connection
docker exec -it mysql-backup mysql -h $MYSQL_HOST -u $MYSQL_USER -p
# Test PostgreSQL connection
docker exec -it mysql-backup psql -h $POSTGRES_HOST -U $POSTGRES_USER -d postgres
# Test S3 connection
docker exec -it mysql-backup aws s3 ls s3://$S3_BUCKET --endpoint-url $AWS_ENDPOINT_URL
Content type
Image
Digest
sha256:48807e1c1…
Size
279.1 MB
Last updated
10 months ago
docker pull kadiiski/database-s3-backup