Module Apache mod_cache

Directive CacheDefaultExpire

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

Directive CacheDetailHeader

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

Directive CacheDisable

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

Directive CacheEnable

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

Directive CacheHeader

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

Directive CacheIgnoreCacheControl

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

Directive CacheIgnoreHeaders

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

Directive CacheIgnoreNoLastMod

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

Directive CacheIgnoreQueryString

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

Directive CacheIgnoreURLSessionIdentifiers

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

Directive CacheKeyBaseURL

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/"

Directive CacheLastModifiedFactor

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

Directive CacheLock

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

Directive CacheLockMaxAge

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.

Directive CacheLockPath

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.

Directive CacheMaxExpire

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

Directive CacheMinExpire

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

Directive CacheQuickHandler

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.

Directive CacheStaleOnError

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

Directive CacheStoreExpired

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

Directive CacheStoreNoStore

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

Directive CacheStorePrivate

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