Skip to content

Commit 73231eb

Browse files
committed
docs: add event whitelimits to configuration
1 parent 081e7de commit 73231eb

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

CONFIGURATION.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,20 +38,22 @@ Running `nostream` for the first time creates the settings file in `<project_roo
3838
| | Spin workers as many CPUs are available when set to zero. Defaults to zero. |
3939
| limits.event.eventId.minLeadingZeroBits | Leading zero bits required on every incoming event for proof of work. |
4040
| | Defaults to zero. Disabled when set to zero. |
41-
| limits.event.kind.whitelist | List of event kinds to allow. Leave empty to allow any. |
42-
| limits.event.kind.blacklist | List of event kinds to reject. Leave empty to allow any. |
41+
| limits.event.kind.whitelist | List of event kinds to always allow. Leave empty to allow any. |
42+
| limits.event.kind.blacklist | List of event kinds to always reject. Leave empty to allow any. |
4343
| limits.event.pubkey.minLeadingZeroBits | Leading zero bits required on the public key of incoming events for proof of work. |
4444
| | Defaults to zero. Disabled when set to zero. |
45-
| limits.event.pubkey.whitelist | List of public keys to allow. Only public keys in this list will be able to post to this relay. |
46-
| limits.event.pubkey.blacklist | List of public keys to reject. Public keys in this list will not be able to post to this relay. |
45+
| limits.event.pubkey.whitelist | List of public keys to always allow. Only public keys in this list will be able to post to this relay. Use for private relays. |
46+
| limits.event.pubkey.blacklist | List of public keys to always reject. Public keys in this list will not be able to post to this relay. |
4747
| 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. |
4848
| 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. |
4949
| limits.event.content.maxLength | Maximum length of `content`. Defaults to 1 MB. Disabled when set to zero. |
5050
| limits.event.rateLimits[].kinds | List of event kinds rate limited. Use `[min, max]` for ranges. Optional. |
5151
| limits.event.rateLimits[].period | Rate limiting period in milliseconds. |
5252
| limits.event.rateLimits[].rate | Maximum number of events during period. |
53+
| limits.event.whitelists.pubkeys | List of public keys to ignore rate limits. |
54+
| limits.event.whitelists.ipAddresses | List of IPs (IPv4 or IPv6) to ignore rate limits. |
5355
| limits.client.subscription.maxSubscriptions | Maximum number of subscriptions per connected client. Defaults to 10. Disabled when set to zero. |
5456
| limits.client.subscription.maxFilters | Maximum number of filters per subscription. Defaults to 10. Disabled when set to zero. |
5557
| limits.message.rateLimits[].period | Rate limit period in milliseconds. |
5658
| limits.message.rateLimits[].rate | Maximum number of messages during period. |
57-
| limits.message.ipWhitelist | List of IPs (IPv4 or IPv6) without rate limit. |
59+
| limits.message.ipWhitelist | List of IPs (IPv4 or IPv6) to ignore rate limits. |

0 commit comments

Comments
 (0)