Improve readme
This commit is contained in:
parent
27e0995b0b
commit
5763bed56b
13
README.md
13
README.md
|
@ -1,3 +1,14 @@
|
||||||
# synapse-cleaner
|
# 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.
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue