comparison xml/ru/docs/http/ngx_http_proxy_module.xml @ 3043:9eadb98ec770

Free nginx: removed commercial version documentation.
author Maxim Dounin <mdounin@mdounin.ru>
date Wed, 14 Feb 2024 20:05:49 +0300
parents 37e082fd009c
children
comparison
equal deleted inserted replaced
3042:19e4897acb84 3043:9eadb98ec770
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Модуль ngx_http_proxy_module" 10 <module name="Модуль ngx_http_proxy_module"
11 link="/ru/docs/http/ngx_http_proxy_module.html" 11 link="/ru/docs/http/ngx_http_proxy_module.html"
12 lang="ru" 12 lang="ru"
13 rev="76"> 13 rev="77">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 Модуль <literal>ngx_http_proxy_module</literal> позволяет передавать 18 Модуль <literal>ngx_http_proxy_module</literal> позволяет передавать
408 [<literal>manager_files</literal>=<value>число</value>] 408 [<literal>manager_files</literal>=<value>число</value>]
409 [<literal>manager_sleep</literal>=<value>время</value>] 409 [<literal>manager_sleep</literal>=<value>время</value>]
410 [<literal>manager_threshold</literal>=<value>время</value>] 410 [<literal>manager_threshold</literal>=<value>время</value>]
411 [<literal>loader_files</literal>=<value>число</value>] 411 [<literal>loader_files</literal>=<value>число</value>]
412 [<literal>loader_sleep</literal>=<value>время</value>] 412 [<literal>loader_sleep</literal>=<value>время</value>]
413 [<literal>loader_threshold</literal>=<value>время</value>] 413 [<literal>loader_threshold</literal>=<value>время</value>]</syntax>
414 [<literal>purger</literal>=<literal>on</literal>|<literal>off</literal>]
415 [<literal>purger_files</literal>=<value>число</value>]
416 [<literal>purger_sleep</literal>=<value>время</value>]
417 [<literal>purger_threshold</literal>=<value>время</value>]</syntax>
418 <default/> 414 <default/>
419 <context>http</context> 415 <context>http</context>
420 416
421 <para> 417 <para>
422 Задаёт путь и другие параметры кэша. 418 Задаёт путь и другие параметры кэша.
457 <para> 453 <para>
458 Кроме того, все активные ключи и информация о данных хранятся в зоне 454 Кроме того, все активные ключи и информация о данных хранятся в зоне
459 разделяемой памяти, <value>имя</value> и <value>размер</value> которой 455 разделяемой памяти, <value>имя</value> и <value>размер</value> которой
460 задаются параметром <literal>keys_zone</literal>. 456 задаются параметром <literal>keys_zone</literal>.
461 Зоны размером в 1 мегабайт достаточно для хранения около 8 тысяч ключей. 457 Зоны размером в 1 мегабайт достаточно для хранения около 8 тысяч ключей.
462 <note>
463 Как часть
464 <commercial_version>коммерческой подписки</commercial_version>
465 в зоне разделяемой памяти также хранится расширенная
466 <link doc="ngx_http_api_module.xml" id="http_caches_">информация</link> о кэше,
467 поэтому для хранения аналогичного количества ключей необходимо указывать
468 больший размер зоны.
469 Например
470 зоны размером в 1 мегабайт достаточно для хранения около 4 тысяч ключей.
471 </note>
472 </para> 458 </para>
473 459
474 <para> 460 <para>
475 Если к данным кэша не обращаются в течение времени, заданного параметром 461 Если к данным кэша не обращаются в течение времени, заданного параметром
476 <literal>inactive</literal>, то данные удаляются, независимо от их свежести. 462 <literal>inactive</literal>, то данные удаляются, независимо от их свежести.
509 Между итерациями делается пауза на время, заданное параметром 495 Между итерациями делается пауза на время, заданное параметром
510 <literal>loader_sleep</literal> (по умолчанию 50 миллисекунд). 496 <literal>loader_sleep</literal> (по умолчанию 50 миллисекунд).
511 </para> 497 </para>
512 498
513 <para> 499 <para>
514 Кроме того,
515 следующие параметры доступны как часть
516 <commercial_version>коммерческой подписки</commercial_version>:
517 </para>
518
519 <para>
520 <list type="tag">
521
522 <tag-name id="purger">
523 <literal>purger</literal>=<literal>on</literal>|<literal>off</literal>
524 </tag-name>
525 <tag-desc>
526 Указывает, будут ли записи в кэше, соответствующие
527 <link id="proxy_cache_purge">маске</link>,
528 удалены с диска при помощи процесса “cache purger” (1.7.12).
529 Установка параметра в значение <literal>on</literal>
530 (по умолчанию <literal>off</literal>)
531 активирует процесс “cache purger”, который
532 проходит по всем записям в кэше
533 и удаляет записи, соответствующие этой маске.
534 </tag-desc>
535
536 <tag-name id="purger_files">
537 <literal>purger_files</literal>=<value>число</value>
538 </tag-name>
539 <tag-desc>
540 Задаёт число элементов, которые будут сканироваться за одну итерацию (1.7.12).
541 По умолчанию <literal>purger_files</literal> равен 10.
542 </tag-desc>
543
544 <tag-name id="purger_threshold">
545 <literal>purger_threshold</literal>=<value>время</value>
546 </tag-name>
547 <tag-desc>
548 Задаёт продолжительность одной итерации (1.7.12).
549 По умолчанию <literal>purger_threshold</literal> равен 50 миллисекундам.
550 </tag-desc>
551
552 <tag-name id="purger_sleep">
553 <literal>purger_sleep</literal>=<value>время</value>
554 </tag-name>
555 <tag-desc>
556 Задаёт паузу между итерациями (1.7.12).
557 По умолчанию <literal>purger_sleep</literal> равен 50 миллисекундам.
558 </tag-desc>
559
560 </list>
561 </para>
562
563 <para>
564 <note> 500 <note>
565 В версиях 1.7.3, 1.7.7 и 1.11.10 формат заголовка кэша был изменён. 501 В версиях 1.7.3, 1.7.7 и 1.11.10 формат заголовка кэша был изменён.
566 При обновлении на более новую версию nginx 502 При обновлении на более новую версию nginx
567 ранее закэшированные ответы будут считаться недействительными. 503 ранее закэшированные ответы будут считаться недействительными.
568 </note>
569 </para>
570
571 </directive>
572
573
574 <directive name="proxy_cache_purge">
575 <syntax>строка ...</syntax>
576 <default/>
577 <context>http</context>
578 <context>server</context>
579 <context>location</context>
580 <appeared-in>1.5.7</appeared-in>
581
582 <para>
583 Задаёт условия, при которых запрос будет считаться запросом
584 на очистку кэша.
585 Если значение хотя бы одного из строковых параметров непустое и не равно “0”,
586 то запись в кэше с соответствующим
587 <link id="proxy_cache_key">ключом кэширования</link> удаляется.
588 В результате успешной операции возвращается ответ с кодом
589 <http-status code="204" text="No Content"/>.
590 </para>
591
592 <para>
593 Если <link id="proxy_cache_key">ключ кэширования</link>
594 запроса на очистку заканчивается
595 звёздочкой (“<literal>*</literal>”), то все записи в кэше, соответствующие
596 этой маске, будут удалены из кэша.
597 Тем не менее, эти записи будут оставаться на диске или до момента удаления
598 из-за <link id="proxy_cache_path">отсутствия обращения к данным</link>,
599 или до обработки их процессом “<link id="purger">cache purger</link>” (1.7.12),
600 или до попытки клиента получить к ним доступ.
601 </para>
602
603 <para>
604 Пример конфигурации:
605 <example>
606 proxy_cache_path /data/nginx/cache keys_zone=cache_zone:10m;
607
608 map $request_method $purge_method {
609 PURGE 1;
610 default 0;
611 }
612
613 server {
614 ...
615 location / {
616 proxy_pass http://backend;
617 proxy_cache cache_zone;
618 proxy_cache_key $uri;
619 proxy_cache_purge $purge_method;
620 }
621 }
622 </example>
623 <note>
624 Функциональность доступна как часть
625 <commercial_version>коммерческой подписки</commercial_version>.
626 </note> 504 </note>
627 </para> 505 </para>
628 506
629 </directive> 507 </directive>
630 508