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

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
comparison
equal deleted inserted replaced
1581:201bf8fa69e5 1582:8973c7b37854
325 <literal>keys_zone</literal>=<value>name</value>:<value>size</value> 325 <literal>keys_zone</literal>=<value>name</value>:<value>size</value>
326 [<literal>inactive</literal>=<value>time</value>] 326 [<literal>inactive</literal>=<value>time</value>]
327 [<literal>max_size</literal>=<value>size</value>] 327 [<literal>max_size</literal>=<value>size</value>]
328 [<literal>loader_files</literal>=<value>number</value>] 328 [<literal>loader_files</literal>=<value>number</value>]
329 [<literal>loader_sleep</literal>=<value>time</value>] 329 [<literal>loader_sleep</literal>=<value>time</value>]
330 [<literal>loader_threshold</literal>=<value>time</value>]</syntax> 330 [<literal>loader_threshold</literal>=<value>time</value>]
331 [<literal>purger</literal>=<literal>on</literal>|<literal>off</literal>]
332 [<literal>purger_files</literal>=<value>number</value>]
333 [<literal>purger_sleep</literal>=<value>time</value>]
334 [<literal>purger_threshold</literal>=<value>time</value>]</syntax>
331 <default/> 335 <default/>
332 <context>http</context> 336 <context>http</context>
333 337
334 <para> 338 <para>
335 Sets the path and other parameters of a cache. 339 Sets the path and other parameters of a cache.
398 <literal>loader_threshold</literal> parameter (by default, 200 milliseconds). 402 <literal>loader_threshold</literal> parameter (by default, 200 milliseconds).
399 Between iterations, a pause configured by the <literal>loader_sleep</literal> 403 Between iterations, a pause configured by the <literal>loader_sleep</literal>
400 parameter (by default, 50 milliseconds) is made. 404 parameter (by default, 50 milliseconds) is made.
401 </para> 405 </para>
402 406
407 <para>
408 Additionally,
409 the following parameters are available as part of our
410 <commercial_version>commercial subscription</commercial_version>:
411 </para>
412
413 <para>
414 <list type="tag">
415
416 <tag-name id="purger">
417 <literal>purger</literal>=<literal>on</literal>|<literal>off</literal>
418 </tag-name>
419 <tag-desc>
420 Instructs whether cache entries that match a
421 <link id="proxy_cache_purge">wildcard key</link>
422 will be removed from the disk by the cache purger (1.7.12).
423 Setting the parameter to <literal>on</literal>
424 (default is <literal>off</literal>)
425 will activate the “cache purger” process that
426 permanently iterates through all cache entries
427 and deletes the entries that match the wildcard key.
428 </tag-desc>
429
430 <tag-name id="purger_files">
431 <literal>purger_files</literal>=<value>number</value>
432 </tag-name>
433 <tag-desc>
434 Sets the number of items that will be scanned during one iteration (1.7.12).
435 By default, <literal>purger_files</literal> is set to 10.
436 </tag-desc>
437
438 <tag-name id="purger_threshold">
439 <literal>purger_threshold</literal>=<value>number</value>
440 </tag-name>
441 <tag-desc>
442 Sets the duration of one iteration (1.7.12).
443 By default, <literal>purger_threshold</literal> is set to 50 milliseconds.
444 </tag-desc>
445
446 <tag-name id="purger_sleep">
447 <literal>purger_sleep</literal>=<value>number</value>
448 </tag-name>
449 <tag-desc>
450 Sets a pause between iterations (1.7.12).
451 By default, <literal>purger_sleep</literal> is set to 50 milliseconds.
452 </tag-desc>
453
454 </list>
455 </para>
456
403 </directive> 457 </directive>
404 458
405 459
406 <directive name="proxy_cache_purge"> 460 <directive name="proxy_cache_purge">
407 <syntax>string ...</syntax> 461 <syntax>string ...</syntax>
423 477
424 <para> 478 <para>
425 If the <link id="proxy_cache_key">cache key</link> of a purge request ends 479 If the <link id="proxy_cache_key">cache key</link> of a purge request ends
426 with an asterisk (“<literal>*</literal>”), all cache entries matching the 480 with an asterisk (“<literal>*</literal>”), all cache entries matching the
427 wildcard key will be removed from the cache. 481 wildcard key will be removed from the cache.
482 However, these entries will remain on the disk until they are deleted
483 for either <link id="proxy_cache_path">inactivity</link>,
484 or processed by the <link id="purger">cache purger</link> (1.7.12),
485 or a client attempts to access them.
428 </para> 486 </para>
429 487
430 <para> 488 <para>
431 Example configuration: 489 Example configuration:
432 <example> 490 <example>