nostrfy

クイックスタートガイド

インストールから稼働中の 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" に設定して再起動してください。
次のステップ
設定リファレンス でリレーのあらゆる面を調整できます。