Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/confirm/docker-mysql-backup
Docker image to backup a MySQL or MariaDB container.
https://github.com/confirm/docker-mysql-backup
Last synced: 4 days ago
JSON representation
Docker image to backup a MySQL or MariaDB container.
- Host: GitHub
- URL: https://github.com/confirm/docker-mysql-backup
- Owner: confirm
- Created: 2016-01-15T13:12:41.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-03-21T20:55:12.000Z (over 4 years ago)
- Last Synced: 2024-08-02T12:50:55.513Z (3 months ago)
- Language: Shell
- Size: 11.7 KB
- Stars: 51
- Watchers: 7
- Forks: 25
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred - confirm/docker-mysql-backup - Docker image to backup a MySQL or MariaDB container. (others)
README
About
=====
The mysql-backup Docker image will provide you a container to backup and restore a [MySQL](https://hub.docker.com/_/mysql/) or [MariaDB](https://hub.docker.com/_/mariadb/) database container.
The backup is made with [mydumper](http://centminmod.com/mydumper.html), a fast MySQL backup utility.
Usage
=====
To backup a [MySQL](https://hub.docker.com/_/mysql/) or [MariaDB](https://hub.docker.com/_/mariadb/) container you simply have to run a container from this Docker image and link a MySQL or MariaDB container to it.
The container will automatically detect the linked database container and tries to backup the database based on the environment variables of the database container:
* `_ENV_MYSQL_DATABASE`
* `_ENV_MYSQL_ROOT_PASSWORD`
Please note the backup will be written to `/backup` by default, so you might want to mount that directory from your host.
Example Docker CLI client
-------------------------
To __create a backup__ from a MySQL container via `docker` CLI client:
```bash
docker run --name my-backup --link my-mysql -v /var/mysql_backups:/backup confirm/mysql-backup
```
The container will stop automatically as soon as the backup has finished.
To create more backups in the future simply start your container again:
```bash
docker start my-backup
```
To __restore a backup__ into a MySQL container via `docker` CLI client:
```bash
docker run --name my-restore --link my-mysql -v /var/mysql_backups:/backup confirm/mysql-backup
```
Example Docker Compose
----------------------
Here's an example of a [Docker Compose](https://docs.docker.com/compose/) file, e.g. `docker-compose.yml`:
```yaml
backup:
image: confirm/mysql-backup
volumes:
- ./data/backup:/backup
links:
- my-mysql
restart: "no"
```
Configuration
=============
Mode
----
By default the container backups the database.
However, you can change the mode of the container by setting the following environment variable:
* `MODE`: Sets the mode of the backup container while [`BACKUP`|`RESTORE`]
Base directory
--------------
By default the base directory `/backup` is used.
However, you can overwrite that by setting the following environment variable:
* `BASE_DIR`: Path of the base directory (aka working directory)
Restory directory
-----------------
By default the container will automatically restore the latest backup found in `BASE_DIR`.
However, you can manually set the name of a backup directory underneath `BASE_DIR`:
* `RESTORE_DIR`: Name of a backup directory to restore
_This option is only required when the container runs in in `RESTORE` mode._
UID and GID
-----------
By default the backup will be written with UID and GID `666`.
However, you can overwrite that by setting the following environment variables:
* `BACKUP_UID`: UID of the backup
* `BACKUP_GID`: GID of the backup
umask
-----
By default a `umask` of `0022` will be used.
However, you can overwrite that by setting the following environment variable:
* `UMASK`: Umask which should be used to write the backup files
mydumper / myloader CLI options
-------------------------------
By default `mydumper` is invoked with the `-c` (compress backup) and `myloader` with the `-o` (overwrite tables) CLI option.
However, you can modify the CLI options by setting the following environment variable:
* `OPTIONS`: Options passed to `mydumper` (when `MODE` is `BACKUP`) or `myloader` (when `MODE` is `RESTORE`)