Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_gzip_static_module.xml @ 617:368a449e85b8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Expanded documentation of what various parameters of the "listen" directive related to socket options do. While here, documented the fact that accept filters also work on NetBSD.
author Ruslan Ermilov <ru@nginx.com>
date Thu, 02 Aug 2012 13:24:07 +0000
parents 764fbac1b8b4
children 08140f6b7964
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: 351
diff changeset
3 <!--
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
4 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
5 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
6 -->
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 351
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_static_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_static_module.html"
589
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
12 lang="en"
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
13 rev="1">
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_static_module</literal> module allows
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
19 to send precompressed files with the “<literal>.gz</literal>”
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20 filename extension instead of regular files.
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
21 </para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
23 <para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24 This module is not built by default, it should be enabled with the
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25 <literal>--with-http_gzip_static_module</literal>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26 configuration parameter.
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27 </para>
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 </section>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30
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 <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
33
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34 <para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35 <example>
351
a4fa80755eab Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents: 330
diff changeset
36 gzip_static on;
a4fa80755eab Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents: 330
diff changeset
37 gzip_proxied expired no-cache no-store private auth;
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 </section>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44 <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
45
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46 <directive name="gzip_static">
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47 <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
48 <default>off</default>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49 <context>http</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50 <context>server</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
51 <context>location</context>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
52
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53 <para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
54 Enables or disables checking the existence of precompressed files.
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55 The following directives are also taken into account:
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56 <link doc="ngx_http_gzip_module.xml" id="gzip_http_version"/>,
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57 <link doc="ngx_http_gzip_module.xml" id="gzip_proxied"/>,
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58 <link doc="ngx_http_gzip_module.xml" id="gzip_disable"/>,
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
59 and <link doc="ngx_http_gzip_module.xml" id="gzip_vary"/>.
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60 </para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62 <para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
63 The files can be compressed using the <command>gzip</command> command,
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64 or any other compatible.
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
65 It is recommended that the modification date and time of original and
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
66 compressed files be the same.
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
67 </para>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
68
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
69 </directive>
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70
f94bcab2a6ae Translated ngx_http_gzip_module and ngx_http_gzip_static_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
71 </section>
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 </module>