diff --git a/docs/_includes/snippet/command-line/sample.md b/docs/_includes/snippet/command-line/sample.md new file mode 100644 index 00000000..91013a84 --- /dev/null +++ b/docs/_includes/snippet/command-line/sample.md @@ -0,0 +1,5 @@ +Here's the command-line help for this action in the [most recent version of +borgmatic](https://projects.torsion.org/borgmatic-collective/borgmatic/releases). +If you're using an older version, some of these flags may not work, and you +should instead run the action with `--help` to see the flags specific to your +borgmatic version. diff --git a/docs/_includes/snippet/configuration/sample.md b/docs/_includes/snippet/configuration/sample.md new file mode 100644 index 00000000..0e3eabf5 --- /dev/null +++ b/docs/_includes/snippet/configuration/sample.md @@ -0,0 +1,6 @@ +Here's an example configuration with all of the available options for this +feature in the [most recent version of +borgmatic](https://projects.torsion.org/borgmatic-collective/borgmatic/releases). +If you're using an older version, some of these options may not work, and you +should instead [generate a sample configuration file specific to your borgmatic +version](https://torsion.org/borgmatic/how-to/set-up-backups/#configuration). diff --git a/docs/reference/command-line/actions/borg.md b/docs/reference/command-line/actions/borg.md index c4fe84f8..2db3f2a4 100644 --- a/docs/reference/command-line/actions/borg.md +++ b/docs/reference/command-line/actions/borg.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/borg.txt %} ``` diff --git a/docs/reference/command-line/actions/break-lock.md b/docs/reference/command-line/actions/break-lock.md index 52ae87f4..234e8ed3 100644 --- a/docs/reference/command-line/actions/break-lock.md +++ b/docs/reference/command-line/actions/break-lock.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/break-lock.txt %} ``` diff --git a/docs/reference/command-line/actions/check.md b/docs/reference/command-line/actions/check.md index befed8b5..cba780ad 100644 --- a/docs/reference/command-line/actions/check.md +++ b/docs/reference/command-line/actions/check.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/check.txt %} ``` diff --git a/docs/reference/command-line/actions/compact.md b/docs/reference/command-line/actions/compact.md index e9e9c809..0138c48d 100644 --- a/docs/reference/command-line/actions/compact.md +++ b/docs/reference/command-line/actions/compact.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/compact.txt %} ``` diff --git a/docs/reference/command-line/actions/config-bootstrap.md b/docs/reference/command-line/actions/config-bootstrap.md index 8608c7a7..0b11d3b8 100644 --- a/docs/reference/command-line/actions/config-bootstrap.md +++ b/docs/reference/command-line/actions/config-bootstrap.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/config-bootstrap.txt %} ``` diff --git a/docs/reference/command-line/actions/config-generate.md b/docs/reference/command-line/actions/config-generate.md index 9891815e..1b3b4a93 100644 --- a/docs/reference/command-line/actions/config-generate.md +++ b/docs/reference/command-line/actions/config-generate.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/config-generate.txt %} ``` diff --git a/docs/reference/command-line/actions/config-validate.md b/docs/reference/command-line/actions/config-validate.md index b5e01aba..f34c2caf 100644 --- a/docs/reference/command-line/actions/config-validate.md +++ b/docs/reference/command-line/actions/config-validate.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/config-validate.txt %} ``` diff --git a/docs/reference/command-line/actions/config.md b/docs/reference/command-line/actions/config.md index 1df4c063..e6d32b63 100644 --- a/docs/reference/command-line/actions/config.md +++ b/docs/reference/command-line/actions/config.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/config.txt %} ``` diff --git a/docs/reference/command-line/actions/create.md b/docs/reference/command-line/actions/create.md index 180ad5b0..6c5fa576 100644 --- a/docs/reference/command-line/actions/create.md +++ b/docs/reference/command-line/actions/create.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/create.txt %} ``` diff --git a/docs/reference/command-line/actions/delete.md b/docs/reference/command-line/actions/delete.md index 68b982dc..de0f8939 100644 --- a/docs/reference/command-line/actions/delete.md +++ b/docs/reference/command-line/actions/delete.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/delete.txt %} ``` diff --git a/docs/reference/command-line/actions/export-tar.md b/docs/reference/command-line/actions/export-tar.md index 26a307c7..d0019b4d 100644 --- a/docs/reference/command-line/actions/export-tar.md +++ b/docs/reference/command-line/actions/export-tar.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/export-tar.txt %} ``` diff --git a/docs/reference/command-line/actions/extract.md b/docs/reference/command-line/actions/extract.md index bcab4037..d9ca7dda 100644 --- a/docs/reference/command-line/actions/extract.md +++ b/docs/reference/command-line/actions/extract.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/extract.txt %} ``` diff --git a/docs/reference/command-line/actions/info.md b/docs/reference/command-line/actions/info.md index 962c5af4..52a0e925 100644 --- a/docs/reference/command-line/actions/info.md +++ b/docs/reference/command-line/actions/info.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/info.txt %} ``` diff --git a/docs/reference/command-line/actions/key-change-passphrase.md b/docs/reference/command-line/actions/key-change-passphrase.md index 4b5ef7c9..bd676aeb 100644 --- a/docs/reference/command-line/actions/key-change-passphrase.md +++ b/docs/reference/command-line/actions/key-change-passphrase.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/key-change-passphrase.txt %} ``` diff --git a/docs/reference/command-line/actions/key-export.md b/docs/reference/command-line/actions/key-export.md index 07b42b49..a46bdd1d 100644 --- a/docs/reference/command-line/actions/key-export.md +++ b/docs/reference/command-line/actions/key-export.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/key-export.txt %} ``` diff --git a/docs/reference/command-line/actions/key-import.md b/docs/reference/command-line/actions/key-import.md index 676c444c..5f12cac5 100644 --- a/docs/reference/command-line/actions/key-import.md +++ b/docs/reference/command-line/actions/key-import.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/key-import.txt %} ``` diff --git a/docs/reference/command-line/actions/list.md b/docs/reference/command-line/actions/list.md index ddb91f15..27bd8f4b 100644 --- a/docs/reference/command-line/actions/list.md +++ b/docs/reference/command-line/actions/list.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/list.txt %} ``` diff --git a/docs/reference/command-line/actions/mount.md b/docs/reference/command-line/actions/mount.md index 82914d0f..ee930a59 100644 --- a/docs/reference/command-line/actions/mount.md +++ b/docs/reference/command-line/actions/mount.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/mount.txt %} ``` diff --git a/docs/reference/command-line/actions/prune.md b/docs/reference/command-line/actions/prune.md index 4944d5d5..a0fb7094 100644 --- a/docs/reference/command-line/actions/prune.md +++ b/docs/reference/command-line/actions/prune.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/prune.txt %} ``` diff --git a/docs/reference/command-line/actions/recreate.md b/docs/reference/command-line/actions/recreate.md index 9c8f7d24..0df0370b 100644 --- a/docs/reference/command-line/actions/recreate.md +++ b/docs/reference/command-line/actions/recreate.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/recreate.txt %} ``` diff --git a/docs/reference/command-line/actions/repo-create.md b/docs/reference/command-line/actions/repo-create.md index aec368de..527f535c 100644 --- a/docs/reference/command-line/actions/repo-create.md +++ b/docs/reference/command-line/actions/repo-create.md @@ -4,6 +4,9 @@ eleventyNavigation: key: repo-create parent: 🎬 Actions --- + +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/repo-create.txt %} ``` diff --git a/docs/reference/command-line/actions/repo-delete.md b/docs/reference/command-line/actions/repo-delete.md index 68563729..77c76370 100644 --- a/docs/reference/command-line/actions/repo-delete.md +++ b/docs/reference/command-line/actions/repo-delete.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/repo-delete.txt %} ``` diff --git a/docs/reference/command-line/actions/repo-info.md b/docs/reference/command-line/actions/repo-info.md index 9d7ca57d..ae094066 100644 --- a/docs/reference/command-line/actions/repo-info.md +++ b/docs/reference/command-line/actions/repo-info.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/repo-info.txt %} ``` diff --git a/docs/reference/command-line/actions/repo-list.md b/docs/reference/command-line/actions/repo-list.md index 551e97ed..1647d5b0 100644 --- a/docs/reference/command-line/actions/repo-list.md +++ b/docs/reference/command-line/actions/repo-list.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/repo-list.txt %} ``` diff --git a/docs/reference/command-line/actions/restore.md b/docs/reference/command-line/actions/restore.md index 47e0d214..8d22c7a0 100644 --- a/docs/reference/command-line/actions/restore.md +++ b/docs/reference/command-line/actions/restore.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/restore.txt %} ``` diff --git a/docs/reference/command-line/actions/transfer.md b/docs/reference/command-line/actions/transfer.md index b0eee89a..fddad653 100644 --- a/docs/reference/command-line/actions/transfer.md +++ b/docs/reference/command-line/actions/transfer.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/transfer.txt %} ``` diff --git a/docs/reference/command-line/actions/umount.md b/docs/reference/command-line/actions/umount.md index 29225838..baa0e3e2 100644 --- a/docs/reference/command-line/actions/umount.md +++ b/docs/reference/command-line/actions/umount.md @@ -5,6 +5,8 @@ eleventyNavigation: parent: 🎬 Actions --- +{% include snippet/command-line/sample.md %} + ``` {% include borgmatic/command-line/umount.txt %} ``` diff --git a/docs/reference/configuration/command-hooks.md b/docs/reference/configuration/command-hooks.md index 2cb90486..7c7f1eb6 100644 --- a/docs/reference/configuration/command-hooks.md +++ b/docs/reference/configuration/command-hooks.md @@ -237,6 +237,8 @@ There are some caveats you should be aware of with this feature. ## Full configuration +{% include snippet/configuration/sample.md %} + ```yaml {% include borgmatic/commands.yaml %} ``` diff --git a/docs/reference/configuration/data-sources/btrfs.md b/docs/reference/configuration/data-sources/btrfs.md index 60eabe4c..14cf34a5 100644 --- a/docs/reference/configuration/data-sources/btrfs.md +++ b/docs/reference/configuration/data-sources/btrfs.md @@ -114,6 +114,8 @@ subvolume, which is necessary for the borgmatic Btrfs hook to work. ## Full configuration +{% include snippet/configuration/sample.md %} + ```yaml {% include borgmatic/btrfs.yaml %} ``` diff --git a/docs/reference/configuration/data-sources/lvm.md b/docs/reference/configuration/data-sources/lvm.md index a86c81da..c0e78e31 100644 --- a/docs/reference/configuration/data-sources/lvm.md +++ b/docs/reference/configuration/data-sources/lvm.md @@ -124,6 +124,8 @@ work. See the comments in the sample systemd service file for details. ## Full configuration +{% include snippet/configuration/sample.md %} + ```yaml {% include borgmatic/lvm.yaml %} ``` diff --git a/docs/reference/configuration/data-sources/mariadb.md b/docs/reference/configuration/data-sources/mariadb.md index 6deed6fb..e18ce23f 100644 --- a/docs/reference/configuration/data-sources/mariadb.md +++ b/docs/reference/configuration/data-sources/mariadb.md @@ -18,6 +18,8 @@ mariadb_databases: ### Full configuration +{% include snippet/configuration/sample.md %} + ```yaml {% include borgmatic/mariadb_databases.yaml %} ``` diff --git a/docs/reference/configuration/data-sources/mongodb.md b/docs/reference/configuration/data-sources/mongodb.md index c9471fe6..4d7556b3 100644 --- a/docs/reference/configuration/data-sources/mongodb.md +++ b/docs/reference/configuration/data-sources/mongodb.md @@ -16,6 +16,8 @@ mongodb_databases: ### Full configuration +{% include snippet/configuration/sample.md %} + ```yaml {% include borgmatic/mongodb_databases.yaml %} ``` diff --git a/docs/reference/configuration/data-sources/mysql.md b/docs/reference/configuration/data-sources/mysql.md index e8832a5b..d9ee55a9 100644 --- a/docs/reference/configuration/data-sources/mysql.md +++ b/docs/reference/configuration/data-sources/mysql.md @@ -16,6 +16,8 @@ mysql_databases: ## Full configuration +{% include snippet/configuration/sample.md %} + ```yaml {% include borgmatic/mysql_databases.yaml %} ``` diff --git a/docs/reference/configuration/data-sources/postgresql.md b/docs/reference/configuration/data-sources/postgresql.md index 4a21d294..c1d68310 100644 --- a/docs/reference/configuration/data-sources/postgresql.md +++ b/docs/reference/configuration/data-sources/postgresql.md @@ -16,6 +16,8 @@ postgresql_databases: ## Full configuration +{% include snippet/configuration/sample.md %} + ```yaml {% include borgmatic/postgresql_databases.yaml %} ``` diff --git a/docs/reference/configuration/data-sources/sqlite.md b/docs/reference/configuration/data-sources/sqlite.md index e449ba5d..9931ca2f 100644 --- a/docs/reference/configuration/data-sources/sqlite.md +++ b/docs/reference/configuration/data-sources/sqlite.md @@ -17,6 +17,8 @@ sqlite_databases: ## Full configuration +{% include snippet/configuration/sample.md %} + ```yaml {% include borgmatic/sqlite_databases.yaml %} ``` diff --git a/docs/reference/configuration/data-sources/zfs.md b/docs/reference/configuration/data-sources/zfs.md index e66bd0a6..cb5a6423 100644 --- a/docs/reference/configuration/data-sources/zfs.md +++ b/docs/reference/configuration/data-sources/zfs.md @@ -113,6 +113,8 @@ the sample systemd service file for details. ## Full configuration +{% include snippet/configuration/sample.md %} + ```yaml {% include borgmatic/zfs.yaml %} ``` diff --git a/docs/reference/configuration/monitoring/apprise.md b/docs/reference/configuration/monitoring/apprise.md index ab868711..bb455395 100644 --- a/docs/reference/configuration/monitoring/apprise.md +++ b/docs/reference/configuration/monitoring/apprise.md @@ -110,6 +110,8 @@ details. ### Full configuration +{% include snippet/configuration/sample.md %} + ```yaml {% include borgmatic/apprise.yaml %} ``` diff --git a/docs/reference/configuration/monitoring/healthchecks.md b/docs/reference/configuration/monitoring/healthchecks.md index 3a4f7d46..f2019af8 100644 --- a/docs/reference/configuration/monitoring/healthchecks.md +++ b/docs/reference/configuration/monitoring/healthchecks.md @@ -53,6 +53,8 @@ or it doesn't hear from borgmatic for a certain period of time. ### Full configuration +{% include snippet/configuration/sample.md %} + ```yaml {% include borgmatic/healthchecks.yaml %} ``` diff --git a/docs/reference/configuration/monitoring/ntfy.md b/docs/reference/configuration/monitoring/ntfy.md index 2db4aa73..122c0755 100644 --- a/docs/reference/configuration/monitoring/ntfy.md +++ b/docs/reference/configuration/monitoring/ntfy.md @@ -52,9 +52,11 @@ ntfy: ### Full configuration -Here's an example configuration with all the available options, -including [priorities](https://ntfy.sh/docs/publish/#message-priority) and -[tags](https://ntfy.sh/docs/publish/#tags-emojis): +{% include snippet/configuration/sample.md %} + +The options here include +[priorities](https://ntfy.sh/docs/publish/#message-priority) and +[tags](https://ntfy.sh/docs/publish/#tags-emojis). ```yaml {% include borgmatic/ntfy.yaml %} diff --git a/docs/reference/configuration/monitoring/pushover.md b/docs/reference/configuration/monitoring/pushover.md index 8db52d31..bafc2559 100644 --- a/docs/reference/configuration/monitoring/pushover.md +++ b/docs/reference/configuration/monitoring/pushover.md @@ -57,6 +57,8 @@ pushover: ### Full configuration +{% include snippet/configuration/sample.md %} + ```yaml {% include borgmatic/pushover.yaml %} ``` diff --git a/docs/reference/configuration/monitoring/uptime-kuma.md b/docs/reference/configuration/monitoring/uptime-kuma.md index 465f2da1..2c79cb03 100644 --- a/docs/reference/configuration/monitoring/uptime-kuma.md +++ b/docs/reference/configuration/monitoring/uptime-kuma.md @@ -61,6 +61,8 @@ Resend Notification every X times = 1 ### Full configuration +{% include snippet/configuration/sample.md %} + ```yaml {% include borgmatic/uptime_kuma.yaml %} ``` diff --git a/docs/reference/configuration/monitoring/zabbix.md b/docs/reference/configuration/monitoring/zabbix.md index 4a8996f8..4fbd607c 100644 --- a/docs/reference/configuration/monitoring/zabbix.md +++ b/docs/reference/configuration/monitoring/zabbix.md @@ -65,6 +65,8 @@ the "Visual name". ### Full configuration +{% include snippet/configuration/sample.md %} + ```yaml {% include borgmatic/zabbix.yaml %} ```