hq/Noteguard
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

improve instructions

Browse source 
Signed-off-by: William Casarin <jb55@jb55.com>
This commit is contained in:
William Casarin 2024-07-11 09:22:03 -07:00
parent 9af92bfca3
commit d7d62d343b
1 changed files with 16 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -38,7 +38,9 @@ kinds = [30065, 1064]
You can install noteguard by copying the binary to the strfry directory. You can install noteguard by copying the binary to the strfry directory.
Static musl builds are convenient ways to package noteguard for deployment. It enables you to copy the binary directly to your server, assuming its the same architecture as the one you're building on. Static musl builds are convenient ways to package noteguard for deployment. It enables you to copy the binary directly to your server, ensure that you are using the correct architecture that your server is running.
You most likely want `x86_64-unknown-linux-musl` or `aarch64-unknown-linux-musl`. Install this target with rustup, build noteguard, and copy the binary to the server:
```sh ```sh
$ rustup target add x86_64-unknown-linux-musl $ rustup target add x86_64-unknown-linux-musl
@ -47,7 +49,17 @@ $ scp ./target/x86_64-unknown-linux-musl/release/noteguard server:strfry
$ scp noteguard.toml server:strfry $ scp noteguard.toml server:strfry
``` ```
You can then setup your `strfry.conf` to use the noteguard by adding it as a writePolicy plugin: Test that the binary executes by running it on the server:
```sh
$ cd strfry
$ <<<'{}' ./noteguard
Failed to parse input: missing field `type` at line 1 column 2
```
Configure `noteguard.toml` with your preferred filters.
Now you can then setup your `strfry.conf` to use the noteguard by adding it as a writePolicy plugin:
``` ```
writePolicy { writePolicy {
@ -56,6 +68,8 @@ writePolicy {
} }
``` ```
And you're done! Enjoy.
## Filters ## Filters
You can use any of the builtin filters, or create your own! You can use any of the builtin filters, or create your own!