comparison xml/ru/docs/http/ngx_http_proxy_module.xml @ 271:4c6d2c614d2c

Cleaned up XML tag mess: - all of <parameter> and <code>, and some of <dirname>, <value>, and <command> were replaced by <literal>; - the rest of <dirname> were replaced by links; - <argument> were replaced by <value>; - <value> is now rendered in HTML in italic; - <literal> and <path> can now contain <value>. Cleaned up terminology mess: - directives take "parameters".
author Ruslan Ermilov <ru@nginx.com>
date Fri, 23 Dec 2011 17:29:59 +0000
parents c78b2d6fe261
children 44ab4026d9f5
comparison
equal deleted inserted replaced
270:945d7299c26c 271:4c6d2c614d2c
47 47
48 </directive> 48 </directive>
49 49
50 50
51 <directive name="proxy_buffering"> 51 <directive name="proxy_buffering">
52 <syntax><value>on|off</value></syntax> 52 <syntax><literal>on</literal> | <literal>off</literal></syntax>
53 <default>on</default> 53 <default>on</default>
54 <context>http, server, location</context> 54 <context>http, server, location</context>
55 55
56 <para> 56 <para>
57 Директива разрешает использовать буферизацию ответа проксируемого сервера. 57 Директива разрешает использовать буферизацию ответа проксируемого сервера.
70 70
71 </directive> 71 </directive>
72 72
73 73
74 <directive name="proxy_buffers"> 74 <directive name="proxy_buffers">
75 <syntax><value>число размер</value></syntax> 75 <syntax><value>число</value> <value>размер</value></syntax>
76 <default>8 4k/8k</default> 76 <default>8 4k/8k</default>
77 <context>http, server, location</context> 77 <context>http, server, location</context>
78 78
79 <para> 79 <para>
80 Директива задаёт число и размер буферов для одного соединения, 80 Директива задаёт число и размер буферов для одного соединения,
85 85
86 </directive> 86 </directive>
87 87
88 88
89 <directive name="proxy_cache"> 89 <directive name="proxy_cache">
90 <syntax><value>[зона|off]</value></syntax> 90 <syntax><value>зона</value> | <literal>off</literal></syntax>
91 <default>off</default> 91 <default>off</default>
92 <context>http, server, location</context> 92 <context>http, server, location</context>
93 93
94 <para> 94 <para>
95 Директива задаёт зону для кэширования. 95 Директива задаёт зону для кэширования.
100 100
101 </directive> 101 </directive>
102 102
103 103
104 <directive name="proxy_cache_bypass"> 104 <directive name="proxy_cache_bypass">
105 <syntax><value>строка [...]</value></syntax> 105 <syntax><value>строка</value> ...</syntax>
106 <default/> 106 <default/>
107 <context>http, server, location</context> 107 <context>http, server, location</context>
108 108
109 <para> 109 <para>
110 Директива задаёт условия, при которых ответ не будет браться из кэша. 110 Директива задаёт условия, при которых ответ не будет браться из кэша.
138 138
139 </directive> 139 </directive>
140 140
141 141
142 <directive name="proxy_cache_path"> 142 <directive name="proxy_cache_path">
143 <syntax><value>путь [levels=уровни] 143 <syntax>
144 keys_zone=название:размер [inactive=время] [max_size=размер]</value></syntax> 144 <value>путь</value>
145 [<literal>levels</literal>=<value>уровни</value>]
146 <literal>keys_zone</literal>=<value>название</value>:<value>размер</value>
147 [<literal>inactive</literal>=<value>время</value>]
148 [<literal>max_size</literal>=<value>размер</value>]</syntax>
145 <default/> 149 <default/>
146 <context>http</context> 150 <context>http</context>
147 151
148 <para> 152 <para>
149 Директива задаёт путь и другие параметры кэша. Данные кэша хранятся в файлах. 153 Директива задаёт путь и другие параметры кэша. Данные кэша хранятся в файлах.
199 203
200 </directive> 204 </directive>
201 205
202 206
203 <directive name="proxy_cache_valid"> 207 <directive name="proxy_cache_valid">
204 <syntax><value>ответ [ответ ...] время</value> 208 <syntax><value>ответ</value> ... <value>время</value></syntax>
205 </syntax>
206 <default/> 209 <default/>
207 <context>http, server, location</context> 210 <context>http, server, location</context>
208 211
209 <para> 212 <para>
210 Директива задаёт время кэширования для разных ответов. 213 Директива задаёт время кэширования для разных ответов.
236 239
237 </directive> 240 </directive>
238 241
239 242
240 <directive name="proxy_cache_use_stale"> 243 <directive name="proxy_cache_use_stale">
241 <syntax><value>[error | timeout | invalid_header 244 <syntax>
242 | updating | http_500 | http_502 | http_503 | http_504 | http_404 | off] 245 <literal>error</literal> |
243 [...]</value></syntax> 246 <literal>timeout</literal> |
247 <literal>invalid_header</literal> |
248 <literal>updating</literal> |
249 <literal>http_500</literal> |
250 <literal>http_502</literal> |
251 <literal>http_503</literal> |
252 <literal>http_504</literal> |
253 <literal>http_404</literal> |
254 <literal>off</literal>
255 ...</syntax>
244 <default>off</default> 256 <default>off</default>
245 <context>http, server, location</context> 257 <context>http, server, location</context>
246 258
247 <para> 259 <para>
248 Директива определяет, в каких случаях можно использовать 260 Директива определяет, в каких случаях можно использовать
284 296
285 </directive> 297 </directive>
286 298
287 299
288 <directive name="proxy_ignore_client_abort"> 300 <directive name="proxy_ignore_client_abort">
289 <syntax><value>[on|off]</value></syntax> 301 <syntax><literal>on</literal> | <literal>off</literal></syntax>
290 <default>off</default> 302 <default>off</default>
291 <context>http, server, location</context> 303 <context>http, server, location</context>
292 304
293 <para> 305 <para>
294 Директива определяет, закрывать ли соединение с проксированным сервером 306 Директива определяет, закрывать ли соединение с проксированным сервером
297 309
298 </directive> 310 </directive>
299 311
300 312
301 <directive name="proxy_ignore_headers"> 313 <directive name="proxy_ignore_headers">
302 <syntax><value>имя [имя ...]</value></syntax> 314 <syntax><value>имя</value> ...</syntax>
303 <default/> 315 <default/>
304 <context>http, server, location</context> 316 <context>http, server, location</context>
305 317
306 <para> 318 <para>
307 Директива proxy_ignore_headers запрещает обработку некоторых 319 Директива proxy_ignore_headers запрещает обработку некоторых
313 325
314 </directive> 326 </directive>
315 327
316 328
317 <directive name="proxy_intercept_errors"> 329 <directive name="proxy_intercept_errors">
318 <syntax><value>[on|off]</value></syntax> 330 <syntax><literal>on</literal> | <literal>off</literal></syntax>
319 <default>off</default> 331 <default>off</default>
320 <context>http, server, location</context> 332 <context>http, server, location</context>
321 333
322 <para> 334 <para>
323 Директива определяет, передавать ли клиенту проксированные ответы с кодом 335 Директива определяет, передавать ли клиенту проксированные ответы с кодом
327 339
328 </directive> 340 </directive>
329 341
330 342
331 <directive name="proxy_next_upstream"> 343 <directive name="proxy_next_upstream">
332 <syntax><value>[error | timeout | invalid_header 344 <syntax>
333 | http_500 | http_502 | http_503 | http_504 | http_404 | off] 345 <literal>error</literal> |
334 [...]</value></syntax> 346 <literal>timeout</literal> |
347 <literal>invalid_header</literal> |
348 <literal>http_500</literal> |
349 <literal>http_502</literal> |
350 <literal>http_503</literal> |
351 <literal>http_504</literal> |
352 <literal>http_404</literal> |
353 <literal>off</literal>
354 ...</syntax>
335 <default>error timeout</default> 355 <default>error timeout</default>
336 <context>http, server, location</context> 356 <context>http, server, location</context>
337 357
338 <para> 358 <para>
339 Директива определяет, в каких случаях запрос будет передан следующему серверу: 359 Директива определяет, в каких случаях запрос будет передан следующему серверу:
389 409
390 </directive> 410 </directive>
391 411
392 412
393 <directive name="proxy_no_cache"> 413 <directive name="proxy_no_cache">
394 <syntax><value>строка [...]</value></syntax> 414 <syntax><value>строка</value> ...</syntax>
395 <default/> 415 <default/>
396 <context>http, server, location</context> 416 <context>http, server, location</context>
397 417
398 <para> 418 <para>
399 Директива задаёт условия, при которых ответ не будет сохраняться в кэш. 419 Директива задаёт условия, при которых ответ не будет сохраняться в кэш.
527 </directive> 547 </directive>
528 548
529 549
530 <directive name="proxy_redirect"> 550 <directive name="proxy_redirect">
531 <syntax> 551 <syntax>
532 <value>default</value> | 552 <literal>default</literal> |
533 <value>off</value> | 553 <literal>off</literal> |
534 <argument>перенаправление замена</argument> 554 <value>перенаправление</value> <value>замена</value></syntax>
535 </syntax>
536 <default>default</default> 555 <default>default</default>
537 <context>http</context> 556 <context>http</context>
538 <context>server</context> 557 <context>server</context>
539 <context>location</context> 558 <context>location</context>
540 559
559 </example> 578 </example>
560 тогда будет подставлено основное имя сервера и порт, если он отличен от 80. 579 тогда будет подставлено основное имя сервера и порт, если он отличен от 80.
561 </para> 580 </para>
562 581
563 <para> 582 <para>
564 Изменение по умолчанию, задаваемое значением <value>default</value>, использует 583 Изменение по умолчанию, задаваемое значением <literal>default</literal>, использует
565 параметры директив <link doc="ngx_http_core_module.xml" id="location"/> и 584 параметры директив <link doc="ngx_http_core_module.xml" id="location"/> и
566 <link id="proxy_pass"/>. 585 <link id="proxy_pass"/>.
567 Поэтому две нижеприведённые конфигурации одинаковы: 586 Поэтому две нижеприведённые конфигурации одинаковы:
568 <example> 587 <example>
569 location /one/ { 588 location /one/ {
574 <example> 593 <example>
575 location /one/ { 594 location /one/ {
576 proxy_pass http://upstream:port/two/; 595 proxy_pass http://upstream:port/two/;
577 proxy_redirect http://upstream:port/two/ /one/; 596 proxy_redirect http://upstream:port/two/ /one/;
578 </example> 597 </example>
579 Значение <value>default</value> недопустимо, если в <link id="proxy_pass"/> 598 Значение <literal>default</literal> недопустимо, если в <link id="proxy_pass"/>
580 используются переменные. 599 используются переменные.
581 </para> 600 </para>
582 601
583 <para> 602 <para>
584 В заменяемой строке можно использовать переменные: 603 В заменяемой строке можно использовать переменные:
594 </example> 613 </example>
595 </para> 614 </para>
596 615
597 <para> 616 <para>
598 Директиву также можно задать (1.1.11) при помощи регулярных выражений. 617 Директиву также можно задать (1.1.11) при помощи регулярных выражений.
599 При этом <argument>перенаправление</argument> должен начинаться либо с символа 618 При этом <value>перенаправление</value> должно начинаться либо с символа
600 “<code>~</code>”, если при сравнении следует учитывать регистр символов, 619 “<literal>~</literal>”, если при сравнении следует учитывать регистр символов,
601 либо с символов “<code>~*</code>”, если регистр символов учитывать не нужно. 620 либо с символов “<literal>~*</literal>”, если регистр символов учитывать
621 не нужно.
602 Регулярное выражение может содержать именованные и позиционные выделения, 622 Регулярное выражение может содержать именованные и позиционные выделения,
603 а <argument>замена</argument> на них ссылаться: 623 а <value>замена</value> ссылаться на них:
604 <example> 624 <example>
605 proxy_redirect ~^(http://[^:]+):\d+(/.+)$ $1$2; 625 proxy_redirect ~^(http://[^:]+):\d+(/.+)$ $1$2;
606 proxy_redirect ~*/user/([^/]+)/(.+)$ http://$1.example.com/$2; 626 proxy_redirect ~*/user/([^/]+)/(.+)$ http://$1.example.com/$2;
607 </example> 627 </example>
608 </para> 628 </para>
615 proxy_redirect http://www.example.com/ /; 635 proxy_redirect http://www.example.com/ /;
616 </example> 636 </example>
617 </para> 637 </para>
618 638
619 <para> 639 <para>
620 Значение <value>off</value> запрещает все директивы <code>proxy_redirect</code> 640 Значение <literal>off</literal> запрещает все директивы
641 <literal>proxy_redirect</literal>
621 на данном уровне: 642 на данном уровне:
622 <example> 643 <example>
623 proxy_redirect off; 644 proxy_redirect off;
624 proxy_redirect default; 645 proxy_redirect default;
625 proxy_redirect http://localhost:8000/ /; 646 proxy_redirect http://localhost:8000/ /;
669 690
670 </directive> 691 </directive>
671 692
672 693
673 <directive name="proxy_set_header"> 694 <directive name="proxy_set_header">
674 <syntax><value>заголовок значение</value></syntax> 695 <syntax><value>заголовок</value> <value>значение</value></syntax>
675 <default>Host $proxy_host</default> 696 <default>Host $proxy_host</default>
676 <default>Connection close</default> 697 <default>Connection close</default>
677 <context>http, server, location</context> 698 <context>http, server, location</context>
678 699
679 <para> 700 <para>
723 744
724 </directive> 745 </directive>
725 746
726 747
727 <directive name="proxy_ssl_session_reuse"> 748 <directive name="proxy_ssl_session_reuse">
728 <syntax><value>[on|off]</value></syntax> 749 <syntax><literal>on</literal> | <literal>off</literal></syntax>
729 <default>on</default> 750 <default>on</default>
730 <context>http, server, location</context> 751 <context>http, server, location</context>
731 752
732 <para> 753 <para>
733 Директива определяет, использовать ли повторно SSL-сессии при 754 Директива определяет, использовать ли повторно SSL-сессии при
738 759
739 </directive> 760 </directive>
740 761
741 762
742 <directive name="proxy_store"> 763 <directive name="proxy_store">
743 <syntax><value>on | off | строка </value></syntax> 764 <syntax><literal>on</literal> | <literal>off</literal> | <value>строка</value></syntax>
744 <default>off</default> 765 <default>off</default>
745 <context>http, server, location</context> 766 <context>http, server, location</context>
746 767
747 <para> 768 <para>
748 Директива разрешает сохранение на диск файлов. 769 Директива разрешает сохранение на диск файлов.
815 836
816 </directive> 837 </directive>
817 838
818 839
819 <directive name="proxy_store_access"> 840 <directive name="proxy_store_access">
820 <syntax><value>пользователи:права [пользователи:права] 841 <syntax><value>пользователи</value>:<value>права</value> ...</syntax>
821 ...</value></syntax>
822 <default>user:rw</default> 842 <default>user:rw</default>
823 <context>http, server, location</context> 843 <context>http, server, location</context>
824 844
825 <para> 845 <para>
826 Директива задаёт права доступа для создаваемых файлов и каталогов, например, 846 Директива задаёт права доступа для создаваемых файлов и каталогов, например,
839 859
840 </directive> 860 </directive>
841 861
842 862
843 <directive name="proxy_temp_path"> 863 <directive name="proxy_temp_path">
844 <syntax><value>путь [ уровень1 [ уровень2 [ уровень3 ] ] ] 864 <syntax><value>путь</value> [<value>уровень1</value> [<value>уровень2</value> [<value>уровень3</value>]]]</syntax>
845 </value></syntax>
846 <default>proxy_temp</default> 865 <default>proxy_temp</default>
847 <context>http, server, location</context> 866 <context>http, server, location</context>
848 867
849 <para> 868 <para>
850 Директива задаёт имя каталога для хранения временных файлов 869 Директива задаёт имя каталога для хранения временных файлов