From 45a0aac2441dc2bee3d7d2314c8d25b4fed64282 Mon Sep 17 00:00:00 2001 From: Christophe Jaillet Date: Sat, 12 Jan 2019 08:54:34 +0000 Subject: [PATCH] Remove the default CacheKeyBaseURL value, it doesn't have any. Improve syntax highlight and hyper-links. (r1851152 in trunk) s/authorisation/authorization/ to be consitent (r1516864 in trunk) git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1851155 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/mod_cache.xml | 61 +++++++++++++++++------------------ 1 file changed, 30 insertions(+), 31 deletions(-) diff --git a/docs/manual/mod/mod_cache.xml b/docs/manual/mod/mod_cache.xml index 7723ddaebd3..6c903c1f3cc 100644 --- a/docs/manual/mod/mod_cache.xml +++ b/docs/manual/mod/mod_cache.xml @@ -179,7 +179,7 @@ LoadModule cache_module modules/mod_cache.so server, a significant number of requests might arrive during this time, and cause a thundering herd of requests to strike the backend suddenly and unpredictably.

-

To keep the thundering herd at bay, the CacheLock +

To keep the thundering herd at bay, the CacheLock directive can be used to define a directory in which locks are created for URLs in flight. The lock is used as a hint by other requests to either suppress an attempt to cache (someone else has @@ -213,8 +213,8 @@ LoadModule cache_module modules/mod_cache.so

As a further safety mechanism, locks have a configurable maximum age. Once this age has been reached, the lock is removed, and a new request is given the opportunity to create a new lock. This maximum age can be set using - the CacheLockMaxAge directive, and defaults to 5 - seconds. + the CacheLockMaxAge directive, and defaults + to 5 seconds.

@@ -246,14 +246,14 @@ LoadModule cache_module modules/mod_cache.so

While this mode offers the best performance, the administrator may find that under certain circumstances they may want to perform further processing on the request after the request is cached, such as to inject personalisation into the - cached page, or to apply authorisation restrictions to the content. Under these + cached page, or to apply authorization restrictions to the content. Under these circumstances, an administrator is often forced to place independent reverse proxy servers either behind or in front of the caching server to achieve this.

-

To solve this problem the CacheQuickHandler - directive can be set to off, and the server will +

To solve this problem the CacheQuickHandler + directive can be set to off, and the server will process all phases normally handled by a non-cached request, including the - authentication and authorisation phases.

+ authentication and authorization phases.

In addition, the administrator may optionally specify the precise point within the filter chain where caching is to take place by adding the @@ -344,19 +344,19 @@ CustomLog "invalidated-requests.log" common env=cache-invalidate manager CacheEnable cache_type [url-string] server configvirtual host -directory +directory + A url-string of '/' applied to forward proxy content in 2.2 and earlier. -

The CacheEnable directive instructs mod_cache to cache urls at or below url-string. The cache storage manager is specified with the cache_type argument. The CacheEnable directive can alternatively be placed inside either - Location or - LocationMatch sections to indicate + Location or + LocationMatch sections to indicate the content is cacheable. cache_type disk instructs mod_cache to use the disk based storage manager @@ -370,8 +370,8 @@ manager actually processes the request. The order in which the storage managers are run is determined by the order of the CacheEnable directives in the configuration file. CacheEnable - directives within Location or - LocationMatch sections are processed + directives within Location or + LocationMatch sections are processed before globally defined CacheEnable directives.

When acting as a forward proxy server, url-string must @@ -438,7 +438,7 @@ CacheEnable disk "http://.example.org/" -

If used in a Location directive, +

If used in a Location directive, the path needs to be specified below the Location, or if the word "on" is used, caching for the whole location will be disabled.

@@ -517,7 +517,7 @@ CacheEnable disk "http://.example.org/"

The CacheDefaultExpire directive specifies a default time, in seconds, to cache a document if neither an expiry date nor last-modified date are provided - with the document. The value specified with the CacheMaxExpire + with the document. The value specified with the CacheMaxExpire directive does not override this setting.

@@ -547,7 +547,7 @@ header. should be considered for caching, even without a last-modified date. If neither a last-modified date nor an expiry date are provided with the document then the value specified by the - CacheDefaultExpire directive will be used to + CacheDefaultExpire directive will be used to generate an expiration date.

@@ -565,7 +565,7 @@ header. -

Ordinarily, requests containing a Cache-Control: no-cache or +

Ordinarily, requests containing a Cache-Control: no-cache or Pragma: no-cache header value will not be served from the cache. The CacheIgnoreCacheControl directive allows this behavior to be overridden. CacheIgnoreCacheControl On @@ -641,7 +641,7 @@ LastModified date. expiry-date would be 3:00pm + 1hour = 4:00pm. If the expiry-period would be longer than that set by - CacheMaxExpire, then the latter takes + CacheMaxExpire, then the latter takes precedence.

@@ -787,7 +787,7 @@ LastModified date. -

Ordinarily, responses with Cache-Control: private header values will not +

Ordinarily, responses with Cache-Control: private header values will not be stored in the cache. The CacheStorePrivate directive allows this behavior to be overridden. CacheStorePrivate On @@ -821,7 +821,7 @@ LastModified date. -

Ordinarily, requests or responses with Cache-Control: no-store header +

Ordinarily, requests or responses with Cache-Control: no-store header values will not be stored in the cache. The CacheStoreNoStore directive allows this behavior to be overridden. CacheStoreNoStore On @@ -916,7 +916,7 @@ CacheLock on Apache HTTP Server 2.3.3 and later -

The CacheQuickHandler directive +

The CacheQuickHandler directive controls the phase in which the cache is handled.

In the default enabled configuration, the cache operates within the quick @@ -928,7 +928,7 @@ CacheLock on

When disabled, the cache operates as a normal handler, and is subject to the full set of phases when handling a server request. While this mode is slower than the default, it allows the cache to be used in cases where full - processing is required, such as when content is subject to authorisation.

+ processing is required, such as when content is subject to authorization.

# Run cache as a normal handler @@ -965,11 +965,11 @@ AddOutputFilterByType CACHE;INCLUDES;DEFLATE text/html Available in Apache 2.3.9 and later -

When the CacheHeader directive +

When the CacheHeader directive is switched on, an X-Cache header will be added to the response with the cache status of this response. If the normal handler is used, this - directive may appear within a Directory - or Location directive. If the quick + directive may appear within a Directory + or Location directive. If the quick handler is used, this directive must appear within a server or virtual host context, otherwise the setting will be ignored.

@@ -1007,7 +1007,7 @@ CacheHeader on Available in Apache 2.3.9 and later -

When the CacheDetailHeader directive +

When the CacheDetailHeader directive is switched on, an X-Cache-Detail header will be added to the response containing the detailed reason for a particular caching decision.

@@ -1017,8 +1017,8 @@ CacheHeader on used by the service and client.

If the normal handler is used, this directive may appear within a - Directory or - Location directive. If the quick handler + Directory or + Location directive. If the quick handler is used, this directive must appear within a server or virtual host context, otherwise the setting will be ignored.

@@ -1038,14 +1038,13 @@ CacheDetailHeader on CacheKeyBaseURL Override the base URL of reverse proxied cache keys. CacheKeyBaseURL URL -CacheKeyBaseURL http://example.com server config virtual host Available in Apache 2.3.9 and later -

When the CacheKeyBaseURL directive +

When the CacheKeyBaseURL directive is specified, the URL provided will be used as the base URL to calculate the URL of the cache keys in the reverse proxy configuration. When not specified, the scheme, hostname and port of the current virtual host is used to construct @@ -1078,7 +1077,7 @@ CacheKeyBaseURL "http://www.example.com/" Available in Apache 2.3.9 and later -

When the CacheStaleOnError directive +

When the CacheStaleOnError directive is switched on, and when stale data is available in the cache, the cache will respond to 5xx responses from the backend by returning the stale data instead of the 5xx response. While the Cache-Control headers sent by clients will be respected, -- 2.47.3