Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_proxy_module.xml @ 1909:399d0e188195

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
1908:d6692a78a444 1909:399d0e188195
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_http_proxy_module" 10 <module name="Module ngx_http_proxy_module"
11 link="/en/docs/http/ngx_http_proxy_module.html" 11 link="/en/docs/http/ngx_http_proxy_module.html"
12 lang="en" 12 lang="en"
13 rev="54"> 13 rev="55">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_http_proxy_module</literal> module allows passing 18 The <literal>ngx_http_proxy_module</literal> module allows passing
188 Defines a shared memory zone used for caching. 188 Defines a shared memory zone used for caching.
189 The same zone can be used in several places. 189 The same zone can be used in several places.
190 Parameter value can contain variables (1.7.9). 190 Parameter value can contain variables (1.7.9).
191 The <literal>off</literal> parameter disables caching inherited 191 The <literal>off</literal> parameter disables caching inherited
192 from the previous configuration level. 192 from the previous configuration level.
193 </para>
194
195 </directive>
196
197
198 <directive name="proxy_cache_background_update">
199 <syntax><literal>on</literal> | <literal>off</literal></syntax>
200 <default>off</default>
201 <context>http</context>
202 <context>server</context>
203 <context>location</context>
204 <appeared-in>1.11.10</appeared-in>
205
206 <para>
207 Allows starting a background subrequest
208 to update an expired cache item,
209 while a stale cached response is returned to the client.
210 Note that it is necessary to
211 <link id="proxy_cache_use_stale_updating">allow</link>
212 the usage of a stale cached response when it is being updated.
193 </para> 213 </para>
194 214
195 </directive> 215 </directive>
196 216
197 217
629 The <literal>error</literal> parameter also permits 649 The <literal>error</literal> parameter also permits
630 using a stale cached response if a proxied server to process a request 650 using a stale cached response if a proxied server to process a request
631 cannot be selected. 651 cannot be selected.
632 </para> 652 </para>
633 653
634 <para> 654 <para id="proxy_cache_use_stale_updating">
635 Additionally, the <literal>updating</literal> parameter permits 655 Additionally, the <literal>updating</literal> parameter permits
636 using a stale cached response if it is currently being updated. 656 using a stale cached response if it is currently being updated.
637 This allows minimizing the number of accesses to proxied servers 657 This allows minimizing the number of accesses to proxied servers
638 when updating cached data. 658 when updating cached data.
639 </para> 659 </para>