Mercurial > hg > nginx-site

comparison xml/ru/docs/http/ngx_http_gzip_module.xml @ 76:4a4caa566120

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Russian documentation import. Changes in module.dtd: <example> now allowed to contain <value> and <emphasis> elements (we need this to show important parts in examples), less strict checking of <directive> syntax (we don't want to fully document some directives, notably deprecated ones). Known issues: 1. <syntax> elements are preserved as is, they will require manual conversion (likely to some not-yet-existed format a la DocBook cmdsynopsis, as currently used one seems to be incomplete); 2. <value> no longer corresponds to replaceable content, and it's use in examples isn't correct; 3. <link doc="document#fragment"> doesn't work with current xslt, either should be supported or changed to <link doc="document" id="fragment">. The following files are intentionally omitted: maillists.xml (support.xml should be used instead), experimental.xml (obsolete), faq.xml (conflicts with existing one, needs discussion). Not yet linked to site.
author Maxim Dounin <mdounin@mdounin.ru>
date Tue, 11 Oct 2011 12:57:50 +0000
parents
children 0a45870d0160
comparison
equal deleted inserted replaced
75:2bf4cd2787c5 76:4a4caa566120
1 <?xml version="1.0" encoding="utf-8"?>
2
3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
4
5 <module name="Директивы модуля ngx_http_gzip_module"
6 link="/ru/docs/http/ngx_http_gzip_module.html"
7 lang="ru">
8
9 <section name="" id="summary">
10
11 <para>
12 Модуль ngx_http_gzip_module - это фильтр, сжимающий ответ методом gzip,
13 что позволяет уменьшить размер передаваемых данных в 2 и более раз.
14 </para>
15
16 </section>
17
18
19 <section name="Пример конфигурации" id="example">
20
21 <para>
22 <example>
23 gzip on;
24 gzip_min_length 1000;
25 gzip_proxied expired no-cache no-store private auth;
26 gzip_types text/plain application/xml;
27 </example>
28 </para>
29
30 <para>
31 Для записи в лог степени сжатия можно использовать переменную $gzip_ratio.
32 </para>
33
34 </section>
35
36
37 <section name="Директивы" id="directives">
38
39 <directive name="gzip">
40 <syntax>gzip <value>on|off</value></syntax>
41 <default>gzip off</default>
42 <context>http, server, location, if в location</context>
43
44 <para>
45 Разрешает или запрещает сжатие ответа методом gzip.
46 </para>
47
48 </directive>
49
50
51 <directive name="gzip_buffers">
52 <syntax>gzip_buffers <value>число размер</value></syntax>
53 <default>gzip_buffers 32 4k/16 8k</default>
54 <context>http, server, location</context>
55
56 <para>
57 Директива задаёт число и размер буферов, в которые будет сжиматься ответ.
58 По умолчанию размер одного буфера равен размеру страницы, в зависимости
59 от платформы это или 4K, или 8K.
60 До версии 0.7.28 по умолчанию использовалось 4 буфера размером 4K или 8K.
61 </para>
62
63 </directive>
64
65
66 <directive name="gzip_comp_level">
67
68 <syntax>gzip_comp_level <value>1..9</value></syntax>
69 <default>gzip_comp_level 1</default>
70 <context>http, server, location</context>
71
72 <para>
73 Устанавливает уровень сжатия ответа методом gzip.
74 </para>
75
76 </directive>
77
78
79 <directive name="gzip_disable">
80 <syntax>gzip_disable <value>regex [regex ...]</value></syntax>
81 <default>нет</default>
82 <context>http, server, location</context>
83
84 <para>
85 Директива (0.6.23) запрещает сжатие ответа методом gzip для запросов
86 со строками "User-Agent", совпадающими с заданными регулярными выражениями.
87 </para>
88
89 <para>
90 Специальная маска "msie6" (0.7.12) соответствует
91 регулярному выражению "MSIE [4-6]\.", но работает быстрее.
92 Начиная с версии 0.8.11, из этой маски исключается "MSIE 6.0; ... SV1".
93 </para>
94
95 </directive>
96
97
98 <directive name="gzip_min_length">
99 <syntax>gzip_min_length <value>длина</value></syntax>
100 <default>gzip_min_length 20</default>
101 <context>http, server, location</context>
102
103 <para>
104 Устанавливает минимальную длину ответа, для которых
105 будет выполняться сжатие ответа методом gzip.
106 Длина определяется только из строки "Content-Length" заголовка ответа.
107 </para>
108
109 </directive>
110
111
112 <directive name="gzip_http_version">
113 <syntax>gzip_http_version <value>1.0|1.1</value></syntax>
114 <default>gzip_http_version 1.1</default>
115 <context>http, server, location</context>
116
117 <para>
118 Устанавливает минимальную версию HTTP запроса для сжатия ответа.
119 </para>
120
121 </directive>
122
123
124 <directive name="gzip_proxied">
125 <syntax>gzip_proxied <value>[off|expired|no-cache|no-store|private|no_last_modified|no_etag|auth|any] ...</value></syntax>
126 <default>gzip_proxied off</default>
127 <context>http, server, location</context>
128
129 <para>
130 Разрешает или запрещает сжатие ответа методом gzip для проксированных
131 запросов в зависимости от запроса и ответа.
132 То что, запрос проксированный, определяется на основании строки "Via"
133 в заголовке запроса.
134 В директиве можно указать одновременно несколько паарметров:
135 <list type="bullet">
136
137 <listitem>
138 off — запрещает сжатие для всех проксированных запросов,
139 игнорируя остальные параметры;
140 </listitem>
141
142 <listitem>
143 expired — разрешить сжатие, если в ответе есть
144 строка "Expires" со значением, запрещающим кэширование;
145 </listitem>
146
147 <listitem>
148 no-cache — разрешить сжатие, если в ответе есть
149 строка "Cache-Control" с параметром "no-cache";
150 </listitem>
151
152 <listitem>
153 no-store — разрешить сжатие, если в ответе есть
154 строка "Cache-Control" с параметром "no-store";
155 </listitem>
156
157 <listitem>
158 private — разрешить сжатие, если в ответе есть
159 строка "Cache-Control" с параметром "private";
160 </listitem>
161
162 <listitem>
163 no_last_modified — разрешить сжатие, если в ответе нет
164 строки "Last-Modified";
165 </listitem>
166
167 <listitem>
168 no_etag — разрешить сжатие, если в ответе нет строки "ETag";
169 </listitem>
170
171 <listitem>
172 auth — разрешить сжатие, если в запросе есть строка "Authorization";
173 </listitem>
174
175 <listitem>
176 any — разрешить сжатие для всех проксированных запросов;
177 </listitem>
178
179 </list>
180 </para>
181
182 </directive>
183
184
185 <directive name="gzip_types">
186 <syntax>gzip_types <value>mime-тип [mime-тип ...]</value></syntax>
187 <default>gzip_types text/html</default>
188 <context>http, server, location</context>
189
190 <para>
191 Разрешает сжатие ответа методом gzip для указанных MIME-типов в дополнение
192 к "text/html". "text/html" сжимается всегда.
193 </para>
194
195 </directive>
196
197
198 <directive name="gzip_vary">
199 <syntax>gzip_vary <value>on|off</value></syntax>
200 <default>gzip_vary off</default>
201 <context>http, server, location</context>
202
203 <para>
204 Разрешает или запрещает выдавать в ответе строку заголовка
205 "Vary: Accept-Encoding", если директивы
206 <link id="gzip"/> или
207 <link doc="ngx_http_gzip_static_module.xml#gzip_static">gzip_static</link>
208 активны.
209 </para>
210
211 </directive>
212
213 </section>
214
215 </module>