matrix-docker-ansible-deploy/docs/configuring-playbook-postgres-backup.md
Suguru Hirahara 9f372d9058
Consistent usage of the words related to BorgBackup (Borg)
In order to avoid confusions between the name of the program itself (BorgBackup and Borg in short) and the backups managed by BorgBackup, the official full name should be preferred where possible, minding capitalization.

- Borg or borg → BorgBackup
- Borg backup(s) → BorgBackup (if it means the program) / backups with BorgBackup (if it means the backups managed by the program)

Based on https://www.borgbackup.org/

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-24 16:30:00 +09:00

2.0 KiB

Setting up postgres backup (optional)

The playbook can install and configure docker-postgres-backup-local for you via the ansible-role-postgres-backup Ansible role.

For a more complete backup solution (one that includes not only Postgres, but also other configuration/data files), you may wish to look into BorgBackup instead.

Adjusting the playbook configuration

To enable Postgres backup, add the following configuration to your inventory/host_vars/matrix.example.com/vars.yml file:

postgres_backup_enabled: true

Refer to the table below for additional configuration variables and their default values.

Name Default value Description
postgres_backup_enabled false Set to true to use docker-postgres-backup-local to create automatic database backups
postgres_backup_schedule '@daily' Cron-schedule specifying the interval between postgres backups.
postgres_backup_keep_days 7 Number of daily backups to keep
postgres_backup_keep_weeks 4 Number of weekly backups to keep
postgres_backup_keep_months 12 Number of monthly backups to keep
postgres_backup_base_path "{{ matrix_base_data_path }}/postgres-backup" Base path for postgres-backup. Also see postgres_backup_data_path
postgres_backup_data_path "{{ postgres_backup_base_path }}/data" Storage path for postgres-backup database backups

Installing

After configuring the playbook, run the installation command:

ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start