Mercurial > hg > nginx-site

comparison xml/ru/docs/http/ngx_http_gzip_module.xml @ 322:099ee546b04e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Revision.
author Ruslan Ermilov <ru@nginx.com>
date Mon, 16 Jan 2012 13:42:12 +0000
parents 2305be197a84
children 92213e993a0b
comparison
equal deleted inserted replaced
321:f28abb2ea638 322:099ee546b04e
1 <?xml version="1.0"?> 1 <?xml version="1.0"?>
2 2
3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
4 4
5 <module name="Директивы модуля ngx_http_gzip_module" 5 <module name="Модуль ngx_http_gzip_module"
6 link="/ru/docs/http/ngx_http_gzip_module.html" 6 link="/ru/docs/http/ngx_http_gzip_module.html"
7 lang="ru"> 7 lang="ru">
8 8
9 <section id="summary"> 9 <section id="summary">
10 10
11 <para> 11 <para>
12 Модуль ngx_http_gzip_module - это фильтр, сжимающий ответ методом gzip, 12 Модуль <literal>ngx_http_gzip_module</literal> — это фильтр,
13 сжимающий ответ методом gzip,
13 что позволяет уменьшить размер передаваемых данных в 2 и более раз. 14 что позволяет уменьшить размер передаваемых данных в 2 и более раз.
14 </para> 15 </para>
15 16
16 </section> 17 </section>
17 18
18 19
19 <section name="Пример конфигурации" id="example"> 20 <section id="example" name="Пример конфигурации">
20 21
21 <para> 22 <para>
22 <example> 23 <example>
23 gzip on; 24 gzip on;
24 gzip_min_length 1000; 25 gzip_min_length 1000;
25 gzip_proxied expired no-cache no-store private auth; 26 gzip_proxied expired no-cache no-store private auth;
26 gzip_types text/plain application/xml; 27 gzip_types text/plain application/xml;
27 </example> 28 </example>
28 </para> 29 </para>
29 30
30 <para> 31 <para>
31 Для записи в лог степени сжатия можно использовать переменную $gzip_ratio. 32 Для записи в лог степени сжатия можно использовать переменную
33 <var>$gzip_ratio</var>.
32 </para> 34 </para>
33 35
34 </section> 36 </section>
35 37
36 38
37 <section name="Директивы" id="directives"> 39 <section id="directives" name="Директивы">
38 40
39 <directive name="gzip"> 41 <directive name="gzip">
40 <syntax><literal>on</literal> | <literal>off</literal></syntax> 42 <syntax><literal>on</literal> | <literal>off</literal></syntax>
41 <default>off</default> 43 <default>off</default>
42 <context>http, server, location, if в location</context> 44 <context>http</context>
45 <context>server</context>
46 <context>location</context>
47 <context>if в location</context>
43 48
44 <para> 49 <para>
45 Разрешает или запрещает сжатие ответа методом gzip. 50 Разрешает или запрещает сжатие ответа методом gzip.
46 </para> 51 </para>
47 52
48 </directive> 53 </directive>
49 54
50 55
51 <directive name="gzip_buffers"> 56 <directive name="gzip_buffers">
52 <syntax><value>число</value> <value>размер</value></syntax> 57 <syntax><value>число</value> <value>размер</value></syntax>
53 <default>32 4k/16 8k</default> 58 <default>32 4k|16 8k</default>
54 <context>http, server, location</context> 59 <context>http</context>
55 60 <context>server</context>
56 <para> 61 <context>location</context>
57 Директива задаёт число и размер буферов, в которые будет сжиматься ответ. 62
58 По умолчанию размер одного буфера равен размеру страницы, в зависимости 63 <para>
59 от платформы это или 4K, или 8K. 64 Задаёт <value>число</value> и <value>размер</value> буферов,
65 в которые будет сжиматься ответ.
66 По умолчанию размер одного буфера равен размеру страницы.
67 В зависимости от платформы это или 4K, или 8K.
68 <note>
60 До версии 0.7.28 по умолчанию использовалось 4 буфера размером 4K или 8K. 69 До версии 0.7.28 по умолчанию использовалось 4 буфера размером 4K или 8K.
70 </note>
61 </para> 71 </para>
62 72
63 </directive> 73 </directive>
64 74
65 75
66 <directive name="gzip_comp_level"> 76 <directive name="gzip_comp_level">
67 77
68 <syntax><value>степень</value></syntax> 78 <syntax><value>степень</value></syntax>
69 <default>1</default> 79 <default>1</default>
70 <context>http, server, location</context> 80 <context>http</context>
81 <context>server</context>
82 <context>location</context>
71 83
72 <para> 84 <para>
73 Устанавливает <value>степень</value> сжатия ответа методом gzip. 85 Устанавливает <value>степень</value> сжатия ответа методом gzip.
74 Допустимые значения находятся в диапазоне 1..9. 86 Допустимые значения находятся в диапазоне 1..9.
75 </para> 87 </para>
78 90
79 91
80 <directive name="gzip_disable"> 92 <directive name="gzip_disable">
81 <syntax><value>regex</value> ...</syntax> 93 <syntax><value>regex</value> ...</syntax>
82 <default/> 94 <default/>
83 <context>http, server, location</context> 95 <context>http</context>
84 96 <context>server</context>
85 <para> 97 <context>location</context>
86 Директива (0.6.23) запрещает сжатие ответа методом gzip для запросов 98 <appeared-in>0.6.23</appeared-in>
87 со строками "User-Agent", совпадающими с заданными регулярными выражениями. 99
88 </para> 100 <para>
89 101 Запрещает сжатие ответа методом gzip для запросов
90 <para> 102 со строками заголовка <header>User-Agent</header>,
91 Специальная маска "msie6" (0.7.12) соответствует 103 совпадающими с заданными регулярными выражениями.
92 регулярному выражению "MSIE [4-6]\.", но работает быстрее. 104 </para>
93 Начиная с версии 0.8.11, из этой маски исключается "MSIE 6.0; ... SV1". 105
106 <para>
107 Специальная маска “<literal>msie6</literal>” (0.7.12) соответствует
108 регулярному выражению “<literal>MSIE [4-6]\.</literal>”, но работает быстрее.
109 Начиная с версии 0.8.11, из этой маски исключается
110 “<literal>MSIE 6.0; ... SV1</literal>”.
94 </para> 111 </para>
95 112
96 </directive> 113 </directive>
97 114
98 115
99 <directive name="gzip_min_length"> 116 <directive name="gzip_min_length">
100 <syntax><value>длина</value></syntax> 117 <syntax><value>длина</value></syntax>
101 <default>20</default> 118 <default>20</default>
102 <context>http, server, location</context> 119 <context>http</context>
103 120 <context>server</context>
104 <para> 121 <context>location</context>
105 Устанавливает минимальную длину ответа, для которых 122
106 будет выполняться сжатие ответа методом gzip. 123 <para>
107 Длина определяется только из строки "Content-Length" заголовка ответа. 124 Устанавливает минимальную длину ответа, который будет сжиматься методом gzip.
125 Длина определяется только из строки <header>Content-Length</header>
126 заголовка ответа.
108 </para> 127 </para>
109 128
110 </directive> 129 </directive>
111 130
112 131
113 <directive name="gzip_http_version"> 132 <directive name="gzip_http_version">
114 <syntax><literal>1.0</literal> | <literal>1.1</literal></syntax> 133 <syntax><literal>1.0</literal> | <literal>1.1</literal></syntax>
115 <default>1.1</default> 134 <default>1.1</default>
116 <context>http, server, location</context> 135 <context>http</context>
117 136 <context>server</context>
118 <para> 137 <context>location</context>
119 Устанавливает минимальную версию HTTP запроса для сжатия ответа. 138
139 <para>
140 Устанавливает минимальную версию HTTP-запроса, необходимую для сжатия ответа.
120 </para> 141 </para>
121 142
122 </directive> 143 </directive>
123 144
124 145
133 <literal>no_etag</literal> | 154 <literal>no_etag</literal> |
134 <literal>auth</literal> | 155 <literal>auth</literal> |
135 <literal>any</literal> 156 <literal>any</literal>
136 ...</syntax> 157 ...</syntax>
137 <default>off</default> 158 <default>off</default>
138 <context>http, server, location</context> 159 <context>http</context>
160 <context>server</context>
161 <context>location</context>
139 162
140 <para> 163 <para>
141 Разрешает или запрещает сжатие ответа методом gzip для проксированных 164 Разрешает или запрещает сжатие ответа методом gzip для проксированных
142 запросов в зависимости от запроса и ответа. 165 запросов в зависимости от запроса и ответа.
143 То что, запрос проксированный, определяется на основании строки "Via" 166 То, что запрос проксированный, определяется на основании строки
167 <header>Via</header>
144 в заголовке запроса. 168 в заголовке запроса.
145 В директиве можно указать одновременно несколько параметров: 169 В директиве можно указать одновременно несколько параметров:
146 <list type="bullet"> 170 <list type="tag">
147 171
148 <listitem> 172 <tag-name><literal>off</literal></tag-name>
149 off — запрещает сжатие для всех проксированных запросов, 173 <tag-desc>
174 запрещает сжатие для всех проксированных запросов,
150 игнорируя остальные параметры; 175 игнорируя остальные параметры;
151 </listitem> 176 </tag-desc>
152 177
153 <listitem> 178 <tag-name><literal>expired</literal></tag-name>
154 expired — разрешить сжатие, если в ответе есть 179 <tag-desc>
155 строка "Expires" со значением, запрещающим кэширование; 180 разрешить сжатие, если в заголовке ответа есть строка
156 </listitem> 181 <header>Expires</header> со значением, запрещающим кэширование;
157 182 </tag-desc>
158 <listitem> 183
159 no-cache — разрешить сжатие, если в ответе есть 184 <tag-name><literal>no-cache</literal></tag-name>
160 строка "Cache-Control" с параметром "no-cache"; 185 <tag-desc>
161 </listitem> 186 разрешить сжатие, если в заголовке ответа есть строка
162 187 <header>Cache-Control</header> с параметром “<literal>no-cache</literal>”;
163 <listitem> 188 </tag-desc>
164 no-store — разрешить сжатие, если в ответе есть 189
165 строка "Cache-Control" с параметром "no-store"; 190 <tag-name><literal>no-store</literal></tag-name>
166 </listitem> 191 <tag-desc>
167 192 разрешить сжатие, если в заголовке ответа есть строка
168 <listitem> 193 <header>Cache-Control</header> с параметром “<literal>no-store</literal>”;
169 private — разрешить сжатие, если в ответе есть 194 </tag-desc>
170 строка "Cache-Control" с параметром "private"; 195
171 </listitem> 196 <tag-name><literal>private</literal></tag-name>
172 197 <tag-desc>
173 <listitem> 198 разрешить сжатие, если в заголовке ответа есть строка
174 no_last_modified — разрешить сжатие, если в ответе нет 199 <header>Cache-Control</header> с параметром “<literal>private</literal>”;
175 строки "Last-Modified"; 200 </tag-desc>
176 </listitem> 201
177 202 <tag-name><literal>no_last_modified</literal></tag-name>
178 <listitem> 203 <tag-desc>
179 no_etag — разрешить сжатие, если в ответе нет строки "ETag"; 204 разрешить сжатие, если в заголовке ответа нет строки
180 </listitem> 205 <header>Last-Modified</header>;
181 206 </tag-desc>
182 <listitem> 207
183 auth — разрешить сжатие, если в запросе есть строка "Authorization"; 208 <tag-name><literal>no_etag</literal></tag-name>
184 </listitem> 209 <tag-desc>
185 210 разрешить сжатие, если в заголовке ответа нет строки
186 <listitem> 211 <header>ETag</header>;
187 any — разрешить сжатие для всех проксированных запросов; 212 </tag-desc>
188 </listitem> 213
214 <tag-name><literal>auth</literal></tag-name>
215 <tag-desc>
216 разрешить сжатие, если в заголовке запроса есть строка
217 <header>Authorization</header>;
218 </tag-desc>
219
220 <tag-name><literal>any</literal></tag-name>
221 <tag-desc>
222 разрешить сжатие для всех проксированных запросов;
223 </tag-desc>
189 224
190 </list> 225 </list>
191 </para> 226 </para>
192 227
193 </directive> 228 </directive>
194 229
195 230
196 <directive name="gzip_types"> 231 <directive name="gzip_types">
197 <syntax><value>mime-тип</value> ...</syntax> 232 <syntax><value>mime-тип</value> ...</syntax>
198 <default>text/html</default> 233 <default>text/html</default>
199 <context>http, server, location</context> 234 <context>http</context>
235 <context>server</context>
236 <context>location</context>
200 237
201 <para> 238 <para>
202 Разрешает сжатие ответа методом gzip для указанных MIME-типов в дополнение 239 Разрешает сжатие ответа методом gzip для указанных MIME-типов в дополнение
203 к "text/html". "text/html" сжимается всегда. 240 к “<literal>text/html</literal>”.
241 Ответы с типом “<literal>text/html</literal>” сжимаются всегда.
204 </para> 242 </para>
205 243
206 </directive> 244 </directive>
207 245
208 246
209 <directive name="gzip_vary"> 247 <directive name="gzip_vary">
210 <syntax><literal>on</literal> | <literal>off</literal></syntax> 248 <syntax><literal>on</literal> | <literal>off</literal></syntax>
211 <default>off</default> 249 <default>off</default>
212 <context>http, server, location</context> 250 <context>http</context>
251 <context>server</context>
252 <context>location</context>
213 253
214 <para> 254 <para>
215 Разрешает или запрещает выдавать в ответе строку заголовка 255 Разрешает или запрещает выдавать в ответе строку заголовка
216 "Vary: Accept-Encoding", если директивы 256 <header>Vary: Accept-Encoding</header>, если директивы
217 <link id="gzip"/> или 257 <link id="gzip"/> или
218 <link doc="ngx_http_gzip_static_module.xml" id="gzip_static"/> 258 <link doc="ngx_http_gzip_static_module.xml" id="gzip_static"/>
219 активны. 259 активны.
220 </para> 260 </para>
221 261