granicus.if.org Git - apache/blob - docs/manual/mod/mod_proxy_fcgi.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Licensed to the Apache Software Foundation (ASF) under one or more
   8  contributor license agreements.  See the NOTICE file distributed with
   9  this work for additional information regarding copyright ownership.
  10  The ASF licenses this file to You under the Apache License, Version 2.0
  11  (the "License"); you may not use this file except in compliance with
  12  the License.  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <modulesynopsis metafile="mod_proxy_fcgi.xml.meta">
  24
  25 <name>mod_proxy_fcgi</name>
  26 <description>FastCGI support module for
  27 <module>mod_proxy</module></description>
  28 <status>Extension</status>
  29 <sourcefile>mod_proxy_fcgi.c</sourcefile>
  30 <identifier>proxy_fcgi_module</identifier>
  31 <compatibility>Available in version 2.3 and later</compatibility>
  32
  33 <summary>
  34     <p>This module <em>requires</em> the service of <module
  35     >mod_proxy</module>. It provides support for the
  36     <a href="http://www.fastcgi.com/">FastCGI</a> protocol.</p>
  37
  38     <p>Thus, in order to get the ability of handling the <code>FastCGI</code>
  39     protocol, <module>mod_proxy</module> and
  40     <module>mod_proxy_fcgi</module> have to be present in the server.</p>
  41
  42     <p>Unlike <a href="http://httpd.apache.org/mod_fcgid/">mod_fcgid</a>
  43     and <a href="http://www.fastcgi.com/">mod_fastcgi</a>,
  44     <module>mod_proxy_fcgi</module> has no provision for starting the
  45     application process; <program>fcgistarter</program> is provided
  46     (on some platforms) for that purpose. Alternatively, external launching
  47     or process management may be available in the FastCGI application
  48     framework in use.</p>
  49
  50     <note type="warning"><title>Warning</title>
  51       <p>Do not enable proxying until you have <a
  52       href="mod_proxy.html#access">secured your server</a>. Open proxy
  53       servers are dangerous both to your network and to the Internet at
  54       large.</p>
  55     </note>
  56 </summary>
  57
  58 <seealso><program>fcgistarter</program></seealso>
  59 <seealso><module>mod_proxy</module></seealso>
  60
  61 <section id="examples"><title>Examples</title>
  62     <p>Remember, in order to make the following examples work, you have to
  63     enable <module>mod_proxy</module> and <module>mod_proxy_fcgi</module>.</p>
  64
  65     <example><title>Single application instance</title>
  66     <highlight language="config">
  67       ProxyPass /myapp/ fcgi://localhost:4000/
  68       </highlight>
  69     </example>
  70
  71     <p>This application should be able to handle multiple concurrent
  72     connections.  <module>mod_proxy</module> enables connection reuse by
  73     default, so after a request has been completed the connection will be
  74     held open by that httpd child process and won't be reused until that
  75     httpd process routes another request to the application.  If the
  76     FastCGI application is unable to handle enough concurrent connections
  77     from httpd, requests can block waiting for the application to close
  78     an existing connection.  One way to resolve this is to disable connection
  79     reuse on the <directive>ProxyPass</directive> directive, as shown in
  80     the following example:</p>
  81
  82     <example><title>Single application instance, no connection reuse</title>
  83     <highlight language="config">
  84       ProxyPass /myapp/ fcgi://localhost:4000/ disablereuse=on
  85       </highlight>
  86     </example>
  87
  88     <p> The following example passes the request URI as a filesystem
  89     path for the PHP-FPM daemon to run. The request URL is implicitly added
  90     to the 2nd parameter. The hostname and port following fcgi:// are where
  91     PHP-FPM is listening.</p>
  92     <example><title>PHP-FPM</title>
  93     <highlight language="config">
  94       ProxyPassMatch ^/myapp/.*\.php(/.*)?$ fcgi://localhost:9000/var/www/
  95     </highlight>
  96     </example>
  97
  98     <p> The following example passes the request URI as a filesystem
  99     path for the PHP-FPM daemon to run. In this case, PHP-FPM is listening on
 100     a unix domain socket (UDS).  Requires 2.4.9 or later. With this syntax,
 101     the hostname and optional port following fci:// are ignored.</p>
 102     <example><title>PHP-FPM with UDS</title>
 103     <highlight language="config">
 104       ProxyPassMatch ^/(.*\.php(/.*)?)$ "unix:/var/run/php5-fpm.sock|fcgi://localhost/var/www/"
 105     </highlight>
 106     </example>
 107
 108     <p>The balanced gateway needs <module>mod_proxy_balancer</module> and
 109     at least one load balancer algorithm module, such as
 110     <module>mod_lbmethod_byrequests</module>, in addition to the proxy
 111     modules listed above.  <module>mod_lbmethod_byrequests</module> is the
 112     default, and will be used for this example configuration.</p>
 113
 114     <example><title>Balanced gateway to multiple application instances</title>
 115     <highlight language="config">
 116 ProxyPass /myapp/ balancer://myappcluster/
 117 &lt;Proxy balancer://myappcluster/&gt;
 118     BalancerMember fcgi://localhost:4000
 119     BalancerMember fcgi://localhost:4001
 120 &lt;/Proxy&gt;
 121     </highlight>
 122     </example>
 123 </section>
 124
 125 <section id="env"><title>Environment Variables</title>
 126     <p>In addition to the configuration directives that control the
 127     behaviour of <module>mod_proxy</module>, there are a number of
 128     <dfn>environment variables</dfn> that control the FCGI protocol
 129     provider:</p>
 130     <dl>
 131         <dt>proxy-fcgi-pathinfo</dt>
 132         <dd>By default <module>mod_proxy_fcgi</module> will neither create
 133         nor export the <var>PATH_INFO</var> environment variable. This allows
 134         the backend FCGI server to correctly determine <var>SCRIPT_NAME</var>
 135         and <var>Script-URI</var> and be compliant with RFC 3875 section 3.3.
 136         If instead you need <module>mod_proxy_fcgi</module> to generate
 137         a "best guess" for <var>PATH_INFO</var>, set this env-var.
 138         This is a workaround for a bug in some FCGI implementations.</dd>
 139     </dl>
 140 </section>
 141
 142 </modulesynopsis>