- commit
- 480b2b0635463cdfcd1558d5dd1b75337e478d94
- parent
- 42e51751a8bc5f726031a687b9f3a90015f14ff1
- author
- Dami <dami.etoile@gmail.com>
| M | docs/ | 6 | ++++-- |
| M | docs/ | 2 | ++ |
| M | docs/ | 4 | ++++ |
@@ -35,7 +35,8 @@ Keeping order. Reports never show in the feed.
3535 - **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.3636 - **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.3737 - **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.38-- **Recent events** shows the feed with delete and ban actions.38+- **Recent events** shows the feed with pin, delete and ban actions. **Search** above it looks through notes, articles and profiles by words, the same index clients use (NIP-50), up to 200 results; **Clear** goes back to the feed.39+- **Pinned** is the group's pin list, up to 20 event ids or addresses in the order clients show them. Pin from the feed or by id; unpin from the list. Moderators may pin. The list is published as a record signed by the relay, so group clients see it.3940 4041 ## Rules4142 @@ -94,6 +95,7 @@ What is here, what moves, and what leaves.
9495 - **Files** lists uploads with sizes and a delete button.9596 - **Jobs** is work the relay does on its own in small rounds: pulls, standing mirrors, fetch my history and rebroadcasts, with run-now and remove per job. See [Data and names](04-data-and-names.md#jobs).9697 98+- **Import a file** takes a JSONL of events, one per line, such as a dump or a strfry export, or a JSON array, up to 64 MB, and stores what checks out as a job: signatures are verified, bans and kind rules apply, the write rule does not. The Jobs table shows stored, skipped and already-here counts. The file counts as a file for fuel until the job is done, then it is deleted.9799 - **Dumps** writes every event as one JSONL file daily or weekly and keeps the newest few. **Dump now** writes one on the spot. Downloads are signed requests. See [Data and names](04-data-and-names.md#dumps).98100 99101 - **Fork this relay** leases a new name, copies this relay into it and reserves the claim for a key. One fork an hour. See [Data and names](04-data-and-names.md#fork-this-relay).@@ -102,7 +104,7 @@ What is here, what moves, and what leaves.
102104 103105 Time since the last event, open connections, fuel status and a breakdown of kinds over the last 30 days. Below it, the usage meters and the list of zaps received.104106 105-**Notifications.** Four switches, all off until you turn them on: a report arrives, fuel runs low, a pull finishes, the handover clock is running (this one switches itself on when you name an heir). The relay writes you a NIP-17 private message with its own key, sealed and gift wrapped, stored here as your inbox and pushed to the relays in your kind 10050 when this relay holds one. **Send a test message** proves the path end to end. Only the owner can read these; the catch-all keep-for rule leaves gift wraps alone, though a rule set on kind 1059 itself still applies. Fuel is reported once when it turns low and then once a day while it stays low.107+**Notifications.** Five switches, all off until you turn them on: a report arrives, fuel runs low, a pull finishes, a note every week on how the relay is doing, the handover clock is running (this one switches itself on when you name an heir). The relay writes you a NIP-17 private message with its own key, sealed and gift wrapped, stored here as your inbox and pushed to the relays in your kind 10050 when this relay holds one. **Send a test message** proves the path end to end. Only the owner can read these; the catch-all keep-for rule leaves gift wraps alone, though a rule set on kind 1059 itself still applies. Fuel is reported once when it turns low and then once a day while it stays low.106108 107109 ## Owner108110 @@ -51,6 +51,8 @@ Your relay is also a group (NIP-29), one group per relay, so clients that unders
5151 5252 The group follows your rules. Members-only reads make the group private. Anything but open writes makes it closed, so joining needs an invite code; with open writes, a join request is accepted at once. A member may leave from their client. Moderators act from their client with the same limits as on the page.5353 54+Moderators can pin up to 20 events or addresses for the group, from the Moderation tab or with a pin list event (kind 9010) from a group client. The relay publishes the list as a signed record (kind 39005) that clients show at the top of the group.55+5456 The group's address is on the Identity tab under **Share**. See [Your relay on the web](05-your-relay-on-the-web.md#the-card-and-the-group-address).5557 5658 ## Hand it over@@ -23,6 +23,10 @@ A job runs once, or every hour, six hours or day. Up to five standing jobs and 2
2323 2424 **Rebroadcast** sends what your relay holds to other relays. Choose kinds and a window in days, or leave both blank for everything. As a standing job it forwards only what arrived since the last run. A target that refuses five events in a row is left alone for that round. Events that only their author may publish are never sent, and a members-only relay never sends private messages.2525 26+## Import a file27+28+The reverse of a dump. Under **Import a file** on the Data tab, pick a JSONL of events, one per line, such as a dump from another bind.ws relay or a strfry export, or a JSON array. Up to 64 MB. The relay keeps the file next to your uploads and reads it back as a job, a slice at a time, so a large file survives the relay sleeping. Every event's signature is checked; your bans and kind rules apply; your write rule does not, since you asked for these. The Jobs table shows how many were stored, how many the relay already had and how many were skipped. When the job is done the file is deleted. While it exists it counts as a file for fuel.29+2630 ## Dumps2731 2832 Under **Dumps**, choose daily or weekly and how many to keep, seven by default. The relay writes every event as one JSONL file and keeps the newest few. **Dump now** writes one on the spot. Each file lists its event count and size, with download and delete. Downloading takes your signature; the files are never a public link.