Mercurial > hg > nginx-site

diff xml/en/docs/http/ngx_http_proxy_module.xml @ 1582:8973c7b37854

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated commercial docs. details: http://hg.nginx.com/nginx.org-se/rev/23bf3610377f branches: se changeset: 1814:23bf3610377f user: Yaroslav Zhuravlev <yar@nginx.com> description: Added purge parameters to proxy_cache_path and friends. diffstat: xml/en/docs/http/ngx_http_fastcgi_module.xml | 60 +++++++++++++++++++++++++++- xml/en/docs/http/ngx_http_proxy_module.xml | 60 +++++++++++++++++++++++++++- xml/en/docs/http/ngx_http_scgi_module.xml | 60 +++++++++++++++++++++++++++- xml/en/docs/http/ngx_http_uwsgi_module.xml | 60 +++++++++++++++++++++++++++- xml/ru/docs/http/ngx_http_fastcgi_module.xml | 60 +++++++++++++++++++++++++++- xml/ru/docs/http/ngx_http_proxy_module.xml | 60 +++++++++++++++++++++++++++- xml/ru/docs/http/ngx_http_scgi_module.xml | 60 +++++++++++++++++++++++++++- xml/ru/docs/http/ngx_http_uwsgi_module.xml | 60 +++++++++++++++++++++++++++- 8 files changed, 472 insertions(+), 8 deletions(-) diffs (truncated from 672 to 500 lines):
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 30 Sep 2015 18:48:54 +0300
parents 305f2c338181
children c2a0a18e65ba
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_proxy_module.xml
+++ b/xml/en/docs/http/ngx_http_proxy_module.xml
@@ -327,7 +327,11 @@ will be cached.
     [<literal>max_size</literal>=<value>size</value>]
     [<literal>loader_files</literal>=<value>number</value>]
     [<literal>loader_sleep</literal>=<value>time</value>]
-    [<literal>loader_threshold</literal>=<value>time</value>]</syntax>
+    [<literal>loader_threshold</literal>=<value>time</value>]
+    [<literal>purger</literal>=<literal>on</literal>|<literal>off</literal>]
+    [<literal>purger_files</literal>=<value>number</value>]
+    [<literal>purger_sleep</literal>=<value>time</value>]
+    [<literal>purger_threshold</literal>=<value>time</value>]</syntax>
 <default/>
 <context>http</context>
 
@@ -400,6 +404,56 @@ Between iterations, a pause configured b
 parameter (by default, 50 milliseconds) is made.
 </para>
 
+<para>
+Additionally,
+the following parameters are available as part of our
+<commercial_version>commercial subscription</commercial_version>:
+</para>
+
+<para>
+<list type="tag">
+
+<tag-name id="purger">
+<literal>purger</literal>=<literal>on</literal>|<literal>off</literal>
+</tag-name>
+<tag-desc>
+Instructs whether cache entries that match a
+<link id="proxy_cache_purge">wildcard key</link>
+will be removed from the disk by the cache purger (1.7.12).
+Setting the parameter to <literal>on</literal>
+(default is <literal>off</literal>)
+will activate the “cache purger” process that
+permanently iterates through all cache entries
+and deletes the entries that match the wildcard key.
+</tag-desc>
+
+<tag-name id="purger_files">
+<literal>purger_files</literal>=<value>number</value>
+</tag-name>
+<tag-desc>
+Sets the number of items that will be scanned during one iteration (1.7.12).
+By default, <literal>purger_files</literal> is set to 10.
+</tag-desc>
+
+<tag-name id="purger_threshold">
+<literal>purger_threshold</literal>=<value>number</value>
+</tag-name>
+<tag-desc>
+Sets the duration of one iteration (1.7.12).
+By default, <literal>purger_threshold</literal> is set to 50 milliseconds.
+</tag-desc>
+
+<tag-name id="purger_sleep">
+<literal>purger_sleep</literal>=<value>number</value>
+</tag-name>
+<tag-desc>
+Sets a pause between iterations (1.7.12).
+By default, <literal>purger_sleep</literal> is set to 50 milliseconds.
+</tag-desc>
+
+</list>
+</para>
+
 </directive>
 
 
@@ -425,6 +479,10 @@ the <http-status code="204" text="No Con
 If the <link id="proxy_cache_key">cache key</link> of a purge request ends
 with an asterisk (“<literal>*</literal>”), all cache entries matching the
 wildcard key will be removed from the cache.
+However, these entries will remain on the disk until they are deleted
+for either <link id="proxy_cache_path">inactivity</link>,
+or processed by the <link id="purger">cache purger</link> (1.7.12),
+or a client attempts to access them.
 </para>
 
 <para>