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 <seealso><module>mod_authnz_fcgi</module></seealso>
  61
  62 <section id="examples"><title>Examples</title>
  63     <p>Remember, in order to make the following examples work, you have to
  64     enable <module>mod_proxy</module> and <module>mod_proxy_fcgi</module>.</p>
  65
  66     <example><title>Single application instance</title>
  67     <highlight language="config">
  68       ProxyPass "/myapp/" "fcgi://localhost:4000/"
  69     </highlight>
  70     </example>
  71
  72     <p> <module>mod_proxy_fcgi</module> disables connection reuse by
  73     default, so after a request has been completed the connection will NOT be
  74     held open by that httpd child process and won't be reused.  If the
  75     FastCGI application is able to handle concurrent connections
  76     from httpd, you can opt-in to connection reuse as shown in the following
  77     example:</p>
  78
  79     <example><title>Single application instance, connection reuse</title>
  80     <highlight language="config">
  81       ProxyPass "/myapp/" "fcgi://localhost:4000/" enablereuse=on
  82       </highlight>
  83     </example>
  84
  85     <p> The following example passes the request URI as a filesystem
  86     path for the PHP-FPM daemon to run. The request URL is implicitly added
  87     to the 2nd parameter. The hostname and port following fcgi:// are where
  88     PHP-FPM is listening.  Connection pooling is enabled.</p>
  89     <example><title>PHP-FPM</title>
  90     <highlight language="config">
  91       ProxyPassMatch "^/myapp/.*\.php(/.*)?$" "fcgi://localhost:9000/var/www/" enablereuse=on
  92     </highlight>
  93     </example>
  94
  95     <p> The following example passes the request URI as a filesystem
  96     path for the PHP-FPM daemon to run. In this case, PHP-FPM is listening on
  97     a unix domain socket (UDS).  Requires 2.4.9 or later. With this syntax,
  98     the hostname and optional port following fcgi:// are ignored.</p>
  99     <example><title>PHP-FPM with UDS</title>
 100     <highlight language="config">
 101       # UDS does not currently support connection reuse
 102       ProxyPassMatch "^/(.*\.php(/.*)?)$" "unix:/var/run/php5-fpm.sock|fcgi://localhost/var/www/"
 103     </highlight>
 104     </example>
 105
 106     <p>The balanced gateway needs <module>mod_proxy_balancer</module> and
 107     at least one load balancer algorithm module, such as
 108     <module>mod_lbmethod_byrequests</module>, in addition to the proxy
 109     modules listed above.  <module>mod_lbmethod_byrequests</module> is the
 110     default, and will be used for this example configuration.</p>
 111
 112     <example><title>Balanced gateway to multiple application instances</title>
 113     <highlight language="config">
 114 ProxyPass "/myapp/" "balancer://myappcluster/"
 115 &lt;Proxy balancer://myappcluster/&gt;
 116     BalancerMember fcgi://localhost:4000
 117     BalancerMember fcgi://localhost:4001
 118 &lt;/Proxy&gt;
 119     </highlight>
 120     </example>
 121
 122       <p>You can also force a request to be handled as a reverse-proxy
 123         request, by creating a suitable Handler pass-through. The example
 124         configuration below will pass all requests for PHP scripts to the
 125         specified FastCGI server using reverse proxy.
 126         This feature is available in Apache HTTP Server 2.4.10 and later. For performance
 127        reasons, you will want to define a <a href="mod_proxy.html#workers">worker</a>
 128        representing the same fcgi:// backend. The benefit of this form is that it
 129        allows the normal mapping of URI to filename to occur in the server, and the
 130        local filesystem result is passed to the backend.  When FastCGI is
 131        configured this way, the server can calculate the most accurate
 132        PATH_INFO.
 133       </p>
 134     <example><title>Proxy via Handler</title>
 135       <highlight language="config">
 136 &lt;FilesMatch "\.php$"&gt;
 137     # Note: The only part that varies is /path/to/app.sock
 138     SetHandler  "proxy:unix:/path/to/app.sock|fcgi://localhost/"
 139 &lt;/FilesMatch&gt;
 140    # Define a matching worker.
 141    # The part that is matched to the SetHandler is the part that
 142    # follows the pipe. If you need to distinguish, "localhost; can
 143    # be anything unique.
 144    &lt;Proxy fcgi://localhost/ enablereuse=on max=10&gt;
 145    &lt;/Proxy&gt;
 146
 147 &lt;FilesMatch ...&gt;
 148     SetHandler  "proxy:fcgi://localhost:9000"
 149 &lt;/FilesMatch&gt;
 150
 151 &lt;FilesMatch ...&gt;
 152     SetHandler  "proxy:balancer://myappcluster/"
 153 &lt;/FilesMatch&gt;
 154       </highlight>
 155    </example>
 156 </section>
 157
 158 <section id="env"><title>Environment Variables</title>
 159     <p>In addition to the configuration directives that control the
 160     behaviour of <module>mod_proxy</module>, there are a number of
 161     <dfn>environment variables</dfn> that control the FCGI protocol
 162     provider:</p>
 163     <dl>
 164         <dt>proxy-fcgi-pathinfo</dt>
 165         <dd>When configured via <directive module="mod_proxy"
 166         >ProxyPass</directive> or  <directive module="mod_proxy"
 167         >ProxyPassMatch</directive>, <module>mod_proxy_fcgi</module> will not
 168         set the <var>PATH_INFO</var> environment variable. This allows
 169         the backend FCGI server to correctly determine <var>SCRIPT_NAME</var>
 170         and <var>Script-URI</var> and be compliant with RFC 3875 section 3.3.
 171         If instead you need <module>mod_proxy_fcgi</module> to generate
 172         a "best guess" for <var>PATH_INFO</var>, set this env-var.
 173         This is a workaround for a bug in some FCGI implementations.  This
 174         variable can be set to multiple values to tweak at how the best guess
 175         is chosen:
 176         <dl>
 177           <dt>first-dot</dt>
 178           <dd>PATH_INFO is split from the slash following the
 179               <em>first</em> "." in the URL.</dd>
 180           <dt>last-dot</dt>
 181           <dd>PATH_INFO is split from the slash following the
 182               <em>last</em> "." in the URL.</dd>
 183           <dt>full</dt>
 184           <dd>PATH_INFO is calculated by an attempt to map the URL to the
 185               local filesystem.</dd>
 186           <dt>unescape</dt>
 187           <dd>PATH_INFO is the path component of the URL, unescaped /
 188               decoded.</dd>
 189           <dt>any other value</dt>
 190           <dd>PATH_INFO is the same as the path component of the URL.
 191               Originally, this was the only proxy-fcgi-pathinfo option.</dd>
 192          </dl>
 193         </dd>
 194     </dl>
 195 </section>
 196
 197 </modulesynopsis>