Topics

#backup #couchdb #docker #influx #mariadb #mongo #mongodb #mysql #redis

Language breakdown

No language data available.

▸ Files click to expand

README

github.com/tiredofit/docker-db-backup

About

>> This is being migrated to the nfrastack/container-db-backup namespace - A new nfrastack release will come in April 2026

This will build a container for backing up multiple types of DB Servers

Backs up CouchDB, InfluxDB, MySQL/MariaDB, Microsoft SQL, MongoDB, Postgres, Redis servers.

dump to local filesystem or backup to S3 Compatible services, and Azure.
multiple backup job support

- selectable when to start the first dump, whether time of day or relative to container start time - selectable interval - selectable omit scheduling during periods of time - selectable database user and password - selectable cleanup and archive capabilities - selectable database name support - all databases, single, or multiple databases - backup all to separate files or one singular file

checksum support choose to have an MD5 or SHA1 hash generated after backup for verification
compression support (none, gz, bz, xz, zstd)
encryption support (passphrase and public key)
notify upon job failure to email, matrix, mattermost, rocketchat, custom script
zabbix metrics support
hooks to execute pre and post backup job for customization purposes
companion script to aid in restores

Maintainer

Dave Conroy

- Quick Start - Persistent Storage - Environment Variables - Base Images used - Container Options - Job Defaults - Compression Options - Encryption Options - Scheduling Options - Default Database Options - CouchDB - InfluxDB - MariaDB/MySQL - Microsoft SQL - MongoDB - Postgresql - Redis - Default Storage Options - Filesystem - S3 - Azure - Hooks - Path Options - Pre Backup - Post backup - Job Backup Options - Compression Options - Encryption Options - Scheduling Options - Specific Database Options - CouchDB - InfluxDB - MariaDB/MySQL - Microsoft SQL - MongoDB - Postgresql - Redis - SQLite - Specific Storage Options - Filesystem - S3 - Azure - Hooks - Path Options - Pre Backup - Post backup - Notifications - Custom Notifications - Email Notifications - Matrix Notifications - Mattermost Notifications - Rocketchat Notifications

Maintenance

- Shell Access - Manual Backups - Restoring Databases

Support

- Usage - Bugfixes - Feature Requests - Updates

License

Prerequisites and Assumptions

You must have a working connection to one of the supported DB Servers and appropriate credentials

Installation

Build from Source

Clone this repository and build the image with docker build <arguments> (imagename) .

Prebuilt Images

Builds of the image are available on Docker Hub

Builds of the image are also available on the Github Container Registry

docker pull ghcr.io/tiredofit/docker-db-backup:(imagetag)

The following image tags are available along with their tagged release based on what's written in the Changelog:

| Alpine Base | Tag | | ----------- | --------- | | latest | :latest |

docker pull docker.io/tiredofit/db-backup:(imagetag)

Multi Architecture

Images are built primarily for amd64 architecture, and may also include builds for arm/v7, arm64 and others. These variants are all unsupported. Consider sponsoring my work so that I can work with various hardware. To see if this image supports multiple architectures, type docker manifest (image):(tag)

Configuration

Quick Start

The quickest way to get started is using docker-compose. See the examples folder for a series of example compose.yml that can be modified for development or production use.

Set various environment variables to understand the capabilities of this image.
Map persistent storage for access to configuration and data files for backup.

Persistent Storage

The following directories are used for configuration and can be mapped for persistent storage. | Directory | Description | | ---------------------- | ----------------------------------------------------------------------------------- | | /backup | Backups | | /assets/scripts/pre | Optional Put custom scripts in this directory to execute before backup operations | | /assets/scripts/post | Optional Put custom scripts in this directory to execute after backup operations | | /logs | Optional Logfiles for backup jobs |

Environment Variables

Base Images used

This image relies on an Alpine Linux base image that relies on an init system for added capabilities. Outgoing SMTP capabilities are handled via msmtp. Individual container performance monitoring is performed by zabbix-agent. Additional tools include: bash,curl,less,logrotate, nano.

Be sure to view the following repositories to understand all the customizable options:

| Image | Description | | ------------------------------------------------------ | -------------------------------------- | | OS Base | Customized Image based on Alpine Linux |

Container Options

| Parameter | Description | Default | | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------- | --------------- | | MODE | AUTO mode to use internal scheduling routines or MANUAL to simply use this as manual backups only executed by your own means | AUTO | | USER_DBBACKUP | The uid that the image should read and write files as (username is dbbackup) | 10000 | | GROUP_DBBACKUP | The gid that the image should read and write files as (groupname is dbbackup) | 10000 | | LOG_PATH | Path to log files | /logs | | TEMP_PATH | Perform Backups and Compression in this temporary directory | /tmp/backups/ | | MANUALRUNFOREVER | TRUE or FALSE if you wish to try to make the container exit after the backup | TRUE | | DEBUG_MODE | If set to true, print copious shell script messages to the container log. Otherwise only basic messages are printed. | FALSE | | BACKUPJOBCONCURRENCY | How many backup jobs to run concurrently | 1 |

Job Defaults

If these are set and no other defaults or variables are set explicitly, they will be added to any of the backup jobs.

| Variable | Description | Default | | --------------------------------- | ------------------------------------------------------------------------------------- | ------------ | | DEFAULTBACKUPLOCATION | Backup to FILESYSTEM, blobxfer or S3 compatible services like S3, Minio, Wasabi | FILESYSTEM | | DEFAULT_CHECKSUM | Either MD5 or SHA1 or NONE | MD5 | | DEFAULTLOGLEVEL | Log output on screen and in files INFO NOTICE ERROR WARN DEBUG | notice | | DEFAULTRESOURCEOPTIMIZED | Perform operations at a lower priority to the CPU and IO scheduler | FALSE | | DEFAULTSKIPAVAILABILITY_CHECK | Before backing up - skip connectivity check | FALSE |

Compression Options

| Variable | Description | Default | | -------------------------------------- | ---------------------------------------------------------------------------------------------- | -------------- | | DEFAULT_COMPRESSION | Use either Gzip GZ, Bzip2 BZ, XZip XZ, ZSTD ZSTD or none NONE | ZSTD | | DEFAULTCOMPRESSIONLEVEL | Numerical value of what level of compression to use, most allow 1 to 9 | 3 | | | except for ZSTD which allows for 1 to 19 | | | DEFAULTGZRSYNCABLE | Use --rsyncable (gzip only) for faster rsync transfers and incremental backup deduplication. | FALSE | | DEFAULTENABLEPARALLEL_COMPRESSION | Use multiple cores when compressing backups TRUE or FALSE | TRUE | | DEFAULTPARALLELCOMPRESSION_THREADS | Maximum amount of threads to use when compressing - Integer value e.g. 8 | autodetected |

Encryption Options

Encryption occurs after compression and the encrypted filename will have a .gpg suffix

| Variable | Description | Default | _FILE | | ----------------------------- | -------------------------------------------- | ------- | ------- | | DEFAULT_ENCRYPT | Encrypt file after backing up with GPG | FALSE | | | DEFAULTENCRYPTPASSPHRASE | Passphrase to encrypt file with GPG | | x | | or | | | | | DEFAULTENCRYPTPUBLIC_KEY | Path of public key to encrypt file with GPG | | x | | DEFAULTENCRYPTPRIVATE_KEY | Path of private key to encrypt file with GPG | | x |

Scheduling Options

| Variable | Description | Default | | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | DEFAULTBACKUPINTERVAL | How often to do a backup, in minutes after the first backup. Defaults to 1440 minutes, or once per day. | 1440 | | DEFAULTBACKUPBEGIN | What time to do the initial backup. Defaults to immediate. (+1) | +0 | | | Must be in one of four formats: | | | | Absolute HHMM, e.g. 2330 or 0415 | | | | Relative +MM, i.e. how many minutes after starting the container, e.g. +0 (immediate), +10 (in 10 minutes), or +90 in an hour and a half | | | | Full datestamp e.g. 2023-12-21 23:30:00 | | | | Cron expression e.g. 30 23 Understand the format - BACKUPINTERVAL is ignored* | | | DEFAULTCLEANUPTIME | Value in minutes to delete old backups (only fired when backup interval executes) | FALSE | | | 1440 would delete anything above 1 day old. You don't need to set this variable if you want to hold onto everything. | | | DEFAULTARCHIVETIME | Value in minutes to move all files files older than (x) from | | | DEFAULTBACKUPBLACKOUT_BEGIN | Use HHMM notation to start a blackout period where no backups occur eg 0420 | | | DEFAULTBACKUPBLACKOUT_END | Use HHMM notation to set the end period where no backups occur eg 0430 | |

You may need to wrap your DEFAULTBACKUPBEGIN value in quotes for it to properly parse. There have been reports of backups that start with a 0 get converted into a different format which will not allow the timer to start at the correct time.

Default Database Options

CouchDB

| Variable | Description | Default | _FILE | | -------------- | ------------ | ------- | ------- | | DEFAULT_PORT | CouchDB Port | 5984 | x |

InfluxDB

| Variable | Description | Default | _FILE | | ------------------------ | ------------------------------------------------------------------------------------------------------- | ------- | ------- | | DEFAULT_PORT | InfluxDB Port | | x | | | Version 1.x | 8088 | | | | Version 2.x | 8086 | | | DEFAULTINFLUXVERSION | What Version of Influx are you backing up from 1.x or 2 series - amd64 and aarch/armv8 only for 2 | 2 | |

MariaDB/MySQL

| Variable | Description | Default | _FILE | | ---------------------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------- | ------- | | DEFAULT_PORT | MySQL / MariaDB Port | 3306 | x | | DEFAULTEXTRABACKUP_OPTS | Pass extra arguments to the backup command only, add them here e.g. --extra-command | | | | DEFAULTEXTRAENUMERATION_OPTS | Pass extra arguments to the database enumeration command only, add them here e.g. --extra-command | | | | DEFAULTEXTRAOPTS | Pass extra arguments to the backup and database enumeration command, add them here e.g. --extra-command | | | | DEFAULTMYSQLCLIENT | Choose between mariadb or mysql client to perform dump operations for compatibility purposes | mariadb | | | DEFAULTMYSQLEVENTS | Backup Events | TRUE | | | DEFAULTMYSQLMAXALLOWEDPACKET | Max allowed packet | 512M | | | DEFAULTMYSQLSINGLE_TRANSACTION | Backup in a single transaction | TRUE | | | DEFAULTMYSQLSTORED_PROCEDURES | Backup stored procedures | TRUE | | | DEFAULTMYSQLENABLE_TLS | Enable TLS functionality | FALSE | | | DEFAULTMYSQLTLSVERIFY | (optional) If using TLS (by means of MYSQLTLS_* variables) verify remote host | FALSE | | | DEFAULTMYSQLTLS_VERSION | What TLS v1.1 v1.2 v1.3 version to utilize | TLSv1.1,TLSv1.2,TLSv1.3 | | | DEFAULTMYSQLTLSCAFILE | Filename to load custom CA certificate for connecting via TLS | /etc/ssl/cert.pem | x | | DEFAULTMYSQLTLSCERTFILE | Filename to load client certificate for connecting via TLS | | x | | DEFAULTMYSQLTLSKEYFILE | Filename to load client key for connecting via TLS | | x |

Microsoft SQL

| Variable | Description | Default | _FILE | | -------------------- | --------------------------------------- | ---------- | ------- | | DEFAULT_PORT | Microsoft SQL Port | 1433 | x | | DEFAULTMSSQLMODE | Backup DATABASE or TRANSACTION logs | DATABASE |

MongoDB

| Variable | Description | Default | _FILE | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------- | ------- | | DEFAULT_AUTH | (Optional) Authentication Database | | x | | DEFAULT_PORT | MongoDB Port | 27017 | x | | MONGOCUSTOMURI | If you wish to override the MongoDB Connection string enter it here e.g. mongodb+srv://username:password@cluster.id.mongodb.net | | x | | | This environment variable will be parsed and populate the DBNAME and DBHOST variables to properly build your backup filenames. | | | | | You can override them by making your own entries | | |

Postgresql

| Variable | Description | Default | _FILE | | -------------------------------- | --------------------------------------------------------------------------------------------------------- | ------- | ------- | | DEFAULT_AUTH | (Optional) Authentication Database | | x | | DEFAULTBACKUPGLOBALS | Backup Globals as part of backup procedure | | | | DEFAULTEXTRABACKUP_OPTS | Pass extra arguments to the backup command only, add them here e.g. --extra-command | | | | DEFAULTEXTRAENUMERATION_OPTS | Pass extra arguments to the database enumeration command only, add them here e.g. --extra-command | | | | DEFAULTEXTRAOPTS | Pass extra arguments to the backup and database enumeration command, add them here e.g. --extra-command | | | | DEFAULT_PORT | PostgreSQL Port | 5432 | x |

Redis

| Variable | Description | Default | _FILE | | -------------------------------- | --------------------------------------------------------------------------------------------------- | ------- | ------- | | DEFAULT_PORT | Default Redis Port | 6379 | x | | DEFAULTEXTRAENUMERATION_OPTS | Pass extra arguments to the database enumeration command only, add them here e.g. --extra-command | | |

Default Storage Options

Options that are related to the value of DEFAULTBACKUPLOCATION

Filesystem

If DEFAULTBACKUPLOCTION = FILESYSTEM then the following options are used:

| Variable | Description | Default | | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | ------------------------------------- | | DEFAULTCREATELATESTSYMLINK | Create a symbolic link pointing to last backup in this format: latest-(DBTYPE)(DBNAME)(DBHOST) | TRUE | | DEFAULTFILESYSTEMPATH | Directory where the database dumps are kept. | /backup | | DEFAULTFILESYSTEMPATH_PERMISSION | Permissions to apply to backup directory | 700 | | DEFAULTFILESYSTEMARCHIVEPATH | Optional Directory where the database dumps archives are kept | ${DEFAULTFILESYSTEM_PATH}/archive/ | | DEFAULTFILESYSTEMPERMISSION | Permissions to apply to files. | 600 |

S3

If DEFAULTBACKUPLOCATION = S3 then the following options are used:

| Parameter | Description | Default | _FILE | | ----------------------------- | ----------------------------------------------------------------------------------------- | ------- | ------- | | DEFAULTS3BUCKET | S3 Bucket name e.g. mybucket | | x | | DEFAULTS3KEY_ID | S3 Key ID (Optional) | | x | | DEFAULTS3KEY_SECRET | S3 Key Secret (Optional) | | x | | DEFAULTS3PATH | S3 Pathname to save to (must NOT end in a trailing slash e.g. 'backup') | | x | | DEFAULTS3REGION | Define region in which bucket is defined. Example: ap-northeast-2 | | x | | DEFAULTS3HOST | Hostname (and port) of S3-compatible service, e.g. minio:8080. Defaults to AWS. | | x | | DEFAULTS3PROTOCOL | Protocol to connect to DEFAULTS3HOST. Either http or https. Defaults to https. | https | x | | DEFAULTS3EXTRA_OPTS | Add any extra options to the end of the aws-cli process execution | | x | | DEFAULTS3CERTCAFILE | Map a volume and point to your custom CA Bundle for verification e.g. /certs/bundle.pem | | x | | OR | | | | | DEFAULTS3CERTSKIPVERIFY | Skip verifying self signed certificates when connecting | TRUE | |

When DEFAULTS3KEYID and/or DEFAULTS3KEYSECRET is not set, will try to use IAM role assigned (if any) for uploading the backup files to S3 bucket.

Azure

If DEFAULTBACKUPLOCATION = blobxfer then the following options are used:.

| Parameter | Description | Default | _FILE | | -------------------------------------- | ------------------------------------------------------------------- | ------------------- | ------- | | DEFAULTBLOBXFERSTORAGE_ACCOUNT | Microsoft Azure Cloud storage account name. | | x | | DEFAULTBLOBXFERSTORAGEACCOUNTKEY | Microsoft Azure Cloud storage account key. | | x | | DEFAULTBLOBXFERREMOTE_PATH | Remote Azure path | /docker-db-backup | x | | DEFAULTBLOBXFERMODE | Azure Storage mode e.g. auto, file, append, block or page | auto | x |

When DEFAULTBLOBXFERMODE is set to auto it will use blob containers by default. If the DEFAULTBLOBXFERREMOTE_PATH path does not exist a blob container with that name will be created.

This service uploads files from backup targed directory DEFAULTFILESYSTEMPATH.

If the a cleanup configuration in DEFAULTCLEANUPTIME is defined, the remote directory on Azure storage will also be cleaned automatically.

Hooks

Path Options

| Parameter | Description | Default | | ------------------------------ | --------------------------------------------------------------------------- | ----------------------- | | DEFAULTSCRIPTLOCATION_PRE | Location on filesystem inside container to execute bash scripts pre backup | /assets/scripts/pre/ | | DEFAULTSCRIPTLOCATION_POST | Location on filesystem inside container to execute bash scripts post backup | /assets/scripts/post/ | | DEFAULTPRESCRIPT | Fill this variable in with a command to execute pre backing up | | | DEFAULTPOSTSCRIPT | Fill this variable in with a command to execute post backing up | |

Pre Backup

If you want to execute a custom script before a backup starts, you can drop bash scripts with the extension of .sh in the location defined in DB01SCRIPTLOCATION_PRE. See the following example to utilize:

$ cat pre-script.sh
##!/bin/bash
#### Example Pre Script
#### $1=DBXX_TYPE (Type of Backup)
#### $2=DBXX_HOST (Backup Host)
#### $3=DBXX_NAME (Name of Database backed up
#### $4=BACKUP START TIME (Seconds since Epoch)
#### $5=BACKUP FILENAME (Filename)
echo "${1} Backup Starting on ${2} for ${3} at ${4}. Filename: ${5}"

## script DBXXTYPE DBXXHOST DBXXNAME STARTEPOCH BACKUPFILENAME ${f} "${backupjobdbtype}" "${backupjobdbhost}" "${backupjobdbname}" "${backuproutinesstarttime}" "${backupjobfile}"

Outputs the following on the console:

mysql Backup Starting on example-db for example at 1647370800. Filename: mysqlexampleexample-db_202200315-000000.sql.bz2

Post backup

If you want to execute a custom script at the end of a backup, you can drop bash scripts with the extension of .sh in the location defined in DB01SCRIPTLOCATION_POST. Also to support legacy users /assets/custom-scripts is also scanned and executed.See the following example to utilize:

$ cat post-script.sh
##!/bin/bash
#### Example Post Script
#### $1=EXIT_CODE (After running backup routine)
#### $2=DBXX_TYPE (Type of Backup)
#### $3=DBXX_HOST (Backup Host)
#### #4=DBXX_NAME (Name of Database backed up
#### $5=BACKUP START TIME (Seconds since Epoch)
#### $6=BACKUP FINISH TIME (Seconds since Epoch)
#### $7=BACKUP TOTAL TIME (Seconds between Start and Finish)
#### $8=BACKUP FILENAME (Filename)
#### $9=BACKUP FILESIZE
#### $10=HASH (If CHECKSUM enabled)
#### $11=MOVEEXITCODE
echo "${1} ${2} Backup Completed on ${3} for ${4} on ${5} ending ${6} for a duration of ${7} seconds. Filename: ${8} Size: ${9} bytes MD5: ${10}"

## script EXITCODE DBTYPE DBHOST DBNAME STARTEPOCH FINISHEPOCH DURATIONEPOCH BACKUP_FILENAME FILESIZE CHECKSUMVALUE ${f} "${exitcode}" "${dbtype}" "${backupjobdbhost}" "${backupjobdbname}" "${backuproutinesstarttime}" "${backuproutinesfinishtime}" "${backuproutinestotaltime}" "${backupjobfile}" "${filesize}" "${checksumvalue}" "${moveexit_code}

Outputs the following on the console:

0 mysql Backup Completed on example-db for example on 1647370800 ending 1647370920 for a duration of 120 seconds. Filename: mysqlexampleexample-db_202200315-000000.sql.bz2 Size: 7795 bytes Hash: 952fbaafa30437494fdf3989a662cd40 0

If you wish to change the size value from bytes to megabytes set environment variable DB01SIZEVALUE=megabytes

You must make your scripts executable otherwise there is an internal check that will skip trying to run it otherwise. If for some reason your filesystem or host is not detecting it right, use the environment variable DB01POSTSCRIPTSKIPX_VERIFY=TRUE to bypass.

Job Backup Options

If DEFAULT_ variables are set and you do not wish for the settings to carry over into your jobs, you can set the appropriate environment variable with the value of unset. Otherwise, override them per backup job. Additional backup jobs can be scheduled by using DB02,DB03,DB04_ ... prefixes. See Specific Database Options which may overrule this list.

| Parameter | Description | Default | _FILE | | ----------- | ---------------------------------------------------------------------------------------------- | ------- | ------- | | DB01_TYPE | Type of DB Server to backup couch influx mysql mssql pgsql mongo redis sqlite3 | | | | DB01_HOST | Server Hostname e.g. mariadb. For sqlite3, full path to DB file e.g. /backup/db.sqlite3 | | x | | DB01_NAME | Schema Name e.g. database | | x | | DB01_USER | username for the database(s) - Can use root for MySQL | | x | | DB01_PASS | (optional if DB doesn't require it) password for the database | | x |

| Variable | Description | Default | | ------------------------------ | --------------------------------------------------------------------------------------------------------- | ------------ | | DB01BACKUPLOCATION | Backup to FILESYSTEM, blobxfer or S3 compatible services like S3, Minio, Wasabi | FILESYSTEM | | DB01_CHECKSUM | Either MD5 or SHA1 or NONE | MD5 | | DB01EXTRABACKUP_OPTS | Pass extra arguments to the backup command only, add them here e.g. --extra-command | | | DB01EXTRAENUMERATION_OPTS | Pass extra arguments to the database enumeration command only, add them here e.g. --extra-command | | | DB01EXTRAOPTS | Pass extra arguments to the backup and database enumeration command, add them here e.g. --extra-command | | | DB01LOGLEVEL | Log output on screen and in files INFO NOTICE ERROR WARN DEBUG | debug | | DB01RESOURCEOPTIMIZED | Perform operations at a lower priority to the CPU and IO scheduler | FALSE | | DB01SKIPAVAILABILITY_CHECK | Before backing up - skip connectivity check | FALSE |

Compression Options

| Variable | Description | Default | | ----------------------------------- | ---------------------------------------------------------------------------------------------- | -------------- | | DB01_COMPRESSION | Use either Gzip GZ, Bzip2 BZ, XZip XZ, ZSTD ZSTD or none NONE | ZSTD | | DB01COMPRESSIONLEVEL | Numerical value of what level of compression to use, most allow 1 to 9 | 3 | | | except for ZSTD which allows for 1 to 19 | | | DB01GZRSYNCABLE | Use --rsyncable (gzip only) for faster rsync transfers and incremental backup deduplication. | FALSE | | DB01ENABLEPARALLEL_COMPRESSION | Use multiple cores when compressing backups TRUE or FALSE | TRUE | | DB01PARALLELCOMPRESSION_THREADS | Maximum amount of threads to use when compressing - Integer value e.g. 8 | autodetected |

Encryption Options

Encryption will occur after compression and the resulting filename will have a .gpg suffix

| Variable | Description | Default | _FILE | | -------------------------- | -------------------------------------------- | ------- | ------- | | DB01_ENCRYPT | Encrypt file after backing up with GPG | FALSE | | | DB01ENCRYPTPASSPHRASE | Passphrase to encrypt file with GPG | | x | | or | | | | | DB01ENCRYPTPUBLIC_KEY | Path of public key to encrypt file with GPG | | x | | DB01ENCRYPTPRIVATE_KEY | Path of private key to encrypt file with GPG | | x |

Scheduling Options

| Variable | Description | Default | | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | DB01BACKUPINTERVAL | How often to do a backup, in minutes after the first backup. Defaults to 1440 minutes, or once per day. | 1440 | | DB01BACKUPBEGIN | What time to do the initial backup. Defaults to immediate. (+1) | +0 | | | Must be in one of four formats: | | | | Absolute HHMM, e.g. 2330 or 0415 | | | | Relative +MM, i.e. how many minutes after starting the container, e.g. +0 (immediate), +10 (in 10 minutes), or +90 in an hour and a half | | | | Full datestamp e.g. 2023-12-21 23:30:00 | | | | Cron expression e.g. 30 23 Understand the format - BACKUPINTERVAL is ignored* | | | DB01CLEANUPTIME | Value in minutes to delete old backups (only fired when backup interval executes) | FALSE | | | 1440 would delete anything above 1 day old. You don't need to set this variable if you want to hold onto everything. | | | DB01ARCHIVETIME | Value in minutes to move all files files older than (x) from DB01BACKUPFILESYSTEM_PATH | | | | to DB01BACKUPFILESYSTEMARCHIVEPATH - which is useful when pairing against an external backup system. | | | DB01BACKUPBLACKOUT_BEGIN | Use HHMM notation to start a blackout period where no backups occur eg 0420 | | | DB01BACKUPBLACKOUT_END | Use HHMM notation to set the end period where no backups occur eg 0430 | |

Specific Database Options

CouchDB

| Variable | Description | Default | _FILE | | ----------- | ------------ | ------- | ------- | | DB01_PORT | CouchDB Port | 5984 | x |

InfluxDB

| Variable | Description | Default | _FILE | | --------------------- | ------------------------------------------------------------------------------------------------------- | ------- | ------- | | DB01_PORT | InfluxDB Port | | x | | | Version 1.x | 8088 | | | | Version 2.x | 8086 | | | DB01INFLUXVERSION | What Version of Influx are you backing up from 1.x or 2 series - amd64 and aarch/armv8 only for 2 | 2 | |

Your Organization will be mapped to DBUSER and your root token will need to be mapped to DBPASS.

You may use DB_NAME=ALL to backup the entire set of databases.

For DB_HOST use syntax of http(s)://db-name

MariaDB/MySQL

| Variable | Description | Default | _FILE | | ------------------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------- | ------- | | DB01EXTRAOPTS | Pass extra arguments to the backup and database enumeration command, add them here e.g. --extra-command | | | | DB01EXTRABACKUP_OPTS | Pass extra arguments to the backup command only, add them here e.g. --extra-command | | | | DB01EXTRAENUMERATION_OPTS | Pass extra arguments to the database enumeration command only, add them here e.g. --extra-command | | | | DB01_NAME | Schema Name e.g. database or ALL to backup all databases the user has access to. | | | | | Backup multiple by separating with commas eg db1,db2 | | x | | DB01NAMEEXCLUDE | If using ALL - use this as to exclude databases separated via commas from being backed up | | x | | DB01SPLITDB | If using ALL - use this to split each database into its own file as opposed to one singular file | FALSE | | | DB01_PORT | MySQL / MariaDB Port | 3306 | x | | DB01MYSQLEVENTS | Backup Events for | TRUE | | | DB01MYSQLMAXALLOWEDPACKET | Max allowed packet | 512M | | | DB01MYSQLSINGLE_TRANSACTION | Backup in a single transaction | TRUE | | | DB01MYSQLSTORED_PROCEDURES | Backup stored procedures | TRUE | | | DB01MYSQLENABLE_TLS | Enable TLS functionality | FALSE | | | DB01MYSQLTLSVERIFY | (optional) If using TLS (by means of MYSQLTLS_* variables) verify remote host | FALSE | | | DB01MYSQLTLS_VERSION | What TLS v1.1 v1.2 v1.3 version to utilize | TLSv1.1,TLSv1.2,TLSv1.3 | | | DB01MYSQLTLSCAFILE | Filename to load custom CA certificate for connecting via TLS | /etc/ssl/cert.pem | x | | DB01MYSQLTLSCERTFILE | Filename to load client certificate for connecting via TLS | | x | | DB01MYSQLTLSKEYFILE | Filename to load client key for connecting via TLS | | x |

Microsoft SQL

| Variable | Description | Default | _FILE | | ----------------- | --------------------------------------- | ---------- | ------- | | DB01_PORT | Microsoft SQL Port | 1433 | x | | DB01MSSQLMODE | Backup DATABASE or TRANSACTION logs | DATABASE |

MongoDB

| Variable | Description | Default | _FILE | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------- | ------- | | DB01_AUTH | (Optional) Authentication Database | | | | DB01_PORT | MongoDB Port | 27017 | x | | DB01MONGOCUSTOM_URI | If you wish to override the MongoDB Connection string enter it here e.g. mongodb+srv://username:password@cluster.id.mongodb.net | | x | | | This environment variable will be parsed and populate the DBNAME and DBHOST variables to properly build your backup filenames. | | | | | You can override them by making your own entries | | |

Postgresql

| Variable | Description | Default | _FILE | | ----------------------------- | --------------------------------------------------------------------------------------------------------- | ------- | ------- | | DB01_AUTH | (Optional) Authentication Database | | | | DB01BACKUPGLOBALS | Backup Globals after backing up database (forces TRUE if _NAME=ALL) | FALSE | | | DB01EXTRAOPTS | Pass extra arguments to the backup and database enumeration command, add them here e.g. --extra-command | | | | DB01EXTRABACKUP_OPTS | Pass extra arguments to the backup command only, add them here e.g. --extra-command | | | | DB01EXTRAENUMERATION_OPTS | Pass extra arguments to the database enumeration command only, add them here e.g. --extra-command | | | | DB01_NAME | Schema Name e.g. database or ALL to backup all databases the user has access to. | | | | | Backup multiple by separating with commas eg db1,db2 | | x | | DB01SPLITDB | If using ALL - use this to split each database into its own file as opposed to one singular file | FALSE | | | DB01_PORT | PostgreSQL Port | 5432 | x |


Redis

| Variable | Description | Default | _FILE | | ------------------------ | --------------------------------------------------------------------------------------------------------- | ------- | ------- | | DB01EXTRAOPTS | Pass extra arguments to the backup and database enumeration command, add them here e.g. --extra-command | | | | DB01EXTRABACKUP_OPTS | Pass extra arguments to the backup command only, add them here e.g. --extra-command | | | | DB01_PORT | Redis Port | 6379 | x |


SQLite

| Variable | Description | Default | _FILE | | ----------- | -------------------------------------------------------- | ------- | ------- | | DB01_HOST | Enter the full path to DB file e.g. /backup/db.sqlite3 | | x |


Specific Storage Options

Options that are related to the value of DB01BACKUPLOCATION


Filesystem

If DB01BACKUPLOCTION = FILESYSTEM then the following options are used:

| Variable | Description | Default | | --------------------------------- | ----------------------------------------------------------------------------------------------------- | ---------------------------------- | | DB01CREATELATESTSYMLINK | Create a symbolic link pointing to last backup in this format: latest-(DBTYPE)-(DBNAME)-(DBHOST) | TRUE | | DB01FILESYSTEMPATH | Directory where the database dumps are kept. | /backup | | DB01FILESYSTEMPATH_PERMISSION | Permissions to apply to backup directory | 700 | | DB01FILESYSTEMARCHIVEPATH | Optional Directory where the database dumps archives are kept | ${DB01FILESYSTEM_PATH}/archive/ | | DB01FILESYSTEMPERMISSION | Directory and File permissions to apply to files. | 600 |

S3

If DB01BACKUPLOCATION = S3 then the following options are used:

| Parameter | Description | Default | _FILE | | -------------------------- | ----------------------------------------------------------------------------------------- | ------- | ------- | | DB01S3BUCKET | S3 Bucket name e.g. mybucket | | x | | DB01S3KEY_ID | S3 Key ID (Optional) | | x | | DB01S3KEY_SECRET | S3 Key Secret (Optional) | | x | | DB01S3PATH | S3 Pathname to save to (must NOT end in a trailing slash e.g. 'backup') | | x | | DB01S3REGION | Define region in which bucket is defined. Example: ap-northeast-2 | | x | | DB01S3HOST | Hostname (and port) of S3-compatible service, e.g. minio:8080. Defaults to AWS. | | x | | DB01S3PROTOCOL | Protocol to connect to DB01S3HOST. Either http or https. Defaults to https. | https | x | | DB01S3EXTRA_OPTS | Add any extra options to the end of the aws-cli process execution | | x | | DB01S3CERTCAFILE | Map a volume and point to your custom CA Bundle for verification e.g. /certs/bundle.pem | | x | | OR | | | | | DB01S3CERTSKIPVERIFY | Skip verifying self signed certificates when connecting | TRUE | |

> When DB01S3KEYID and/or DB01S3KEYSECRET is not set, will try to use IAM role assigned (if any) for uploading the backup files to S3 bucket.


Azure

If DB01BACKUPLOCATION = blobxfer then the following options are used:.

| Parameter | Description | Default | _FILE | | -------------------------------------- | ------------------------------------------------------------------- | ------------------- | ------- | | DB01BLOBXFERSTORAGE_ACCOUNT | Microsoft Azure Cloud storage account name. | | x | | DB01BLOBXFERSTORAGEACCOUNTKEY | Microsoft Azure Cloud storage account key. | | x | | DB01BLOBXFERREMOTE_PATH | Remote Azure path | /docker-db-backup | x | | DB01BLOBXFERREMOTE_MODE | Azure Storage mode e.g. auto, file, append, block or page | auto | x |

When DEFAULTBLOBXFERMODE is set to auto it will use blob containers by default. If the DEFAULTBLOBXFERREMOTE_PATH path does not exist a blob container with that name will be created.


> This service uploads files from backup directory

DB01BACKUPFILESYSTEM_PATH

.
> If the a cleanup configuration in

DB01CLEANUPTIME

 is defined, the remote directory on Azure storage will also be cleaned automatically.
Hooks
Path Options

| Parameter | Description | Default | | --------------------------- | --------------------------------------------------------------------------- | ----------------------- | | DB01SCRIPTLOCATION_PRE | Location on filesystem inside container to execute bash scripts pre backup | /assets/scripts/pre/ | | DB01SCRIPTLOCATION_POST | Location on filesystem inside container to execute bash scripts post backup | /assets/scripts/post/ | | DB01PRESCRIPT | Fill this variable in with a command to execute pre backing up | | | DB01POSTSCRIPT | Fill this variable in with a command to execute post backing up | |


Pre Backup

If you want to execute a custom script before a backup starts, you can drop bash scripts with the extension of .sh in the location defined in DB01SCRIPTLOCATION_PRE. See the following example to utilize:


<pre><code class="lang-bash">$ cat pre-script.sh ##!/bin/bash
#### Example Pre Script
#### $1=DB01_TYPE (Type of Backup)
#### $2=DB01_HOST (Backup Host)
#### $3=DB01_NAME (Name of Database backed up
#### $4=BACKUP START TIME (Seconds since Epoch)
#### $5=BACKUP FILENAME (Filename)
echo &quot;${1} Backup Starting on ${2} for ${3} at ${4}. Filename: ${5}&quot;</code></pre>
## script DB01TYPE DB01HOST DB01NAME STARTEPOCH BACKUPFILENAME     ${f} "${backupjobdbtype}" "${backupjobdbhost}" "${backupjobdbname}" "${backuproutinesstarttime}" "${backupjobfilename}"
Outputs the following on the console:

mysql Backup Starting on example-db for example at 1647370800. Filename: mysqlexampleexample-db_202200315-000000.sql.bz2


Post backup

If you want to execute a custom script at the end of a backup, you can drop bash scripts with the extension of .sh in the location defined in DB01SCRIPTLOCATION_POST. Also to support legacy users /assets/custom-scripts is also scanned and executed.See the following example to utilize:


<pre><code class="lang-bash">$ cat post-script.sh ##!/bin/bash
#### Example Post Script
#### $1=EXIT_CODE (After running backup routine)
#### $2=DB_TYPE (Type of Backup)
#### $3=DB_HOST (Backup Host)
#### #4=DB_NAME (Name of Database backed up
#### $5=BACKUP START TIME (Seconds since Epoch)
#### $6=BACKUP FINISH TIME (Seconds since Epoch)
#### $7=BACKUP TOTAL TIME (Seconds between Start and Finish)
#### $8=BACKUP FILENAME (Filename)
#### $9=BACKUP FILESIZE
#### $10=HASH (If CHECKSUM enabled)
#### $11=MOVEEXITCODE
echo &quot;${1} ${2} Backup Completed on ${3} for ${4} on ${5} ending ${6} for a duration of ${7} seconds. Filename: ${8} Size: ${9} bytes MD5: ${10}&quot;</code></pre>
## script EXITCODE DBTYPE DBHOST DBNAME STARTEPOCH FINISHEPOCH DURATIONEPOCH BACKUP_FILENAME FILESIZE CHECKSUMVALUE       ${f} "${exitcode}" "${dbtype}" "${dbhost}" "${dbname}" "${backuproutinesstarttime}" "${backuproutinesfinishtime}" "${backuproutinestotaltime}" "${backupjobfilename}" "${filesize}" "${checksumvalue}" "${moveexit_code}
Outputs the following on the console:

0 mysql Backup Completed on example-db for example on 1647370800 ending 1647370920 for a duration of 120 seconds. Filename: mysqlexampleexample-db_202200315-000000.sql.bz2 Size: 7795 bytes Hash: 952fbaafa30437494fdf3989a662cd40 0

If you wish to change the size value from bytes to megabytes set environment variable DB01SIZEVALUE=megabytes

You must make your scripts executable otherwise there is an internal check that will skip trying to run it otherwise. If for some reason your filesystem or host is not detecting it right, use the environment variable DB01POSTSCRIPTSKIPX_VERIFY=TRUE to bypass.


Notifications
This image has capabilities on sending notifications via a handful of services when a backup job fails. This is a global option that cannot be individually set per backup job.

| Parameter | Description | Default | | ---------------------- | --------------------------------------------------------------------------------- | ------- | | ENABLE_NOTIFICATIONS` | Enable Notifications

README truncated. View on GitHub

🔗 More in this category

github.com/tiredofit/docker-db-backup

About

Maintainer

Table of Contents

Prerequisites and Assumptions

Installation

Build from Source

Prebuilt Images

Multi Architecture

Configuration

Quick Start

Persistent Storage

Environment Variables

Base Images used

Container Options

Job Defaults

Compression Options

Encryption Options

Scheduling Options

Default Database Options

CouchDB

InfluxDB

MariaDB/MySQL

Microsoft SQL

MongoDB

Postgresql

Redis

Default Storage Options

Filesystem

S3

Azure

Hooks

Path Options

Pre Backup

#### Example Pre Script

#### $1=DBXX_TYPE (Type of Backup)

#### $2=DBXX_HOST (Backup Host)

#### $3=DBXX_NAME (Name of Database backed up

#### $4=BACKUP START TIME (Seconds since Epoch)

#### $5=BACKUP FILENAME (Filename)

Post backup

#### Example Post Script

#### $1=EXIT_CODE (After running backup routine)

#### $2=DBXX_TYPE (Type of Backup)

#### $3=DBXX_HOST (Backup Host)

#### #4=DBXX_NAME (Name of Database backed up

#### $5=BACKUP START TIME (Seconds since Epoch)

#### $6=BACKUP FINISH TIME (Seconds since Epoch)

#### $7=BACKUP TOTAL TIME (Seconds between Start and Finish)

#### $8=BACKUP FILENAME (Filename)

#### $9=BACKUP FILESIZE

#### $10=HASH (If CHECKSUM enabled)

#### $11=MOVEEXITCODE

Job Backup Options

Compression Options

Encryption Options

Scheduling Options

Specific Database Options

CouchDB

InfluxDB

MariaDB/MySQL

Microsoft SQL

MongoDB

Postgresql

Redis

SQLite

Specific Storage Options

Filesystem

S3

Azure

Hooks

Path Options

Pre Backup

#### Example Pre Script

#### $1=DB01_TYPE (Type of Backup)

#### $2=DB01_HOST (Backup Host)

#### $3=DB01_NAME (Name of Database backed up

#### $4=BACKUP START TIME (Seconds since Epoch)

#### $5=BACKUP FILENAME (Filename)

Post backup