Improve readme

This commit is contained in:
Dryusdan 2020-06-19 10:05:23 +02:00
parent 27e0995b0b
commit 5763bed56b
1 changed files with 12 additions and 1 deletions

View File

@ -1,3 +1,14 @@
# synapse-cleaner
A bash script for vacuuming synapse
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.