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

readme: add optional indicator to filter docs

Browse source 
Signed-off-by: William Casarin <jb55@jb55.com>
This commit is contained in:
William Casarin 2024-07-09 09:55:41 -07:00
parent 784d32e327
commit 4b5f67d473
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -39,15 +39,15 @@ Settings:
- `notes_per_minute`: the number of notes per minute which are allowed to be written per ip.
- `whitelist`: 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.
### Whitelist
The whitelist filter only allows notes to pass if it matches a particular pubkey or source ip:
- `pubkeys`: a list of hex public keys to let through
- `pubkeys` *optional*: a list of hex public keys to let through
- `ips`: a list of ip addresses to let through
- `ips` *optional*: a list of ip addresses to let through
Either criteria can match