hosting/bob
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

restic: Update docs

Browse source
This commit is contained in:
Marty Oehme 2025-07-18 15:12:19 +02:00
parent 86d49a756b
commit 003cf64a77
Signed by: Marty
GPG key ID: 4E535BC19C61886E
1 changed files with 13 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

18
roles/restic/README.md
View file

@ -3,15 +3,17 @@
Backup maintenance stack.
Takes care of regularly pruning the backup repository and checking its integrity.
Currently only supports S3 as a backend.
Supports any restic backend.
Variables set here are used in other roles to individually configure their backups.
## Defaults
```yaml
restic_timezone: US/Chicago
restic_tz: US/Chicago
```
The timezone to be used for the cronjob.
The timezone to be used for any cronjobs.
Inherits from the global `timezone` variable or can be set individually.
```yaml
restic_version: latest
@ -25,6 +27,8 @@ restic_pass: <restic-pass>
```
The repository url and the restic repository password.
Can be of any type restic supports
(e.g. `/path/to/backups` for local, `s3:address.to.s3.com` for S3, etc.)
See the restic documentation for more information.
```yaml
@ -39,11 +43,15 @@ restic_prune_cron: 0 0 4 * * *
restic_forget_args: --prune --keep-last 14 --keep-daily 2 --keep-weekly 2
```
The default prune and forget cronjob schedule and arguments: Prune the repository every day at 4:00 AM and keep the last 14 snapshots, 2 daily snapshots and 2 weekly snapshots.
The default prune and forget cronjob schedule and arguments:
Prune the repository every day at 4:00 AM and keep the last 14 snapshots, 2 daily snapshots and 2 weekly snapshots.
Be aware that go-cron has an extra field in the front for seconds compared to many other implementations.
```yaml
restic_check_cron: 0 15 5 * * *
restic_check_args: --read-data-subset=5%
```
The default check cronjob schedule and arguments: Check the repository integrity every day at 5:15 AM and in addition to structural checks, read 5 randomly chosen % for a data integrity check.
The default check cronjob schedule and arguments:
Check the repository integrity every day at 5:15 AM and in addition to structural checks,
read 5 randomly chosen % for a data integrity check.