Справочник по конфигурации

Основы

Конфигурация — это TOML файл, по умолчанию с именем nostrfy.toml. Создайте его командой init:

nostrfy --config nostrfy.toml init

Проверьте его (рекомендуется перед каждым запуском):

nostrfy --config nostrfy.toml check

Каждая команда принимает --config <path> (по умолчанию nostrfy.toml).

Общий синтаксис:

[section]
key = "string"
key = 8080
key = [1, 2]
key = true

Разделы конфигурации

Каждый ключ необязателен; отсутствующий ключ использует значение по умолчанию.

Раздел [relay] — идентичность релея

Детали ключей

• private_key — собственный секретный ключ релея, которым подписываются сгенерированные релеем события: метаданные групп NIP-29 (39000-39005) и события ролей/участников NIP-43. Создайте командой nostrfy genkey; храните в секрете. Читается один раз при запуске, поэтому его изменение требует перезапуска.
• public_url — используется для проверки тегов с URL от клиентов: NIP-42 AUTH, NIP-62 vanish и NIP-98 admin auth. Если пусто, релей откатывается к host:port, который никогда не совпадёт с реальным URL клиента при привязке 0.0.0.0 или 127.0.0.1 (пишется предупреждение). Всегда задавайте его.
• enabled_nips против disabled_nips — побеждает список разрешённых: когда enabled_nips не пуст, рекламируются только его NIP, а disabled_nips игнорируется. Оба требуют перезапуска.
• reject_ephemeral — kinds 20000-29999 отклоняются, но освобождённые kinds, которые NIP требуют ретранслировать, всё равно пересылаются: 22242, 27235, 28934/28935/28936, 24133, 23194/23195, 24242 и 21059. Применяется по SIGHUP.
• enabled_git — опциональный NIP-34: принимает kinds 1617-1633 и 30617/30618 и рекламирует NIP-34. По умолчанию выключен, т.к. патчи могут быть большими. Применяется по SIGHUP.

Раздел [server] — настройки сервера

Детали ключей

• host — 0.0.0.0 привязывает все интерфейсы IPv4; 127.0.0.1 — только локально.
• port — 1-65535; порт 80 требует root. Этот один порт обслуживает WebSocket-релей, NIP-11 документ, REST API и NIP-86 RPC вместе.
• api_host — выделяет REST API под одно имя хоста, чтобы API и релей могли делить один порт за обратным прокси. Фиксируется при запуске — требует перезапуска.
• ws_paths — root обслуживает только /, inbox-outbox обслуживает только /inbox и /outbox, all — и то, и другое. Фиксируется при запуске — требует перезапуска.
• trusted_proxies — перечисляйте только собственные адреса прокси (loopback для nginx/Caddy на том же хосте, диапазон источника балансировщика в облаке). Если задано, IP клиента выводится из последней недоверенной записи X-Forwarded-For для лимитов на IP, ограничения скорости, blockip и журналов. Никогда не добавляйте адрес, доступный клиентам напрямую — они смогут подделать заголовок и обойти per-IP лимиты. Фиксируется при запуске — требует перезапуска.

Раздел [rpc] — управление NIP-86

NIP-86 RPC смонтирован на публичных маршрутах релея POST / — отдельного управляющего порта нет. management_token и admin_pubkey иногда встречаются под [server] в старых гайдах; эти написания — устаревшие алиасы этих ключей [rpc].

Раздел [limits] — лимиты и защита

Соединения и сообщения

Подписки и запросы

События

Устаревшие алиасы: limits.require_pow, limits.new_pubkey_min_age_secs и limits.max_indexed_words по-прежнему принимаются как алиасы relay.require_pow, relay.new_pubkey_min_age_secs и database.max_indexed_words.

REST API

Живая рассылка

Раздел [database] — база данных

Детали ключей

• map_size — нижняя граница memory map: карта всегда открывается не меньше этого размера.
• max_map_size — потолок, открывается как разреженное виртуальное резервирование: физический диск растёт только с реально записанными данными. Повысьте его при database map is full.
• search_index = false — поиск всё равно работает (полнословное сопоставление с content), но сканирования становятся медленнее; на крошечном VPS это вдвое уменьшает базу. Рекомендуется на маленьких инстансах.
• disabled_fsync — компромисс надёжности ради пропускной способности: записи фиксируются в page cache ОС, и потеря питания может уничтожить самые свежие записи.

Раздел [daemon] — демон

Пути разрешаются относительно каталога файла конфигурации, поэтому остаются корректными после смены рабочего каталога демоном.

Раздел [access] — контроль доступа

Списки разрешённых/запрещённых ключей — не ключи конфигурации — они хранятся в базе релея (LMDB) и управляются в процессе работы:

nostrfy relay allow npub1...
nostrfy relay deny npub1...
nostrfy relay list

• restrict_relay = true — только ключи из списка разрешённых могут публиковать, а чтение остаётся открытым для всех (любой клиент может подписываться и читать).
• Запрещённый ключ всегда отклоняется при публикации и никогда не обслуживается при чтении.
• method_grants — гранты методов NIP-86 для не-админ ключей (ключ → имена методов, напр. модератору разрешены banevent и listbannedevents). При первом запуске засеиваются из конфигурации, затем управляются в процессе работы через NIP-86 assignmethod/unassignmethod (просмотр через listmethodassignees). Выдавать можно только модерационные и читающие методы — управление правами, ролями, инвайтами и идентичностью релея остаётся только админским, а забаненный ключ отклоняется даже с грантами. См. управляющий API.

Раздел [blossom] — файловый сервер Blossom

Горячая перезагрузка (SIGHUP)

Отредактируйте файл и отправьте kill -HUP $(cat nostrfy.pid) — конфигурация перезагрузится без перезапуска. Большинство настроек вступают в силу сразу; несколько зафиксированы при запуске:

[access] перезагрузкой не применяется — списки засеиваются один раз при запуске и затем управляются в процессе работы через NIP-86. Журнал предупреждает, когда изменилась настройка, требующая перезапуска, а несколько захваченных при запуске настроек проверкой перезагрузки не охватываются.