HttpAdditionModule - Revision history

Admin: /* Directives */

2012-05-02T19:42:26Z

‎Directives

Admin: /* Directives */

2012-04-30T17:58:11Z

‎Directives

VBart: /* References */ Update link to the original documentation

2012-04-21T15:47:50Z

‎References: Update link to the original documentation

Jlund: Fixing a spelling mistake

2010-12-15T20:40:56Z

Fixing a spelling mistake

New page

= Synopsis =
This module adds contents of other locations before and after the current location's content.

It is implemented as an output filter, the contents of the main request and subrequests to other locations are not buffered completely and are still sent to the client in a streaming fashion. Because the length of the final response body is unknown while sending the HTTP headers, the HTTP chunked encoding is always used here.

== Installation ==

By default the module is not built, it is necessary to enable its build with
<pre>
./configure --with-http_addition_module
</pre>
at compilation time.

Example:
<geshi lang="nginx">
location / {
add_before_body /before_action;
add_after_body /after_action;
}
</geshi>

== Limitations ==

Note that as of 0.8.17 no contents will be added if the current location is served as a subrequest itself. Consider the following example:

<geshi lang="nginx">
location /foo {
add_before_body /bar;
}

location /bar {
add_before_body /baz;
}
</geshi>

Then accessing ''/foo'' won't get ''/baz'' inserted before the contents of the subrequest ''/bar''.

Also note that at this time, only strings can be used in before/after body locations, not variables. So
<geshi lang="nginx">
location / {
set $before_action /before_action;
add_before_body $before_action;
}
</geshi>

will not work as expected (although the configuration file will still load properly).

= Directives =
== add_before_body ==
'''syntax:''' ''add_before_body uri''

'''default:''' ''no''

'''context:''' ''http, server, location''

Directive adds content of uri before the response body, issued as a result of the work of the assigned subrequest.

== add_after_body ==
'''syntax:''' ''add_after_body uri''

'''default:''' ''no''

'''context:''' ''http, server, location''

Directive adds content of uri after the response body, issued as a result of the work of the assigned subrequest.

== addition_types ==
'''syntax:''' ''addition_types mime-type [mime-type ...]''

'''default:''' ''text/html''

'''context:''' ''http, server, location''

Directive (since 0.7.9) allows you to add text only to locations of the specified MIME-types (defaults to ''"text/html"'').

(Before 0.8.17, this directive was mispelled as "addtion_types" in the source. This bug has been fixed in 0.8.17.)

= References =
[http://sysoev.ru/nginx/docs/http/ngx_http_addition_module.html Original Documentation]

← Older revision		Revision as of 15:47, 21 April 2012
Line 79:		Line 79:

	= References =		= References =
−	[http://~~sysoev~~.ru/~~nginx~~/docs/http/ngx_http_addition_module.html Original Documentation]	+	[http://nginx.org/en/docs/http/ngx_http_addition_module.html Original Documentation]

@@ Line 50: / Line 50: @@
 = Directives =
 == add_before_body ==
-<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_addition_module/add_before_body.txt" />
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_addition_module/add_before_body.txt" />
 Directive adds content of uri before the response body, issued as a result of the work of the assigned subrequest.
 == add_after_body ==
-<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_addition_module/add_after_body.txt" />
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_addition_module/add_after_body.txt" />
 Directive adds content of uri after the response body, issued as a result of the work of the assigned subrequest.
 == addition_types ==
-<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_addition_module/addition_types.txt" />
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_addition_module/addition_types.txt" />
 Directive (since 0.7.9) allows you to add text only to locations of the specified MIME-types (defaults to ''"text/html"'').