From: Bill Stoddard Date: Tue, 13 Aug 2002 23:01:13 +0000 (+0000) Subject: mod_cache doc updates. X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4d95ed1e4098e8da6c6a18feaf28593b48374ba1;p=apache mod_cache doc updates. Submitted by: Jean-Jacques Clar git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@96366 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/mod_cache.xml b/docs/manual/mod/mod_cache.xml index 56690df4ef..b81944aaa6 100644 --- a/docs/manual/mod/mod_cache.xml +++ b/docs/manual/mod/mod_cache.xml @@ -4,7 +4,7 @@ mod_cache -Content cache keyed to URIs +Content cache keyed to URIs. Experimental mod_cache.c cache_module @@ -20,17 +20,44 @@ This module is experimental. Documentation is still under development... management modules. Two storage management modules are included in the base Apache distribution:

-
mod_disk_cache
-
implements a disk based storage manager for use with mod_proxy
-
mod_mem_cache
+
mod_disk_cache
+
implements a disk based storage manager for use with mod_proxy
+
mod_mem_cache
implements an in-memory based storage manager. mod_mem_cache can be configured to operate in two modes: caching open file - descriptors or caching objects in heap storage. mod_mem_cache + descriptors or caching objects in heap storage. mod_mem_cache is most useful when used to cache locally generated content or to cache backend server content for mod_proxy configured for ProxyPass (aka reverse proxy)

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

+ + + + mod_disk_cache + mod_mem_cache + + + CacheRoot + CacheSize + CacheGcInterval + CacheDirLevels + CacheDirLength + CacheExpiryCheck + CacheMinFileSize + CacheMaxFileSize + CacheTimeMargin + CacheGcDaily + CacheGcUnused + CacheGcClean + CacheGcMemUsage + MCacheSize + MCacheMaxObjectCount + MCacheMinObjectSize + MCacheMaxObjectSize + MCacheRemovalAlgorithm + +
Sample Configuration @@ -47,7 +74,7 @@ LoadModule cache_module modules/mod_cache.so
#LoadModule disk_cache_module modules/mod_disk_cache.so
<IfModule mod_disk_cache.c>
CacheRoot c:/cacheroot
- CacheSize + CacheSize 256
CacheEnable disk /
CacheDirLevels 5
CacheDirLength 3
@@ -128,11 +155,13 @@ LoadModule cache_module modules/mod_cache.so
CacheMaxExpire The maximum time in seconds to cache a document - +CacheMaxExpire seconds +CacheMaxExpire 86400 (one day) server config -

The maximum time in seconds to cache a document.

+

The maximum time in seconds to cache a document. The CacheMaxExpire + takes precedence over the Expire field from the header.

CacheMaxExpire 604800 @@ -140,11 +169,13 @@ LoadModule cache_module modules/mod_cache.so
CacheDefaultExpire - +CacheDefaultExpire seconds +CacheDefaultExpire 3600 (one hour) server config -

The default time in seconds to cache a document.

+

The default time in seconds to cache a document if the page does not have + an expiry date in the Expires field.

CacheDefaultExpire 86400 @@ -154,7 +185,7 @@ LoadModule cache_module modules/mod_cache.so
CacheIgnoreNoLastMod Ignore responses where there is no Last Modified Header - +CacheIgnoreNoLastMod server config @@ -169,7 +200,7 @@ LoadModule cache_module modules/mod_cache.so
CacheIgnoreCacheControl Ignore requests from the client for uncached content - +CacheIgnoreCacheControl server config @@ -184,7 +215,8 @@ LoadModule cache_module modules/mod_cache.so
CacheLastModifiedFactor The factor used to estimate the Expires date from the LastModified date - +CacheLastModifiedFactor float +CacheLastModifiedFactor 0.1 server config @@ -196,4 +228,42 @@ LoadModule cache_module modules/mod_cache.so
+ +CacheForceCompletion +Percentage of download to arrive for the cache to force complete transfert +CacheLastModifiedFactor Percentage +CacheLastModifiedFactor 60 +server config + + +

Percentage of download to arrive for the cache to force complete transfert.

+ + + CacheForceCompletion + + +This feature is currently not implemented. + + + + + +CacheForceCompletion +Percentage of download to arrive for the cache to force complete transfert +CacheLastModifiedFactor Percentage +CacheLastModifiedFactor 60 +server config + + +

Percentage of download to arrive for the cache to force complete transfert.

+ + + CacheForceCompletion + + +This feature is currently not implemented. + + + + diff --git a/docs/manual/mod/mod_disk_cache.xml b/docs/manual/mod/mod_disk_cache.xml new file mode 100644 index 0000000000..5c415f7f51 --- /dev/null +++ b/docs/manual/mod/mod_disk_cache.xml @@ -0,0 +1,259 @@ + + + + + +mod_disk_cache +Content cache keyed to URIs +Experimental +mod_disk_cache.c +disk_cache_module + + + + +This module is experimental. Documentation is still under development... + +

mod_disk_cache implements a disk based storage manager for use with mod_proxy.

+

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

+ +

mod_disk_cache requires the services of mod_cache.

+ + + + +CacheRoot +The directory to store cache files +CacheRoot directory +none +server config + + +

The CacheRoot directive defines the name of the directory + on the disk to contain cache files. What is happening if not set ?

+ + + CacheRoot c:/cacheroot
+ + + + + +CacheSize +The maximum amount of disk space that will be used by the cache in KBytes +CacheSize KBytes +CacheSize 1000000 +server config + + +

The MCacheSize directive sets the desired disk space + usage of the cache, in KBytes (1024-byte units). This directive does not put a + hard limit on the size of the cache. The garbage collector will delete files + until the usage is at or below the settings. Always use a value that is lower + than the available disk space.

+ + + MCacheSize 5000000
+ + + + + +CacheGcInterval +The interval between garbage collections +CacheGcInterval hours +server config + + + + + CacheGcInterval 24
+ + +The CacheGcInterval directive is currently not implemented. + + + + + +CacheDirLevels +The number of levels of subdirectories in the cache +CacheDirLevels levels +CacheDirLevels 3 +server config + + +

The CacheDirLevels directive sets the number of + subdirectory levels in the cache. Cached data will be saved this many directory + levels below CacheRoot

+ + +

CacheDirLevels*CacheDirLength value must not be higher than 20.

+ + + CacheDirLevels 5
+ + + + + +CacheDirLength +The number of characters in subdirectory names +CacheDirLength length +CacheDirLength 2 +server config + + +

The CacheDirLength directive sets the number of + characters for each subdirectory in the cache

+ + +

CacheDirLevels*CacheDirLength value must not be higher than 20.

+ + + CacheDirLength 4
+ + + + + +CacheExpiryCheck +On if cache observes Expires date when seeking files +CacheExpiryCheck binary +CacheExpiryCheck ? +server config + + + + + CacheExpiryCheck On
+ + +The CacheExpiryCheck directive is currently not implemented. + + + + + +CacheMinFileSize +The minimum size (in bytes) of a file to be placed in the cache +CacheMinFileSize bytes +CacheMinFileSize 1 +server config + + +

The CacheMinFileSize directive sets the minimum + size in bytes of a file to be cached.

+ + + CacheMinFileSize 64
+ + + + + +CacheMaxFileSize +The maximum size (in bytes) of a file to be placed in the cache +CacheMaxFileSize bytes +CacheMaxFileSize 1000000 +server config + + +

The CacheMaxFileSize directive sets the maximum + size in bytes of a file to be cached.

+ + + CacheMaxFileSize 64000
+ + + + + +CacheTimeMargin +The minimum time margin to cache a document +CacheTimeMargin ? +CacheTimeMargin ? +server config + + + + + CacheTimeMargin
+ + + + + +CacheGcDaily +The time of day for garbage collection (24 hour clock) +CacheGcDaily time +CacheGcDaily ? +server config + + + + + CacheGcDaily
+ + +The CacheGcDaily directive is currently not implemented. + + + + + +CacheGcUnused +The time in hours to retain unused file that match a url +CacheGcUnused hours +CacheGcUnused ? +server config + + + + + CacheGcUnused
+ + +The CacheGcUnused directive is currently not implemented. + + + + + +CacheGcClean +The time in hours to retain unchanged files that match a url +CacheGcClean hours +CacheGcClean ? +server config + + + + + CacheGcClean
+ + +The CacheGcClean directive is currently not implemented. + + + + + +CacheGcMemUsage +The maximum kilobytes of memory used for garbage collection +CacheGcMemUsage KBytes +CacheGcMemUsage ? +server config + + + + + CacheGcMemUsage
+ + +The CacheGcMemUsage directive is currently not implemented. + + + + + \ No newline at end of file diff --git a/docs/manual/mod/mod_mem_cache.xml b/docs/manual/mod/mod_mem_cache.xml new file mode 100644 index 0000000000..b3cd5433c8 --- /dev/null +++ b/docs/manual/mod/mod_mem_cache.xml @@ -0,0 +1,139 @@ + + + + + +mod_mem_cache +Content cache keyed to URIs +Experimental +mod_mem_cache.c +mem_cache_module + + + + +This module is experimental. Documentation is still under development... + +

mod_mem_cache implements an in-memory based storage manager. + mod_mem_cache can be configured to operate in two modes: caching open file + descriptors or caching objects in heap storage. mod_mem_cache + is most useful when used to cache locally generated content or to cache + backend server content for mod_proxy configured for ProxyPass + (aka reverse proxy)

+ +

mod_mem_cache requires the services of mod_cache.

+ +

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

+ + + +MCacheSize +The maximum amount of memory used by the cache in KBytes +MCacheSize KBytes +MCacheSize 100 +server config + + +

The MCacheSize directive sets the desired space + usage of the cache, in KBytes (1024-byte units). If a new entry needs to be + inserted in the cache and the size of the entry is greather than the + remaining size, entries will be removed until the new entry could be cached. + The removed entry is decided base on the MCacheRemovalAlgorithm algorithm

+ + + The size must be greater than MCacheMaxObjectSize. + + + + MCacheSize 700000
+ + + + + +MCacheMaxObjectCount +The maximum number of objects allowed to be placed in the cache +MCacheMaxObjectCount value +MCacheMaxObjectCount 1009 +server config + + +

The MCacheMaxObjectCount directive sets the maximum + number of objects to be cached. If a new entry needs to be + inserted in the cache and the maximum number of objects is reached, an entry + will be removed to allow the new entry be cached.

+ + + The size must be greater than MCacheMinObjectSize. + + + + The value of MCacheMaxObjectCount is used to create + the open hash table. + + + MCacheMaxObjectCount 13001
+ + + + + +MCacheMinObjectSize +The minimum size (in bytes) of an object to be placed in the cache +MCacheMinObjectSize bytes +MCacheMinObjectSize 0 +server config + + +

The MCacheMinObjectSize directive sets the minimum + size in bytes of an object to be cached.

+ + + MCacheMinObjectSize 10000
+ + + + + +MCacheMaxObjectSize +The maximum size (in bytes) of an object to be placed in the cache +MCacheMaxObjectSize bytes +MCacheMaxObjectSize 10000 +server config + + +

The MCacheMaxObjectSize directive sets the maximum + size of an object to be cached.

+ + + MCacheMaxObjectSize 6400000
+ + + + + +MCacheRemovalAlgorithm +The algorithm used to remove entries from the cache +MCacheRemovalAlgorithm algorithm +MCacheRemovalAlgorithm GDSF +server config + + +

The MCacheRemovalAlgorithm directive sets the algorithm + used to remove entries from the cache. + Two choices are available:
+ LRU (Least Recently Used): LRU removes the objects that have not been + accessed for the longest time.
+ GDSF (GreadyDual-Size): This algorithm assigns priority to cached objects + based on the coast of a cache miss and the size of the object. Objects with + smallest priority are removed first.

+ + + MCacheRemovalAlgorithm GDSF
+ MCacheRemovalAlgorithm LRU
+ + + + + \ No newline at end of file