Module Apache mod_cache

CacheDefaultExpire Directive

La directive CacheDefaultExpire permet de sp�cifier un temps par d�faut, en secondes, pendant lequel sera conserv� dans le cache un document qui ne poss�de ni date d'expiration, ni date de derni�re modification. La valeur de cette directive est �cras�e par la valeur de la directive CacheMaxExpire si cette derni�re est utilis�e.

CacheDefaultExpire 86400

CacheDetailHeader Directive

Lorsque la directive CacheDetailHeader est d�finie � on, un en-t�te X-Cache-Detail est ajout� � la r�ponse et contient les raisons pr�cises d'une d�cision d'utilisation du cache vis � vis de cette derni�re.

Ceci peut s'av�rer utile au cours du d�veloppement de services RESTful mis en cache pour obtenir des informations suppl�mentaires � propos des d�cisions vis � vis du cache �crites dans les en-t�tes de la r�ponse. Il est ainsi possible de v�rifier si Cache-Control et d'autres en-t�tes ont �t� correctement utilis�s par le service et le client.

Si le gestionnaire normal est utilis�, cette directive peut se situer dans une section <Directory> ou <Location>. Si c'est le gestionnaire rapide qui est utilis�, elle doit se situer dans un contexte de serveur principal ou de serveur virtuel, sinon elle sera ignor�e.

# Active l'en-t�te X-Cache-Detail
CacheDetailHeader on

CacheDisable Directive

La directive CacheDisable enjoint mod_cache de ne pas mettre en cache l'URL sp�cifi�e par cha�ne URL, ainsi que les URLs de niveaux inf�rieurs.

CacheDisable /fichiers_locaux

Si la directive se trouve � l'int�rieur d'une section <Location>, le chemin doit �tre sp�cifi� en dessous de la Location, et si le mot "on" est utilis�, la mise en cache sera d�sactiv�e pour l'ensemble de l'arborescence concern�e par la section Location.

<Location /foo>
    CacheDisable on
</Location>

Avec les versions 2.2.12 et ult�rieures, on peut d�finir la variable d'environnement no-cache pour une d�finition plus fine des ressources � mettre en cache.

Voir aussi

• Les variables d'environnement dans Apache

CacheEnable Directive

La directive CacheEnable enjoint mod_cache de mettre en cache l'URL pr�cis�e par cha�ne URL, ainsi que les URLs de niveaux inf�rieurs. Le gestionnaire de stockage du cache est sp�cifi� � l'aide de l'argument type de cache. La directive CacheEnable peut �tre plac�e � l'int�rieur d'une section <Location> ou <LocationMatch> pour indiquer que le contenu consid�r� peut �tre mis en cache. Si type de cache a pour valeur disk, mod_cache utilisera le gestionnaire de stockage sur disque impl�ment� par mod_cache_disk. Pour que mod_cache utilise le gestionnaire de stockage bas� sur le cache d'objets partag�s impl�ment� par mod_cache_socache, sp�cifiez socache comme valeur du param�tre type de cache.

Si les diff�rentes directives CacheEnable sp�cifient des URLs qui se recoupent (comme dans l'exemple ci-dessous), tous les gestionnaires de stockage possibles seront lanc�s, jusqu'au premier d'entre eux qui traitera effectivement la requ�te. L'ordre dans lequel les gestionnaires de stockage sont lanc�s est d�termin� par l'ordre dans lequel apparaissent les directives CacheEnable dans le fichier de configuration. Les directives CacheEnable situ�es � l'int�rieur de sections <Location> ou <LocationMatch> sont trait�es avant les directives CacheEnable d�finies au niveau global.

En fonctionnement du type serveur mandataire direct, cha�ne URL doit au moins d�buter par un protocole pour lequel la mise en cache doit �tre activ�e.

# Mise en cache de contenu (gestionnaire normal seulement)
CacheQuickHandler off
<Location /foo>
    CacheEnable disk
</Location>

# Mise en cache via une expression rationnelle (gestionnaire normal seulement)
CacheQuickHandler off
<LocationMatch foo$>
    CacheEnable disk
</LocationMatch>

# Mise en cache de tous les contenus, � l'exception des URLs
# mandat�es en direct (gestionnaire normal ou rapide)
CacheEnable  disk  /

# Mise en cache des URLs FTP mandat�es (gestionnaire normal ou rapide)
CacheEnable  disk  ftp://

# Mise en cache des contenus mandat�s en direct depuis www.example.org (gestionnaire normal ou rapide)
CacheEnable  disk  http://www.example.org/

Un nom d'h�te commen�ant par un caract�re "*" correspondra � tout nom d'h�te se terminant par le suffixe consid�r�. Un nom d'h�te commen�ant par un caract�re "." correspondra � tout nom d'h�te contenant le composant de nom de domaine qui suit ce caract�re.

# Correspond � www.example.org et fooexample.org
CacheEnable  disk  http://*example.org/
# Correspond � www.example.org, mais pas � fooexample.org
CacheEnable  disk  http://.example.org/

Depuis la version 2.2.12, on peut d�finir la variable d'environnement no-cache pour une d�finition plus fine des ressources � mettre en cache.

Voir aussi

• Les variables d'environnement dans Apache

CacheHeader Directive

Lorsque la directive CacheHeader est d�finie � on, un en-t�te X-Cache est ajout� � la r�ponse et contient l'�tat du cache pour cette derni�re. Si le gestionnaire normal est utilis�, cette directive peut se situer dans une section <Directory> ou <Location>. Si c'est le gestionnaire rapide qui est utilis�, elle doit se situer dans un contexte de serveur principal ou de serveur virtuel, sinon elle sera ignor�e.

HIT

Le contenu �tait � jour et a �t� servi depuis le cache.

REVALIDATE

Le contenu �tait p�rim�, a �t� mis � jour, puis a �t� servi depuis le cache.

MISS

Le contenu n'a pas �t� servi depuis le cache, mais directement depuis le serveur demand�.

# Active l'en-t�te X-Cache
CacheHeader on

X-Cache: HIT from localhost

CacheIgnoreCacheControl Directive

Normalement, les requ�tes contenant des en-t�tes tels que Cache-Control: no-cache ou Pragma: no-cache ne sont pas servies depuis le cache. La directive CacheIgnoreCacheControl permet de modifier ce comportement. Avec CacheIgnoreCacheControl On, le serveur tentera de servir la ressource depuis le cache, m�me si la requ�te contient un des en-t�tes cit�s plus haut. Les ressources qui requi�rent une autorisation ne seront jamais mises en cache.

CacheIgnoreCacheControl On

Voir aussi

• CacheStorePrivate
• CacheStoreNoStore

CacheIgnoreHeaders Directive

En accord avec la RFC 2616, les en-t�tes HTTP hop-by-hop ne sont pas stock�s dans le cache. Les en-t�tes HTTP suivant sont des en-t�tes hop-by-hop, et en tant que tels, ne sont en aucun cas stock�s dans le cache, quelle que soit la d�finition de la directive CacheIgnoreHeaders :

• Connection
• Keep-Alive
• Proxy-Authenticate
• Proxy-Authorization
• TE
• Trailers
• Transfer-Encoding
• Upgrade

La directive CacheIgnoreHeaders permet de sp�cifier quels en-t�tes HTTP ne doivent pas �tre stock�s dans le cache. Par exemple, il peut s'av�rer pertinent dans certains cas de ne pas stocker les cookies dans le cache.

La directive CacheIgnoreHeaders accepte une liste d'en-t�tes HTTP s�par�s par des espaces, qui ne doivent pas �tre stock�s dans le cache. Si les en-t�tes hop-by-hop sont les seuls � ne pas devoir �tre stock�s dans le cache (le comportement compatible RFC 2616), la directive CacheIgnoreHeaders peut �tre d�finie � None.

CacheIgnoreHeaders Set-Cookie

CacheIgnoreHeaders None

CacheIgnoreNoLastMod Directive

Normalement, les documents qui ne poss�dent pas de date de derni�re modification ne sont pas mis en cache. Dans certaines circonstances, la date de derni�re modification est supprim�e (au cours des traitements li�s � mod_include par exemple), ou n'existe tout simplement pas. La directive CacheIgnoreNoLastMod permet de sp�cifier si les documents ne poss�dant pas de date de derni�re modification doivent �tre mis en cache, m�me sans date de derni�re modification. Si le document ne poss�de ni date d'expiration, ni date de derni�re modification, la valeur sp�cifi�e par la directive CacheDefaultExpire servira � g�n�rer une date d'expiration.

CacheIgnoreNoLastMod On

CacheIgnoreQueryString Directive

Normalement, les requ�tes comportant une cha�ne de param�tres sont mises en cache s�par�ment si leurs cha�nes de param�tres diff�rent. En accord avec la RFC 2616/13.9, cette mise en cache n'est effectu�e s�par�ment que si une date d'expiration est sp�cifi�e. La directive CacheIgnoreQueryString permet la mise en cache de requ�tes m�me si aucune date d'expiration est sp�cifi�e, et de renvoyer une r�ponse depuis la cache m�me si les cha�nes de param�tres diff�rent. Du point de vue du cache, la requ�te est trait�e comme si elle ne poss�dait pas de cha�ne de param�tres lorsque cette directive est activ�e.

CacheIgnoreQueryString On

CacheIgnoreURLSessionIdentifiers Directive

Certaines applications encodent l'identifiant de session dans l'URL comme dans l'exemple suivant :

• /une-application/image.gif;jsessionid=123456789
• /une-application/image.gif?PHPSESSIONID=12345678

Ceci implique la mise en cache des ressources s�par�ment pour chaque session, ce qui n'est en g�n�ral pas souhait�. La directive CacheIgnoreURLSessionIdentifiers permet de d�finir une liste d'identifiants qui seront supprim�s de la cl� utilis�e pour identifier une entit� dans le cache, de fa�on � ce que les ressources ne soient pas stock�es s�par�ment pour chaque session.

CacheIgnoreURLSessionIdentifiers None vide la liste des identifiants ignor�s. Autrement, chaque identifiant sp�cifi� est ajout� � la liste.

CacheIgnoreURLSessionIdentifiers jsessionid

CacheIgnoreURLSessionIdentifiers None

CacheKeyBaseURL Directive

Lorsque la directive CacheKeyBaseURL est utilis�e, l'URL sp�cifi�e sera utilis�e comme URL de base pour calculer l'URL des cl�s du cache dans la configuration du mandataire inverse. Par d�faut, c'est le protocole/nom d'h�te/port du serveur virtuel courant qui sera utilis� pour construire la cl� de cache. Dans le cas d'un cluster de machines, si toutes les entr�es du cache doivent poss�der la m�me cl�, cette directive permet de sp�cifier une nouvelle URL de base.

# Remplace l'URL de base de la cl� de cache.
CacheKeyBaseURL http://www.example.com/

CacheLastModifiedFactor Directive

Si un document ne poss�de pas de date d'expiration, elle peut �tre calcul�e en fonction de la date de derni�re modification, si elle existe. La directive CacheLastModifiedFactor permet de sp�cifier un facteur � utiliser pour la g�n�ration de cette date d'expiration au sein de la formule suivante : d�lai-expiration = dur�e-depuis-date-derni�re-modification * facteur date-expiration = date-courante + d�lai-expiration Par exemple, si la derni�re modification du document date de 10 heures, et si facteur a pour valeur 0.1, le d�lai d'expiration sera de 10*0.1 = 1 heure. Si l'heure courante est 3:00pm, la date d'expiration calcul�e sera 3:00pm + 1 heure = 4:00pm. Si le d�lai d'expiration est sup�rieur � celui sp�cifi� par la directive CacheMaxExpire, c'est ce dernier qui l'emporte.

CacheLastModifiedFactor 0.5

CacheLock Directive

La directive CacheLock active la protection contre les temp�tes de requ�tes pour l'espace d'adressage donn�.

La configuration minimale pour activer le verrouillage contre les temp�tes de requ�tes dans le r�pertoire temp par d�faut du syst�me est la suivante :

# Active le verrouillage du cache
CacheLock on

CacheLockMaxAge Directive

La directive CacheLockMaxAge permet de sp�cifier la dur�e de vie maximale d'un verrou de cache.

Un verrou plus ancien que cette valeur exprim�e en secondes sera ignor�, et la prochaine requ�te entrante sera alors en mesure de recr�er le verrou. Ce m�canisme permet d'�viter les mises � jour trop longues initi�es par des clients lents.

CacheLockPath Directive

La directive CacheLockPath permet de sp�cifier le r�pertoire dans lequel les verrous sont cr��s. Par d�faut, c'est le r�pertoire temporaire du syst�me qui est utilis�. Les verrous sont des fichiers vides qui n'existent que pour les URLs p�rim�es en cours de mise � jour, et consomment donc bien moins de ressources que le traditionnel cache sur disque.

CacheMaxExpire Directive

La directive CacheMaxExpire permet de sp�cifier le nombre maximum de secondes pendant lequel les documents HTTP suceptibles d'�tre mis en cache seront conserv�s sans v�rifier leur contenu sur le serveur d'origine. Ce nombre de secondes correspond donc � la dur�e maximale pendant laquelle un document ne sera pas � jour. L'utilisation de cette valeur maximale est forc�e, m�me si le document poss�de une date d'expiration.

CacheMaxExpire 604800

CacheMinExpire Directive

La directive CacheMaxExpire permet de sp�cifier le nombre maximum de secondes pendant lequel les documents HTTP suceptibles d'�tre mis en cache seront conserv�s sans v�rifier leur contenu sur le serveur d'origine. Elle n'est prise en compte que dans le cas o� le document ne poss�de aucune date d'expiration valide.

CacheMinExpire 3600

CacheQuickHandler Directive

La directive CacheQuickHandler permet de contr�ler la phase au cours de laquelle la mise en cache est effectu�e.

Avec la configuration par d�faut, le cache agit au cours de la phase du gestionnaire rapide. Cette phase court-circuite la majorit� des traitements du serveur, et constitue le mode d'op�ration le plus performant pour un serveur typique. Le cache s'incruste devant le serveur, et la majorit� des traitements du serveur est court-circuit�e.

Lorsque cette directive est d�finie � off, le cache agit comme un gestionnaire normal, et est concern� par toutes les phases de traitement d'une requ�te. Bien que ce mode soit moins performant que le mode par d�faut, il permet d'utiliser le cache dans les cas o� un traitement complet de la requ�te est n�cessaire, comme par exemple lorsque le contenu est soumis � autorisation.

# Ex�cute le cache comme un gestionnaire normal
CacheQuickHandler off

Lorsque le gestionnaire rapide est d�sactiv�, l'administrateur a aussi la possibilit� de choisir avec pr�cision le point de la cha�ne de filtrage o� la mise en cache sera effectu�e, en utilisant le filtre CACHE.

# Mise en cache du contenu avant l'intervention de mod_include et
     # mod_deflate
CacheQuickHandler off
AddOutputFilterByType CACHE;INCLUDES;DEFLATE text/html

Si le filtre CACHE est sp�cifi� plusieurs fois, c'est la derni�re instance qui sera prise en compte.

CacheStaleOnError Directive

Lorsque la directive CacheStaleOnError est d�finie � on, et si des donn�es non mises � jour sont disponibles dans le cache, ce dernier renverra ces donn�es, plut�t qu'une �ventuelle r�ponse 5xx en provenance du serveur d'arri�re-plan. Alors que l'en-t�te Cache-Control envoy� par les clients sera respect�, et que les clients recevront donc dans ce cas la r�ponse 5xx brute � leur requ�te, cette r�ponse 5xx renvoy�e au client n'invalidera pas le contenu dans le cache.

# Sert des donn�es non mises � jour en cas d'erreur.
CacheStaleOnError on

CacheStoreExpired Directive

Depuis la version 2.2.4, les r�ponses qui sont arriv�es � expiration ne sont pas stock�es dans le cache. La directive CacheStoreExpired permet de modifier ce comportement. Avec CacheStoreExpired On, le serveur tente de mettre en cache la ressource si elle est p�rim�e. Les requ�tes suivantes vont d�clencher une requ�te si-modifi�-depuis de la part du serveur d'origine, et la r�ponse sera renvoy�e � partir du cache si la ressource d'arri�re-plan n'a pas �t� modifi�e.

CacheStoreExpired On

CacheStoreNoStore Directive

Normalement, les requ�tes ou r�ponses dont l'en-t�te Cache-Control: a pour valeur no-store ne sont pas stock�es dans le cache. La directive CacheStoreNoStore permet de modifier ce comportement. Si CacheStoreNoStore est d�finie � On, le serveur tente de mettre la ressource en cache m�me si elle contient des en-t�tes ayant pour valeur no-store. Les ressources n�cessitant une autorisation ne sont jamais mises en cache.

CacheStoreNoStore On

Voir aussi

• CacheIgnoreCacheControl
• CacheStorePrivate

CacheStorePrivate Directive

Normalement, les r�ponse comportant un en-t�te Cache-Control: dont la valeur est private ne seront pas stock�es dans le cache. La directive CacheStorePrivate permet de modifier ce comportement. Si CacheStorePrivate est d�finie � On, le serveur tentera de mettre la ressource en cache, m�me si elle contient des en-t�tes ayant pour valeur private. Les ressources n�cessitant une autorisation ne sont jamais mises en cache.

CacheStorePrivate On

Voir aussi

• CacheIgnoreCacheControl
• CacheStoreNoStore