]> git.ipfire.org Git - thirdparty/apache/httpd.git/commitdiff
Restructure ProxyPass directive doc
authorMike Rumph <mrumph@apache.org>
Wed, 19 Aug 2015 16:18:23 +0000 (16:18 +0000)
committerMike Rumph <mrumph@apache.org>
Wed, 19 Aug 2015 16:18:23 +0000 (16:18 +0000)
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1696622 13f79535-47bb-0310-9956-ffa450edef68

docs/manual/mod/mod_proxy.html.en
docs/manual/mod/mod_proxy.xml

index 8abe679615612e6bc4240090c25ea01c5c8d3320..7b30cedb93e35dd5273f728f99a17e7e0144ac4f 100644 (file)
@@ -1022,6 +1022,12 @@ through</td></tr>
     the <code>[P,NE]</code> option to prevent the <code>'|'</code> character
     from being escaped.</div>
 
+    <p>When used inside a <code class="directive"><a href="../mod/core.html#location">&lt;Location&gt;</a></code> section, the first argument is omitted and the local
+    directory is obtained from the <code class="directive"><a href="../mod/core.html#location">&lt;Location&gt;</a></code>. The same will occur inside a
+    <code class="directive"><a href="../mod/core.html#locationmatch">&lt;LocationMatch&gt;</a></code> section;
+    however, ProxyPass does not interpret the regexp as such, so it is necessary
+    to use <code class="directive">ProxyPassMatch</code> in this situation instead.</p>
+
     <p>Suppose the local server has address <code>http://example.com/</code>;
     then</p>
 
@@ -1034,6 +1040,12 @@ through</td></tr>
     <code>http://example.com/mirror/foo/bar</code> to be internally converted
     into a proxy request to <code>http://backend.example.com/bar</code>.</p>
 
+    <p>The ProxyPass directive is not supported in <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code> or <code class="directive"><a href="../mod/core.html#files">&lt;Files&gt;</a></code> sections.</p>
+
+    <p>If you require a more flexible reverse-proxy configuration, see the
+    <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> directive with the
+    <code>[P]</code> flag.</p>
+
     <p>The following alternative syntax is possible; however, it can carry a
     performance penalty when present in very large numbers. The advantage of
     the below syntax is that it allows for dynamic control via the
@@ -1087,6 +1099,8 @@ ProxyPass "/mirror/foo"   "http://backend.example.com"</pre>
 
     </div> 
 
+    <p><strong>ProxyPass <code>key=value</code> Parameters</strong></p>
+
     <p>In Apache HTTP Server 2.1 and later, mod_proxy supports pooled
     connections to a backend server.  Connections created on demand
     can be retained in a pool for future use.  Limits on the pool size
@@ -1409,7 +1423,7 @@ ProxyPass "/"             "balancer://mycluster/" stickysession=JSESSIONID|jsess
 
 
     <p>Setting up a hot-standby that will only be used if no other
-     members are available</p>
+     members are available:</p>
     <pre class="prettyprint lang-config">ProxyPass "/" "balancer://hotcluster/"
 &lt;Proxy balancer://hotcluster&gt;
     BalancerMember ajp://1.2.3.4:8009 loadfactor=1
@@ -1420,6 +1434,8 @@ ProxyPass "/"             "balancer://mycluster/" stickysession=JSESSIONID|jsess
 &lt;/Proxy&gt;</pre>
 
 
+    <p><strong>Additional ProxyPass Keywords</strong></p>
+
     <p>Normally, mod_proxy will canonicalise ProxyPassed URLs.
     But this may be incompatible with some backends, particularly those
     that make use of <var>PATH_INFO</var>.  The optional <var>nocanon</var>
@@ -1433,18 +1449,6 @@ ProxyPass "/"             "balancer://mycluster/" stickysession=JSESSIONID|jsess
     The optional <var>noquery</var> keyword (available in
     httpd 2.4.1 and later) prevents this.</p>
 
-    <p>When used inside a <code class="directive"><a href="../mod/core.html#location">&lt;Location&gt;</a></code> section, the first argument is omitted and the local
-    directory is obtained from the <code class="directive"><a href="../mod/core.html#location">&lt;Location&gt;</a></code>. The same will occur inside a
-    <code class="directive"><a href="../mod/core.html#locationmatch">&lt;LocationMatch&gt;</a></code> section;
-    however, ProxyPass does not interpret the regexp as such, so it is necessary
-    to use <code class="directive">ProxyPassMatch</code> in this situation instead.</p>
-
-    <p>This directive is not supported in <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code> or <code class="directive"><a href="../mod/core.html#files">&lt;Files&gt;</a></code> sections.</p>
-
-    <p>If you require a more flexible reverse-proxy configuration, see the
-    <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> directive with the
-    <code>[P]</code> flag.</p>
-
     <p>The optional <var>interpolate</var> keyword, in combination with
     <code class="directive">ProxyPassInterpolateEnv</code>, causes the ProxyPass
     to interpolate environment variables, using the syntax
index 269954f0051cfe578e4b62f886c0a5161eca66d1..56dc4450dfaf92fcaaf412863c0e9c3af6ce7dc5 100644 (file)
@@ -883,6 +883,14 @@ expressions</description>
     the <code>[P,NE]</code> option to prevent the <code>'|'</code> character
     from being escaped.</note>
 
+    <p>When used inside a <directive type="section" module="core"
+    >Location</directive> section, the first argument is omitted and the local
+    directory is obtained from the <directive type="section" module="core"
+    >Location</directive>. The same will occur inside a
+    <directive type="section" module="core">LocationMatch</directive> section;
+    however, ProxyPass does not interpret the regexp as such, so it is necessary
+    to use <directive>ProxyPassMatch</directive> in this situation instead.</p>
+
     <p>Suppose the local server has address <code>http://example.com/</code>;
     then</p>
 
@@ -896,6 +904,14 @@ expressions</description>
     <code>http://example.com/mirror/foo/bar</code> to be internally converted
     into a proxy request to <code>http://backend.example.com/bar</code>.</p>
 
+    <p>The ProxyPass directive is not supported in <directive type="section" module="core"
+    >Directory</directive> or <directive type="section" module="core"
+    >Files</directive> sections.</p>
+
+    <p>If you require a more flexible reverse-proxy configuration, see the
+    <directive module="mod_rewrite">RewriteRule</directive> directive with the
+    <code>[P]</code> flag.</p>
+
     <p>The following alternative syntax is possible; however, it can carry a
     performance penalty when present in very large numbers. The advantage of
     the below syntax is that it allows for dynamic control via the
@@ -952,6 +968,8 @@ ProxyPass "/mirror/foo"   "http://backend.example.com"
 
     </note> <!-- /ordering_proxypass -->
 
+    <p><strong>ProxyPass <code>key=value</code> Parameters</strong></p>
+
     <p>In Apache HTTP Server 2.1 and later, mod_proxy supports pooled
     connections to a backend server.  Connections created on demand
     can be retained in a pool for future use.  Limits on the pool size
@@ -1278,7 +1296,7 @@ ProxyPass "/"             "balancer://mycluster/" stickysession=JSESSIONID|jsess
     </highlight>
 
     <p>Setting up a hot-standby that will only be used if no other
-     members are available</p>
+     members are available:</p>
     <highlight language="config">
 ProxyPass "/" "balancer://hotcluster/"
 &lt;Proxy balancer://hotcluster&gt;
@@ -1290,6 +1308,8 @@ ProxyPass "/" "balancer://hotcluster/"
 &lt;/Proxy&gt;
     </highlight>
 
+    <p><strong>Additional ProxyPass Keywords</strong></p>
+
     <p>Normally, mod_proxy will canonicalise ProxyPassed URLs.
     But this may be incompatible with some backends, particularly those
     that make use of <var>PATH_INFO</var>.  The optional <var>nocanon</var>
@@ -1303,22 +1323,6 @@ ProxyPass "/" "balancer://hotcluster/"
     The optional <var>noquery</var> keyword (available in
     httpd 2.4.1 and later) prevents this.</p>
 
-    <p>When used inside a <directive type="section" module="core"
-    >Location</directive> section, the first argument is omitted and the local
-    directory is obtained from the <directive type="section" module="core"
-    >Location</directive>. The same will occur inside a
-    <directive type="section" module="core">LocationMatch</directive> section;
-    however, ProxyPass does not interpret the regexp as such, so it is necessary
-    to use <directive>ProxyPassMatch</directive> in this situation instead.</p>
-
-    <p>This directive is not supported in <directive type="section" module="core"
-    >Directory</directive> or <directive type="section" module="core"
-    >Files</directive> sections.</p>
-
-    <p>If you require a more flexible reverse-proxy configuration, see the
-    <directive module="mod_rewrite">RewriteRule</directive> directive with the
-    <code>[P]</code> flag.</p>
-
     <p>The optional <var>interpolate</var> keyword, in combination with
     <directive>ProxyPassInterpolateEnv</directive>, causes the ProxyPass
     to interpolate environment variables, using the syntax