Skip to content

Commit bee0276

Browse files
agentzhagentzh
committed
sync'd docs from the nginx wiki site.
1 parent d0287de commit bee0276

File tree

3 files changed

+25
-53
lines changed

3 files changed

+25
-53
lines changed

‎README

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Version
1616
Synopsis
1717
upstream my_memcached {
1818
server 10.62.136.7:11211;
19-
keepalive 512 single; # this requires the ngx_http_upstream_keepalive module
19+
keepalive 512; # this requires the ngx_http_upstream_keepalive module
2020
}
2121

2222
location = /memc {
@@ -265,22 +265,15 @@ Description
265265
former is used in the srcache_fetch subrequest and the latter is used in
266266
the srcache_store subrequest.
267267

268-
[[HttpRedisModule]]'s latest version (as of this writing), 0.3.5, has a
269-
bug that could cause problems. A patch is provided here:
270-
271-
https://groups.google.com/group/openresty/browse_thread/thread/b5ddf1b24d3c9677
272-
273-
Finally, the Nginx core also has a bug that could prevent
274-
[[HttpRedis2Module]]'s pipelining support from working properly in
275-
certain extreme conditions. And the following patch fixes this:
268+
The Nginx core also has a bug that could prevent [[HttpRedis2Module]]'s
269+
pipelining support from working properly in certain extreme conditions.
270+
And the following patch fixes this:
276271

277272
http://mailman.nginx.org/pipermail/nginx-devel/2012-March/002040.html
278273

279-
Note that, however, if you are using the [ngx_openresty
280-
(<http://openresty.org/>)] 1.0.11.27 bundle or later, then you only need
281-
to prepare [[HttpRedisModule]] and the patch mentioned above, because
282-
other patches and components are already in the bundle properly except
283-
[[HttpRedisModule]].
274+
Note that, however, if you are using the ngx_openresty
275+
(<http://openresty.org/>) 1.0.15.3 bundle or later, then you already
276+
have everything that you need here in the bundle.
284277

285278
Directives
286279
srcache_fetch
@@ -921,16 +914,13 @@ Compatibility
921914

922915
* 1.1.x (last tested: 1.1.5)
923916

924-
* 1.0.x (last tested: 1.0.9)
917+
* 1.0.x (last tested: 1.0.11)
925918

926919
* 0.9.x (last tested: 0.9.4)
927920

928-
* 0.8.x (last tested: 0.8.54)
929-
930-
* 0.7.x >= 0.7.46 (last tested: 0.7.68)
921+
* 0.8.x >= 0.8.54 (last tested: 0.8.54)
931922

932-
Earlier versions of Nginx like 0.6.x and 0.5.x, as well as latest nginx
933-
0.8.42+ will *not* work.
923+
Earlier versions of Nginx like 0.7.x, 0.6.x and 0.5.x will *not* work.
934924

935925
If you find that any particular version of Nginx above 0.7.44 does not
936926
work with this module, please consider reporting a bug.
@@ -950,7 +940,6 @@ Source Repository
950940
Available on github at agentzh/srcache-nginx-module
951941
(<http://github.com/agentzh/srcache-nginx-module>).
952942

953-
ChangeLog
954943
Test Suite
955944
This module comes with a Perl-driven test suite. The test cases
956945
(<http://github.com/agentzh/srcache-nginx-module/tree/master/test/t>)
@@ -988,7 +977,7 @@ Author
988977
Zhang "agentzh" Yichun (章亦春) <agentzh@gmail.com>
989978

990979
Copyright & License
991-
Copyright (c) 2010-2012 Zhang "agentzh" Yichun (章亦春)
980+
Copyright (c) 2010-2012, Zhang "agentzh" Yichun (章亦春)
992981
<agentzh@gmail.com>.
993982

994983
This module is licensed under the terms of the BSD license.

‎README.markdown

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Synopsis
2626

2727
upstream my_memcached {
2828
server 10.62.136.7:11211;
29-
keepalive 512 single; # this requires the ngx_http_upstream_keepalive module
29+
keepalive 512; # this requires the ngx_http_upstream_keepalive module
3030
}
3131

3232
location = /memc {
@@ -235,15 +235,11 @@ This example makes use of the [$echo_request_body](http://wiki.nginx.org/HttpEch
235235

236236
Also, you need both [HttpRedisModule](http://wiki.nginx.org/HttpRedisModule) and [HttpRedis2Module](http://wiki.nginx.org/HttpRedis2Module). The former is used in the [srcache_fetch](http://wiki.nginx.org/HttpSRCacheModule#srcache_fetch) subrequest and the latter is used in the [srcache_store](http://wiki.nginx.org/HttpSRCacheModule#srcache_store) subrequest.
237237

238-
[HttpRedisModule](http://wiki.nginx.org/HttpRedisModule)'s latest version (as of this writing), `0.3.5`, has a bug that could cause problems. A patch is provided here:
239-
240-
https://groups.google.com/group/openresty/browse_thread/thread/b5ddf1b24d3c9677
241-
242-
Finally, the Nginx core also has a bug that could prevent [HttpRedis2Module](http://wiki.nginx.org/HttpRedis2Module)'s pipelining support from working properly in certain extreme conditions. And the following patch fixes this:
238+
The Nginx core also has a bug that could prevent [HttpRedis2Module](http://wiki.nginx.org/HttpRedis2Module)'s pipelining support from working properly in certain extreme conditions. And the following patch fixes this:
243239

244240
http://mailman.nginx.org/pipermail/nginx-devel/2012-March/002040.html
245241

246-
Note that, however, if you are using the [[ngx_openresty](http://openresty.org/)] 1.0.11.27 bundle or later, then you only need to prepare [HttpRedisModule](http://wiki.nginx.org/HttpRedisModule) and the patch mentioned above, because other patches and components are already in the bundle properly except [HttpRedisModule](http://wiki.nginx.org/HttpRedisModule).
242+
Note that, however, if you are using the [ngx_openresty](http://openresty.org/) 1.0.15.3 bundle or later, then you already have everything that you need here in the bundle.
247243

248244
Directives
249245
==========
@@ -690,7 +686,6 @@ You don't have to use this variable for the expiration time.
690686

691687
This variable was first introduced in the `v0.12rc7` release.
692688

693-
694689
$srcache_fetch_status
695690
---------------------
696691
**type:** *string*
@@ -788,12 +783,11 @@ The following versions of Nginx should work with this module:
788783

789784
* 1.2.x (last tested: 1.2.1)
790785
* 1.1.x (last tested: 1.1.5)
791-
* 1.0.x (last tested: 1.0.9)
786+
* 1.0.x (last tested: 1.0.11)
792787
* 0.9.x (last tested: 0.9.4)
793-
* 0.8.x (last tested: 0.8.54)
794-
* 0.7.x >= 0.7.46 (last tested: 0.7.68)
788+
* 0.8.x >= 0.8.54 (last tested: 0.8.54)
795789

796-
Earlier versions of Nginx like 0.6.x and 0.5.x, as well as latest nginx 0.8.42+ will *not* work.
790+
Earlier versions of Nginx like 0.7.x, 0.6.x and 0.5.x will *not* work.
797791

798792
If you find that any particular version of Nginx above 0.7.44 does not work with this module, please consider reporting a bug.
799793

@@ -808,9 +802,6 @@ Source Repository
808802
=================
809803
Available on github at [agentzh/srcache-nginx-module](http://github.com/agentzh/srcache-nginx-module).
810804

811-
ChangeLog
812-
=========
813-
814805
Test Suite
815806
==========
816807
This module comes with a Perl-driven test suite. The [test cases](http://github.com/agentzh/srcache-nginx-module/tree/master/test/t) are [declarative](http://github.com/agentzh/srcache-nginx-module/blob/master/test/t/main-req.t) too. Thanks to the [Test::Nginx](http://search.cpan.org/perldoc?Test::Base) module in the Perl world.
@@ -840,7 +831,7 @@ Zhang "agentzh" Yichun (章亦春) <agentzh@gmail.com>
840831

841832
Copyright & License
842833
===================
843-
Copyright (c) 2010-2012 Zhang "agentzh" Yichun (章亦春) <agentzh@gmail.com>.
834+
Copyright (c) 2010-2012, Zhang "agentzh" Yichun (章亦春) <agentzh@gmail.com>.
844835

845836
This module is licensed under the terms of the BSD license.
846837

‎doc/HttpSRCacheModule.wiki

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This document describes srcache-nginx-module [https://github.com/agentzh/srcache
1717
<geshi lang="nginx">
1818
upstream my_memcached {
1919
server 10.62.136.7:11211;
20-
keepalive 512 single; # this requires the ngx_http_upstream_keepalive module
20+
keepalive 512; # this requires the ngx_http_upstream_keepalive module
2121
}
2222

2323
location = /memc {
@@ -222,15 +222,11 @@ This example makes use of the [[HttpEchoModule#$echo_request_body|$echo_request_
222222

223223
Also, you need both [[HttpRedisModule]] and [[HttpRedis2Module]]. The former is used in the [[#srcache_fetch|srcache_fetch]] subrequest and the latter is used in the [[#srcache_store|srcache_store]] subrequest.
224224

225-
[[HttpRedisModule]]'s latest version (as of this writing), <code>0.3.5</code>, has a bug that could cause problems. A patch is provided here:
226-
227-
https://groups.google.com/group/openresty/browse_thread/thread/b5ddf1b24d3c9677
228-
229-
Finally, the Nginx core also has a bug that could prevent [[HttpRedis2Module]]'s pipelining support from working properly in certain extreme conditions. And the following patch fixes this:
225+
The Nginx core also has a bug that could prevent [[HttpRedis2Module]]'s pipelining support from working properly in certain extreme conditions. And the following patch fixes this:
230226

231227
http://mailman.nginx.org/pipermail/nginx-devel/2012-March/002040.html
232228
233-
Note that, however, if you are using the [[http://openresty.org/ ngx_openresty]] 1.0.11.27 bundle or later, then you only need to prepare [[HttpRedisModule]] and the patch mentioned above, because other patches and components are already in the bundle properly except [[HttpRedisModule]].
229+
Note that, however, if you are using the [http://openresty.org/ ngx_openresty] 1.0.15.3 bundle or later, then you already have everything that you need here in the bundle.
234230

235231
= Directives =
236232

@@ -656,7 +652,6 @@ You don't have to use this variable for the expiration time.
656652

657653
This variable was first introduced in the <code>v0.12rc7</code> release.
658654

659-
660655
== $srcache_fetch_status ==
661656
'''type:''' ''string''
662657

@@ -748,12 +743,11 @@ The following versions of Nginx should work with this module:
748743

749744
* 1.2.x (last tested: 1.2.1)
750745
* 1.1.x (last tested: 1.1.5)
751-
* 1.0.x (last tested: 1.0.9)
746+
* 1.0.x (last tested: 1.0.11)
752747
* 0.9.x (last tested: 0.9.4)
753-
* 0.8.x (last tested: 0.8.54)
754-
* 0.7.x >= 0.7.46 (last tested: 0.7.68)
748+
* 0.8.x >= 0.8.54 (last tested: 0.8.54)
755749
756-
Earlier versions of Nginx like 0.6.x and 0.5.x, as well as latest nginx 0.8.42+ will ''not'' work.
750+
Earlier versions of Nginx like 0.7.x, 0.6.x and 0.5.x will ''not'' work.
757751

758752
If you find that any particular version of Nginx above 0.7.44 does not work with this module, please consider reporting a bug.
759753

@@ -766,8 +760,6 @@ Although a lot of effort has been put into testing and code tuning, there must b
766760
= Source Repository =
767761
Available on github at [http://github.com/agentzh/srcache-nginx-module agentzh/srcache-nginx-module].
768762

769-
= ChangeLog =
770-
771763
= Test Suite =
772764
This module comes with a Perl-driven test suite. The [http://github.com/agentzh/srcache-nginx-module/tree/master/test/t test cases] are [http://github.com/agentzh/srcache-nginx-module/blob/master/test/t/main-req.t declarative] too. Thanks to the [http://search.cpan.org/perldoc?Test::Base Test::Nginx] module in the Perl world.
773765

@@ -792,7 +784,7 @@ You'll be very welcomed to submit patches to the author or just ask for a commit
792784
Zhang "agentzh" Yichun (章亦春) <agentzh@gmail.com>
793785

794786
= Copyright & License =
795-
Copyright (c) 2010-2012 Zhang "agentzh" Yichun (章亦春) <agentzh@gmail.com>.
787+
Copyright (c) 2010-2012, Zhang "agentzh" Yichun (章亦春) <agentzh@gmail.com>.
796788

797789
This module is licensed under the terms of the BSD license.
798790

0 commit comments

Comments
 (0)