github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/manual/mod/mod_proxy_scgi.html.en (about) 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_scgi - Apache HTTP Server Version 2.2</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" /><link href="http://httpd.apache.org/docs/current/mod/mod_proxy_scgi.html" rel="canonical" /></head> 18 <body> 19 <div id="page-header"> 20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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.2</p> 22 <img alt="" src="../images/feather.gif" /></div> 23 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> 24 <div id="path"> 25 <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.2</a> > <a href="./">Modules</a></div> 26 <div id="page-content"> 27 <div class="retired"><h4>Please note</h4> 28 <p> This document refers to a legacy release (<strong>2.2</strong>) of Apache httpd. The active release (<strong>2.4</strong>) is documented <a href="http://httpd.apache.org/docs/current">here</a>. If you have not already upgraded, please follow <a href="http://httpd.apache.org/docs/current/upgrading.html">this link</a> for more information.</p> 29 <p>You may follow <a href="http://httpd.apache.org/docs/current/mod/mod_proxy_scgi.html">this link</a> to go to the current version of this document.</p></div><div id="preamble"><h1>Apache Module mod_proxy_scgi</h1> 30 <div class="toplang"> 31 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_scgi.html" title="English"> en </a> | 32 <a href="../ja/mod/mod_proxy_scgi.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p> 33 </div> 34 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>SCGI gateway module for <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></td></tr> 35 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr> 36 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>proxy_scgi_module</td></tr> 37 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_proxy_scgi.c</td></tr> 38 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.2.14 and later</td></tr></table> 39 <h3>Summary</h3> 40 41 <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 42 <a href="http://python.ca/scgi/protocol.txt">SCGI protocol, version 43 1</a>.</p> 44 45 <p>Thus, in order to get the ability of handling the SCGI protocol, 46 <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> and <code class="module"><a href="../mod/mod_proxy_scgi.html">mod_proxy_scgi</a></code> have to 47 be present in the server.</p> 48 49 <div class="warning"><h3>Warning</h3> 50 <p>Do not enable proxying until you have <a href="mod_proxy.html#access">secured your server</a>. Open proxy 51 servers are dangerous both to your network and to the Internet at 52 large.</p> 53 </div> 54 </div> 55 <div id="quickview"><h3>Topics</h3> 56 <ul id="topics"> 57 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li> 58 </ul><h3 class="directives">Directives</h3> 59 <ul id="toc"> 60 <li><img alt="" src="../images/down.gif" /> <a href="#proxyscgiinternalredirect">ProxySCGIInternalRedirect</a></li> 61 <li><img alt="" src="../images/down.gif" /> <a href="#proxyscgisendfile">ProxySCGISendfile</a></li> 62 </ul> 63 <h3>See also</h3> 64 <ul class="seealso"> 65 <li><code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></li> 66 <li><code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code></li> 67 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 68 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 69 <div class="section"> 70 <h2><a name="examples" id="examples">Examples</a></h2> 71 <p>Remember, in order to make the following examples work, you have to 72 enable <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> and <code class="module"><a href="../mod/mod_proxy_scgi.html">mod_proxy_scgi</a></code>.</p> 73 74 <div class="example"><h3>Simple gateway</h3><p><code> 75 ProxyPass /scgi-bin/ scgi://localhost:4000/ 76 </code></p></div> 77 78 <p>The balanced gateway needs <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code> in 79 addition to the already mentioned proxy modules.</p> 80 81 <div class="example"><h3>Balanced gateway</h3><p><code> 82 ProxyPass /scgi-bin/ balancer://somecluster/<br /> 83 <Proxy balancer://somecluster/><br /> 84 <span class="indent"> 85 BalancerMember scgi://localhost:4000/<br /> 86 BalancerMember scgi://localhost:4001/<br /> 87 </span> 88 </Proxy> 89 </code></p></div> 90 </div> 91 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 92 <div class="directive-section"><h2><a name="ProxySCGIInternalRedirect" id="ProxySCGIInternalRedirect">ProxySCGIInternalRedirect</a> <a name="proxyscgiinternalredirect" id="proxyscgiinternalredirect">Directive</a></h2> 93 <table class="directive"> 94 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable or disable internal redirect responses from the 95 backend</td></tr> 96 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxySCGIInternalRedirect On|Off</code></td></tr> 97 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxySCGIInternalRedirect On</code></td></tr> 98 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr> 99 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> 100 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_scgi</td></tr> 101 </table> 102 <p>The <code class="directive">ProxySCGIInternalRedirect</code> enables the backend 103 to internally redirect the gateway to a different URL. This feature 104 origins in <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>, which internally redirects the 105 response, if the response status is <code>OK</code> (<code>200</code>) and 106 the response contains a <code>Location</code> header and its value starts 107 with a slash (<code>/</code>). This value is interpreted as a new local 108 URL the apache internally redirects to.</p> 109 110 <p><code class="module"><a href="../mod/mod_proxy_scgi.html">mod_proxy_scgi</a></code> does the same as 111 <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code> in this regard, except that you can turn off the 112 feature.</p> 113 114 <div class="example"><h3>Example</h3><p><code> 115 ProxySCGIInternalRedirect Off 116 </code></p></div> 117 118 </div> 119 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 120 <div class="directive-section"><h2><a name="ProxySCGISendfile" id="ProxySCGISendfile">ProxySCGISendfile</a> <a name="proxyscgisendfile" id="proxyscgisendfile">Directive</a></h2> 121 <table class="directive"> 122 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable evaluation of <var>X-Sendfile</var> pseudo response 123 header</td></tr> 124 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxySCGISendfile On|Off|<var>Headername</var></code></td></tr> 125 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxySCGISendfile Off</code></td></tr> 126 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr> 127 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> 128 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_scgi</td></tr> 129 </table> 130 <p>The <code class="directive">ProxySCGISendfile</code> directive enables the 131 SCGI backend to let files serve directly by the gateway. This is useful 132 performance purposes -- the httpd can use <code>sendfile</code> or other 133 optimizations, which are not possible if the file comes over the backend 134 socket.</p> 135 <p>The <code class="directive">ProxySCGISendfile</code> argument determines the 136 gateway behaviour:</p> 137 <dl> 138 <dt><code>Off</code></dt> 139 <dd>No special handling takes place.</dd> 140 141 <dt><code>On</code></dt> 142 <dd>The gateway looks for a backend response header called 143 <code>X-Sendfile</code> and interprets the value as filename to serve. The 144 header is removed from the final response headers. This is equivalent to 145 <code>ProxySCGISendfile X-Sendfile</code>.</dd> 146 147 <dt>anything else</dt> 148 <dd>Similar to <code>On</code>, but instead of the hardcoded header name 149 the argument is applied as header name.</dd> 150 </dl> 151 152 <div class="example"><h3>Example</h3><p><code> 153 # Use the default header (X-Sendfile)<br /> 154 ProxySCGISendfile On<br /> 155 <br /> 156 # Use a different header<br /> 157 ProxySCGISendfile X-Send-Static 158 </code></p></div> 159 160 </div> 161 </div> 162 <div class="bottomlang"> 163 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_scgi.html" title="English"> en </a> | 164 <a href="../ja/mod/mod_proxy_scgi.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p> 165 </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&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> 166 <script type="text/javascript"><!--//--><![CDATA[//><!-- 167 var comments_shortname = 'httpd'; 168 var comments_identifier = 'http://httpd.apache.org/docs/2.2/mod/mod_proxy_scgi.html'; 169 (function(w, d) { 170 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 171 d.write('<div id="comments_thread"><\/div>'); 172 var s = d.createElement('script'); 173 s.type = 'text/javascript'; 174 s.async = true; 175 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 176 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 177 } 178 else { 179 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 180 } 181 })(window, document); 182 //--><!]]></script></div><div id="footer"> 183 <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> 184 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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[//><!-- 185 if (typeof(prettyPrint) !== 'undefined') { 186 prettyPrint(); 187 } 188 //--><!]]></script> 189 </body></html>