ngx_http_gunzip_module.xml

<?xml version="1.0"?>

<!--
  Copyright (C) Maxim Dounin
  Copyright (C) Nginx, Inc.
  -->

<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">

<module name="Module ngx_http_gunzip_module"
        link="/en/docs/http/ngx_http_gunzip_module.html"
        lang="en"
        rev="2">

<section id="summary">

<para>
The <literal>ngx_http_gunzip_module</literal> module is a filter that
decompresses responses with “<literal>Content-Encoding: gzip</literal>”
for clients that do not support “gzip” encoding method.
The module will be useful when it is desirable to store
data compressed to save space and reduce I/O costs.
</para>

<para>
This module is not built by default, it should be enabled with the
<literal>--with-http_gunzip_module</literal>
configuration parameter.
</para>

</section>


<section id="example" name="Example Configuration">

<para>
<example>
location /storage/ {
    gunzip on;
    ...
}
</example>
</para>

</section>


<section id="directives" name="Directives">

<directive name="gunzip">
<syntax><literal>on</literal> | <literal>off</literal></syntax>
<default>off</default>
<context>http</context>
<context>server</context>
<context>location</context>

<para>
Enables or disables decompression of gzipped responses
for clients that lack gzip support.
If enabled, the following directives are also taken into account
when determining if clients support gzip:
<link doc="ngx_http_gzip_module.xml" id="gzip_http_version"/>,
<link doc="ngx_http_gzip_module.xml" id="gzip_proxied"/>, and
<link doc="ngx_http_gzip_module.xml" id="gzip_disable"/>.
See also the <link doc="ngx_http_gzip_module.xml" id="gzip_vary"/> directive.
</para>

</directive>


<directive name="gunzip_buffers">
<syntax><value>number</value> <value>size</value></syntax>
<default>32 4k|16 8k</default>
<context>http</context>
<context>server</context>
<context>location</context>

<para>
Sets the <value>number</value> and <value>size</value> of buffers
used to decompress a response.
By default, the buffer size is equal to one memory page.
This is either 4K or 8K, depending on a platform.
</para>

</directive>

</section>

</module>