2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.fr.xsl"?>
4 <!-- English Revision : 1300892 -->
5 <!-- French translation : Lucien GENTIS -->
6 <!-- Reviewed by : Vincent Deffontaines -->
9 Licensed to the Apache Software Foundation (ASF) under one or more
10 contributor license agreements. See the NOTICE file distributed with
11 this work for additional information regarding copyright ownership.
12 The ASF licenses this file to You under the Apache License, Version 2.0
13 (the "License"); you may not use this file except in compliance with
14 the License. You may obtain a copy of the License at
16 http://www.apache.org/licenses/LICENSE-2.0
18 Unless required by applicable law or agreed to in writing, software
19 distributed under the License is distributed on an "AS IS" BASIS,
20 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21 See the License for the specific language governing permissions and
22 limitations under the License.
25 <modulesynopsis metafile="mod_cache.xml.meta">
27 <name>mod_cache</name>
28 <description>Filtre de mise en cache HTTP conforme à la RFC 2616</description>
29 <status>Extension</status>
30 <sourcefile>mod_cache.c</sourcefile>
31 <identifier>cache_module</identifier>
34 <note type="warning">Ce module doit être utilisé avec précautions
35 car lorsque la directive <directive
36 module="mod_cache">CacheQuickHandler</directive> est définie à sa
37 valeur par défaut <strong>on</strong>, les directives <directive
38 module="mod_access_compat">Allow</directive> and <directive
39 module="mod_access_compat">Deny</directive> sont court-circuitées. Vous
40 ne devez donc pas activer la gestion rapide de la mise en cache pour
41 un contenu auquel vous souhaitez limiter l'accès en fonction du nom
42 d'hôte du client, de l'adresse IP ou d'une variable
43 d'environnement.</note>
45 <p><module>mod_cache</module> implémente un <strong>filtre de mise
46 en cache de contenu HTTP</strong> conforme à la <a
47 href="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616</a>, avec
48 support de la mise en cache des réponses dont le contenu a été
49 négocié et comportant l'en-tête Vary.</p>
51 <p>La mise en cache conforme à la RFC 2616 fournit un mécanisme
52 permettant de vérifier si un contenu expiré ou dépassé est encore à
53 jour, et peut apporter un gain de performances significatif si le
54 serveur original supporte les <strong>requêtes
55 conditionnelles</strong> en prenant en compte l'en-tête de requête
57 href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.26">If-None-Match</a>.
58 Le contenu n'est ainsi régénéré que lorsqu'il a été modifié, et non
59 lorsqu'il a expiré.</p>
61 <p>En tant que filtre, <module>mod_cache</module> peut être placé
62 en face d'un contenu issu de tout gestionnaire, y compris
63 <strong>des fichiers à accès séquentiel</strong> (servis depuis un
65 cache sur un gros disque), la sortie d'un <strong>script
66 CGI</strong> ou d'un <strong>générateur de contenu
67 dynamique</strong>, ou du contenu <strong>mandaté depuis un autre
70 <p>Dans la configuration par défaut, <module>mod_cache</module>
71 place le filtre de mise en cache aussi loin que possible dans la
72 pile de filtres, utilisant le <strong>gestionnaire rapide</strong>
73 pour court-circuiter tout traitement par requête lors de l'envoi du
74 contenu au client. Dans ce mode opératoire,
75 <module>mod_cache</module> peut être considéré comme un serveur
76 mandataire avec cache fixé en tête du serveur web, alors qu'il
77 s'exécute dans ce même serveur web.</p>
79 <p>Lorsque le gestionnaire rapide est désactivé via la directive
80 <directive module="mod_cache">CacheQuickHandler</directive>, il
81 devient possible d'insérer le filtre <strong>CACHE</strong> à un
82 point de la pile de filtres choisi par l'administrateur. Ceci permet
83 de mettre en cache un contenu avant que celui-ci ne soit
84 personnalisé par le filtre <module>mod_include</module>, ou
85 éventuellement compressé par le filtre <module>mod_deflate</module>.</p>
87 <p>Dans le mode de fonctionnement normal, <module>mod_cache</module>
88 peut être contrôlé par les en-têtes <a
89 href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9">Cache-Control</a>
91 href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.32">Pragma</a>
92 envoyés par un client dans une requête, ou par un serveur dans une
93 réponse. Dans des circonstances exceptionnelles,
94 <module>mod_cache</module> peut cependant être configuré pour
95 outrepasser ces en-têtes et forcer un comportement spécifique au
96 site, bien qu'un tel comportement sera limité à ce cache seulement,
97 et n'affectera pas les opérations des autres caches qui peuvent
98 s'insérer entre le client et le serveur, et ce type de configuration
99 ne doit donc être utiliser qu'en cas de nécessité absolue.</p>
101 <p>La RFC 2616 permet au cache de renvoyer des données périmées
102 pendant que l'entrée périmée correspondante est mise à jour depuis
103 le serveur original, et <module>mod_cache</module> supporte cette
104 fonctionnalité lorsque la directive <directive
105 module="mod_cache">CacheLock</directive> est configurée en
106 conséquence. De telles réponses comportent un en-tête HTTP <a
107 href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.46">Warning</a>
108 contenant un code de réponse 110. La RFC 2616 permet aussi au cache
109 de renvoyer des données périmées lorsque la tentative de mise à jour
110 des données périmées renvoie une erreur 500 ou supérieure, et cette
111 fonctionnalité est supportée par défaut par
112 <module>mod_cache</module>. De telles réponses comportent un en-tête HTTP <a
113 href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.46">Warning</a>
114 contenant un code de réponse 111.</p>
116 <p><module>mod_cache</module> requiert les services d'un ou
117 plusieurs modules de gestion de stockage. La distribution Apache de base
118 inclut un module de gestion de stockage :</p>
120 <dt><module>mod_cache_disk</module></dt>
122 <dd>implémente un gestionnaire de stockage sur disque. Les en-têtes
123 et corps sont stockés séparément sur le disque dans une structure de
124 répertoires basée sur le condensé md5 de l'URL mise en cache.
125 Plusieurs réponses à contenu négocié peuvent être stockées en même
126 temps, mais la mise en cache de contenus partiels n'est pas
127 supportée par ce module. L'utilitaire
128 <program>htcacheclean</program> permet de lister et de supprimer les
129 URLs mises en cache, et de maintenir le cache en deçà de
130 certaines limites de taille et de nombre d'inodes.</dd>
133 <p>Pour de plus amples détails, une description, et des exemples,
134 reportez-vous au <a href="../caching.html">Guide de la mise en
137 <seealso><a href="../caching.html">Guide de la mise en
140 <section id="related"><title>Modules apparentés et directives</title>
143 <module>mod_cache_disk</module>
146 <directive module="mod_cache_disk">CacheRoot</directive>
147 <directive module="mod_cache_disk">CacheDirLevels</directive>
148 <directive module="mod_cache_disk">CacheDirLength</directive>
149 <directive module="mod_cache_disk">CacheMinFileSize</directive>
150 <directive module="mod_cache_disk">CacheMaxFileSize</directive>
155 <section id="sampleconf"><title>Exemple de configuration</title>
156 <example><title>Extrait de httpd.conf</title>
158 # Exemple de configuration du cache<br />
160 LoadModule cache_module modules/mod_cache.so<br />
162 <IfModule mod_cache.c><br />
164 LoadModule disk_cache_module modules/mod_cache_disk.so<br />
165 <IfModule mod_cache_disk.c><br />
167 CacheRoot c:/cacheroot<br />
168 CacheEnable disk /<br />
169 CacheDirLevels 5<br />
170 CacheDirLength 3<br />
172 </IfModule> <br />
174 # Lorsqu'on sert de mandataire, on ne met pas en cache la liste
175 # des mises à jour de sécurité<br />
176 CacheDisable http://security.update.server/update-list/<br />
182 <section id="thunderingherd"><title>Eviter une tempête de requête</title>
183 <p>Lorsqu'une entrée du cache est périmée, <module>mod_cache</module>
184 soumet une requête conditionnelle au processus d'arrière-plan, qui est
185 censé confirmer la validité de l'entrée du cache, ou dans la négative
186 envoyer une entrée mise à jour.</p>
187 <p>Un court mais non négligeable laps de temps existe entre le moment
188 où l'entrée du cache est périmée, et le moment où elle est mise à
189 jour. Sur un serveur fortement chargé, un certain nombre de requêtes
190 peut arriver pendant ce laps de temps, et provoquer une
191 <strong>tempête</strong> de requêtes susceptibles de saturer le
192 processus d'arrière-plan de manière soudaine et imprédictible.</p>
193 <p>Pour contenir cette tempête, on peut utiliser la directive
194 <directive>CacheLock</directive> afin de définir un répertoire où
195 seront créés <strong>à la volée</strong> des verrous pour les URLs.
196 Ces verrous sont utilisés comme autant d'<strong>indications</strong>
197 par les autres requêtes, soit pour empêcher une tentative de mise en
198 cache (un autre processus est en train de récupérer l'entité), soit
199 pour indiquer qu'une entrée périmée est en cours de mise à jour
200 (pendant ce temps, c'est le contenu périmé qui sera renvoyé).
203 <title>Mise en cache initiale d'une entrée</title>
204 <p>Lorsqu'une entité est mise en cache pour la première fois, un
205 verrou est créé pour cette entité jusqu'à ce que la réponse ait été
206 entièrement mise en cache. Pendant la durée de vie du verrou, le
207 cache va empêcher une seconde tentative de mise en cache de la même
208 entité. Bien que cela ne suffise pas à contenir la tempête de
209 requêtes, toute tentative de mettre en cache la même entité
210 plusieurs fois simultanément est stoppée.
214 <title>Mise à jour d'une entrée périmée</title>
215 <p>Lorsqu'une entrée atteint la limite de sa durée de vie, et
216 devient par conséquent périmée, un verrou est créé pour cette entité
217 jusqu'à ce que la réponse ait été soit confirmée comme encore
218 valide, soit remplacée par le processus d'arrière-plan. Pendant la
219 durée de vie du verrou, une seconde requête entrante va provoquer le
220 renvoi de la donnée périmée, et la tempête de requêtes sera
224 <title>Verrous et en-tête Cache-Control: no-cache</title>
225 <p>Les verrous ne sont utilisés <strong>qu'à titre
226 indicatif</strong> pour enjoindre le cache à être plus coopératif
227 avec les serveurs d'arrière-plan, et il est possible de passer outre
228 si nécessaire. Si le client envoie une requête contenant un en-tête
229 Cache-Control imposant un nouveau téléchargement de l'entité, tout
230 verrou éventuel sera ignoré, la requête du client sera honorée
231 immédiatement, et l'entrée du cache mise à jour.</p>
233 <p>Comme mécanisme de sécurité supplémentaire, la durée de vie
234 maximale des verrous est configurable. Lorsque cette limite est
235 atteinte, le verrou est supprimé et une autre requête peut alors en
236 créer un nouveau. Cette durée de vie peut être définie via la
237 directive <directive>CacheLockMaxAge</directive>, et sa valeur par
238 défaut est de 5 secondes.
242 <title>Exemple de configuration</title>
243 <example><title>Activation du verrouillage du cache</title>
245 # Active le verrouillage du cache<br />
247 <IfModule mod_cache.c><br />
250 CacheLockPath /tmp/mod_cache-lock<br />
251 CacheLockMaxAge 5<br />
258 <section id="finecontrol"><title>Contrôle fin via le filtre CACHE</title>
259 <p>Dans son mode de fonctionnement par défaut, le cache s'exécute sous
260 la forme d'un gestionnaire rapide, court-circuitant la majorité des
261 traitements du serveur et fournissant ainsi une mise en cache
262 possédant les plus hautes performances disponibles.</p>
264 <p>Dans ce mode, le cache <strong>s'incruste</strong> devant le
265 serveur, comme si un mandataire de mise en cache indépendant RFC 2616
266 était placé devant ce dernier.</p>
268 <p>Bien que que ce mode offre les meilleures performances, les
269 administrateurs peuvent souhaiter, dans certaines circonstances,
270 effectuer des traitements sur la requête après que cette dernière ait
271 été mise en cache, comme ajouter du contenu personnalisé à la page
272 mise en cache, ou appliquer des restrictions d'autorisations au
273 contenu. Pour y parvenir, l'administrateur sera alors souvent forcé de
274 placer des serveurs mandataires inverses indépendants soit derrière,
275 soit devant le serveur de mise en cache.</p>
277 <p>Pour résoudre ce problème, la directive <directive
278 module="mod_cache">CacheQuickHandler</directive> peut être définie à
279 <strong>off</strong>, afin que le serveur traite toutes les phases
280 normalement exécutées par une requête non mise en cache, y compris les
281 phases <strong>d'authentification et d'autorisation</strong>.</p>
283 <p>En outre, l'administrateur peut éventuellement spécifier le
284 <strong>point précis dans la chaîne de filtrage</strong> où devra
285 intervenir la mise en cache en ajoutant le filtre
286 <strong>CACHE</strong> à la chaîne de filtrage en sortie.</p>
288 <p>Par exemple, pour mettre en cache le contenu avant d'appliquer une
289 compression à la réponse, placez le filtre <strong>CACHE</strong>
290 avant le filtre <strong>DEFLATE</strong> comme dans l'exemple suivant
294 # Mise en cache du contenu avant la compression optionnelle<br />
295 CacheQuickHandler off<br />
296 AddOutputFilterByType CACHE;DEFLATE text/plain<br /><br />
299 <p>Une autre possibilité consiste à mettre en cache le contenu avant
300 l'ajout de contenu personnalisé via <module>mod_include</module> (ou
301 tout autre filtre de traitement de contenu). Dans l'exemple suivant,
302 les modèles contenant des balises comprises par
303 <module>mod_include</module> sont mis en cache avant d'être
304 interprétés :</p>
307 # Mise en cache du contenu avant l'intervention de mod_include et
309 CacheQuickHandler off<br />
310 AddOutputFilterByType CACHE;INCLUDES;DEFLATE text/html<br /><br />
313 <p>Vous pouvez insérer le filtre <strong>CACHE</strong> en tout point
314 de la chaîne de filtrage. Dans l'exemple suivant, le contenu est mis
315 en cache après avoir été interprété par <module>mod_include</module>,
316 mais avant d'être traité par <module>mod_deflate</module> :</p>
319 # Mise en cache du contenu entre les interventions de mod_include et
321 CacheQuickHandler off<br />
322 AddOutputFilterByType INCLUDES;CACHE;DEFLATE text/html<br /><br />
325 <note type="warning"><title>Avertissement :</title>Si pour une raison
326 ou pour une autre, le point d'insertion du filtre
327 <strong>CACHE</strong> dans la chaîne de filtrage est modifié, vous
328 devez <strong>vider votre cache</strong> pour être sûr que les données
329 servies soient à jour. En effet, <module>mod_cache</module> n'est pas
330 en mesure d'effectuer cette opération à votre place.</note>
334 <section id="status"><title>Etat du cache et journalisation</title>
335 <p>Lorsque <module>mod_cache</module> a décidé s'il devait ou non
336 servir une entité depuis le cache, les raisons précises de cette
337 décision sont enregistrées dans l'environnement du sous-processus
338 interne à la requête sous la clé <strong>cache-status</strong>.
339 Cette information peut être journalisée via la directive <directive
340 module="mod_log_config">LogFormat</directive> comme suit :</p>
343 LogFormat "%{cache-status}e ..."
346 <p>En fonction de la décision prise, l'information est aussi écrite
347 dans l'environnement du sous-processus sous une des quatre clés
351 <dt>cache-hit</dt><dd>Le contenu a été servi depuis le cache.</dd>
352 <dt>cache-revalidate</dt><dd>Le contenu du cache était périmé, a été
353 mis à jour avec succès, puis servi depuis le cache.</dd>
354 <dt>cache-miss</dt><dd>Le contenu n'était pas dans le cache et a été
355 servi directement depuis le serveur demandé.</dd>
356 <dt>cache-invalidate</dt><dd>L'entité du cache est devenue invalide
357 suite à une requête d'un type autre que GET ou HEAD.</dd>
360 <p>Il est alors possible d'envisager une journalisation conditionnelle
361 du traitement des requêtes par rapport au cache comme dans l'exemple
365 CustomLog requetes-depuis-cache.log common env=cache-hit<br />
366 CustomLog requetes-hors-cache.log common env=cache-miss<br />
367 CustomLog requetes-avec-mise-a-jour-du-cache.log common env=cache-revalidate<br />
368 CustomLog requetes-avec-invalidation.log common env=cache-invalidate<br />
371 <p>Pour les concepteurs de modules, une accroche (hook) nommée
372 <var>cache_status</var> est disponible et permet aux modules de
373 répondre aux résultats de la vérification du cache ci-dessus de manière
374 personnalisée.</p>
379 <name>CacheEnable</name>
380 <description>Active la mise en cache des URLs spécifiées en utilisant le
381 gestionnaire de stockage précisé</description>
382 <syntax>CacheEnable <var>type de cache</var> [<var>chaîne
384 <contextlist><context>server config</context><context>virtual host</context>
385 <context>directory</context><context>.htaccess</context>
389 <p>La directive <directive>CacheEnable</directive> enjoint
390 <module>mod_cache</module> de mettre en cache l'URL précisée par
391 <var>chaîne URL</var>, ainsi que les URLs de niveaux inférieurs. Le
392 gestionnaire de stockage du cache est spécifié à l'aide de
393 l'argument <var>type de cache</var>. La directive
394 <directive>CacheEnable</directive> peut être placée à l'intérieur d'une
395 section <directive type="section">Location</directive> ou <directive
396 type="section">LocationMatch</directive> pour indiquer que le
397 contenu considéré peut être mis en cache. Si <var>type de cache</var>
398 a pour valeur <code>disk</code>, <module>mod_cache</module>
399 utilisera le gestionnaire de stockage sur disque implémenté par
400 <module>mod_cache_disk</module>.</p>
401 <p>Si les différentes directives <directive>CacheEnable</directive>
402 spécifient des URLs qui se recoupent (comme dans l'exemple
403 ci-dessous), tous les gestionnaires de stockage possibles seront
404 lancés, jusqu'au premier d'entre eux qui traitera effectivement la
406 L'ordre dans lequel les gestionnaires de stockage sont lancés est
407 déterminé par l'ordre dans lequel apparaissent les directives
408 <directive>CacheEnable</directive> dans le fichier de
409 configuration. Les directives <directive>CacheEnable</directive>
410 situées à l'intérieur de sections <directive
411 type="section">Location</directive> ou <directive
412 type="section">LocationMatch</directive> sont traitées avant les
413 directives <directive>CacheEnable</directive> définies au niveau
416 <p>En fonctionnement du type serveur mandataire direct, <var>chaîne
417 URL</var> peut aussi être utilisé pour spécifier des sites distants
418 et des protocoles de mandat pour lesquels la mise en cache devra
419 être activée.</p>
422 # Mise en cache de contenu<br />
423 <Location /foo><br />
425 CacheEnable disk<br />
427 </Location><br /><br />
428 # Mise en cache via une expression rationnelle<br />
429 <LocationMatch foo$><br />
431 CacheEnable disk<br />
433 </LocationMatch><br /><br />
434 # Mise en cache des URLs mandatées<br />
435 CacheEnable disk /<br /><br />
436 # Mise en cache des URLs FTP mandatées<br />
437 CacheEnable disk ftp://<br /><br />
438 # Mise en cache des contenus situés dans www.example.org<br />
439 CacheEnable disk http://www.example.org/<br />
442 <p>Un nom d'hôte commençant par un caractère <strong>"*"</strong>
443 correspondra à tout nom d'hôte se terminant par le suffixe
444 considéré. Un nom d'hôte commençant par un caractère
445 <strong>"."</strong> correspondra à tout nom d'hôte contenant le
446 composant de nom de domaine qui suit ce caractère.</p>
449 # Correspond à www.example.org et fooexample.org<br />
450 CacheEnable disk http://*example.org/<br />
451 # Correspond à www.example.org, mais pas à fooexample.org<br />
452 CacheEnable disk http://.example.org/<br />
455 <p>Depuis la version 2.2.12, on peut définir la variable
456 d'environnement <code>no-cache</code> pour une définition plus fine
457 des ressources à mettre en cache.</p>
460 <seealso><a href="../env.html">Les variables d'environnement dans
465 <name>CacheDisable</name>
466 <description>Désactive la mise en cache des URLs
467 spécifiées</description>
468 <syntax>CacheDisable <var>chaîne-url</var> | <var>on</var></syntax>
469 <contextlist><context>server config</context><context>virtual host</context>
470 <context>directory</context><context>.htaccess</context>
474 <p>La directive <directive>CacheDisable</directive> enjoint
475 <module>mod_cache</module> de <em>ne pas</em> mettre en cache l'URL
476 spécifiée par <var>chaîne URL</var>, ainsi que les URLs de niveaux
477 inférieurs.</p>
479 <example><title>Exemple</title>
480 CacheDisable /fichiers_locaux
483 <p>Si la directive se trouve à l'intérieur d'une section <directive
484 type="section">Location</directive>, le chemin doit être spécifié en
485 dessous de la Location, et si le mot "on" est utilisé, la mise en
486 cache sera désactivée pour l'ensemble de l'arborescence concernée
487 par la section Location.</p>
489 <example><title>Exemple</title>
490 <Location /foo><br />
492 CacheDisable on<br />
494 </Location><br />
497 <p>Avec les versions 2.2.12 et ultérieures, on peut définir la
498 variable d'environnement <code>no-cache</code> pour une définition
499 plus fine des ressources à mettre en cache.</p>
501 <seealso><a href="../env.html">Les variables d'environnement dans
505 <name>CacheMaxExpire</name>
506 <description>La durée maximale en secondes de mise en cache d'un
507 document</description>
508 <syntax>CacheMaxExpire <var>secondes</var></syntax>
509 <default>CacheMaxExpire 86400 (une journée)</default>
510 <contextlist><context>server config</context><context>virtual host</context>
511 <context>directory</context><context>.htaccess</context>
515 <p>La directive <directive>CacheMaxExpire</directive> permet de
516 spécifier le nombre maximum de secondes pendant lequel les documents
517 HTTP suceptibles d'être mis en cache seront conservés sans vérifier
518 leur contenu sur le serveur d'origine. Ce nombre de secondes
519 correspond donc à la durée maximale pendant laquelle un document ne
520 sera pas à jour. L'utilisation de cette valeur maximale est forcée,
521 même si le document possède une date d'expiration.</p>
524 CacheMaxExpire 604800
530 <name>CacheMinExpire</name>
531 <description>La durée minimale en secondes de mise en cache d'un
532 document</description>
533 <syntax>CacheMinExpire <var>secondes</var></syntax>
534 <default>CacheMinExpire 0</default>
535 <contextlist><context>server config</context><context>virtual host</context>
536 <context>directory</context><context>.htaccess</context>
540 <p>La directive <directive>CacheMaxExpire</directive> permet de
541 spécifier le nombre maximum de secondes pendant lequel les documents
542 HTTP suceptibles d'être mis en cache seront conservés sans vérifier
543 leur contenu sur le serveur d'origine. Elle n'est prise en compte
544 que dans le cas où le document ne possède aucune date d'expiration
554 <name>CacheDefaultExpire</name>
555 <description>La durée par défaut de mise en cache d'un document
556 lorsqu'aucune date d'expiration n'a été spécifiée.</description>
557 <syntax>CacheDefaultExpire <var>secondes</var></syntax>
558 <default>CacheDefaultExpire 3600 (une heure)</default>
559 <contextlist><context>server config</context><context>virtual host</context>
560 <context>directory</context><context>.htaccess</context>
564 <p>La directive <directive>CacheDefaultExpire</directive> permet de
565 spécifier un temps par défaut, en secondes, pendant lequel sera
566 conservé dans le cache un document qui ne possède ni date
567 d'expiration, ni date de dernière modification. La valeur de cette
568 directive est écrasée par la valeur de la directive
569 <directive>CacheMaxExpire</directive> si cette dernière est
573 CacheDefaultExpire 86400
579 <name>CacheIgnoreNoLastMod</name>
580 <description>Ignore le fait qu'une réponse ne possède pas d'en-tête Last
581 Modified.</description>
582 <syntax>CacheIgnoreNoLastMod On|Off</syntax>
583 <default>CacheIgnoreNoLastMod Off</default>
584 <contextlist><context>server config</context><context>virtual host</context>
585 <context>directory</context><context>.htaccess</context>
589 <p>Normalement, les documents qui ne possèdent pas de date de
590 dernière modification ne sont pas mis en cache. Dans certaines
591 circonstances, la date de dernière modification est supprimée (au
592 cours des traitements liés à <module>mod_include</module> par
593 exemple), ou n'existe tout simplement pas. La directive
594 <directive>CacheIgnoreNoLastMod</directive> permet de spécifier si
595 les documents ne possèdant pas de date de dernière modification
596 doivent être mis en cache, même sans date de dernière modification.
597 Si le document ne possède ni date d'expiration, ni date de dernière
598 modification, la valeur spécifiée par la directive
599 <directive>CacheDefaultExpire</directive> servira à générer une date
604 CacheIgnoreNoLastMod On
610 <name>CacheIgnoreCacheControl</name>
611 <description>Ignore les en-têtes de requête enjoignant de ne pas servir
612 le contenu au client depuis le cache</description>
613 <syntax>CacheIgnoreCacheControl On|Off</syntax>
614 <default>CacheIgnoreCacheControl Off</default>
615 <contextlist><context>server config</context><context>virtual host</context>
619 <p>Normalement, les requêtes contenant des en-têtes tels que
620 Cache-Control: no-cache ou Pragma: no-cache ne sont pas servies
621 depuis le cache. La directive
622 <directive>CacheIgnoreCacheControl</directive> permet de modifier ce
623 comportement. Avec <directive>CacheIgnoreCacheControl
624 On</directive>, le serveur tentera de servir la ressource depuis le
625 cache, même si la requête contient un des en-têtes cités plus haut.
626 Les ressources qui requièrent une autorisation ne seront
627 <em>jamais</em> mises en cache.</p>
630 CacheIgnoreCacheControl On
633 <note type="warning"><title>Avertissement :</title>
634 Cette directive permet de servir des ressources depuis le cache,
635 même si le client a demandé à ce qu'il n'en soit pas ainsi. Le
636 contenu servi est ainsi susceptible d'être périmé.
639 <seealso><directive module="mod_cache">CacheStorePrivate</directive></seealso>
640 <seealso><directive module="mod_cache">CacheStoreNoStore</directive></seealso>
644 <name>CacheIgnoreQueryString</name>
645 <description>Ignore la chaîne de paramètres lors de la mise en
647 <syntax>CacheIgnoreQueryString On|Off</syntax>
648 <default>CacheIgnoreQueryString Off</default>
649 <contextlist><context>server config</context><context>virtual host</context>
653 <p>Normalement, les requêtes comportant une chaîne de paramètres
654 sont mises en cache séparément si leurs chaînes de paramètres
656 En accord avec la RFC 2616/13.9, cette mise en cache n'est effectuée
657 séparément que si une date d'expiration est spécifiée. La directive
658 <directive>CacheIgnoreQueryString</directive> permet la mise en
659 cache de requêtes même si aucune date d'expiration est spécifiée, et
660 de renvoyer une réponse depuis la cache même si les chaînes de
661 paramètres diffèrent. Du point de vue du cache, la requête est
662 traitée comme si elle ne possèdait pas de chaîne de paramètres
663 lorsque cette directive est activée.</p>
666 CacheIgnoreQueryString On
673 <name>CacheLastModifiedFactor</name>
674 <description>Le facteur utilisé pour générer une date d'expiration en
675 fonction de la date de dernière modification.</description>
676 <syntax>CacheLastModifiedFactor <var>flottant</var></syntax>
677 <default>CacheLastModifiedFactor 0.1</default>
678 <contextlist><context>server config</context><context>virtual host</context>
679 <context>directory</context><context>.htaccess</context>
683 <p>Si un document ne possède pas de date d'expiration, elle peut
684 être calculée en fonction de la date de dernière modification, si
685 elle existe. La directive
686 <directive>CacheLastModifiedFactor</directive> permet de spécifier
687 un <var>facteur</var> à utiliser pour la génération de cette date
688 d'expiration au sein de la formule suivante :
690 <code>délai-expiration = durée-depuis-date-dernière-modification *
692 date-expiration = date-courante + délai-expiration</code>
694 Par exemple, si la dernière modification du document date de 10
695 heures, et si <var>facteur</var> a pour valeur 0.1, le délai
696 d'expiration sera de 10*0.1 = 1 heure. Si l'heure courante est
697 3:00pm, la date d'expiration calculée sera 3:00pm + 1 heure =
700 Si le délai d'expiration est supérieur à celui spécifié par la
701 directive <directive>CacheMaxExpire</directive>, c'est ce dernier
705 CacheLastModifiedFactor 0.5
711 <name>CacheIgnoreHeaders</name>
712 <description>Ne pas stocker le(s) en-tête(s) spécifié(s) dans le cache.
714 <syntax>CacheIgnoreHeaders <var>en-tête</var> [<var>en-tête</var>] ...</syntax>
715 <default>CacheIgnoreHeaders None</default>
716 <contextlist><context>server config</context><context>virtual host</context>
720 <p>En accord avec la RFC 2616, les en-têtes HTTP hop-by-hop ne sont
721 pas stockés dans le cache. Les en-têtes HTTP suivant sont des
722 en-têtes hop-by-hop, et en tant que tels, ne sont en <em>aucun</em>
723 cas stockés dans le cache, quelle que soit la définition de la
724 directive <directive>CacheIgnoreHeaders</directive> :</p>
727 <li><code>Connection</code></li>
728 <li><code>Keep-Alive</code></li>
729 <li><code>Proxy-Authenticate</code></li>
730 <li><code>Proxy-Authorization</code></li>
731 <li><code>TE</code></li>
732 <li><code>Trailers</code></li>
733 <li><code>Transfer-Encoding</code></li>
734 <li><code>Upgrade</code></li>
737 <p>La directive <directive>CacheIgnoreHeaders</directive> permet de
738 spécifier quels en-têtes HTTP ne doivent pas être stockés dans le
739 cache. Par exemple, il peut s'avérer pertinent dans certains cas de
740 ne pas stocker les cookies dans le cache.</p>
742 <p>La directive <directive>CacheIgnoreHeaders</directive> accepte
743 une liste d'en-têtes HTTP séparés par des espaces, qui ne doivent
744 pas être stockés dans le cache. Si les en-têtes hop-by-hop sont les
745 seuls à ne pas devoir être stockés dans le cache (le comportement
746 compatible RFC 2616), la directive
747 <directive>CacheIgnoreHeaders</directive> peut être définie à
748 <code>None</code>.</p>
750 <example><title>Exemple 1</title>
751 CacheIgnoreHeaders Set-Cookie
754 <example><title>Exemple 2</title>
755 CacheIgnoreHeaders None
758 <note type="warning"><title>Avertissement :</title>
759 Si des en-têtes nécessaires à la bonne gestion du cache, comme
760 <code>Expires</code>, ne sont pas stockés suite à la définition
761 d'une directive <directive>CacheIgnoreHeaders</directive>, le
762 comportement de mod_cache sera imprévisible.
768 <name>CacheIgnoreURLSessionIdentifiers</name>
769 <description>Ignore les identifiants de session définis encodés dans
770 l'URL lors de la mise en cache
772 <syntax>CacheIgnoreURLSessionIdentifiers <var>identifiant</var>
773 [<var>identifiant</var>] ...</syntax>
774 <default>CacheIgnoreURLSessionIdentifiers None</default>
775 <contextlist><context>server config</context><context>virtual host</context>
779 <p>Certaines applications encodent l'identifiant de session dans
780 l'URL comme dans l'exemple suivant :
783 <li><code>/une-application/image.gif;jsessionid=123456789</code></li>
784 <li><code>/une-application/image.gif?PHPSESSIONID=12345678</code></li>
786 <p>Ceci implique la mise en cache des ressources séparément pour
787 chaque session, ce qui n'est en général pas souhaité. La directive
788 <directive>CacheIgnoreURLSessionIdentifiers</directive> permet de
789 définir une liste d'identifiants qui seront supprimés de la clé
790 utilisée pour identifier une entité dans le cache, de façon à ce que
791 les ressources ne soient pas stockées séparément pour chaque
794 <p><code>CacheIgnoreURLSessionIdentifiers None</code> vide la liste
795 des identifiants ignorés. Autrement, chaque identifiant spécifié est
796 ajouté à la liste.</p>
798 <example><title>Exemple 1</title>
799 CacheIgnoreURLSessionIdentifiers jsessionid
802 <example><title>Exemple 2</title>
803 CacheIgnoreURLSessionIdentifiers None
810 <name>CacheStoreExpired</name>
811 <description>Tente de mettre en cache les réponses que le serveur
812 considère comme arrivées à expiration</description>
813 <syntax>CacheStoreExpired On|Off</syntax>
814 <default>CacheStoreExpired Off</default>
815 <contextlist><context>server config</context><context>virtual host</context>
816 <context>directory</context><context>.htaccess</context>
820 <p>Depuis la version 2.2.4, les réponses qui sont arrivées à
821 expiration ne sont pas stockées dans le cache. La directive
822 <directive>CacheStoreExpired</directive> permet de modifier ce
823 comportement. Avec <directive>CacheStoreExpired</directive> On, le
824 serveur tente de mettre en cache la ressource si elle est périmée.
825 Les requêtes suivantes vont déclencher une requête si-modifié-depuis
826 de la part du serveur d'origine, et la réponse sera renvoyée à
827 partir du cache si la ressource d'arrière-plan n'a pas été modifiée.</p>
836 <name>CacheStorePrivate</name>
837 <description>Tente de mettre en cache des réponses que le serveur a
838 marquées comme privées</description>
839 <syntax>CacheStorePrivate On|Off</syntax>
840 <default>CacheStorePrivate Off</default>
841 <contextlist><context>server config</context><context>virtual host</context>
842 <context>directory</context><context>.htaccess</context>
846 <p>Normalement, les réponse comportant un en-tête Cache-Control:
847 dont la valeur est private ne seront pas stockées dans le cache. La
848 directive <directive>CacheStorePrivate</directive> permet de
849 modifier ce comportement. Si
850 <directive>CacheStorePrivate</directive> est définie à On, le
851 serveur tentera de mettre la ressource en cache, même si elle
852 contient des en-têtes ayant pour valeur private. Les ressources
853 nécessitant une autorisation ne sont <em>jamais</em> mises en
860 <note type="warning"><title>Avertissement :</title>
861 Cette directive autorise la mise en cache même si le serveur
862 indique que la ressource ne doit pas être mise en cache. Elle
863 n'est de ce fait appropriée que dans le cas d'un cache
867 <seealso><directive module="mod_cache">CacheIgnoreCacheControl</directive></seealso>
868 <seealso><directive module="mod_cache">CacheStoreNoStore</directive></seealso>
872 <name>CacheStoreNoStore</name>
873 <description>Tente de mettre en cache les requêtes ou réponses dont
874 l'entête Cache-Control: a pour valeur no-store.</description>
875 <syntax>CacheStoreNoStore On|Off</syntax>
876 <default>CacheStoreNoStore Off</default>
877 <contextlist><context>server config</context><context>virtual host</context>
878 <context>directory</context><context>.htaccess</context>
882 <p>Normalement, les requêtes ou réponses dont l'en-tête
883 Cache-Control: a pour valeur no-store ne sont pas stockées dans le
884 cache. La directive <directive>CacheStoreNoStore</directive> permet
885 de modifier ce comportement. Si
886 <directive>CacheStoreNoStore</directive> est définie à On, le
887 serveur tente de mettre la ressource en cache même si elle contient
888 des en-têtes ayant pour valeur no-store. Les ressources
889 nécessitant une autorisation ne sont <em>jamais</em> mises en
896 <note type="warning"><title>Avertissement :</title>
897 Selon la RFC 2616, la valeur d'en-tête no-store est censée
898 "prévenir la suppression ou la rétention par inadvertance
899 d'informations sensibles (par exemple, sur des bandes de
900 sauvegarde)". Autrement dit, l'activation de la directive
901 <directive>CacheStoreNoCache</directive> pourrait provoquer le
902 stockage d'informations sensibles dans le cache. Vous avez donc
903 été prévenus.
906 <seealso><directive module="mod_cache">CacheIgnoreCacheControl</directive></seealso>
907 <seealso><directive module="mod_cache">CacheStorePrivate</directive></seealso>
911 <name>CacheLock</name>
912 <description>Active la protection contre les tempêtes de requêtes.</description>
913 <syntax>CacheLock <var>on|off</var></syntax>
914 <default>CacheLock off</default>
915 <contextlist><context>server config</context><context>virtual host</context>
917 <compatibility>Disponible depuis la version 2.2.15 d'Apache</compatibility>
920 <p>La directive <directive>CacheLock</directive> active la protection
921 contre les tempêtes de requêtes pour l'espace d'adressage donné.</p>
923 <p>La configuration minimale pour activer le verrouillage contre les
924 tempêtes de requêtes dans le répertoire temp par défaut du système est
928 # Active le verrouillage du cache<br />
929 CacheLock on<br /><br />
936 <name>CacheLockPath</name>
937 <description>Définit le répertoire des verrous.</description>
938 <syntax>CacheLockPath <var>répertoire</var></syntax>
939 <default>CacheLockPath /tmp/mod_cache-lock</default>
940 <contextlist><context>server config</context><context>virtual host</context>
944 <p>La directive <directive>CacheLockPath</directive> permet de
945 spécifier le répertoire dans lequel les verrous sont créés. Par
946 défaut, c'est le répertoire temporaire du système qui est utilisé. Les
947 verrous sont des fichiers vides qui n'existent que pour les URLs
948 périmées en cours de mise à jour, et consomment donc bien moins de
949 ressources que le traditionnel cache sur disque.</p>
955 <name>CacheLockMaxAge</name>
956 <description>Définit la durée de vie maximale d'un verrou de cache.</description>
957 <syntax>CacheLockMaxAge <var>entier</var></syntax>
958 <default>CacheLockMaxAge 5</default>
959 <contextlist><context>server config</context><context>virtual host</context>
963 <p>La directive <directive>CacheLockMaxAge</directive> permet de
964 spécifier la durée de vie maximale d'un verrou de cache.</p>
966 <p>Un verrou plus ancien que cette valeur exprimée en secondes sera
967 ignoré, et la prochaine requête entrante sera alors en mesure de
968 recréer le verrou. Ce mécanisme permet d'éviter les mises à jour trop
969 longues initiées par des clients lents.</p>
975 <name>CacheQuickHandler</name>
976 <description>Exécute le cache à partir d'un gestionnaire rapide.</description>
977 <syntax>CacheQuickHandler <var>on|off</var></syntax>
978 <default>CacheQuickHandler on</default>
979 <contextlist><context>server config</context><context>virtual host</context>
981 <compatibility>Disponible à partir de la version 2.3.3 du serveur HTTP
982 Apache</compatibility>
985 <p>La directive <directive
986 module="mod_cache">CacheQuickHandler</directive> permet de contrôler
987 la phase au cours de laquelle la mise en cache est effectuée.</p>
989 <p>Avec la configuration par défaut, le cache agit au cours de la
990 phase du gestionnaire rapide. Cette phase court-circuite la majorité
991 des traitements du serveur, et constitue le mode d'opération le plus
992 performant pour un serveur typique. Le cache
993 <strong>s'incruste</strong> devant le serveur, et la majorité des
994 traitements du serveur est court-circuitée.</p>
996 <p>Lorsque cette directive est définie à off, le cache agit comme un
997 gestionnaire normal, et est concerné par toutes les phases de
998 traitement d'une requête. Bien que ce mode soit moins performant que
999 le mode par défaut, il permet d'utiliser le cache dans les cas où un
1000 traitement complet de la requête est nécessaire, comme par exemple
1001 lorsque le contenu est soumis à autorisation.</p>
1004 # Exécute le cache comme un gestionnaire normal<br />
1005 CacheQuickHandler off<br /><br />
1008 <p>Lorsque le gestionnaire rapide est désactivé, l'administrateur a
1009 aussi la possibilité de choisir avec précision le point de la chaîne
1010 de filtrage où la mise en cache sera effectuée, en utilisant le
1011 filtre <strong>CACHE</strong>.</p>
1014 # Mise en cache du contenu avant l'intervention de mod_include et
1016 CacheQuickHandler off<br />
1017 AddOutputFilterByType CACHE;INCLUDES;DEFLATE text/html<br /><br />
1020 <p>Si le filtre CACHE est spécifié plusieurs fois, c'est la dernière
1021 instance qui sera prise en compte.</p>
1024 </directivesynopsis>
1027 <name>CacheHeader</name>
1028 <description>Ajoute un en-tête X-Cache à la réponse.</description>
1029 <syntax>CacheHeader <var>on|off</var></syntax>
1030 <default>CacheHeader off</default>
1031 <contextlist><context>server config</context>
1032 <context>virtual host</context>
1033 <context>directory</context>
1034 <context>.htaccess</context>
1036 <compatibility>Disponible depuis la version 2.3.9 d'Apache</compatibility>
1039 <p>Lorsque la directive <directive
1040 module="mod_cache">CacheHeader</directive> est définie à on, un
1041 en-tête <strong>X-Cache</strong> est ajouté à la réponse et contient
1042 l'état du cache pour cette dernière. Si le gestionnaire normal est
1043 utilisé, cette directive peut se situer dans une section <directive
1044 module="core"><Directory></directive> ou <directive
1045 module="core"><Location></directive>. Si c'est le
1046 gestionnaire rapide qui est utilisé, elle doit se situer dans un
1047 contexte de serveur principal ou de serveur virtuel, sinon elle sera
1051 <dt><strong>HIT</strong></dt><dd>Le contenu était à jour et a été
1052 servi depuis le cache.</dd>
1053 <dt><strong>REVALIDATE</strong></dt><dd>Le contenu était périmé, a
1054 été mis à jour, puis a été servi depuis le cache.</dd>
1055 <dt><strong>MISS</strong></dt><dd>Le contenu n'a pas été servi
1056 depuis le cache, mais directement depuis le serveur demandé.</dd>
1060 # Active l'en-tête X-Cache<br />
1061 CacheHeader on<br />
1065 X-Cache: HIT from localhost<br />
1069 </directivesynopsis>
1072 <name>CacheDetailHeader</name>
1073 <description>Ajoute un en-tête X-Cache-Detail à la réponse.</description>
1074 <syntax>CacheDetailHeader <var>on|off</var></syntax>
1075 <default>CacheDetailHeader off</default>
1076 <contextlist><context>server config</context>
1077 <context>virtual host</context>
1078 <context>directory</context>
1079 <context>.htaccess</context>
1081 <compatibility>Disponible depuis la version 2.3.9 d'Apache</compatibility>
1084 <p>Lorsque la directive <directive
1085 module="mod_cache">CacheDetailHeader</directive> est définie à on, un
1086 en-tête <strong>X-Cache-Detail</strong> est ajouté à la réponse et
1087 contient les raisons précises d'une décision d'utilisation du cache
1088 vis à vis de cette dernière.</p>
1090 <p>Ceci peut s'avérer utile au cours du développement de services
1091 RESTful mis en cache pour obtenir des informations supplémentaires à
1092 propos des décisions vis à vis du cache écrites dans les en-têtes de
1093 la réponse. Il est ainsi possible de vérifier si
1094 <code>Cache-Control</code> et d'autres en-têtes ont été correctement
1095 utilisés par le service et le client.</p>
1097 <p>Si le gestionnaire normal est utilisé, cette directive peut se
1098 situer dans une section <directive
1099 module="core"><Directory></directive> ou <directive
1100 module="core"><Location></directive>. Si c'est le gestionnaire
1101 rapide qui est utilisé, elle doit se situer dans un contexte de
1102 serveur principal ou de serveur virtuel, sinon elle sera ignorée.</p>
1105 # Active l'en-tête X-Cache-Detail<br />
1106 CacheDetailHeader on<br />
1110 X-Cache-Detail: "conditional cache hit: entity refreshed" from localhost<br />
1114 </directivesynopsis>
1117 <name>CacheKeyBaseURL</name>
1118 <description>Remplace l'URL de base des clés du cache mandatées en
1119 inverse</description>
1120 <syntax>CacheKeyBaseURL <var>URL</var></syntax>
1121 <default>CacheKeyBaseURL http://example.com</default>
1122 <contextlist><context>server config</context>
1123 <context>virtual host</context>
1125 <compatibility>Disponible depuis la version 2.3.9 d'Apache</compatibility>
1128 <p>Lorsque la directive <directive
1129 module="mod_cache">CacheKeyBaseURL</directive> est utilisée, l'URL
1130 spécifiée sera utilisée comme URL de base pour calculer l'URL des clés
1131 du cache dans la configuration du mandataire inverse. Par défaut,
1132 c'est le protocole/nom d'hôte/port du serveur virtuel courant qui sera
1133 utilisé pour construire la clé de cache. Dans le cas d'un cluster de
1134 machines, si toutes les entrées du cache doivent posséder la même clé,
1135 cette directive permet de spécifier une nouvelle URL de base.</p>
1138 # Remplace l'URL de base de la clé de cache.<br />
1139 CacheKeyBaseURL http://www.example.com/<br />
1142 <note type="warning">Prenez garde en définissant cette directive. Si
1143 deux serveurs virtuels distincts possèdent accidentellement la même
1144 URL de base, les entrées en provenance d'un serveur virtuel seront
1145 servies par l'autre.</note>
1148 </directivesynopsis>
1151 <name>CacheStaleOnError</name>
1152 <description>Sert du contenu non à jour à la place de réponses 5xx.</description>
1153 <syntax>CacheStaleOnError <var>on|off</var></syntax>
1154 <default>CacheStaleOnError on</default>
1155 <contextlist><context>server config</context>
1156 <context>virtual host</context>
1157 <context>directory</context>
1158 <context>.htaccess</context>
1160 <compatibility>Disponible depuis la version 2.3.9 d'Apache</compatibility>
1163 <p>Lorsque la directive <directive
1164 module="mod_cache">CacheStaleOnError</directive> est définie à on, et
1165 si des données non mises à jour sont disponibles dans le cache, ce
1166 dernier renverra ces données, plutôt qu'une éventuelle réponse 5xx en
1167 provenance du serveur d'arrière-plan. Alors que l'en-tête
1168 Cache-Control envoyé par les clients sera respecté, et que les clients
1169 recevront donc dans ce cas la réponse 5xx brute à leur requête, cette
1170 réponse 5xx renvoyée au client n'invalidera pas le contenu dans le
1174 # Sert des données non mises à jour en cas d'erreur.<br />
1175 CacheStaleOnError on<br />
1179 </directivesynopsis>
projects / apache / blob