bumped version to 0.19; also added a "Trouble Shooting" section to docs.

agentzh · agentzh · commit f957c0fe3865 · 2013-02-04T22:15:53.000-08:00
diff --git a/README b/README
@@ -9,9 +9,9 @@ Status
     This module is production ready.
 
 Version
-    This document describes srcache-nginx-module v0.18
-    (<https://github.com/agentzh/srcache-nginx-module/tags>) released on 25
-    January 2013.
+    This document describes srcache-nginx-module v0.19
+    (<https://github.com/agentzh/srcache-nginx-module/tags>) released on 4
+    February 2013.
 
 Synopsis
         upstream my_memcached {
@@ -885,6 +885,21 @@ Caveats
             }
         }
 
+Trouble Shooting
+    To debug issues, you should always check your Nginx "error.log" file
+    first. If no error messages are printed, you need to enable the Nginx
+    debugging logs to get more details, as explained in
+    [[Debugging#Debugging_log]].
+
+    Several common pitfalls for beginners:
+
+    *   The original response carries a "Cache-Control" header that
+        explicitly disables caching and you do not configure directives like
+        srcache_response_cache_control.
+
+    *   The original response is already gzip compressed, which is not
+        cached by default (see srcache_ignore_content_encoding).
+
 Installation
     It is recommended to install this module as well as the Nginx core and
     many other goodies via the ngx_openresty bundle
diff --git a/README.markdown b/README.markdown
@@ -18,7 +18,7 @@ This module is production ready.
 Version
 =======
 
-This document describes srcache-nginx-module [v0.18](https://github.com/agentzh/srcache-nginx-module/tags) released on 25 January 2013.
+This document describes srcache-nginx-module [v0.19](https://github.com/agentzh/srcache-nginx-module/tags) released on 4 February 2013.
 
 Synopsis
 ========
@@ -756,6 +756,16 @@ Caveats
     }
 
 
+Trouble Shooting
+================
+
+To debug issues, you should always check your Nginx `error.log` file first. If no error messages are printed, you need to enable the Nginx debugging logs to get more details, as explained in [[Debugging#Debugging_log]].
+
+Several common pitfalls for beginners:
+
+* The original response carries a `Cache-Control` header that explicitly disables caching and you do not configure directives like [srcache_response_cache_control](http://wiki.nginx.org/HttpSRCacheModule#srcache_response_cache_control).
+* The original response is already gzip compressed, which is not cached by default (see [srcache_ignore_content_encoding](http://wiki.nginx.org/HttpSRCacheModule#srcache_ignore_content_encoding)).
+
 Installation
 ============
 
diff --git a/doc/HttpSRCacheModule.wiki b/doc/HttpSRCacheModule.wiki
@@ -10,7 +10,7 @@ This module is production ready.
 
 = Version =
 
-This document describes srcache-nginx-module [https://github.com/agentzh/srcache-nginx-module/tags v0.18] released on 25 January 2013.
+This document describes srcache-nginx-module [https://github.com/agentzh/srcache-nginx-module/tags v0.19] released on 4 February 2013.
 
 = Synopsis =
 
@@ -718,6 +718,15 @@ This variable was first introduced in the <code>v0.14</code> release.
     }
 </geshi>
 
+= Trouble Shooting =
+
+To debug issues, you should always check your Nginx <code>error.log</code> file first. If no error messages are printed, you need to enable the Nginx debugging logs to get more details, as explained in [[Debugging#Debugging_log]].
+
+Several common pitfalls for beginners:
+
+* The original response carries a <code>Cache-Control</code> header that explicitly disables caching and you do not configure directives like [[#srcache_response_cache_control|srcache_response_cache_control]].
+* The original response is already gzip compressed, which is not cached by default (see [[#srcache_ignore_content_encoding|srcache_ignore_content_encoding]]).
+
 = Installation =
 
 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.
