ngx_http_addition_module.xml

<?xml version="1.0"?>

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

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

<module name="Module ngx_http_addition_module"
        link="/en/docs/http/ngx_http_addition_module.html"
        lang="en"
        rev="4">

<section id="summary">

<para>
The <literal>ngx_http_addition_module</literal> module is a filter
that adds text before and after a response.
This module is not built by default, it should be enabled with the
<literal>--with-http_addition_module</literal>
configuration parameter.
</para>

</section>


<section id="example" name="Example Configuration">

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

</section>


<section id="directives" name="Directives">

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

<para>
Adds the text returned as a result of processing a given subrequest
before the response body.
An empty string (<literal>""</literal>) as a parameter cancels addition
inherited from the previous configuration level.
</para>

</directive>


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

<para>
Adds the text returned as a result of processing a given subrequest
after the response body.
An empty string (<literal>""</literal>) as a parameter cancels addition
inherited from the previous configuration level.
</para>

</directive>


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

<para>
Allows adding text in responses with the specified MIME types,
in addition to “<literal>text/html</literal>”.
The special value “<literal>*</literal>” matches any MIME type (0.8.29).
</para>

</directive>

</section>

</module>