search

matrix-org / rust-synapse-compress-state

A tool to compress some state in a Synapse instance's database
https://pypi.org/project/synapse-auto-compressor/
Apache License 2.0
142 stars 32 forks source link

Document how to choose levels/what they do #84

Open olmari opened 2 years ago

olmari commented 2 years ago

I do realise there i no one perfect answer to what settings to do, but i'd appreciate at least definiton of what those states mean and what would be theoretical best settings, if any :)

erikjohnston commented 2 years ago

The optimal setting depends on the room, and basically impossible to guess without trying different values. IME the default levels are usually good, if not necessarily the best.

https://github.com/matrix-org/rust-synapse-compress-state/blob/main/docs/algorithm.md has some words on how this work.

But yeah, I'm sure we can make the documentation a bit better here :)