2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
4 <!-- $LastChangedRevision$ -->
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
14 http://www.apache.org/licenses/LICENSE-2.0
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.
23 <modulesynopsis metafile="mod_proxy_fcgi.xml.meta">
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>
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>
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>
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 for
48 <note type="warning"><title>Warning</title>
49 <p>Do not enable proxying until you have <a
50 href="mod_proxy.html#access">secured your server</a>. Open proxy
51 servers are dangerous both to your network and to the Internet at
56 <seealso><program>fcgistarter</program></seealso>
57 <seealso><module>mod_proxy</module></seealso>
59 <section id="examples"><title>Examples</title>
60 <p>Remember, in order to make the following examples work, you have to
61 enable <module>mod_proxy</module> and <module>mod_proxy_fcgi</module>.</p>
63 <example><title>Single application instance</title>
64 ProxyPass /myapp/ fcgi://localhost:4000/
67 <p>This application should be able to handle multiple concurrent
68 connections. <module>mod_proxy</module> enables connection reuse by
69 default, so after a request has been completed the connection will be
70 held open by that httpd child process and won't be reused until that
71 httpd process routes another request to the application. If the
72 FastCGI application is unable to handle enough concurrent connections
73 from httpd, requests can block waiting for the application to close
74 an existing connection. One way to resolve this is to disable connection
75 reuse on the <directive>ProxyPass</directive> directive, as shown in
76 the following example:</p>
78 <example><title>Single application instance, no connection reuse</title>
79 ProxyPass /myapp/ fcgi://localhost:4000/ disablereuse=on
82 <p>The balanced gateway needs <module>mod_proxy_balancer</module> and
83 at least one load balancer algorithm module, such as
84 <module>mod_lbmethod_byrequests</module>, in addition to the proxy
85 modules listed above. <module>mod_lbmethod_byrequests</module> is the
86 default, and will be used for this example configuration.</p>
88 <example><title>Balanced gateway to multiple application instances</title>
89 ProxyPass /myapp/ balancer://myappcluster/<br />
90 <Proxy balancer://myappcluster/><br />
92 BalancerMember fcgi://localhost:4000/<br />
93 BalancerMember fcgi://localhost:4001/<br />