[{"data":1,"prerenderedAt":929},["ShallowReactive",2],{"docs-navigation":3,"docs-search-sections":94,"docs-\u002Fdocs\u002Frelay\u002Foperations\u002Fbackup-and-retention":680,"docs-nav-catchall":895,"docs-surround-\u002Fdocs\u002Frelay\u002Foperations\u002Fbackup-and-retention":925},[4],{"title":5,"path":6,"stem":7,"children":8},"Documentation","\u002Fdocs","docs\u002Findex",[9,10],{"title":5,"path":6,"stem":7},{"title":11,"path":12,"stem":13,"children":14},"Nostrfi Relay","\u002Fdocs\u002Frelay","docs\u002Frelay\u002Findex",[15,16,26,30,39,43,76,85],{"title":11,"path":12,"stem":13},{"title":17,"path":18,"stem":19,"children":20,"page":25},"Getting Started","\u002Fdocs\u002Frelay\u002Fgetting-started","docs\u002Frelay\u002F1.getting-started",[21],{"title":22,"path":23,"stem":24},"Quickstart","\u002Fdocs\u002Frelay\u002Fgetting-started\u002Fquickstart","docs\u002Frelay\u002F1.getting-started\u002Fquickstart",false,{"title":27,"path":28,"stem":29},"Changelog","\u002Fdocs\u002Frelay\u002Fchangelog","docs\u002Frelay\u002Fchangelog",{"title":31,"path":32,"stem":33,"children":34,"page":25},"Concepts","\u002Fdocs\u002Frelay\u002Fconcepts","docs\u002Frelay\u002Fconcepts",[35],{"title":36,"path":37,"stem":38},"Relay role and architecture","\u002Fdocs\u002Frelay\u002Fconcepts\u002Frelay-role","docs\u002Frelay\u002Fconcepts\u002Frelay-role",{"title":40,"path":41,"stem":42},"Current limitations","\u002Fdocs\u002Frelay\u002Flimitations","docs\u002Frelay\u002Flimitations",{"title":44,"path":45,"stem":46,"children":47,"page":25},"Operations","\u002Fdocs\u002Frelay\u002Foperations","docs\u002Frelay\u002Foperations",[48,52,56,60,64,68,72],{"title":49,"path":50,"stem":51},"Admin dashboard","\u002Fdocs\u002Frelay\u002Foperations\u002Fadmin-dashboard","docs\u002Frelay\u002Foperations\u002Fadmin-dashboard",{"title":53,"path":54,"stem":55},"Backup and retention","\u002Fdocs\u002Frelay\u002Foperations\u002Fbackup-and-retention","docs\u002Frelay\u002Foperations\u002Fbackup-and-retention",{"title":57,"path":58,"stem":59},"Capacity and sizing","\u002Fdocs\u002Frelay\u002Foperations\u002Fcapacity","docs\u002Frelay\u002Foperations\u002Fcapacity",{"title":61,"path":62,"stem":63},"Development operation","\u002Fdocs\u002Frelay\u002Foperations\u002Fdevelopment-operation","docs\u002Frelay\u002Foperations\u002Fdevelopment-operation",{"title":65,"path":66,"stem":67},"Event browser","\u002Fdocs\u002Frelay\u002Foperations\u002Fevent-browser","docs\u002Frelay\u002Foperations\u002Fevent-browser",{"title":69,"path":70,"stem":71},"Moderation","\u002Fdocs\u002Frelay\u002Foperations\u002Fmoderation","docs\u002Frelay\u002Foperations\u002Fmoderation",{"title":73,"path":74,"stem":75},"Observability","\u002Fdocs\u002Frelay\u002Foperations\u002Fobservability","docs\u002Frelay\u002Foperations\u002Fobservability",{"title":77,"path":78,"stem":79,"children":80,"page":25},"Reference","\u002Fdocs\u002Frelay\u002Freference","docs\u002Frelay\u002Freference",[81],{"title":82,"path":83,"stem":84},"Protocol support","\u002Fdocs\u002Frelay\u002Freference\u002Fprotocol-support","docs\u002Frelay\u002Freference\u002Fprotocol-support",{"title":86,"path":87,"stem":88,"children":89,"page":25},"Security","\u002Fdocs\u002Frelay\u002Fsecurity","docs\u002Frelay\u002Fsecurity",[90],{"title":91,"path":92,"stem":93},"Trust and data","\u002Fdocs\u002Frelay\u002Fsecurity\u002Ftrust-and-data","docs\u002Frelay\u002Fsecurity\u002Ftrust-and-data",[95,99,104,110,113,118,123,128,133,138,143,148,153,158,163,168,173,178,183,188,191,196,201,206,211,216,221,226,231,236,241,245,250,253,258,263,268,273,278,281,286,291,296,301,305,308,313,318,323,328,333,338,343,348,353,358,363,368,371,376,381,386,391,396,401,406,411,414,419,424,429,434,439,442,447,452,457,462,467,470,475,480,485,490,495,498,502,507,512,517,522,527,532,537,542,547,550,555,560,564,569,574,579,584,589,593,596,601,606,611,616,619,624,629,634,639,643,648,651,656,661,666,671,676],{"id":6,"title":5,"titles":96,"content":97,"level":98},[],"Documentation for Nostrfi Relay, a self-operable Nostr relay: architecture, protocol support, operations, security, and known limitations.",1,{"id":100,"title":5,"titles":101,"content":102,"level":103},"\u002Fdocs#documentation",[5],"Nostrfi documentation provides comprehensive guidance for understanding,\nevaluating, integrating, operating, and troubleshooting Nostrfi products.",2,{"id":105,"title":106,"titles":107,"content":108,"level":109},"\u002Fdocs#available-documentation","Available documentation",[5,5],"Nostrfi Relay documentation — architecture, protocol support, the admin dashboard, operations, security, and limitations All documentation is clearly labelled with its product, owner, and last review\ndate. Relay documentation reflects the current release, v0.3.0.",3,{"id":23,"title":22,"titles":111,"content":112,"level":98},[],"Run your own Nostr relay with Nostrfi Relay. Start the relay and its admin dashboard with Docker Compose, sign in with your Nostr key, and connect a client. This guide takes you from nothing to a running Nostr relay that you operate:\nthe relay, its admin dashboard, and a TLS reverse proxy, all on one machine.\nYou then sign in to the dashboard with your own Nostr key and connect a\nclient. It takes about ten minutes, most of it spent downloading images. Read the current limitations before you put real\nusers on your relay. These steps are written for release v0.3.0.",{"id":114,"title":115,"titles":116,"content":117,"level":103},"\u002Fdocs\u002Frelay\u002Fgetting-started\u002Fquickstart#before-you-start","Before you start",[22],"You need: A Linux x86-64 machine with Docker Engine and Docker Compose v2. The\npublished images are built for linux\u002Famd64 only. On ARM hosts, including\nApple Silicon, see On ARM hosts.At least 1 GB of RAM and 1 vCPU for the relay, dashboard, and proxy\ntogether. See capacity and sizing.Your Nostr public key in hex: 64 characters, not the npub1… form.\nIf you only have an npub, decode it with a NIP-19 tool, such as\nnak decode npub1….A signer for that key: a NIP-07 browser extension or a NIP-46 remote\nsigner (bunker). The dashboard never asks for your private key.git and openssl.",{"id":119,"title":120,"titles":121,"content":122,"level":103},"\u002Fdocs\u002Frelay\u002Fgetting-started\u002Fquickstart#_1-get-the-release","1. Get the release",[22],"git clone --branch v0.3.0 --depth 1 https:\u002F\u002Fgithub.com\u002Fnostrfi\u002Frelay.git\ncd relay",{"id":124,"title":125,"titles":126,"content":127,"level":103},"\u002Fdocs\u002Frelay\u002Fgetting-started\u002Fquickstart#_2-make-yourself-the-operator","2. Make yourself the operator",[22],"Open backend\u002Fconfig.yaml and set relay_info.pubkey to your hex public key.\nSet the name, description, and contact while you are there. They are\npublished in the relay's NIP-11 information document. relay_info:\n  name: \"My Relay\"\n  description: \"A Nostr relay run by me.\"\n  pubkey: \"\u003Cyour 64-character hex pubkey>\"\n  contact: \"you@example.com\" This pubkey becomes the relay's owner: the key that can sign in to the\ndashboard, use the NIP-86 moderation API, and grant\nadministrators later.\nmoderation.admin_pubkey defaults to it. The file ships with an example pubkey. If you leave it in place, the relay\nruns normally, but you will not be able to sign in to the dashboard or\nmoderate the relay.",{"id":129,"title":130,"titles":131,"content":132,"level":103},"\u002Fdocs\u002Frelay\u002Fgetting-started\u002Fquickstart#_3-create-the-environment-file","3. Create the environment file",[22],"Create a .env file next to docker-compose.yml: cat > .env \u003C\u003CEOF\nCOMPOSE_FILE=docker-compose.yml:docker-compose.tls.yml\nRELAY_VERSION=0.3.0\nDASHBOARD_VERSION=0.3.0\nNUXT_SESSION_PASSWORD=$(openssl rand -base64 48)\nEOF COMPOSE_FILE adds the TLS overlay, which puts Caddy in front of the relay\nand the dashboard. Every docker compose command below then uses both\nfiles.RELAY_VERSION and DASHBOARD_VERSION pin the published images to this\nrelease instead of latest.NUXT_SESSION_PASSWORD seals the dashboard's session cookie. The dashboard\nrefuses to start a session without it. Keep the file private.",{"id":134,"title":135,"titles":136,"content":137,"level":103},"\u002Fdocs\u002Frelay\u002Fgetting-started\u002Fquickstart#_4-start-it","4. Start it",[22],"docker compose up -d\ndocker compose ps Wait until relay and dashboard report healthy. Three containers run: ContainerRolenostrfi-relayThe relay. It stores events in a Docker volume, relay-db.nostrfi-relay-dashboardThe admin dashboard, served at \u002Fadmin.nostrfi-relay-caddyTLS on port 8443, routing \u002Fadmin to the dashboard and everything else to the relay. Locally, Caddy issues itself a certificate for localhost (tls internal),\nso no domain or DNS is needed.",{"id":139,"title":140,"titles":141,"content":142,"level":103},"\u002Fdocs\u002Frelay\u002Fgetting-started\u002Fquickstart#_5-check-the-relay-answers","5. Check the relay answers",[22],"Ask for the relay's NIP-11 information document: curl -k -H \"Accept: application\u002Fnostr+json\" https:\u002F\u002Flocalhost:8443\u002F You should get JSON with your relay's name, your pubkey, and the supported\nNIPs. -k accepts Caddy's local certificate. To check readiness: curl -k https:\u002F\u002Flocalhost:8443\u002Freadyz",{"id":144,"title":145,"titles":146,"content":147,"level":103},"\u002Fdocs\u002Frelay\u002Fgetting-started\u002Fquickstart#_6-sign-in-to-the-dashboard","6. Sign in to the dashboard",[22],"Open https:\u002F\u002Flocalhost:8443\u002Fadmin in your browser and accept the local\ncertificate (see Trust the local certificate\nto avoid the warning).Choose Sign in, then approve with your browser extension or paste a\nbunker URL. Your signer asks twice: once for the dashboard's sign-in\nchallenge, and once for a whoami that asks the relay what role your key\nholds.The overview opens, with live connections, subscriptions, stored events,\nand events by day. The relay decides who may sign in, so only the pubkey from step 2 can, until\nyou grant administrators. If sign-in is refused, check that\nrelay_info.pubkey is your key in hex. After changing it, run\ndocker compose restart relay dashboard. See admin dashboard for what each\npage does.",{"id":149,"title":150,"titles":151,"content":152,"level":103},"\u002Fdocs\u002Frelay\u002Fgetting-started\u002Fquickstart#_7-connect-a-client","7. Connect a client",[22],"Add wss:\u002F\u002Flocalhost:8443 as a relay in a Nostr client on the same machine,\npublish a note, and open Events in the dashboard to see it arrive.",{"id":154,"title":155,"titles":156,"content":157,"level":109},"\u002Fdocs\u002Frelay\u002Fgetting-started\u002Fquickstart#trust-the-local-certificate","Trust the local certificate",[22,150],"Browsers and most clients reject Caddy's local certificate until you trust\nit. Either open https:\u002F\u002Flocalhost:8443 once and accept the warning, or\nexport Caddy's root certificate and add it to your system or browser trust\nstore: docker compose exec caddy cat \u002Fdata\u002Fcaddy\u002Fpki\u002Fauthorities\u002Flocal\u002Froot.crt > caddy-local-root.crt A relay on a real domain gets a publicly trusted certificate instead. See the\nnext section.",{"id":159,"title":160,"titles":161,"content":162,"level":103},"\u002Fdocs\u002Frelay\u002Fgetting-started\u002Fquickstart#put-it-on-a-server","Put it on a server",[22],"To serve real clients, run the same setup on a server with a domain name\npointing at it: In Caddyfile, replace localhost with your domain and delete the\ntls internal line. Caddy then obtains and renews a Let's Encrypt\ncertificate.In docker-compose.tls.yml, change the port mapping 8443:443 to\n443:443 and add 80:80 for the certificate challenge.In .env, add RELAY_URL=wss:\u002F\u002Fyour-domain. The TLS overlay passes it to\nthe relay as auth.relay_url, which binds NIP-42 authentication and every\noperator signature to your relay's address. Without it, the relay expects\nwss:\u002F\u002Flocalhost:8443 and refuses dashboard sign-in and moderation\nrequests signed for your domain.Run docker compose up -d again. Then work through the\nproduction-readiness checklist,\nset up backups, and decide on\nyour moderation approach.",{"id":164,"title":165,"titles":166,"content":167,"level":103},"\u002Fdocs\u002Frelay\u002Fgetting-started\u002Fquickstart#stop-or-remove-it","Stop or remove it",[22],"docker compose down       # stop; keeps events and certificates\ndocker compose down -v    # stop and delete the event database and certificates",{"id":169,"title":170,"titles":171,"content":172,"level":103},"\u002Fdocs\u002Frelay\u002Fgetting-started\u002Fquickstart#other-ways-to-run-it","Other ways to run it",[22],"",{"id":174,"title":175,"titles":176,"content":177,"level":109},"\u002Fdocs\u002Frelay\u002Fgetting-started\u002Fquickstart#on-arm-hosts","On ARM hosts",[22,170],"The published images are linux\u002Famd64 only. The Compose file can also build\nboth images from the checked-out source. Leave RELAY_VERSION and\nDASHBOARD_VERSION out of .env, then run docker compose up -d --build.\nThis path has not yet been tested on ARM.",{"id":179,"title":180,"titles":181,"content":182,"level":109},"\u002Fdocs\u002Frelay\u002Fgetting-started\u002Fquickstart#the-relay-alone-from-source","The relay alone, from source",[22,170],"To run only the relay, without the dashboard or TLS, you need Go 1.25 or newer\nand a C compiler, because the DuckDB driver uses cgo: cd backend\ngo run .\u002Fcmd\u002Frelay It reads backend\u002Fconfig.yaml, stores events in backend\u002Fdb\u002Frelay.db, and\nlistens on ws:\u002F\u002Flocalhost:8080. See\ndevelopment operation. The v0.3.0 release also attaches a prebuilt relay-linux-amd64 binary. It\nneeds glibc 2.36 or newer, so it runs on Debian 12, Ubuntu 24.04, and later\ndistributions. On older distributions, use the container images or build\nfrom source instead.",{"id":184,"title":185,"titles":186,"content":187,"level":103},"\u002Fdocs\u002Frelay\u002Fgetting-started\u002Fquickstart#next-steps","Next steps",[22],"How the relay is structuredWhich NIPs it supportsWhat an operator can see, and the threat modelObservability and metrics html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}",{"id":28,"title":27,"titles":189,"content":190,"level":98},[],"What changed in each Nostrfi Relay release, for operators: new dashboard features, fixes, and what to check when you upgrade.",{"id":192,"title":193,"titles":194,"content":195,"level":103},"\u002Fdocs\u002Frelay\u002Fchangelog#how-releases-work","How releases work",[27],"Nostrfi Relay releases follow semantic versioning.\nEach release is tagged v\u003Cversion> and published on\nGitHub releases, with relay and\ndashboard images on the GitHub Container Registry and a Linux binary attached. This page summarises each release for the people who run the relay. The full\nlist of commits is in the release notes on GitHub. Before 1.0, a release may\nchange configuration between versions, so read the notes before you upgrade.",{"id":197,"title":198,"titles":199,"content":200,"level":103},"\u002Fdocs\u002Frelay\u002Fchangelog#_030-16-november-2026","0.3.0 (16 November 2026)",[27],"Release notes on GitHub This release deletes stored ephemeral events on its first start, and refuses\noperator requests until the relay knows its own public address. Read\nUpgrading before you deploy it.",{"id":202,"title":203,"titles":204,"content":205,"level":109},"\u002Fdocs\u002Frelay\u002Fchangelog#administrators","Administrators",[27,198],"Grant administrator rights to other pubkeys, so a team can run a relay\nwithout sharing the owner's key. The owner (moderation.admin_pubkey) uses\nthe NIP-86 assignrole and unassignrole methods. The relay adds two\nmethods of its own: listroleassignments and whoami.Administrators can moderate and browse events. Role management and the\nconfiguration API stay owner only, and answer administrators with 403.\nSee administrators.Administrators can sign in to the dashboard. The dashboard asks the\nrelay which role a key holds, so your signer now prompts twice at sign-in.\nConfiguration is hidden from administrators. See\nadmin dashboard.",{"id":207,"title":208,"titles":209,"content":210,"level":109},"\u002Fdocs\u002Frelay\u002Fchangelog#protocol","Protocol",[27,198],"Ephemeral events are no longer stored. Kinds 20000–29999, such as\npresence heartbeats, are delivered to open subscriptions and never written\nto the database, as NIP-01 expects. A new metric,\nrelay_events_ephemeral_total, counts them.Kind 22242 sent as EVENT is refused. NIP-42 authentication events\nbelong in AUTH messages. Before, they were stored and broadcast.",{"id":212,"title":213,"titles":214,"content":215,"level":109},"\u002Fdocs\u002Frelay\u002Fchangelog#security-fixes","Security fixes",[27,198],"Operator signatures are bound to this relay. A NIP-98 signature must\nname this relay's origin, and each one is accepted once. Before, a\nsignature a browser extension made for another website could be replayed\nat the relay\n(nostrfi\u002Frelay#60).Administrator grants are kept consistent. A grant or revocation is\ncompleted even if the client disconnects mid-request. At start, the relay\ndeletes any stored grant for the owner's own key, and warns about grants\nmade by a former owner key.Dashboard sessions end when they should. Signing out really ends the\nsession, signing in again revokes the previous one, and restarting the\ndashboard ends every session. Revoking an administrator ends their\ndashboard access too.",{"id":217,"title":218,"titles":219,"content":220,"level":109},"\u002Fdocs\u002Frelay\u002Fchangelog#packaging","Packaging",[27,198],"The prebuilt relay-linux-amd64 binary needs glibc 2.36 or newer, down\nfrom 2.43, so it runs on Debian 12 and Ubuntu 24.04.",{"id":222,"title":223,"titles":224,"content":225,"level":109},"\u002Fdocs\u002Frelay\u002Fchangelog#upgrading","Upgrading",[27,198],"Back up first. Migration 6 deletes every stored ephemeral event when\n0.3.0 first starts. To keep them, take the backup with your current 0.2.0\nbinary, or copy db\u002Frelay.db while the relay is stopped. A backup taken\nwith 0.3.0 runs the migration first. See\nbackup and retention.Set the relay's public address. The relay refuses every operator\nrequest, including dashboard sign-in, unless auth.relay_url or\nmoderation.api_origin gives its origin. With the TLS overlay, set\nRELAY_URL=wss:\u002F\u002Fyour-domain in .env; it defaults to\nwss:\u002F\u002Flocalhost:8443. See\nmoderation.Remove NUXT_ADMIN_PUBKEY from the dashboard's environment. It is no\nlonger read. The owner is moderation.admin_pubkey in the relay's\nconfig.yaml, as before.Operators sign in again after the upgrade, because older sessions carry\nno role.",{"id":227,"title":228,"titles":229,"content":230,"level":103},"\u002Fdocs\u002Frelay\u002Fchangelog#_020-12-november-2026","0.2.0 (12 November 2026)",[27],"Release notes on GitHub",{"id":232,"title":233,"titles":234,"content":235,"level":109},"\u002Fdocs\u002Frelay\u002Fchangelog#dashboard","Dashboard",[27,228],"Filter events by several tags at once, including multi-letter tags. The\nevent browser explains how tag rows\ncombine.Relay status and uptime on the Overview, with a spinner while the page\nrefreshes. See the admin dashboard.The Metrics page has the same status card and refresh spinner as the\nOverview, so either page tells you at a glance whether the relay is up.",{"id":237,"title":238,"titles":239,"content":240,"level":109},"\u002Fdocs\u002Frelay\u002Fchangelog#fixes","Fixes",[27,228],"NIP-42 authentication: the relay now answers every AUTH message with an\nOK, as the specification requires: true when authentication succeeds, and\nfalse with an invalid: or restricted: reason when it does not (this was\na NOTICE before). Clients that wait for the reply, such as nak and\ngo-nostr, no longer time out, so they can publish NIP-70 protected events.\nSee protocol support.",{"id":242,"title":223,"titles":243,"content":244,"level":109},"\u002Fdocs\u002Frelay\u002Fchangelog#upgrading-1",[27,228],"No configuration changes.The prebuilt relay-linux-amd64 binary attached to this release needs glibc\n2.43 or newer. The container images are not affected. The fix is merged and\nships in the next release.",{"id":246,"title":247,"titles":248,"content":249,"level":103},"\u002Fdocs\u002Frelay\u002Fchangelog#_010-11-november-2026","0.1.0 (11 November 2026)",[27],"Release notes on GitHub The first tagged release of Nostrfi Relay and its operator dashboard. Releases\nare now cut from a release PR, and the relay is built with Go 1.26.11 to clear\nstandard-library security advisories. Start with the quickstart, and read\nthe current limitations before you deploy.",{"id":37,"title":36,"titles":251,"content":252,"level":98},[],"What a Nostr relay does, how Nostrfi Relay is structured inside, its main event and subscription flows, and how it scales.",{"id":254,"title":255,"titles":256,"content":257,"level":103},"\u002Fdocs\u002Frelay\u002Fconcepts\u002Frelay-role#what-a-relay-does","What a relay does",[36],"A Nostr relay is a server that stores signed events and serves them to clients\nover WebSocket connections. Clients publish events to relays and subscribe to\nevent feeds from relays. Each client chooses which relays to connect to and can\nconnect to several at once. The relay does not hold users' private keys. Clients sign events locally and\nsend the signed event to the relay. The relay verifies the signature before\nstoring or serving the event.",{"id":259,"title":260,"titles":261,"content":262,"level":103},"\u002Fdocs\u002Frelay\u002Fconcepts\u002Frelay-role#system-architecture","System architecture",[36],"Nostrfi Relay runs as two processes: the Go relay and a Nuxt admin dashboard.\nIn the documented deployment, a Caddy reverse proxy terminates TLS and is the\nonly public entry point. It routes \u002Fadmin to the dashboard and everything\nelse to the relay. The browser never talks to the relay directly for dashboard data. The\ndashboard's server calls the relay over the internal network, forwarding\nrequests the operator signed in their own browser.",{"id":264,"title":265,"titles":266,"content":267,"level":103},"\u002Fdocs\u002Frelay\u002Fconcepts\u002Frelay-role#inside-the-relay","Inside the relay",[36],"The relay is a single Go process organised in layers, with dependencies\npointing inward: Domain: events, moderation entries, and subscriptions, plus the\nrepository interfaces. Constructing a domain event is the one place a\nsignature is verified.Application: event, moderation, and maintenance services that\norchestrate use cases.Infrastructure: the DuckDB repository that stores events, their full\ntag arrays, and a tag index for filter lookups.Interfaces: the HTTP and WebSocket handler. It serves NIP-11, the NIP-86\nmanagement API, and the operator APIs, and owns connections, subscriptions,\nauthentication, Negentropy sessions, and live delivery. SIGINT or SIGTERM starts a graceful shutdown of both listeners before the\ndatabase is closed.",{"id":269,"title":270,"titles":271,"content":272,"level":103},"\u002Fdocs\u002Frelay\u002Fconcepts\u002Frelay-role#main-flows","Main flows",[36],"Publish. The relay verifies the event's signature, checks limits,\nauthentication, and bans, applies replacement, deletion, and expiration rules,\nsaves the event, replies OK, and delivers it to matching live\nsubscriptions. Subscribe. The relay keeps the filters in memory for live delivery,\nqueries each filter, removes duplicates, applies gift-wrap access rules, sends\nthe stored events, then EOSE. CLOSE removes the subscription. Authenticate. Every connection gets a random challenge. A signed kind\n22242 event carrying it makes that pubkey the connection's identity. Reconcile. Negentropy sessions find the differences between a client's\nevents and the relay's. Event bodies still move over normal requests.",{"id":274,"title":275,"titles":276,"content":277,"level":103},"\u002Fdocs\u002Frelay\u002Fconcepts\u002Frelay-role#scaling","Scaling",[36],"The relay is single-instance by design. Connected clients, subscriptions,\nauthentication, live broadcasts, and Negentropy sessions are local to one\nprocess. Horizontal scaling is not planned, and most operators never need it:\nNostr clients use several independent relays, so redundancy comes from the\nnetwork, not from clustering one relay. See\ncurrent limitations for why.",{"id":12,"title":11,"titles":279,"content":280,"level":98},[],"A self-operable Nostr relay with an operator dashboard — architecture, protocol support, operations, security, and limitations.",{"id":282,"title":283,"titles":284,"content":285,"level":103},"\u002Fdocs\u002Frelay#overview","Overview",[11],"Nostrfi Relay is a Nostr relay written in Go, with an admin dashboard for the\nperson who runs it. It speaks the Nostr WebSocket protocol and implements\nNIP-01, 02, 09, 11, 17, 22, 28, 40, 42, 50, 70, 71, 77, 86, and 98. The relay accepts signed events, serves filtered history, delivers live events\nto active subscriptions, and stores events in a local DuckDB database. The\ndashboard runs as a separate process behind the same domain and lets the\noperator see what the relay is doing and act on it, signing in with their own\nNostr key. New here? The quickstart gets the relay and its dashboard\nrunning on your machine and signs you in with your Nostr key. Released and in production. The current release is\nv0.3.0, and Nostrfi\nruns it in production. The source is public and anyone can run it. Releases\nbefore 1.0 may still change configuration between versions, so read the release\nnotes when you upgrade, and the current limitations\nbefore you deploy.",{"id":287,"title":288,"titles":289,"content":290,"level":103},"\u002Fdocs\u002Frelay#what-the-relay-does","What the relay does",[11],"Accepts signed events and returns NIP-01 OK responsesServes stored events for REQ filters, including prefix filters, then EOSEDelivers newly accepted events to matching live subscriptionsPreserves every event's full tag array through storageApplies replaceable and parameterized-replaceable event semanticsSearches event content with NIP-50 (substring matching, not ranked)Enforces every advertised NIP-11 limit, plus connection and rate limitsAuthenticates clients with NIP-42 and protects NIP-70 eventsRestricts kind 1059 gift-wrap reads to authenticated recipients and authorsHonors expiration and deletion requests, and supports Negentropy syncLets the operator ban pubkeys and events and block IPs through NIP-86",{"id":292,"title":293,"titles":294,"content":295,"level":103},"\u002Fdocs\u002Frelay#what-the-operator-gets","What the operator gets",[11],"An admin dashboard with an\noverview, live metrics, an event browser, moderation, and a configuration\nviewer, signed in with a Nostr keyModeration through the standard NIP-86\nAPI, usable from the dashboard or any NIP-98-capable toolHealth and readiness endpoints and Prometheus\nmetrics on an internal-only listenerSchema migrations, an expiry purge worker, and verified\nbackup and restoreContainer images, a TLS-terminating reverse-proxy overlay, and a measured\ncapacity baseline",{"id":297,"title":298,"titles":299,"content":300,"level":103},"\u002Fdocs\u002Frelay#source","Source",[11],"The relay source repository is at\ngithub.com\u002Fnostrfi\u002Frelay.",{"id":302,"title":185,"titles":303,"content":304,"level":103},"\u002Fdocs\u002Frelay#next-steps",[11],"Relay role and architectureProtocol supportDevelopment operationAdmin dashboardTrust and dataCurrent limitations",{"id":41,"title":40,"titles":306,"content":307,"level":98},[],"Known limitations of Nostrfi Relay: single instance, unranked search, proxy IP blocks, query bounds, and client compatibility.",{"id":309,"title":310,"titles":311,"content":312,"level":103},"\u002Fdocs\u002Frelay\u002Flimitations#known-limitations","Known limitations",[40],"The following limitations are known and should be understood before any\ndeployment. The relay's intended operating model is a public reusable relay:\ngeneral-purpose infrastructure open to any Nostr client or user, not limited\nto Nostrfi's own products or team. The limitations below are what stand\nbetween the current release and that goal. Limitations that have been resolved are\nkept and marked as such, so links to this page stay valid.",{"id":314,"title":315,"titles":316,"content":317,"level":103},"\u002Fdocs\u002Frelay\u002Flimitations#single-instance","Single instance",[40],"The relay runs as a single instance. This is deliberate, and horizontal\nscaling is not planned. Connected clients, subscriptions, authentication, live\nbroadcasts, and Negentropy sessions are local to one process, and there is no\nshared event bus or connection state between instances. Most operators never need to scale a relay out horizontally. Nostr already\nprovides redundancy at the network level: clients connect to several\nindependent relays, so one relay going down does not take the network down.\nHorizontal scaling of a single relay only pays off at a scale most operators\nnever reach. Network-level redundancy comes free. Clients publish to and read from\nseveral relays at once. When one relay is down, the same events are usually\navailable from the others, so a single relay does not need to be highly\navailable.Clustering has a real operational cost. Shared databases, cross-instance\nsync, load balancers, and the monitoring they need add complexity that a\npersonal or community relay rarely justifies.The hard scaling problem is economic, not technical. A measurement study\nof 712 public relays found that 20% were down for more than 40% of the\nobservation period, and identified the cost of running free relays as a\ncontributing factor\n(Wei and Tyson). More nodes do not pay\nfor bandwidth and storage.Traffic spikes are brief. A popular post can load a relay heavily for a\nwhile, but the load passes. Rate and connection limits protect the relay\nwhile it does. The Nostr network scales by adding more independent relays, not by making any\nsingle relay bigger. Horizontal scaling of one relay is a performance\noptimisation for operators whose relay already carries a significant share of\nthe network's traffic. As a rough rule of thumb (user counts are indicative, not measured): Use caseGeneral recommendationWith Nostrfi RelayPersonal or allow-listed relaySingle instance, no scaling neededFitsSmall public relay (under about 5,000 users)Single instance, perhaps a standbyFits; use a verified backup as a cold standby, since hot standby is not supportedMedium public relay (about 5,000–20,000 users)Two instances behind a router, or sharing a databaseNot supported; run another independent relay insteadLarge public relay (20,000+ users, high write volume)True horizontal scaling, such as Shugur Relay or a custom designOut of scope To serve more with Nostrfi Relay, give the host more resources. If one host is\nno longer enough, run another independent relay rather than clustering this\none. The trade-off is that one relay's capacity is bounded by its host, and while\nit is down its clients rely on their other relays. See\ncapacity and sizing.",{"id":319,"title":320,"titles":321,"content":322,"level":103},"\u002Fdocs\u002Frelay\u002Flimitations#search-is-not-ranked","Search is not ranked",[40],"NIP-50 search is a case-insensitive substring match, not ranked full-text\nsearch. Multi-word terms match literally, and every search scans the stored\ncontent, so its cost grows with the database. Each search has a work budget,\nbut many concurrent searches are limited only by the connection and rate\nlimits. See protocol support.",{"id":324,"title":325,"titles":326,"content":327,"level":103},"\u002Fdocs\u002Frelay\u002Flimitations#ip-blocks-behind-a-reverse-proxy","IP blocks behind a reverse proxy",[40],"NIP-86 IP blocks match the address the relay sees. Behind the documented\nTLS proxy, that is the proxy's address, not the client's, so IP blocks are not\neffective there until trusted-proxy support exists. This remains open, as does\na per-source connection cap.",{"id":329,"title":330,"titles":331,"content":332,"level":103},"\u002Fdocs\u002Frelay\u002Flimitations#unbounded-queries-and-negentropy-sessions","Unbounded queries and Negentropy sessions",[40],"A non-search REQ filter that omits limit is not given a default limit, and\nNegentropy sessions per connection are not capped. Both are tracked as\nfollow-up work from the threat model.",{"id":334,"title":335,"titles":336,"content":337,"level":103},"\u002Fdocs\u002Frelay\u002Flimitations#multi-letter-tag-filters","Multi-letter tag filters",[40],"Public REQ subscriptions filter stored events by single-letter tags only.\nFiltering by multi-letter and value-less tags, such as client or -, is\navailable to the operator through the\nevent browser. Events stored before\nschema version 3 cannot match multi-letter tags at all.",{"id":339,"title":340,"titles":341,"content":342,"level":103},"\u002Fdocs\u002Frelay\u002Flimitations#gift-wrap-access-policy","Gift-wrap access policy",[40],"Kind 1059 gift wraps can be read by their recipient and by their author.\nThe policy, and the metadata it exposes, are still under review.",{"id":344,"title":345,"titles":346,"content":347,"level":103},"\u002Fdocs\u002Frelay\u002Flimitations#client-compatibility","Client compatibility",[40],"Compatibility has been verified with nostr-tools only. Other SDKs and\nnative and web clients have not been tested yet.",{"id":349,"title":350,"titles":351,"content":352,"level":103},"\u002Fdocs\u002Frelay\u002Flimitations#no-encryption-at-rest","No encryption at rest",[40],"The database and its backups are not encrypted at rest. Restricting host\naccess is the compensating control. This is an accepted risk; see\ntrust and data.",{"id":354,"title":355,"titles":356,"content":357,"level":103},"\u002Fdocs\u002Frelay\u002Flimitations#no-tls-in-the-application","No TLS in the application",[40],"The relay doesn't terminate TLS itself. This is deliberate: TLS belongs to the\ndeployment layer. A documented, exercised reverse-proxy overlay (Caddy, via\ndocker-compose.tls.yml) provides it.",{"id":359,"title":360,"titles":361,"content":362,"level":103},"\u002Fdocs\u002Frelay\u002Flimitations#no-service-level-objective-yet","No service-level objective yet",[40],"Nostrfi runs the relay in production, and the production-readiness checklist\nin the development operation guide\nis complete. A formal service-level objective has not been set yet, and the\npublished capacity numbers come from a development sandbox rather than\nproduction hardware.",{"id":364,"title":365,"titles":366,"content":367,"level":103},"\u002Fdocs\u002Frelay\u002Flimitations#resolved","Resolved",[40],"Tag fidelity. Every event's full tag array is stored and returned\nexactly. Events stored before this change fall back to their first two\nfields, because the rest was never saved.Unenforced limits. Every advertised NIP-11 limit is enforced on the\nrequest path.Prefix filters. ids and authors prefix filters work for stored\nqueries and live delivery.WebSocket origins. The origin policy is configurable, with a production\nmode that requires an allow-list.Backup and retention. Schema migrations, an expiry purge worker, and\nverified backup and restore exist. Deletion and replacement remove their tag\nrows in the same transaction.Health and metrics. \u002Fhealthz, \u002Freadyz, and Prometheus \u002Fmetrics\nexist, with a provisional dashboard and alert set. Distributed tracing\nremains open.Authentication gaps. The NIP-42 relay tag and event freshness are\nvalidated when configured. Authentication sessions are still not durable\nacross connections.Load testing. A single-instance capacity baseline has been measured. See\ncapacity and sizing.Threat model. A written threat model covers the public reusable\noperating model. See trust and data.Shared operator key. Since 0.3.0 the owner can grant administrators,\nso a team no longer has to share one key. See\nadministrators.Operator signature replay. Since 0.3.0 a NIP-98 signature must name\nthis relay's origin and is accepted once, so a signature made for another\nwebsite can't be replayed here.Stored ephemeral events. Since 0.3.0 kinds 20000–29999 are\ndelivered but never stored, and those stored earlier are deleted on upgrade.",{"id":50,"title":49,"titles":369,"content":370,"level":98},[],"The operator dashboard for Nostrfi Relay — sign-in, overview, metrics, event browser, moderation, and configuration.",{"id":372,"title":373,"titles":374,"content":375,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fadmin-dashboard#what-it-is","What it is",[49],"The admin dashboard is a web interface for the person who runs the relay. It\nis served at \u002Fadmin on the relay's domain and runs as its own process (a\nNuxt server-rendered app), next to the relay rather than inside it. The dashboard holds no relay state of its own. Everything it shows comes from\nthe relay, and every change it makes goes through the relay's own APIs.",{"id":377,"title":378,"titles":379,"content":380,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fadmin-dashboard#pages","Pages",[49],"PagePathWhat it showsRelay information\u002FadminThe relay's public NIP-11 information. Public; no sign-in needed.Overview\u002Fadmin\u002FdashboardWhat the relay is doing: identity, a metrics summary, and stored events by period and by kind.Metrics\u002Fadmin\u002Fdashboard\u002FmetricsLive connections, message and rejection rates, subscriptions, query latency, and storage.Events\u002Fadmin\u002Fdashboard\u002FeventsA browser for stored events, with filters and a detail view. See the event browser.Moderation\u002Fadmin\u002Fdashboard\u002FmoderationBanned pubkeys, banned events, and blocked IPs, with actions to change them.Configuration\u002Fadmin\u002Fdashboard\u002FconfigurationThe configuration the running relay is actually enforcing. Owner only.",{"id":382,"title":383,"titles":384,"content":385,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fadmin-dashboard#signing-in","Signing in",[49],"Sign-in uses your Nostr key, not a password. The relay's owner and its\nadministrators can sign\nin. Choose Sign in in the header and approve with a browser extension\n(NIP-07) or a remote signer (NIP-46 bunker). Your signer asks you to approve twice, by design: A one-time NIP-98 challenge for the dashboard, which proves who you are.A NIP-86 whoami for the relay, which asks the relay what role your key\nholds. The dashboard opens an 8-hour session only if the relay answers owner or\nadmin for the same key that signed the challenge. The dashboard keeps no\nlist of administrators; the relay decides who may sign in. A key with no role\ngets the same generic refusal as any stranger. If the relay rejects the\nwhoami itself, for example because your clock is out of step, the sign-in\ndialog shows the relay's reason. Administrators see every page except Configuration, which is owner only.\nThe sidebar shows your role next to your npub. The session only proves who signed in; it is not a credential the relay\naccepts. Every privileged relay operation still needs its own NIP-98\nsignature from your signer, which the relay checks against the owner and its\nadministrators. A stolen session cookie gives dashboard access, never the\nability to change relay state. Sign-in attempts are rate-limited per client address.",{"id":387,"title":388,"titles":389,"content":390,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fadmin-dashboard#when-a-session-ends","When a session ends",[49],"Signing out clears the session and any stored bunker pairing. A copy of\nthe cookie, or a request still in flight, can't bring it back.Signing in again in the same browser ends the previous session.Restarting the dashboard ends every session, so operators sign in again.Revoking an administrator ends their dashboard access. The relay refuses\ntheir next signed request, and the dashboard then signs them out. Metrics\nis the one view the relay doesn't authorize itself, so after 15 minutes\nwithout a confirmed role it asks the signer for one more whoami. A revoked\nkey is signed out there. A key loses access to metrics no more than 15\nminutes after it is revoked, and loses everything else straight away. If\nyou decline the prompt, Metrics pauses until you refresh it.",{"id":392,"title":393,"titles":394,"content":395,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fadmin-dashboard#why-actions-ask-your-signer","Why actions ask your signer",[49],"The event browser, moderation, and configuration pages call operator APIs\nthat require a fresh signature for each request. Expect a signer approval for\neach query or action. That is why the\nevent browser runs on an explicit\nRun query action and pages 100 events at a time, rather than querying as\nyou type. If your signer isn't available, the page says so rather than showing\nan empty list. The event detail view verifies each event's signature in your browser, over\nthe event exactly as the relay returned it.",{"id":397,"title":398,"titles":399,"content":400,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fadmin-dashboard#reading-the-metrics-page","Reading the metrics page",[49],"The metrics page is the one view that needs no signature. The dashboard's\nserver reads the relay's internal metrics listener, which is not published\noutside the deployment. There is no metrics store. Rates are calculated from samples the page\ntakes while it is open. For history, point Prometheus at the same endpoint.Sampling pauses while the tab is hidden. The status card then reads\nPaused and its refresh icon stops turning. Hover over or focus the icon\nfor the age of the last sample.Counters reset when the relay restarts. The page shows restarted\ninstead of a misleading rate.",{"id":402,"title":403,"titles":404,"content":405,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fadmin-dashboard#theme","Theme",[49],"The dashboard follows your operating system's light or dark preference. The\nsun\u002Fmoon button pins a choice, stored in that browser only.",{"id":407,"title":408,"titles":409,"content":410,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fadmin-dashboard#configuring-it","Configuring it",[49],"The dashboard service needs NUXT_SESSION_PASSWORD, a secret of at least 32\ncharacters that seals the session cookie. It refuses to open sessions without\none. Generate one per deployment, for example with openssl rand -base64 48. Who may sign in comes from the relay: the owner is moderation.admin_pubkey\nin the relay's config.yaml, and administrators are granted through the\nrelay. Since 0.3.0 the dashboard no longer reads NUXT_ADMIN_PUBKEY. If it is\nstill set, the dashboard logs one warning at startup and ignores it. The relay refuses every operator request, including sign-in, unless it knows\nits own public origin. Set auth.relay_url (or moderation.api_origin) on the\nrelay. See moderation. NUXT_RELAY_API_BASE and NUXT_RELAY_METRICS_BASE tell the dashboard where\nthe relay and its metrics listener are. The shipped docker-compose.yml\nalready sets them. See the source repository's README.md for details.",{"id":54,"title":53,"titles":412,"content":413,"level":98},[],"Schema migrations, expiry purging, and verified backup and restore for Nostrfi Relay.",{"id":415,"title":416,"titles":417,"content":418,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fbackup-and-retention#schema-migrations","Schema migrations",[53],"Schema changes are applied at startup by a versioned migration runner, which\nrecords each applied version in a schema_migrations table. If a migration\nfails, the relay stops rather than serving traffic against a half-migrated\ndatabase, and retries the migration on the next start. Migration 6 (0.3.0) deletes data. It removes every stored ephemeral\nevent (kinds 20000–29999, mostly kind 20001 presence heartbeats) and\ntheir tag rows, because the relay no longer stores them. It runs once, on the\nfirst start of a 0.3.0 binary, and logs how many events it removed. The\ndatabase file shrinks after the next checkpoint.To keep those events, back up before upgrading: with the pre-0.3.0\nbinary's -backup, or by copying db\u002Frelay.db while the relay is stopped.\nDon't take this backup with the 0.3.0 binary, because -backup applies\npending migrations first.",{"id":420,"title":421,"titles":422,"content":423,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fbackup-and-retention#retention","Retention",[53],"Expired events (NIP-40) are hidden from reads immediately. A background\nworker deletes them on an interval and then compacts the database: retention:\n  purge_interval_seconds: 3600 # 0 disables the worker Each sweep is logged with the number of events purged. Deletion requests\n(NIP-09) and replaceable-event updates remove the old event and its tag rows\nin one transaction.",{"id":425,"title":426,"titles":427,"content":428,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fbackup-and-retention#backup","Backup",[53],"cd backend\ngo run .\u002Fcmd\u002Frelay -backup \u002Fpath\u002Fto\u002Fbackup-dir This exports the database with DuckDB's native export (Parquet) and writes a\nbackup-manifest.json with the event and tag row counts. It then exits; it\ndoes not start the relay. -backup applies any pending schema migrations before exporting, so a backup\ntaken with a newer binary reflects that binary's migrations, including\ndestructive ones. Administrator grants are part of the database, so they are\nbacked up and restored with it.",{"id":430,"title":431,"titles":432,"content":433,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fbackup-and-retention#restore","Restore",[53],"cd backend\ngo run .\u002Fcmd\u002Frelay -restore \u002Fpath\u002Fto\u002Fbackup-dir Restore imports the backup into a new database, checks the row counts against\nthe manifest, and runs a test query. It fails loudly if either check fails.\nIt refuses to run if the database file already exists, so it never merges\nwith or overwrites a live database.",{"id":435,"title":436,"titles":437,"content":438,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fbackup-and-retention#what-you-are-responsible-for","What you are responsible for",[53],"The relay doesn't schedule backups. Running them on a schedule, storing them\noff the host, rotating them, and choosing a recovery point objective belong\nto your deployment. Recovery time is restart time plus the time -restore takes on your\ndata. Measure it for your own database size.Deleted events remain in older backups until those backups rotate.Backups are not encrypted. Protect them like the live database; see\ntrust and data. html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"id":58,"title":57,"titles":440,"content":441,"level":98},[],"Measured single-instance capacity of Nostrfi Relay, and how much memory and CPU to give it. These numbers come from a shared development sandbox, from single runs. They\nare a baseline, not a guarantee. Measure on your own hardware before relying\non them.",{"id":443,"title":444,"titles":445,"content":446,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fcapacity#sizing","Sizing",[57],"ProcessIdle memoryUnder loadRelay (Go)about 55 MBabout 270 MB peak, settling near 257 MBDashboard (Nuxt)about 97 MBabout 250 MB Size for the loaded figure. Both processes keep their high-water mark:\nDuckDB keeps its buffer pool, and Node's heap doesn't shrink promptly.CPU is the relay's constraint. The full load test kept the relay at\nabout one busy core, mostly NIP-50 search. A dashboard page costs about\n7 ms of CPU. As a floor, the relay, dashboard, and Caddy fit in 1 GB of RAM and\n1 vCPU for a relay under load with a few operators. Plan 2 vCPUs if\nthe dashboard will also see sustained traffic, and 2 GB for headroom.\nThe shipped Compose files set no resource limits; that is a per-deployment\nchoice.",{"id":448,"title":449,"titles":450,"content":451,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fcapacity#measured-throughput","Measured throughput",[57],"Measured with the relay's default configuration: ScenarioResultConnection ramp, 50 connectionsp95 4 ms to the authentication challengeLive delivery, 10 subscribers × 100 eventsp50 0.3 ms, p95 208 msNegentropy full resync, 200 eventsone round trip, about 4 msUnique publishes, 50 connections × 5 events\u002Fs250 events\u002Fs The per-connection publish rate limit (5 events\u002Fs by default) bounded\npublish throughput, not storage. Raising it is a configuration change.",{"id":453,"title":454,"titles":455,"content":456,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fcapacity#search-cost","Search cost",[57],"Search scans the stored content, so its cost grows roughly linearly with the\nnumber of events. With 10 concurrent searchers alongside publishing: Stored eventsSearch p50 \u002F p95Publish throughput during searchabout 7,70084–150 ms \u002F 182–267 ms247 events\u002Fsabout 28,000226–350 ms \u002F 421–559 ms166 events\u002Fs Concurrent search competes with writes: at about 28,000 events it cut publish\nthroughput by a third. The default 5-second search budget is estimated to\nstart binding at a few hundred thousand events, which hasn't been measured\ndirectly.",{"id":458,"title":459,"titles":460,"content":461,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fcapacity#reproducing-it","Reproducing it",[57],"The relay repository includes the load-test tool used for these numbers: cd backend\ngo build -o loadtest .\u002Fcmd\u002Floadtest\n.\u002Floadtest -url ws:\u002F\u002Flocalhost:8080 -json results.json Run .\u002Floadtest -h for the scenario flags.",{"id":463,"title":464,"titles":465,"content":466,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fcapacity#not-yet-measured","Not yet measured",[57],"Repeated runs for variance, and production-class hardwareLong soak tests (memory growth, leaks, degradation over hours)Larger events and tag-heavy payloadsMulti-round Negentropy and search beyond about 28,000 eventsMore than one instance html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"id":62,"title":61,"titles":468,"content":469,"level":98},[],"How to run Nostrfi Relay and its admin dashboard with Docker Compose, configure it, and what production operation adds.",{"id":471,"title":472,"titles":473,"content":474,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fdevelopment-operation#running-it","Running it",[61],"For a step-by-step first run with the dashboard and TLS, follow the\nquickstart. This page is the reference behind it. The repository has two parts: backend\u002F (the Go relay) and frontend\u002F (the\nadmin dashboard). To run the relay alone from source, you need Go 1.25: cd backend\ngo run .\u002Fcmd\u002Frelay It listens on server.listen_addr (default :8080) and opens the DuckDB file\nat storage.db_path (default db\u002Frelay.db, relative to the configuration\nfile). To run the relay and the dashboard together, use Docker Compose. Add the TLS\noverlay to put Caddy in front of both: docker compose -f docker-compose.yml -f docker-compose.tls.yml up -d CI publishes versioned images of both processes to ghcr.io\u002Fnostrfi\u002Frelay\nand ghcr.io\u002Fnostrfi\u002Frelay-dashboard, tagged with the semantic version,\nsha-\u003Cshortsha>, and latest. Rolling back means setting RELAY_VERSION or\nDASHBOARD_VERSION to an earlier tag and recreating the container. See the\nsource repository's README.md, \"Deployment\" section. The relay never terminates TLS itself. That boundary is deliberate; see\ntrust and data.",{"id":476,"title":477,"titles":478,"content":479,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fdevelopment-operation#configuration","Configuration",[61],"backend\u002Fconfig.yaml holds the NIP-11 relay information (name, description,\noperator pubkey, contact, supported NIPs, and limits) plus operational\nsettings: resource limits, NIP-42 binding, WebSocket origin policy,\nmoderation, retention, listeners, and the database path. Set\nRELAY_CONFIG_FILE to load it from somewhere else. The source repository's\nREADME.md, \"Configuration\" section, is the full reference. The relay logs which configuration file it loaded and warns when it found\nnone. It refuses every management and operator API request, and the\ndashboard can't sign anyone in, in two cases: No owner pubkey is configured (moderation.admin_pubkey, or else\nrelay_info.pubkey).The relay doesn't know its own public origin. Set auth.relay_url to the\nrelay's wss:\u002F\u002F URL. The TLS overlay sets it from RELAY_URL in .env.\nUse moderation.api_origin when operator requests are signed for a\ndifferent origin, such as http:\u002F\u002Flocalhost:3000 for the dashboard's\ndevelopment server. The relay logs a warning at startup when neither is\nset. Every advertised limit is enforced on the request path. Set a limit to 0 to\nleave it unenforced.",{"id":481,"title":482,"titles":483,"content":484,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fdevelopment-operation#storage-lifecycle","Storage lifecycle",[61],"Schema changes are applied by a versioned migration runner, and a failed\nmigration stops startup. A background worker purges expired events. -backup\nand -restore export and import the database with a verified manifest. See\nbackup and retention.",{"id":486,"title":487,"titles":488,"content":489,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fdevelopment-operation#logging-and-observability","Logging and observability",[61],"Logs are structured JSON on standard output. \u002Fhealthz reports process\nhealth and \u002Freadyz checks the database. Prometheus \u002Fmetrics is served on a\nseparate internal listener. See observability.",{"id":491,"title":492,"titles":493,"content":494,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fdevelopment-operation#production-readiness-checklist","Production-readiness checklist",[61],"Define public, private, or product-specific relay policy and ownership. Make listener, public relay URL, data path, and shutdown settings explicit. Put authenticated TLS termination in front of the service (through the\ndocumented reverse-proxy overlay; the relay itself never terminates TLS). Enforce message, connection, subscription, filter, event, and time limits. Add connection and publication rate limits plus resource backpressure. Restrict and test the WebSocket origin policy. Add liveness, readiness, metrics, dashboards, and alerting (a provisional\nset; no formal service-level objective yet). Distributed tracing remains open. Establish schema migrations, backup, restore, retention, and purge jobs. Define moderation, abuse response, legal requests, and operator access. Load-test expected event volume, database growth, queries, and fan-out\n(a single-instance sandbox baseline; see capacity and sizing). Threat-model untrusted JSON, large events, connection floods, and metadata\n(see trust and data). Add release packaging, dependency scanning, and a deployment runbook\n(CI runs govulncheck on every build; a finding fails the build). Nostrfi runs the relay in production. There is no formal service-level\nobjective yet, the published capacity numbers come from a development sandbox,\nand the threat model leaves follow-up work open.\nSee current limitations. html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"id":66,"title":65,"titles":496,"content":497,"level":98},[],"How to filter stored events on the admin dashboard's Events page, including tag filters and the tags the relay supports.",{"id":499,"title":373,"titles":500,"content":501,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fevent-browser#what-it-is",[65],"The Events page of the admin dashboard,\nat \u002Fadmin\u002Fdashboard\u002Fevents, lets you look through the events the relay has\nstored. You fill in a filter, run the query, and open any result to see the\nfull event, with its signature checked in your browser. This page describes relay 0.2.0 and later.",{"id":503,"title":504,"titles":505,"content":506,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fevent-browser#the-filters","The filters",[65],"Every field is optional. Leave everything blank to see the newest events. FieldWhat to enterMatchesKindsKind numbers separated by commas, for example 1, 7Events of any of those kindsAuthorA hex pubkey, or at least its first four charactersEvents signed by that keyEvent IDA hex event ID, or at least its first four charactersThat eventContent containsAt least 3 charactersEvents whose content contains the text, ignoring caseFrom \u002F ToA date and time, in your browser's timezoneEvents created in that range, inclusiveTagsOne or more tag rows (see below)Events carrying those tags Author and event ID take hex only, not npub or note strings.",{"id":508,"title":509,"titles":510,"content":511,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fevent-browser#tag-rows","Tag rows",[65],"Each tag row has a tag name, picked from the supported tags,\nand an optional value. Add Tag adds another row.The trash button removes a row.Clear filters empties every field and leaves one empty tag row. A row with no tag name is ignored. A value with no tag name is an error, and\nthe page asks you to choose a tag.",{"id":513,"title":514,"titles":515,"content":516,"level":109},"\u002Fdocs\u002Frelay\u002Foperations\u002Fevent-browser#how-rows-combine","How rows combine",[65,509],"Different tag names must all match. A t row and a client row find\nevents that have both.Rows with the same tag name are alternatives. Two t rows find events\nwith either hashtag. This is how NIP-01 filters treat several values for one\ntag.A value is compared with the tag's first value, exactly, including case.\nFor [\"t\", \"nostr\"] that is nostr.Tags combine with the other fields the same way. Kinds 1 and a t row\nfind kind 1 events with that hashtag.",{"id":518,"title":519,"titles":520,"content":521,"level":109},"\u002Fdocs\u002Frelay\u002Foperations\u002Fevent-browser#leaving-the-value-blank","Leaving the value blank",[65,509],"A row with a blank value matches every event that carries the tag, whatever\nits value. This is the only way to find tags that have no value, such as the\nNIP-70 - tag on protected events. If one row for a tag name is blank, other rows for the same name add nothing:\n\"has a t tag, or has t = nostr\" is just \"has a t tag\".",{"id":523,"title":524,"titles":525,"content":526,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fevent-browser#running-a-query","Running a query",[65],"Nothing runs as you type. Press Run query when the filter is ready. Each query is a call to the relay's operator API, so your signer is asked to\nsign it, once per query. A query returns up to 100 events, newest first.\nLoad more fetches the next 100 and costs another signature. See\nwhy actions ask your signer. Expired events and events banned through moderation are never returned.",{"id":528,"title":529,"titles":530,"content":531,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fevent-browser#examples","Examples",[65],"To findKindsTag rowsNotes published from one client1client = amethystPosts with either of two hashtagst = nostr, and t = relaysEvery protected event- with the value left blankReactions to one event7e = the event's hex IDEverything that mentions a pubkeyp = the hex pubkey Client names in client tags are whatever the client writes, so check the\nexact spelling on one of its events first.",{"id":533,"title":534,"titles":535,"content":536,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fevent-browser#supported-tags","Supported tags",[65],"The relay lets you filter by these tags. It refuses any other name, so the\ntag picker offers only these. TagDescriptionDefined inaReferences an addressable or replaceable eventNIP-01altHuman-readable summary for custom event kindsNIP-31dUnique identifier for addressable eventsNIP-01eReferences another eventNIP-01gGeographic location as a geohashNIP-52hGroup in the relay-based groups systemNIP-29iExternal identities and content identifiersNIP-39, NIP-35, NIP-73pReferences a user's public keyNIP-01qReferences an event in a quote repostNIP-18rankRanking score (0-100) for trusted assertionsNIP-85rReferences a URL or relay addressNIP-24, NIP-65tHashtagNIP-24-Protected event, publishable only by its authorNIP-70clientClient application that published the eventNIP-89emojiCustom emoji used in the contentNIP-30imetaMetadata about media URLs in the contentNIP-92proxySource of the event on another protocolNIP-48zapRecipients of Lightning payments (zaps)NIP-57",{"id":538,"title":539,"titles":540,"content":541,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fevent-browser#limits","Limits",[65],"Older events can't match multi-letter tags. Events stored before the\nrelay kept every event's full tags (schema version 3) were saved with\nsingle-letter tags only, so a client, alt, or other multi-letter row\nnever finds them. See tag fidelity.Multi-letter tag filters are an operator feature. Public REQ\nsubscriptions from Nostr clients still filter stored events by\nsingle-letter tags only, as NIP-01 defines. Only the dashboard and the\noperator events API can filter by tags such as client or -.",{"id":543,"title":544,"titles":545,"content":546,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fevent-browser#the-api-behind-it","The API behind it",[65],"The Events page is a client of the relay's operator events API,\nPOST \u002Fapi\u002Fevents\u002Fquery, which you can also call yourself with a NIP-98\nsignature. Its request fields and responses are documented in the relay's\nREADME.",{"id":70,"title":69,"titles":548,"content":549,"level":98},[],"How the owner and administrators ban pubkeys and events, block IPs, and manage administrator roles through the NIP-86 management API.",{"id":551,"title":552,"titles":553,"content":554,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fmoderation#how-moderation-works","How moderation works",[69],"The relay implements the ban-list and role parts of the\nNIP-86 relay management API.\nRequests are JSON-RPC POST requests to the relay's own URL, with\nContent-Type: application\u002Fnostr+json+rpc, authenticated with a NIP-98\nsignature from the owner's key or an administrator's key. You can call the API from the admin dashboard\nor from any NIP-98-capable tool, such as nak. The dashboard forwards your\nsigned request unchanged, so the relay authorizes it the same way either way.",{"id":556,"title":557,"titles":558,"content":559,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fmoderation#methods","Methods",[69],"MethodEffectbanpubkey \u002F unbanpubkey \u002F listbannedpubkeysRejects future publishes from a pubkey with blocked:. Events it already published stay served unless you ban them separately.banevent \u002F allowevent \u002F listbannedeventsHides an event from REQ results. The row is kept, so allowevent reverses it.blockip \u002F unblockip \u002F listblockedipsRejects new WebSocket connections from an IP address or CIDR range with 403.assignrole \u002F unassignroleGrants or revokes the admin role. Owner only. See administrators.listroleassignmentsLists the owner and every administrator. Owner only. Specific to this relay.whoamiReturns the caller's own pubkey and role. Specific to this relay.supportedmethodsLists the methods above. Allow-list, custom-role (createrole and similar), kind-filter, and\nrelay-metadata methods are not implemented.",{"id":561,"title":203,"titles":562,"content":563,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fmoderation#administrators",[69],"The owner is the key in moderation.admin_pubkey, which defaults to the\nrelay's NIP-11 pubkey. Since 0.3.0 the owner can grant administrator rights\nto other pubkeys, so a team can run a relay without sharing the owner's key.\nAdministrators sign every request with their own key. Operator APIOwnerAdministratorBan-list methods, supportedmethods, whoamiYesYesEvent browse and statistics APIsYesYesassignrole, unassignrole, listroleassignmentsYesNo (403)Configuration APIYesNo (403) An administrator calling an owner-only method gets 403 with\n{\"error\": \"forbidden\", \"reason\": \"owner only\"}. admin is the only role: {\"method\": \"assignrole\", \"params\": [\"\u003C64-char-lowercase-hex-pubkey>\", \"admin\", \"optional label\"]}\n{\"method\": \"unassignrole\", \"params\": [\"\u003C64-char-lowercase-hex-pubkey>\", \"admin\"]} The optional third assignrole parameter is a label of up to 100 characters.\nIt is specific to this relay; NIP-86 defines only the first two. Granting the\nrole again replaces the label. listroleassignments returns the owner first, then each administrator with\nits label, who granted it, and when. whoami returns the caller's own role.\nA key that holds no role gets the usual generic 401, so whoami can't be\nused to find out who the administrators are. Grants are stored in the relay's database, so they survive restarts and are\nincluded in backups. A revocation takes effect on the revoked key's next\nrequest. The owner always comes from configuration and can't be granted,\nrevoked, or removed through the API.",{"id":565,"title":566,"titles":567,"content":568,"level":109},"\u002Fdocs\u002Frelay\u002Foperations\u002Fmoderation#what-an-administrator-can-do","What an administrator can do",[69,203],"Administrators can read every stored event through the event browser,\nincluding encrypted direct messages and gift wraps (as ciphertext only). They\ncan ban any pubkey or event and block any IP range, including the owner's\npubkey or 0.0.0.0\u002F0. Bans and blocks apply to publishing and WebSocket\nconnections, never to the operator APIs, so an administrator can't lock the\nowner out of management. The owner can undo anything an administrator does\nwith the matching unban, allow, or unblock call. Grant the role only to people you would trust with that access.",{"id":570,"title":571,"titles":572,"content":573,"level":109},"\u002Fdocs\u002Frelay\u002Foperations\u002Fmoderation#changing-the-owner-key","Changing the owner key",[69,203],"If you change moderation.admin_pubkey, the new key is the owner from the\nnext start. Administrators granted by the old owner keep their role. The relay logs a\nwarning at start for each one. If you rotated the key because it may have\nbeen compromised, check the list with listroleassignments and\nunassignrole any grant you didn't make.A stored grant for the new owner's own key is deleted at start.",{"id":575,"title":576,"titles":577,"content":578,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fmoderation#authentication","Authentication",[69],"Each request needs an Authorization: Nostr \u003Cbase64> header containing a\nsigned kind 27235 event. Its payload tag must be the SHA-256 of the exact\nrequest body. The relay rejects the request with 401 if the signature,\ntags, or freshness (60 seconds by default) fail, or if the signer is neither\nthe owner nor an administrator. Since 0.3.0, two more checks bind each signature to this relay and to one\nrequest: The u tag must name this relay's origin, not just the right path. The\norigin comes from moderation.api_origin, or else from auth.relay_url\n(wss:\u002F\u002F becomes https:\u002F\u002F). It is read from configuration, not from the\nrequest, so it holds behind a TLS proxy. This stops a malicious website\nfrom getting your signer to sign a request and replaying it at the relay.Each signed event is accepted once. A second use within the freshness\nwindow gets the same 401 as an unknown key. A client that repeats a call\nquickly must vary the event; the dashboard adds a random nonce tag. The\nrecord of used events is kept in memory, so a restart clears it. With neither auth.relay_url nor moderation.api_origin set, the relay logs\na warning at startup and refuses every operator request, including\ndashboard sign-in. Set auth.relay_url to the relay's public wss:\u002F\u002F URL.\nFor local development against the dashboard's dev server, set\nmoderation.api_origin: \"http:\u002F\u002Flocalhost:3000\".",{"id":580,"title":581,"titles":582,"content":583,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fmoderation#validation","Validation",[69],"Pubkeys and event IDs must be 64-character lowercase hex. npub\u002Fnote\nforms, prefixes, and uppercase hex are rejected.IP blocks must be a valid IPv4 or IPv6 address or CIDR range.The optional reason is at most 500 characters and can't be only whitespace. A rejected call stores nothing and returns an {\"error\": \"...\"} response.",{"id":585,"title":586,"titles":587,"content":588,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fmoderation#accountability","Accountability",[69],"Every management call, successful or not, is logged with the method, the\noperator's pubkey and role, the outcome, and, for role changes, the target\npubkey. A successful whoami is not logged, because it changes nothing and\nruns at every dashboard sign-in. Logs never include event content,\nprivate keys, or the raw request body.",{"id":590,"title":539,"titles":591,"content":592,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fmoderation#limits",[69],"Moderation acts on this relay only. It can't stop the same content being\npublished to other relays.IP blocks match the address the relay sees. Behind the documented TLS\nproxy, that is the proxy's address, so IP blocks are not effective there\nyet. See current limitations.Abuse reports go to the contact address in the relay's NIP-11 document and\nare triaged by the operator. html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"id":74,"title":73,"titles":594,"content":595,"level":98},[],"Health and readiness endpoints, Prometheus metrics, and the provisional dashboard and alerts for Nostrfi Relay.",{"id":597,"title":598,"titles":599,"content":600,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fobservability#health-and-readiness","Health and readiness",[73],"\u002Fhealthz returns 200 whenever the process can respond. It checks no\ndependencies.\u002Freadyz returns 200 when the database answers a 2-second ping, and\n503 otherwise. Use it for load-balancer, orchestrator, and container\nhealth checks, and as the primary \"is the relay up\" signal. Both are on the relay's public listener.",{"id":602,"title":603,"titles":604,"content":605,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fobservability#where-metrics-are-served","Where metrics are served",[73],"\u002Fmetrics serves Prometheus-format metrics on a separate listener,\nserver.metrics_listen_addr, which defaults to 127.0.0.1:2112. It is not on\nthe public port and has no authentication, so where it is bound is its access\ncontrol. Docker Compose: the relay binds :2112 inside the container, and the\nport is not published. Attach Prometheus to the Compose network and scrape\nrelay:2112. Never publish it on 0.0.0.0.A binary on a host: the default suits a Prometheus on the same host.\nFor a remote scraper, bind an interface it can reach and firewall it.",{"id":607,"title":608,"titles":609,"content":610,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fobservability#metrics","Metrics",[73],"MetricTypeMeaningrelay_connections_activeGaugeOpen WebSocket connectionsrelay_messages_totalCounterMessages received, by typerelay_rejections_totalCounterRejections, by reasonrelay_subscriptions_activeGaugeActive REQ subscriptionsrelay_query_duration_secondsHistogramQuery duration, by query (req or negentropy)relay_events_stored_totalCounterEvents stored. Ephemeral events are not counted.relay_save_failures_totalCounterEvent save failuresrelay_events_ephemeral_totalCounterEphemeral events (kinds 20000–29999) accepted and broadcast without being stored. Added in 0.3.0. The type and reason labels are bounded to known values, so clients can't\ninflate cardinality. No metric includes event content or pubkeys. The\nstandard Go runtime and process metrics are served too. The admin dashboard shows these\nmetrics live, without storing them.",{"id":612,"title":613,"titles":614,"content":615,"level":103},"\u002Fdocs\u002Frelay\u002Foperations\u002Fobservability#provisional-dashboard-and-alerts","Provisional dashboard and alerts",[73],"There is no approved service-level objective yet, so these are a\nconservative starting point, not targets. Dashboard panels: connections, message rate by type, rejection rate by\nreason, subscriptions, p95 query latency, storage growth with save failures,\nand readiness. Alerts: Relay down: \u002Freadyz failing for more than 2 minutes.Save failures: any sustained non-zero rate for 5 minutes.Elevated rejection rate and query latency: thresholds deliberately\nunset. Choose them after observing normal traffic. Distributed tracing is not implemented.",{"id":83,"title":82,"titles":617,"content":618,"level":98},[],"Which Nostr NIPs Nostrfi Relay implements, its resource limits and search behaviour, client compatibility, and the limits of that evidence.",{"id":620,"title":621,"titles":622,"content":623,"level":103},"\u002Fdocs\u002Frelay\u002Freference\u002Fprotocol-support#advertised-nips","Advertised NIPs",[82],"The relay advertises NIPs 1, 2, 9, 11, 17, 22, 28, 40, 42, 50, 70, 71, 77, 86, 98\nin its default configuration. \"Covered\" below means a relevant automated\nintegration test exists and passed at the reviewed revision; it does not imply\nexhaustive conformance to every requirement in that NIP. NIPImplemented behavior observedEvidence and qualification01Signed event publication; OK; REQ; EVENT; EOSE; CLOSE; live matching; common filters; ephemeral events (kinds 20000–29999) delivered to open subscriptions and never storedCovered. Ephemeral events pass every publish check, then get OK true and are broadcast without being saved. Because they skip the database's duplicate check, the same ephemeral event sent twice is broadcast twice. ids and authors filters support prefix matching in both stored queries and live delivery. Tags round-trip exactly through storage, including multi-field and multi-letter tags. Message grammar, malformed input, duplicate events, and concurrent subscriptions have integration tests.02Kind 3 contact lists use replaceable-event behaviorCovered for replacement of an older list.09Kind 5 requests delete same-author targets addressed by e or a; the deletion request remains storedCovered. Tag rows are removed in the same transaction as the event. No tombstone prevents later re-publication.11HTTP relay information document with CORS headers and configurable metadata and limitationsCovered. Every non-zero advertised limit is enforced on the request path. See resource limits.17Kind 10050 storage and authenticated access control for kind 1059 gift wrapsCovered for recipient access and unauthenticated denial. The event author can also read the gift wrap; that policy is still under review.22Kind 1111 comments and upper\u002Flower-case indexed tag filteringCovered for storing and finding a comment by E and e.28Kinds 40–44; latest kind 41 retained per referenced channelCovered. Channel moderation events are stored but not enforced as access policy.40Expiration stored; expired records omitted from queries; already-expired events rejectedCovered. Expired rows are hidden immediately and purged by a background worker.42Challenge on connection and signed kind 22242 authenticationCovered. The relay tag is matched against the configured relay URL, and stale authentication events are rejected, when the operator configures them. A kind 22242 event sent as EVENT is refused with invalid: and never broadcast or stored.50search filter over event content, combined with the rest of the filterCovered. Case-insensitive substring matching, not ranked full-text search. See search.70--tagged events require authentication as the event authorCovered for unauthenticated, matching-author, and different-author publication.71Kinds 21 and 34235 stored and queried; addressable replacement for kind 34235Covered. Media is not hosted or validated by the relay.77NEG-OPEN, NEG-MSG, NEG-CLOSE, NEG-ERR; reconciliation over timestamp\u002FID vectorsCovered, including a 200-event full resync in the capacity baseline. Sessions are connection-local and held in memory.86Relay management API: pubkey bans, event bans, IP\u002FCIDR blocks, supportedmethods, and assignrole\u002Funassignrole for the single admin role; relay-specific listroleassignments and whoamiCovered by integration tests against a running relay. Allow-list, custom-role, kind-filter, and relay-metadata methods are not implemented. See moderation.98HTTP Auth (kind 27235)Used only to authenticate management and operator API requests. The u tag's origin must match the relay's configured origin, and each event is accepted once. Exercised by every test that calls those APIs. Kind 27235 is in the ephemeral range, so one sent as EVENT is broadcast but not stored.",{"id":625,"title":626,"titles":627,"content":628,"level":103},"\u002Fdocs\u002Frelay\u002Freference\u002Fprotocol-support#resource-limits","Resource limits",[82],"Every field in the NIP-11 limitation block is enforced, not just advertised:\nmessage size, subscription and filter counts, subscription ID length,\nlimit clamping, content length, tag count, created_at bounds, and\nproof-of-work difficulty. The relay also applies limits that NIP-11 does not\ndescribe: a total connection cap and per-connection rate limits for messages\nand for published events. Rejections use stable, machine-readable prefixes (invalid:, restricted:,\nrate-limited:, auth-required:, pow:, blocked:, error:). A rejected\nREQ receives CLOSED; a rejected EVENT receives OK false.",{"id":630,"title":631,"titles":632,"content":633,"level":103},"\u002Fdocs\u002Frelay\u002Freference\u002Fprotocol-support#search","Search",[82],"NIP-50 search is a case-insensitive substring match over event content. It\nis not ranked full-text search: Results are ordered by where the term first appears, then by shorter\ncontent, then newest — a deliberately narrow definition of \"quality\".Multi-word terms match literally, so best nostr apps does not find\n\"best apps for nostr\".key:value extensions are accepted and ignored.A term shorter than three characters, or a query made only of extensions,\nis refused with CLOSED and an invalid: reason.A search with no limit receives the advertised max_limit.Each search has a work budget (5 seconds by default). A search that exceeds\nit is cancelled with CLOSED error: search timed out.Live subscriptions keep applying the term after EOSE. Negentropy ignores it. Search cost grows roughly linearly with the number of stored events, because\nno index can answer a substring query. See\ncapacity and sizing.",{"id":635,"title":636,"titles":637,"content":638,"level":103},"\u002Fdocs\u002Frelay\u002Freference\u002Fprotocol-support#general-event-semantics","General event semantics",[82],"Kinds 0, 3, and 10000–19999 are replaceable by author and kind.Kinds 30000–39999 are parameterized replaceable by author, kind, and d tag.Kind 41 is replaced per referenced channel, keyed by its e tag.Single-letter tags are indexed for # filters. The full, ordered tag array\nof every event is stored and returned regardless of indexing.Results exclude expired events and are ordered newest first, except for\nNegentropy reads (oldest first) and searches (ordered as above).Multiple filters in one REQ are queried independently, and duplicate\nevents are suppressed in the initial response.",{"id":640,"title":345,"titles":641,"content":642,"level":103},"\u002Fdocs\u002Frelay\u002Freference\u002Fprotocol-support#client-compatibility",[82],"Client or SDKResultnostr-tools v2.24.1 (JavaScript)Verified 2026-08-11: connect, publish, subscribe, and exact tag round-trip.NDK, nakNot yet tested.Damus, Amethyst, Coracle, SnortNot yet tested; they need manual QA or browser automation. \"Not yet tested\" means no run has happened, not that a run failed.",{"id":644,"title":645,"titles":646,"content":647,"level":103},"\u002Fdocs\u002Frelay\u002Freference\u002Fprotocol-support#conformance-work-still-needed","Conformance work still needed",[82],"Decide and document gift-wrap read, retention, and operator-access policy.Test against NDK and nak, then the native and web clients.Audit each NIP's specification text line by line against a pinned NIPs\nrevision. The checks so far verified the relay's behavior against its own\nsource and tests.",{"id":92,"title":91,"titles":649,"content":650,"level":98},[],"What data and metadata a Nostr relay operator can observe, the Nostrfi Relay threat model, authentication limits, and moderation. The relay's intended operating model is a public reusable relay, so the trust\nboundaries below apply to any connecting client or user, not only to Nostrfi's\nown products or team.",{"id":652,"title":653,"titles":654,"content":655,"level":103},"\u002Fdocs\u002Frelay\u002Fsecurity\u002Ftrust-and-data#data-and-trust-boundaries","Data and trust boundaries",[91],"Event signatures are verified before storage; the relay does not hold user\nsigning keys.DuckDB contains event envelopes and content and must be treated as user data.Gift-wrap content may be encrypted, but its event envelope and recipient tag\nremain visible to the operator.Ephemeral events (kinds 20000–29999, such as presence heartbeats,\ntyping indicators, and NIP-46 signer traffic) are delivered to open\nsubscriptions and never written to the database or its backups. Ephemeral\nevents stored by releases before 0.3.0 are deleted on upgrade, but copies\nremain in older backups until those rotate.Authentication and subscription authorization live only in process memory.The application provides no TLS; a production deployment needs a trusted edge\nor equivalent transport termination. A documented, exercised\nTLS-terminating reverse-proxy overlay is available for this.Logs include authenticated public keys, but never the raw Negentropy\nmessage payload (only the subscription ID) — that hex vector is\nhigh-volume reconciliation metadata, not something worth logging at\nInfo level.",{"id":657,"title":658,"titles":659,"content":660,"level":103},"\u002Fdocs\u002Frelay\u002Fsecurity\u002Ftrust-and-data#what-an-operator-can-observe","What an operator can observe",[91],"The relay operator can observe: Connection metadata (IP address, timing, connection duration).All published event envelopes, including event content, author pubkey,\ntimestamps, signatures, and tag values.Gift-wrap metadata and ciphertext (kind 1059 events are access-controlled in\nthe application but exist unencrypted at the database-envelope level).Authenticated public keys after NIP-42 authentication.Subscription filters and query patterns.Negentropy reconciliation messages. The relay does not require users' private keys. It does, however, store public\nevent content and metadata. Operators should treat all stored data and\nconnection metadata as observable.",{"id":662,"title":663,"titles":664,"content":665,"level":103},"\u002Fdocs\u002Frelay\u002Fsecurity\u002Ftrust-and-data#threat-model","Threat model",[91],"A written threat model covers the relay's public reusable operating model:\nresource exhaustion, hostile events, WebSocket origins, metadata disclosure,\nmoderation, database access, retention, deletion, logging, and abuse response.\nIt enumerates assets and trust boundaries, and maps every identified threat to\nan implemented mitigation, a tracked gap, a follow-up ticket, or an explicitly\naccepted residual risk. The full threat model is in the relay's source\nrepository as\ndocs\u002Fthreat-model.md,\nwhere it is maintained alongside the code it describes. Risks the threat model explicitly accepts rather than mitigates include: no\nencryption at rest for stored events, gift-wrap envelopes, or backups\n(host-access restriction is the compensating control); operator-observable\nconnection metadata and query patterns; no payment or proof-of-work admission\ngate; and development-mode defaults (open origins, presence-only\nauthentication checks) that are unsuitable for internet-facing deployments.",{"id":667,"title":668,"titles":669,"content":670,"level":103},"\u002Fdocs\u002Frelay\u002Fsecurity\u002Ftrust-and-data#authentication-limitations","Authentication limitations",[91],"Authentication validates the event signature and challenge. The supplied\nrelay tag's value is matched against the operator's configured canonical\nrelay URL, and the authentication event's freshness is checked, when the\noperator has configured them — left unconfigured, only the tag's presence is\nchecked (the historical, development-friendly default). Authentication\nsessions are not durable across connections.",{"id":672,"title":673,"titles":674,"content":675,"level":103},"\u002Fdocs\u002Frelay\u002Fsecurity\u002Ftrust-and-data#websocket-origin-policy","WebSocket origin policy",[91],"Origin restriction is configurable. The default development mode accepts\nevery origin, which suits a public relay that serves arbitrary web clients.\nIt logs a warning when it binds a public interface directly. Production mode\nrequires an allow-list and rejects browser connections from unlisted origins.\nConnections that send no Origin header, such as CLI tools and relay-to-relay\nsync, are admitted in both modes. Origin checks restrict honest browsers only;\nthey are not an access control.",{"id":677,"title":69,"titles":678,"content":679,"level":103},"\u002Fdocs\u002Frelay\u002Fsecurity\u002Ftrust-and-data#moderation",[91],"The operator can remove or hide a specific published event from being\nserved, and can block a pubkey from publishing or a connection source (IP or\nCIDR range) from connecting — independent of the same-author deletion any\nNostr user can already request. These actions: Are authenticated to the owner's key or an administrator's key, not any\nconnecting client's. Each signature must name this relay's origin and is\naccepted once, so a signature made for another website can't be replayed\nhere.Are logged for accountability.Act on this relay's storage and serving only — they do not, and cannot,\nprevent the same content from being published to other relays.For a pubkey ban specifically: block that pubkey's future publishes only.\nContent the pubkey already published before the ban remains served unless\nseparately hidden. Administrators are trusted with a lot: they can read every stored event,\nincluding gift-wrap ciphertext, and ban or block anything. They can't lock the\nowner out of the operator APIs, and the owner can undo their actions. See\nadministrators. Moderation is available from the admin dashboard\nor any NIP-98-capable tool. See moderation\nfor the methods and their limits. Abuse reports are received at the contact address published in this relay's\nNIP-11 relay information document and triaged by the operator.",{"id":681,"title":53,"audience":682,"badge":683,"body":684,"category":885,"description":413,"draft":25,"extension":886,"lastReviewed":887,"meta":888,"navigation":889,"owner":890,"path":54,"prerequisites":683,"product":891,"seo":892,"sitemap":893,"stem":55,"version":683,"__hash__":894},"docs\u002Fdocs\u002Frelay\u002Foperations\u002Fbackup-and-retention.md","operators",null,{"type":685,"value":686,"toc":878},"minimark",[687,691,700,741,744,747,782,785,788,805,812,817,820,834,837,840,843,874],[688,689,416],"h2",{"id":690},"schema-migrations",[692,693,694,695,699],"p",{},"Schema changes are applied at startup by a versioned migration runner, which\nrecords each applied version in a ",[696,697,698],"code",{},"schema_migrations"," table. If a migration\nfails, the relay stops rather than serving traffic against a half-migrated\ndatabase, and retries the migration on the next start.",[701,702,704,723],"callout",{"type":703},"warning",[692,705,706,710,711,714,715,718,719,722],{},[707,708,709],"strong",{},"Migration 6 (0.3.0) deletes data."," It removes every stored ephemeral\nevent (kinds ",[696,712,713],{},"20000","–",[696,716,717],{},"29999",", mostly kind ",[696,720,721],{},"20001"," presence heartbeats) and\ntheir tag rows, because the relay no longer stores them. It runs once, on the\nfirst start of a 0.3.0 binary, and logs how many events it removed. The\ndatabase file shrinks after the next checkpoint.",[692,724,725,726,729,730,733,734,737,738,740],{},"To keep those events, back up ",[707,727,728],{},"before"," upgrading: with the pre-0.3.0\nbinary's ",[696,731,732],{},"-backup",", or by copying ",[696,735,736],{},"db\u002Frelay.db"," while the relay is stopped.\nDon't take this backup with the 0.3.0 binary, because ",[696,739,732],{}," applies\npending migrations first.",[688,742,421],{"id":743},"retention",[692,745,746],{},"Expired events (NIP-40) are hidden from reads immediately. A background\nworker deletes them on an interval and then compacts the database:",[748,749,753],"pre",{"className":750,"code":751,"language":752,"meta":172,"style":172},"language-yaml shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","retention:\n  purge_interval_seconds: 3600 # 0 disables the worker\n","yaml",[696,754,755,766],{"__ignoreMap":172},[756,757,759,762],"span",{"class":758,"line":98},"line",[756,760,743],{"class":761},"swJcz",[756,763,765],{"class":764},"sMK4o",":\n",[756,767,768,771,774,778],{"class":758,"line":103},[756,769,770],{"class":761},"  purge_interval_seconds",[756,772,773],{"class":764},":",[756,775,777],{"class":776},"sbssI"," 3600",[756,779,781],{"class":780},"sHwdD"," # 0 disables the worker\n",[692,783,784],{},"Each sweep is logged with the number of events purged. Deletion requests\n(NIP-09) and replaceable-event updates remove the old event and its tag rows\nin one transaction.",[688,786,426],{"id":787},"backup",[748,789,793],{"className":790,"code":791,"language":792,"meta":172,"style":172},"language-sh shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","cd backend\ngo run .\u002Fcmd\u002Frelay -backup \u002Fpath\u002Fto\u002Fbackup-dir\n","sh",[696,794,795,800],{"__ignoreMap":172},[756,796,797],{"class":758,"line":98},[756,798,799],{},"cd backend\n",[756,801,802],{"class":758,"line":103},[756,803,804],{},"go run .\u002Fcmd\u002Frelay -backup \u002Fpath\u002Fto\u002Fbackup-dir\n",[692,806,807,808,811],{},"This exports the database with DuckDB's native export (Parquet) and writes a\n",[696,809,810],{},"backup-manifest.json"," with the event and tag row counts. It then exits; it\ndoes not start the relay.",[692,813,814,816],{},[696,815,732],{}," applies any pending schema migrations before exporting, so a backup\ntaken with a newer binary reflects that binary's migrations, including\ndestructive ones. Administrator grants are part of the database, so they are\nbacked up and restored with it.",[688,818,431],{"id":819},"restore",[748,821,823],{"className":790,"code":822,"language":792,"meta":172,"style":172},"cd backend\ngo run .\u002Fcmd\u002Frelay -restore \u002Fpath\u002Fto\u002Fbackup-dir\n",[696,824,825,829],{"__ignoreMap":172},[756,826,827],{"class":758,"line":98},[756,828,799],{},[756,830,831],{"class":758,"line":103},[756,832,833],{},"go run .\u002Fcmd\u002Frelay -restore \u002Fpath\u002Fto\u002Fbackup-dir\n",[692,835,836],{},"Restore imports the backup into a new database, checks the row counts against\nthe manifest, and runs a test query. It fails loudly if either check fails.\nIt refuses to run if the database file already exists, so it never merges\nwith or overwrites a live database.",[688,838,436],{"id":839},"what-you-are-responsible-for",[692,841,842],{},"The relay doesn't schedule backups. Running them on a schedule, storing them\noff the host, rotating them, and choosing a recovery point objective belong\nto your deployment.",[844,845,846,857,863],"ul",{},[847,848,849,852,853,856],"li",{},[707,850,851],{},"Recovery time"," is restart time plus the time ",[696,854,855],{},"-restore"," takes on your\ndata. Measure it for your own database size.",[847,858,859,862],{},[707,860,861],{},"Deleted events"," remain in older backups until those backups rotate.",[847,864,865,868,869,873],{},[707,866,867],{},"Backups are not encrypted."," Protect them like the live database; see\n",[870,871,872],"a",{"href":92},"trust and data",".",[875,876,877],"style",{},"html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":172,"searchDepth":103,"depth":103,"links":879},[880,881,882,883,884],{"id":690,"depth":103,"text":416},{"id":743,"depth":103,"text":421},{"id":787,"depth":103,"text":426},{"id":819,"depth":103,"text":431},{"id":839,"depth":103,"text":436},"operations","md","2026-11-16",{},true,"Nostrfi","relay",{"title":53,"description":413},{"loc":54},"E2MdGvjV3H5J8jrsMwtOktuR5lTo6uDbwz1sQPiqSyE",[896],{"title":5,"path":6,"stem":7,"children":897},[898,899],{"title":5,"path":6,"stem":7},{"title":11,"path":12,"stem":13,"children":900},[901,902,905,906,909,910,919,922],{"title":11,"path":12,"stem":13},{"title":17,"path":18,"stem":19,"children":903,"page":25},[904],{"title":22,"path":23,"stem":24},{"title":27,"path":28,"stem":29},{"title":31,"path":32,"stem":33,"children":907,"page":25},[908],{"title":36,"path":37,"stem":38},{"title":40,"path":41,"stem":42},{"title":44,"path":45,"stem":46,"children":911,"page":25},[912,913,914,915,916,917,918],{"title":49,"path":50,"stem":51},{"title":53,"path":54,"stem":55},{"title":57,"path":58,"stem":59},{"title":61,"path":62,"stem":63},{"title":65,"path":66,"stem":67},{"title":69,"path":70,"stem":71},{"title":73,"path":74,"stem":75},{"title":77,"path":78,"stem":79,"children":920,"page":25},[921],{"title":82,"path":83,"stem":84},{"title":86,"path":87,"stem":88,"children":923,"page":25},[924],{"title":91,"path":92,"stem":93},[926,927],{"title":49,"path":50,"stem":51,"description":370,"children":-1},{"title":57,"path":58,"stem":59,"description":928,"children":-1},"Measured single-instance capacity of Nostrfi Relay, and how much memory and CPU to give it.",1794954746097]