Return-Path: Delivered-To: apache-cvs-archive@hyperreal.org Received: (qmail 25311 invoked by uid 6000); 15 Oct 1997 14:45:29 -0000 Received: (qmail 25291 invoked by uid 161); 15 Oct 1997 14:45:27 -0000 Date: 15 Oct 1997 14:45:27 -0000 Message-ID: <19971015144527.25290.qmail@hyperreal.org> From: coar@hyperreal.org To: apache-cvs@hyperreal.org Subject: cvs commit: apachen/htdocs/manual/mod directive-dict.html directives.html mod_example.html mod_proxy.html Sender: apache-cvs-owner@apache.org Precedence: bulk Reply-To: new-httpd@apache.org coar 97/10/15 07:45:27 Modified: htdocs/manual/mod directives.html mod_example.html mod_proxy.html Added: htdocs/manual/mod directive-dict.html Log: Clean up some typos in the proxy documentation, and add a dictionary for the directive attributes (status, override, et cetera) - part of the directive-documentation-normalisation effort, and something I've wanted for a long time. Updated the mod_example page to use the links to the dictionary (as an example ;-). Revision Changes Path 1.34 +9 -1 apachen/htdocs/manual/mod/directives.html Index: directives.html =================================================================== RCS file: /export/home/cvs/apachen/htdocs/manual/mod/directives.html,v retrieving revision 1.33 retrieving revision 1.34 diff -u -r1.33 -r1.34 --- directives.html 1997/09/12 09:38:03 1.33 +++ directives.html 1997/10/15 14:45:24 1.34 @@ -14,7 +14,15 @@ >

Apache Directives

- +

+Each Apache directive available in the standard Apache distribution is +listed here. They are described using a consistent format, and there is +a dictionary +of the terms used in their descriptions available. +

AccessConfig

AccessFileName 1.5 +33 -7 apachen/htdocs/manual/mod/mod_example.html Index: mod_example.html =================================================================== RCS file: /export/home/cvs/apachen/htdocs/manual/mod/mod_example.html,v retrieving revision 1.4 retrieving revision 1.5 diff -u -r1.4 -r1.5 --- mod_example.html 1997/09/11 13:27:50 1.4 +++ mod_example.html 1997/10/15 14:45:25 1.5 @@ -117,20 +117,46 @@ Example

- Syntax: Example + Syntax: Example
- Default: None + Default: None
- Context: server config, virtual host, directory, .htaccess + Context: server config, virtual host, directory, + .htaccess
- Override: Options + Override: Options
- Status: Extension + Status: Extension
- Module: mod_example + Module: mod_example +
+ Compatibility: Example is only + available in Apache 1.2 and later.

- The Example directive activates the example module's content handler + The Example directive activates the example module's + content handler for a particular location or file type. It takes no arguments. If you browse to an URL to which the example content-handler applies, you will get a display of the routines within the module and how and in 1.29 +95 -33 apachen/htdocs/manual/mod/mod_proxy.html Index: mod_proxy.html =================================================================== RCS file: /export/home/cvs/apachen/htdocs/manual/mod/mod_proxy.html,v retrieving revision 1.28 retrieving revision 1.29 diff -u -r1.28 -r1.29 --- mod_proxy.html 1997/07/21 04:41:57 1.28 +++ mod_proxy.html 1997/10/15 14:45:25 1.29 @@ -17,13 +17,15 @@ This module is contained in the mod_proxy.c file for Apache 1.1.x, or the modules/proxy subdirectory for Apache 1.2, and -is not compiled in by default. It provides for an HTTP 1.0 caching proxy +is not compiled in by default. It provides for an HTTP +1.0 caching proxy server. It is only available in Apache 1.1 and later. Common configuration -questions are addressed here. +questions are addressed after the directive +descriptions.

Note:

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

+stability is greatly improved.

Summary

@@ -61,18 +63,23 @@ Syntax: ProxyRequests on/off
Default: ProxyRequests Off
Context: server config, virtual host
+Override: Not applicable
Status: Base
Module: mod_proxy
-Compatibility: ProxyRequest is only available in +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. +

ProxyRemote

Syntax: ProxyRemote <match> <remote-server>
+Default: None
Context: server config, virtual host
+Override: Not applicable
Status: Base
Module: mod_proxy
Compatibility: ProxyRemote is only available in @@ -90,7 +97,7 @@ <protocol> is the protocol that should be used to communicate with the remote server; only "http" is supported by this module. - +

Example:

ProxyRemote http://goodguys.com/ http://mirrorguys.com:8000 @@ -102,9 +109,13 @@ as yet another HTTP proxy request, to another proxy which can handle them. +

ProxyPass

Syntax: ProxyPass <path> <url>
+Default: None
Context: server config, virtual host
+Override: Not applicable
Status: Base
Module: mod_proxy
Compatibility: ProxyPass is only available in @@ -114,17 +125,23 @@ server; the local server does not act as a proxy in the conventional sense, but appears to be a mirror of the remote server. <path> is the name of a local virtual path; <url> is a partial URL for the remote server. - -Suppose the local server has address http://wibble.org; then +

+Suppose the local server has address http://wibble.org/; then

      ProxyPass /mirror/foo http://foo.com

-Will cause a local request for the http://wibble.org/mirror/foo/bar to be -internally converted into a proxy request to http://foo.com/bar +will cause a local request for the +<http://wibble.org/mirror/foo/bar> to be +internally converted into a proxy request to +<http://foo.com/bar>. + +

ProxyBlock

Syntax: ProxyBlock <word/host/domain list>
+Default: None
Context: server config, virtual host
+Override: Not applicable
Status: Base
Module: mod_proxy
Compatibility: ProxyBlock is only available in @@ -152,23 +169,29 @@ blocks connections to all sites. +

NoProxy

Syntax: NoProxy { <Domain> | <SubNet> | <IpAddr> | <Hostname> }
+Default: None
Context: server config, virtual host
+Override: Not applicable
Status: Base
Module: mod_proxy
Compatibility: NoProxy is only available in Apache 1.3 and later.

-This directive is only useful for apache proxy servers within intranets. +This directive is only useful for Apache proxy servers within intranets. The NoProxy directive specifies a list of subnets, IP addresses, hosts and/or domains, separated by spaces. A request to a host which matches one or more of these is always served directly, without forwarding to -the configured ProxyRemote proxy server(s).
Example: +the configured ProxyRemote proxy server(s). +

+Example:

ProxyRemote * http://firewall.mycompany.com:81 @@ -178,7 +201,7 @@

Domain +

Domain

A Domain is a partially qualified DNS domain name, preceded by a period. It represents a list of hosts which logically belong to the same DNS @@ -198,7 +221,7 @@ -

SubNet +

SubNet

A SubNet is a partially qualified internet address in numeric (dotted quad) form, optionally followed by a slash and the netmask, specified as the number of significant bits in the @@ -223,29 +246,33 @@ -

IPAddr +

IPAddr

A IPAddr represents a fully qualified internet address in numeric (dotted quad) form. Usually, this address represents a host, but there need not necessarily be a DNS domain name connected with the address.
Example: 192.168.123.7
- Note: An IPAddr does not need to be resolved by the DNS system, so - it can result in more effective apache performance.
-

See Also: -DNS Issues

+ Note: An IPAddr does not need to be resolved by the DNS + system, so it can result in more effective apache performance. +

See Also: + DNS Issues

Hostname +

Hostname

A Hostname is a fully qualified DNS domain name which can - be resolved to one or more IPAddrs via the DNS domain name service. - It represents a logical host (in contrast to Domains, see - above) and must be resolvable to at least one IPAddr (or - often to a list of hosts with different IPAddr's).
+ be resolved to one or more IPAddrs via the DNS domain name service. + It represents a logical host (in contrast to + Domains, see + above) and must be resolvable to at least one IPAddr (or often to a list of hosts + with different IPAddr's).
Examples: prep.ai.mit.edu www.apache.org.
Note: In many situations, it is more effective to specify an - IPAddr in place of a Hostname since a DNS lookup + IPAddr in place of a + Hostname since a DNS lookup can be avoided. Name resolution in Apache can take a remarkable deal of time when the connection to the name server uses a slow PPP link.
@@ -258,20 +285,25 @@ DNS Issues

ProxyDomain

Syntax: ProxyDomain <Domain>
+Default: None
Context: server config, virtual host
+Override: Not applicable
Status: Base
Module: mod_proxy
Compatibility: ProxyDomain is only available in Apache 1.3 and later.

-This directive is only useful for apache proxy servers within intranets. +This directive is only useful for Apache proxy servers within intranets. The ProxyDomain directive specifies the default domain which the apache proxy server will belong to. If a request to a host without a domain name is encountered, a redirection response to the same host with the configured Domain appended will be generated. -
Example: +

+Example:

     ProxyRemote  *  http://firewall.mycompany.com:81
  @@ -279,9 +311,13 @@
     ProxyDomain     .mycompany.com

CacheRoot

Syntax: CacheRoot <directory>
+Default: None
Context: server config, virtual host
+Override: Not applicable
Status: Base
Module: mod_proxy
Compatibility: CacheRoot is only available in @@ -291,22 +327,29 @@ writable by the httpd server. +

CacheSize

Syntax: CacheSize <size>
Default: CacheSize 5
Context: server config, virtual host
+Override: Not applicable
Status: Base
Module: mod_proxy
Compatibility: CacheSize is only available in Apache 1.1 and later.

-Sets the desired space usage of the cache, in Kb (1024 byte units). Although +Sets the desired space usage of the cache, in KB (1024-byte units). Although usage may grow above this setting, the garbage collection will delete files until the usage is at or below this setting. +

CacheGcInterval

Syntax: CacheGcInterval <time>
+Default: None
Context: server config, virtual host
+Override: Not applicable
Status: Base
Module: mod_proxy
Compatibility: CacheGcinterval is only available in @@ -315,10 +358,13 @@ Check the cache every <time> hours, and delete files if the space usage is greater than that set by CacheSize. +

CacheMaxExpire

Syntax: CacheMaxExpire <time>
Default: CacheMaxExpire 24
Context: server config, virtual host
+Override: Not applicable
Status: Base
Module: mod_proxy
Compatibility: CacheMaxExpire is only available in @@ -329,10 +375,13 @@ hours out of date. This restriction is enforced even if an expiry date was supplied with the document. +

CacheLastModifiedFactor

Syntax: CacheLastModifiedFactor <factor>
Default: CacheLastModifiedFactor 0.1
Context: server config, virtual host
+Override: Not applicable
Status: Base
Module: mod_proxy
Compatibility: CacheLastModifiedFactor is only available in @@ -349,10 +398,13 @@

If the expiry-period would be longer than that set by CacheMaxExpire, then the latter takes precedence. +

CacheDirLevels

Syntax: CacheDirLevels <levels>
Default: CacheDirLevels 3
Context: server config, virtual host
+Override: Not applicable
Status: Base
Module: mod_proxy
Compatibility: CacheDirLevels is only available in @@ -361,10 +413,13 @@ CacheDirLevels sets the number of levels of subdirectories in the cache. Cached data will be saved this many directory levels below CacheRoot. +

CacheDirLength

Syntax: CacheDirLength <length>
Default: CacheDirLength 1
Context: server config, virtual host
+Override: Not applicable
Status: Base
Module: mod_proxy
Compatibility: CacheDirLength is only available in @@ -372,10 +427,13 @@ CacheDirLength sets the number of characters in proxy cache subdirectory names. +

CacheDefaultExpire

Syntax: CacheDefaultExpire <time>
Default: CacheDefaultExpire 1
Context: server config, virtual host
+Override: Not applicable
Status: Base
Module: mod_proxy
Compatibility: CacheDefaultExpire is only available in @@ -384,11 +442,15 @@ If the document is fetched via a protocol that does not support expiry times, then use <time> hours as the expiry time. CacheMaxExpire does not -override. +override this setting. + +

NoCache

Syntax: NoCache <word/host/domain list>
+Default: None
Context: server config, virtual host
+Override: Not applicable
Status: Base
Module: mod_proxy
Compatibility: NoCache is only available in @@ -424,7 +486,7 @@

Controlling access to your proxy
Using Netscape hostname shortcuts -
Why doesn't file type xxx download via FTP? +
Why doesn't file type xxx download via FTP?
Why does Apache start more slowly when using the proxy module?

Can I use the Apache proxy module with my SOCKS proxy? @@ -456,10 +518,10 @@ here.

Why doesn't file type xxx download via FTP?

You probably don't have that particular file type defined as -application/octet-stream in your proxy's mime.types configuration +application/octet-stream in your proxy's mime.types configuration file. A useful line can be

@@ -477,10 +539,10 @@

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

Yes. Just build Apache with the rule SOCKS4=yes in your -Configuration file, and follow the instructions there. SOCKS5 +Configuration file, and follow the instructions there. SOCKS5 capability can be added in a similar way (there's no SOCKS5 rule yet), so use the EXTRA_LDFLAGS definition, or build Apache -normally and run it with the runsocks wrapper provided with SOCKS5, +normally and run it with the runsocks wrapper provided with SOCKS5, if your OS supports dynamically linked libraries.

Some users have reported problems when using SOCKS version 4.2 on Solaris. 1.1 apachen/htdocs/manual/mod/directive-dict.html Index: directive-dict.html =================================================================== Definitions of terms used to describe Apache directives

Terms Used to Describe Apache Directives

Each Apache configuration directive is described using a common format that looks like this:

Syntax: directive-name some args
Default: directive-name default-value
Context: context-list
Override: override
Status: status
Module: module-name
Compatibility: compatibility notes

Each of the directive's attributes, complete with possible values where possible, are described in this document.

Syntax

This indicates the format of the directive as it would appear in a configuration file. This syntax is extremely directive-specific, so refer to the text of the directive's description for details.

Default

If the directive has a default value (i.e., if you omit it from your configuration entirely, the Apache Web server will behave as though you set it to a particular value), it is described here. If there is no default value, this section should say "None".

Context

This indicates where in the server's configuration files the directive is legal. It's a comma-separated list of one or more of the following values:

server config: This means that the directive may be used in the server configuration files (e.g., httpd.conf, srm.conf, and access.conf), but not within any <VirtualHost> or <Directory> containers. It is not allowed in .htaccess files at all.
virtual host: This context means that the directive may appear inside <VirtualHost> containers in the server configuration files.
directory: A directive marked as being valid in this context may be used inside <Directory> containers in the server configuration files.
.htaccess: If a directive is valid in this context, it means that it can appear inside per-directory .htaccess files. It may not be processed, though depending upon the overrides currently active.

The directive is only allowed within the designated context; if you try to use it elsewhere, you'll get a configuration error that will either prevent the server from handling requests in that context correctly, or will keep the server from operating at all -- i.e., the server won't even start.

The valid locations for the directive are actually the result of a Boolean OR of all of the listed contexts. In other words, a directive that is marked as being valid in "server config, .htaccess" can be used in the httpd.conf file and in .htaccess files, but not within any <Directory> or <VirtualHost> containers.

Override

This directive attribute indicates which configuration override must be active in order for the directive to be processed when it appears in a .htaccess file. If the directive's context doesn't permit it to appear in .htaccess files, this attribute should say "Not applicable".

Overrides are activated by the AllowOverrides directive, and apply to a particular scope (such as a directory) and all descendants, unless further modified by other AllowOverrides directives at lower levels. The documentation for that directive also lists the possible override names available.

Status

This indicates how tightly bound into the Apache Web server the directive is; in other words, you may need to recompile the server with an enhanced set of modules in order to gain access to the directive and its functionality. Possible values for this attribute are:

Core: If a directive is listed as having "Core" status, that means it is part of the innermost portions of the Apache Web server, and is always available.
Base: A directive labeled as having "Base" status is supported by one of the standard Apache modules which is compiled into the server by default, and is therefore normally available unless you've taken steps to remove the module from your configuration.
Extension: A directive with "Extension" status is provided by one of the modules included with the Apache server kit, but the module isn't normally compiled into the server. To enable the directive and its functionality, you will need to change the server build configuration files and re-compile Apache.
Experimental: "Experimental" status indicates that the directive is available as part of the Apache kit, but you're on your own if you try to use it. The directive is being documented for completeness, and is not necessarily supported. The module which provides the directive may or may not be compiled in by default; check the top of the page which describes the directive and its module to see if it remarks on the availability.

Module

This quite simply lists the name of the source module which defines the directive.

Compatibility

If the directive wasn't part of the original Apache version 1 distribution, the version in which it was introduced should be listed here. If the directive has the same name as one from the NCSA HTTPd server, any inconsistencies in behaviour between the two should also be mentioned. Otherwise, this attribute should say "No compatibility issues."