| @@ -2,7 +2,7 @@ | |||||
| The playbook can install and configure [synapse_auto_compressor](https://github.com/matrix-org/rust-synapse-compress-state/#automated-tool-synapse_auto_compressor) for you. | The playbook can install and configure [synapse_auto_compressor](https://github.com/matrix-org/rust-synapse-compress-state/#automated-tool-synapse_auto_compressor) for you. | ||||
| It's a cli tool that automatically compresses `state_groups` database table in background. | |||||
| It's a CLI tool that automatically compresses Synapse's `state_groups` database table in the background. | |||||
| See the project's [documentation](https://github.com/matrix-org/rust-synapse-compress-state/#automated-tool-synapse_auto_compressor) to learn what it does and why it might be useful to you. | See the project's [documentation](https://github.com/matrix-org/rust-synapse-compress-state/#automated-tool-synapse_auto_compressor) to learn what it does and why it might be useful to you. | ||||
| @@ -27,10 +27,10 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | |||||
| ## Usage | ## Usage | ||||
| After installation, synapse_auto_compressor will run automatically every day by the defined schedule | |||||
| 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 start the tool | ||||
| 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 | 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`. This will not return until the run is done, so possibly a long time. | |||||
| 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. | Consider using [tmux](https://en.wikipedia.org/wiki/Tmux) if your SSH connection is unstable. | ||||