Return-Path: Delivered-To: apmail-httpd-cvs-archive@www.apache.org Received: (qmail 84754 invoked from network); 20 Sep 2009 00:06:35 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.3) by minotaur.apache.org with SMTP; 20 Sep 2009 00:06:35 -0000 Received: (qmail 35372 invoked by uid 500); 20 Sep 2009 00:06:35 -0000 Delivered-To: apmail-httpd-cvs-archive@httpd.apache.org Received: (qmail 35274 invoked by uid 500); 20 Sep 2009 00:06:35 -0000 Mailing-List: contact cvs-help@httpd.apache.org; run by ezmlm Precedence: bulk Reply-To: dev@httpd.apache.org list-help: list-unsubscribe: List-Post: List-Id: Delivered-To: mailing list cvs@httpd.apache.org Received: (qmail 35265 invoked by uid 99); 20 Sep 2009 00:06:34 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 20 Sep 2009 00:06:34 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 20 Sep 2009 00:06:31 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 04AC52388882; Sun, 20 Sep 2009 00:06:09 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r816970 - /httpd/mod_fcgid/trunk/docs/manual/mod/mod_fcgid.html.en Date: Sun, 20 Sep 2009 00:06:08 -0000 To: cvs@httpd.apache.org From: trawick@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20090920000609.04AC52388882@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: trawick Date: Sun Sep 20 00:06:08 2009 New Revision: 816970 URL: http://svn.apache.org/viewvc?rev=816970&view=rev Log: regenerate docs Modified: httpd/mod_fcgid/trunk/docs/manual/mod/mod_fcgid.html.en Modified: httpd/mod_fcgid/trunk/docs/manual/mod/mod_fcgid.html.en URL: http://svn.apache.org/viewvc/httpd/mod_fcgid/trunk/docs/manual/mod/mod_fcgid.html.en?rev=816970&r1=816969&r2=816970&view=diff ============================================================================== --- httpd/mod_fcgid/trunk/docs/manual/mod/mod_fcgid.html.en (original) +++ httpd/mod_fcgid/trunk/docs/manual/mod/mod_fcgid.html.en Sun Sep 20 00:06:08 2009 @@ -91,25 +91,135 @@
  • TimeScore
  • ZombieScanInterval
  • -

    See also

    +

    Topics

    +

    See also

    +
    top
    +
    +

    Examples

    + +

    Note

    +

    The examples assume that mod_fcgid and other necessary + modules are loaded into the server already, either built-in or + via the LoadModule + directive.

    + +

    Additionally, the example configurations provide full access + to the applications using access control directives which work + with Apache 2.0 and 2.2. These directives are not appropriate + for all environments, and they do not work for development + levels of Apache HTTP Server (Subversion trunk).

    +
    + +

    The first example is a very simple Perl FastCGI application, + and its configuration directives. This is typical for FastCGI + applications which are named in the URL and which require no + special configuration.

    + +

    Perl FastCGI application - /usr/local/apache/fcgi-bin/foo.pl

    + #!/usr/bin/perl
    + use CGI::Fast;
    +
    + while (my $q = CGI::Fast->new) {
    + + print("Content-Type: text/plain\n\n");
    + foreach $var (sort(keys(%ENV))) {
    + + $val = $ENV{$var};
    + $val =~ s|\n|\\n|g;
    + $val =~ s|"|\\"|g;
    + print "${var}=\"${val}\"\n";
    +
    + }
    +
    + }
    +

    + +

    Configuration directives

    + <Directory /usr/local/apache/fcgi-bin/>
    + + SetHandler fcgid-script
    + Options +ExecCGI
    +
    + # Customize the next two directives for your requirements.
    + Order allow,deny
    + Allow from all
    +
    + </Directory>
    +

    + +

    PHP applications are usually configured using the + FCGIWrapper directive + and a corresponding wrapper script, as in the following + example:

    + +

    PHP application - /usr/local/phpapp/phpinfo.php

    + <?php
    + + phpinfo();
    +
    + ?>
    +

    + +

    Configuration directives

    + Alias /phpapp/ /usr/local/phpapp/
    + <Location /phpapp/>
    + + AddHandler fcgid-script .php
    + Options +ExecCGI
    + FCGIWrapper /usr/local/bin/php-wrapper .php
    + # Uncomment the following line if cgi.fix_pathinfo
    + # is set to 1 in php.ini:
    + # PHP_Fix_Pathinfo_Enable 1
    +
    + # Customize the next two directives for your requirements.
    + Order allow,deny
    + Allow from all
    +
    + </Location>
    +
    + <FilesMatch /usr/local/phpapp/phpinfo.php> + + # Customize the next two directives for your requirements.
    + Order allow,deny
    + Allow from all
    +
    + </FilesMatch> + +

    + +

    PHP wrapper script - /usr/local/bin/php-wrapper

    + #!/bin/sh
    + # Set desired PHP_FCGI_* environment variables.
    + # Example:
    + PHP_FCGI_MAX_REQUESTS=1000
    + export PHP_FCGI_MAX_REQUESTS
    +
    + # Replace with the path to your FastCGI-enabled PHP executable
    + exec /usr/local/bin/php-cgi
    +

    + +
    top

    BusyScanInterval Directive

    - +
    Description:scan interval for busy timeout process
    Syntax:BusyScanInterval seconds
    Default:BusyScanInterval 120
    Context:server config, virtual host
    Context:server config
    Status:External
    Module:mod_fcgid
    -

    The module performs the BusyTimeout check - at this interval.

    +

    The module performs the + BusyTimeout check at this + interval.

    top
    @@ -118,7 +228,7 @@ Description:a FastCGI application will be killed after handling a request for BusyTimeout Syntax:BusyTimeout seconds Default:BusyTimeout 300 -Context:server config, virtual host +Context:server config Status:External Module:mod_fcgid @@ -146,6 +256,15 @@

    Use DefaultInitEnv to define environment variables to pass to the FastCGI application. This directive can be used multiple times.

    + +

    Note

    +

    These settings are associated with the FastCGI process and are + not reset on every request based on the current virtual host + settings. The FastCGI process will run with the environment + settings of the virtual host of the request that caused the FastCGI + process to be started; these are not necessarily the same as those + of the virtual hosts of subsequent requests.

    +
    top
    @@ -154,11 +273,16 @@ Description:Max process count of one class of FastCGI application Syntax:DefaultMaxClassProcessCount value Default:DefaultMaxClassProcessCount 100 -Context:server config, virtual host +Context:server config Status:External Module:mod_fcgid -

    TODO

    +

    A process class is the set of processes which were started by the same + command, and share certain other characteristics such as virtual host and + identity.

    + +

    This directive sets the maximum number of processes in a class that + can be started.

    top
    @@ -167,11 +291,16 @@ Description:Min process count of one class of FastCGI application Syntax:DefaultMinClassProcessCount value Default:DefaultMinClassProcessCount 3 -Context:server config, virtual host +Context:server config Status:External Module:mod_fcgid -

    TODO

    +

    A process class is the set of processes which were started by the same + command, and share certain other characteristics such as virtual host and + identity.

    + +

    This directive sets the minimum number of processes in a class that + will be retained after finishing requests.

    top
    @@ -180,11 +309,15 @@ Description:scan interval for exited process Syntax:ErrorScanInterval seconds Default:ErrorScanInterval 3 -Context:server config, virtual host +Context:server config Status:External Module:mod_fcgid -

    TODO

    +

    This is the interval at which the module will handle + pending process termination. Termination is pending for + any processes which have exceeded + IdleScanInterval or + ProcessLifeTime.

    top
    @@ -233,7 +366,13 @@ Status:External Module:mod_fcgid -

    TODO

    +

    This directive controls whether or not other access checkers + are allowed to run when this module has an access checker configured + and it fails a request. If this directive is On (default) + and a FastCGI access checker returns a failure status, a failure is + returned to the client without giving other access checkers a chance to + allow access. If this directive is Off, other access + checkers will be called.

    top
    @@ -289,7 +428,13 @@ Status:External Module:mod_fcgid -

    TODO

    +

    This directive controls whether or not other authenticators + are allowed to run when this module has an authenticator configured + and it fails a request. If this directive is On (default) + and a FastCGI authenticator returns a failure status, a failure is + returned to the client without giving other authenticators a chance to + validate the client identity. If this directive is Off, + other authenticators will be called.

    top
    @@ -343,7 +488,13 @@ Status:External Module:mod_fcgid -

    TODO

    +

    This directive controls whether or not other authorizers + are allowed to run when this module has an authorizer configured + and it fails a request. If this directive is On (default) + and a FastCGI authorizer returns a failure status, a failure is + returned to the client without giving other authorizer a chance to + access the resource. If this directive is Off, other + authorizers will be called.

    top
    @@ -364,10 +515,10 @@

    The optional suffix argument restricts the use of this FCGI server to all URLs with the given exact path suffix. A suffix needs to start with '.'.

    -

    The virtual flag signals, that there will be no check, +

    The virtual flag signals that there will be no check whether the request URL actually points to an existing file. The only file which needs to exist is the wrapper itself.

    -

    The directive can be used multiply times. A wrapper defined without a suffix +

    The directive can be used multiple times. A wrapper defined without a suffix is used as a default in case no suffix matches.

    @@ -377,11 +528,14 @@ Description:scan interval for idle timeout process Syntax:IdleScanInterval seconds Default:IdleScanInterval 120 -Context:server config, virtual host +Context:server config Status:External Module:mod_fcgid -

    TODO

    +

    This is the interval at which the module will search for + processes which have exceeded + IdleScanInterval or + ProcessLifeTime.

    top
    @@ -390,11 +544,12 @@ Description:An idle FastCGI application will be killed after IdleTimeout Syntax:IdleTimeout seconds Default:IdleTimeout 300 -Context:server config, virtual host +Context:server config Status:External Module:mod_fcgid -

    TODO

    +

    Application processes which have not handled a request + for this period of time will be terminated.

    top
    @@ -407,7 +562,14 @@ Status:External Module:mod_fcgid -

    TODO

    +

    This is the maximum period of time the module will wait + while trying to read from or write to a FastCGI application.

    + +

    Warning

    +

    The FastCGI application must begin generating the response within + this period of time. Increase this directive as necessary to handle + applications which take a relatively long period of time to respond.

    +
    top
    @@ -420,7 +582,10 @@ Status:External Module:mod_fcgid -

    TODO

    +

    This is the maximum period of time the module will wait + while trying to connect to a FastCGI application on Windows. + (This directive is not respected on Unix, where AF_UNIX defaults + will apply.)

    top
    @@ -429,7 +594,7 @@ Description:maximum number of FastCGI application processes Syntax:MaxProcessCount value Default:MaxProcessCount 1000 -Context:server config, virtual host +Context:server config Status:External Module:mod_fcgid @@ -447,11 +612,12 @@ Status:External Module:mod_fcgid -

    This module reads the request body from the client before - sending to the application. Normally the request body will - be stored in memory. If the body exceeds - MaxRequestInMem bytes, the body will - be stored in a temporary file.

    +

    This module reads the entire request body from the client + before sending it to the application. Normally the request body + will be stored in memory. Once the amount of request body read + from the client exceeds MaxRequestInMem + bytes, the remainder of the request body will be stored in a + temporary file.

    top
    @@ -464,7 +630,7 @@ Status:External Module:mod_fcgid -

    If the size of the request exceeds this amount, the +

    If the size of the request body exceeds this amount, the request will fail with 500 Server Error.

    @@ -478,8 +644,9 @@ Status:External Module:mod_fcgid -

    If set, FastCGI application processes will be terminated after - handling this many requests.

    +

    FastCGI application processes will be terminated after handling + the specified number of requests. A value of -1 + disables the check.

    top
    @@ -492,7 +659,8 @@ Status:External Module:mod_fcgid -

    TODO

    +

    This is the maximum amount of response data the module will read + from the FastCGI application before flushing the data to the client.

    top
    @@ -517,7 +685,7 @@ setting Syntax:PHP_Fix_Pathinfo_Enable 1 Default:PHP_Fix_Pathinfo_Enable 0 -Context:server config, virtual host +Context:server config Status:External Module:mod_fcgid @@ -534,7 +702,7 @@ Description:maximum FastCGI application process lifetime Syntax:ProcessLifeTime seconds Default:ProcessLifeTime 3600 -Context:server config, virtual host +Context:server config Status:External Module:mod_fcgid @@ -548,7 +716,7 @@ Description:shared memory file path Syntax:SharememPath pathname Default:SharememPath logs/fcgid_shm -Context:server config, virtual host +Context:server config Status:External Module:mod_fcgid @@ -563,7 +731,7 @@ Description:directory for AF_UNIX sockets (Unix) or pipes (Windows) Syntax:SocketPath pathname Default:SocketPath logs/fcgidsock -Context:server config, virtual host +Context:server config Status:External Module:mod_fcgid @@ -579,7 +747,7 @@ Description:Each spawn adds this value to the process activity score. Syntax:SpawnScore value Default:SpawnScore 1 -Context:server config, virtual host +Context:server config Status:External Module:mod_fcgid @@ -594,7 +762,7 @@ a spawn to occur Syntax:SpawnScoreUpLimit value Default:SpawnScoreUpLimit 10 -Context:server config, virtual host +Context:server config Status:External Module:mod_fcgid @@ -620,7 +788,7 @@ score. Syntax:TerminationScore value Default:TerminationScore 2 -Context:server config, virtual host +Context:server config Status:External Module:mod_fcgid @@ -635,7 +803,7 @@ second Syntax:TimeScore value Default:TimeScore 1 -Context:server config, virtual host +Context:server config Status:External Module:mod_fcgid @@ -649,7 +817,7 @@ Description:scan interval for zombie process Syntax:ZombieScanInterval seconds Default:ZombieScanInterval 3 -Context:server config, virtual host +Context:server config Status:External Module:mod_fcgid @@ -662,6 +830,6 @@

    Available Languages:  en 

    \ No newline at end of file