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
143 stars 33 forks source link

How do I start the synapse-compress-state script? #13

Open rubo77 opened 4 years ago

rubo77 commented 4 years ago

Please add detailed information to the README for someone, who has never used rust before, how to start the script:

build this rust script

  1. install Rust

    • on Debian 10:

      sudo apt install cargo

    • or manual rust install (min needed rust version 1.27)

      Make sure to have at least 2GB free diskspace, then:

      curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh` (choose default if asked)

  2. clone this repo

    git clone https://github.com/matrix-org/ cd rust-synapse-compress-state

  3. configure the current shell

    source $HOME/.cargo/env

  4. build the script

    cargo build

Now you can run the script in target/debug/synapse-compress-state

rubo77 commented 4 years ago

rust is quite large. On my synapse mashine I don't want to have 2GB rust hanging around, maybe you can use a minimal install for rust too? like https://github.com/lambci/lambci/blob/master/home/init/rust