ドキュメント
nginx内のRubyでリクエストの処理を組み立てます。ここはv3の開発ブランチnextの文書です。実装済みの挙動と今後の計画を区別しています。リリース済みの2.7系は安定版のドキュメントを参照してください。
動く例を試す
Section titled “動く例を試す”- モデルの振り分けを試す:Rubyの対応表で転送先と認証情報を変え、同じ内容を再送します。プロバイダのキーは不要です。
- インストール:nginxに合わせたビルドと必要な環境、オプション、更新時の確認。
アプリに規則を加える
Section titled “アプリに規則を加える”- モデルAPIの中継:利用者キーの検査、モデルの振り分け、同時実行制限、ストリーム中継。計画中の拡張は明示しています。
- HTTPの振り分け:リクエストの情報からバックエンドを選択。
- アクセス制御:ローカルの拒否リストにある接続元を拒否。
- レート制限:APIキーごとの制限。
- レスポンスのフィルタ:レスポンスボディの変更。
- TCPの中継:接続元を確認。
- MCPゲートウェイの設計案:未検証の構成と、未確認の範囲や境界。
- v3で広げる用途:MCPツールの認可、AIアプリケーション別の連携、モデルAPIの切替、AIクローラーのリクエストの制御、キャッシュとテレメトリの構想。
- 用語集:モデル、モデルAPI、エージェント、MCP、A2A、それらの通信、AIゲートウェイを指す語。
APIやビルド設定を調べる
Section titled “APIやビルド設定を調べる”- ディレクティブ:nginxがRubyを呼ぶ場所と設定。
- Rubyのクラスとメソッド:ハンドラで使えるAPI。
- ビルドのリファレンス:コンパイルオプションと同梱gem。
リクエストの流れを理解する
Section titled “リクエストの流れを理解する”- リクエストのフェーズ:ハンドラの実行順。
- ヘッダ・ボディ断片の制約。
- ブロックせずに待つ:nginxへ処理を委ねる方法。
- ライフタイム:worker内の共有状態とリクエスト単位の状態。
運用とアップグレード
Section titled “運用とアップグレード”- リリースノート:挙動の変更。
- 2.xからの移行:v3へ移る際に必要な変更。
- 信頼境界:モジュールと各スクリプトが検証する範囲。
- セキュリティポリシー:サポート対象と非公開での脆弱性報告。
開発に参加し進捗を追う
Section titled “開発に参加し進捗を追う”- 開発に参加する:変更の範囲、レビュー、貢献の手順。
- テスト:テストの種類と実行方法。
- 開発の手順:ブランチの運用と共同作業の引継ぎ。
- 現在の作業:日付付きの作業・公開記録。
- ブランチの運用:保守・開発系列。
- その他のユースケース:追加の例と、それぞれの前提。
ngx_mrubyはMITライセンスで提供します。