FastCGI SAF パラメータ

FastCGI プラグインの SAF「auth-fastcgi」、「responder-fastcgi」、および「filter-fastcgi」はすべて、特に明記されていないかぎり、次のパラメータを受け付けます。

パラメータ chroot、user、group、および nice は、UNIX プラットフォームにしか適用できません。Windows プラットフォームでは、それらのパラメータは無視されます。

• app-path - (省略可能) 要求を処理する FastCGI アプリケーションのパス。その機能は次のように、bind-path パラメータの値に依存します。

  1. app-path のみが指定された場合、プラグインは、プラグインによって作成された UNIX ドメインソケットを待機する FastCGI アプリケーションを作成します。このパラメータは、UNIX プラットフォームでしか受け付けられません。Windows では、エラーメッセージがログに記録されます。

  2. app-path と bind-path がどちらも指定された場合、プラグインは、指定された FastCGI アプリケーションのプロセスを起動し、それを指定された bind-path にバインドします。

  3. bind-path のみが指定された場合、FastCGI アプリケーションはリモートで実行されているものとみなされます。このため、プラグインは、FastCGI アプリケーションのプロセスを起動しません。

  4. 「app-path」、「 bind-path」がどちらも指定されなかった場合、プラグインはログにエラーメッセージを記録します。

• app-args — (省略可能) FastCGI アプリケーションプロセスへの引数として渡される値。app-args パラメータは複数指定できます。app-args パラメータを複数指定する場合の形式は、app-args="value" app-args="value" ... です

• bind-path - (省略可能) UNIX ドメインソケット名、形式「host:port」のいずれかになります。「app-path」パラメータの説明のなかで、「bind-path」パラメータの使用方法が説明されています。UNIX ドメインソケット名は UNIX プラットフォームでしか適用できません。Windows プラットフォームでは、bind-path は「host:port 」として指定する必要があります。

• min-procs - (省略可能) 作成すべき FastCGI アプリケーションプロセスの最小数を指定する整数。デフォルトは 1 です。

• max-procs - (省略可能) 同時に作成可能な FastCGI アプリケーションプロセスの最大数を指定する整数。この整数値は、min-procs と等しいかそれより大きくなければいけません。デフォルトは 1 です。

• chroot - (省略可能) FastCGI サーバーアプリケーションプロセスの chroot を実行するときのルートディレクトリを設定するために使用されます。デフォルトは、Web Server のルートディレクトリになります。

• user - (省略可能) FastCGI アプリケーション実行時に使用するユーザー ID を指定します。デフォルトは、Web Server のユーザー ID になります。

• group - (省略可能) 指定されたグループの下で FastCGI アプリケーションが実行されます。デフォルトは、Web Server のグループになります。

• nice - (省略可能) FastCGI アプリケーションプロセスの nice/priority 値を指定します。

• listen-queue - (省略可能) ソケットの待機キューサイズを指定する整数。このパラメータのデフォルト値は 256 です。

• app-env - (省略可能) FastCGI アプリケーションプロセスに環境変数として渡される値ペア。「app-env」パラメータは複数指定できます。app-env パラメータを複数指定する場合の形式は、app-env="name=value" app-env="name=value"... です。

• reuse-connection - (省略可能) FastCGI アプリケーションへの接続が再利用されるかどうかを決定するブール値。False (0、false、no) は、要求が終了するたびに FastCGI アプリケーションへの接続が閉じられることを示します。True (1、true、yes) は、既存の接続が新しい要求で再利用されることを示します。デフォルトは false です。connection-timeout も参照してください。

• connection-timeout - (省略可能) 「reuse-connection」が True に設定されている場合に、この値はプール内の接続のタイムアウト値を秒単位で指定します。この指定された期間の間、ある接続がアイドル状態になっていると、プラグインはその接続を閉じます。このパラメータのデフォルト値は 5 秒です。reuse-connection も参照してください。

• resp-timeout - (省略可能) FastCGI サーバー応答タイムアウトを秒単位で表す整数。指定された期間の間、FastCGI アプリケーションから応答がなかった場合、その要求は破棄されます。このパラメータのデフォルト値は 5 分です。

• restart-interval - (省略可能) FastCGI アプリケーションが次に再起動されるまでの時間間隔 (分) を表す整数。このパラメータのデフォルト値は 60 分 (1 時間) です。このパラメータの値をゼロに設定すると、FastCGI アプリケーションが強制的に再起動されることがなくなります。

• req-retry - (省略可能) FastCGI アプリケーションが要求を拒否した場合にプラグインが要求を再送信すべき回数を表す整数。このパラメータのデフォルト値はゼロです。

error-fastcgi サーバーアプリケーション関数 (SAF) は次のパラメータを受け付けます。

• error-url - 障害またはエラーが発生したときに表示するページの URI または URL を指定します。このパラメータの値は、絶対パス、ドキュメントルートからの相対パス、URL、URI のいずれかになります。

• error-reason - (省略可能) FastCGI プロトコルのエラーを表す文字列。この文字列は、プラグインエラー発生時に表示するエラー URL を区別するために使用されます。