sync'd docs from the nginx wiki page.

This commit is contained in:
agentzh (章亦春) 2011-08-16 14:22:40 +08:00
Родитель dca8a24b7f
Коммит f4f4b62967
3 изменённых файлов: 81 добавлений и 19 удалений

44
README
Просмотреть файл

@ -1,12 +1,11 @@
Name
ngx_lua - Embed the Power of Lua into Nginx
ngx_lua - Embed the power of Lua into Nginx
*This module is not distributed with the Nginx source.* See the
installation instructions.
Status
This module is under active development and is already production ready
:)
We're already using this module very heavily in our production web
applications here in Taobao.com, Alibaba Group.
This module is under active development and is already production ready.
Version
This document describes lua-nginx-module v0.2.1rc10
@ -900,6 +899,10 @@ Nginx API for Lua
Reading values from "ngx.header.HEADER" is not implemented yet, and
usually you shouldn't need it.
Setting "ngx.header.HEADER" after sending out response headers (either
explicitly with ngx.send_headers or implicitly with ngx.print and its
friends) will throw out a Lua exception.
ngx.req.get_uri_args
syntax: *args = ngx.req.get_uri_args()*
@ -1298,15 +1301,40 @@ Nginx API for Lua
* set_quote_pgsql_str
* set_escape_uri
* set_quote_json_str
* set_unescape_uri
* set_escape_uri
* set_encode_base32
* set_decode_base32
* set_encode_base64
* set_decode_base64
* set_encode_hex
* set_decode_hex
* set_sha1
* set_md5
For instance,
local res = ndk.set_var.set_escape_uri('a/b');
-- now res == 'a%2fb'
Similarly, the following directives provided by
[[NginxHttpEncryptedSessionModule]] can be invoked from within Lua too:
* set_encrypt_session
* set_decrypt_session
This feature requires the ngx_devel_kit
(<https://github.com/simpl/ngx_devel_kit>) module.
@ -1674,3 +1702,5 @@ See Also
* memc-nginx-module (<http://github.com/agentzh/memc-nginx-module>)
* The ngx_openresty bundle (<http://openresty.org>)

Просмотреть файл

@ -1,15 +1,14 @@
Name
====
ngx_lua - Embed the Power of Lua into Nginx
ngx_lua - Embed the power of Lua into Nginx
*This module is not distributed with the Nginx source.* See [the installation instructions](http://wiki.nginx.org/NginxHttpLuaModule#Installation).
Status
======
This module is under active development and is already production ready :)
We're already using this module very heavily in our production web applications
here in Taobao.com, Alibaba Group.
This module is under active development and is already production ready.
Version
=======
@ -1034,6 +1033,8 @@ For reading request headers, use the [ngx.req.get_headers](http://wiki.nginx.org
Reading values from `ngx.header.HEADER` is not implemented yet,
and usually you shouldn't need it.
Setting `ngx.header.HEADER` after sending out response headers (either explicitly with [ngx.send_headers](http://wiki.nginx.org/NginxHttpLuaModule#ngx.send_headers) or implicitly with [ngx.print](http://wiki.nginx.org/NginxHttpLuaModule#ngx.print) and its friends) will throw out a Lua exception.
ngx.req.get_uri_args
--------------------
**syntax:** *args = ngx.req.get_uri_args()*
@ -1527,8 +1528,17 @@ For example, [NginxHttpSetMiscModule](http://wiki.nginx.org/NginxHttpSetMiscModu
* [set_quote_sql_str](http://wiki.nginx.org/NginxHttpSetMiscModule#set_quote_sql_str)
* [set_quote_pgsql_str](http://wiki.nginx.org/NginxHttpSetMiscModule#set_quote_pgsql_str)
* [set_escape_uri](http://wiki.nginx.org/NginxHttpSetMiscModule#set_escape_uri)
* [set_quote_json_str](http://wiki.nginx.org/NginxHttpSetMiscModule#set_quote_json_str)
* [set_unescape_uri](http://wiki.nginx.org/NginxHttpSetMiscModule#set_unescape_uri)
* [set_escape_uri](http://wiki.nginx.org/NginxHttpSetMiscModule#set_escape_uri)
* [set_encode_base32](http://wiki.nginx.org/NginxHttpSetMiscModule#set_encode_base32)
* [set_decode_base32](http://wiki.nginx.org/NginxHttpSetMiscModule#set_decode_base32)
* [set_encode_base64](http://wiki.nginx.org/NginxHttpSetMiscModule#set_encode_base64)
* [set_decode_base64](http://wiki.nginx.org/NginxHttpSetMiscModule#set_decode_base64)
* [set_encode_hex](http://wiki.nginx.org/NginxHttpSetMiscModule#set_encode_base64)
* [set_decode_hex](http://wiki.nginx.org/NginxHttpSetMiscModule#set_decode_base64)
* [set_sha1](http://wiki.nginx.org/NginxHttpSetMiscModule#set_encode_base64)
* [set_md5](http://wiki.nginx.org/NginxHttpSetMiscModule#set_decode_base64)
For instance,
@ -1537,6 +1547,11 @@ For instance,
-- now res == 'a%2fb'
Similarly, the following directives provided by [NginxHttpEncryptedSessionModule](http://wiki.nginx.org/NginxHttpEncryptedSessionModule) can be invoked from within Lua too:
* [set_encrypt_session](http://wiki.nginx.org/NginxHttpEncryptedSessionModule#set_encrypt_session)
* [set_decrypt_session](http://wiki.nginx.org/NginxHttpEncryptedSessionModule#set_decrypt_session)
This feature requires the [ngx_devel_kit](https://github.com/simpl/ngx_devel_kit) module.
HTTP 1.0 support
@ -1807,4 +1822,5 @@ See Also
* [drizzle-nginx-module](http://github.com/chaoslawful/drizzle-nginx-module)
* [postgres-nginx-module](http://github.com/FRiCKLE/ngx_postgres)
* [memc-nginx-module](http://github.com/agentzh/memc-nginx-module)
* [The ngx_openresty bundle](http://openresty.org)

Просмотреть файл

@ -1,13 +1,12 @@
= Name =
ngx_lua - Embed the Power of Lua into Nginx
ngx_lua - Embed the power of Lua into Nginx
''This module is not distributed with the Nginx source.'' See [[#Installation|the installation instructions]].
= Status =
This module is under active development and is already production ready :)
We're already using this module very heavily in our production web applications
here in Taobao.com, Alibaba Group.
This module is under active development and is already production ready.
= Version =
@ -1003,6 +1002,8 @@ For reading request headers, use the [[#ngx.req.get_headers|ngx.req.get_headers]
Reading values from <code>ngx.header.HEADER</code> is not implemented yet,
and usually you shouldn't need it.
Setting <code>ngx.header.HEADER</code> after sending out response headers (either explicitly with [[#ngx.send_headers|ngx.send_headers]] or implicitly with [[#ngx.print|ngx.print]] and its friends) will throw out a Lua exception.
== ngx.req.get_uri_args ==
'''syntax:''' ''args = ngx.req.get_uri_args()''
@ -1469,8 +1470,17 @@ For example, [[NginxHttpSetMiscModule]]'s following directives can be invoked th
* [[NginxHttpSetMiscModule#set_quote_sql_str|set_quote_sql_str]]
* [[NginxHttpSetMiscModule#set_quote_pgsql_str|set_quote_pgsql_str]]
* [[NginxHttpSetMiscModule#set_escape_uri|set_escape_uri]]
* [[NginxHttpSetMiscModule#set_quote_json_str|set_quote_json_str]]
* [[NginxHttpSetMiscModule#set_unescape_uri|set_unescape_uri]]
* [[NginxHttpSetMiscModule#set_escape_uri|set_escape_uri]]
* [[NginxHttpSetMiscModule#set_encode_base32|set_encode_base32]]
* [[NginxHttpSetMiscModule#set_decode_base32|set_decode_base32]]
* [[NginxHttpSetMiscModule#set_encode_base64|set_encode_base64]]
* [[NginxHttpSetMiscModule#set_decode_base64|set_decode_base64]]
* [[NginxHttpSetMiscModule#set_encode_base64|set_encode_hex]]
* [[NginxHttpSetMiscModule#set_decode_base64|set_decode_hex]]
* [[NginxHttpSetMiscModule#set_encode_base64|set_sha1]]
* [[NginxHttpSetMiscModule#set_decode_base64|set_md5]]
For instance,
@ -1479,6 +1489,11 @@ For instance,
-- now res == 'a%2fb'
</geshi>
Similarly, the following directives provided by [[NginxHttpEncryptedSessionModule]] can be invoked from within Lua too:
* [[NginxHttpEncryptedSessionModule#set_encrypt_session|set_encrypt_session]]
* [[NginxHttpEncryptedSessionModule#set_decrypt_session|set_decrypt_session]]
This feature requires the [https://github.com/simpl/ngx_devel_kit ngx_devel_kit] module.
= HTTP 1.0 support =
@ -1735,4 +1750,5 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* [http://github.com/chaoslawful/drizzle-nginx-module drizzle-nginx-module]
* [http://github.com/FRiCKLE/ngx_postgres postgres-nginx-module]
* [http://github.com/agentzh/memc-nginx-module memc-nginx-module]
* [http://openresty.org The ngx_openresty bundle]