Backup MongoDB databases
A script that creates backups of a MongoDB databases at a set schedule.
- Backups are GZIP compressed
- Backups are stored locally, in an AWS S3 bucket, or both
- Backups are retained according to a configurable retention policy with old backups automatically removed
- Outside of the schedule, send a
POSTrequest to the/start_backupAPI endpoint to create a backup on demand
Configuration is managed through environment variables. The following variables are required:
AWS_ACCESS_KEY_ID- The AWS access key IDAWS_S3_BUCKET_NAME- The AWS S3 bucket nameAWS_S3_BUCKET_PATH- The AWS S3 bucket pathAWS_SECRET_ACCESS_KEY- The AWS secret access keyBACKUP_DIR- The directory to store the backupsCRON_SCHEDULE- The cron schedule to run the backup script (Note: This only parses hours and minutes but must include all 5 fields as a single string e.g.20 11 * * *or*\2 * * * *) (default: 2am daily)DAILY_RETENTION- The number of daily backups to keep (default: 7)LOG_FILE- The file to write logs to (default:backup-mongodb.log)LOG_LEVEL- The log level to use (default:INFO)MONGO_DB- The name of the database to backupMONGO_URI- The URI to connect to the MongoDB instanceMONTHLY_RETENTION- The number of monthly backups to keep (default: 12)PORT- The port to connect to the MongoDB instance (default:8080)STORAGE_LOCATION- The storage type to use. Valid options arelocal,s3, orboth(default:local)WEEKLY_RETENTION- The number of weekly backups to keep (default: 4)YEARLY_RETENTION- The number of yearly backups to keep (default: 2)
This script is intended to be run as a Docker container. The following command will run the script with the default configuration:
docker run -d \
-e MONGO_URI="mongodb://localhost:27017" \
-e MONGO_DB="mydb" \
-e BACKUP_DIR="/data/backups" \
-e CRON_SCHEDULE="0 02 * * *" \
-e STORAGE="local" \
-e LOG_FILE="/data/backup-mongodb.log" \
-e TZ="America/New_York" \
-v /path/to/data:/data \
-p 8080:8080 \
--name backup-mongodb \
ghcr.io/natelandau/backup-mongodb:latestThere are two ways to contribute to this project.
- Install Python 3.11 and uv
- Clone this repository.
git clone https://github.com/natelandau/backup-mongodb - Install the uv environment with
uv sync. - Activate your uv environment with
source .venv/bin/activate. - Install the pre-commit hooks with
pre-commit install --install-hooks.
- This project follows the Conventional Commits standard to automate Semantic Versioning and Keep A Changelog with Commitizen.
- When you're ready to commit changes run
cz c
- When you're ready to commit changes run
- Run
duty --listfrom within the development environment to print a list of Duty tasks available to run on this project. Common commands:duty lintruns all lintersduty testruns all tests with Pytest
- Run
uv add {package}from within the development environment to install a run time dependency and add it topyproject.tomlandpoetry.lock. - Run
uv remove {package}from within the development environment to uninstall a run time dependency and remove it frompyproject.tomlanduv.lock. - Run
duty updatefrom within the development environment to upgrade all dependencies to the latest versions allowed bypyproject.toml.