docs/manual/mod/mod_disk_cache.html.en


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
              This file is generated from xml source: DO NOT EDIT
        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
      --><title>mod_disk_cache - Apache HTTP Server</title><link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /><link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /><link href="../images/favicon.ico" rel="shortcut icon" /></head><body><div id="page-header"><p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p><p class="apache">Apache HTTP Server Version 2.0</p><img alt="" src="../images/feather.gif" /></div><div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div><div id="path"><a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs-project/">Documentation</a> &gt; <a href="../">Version 2.0</a> &gt; <a href="./">Modules</a></div><div id="page-content"><div id="preamble"><h1>Apache Module mod_disk_cache</h1><table class="module"><tr><th>Description:
                </th><td>Content cache keyed to URIs</td></tr><tr><th><a href="module-dict.html#Status">Status:
                  </a></th><td>Experimental</td></tr><tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:
                  </a></th><td>disk_cache_module</td></tr></table><h3>Summary</h3>

<div class="warning">
This module is experimental. Documentation is still under development...
</div>
    <p><code class="module"><a href="../mod/mod_disk_cache.html">mod_disk_cache</a></code> implements a disk based storage manager for use with <code class="module"><a href="../mod/mod_proxy..html">mod_proxy.</a></code></p>
    <p>Content stored and retrived keyed to the URL. Content with
    access protections is not cached.</p>
<div class="note">
    <p><code class="module"><a href="../mod/mod_disk_cache.html">mod_disk_cache</a></code> requires the services of <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code>.</p>
</div>
</div><div id="quickview"><h3 class="directives">Directives</h3><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#cachedirlength">CacheDirLength</a></li><li><img alt="" src="../images/down.gif" /> <a href="#cachedirlevels">CacheDirLevels</a></li><li><img alt="" src="../images/down.gif" /> <a href="#cacheexpirycheck">CacheExpiryCheck</a></li><li><img alt="" src="../images/down.gif" /> <a href="#cachegcclean">CacheGcClean</a></li><li><img alt="" src="../images/down.gif" /> <a href="#cachegcdaily">CacheGcDaily</a></li><li><img alt="" src="../images/down.gif" /> <a href="#cachegcinterval">CacheGcInterval</a></li><li><img alt="" src="../images/down.gif" /> <a href="#cachegcmemusage">CacheGcMemUsage</a></li><li><img alt="" src="../images/down.gif" /> <a href="#cachegcunused">CacheGcUnused</a></li><li><img alt="" src="../images/down.gif" /> <a href="#cachemaxfilesize">CacheMaxFileSize</a></li><li><img alt="" src="../images/down.gif" /> <a href="#cacheminfilesize">CacheMinFileSize</a></li><li><img alt="" src="../images/down.gif" /> <a href="#cacheroot">CacheRoot</a></li><li><img alt="" src="../images/down.gif" /> <a href="#cachesize">CacheSize</a></li><li><img alt="" src="../images/down.gif" /> <a href="#cachetimemargin">CacheTimeMargin</a></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="CacheDirLength" id="CacheDirLength">CacheDirLength</a> <a name="cachedirlength" id="cachedirlength">Directive</a></h2><table class="directive"><tr><th>Description: 
            </th><td>The number of characters in subdirectory names</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
              </a></th><td>CacheDirLength <em>length</em></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
              </a></th><td><code>CacheDirLength 2</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
              </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
              </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
              </a></th><td>mod_disk_cache</td></tr></table>
    <p>The <code class="directive">CacheDirLength</code> directive sets the number of 
    characters for each subdirectory in the cache</p>

<div class="note">
    <p>CacheDirLevels*CacheDirLength value must not be higher than 20.</p>
</div>
<div class="example"><p><code>
  CacheDirLength  4 <br />
</code></p></div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="CacheDirLevels" id="CacheDirLevels">CacheDirLevels</a> <a name="cachedirlevels" id="cachedirlevels">Directive</a></h2><table class="directive"><tr><th>Description: 
            </th><td>The number of levels of subdirectories in the cache</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
              </a></th><td>CacheDirLevels <em>levels</em></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
              </a></th><td><code>CacheDirLevels 3</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
              </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
              </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
              </a></th><td>mod_disk_cache</td></tr></table>
    <p>The <code class="directive">CacheDirLevels</code> directive sets the number of 
    subdirectory levels in the cache. Cached data will be saved this many directory
    levels below <code class="directive">CacheRoot</code></p>

<div class="note">
    <p>CacheDirLevels*CacheDirLength value must not be higher than 20.</p>
</div>
<div class="example"><p><code>
  CacheDirLevels  5 <br />
</code></p></div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="CacheExpiryCheck" id="CacheExpiryCheck">CacheExpiryCheck</a> <a name="cacheexpirycheck" id="cacheexpirycheck">Directive</a></h2><table class="directive"><tr><th>Description: 
            </th><td>On if cache observes Expires date when seeking files</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
              </a></th><td>CacheExpiryCheck <em>binary</em></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
              </a></th><td><code>CacheExpiryCheck ?</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
              </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
              </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
              </a></th><td>mod_disk_cache</td></tr></table>

<div class="example"><p><code>
   CacheExpiryCheck On<br />
</code></p></div>
<div class="warning">
The <code class="directive">CacheExpiryCheck</code> directive is currently <em>not</em> implemented.
</div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="CacheGcClean" id="CacheGcClean">CacheGcClean</a> <a name="cachegcclean" id="cachegcclean">Directive</a></h2><table class="directive"><tr><th>Description: 
            </th><td>The time in hours to retain unchanged files that match a url</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
              </a></th><td>CacheGcClean <em>hours</em></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
              </a></th><td><code>CacheGcClean ?</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
              </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
              </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
              </a></th><td>mod_disk_cache</td></tr></table>

<div class="example"><p><code>
   CacheGcClean<br />
</code></p></div>
<div class="warning">
The <code class="directive">CacheGcClean</code> directive is currently <em>not</em> implemented.
</div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="CacheGcDaily" id="CacheGcDaily">CacheGcDaily</a> <a name="cachegcdaily" id="cachegcdaily">Directive</a></h2><table class="directive"><tr><th>Description: 
            </th><td>The time of day for garbage collection (24 hour clock)</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
              </a></th><td>CacheGcDaily <em>time</em></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
              </a></th><td><code>CacheGcDaily ?</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
              </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
              </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
              </a></th><td>mod_disk_cache</td></tr></table>

<div class="example"><p><code>
   CacheGcDaily<br />
</code></p></div>
<div class="warning">
The <code class="directive">CacheGcDaily</code> directive is currently <em>not</em> implemented.
</div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="CacheGcInterval" id="CacheGcInterval">CacheGcInterval</a> <a name="cachegcinterval" id="cachegcinterval">Directive</a></h2><table class="directive"><tr><th>Description: 
            </th><td>The interval between garbage collections</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
              </a></th><td>CacheGcInterval <em>hours</em></td></tr><tr><th><a href="directive-dict.html#Context">Context:
              </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
              </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
              </a></th><td>mod_disk_cache</td></tr></table>

<div class="example"><p><code>
  CacheGcInterval  24 <br />
</code></p></div>
<div class="warning">
The <code class="directive">CacheGcInterval</code> directive is currently <em>not</em> implemented.
</div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="CacheGcMemUsage" id="CacheGcMemUsage">CacheGcMemUsage</a> <a name="cachegcmemusage" id="cachegcmemusage">Directive</a></h2><table class="directive"><tr><th>Description: 
            </th><td>The maximum kilobytes of memory used for garbage collection</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
              </a></th><td>CacheGcMemUsage <em>KBytes</em></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
              </a></th><td><code>CacheGcMemUsage ?</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
              </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
              </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
              </a></th><td>mod_disk_cache</td></tr></table>

<div class="example"><p><code>
   CacheGcMemUsage<br />
</code></p></div>
<div class="warning">
The <code class="directive">CacheGcMemUsage</code> directive is currently <em>not</em> implemented.
</div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="CacheGcUnused" id="CacheGcUnused">CacheGcUnused</a> <a name="cachegcunused" id="cachegcunused">Directive</a></h2><table class="directive"><tr><th>Description: 
            </th><td>The time in hours to retain unused file that match a url</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
              </a></th><td>CacheGcUnused <em>hours</em></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
              </a></th><td><code>CacheGcUnused ?</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
              </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
              </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
              </a></th><td>mod_disk_cache</td></tr></table>

<div class="example"><p><code>
   CacheGcUnused<br />
</code></p></div>
<div class="warning">
The <code class="directive">CacheGcUnused</code> directive is currently <em>not</em> implemented.
</div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="CacheMaxFileSize" id="CacheMaxFileSize">CacheMaxFileSize</a> <a name="cachemaxfilesize" id="cachemaxfilesize">Directive</a></h2><table class="directive"><tr><th>Description: 
            </th><td>The maximum size (in bytes) of a file to be placed in the cache</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
              </a></th><td>CacheMaxFileSize <em>bytes</em></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
              </a></th><td><code>CacheMaxFileSize 1000000</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
              </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
              </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
              </a></th><td>mod_disk_cache</td></tr></table>
    <p>The <code class="directive">CacheMaxFileSize</code> directive sets the maximum
    size in bytes of a file to be cached.</p>

<div class="example"><p><code>
   CacheMaxFileSize 64000<br />
</code></p></div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="CacheMinFileSize" id="CacheMinFileSize">CacheMinFileSize</a> <a name="cacheminfilesize" id="cacheminfilesize">Directive</a></h2><table class="directive"><tr><th>Description: 
            </th><td>The minimum size (in bytes) of a file to be placed in the cache</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
              </a></th><td>CacheMinFileSize <em>bytes</em></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
              </a></th><td><code>CacheMinFileSize 1</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
              </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
              </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
              </a></th><td>mod_disk_cache</td></tr></table>
    <p>The <code class="directive">CacheMinFileSize</code> directive sets the minimum
    size in bytes of a file to be cached.</p>

<div class="example"><p><code>
   CacheMinFileSize 64<br />
</code></p></div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="CacheRoot" id="CacheRoot">CacheRoot</a> <a name="cacheroot" id="cacheroot">Directive</a></h2><table class="directive"><tr><th>Description: 
            </th><td>The directory to store cache files</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
              </a></th><td>CacheRoot <em>directory</em></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
              </a></th><td><code>none</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
              </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
              </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
              </a></th><td>mod_disk_cache</td></tr></table>
    <p>The <code class="directive">CacheRoot</code> directive defines the name of the directory
    on the disk to contain cache files. What is happening if not set ?</p>

<div class="example"><p><code>
  CacheRoot c:/cacheroot <br />
</code></p></div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="CacheSize" id="CacheSize">CacheSize</a> <a name="cachesize" id="cachesize">Directive</a></h2><table class="directive"><tr><th>Description: 
            </th><td>The maximum amount of disk space that will be used by the cache in KBytes</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
              </a></th><td>CacheSize <em>KBytes</em></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
              </a></th><td><code>CacheSize 1000000</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
              </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
              </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
              </a></th><td>mod_disk_cache</td></tr></table>
    <p>The <code class="directive">MCacheSize</code> 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.</p>

<div class="example"><p><code>
  MCacheSize  5000000 <br />
</code></p></div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="CacheTimeMargin" id="CacheTimeMargin">CacheTimeMargin</a> <a name="cachetimemargin" id="cachetimemargin">Directive</a></h2><table class="directive"><tr><th>Description: 
            </th><td>The minimum time margin to cache a document</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
              </a></th><td>CacheTimeMargin <em>?</em></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
              </a></th><td><code>CacheTimeMargin ?</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
              </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
              </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
              </a></th><td>mod_disk_cache</td></tr></table>

<div class="example"><p><code>
   CacheTimeMargin<br />
</code></p></div>
</div></div><div id="footer"><p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p><p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div></body></html>