Replace various how-to links with replacement reference links (#942).

This commit is contained in:
Dan Helfman
2025-10-13 18:38:25 -07:00
parent c7053f8202
commit 9787c9fda0
10 changed files with 20 additions and 17 deletions
@@ -188,9 +188,9 @@ borgmatic does not run `on_error` hooks if an error occurs within a
## Hook output
Any output produced by your hooks shows up both at the console and in syslog
(when enabled). For more information, read about <a
href="https://torsion.org/borgmatic/how-to/inspect-your-backups/">inspecting
your backups</a>.
(when enabled). For more information, see the <a
href="https://torsion.org/borgmatic/reference/command-line/logging/">logging
documentation</a>.
## Security
+4 -2
View File
@@ -298,8 +298,10 @@ hooks:
### External passwords
If you don't want to keep your database passwords in your borgmatic
configuration file, you can instead pass them in [from external credential
sources](https://torsion.org/borgmatic/how-to/provide-your-passwords/).
configuration file, you can instead pass them in from [external credential
sources](https://torsion.org/borgmatic/reference/configuration/credentials/) or
[environment
variables](https://torsion.org/borgmatic/reference/configuration/environment-variables/).
### Configuration backups
+1 -1
View File
@@ -33,7 +33,7 @@ uv tool install --editable .
```
Or to work on the [Apprise
hook](https://torsion.org/borgmatic/how-to/monitor-your-backups/#apprise-hook),
hook](https://torsion.org/borgmatic/reference/configuration/monitoring/apprise/),
change that last line to:
```bash
+3 -2
View File
@@ -41,14 +41,15 @@ your particular infrastructure:
* **Consistency checks:** While not strictly part of monitoring, if you want
confidence that your backups are not only running but are restorable as well,
you can configure particular [consistency
checks](https://torsion.org/borgmatic/how-to/deal-with-very-large-backups/#consistency-check-configuration)
checks](https://torsion.org/borgmatic/reference/configuration/consistency-checks/)
or even script full [extract
tests](https://torsion.org/borgmatic/how-to/extract-a-backup/).
* **Commands run on error:** borgmatic's command hooks support running
arbitrary commands or scripts when borgmatic itself encounters an error
running your backups. So for instance, you can run a script to send yourself
a text message alert. But note that if borgmatic doesn't actually run, this
alert won't fire. See the [documentation on command hooks](https://torsion.org/borgmatic/how-to/add-preparation-and-cleanup-steps-to-backups/)
alert won't fire. See the [documentation on preparation and cleanup
steps](https://torsion.org/borgmatic/how-to/add-preparation-and-cleanup-steps-to-backups/)
for details.
+1 -1
View File
@@ -71,7 +71,7 @@ cron job).
<span class="minilink minilink-addedin">New in version 1.8.5</span> Instead of
(or in addition to) specifying actions on the command-line, you can configure
borgmatic to [skip particular
actions](https://torsion.org/borgmatic/how-to/set-up-backups/#skipping-actions).
actions](https://torsion.org/borgmatic/reference/command-line/actions/#skipping-actions).
### Skipping actions
+1 -1
View File
@@ -75,7 +75,7 @@ doesn't exist) rather than a Borg option.
An alternate to command-line overrides is passing in your values via
[environment
variables](https://torsion.org/borgmatic/how-to/provide-your-passwords/).
variables](https://torsion.org/borgmatic/reference/configuration/environment-variables/).
### Deprecated overrides
+2 -2
View File
@@ -7,7 +7,7 @@ eleventyNavigation:
<span class="minilink minilink-addedin">New in version 1.7.10</span> borgmatic
supports defining custom configuration constants. This is similar to the
[variable interpolation
feature](https://torsion.org/borgmatic/how-to/add-preparation-and-cleanup-steps-to-backups/#variable-interpolation)
feature](https://torsion.org/borgmatic/reference/configuration/command-hooks/#variable-interpolation)
for command hooks, but the constants feature lets you substitute your own custom
values into any option values in the entire configuration file.
@@ -74,4 +74,4 @@ meaning you can define a constant and then include a separate configuration file
that uses that constant.
An alternate to constants is passing in your values via [environment
variables](https://torsion.org/borgmatic/how-to/provide-your-passwords/).
variables](https://torsion.org/borgmatic/reference/configuration/environment-variables/).
@@ -77,7 +77,7 @@ match `/var` to a pattern like `+ fm:/v*/lib/data`.
<span class="minilink minilink-addedin">With Borg version 1.2 and
earlier</span>Snapshotted files are instead stored at a path dependent on the
[runtime
directory](https://torsion.org/borgmatic/how-to/backup-your-databases/#runtime-directory)
directory](https://torsion.org/borgmatic/reference/configuration/runtime-directory/)
in use at the time the archive was created, as Borg 1.2 and earlier do not
support path rewriting.
@@ -91,7 +91,7 @@ cache](https://borgbackup.readthedocs.io/en/stable/internals/data-structures.htm
may not get cache hits on snapshotted files. This makes backing up ZFS snapshots
a little slower than non-snapshotted files that have consistent paths. You can
mitigate this by setting a fixed [runtime
directory](https://torsion.org/borgmatic/how-to/backup-your-databases/#runtime-directory)
directory](https://torsion.org/borgmatic/reference/configuration/runtime-directory/))
(that's not located in `/tmp`). This allows borgmatic to use a consistent
snapshot path from one run to the next, thereby resulting in Borg files cache
hits.
@@ -35,7 +35,7 @@ require setting an explicit `encryption_passphrase` value in borgmatic's
configuration file.
For [database
configuration](https://torsion.org/borgmatic/how-to/backup-your-databases/),
configuration](https://torsion.org/borgmatic/reference/configuration/data-sources/),
the same approach applies. For example:
```yaml
@@ -88,6 +88,6 @@ on the command-line. But please be aware of the security implications of
specifying secrets on the command-line.
Additionally, borgmatic action hooks support their own [variable
interpolation](https://torsion.org/borgmatic/how-to/add-preparation-and-cleanup-steps-to-backups/#variable-interpolation),
interpolation](https://torsion.org/borgmatic/reference/configuration/command-hooks/#variable-interpolation),
although in that case it's for particular borgmatic runtime values rather than
(only) environment variables.
@@ -12,7 +12,7 @@ us today such as: Telegram, Discord, Slack, Amazon SNS, Gotify, etc."
Depending on how you installed borgmatic, it may not have come with Apprise.
For instance, if you originally [installed borgmatic with
pipx](https://torsion.org/borgmatic/how-to/set-up-backups/#installation),
pipx](https://torsion.org/borgmatic/how-to/set-up-backups/),
run the following to install Apprise so borgmatic can use it:
```bash