Konfigurationsreferenz

Grundlagen

Die Konfiguration ist eine TOML-Datei, standardmäßig nostrfy.toml genannt. Erstellen Sie sie mit init:

nostrfy --config nostrfy.toml init

Validieren Sie sie (vor jedem Start empfohlen):

nostrfy --config nostrfy.toml check

Jeder Befehl akzeptiert --config <path> (Standard nostrfy.toml).

Allgemeine Syntax:

[section]
key = "string"
key = 8080
key = [1, 2]
key = true

Konfigurationsabschnitte

Jeder Schlüssel ist optional; ein fehlender Schlüssel verwendet seinen Standardwert.

Abschnitt [relay] — Relay-Identität

Details zu Schlüsseln

• private_key — der eigene geheime Schlüssel des Relays, verwendet zum Signieren Relay-generierter Events: NIP-29-Gruppenmetadaten (39000–39005) und NIP-43-Rollen-/Mitgliedschafts-Events. Generieren Sie ihn mit nostrfy genkey; halten Sie ihn geheim. Er wird einmal beim Start gelesen, daher erfordert eine Änderung einen Neustart.
• public_url — wird zur Validierung URL-tragender Tags von Clients verwendet: NIP-42-AUTH, NIP-62-Vanish und NIP-98-Admin-Auth. Wenn leer, fällt das Relay auf host:port zurück, was niemals mit einer echten Client-URL übereinstimmt, wenn 0.0.0.0 oder 127.0.0.1 gebunden ist (eine Warnung wird geloggt). Immer setzen.
• enabled_nips vs disabled_nips — die Allowlist gewinnt: wenn enabled_nips nicht leer ist, werden nur deren NIPs beworben und disabled_nips wird ignoriert. Beides erfordert einen Neustart.
• reject_ephemeral — Kinds 20000–29999 werden abgelehnt, aber die ausgenommenen Kinds, die laut NIPs weitergeleitet werden müssen, werden weiterhin weitergeleitet: 22242, 27235, 28934/28935/28936, 24133, 23194/23195, 24242 und 21059. Gilt bei SIGHUP.
• enabled_git — Opt-in für NIP-34: akzeptiert Kinds 1617–1633 und 30617/30618 und bewirbt NIP-34. Standardmäßig aus, da Patch-Payloads groß sein können. Gilt bei SIGHUP.

Abschnitt [server] — Servereinstellungen

Details zu Schlüsseln

• host — 0.0.0.0 bindet alle IPv4-Schnittstellen; 127.0.0.1 ist nur lokal.
• port — 1–65535; Port 80 erfordert Root. Dieser eine Port bedient gemeinsam das WebSocket-Relay, das NIP-11-Dokument, die REST-API und die NIP-86-RPC.
• api_host — widmet die REST-API einem einzigen Hostnamen, sodass sich API und Relay einen Port hinter einem Reverse-Proxy teilen können. Beim Start fixiert — erfordert einen Neustart.
• ws_paths — root bedient nur /, inbox-outbox bedient nur /inbox und /outbox, all bedient beides. Beim Start fixiert — erfordert einen Neustart.
• trusted_proxies — listen Sie nur die eigenen Adressen des Proxys auf (Loopback für nginx/Caddy auf demselben Host, Quellbereich des Load-Balancers in der Cloud). Wenn gesetzt, wird die Client-IP aus dem letzten nicht vertrauenswürdigen X-Forwarded-For-Eintrag abgeleitet für die Pro-IP-Begrenzungen, das Ratenlimit, blockip und die Logs. Fügen Sie niemals eine Adresse hinzu, die Clients direkt erreichen können — sie könnten den Header fälschen und die Pro-IP-Limits umgehen. Beim Start fixiert — erfordert einen Neustart.

Abschnitt [rpc] — NIP-86-Verwaltung

Die NIP-86-RPC ist auf den öffentlichen POST /-Routen des Relays eingebunden — es gibt keinen separaten Verwaltungsport. management_token und admin_pubkey erscheinen in alten Anleitungen manchmal unter [server]; diese Schreibweisen sind veraltete Aliase dieser [rpc]-Schlüssel.

Abschnitt [limits] — Limits und Schutzmaßnahmen

Verbindungen und Nachrichten

Abonnements und Abfragen

Events

Veraltete Aliase: limits.require_pow, limits.new_pubkey_min_age_secs und limits.max_indexed_words werden weiterhin als Aliase von relay.require_pow, relay.new_pubkey_min_age_secs und database.max_indexed_words akzeptiert.

REST-API

Live-Fan-out

Abschnitt [database] — Datenbank

Details zu Schlüsseln

• map_size — die Untergrenze für die Memory-Map: die Map wird immer mindestens so groß geöffnet.
• max_map_size — die Obergrenze, geöffnet als spärliche virtuelle Reservierung: physischer Speicher wächst nur mit den tatsächlich geschriebenen Daten. Erhöhen Sie sie bei database map is full.
• search_index = false — die Suche funktioniert weiterhin (Ganzwortsuche im Inhalt), aber Scans werden langsamer; auf einem winzigen VPS halbiert es die Datenbank. Für kleine Instanzen empfohlen.
• disabled_fsync — tauscht Haltbarkeit gegen Durchsatz: Schreibvorgänge landen im OS-Page-Cache und bei Stromausfall können die neuesten Schreibvorgänge verloren gehen.

Abschnitt [daemon] — Daemon

Pfade werden relativ zum Verzeichnis der Konfigurationsdatei aufgelöst, sodass sie gültig bleiben, nachdem der Daemon sein Arbeitsverzeichnis wechselt.

Abschnitt [access] — Zugriffskontrolle

Die Pubkey-Allow-/Deny-Listen sind keine Konfigurationsschlüssel — sie leben in der Relay-Datenbank (LMDB) und werden zur Laufzeit verwaltet:

nostrfy relay allow npub1...
nostrfy relay deny npub1...
nostrfy relay list

• restrict_relay = true — nur die allow-gelisteten Pubkeys dürfen veröffentlichen, während das Lesen für alle offen bleibt (jeder Client kann weiterhin abonnieren und abrufen).
• Ein denied Pubkey wird beim Veröffentlichen immer abgewiesen und beim Lesen nie bedient.
• method_grants — NIP-86-Methodengrants für Nicht-Admin-Pubkeys (Pubkey → Methodennamen, z. B. ein Moderator mit banevent und listbannedevents). Beim ersten Start aus der Konfiguration initialisiert, dann zur Laufzeit mit NIP-86 assignmethod/unassignmethod verwaltet (prüfbar mit listmethodassignees). Nur Moderations- und Lesemethoden sind übertragbar — Berechtigungs-, Rollen-, Invite-Claim- und Relay-Identitätsverwaltung bleiben Admin-only, und ein gebannter Pubkey wird auch mit Grants abgewiesen. Siehe die Verwaltungs-API.

Abschnitt [blossom] — Blossom-Dateiserver

Neuladen zur Laufzeit (SIGHUP)

Das Bearbeiten der Datei und Senden von kill -HUP $(cat nostrfy.pid) lädt die Konfiguration ohne Neustart neu. Die meisten Einstellungen wirken sofort; einige sind beim Start fixiert:

[access] wird durch ein Neuladen nicht angewendet — die Listen werden einmal beim Start initialisiert und dann zur Laufzeit per NIP-86 verwaltet. Das Log warnt, wenn sich eine neustartpflichtige Einstellung geändert hat, und einige beim Start erfasste Einstellungen werden beim Neuladen nicht geprüft.