To use, mount the volumes you wish to backup under /backup, then configure the following secrets/environment variables:
| Secret | Description |
|---|---|
borg_ssh_key | The private key used for remote backups |
borg_passphrase | The passphrase to use with repokey encrypted repositories (Required when BORG_ENCRYPTION is repokey) |
| Variable | Default | Description |
|---|---|---|
BORG_REPO | none | The target borg repository where archives will be stored |
BORG_ARCHIVE_NAME | none | The base name to use when creating an archive |
| Variable | Default | Description |
|---|---|---|
BORG_MYSQL_HOST | none | The MySQL host to connect to. (Required) |
BORG_MYSQL_PASSWORD | none | The password used to connect to MySQL. (Required) |
BORG_MYSQL_USER | root | The user used to connect to MySQL. |
BORG_MYSQL_PATH | /backup/mysqldump | The path where mysqldump files should be stored. |
BORG_MYSQL_DUMP_OPTS | --complete-insert --events --routines --triggers --single-transaction | Options passed to mysqldump. |
BORG_MYSQL_DATABASES | none | If set, the databases to dump. If unset, all databases except mysql, information_schema, and performance_schema will be dumped. |
BORG_MYSQL_GZIP | yes | If set to no, database dumps will not be compressed. |
| Variable | Default | Description |
|---|---|---|
BORG_ENCRYPTION | repokey | The encryption type to use (repokey, keyfile, authenticated) |
| Variable | Default | Description |
|---|---|---|
BORG_DATEPATTERN | -%Y-%m-%d-%H-%M-%S | The date pattern suffix to use when creating archives |
BORG_EXCLUDE_IF_PRESENT | none | If set, exclude directories that contain the specified file |
BORG_KEEP_DAILY | none | The number of daily backups to keep when pruning |
BORG_KEEP_WEEKLY | none | The number of weekly backups to keep when pruning |
BORG_KEEP_MONTHLY | none | The number of monthly backups to keep when pruning |
BORG_KEEP_YEARLY | none | The number of yearly backups to keep when pruning |
BORG_KEEP_WITHIN | none | Keep all archives within this time interval |
| Variable | Default | Description |
|---|---|---|
BORG_FAILED_BACKUP_URL | none | If set, a url to request when the backup fails |
BORG_POST_BACKUP_URL | none | If set, a url to request when the backup is complete |
BORG_PRE_BACKUP_URL | none | If set, a url to request when the backup script begins |
| Variable | Default | Description |
|---|---|---|
BORG_REMOTE_PATH | none | If set, the path to the borg executable on the server |
| Variable | Default | Description |
|---|---|---|
BORG_SCHEDULE | @daily | A cron schedule expression to determine when to run the backup |
CROND_LOG_LEVEL | 8 | The log level to use for crond in the container |
Content type
Image
Digest
Size
30.7 MB
Last updated
about 5 years ago
docker pull kolbyjack/borg-client