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

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
   4 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_proxy_fcgi - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.png" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_proxy_fcgi</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_fcgi.html" title="English">&nbsp;en&nbsp;</a> |
  30 <a href="../fr/mod/mod_proxy_fcgi.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
  31 </div>
  32 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>FastCGI support module for
  33 <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></td></tr>
  34 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  35 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>proxy_fcgi_module</td></tr>
  36 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_proxy_fcgi.c</td></tr>
  37 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.3 and later</td></tr></table>
  38 <h3>Summary</h3>
  39
  40     <p>This module <em>requires</em> the service of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>. It provides support for the
  41     <a href="http://www.fastcgi.com/">FastCGI</a> protocol.</p>
  42
  43     <p>Thus, in order to get the ability of handling the <code>FastCGI</code>
  44     protocol, <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> and
  45     <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> have to be present in the server.</p>
  46
  47     <p>Unlike <a href="http://httpd.apache.org/mod_fcgid/">mod_fcgid</a>
  48     and <a href="http://www.fastcgi.com/">mod_fastcgi</a>,
  49     <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> has no provision for starting the
  50     application process; <code class="program"><a href="../programs/fcgistarter.html">fcgistarter</a></code> is provided
  51     (on some platforms) for that purpose. Alternatively, external launching
  52     or process management may be available in the FastCGI application
  53     framework in use.</p>
  54
  55     <div class="warning"><h3>Warning</h3>
  56       <p>Do not enable proxying until you have <a href="mod_proxy.html#access">secured your server</a>. Open proxy
  57       servers are dangerous both to your network and to the Internet at
  58       large.</p>
  59     </div>
  60 </div>
  61 <div id="quickview"><h3>Topics</h3>
  62 <ul id="topics">
  63 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
  64 <li><img alt="" src="../images/down.gif" /> <a href="#env">Environment Variables</a></li>
  65 </ul><h3 class="directives">Directives</h3>
  66 <ul id="toc">
  67 <li><img alt="" src="../images/down.gif" /> <a href="#proxyfcgibackendtype">ProxyFCGIBackendType</a></li>
  68 <li><img alt="" src="../images/down.gif" /> <a href="#proxyfcgisetenvif">ProxyFCGISetEnvIf</a></li>
  69 </ul>
  70 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_proxy_fcgi">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_proxy_fcgi">Report a bug</a></li></ul><h3>See also</h3>
  71 <ul class="seealso">
  72 <li><code class="program"><a href="../programs/fcgistarter.html">fcgistarter</a></code></li>
  73 <li><code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></li>
  74 <li><code class="module"><a href="../mod/mod_authnz_fcgi.html">mod_authnz_fcgi</a></code></li>
  75 <li><a href="#comments_section">Comments</a></li></ul></div>
  76 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  77 <div class="section">
  78 <h2><a name="examples" id="examples">Examples</a></h2>
  79     <p>Remember, in order to make the following examples work, you have to
  80     enable <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> and <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code>.</p>
  81
  82     <div class="example"><h3>Single application instance</h3><pre class="prettyprint lang-config">ProxyPass "/myapp/" "fcgi://localhost:4000/"</pre>
  83 </div>
  84
  85     <p> <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> disables connection reuse by
  86     default, so after a request has been completed the connection will NOT be
  87     held open by that httpd child process and won't be reused.  If the
  88     FastCGI application is able to handle concurrent connections
  89     from httpd, you can opt-in to connection reuse as shown in the following
  90     example:</p>
  91
  92     <div class="example"><h3>Single application instance, connection reuse (2.4.11 and later)</h3><pre class="prettyprint lang-config">ProxyPass "/myapp/" "fcgi://localhost:4000/" enablereuse=on</pre>
  93 </div>
  94
  95     <p> The following example passes the request URI as a filesystem
  96     path for the PHP-FPM daemon to run. The request URL is implicitly added
  97     to the 2nd parameter. The hostname and port following fcgi:// are where
  98     PHP-FPM is listening.  Connection pooling is enabled.</p>
  99     <div class="example"><h3>PHP-FPM</h3><pre class="prettyprint lang-config">ProxyPassMatch "^/myapp/.*\.php(/.*)?$" "fcgi://localhost:9000/var/www/" enablereuse=on</pre>
 100 </div>
 101
 102     <p> The following example passes the request URI as a filesystem
 103     path for the PHP-FPM daemon to run. In this case, PHP-FPM is listening on
 104     a unix domain socket (UDS).  Requires 2.4.9 or later. With this syntax,
 105     the hostname and optional port following fcgi:// are ignored.</p>
 106     <div class="example"><h3>PHP-FPM with UDS</h3><pre class="prettyprint lang-config"># UDS does not currently support connection reuse
 107 ProxyPassMatch "^/(.*\.php(/.*)?)$" "unix:/var/run/php5-fpm.sock|fcgi://localhost/var/www/"</pre>
 108 </div>
 109
 110     <p>The balanced gateway needs <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code> and
 111     at least one load balancer algorithm module, such as
 112     <code class="module"><a href="../mod/mod_lbmethod_byrequests.html">mod_lbmethod_byrequests</a></code>, in addition to the proxy
 113     modules listed above.  <code class="module"><a href="../mod/mod_lbmethod_byrequests.html">mod_lbmethod_byrequests</a></code> is the
 114     default, and will be used for this example configuration.</p>
 115
 116     <div class="example"><h3>Balanced gateway to multiple application instances</h3><pre class="prettyprint lang-config">ProxyPass "/myapp/" "balancer://myappcluster/"
 117 &lt;Proxy "balancer://myappcluster/"&gt;
 118     BalancerMember "fcgi://localhost:4000"
 119     BalancerMember "fcgi://localhost:4001"
 120 &lt;/Proxy&gt;</pre>
 121 </div>
 122
 123       <p>You can also force a request to be handled as a reverse-proxy
 124         request, by creating a suitable Handler pass-through. The example
 125         configuration below will pass all requests for PHP scripts to the
 126         specified FastCGI server using reverse proxy.
 127         This feature is available in Apache HTTP Server 2.4.10 and later. For performance
 128        reasons, you will want to define a <a href="mod_proxy.html#workers">worker</a>
 129        representing the same fcgi:// backend. The benefit of this form is that it
 130        allows the normal mapping of URI to filename to occur in the server, and the
 131        local filesystem result is passed to the backend.  When FastCGI is
 132        configured this way, the server can calculate the most accurate
 133        PATH_INFO.
 134       </p>
 135     <div class="example"><h3>Proxy via Handler</h3><pre class="prettyprint lang-config">&lt;FilesMatch "\.php$"&gt;
 136     # Note: The only part that varies is /path/to/app.sock
 137     SetHandler  "proxy:unix:/path/to/app.sock|fcgi://localhost/"
 138 &lt;/FilesMatch&gt;
 139
 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;</pre>
 154 </div>
 155 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 156 <div class="section">
 157 <h2><a name="env" id="env">Environment Variables</a></h2>
 158     <p>In addition to the configuration directives that control the
 159     behaviour of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, there are a number of
 160     <dfn>environment variables</dfn> that control the FCGI protocol
 161     provider:</p>
 162     <dl>
 163         <dt>proxy-fcgi-pathinfo</dt>
 164         <dd>When configured via <code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code> or  <code class="directive"><a href="../mod/mod_proxy.html#proxypassmatch">ProxyPassMatch</a></code>, <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> will not
 165         set the <var>PATH_INFO</var> environment variable. This allows
 166         the backend FCGI server to correctly determine <var>SCRIPT_NAME</var>
 167         and <var>Script-URI</var> and be compliant with RFC 3875 section 3.3.
 168         If instead you need <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> to generate
 169         a "best guess" for <var>PATH_INFO</var>, set this env-var.
 170         This is a workaround for a bug in some FCGI implementations.  This
 171         variable can be set to multiple values to tweak at how the best guess
 172         is chosen (In 2.4.11 and later only):
 173         <dl>
 174           <dt>first-dot</dt>
 175           <dd>PATH_INFO is split from the slash following the
 176               <em>first</em> "." in the URL.</dd>
 177           <dt>last-dot</dt>
 178           <dd>PATH_INFO is split from the slash following the
 179               <em>last</em> "." in the URL.</dd>
 180           <dt>full</dt>
 181           <dd>PATH_INFO is calculated by an attempt to map the URL to the
 182               local filesystem.</dd>
 183           <dt>unescape</dt>
 184           <dd>PATH_INFO is the path component of the URL, unescaped /
 185               decoded.</dd>
 186           <dt>any other value</dt>
 187           <dd>PATH_INFO is the same as the path component of the URL.
 188               Originally, this was the only proxy-fcgi-pathinfo option.</dd>
 189          </dl>
 190         </dd>
 191     </dl>
 192 </div>
 193 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 194 <div class="directive-section"><h2><a name="ProxyFCGIBackendType" id="ProxyFCGIBackendType">ProxyFCGIBackendType</a> <a name="proxyfcgibackendtype" id="proxyfcgibackendtype">Directive</a></h2>
 195 <table class="directive">
 196 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specify the type of backend FastCGI application</td></tr>
 197 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyFCGIBackendType FPM|GENERIC</code></td></tr>
 198 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyFCGIBackendType FPM</code></td></tr>
 199 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 200 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 201 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 202 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_fcgi</td></tr>
 203 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.4.26 and later</td></tr>
 204 </table>
 205 <p>This directive allows the type of backend FastCGI application to be
 206 specified. Some FastCGI servers, such as PHP-FPM,  use historical quirks of
 207 environment variables to identify the type of proxy server being used.  Set
 208 this directive to "GENERIC" if your non PHP-FPM application has trouble
 209 interpreting environment variables such as SCRIPT_FILENAME or PATH_TRANSLATED
 210 as set by the server.</p>
 211
 212 <p>One example of values that change based on the setting of this directive is
 213 SCRIPT_FILENAME. When using <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> historically,
 214 SCRIPT_FILENAME was prefixed with the string "proxy:fcgi://". This variable is
 215 what some generic FastCGI applications would read as their script input, but
 216 PHP-FPM would strip the prefix then remember it was talking to Apache.  In
 217 2.4.21 through 2.4.25, this prefix was automatically stripped by the server,
 218 breaking the ability of PHP-FPM to detect and interoperate with Apache in some
 219 scenarios.</p>
 220
 221 </div>
 222 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 223 <div class="directive-section"><h2><a name="ProxyFCGISetEnvIf" id="ProxyFCGISetEnvIf">ProxyFCGISetEnvIf</a> <a name="proxyfcgisetenvif" id="proxyfcgisetenvif">Directive</a></h2>
 224 <table class="directive">
 225 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Allow variables sent to FastCGI servers to be fixed up</td></tr>
 226 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyFCGISetEnvIf <var>conditional-expression</var>
 227     [!]<var>environment-variable-name</var>
 228     [<var>value-expression</var>]</code></td></tr>
 229 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 230 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 231 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 232 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_fcgi</td></tr>
 233 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.4.26 and later</td></tr>
 234 </table>
 235 <p>Just before passing a request to the configured FastCGI server, the core of
 236 the web server sets a number of environment variables based on details of the
 237 current request. FastCGI programs often uses these environment variables
 238 as inputs that determine what underlying scripts they will process, or what
 239 output they directly produce.</p>
 240 <p>Examples of noteworthy environment variables are:</p>
 241 <ul>
 242   <li>SCRIPT_NAME</li>
 243   <li>SCRIPT_FILENAME</li>
 244   <li>REQUEST_URI</li>
 245   <li>PATH_INFO</li>
 246   <li>PATH_TRANSLATED</li>
 247 </ul>
 248
 249 <p>This directive allows the environment variables above, or any others of
 250 interest, to be overridden.  This directive is evaluated after the initial
 251 values for these variables are set, so they can be used as input into both
 252 the condition expressions and value expressions.</p>
 253 <p>Parameter syntax:</p>
 254 <dl>
 255 <dt>conditional-expression</dt>
 256 <dd>Specifies an expression that controls whether the environment variable that
 257    follows will be modified.  For information on the expression syntax, see
 258    the examples that follow or the full specification at the
 259    <a href="../expr.html">ap_expr</a> documentation.
 260    </dd>
 261 <dt>environment-variable-name</dt>
 262 <dd> Specifies the CGI environment variable to change,
 263    such as PATH_INFO. If preceded by an exclamation point, the variable
 264    will be unset.</dd>
 265 <dt>value-expression</dt>
 266 <dd>Specifies the replacement value for the preceding environment variable.
 267    Backreferences, such as "$1", can be included from regular expression
 268    captures in <var>conditional-expression</var>. If omitted, the variable is
 269    set (or overridden) to an empty string &#8212; but see the Note below.</dd>
 270 </dl>
 271
 272 <div class="example"><pre class="prettyprint lang-config"># A basic, unconditional override
 273 ProxyFCGISetEnvIf "true" PATH_INFO "/example"
 274
 275 # Use an environment variable in the value
 276 ProxyFCGISetEnvIf "true" PATH_INFO "%{reqenv:SCRIPT_NAME}"
 277
 278 # Use captures in the conditions and backreferences in the replacement
 279 ProxyFCGISetEnvIf "reqenv('PATH_TRANSLATED') =~ m|(/.*prefix)(\d+)(.*)|" PATH_TRANSLATED "$1$3"</pre>
 280 </div>
 281
 282 <div class="note"><h3>Note: Unset vs. Empty</h3>
 283   The following will unset <code>VARIABLE</code>, preventing it from being sent
 284   to the FastCGI server:
 285
 286     <pre class="prettyprint lang-config">ProxyFCGISetEnvIf true !VARIABLE</pre>
 287
 288
 289   Whereas the following will erase any existing <em>value</em> of
 290   <code>VARIABLE</code> (by setting it to the empty string), but the empty
 291   <code>VARIABLE</code> will still be sent to the server:
 292
 293     <pre class="prettyprint lang-config">ProxyFCGISetEnvIf true VARIABLE</pre>
 294
 295
 296   The CGI/1.1 specification
 297   <a href="https://tools.ietf.org/html/rfc3875#section-4.1">does not
 298   distinguish</a> between a variable with an empty value and a variable that
 299   does not exist. However, many CGI and FastCGI implementations distinguish (or
 300   allow scripts to distinguish) between the two. The choice of which to use is
 301   dependent upon your implementation and your reason for modifying the variable.
 302 </div>
 303
 304
 305 </div>
 306 </div>
 307 <div class="bottomlang">
 308 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_fcgi.html" title="English">&nbsp;en&nbsp;</a> |
 309 <a href="../fr/mod/mod_proxy_fcgi.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
 310 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 311 <script type="text/javascript"><!--//--><![CDATA[//><!--
 312 var comments_shortname = 'httpd';
 313 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_proxy_fcgi.html';
 314 (function(w, d) {
 315     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 316         d.write('<div id="comments_thread"><\/div>');
 317         var s = d.createElement('script');
 318         s.type = 'text/javascript';
 319         s.async = true;
 320         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 321         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 322     }
 323     else {
 324         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 325     }
 326 })(window, document);
 327 //--><!]]></script></div><div id="footer">
 328 <p class="apache">Copyright 2017 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
 329 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 330 if (typeof(prettyPrint) !== 'undefined') {
 331     prettyPrint();
 332 }
 333 //--><!]]></script>
 334 </body></html>