ngx_mrubyはnginxにmrubyを組み込み、リクエストの処理、アクセス制御、転送先の選択、レスポンスのフィルタ、TCP/UDPのハンドラをRubyで書けるようにします。各アプリケーションではなくnginx側で共通の振り分けや処理を行いたい場合に使います。接続を扱うのはnginxで、その判断の規則をRubyで書きます。
ここは2.xの保守ブランチのドキュメントです。特定のリリースタグの内容とは限らず、未リリースの変更を含むことがあります。リリース済みの版を使う場合はGitHubのリリースから最新のv2.*タグを選び、そのタグの文書を読んでください。将来masterがv3へ変わっても2.xの保守修正を追うには、v2.xを使います。ブランチの運用で違いを確認できます。
導入して動かす
Section titled “導入して動かす”- インストール:ソースからのビルドか動的モジュールを選び、nginxのビルド条件を合わせて、Rubyのhello-worldを動かします。
- ユースケース:振り分け、アクセス制御、フィルタなどの設定例です。各例が必要とするサービスやgemを確認してください。
- 設定ファイルの例:ディレクティブと呼び出すスクリプトを確認します。そのまま本番へ導入するための設定ではありません。
nginxの設定とRubyのAPI
Section titled “nginxの設定とRubyのAPI”- ディレクティブ:ハンドラの実行フェーズとスクリプトのキャッシュを設定します。
- Rubyのクラスとメソッド:リクエスト、変数、レスポンス出力、upstream、フィルタ、SSL、streamのAPIです。
- リクエスト間でワーカーに残る状態(英語原文):Rubyオブジェクトへの保存前に、共有VMの状態を確認します。
運用とアップグレード
Section titled “運用とアップグレード”- リリースノート:利用中の版より新しい各リリースの挙動変更を読みます。保守ブランチにノートがあるだけでは公開済みとは限りません。GitHubのリリースタグも確認してください。
- 信頼境界(英語原文):設定とRubyスクリプトは信頼するコードで、クライアント入力は信頼しません。ngx_mrubyは、信頼できないスクリプトを動かすためのサンドボックスではありません。
- セキュリティポリシー:サポート対象の版と非公開での報告方法です。
- テスト:ビルドや設定変更を結合テストで確認します。
開発とほかのバージョン
Section titled “開発とほかのバージョン”- ngx_mrubyの開発:開発への参加と保守の手順です。
- 3.xのドキュメント:
nextで開発中の別の系列です。新しいAPI、プロキシのレシピ、計画中の機能は2.7の仕様ではありません。対応状況を確認せず2.xの環境へコピーしないでください。 - 過去の紹介とベンチマーク(英語原文):古い例や設計論文は歴史的な資料として残しています。2013年と2014年の測定は当時の環境とワークロードの結果であり、現在の導入手順、性能、ほかのサーバーより優れていることの根拠ではありません。
この入口は日本語で案内しています。リンク先に日本語版がない場合は英語原文を表示します。ワーカーの状態と信頼境界の詳細な契約は、上記の英語原文を参照してください。
配布条件はMITライセンスです。