nik/chorus
1
0
Fork 0
mirror of https://github.com/mikedilger/chorus.git synced 2026-01-03 06:15:33 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Mike Dilger 2024-04-09 19:14:15 +12:00
parent 363a2835f0
commit 83c4882e29
2 changed files with 31 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/DEPLOYING.md
View File

@ -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
````

29
docs/TOOLS.md Normal file
View File

@ -0,0 +1,29 @@
# Tools
Chorus comes with four binaries other than the main `chorus` binary.
## chorus_dump
Usage: **chorus_dump** *<path_to_config_file\>*
This dumps every event to STDOUT in JSON format.
## chorus_compress
Usage: **chorus_compress** *<path_to_config_file\>*
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** *<path_to_config_file\>*
This shows the public keys you have approved.
## chorus_moderate
Usage: **chorus_moderate** *<path_to_config_file\>*
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.