From 67406b60b3ea42c32f8bbbf31c5959d90e0e5079 Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Tue, 28 Oct 2025 23:01:51 -0700 Subject: [PATCH] Cleanup "other ways to install" section and boost "Docker" there so it shows up in search. --- docs/how-to/develop-on-borgmatic.md | 4 ++++ docs/how-to/set-up-backups.md | 18 ++++++++++++------ .../configuration/credentials/container.md | 15 +++++++++------ 3 files changed, 25 insertions(+), 12 deletions(-) diff --git a/docs/how-to/develop-on-borgmatic.md b/docs/how-to/develop-on-borgmatic.md index 851f8e50..0ae5d796 100644 --- a/docs/how-to/develop-on-borgmatic.md +++ b/docs/how-to/develop-on-borgmatic.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: How-to guides order: 15 --- + + To get set up to develop on borgmatic, first [`install uv`](https://docs.astral.sh/uv/) to make managing your borgmatic environment easier without impacting other Python applications on your system. @@ -205,3 +207,5 @@ borgmatic's developer build for documentation optionally supports using Setting up Podman is outside the scope of this documentation. But once you install and configure Podman, then `scripts/dev-docs` should automatically use Podman instead of Docker. + + diff --git a/docs/how-to/set-up-backups.md b/docs/how-to/set-up-backups.md index 5ca6be90..0fd2cca6 100644 --- a/docs/how-to/set-up-backups.md +++ b/docs/how-to/set-up-backups.md @@ -75,12 +75,16 @@ with `sudo`. If that doesn't work, you may need to update your [sudoers Besides the approaches described above, there are several other options for installing borgmatic: - * [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/) +#### Docker / Podman + + * [container image with scheduled backups](https://github.com/borgmatic-collective/docker-borgmatic) (+ Docker Compose files) + * [container image with multi-arch and Docker CLI support](https://github.com/modem7/docker-borgmatic) + +#### Operating system packages + * [Debian](https://tracker.debian.org/pkg/borgmatic) * [Ubuntu](https://launchpad.net/ubuntu/+source/borgmatic) - * [Fedora official](https://bodhi.fedoraproject.org/updates/?search=borgmatic) - * [Fedora unofficial](https://copr.fedorainfracloud.org/coprs/heffer/borgmatic/) + * [Fedora](https://bodhi.fedoraproject.org/updates/?search=borgmatic) * [Gentoo](https://packages.gentoo.org/packages/app-backup/borgmatic) * [Arch Linux](https://archlinux.org/packages/extra/any/borgmatic/) * [Alpine Linux](https://pkgs.alpinelinux.org/packages?name=borgmatic) @@ -88,9 +92,11 @@ installing borgmatic: * [openSUSE](https://software.opensuse.org/package/borgmatic) * [macOS (via Homebrew)](https://formulae.brew.sh/formula/borgmatic) * [macOS (via MacPorts)](https://ports.macports.org/port/borgmatic/) - * [NixOS](https://search.nixos.org/packages?show=borgmatic&sort=relevance&type=packages&query=borgmatic) + * [NixOS](https://search.nixos.org/packages?channel=unstable&show=borgmatic&query=borgmatic) + +#### Etc. + * [Ansible role](https://github.com/borgbase/ansible-role-borgbackup) - * [Unraid](https://unraid.net/community/apps?q=borgmatic#r) * [uv tool install](https://docs.astral.sh/uv/) diff --git a/docs/reference/configuration/credentials/container.md b/docs/reference/configuration/credentials/container.md index 7129c46c..ac879bc1 100644 --- a/docs/reference/configuration/credentials/container.md +++ b/docs/reference/configuration/credentials/container.md @@ -5,11 +5,14 @@ eleventyNavigation: parent: 🔒 Credentials --- New in version 1.9.11 When -running inside a container, borgmatic can read [Docker -secrets](https://docs.docker.com/compose/how-tos/use-secrets/) and [Podman +running inside a container, borgmatic can read [Docker +secrets](https://docs.docker.com/compose/how-tos/use-secrets/) and [Podman secrets](https://www.redhat.com/en/blog/new-podman-secrets-command). Creating those secrets and passing them into your borgmatic container is outside the -scope of this documentation, but here's a simple example of that with [Docker +scope of this documentation, but here's a simple example of that with [Docker Compose](https://docs.docker.com/compose/): ```yaml @@ -25,9 +28,9 @@ secrets: ``` This assumes there's a file on the host at `/etc/borgmatic/passphrase.txt` -containing your passphrase. Docker or Podman mounts the contents of that file -into a secret named `borgmatic_passphrase` in the borgmatic container at -`/run/secrets/`. +containing your passphrase. Docker or +Podman mounts the contents of that file into a secret named +`borgmatic_passphrase` in the borgmatic container at `/run/secrets/`. Once your container secret is in place, you can consume it within your borgmatic configuration file: