diff --git a/docs/DEPLOYING.md b/docs/DEPLOYING.md index 5498784..a3a7a30 100644 --- a/docs/DEPLOYING.md +++ b/docs/DEPLOYING.md @@ -68,10 +68,7 @@ cargo build --release Ok now let's install that (along with the utility binaries): ```bash -sudo install --mode=0700 --owner=chorus ./target/release/chorus /opt/chorus/sbin/chorus -sudo install --mode=0700 --owner=chorus ./target/release/chorus_dump /opt/chorus/sbin/chorus_dump -sudo install --mode=0700 --owner=chorus ./target/release/chorus_dump_approvals /opt/chorus/sbin/chorus_dump_approvals -sudo install --mode=0700 --owner=chorus ./target/release/chorus_moderate /opt/chorus/sbin/chorus_moderate +sudo install --mode=0700 --owner=chorus ./target/release/{chorus,chorus_compress,chorus_dump,chorus_dump_approvals,chorus_moderate} /opt/chorus/sbin/ ``` Now let's create our config file @@ -181,10 +178,7 @@ sudo journalctl -f -u chorus.service cd /opt/chorus/src/chorus git pull cargo build --release -sudo install --mode=0700 --owner=chorus ./target/release/chorus /opt/chorus/sbin/chorus -sudo install --mode=0700 --owner=chorus ./target/release/chorus_dump /opt/chorus/sbin/chorus_dump -sudo install --mode=0700 --owner=chorus ./target/release/chorus_dump_approvals /opt/chorus/sbin/chorus_dump_approvals -sudo install --mode=0700 --owner=chorus ./target/release/chorus_moderate /opt/chorus/sbin/chorus_moderate +sudo install --mode=0700 --owner=chorus ./target/release/{chorus,chorus_compress,chorus_dump,chorus_dump_approvals,chorus_moderate} /opt/chorus/sbin/ sudo systemctl restart chorus.service ```` diff --git a/docs/TOOLS.md b/docs/TOOLS.md new file mode 100644 index 0000000..89eb2e3 --- /dev/null +++ b/docs/TOOLS.md @@ -0,0 +1,29 @@ +# Tools + +Chorus comes with four binaries other than the main `chorus` binary. + +## chorus_dump + +Usage: **chorus_dump** ** + +This dumps every event to STDOUT in JSON format. + +## chorus_compress + +Usage: **chorus_compress** ** + +This compresses the data by rewriting it entirely. + +This leaves the old data under `.bak` extensions (`event.map.bak` and `lmdb.bak`) If these arready exist, the compress command will fail. You are responsible for deleting or saving this files. + +## chorus_dump_approvals + +Usage: **chorus_dump_approvals** ** + +This shows the public keys you have approved. + +## chorus_moderate + +Usage: **chorus_moderate** ** + +This is an interactive tool to moderate events which have been accepted, but which are not authored by a chorus user. If you chose to approve them, they will become available to the public.