diff --git a/docs/manual/mod/mod_disk_cache.xml b/docs/manual/mod/mod_disk_cache.xml index f99ba96872..d53cb68727 100644 --- a/docs/manual/mod/mod_disk_cache.xml +++ b/docs/manual/mod/mod_disk_cache.xml @@ -4,52 +4,57 @@ mod_disk_cache -Content cache keyed to URIs +Content cache storage manager keyed to URIs Experimental mod_disk_cache.c disk_cache_module + + This module is experimental. Documentation is still under development... + - -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.

- +

mod_disk_cache implements a disk based storage manager. It is primarily of + use in conjunction with mod_proxy.

+

Content is stored in and retrieved from the cache using URI based keys. Content with + access protection is not cached.

+ + Note: +

mod_disk_cache requires the services of mod_cache.

+ CacheRoot The directory root under which cache files are stored -CacheRoot directory +CacheRoot directory none -server config +server configvirtual host + -

The CacheRoot directive defines the name of the directory - on the disk to contain cache files. If the mod_disk_cache module has been loaded - or compiled in to the Apache server, this directive must be defined. Failing to - provide a value for CacheRoot will result in a configuration +

The CacheRoot directive defines the name of the + directory on the disk to contain cache files. If the + mod_disk_cache module has been loaded or compiled in to the + Apache server, this directive must be defined. Failing to provide a + value for CacheRoot will result in a configuration file processing error. The CacheDirLevels and - CacheDirLength directives define the structure of the directories - under the specified root directory.

+ CacheDirLength directives define the structure of + the directories under the specified root directory.

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

The CacheSize directive sets the desired disk space @@ -66,198 +71,243 @@ This module is experimental. Documentation is still under development... CacheGcInterval -The interval between garbage collections -CacheGcInterval hours -server config +The interval between garbage collection attempts. +CacheGcInterval hours +server configvirtual host + +

The CacheGcInterval directive specifies the + number of hours to wait between attempts to free up disk space.

+

More detail will be added here, when the function is implemented.

- - CacheGcInterval 24
- - -The CacheGcInterval directive is currently not implemented. - + + CacheGcInterval 24
+ + + + The CacheGcInterval directive is currently + not implemented. + CacheDirLevels -The number of levels of subdirectories in the cache -CacheDirLevels levels +The number of levels of subdirectories in the cache. +CacheDirLevels levels CacheDirLevels 3 -server config +server configvirtual host +

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

+ subdirectory levels in the cache. Cached data will be saved this many + directory levels below the CacheRoot directory.

- -

CacheDirLevels*CacheDirLength value must not be higher than 20.

- - - CacheDirLevels 5
- + +

The result of CacheDirLevels* + CacheDirLength must not be higher than 20.

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

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

+ characters for each subdirectory name in the cache hierarchy.

- -

CacheDirLevels*CacheDirLength value must not be higher than 20.

- - - CacheDirLength 4
- + +

The result of CacheDirLevels* + CacheDirLength must not be higher than 20.

+ + + + CacheDirLength 4
+ CacheExpiryCheck -On if cache observes Expires date when seeking files -CacheExpiryCheck binary -CacheExpiryCheck ? -server config +Indicates if the cache observes Expires dates when seeking +files +CacheExpiryCheck On|Off +CacheExpiryCheck On +server configvirtual host + +

More detail will be added here, when the function is implemented.

- - CacheExpiryCheck On
- - -The CacheExpiryCheck directive is currently not implemented. - + + CacheExpiryCheck Off
+ + + + The CacheExpiryCheck directive is currently + not implemented. + CacheMinFileSize -The minimum size (in bytes) of a file to be placed in the cache -CacheMinFileSize bytes +The minimum size (in bytes) of a document to be placed in the +cache +CacheMinFileSize bytes CacheMinFileSize 1 -server config +server configvirtual host +

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

+ size, in bytes, for a document to be considered for storage in the cache.

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

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

+ size, in bytes, for a document to be considered for storage in the cache.

- - CacheMaxFileSize 64000
- + + CacheMaxFileSize 64000
+ CacheTimeMargin The minimum time margin to cache a document -CacheTimeMargin ? +CacheTimeMargin ? CacheTimeMargin ? -server config +server configvirtual host + +

More detail will be added here, when the function is implemented.

- - CacheTimeMargin
- + + CacheTimeMargin X
+ + + + The CacheTimeMargin directive is currently + not implemented. + CacheGcDaily -The time of day for garbage collection (24 hour clock) -CacheGcDaily time +The recurring time each day for garbage collection to be run. +(24 hour clock) +CacheGcDaily time CacheGcDaily ? -server config +server configvirtual host + +

More detail will be added here, when the function is implemented.

- - CacheGcDaily
- - -The CacheGcDaily directive is currently not implemented. - + + CacheGcDaily 23:59
+ + + + The CacheGcDaily directive is currently + not implemented. + CacheGcUnused -The time in hours to retain unused file that match a url -CacheGcUnused hours +The time to retain unreferenced cached files that match a URL. +CacheGcUnused hours url-string CacheGcUnused ? -server config +server configvirtual host + +

More detail will be added here, when the function is implemented.

- - CacheGcUnused
- - -The CacheGcUnused directive is currently not implemented. - + + CacheGcUnused 12 /local_images
+ + + + The CacheGcUnused directive is currently + not implemented. + CacheGcClean -The time in hours to retain unchanged files that match a url -CacheGcClean hours +The time to retain unchanged cached files that match a URL +CacheGcClean hours url-string CacheGcClean ? -server config +server configvirtual host + +

More detail will be added here, when the function is implemented.

- - CacheGcClean
- - -The CacheGcClean directive is currently not implemented. - + + CacheGcClean 12 /daily_scripts
+ + + + The CacheGcClean directive is currently + not implemented. + CacheGcMemUsage The maximum kilobytes of memory used for garbage collection -CacheGcMemUsage KBytes +CacheGcMemUsage KBytes CacheGcMemUsage ? -server config +server configvirtual host + +

More detail will be added here, when the function is implemented.

- - CacheGcMemUsage
- - -The CacheGcMemUsage directive is currently not implemented. - + + CacheGcMemUsage 16
+ + + + The CacheGcMemUsage directive is currently + not implemented. +