mod_deflate.html revision eb3c08a98b098f4666e64d7224d138a5c38904e1
0N/A<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1472N/A "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
0N/A
0N/A<html xmlns="http://www.w3.org/1999/xhtml">
0N/A <head>
0N/A <meta name="generator" content="HTML Tidy, see www.w3.org" />
0N/A
0N/A <title>Apache module mod_deflate</title>
0N/A </head>
0N/A <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
0N/A
0N/A <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
0N/A vlink="#000080" alink="#FF0000">
0N/A <!--#include virtual="header.html" -->
0N/A
0N/A <h1 align="CENTER">Module mod_deflate</h1>
0N/A
0N/A <p>This module provides the ability to compress content before
1472N/A it is delivered to the client.</p>
1472N/A
1472N/A <p><a href="module-dict.html#Status"
0N/A rel="Help"><strong>Status:</strong></a> Experimental<br />
0N/A <a href="module-dict.html#SourceFile"
0N/A rel="Help"><strong>Source File:</strong></a>
0N/A mod_deflate.c<br />
0N/A <a href="module-dict.html#ModuleIdentifier"
0N/A rel="Help"><strong>Module Identifier:</strong></a>
0N/A deflate_module<br />
0N/A <a href="module-dict.html#Compatibility"
0N/A rel="Help"><strong>Compatibility:</strong></a> Available in
0N/A Apache 2.0 and later.</p>
0N/A
0N/A <h2>Summary</h2>
0N/A
0N/A <p>The experimental <samp>mod_deflate</samp> module allows
0N/A output from your server to be compressed before being sent
0N/A to the client over the network.</p>
0N/A
0N/A <h2>Directives</h2>
0N/A
0N/A <ul>
0N/A <li><a href="#DeflateFilterNote">DeflateFilterNote</a></li>
0N/A
0N/A <li><a href="#DeflateWindowSize">DeflateWindowSize</a></li>
0N/A
0N/A <li><a href="#DeflateMemLevel">DeflateMemLevel</a></li>
0N/A </ul>
0N/A
0N/A <p>See also: <a href="mod_mime.html#addoutputfilter">
0N/A AddOutputFilter</a> and <a href="core.html#setoutputfilter">
0N/A SetOutputFilter</a>
0N/A
0N/A <h2>Enabling Compression</h2>
0N/A
0N/A <p>Compression is implemented by the <code>DEFLATE</code>
0N/A <a href="/filter.html">filter</a>. The following directive
0N/A will enable compression for documents in the container where it
0N/A is placed:</p>
0N/A
0N/A <blockquote>
0N/A <code>SetOutputFilter DEFLATE</code>
0N/A </blockquote>
0N/A
0N/A <p>Here is an example of enabling compression for the Apache
0N/A documentation:</p>
0N/A
0N/A <blockquote>
0N/A <code>&lt;Directory "/your-server-root/manual"&gt;<br />
SetOutputFilter DEFLATE</code><br />
<em>leave the existing directives as-is</em><br />
<code>&lt;/Directory&gt;</code>
</blockquote>
<hr />
<!-- the HR is part of the directive description -->
<h2><a id="DeflateFilterNote" name="DeflateFilterNote">DeflateFilterNote
directive</a></h2>
<p><a href="directive-dict.html#Syntax"
rel="Help"><strong>Syntax:</strong></a> DeflateFilterNote <em>notename
</em><br />
<a href="directive-dict.html#Default"
rel="Help"><strong>Default:</strong></a> <i>none</i><br />
<a href="directive-dict.html#Context"
rel="Help"><strong>Context:</strong></a> server config<br />
<a href="directive-dict.html#Override"
rel="Help"><strong>Override:</strong></a> none<br />
<a href="directive-dict.html#Status"
rel="Help"><strong>Status:</strong></a> Experimental<br />
<a href="directive-dict.html#Module"
rel="Help"><strong>Module:</strong></a> mod_deflate<br />
<a href="directive-dict.html#Compatibility"
rel="Help"><strong>Compatibility:</strong></a> Apache 2.0 and
above</p>
<p>The DeflateFilterNote directive specifies that a note about
compression ratios should be attached to the request. The name
of the note is the value specified for the directive.</p>
<hr />
<!-- the HR is part of the directive description -->
<h2><a id="DeflateWindowSize"
name="DeflateWindowSize">DeflateWindowSize directive</a></h2>
<p><a href="directive-dict.html#Syntax"
rel="Help"><strong>Syntax:</strong></a> DeflateWindowSize
<em>value</em><br />
<a href="directive-dict.html#Default"
rel="Help"><strong>Default:</strong></a> <em>none</em><br />
<a href="directive-dict.html#Context"
rel="Help"><strong>Context:</strong></a> server config<br />
<a href="directive-dict.html#Override"
rel="Help"><strong>Override:</strong></a> none<br />
<a href="directive-dict.html#Status"
rel="Help"><strong>Status:</strong></a> Experimental<br />
<a href="directive-dict.html#Module"
rel="Help"><strong>Module:</strong></a> mod_deflate<br />
<a href="directive-dict.html#Compatibility"
rel="Help"><strong>Compatibility:</strong></a> Apache 2.0 and
above</p>
<p>The <samp>DeflateWindowSize</samp> directive specifies the
zlib compression window size.</p>
<hr />
<!-- the HR is part of the directive description -->
<h2><a id="DeflateMemLevel" name="DeflateMemLevel">DeflateMemLevel
directive</a></h2>
<p><a href="directive-dict.html#Syntax"
rel="Help"><strong>Syntax:</strong></a> DeflateMemLevel
<em>value</em><br />
<a href="directive-dict.html#Default"
rel="Help"><strong>Default:</strong></a> <em>none</em><br />
<a href="directive-dict.html#Context"
rel="Help"><strong>Context:</strong></a> server config<br />
<a href="directive-dict.html#Override"
rel="Help"><strong>Override:</strong></a> none<br />
<a href="directive-dict.html#Status"
rel="Help"><strong>Status:</strong></a> Experimental<br />
<a href="directive-dict.html#Module"
rel="Help"><strong>Module:</strong></a> mod_deflate<br />
<a href="directive-dict.html#Compatibility"
rel="Help"><strong>Compatibility:</strong></a> Apache 2.0 and
above</p>
<p>The DeflateMemLevel directive specifies the amount of
memory available to zlib for compression.</p>
<!--#include virtual="footer.html" -->
</body>
</html>