Skip to content

Image filter: documented the image_filter_max_pixels directive #296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
VadimZhestikov wants to merge 1 commit into from
+47 −3
Closed

Image filter: documented the image_filter_max_pixels directive #296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion xml/en/docs/http/ngx_http_image_filter_module.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<module name="Module ngx_http_image_filter_module"
link="/en/docs/http/ngx_http_image_filter_module.html"
lang="en"
rev="4">
rev="5">

<section id="summary">

Expand Down Expand Up @@ -205,6 +205,28 @@ Parameter value can contain variables.
</directive>


<directive name="image_filter_max_pixels">
<syntax><value>pixels</value></syntax>
<default>20000000</default>
<context>http</context>
<context>server</context>
<context>location</context>
<appeared-in>1.31.4</appeared-in>

<para>
Limits the maximum size of an image being processed, in pixels
(width multiplied by height).
The limit applies both to the source image
and to the transformation result.
When the limit is exceeded, the image is not processed
and the server returns error
<http-status code="415" text="Unsupported Media Type"/>.
The zero value disables the limit.
</para>

</directive>


<directive name="image_filter_sharpen">
<syntax><value>percent</value></syntax>
<default>0</default>
Expand Down
26 changes: 24 additions & 2 deletions xml/ru/docs/http/ngx_http_image_filter_module.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<module name="Модуль ngx_http_image_filter_module"
link="/ru/docs/http/ngx_http_image_filter_module.html"
lang="ru"
rev="4">
rev="5">

<section id="summary">

Expand Down Expand Up @@ -209,6 +209,28 @@ location = /empty {
</directive>


<directive name="image_filter_max_pixels">
<syntax><value>пикселы</value></syntax>
<default>20000000</default>
<context>http</context>
<context>server</context>
<context>location</context>
<appeared-in>1.31.4</appeared-in>

<para>
Ограничивает максимальный размер обрабатываемого изображения в пикселах
(ширину, умноженную на высоту).
Ограничение распространяется как на исходное изображение,
так и на результат преобразования.
При превышении ограничения изображение не обрабатывается
и сервер вернёт ошибку
<http-status code="415" text="Unsupported Media Type"/>.
Значение <literal>0</literal> отключает ограничение.
</para>

</directive>


<directive name="image_filter_sharpen">
<syntax><value>процент</value></syntax>
<default>0</default>
Expand All @@ -219,7 +241,7 @@ location = /empty {
<para>
Повышает резкость итогового изображения.
Процент резкости может быть больше 100.
Значение 0 отключает повышение резкости.
Значение <literal>0</literal> отключает повышение резкости.
В значении параметра допустимо использование переменных.
</para>

Expand Down