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

Add blacklist docs

Browse source
This commit is contained in:
Daniel Saxton 2025-03-08 07:30:07 -06:00
parent 62c2aa547b
commit 11de1ddfbb
1 changed files with 12 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,4 +1,3 @@
# noteguard # noteguard
A high performance note filter plugin system for [strfry] A high performance note filter plugin system for [strfry]
@ -107,6 +106,18 @@ The whitelist filter only allows notes to pass if it matches a particular pubkey
Either criteria can match Either criteria can match
### Blacklist
* name: `blacklist`
The blacklist filter blocks notes that match any pubkey, ip, or CIDR range:
- `pubkeys` *optional*: a list of hex public keys to block
- `ips` *optional*: a list of IP addresses to block
- `cidrs` *optional*: a list of CIDR ranges to block
### Kinds ### Kinds
* name: `kinds` * name: `kinds`
@ -155,7 +166,6 @@ be queued if the connection goes down (up to the `queue_size` buffer limit)
- `queue_size` *optional* - size of the note queue, this is used to buffer notes if the connection goes down. Default is 1000. - `queue_size` *optional* - size of the note queue, this is used to buffer notes if the connection goes down. Default is 1000.
## Testing ## Testing
You can test your filters like so: You can test your filters like so: