comparison xml/ru/docs/http/ngx_http_scgi_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 4add6ae1296f
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_scgi_module" 10 <module name="Модуль ngx_http_scgi_module"
11 link="/ru/docs/http/ngx_http_scgi_module.html" 11 link="/ru/docs/http/ngx_http_scgi_module.html"
12 lang="ru" 12 lang="ru"
13 rev="41"> 13 rev="42">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 Модуль <literal>ngx_http_scgi_module</literal> позволяет передавать 18 Модуль <literal>ngx_http_scgi_module</literal> позволяет передавать
382 [<literal>manager_files</literal>=<value>число</value>] 382 [<literal>manager_files</literal>=<value>число</value>]
383 [<literal>manager_sleep</literal>=<value>время</value>] 383 [<literal>manager_sleep</literal>=<value>время</value>]
384 [<literal>manager_threshold</literal>=<value>время</value>] 384 [<literal>manager_threshold</literal>=<value>время</value>]
385 [<literal>loader_files</literal>=<value>число</value>] 385 [<literal>loader_files</literal>=<value>число</value>]
386 [<literal>loader_sleep</literal>=<value>время</value>] 386 [<literal>loader_sleep</literal>=<value>время</value>]
387 [<literal>loader_threshold</literal>=<value>время</value>] 387 [<literal>loader_threshold</literal>=<value>время</value>]</syntax>
388 [<literal>purger</literal>=<literal>on</literal>|<literal>off</literal>]
389 [<literal>purger_files</literal>=<value>число</value>]
390 [<literal>purger_sleep</literal>=<value>время</value>]
391 [<literal>purger_threshold</literal>=<value>время</value>]</syntax>
392 <default/> 388 <default/>
393 <context>http</context> 389 <context>http</context>
394 390
395 <para> 391 <para>
396 Задаёт путь и другие параметры кэша. 392 Задаёт путь и другие параметры кэша.
431 <para> 427 <para>
432 Кроме того, все активные ключи и информация о данных хранятся в зоне 428 Кроме того, все активные ключи и информация о данных хранятся в зоне
433 разделяемой памяти, <value>имя</value> и <value>размер</value> которой 429 разделяемой памяти, <value>имя</value> и <value>размер</value> которой
434 задаются параметром <literal>keys_zone</literal>. 430 задаются параметром <literal>keys_zone</literal>.
435 Зоны размером в 1 мегабайт достаточно для хранения около 8 тысяч ключей. 431 Зоны размером в 1 мегабайт достаточно для хранения около 8 тысяч ключей.
436 <note>
437 Как часть
438 <commercial_version>коммерческой подписки</commercial_version>
439 в зоне разделяемой памяти также хранится расширенная
440 <link doc="ngx_http_api_module.xml" id="http_caches_">информация</link> о кэше,
441 поэтому для хранения аналогичного количества ключей необходимо указывать
442 больший размер зоны.
443 Например
444 зоны размером в 1 мегабайт достаточно для хранения около 4 тысяч ключей.
445 </note>
446 </para> 432 </para>
447 433
448 <para> 434 <para>
449 Если к данным кэша не обращаются в течение времени, заданного параметром 435 Если к данным кэша не обращаются в течение времени, заданного параметром
450 <literal>inactive</literal>, то данные удаляются, независимо от их свежести. 436 <literal>inactive</literal>, то данные удаляются, независимо от их свежести.
483 Между итерациями делается пауза на время, заданное параметром 469 Между итерациями делается пауза на время, заданное параметром
484 <literal>loader_sleep</literal> (по умолчанию 50 миллисекунд). 470 <literal>loader_sleep</literal> (по умолчанию 50 миллисекунд).
485 </para> 471 </para>
486 472
487 <para> 473 <para>
488 Кроме того,
489 следующие параметры доступны как часть
490 <commercial_version>коммерческой подписки</commercial_version>:
491 </para>
492
493 <para>
494 <list type="tag">
495
496 <tag-name id="purger">
497 <literal>purger</literal>=<literal>on</literal>|<literal>off</literal>
498 </tag-name>
499 <tag-desc>
500 Указывает, будут ли записи в кэше, соответствующие
501 <link id="scgi_cache_purge">маске</link>,
502 удалены с диска при помощи процесса “cache purger” (1.7.12).
503 Установка параметра в значение <literal>on</literal>
504 (по умолчанию <literal>off</literal>)
505 активирует процесс “cache purger”, который
506 проходит по всем записям в кэше
507 и удаляет записи, соответствующие этой маске.
508 </tag-desc>
509
510 <tag-name id="purger_files">
511 <literal>purger_files</literal>=<value>число</value>
512 </tag-name>
513 <tag-desc>
514 Задаёт число элементов, которые будут сканироваться за одну итерацию (1.7.12).
515 По умолчанию <literal>purger_files</literal> равен 10.
516 </tag-desc>
517
518 <tag-name id="purger_threshold">
519 <literal>purger_threshold</literal>=<value>время</value>
520 </tag-name>
521 <tag-desc>
522 Задаёт продолжительность одной итерации (1.7.12).
523 По умолчанию <literal>purger_threshold</literal> равен 50 миллисекундам.
524 </tag-desc>
525
526 <tag-name id="purger_sleep">
527 <literal>purger_sleep</literal>=<value>время</value>
528 </tag-name>
529 <tag-desc>
530 Задаёт паузу между итерациями (1.7.12).
531 По умолчанию <literal>purger_sleep</literal> равен 50 миллисекундам.
532 </tag-desc>
533
534 </list>
535 </para>
536
537 <para>
538 <note> 474 <note>
539 В версиях 1.7.3, 1.7.7 и 1.11.10 формат заголовка кэша был изменён. 475 В версиях 1.7.3, 1.7.7 и 1.11.10 формат заголовка кэша был изменён.
540 При обновлении на более новую версию nginx 476 При обновлении на более новую версию nginx
541 ранее закэшированные ответы будут считаться недействительными. 477 ранее закэшированные ответы будут считаться недействительными.
542 </note>
543 </para>
544
545 </directive>
546
547
548 <directive name="scgi_cache_purge">
549 <syntax>строка ...</syntax>
550 <default/>
551 <context>http</context>
552 <context>server</context>
553 <context>location</context>
554 <appeared-in>1.5.7</appeared-in>
555
556 <para>
557 Задаёт условия, при которых запрос будет считаться запросом
558 на очистку кэша.
559 Если значение хотя бы одного из строковых параметров непустое и не равно “0”,
560 то запись в кэше с соответствующим
561 <link id="scgi_cache_key">ключом кэширования</link> удаляется.
562 В результате успешной операции возвращается ответ с кодом
563 <http-status code="204" text="No Content"/>.
564 </para>
565
566 <para>
567 Если <link id="scgi_cache_key">ключ кэширования</link>
568 запроса на очистку заканчивается
569 звёздочкой (“<literal>*</literal>”), то все записи в кэше, соответствующие
570 этой маске, будут удалены из кэша.
571 Тем не менее, эти записи будут оставаться на диске или до момента удаления
572 из-за <link id="scgi_cache_path">отсутствия обращения к данным</link>,
573 или до обработки их процессом “<link id="purger">cache purger</link>” (1.7.12),
574 или до попытки клиента получить к ним доступ.
575 </para>
576
577 <para>
578 Пример конфигурации:
579 <example>
580 scgi_cache_path /data/nginx/cache keys_zone=cache_zone:10m;
581
582 map $request_method $purge_method {
583 PURGE 1;
584 default 0;
585 }
586
587 server {
588 ...
589 location / {
590 scgi_pass http://backend;
591 scgi_cache cache_zone;
592 scgi_cache_key $uri;
593 scgi_cache_purge $purge_method;
594 }
595 }
596 </example>
597 <note>
598 Функциональность доступна как часть
599 <commercial_version>коммерческой подписки</commercial_version>.
600 </note> 478 </note>
601 </para> 479 </para>
602 480
603 </directive> 481 </directive>
604 482