Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_image_filter_module.xml @ 1830:6ebdef43330a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added support for WebP to the image_filter module.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 25 Oct 2016 19:52:33 +0300
parents 95c3c3bbf1ce
children
comparison
equal deleted inserted replaced
1829:5b2bdd96b4e1 1830:6ebdef43330a
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_http_image_filter_module" 10 <module name="Module ngx_http_image_filter_module"
11 link="/en/docs/http/ngx_http_image_filter_module.html" 11 link="/en/docs/http/ngx_http_image_filter_module.html"
12 lang="en" 12 lang="en"
13 rev="3"> 13 rev="4">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_http_image_filter_module</literal> module (0.7.54+) is a filter 18 The <literal>ngx_http_image_filter_module</literal> module (0.7.54+) is a filter
19 that transforms images in JPEG, GIF, and PNG formats. 19 that transforms images in JPEG, GIF, PNG, and WebP formats.
20 </para> 20 </para>
21 21
22 <para> 22 <para>
23 This module is not built by default, it should be enabled with the 23 This module is not built by default, it should be enabled with the
24 <literal>--with-http_image_filter_module</literal> 24 <literal>--with-http_image_filter_module</literal>
25 configuration parameter. 25 configuration parameter.
26 <note> 26 <note>
27 This module utilizes the 27 This module utilizes the
28 <link url="http://libgd.org">libgd</link> library. 28 <link url="http://libgd.org">libgd</link> library.
29 It is recommended to use the latest available version of the library. 29 It is recommended to use the latest available version of the library.
30 </note>
31 <note>
32 The WebP format support appeared in version 1.11.6.
33 To transform images in this format,
34 the <literal>libgd</literal> library must be compiled with the WebP support.
30 </note> 35 </note>
31 </para> 36 </para>
32 37
33 </section> 38 </section>
34 39
83 turns off module processing in a surrounding location. 88 turns off module processing in a surrounding location.
84 </tag-desc> 89 </tag-desc>
85 90
86 <tag-name><literal>test</literal></tag-name> 91 <tag-name><literal>test</literal></tag-name>
87 <tag-desc> 92 <tag-desc>
88 ensures that responses are images in either JPEG, GIF, or PNG format. 93 ensures that responses are images in either JPEG, GIF, PNG, or WebP format.
89 Otherwise, the 94 Otherwise, the
90 <http-status code="415" text="Unsupported Media Type"/> 95 <http-status code="415" text="Unsupported Media Type"/>
91 error is returned. 96 error is returned.
92 </tag-desc> 97 </tag-desc>
93 98
231 The alpha channel transparency in PNG is always preserved. 236 The alpha channel transparency in PNG is always preserved.
232 </para> 237 </para>
233 238
234 </directive> 239 </directive>
235 240
241
242 <directive name="image_filter_webp_quality">
243 <syntax><value>quality</value></syntax>
244 <default>80</default>
245 <context>http</context>
246 <context>server</context>
247 <context>location</context>
248 <appeared-in>1.11.6</appeared-in>
249
250 <para>
251 Sets the desired <value>quality</value> of the transformed WebP images.
252 Acceptable values are in the range from 1 to 100.
253 Lesser values usually imply both lower image quality and less data to transfer.
254 Parameter value can contain variables.
255 </para>
256
257 </directive>
258
236 </section> 259 </section>
237 260
238 </module> 261 </module>