@@ -14,6 +14,7 @@ The backup is made with [mydumper](http://centminmod.com/mydumper.html), a fast
1414To backup a [ MySQL] ( https://hub.docker.com/_/mysql/ ) or [ MariaDB] ( https://hub.docker.com/_/mariadb/ ) database, you simply specify the credentials and the host. You can optionally specify the database as well.
1515
1616## Environment variables
17+
1718| ** Variable** | ** Default** | ** Mandatory** | ** Description** |
1819| :--------------| :-----------:| :-------------:| :-----------------------------------------------------|
1920| ` DB_HOST ` | - | * yes* | The host to connect to |
@@ -33,7 +34,7 @@ Please note the backup will be written to `/backup` by default, so you might wan
3334
3435## Example Docker CLI client
3536
36- To __ create a backup __ from a MySQL container via ` docker ` CLI client:
37+ To ** create a backup ** from a MySQL container via ` docker ` CLI client:
3738
3839``` bash
3940docker run --name my-backup -e DB_HOST=mariadb -e DB_PASS=amazing_pass -v /var/mysql_backups:/backup registry.gitlab.com/ix.ai/mariadb-backup:latest
@@ -46,15 +47,17 @@ To create more backups in the future simply start your container again:
4647docker start my-backup
4748```
4849
49- To __ restore a backup __ into a MySQL container via ` docker ` CLI client:
50+ To ** restore a backup ** into a MySQL container via ` docker ` CLI client:
5051
5152``` bash
5253docker run --name my-restore -e DB_HOST=mariadb -e DB_PASS=amazing_pass -v /var/mysql_backups:/backup registry.gitlab.com/ix.ai/mariadb-backup:latest
5354```
5455
5556## Script example
57+
5658The following example uses the image [ ] ( ) for MariaDB.
5759To back up multiple databases, all running in docker, all labeled with ` mariadb-backup ` :
60+
5861``` bash
5962#! /usr/bin/env bash
6063/bin/mkdir -p /mariadb-backup
7477
7578## Configuration
7679
77-
7880### Mode
7981
8082By default the container backups the database.
@@ -96,7 +98,7 @@ However, you can manually set the name of a backup directory underneath `BASE_DI
9698
9799* ` RESTORE_DIR ` : Name of a backup directory to restore
98100
99- _ This option is only required when the container runs in in ` RESTORE ` mode._
101+ * This option is only required when the container runs in in ` RESTORE ` mode.*
100102
101103### UID and GID
102104
@@ -122,16 +124,17 @@ However, you can modify the CLI options by setting the following environment var
122124
123125## Tags and Arch
124126
125- Starting with version v0.0.3, the images are multi-arch, with builds for amd64, arm64, armv7 and armv6.
127+ Starting with version v0.0.3, the images are multi-arch, with builds for amd64, arm64, armv7. Support for armv6 has been dropped.
128+
126129* ` vN.N.N ` - for example v0.0.2
127130* ` latest ` - always pointing to the latest version
128131* ` dev-master ` - the last build on the master branch
129132
130- ## Resources:
131- * GitLab: https://gitlab.com/ix.ai/mariadb-backup
132- * GitHub: https://github .com/ix- ai/mariadb-backup
133- * GitLab Registry: https://gitlab .com/ix. ai/mariadb-backup/container_registry
134- * Docker Hub: https://hub.docker.com/r/ixdotai/mariadb-backup
133+ ## Resources
134+
135+ * Gitlab Registry: ` registry.gitlab.com/ix.ai/mariadb-backup ` - [ gitlab.com/ix.ai/mariadb-backup ] ( https://gitlab .com/ix. ai/mariadb-backup )
136+ * GitHub Registry: ` ghcr.io/ix-ai/mariadb-backup ` [ github.com/ix-ai/mariadb-backup ] ( https://github .com/ix- ai/mariadb-backup )
137+ * Docker Hub: ` ixdotai/mariadb-backup ` - [ hub.docker.com/r/ixdotai/mariadb-backup ] ( https://hub.docker.com/r/ixdotai/mariadb-backup )
135138
136139## Credits
137140
0 commit comments