Руководство по быстрому старту

От установки до работающего релея Nostr — считаные минуты: напишите конфигурацию, проверьте её, запустите демон и выполните первую проверку работоспособности.

1. Создайте конфигурацию

nostrfy init записывает стандартный, полностью прокомментированный nostrfy.toml:

sh
nostrfy --config nostrfy.toml init

Откройте его в текстовом редакторе и настройте — каждая опция прокомментирована.

2. Проверьте конфигурацию

nostrfy check настоятельно рекомендуется перед запуском; при любой проблеме он точно укажет, в чём дело.

sh
nostrfy --config nostrfy.toml check

3. Запустите релей

sh
nostrfy --config nostrfy.toml start

Запускается как демон. Добавьте --foreground, чтобы работать в терминале.

Затем проверьте, что релей запущен, с помощью конечной точки проверки работоспособности:

sh
curl http://127.0.0.1:8080/health

=> {"status":"ok"}

4. Направьте клиент на релей

На той же машине подключитесь к ws://<host>:8080. Хост по умолчанию — 127.0.0.1 принимает только локальные соединения. Чтобы открыть релей для других машин, задайте в конфигурации server.host = "0.0.0.0":

toml
[server]
host = "0.0.0.0"

Для wss:// нужен прокси, завершающий TLS (nginx или Caddy), перед релеем — см. документацию по развёртыванию.

5. Остановка и перезапуск

sh
nostrfy --config nostrfy.toml stop
nostrfy --config nostrfy.toml restart
kill -HUP $(cat nostrfy.pid)  # перезагружает конфигурацию без перезапуска

restart перечитывает конфигурацию; SIGHUP перезагружает большинство настроек без перезапуска.

Эффективная эксплуатация

  • nostrfy stats показывает живую статистику — также по HTTP: /relay/stats и /metrics.
  • Лог пишется в daemon.log_file и автоматически ротируется.
  • RUST_LOG управляет уровнем логирования (например, RUST_LOG=nostrfy=debug).
Внешние клиенты не подключаются?
По умолчанию server.host равен 127.0.0.1. Установите host = "0.0.0.0" и перезапустите.
Далее
В справочнике по конфигурации можно настроить любые аспекты релея.