2017-03-26 10:27:07 +00:00
|
|
|
# volume-backup
|
|
|
|
|
|
|
|
An utility to backup and restore [docker volumes](https://docs.docker.com/engine/reference/commandline/volume/).
|
|
|
|
|
2017-03-26 10:30:18 +00:00
|
|
|
**Note**: Make sure no container is using the volume before backup or restore, otherwise your data might be damaged.
|
2017-03-26 10:27:07 +00:00
|
|
|
|
|
|
|
## Backup
|
|
|
|
|
|
|
|
Syntax:
|
|
|
|
|
2017-04-09 09:12:10 +00:00
|
|
|
docker run -v [volume-name]:/volume -v [output-dir]:/backup --rm loomchild/volume-backup backup [archive-name]
|
2017-03-26 10:27:07 +00:00
|
|
|
|
|
|
|
For example:
|
|
|
|
|
2018-01-14 13:21:49 +00:00
|
|
|
docker run -v some_volume:/volume -v /tmp:/backup --rm loomchild/volume-backup backup some_archive
|
2017-03-26 10:27:07 +00:00
|
|
|
|
2018-01-14 13:21:49 +00:00
|
|
|
will archive volume named `some_volume` to `/tmp/some_archive.tar.bz2` archive file.
|
|
|
|
|
2018-01-14 13:25:01 +00:00
|
|
|
### Backup to standard output
|
|
|
|
|
|
|
|
This avoids mounting a second backup volume and allows to redirect it to a file, network, etc.
|
2018-01-14 13:21:49 +00:00
|
|
|
|
2019-01-14 16:08:14 +00:00
|
|
|
**WARNING**: This method should not be used with a Docker for Windows installation; no usable backup will be generated.
|
|
|
|
|
2018-01-14 13:21:49 +00:00
|
|
|
Syntax:
|
|
|
|
|
|
|
|
docker run -v [volume-name]:/volume --rm loomchild/volume-backup backup - > [archive-name]
|
|
|
|
|
|
|
|
For example:
|
|
|
|
|
|
|
|
docker run -v some_volume:/volume --rm loomchild/volume-backup backup - > some_archive.tar.bz2
|
|
|
|
|
|
|
|
will archive volume named `some_volume` to `some_archive.tar.bz2` archive file.
|
2017-03-26 10:27:07 +00:00
|
|
|
|
|
|
|
## Restore
|
|
|
|
|
2017-03-26 10:30:18 +00:00
|
|
|
**Note**: This operation will delete all contents of the volume
|
|
|
|
|
2017-03-26 10:27:07 +00:00
|
|
|
Syntax:
|
|
|
|
|
2017-04-09 09:12:10 +00:00
|
|
|
docker run -v [volume-name]:/volume -v [output-dir]:/backup --rm loomchild/volume-backup restore [archive-name]
|
2017-03-26 10:27:07 +00:00
|
|
|
|
|
|
|
For example:
|
|
|
|
|
2018-01-14 13:21:49 +00:00
|
|
|
docker run -v some_volume:/volume -v /tmp:/backup --rm loomchild/volume-backup restore some_archive
|
|
|
|
|
|
|
|
will clean and restore volume named `some_volume` from `/tmp/some_archive.tar.bz2` archive file.
|
|
|
|
|
2018-01-14 13:25:01 +00:00
|
|
|
### Restore from standard input
|
|
|
|
|
|
|
|
This avoids mounting a second backup volume.
|
2018-01-14 13:21:49 +00:00
|
|
|
|
|
|
|
**Note**: Don't forget the `-i` switch for interactive operation.
|
|
|
|
|
2019-01-14 16:08:14 +00:00
|
|
|
**WARNING**: This method should not be used with a Docker for Windows installation; no usable backup will be generated.
|
|
|
|
|
2018-01-14 13:21:49 +00:00
|
|
|
Syntax:
|
|
|
|
|
|
|
|
cat [archive-name] | docker run -i -v [volume-name]:/volume --rm loomchild/volume-backup restore -
|
|
|
|
|
|
|
|
For example:
|
|
|
|
|
|
|
|
cat some_archive.tar.bz2 | docker run -i -v some_volume:/volume --rm loomchild/volume-backup restore -
|
2017-03-26 10:27:07 +00:00
|
|
|
|
2018-01-14 13:21:49 +00:00
|
|
|
will clean and restore volume named `some_volume` from `some_archive.tar.bz2` archive file.
|