<?xml version="1.0"?>

<!--
  Copyright (C) Igor Sysoev
  Copyright (C) Nginx, Inc.
  -->

<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">

<module name="Модуль ngx_http_sub_module"
        link="/ru/docs/http/ngx_http_sub_module.html"
        lang="ru"
        rev="6">

<section id="summary">

<para>
Модуль <literal>ngx_http_sub_module</literal> — это фильтр,
изменяющий в ответе одну заданную строку на другую.
</para>

<para>
По умолчанию этот модуль не собирается, его сборку необходимо
разрешить с помощью конфигурационного параметра
<literal>--with-http_sub_module</literal>.
</para>

</section>


<section id="example" name="Пример конфигурации">

<para>
<example>
location / {
    sub_filter '&lt;a href="http://127.0.0.1:8080/'  '&lt;a href="https://$host/';
    sub_filter '&lt;img src="http://127.0.0.1:8080/' '&lt;img src="https://$host/';
    sub_filter_once on;
}
</example>
</para>

</section>


<section id="directives" name="Директивы">

<directive name="sub_filter">
<syntax><value>строка</value> <value>замена</value></syntax>
<default/>
<context>http</context>
<context>server</context>
<context>location</context>

<para>
Задаёт строку, которую нужно заменить, и строку замены.
Заменяемая строка проверяется без учёта регистра.
В заменяемой строке (1.9.4) и в строке замены можно использовать переменные.
На одном уровне конфигурации может
быть указано несколько директив <literal>sub_filter</literal> (1.9.4).
Директивы наследуются с предыдущего уровня конфигурации при условии, что
на данном уровне не описаны свои директивы <literal>sub_filter</literal>.
</para>

</directive>


<directive name="sub_filter_last_modified">
<syntax><literal>on</literal> | <literal>off</literal></syntax>
<default>off</default>
<context>http</context>
<context>server</context>
<context>location</context>
<appeared-in>1.5.1</appeared-in>

<para>
Позволяет сохранить поле заголовка <header>Last-Modified</header>
исходного ответа во время замены
для лучшего кэширования ответов.
</para>

<para>
По умолчанию поле заголовка удаляется, так как содержимое ответа
изменяется во время обработки.
</para>

</directive>


<directive name="sub_filter_once">
<syntax><literal>on</literal> | <literal>off</literal></syntax>
<default>on</default>
<context>http</context>
<context>server</context>
<context>location</context>

<para>
Определяет, сколько раз нужно искать каждую из заменяемых строк:
один раз или многократно.
</para>

</directive>


<directive name="sub_filter_types">
<syntax><value>mime-тип</value> ...</syntax>
<default>text/html</default>
<context>http</context>
<context>server</context>
<context>location</context>

<para>
Разрешает замену строк в ответах с указанными MIME-типами
в дополнение к “<literal>text/html</literal>”.
Специальное значение “<literal>*</literal>” соответствует любому MIME-типу
(0.8.29).
</para>

</directive>

</section>

</module>