comparison xml/ru/docs/http/ngx_http_proxy_module.xml @ 102:c76a257f3fd4

The directive name is now automatically printed in <default> and <syntax>. Specifying <default> is made non-optional. Visible changes: - "types" and "proxy_set_header" get proper defaults (not yet displayed nicely); - "fastcgi_hide_header", "fastcgi_ignore_headers", "fastcgi_pass_header", "proxy_hide_header", "proxy_ignore_headers", and "proxy_pass_header" now have their (empty) defaults documented; - mentions of "fastcgi_redirect_errors" and "proxy_redirect_errors" which are long unsupported were removed.
author Ruslan Ermilov <ru@nginx.com>
date Wed, 19 Oct 2011 05:15:24 +0000
parents 1d315ef37215
children 56457a474903
comparison
equal deleted inserted replaced
101:b8fd014ec712 102:c76a257f3fd4
31 31
32 32
33 <section name="Директивы" id="directives"> 33 <section name="Директивы" id="directives">
34 34
35 <directive name="proxy_buffer_size"> 35 <directive name="proxy_buffer_size">
36 <syntax>proxy_buffer_size <value>размер</value></syntax> 36 <syntax><value>размер</value></syntax>
37 <default>proxy_buffer_size 4k/8k</default> 37 <default>4k/8k</default>
38 <context>http, server, location</context> 38 <context>http, server, location</context>
39 39
40 <para> 40 <para>
41 Директива задаёт размер буфера, в который будет читаться 41 Директива задаёт размер буфера, в который будет читаться
42 первая часть ответа, получаемого от проксируемого сервера. 42 первая часть ответа, получаемого от проксируемого сервера.
47 47
48 </directive> 48 </directive>
49 49
50 50
51 <directive name="proxy_buffering"> 51 <directive name="proxy_buffering">
52 <syntax>proxy_buffering <value>on|off</value></syntax> 52 <syntax><value>on|off</value></syntax>
53 <default>proxy_buffering 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 Директива разрешает использовать буферизацию ответа проксируемого сервера.
58 Если буферизация включена, то nginx принимает ответ проксируемого сервера 58 Если буферизация включена, то nginx принимает ответ проксируемого сервера
70 70
71 </directive> 71 </directive>
72 72
73 73
74 <directive name="proxy_buffers"> 74 <directive name="proxy_buffers">
75 <syntax>proxy_buffers <value>число размер</value></syntax> 75 <syntax><value>число размер</value></syntax>
76 <default>proxy_buffers 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 Директива задаёт число и размер буферов для одного соединения,
81 в которые будет читаться ответ, получаемый от проксируемого сервера. 81 в которые будет читаться ответ, получаемый от проксируемого сервера.
85 85
86 </directive> 86 </directive>
87 87
88 88
89 <directive name="proxy_cache"> 89 <directive name="proxy_cache">
90 <syntax>proxy_cache <value>[зона|off]</value></syntax> 90 <syntax><value>[зона|off]</value></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>proxy_cache_bypass <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 Директива задаёт условия, при которых ответ не будет браться из кэша.
119 119
120 </directive> 120 </directive>
121 121
122 122
123 <directive name="proxy_cache_key"> 123 <directive name="proxy_cache_key">
124 <syntax>proxy_cache_key <value>строка</value></syntax> 124 <syntax><value>строка</value></syntax>
125 <default>$scheme$proxy_host$request_uri</default> 125 <default>$scheme$proxy_host$request_uri</default>
126 <context>http, server, location</context> 126 <context>http, server, location</context>
127 127
128 <para> 128 <para>
129 Директива задаёт ключ для кэширования, например, 129 Директива задаёт ключ для кэширования, например,
138 138
139 </directive> 139 </directive>
140 140
141 141
142 <directive name="proxy_cache_path"> 142 <directive name="proxy_cache_path">
143 <syntax>proxy_cache_path <value>путь [levels=уровни] 143 <syntax><value>путь [levels=уровни]
144 keys_zone=название:размер [inactive=время] [max_size=размер]</value></syntax> 144 keys_zone=название:размер [inactive=время] [max_size=размер]</value></syntax>
145 <default/> 145 <default/>
146 <context>http</context> 146 <context>http</context>
147 147
148 <para> 148 <para>
186 186
187 </directive> 187 </directive>
188 188
189 189
190 <directive name="proxy_cache_min_uses"> 190 <directive name="proxy_cache_min_uses">
191 <syntax>proxy_cache_min_uses <value>число</value></syntax> 191 <syntax><value>число</value></syntax>
192 <default>proxy_cache_min_uses 1</default> 192 <default>1</default>
193 <context>http, server, location</context> 193 <context>http, server, location</context>
194 194
195 <para> 195 <para>
196 Директива задаёт число запросов, после которого ответ будет 196 Директива задаёт число запросов, после которого ответ будет
197 закэширован. 197 закэширован.
199 199
200 </directive> 200 </directive>
201 201
202 202
203 <directive name="proxy_cache_valid"> 203 <directive name="proxy_cache_valid">
204 <syntax>proxy_cache_valid <value>ответ [ответ ...] время</value> 204 <syntax><value>ответ [ответ ...] время</value>
205 </syntax> 205 </syntax>
206 <default/> 206 <default/>
207 <context>http, server, location</context> 207 <context>http, server, location</context>
208 208
209 <para> 209 <para>
236 236
237 </directive> 237 </directive>
238 238
239 239
240 <directive name="proxy_cache_use_stale"> 240 <directive name="proxy_cache_use_stale">
241 <syntax>proxy_cache_use_stale <value>[error | timeout | invalid_header 241 <syntax><value>[error | timeout | invalid_header
242 | updating | http_500 | http_502 | http_503 | http_504 | http_404 | off] 242 | updating | http_500 | http_502 | http_503 | http_504 | http_404 | off]
243 [...]</value></syntax> 243 [...]</value></syntax>
244 <default>proxy_cache_use_stale off</default> 244 <default>off</default>
245 <context>http, server, location</context> 245 <context>http, server, location</context>
246 246
247 <para> 247 <para>
248 Директива определяет, в каких случаях можно использовать 248 Директива определяет, в каких случаях можно использовать
249 устаревший закэшированный ответ, если при работе с проксированным 249 устаревший закэшированный ответ, если при работе с проксированным
255 255
256 </directive> 256 </directive>
257 257
258 258
259 <directive name="proxy_connect_timeout"> 259 <directive name="proxy_connect_timeout">
260 <syntax>proxy_connect_timeout <value>время</value></syntax> 260 <syntax><value>время</value></syntax>
261 <default>proxy_connect_timeout 60</default> 261 <default>60</default>
262 <context>http, server, location</context> 262 <context>http, server, location</context>
263 263
264 <para> 264 <para>
265 Директива задаёт таймаут для соединения с проксированным сервером. 265 Директива задаёт таймаут для соединения с проксированным сервером.
266 Необходимо иметь в виду, что этот таймаут не может быть больше 75 секунд. 266 Необходимо иметь в виду, что этот таймаут не может быть больше 75 секунд.
268 268
269 </directive> 269 </directive>
270 270
271 271
272 <directive name="proxy_hide_header"> 272 <directive name="proxy_hide_header">
273 <syntax>proxy_hide_header <value>имя</value></syntax> 273 <syntax><value>имя</value></syntax>
274 <default/>
274 <context>http, server, location</context> 275 <context>http, server, location</context>
275 276
276 <para> 277 <para>
277 nginx не передаёт клиенту строки заголовка "Date", "Server", "X-Pad" и 278 nginx не передаёт клиенту строки заголовка "Date", "Server", "X-Pad" и
278 "X-Accel-..." из ответа проксированного сервера. 279 "X-Accel-..." из ответа проксированного сервера.
283 284
284 </directive> 285 </directive>
285 286
286 287
287 <directive name="proxy_ignore_client_abort"> 288 <directive name="proxy_ignore_client_abort">
288 <syntax>proxy_ignore_client_abort <value>[on|off]</value></syntax> 289 <syntax><value>[on|off]</value></syntax>
289 <default>proxy_ignore_client_abort off</default> 290 <default>off</default>
290 <context>http, server, location</context> 291 <context>http, server, location</context>
291 292
292 <para> 293 <para>
293 Директива определяет, закрывать ли соединение с проксированным сервером 294 Директива определяет, закрывать ли соединение с проксированным сервером
294 в случае, если клиент закрыл соединение, не дождавшись ответа. 295 в случае, если клиент закрыл соединение, не дождавшись ответа.
296 297
297 </directive> 298 </directive>
298 299
299 300
300 <directive name="proxy_ignore_headers"> 301 <directive name="proxy_ignore_headers">
301 <syntax>proxy_ignore_headers <value>имя [имя ...]</value></syntax> 302 <syntax><value>имя [имя ...]</value></syntax>
303 <default/>
302 <context>http, server, location</context> 304 <context>http, server, location</context>
303 305
304 <para> 306 <para>
305 Директива proxy_ignore_headers запрещает обработку некоторых 307 Директива proxy_ignore_headers запрещает обработку некоторых
306 строк заголовка из ответа проксированного сервера. 308 строк заголовка из ответа проксированного сервера.
311 313
312 </directive> 314 </directive>
313 315
314 316
315 <directive name="proxy_intercept_errors"> 317 <directive name="proxy_intercept_errors">
316 <syntax>proxy_intercept_errors <value>[on|off]</value></syntax> 318 <syntax><value>[on|off]</value></syntax>
317 <default>proxy_intercept_errors off</default> 319 <default>off</default>
318 <context>http, server, location</context> 320 <context>http, server, location</context>
319 321
320 <para> 322 <para>
321 Директива определяет, передавать ли клиенту проксированные ответы с кодом 323 Директива определяет, передавать ли клиенту проксированные ответы с кодом
322 больше или равные 400 или же перенаправлять их на обработку nginx'у с помощью 324 больше или равные 400 или же перенаправлять их на обработку nginx'у с помощью
325 327
326 </directive> 328 </directive>
327 329
328 330
329 <directive name="proxy_next_upstream"> 331 <directive name="proxy_next_upstream">
330 <syntax>proxy_next_upstream <value>[error | timeout | invalid_header 332 <syntax><value>[error | timeout | invalid_header
331 | http_500 | http_502 | http_503 | http_504 | http_404 | off] 333 | http_500 | http_502 | http_503 | http_504 | http_404 | off]
332 [...]</value></syntax> 334 [...]</value></syntax>
333 <default>proxy_next_upstream error timeout</default> 335 <default>error timeout</default>
334 <context>http, server, location</context> 336 <context>http, server, location</context>
335 337
336 <para> 338 <para>
337 Директива определяет, в каких случаях запрос будет передан следующему серверу: 339 Директива определяет, в каких случаях запрос будет передан следующему серверу:
338 <list type="bullet"> 340 <list type="bullet">
387 389
388 </directive> 390 </directive>
389 391
390 392
391 <directive name="proxy_no_cache"> 393 <directive name="proxy_no_cache">
392 <syntax>proxy_no_cache <value>строка [...]</value></syntax> 394 <syntax><value>строка [...]</value></syntax>
393 <default/> 395 <default/>
394 <context>http, server, location</context> 396 <context>http, server, location</context>
395 397
396 <para> 398 <para>
397 Директива задаёт условия, при которых ответ не будет сохраняться в кэш. 399 Директива задаёт условия, при которых ответ не будет сохраняться в кэш.
406 408
407 </directive> 409 </directive>
408 410
409 411
410 <directive name="proxy_pass"> 412 <directive name="proxy_pass">
411 <syntax>proxy_pass <value>URL</value></syntax> 413 <syntax><value>URL</value></syntax>
412 <default/> 414 <default/>
413 <context>location, if в location, limit_except</context> 415 <context>location, if в location, limit_except</context>
414 416
415 <para> 417 <para>
416 Директива задаёт адрес проксируемоего сервера и URI, на который 418 Директива задаёт адрес проксируемоего сервера и URI, на который
511 513
512 </directive> 514 </directive>
513 515
514 516
515 <directive name="proxy_pass_header"> 517 <directive name="proxy_pass_header">
516 <syntax>proxy_pass_header <value>имя</value></syntax> 518 <syntax><value>имя</value></syntax>
519 <default/>
517 <context>http, server, location</context> 520 <context>http, server, location</context>
518 521
519 <para> 522 <para>
520 Директива разрешает передавать от проксируемого сервера клиенту 523 Директива разрешает передавать от проксируемого сервера клиенту
521 запрещённые для передачи строки. 524 запрещённые для передачи строки.
523 526
524 </directive> 527 </directive>
525 528
526 529
527 <directive name="proxy_redirect"> 530 <directive name="proxy_redirect">
528 <syntax>proxy_redirect <value>[default|off|редирект замена]</value> 531 <syntax><value>[default|off|редирект замена]</value>
529 </syntax> 532 </syntax>
530 <default>proxy_redirect default</default> 533 <default>default</default>
531 <context>http, server, location</context> 534 <context>http, server, location</context>
532 535
533 <para> 536 <para>
534 Директива задаёт текст, который нужно изменить в строках заголовка "Location" 537 Директива задаёт текст, который нужно изменить в строках заголовка "Location"
535 и "Refresh" в ответе проксируемого сервера. Предположим, проксируемый сервер 538 и "Refresh" в ответе проксируемого сервера. Предположим, проксируемый сервер
601 604
602 </directive> 605 </directive>
603 606
604 607
605 <directive name="proxy_read_timeout"> 608 <directive name="proxy_read_timeout">
606 <syntax>proxy_read_timeout <value>время</value></syntax> 609 <syntax><value>время</value></syntax>
607 <default>proxy_read_timeout 60</default> 610 <default>60</default>
608 <context>http, server, location</context> 611 <context>http, server, location</context>
609 612
610 <para> 613 <para>
611 Директива задаёт таймаут при чтении ответа проксированного сервера. 614 Директива задаёт таймаут при чтении ответа проксированного сервера.
612 Таймаут устанавливается не на всю передачу ответа, 615 Таймаут устанавливается не на всю передачу ответа,
616 </para> 619 </para>
617 620
618 </directive> 621 </directive>
619 622
620 623
621 <directive name="proxy_redirect_errors">
622 <syntax>proxy_redirect_errors <value>[on|off]</value></syntax>
623
624 <para>
625 Директива переименована в <link id="proxy_intercept_errors"/>.
626 </para>
627
628 </directive>
629
630
631 <directive name="proxy_send_timeout"> 624 <directive name="proxy_send_timeout">
632 <syntax>proxy_send_timeout <value>время</value></syntax> 625 <syntax><value>время</value></syntax>
633 <default>proxy_send_timeout 60</default> 626 <default>60</default>
634 <context>http, server, location</context> 627 <context>http, server, location</context>
635 628
636 <para> 629 <para>
637 Директива задаёт таймаут при передаче запроса проксированному серверу. 630 Директива задаёт таймаут при передаче запроса проксированному серверу.
638 Таймаут устанавливается не на всю передачу запроса, 631 Таймаут устанавливается не на всю передачу запроса,
643 636
644 </directive> 637 </directive>
645 638
646 639
647 <directive name="proxy_set_header"> 640 <directive name="proxy_set_header">
648 <syntax>proxy_set_header <value>заголовок значение</value></syntax> 641 <syntax><value>заголовок значение</value></syntax>
649 <default>Host и Connection</default> 642 <default>Host $proxy_host</default>
643 <default>Connection close</default>
650 <context>http, server, location</context> 644 <context>http, server, location</context>
651 645
652 <para> 646 <para>
653 Директива позволяет переопределять или добавлять строки заголовка запроса, 647 Директива позволяет переопределять или добавлять строки заголовка запроса,
654 передаваемые проксируемому серверу. 648 передаваемые проксируемому серверу.
696 690
697 </directive> 691 </directive>
698 692
699 693
700 <directive name="proxy_ssl_session_reuse"> 694 <directive name="proxy_ssl_session_reuse">
701 <syntax>proxy_ssl_session_reuse <value>[on|off]</value></syntax> 695 <syntax><value>[on|off]</value></syntax>
702 <default>proxy_ssl_session_reuse on</default> 696 <default>on</default>
703 <context>http, server, location</context> 697 <context>http, server, location</context>
704 698
705 <para> 699 <para>
706 Директива определяет, использовать ли повторно SSL-сессии при 700 Директива определяет, использовать ли повторно SSL-сессии при
707 работе с проксированным сервером. Если в логах появляются ошибки 701 работе с проксированным сервером. Если в логах появляются ошибки
711 705
712 </directive> 706 </directive>
713 707
714 708
715 <directive name="proxy_store"> 709 <directive name="proxy_store">
716 <syntax>proxy_store <value>on | off | строка </value></syntax> 710 <syntax><value>on | off | строка </value></syntax>
717 <default>proxy_store off</default> 711 <default>off</default>
718 <context>http, server, location</context> 712 <context>http, server, location</context>
719 713
720 <para> 714 <para>
721 Директива разрешает сохранение на диск файлов. 715 Директива разрешает сохранение на диск файлов.
722 Параметр "on" сохраняет файлы в соответствии с путями, указаными в директивах 716 Параметр "on" сохраняет файлы в соответствии с путями, указаными в директивах
788 782
789 </directive> 783 </directive>
790 784
791 785
792 <directive name="proxy_store_access"> 786 <directive name="proxy_store_access">
793 <syntax>proxy_store_access <value>пользователи:права [пользователи:права] 787 <syntax><value>пользователи:права [пользователи:права]
794 ...</value></syntax> 788 ...</value></syntax>
795 <default>proxy_store_access user:rw</default> 789 <default>user:rw</default>
796 <context>http, server, location</context> 790 <context>http, server, location</context>
797 791
798 <para> 792 <para>
799 Директива задаёт права доступа для создаваемых файлов и каталогов, например, 793 Директива задаёт права доступа для создаваемых файлов и каталогов, например,
800 <example> 794 <example>
812 806
813 </directive> 807 </directive>
814 808
815 809
816 <directive name="proxy_temp_path"> 810 <directive name="proxy_temp_path">
817 <syntax>proxy_temp_path <value>путь [ уровень1 [ уровень2 [ уровень3 ] ] ] 811 <syntax><value>путь [ уровень1 [ уровень2 [ уровень3 ] ] ]
818 </value></syntax> 812 </value></syntax>
819 <default>proxy_temp_path proxy_temp</default> 813 <default>proxy_temp</default>
820 <context>http, server, location</context> 814 <context>http, server, location</context>
821 815
822 <para> 816 <para>
823 Директива задаёт имя каталога для хранения временных файлов 817 Директива задаёт имя каталога для хранения временных файлов
824 полученных от другого сервера. 818 полученных от другого сервера.