commit 7387bcdf1420d197bf7eb335aabebff42231fdc3
parent 24a1c0dfc297956e3533b2bc52cc08c2197646f1
Author: William Casarin <jb55@jb55.com>
Date: Sun, 7 Jul 2024 22:33:52 -0500
update readme
Diffstat:
1 file changed, 18 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -3,6 +3,8 @@
A high performance note filter plugin system for [strfry]
+WIP!
+
## Usage
Filters are registered and loaded from the [noteguard.toml](noteguard.toml) config.
@@ -20,4 +22,20 @@ notes_per_second = 1
whitelist = ["127.0.0.1"]
```
+## Filters
+
+You can use any of the builtin filters, or create your own!
+
+This is the initial release, and only includes one filter so far:
+
+### Ratelimit
+
+The ratelimit filter limits the rate at which notes are written to the relay per-ip.
+
+Settings:
+
+- `notes_per_second`: the delay in seconds between accepted notes. 1 means only one note can be written per second. 2 means only 1 note can be written every 2 seconds, etc. TODO: rename this because its confusing.
+
+- `whitelist`: a list of IP4 or IP6 addresses that are allowed to bypass the ratelimit.
+
[strfry]: https://github.com/hoytech/strfry
