Add blacklist docs
This commit is contained in:
parent
62c2aa547b
commit
11de1ddfbb
1 changed files with 12 additions and 2 deletions
14
README.md
14
README.md
|
|
@ -1,4 +1,3 @@
|
|||
|
||||
# noteguard
|
||||
|
||||
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
|
||||
|
||||
### 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
|
||||
|
||||
* 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.
|
||||
|
||||
|
||||
## Testing
|
||||
|
||||
You can test your filters like so:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue