Apache HTTP Server Version 2.2
Apache HTTP Server Version 2.2
This document refers to the 2.2 version of Apache httpd, which is no longer maintained. The active release is documented here. If you have not already upgraded, please follow this link for more information.
You may follow this link to go to the current version of this document.
| Description: | Compress content before it is delivered to the client |
|---|---|
| Status: | Extension |
| Module Identifier: | deflate_module |
| Source File: | mod_deflate.c |
The mod_deflate module provides
the DEFLATE output filter that allows output from
your server to be compressed before being sent to the client over
the network.
DeflateBufferSize DeflateCompressionLevel DeflateFilterNote DeflateInflateLimitRequestBody DeflateInflateRatioBurst DeflateInflateRatioLimit DeflateMemLevel DeflateWindowSize
Some web applications are vulnerable to an information disclosure attack when a TLS connection carries deflate compressed data. For more information, review the details of the "BREACH" family of attacks.
This is a simple configuration that compresses common text-based content types.
AddOutputFilterByType DEFLATE text/html text/plain text/xml text/css text/javascript application/javascript
Compression is implemented by the DEFLATE
filter. The following directive
will enable compression for documents in the container where it
is placed:
SetOutputFilter DEFLATE
Some popular browsers cannot handle compression of all content
so you may want to set the gzip-only-text/html note to
1 to only allow html files to be compressed (see
below). If you set this to anything but 1 it
will be ignored.
If you want to restrict the compression to particular MIME types
in general, you may use the AddOutputFilterByType directive. Here is an example of
enabling compression only for the html files of the Apache
documentation:
<Directory "/your-server-root/manual">
AddOutputFilterByType DEFLATE text/html
</Directory>
For browsers that have problems even with compression of all file
types, use the BrowserMatch directive to set the no-gzip
note for that particular browser so that no compression will be
performed. You may combine no-gzip with gzip-only-text/html to get the best results. In that case
the former overrides the latter. Take a look at the following
excerpt from the configuration example
defined in the section above:
BrowserMatch ^Mozilla/4 gzip-only-text/html
BrowserMatch ^Mozilla/4\.0[678] no-gzip
BrowserMatch \bMSIE !no-gzip !gzip-only-text/html
At first we probe for a User-Agent string that
indicates a Netscape Navigator version of 4.x. These versions
cannot handle compression of types other than
text/html. The versions 4.06, 4.07 and 4.08 also
have problems with decompressing html files. Thus, we completely
turn off the deflate filter for them.
The third BrowserMatch
directive fixes the guessed identity of the user agent, because
the Microsoft Internet Explorer identifies itself also as "Mozilla/4"
but is actually able to handle requested compression. Therefore we
match against the additional string "MSIE" (\b means
"word boundary") in the User-Agent Header and turn off
the restrictions defined before.
DEFLATE filter is always inserted after RESOURCE
filters like PHP or SSI. It never touches internal subrequests.
force-gzip,
set via SetEnv, which
will ignore the accept-encoding setting of your browser and will
send compressed output.
The mod_deflate module also provides a filter for
inflating/uncompressing a gzip compressed response body. In order to activate
this feature you have to insert the INFLATE filter into
the output filter chain using SetOutputFilter or AddOutputFilter, for example:
<Location /dav-area>
ProxyPass http://example.com/
SetOutputFilter INFLATE
</Location>
This Example will uncompress gzip'ed output from example.com, so other filters can do further processing with it.
The mod_deflate module also provides a filter for
decompressing a gzip compressed request body . In order to activate
this feature you have to insert the DEFLATE filter into
the input filter chain using SetInputFilter or AddInputFilter, for example:
<Location /dav-area>
SetInputFilter DEFLATE
</Location>
Now if a request contains a Content-Encoding:
gzip header, the body will be automatically decompressed.
Few browsers have the ability to gzip request bodies. However,
some special applications actually do support request
compression, for instance some WebDAV clients.
If you evaluate the request body yourself, don't trust
the Content-Length header!
The Content-Length header reflects the length of the
incoming data from the client and not the byte count of
the decompressed data stream.
The mod_deflate module sends a Vary:
Accept-Encoding HTTP response header to alert proxies that
a cached response should be sent only to clients that send the
appropriate Accept-Encoding request header. This
prevents compressed content from being sent to a client that will
not understand it.
If you use some special exclusions dependent
on, for example, the User-Agent header, you must
manually configure an addition to the Vary header
to alert proxies of the additional restrictions. For example,
in a typical configuration where the addition of the DEFLATE
filter depends on the User-Agent, you should add:
Header append Vary User-Agent
If your decision about compression depends on other information
than request headers (e.g. HTTP version), you have to set the
Vary header to the value *. This prevents
compliant proxies from caching entirely.
Header set Vary *
| Description: | Fragment size to be compressed at one time by zlib |
|---|---|
| Syntax: | DeflateBufferSize value |
| Default: | DeflateBufferSize 8096 |
| Context: | server config, virtual host |
| Status: | Extension |
| Module: | mod_deflate |
The DeflateBufferSize directive specifies
the size in bytes of the fragments that zlib should compress at one
time.
| Description: | How much compression do we apply to the output |
|---|---|
| Syntax: | DeflateCompressionLevel value |
| Default: | Zlib's default |
| Context: | server config, virtual host |
| Status: | Extension |
| Module: | mod_deflate |
| Compatibility: | This directive is available since Apache 2.0.45 |
The DeflateCompressionLevel directive specifies
what level of compression should be used, the higher the value,
the better the compression, but the more CPU time is required to
achieve this.
The value must between 1 (less compression) and 9 (more compression).
| Description: | Places the compression ratio in a note for logging |
|---|---|
| Syntax: | DeflateFilterNote [type] notename |
| Context: | server config, virtual host |
| Status: | Extension |
| Module: | mod_deflate |
| Compatibility: | type is available since Apache 2.0.45 |
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. You can use that note for statistical purposes by
adding the value to your access log.
DeflateFilterNote ratio
LogFormat '"%r" %b (%{ratio}n) "%{User-agent}i"' deflate
CustomLog logs/deflate_log deflate
If you want to extract more accurate values from your logs, you can use the type argument to specify the type of data left as a note for logging. type can be one of:
InputOutputRatiooutput/input * 100)
in the note. This is the default, if the type argument
is omitted.Thus you may log it this way:
DeflateFilterNote Input instream
DeflateFilterNote Output outstream
DeflateFilterNote Ratio ratio
LogFormat '"%r" %{outstream}n/%{instream}n (%{ratio}n%%)' deflate
CustomLog logs/deflate_log deflate
| Description: | Maximum size of inflated request bodies |
|---|---|
| Syntax: | DeflateInflateLimitRequestBodyvalue |
| Default: | None, but LimitRequestBody applies after deflation |
| Context: | server config, virtual host, directory, .htaccess |
| Status: | Extension |
| Module: | mod_deflate |
| Compatibility: | 2.2.28 and later |
The DeflateInflateLimitRequestBody directive
specifies the maximum size of an inflated request body. If it is unset,
LimitRequestBody is applied to the
inflated body.
| Description: | Maximum number of times the inflation ratio for request bodies can be crossed |
|---|---|
| Syntax: | DeflateInflateRatioBurst value |
| Default: | 3 |
| Context: | server config, virtual host, directory, .htaccess |
| Status: | Extension |
| Module: | mod_deflate |
| Compatibility: | 2.2.28 and later |
The DeflateInflateRatioBurst directive
specifies the maximum number of times the
DeflateInflateRatioLimit can be crossed before
terminating the request.
| Description: | Maximum inflation ratio for request bodies |
|---|---|
| Syntax: | DeflateInflateRatioLimit value |
| Default: | 200 |
| Context: | server config, virtual host, directory, .htaccess |
| Status: | Extension |
| Module: | mod_deflate |
| Compatibility: | 2.2.28 and later |
The DeflateInflateRatioLimit directive
specifies the maximum ratio of deflated to inflated size of an
inflated request body. This ratio is checked as the body is
streamed in, and if crossed more than
DeflateInflateRatioBurst times, the request
will be terminated.
| Description: | How much memory should be used by zlib for compression |
|---|---|
| Syntax: | DeflateMemLevel value |
| Default: | DeflateMemLevel 9 |
| Context: | server config, virtual host |
| Status: | Extension |
| Module: | mod_deflate |
The DeflateMemLevel directive specifies
how much memory should be used by zlib for compression
(a value between 1 and 9).
| Description: | Zlib compression window size |
|---|---|
| Syntax: | DeflateWindowSize value |
| Default: | DeflateWindowSize 15 |
| Context: | server config, virtual host |
| Status: | Extension |
| Module: | mod_deflate |
The DeflateWindowSize directive specifies the
zlib compression window size (a value between 1 and 15). Generally, the
higher the window size, the higher can the compression ratio be expected.