Schnellstartanleitung

Von der Installation zum laufenden Nostr-Relay in Minuten: Konfiguration schreiben, validieren, Daemon starten und den ersten Health-Check ausführen.

1. Konfiguration erstellen

nostrfy init schreibt eine standardmäßige, vollständig kommentierte nostrfy.toml:

sh
nostrfy --config nostrfy.toml init

Öffnen Sie sie in einem Texteditor und passen Sie sie an — jede Option ist kommentiert.

2. Konfiguration validieren

nostrfy check wird vor dem Start dringend empfohlen; bei Problemen meldet er genau, was falsch ist.

sh
nostrfy --config nostrfy.toml check

3. Relay starten

sh
nostrfy --config nostrfy.toml start

Läuft als Daemon. Mit --foreground im Terminal.

Prüfen Sie dann mit dem Health-Endpunkt, ob das Relay läuft:

sh
curl http://127.0.0.1:8080/health

=> {"status":"ok"}

4. Client verbinden

Verbinden Sie sich auf derselben Maschine mit ws://<host>:8080. Der Standard-Host ist 127.0.0.1, der nur lokale Verbindungen akzeptiert. Um das Relay von anderen Maschinen zu erreichen, setzen Sie in der Konfiguration server.host = "0.0.0.0":

toml
[server]
host = "0.0.0.0"

Für wss:// benötigen Sie einen TLS-terminierenden Proxy (nginx oder Caddy) davor — siehe die Bereitstellungs-Dokumentation.

5. Stoppen und neu starten

sh
nostrfy --config nostrfy.toml stop
nostrfy --config nostrfy.toml restart
kill -HUP $(cat nostrfy.pid)  # Konfiguration ohne Neustart neu laden

restart liest die Konfiguration neu ein; SIGHUP lädt die meisten Einstellungen ohne Neustart neu.

Effektiver Betrieb

  • nostrfy stats zeigt Live-Statistiken — auch über HTTP unter /relay/stats und /metrics.
  • Das Log wird nach daemon.log_file geschrieben und automatisch rotiert.
  • RUST_LOG steuert die Log-Stufe (z. B. RUST_LOG=nostrfy=debug).
Externe Clients können sich nicht verbinden?
server.host ist standardmäßig 127.0.0.1. Setzen Sie server.host = "0.0.0.0" und starten Sie neu.
Weiter
In der Konfigurationsreferenz können Sie jeden Aspekt des Relays abstimmen.