From: Graham Leggett Date: Sat, 29 Sep 2001 19:55:24 +0000 (+0000) Subject: chuck: Docco update X-Git-Tag: 2.0.26~154 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7887bb471ea0c373a90c3576cc48c468f1d1496d;p=thirdparty%2Fapache%2Fhttpd.git chuck: Docco update PR: Obtained from: Submitted by: Reviewed by: git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@91196 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/mod_proxy.html b/docs/manual/mod/mod_proxy.html index 08fbc43c2d3..765e4df9aef 100644 --- a/docs/manual/mod/mod_proxy.html +++ b/docs/manual/mod/mod_proxy.html @@ -75,15 +75,6 @@ stability is greatly improved.

  • NoProxy
  • ProxyDomain
  • ProxyVia -
  • CacheRoot -
  • CacheSize -
  • CacheMaxExpire -
  • CacheDefaultExpire -
  • CacheLastModifiedFactor -
  • CacheGcInterval -
  • CacheDirLevels -
  • CacheDirLength -
  • CacheForceCompletion
  • NoCache @@ -770,365 +761,6 @@ additionally have the Apache server version shown as a Via: comment
    -

    CacheForceCompletion directive

    -Syntax: CacheForceCompletion percentage
    -Default: 90
    -Context: server config, virtual host
    -Override: Not applicable
    -Status: Base
    -Module: mod_proxy
    -Compatibility: CacheForceCompletion is only available in -Apache 1.3.1 and later.

    - -If an http transfer that is being cached is cancelled, the proxy module will -complete the transfer to cache if more than the percentage specified has -already been transferred.

    - -This is a percentage, and must be a number between 1 and 100, or 0 to use -the default. 100 will cause a document to be cached only if the transfer -was allowed to complete. A number between 60 and 90 is recommended. - -


    - -

    CacheRoot directive

    -Syntax: CacheRoot directory
    -Default: None
    -Context: server config, virtual host
    -Override: Not applicable
    -Status: Base
    -Module: mod_proxy
    -Compatibility: CacheRoot is only available in -Apache 1.1 and later.

    - -Sets the name of the directory to contain cache files; this must be -writable by the httpd server. -(see the User directive).
    -Setting CacheRoot enables proxy cacheing; without defining -a CacheRoot, proxy functionality will be available -if ProxyRequests are set to On, but no -cacheing will be available. - -


    - -

    CacheSize directive

    -Syntax: CacheSize kilobytes
    -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 -usage may grow above this setting, the garbage collection will delete files -until the usage is at or below this setting.
    -Depending on the expected proxy traffic volume and CacheGcInterval, -use a value which is at least 20 to 40 % lower than the available space. - -


    - -

    CacheGcInterval directive

    -Syntax: CacheGcInterval hours
    -Default: None
    -Context: server config, virtual host
    -Override: Not applicable
    -Status: Base
    -Module: mod_proxy
    -Compatibility: CacheGcinterval is only available in -Apache 1.1 and later.

    - -Check the cache after the specified number of hours, and -delete files if the space usage is greater than that set by -CacheSize. Note that hours accepts a float value, you could for -example use CacheGcInterval 1.5 to check the cache every -90 minutes. (If unset, no garbage collection will be performed, and -the cache will grow indefinitely.) Note also that the larger the -CacheGcInterval, the more extra space beyond the -configured CacheSize will be needed for the cache between -garbage collections.
    - -


    - -

    CacheMaxExpire directive

    -Syntax: CacheMaxExpire hours
    -Default: CacheMaxExpire 24
    -Context: server config, virtual host
    -Override: Not applicable
    -Status: Base
    -Module: mod_proxy
    -Compatibility: CacheMaxExpire is only available in -Apache 1.1 and later.

    - -

    Specifies the maximum number of hours for which cachable HTTP -documents will be retained without checking the origin server. Thus, -documents will be out of date at most this number of hours -This restriction is enforced even if an expiry date was supplied with -the document.

    - -
    - -

    CacheLastModifiedFactor directive

    -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 -Apache 1.1 and later.

    - -If the origin HTTP server did not supply an expiry date for the -document, then estimate one using the formula -

    -  expiry-period = time-since-last-modification * factor
    -
    -For example, if the document was last modified 10 hours ago, and -factor is 0.1, then the expiry period will be set to 10*0.1 = 1 hour. - -

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


    - -

    CacheDirLevels directive

    -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 -Apache 1.1 and later.

    - -CacheDirLevels sets the number of levels of subdirectories in -the cache. Cached data will be saved this many directory levels below -CacheRoot. - -


    - -

    CacheDirLength directive

    -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 -Apache 1.1 and later.

    - -CacheDirLength sets the number of characters in proxy cache subdirectory names. - -


    - -

    CacheDefaultExpire directive

    -Syntax: CacheDefaultExpire hours
    -Default: CacheDefaultExpire 1
    -Context: server config, virtual host
    -Override: Not applicable
    -Status: Base
    -Module: mod_proxy
    -Compatibility: CacheDefaultExpire is only available in -Apache 1.1 and later.

    - -If the document is fetched via a protocol that does not support expiry times, -then use the specified number of hours as the expiry time. -CacheMaxExpire does not -override this setting. - -


    -

    NoCache directive

    Compatibility: NoCache is only available in -Apache 1.1 and later.

    +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