From e703253ecda942605027c026b3b045b2946a1d12 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Thu, 16 Jan 2025 20:25:45 +0900 Subject: [PATCH] Update docs/configuring-playbook-backup-borg.md: add descriptions about other useful options This commit adds descriptions about options for setting the archive name and the retention policy. Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-backup-borg.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/configuring-playbook-backup-borg.md b/docs/configuring-playbook-backup-borg.md index 1f6228db0..c0cceb7d2 100644 --- a/docs/configuring-playbook-backup-borg.md +++ b/docs/configuring-playbook-backup-borg.md @@ -75,6 +75,26 @@ backup_borg_ssh_key_private: | **Note**: `REPO` will be initialized on backup start, for example: `matrix`. See [Remote repositories](https://borgbackup.readthedocs.io/en/stable/usage/general.html#repository-urls) for the syntax. +### Set backup archive name (optional) + +You can specify the backup archive name format. To set it, add the following configuration to your `vars.yml` file (adapt to your needs): + +```yaml +backup_borg_storage_archive_name_format: matrix-{now:%Y-%m-%d-%H%M%S} +``` + +### Configure retention policy (optional) + +It is also possible to configure a retention strategy. To configure it, add the following configuration to your `vars.yml` file (adapt to your needs): + +```yaml +backup_borg_retention_keep_hourly: 0 +backup_borg_retention_keep_daily: 7 +backup_borg_retention_keep_weekly: 4 +backup_borg_retention_keep_monthly: 12 +backup_borg_retention_keep_yearly: 2 +``` + ### Backup without encryption (optional) To backup without encryption, add the following configuration to your `vars.yml` file: