diff xml/en/docs/http/ngx_http_scgi_module.xml @ 1909:399d0e188195

Documented proxy_cache_background_update and friends.
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 15 Feb 2017 23:16:54 +0300
parents 6839c258c473
children 41cf2c2d8c5c
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_scgi_module.xml
+++ b/xml/en/docs/http/ngx_http_scgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_scgi_module"
         link="/en/docs/http/ngx_http_scgi_module.html"
         lang="en"
-        rev="29">
+        rev="30">
 
 <section id="summary">
 
@@ -193,6 +193,26 @@ from the previous configuration level.
 </directive>
 
 
+<directive name="scgi_cache_background_update">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.11.10</appeared-in>
+
+<para>
+Allows starting a background subrequest
+to update an expired cache item,
+while a stale cached response is returned to the client.
+Note that it is necessary to
+<link id="scgi_cache_use_stale_updating">allow</link>
+the usage of a stale cached response when it is being updated.
+</para>
+
+</directive>
+
+
 <directive name="scgi_cache_bypass">
 <syntax><value>string</value> ...</syntax>
 <default/>
@@ -604,7 +624,7 @@ using a stale cached response if an SCGI
 cannot be selected.
 </para>
 
-<para>
+<para id="scgi_cache_use_stale_updating">
 Additionally, the <literal>updating</literal> parameter permits
 using a stale cached response if it is currently being updated.
 This allows minimizing the number of accesses to SCGI servers