Guide de démarrage rapide

1. Créer une configuration

nostrfy init écrit un nostrfy.toml par défaut entièrement commenté :

nostrfy --config nostrfy.toml init

Ouvrez-le dans un éditeur de texte et ajustez-le — chaque option est commentée.

2. Valider la configuration

nostrfy check est fortement recommandé avant de démarrer ; en cas de problème, il indique précisément quoi corriger.

nostrfy --config nostrfy.toml check

3. Démarrer le relais

nostrfy --config nostrfy.toml start

S’exécute comme démon. Ajoutez --foreground pour rester dans le terminal.

Vérifiez ensuite que le relais est en marche avec le contrôle de santé :

curl http://127.0.0.1:8080/health

=> {"status":"ok"}

4. Pointer un client vers lui

Sur la même machine, connectez-vous à ws://<host>:8080. L’hôte par défaut est 127.0.0.1, qui n’accepte que les connexions locales. Pour joindre le relais depuis d’autres machines, définissez dans la configuration server.host = "0.0.0.0" :

[server]
host = "0.0.0.0"

Pour wss://, il faut un proxy terminant le TLS (nginx ou Caddy) devant — voir la documentation sur le déploiement.

5. Arrêt et redémarrage

nostrfy --config nostrfy.toml stop
nostrfy --config nostrfy.toml restart
kill -HUP $(cat nostrfy.pid)  # rechargez la configuration sans redémarrage

restart relit la configuration ; SIGHUP recharge la plupart des réglages sans redémarrage.

Exploitation efficace

• nostrfy stats affiche les statistiques en direct — aussi via HTTP à /relay/stats et /metrics.
• Le journal est écrit dans daemon.log_file avec rotation automatique.
• RUST_LOG contrôle le niveau de journalisation (par ex. RUST_LOG=nostrfy=debug).