Document Nostr user onboarding and its known limitations
CI / Test (pull_request) Successful in 47s

This commit is contained in:
raucao committed 2026-11-18 21:53:39 +04:00
1 parent 31dfbc4b08
commit 1b4bca3078
1 file changed
+34
+34
View File
@@ -60,4 +60,38 @@ it to your local strfry for example:
nak req -i 0fb010192685b86b0810b3de3706fbbf3b8c1db30b14533094a2b9700c820cdc nostr.kosmos.org | nak event ws://localhost:4777
## User onboarding
The account settings page lets users publish their own Nostr data:
* **Profile** (kind `0`) — display name, NIP-05 address and Lightning address. Edited fields are
merged into the existing profile JSON, so unknown keys (`about`, `picture`, …) are preserved.
* **Relay list** (NIP-65, kind `10002`) — the site relay is pre-included; entries can be marked
read-only or write-only.
* **Media server list** (Blossom, kind `10063`) — the configured Blossom server is pre-included.
Events are signed in the browser with a NIP-07 extension and sent to the app, which verifies them
(`NostrManager::VerifySignedEvent` recomputes the event id from the body before checking the
signature) and publishes them to the site relay and the user's relays. Reads — discovering an
existing profile, relay list or media server list — happen server-side.
Relevant settings (admin → Services → Nostr):
* **Relay URL** — the site's relay, pre-included in user relay lists.
* **Blossom server URL** — the site's media server, pre-included in user media server lists.
* **Discovery relays** — used to look up a user's published events.
### Known limitations
* Relays that require NIP-42 authentication are not supported: the `nostr` gem's client cannot
answer `AUTH`.
* A new relay list is published to the new list plus the site relay, so relays that were *removed*
from the list do not receive the update.
* Relay URL validation (ws/wss only, no loopback/private/link-local hosts) has a DNS-rebinding
time-of-check/time-of-use gap between validation and connection.
* The relay editor rejects non-`ws`/`wss` URLs, so an existing list containing e.g. `http://`
entries cannot be saved unchanged.
* Metadata discovery is sequential (relays → profile → media server list) and can take a while on
slow relays.
[1]: https://github.com/hoytech/strfry