Documentation and config schema update about ~/.borgmatic volume mount (#906).

Reviewed-on: https://projects.torsion.org/borgmatic-collective/borgmatic/pulls/907
This commit is contained in:
Dan Helfman
2024-08-20 21:51:51 +00:00
2 changed files with 30 additions and 6 deletions
+16 -5
View File
@@ -1044,9 +1044,12 @@ properties:
description: |
Command to use instead of "pg_dump" or "pg_dumpall".
This can be used to run a specific pg_dump version
(e.g., one inside a running container). Defaults to
"pg_dump" for single database dump or "pg_dumpall" to
dump all databases.
(e.g., one inside a running container).
If you run it from within a container, make sure to
mount your host ".borgmatic" folder inside
the container with the same directory structure.
Defaults to "pg_dump" for single database dump
or "pg_dumpall" to dump all databases.
example: docker exec my_pg_container pg_dump
pg_restore_command:
type: string
@@ -1160,7 +1163,11 @@ properties:
description: |
Command to use instead of "mariadb-dump". This can be
used to run a specific mariadb_dump version (e.g., one
inside a running container). Defaults to "mariadb-dump".
inside a running container).
If you run it from within a container, make sure to
mount your host ".borgmatic" folder inside
the container with the same directory structure.
Defaults to "mariadb-dump".
example: docker exec mariadb_container mariadb-dump
mariadb_command:
type: string
@@ -1290,7 +1297,11 @@ properties:
description: |
Command to use instead of "mysqldump". This can be used
to run a specific mysql_dump version (e.g., one inside a
running container). Defaults to "mysqldump".
running container).
If you run it from within a container, make sure to
mount your host ".borgmatic" folder inside
the container with the same directory structure.
Defaults to "mysqldump".
example: docker exec mysql_container mysqldump
mysql_command:
type: string
+14 -1
View File
@@ -229,7 +229,20 @@ hooks:
... where `my_pg_container` is the name of your database container. In this
example, you'd also need to set the `pg_restore_command` and `psql_command`
options.
options. If you choose to use the `pg_dump` within the container though,
note that it tries to output the backup to a file inside the container.
So you'll have to mount the `.borgmatic` folder inside your home folder
with the same directory structure inside the container.
See the following Docker compose file an as example:
```yaml
services:
db:
image: postgres
volumes:
- /home/USERNAME/.borgmatic:/home/USERNAME/.borgmatic
```
Similar command override options are available for (some of) the other
supported database types as well. See the [configuration