Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_gunzip_module.xml @ 3014:c0a4a4a55e45

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented Periodic Session object in njs Reference.
author Yaroslav Zhuravlev <yar@nginx.com>
date Fri, 29 Sep 2023 20:06:59 +0100
parents 95c3c3bbf1ce
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
676
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
2
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
3 <!--
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
4 Copyright (C) Maxim Dounin
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
5 Copyright (C) Nginx, Inc.
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
6 -->
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
7
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
9
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
10 <module name="Module ngx_http_gunzip_module"
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
11 link="/en/docs/http/ngx_http_gunzip_module.html"
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
12 lang="en"
744
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 676
diff changeset
13 rev="2">
676
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
14
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
15 <section id="summary">
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
16
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
17 <para>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
18 The <literal>ngx_http_gunzip_module</literal> module is a filter that
744
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 676
diff changeset
19 decompresses responses with “<literal>Content-Encoding: gzip</literal>”
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 676
diff changeset
20 for clients that do not support “gzip” encoding method.
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 676
diff changeset
21 The module will be useful when it is desirable to store
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 744
diff changeset
22 data compressed to save space and reduce I/O costs.
676
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
23 </para>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
24
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
25 <para>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
26 This module is not built by default, it should be enabled with the
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
27 <literal>--with-http_gunzip_module</literal>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
28 configuration parameter.
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
29 </para>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
30
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
31 </section>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
32
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
33
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
34 <section id="example" name="Example Configuration">
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
35
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
36 <para>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
37 <example>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
38 location /storage/ {
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
39 gunzip on;
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
40 ...
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
41 }
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
42 </example>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
43 </para>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
44
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
45 </section>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
46
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
47
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
48 <section id="directives" name="Directives">
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
49
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
50 <directive name="gunzip">
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
51 <syntax><literal>on</literal> | <literal>off</literal></syntax>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
52 <default>off</default>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
53 <context>http</context>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
54 <context>server</context>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
55 <context>location</context>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
56
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
57 <para>
744
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 676
diff changeset
58 Enables or disables decompression of gzipped responses
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 676
diff changeset
59 for clients that lack gzip support.
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 676
diff changeset
60 If enabled, the following directives are also taken into account
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 676
diff changeset
61 when determining if clients support gzip:
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 676
diff changeset
62 <link doc="ngx_http_gzip_module.xml" id="gzip_http_version"/>,
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 676
diff changeset
63 <link doc="ngx_http_gzip_module.xml" id="gzip_proxied"/>, and
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 676
diff changeset
64 <link doc="ngx_http_gzip_module.xml" id="gzip_disable"/>.
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 676
diff changeset
65 See also the <link doc="ngx_http_gzip_module.xml" id="gzip_vary"/> directive.
676
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
66 </para>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
67
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
68 </directive>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
69
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
70
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
71 <directive name="gunzip_buffers">
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
72 <syntax><value>number</value> <value>size</value></syntax>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
73 <default>32 4k|16 8k</default>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
74 <context>http</context>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
75 <context>server</context>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
76 <context>location</context>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
77
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
78 <para>
744
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 676
diff changeset
79 Sets the <value>number</value> and <value>size</value> of buffers
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 676
diff changeset
80 used to decompress a response.
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 676
diff changeset
81 By default, the buffer size is equal to one memory page.
ac709e45740d Revision of ngx_http_gunzip_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 676
diff changeset
82 This is either 4K or 8K, depending on a platform.
676
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
83 </para>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
84
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
85 </directive>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
86
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
87 </section>
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
88
6d6aa03e43fa Actually added gunzip module documentation files.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
89 </module>