2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.fr.xsl"?>
4 <!-- English Revision : 1330980 -->
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_deflate.xml.meta">
27 <name>mod_deflate</name>
28 <description>Comprime le contenu avant de le servir au
30 <status>Extension</status>
31 <sourcefile>mod_deflate.c</sourcefile>
32 <identifier>deflate_module</identifier>
35 <p>Le module <module>mod_deflate</module> implémente le filtre de
36 sortie <code>DEFLATE</code> qui permet de comprimer la sortie de
37 votre serveur avant de l'envoyer au client sur le réseau.</p>
39 <seealso><a href="../filter.html">Les filtres</a></seealso>
41 <section id="recommended"><title>Exemples de configurations</title>
42 <p>Voici un exemple simple de configuration pour les
45 <example><title>Ne comprime que certains types de documents</title>
46 <highlight language="config">
47 AddOutputFilterByType DEFLATE text/html text/plain text/xml
51 <p>La configuration suivante, tout en produisant un contenu encore
52 plus comprimé, est aussi beaucoup plus compliquée. N'utilisez pas
53 cet exemple si vous ne comprenez pas tous les détails de la
56 <example><title>Comprime tout, sauf les images</title>
57 <highlight language="config">
60 SetOutputFilter DEFLATE
62 # Netscape 4.x a quelques problèmes ...
63 BrowserMatch ^Mozilla/4 gzip-only-text/html
65 # Netscape 4.06-4.08 ont d'autres problèmes
66 BrowserMatch ^Mozilla/4\.0[678] no-gzip
68 # MSIE se fait passer pour Netscape, mais ça marche
69 BrowserMatch \bMSIE !no-gzip !gzip-only-text/html
70 # Ne pas comprimer les images
71 SetEnvIfNoCase Request_URI \.(?:gif|jpe?g|png)$ no-gzip dont-vary
73 # On s'assure que les mandataires ne servent pas le mauvais
75 Header append Vary User-Agent env=!dont-vary
82 <section id="enable"><title>Activation de la compression</title>
84 <section id="output"><title>Compression de la sortie</title>
85 <p>La compression est implémentée par le <a
86 href="../filter.html">filtre</a> <code>DEFLATE</code>. La
87 directive suivante active la compression des documents dans le
88 conteneur où elle est placée :</p>
90 <highlight language="config">
91 SetOutputFilter DEFLATE
94 <p>Certains navigateurs populaires ne gèrent pas la compression de
95 tous les contenus, et pour résoudre ce problème, vous pouvez
96 définir la note <code>gzip-only-text/html</code> à <code>1</code>
97 pour ne permettre que la compression des fichiers html (voir
98 ci-dessous). Si vous définissez cette note à <em>toute autre
99 valeur que <code>1</code></em>, elle sera ignorée.</p>
101 <p>Si vous voulez limiter la compression à certains types MIME
102 particuliers, vous pouvez utiliser la directive <directive
103 module="mod_filter">AddOutputFilterByType</directive>. Voici un exemple
104 où la compression n'est activée que pour les fichiers html de la
105 documentation d'Apache :</p>
107 <highlight language="config">
108 <Directory "/your-server-root/manual">
109 AddOutputFilterByType DEFLATE text/html
113 <p>Pour les navigateurs qui ont des problèmes avec la compression
114 de tous les types de fichiers, vous pouvez utiliser la directive
115 <directive module="mod_setenvif">BrowserMatch</directive> pour
116 définir la note <code>no-gzip</code>, pour le navigateur
117 considéré, de façon à ce qu'aucune compression ne soit effectuée.
118 Vous pouvez combiner <code>no-gzip</code> avec
119 <code>gzip-only-text/html</code> afin d'obtenir le meilleur
120 résultat possible. Dans ce cas, la première note l'emporte sur la
121 deuxième. Considérons l'extrait suivant de l'<a
122 href="#recommended">exemple de configuration</a> de la section
123 précédente :</p>
125 <highlight language="config">
126 BrowserMatch ^Mozilla/4 gzip-only-text/html
127 BrowserMatch ^Mozilla/4\.0[678] no-gzip
128 BrowserMatch \bMSIE !no-gzip !gzip-only-text/html
131 <p>Tout d'abord, on recherche un en-tête <code>User-Agent</code>
132 qui signale un navigateur Netscape version 4.x. Ces versions ne
133 gèrent pas la compression des types de fichiers autres que
134 <code>text/html</code>. En outre, les versions 4.06, 4.07 et 4.08
135 ont des problèmes avec la décompression des fichiers html. Par
136 conséquent, nous désactivons complètement le filtre deflate pour
139 <p>La troisième directive <directive
140 module="mod_setenvif">BrowserMatch</directive> corrige l'identité
141 sous laquelle se présente le navigateur ; en effet, Microsoft
142 Internet Explorer s'identifie aussi lui-même comme "Mozilla/4",
143 mais par contre, il sait gérer les contenus compressés. On
144 recherche donc la chaîne additionnelle "MSIE" (<code>\b</code>
145 signifie "par mots entiers") dans l'en-tête
146 <code>User-Agent</code>, et si elle est trouvée, on annule les
147 restrictions définies auparavant.</p>
149 <note><title>Note</title>
150 Le filtre <code>DEFLATE</code> est toujours inséré après les
151 filtres RESOURCE comme PHP ou SSI. Il n'affecte jamais les
152 sous-requêtes internes.
154 <note><title>Note</title>
155 La variable d'environnement <code>force-gzip</code>, définie à
156 l'aide de la directive <directive
157 module="mod_env">SetEnv</directive>, permet d'ignorer la
158 configuration de votre navigateur quant aux codages acceptés, et
159 d'envoyer sans condition une sortie comprimée.
163 <section id="inflate"><title>Décompression de la sortie</title>
164 <p>Le module <module>mod_deflate</module> fournit aussi un filtre
165 permettant de décomprimer un corps de réponse comprimé par gzip.
166 Pour activer cette fonctionnalité, vous devez insérer le filtre
167 <code>INFLATE</code> dans la chaîne de filtrage en sortie via la
168 directive <directive module="core">SetOutputFilter</directive> ou
169 <directive module="mod_mime">AddOutputFilter</directive>, comme
170 dans l'exemple suivant :</p>
172 <highlight language="config">
173 <Location /dav-area>
174 ProxyPass http://example.com/
175 SetOutputFilter INFLATE
179 <p>Dans cet exemple, les sorties comprimées par gzip en
180 provenance de example.com seront décomprimées afin de pouvoir
181 être éventuellement traitées par d'autres filtres.
185 <section id="input"><title>Décompression de l'entrée</title>
186 <p>Le module <module>mod_deflate</module> fournit également un filtre
187 permettant de décomprimer un corps de requête comprimé par gzip.
188 Pour activer cette fonctionnalité, vous devez insérer le filtre
189 <code>DEFLATE</code> dans la chaîne de filtrage en entrée via la
190 directive <directive module="core">SetInputFilter</directive> ou
191 <directive module="mod_mime">AddInputFilter</directive>, comme
192 dans l'exemple suivant :</p>
194 <highlight language="config">
195 <Location /dav-area>
196 SetInputFilter DEFLATE
200 <p>Désormais, si une requête contient un en-tête
201 <code>Content-Encoding: gzip</code>, son corps sera
202 automatiquement décomprimé. Peu de navigateurs sont actuellement
203 en mesure de comprimer les corps de requêtes. Cependant,
204 certaines applications spécialisées supportent les requêtes
205 comprimées, comme par exemple certains clients <a
206 href="http://www.webdav.org">WebDAV</a>.</p>
208 <note type="warning"><title>Note à propos de l'en-tête
209 <code>Content-Length</code></title>
210 <p>Si vous évaluez vous-même la taille du corps de requête,
211 <em>ne faites pas confiance à l'en-tête
212 <code>Content-Length</code>!</em> L'en-tête
213 Content-Length indique la longueur des données en provenance du
214 client, et <em>non</em> la quantité d'octets que représente le
215 flux de données décompressé.</p>
220 <section id="proxies"><title>Prise en compte des serveurs mandataires</title>
222 <p>Le module <module>mod_deflate</module> envoie un en-tête de
223 réponse HTTP <code>Vary: Accept-Encoding</code> pour avertir les
224 mandataires qu'une réponse enregistrée dans le cache ne doit être
225 envoyée qu'aux clients qui ont envoyé l'en-tête de requête
226 <code>Accept-Encoding</code> approprié. Ceci permet d'éviter l'envoi
227 d'un contenu comprimé à un client qui ne sera pas en mesure
228 de l'interpréter.</p>
230 <p>Si vous avez défini des exclusions spécifiques dépendant, par
231 exemple, de l'en-tête <code>User-Agent</code>, vous devez
232 ajouter manuellement des données à l'en-tête <code>Vary</code> afin
233 d'informer les mandataires des restrictions supplémentaires. Par
234 exemple, dans la configuration classique où l'addition du filtre
235 <code>DEFLATE</code> dépend du contenu de l'en-tête
236 <code>User-Agent</code>, vous devez spécifier :</p>
238 <highlight language="config">
239 Header append Vary User-Agent
242 <p>Si votre décision de comprimer le contenu dépend d'autres
243 informations que celles contenues dans les en-têtes de la requête
244 (par exemple la version HTTP), vous devez attribuer à l'en-tête
245 <code>Vary</code> la valeur <code>*</code>, ce qui permet d'empêcher
246 les mandataires compatibles de tout mettre en cache.</p>
248 <example><title>Exemple</title>
249 <highlight language="config">
256 <name>DeflateFilterNote</name>
257 <description>Enregistre le taux de compression sous la forme d'une note
258 à des fins de journalisation</description>
259 <syntax>DeflateFilterNote [<var>type</var>] <var>nom de la note</var></syntax>
260 <contextlist><context>server config</context><context>virtual host</context>
262 <compatibility><var>type</var> est disponible depuis la version 2.0.45
263 d'Apache</compatibility>
266 <p>La directive <directive>DeflateFilterNote</directive> permet de
267 spécifier qu'une note à propos du taux de compression doit être
268 attachée à la requête. Le nom de la note est passé sous la forme
269 d'un argument de la directive. Vous pouvez utiliser cette note à des
270 fins statistiques en enregistrant sa valeur dans votre <a
271 href="../logs.html#accesslog">journal des accès</a>.</p>
273 <example><title>Exemple</title>
274 <highlight language="config">
275 DeflateFilterNote ratio
277 LogFormat '"%r" %b (%{ratio}n) "%{User-agent}i"' deflate
278 CustomLog logs/deflate_log deflate
282 <p>Pour extraire des informations plus précises de vos journaux,
283 vous pouvez utiliser l'argument <var>type</var> pour spécifier le
284 type de données de la note enregistrée dans le journal.
285 <var>type</var> peut prendre une des valeurs suivantes :</p>
288 <dt><code>Input</code></dt>
289 <dd>Enregistre dans la note la taille en octets du flux en entrée
292 <dt><code>Output</code></dt>
293 <dd>Enregistre dans la note la taille en octets du flux en sortie
296 <dt><code>Ratio</code></dt>
297 <dd>Enregistre le taux de compression (<code>sortie/entrée *
298 100</code>) dans la note. Il s'agit de la valeur par défaut si
299 l'argument <var>type</var> est omis.</dd>
302 <p>Vous pouvez donc configurer votre journalisation de la manière
305 <example><title>Journalisation détaillée</title>
306 <highlight language="config">
307 DeflateFilterNote Input instream
308 DeflateFilterNote Output outstream
309 DeflateFilterNote Ratio ratio
311 LogFormat '"%r" %{outstream}n/%{instream}n (%{ratio}n%%)' deflate
312 CustomLog logs/deflate_log deflate
316 <seealso><module>mod_log_config</module></seealso>
320 <name>DeflateBufferSize</name>
321 <description>Taille du fragment que zlib devra comprimer en une seule
323 <syntax>DeflateBufferSize <var>valeur</var></syntax>
324 <default>DeflateBufferSize 8096</default>
325 <contextlist><context>server config</context><context>virtual host</context>
329 <p>La directive <directive>DeflateBufferSize</directive> permet de
330 spécifier la taille en octets du fragment que zlib devra comprimer
331 en une seule fois.</p>
336 <name>DeflateWindowSize</name>
337 <description>Taille de la fenêtre de compression zlib</description>
338 <syntax>DeflateWindowSize <var>valeur</var></syntax>
339 <default>DeflateWindowSize 15</default>
340 <contextlist><context>server config</context><context>virtual host</context>
344 <p>La directive <directive>DeflateWindowSize</directive> permet de
345 spécifier la fenêtre de compression zlib (une valeur comprise entre
346 1 et 15). En général, plus grande sera la taille de la fenêtre, plus
347 grand sera le taux de compression auquel on pourra s'attendre.</p>
353 <name>DeflateMemLevel</name>
354 <description>La quantité de mémoire utilisable par zlib pour la
355 compression</description>
356 <syntax>DeflateMemLevel <var>valeur</var></syntax>
357 <default>DeflateMemLevel 9</default>
358 <contextlist><context>server config</context><context>virtual host</context>
362 <p>La directive <directive>DeflateMemLevel</directive> permet de
363 spécifier la quantité de mémoire utilisable par zlib pour la
364 compression (une valeur comprise entre 1 et 9).</p>
369 <name>DeflateCompressionLevel</name>
370 <description>Le niveau de compression que nous appliquons à la
372 <syntax>DeflateCompressionLevel <var>valeur</var></syntax>
373 <default>La valeur par défaut de zlib</default>
374 <contextlist><context>server config</context><context>virtual host</context>
376 <compatibility>Cette directive est disponible depuis la version 2.0.45
377 d'Apache</compatibility>
380 <p>La directive <directive>DeflateCompressionLevel</directive>
381 permet de spécifier le niveau de compression à utiliser ; plus
382 grande est la valeur, meilleure sera la compression, mais plus grand
383 sera aussi le temps CPU nécessaire pour effectuer le
385 <p>La valeur doit être comprise entre 1 (compression minimale) et 9
386 (compression maximale).</p>