matrix-docker-ansible-deploy/docs/configuring-playbook-postgres-backup.md
Slavi Pantaleev 4eed49f931 Replace custom/matrix-postgres-backup role with galaxy/com.devture.ansible.role.postgres_backup
This role is usable on its own and it's not tied to Matrix, so
extracting it out into an independent role that we install via
ansible-galaxy makes sense.

This also fixes the confusion from the other day, where
`matrix_postgres_*` had to be renamed to `devture_postgres_*`
(unless it was about `matrix_postgres_backup_*`).
We now can safely say that ALL `matrix_postgres_*` variables need to be
renamed.

Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2305
2022-11-30 11:01:19 +02:00

2.0 KiB

Setting up postgres backup (optional)

The playbook can install and configure docker-postgres-backup-local for you via the com.devture.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

Minimal working configuration (inventory/host_vars/matrix.DOMAIN/vars.yml) to enable Postgres backup:

devture_postgres_backup_enabled: true

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

Name Default value Description
devture_postgres_backup_enabled false Set to true to use docker-postgres-backup-local to create automatic database backups
devture_postgres_backup_schedule '@daily' Cron-schedule specifying the interval between postgres backups.
devture_postgres_backup_keep_days 7 Number of daily backups to keep
devture_postgres_backup_keep_weeks 4 Number of weekly backups to keep
devture_postgres_backup_keep_months 12 Number of monthly backups to keep
devture_postgres_base_path "{{ matrix_base_data_path }}/postgres-backup" Base path for postgres-backup. Also see devture_postgres_data_path
devture_postgres_data_path "{{ devture_postgres_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