Guía de inicio rápido

1. Crear una configuración

nostrfy init escribe un nostrfy.toml predeterminado con todos los comentarios:

nostrfy --config nostrfy.toml init

Ábrelo en un editor de texto y ajústalo — cada opción está comentada.

2. Validar la configuración

nostrfy check se recomienda encarecidamente antes de arrancar; si algo va mal, indica exactamente qué.

nostrfy --config nostrfy.toml check

3. Arrancar el relé

nostrfy --config nostrfy.toml start

Se ejecuta como demonio. Añade --foreground para quedarte en la terminal.

Luego verifica que el relé esté activo con la comprobación de estado:

curl http://127.0.0.1:8080/health

=> {"status":"ok"}

4. Apuntar un cliente

En la misma máquina, conéctate a ws://<host>:8080. El host predeterminado es 127.0.0.1, que solo acepta conexiones locales. Para acceder al relé desde otras máquinas, configura en la configuración server.host = "0.0.0.0":

[server]
host = "0.0.0.0"

Para wss://, necesitas un proxy que termine el TLS (nginx o Caddy) delante — consulta la documentación de despliegue.

5. Detener y reiniciar

nostrfy --config nostrfy.toml stop
nostrfy --config nostrfy.toml restart
kill -HUP $(cat nostrfy.pid)  # recarga la configuración sin reiniciar

restart relee la configuración; SIGHUP recarga la mayoría de los ajustes sin reiniciar.

Operación eficaz

• nostrfy stats muestra estadísticas en vivo — también por HTTP en /relay/stats y /metrics.
• El registro se escribe en daemon.log_file y se rota automáticamente.
• RUST_LOG controla el nivel de registro (por ejemplo, RUST_LOG=nostrfy=debug).