Guia de início rápido

1. Criar uma configuração

nostrfy init grava um nostrfy.toml padrão:

nostrfy --config nostrfy.toml init

Abra o arquivo em um editor de texto e ajuste — cada opção é comentada.

2. Validar a configuração

nostrfy check é fortemente recomendado antes de iniciar; se algo estiver errado, ele indica exatamente o quê.

nostrfy --config nostrfy.toml check

3. Iniciar o relay

nostrfy --config nostrfy.toml start

Roda como daemon. Adicione --foreground para rodar no terminal.

Depois verifique se o relay está no ar com o endpoint de saúde:

curl http://127.0.0.1:8080/health

=> {"status":"ok"}

4. Apontar um cliente

Na mesma máquina, conecte-se a ws://<host>:8080. O host padrão é 127.0.0.1, que aceita apenas conexões locais. Para acessar o relay de outras máquinas, defina na configuração server.host = "0.0.0.0":

[server]
host = "0.0.0.0"

Para wss://, você precisa de um proxy que termine o TLS (nginx ou Caddy) na frente — veja a implantação.

5. Parar e reiniciar

nostrfy --config nostrfy.toml stop
nostrfy --config nostrfy.toml restart
kill -HUP $(cat nostrfy.pid)  # recarrega a configuração sem reiniciar

restart relê a configuração; o SIGHUP recarrega a maioria das configurações sem reiniciar.

Operação no dia a dia

• nostrfy stats mostra estatísticas ao vivo — também via HTTP em /relay/stats e /metrics.
• O log é gravado em daemon.log_file e passa por rotação automática.
• RUST_LOG controla o nível de log (por exemplo, RUST_LOG=nostrfy=debug).