matrix-docker-ansible-deploy/docs/configuring-playbook-postgres-backup.md
Suguru Hirahara bf5373479b
Use common expression on documentation regarding playbook configuration
Overall the playbook uses the expression "Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:" with the heading "Adjusting the playbook configuration" for sections to explain what to be added as variables

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-12 20:59:15 +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 borg backup instead.

Adjusting the playbook configuration

To enable Postgres backup, add the following configuration to your inventory/host_vars/matrix.DOMAIN/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 again:

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