Skip to content

Commit 73bc7a9

Browse files
agentzhagentzh
committed
updated docs to reflect recent changes.
1 parent f957c0f commit 73bc7a9

File tree

3 files changed

+35
-18
lines changed

3 files changed

+35
-18
lines changed

‎README

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,18 @@ Directives
389389
srcache_store_hide_header directives to control what headers to cache
390390
and what not.
391391

392-
This directive works in an output filter.
392+
The original response's data chunks get emitted as soon as they arrive.
393+
"srcache_store" just copies and collects the data in an output filter
394+
without postponing them from being sent downstream.
395+
396+
But please note that even though all the response data will be sent
397+
immediately, the current Nginx request lifetime will not finish until
398+
the srcache_store subrequest completes. That means a delay in closing
399+
the TCP connection on the server side (when HTTP keepalive is disabled,
400+
but proper HTTP clients should close the connection actively on the
401+
client side, which adds no extra delay or other issues at all) or
402+
serving the next request sent on the same TCP connection (when HTTP
403+
keepalive is in action).
393404

394405
srcache_store_max_size
395406
syntax: *srcache_store_max_size <size>*
@@ -910,17 +921,17 @@ Installation
910921
Alternatively, you can build Nginx with this module all by yourself:
911922

912923
* Grab the nginx source code from nginx.org (<http://nginx.org>), for
913-
example, the version 1.2.6 (see Nginx Compatibility),
924+
example, the version 1.2.7 (see Nginx Compatibility),
914925

915926
* and then download the latest version of the release tarball of this
916927
module from srcache-nginx-module file list
917928
(<http://github.com/agentzh/srcache-nginx-module/tags>),
918929

919930
* and finally build the Nginx source with this module
920931

921-
wget 'http://nginx.org/download/nginx-1.2.6.tar.gz'
922-
tar -xzvf nginx-1.2.6.tar.gz
923-
cd nginx-1.2.6/
932+
wget 'http://nginx.org/download/nginx-1.2.7.tar.gz'
933+
tar -xzvf nginx-1.2.7.tar.gz
934+
cd nginx-1.2.7/
924935

925936
# Here we assume you would install you nginx under /opt/nginx/.
926937
./configure --prefix=/opt/nginx \
@@ -934,7 +945,7 @@ Compatibility
934945

935946
* 1.3.x (last tested: 1.3.7)
936947

937-
* 1.2.x (last tested: 1.2.6)
948+
* 1.2.x (last tested: 1.2.7)
938949

939950
* 1.1.x (last tested: 1.1.5)
940951

‎README.markdown

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,10 @@ Since the `v0.12rc7` release, both the response status line, response headers, a
336336

337337
You can use the [srcache_store_pass_header](http://wiki.nginx.org/HttpSRCacheModule#srcache_store_pass_header) and/or [srcache_store_hide_header](http://wiki.nginx.org/HttpSRCacheModule#srcache_store_hide_header) directives to control what headers to cache and what not.
338338

339-
This directive works in an output filter.
339+
The original response's data chunks get emitted as soon as
340+
they arrive. `srcache_store` just copies and collects the data in an output filter without postponing them from being sent downstream.
341+
342+
But please note that even though all the response data will be sent immediately, the current Nginx request lifetime will not finish until the srcache_store subrequest completes. That means a delay in closing the TCP connection on the server side (when HTTP keepalive is disabled, but proper HTTP clients should close the connection actively on the client side, which adds no extra delay or other issues at all) or serving the next request sent on the same TCP connection (when HTTP keepalive is in action).
340343

341344
srcache_store_max_size
342345
----------------------
@@ -773,13 +776,13 @@ It is recommended to install this module as well as the Nginx core and many othe
773776

774777
Alternatively, you can build Nginx with this module all by yourself:
775778

776-
* Grab the nginx source code from [nginx.org](http://nginx.org), for example, the version 1.2.6 (see [Nginx Compatibility](http://wiki.nginx.org/HttpSRCacheModule#Compatibility)),
779+
* Grab the nginx source code from [nginx.org](http://nginx.org), for example, the version 1.2.7 (see [Nginx Compatibility](http://wiki.nginx.org/HttpSRCacheModule#Compatibility)),
777780
* and then download the latest version of the release tarball of this module from srcache-nginx-module [file list](http://github.com/agentzh/srcache-nginx-module/tags),
778781
* and finally build the Nginx source with this module
779782

780-
wget 'http://nginx.org/download/nginx-1.2.6.tar.gz'
781-
tar -xzvf nginx-1.2.6.tar.gz
782-
cd nginx-1.2.6/
783+
wget 'http://nginx.org/download/nginx-1.2.7.tar.gz'
784+
tar -xzvf nginx-1.2.7.tar.gz
785+
cd nginx-1.2.7/
783786
784787
# Here we assume you would install you nginx under /opt/nginx/.
785788
./configure --prefix=/opt/nginx \
@@ -795,7 +798,7 @@ Compatibility
795798
The following versions of Nginx should work with this module:
796799

797800
* 1.3.x (last tested: 1.3.7)
798-
* 1.2.x (last tested: 1.2.6)
801+
* 1.2.x (last tested: 1.2.7)
799802
* 1.1.x (last tested: 1.1.5)
800803
* 1.0.x (last tested: 1.0.11)
801804
* 0.9.x (last tested: 0.9.4)

‎doc/HttpSRCacheModule.wiki

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,10 @@ Since the <code>v0.12rc7</code> release, both the response status line, response
319319
320320
You can use the [[#srcache_store_pass_header|srcache_store_pass_header]] and/or [[#srcache_store_hide_header|srcache_store_hide_header]] directives to control what headers to cache and what not.
321321

322-
This directive works in an output filter.
322+
The original response's data chunks get emitted as soon as
323+
they arrive. <code>srcache_store</code> just copies and collects the data in an output filter without postponing them from being sent downstream.
324+
325+
But please note that even though all the response data will be sent immediately, the current Nginx request lifetime will not finish until the srcache_store subrequest completes. That means a delay in closing the TCP connection on the server side (when HTTP keepalive is disabled, but proper HTTP clients should close the connection actively on the client side, which adds no extra delay or other issues at all) or serving the next request sent on the same TCP connection (when HTTP keepalive is in action).
323326

324327
== srcache_store_max_size ==
325328
'''syntax:''' ''srcache_store_max_size <size>''
@@ -733,13 +736,13 @@ It is recommended to install this module as well as the Nginx core and many othe
733736

734737
Alternatively, you can build Nginx with this module all by yourself:
735738

736-
* Grab the nginx source code from [http://nginx.org nginx.org], for example, the version 1.2.6 (see [[#Compatibility|Nginx Compatibility]]),
739+
* Grab the nginx source code from [http://nginx.org nginx.org], for example, the version 1.2.7 (see [[#Compatibility|Nginx Compatibility]]),
737740
* and then download the latest version of the release tarball of this module from srcache-nginx-module [http://github.com/agentzh/srcache-nginx-module/tags file list],
738741
* and finally build the Nginx source with this module
739742
<geshi lang="nginx">
740-
wget 'http://nginx.org/download/nginx-1.2.6.tar.gz'
741-
tar -xzvf nginx-1.2.6.tar.gz
742-
cd nginx-1.2.6/
743+
wget 'http://nginx.org/download/nginx-1.2.7.tar.gz'
744+
tar -xzvf nginx-1.2.7.tar.gz
745+
cd nginx-1.2.7/
743746

744747
# Here we assume you would install you nginx under /opt/nginx/.
745748
./configure --prefix=/opt/nginx \
@@ -754,7 +757,7 @@ Alternatively, you can build Nginx with this module all by yourself:
754757
The following versions of Nginx should work with this module:
755758

756759
* 1.3.x (last tested: 1.3.7)
757-
* 1.2.x (last tested: 1.2.6)
760+
* 1.2.x (last tested: 1.2.7)
758761
* 1.1.x (last tested: 1.1.5)
759762
* 1.0.x (last tested: 1.0.11)
760763
* 0.9.x (last tested: 0.9.4)

0 commit comments

Comments
 (0)