Bläddra i källkod

Update docs for backup-borg and synapse-auto-compressor: use the common descriptions

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/4028/head
Suguru Hirahara 1 år sedan
förälder
incheckning
b0c73c8378
Ingen känd nyckel hittad för denna signaturen i databasen GPG-nyckel ID: E4F9743DAB4B7B75
2 ändrade filer med 18 tillägg och 4 borttagningar
  1. +7
    -3
      docs/configuring-playbook-backup-borg.md
  2. +11
    -1
      docs/configuring-playbook-synapse-auto-compressor.md

+ 7
- 3
docs/configuring-playbook-backup-borg.md Visa fil

@@ -95,9 +95,9 @@ backup_borg_retention_keep_monthly: 12
backup_borg_retention_keep_yearly: 2 backup_borg_retention_keep_yearly: 2
``` ```


### Edit the backup schedule (optional)
### Edit the schedule (optional)


By default the backup will run 4 a.m. every day based on the `backup_borg_schedule` variable. It is defined in the format of systemd timer calendar.
By default the task will run 4 a.m. every day based on the `backup_borg_schedule` variable. It is defined in the format of systemd timer calendar.


To edit the schedule, add the following configuration to your `vars.yml` file (adapt to your needs): To edit the schedule, add the following configuration to your `vars.yml` file (adapt to your needs):


@@ -134,7 +134,11 @@ The shortcut commands with the [`just` program](just.md) are also available: `ju


`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) 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. `just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) 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.


## Manually start a backup
## Usage

After installation, `backup-borg` will run automatically every day at `04:00:00` (as defined in `backup_borg_schedule` by default).

### Manually start the task


Sometimes it can be helpful to run the backup as you'd like, avoiding to wait until 4 a.m., like when you test your configuration. Sometimes it can be helpful to run the backup as you'd like, avoiding to wait until 4 a.m., like when you test your configuration.




+ 11
- 1
docs/configuring-playbook-synapse-auto-compressor.md Visa fil

@@ -14,6 +14,16 @@ Add the following configuration to your `inventory/host_vars/matrix.example.com/
matrix_synapse_auto_compressor_enabled: true matrix_synapse_auto_compressor_enabled: true
``` ```


### Edit the schedule (optional)

By default the task will run 0 a.m. every day based on the `matrix_synapse_auto_compressor_calendar` variable. It is defined in the format of systemd timer calendar.

To edit the schedule, add the following configuration to your `vars.yml` file (adapt to your needs):

```yaml
matrix_synapse_auto_compressor_calendar: "*-*-* 00:00:00"
```

### Extending the configuration ### Extending the configuration


There are some additional things you may wish to configure about the component. There are some additional things you may wish to configure about the component.
@@ -39,7 +49,7 @@ The shortcut commands with the [`just` program](just.md) are also available: `ju


After installation, `synapse_auto_compressor` will run automatically every day at `00:00:00` (as defined in `matrix_synapse_auto_compressor_calendar` by default). After installation, `synapse_auto_compressor` will run automatically every day at `00:00:00` (as defined in `matrix_synapse_auto_compressor_calendar` by default).


## Manually execute compression
### Manually start the task


Sometimes it can be helpful to execute compression as you'd like, avoiding to wait until 00:00, like when you test your configuration. Sometimes it can be helpful to execute compression as you'd like, avoiding to wait until 00:00, like when you test your configuration.




Laddar…
Avbryt
Spara