home *** CD-ROM | disk | FTP | other *** search
/ GameStar 2004 May / Gamestar_62_2004-05_dvd.iso / Programy / apache_2.0.48-win32-x86-no_ssl.msi / Data.Cab / F252501_mod_deflate.html.en < prev    next >
Extensible Markup Language  |  2003-05-29  |  21KB  |  348 lines

  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
  4.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  5.               This file is generated from xml source: DO NOT EDIT
  6.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  7.       -->
  8. <title>mod_deflate - Apache HTTP Server</title>
  9. <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10. <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11. <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12. <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13. <body>
  14. <div id="page-header">
  15. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16. <p class="apache">Apache HTTP Server Version 2.0</p>
  17. <img alt="" src="../images/feather.gif" /></div>
  18. <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
  19. <div id="path">
  20. <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Modules</a></div>
  21. <div id="page-content">
  22. <div id="preamble"><h1>Apache Module mod_deflate</h1>
  23. <div class="toplang">
  24. <p><span>Available Languages: </span><a href="../en/mod/mod_deflate.html" title="English"> en </a> |
  25. <a href="../ja/mod/mod_deflate.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
  26. <a href="../ko/mod/mod_deflate.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
  27. </div>
  28. <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Compress content before it is delivered to the
  29. client</td></tr>
  30. <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  31. <tr><th><a href="module-dict.html#ModuleIdentifier">ModuleáIdentifier:</a></th><td>deflate_module</td></tr>
  32. <tr><th><a href="module-dict.html#SourceFile">SourceáFile:</a></th><td>mod_deflate.c</td></tr></table>
  33. <h3>Summary</h3>
  34.  
  35.     <p>The <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code> module provides
  36.     the <code>DEFLATE</code> output filter that allows output from
  37.     your server to be compressed before being sent to the client over
  38.     the network.</p>
  39. </div>
  40. <div id="quickview"><h3 class="directives">Directives</h3>
  41. <ul id="toc">
  42. <li><img alt="" src="../images/down.gif" /> <a href="#deflatebuffersize">DeflateBufferSize</a></li>
  43. <li><img alt="" src="../images/down.gif" /> <a href="#deflatecompressionlevel">DeflateCompressionLevel</a></li>
  44. <li><img alt="" src="../images/down.gif" /> <a href="#deflatefilternote">DeflateFilterNote</a></li>
  45. <li><img alt="" src="../images/down.gif" /> <a href="#deflatememlevel">DeflateMemLevel</a></li>
  46. <li><img alt="" src="../images/down.gif" /> <a href="#deflatewindowsize">DeflateWindowSize</a></li>
  47. </ul>
  48. <h3>Topics</h3>
  49. <ul id="topics">
  50. <li><img alt="" src="../images/down.gif" /> <a href="#recommended">Recommended Configuration</a></li>
  51. <li><img alt="" src="../images/down.gif" /> <a href="#enable">Enabling Compression</a></li>
  52. <li><img alt="" src="../images/down.gif" /> <a href="#proxies">Dealing with proxy servers</a></li>
  53. </ul><h3>See also</h3>
  54. <ul class="seealso">
  55. <li><a href="../filter.html">Filters</a></li>
  56. </ul></div>
  57. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  58. <div class="section">
  59. <h2><a name="recommended" id="recommended">Recommended Configuration</a></h2>
  60.     <p>This is a sample configuration for the impatient. But please take
  61.     the time and read the sections below for a detailed description!</p>
  62.  
  63.     <div class="example"><h3>Compress only a few types</h3><p><code>
  64.       AddOutputFilterByType DEFLATE text/html text/plain text/xml
  65.     </code></p></div>
  66.  
  67.     <div class="example"><h3>Compress everything except images</h3><p><code>
  68.       <Location /><br />
  69.       <span class="indent">
  70.         # Insert filter<br />
  71.         SetOutputFilter DEFLATE<br />
  72.         <br />
  73.         # Netscape 4.x has some problems...<br />
  74.         BrowserMatch ^Mozilla/4         gzip-only-text/html<br />
  75.         <br />
  76.         # Netscape 4.06-4.08 have some more problems<br />
  77.         BrowserMatch ^Mozilla/4\.0[678] no-gzip<br />
  78.         <br />
  79.         # MSIE masquerades as Netscape, but it is fine<br />
  80.         BrowserMatch \bMSIE             !no-gzip !gzip-only-text/html<br />
  81.         <br />
  82.         # Don't compress images<br />
  83.         SetEnvIfNoCase Request_URI \<br />
  84.         <span class="indent">
  85.           \.(?:gif|jpe?g|png)$ no-gzip dont-vary<br />
  86.         </span>
  87.         <br />
  88.         # Make sure proxies don't deliver the wrong content<br />
  89.         Header append Vary User-Agent env=!dont-vary<br />
  90.       </span>
  91.       </Location>
  92.     </code></p></div>
  93.  
  94. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  95. <div class="section">
  96. <h2><a name="enable" id="enable">Enabling Compression</a></h2>
  97.  
  98.     <h3><a name="output" id="output">Output Compression</a></h3>
  99.       <p>Compression is implemented by the <code>DEFLATE</code>
  100.       <a href="../filter.html">filter</a>. The following directive
  101.       will enable compression for documents in the container where it
  102.       is placed:</p>
  103.  
  104.       <div class="example"><p><code>
  105.         SetOutputFilter DEFLATE
  106.       </code></p></div>
  107.  
  108.       <p>Some popular browsers cannot handle compression of all content
  109.       so you may want to set the <code>gzip-only-text/html</code> note to
  110.       <code>1</code> to only allow html files to be compressed (see
  111.       below). If you set this to <em>anything but <code>1</code></em> it
  112.       will be ignored.</p>
  113.       
  114.       <p>If you want to restrict the compression to particular MIME types
  115.       in general, you may use the <code class="directive"><a href="../mod/core.html#addoutputfilterbytype">AddOutputFilterByType</a></code> directive. Here is an example of
  116.       enabling compression only for the html files of the Apache
  117.       documentation:</p>
  118.  
  119.       <div class="example"><p><code>
  120.         <Directory "/your-server-root/manual"><br />
  121.         <span class="indent">
  122.           AddOutputFilterByType DEFLATE text/html<br />
  123.         </span>
  124.         </Directory>
  125.       </code></p></div>
  126.  
  127.       <p>For browsers that have problems even with compression of all file
  128.       types, use the <code class="directive"><a href="../mod/mod_setenvif.html#browsermatch">BrowserMatch</a></code> directive to set the <code>no-gzip</code>
  129.       note for that particular browser so that no compression will be
  130.       performed. You may combine <code>no-gzip</code> with <code>gzip-only-text/html</code> to get the best results. In that case
  131.       the former overrides the latter. Take a look at the following
  132.       excerpt from the <a href="#recommended">configuration example</a>
  133.       defined in the section above:</p>
  134.  
  135.       <div class="example"><p><code>
  136.         BrowserMatch ^Mozilla/4         gzip-only-text/html<br />
  137.         BrowserMatch ^Mozilla/4\.0[678] no-gzip<br />
  138.         BrowserMatch \bMSIE             !no-gzip !gzip-only-text/html
  139.       </code></p></div>
  140.  
  141.       <p>At first we probe for a <code>User-Agent</code> string that
  142.       indicates a Netscape Navigator version of 4.x. These versions
  143.       cannot handle compression of types other than
  144.       <code>text/html</code>. The versions 4.06, 4.07 and 4.08 also
  145.       have problems with decompressing html files. Thus, we completely
  146.       turn off the deflate filter for them.</p>
  147.  
  148.       <p>The third <code class="directive"><a href="../mod/mod_setenvif.html#browsermatch">BrowserMatch</a></code>
  149.       directive fixes the guessed identity of the user agent, because
  150.       the Microsoft Internet Explorer identifies itself also as "Mozilla/4"
  151.       but is actually able to handle requested compression. Therefore we
  152.       match against the additional string "MSIE" (<code>\b</code> means
  153.       "word boundary") in the <code>User-Agent</code> Header and turn off
  154.       the restrictions defined before.</p>
  155.  
  156.       <div class="note"><h3>Note</h3>
  157.         The <code>DEFLATE</code> filter is always inserted after RESOURCE
  158.         filters like PHP or SSI. It never touches internal subrequests.
  159.       </div>
  160.     
  161.  
  162.     <h3><a name="input" id="input">Input Decompression</a></h3>
  163.       <p>The <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code> module also provides a filter for
  164.       decompressing a gzip compressed request body . In order to activate
  165.       this feature you have to insert the <code>DEFLATE</code> filter into
  166.       the input filter chain using <code class="directive"><a href="../mod/core.html#setinputfilter">SetInputFilter</a></code> or <code class="directive"><a href="../mod/mod_mime.html#addinputfilter">AddInputFilter</a></code>, for example:</p>
  167.  
  168.       <div class="example"><p><code>
  169.         <Location /dav-area><br />
  170.         <span class="indent">
  171.           SetInputFilter DEFLATE<br />
  172.         </span>
  173.         </Location>
  174.       </code></p></div>
  175.       
  176.       <p>Now if a request contains a <code>Content-Encoding:
  177.       gzip</code> header, the body will be automatically decompressed.
  178.       Few browsers have the ability to gzip request bodies. However,
  179.       some special applications actually do support request
  180.       compression, for instance some <a href="http://www.webdav.org">WebDAV</a> clients.</p>
  181.  
  182.       <div class="warning"><h3>Note on Content-Length</h3>
  183.         <p>If you evaluate the request body yourself, <em>don't trust
  184.         the <code>Content-Length</code> header!</em>
  185.         The Content-Length header reflects the length of the
  186.         incoming data from the client and <em>not</em> the byte count of
  187.         the decompressed data stream.</p>
  188.       </div>
  189.     
  190. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  191. <div class="section">
  192. <h2><a name="proxies" id="proxies">Dealing with proxy servers</a></h2>
  193.  
  194.     <p>The <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code> module sends a <code>Vary:
  195.     Accept-Encoding</code> HTTP response header to alert proxies that
  196.     a cached response should be sent only to clients that send the
  197.     appropriate <code>Accept-Encoding</code> request header.  This
  198.     prevents compressed content from being sent to a client that will
  199.     not understand it.</p>
  200.  
  201.     <p>If you use some special exclusions dependent
  202.     on, for example, the <code>User-Agent</code> header, you must 
  203.     manually configure an addition to the <code>Vary</code> header
  204.     to alert proxies of the additional restrictions.  For example,
  205.     in a typical configuration where the addition of the <code>DEFLATE</code>
  206.     filter depends on the <code>User-Agent</code>, you should add:</p>
  207.  
  208.     <div class="example"><p><code>
  209.       Header append Vary User-Agent
  210.     </code></p></div>
  211.     
  212.     <p>If your decision about compression depends on other information
  213.     than request headers (<em>e.g.</em> HTTP version), you have to set the
  214.     <code>Vary</code> header to the value <code>*</code>. This prevents
  215.     compliant proxies from caching entirely.</p>
  216.  
  217.     <div class="example"><h3>Example</h3><p><code>
  218.       Header set Vary *
  219.     </code></p></div>
  220. </div>
  221. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  222. <div class="directive-section"><h2><a name="DeflateBufferSize" id="DeflateBufferSize">DeflateBufferSize</a> <a name="deflatebuffersize" id="deflatebuffersize">Directive</a></h2>
  223. <table class="directive">
  224. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Fragment size to be compressed at one time by zlib</td></tr>
  225. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DeflateBufferSize <var>value</var></code></td></tr>
  226. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DeflateBufferSize 8096</code></td></tr>
  227. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  228. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  229. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_deflate</td></tr>
  230. </table>
  231.     <p>The <code class="directive">DeflateBufferSize</code> directive specifies
  232.     the size in bytes of the fragments that zlib should compress at one
  233.     time.</p>
  234.  
  235. </div>
  236. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  237. <div class="directive-section"><h2><a name="DeflateCompressionLevel" id="DeflateCompressionLevel">DeflateCompressionLevel</a> <a name="deflatecompressionlevel" id="deflatecompressionlevel">Directive</a></h2>
  238. <table class="directive">
  239. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>How much compression do we apply to the output</td></tr>
  240. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DeflateCompressionLevel <var>value</var></code></td></tr>
  241. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Zlib's default</code></td></tr>
  242. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  243. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  244. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_deflate</td></tr>
  245. <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>This directive is available since Apache 2.0.45</td></tr>
  246. </table>
  247.     <p>The <code class="directive">DeflateCompressionLevel</code> directive specifies
  248.         what level of compression should be used, the higher the value, 
  249.         the better the compression, but the more CPU time is required to
  250.         achieve this.</p>
  251.     <p>The value must between 1 (less compression) and 9 (more compression).</p>
  252.  
  253. </div>
  254. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  255. <div class="directive-section"><h2><a name="DeflateFilterNote" id="DeflateFilterNote">DeflateFilterNote</a> <a name="deflatefilternote" id="deflatefilternote">Directive</a></h2>
  256. <table class="directive">
  257. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Places the compression ratio in a note for logging</td></tr>
  258. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DeflateFilterNote [<var>type</var>] <var>notename</var></code></td></tr>
  259. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  260. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  261. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_deflate</td></tr>
  262. <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td><var>type</var> is available since Apache 2.0.45</td></tr>
  263. </table>
  264.     <p>The <code class="directive">DeflateFilterNote</code> directive
  265.     specifies that a note about compression ratios should be attached
  266.     to the request. The name of the note is the value specified for
  267.     the directive. You can use that note for statistical purposes by
  268.     adding the value to your <a href="../logs.html#accesslog">access log</a>.</p>
  269.  
  270.     <div class="example"><h3>Example</h3><p><code>
  271.       DeflateFilterNote ratio<br />
  272.       <br />
  273.       LogFormat '"%r" %b (%{ratio}n) "%{User-agent}i"' deflate<br />
  274.       CustomLog logs/deflate_log deflate
  275.     </code></p></div>
  276.  
  277.     <p>If you want to extract more accurate values from your logs, you
  278.     can use the <var>type</var> argument to specify the type of data
  279.     left as note for logging. <var>type</var> can be one of:</p>
  280.  
  281.     <dl>
  282.       <dt><code>Input</code></dt>
  283.       <dd>Store the byte count of the filter's input stream in the note.</dd>
  284.  
  285.       <dt><code>Output</code></dt>
  286.       <dd>Store the byte count of the filter's output stream in the note.</dd>
  287.  
  288.       <dt><code>Ratio</code></dt>
  289.       <dd>Store the compression ratio (<code>output/input * 100</code>)
  290.       in the note. This is the default, if the <var>type</var> argument
  291.       is omitted.</dd>
  292.     </dl>
  293.  
  294.     <p>Thus you may log it this way:</p>
  295.  
  296.     <div class="example"><h3>Accurate Logging</h3><p><code>
  297.       DeflateFilterNote Input instream<br />
  298.       DeflateFilterNote Output outstream<br />
  299.       DeflateFilterNote Ratio ratio<br />
  300.       <br />
  301.       LogFormat '"%r" %{outstream}n/%{instream}n (%{ratio}n%%)' deflate<br />
  302.       CustomLog logs/deflate_log deflate
  303.     </code></p></div>
  304.  
  305. <h3>See also</h3>
  306. <ul>
  307. <li><code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code></li>
  308. </ul>
  309. </div>
  310. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  311. <div class="directive-section"><h2><a name="DeflateMemLevel" id="DeflateMemLevel">DeflateMemLevel</a> <a name="deflatememlevel" id="deflatememlevel">Directive</a></h2>
  312. <table class="directive">
  313. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>How much memory should be used by zlib for compression</td></tr>
  314. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DeflateMemLevel <var>value</var></code></td></tr>
  315. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DeflateMemLevel 9</code></td></tr>
  316. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  317. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  318. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_deflate</td></tr>
  319. </table>
  320.     <p>The <code class="directive">DeflateMemLevel</code> directive specifies
  321.     how much memory should be used by zlib for compression
  322.     (a value between 1 and 9).</p>
  323.  
  324. </div>
  325. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  326. <div class="directive-section"><h2><a name="DeflateWindowSize" id="DeflateWindowSize">DeflateWindowSize</a> <a name="deflatewindowsize" id="deflatewindowsize">Directive</a></h2>
  327. <table class="directive">
  328. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Zlib compression window size</td></tr>
  329. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DeflateWindowSize <var>value</var></code></td></tr>
  330. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DeflateWindowSize 15</code></td></tr>
  331. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  332. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  333. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_deflate</td></tr>
  334. </table>
  335.     <p>The <code class="directive">DeflateWindowSize</code> directive specifies the
  336.     zlib compression window size (a value between 1 and 15). Generally, the
  337.     higher the window size, the higher can the compression ratio be expected.</p>
  338.  
  339. </div>
  340. </div>
  341. <div class="bottomlang">
  342. <p><span>Available Languages: </span><a href="../en/mod/mod_deflate.html" title="English"> en </a> |
  343. <a href="../ja/mod/mod_deflate.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
  344. <a href="../ko/mod/mod_deflate.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
  345. </div><div id="footer">
  346. <p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
  347. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
  348. </body></html>