Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_image_filter_module.xml @ 556:345012910707
Documented the "events" and "use" directives.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Wed, 27 Jun 2012 11:39:27 +0000 |
parents | bb51d3e17dd0 |
children | be54c443235a |
rev | line source |
---|---|
222
bfe3eff81d04
Removed redundant encoding specification.
Ruslan Ermilov <ru@nginx.com>
parents:
205
diff
changeset
|
1 <?xml version="1.0"?> |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
4 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
5 <module name="Module ngx_http_image_filter_module" |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
6 link="/en/docs/http/ngx_http_image_filter_module.html" |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
7 lang="en"> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
8 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
9 <section id="summary"> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
10 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
11 <para> |
347
daae2b619815
Specify the module history information in a unified place.
Ruslan Ermilov <ru@nginx.com>
parents:
294
diff
changeset
|
12 The <literal>ngx_http_image_filter_module</literal> module (0.7.54+) is a filter |
daae2b619815
Specify the module history information in a unified place.
Ruslan Ermilov <ru@nginx.com>
parents:
294
diff
changeset
|
13 that transforms images in JPEG, GIF, and PNG formats. |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
14 </para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
15 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
16 <para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
17 This module is not built by default, it should be enabled with the |
271 | 18 <literal>--with-http_image_filter_module</literal> |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
19 configuration parameter. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
20 <note> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
21 This module utilizes the |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
22 <link url="http://libgd.org">libgd</link> library. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
23 It is recommended to use the latest available version of the library; |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
24 it is version 2.0.35 as of this writing. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
25 </note> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
26 </para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
27 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
28 </section> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
29 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
30 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
31 <section id="example" name="Example Configuration"> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
32 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
33 <para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
34 <example> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
35 location /img/ { |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
36 proxy_pass http://backend; |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
37 image_filter resize 150 100; |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
38 image_filter rotate 90; |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
39 error_page 415 = /empty; |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
40 } |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
41 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
42 location = /empty { |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
43 empty_gif; |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
44 } |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
45 </example> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
46 </para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
47 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
48 </section> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
49 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
50 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
51 <section id="directives" name="Directives"> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
52 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
53 <directive name="image_filter"> |
364 | 54 <syntax><literal>off</literal></syntax> |
55 <syntax><literal>test</literal></syntax> | |
56 <syntax><literal>size</literal></syntax> | |
57 <syntax> | |
58 <literal>rotate</literal> | |
59 <literal>90</literal> | <literal>180</literal> | | |
60 <literal>270</literal></syntax> | |
61 <syntax> | |
62 <literal>resize</literal> | |
63 <value>width</value> | |
64 <value>height</value></syntax> | |
65 <syntax> | |
66 <literal>crop</literal> | |
67 <value>width</value> | |
68 <value>height</value></syntax> | |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
69 <default/> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
70 <context>location</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
71 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
72 <para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
73 Sets the type of transformation to perform on images: |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
74 <list type="tag"> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
75 |
271 | 76 <tag-name><literal>off</literal></tag-name> |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
77 <tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
78 turns off module processing in a surrounding location. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
79 </tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
80 |
271 | 81 <tag-name><literal>test</literal></tag-name> |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
82 <tag-desc> |
294 | 83 ensures that responses are images in either JPEG, GIF, or PNG format. |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
84 Otherwise, the error |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
85 <http-status code="415" text="Unsupported Media Type"/> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
86 is returned. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
87 </tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
88 |
271 | 89 <tag-name><literal>size</literal></tag-name> |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
90 <tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
91 outputs information about images in a JSON format, e.g.: |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
92 <example> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
93 { "img" : { "width": 100, "height": 100, "type": "gif" } } |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
94 </example> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
95 In case of an error, the following is output: |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
96 <example> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
97 {} |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
98 </example> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
99 </tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
100 |
271 | 101 <tag-name><literal>rotate</literal> |
102 <literal>90</literal>|<literal>180</literal>|<literal>270</literal> | |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
103 </tag-name> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
104 <tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
105 rotates images counter-clockwise by the specified number of degrees. |
271 | 106 Value of the parameter can contain variables. |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
107 Can be used either alone, or along with the |
271 | 108 <literal>resize</literal> and <literal>crop</literal> transformations. |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
109 </tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
110 |
271 | 111 <tag-name><literal>resize</literal> |
112 <value>width</value> | |
113 <value>height</value> | |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
114 </tag-name> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
115 <tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
116 proportionally reduces an image to the specified sizes. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
117 To reduce by only one dimension, another dimension can be specified as |
271 | 118 “<literal>-</literal>”. |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
119 In case of an error, the server will return code |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
120 <http-status code="415" text="Unsupported Media Type"/>. |
271 | 121 Values of parameters can contain variables. |
122 When used along with the <literal>rotate</literal> parameter, | |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
123 the rotation happens <emphasis>after</emphasis> reduction. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
124 </tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
125 |
271 | 126 <tag-name><literal>crop</literal> |
127 <value>width</value> | |
128 <value>height</value> | |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
129 </tag-name> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
130 <tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
131 proportionally reduces an image to the size of the largest side |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
132 and crops extraneous edges by another side. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
133 To reduce by only one dimension, another dimension can be specified as |
271 | 134 “<literal>-</literal>”. |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
135 In case of an error, the server will return code |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
136 <http-status code="415" text="Unsupported Media Type"/>. |
271 | 137 Values of parameters can contain variables. |
138 When used along with the <literal>rotate</literal> parameter, | |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
139 the rotation happens <emphasis>before</emphasis> reduction. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
140 </tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
141 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
142 </list> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
143 </para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
144 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
145 </directive> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
146 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
147 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
148 <directive name="image_filter_buffer"> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
149 <syntax><value>size</value></syntax> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
150 <default>1M</default> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
151 <context>http</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
152 <context>server</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
153 <context>location</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
154 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
155 <para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
156 Sets the maximum size of the buffer used for reading images. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
157 When a size is exceeded the server will return error |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
158 <http-status code="415" text="Unsupported Media Type"/>. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
159 </para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
160 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
161 </directive> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
162 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
163 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
164 <directive name="image_filter_jpeg_quality"> |
271 | 165 <syntax><value>quality</value></syntax> |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
166 <default>75</default> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
167 <context>http</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
168 <context>server</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
169 <context>location</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
170 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
171 <para> |
271 | 172 Sets the desired <value>quality</value> of the transformed JPEG images. |
173 Acceptable values are in the 1..100 range. | |
205 | 174 Lesser values usually imply both lower image quality and less data to transfer. |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
175 The maximum recommended value is 95. |
271 | 176 Value of the parameter can contain variables. |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
177 </para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
178 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
179 </directive> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
180 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
181 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
182 <directive name="image_filter_sharpen"> |
271 | 183 <syntax><value>percent</value></syntax> |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
184 <default>0</default> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
185 <context>http</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
186 <context>server</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
187 <context>location</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
188 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
189 <para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
190 Increases sharpness of the final image. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
191 The sharpness percentage can exceed 100. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
192 The value of 0 disables sharpening. |
271 | 193 Value of the parameter can contain variables. |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
194 </para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
195 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
196 </directive> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
197 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
198 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
199 <directive name="image_filter_transparency"> |
271 | 200 <syntax><literal>on</literal>|<literal>off</literal></syntax> |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
201 <default>on</default> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
202 <context>http</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
203 <context>server</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
204 <context>location</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
205 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
206 <para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
207 Defines whether transparency should be preserved when transforming |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
208 PNG images with colors specified by a palette, or in GIF images. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
209 The loss of transparency allows to obtain images of a better quality. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
210 The alpha channel transparency in PNG is always preserved. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
211 </para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
212 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
213 </directive> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
214 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
215 </section> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
216 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
217 </module> |