diff --git a/borgmatic/config/schema.yaml b/borgmatic/config/schema.yaml index 2650085..c4fd313 100644 --- a/borgmatic/config/schema.yaml +++ b/borgmatic/config/schema.yaml @@ -836,25 +836,25 @@ properties: 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 - docker container). Defaults to "pg_dump" for - single database dump or "pg_dumpall" to dump - all databases. + container). 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 description: | Command to use instead of "pg_restore". This can be used to run a specific pg_restore - version (e.g., one inside a running docker - container). Defaults to "pg_restore". + version (e.g., one inside a running container). + Defaults to "pg_restore". example: docker exec my_pg_container pg_restore psql_command: type: string description: | Command to use instead of "psql". This can be used to run a specific psql version (e.g., - one inside a running docker container). - Defaults to "psql". + one inside a running container). Defaults to + "psql". example: docker exec my_pg_container psql options: type: string diff --git a/docs/how-to/backup-your-databases.md b/docs/how-to/backup-your-databases.md index 91dba18..db93c07 100644 --- a/docs/how-to/backup-your-databases.md +++ b/docs/how-to/backup-your-databases.md @@ -138,7 +138,7 @@ hooks: ### Containers -If your database is running within a Docker container and borgmatic is too, no +If your database is running within a container and borgmatic is too, no problem—simply configure borgmatic to connect to the container's name on its exposed port. For instance: @@ -154,10 +154,10 @@ hooks: But what if borgmatic is running on the host? You can still connect to a database container if its ports are properly exposed to the host. For -instance, when running the database container with Docker, you can specify -`--publish 127.0.0.1:5433:5432` so that it exposes the container's port 5432 -to port 5433 on the host (only reachable on localhost, in this case). Or the -same thing with Docker Compose: +instance, when running the database container, you can specify `--publish +127.0.0.1:5433:5432` so that it exposes the container's port 5432 to port 5433 +on the host (only reachable on localhost, in this case). Or the same thing +with Docker Compose: ```yaml services: diff --git a/docs/how-to/develop-on-borgmatic.md b/docs/how-to/develop-on-borgmatic.md index 027a814..19b4bd1 100644 --- a/docs/how-to/develop-on-borgmatic.md +++ b/docs/how-to/develop-on-borgmatic.md @@ -87,19 +87,20 @@ tox -e codespell borgmatic additionally includes some end-to-end tests that integration test with Borg and supported databases for a few representative scenarios. These tests don't run by default when running `tox`, because they're relatively slow -and depend on Docker containers for runtime dependencies. These tests tests do -run on the continuous integration (CI) server, and running them on your -developer machine is the closest thing to CI test parity. +and depend on containers for runtime dependencies. These tests do run on the +continuous integration (CI) server, and running them on your developer machine +is the closest thing to CI-test parity. -If you would like to run the full test suite, first install Docker and [Docker -Compose](https://docs.docker.com/compose/install/). Then run: +If you would like to run the full test suite, first install Docker (or Podman; +see below) and [Docker Compose](https://docs.docker.com/compose/install/). +Then run: ```bash scripts/run-end-to-end-dev-tests ``` -Note that this scripts assumes you have permission to run Docker. If you -don't, then you may need to run with `sudo`. +This script assumes you have permission to run `docker`. If you don't, then +you may need to run with `sudo`. #### Podman @@ -119,6 +120,7 @@ some key points to double-check: * Create a non-root Podman socket for that user: ```bash systemctl --user enable --now podman.socket + systemctl --user start --now podman.socket ``` Then you'll be able to run end-to-end tests as per normal, and the test script @@ -161,11 +163,12 @@ To build and view a copy of the documentation with your local changes, run the following from the root of borgmatic's source code: ```bash -sudo scripts/dev-docs +scripts/dev-docs ``` -This requires Docker to be installed on your system. You may not need to use -sudo if your non-root user has permissions to run Docker. +This requires Docker (or Podman; see below) to be installed on your system. +This script assumes you have permission to run `docker`. If you don't, then +you may need to run with `sudo`. After you run the script, you can point your web browser at http://localhost:8080 to view the documentation with your changes. diff --git a/docs/how-to/set-up-backups.md b/docs/how-to/set-up-backups.md index ca70316..9340282 100644 --- a/docs/how-to/set-up-backups.md +++ b/docs/how-to/set-up-backups.md @@ -82,8 +82,8 @@ on a relatively dedicated system, then a global install can work out fine. Besides the approaches described above, there are several other options for installing borgmatic: - * [Docker image with scheduled backups](https://hub.docker.com/r/b3vis/borgmatic/) (+ Docker Compose files) - * [Docker image with multi-arch and Docker CLI support](https://hub.docker.com/r/modem7/borgmatic-docker/) + * [container image with scheduled backups](https://hub.docker.com/r/b3vis/borgmatic/) (+ Docker Compose files) + * [container image with multi-arch and Docker CLI support](https://hub.docker.com/r/modem7/borgmatic-docker/) * [Debian](https://tracker.debian.org/pkg/borgmatic) * [Ubuntu](https://launchpad.net/ubuntu/+source/borgmatic) * [Fedora official](https://bodhi.fedoraproject.org/updates/?search=borgmatic)