b268a811d2
Note that files in docs/assets/ are managed with REUSE.toml Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2.3 KiB
Setting up synapse-auto-compressor (optional)
The playbook can install and configure synapse_auto_compressor for you.
It's a CLI tool that automatically compresses Synapse's state_groups database table in the background.
See the project's documentation to learn what it does and why it might be useful to you.
Adjusting the playbook configuration
Add the following configuration to your inventory/host_vars/matrix.example.com/vars.yml file:
matrix_synapse_auto_compressor_enabled: true
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 (2x-5x faster 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.
Usage
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
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 if your SSH connection is unstable.