RealOrangeOne/docker-db-auto-backup
RealOrangeOne/docker-db-auto-backup has 201 GitHub stars and 26 forks. GitHot measured 0 stars in 24 hours, 0 in 7 days, and 0 in 15 days. Last checked 2026-11-17 00:27 UTC. Last push 2026-11-12.
Measured star growth
- in 24h
- 0
- in 7 days
- 0
- in 15 days
- 0
- in 1 month
- Update delayed
Net star changes over overlapping periods, not daily totals. Missing measurements are left blank. Stars measure attention, not software quality.
About
A script to automatically back up all databases running under docker on a host
DataREADME.md
Originaldocker-db-auto-backup
A script to automatically back up all databases running under docker on a host, with optional compression support.
Supported databases
- MySQL
- MariaDB
- PostgreSQL
- TimescaleDB
- pgvecto.rs
- pgvector,
- Nextcloud's AIO
- pgautoupgrade
- Immich's Postgres VectorChord
- Redis
If your database isn't detected automatically, you can specify using the db-auto-backup label (configurable using $AUTO_BACKUP_LABEL):
services:
valkey:
image: valkey/valkey:9
labels:
- "auto-backup=redis" # Backup as if it were redis
my_custom_database:
image: some.private.host/organization/custom_database:latest
labels:
- "auto-backup=postgres" # Force identification as postgres
unimportant:
image: postgres:18
labels:
- "auto-backup=false" # Skip backup
Installation
This container requires access to the docker socket. This can be done either by mounting /var/lib/docker.sock, or using a HTTP proxy to provide it through $DOCKER_HOST.
Mount your backup directory as /var/backups (or override $BACKUP_DIR). Backups will be saved here based on the name of the container. Backups are not dated or compressed.
Backups run daily at midnight. To change this, add a cron-style schedule to $SCHEDULE. For more information on the format of the cron strings, please see the croniter documentation on PyPI.
Output is intentionally limited, to avoid polluting container logs. Set $DEBUG to something other than "false" to show additional details.
Success hooks
When backups are completed successfully, a request can be made to the URL defined in $SUCCESS_HOOK_URL. By default, a GET request is made. To include logs, also set $INCLUDE_LOGS to a non-empty value, which sends a POST request instead with helpful details in the body.
Note: Previous versions also supported $HEALTHCHECKS_ID, $HEALTHCHECKS_HOST and $UPTIME_KUMA_URL, or native support for healthchecks.io and Uptime Kuma respectively. These are all still supported, however $SUCCESS_HOOK_URL is preferred.
Compression
Files are backed up uncompressed by default, on the assumption a snapshotting or native compressed filesystem is being used (eg ZFS). To enable compression, set $COMPRESSION to one of the supported algorithms:
gziplzma/xzbz2zstdplain(no compression - the default)
Example docker-compose.yml
version: "2.3"
services:
backup:
image: ghcr.io/realorangeone/db-auto-backup:latest
restart: unless-stopped
volumes:
- /var/run/docker.sock:/var/run/docker.sock:ro
- ./backups:/var/backups
environment:
- SUCCESS_HOOK_URL=https://hc-ping.com/1234
- INCLUDE_LOGS=true
Oneshot
You may want to use this container to run backups just once, rather than on a schedule. To achieve this, set $SCHEDULE to an empty string, and the backup will run just once. This may be useful in conjunction with an external scheduler.