From: Bill Stoddard Date: Wed, 3 Apr 2002 04:07:35 +0000 (+0000) Subject: First meager steps to documenting mod_cache X-Git-Tag: 2.0.35~52 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=c6b4bf8e37053b849df0b9cd90d2a26ef7edc7e2;p=apache First meager steps to documenting mod_cache git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@94408 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/mod_cache.xml b/docs/manual/mod/mod_cache.xml new file mode 100644 index 0000000000..be00e9cbbc --- /dev/null +++ b/docs/manual/mod/mod_cache.xml @@ -0,0 +1,192 @@ + + + + + +mod_cache +Content cache keyed to URIs +Experimental +mod_cache.c +cache_module + + + + +This module is experimental. Documentation is still under development... + +

mod_cache implements an RFC 2616 compliant HTTP content + cache that can be used to cache either local or proxied content. + mod_cache requires the services of one or more storage + management modules. Two storage management modules are included in + the base Apache distribution: mod_disk_cache implements a + disk based storage manager (generally used for proxy caching) and + mod_mem_cache implements an in-memory based storage + manager (primarily useful for caching local content).

+ +

Content stored and retrived keyed to the URL. Content with + access protections is not cached.

+ + + +
Sample Configuration + +Sample httpd.conf + +#
+# Sample Cache Configuration
+#
+LoadModule cache_module modules/mod_cache.so
+<IfModule mod_cache.c>
+ CacheOn On
+

+ #LoadModule disk_cache_module modules/mod_disk_cache.so
+ <IfModule mod_disk_cache.c>
+ CacheRoot c:/cacheroot
+ CacheEnable disk /
+ CacheDirLevels 5
+ CacheDirLength 3
+ </IfModule>
+

+ LoadModule mem_cache_module modules/mod_mem_cache.so
+ <IfModule mod_mem_cache.c>
+ CacheEnable mem /
+ CacheSize 4096
+ CacheMaxObjectCount 100
+ CacheMinObjectSize 1
+ CacheMaxObjectSize 2048
+ </IfModule>
+

+</IfModule>
+ + + +

+ + +CacheOn + +CacheOn +server config + + +

+

+ + + + CacheOn + + + + + +CacheEnable +Enable caching specified URLs in a specified storage manager +CacheEnable cache_type url-string +server config + + +

The CacheEnable directive instructs + mod_cache to cache urls at or below url-string. + The cache store is specified with the cache_type argument. + cache_type mem instructs mod_cache to use the + in-memory cache storage manager implemented by mod_mem_cache. + cache_type disk instructs mod_cache to use the + cache storage manager implemented by mod_disk_cache .

+ + + CacheEnable disk /
+ CacheEnable mem /manual + + + + + + +CacheDisable +Disable caching of specified URLs by specified storage manager +CacheDisable cache_type url-string +server config + + +

The CacheDisable directive instructs + mod_cache to not cache urls at or above url-string.

+ +Example + CacheDisable disk /local_files + + + + + +CacheMaxExpire +The maximum time in seconds to cache a document + +server config + + +

The maximum time in seconds to cache a document.

+ + CacheMaxExpire 604800 + + + + +CacheDefaultExpire + +server config + + +

The default time in seconds to cache a document.

+ + CacheDefaultExpire 86400 + + + + + +CacheIgnoreNoLastMod +Ignore responses where there is no Last Modified Header + +server config + + +

Ignore responses where there is no Last Modified Header

+ + + CacheIgnoreNoLastMod + + + + + +CacheIgnoreCacheControl +Ignore requests from the client for uncached content + +server config + + +

Ignore requests from the client for uncached content

+ + + CacheIgnoreNoLastMod + + + + + +CacheLastModifiedFactor +The factor used to estimate the Expires date from the LastModified date + +server config + + +

The factor used to estimate the Expires date from the LastModified date.

+ + + CacheLastModifiedFactor + + + + +