From: Mike Rumph Date: Wed, 19 Aug 2015 16:18:23 +0000 (+0000) Subject: Restructure ProxyPass directive doc X-Git-Tag: 2.5.0-alpha~2942 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2cc9b103f5145a7e142e47864efdc6b4dae62b4b;p=thirdparty%2Fapache%2Fhttpd.git Restructure ProxyPass directive doc git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1696622 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/mod_proxy.html.en b/docs/manual/mod/mod_proxy.html.en index 8abe6796156..7b30cedb93e 100644 --- a/docs/manual/mod/mod_proxy.html.en +++ b/docs/manual/mod/mod_proxy.html.en @@ -1022,6 +1022,12 @@ through the [P,NE] option to prevent the '|' character from being escaped. +

When used inside a <Location> section, the first argument is omitted and the local + directory is obtained from the <Location>. The same will occur inside a + <LocationMatch> section; + however, ProxyPass does not interpret the regexp as such, so it is necessary + to use ProxyPassMatch in this situation instead.

+

Suppose the local server has address http://example.com/; then

@@ -1034,6 +1040,12 @@ through http://example.com/mirror/foo/bar to be internally converted into a proxy request to http://backend.example.com/bar.

+

The ProxyPass directive is not supported in <Directory> or <Files> sections.

+ +

If you require a more flexible reverse-proxy configuration, see the + RewriteRule directive with the + [P] flag.

+

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" +

ProxyPass key=value Parameters

+

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

Setting up a hot-standby that will only be used if no other - members are available

+ members are available:

ProxyPass "/" "balancer://hotcluster/"
 <Proxy balancer://hotcluster>
     BalancerMember ajp://1.2.3.4:8009 loadfactor=1
@@ -1420,6 +1434,8 @@ ProxyPass "/"             "balancer://mycluster/" stickysession=JSESSIONID|jsess
 </Proxy>
+

Additional ProxyPass Keywords

+

Normally, mod_proxy will canonicalise ProxyPassed URLs. But this may be incompatible with some backends, particularly those that make use of PATH_INFO. The optional nocanon @@ -1433,18 +1449,6 @@ ProxyPass "/" "balancer://mycluster/" stickysession=JSESSIONID|jsess The optional noquery keyword (available in httpd 2.4.1 and later) prevents this.

-

When used inside a <Location> section, the first argument is omitted and the local - directory is obtained from the <Location>. The same will occur inside a - <LocationMatch> section; - however, ProxyPass does not interpret the regexp as such, so it is necessary - to use ProxyPassMatch in this situation instead.

- -

This directive is not supported in <Directory> or <Files> sections.

- -

If you require a more flexible reverse-proxy configuration, see the - RewriteRule directive with the - [P] flag.

-

The optional interpolate keyword, in combination with ProxyPassInterpolateEnv, causes the ProxyPass to interpolate environment variables, using the syntax diff --git a/docs/manual/mod/mod_proxy.xml b/docs/manual/mod/mod_proxy.xml index 269954f0051..56dc4450dfa 100644 --- a/docs/manual/mod/mod_proxy.xml +++ b/docs/manual/mod/mod_proxy.xml @@ -883,6 +883,14 @@ expressions the [P,NE] option to prevent the '|' character from being escaped. +

When used inside a Location section, the first argument is omitted and the local + directory is obtained from the Location. The same will occur inside a + LocationMatch section; + however, ProxyPass does not interpret the regexp as such, so it is necessary + to use ProxyPassMatch in this situation instead.

+

Suppose the local server has address http://example.com/; then

@@ -896,6 +904,14 @@ expressions http://example.com/mirror/foo/bar to be internally converted into a proxy request to http://backend.example.com/bar.

+

The ProxyPass directive is not supported in Directory or Files sections.

+ +

If you require a more flexible reverse-proxy configuration, see the + RewriteRule directive with the + [P] flag.

+

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" +

ProxyPass key=value Parameters

+

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

Setting up a hot-standby that will only be used if no other - members are available

+ members are available:

ProxyPass "/" "balancer://hotcluster/" <Proxy balancer://hotcluster> @@ -1290,6 +1308,8 @@ ProxyPass "/" "balancer://hotcluster/" </Proxy> +

Additional ProxyPass Keywords

+

Normally, mod_proxy will canonicalise ProxyPassed URLs. But this may be incompatible with some backends, particularly those that make use of PATH_INFO. The optional nocanon @@ -1303,22 +1323,6 @@ ProxyPass "/" "balancer://hotcluster/" The optional noquery keyword (available in httpd 2.4.1 and later) prevents this.

-

When used inside a Location section, the first argument is omitted and the local - directory is obtained from the Location. The same will occur inside a - LocationMatch section; - however, ProxyPass does not interpret the regexp as such, so it is necessary - to use ProxyPassMatch in this situation instead.

- -

This directive is not supported in Directory or Files sections.

- -

If you require a more flexible reverse-proxy configuration, see the - RewriteRule directive with the - [P] flag.

-

The optional interpolate keyword, in combination with ProxyPassInterpolateEnv, causes the ProxyPass to interpolate environment variables, using the syntax