Skip to content

Commit a9a00aa

Browse files
committed
docs: add event/message ratelimit to configuration
1 parent ff9b87f commit a9a00aa

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CONFIGURATION.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,5 +37,11 @@ Running `nostr-ts-relay` for the first time creates the settings file in `~/.nos
3737
| limits.event.pubkey.blacklist | List of public keys to reject. Public keys in this list will not be able to post to this relay. |
3838
| limits.event.createdAt.maxPositiveDelta | Maximum number of seconds an event's `created_at` can be in the future. Defaults to 900 (15 minutes). Disabled when set to zero. |
3939
| limits.event.createdAt.minNegativeDelta | Maximum number of secodns an event's `created_at` can be in the past. Defaults to zero. Disabled when set to zero. |
40+
| limits.event.rateLimits[].kinds | List of event kinds rate limited. Use `[min, max]` for ranges. Optional. |
41+
| limits.event.rateLimits[].period | Rate limiting period in milliseconds. |
42+
| limits.event.rateLimits[].rate | Maximum number of events during period. |
4043
| limits.client.subscription.maxSubscriptions | Maximum number of subscriptions per connected client. Defaults to 10. Disabled when set to zero. |
4144
| limits.client.subscription.maxFilters | Maximum number of filters per subscription. Defaults to 10. Disabled when set to zero. |
45+
| limits.message.rateLimits[].period | Rate limit period in milliseconds. |
46+
| limits.message.rateLimits[].rate | Maximum number of messages during period. |
47+
| limits.message.ipWhitelist | List of IPs (IPv4 or IPv6) without rate limit. |

0 commit comments

Comments
 (0)