Mercurial > hg > ngx_http_gunzip_filter_module

annotate README @ 5:d8e85fd12fab

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Gunzip: require gzip and zlib in config. Require nginx core gzip bits and zlib library instead of assuming they are brought by gzip module. This fixes compilation without gzip module.
author Maxim Dounin <mdounin@mdounin.ru>
date Mon, 28 Dec 2009 02:01:08 +0300
parents 0dd7d109e56b
children 93115aab4c92
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
1 Gunzip module for nginx.
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
2
1
0dd7d109e56b Gunzip: add more tests and improve docs.
Maxim Dounin <mdounin@mdounin.ru>
parents: 0
diff changeset
3 This module allows gunzipping responses returned with Content-Encoding: gzip
0
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
4 for clients that doesn't support it. It may be usefull if you prefer to store
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
5 data compressed (to save space or disk/network IO) but do not want to penalize
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
6 clients without gzip support.
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
7
1
0dd7d109e56b Gunzip: add more tests and improve docs.
Maxim Dounin <mdounin@mdounin.ru>
parents: 0
diff changeset
8 Note well: only responses with Content-Encoding set to gzip before this module
0dd7d109e56b Gunzip: add more tests and improve docs.
Maxim Dounin <mdounin@mdounin.ru>
parents: 0
diff changeset
9 are handled (e.g. using "add_header Content-Encoding gzip;" isn't enough as it
0dd7d109e56b Gunzip: add more tests and improve docs.
Maxim Dounin <mdounin@mdounin.ru>
parents: 0
diff changeset
10 happens after). As of now only proxy and fastcgi are able to do so.
0dd7d109e56b Gunzip: add more tests and improve docs.
Maxim Dounin <mdounin@mdounin.ru>
parents: 0
diff changeset
11
0dd7d109e56b Gunzip: add more tests and improve docs.
Maxim Dounin <mdounin@mdounin.ru>
parents: 0
diff changeset
12 This module was designed to work with nginx 0.8.* (though it should work with
0dd7d109e56b Gunzip: add more tests and improve docs.
Maxim Dounin <mdounin@mdounin.ru>
parents: 0
diff changeset
13 0.7.* too).
0dd7d109e56b Gunzip: add more tests and improve docs.
Maxim Dounin <mdounin@mdounin.ru>
parents: 0
diff changeset
14
0
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
15 Configuration directives:
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
16
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
17 gunzip (on|off)
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
18
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
19 Context: http, server, location
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
20 Default: off
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
21
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
22 Switches gunzip.
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
23
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
24 gunzip_buffers <number> <size>
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
25
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
26 Context: http, server, location
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
27 Default: 32 4k/16 8k
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
28
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
29 Specifies number and size of buffers available for decompression.
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
30
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
31 Usage:
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
32
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
33 location /storage/ {
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
34 gunzip on;
1
0dd7d109e56b Gunzip: add more tests and improve docs.
Maxim Dounin <mdounin@mdounin.ru>
parents: 0
diff changeset
35 ...
0
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
36 }
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
37
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
38 To compile nginx with gunzip module, use "--add-module <path>" option to nginx
a75d4ad9c5d2 Gunzip filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
39 configure.