mod_disk_cache - Apache HTTP Server

From 0658952d7b1121fcfc08a4b72e0c742611906d32 Mon Sep 17 00:00:00 2001 From: Erik Abele Date: Fri, 16 Aug 2002 22:41:06 +0000 Subject: [PATCH] Fixed missing transformations git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@96422 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/mod_disk_cache.html.en | 201 +++++++++++++++++++++++++ docs/manual/mod/mod_mem_cache.html.en | 113 ++++++++++++++ 2 files changed, 314 insertions(+) create mode 100644 docs/manual/mod/mod_disk_cache.html.en create mode 100644 docs/manual/mod/mod_mem_cache.html.en diff --git a/docs/manual/mod/mod_disk_cache.html.en b/docs/manual/mod/mod_disk_cache.html.en new file mode 100644 index 0000000000..8e9fb07ea3 --- /dev/null +++ b/docs/manual/mod/mod_disk_cache.html.en @@ -0,0 +1,201 @@ +mod_disk_cache - Apache HTTP Server

Apache HTTP Server Version 2.0
Apache Module mod_disk_cache
Description: + Content cache keyed to URIs
Status: + Experimental
Module Identifier: + disk_cache_module
Summary
+ +
+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.
+
+
Directives
CacheDirLength
CacheDirLevels
CacheExpiryCheck
CacheGcClean
CacheGcDaily
CacheGcInterval
CacheGcMemUsage
CacheGcUnused
CacheMaxFileSize
CacheMinFileSize
CacheRoot
CacheSize
CacheTimeMargin
CacheDirLength Directive
Description: + The number of characters in subdirectory names
Syntax: + CacheDirLength length
Default: + CacheDirLength 2
Context: + server config
Status: + Experimental
Module: + mod_disk_cache
+
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 +
+
CacheDirLevels Directive
Description: + The number of levels of subdirectories in the cache
Syntax: + CacheDirLevels levels
Default: + CacheDirLevels 3
Context: + server config
Status: + Experimental
Module: + mod_disk_cache
+
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 +
+
CacheExpiryCheck Directive
Description: + On if cache observes Expires date when seeking files
Syntax: + CacheExpiryCheck binary
Default: + CacheExpiryCheck ?
Context: + server config
Status: + Experimental
Module: + mod_disk_cache
+ +
+ CacheExpiryCheck On +
+
+The CacheExpiryCheck directive is currently not implemented. +
+
CacheGcClean Directive
Description: + The time in hours to retain unchanged files that match a url
Syntax: + CacheGcClean hours
Default: + CacheGcClean ?
Context: + server config
Status: + Experimental
Module: + mod_disk_cache
+ +
+ CacheGcClean +
+
+The CacheGcClean directive is currently not implemented. +
+
CacheGcDaily Directive
Description: + The time of day for garbage collection (24 hour clock)
Syntax: + CacheGcDaily time
Default: + CacheGcDaily ?
Context: + server config
Status: + Experimental
Module: + mod_disk_cache
+ +
+ CacheGcDaily +
+
+The CacheGcDaily directive is currently not implemented. +
+
CacheGcInterval Directive
Description: + The interval between garbage collections
Syntax: + CacheGcInterval hours
Context: + server config
Status: + Experimental
Module: + mod_disk_cache
+ +
+ CacheGcInterval 24 +
+
+The CacheGcInterval directive is currently not implemented. +
+
CacheGcMemUsage Directive
Description: + The maximum kilobytes of memory used for garbage collection
Syntax: + CacheGcMemUsage KBytes
Default: + CacheGcMemUsage ?
Context: + server config
Status: + Experimental
Module: + mod_disk_cache
+ +
+ CacheGcMemUsage +
+
+The CacheGcMemUsage directive is currently not implemented. +
+
CacheGcUnused Directive
Description: + The time in hours to retain unused file that match a url
Syntax: + CacheGcUnused hours
Default: + CacheGcUnused ?
Context: + server config
Status: + Experimental
Module: + mod_disk_cache
+ +
+ CacheGcUnused +
+
+The CacheGcUnused directive is currently not implemented. +
+
CacheMaxFileSize Directive
Description: + The maximum size (in bytes) of a file to be placed in the cache
Syntax: + CacheMaxFileSize bytes
Default: + CacheMaxFileSize 1000000
Context: + server config
Status: + Experimental
Module: + mod_disk_cache
+
The CacheMaxFileSize directive sets the maximum + size in bytes of a file to be cached.
+ +
+ CacheMaxFileSize 64000 +
+
CacheMinFileSize Directive
Description: + The minimum size (in bytes) of a file to be placed in the cache
Syntax: + CacheMinFileSize bytes
Default: + CacheMinFileSize 1
Context: + server config
Status: + Experimental
Module: + mod_disk_cache
+
The CacheMinFileSize directive sets the minimum + size in bytes of a file to be cached.
+ +
+ CacheMinFileSize 64 +
+
CacheRoot Directive
Description: + The directory to store cache files
Syntax: + CacheRoot directory
Default: + none
Context: + server config
Status: + Experimental
Module: + mod_disk_cache
+
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 Directive
Description: + The maximum amount of disk space that will be used by the cache in KBytes
Syntax: + CacheSize KBytes
Default: + CacheSize 1000000
Context: + server config
Status: + Experimental
Module: + mod_disk_cache
+
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 +
+
CacheTimeMargin Directive
Description: + The minimum time margin to cache a document
Syntax: + CacheTimeMargin ?
Default: + CacheTimeMargin ?
Context: + server config
Status: + Experimental
Module: + mod_disk_cache
+ +
+ CacheTimeMargin +
+

Apache HTTP Server Version 2.0

\ No newline at end of file diff --git a/docs/manual/mod/mod_mem_cache.html.en b/docs/manual/mod/mod_mem_cache.html.en new file mode 100644 index 0000000000..fcdbcb1bb2 --- /dev/null +++ b/docs/manual/mod/mod_mem_cache.html.en @@ -0,0 +1,113 @@ +mod_mem_cache - Apache HTTP Server

Apache HTTP Server Version 2.0
Apache Module mod_mem_cache
Description: + Content cache keyed to URIs
Status: + Experimental
Module Identifier: + mem_cache_module
Summary
+ +
+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.
+
Directives
MCacheMaxObjectCount
MCacheMaxObjectSize
MCacheMinObjectSize
MCacheRemovalAlgorithm
MCacheSize
MCacheMaxObjectCount Directive
Description: + The maximum number of objects allowed to be placed in the cache
Syntax: + MCacheMaxObjectCount value
Default: + MCacheMaxObjectCount 1009
Context: + server config
Status: + Experimental
Module: + mod_mem_cache
+
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 +
+
MCacheMaxObjectSize Directive
Description: + The maximum size (in bytes) of an object to be placed in the cache
Syntax: + MCacheMaxObjectSize bytes
Default: + MCacheMaxObjectSize 10000
Context: + server config
Status: + Experimental
Module: + mod_mem_cache
+
The MCacheMaxObjectSize directive sets the maximum + size of an object to be cached.
+ +
+ MCacheMaxObjectSize 6400000 +
+
MCacheMinObjectSize Directive
Description: + The minimum size (in bytes) of an object to be placed in the cache
Syntax: + MCacheMinObjectSize bytes
Default: + MCacheMinObjectSize 0
Context: + server config
Status: + Experimental
Module: + mod_mem_cache
+
The MCacheMinObjectSize directive sets the minimum + size in bytes of an object to be cached.
+ +
+ MCacheMinObjectSize 10000 +
+
MCacheRemovalAlgorithm Directive
Description: + The algorithm used to remove entries from the cache
Syntax: + MCacheRemovalAlgorithm algorithm
Default: + MCacheRemovalAlgorithm GDSF
Context: + server config
Status: + Experimental
Module: + mod_mem_cache
+
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 +
+
MCacheSize Directive
Description: + The maximum amount of memory used by the cache in KBytes
Syntax: + MCacheSize KBytes
Default: + MCacheSize 100
Context: + server config
Status: + Experimental
Module: + mod_mem_cache
+
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 +
+

Apache HTTP Server Version 2.0

\ No newline at end of file -- 2.40.0