view xml/ru/docs/http/ngx_http_addition_module.xml @ 2846:fdf1464e1977

Moved banner to the external file to make partial rollout possible. An idea is to have several banners and show them with different probability specified by split directive in the nginx.conf
author Sergey Budnevitch <sb@waeme.net>
date Tue, 10 May 2022 18:07:27 +0400
parents 813b8349cdbe
children
line wrap: on
line source

<?xml version="1.0"?>

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

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

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

<section id="summary">

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

</section>


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

<para>
<example>
location / {
    add_before_body /before_action;
    add_after_body  /after_action;
}
</example>
</para>

</section>


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

<directive name="add_before_body">
<syntax><value>uri</value></syntax>
<default/>
<context>http</context>
<context>server</context>
<context>location</context>

<para>
Добавляет перед телом ответа текст, выдаваемый в результате
работы заданного подзапроса.
Пустая строка (<literal>""</literal>) в качестве параметра отменяет добавление,
унаследованное с предыдущего уровня конфигурации.
</para>

</directive>


<directive name="add_after_body">
<syntax><value>uri</value></syntax>
<default/>
<context>http</context>
<context>server</context>
<context>location</context>

<para>
Добавляет после тела ответа текст, выдаваемый в результате
работы заданного подзапроса.
Пустая строка (<literal>""</literal>) в качестве параметра отменяет добавление,
унаследованное с предыдущего уровня конфигурации.
</para>

</directive>


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

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

</directive>

</section>

</module>