HttpCharsetModule - Revision history

Admin: /* Directives */

2012-05-02T19:28:40Z

‎Directives

Admin: /* Directives */

2012-04-30T06:53:50Z

‎Directives

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

2012-04-21T15:20:07Z

‎References: update link to the original documentation

MichaelLustfield: moved NginxHttpCharsetModule to HttpCharsetModule: Removing Nginx prefix from page titles

2010-09-22T19:25:29Z

moved NginxHttpCharsetModule to HttpCharsetModule: Removing Nginx prefix from page titles

New page

= Synopsis =

This module adds the text encoding to the "Content-Type indicated" response-header.

Furthermore, module can reencode data of one encoding into another.
It is necessary to note that the reencoding is accomplished only in one direction - from the server to the client, and only one-byte encodings can be reencoded.

Example configuration:
<geshi lang="nginx">
charset windows-1251;
source_charset koi8-r;
</geshi>

= Directives =

== charset ==
'''syntax:''' ''charset encoding|off''

'''default:''' ''charset off''

'''context:''' ''http, server, location, if in location''

The directive charset adds the line "Content-Type" into response-header with indicated encoding.
If this encoding is differed from that indicated in directive source_charset, then reencoding is carried out.
The parameter "off" deactivate the insertation of the line "Content-Type" in the response-header.

== charset_map ==
'''syntax:''' ''charset_map encoding1 encoding2 {...}''

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

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

The directive charset_map describes the table of reencoding from one encoding into another.
A table for the inverse reencoding is created using the same data.
The codes of symbols are assigned in hexadecimal form. If no recorded symbols are
in the range 80-FF they will be substituted with '?'.

Example usage:
<geshi lang="nginx">
charset_map koi8-r windows-1251 {
C0 FE ; # small yu
C1 E0 ; # small a
C2 E1 ; # small b
C3 F6 ; # small ts
# ...
}
</geshi>

The complete table of conversion from koi8-r into Windows-1251 is distributed with nginx and is located in file conf/koi-win.

== override_charset ==
'''syntax:''' ''override_charset on|off''

'''default:''' ''override_charset off''

'''context:''' ''http, server, location, if in location''

This directive determines, to carry out reencoding for the response, obtained from the proxied
server or from FastCGI-server, if in the response-header a "Content-Type" header already is.
If reencoding is permitted, then as the initial encoding the encoding, indicated in the obtained answer, is used.

It is necessary to note that if the response was obtained in the subquery then, independent of directive override_charset,
is always carried out reencoding from encoding of the response into encoding of basic demand.

== source_charset ==
'''syntax:''' ''source_charset encoding''

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

'''context:''' ''http, server, location, if in location''

The directive source_charset assigns the initial encoding of response. If this encoding is differed from that
indicated in directive charset, then reencoding is carried out.

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

@@ Line 17: / Line 17: @@
 == charset ==
-<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_charset_module/charset.txt" />
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_charset_module/charset.txt" />
 The directive charset adds the line "Content-Type" into response-header with indicated encoding.
@@ Line 25: / Line 25: @@
 == charset_map ==
-<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_charset_module/charset_map.txt" />
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_charset_module/charset_map.txt" />
 The directive charset_map describes the table of reencoding from one encoding into another.
@@ Line 46: / Line 46: @@
 == charset_types ==
-<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_charset_module/charset_types.txt" />
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_charset_module/charset_types.txt" />
 == override_charset ==
-<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_charset_module/override_charset.txt" />
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_charset_module/override_charset.txt" />
 This directive determines, to carry out reencoding for the response, obtained from the proxied
@@ Line 59: / Line 59: @@
 == source_charset ==
-<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_charset_module/source_charset.txt" />
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_charset_module/source_charset.txt" />
 The directive source_charset assigns the initial encoding of response. If this encoding is differed from that

← Older revision		Revision as of 15:20, 21 April 2012
Line 80:		Line 80:

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

@@ Line 17: / Line 17: @@
 == charset ==
-'''syntax:''' ''charset encoding|off''
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_charset_module/charset.txt" />
-−
-'''default:''' ''charset off''
-−
-'''context:''' ''http, server, location, if in location''
 The directive charset adds the line "Content-Type" into response-header with indicated encoding.
@@ Line 29: / Line 25: @@
 == charset_map ==
-'''syntax:''' ''charset_map  encoding1 encoding2 {...}''
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_charset_module/charset_map.txt" />
-−
-'''default:''' ''no''
-−
-'''context:''' ''http, server, location''
 The directive charset_map describes the table of reencoding from one encoding into another.
@@ Line 53: / Line 45: @@
 The complete table of conversion from koi8-r into Windows-1251 is distributed with nginx and is located in file conf/koi-win.
 == override_charset ==
-'''syntax:''' ''override_charset on|off''
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_charset_module/override_charset.txt" />
-−
-'''default:''' ''override_charset off''
-−
-'''context:''' ''http, server, location, if in location''
 This directive determines, to carry out reencoding for the response, obtained from the proxied
@@ Line 67: / Line 57: @@
 It is necessary to note that if the response was obtained in the subquery then, independent of directive override_charset,
 is always carried out reencoding from encoding of the response into encoding of basic demand.
 == source_charset ==
-'''syntax:''' ''source_charset encoding''
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_charset_module/source_charset.txt" />
-−
-'''default:''' ''no''
-−
-'''context:''' ''http, server, location, if in location''
 The directive source_charset assigns the initial encoding of response. If this encoding is differed from that