diff --git a/README.md b/README.md index 8909142..6edea68 100644 --- a/README.md +++ b/README.md @@ -82,9 +82,10 @@ providers include specific support for Borg/borgmatic. Using these links and services helps support borgmatic development and hosting. (These are referral links, but without any tracking scripts or cookies.) - * [BorgBase](https://www.borgbase.com/?utm_source=borgmatic): Borg hosting - service with support for monitoring, 2FA, and append-only repos. - + ## Support and contributing @@ -115,3 +116,8 @@ your thing. In general, contributions are very welcome. We don't bite! Also, please check out the [borgmatic development how-to](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/) for info on cloning source code, running tests, etc. + + diff --git a/borgmatic/config/schema.yaml b/borgmatic/config/schema.yaml index 14ef7e8..e8e56a1 100644 --- a/borgmatic/config/schema.yaml +++ b/borgmatic/config/schema.yaml @@ -156,7 +156,7 @@ map: desc: | Type of compression to use when creating archives. See https://borgbackup.readthedocs.org/en/stable/usage.html#borg-create for details. - Defaults to no compression. + Defaults to "lz4". example: lz4 remote_rate_limit: type: int diff --git a/docs/how-to/deal-with-very-large-backups.md b/docs/how-to/deal-with-very-large-backups.md index 5f02010..e2dd089 100644 --- a/docs/how-to/deal-with-very-large-backups.md +++ b/docs/how-to/deal-with-very-large-backups.md @@ -93,4 +93,4 @@ backups. ## Related documentation - * [Set up backups with borgmatic](../../docs/how-to/set-up-backups.md) + * [Set up backups with borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups.md) diff --git a/docs/how-to/develop-on-borgmatic.md b/docs/how-to/develop-on-borgmatic.md index e3d2a8b..9a6254a 100644 --- a/docs/how-to/develop-on-borgmatic.md +++ b/docs/how-to/develop-on-borgmatic.md @@ -109,4 +109,4 @@ also linked from the commits list on each pull request. ## Related documentation - * [Inspect your backups](../../docs/how-to/inspect-your-backups.md) + * [Inspect your backups](https://torsion.org/borgmatic/docs/how-to/inspect-your-backups.md) diff --git a/docs/how-to/inspect-your-backups.md b/docs/how-to/inspect-your-backups.md index 32f6e30..5e50fc5 100644 --- a/docs/how-to/inspect-your-backups.md +++ b/docs/how-to/inspect-your-backups.md @@ -42,5 +42,5 @@ output formatted as JSON. ## Related documentation - * [Set up backups with borgmatic](../../docs/how-to/set-up-backups.md) - * [Develop on borgmatic](../../docs/how-to/develop-on-borgmatic.md) + * [Set up backups with borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups.md) + * [Develop on borgmatic](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic.md) diff --git a/docs/how-to/make-per-application-backups.md b/docs/how-to/make-per-application-backups.md index fbf20b0..08a2ad0 100644 --- a/docs/how-to/make-per-application-backups.md +++ b/docs/how-to/make-per-application-backups.md @@ -108,4 +108,4 @@ nested values. ## Related documentation - * [Set up backups with borgmatic](../../docs/how-to/set-up-backups.md) + * [Set up backups with borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups.md) diff --git a/docs/how-to/restore-a-backup.md b/docs/how-to/restore-a-backup.md index e8b2196..43156ec 100644 --- a/docs/how-to/restore-a-backup.md +++ b/docs/how-to/restore-a-backup.md @@ -57,5 +57,5 @@ Like a whole-archive restore, this also restores into the current directory. ## Related documentation - * [Set up backups with borgmatic](../../docs/how-to/set-up-backups.md) - * [Inspect your backups](../../docs/how-to/inspect-your-backups.md) + * [Set up backups with borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups.md) + * [Inspect your backups](https://torsion.org/borgmatic/docs/how-to/inspect-your-backups.md) diff --git a/docs/how-to/run-preparation-steps-before-backups.md b/docs/how-to/run-preparation-steps-before-backups.md index 95e7148..1944fd9 100644 --- a/docs/how-to/run-preparation-steps-before-backups.md +++ b/docs/how-to/run-preparation-steps-before-backups.md @@ -47,5 +47,5 @@ injection or privilege escalation, do not forget to set secure permissions ## Related documentation - * [Set up backups with borgmatic](../../docs/how-to/set-up-backups.md) - * [Make per-application backups](../../docs/how-to/make-per-application-backups.md) + * [Set up backups with borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups.md) + * [Make per-application backups](https://torsion.org/borgmatic/docs/how-to/make-per-application-backups.md) diff --git a/docs/how-to/set-up-backups.md b/docs/how-to/set-up-backups.md index 7420aa9..a23433d 100644 --- a/docs/how-to/set-up-backups.md +++ b/docs/how-to/set-up-backups.md @@ -47,9 +47,10 @@ providers include specific support for Borg/borgmatic. Using these links and services helps support borgmatic development and hosting. (These are referral links, but without any tracking scripts or cookies.) - * [BorgBase](https://www.borgbase.com/?utm_source=borgmatic): Borg hosting - service with support for monitoring, 2FA, and append-only repos. - + ## Configuration @@ -73,7 +74,7 @@ uncomment a particular option, also uncomment its containing section name, or else borgmatic won't recognize the option. You can also get the same sample configuration file from the [configuration -reference](../../docs/reference/configuration.md), the authoritative set of +reference](https://torsion.org/borgmatic/docs/reference/configuration.md), the authoritative set of all configuration options. This is handy if borgmatic has added new options since you originally created your configuration file. @@ -220,8 +221,13 @@ it. ## Related documentation - * [Make per-application backups](../../docs/how-to/make-per-application-backups.md) - * [Deal with very large backups](../../docs/how-to/deal-with-very-large-backups.md) - * [Inspect your backups](../../docs/how-to/inspect-your-backups.md) - * [borgmatic configuration reference](../../docs/reference/configuration.md) - * [borgmatic command-line reference](../../docs/reference/command-line.md) + * [Make per-application backups](https://torsion.org/borgmatic/docs/how-to/make-per-application-backups.md) + * [Deal with very large backups](https://torsion.org/borgmatic/docs/how-to/deal-with-very-large-backups.md) + * [Inspect your backups](https://torsion.org/borgmatic/docs/how-to/inspect-your-backups.md) + * [borgmatic configuration reference](https://torsion.org/borgmatic/docs/reference/configuration.md) + * [borgmatic command-line reference](https://torsion.org/borgmatic/docs/reference/command-line.md) + + diff --git a/docs/how-to/upgrade.md b/docs/how-to/upgrade.md index e0c1e7f..da1103a 100644 --- a/docs/how-to/upgrade.md +++ b/docs/how-to/upgrade.md @@ -76,4 +76,4 @@ files. ## Related documentation - * [Develop on borgmatic](../../docs/how-to/develop-on-borgmatic.md) + * [Develop on borgmatic](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic.md) diff --git a/docs/reference/command-line.md b/docs/reference/command-line.md index da673ba..6fc5df5 100644 --- a/docs/reference/command-line.md +++ b/docs/reference/command-line.md @@ -12,5 +12,5 @@ Here are all of the available borgmatic command-line options: ## Related documentation - * [Set up backups with borgmatic](../../docs/how-to/set-up-backups.md) - * [borgmatic configuration reference](../../docs/reference/configuration.md) + * [Set up backups with borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups.md) + * [borgmatic configuration reference](https://torsion.org/borgmatic/docs/reference/configuration.md) diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md index 93d71c7..e741a7c 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md @@ -10,10 +10,10 @@ Here is a full sample borgmatic configuration file including all available optio ``` Note that you can also [download this configuration -file](../../docs/reference/config.yaml) for use locally. +file](https://torsion.org/borgmatic/docs/reference/config.yaml) for use locally. ## Related documentation - * [Set up backups with borgmatic](../../docs/how-to/set-up-backups.md) - * [borgmatic command-line reference](../../docs/reference/command-line.md) + * [Set up backups with borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups.md) + * [borgmatic command-line reference](https://torsion.org/borgmatic/docs/reference/command-line.md)