silintl/mysql-backup-restore repository overview

⁠mysql-backup-restore

Service to backup and/or restore mysql databases using S3

⁠How to use it

1. Create an S3 bucket to hold your backups
2. Turn versioning on for that bucket
3. Supply all appropriate environment variables
4. Run a backup and check your bucket for that backup

⁠Environment variables

MODE=[backup|restore]

DB_NAMES=name1 name2 name3 ...

MYSQL_USER=

MYSQL_PASSWORD=

MYSQL_DUMP_ARGS= (optional) additional arguments to the mysqldump command, e.g., --max_allowed_packet=50M

AWS_ACCESS_KEY= used for S3 interactions

AWS_SECRET_KEY= used for S3 interactions

S3_BUCKET= e.g., s3://database-backups NOTE: no trailing slash

⁠Docker Hub

This image is built automatically on Docker Hub as silintl/mysql-backup-restore⁠

⁠Playing with it locally

You'll need Docker⁠ and Make⁠

1. cp local.env.dist local.env and supply variables
2. Ensure you have a gz dump in your S3 bucket to be used for testing. A test database is provided as part of this project in the test folder.
3. make

A UI into the local database will then be running at http://localhost:8001⁠

A couple of test databases are provided in the test folder if needed.