Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_gzip_module.xml @ 3011:55d49eb065ac

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed example in the js_periodic directive.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 14 Sep 2023 16:38:00 +0100
parents a4ef92436fbc
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
2
580
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 546
diff changeset
3 <!--
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 546
diff changeset
4 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 546
diff changeset
5 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 546
diff changeset
6 -->
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 546
diff changeset
7
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
9
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
10 <module name="Module ngx_http_gzip_module"
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 link="/en/docs/http/ngx_http_gzip_module.html"
589
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
12 lang="en"
2354
a4ef92436fbc Documented BREACH attack vulnerability for the gzip module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2142
diff changeset
13 rev="5">
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15 <section id="summary">
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
17 <para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
18 The <literal>ngx_http_gzip_module</literal> module is a filter
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
19 that compresses responses using the “gzip” method.
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
20 This often helps to reduce the size of transmitted data by half or even more.
2354
a4ef92436fbc Documented BREACH attack vulnerability for the gzip module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2142
diff changeset
21 <note>
a4ef92436fbc Documented BREACH attack vulnerability for the gzip module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2142
diff changeset
22 When using the SSL/TLS protocol, compressed responses may be subject to
a4ef92436fbc Documented BREACH attack vulnerability for the gzip module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2142
diff changeset
23 <link url="https://en.wikipedia.org/wiki/BREACH">BREACH</link> attacks.
a4ef92436fbc Documented BREACH attack vulnerability for the gzip module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2142
diff changeset
24 </note>
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25 </para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27 </section>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30 <section id="example" name="Example Configuration">
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32 <para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33 <example>
351
a4fa80755eab Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents: 330
diff changeset
34 gzip on;
a4fa80755eab Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents: 330
diff changeset
35 gzip_min_length 1000;
a4fa80755eab Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents: 330
diff changeset
36 gzip_proxied expired no-cache no-store private auth;
a4fa80755eab Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents: 330
diff changeset
37 gzip_types text/plain application/xml;
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38 </example>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39 </para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
40
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
41 <para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42 The <var>$gzip_ratio</var> variable can be used to log the
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43 achieved compression ratio.
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44 </para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46 </section>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49 <section id="directives" name="Directives">
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
51 <directive name="gzip">
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
52 <syntax><literal>on</literal> | <literal>off</literal></syntax>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53 <default>off</default>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
54 <context>http</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55 <context>server</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56 <context>location</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57 <context>if in location</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
59 <para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60 Enables or disables gzipping of responses.
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61 </para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
63 </directive>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
65
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
66 <directive name="gzip_buffers">
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
67 <syntax><value>number</value> <value>size</value></syntax>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
68 <default>32 4k|16 8k</default>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
69 <context>http</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70 <context>server</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
71 <context>location</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
72
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
73 <para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74 Sets the <value>number</value> and <value>size</value> of buffers
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
75 used to compress a response.
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
76 By default, the buffer size is equal to one memory page.
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
77 This is either 4K or 8K, depending on a platform.
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
78 <note>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
79 Until version 0.7.28, four 4K or 8K buffers were used by default.
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80 </note>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81 </para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
82
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
83 </directive>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
84
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
85
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
86 <directive name="gzip_comp_level">
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
87
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88 <syntax><value>level</value></syntax>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89 <default>1</default>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 <context>http</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
91 <context>server</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92 <context>location</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
93
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94 <para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95 Sets a gzip compression <value>level</value> of a response.
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
96 Acceptable values are in the range from 1 to 9.
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
97 </para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
98
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
99 </directive>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
100
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
101
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
102 <directive name="gzip_disable">
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
103 <syntax><value>regex</value> ...</syntax>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
104 <default/>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
105 <context>http</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
106 <context>server</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
107 <context>location</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
108 <appeared-in>0.6.23</appeared-in>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
109
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
110 <para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
111 Disables gzipping of responses for requests with
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
112 <header>User-Agent</header> header fields matching
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
113 any of the specified regular expressions.
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
114 </para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
115
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
116 <para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117 The special mask “<literal>msie6</literal>” (0.7.12) corresponds to
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
118 the regular expression “<literal>MSIE [4-6]\.</literal>”, but works faster.
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
119 Starting from version 0.8.11, “<literal>MSIE 6.0; ... SV1</literal>”
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120 is excluded from this mask.
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
121 </para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
122
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123 </directive>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
125
2142
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 1248
diff changeset
126 <directive name="gzip_http_version">
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 1248
diff changeset
127 <syntax><literal>1.0</literal> | <literal>1.1</literal></syntax>
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 1248
diff changeset
128 <default>1.1</default>
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 1248
diff changeset
129 <context>http</context>
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 1248
diff changeset
130 <context>server</context>
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 1248
diff changeset
131 <context>location</context>
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 1248
diff changeset
132
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 1248
diff changeset
133 <para>
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 1248
diff changeset
134 Sets the minimum HTTP version of a request required to compress a response.
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 1248
diff changeset
135 </para>
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 1248
diff changeset
136
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 1248
diff changeset
137 </directive>
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 1248
diff changeset
138
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 1248
diff changeset
139
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
140 <directive name="gzip_min_length">
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
141 <syntax><value>length</value></syntax>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
142 <default>20</default>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
143 <context>http</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
144 <context>server</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
145 <context>location</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
146
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
147 <para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
148 Sets the minimum length of a response that will be gzipped.
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
149 The length is determined only from the <header>Content-Length</header>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
150 response header field.
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
151 </para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
152
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
153 </directive>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
154
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
155
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
156 <directive name="gzip_proxied">
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
157 <syntax>
364
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
158 <literal>off</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
159 <literal>expired</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
160 <literal>no-cache</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
161 <literal>no-store</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
162 <literal>private</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
163 <literal>no_last_modified</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
164 <literal>no_etag</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
165 <literal>auth</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
166 <literal>any</literal>
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
167 ...</syntax>
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
168 <default>off</default>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
169 <context>http</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
170 <context>server</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
171 <context>location</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
172
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
173 <para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
174 Enables or disables gzipping of responses for proxied
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
175 requests depending on the request and response.
1248
6d51bb4f19f7 Gzip: fixed minor flaws in the "gzip_proxied" directive.
Gunnlaugur Thor Briem <gunnlaugur@gmail.com>
parents: 966
diff changeset
176 The fact that the request is proxied is determined by
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
177 the presence of the <header>Via</header> request header field.
1248
6d51bb4f19f7 Gzip: fixed minor flaws in the "gzip_proxied" directive.
Gunnlaugur Thor Briem <gunnlaugur@gmail.com>
parents: 966
diff changeset
178 The directive accepts multiple parameters:
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
179 <list type="tag">
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
180
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
181 <tag-name><literal>off</literal></tag-name>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
182 <tag-desc>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
183 disables compression for all proxied requests,
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
184 ignoring other parameters;
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
185 </tag-desc>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
186
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
187 <tag-name><literal>expired</literal></tag-name>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
188 <tag-desc>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
189 enables compression if a response header includes the
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
190 <header>Expires</header> field with a value that disables caching;
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
191 </tag-desc>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
192
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
193 <tag-name><literal>no-cache</literal></tag-name>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
194 <tag-desc>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
195 enables compression if a response header includes the
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
196 <header>Cache-Control</header> field with the
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
197 “<literal>no-cache</literal>” parameter;
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
198 </tag-desc>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
199
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
200 <tag-name><literal>no-store</literal></tag-name>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
201 <tag-desc>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
202 enables compression if a response header includes the
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
203 <header>Cache-Control</header> field with the
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
204 “<literal>no-store</literal>” parameter;
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
205 </tag-desc>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
206
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
207 <tag-name><literal>private</literal></tag-name>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
208 <tag-desc>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
209 enables compression if a response header includes the
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
210 <header>Cache-Control</header> field with the
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
211 “<literal>private</literal>” parameter;
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
212 </tag-desc>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
213
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
214 <tag-name><literal>no_last_modified</literal></tag-name>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
215 <tag-desc>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
216 enables compression if a response header does not include the
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
217 <header>Last-Modified</header> field;
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
218 </tag-desc>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
219
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
220 <tag-name><literal>no_etag</literal></tag-name>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
221 <tag-desc>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
222 enables compression if a response header does not include the
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
223 <header>ETag</header> field;
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
224 </tag-desc>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
225
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
226 <tag-name><literal>auth</literal></tag-name>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
227 <tag-desc>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
228 enables compression if a request header includes the
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
229 <header>Authorization</header> field;
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
230 </tag-desc>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
231
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
232 <tag-name><literal>any</literal></tag-name>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
233 <tag-desc>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
234 enables compression for all proxied requests.
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
235 </tag-desc>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
236
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
237 </list>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
238 </para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
239
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
240 </directive>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
241
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
242
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
243 <directive name="gzip_types">
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
244 <syntax><value>mime-type</value> ...</syntax>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
245 <default>text/html</default>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
246 <context>http</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
247 <context>server</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
248 <context>location</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
249
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
250 <para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
251 Enables gzipping of responses for the specified MIME types in addition
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
252 to “<literal>text/html</literal>”.
546
694db9597ee0 Documented the special value "*" in various "*_type" directives.
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
253 The special value “<literal>*</literal>” matches any MIME type (0.8.29).
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
254 Responses with the “<literal>text/html</literal>” type are always compressed.
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
255 </para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
256
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
257 </directive>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
258
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
259
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
260 <directive name="gzip_vary">
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
261 <syntax><literal>on</literal> | <literal>off</literal></syntax>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
262 <default>off</default>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
263 <context>http</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
264 <context>server</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
265 <context>location</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
266
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
267 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
268 Enables or disables inserting the <header>Vary: Accept-Encoding</header>
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
269 response header field if the directives
744
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 589
diff changeset
270 <link id="gzip"/>,
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 589
diff changeset
271 <link doc="ngx_http_gzip_static_module.xml" id="gzip_static"/>, or
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 589
diff changeset
272 <link doc="ngx_http_gunzip_module.xml" id="gunzip"/>
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
273 are active.
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
274 </para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
275
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
276 </directive>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
277
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
278 </section>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
279
825
ae15915990ad Documented the "gzip_ratio" variable.
Homutov Vladimir <vl@nginx.com>
parents: 744
diff changeset
280
ae15915990ad Documented the "gzip_ratio" variable.
Homutov Vladimir <vl@nginx.com>
parents: 744
diff changeset
281 <section id="variables" name="Embedded Variables">
ae15915990ad Documented the "gzip_ratio" variable.
Homutov Vladimir <vl@nginx.com>
parents: 744
diff changeset
282
ae15915990ad Documented the "gzip_ratio" variable.
Homutov Vladimir <vl@nginx.com>
parents: 744
diff changeset
283 <para>
ae15915990ad Documented the "gzip_ratio" variable.
Homutov Vladimir <vl@nginx.com>
parents: 744
diff changeset
284 <list type="tag">
ae15915990ad Documented the "gzip_ratio" variable.
Homutov Vladimir <vl@nginx.com>
parents: 744
diff changeset
285
ae15915990ad Documented the "gzip_ratio" variable.
Homutov Vladimir <vl@nginx.com>
parents: 744
diff changeset
286 <tag-name id="var_gzip_ratio"><var>$gzip_ratio</var></tag-name>
ae15915990ad Documented the "gzip_ratio" variable.
Homutov Vladimir <vl@nginx.com>
parents: 744
diff changeset
287 <tag-desc>achieved compression ratio, computed as the ratio between the
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 825
diff changeset
288 original and compressed response sizes.</tag-desc>
825
ae15915990ad Documented the "gzip_ratio" variable.
Homutov Vladimir <vl@nginx.com>
parents: 744
diff changeset
289
ae15915990ad Documented the "gzip_ratio" variable.
Homutov Vladimir <vl@nginx.com>
parents: 744
diff changeset
290 </list>
ae15915990ad Documented the "gzip_ratio" variable.
Homutov Vladimir <vl@nginx.com>
parents: 744
diff changeset
291 </para>
ae15915990ad Documented the "gzip_ratio" variable.
Homutov Vladimir <vl@nginx.com>
parents: 744
diff changeset
292
ae15915990ad Documented the "gzip_ratio" variable.
Homutov Vladimir <vl@nginx.com>
parents: 744
diff changeset
293 </section>
ae15915990ad Documented the "gzip_ratio" variable.
Homutov Vladimir <vl@nginx.com>
parents: 744
diff changeset
294
330
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
295 </module>