This module is already production ready.

Version

This document describes ngx_redis2 v0.08rc2

(<https://github.com/agentzh/redis2-nginx-module/tags>) released on 24

November 2011.

This document describes ngx_redis2 v0.09

(<https://github.com/agentzh/redis2-nginx-module/tags>) released on 8

September 2012.

Synopsis

location /foo {

@@ -63,6 +63,19 @@ Synopsis

redis2_pass 127.0.0.1:6379;

}

location /init {

redis2_query del key1;

redis2_query lpush key1 C;

redis2_query lpush key1 B;

redis2_query lpush key1 A;

redis2_pass 127.0.0.1:6379;

}

location /get {

redis2_query lrange key1 0 -1;

redis2_pass 127.0.0.1:6379;

}

Description

This is an Nginx upstream module that makes nginx talk to a Redis

(<http://redis.io/>) 2.x server in a non-blocking way. The full Redis

@@ -265,7 +278,7 @@ Connection Pool

# a pool with at most 1024 connections

# and do not distinguish the servers:

keepalive 1024 single;

keepalive 1024;

}

server {

@@ -280,9 +293,10 @@ Connection Pool

Lua Interoperability

This module can be served as a non-blocking redis2 client for

[[HttpLuaModule]].

Here's an example using a GET subrequest:

[[HttpLuaModule]] (but nowadays it is recommended to use the

lua-resty-redis (<http://github.com/agentzh/lua-resty-redis>) library

instead, which is much simpler to use and more efficient most of the

time). Here's an example using a GET subrequest:

location /redis {

internal;

@@ -506,17 +520,17 @@ Installation

standard Nginx core as follows:

* Grab the nginx source code from nginx.org (<http://nginx.org>), for

example, the version 1.0.8 (see nginx compatibility),

example, the version 1.2.1 (see nginx compatibility),

* and then download the latest version of the release tarball of this

module from ngx_redis2's file list

(<http://github.com/agentzh/redis2-nginx-module/tags>).

* and finally build the source with this module:

wget 'http://nginx.org/download/nginx-1.0.8.tar.gz'

tar -xzvf nginx-1.0.8.tar.gz

cd nginx-1.0.8/

wget 'http://nginx.org/download/nginx-1.2.1.tar.gz'

tar -xzvf nginx-1.2.1.tar.gz

cd nginx-1.2.1/

# Here we assume you would install you nginx under /opt/nginx/.

./configure --prefix=/opt/nginx \

@@ -526,13 +540,17 @@ Installation

make install

Compatibility

Redis 2.0, 2.2, and above should work with this module without any

Redis 2.0, 2.2, 2.4, and above should work with this module without any

issues. So is the Alchemy Database

(<http://code.google.com/p/alchemydatabase/>) (aka redisql in its early

days).

The following versions of Nginx should work with this module:

* 1.3.x (last tested: 1.3.4)

* 1.2.x (last tested: 1.2.3)

* 1.1.x (last tested: 1.1.5)

* 1.0.x (last tested: 1.0.10)

* Add the "redis2_as_json" directive to allow emitting JSON directly.

Author

Zhang "agentzh" Yichun (章亦春) <agentzh@gmail.com>

Yichun "agentzh" Zhang (章亦春) <agentzh@gmail.com>

Getting involved

You'll be very welcomed to submit patches to the author or just ask for

@@ -575,7 +593,7 @@ Getting involved

Copyright & License

This module is licenced under the BSD license.

Copyright (C) 2010, 2011, by Zhang "agentzh" Yichun (章亦春)

Copyright (C) 2010-2012, by Yichun "agentzh" Zhang (章亦春)

<agentzh@gmail.com>.

All rights reserved.

@@ -606,10 +624,15 @@ Copyright & License

SEE ALSO

* The Redis (<http://redis.io/>) server homepage.

* The Redis wire protocol: http://redis.io/topics/protocol

* a redis response parser and a request constructor for Lua:

[[LuaRedisParser]].

* [[HttpLuaModule]]

* The ngx_openresty bundle (<http://openresty.org>).

* The lua-resty-redis (<https://github.com/agentzh/lua-resty-redis>)

library based on the [[HttpLuaModule]] cosocket API.