From fbe32cc17ce431dc88fa03587d9413d5523d059b Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Wed, 22 Jan 2025 01:35:34 +0900 Subject: [PATCH] Update docs/configuring-playbook-backup-borg.md and docs/configuring-playbook-synapse-auto-compressor.md: adopt the common description Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-backup-borg.md | 2 +- docs/configuring-playbook-synapse-auto-compressor.md | 8 ++++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/configuring-playbook-backup-borg.md b/docs/configuring-playbook-backup-borg.md index ed960f252..702e72613 100644 --- a/docs/configuring-playbook-backup-borg.md +++ b/docs/configuring-playbook-backup-borg.md @@ -138,6 +138,6 @@ The shortcut commands with the [`just` program](just.md) are also available: `ju 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. -If you want to run the backup immediately, log in to the server with SSH and run `systemctl start matrix-backup-borg`. +If you want to run it immediately, log in to the server with SSH and run `systemctl start matrix-backup-borg`. This will not return until the backup is done, so it can possibly take a long time. Consider using [tmux](https://en.wikipedia.org/wiki/Tmux) if your SSH connection is unstable. diff --git a/docs/configuring-playbook-synapse-auto-compressor.md b/docs/configuring-playbook-synapse-auto-compressor.md index 50e981cb4..8af611fae 100644 --- a/docs/configuring-playbook-synapse-auto-compressor.md +++ b/docs/configuring-playbook-synapse-auto-compressor.md @@ -31,6 +31,10 @@ 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). -## Manually start the tool +## Manually execute compression -For testing your setup it can be helpful to not wait until 00:00. If you want to run the tool immediately, log onto the server and run `systemctl start matrix-synapse-auto-compressor`. Running this command will not return control to your terminal until the compression run is done, which may take a long time. Consider using [tmux](https://en.wikipedia.org/wiki/Tmux) if your SSH connection is unstable. +Sometimes it can be helpful to execute compression as you'd like, avoiding to wait until 00:00, like when you test your configuration. + +If you want to execute it immediately, log in to the server with SSH and run `systemctl start matrix-synapse-auto-compressor`. + +This will not return until the compression is done, so it can possibly take a long time. Consider using [tmux](https://en.wikipedia.org/wiki/Tmux) if your SSH connection is unstable.