]> granicus.if.org Git - apache/blobdiff - docs/manual/mod/mod_deflate.xml
Merge in APR[-util] macros from branches/trunk-buildconf-noapr
[apache] / docs / manual / mod / mod_deflate.xml
index 49749bac6eba3bbc9b58a12e059802fe1753dc9d..0dfe511070f59eed5aee8b27f8a4813f47307b07 100644 (file)
@@ -37,6 +37,14 @@ client</description>
 </summary>
 <seealso><a href="../filter.html">Filters</a></seealso>
 
+<section id="supportedencodings"><title>Supported Encodings</title>
+  <p>The <code>gzip</code> encoding is the only one supported to ensure complete compatibility
+  with old browser implementations. The <code>deflate</code> encoding is not supported, 
+  please check the <a href="http://www.gzip.org/zlib/zlib_faq.html#faq38">zlib's documentation</a>
+  for a complete explanation.
+  </p>
+</section>
+
 <section id="recommended"><title>Sample Configurations</title>
     <note type="warning"><title>Compression and TLS</title>
         <p>Some web applications are vulnerable to an information disclosure
@@ -240,7 +248,7 @@ content</title>
       DeflateFilterNote ratio
 
       LogFormat '"%r" %b (%{ratio}n) "%{User-agent}i"' deflate
-      CustomLog logs/deflate_log deflate
+      CustomLog "logs/deflate_log" deflate
       </highlight>
     </example>
 
@@ -270,7 +278,7 @@ DeflateFilterNote Output outstream
 DeflateFilterNote Ratio ratio
 
 LogFormat '"%r" %{outstream}n/%{instream}n (%{ratio}n%%)' deflate
-CustomLog logs/deflate_log deflate
+CustomLog "logs/deflate_log" deflate
 </highlight>
     </example>
 </usage>
@@ -288,7 +296,14 @@ CustomLog logs/deflate_log deflate
 <usage>
     <p>The <directive>DeflateBufferSize</directive> directive specifies
     the size in bytes of the fragments that zlib should compress at one
-    time.</p>
+    time. If the compressed response size is bigger than the one specified
+    by this directive then httpd will switch to chunked encoding 
+    (HTTP header <code>Transfer-Encoding</code> set to <code>Chunked</code>), with the
+    side effect of not setting any <code>Content-Length</code> HTTP header. This is particularly 
+    important when httpd works behind reverse caching proxies or when httpd is configured with 
+    <module>mod_cache</module> and <module>mod_cache_disk</module> because
+    HTTP responses without any <code>Content-Length</code> header might not be cached.
+  </p>
 </usage>
 </directivesynopsis>
 
@@ -377,6 +392,7 @@ CustomLog logs/deflate_log deflate
 <default>None, but LimitRequestBody applies after deflation</default>
 <contextlist><context>server config</context><context>virtual host</context>
 <context>directory</context><context>.htaccess</context></contextlist>
+<override>All</override>
 <compatibility>2.4.10 and later</compatibility>
 
 <usage>
@@ -394,6 +410,7 @@ CustomLog logs/deflate_log deflate
 <default>200</default>
 <contextlist><context>server config</context><context>virtual host</context>
 <context>directory</context><context>.htaccess</context></contextlist>
+<override>All</override>
 <compatibility>2.4.10 and later</compatibility>
 
 <usage>
@@ -414,6 +431,7 @@ CustomLog logs/deflate_log deflate
 <default>3</default>
 <contextlist><context>server config</context><context>virtual host</context>
 <context>directory</context><context>.htaccess</context></contextlist>
+<override>All</override>
 <compatibility>2.4.10 and later</compatibility>
 
 <usage>