Guida all’avvio rapido

1. Creare una configurazione

nostrfy init scrive un file nostrfy.toml predefinito e completamente commentato:

nostrfy --config nostrfy.toml init

Aprilo in un editor di testo e regolalo — ogni opzione è commentata.

2. Convalidare la configurazione

nostrfy check è fortemente consigliato prima dell’avvio; se qualcosa non va, indica esattamente cosa.

nostrfy --config nostrfy.toml check

3. Avviare il relay

nostrfy --config nostrfy.toml start

Viene eseguito come demone. Aggiungi --foreground per restare nel terminale.

Poi verifica che il relay sia attivo tramite /health per il controllo dello stato:

curl http://127.0.0.1:8080/health

=> {"status":"ok"}

4. Puntare un client

Sulla stessa macchina, connettiti a ws://<host>:8080. L’host predefinito è 127.0.0.1, che accetta solo connessioni locali. Per raggiungere il relay da altre macchine, imposta nella configurazione server.host = "0.0.0.0":

[server]
host = "0.0.0.0"

Per wss:// serve un proxy che termini il TLS (nginx o Caddy) davanti — vedi la documentazione sulla distribuzione.

5. Arresto e riavvio

nostrfy --config nostrfy.toml stop
nostrfy --config nostrfy.toml restart
kill -HUP $(cat nostrfy.pid)  # ricarica la configurazione senza riavvio

restart rilegge la configurazione; SIGHUP ricarica la maggior parte delle impostazioni senza riavvio.

Gestione efficace

• nostrfy stats mostra statistiche in tempo reale — anche via HTTP su /relay/stats e /metrics.
• Il log viene scritto in daemon.log_file e viene ruotato automaticamente.
• RUST_LOG controlla il livello di log (ad esempio, RUST_LOG=nostrfy=debug).