nik/chorus
1
0
Fork 0
mirror of https://github.com/mikedilger/chorus.git synced 2026-05-03 06:51:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update BEHAVIOR.md

Browse Source
This commit is contained in:
Mike Dilger 2024-03-12 11:24:19 +13:00
parent f6c8d214a4
commit a701da6dda
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/BEHAVIOR.md
View File

@ -4,7 +4,11 @@
If `verify_events` is set in the configuration, chorus rejects invalid events in all cases. If `verify_events` is set in the configuration, chorus rejects invalid events in all cases.
Chorus accepts all events submitted by authorized users. If an event has a '-' tag, it must be submitted by an AUTHed user that matches the pubkey of the event, else it is rejected.
If `open_relay` is true, all other events are accepted. If false, the remaining rules apply.
Chorus accepts all events submitted by AUTHed authorized users.
Chorus accepts relay list metadata (kind 10002) from anybody. Chorus accepts relay list metadata (kind 10002) from anybody.
@ -18,13 +22,15 @@ If you wish to change these rules, change the source code at `nostr.rs:screen_in
## REQ Read permissions and behavior ## REQ Read permissions and behavior
Chorus does not serve any DM (kind 4) or GiftWrap (kind 1059) unless the connection is AUTHed and the user matches either a tagged person or the author of the event.
If `open_relay` is true, all other events are served. If false, the remaining rules apply.
Chorus serves all relay list metadata (kind 10002) events queried. Chorus serves all relay list metadata (kind 10002) events queried.
Chorus serves all ephemeral events. Chorus serves all ephemeral events.
Chorus does not serve any DM (kind 4) or GiftWrap (kind 1059) unless the connection is AUTHed and the user matches either a tagged person or the author of the event. Chorus serves all events to AUTHed authorized users.
Chorus serves all events to AUTHed and authorized users.
Chorus serves all events which were authored by an authorized user. Chorus serves all events which were authored by an authorized user.
@ -38,19 +44,19 @@ If you wish to change these rules, change the source code at `nostr.rs:screen_ou
## Abuse, Banning, Throttling, and the like ## Abuse, Banning, Throttling, and the like
WebSocket frames and messages are limited to 1 MB. WebSocket frames and messages are limited to 1 MB (slightly less for messages due to some overhead).
Each connection has a memory buffer used for JSON deserialization that is no larger Each connection has a memory buffer used for JSON deserialization that is no larger
than the WebSocket message. No more than one such buffer exists per connection, and memory than the WebSocket message. No more than one such buffer exists per connection, and memory
allocation is generally tightly controlled. allocation is generally tightly controlled.
Every connection is IP banned for 4 seconds after disconnection, whether or not the connection Every connection is IP banned for 2 seconds after disconnection, whether or not the connection
was well behaved. We don't think clients should ever reconnect immediately. If chorus is was well behaved. We don't think clients should ever reconnect immediately. If chorus is
run directly (not behind an nginx proxy), this IP banning is more efficient because it happens run directly (not behind an nginx proxy), this IP banning is more efficient because it happens
prior to SSL setup. prior to SSL setup.
A maximum of 32 subscriptions are allowed by default, although this is configurable with the A maximum of 32 subscriptions are allowed by default (per connection), although this is
`max_subscriptions` configuration setting. configurable with the `max_subscriptions` configuration setting.
## NIP Support ## NIP Support
@ -79,8 +85,6 @@ as well as remembering these (id,pubkey) pairs to reject such events subsequentl
Chorus fully complies with NIP-11. Chorus fully complies with NIP-11.
Chorus returns a brief result without much detail.
### NIP-26 Delegated Event Signing ### NIP-26 Delegated Event Signing
Chorus does not support NIP-26. Chorus does not support NIP-26.
@ -130,4 +134,3 @@ Chorus does not support NIP-94.
### NIP-96 HTTP File Storage Integration ### NIP-96 HTTP File Storage Integration
Chorus does not support NIP-96. Chorus does not support NIP-96.