bc1849d7ff
* Replace "just run-tags install-all/setup-all,start" with "just install-all/setup-all" Thanks to the tip by Slavi that the overhead of ensure-matrix-users-created is negligible. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit installing instructions - Move the anchor links to docs/just.md - Add note about running "ensure-matrix-users-created" tags, if ansible-playbook's tags not "setup-all,ensure-matrix-users-created,start", ie. either "setup-all,start", "setup-email2matrix,start", "setup-aux-files,setup-corporal,start", or "setup-matrix-user-verification-service,start" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update descriptions about installation - Introduce the most conservative and stable raw ansible-playbook command. - Introduce the just commands on installing.md and maintenance-upgrading-services.md, not on quick-start.md, since it is too early for quick start guide readers who are just starting to climb learning curve to use the shortcuts. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-etherpad.md: remove the note about ensure-matrix-users-created Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> --------- Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2.6 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 it with playbook tags as below:
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
The shortcut commands with the just program are also available: just install-all or just setup-all
just install-all is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your vars.yml to remove other components, you'd need to run just setup-all, or these components will still remain installed. Note these shortcuts run the ensure-matrix-users-created tag too.