From: Graham Leggett Date: Sat, 29 Sep 2001 19:58:38 +0000 (+0000) Subject: Updated mod_proxy.html docs to include v2.0 configuration. X-Git-Tag: 2.0.26~152 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7b459ee2914e56c3866105bb538f037cbf18fd67;p=thirdparty%2Fapache%2Fhttpd.git Updated mod_proxy.html docs to include v2.0 configuration. PR: Obtained from: Submitted by: Reviewed by: git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@91198 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/mod_proxy.html b/docs/manual/mod/mod_proxy.html index daa4d668dc7..3163648158f 100644 --- a/docs/manual/mod/mod_proxy.html +++ b/docs/manual/mod/mod_proxy.html @@ -15,16 +15,16 @@
Warning: -This document has not been updated to take into account changes +This document has been updated to take into account changes made in the 2.0 version of the Apache HTTP Server. Some of the -information may still be relevant, but please use it +information may still be inaccurate, please use it with care.

Apache module mod_proxy

-

This module provides for an HTTP 1.0 caching proxy +

This module provides for an HTTP 1.1 proxy / gateway server.

Summary -This module implements a proxy/cache for Apache. It implements +This module implements a proxy/gateway for Apache. It implements proxying capability for FTP, CONNECT (for SSL), -HTTP/0.9, and -HTTP/1.0. +HTTP/0.9, +HTTP/1.0, and +HTTP/1.1. The module can be configured to connect to other proxy modules for these and other protocols. -

This module was experimental in Apache 1.1.x. As of Apache 1.2, mod_proxy -stability is greatly improved.

+

This module was experimental in Apache 1.1.x. Improvements and bugfixes +were made in Apache v1.2.x and Apache v1.3.x, then the module underwent a major +overhaul for Apache v2.0. The protocol support was upgraded to HTTP/1.1, +and filter support was enabled. +

Please note that the caching function present in mod_proxy up to Apache +v1.3.x has been removed from mod_proxy and will be incorporated +into a new module, mod_cache. +

Directives

Common configuration topics

+

Forward and Reverse Proxies

+ +Apache can be configured in both a forward and reverse +proxy configuration. + +

A forward proxy is an intermediate system that enables a browser to connect to a +remote network to which it normally does not have access. A forward proxy +can also be used to cache data, reducing load on the networks between the +forward proxy and the remote webserver. + +

Apache's mod_proxy can be figured to +behave like a forward proxy using the ProxyRemote +directive. In addition, caching of data can be achieved by configuring +Apache mod_cache. Other dedicated forward proxy packages include +Squid. + +

A reverse proxy is a webserver system that is capable of serving webpages +sourced from other webservers - in addition to webpages on disk or generated +dynamically by CGI - making these pages look like they originated at the +reverse proxy. + +

When configured with the mod_cache module the reverse +proxy can act as a cache for slower backend webservers. The reverse proxy +can also enable advanced URL strategies and management techniques, allowing +webpages served using different webserver systems or architectures to +coexist inside the same URL space. Reverse proxy systems are also ideal for +implementing centralised logging websites with many or diverse website +backends. Complex multi-tier webserver systems can be constructed using an +Apache mod_proxy frontend and any number of backend webservers. + +

The reverse proxy is configured using the +ProxyPass and ProxyPassReverse directives. Caching can be +enabled using mod_cache as with the forward proxy. +

Controlling access to your proxy

You can control who can access your proxy via the normal <Directory> @@ -106,12 +148,16 @@ Allow from [machines you'd like to allow by IP address or name] A <Files> block will also work, and is the only method known to work for all possible URLs in Apache versions earlier than 1.2b10.

-

Using Netscape hostname shortcuts

+When configuring a reverse proxy, access control takes on the attributes of +the normal server configuration. + +

Why doesn't file type xxx download via FTP?

@@ -133,12 +179,12 @@ suffixing the request with ;type=a to force an ASCII transfer.

Why does Apache start more slowly when using the proxy module?

-If you're using the ProxyBlock or NoCache -directives, hostnames' IP addresses are looked up and cached during +If you're using the ProxyBlock +directive, hostnames' IP addresses are looked up and cached during startup for later match test. This may take a few seconds (or more) depending on the speed with which the hostname lookups occur.

-

Can I use the Apache proxy module with my SOCKS proxy?

+

What other functions are useful for an intranet proxy server?

An Apache proxy server situated in an intranet needs to forward external @@ -205,9 +251,12 @@ since the user's bookmark files will then contain fully qualified hosts.

>Compatibility: ProxyRequests is only available in Apache 1.1 and later.

-This allows or prevents Apache from functioning as a proxy -server. Setting ProxyRequests to 'off' does not disable use of the ProxyPass directive. +This allows or prevents Apache from functioning as a forward proxy +server. (Setting ProxyRequests to 'off' does not disable use of the ProxyPass directive.) + +

In a typical reverse proxy configuration, this option should be set to +'off'.

@@ -266,6 +315,10 @@ In the last example, the proxy will forward FTP requests, encapsulated as yet another HTTP proxy request, to another proxy which can handle them. +

This option also supports reverse proxy configuration - a backend webserver +can be embedded within a virtualhost URL space even if that server is hidden +by another forward proxy. +

ProxyPass directive

@@ -346,8 +399,9 @@ internally converted into a proxy request to >Compatibility: ProxyPassReverse is only available in Apache 1.3b6 and later.

-This directive lets Apache adjust the URL in the Location header on -HTTP redirect responses. For instance this is essential when Apache is used as +This directive lets Apache adjust the URL in the Location, +Content-Location and URI headers on +HTTP redirect responses. This is essential when Apache is used as a reverse proxy to avoid by-passing the reverse proxy because of HTTP redirects on the backend servers which stay behind the reverse proxy.

@@ -759,64 +813,7 @@ additionally have the Apache server version shown as a Via: comment Via: header lines removed. No new Via: header will be generated. -

- -

NoCache directive

-Syntax: NoCache *|word|host|domain - [word|host|domain] ...
-Default: None
-Context: server config, virtual host
-Override: Not applicable
-Status: Base
-Module: mod_proxy
-Compatibility: NoCache is only available in -Apache 1.1 and later. In addition, in Apache 2.0 and later, it is -always on, for all hosts.

- -From httpd-1.3: -The NoCache directive specifies a list of words, hosts and/or domains, separated -by spaces. HTTP and non-passworded FTP documents from matched words, hosts or -domains are not cached by the proxy server. The proxy module will -also attempt to determine IP addresses of list items which may be hostnames -during startup, and cache them for match test as well. Example: - -

-  NoCache joes-garage.com some-host.co.uk bullwinkle.wotsamattau.edu
-
- -'bullwinkle.wotsamattau.edu' would also be matched if referenced by IP -address.

- -Note that 'wotsamattau' would also be sufficient to match 'wotsamattau.edu'.

- -Note also that - -

-NoCache *
-
- -disables caching completely.

+