Wavyzz/docker-volume-backup
2
0
Fork 0
mirror of https://github.com/offen/docker-volume-backup.git synced 2025-12-05 09:08:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update the custom commands documentation (#288)

Browse Source 
Include requirement for docker socket and the need to use EXEC_LABEL
if you are running multiple copies
This commit is contained in:
Nigel Metheringham
2023-10-21 07:05:41 +01:00
committed by GitHub
parent e8ac4e1da6
commit d0d8e5b076
2 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/how-tos/run-custom-commands.md
View File

@@ -16,6 +16,10 @@ Such commands are defined by specifying the command in a `docker-volume-backup.[
- `copy` (the tar archive is copied to all configured storages)
- `prune` (existing backups are pruned based on the defined ruleset - optional)
{: .note }
So that the `docker-volume-backup` container can access the labels on other containers, it is necessary that the docker socket is mounted into
the `docker-volume-backup` container as shown in the Quickstart example.
Taking a database dump using `mysqldump` would look like this:
```yml
@@ -38,7 +42,9 @@ volumes:
Due to Docker limitations, you currently cannot use any kind of redirection in these commands unless you pass the command to `/bin/sh -c` or similar.
I.e. instead of using `echo "ok" > ok.txt` you will need to use `/bin/sh -c 'echo "ok" > ok.txt'`.
If you need fine grained control about which container's commands are run, you can use the `EXEC_LABEL` configuration on your `docker-volume-backup` container:
If you have more than one `docker-volume-backup` container (possibly across several docker-compose environments) to backup or you are using
multiple backup schedules, you will need to use `EXEC_LABEL` in the configuration and a `docker-volume-backup.exec-label` label on each
container using custom commands to ensure that the commands are only run by the correct `docker-volume-backup` instance.
```yml
version: '3'