Skip to content
このページは AI の支援により作成・翻訳されました。誤りがあれば、改善にご協力ください。 GitHub で編集

prx gateway

HTTP/WebSocket ゲートウェイサーバーをスタンドアロンプロセスとして起動します。prx daemon とは異なり、このコマンドはゲートウェイのみを起動します -- チャネル、cron スケジューラ、進化エンジンは含まれません。

これは、完全なデーモンなしで PRX API を公開したい場合や、チャネルとスケジューリングを別プロセスとして実行する場合に便利です。

使い方

bash
prx gateway [OPTIONS]

オプション

フラグ短縮形デフォルト説明
--config-c~/.config/prx/config.toml設定ファイルのパス
--port-p3120リッスンポート
--host-H127.0.0.1バインドアドレス
--log-level-linfoログの詳細度: trace, debug, info, warn, error
--cors-origin*許可する CORS オリジン(カンマ区切り)
--tls-certTLS 証明書ファイルのパス
--tls-keyTLS 秘密鍵ファイルのパス

エンドポイント

ゲートウェイは以下のエンドポイントグループを公開します:

パスメソッド説明
/healthGETヘルスチェック(200 OK を返す)
/api/v1/chatPOSTチャットメッセージの送信
/api/v1/chat/streamPOSTチャットメッセージの送信(ストリーミング SSE)
/api/v1/sessionsGET, POSTセッション管理
/api/v1/sessions/:idGET, DELETE単一セッション操作
/api/v1/toolsGET使用可能なツールの一覧
/api/v1/memoryGET, POSTメモリ操作
/wsWSリアルタイム通信用 WebSocket エンドポイント
/webhooks/:channelPOSTチャネル用受信 Webhook レシーバー

完全な API ドキュメントについては、ゲートウェイ HTTP APIゲートウェイ WebSocket を参照してください。

使用例

bash
# デフォルトポートで起動
prx gateway

# すべてのインターフェースのポート 8080 にバインド
prx gateway --host 0.0.0.0 --port 8080

# TLS 付き
prx gateway --tls-cert /etc/prx/cert.pem --tls-key /etc/prx/key.pem

# CORS を制限
prx gateway --cors-origin "https://app.example.com,https://admin.example.com"

# デバッグログ
prx gateway --log-level debug

リバースプロキシの背後で

本番環境では、TLS 終端とロードバランシングのためにゲートウェイをリバースプロキシ(Nginx、Caddy など)の背後に配置します:

# Caddy の例
api.example.com {
    reverse_proxy localhost:3120
}
nginx
# Nginx の例
server {
    listen 443 ssl;
    server_name api.example.com;

    location / {
        proxy_pass http://127.0.0.1:3120;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
    }
}

シグナル

シグナル動作
SIGHUP設定のリロード
SIGTERMグレースフルシャットダウン(処理中のリクエストを完了)

関連ドキュメント

Released under the Apache-2.0 License.