Skip to content

Commit fc03db3

Browse files
agentzhagentzh
committed
updated docs to reflect recent changes.
1 parent 369342a commit fc03db3

File tree

3 files changed

+28
-21
lines changed

3 files changed

+28
-21
lines changed

‎README

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -580,6 +580,9 @@ Directives
580580
and "DELETE". The "GET" and "HEAD" methods are always implicitly
581581
included in the list regardless of their presence in this directive.
582582

583+
Note that "HEAD" requests are always skipped by srcache_store because
584+
their responses never carry a response body.
585+
583586
This directive was first introduced in the "v0.12rc7" release.
584587

585588
srcache_ignore_content_encoding
@@ -893,22 +896,22 @@ Installation
893896
ngx_openresty bundle (<http://openresty.org>), then you are highly
894897
recommended to apply the nonbuffered-upstream-truncation patch
895898
(<https://raw.github.com/agentzh/ngx_openresty/master/patches/nginx-1.2.
896-
3-nonbuffered-upstream-truncation.patch>) to your Nginx source tree.
899+
6-nonbuffered-upstream-truncation.patch>) to your Nginx source tree.
897900

898901
Alternatively, you can build Nginx with this module all by yourself:
899902

900903
* Grab the nginx source code from nginx.org (<http://nginx.org>), for
901-
example, the version 1.2.3 (see Nginx Compatibility),
904+
example, the version 1.2.6 (see Nginx Compatibility),
902905

903906
* and then download the latest version of the release tarball of this
904907
module from srcache-nginx-module file list
905908
(<http://github.com/agentzh/srcache-nginx-module/tags>),
906909

907910
* and finally build the Nginx source with this module
908911

909-
wget 'http://nginx.org/download/nginx-1.2.3.tar.gz'
910-
tar -xzvf nginx-1.2.3.tar.gz
911-
cd nginx-1.2.3/
912+
wget 'http://nginx.org/download/nginx-1.2.6.tar.gz'
913+
tar -xzvf nginx-1.2.6.tar.gz
914+
cd nginx-1.2.6/
912915

913916
# Here we assume you would install you nginx under /opt/nginx/.
914917
./configure --prefix=/opt/nginx \
@@ -920,9 +923,9 @@ Installation
920923
Compatibility
921924
The following versions of Nginx should work with this module:
922925

923-
* 1.3.x (last tested: 1.3.4)
926+
* 1.3.x (last tested: 1.3.7)
924927

925-
* 1.2.x (last tested: 1.2.3)
928+
* 1.2.x (last tested: 1.2.6)
926929

927930
* 1.1.x (last tested: 1.1.5)
928931

‎README.markdown

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -502,6 +502,8 @@ This directive specifies HTTP request methods that are considered by either [src
502502

503503
The following HTTP methods are allowed: `GET`, `HEAD`, `POST`, `PUT`, and `DELETE`. The `GET` and `HEAD` methods are always implicitly included in the list regardless of their presence in this directive.
504504

505+
Note that `HEAD` requests are always skipped by [srcache_store](http://wiki.nginx.org/HttpSRCacheModule#srcache_store) because their responses never carry a response body.
506+
505507
This directive was first introduced in the `v0.12rc7` release.
506508

507509
srcache_ignore_content_encoding
@@ -759,17 +761,17 @@ Installation
759761

760762
It is recommended to install this module as well as the Nginx core and many other goodies via the [ngx_openresty bundle](http://openresty.org). It is the easiest way and most safe way to set things up. See OpenResty's [installation instructions](http://openresty.org/#Installation) for details.
761763

762-
If you are using Nginx distributions that are not shipped with the [ngx_openresty bundle](http://openresty.org), then you are highly recommended to apply the [nonbuffered-upstream-truncation patch](https://raw.github.com/agentzh/ngx_openresty/master/patches/nginx-1.2.3-nonbuffered-upstream-truncation.patch) to your Nginx source tree.
764+
If you are using Nginx distributions that are not shipped with the [ngx_openresty bundle](http://openresty.org), then you are highly recommended to apply the [nonbuffered-upstream-truncation patch](https://raw.github.com/agentzh/ngx_openresty/master/patches/nginx-1.2.6-nonbuffered-upstream-truncation.patch) to your Nginx source tree.
763765

764766
Alternatively, you can build Nginx with this module all by yourself:
765767

766-
* Grab the nginx source code from [nginx.org](http://nginx.org), for example, the version 1.2.3 (see [Nginx Compatibility](http://wiki.nginx.org/HttpSRCacheModule#Compatibility)),
768+
* 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)),
767769
* 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),
768770
* and finally build the Nginx source with this module
769771

770-
wget 'http://nginx.org/download/nginx-1.2.3.tar.gz'
771-
tar -xzvf nginx-1.2.3.tar.gz
772-
cd nginx-1.2.3/
772+
wget 'http://nginx.org/download/nginx-1.2.6.tar.gz'
773+
tar -xzvf nginx-1.2.6.tar.gz
774+
cd nginx-1.2.6/
773775
774776
# Here we assume you would install you nginx under /opt/nginx/.
775777
./configure --prefix=/opt/nginx \
@@ -784,8 +786,8 @@ Compatibility
784786

785787
The following versions of Nginx should work with this module:
786788

787-
* 1.3.x (last tested: 1.3.4)
788-
* 1.2.x (last tested: 1.2.3)
789+
* 1.3.x (last tested: 1.3.7)
790+
* 1.2.x (last tested: 1.2.6)
789791
* 1.1.x (last tested: 1.1.5)
790792
* 1.0.x (last tested: 1.0.11)
791793
* 0.9.x (last tested: 0.9.4)

‎doc/HttpSRCacheModule.wiki

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -478,6 +478,8 @@ This directive specifies HTTP request methods that are considered by either [[#s
478478

479479
The following HTTP methods are allowed: <code>GET</code>, <code>HEAD</code>, <code>POST</code>, <code>PUT</code>, and <code>DELETE</code>. The <code>GET</code> and <code>HEAD</code> methods are always implicitly included in the list regardless of their presence in this directive.
480480

481+
Note that <code>HEAD</code> requests are always skipped by [[#srcache_store|srcache_store]] because their responses never carry a response body.
482+
481483
This directive was first introduced in the <code>v0.12rc7</code> release.
482484

483485
== srcache_ignore_content_encoding ==
@@ -720,17 +722,17 @@ This variable was first introduced in the <code>v0.14</code> release.
720722

721723
It is recommended to install this module as well as the Nginx core and many other goodies via the [http://openresty.org ngx_openresty bundle]. It is the easiest way and most safe way to set things up. See OpenResty's [http://openresty.org/#Installation installation instructions] for details.
722724

723-
If you are using Nginx distributions that are not shipped with the [http://openresty.org ngx_openresty bundle], then you are highly recommended to apply the [https://raw.github.com/agentzh/ngx_openresty/master/patches/nginx-1.2.3-nonbuffered-upstream-truncation.patch nonbuffered-upstream-truncation patch] to your Nginx source tree.
725+
If you are using Nginx distributions that are not shipped with the [http://openresty.org ngx_openresty bundle], then you are highly recommended to apply the [https://raw.github.com/agentzh/ngx_openresty/master/patches/nginx-1.2.6-nonbuffered-upstream-truncation.patch nonbuffered-upstream-truncation patch] to your Nginx source tree.
724726

725727
Alternatively, you can build Nginx with this module all by yourself:
726728

727-
* Grab the nginx source code from [http://nginx.org nginx.org], for example, the version 1.2.3 (see [[#Compatibility|Nginx Compatibility]]),
729+
* Grab the nginx source code from [http://nginx.org nginx.org], for example, the version 1.2.6 (see [[#Compatibility|Nginx Compatibility]]),
728730
* 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],
729731
* and finally build the Nginx source with this module
730732
<geshi lang="nginx">
731-
wget 'http://nginx.org/download/nginx-1.2.3.tar.gz'
732-
tar -xzvf nginx-1.2.3.tar.gz
733-
cd nginx-1.2.3/
733+
wget 'http://nginx.org/download/nginx-1.2.6.tar.gz'
734+
tar -xzvf nginx-1.2.6.tar.gz
735+
cd nginx-1.2.6/
734736

735737
# Here we assume you would install you nginx under /opt/nginx/.
736738
./configure --prefix=/opt/nginx \
@@ -744,8 +746,8 @@ Alternatively, you can build Nginx with this module all by yourself:
744746

745747
The following versions of Nginx should work with this module:
746748

747-
* 1.3.x (last tested: 1.3.4)
748-
* 1.2.x (last tested: 1.2.3)
749+
* 1.3.x (last tested: 1.3.7)
750+
* 1.2.x (last tested: 1.2.6)
749751
* 1.1.x (last tested: 1.1.5)
750752
* 1.0.x (last tested: 1.0.11)
751753
* 0.9.x (last tested: 0.9.4)

0 commit comments

Comments
 (0)