Xbackup is a Docker-based backup solution for MySQL databases, utilizing xtrabackup for creating backups and s3cmd for pushing these backups to Amazon S3. The setup includes incremental and full backups, managed by cron jobs, with configurable parameters for database credentials, S3 credentials, and backup schedules.
- Full and incremental MySQL backups using
xtrabackup - Secure backup storage in Amazon S3
- Configurable backup schedules via cron jobs
- Easy deployment using Docker and Docker Compose
- bash and sudo privilege
- AWS S3 bucket and credentials
- Rest will be installed at the runtime
-
Clone the repository:
git clone https://github.com/Cosmicoppai/xbackup.git cd xbackup -
Configure Environment Variables:
Create a
.envfile in the project root and add your configuration:DB_HOST=your_database_host DB_USER=your_database_user DB_PASSWORD=your_database_password DB_NAME=your_database_name S3_ACCESS_KEY=your_s3_access_key S3_SECRET_KEY=your_s3_secret_key S3_BUCKET=your_s3_bucket_name S3_REGION=your_s3_region
-
Build and Run the Docker Container:
chmod +x ./xbackup.sh sudo ./xbackup.sh start
Backups are managed using cron jobs defined in the docker-compose.yml file. Modify the cron job schedule as needed:
Edit the cron job time in .env file to set your backup schedules:
CRON_TIME="0 */3 * * *"To restore a backup, download the backup files from S3 and use xtrabackup to apply logs and restore the database:
./xbackup.sh load # it'll download the backup from s3
# check everything is correct and correctly downloaded/decompressed
# move the backup into the data dir
./xbackup.sh apply Feel free to fork this repository and submit pull requests. Contributions are welcome!
This project is licensed under the MIT License. See the LICENSE file for details.
For any questions or suggestions, feel free to open an issue or contact the repository owner.