Dockerized service to automatically backup all of your database containers.
Docker Image Tags:
jandi/database-backupDocker Hubghcr.io/jan-di/database-backupGitHub Container Registry
Configure the backup service by specifying environment variables:
| Name | Default | Description |
|---|---|---|
TZ |
UTC |
Time Zone for scheduling and log messages |
SCHEDULE |
(none) | Specify a cron expression or an interval (number of seconds to wait between backup cycles). Leave undefined to make a one time run. See Croniter Documentation for cron options. |
SCHEDULE_HASH_ID |
(none) | Seed for hashed components in cron expressions. If not defined, the hostname of the container is used. |
RUN_AT_STARTUP |
(none) | Do a backup right after the backup service starts. If not defined, it is enabled when using an interval as schedule, and disabled when using cron expressions. Not used, if no schedule is defined. |
DUMP_UID |
-1 |
UID of dump files. -1 means default (docker executing user) |
DUMP_GID |
-1 |
GID of dump files. -1 means default (docker executing user) |
HEALTHCHECKS_IO_URL |
(none) | Base Url for Healthchecks.io integration |
DEBUG |
false |
More verbose output for debugging |
DOCKER_NETWORK_NAME |
database-backup |
Name of the internal network, that is used to connect to the database containers. |
DOCKER_TARGET_NAME |
database-backup-target |
Name of the internal hostname, that is used to connect to the database containers. |
You can also define global default values for all container specific labels. Do this by prepending the label name by GLOBAL_. For example, to provide a default username, you can set a default value for jan-di.database-backup.username by specifying the environment variable GLOBAL_USERNAME. See next chapter for reference.
Configure each database container by specifying labels. Every label must be prefixed by jan-di.database-backup.:
| Name | Default | Description |
|---|---|---|
enable |
false |
Enable backup for this container |
type |
auto |
Specify type of database. Possible values: auto, mysql, mariadb, postgres. Auto tries to get the type from the image name (for specific well known images) |
username |
root |
Login user |
password |
(none) | Login password |
port |
auto |
Port (inside container). Possible values: auto or a valid port number. Auto gets the default port corresponding to the type. |
dump_name |
(none) | Overwrite the base name of the dump file. If not defined, the container name is used. |
compress |
false |
Compress SQL Dump with gzip |
compression_level |
6 |
Gzip compression level (1-9) |
encrypt |
false |
Encrypt SQL Dump with AES |
encryption_key |
(none) | Key/Passphrase used to encrypt |
Example docker-compose.yml:
version: '3.8'
services:
db-backup: # backup service
image: ghcr.io/jan-di/database-backup
environment:
- TZ=Europe/Berlin
- SCHEDULE=600
- GLOBAL_PASSWORD=secret-password
volumes:
- /var/run/docker.sock:/var/run/docker.sock
database1: # well known database image
image: mariadb:latest
environment:
- MYSQL_ROOT_PASSWORD=secret-password
labels:
- jan-di.database-backup.enable=true
database2: # custom database image
image: user/my-database:latest
environment:
- DB_PASSWORD=secret-password
labels:
- jan-di.database-backup.enable=true
- jan-di.database-backup.type=postgres
- jan-di.database-backup.password=other-passwordInspired by kibatic/docker-mysql-backup