<?xml version="1.0"?>

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

<module name="Директивы модуля ngx_http_gzip_module"
        link="/ru/docs/http/ngx_http_gzip_module.html"
        lang="ru">

<section id="summary">

<para>
Модуль ngx_http_gzip_module - это фильтр, сжимающий ответ методом gzip,
что позволяет уменьшить размер передаваемых данных в 2 и более раз.
</para>

</section>


<section name="Пример конфигурации" id="example">

<para>
<example>
    gzip             on;
    gzip_min_length  1000;
    gzip_proxied     expired no-cache no-store private auth;
    gzip_types       text/plain application/xml;
</example>
</para>

<para>
Для записи в лог степени сжатия можно использовать переменную $gzip_ratio.
</para>

</section>


<section name="Директивы" id="directives">

<directive name="gzip">
<syntax><literal>on</literal> | <literal>off</literal></syntax>
<default>off</default>
<context>http, server, location, if в location</context>

<para>
Разрешает или запрещает сжатие ответа методом gzip.
</para>

</directive>


<directive name="gzip_buffers">
<syntax><value>число</value> <value>размер</value></syntax>
<default>32 4k/16 8k</default>
<context>http, server, location</context>

<para>
Директива задаёт число и размер буферов, в которые будет сжиматься ответ.
По умолчанию размер одного буфера равен размеру страницы, в зависимости
от платформы это или 4K, или 8K.
До версии 0.7.28 по умолчанию использовалось 4 буфера размером 4K или 8K.
</para>

</directive>


<directive name="gzip_comp_level">

<syntax><value>степень</value></syntax>
<default>1</default>
<context>http, server, location</context>

<para>
Устанавливает <value>степень</value> сжатия ответа методом gzip.
Допустимые значения находятся в диапазоне 1..9.
</para>

</directive>


<directive name="gzip_disable">
<syntax><value>regex</value> ...</syntax>
<default/>
<context>http, server, location</context>

<para>
Директива (0.6.23) запрещает сжатие ответа методом gzip для запросов
со строками "User-Agent", совпадающими с заданными регулярными выражениями.
</para>

<para>
Специальная маска "msie6" (0.7.12) соответствует
регулярному выражению "MSIE [4-6]\.", но работает быстрее.
Начиная с версии 0.8.11, из этой маски исключается "MSIE 6.0; ... SV1".
</para>

</directive>


<directive name="gzip_min_length">
<syntax><value>длина</value></syntax>
<default>20</default>
<context>http, server, location</context>

<para>
Устанавливает минимальную длину ответа, для которых
будет выполняться сжатие ответа методом gzip.
Длина определяется только из строки "Content-Length" заголовка ответа.
</para>

</directive>


<directive name="gzip_http_version">
<syntax><literal>1.0</literal> | <literal>1.1</literal></syntax>
<default>1.1</default>
<context>http, server, location</context>

<para>
Устанавливает минимальную версию HTTP запроса для сжатия ответа.
</para>

</directive>


<directive name="gzip_proxied">
<syntax>
  <literal>off</literal> |
  <literal>expired</literal> |
  <literal>no-cache</literal> |
  <literal>no-store</literal> |
  <literal>private</literal> |
  <literal>no_last_modified</literal> |
  <literal>no_etag</literal> |
  <literal>auth</literal> |
  <literal>any</literal>
  ...</syntax>
<default>off</default>
<context>http, server, location</context>

<para>
Разрешает или запрещает сжатие ответа методом gzip для проксированных
запросов в зависимости от запроса и ответа.
То что, запрос проксированный, определяется на основании строки "Via"
в заголовке запроса.
В директиве можно указать одновременно несколько паарметров:
<list type="bullet">

<listitem>
off — запрещает сжатие для всех проксированных запросов,
игнорируя остальные параметры;
</listitem>

<listitem>
expired — разрешить сжатие, если в ответе есть
строка "Expires" со значением, запрещающим кэширование;
</listitem>

<listitem>
no-cache — разрешить сжатие, если в ответе есть
строка "Cache-Control" с параметром "no-cache";
</listitem>

<listitem>
no-store — разрешить сжатие, если в ответе есть
строка "Cache-Control" с параметром "no-store";
</listitem>

<listitem>
private — разрешить сжатие, если в ответе есть
строка "Cache-Control" с параметром "private";
</listitem>

<listitem>
no_last_modified — разрешить сжатие, если в ответе нет
строки "Last-Modified";
</listitem>

<listitem>
no_etag — разрешить сжатие, если в ответе нет строки "ETag";
</listitem>

<listitem>
auth — разрешить сжатие, если в запросе есть строка "Authorization";
</listitem>

<listitem>
any — разрешить сжатие для всех проксированных запросов;
</listitem>

</list>
</para>

</directive>


<directive name="gzip_types">
<syntax><value>mime-тип</value> ...</syntax>
<default>text/html</default>
<context>http, server, location</context>

<para>
Разрешает сжатие ответа методом gzip для указанных MIME-типов в дополнение
к "text/html". "text/html" сжимается всегда.
</para>

</directive>


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

<para>
Разрешает или запрещает выдавать в ответе строку заголовка
"Vary: Accept-Encoding", если директивы
<link id="gzip"/> или
<link doc="ngx_http_gzip_static_module.xml" id="gzip_static"/>
активны.
</para>

</directive>

</section>

</module>