Include a sample borgmatic configuration file in the documentation (#119).
This commit is contained in:
parent
18ae91ea6e
commit
290e969a22
4 changed files with 30 additions and 6 deletions
1
NEWS
1
NEWS
|
@ -1,5 +1,6 @@
|
||||||
1.2.16.dev0
|
1.2.16.dev0
|
||||||
* Refactor documentation into multiple separate pages for clarity and findability.
|
* Refactor documentation into multiple separate pages for clarity and findability.
|
||||||
|
* #119: Include a sample borgmatic configuration file in the documentation.
|
||||||
|
|
||||||
1.2.15
|
1.2.15
|
||||||
* #127: Remove date echo from schema example, as it's not a substitute for real logging.
|
* #127: Remove date echo from schema example, as it's not a substitute for real logging.
|
||||||
|
|
|
@ -56,7 +56,7 @@ href="https://asciinema.org/a/203761" target="_blank">screencast</a>.
|
||||||
|
|
||||||
## How-to guides
|
## How-to guides
|
||||||
|
|
||||||
* [Set up backups with borgmatic](docs/how-to/set-up-backups.md) \<-- *Start here!*
|
* [Set up backups with borgmatic](docs/how-to/set-up-backups.md) ⬅ *Start here!*
|
||||||
* [Make per-application backups](docs/how-to/make-per-application-backups.md)
|
* [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)
|
* [Deal with very large backups](docs/how-to/deal-with-very-large-backups.md)
|
||||||
* [Inspect your backups](docs/how-to/inspect-your-backups.md)
|
* [Inspect your backups](docs/how-to/inspect-your-backups.md)
|
||||||
|
@ -65,6 +65,11 @@ href="https://asciinema.org/a/203761" target="_blank">screencast</a>.
|
||||||
* [Develop on borgmatic](docs/how-to/develop-on-borgmatic.md)
|
* [Develop on borgmatic](docs/how-to/develop-on-borgmatic.md)
|
||||||
|
|
||||||
|
|
||||||
|
## Reference guides
|
||||||
|
|
||||||
|
* [borgmatic configuration reference](docs/reference/configuration.md)
|
||||||
|
|
||||||
|
|
||||||
## Support and contributing
|
## Support and contributing
|
||||||
|
|
||||||
### Issues
|
### Issues
|
||||||
|
|
|
@ -48,11 +48,10 @@ default). You should edit the file to suit your needs, as the values are
|
||||||
representative. All fields are optional except where indicated, so feel free
|
representative. All fields are optional except where indicated, so feel free
|
||||||
to ignore anything you don't need.
|
to ignore anything you don't need.
|
||||||
|
|
||||||
You can also have a look at the [full configuration
|
You can also get the same sample configuration file from the [configuration
|
||||||
schema](https://projects.torsion.org/witten/borgmatic/src/master/borgmatic/config/schema.yaml)
|
reference](../../docs/reference/configuration.md), the authoritative set of
|
||||||
for the authoritative set of all configuration options. This is handy if
|
all configuration options. This is handy if borgmatic has added new options
|
||||||
borgmatic has added new options since you originally created your
|
since you originally created your configuration file.
|
||||||
configuration file.
|
|
||||||
|
|
||||||
|
|
||||||
### Encryption
|
### Encryption
|
||||||
|
@ -177,3 +176,4 @@ it.
|
||||||
* [Make per-application backups](../../docs/how-to/make-per-application-backups.md)
|
* [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)
|
* [Deal with very large backups](../../docs/how-to/deal-with-very-large-backups.md)
|
||||||
* [Inspect your backups](../../docs/how-to/inspect-your-backups.md)
|
* [Inspect your backups](../../docs/how-to/inspect-your-backups.md)
|
||||||
|
* [borgmatic configuration reference](../../docs/reference/configuration.md)
|
||||||
|
|
18
docs/reference/configuration.md
Normal file
18
docs/reference/configuration.md
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
---
|
||||||
|
title: borgmatic configuration reference
|
||||||
|
---
|
||||||
|
## Configuration file
|
||||||
|
|
||||||
|
Here is a full sample borgmatic configuration file including all available options:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
{% include borgmatic/config.yaml %}
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that you can also [download this configuration
|
||||||
|
file](../../docs/reference/config.yaml) for use locally.
|
||||||
|
|
||||||
|
|
||||||
|
## Related documentation
|
||||||
|
|
||||||
|
* [Set up backups with borgmatic](../../docs/how-to/set-up-backups.md)
|
Loading…
Reference in a new issue