設定參考

基礎

設定是一個 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 消除與 NIP-98 管理認證。為空時，中繼回退到 host:port，而綁定 0.0.0.0 或 127.0.0.1 時它永遠不會符合真實用戶端 URL（會記錄警告）。務必設定它。
• enabled_nips 與 disabled_nips — 允許清單優先：當 enabled_nips 非空時，只公佈其中的 NIP，disabled_nips 被忽略。兩者都需要重新啟動。
• reject_ephemeral — 類型 20000-29999 被拒絕，但 NIP 要求轉送的豁免類型仍會轉送：22242、27235、28934/28935/28936、24133、23194/23195、24242 與 21059。SIGHUP 時生效。
• enabled_git — 選用的 NIP-34：接受類型 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 — 只列出代理本身的位址（同主機上 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 — 搜尋仍可用（針對內容的全詞比對）但掃描會更慢；在微型 VPS 上它可將資料庫減半。小型執行個體推薦。
• disabled_fsync — 以持久性換取輸送量：寫入提交到作業系統頁快取，斷電可能遺失最近的寫入。

[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 在執行階段管理。當需要重新啟動的設定發生變化時日誌會警告，少數啟動時擷取的設定不會被重載檢查。