matrix-docker-ansible-deploy/docs/configuring-playbook-postgres-backup.md

# Setting up postgres backup (optional)

The playbook can install and configure [docker-postgres-backup-local](https://github.com/prodrigestivill/docker-postgres-backup-local) for you via the [com.devture.ansible.role.postgres_backup](https://github.com/devture/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](configuring-playbook-backup-borg.md) instead.


## Adjusting the playbook configuration

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

```yaml
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](https://github.com/prodrigestivill/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](installing.md) command again:

```
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```
- added a description howto use the postgres-backup role 2021-02-15 19:41:06 +00:00			`# Setting up postgres backup (optional)`

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 08:59:25 +00:00			`The playbook can install and configure [docker-postgres-backup-local](https://github.com/prodrigestivill/docker-postgres-backup-local) for you via the [com.devture.ansible.role.postgres_backup](https://github.com/devture/com.devture.ansible.role.postgres_backup) Ansible role.`
- added a description howto use the postgres-backup role 2021-02-15 19:41:06 +00:00
Announce borg backup support Related to: - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1727 - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1754 - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1755 - https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/467 2022-04-19 16:29:41 +00:00			`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](configuring-playbook-backup-borg.md) instead.`


- added a description howto use the postgres-backup role 2021-02-15 19:41:06 +00:00			`## Adjusting the playbook configuration`

Minor docs improvements 2021-04-05 08:13:45 +00:00			Minimal working configuration (`inventory/host_vars/matrix.DOMAIN/vars.yml`) to enable Postgres backup:

			```yaml
Switch postgres/postgres-backup Ansible role sources and adjust variable names (devture_postgres_ -> postgres_) 2024-09-27 06:37:24 +00:00			`postgres_backup_enabled: true`
Minor docs improvements 2021-04-05 08:13:45 +00:00			```

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


- added a description howto use the postgres-backup role 2021-02-15 19:41:06 +00:00			`\| Name \| Default value \| Description \|`
			`\| :-------------------------------- \| :--------------------------- \| :--------------------------------------------------------------- \|`
Switch postgres/postgres-backup Ansible role sources and adjust variable names (devture_postgres_ -> postgres_) 2024-09-27 06:37:24 +00:00			\|`postgres_backup_enabled`\|`false`\|Set to true to use [docker-postgres-backup-local](https://github.com/prodrigestivill/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 \|
Minor docs improvements 2021-04-05 08:13:45 +00:00
- added a description howto use the postgres-backup role 2021-02-15 19:41:06 +00:00
			`## Installing`

			`After configuring the playbook, run the [installation](installing.md) command again:`

			```
			`ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start`
Minor docs improvements 2021-04-05 08:13:45 +00:00			```