diff --git a/README.md b/README.md index 3917625..01be7f8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,14 @@ # synapse-cleaner -A bash script for vacuuming synapse \ No newline at end of file +A bash script for vacuuming synapse + +## Requirement : +- Bash +- https://github.com/matrix-org/rust-synapse-compress-state + +## Installation +- Copy `utils/config.tpl` to `utils/config` and fill it. +- Launch `bash synapse-cleaner.sh PARTIAL` to launch without vacuuming +- Launch `bash synapse-cleaner.sh FULL` to launch with vacuuming, DB compressing... It's heavy for server but it's very usefull. + +