- commit
- 9e379115cb53e7df9a6ec3f4db26331959c94d87
- parent
- 5aaca4f2d0dc166f586c3938769864fbfd4c36e9
- author
- Dami <dami.etoile@gmail.com>
| M | docs/ | 13 | +++++++++++-- |
| M | docs/ | 10 | ++++++++++ |
@@ -32,7 +32,8 @@ A moderator who signs in on the relay's page sees People and Moderation, nothing
3232 Keeping order. Reports never show in the feed.3333 3434 - **Reports** filed against people or events arrive here. Resolve each one by dismissing it, deleting the event or banning the author.35-- **Ban** a pubkey. Their events are refused and their open connections are closed.35+- **Ban** a pubkey. Their events are refused and their open connections are closed. Tick **erase** and everything they wrote here, their profile included, and every file they uploaded goes too. The row action asks the same question; so does banning from a report.36+- **Hide after N reports.** Set a number and an event reported by that many different people is hidden: not served, counted, synced, rebroadcast or shown on a page, until a moderator resolves the reports. Dismissing the last open report shows it again; deleting or banning makes it permanent. Reports on a person or a file never hide anything. Hidden events are marked in the reports table.3637 - **Block an address.** An IP address, v4 or v6, gets no socket and no write or read door; its open connections are closed. The page, the relay information and management stay reachable, so you can undo a block on your own address. Addresses churn, so blocks are not part of the exported configuration.3738 - **Recent events** shows the feed with delete and ban actions.3839 @@ -42,7 +43,8 @@ Who can do what, and how much.
4243 4344 | Rule | Choices |4445 |---|---|45-| Writes | anyone, members, only me |46+| Writes | anyone, members, members and their follows, only me |47+| Open to anyone | kinds anyone may write whatever the write rule says, and whether anyone may reply to a member |4648 | Reads | anyone, signed in, members |4749 | Proof of work | minimum bits an event must carry, 0 to disable |4850 | Timestamp window | how far in the future an event may be dated |@@ -50,9 +52,16 @@ Who can do what, and how much.
5052 | Rate limits | events and queries per minute, per connection; an address gets four times that across all its connections |5153 | Upload size | largest file in megabytes, up to 95 |5254 | Kinds | allow list and block list by kind number |55+| Blocked words | content containing one is refused |5356 5457 An empty allow list means every kind. Blocks always win.5558 59+**Members and their follows** is a web of trust one hop wide: members and the owner may write, and so may everyone in their newest contact lists (kind 3) stored here. The web is rebuilt whenever a member's list arrives or the member list changes, and holds up to 50,000 pubkeys. Clients see the relay as restricted, and the group as closed, the same as the members rule.60+61+**Open to anyone** loosens a limited rule for guests without opening it. List kinds, such as 7 for reactions, and anyone may write those. Switch on replies and anyone may answer a note (kind 1) or a comment (kind 1111) by a member or by you, one hop: a reply to a guest's reply is not a reply to a member. Bans, blocked words, kind rules, proof of work, fuel and the rate limits still apply to guests.62+63+**Blocked words** is a list, one word or phrase per line, lowercased and matched anywhere in the content of any kind. An event that contains one is refused with a reason that says so. You and your moderators are exempt, and moderators may edit the list. Tags are not searched.64+5665 The per-address limit is what stops a client from opening many sockets to multiply its allowance. It also serves as the HTTP bridge's rate limit, which has no socket to meter. Address buckets live in memory and reset when the relay sleeps.5766 5867 ### Presets@@ -17,6 +17,12 @@ Two limits sit in each row, for the owner only. **Keep for** is a keep-for rule
1717 1818 Removing a member ends their live subscriptions when reads are members-only.1919 20+## Guests21+22+A members-only relay does not have to be silent to everyone else. On the Rules tab, **Open to anyone** lists kinds a stranger may write regardless of the write rule, reactions and zap receipts being the usual ones, and a switch lets anyone reply to a member's note or comment. A reply is one hop: answering a guest's reply is not answering a member. Everything else still applies to guests, bans and blocked words first.23+24+**Members and their follows** is the wider door: the write rule that admits every pubkey in a member's contact list, one hop from the member list. It rebuilds itself as lists arrive and members come and go.25+2026 ## Invites2127 2228 **New invite link** mints a link that lives one hour to 30 days, three days by default, and takes as many people as you allow, or any number if you leave the count at zero. The person opens it, reads the join terms, signs once and becomes a member.@@ -35,6 +41,10 @@ Set a member's role to *moderator* from the selector in their row. A moderator c
3541 3642 A moderator who signs in on the relay's page sees the People and Moderation tabs, nothing else. What the Moderation tab holds is in [Relay configuration](01-relay-configuration.md#moderation).3743 44+## Keeping order45+46+Three tools for the noise a bigger relay attracts, all on the Rules and Moderation tabs. **Blocked words** refuse any content that contains one, from anyone but you and your moderators. **Ban and erase** removes a person together with everything they wrote and uploaded. **Hide after N reports** takes an event out of view once that many different people have reported it, until a moderator looks. The [configuration guide](01-relay-configuration.md) has the details.47+3848 ## Groups in clients3949 4050 Your relay is also a group (NIP-29), one group per relay, so clients that understand groups, such as Flotilla, Chachi, 0xchat and Coracle, show it as a community: name and picture, who is in it, a join button and moderation. The group id is the relay's name.