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

readme: document new rate-limit message option

Browse source
This commit is contained in:
William Casarin 2024-11-18 11:07:15 -08:00
parent 778c5a053b
commit db9ef05d85
1 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -19,6 +19,7 @@ pipeline = ["protected_events", "kinds", "whitelist", "ratelimit", "forwarder"]
[filters.ratelimit] [filters.ratelimit]
posts_per_minute = 8 posts_per_minute = 8
whitelist = ["127.0.0.1"] whitelist = ["127.0.0.1"]
message = "rate-limit: you note too much"
[filters.whitelist] [filters.whitelist]
pubkeys = ["16c21558762108afc34e4ff19e4ed51d9a48f79e0c34531efc423d21ab435e93"] pubkeys = ["16c21558762108afc34e4ff19e4ed51d9a48f79e0c34531efc423d21ab435e93"]
@ -92,6 +93,8 @@ Settings:
- `whitelist` *optional*: a list of IP4 or IP6 addresses that are allowed to bypass the ratelimit. - `whitelist` *optional*: a list of IP4 or IP6 addresses that are allowed to bypass the ratelimit.
- `message` *optional*: the error message to return when connection is rate-limited. default is: `rate-limited: you are noting too much`
### Whitelist ### Whitelist
* name: `whitelist` * name: `whitelist`