設定リファレンス

基本

設定は 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 管理認証。空の場合、リレーは host:port にフォールバックしますが、0.0.0.0 や 127.0.0.1 にバインドしている場合は実際のクライアント URL と一致せず(警告が記録されます)。 必ず設定してください。
• enabled_nips と disabled_nips — 許可リストが優先されます:enabled_nips が 空でない場合、その NIP のみが広告され、disabled_nips は無視されます。どちらも再起動が必要です。
• reject_ephemeral — kind 20000-29999 は拒否されますが、NIP が転送を要求する除外 kind は引き続き 転送されます:22242、27235、28934/28935/28936、24133、23194/23195、24242、21059。SIGHUP で適用されます。
• enabled_git — オプトインの NIP-34:kind 1617-1633 および 30617/30618 を受け入れ、NIP-34 を広告します。 パッチペイロードが大きくなる可能性があるため既定では無効です。SIGHUP で適用されます。

セクション [server] — サーバー設定

キーの詳細

• host — 0.0.0.0 はすべての IPv4 インターフェースにバインドします。127.0.0.1 はローカルのみです。
• port — 1-65535。ポート 80 には root が必要です。この 1 つのポートで WebSocket リレー、NIP-11 文書、REST API、NIP-86 RPC をまとめて提供します。
• api_host — REST API を単一ホスト名に専用化し、リバースプロキシ配下で API とリレーが1つのポートを共有できるようにします。起動時に固定 — 再起動が必要です。
• ws_paths — root は / のみ、inbox-outbox は /inbox と /outbox のみ、all は両方を提供します。起動時に固定 — 再起動が必要です。
• trusted_proxies — プロキシ自身のアドレスのみを列挙します(同一ホストの nginx/Caddy ならループバック、クラウドなら バランサーの送信元範囲)。設定すると、クライアント IP は信頼できない最後の X-Forwarded-For エントリから導出され、IP ごとの上限、レート制限、blockip、ログに使用されます。クライアントが直接到達できるアドレスは 絶対に追加しないでください — ヘッダーを偽装して 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 — メモリマップの下限です。マップは常に最低でもこのサイズで開かれます。
• max_map_size — 上限で、スパースな仮想予約として開かれます。物理ディスクは実際に書き込まれたデータ分だけ 増加します。database map is full が出たら引き上げてください。
• search_index = false — 検索は引き続き動作します(content に対する完全一致スキャン)が、スキャンは 遅くなります。小規模 VPS ではデータベースが半分程度になります。小規模インスタンスにおすすめです。
• disabled_fsync — 耐久性とスループットのトレードオフです。書き込みは OS のページキャッシュにコミットされ、 電源喪失時には直近の書き込みが失われる可能性があります。

セクション [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 で確認)。付与可能なのはモデレーション系と読み取り系メソッドのみです — 権限・ロール・招待・リレー識別情報の管理は管理者のみで、BAN 済み公開鍵は許可があっても拒否されます。詳しくは 管理 API を参照してください。

セクション [blossom] — Blossom ファイルサーバー

実行時のリロード(SIGHUP)

ファイルを編集して kill -HUP $(cat nostrfy.pid) を送ると、設定を再起動なしでリロードします。 ほとんどの設定は即時に反映されますが、一部は起動時に固定されます:

[access] はリロードでは適用されません — リストは起動時に一度だけ投入され、以後は NIP-86 経由で実行時に管理します。 再起動が必要な設定が変更された場合はログに警告が出ますが、起動時に取り込んだ一部設定はリロードのチェック対象外です。