nginx-site: xml/en/docs/http/ngx_http_proxy

annotate xml/en/docs/http/ngx_http_proxy_module.xml @ 1345:da296387cdac

Documented the Vary support in proxy_ignore_headers and friends.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Wed, 29 Oct 2014 15:28:02 +0400
parents	1bdde28e359b
children	97c8b146cb0e

rev	line source
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1 <?xml version="1.0"?>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2
580 be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 575 diff changeset	3 <!--
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 575 diff changeset	4 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 575 diff changeset	5 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 575 diff changeset	6 -->
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 575 diff changeset	7
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	9
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	10 <module name="Module ngx_http_proxy_module"
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	11 link="/en/docs/http/ngx_http_proxy_module.html"
589 764fbac1b8b4 Added document revision. Ruslan Ermilov <ru@nginx.com> parents: 580 diff changeset	12 lang="en"
1345 da296387cdac Documented the Vary support in proxy_ignore_headers and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1343 diff changeset	13 rev="29">
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	14
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	15 <section id="summary">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	16
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	17 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	18 The <literal>ngx_http_proxy_module</literal> module allows passing
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	19 requests to another server.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	20 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	21
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	22 </section>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	23
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	24
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	25 <section id="example" name="Example Configuration">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	26
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	27 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	28 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	29 location / {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	30 proxy_pass http://localhost:8000;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	31 proxy_set_header Host $host;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	32 proxy_set_header X-Real-IP $remote_addr;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	33 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	34 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	35 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	36
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	37 </section>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	38
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	39
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	40 <section id="directives" name="Directives">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	41
772 ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	42 <directive name="proxy_bind">
815 ed29fd8be462 _bind: variables support and inheritance. Ruslan Ermilov <ru@nginx.com>* parents: 799 diff changeset	43 <syntax><value>address</value> \| <literal>off</literal></syntax>
772 ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	44 <default/>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	45 <context>http</context>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	46 <context>server</context>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	47 <context>location</context>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	48 <appeared-in>0.8.22</appeared-in>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	49
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	50 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	51 Makes outgoing connections to a proxied server originate
772 ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	52 from the specified local IP <value>address</value>.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	53 Parameter value can contain variables (1.3.12).
815 ed29fd8be462 _bind: variables support and inheritance. Ruslan Ermilov <ru@nginx.com>* parents: 799 diff changeset	54 The special value <literal>off</literal> (1.3.12) cancels the effect
ed29fd8be462 _bind: variables support and inheritance. Ruslan Ermilov <ru@nginx.com>* parents: 799 diff changeset	55 of the <literal>proxy_bind</literal> directive
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	56 inherited from the previous configuration level, which allows the
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	57 system to auto-assign the local IP address.
772 ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	58 </para>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	59
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	60 </directive>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	61
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	62
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	63 <directive name="proxy_buffer_size">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	64 <syntax><value>size</value></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	65 <default>4k\|8k</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	66 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	67 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	68 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	69
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	70 <para>
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	71 Sets the size of the buffer <value>size</value> used for reading the first part
4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	72 of the response received from the proxied server.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	73 This part usually contains a small response header.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	74 By default, the buffer size is equal to the size of one
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	75 buffer set by the <link id="proxy_buffers"/> directive.
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	76 It can be made smaller, however.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	77 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	78
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	79 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	80
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	81
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	82 <directive name="proxy_buffering">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	83 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	84 <default>on</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	85 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	86 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	87 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	88
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	89 <para>
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	90 Enables or disables buffering of responses from the proxied server.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	91 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	92
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	93 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	94 When buffering is enabled, nginx receives a response from the proxied server
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	95 as soon as possible, saving it into the buffers set by the
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	96 <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/> directives.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	97 If the whole response does not fit into memory, a part of it can be saved
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	98 to a <link id="proxy_temp_path">temporary file</link> on the disk.
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	99 Writing to temporary files is controlled by the
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	100 <link id="proxy_max_temp_file_size"/> and
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	101 <link id="proxy_temp_file_write_size"/> directives.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	102 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	103
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	104 <para>
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	105 When buffering is disabled, the response is passed to a client synchronously,
362 db6774c4c699 Fixed translation. Ruslan Ermilov <ru@nginx.com> parents: 351 diff changeset	106 immediately as it is received.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	107 nginx will not try to read the whole response from the proxied server.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	108 The maximum size of the data that nginx can receive from the server
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	109 at a time is set by the <link id="proxy_buffer_size"/> directive.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	110 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	111
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	112 <para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	113 Buffering can also be enabled or disabled by passing
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	114 “<literal>yes</literal>” or “<literal>no</literal>” in the
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	115 <header>X-Accel-Buffering</header> response header field.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	116 This capability can be disabled using the
992 7cc496641627 Removed extraneous links. Ruslan Ermilov <ru@nginx.com> parents: 985 diff changeset	117 <link id="proxy_ignore_headers"/> directive.
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	118 </para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	119
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	120 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	121
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	122
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	123 <directive name="proxy_buffers">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	124 <syntax><value>number</value> <value>size</value></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	125 <default>8 4k\|8k</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	126 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	127 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	128 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	129
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	130 <para>
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	131 Sets the <value>number</value> and <value>size</value> of the
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	132 buffers used for reading a response from the proxied server,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	133 for a single connection.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	134 By default, the buffer size is equal to one memory page.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	135 This is either 4K or 8K, depending on a platform.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	136 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	137
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	138 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	139
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	140
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	141 <directive name="proxy_busy_buffers_size">
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	142 <syntax><value>size</value></syntax>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	143 <default>8k\|16k</default>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	144 <context>http</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	145 <context>server</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	146 <context>location</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	147
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	148 <para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	149 When <link id="proxy_buffering">buffering</link> of responses from the proxied
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	150 server is enabled, limits the total <value>size</value> of buffers that
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	151 can be busy sending a response to the client while the response is not
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	152 yet fully read.
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	153 In the meantime, the rest of the buffers can be used for reading the response
4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	154 and, if needed, buffering part of the response to a temporary file.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	155 By default, <value>size</value> is limited by the size of two buffers set by the
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	156 <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/> directives.
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	157 </para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	158
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	159 </directive>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	160
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	161
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	162 <directive name="proxy_cache">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	163 <syntax><value>zone</value> \| <literal>off</literal></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	164 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	165 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	166 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	167 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	168
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	169 <para>
575 ebcb351d9eb3 Consistently using the term "shared memory zone". Ruslan Ermilov <ru@nginx.com> parents: 535 diff changeset	170 Defines a shared memory zone used for caching.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	171 The same zone can be used in several places.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	172 The <literal>off</literal> parameter disables caching inherited
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	173 from the previous configuration level.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	174 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	175
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	176 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	177
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	178
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	179 <directive name="proxy_cache_bypass">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	180 <syntax><value>string</value> ...</syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	181 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	182 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	183 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	184 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	185
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	186 <para>
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	187 Defines conditions under which the response will not be taken from a cache.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	188 If at least one value of the string parameters is not empty and is not
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	189 equal to “0” then the response will not be taken from the cache:
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	190 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	191 proxy_cache_bypass $cookie_nocache $arg_nocache$arg_comment;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	192 proxy_cache_bypass $http_pragma $http_authorization;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	193 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	194 Can be used along with the <link id="proxy_no_cache"/> directive.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	195 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	196
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	197 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	198
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	199
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	200 <directive name="proxy_cache_key">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	201 <syntax><value>string</value></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	202 <default>$scheme$proxy_host$request_uri</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	203 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	204 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	205 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	206
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	207 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	208 Defines a key for caching, for example
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	209 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	210 proxy_cache_key "$host$request_uri $cookie_user";
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	211 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	212 By default, the directive’s value is close to the string
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	213 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	214 proxy_cache_key $scheme$proxy_host$uri$is_args$args;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	215 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	216 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	217
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	218 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	219
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	220
302 df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	221 <directive name="proxy_cache_lock">
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	222 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	223 <default>off</default>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	224 <context>http</context>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	225 <context>server</context>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	226 <context>location</context>
310 86732337c730 Added a historical information for proxy_cache_lock, proxy_cache_lock_timeout, Ruslan Ermilov <ru@nginx.com> parents: 302 diff changeset	227 <appeared-in>1.1.12</appeared-in>
302 df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	228
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	229 <para>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	230 When enabled, only one request at a time will be allowed to populate
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	231 a new cache element identified according to the <link id="proxy_cache_key"/>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	232 directive by passing a request to a proxied server.
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	233 Other requests of the same cache element will either wait
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	234 for a response to appear in the cache or the cache lock for
302 df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	235 this element to be released, up to the time set by the
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	236 <link id="proxy_cache_lock_timeout"/> directive.
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	237 </para>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	238
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	239 </directive>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	240
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	241
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	242 <directive name="proxy_cache_lock_timeout">
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	243 <syntax><value>time</value></syntax>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	244 <default>5s</default>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	245 <context>http</context>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	246 <context>server</context>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	247 <context>location</context>
310 86732337c730 Added a historical information for proxy_cache_lock, proxy_cache_lock_timeout, Ruslan Ermilov <ru@nginx.com> parents: 302 diff changeset	248 <appeared-in>1.1.12</appeared-in>
302 df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	249
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	250 <para>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	251 Sets a timeout for <link id="proxy_cache_lock"/>.
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	252 </para>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	253
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	254 </directive>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	255
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	256
790 ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	257 <directive name="proxy_cache_methods">
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	258 <syntax>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	259 <literal>GET</literal> \|
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	260 <literal>HEAD</literal> \|
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	261 <literal>POST</literal>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	262 ...</syntax>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	263 <default>GET HEAD</default>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	264 <context>http</context>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	265 <context>server</context>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	266 <context>location</context>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	267 <appeared-in>0.7.59</appeared-in>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	268
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	269 <para>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	270 If the client request method is listed in this directive then
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	271 the response will be cached.
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	272 “<literal>GET</literal>” and “<literal>HEAD</literal>” methods are always
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	273 added to the list, though it is recommended to specify them explicitly.
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	274 See also the <link id="proxy_no_cache"/> directive.
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	275 </para>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	276
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	277 </directive>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	278
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	279
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	280 <directive name="proxy_cache_min_uses">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	281 <syntax><value>number</value></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	282 <default>1</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	283 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	284 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	285 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	286
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	287 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	288 Sets the <value>number</value> of requests after which the response
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	289 will be cached.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	290 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	291
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	292 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	293
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	294
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	295 <directive name="proxy_cache_path">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	296 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	297 <value>path</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	298 [<literal>levels</literal>=<value>levels</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	299 <literal>keys_zone</literal>=<value>name</value>:<value>size</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	300 [<literal>inactive</literal>=<value>time</value>]
508 5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	301 [<literal>max_size</literal>=<value>size</value>]
5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	302 [<literal>loader_files</literal>=<value>number</value>]
5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	303 [<literal>loader_sleep</literal>=<value>time</value>]
5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	304 [<literal>loader_threshold</literal>=<value>time</value>]</syntax>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	305 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	306 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	307
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	308 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	309 Sets the path and other parameters of a cache.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	310 Cache data are stored in files.
1190 dd4cfc6ce770 Corrected description of _cache_path file names. Ruslan Ermilov <ru@nginx.com>* parents: 1189 diff changeset	311 The file name in a cache is a result of
dd4cfc6ce770 Corrected description of _cache_path file names. Ruslan Ermilov <ru@nginx.com>* parents: 1189 diff changeset	312 applying the MD5 function to the
dd4cfc6ce770 Corrected description of _cache_path file names. Ruslan Ermilov <ru@nginx.com>* parents: 1189 diff changeset	313 <link id="proxy_cache_key">cache key</link>.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	314 The <literal>levels</literal> parameter defines hierarchy levels of a cache.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	315 For example, in the following configuration
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	316 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	317 proxy_cache_path /data/nginx/cache levels=1:2 keys_zone=one:10m;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	318 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	319 file names in a cache will look like this:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	320 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	321 /data/nginx/cache/<emphasis>c</emphasis>/<emphasis>29</emphasis>/b7f54b2df7773722d382f4809d650<emphasis>29c</emphasis>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	322 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	323 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	324
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	325 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	326 A cached response is first written to a temporary file,
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	327 and then the file is renamed.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	328 Starting from version 0.8.9, temporary files and the cache can be put on
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	329 different file systems.
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	330 However, be aware that in this case a file is copied
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	331 across two file systems instead of the cheap renaming operation.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	332 It is thus recommended that for any given location both cache and a directory
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	333 holding temporary files, set by the <link id="proxy_temp_path"/> directive,
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	334 are put on the same file system.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	335 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	336
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	337 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	338 In addition, all active keys and information about data are stored
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	339 in a shared memory zone, whose <value>name</value> and <value>size</value>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	340 are configured by the <literal>keys_zone</literal> parameter.
1189 f25d00109de0 Documented cache keys_zone memory estimates. Maxim Dounin <mdounin@mdounin.ru> parents: 1166 diff changeset	341 One megabyte zone can store about 8 thousand keys.
f25d00109de0 Documented cache keys_zone memory estimates. Maxim Dounin <mdounin@mdounin.ru> parents: 1166 diff changeset	342 </para>
f25d00109de0 Documented cache keys_zone memory estimates. Maxim Dounin <mdounin@mdounin.ru> parents: 1166 diff changeset	343
f25d00109de0 Documented cache keys_zone memory estimates. Maxim Dounin <mdounin@mdounin.ru> parents: 1166 diff changeset	344 <para>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	345 Cached data that are not accessed during the time specified by the
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	346 <literal>inactive</literal> parameter get removed from the cache
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	347 regardless of their freshness.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	348 By default, <literal>inactive</literal> is set to 10 minutes.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	349 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	350
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	351 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	352 The special “cache manager” process monitors the maximum cache size set
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	353 by the <literal>max_size</literal> parameter.
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	354 When this size is exceeded, it removes the least recently used data.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	355 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	356
508 5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	357 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	358 A minute after the start the special “cache loader” process is activated.
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	359 It loads information about previously cached data stored on file system
508 5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	360 into a cache zone.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	361 The loading is done in iterations.
508 5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	362 During one iteration no more than <literal>loader_files</literal> items
5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	363 are loaded (by default, 100).
5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	364 Besides, the duration of one iteration is limited by the
5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	365 <literal>loader_threshold</literal> parameter (by default, 200 milliseconds).
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	366 Between iterations, a pause configured by the <literal>loader_sleep</literal>
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	367 parameter (by default, 50 milliseconds) is made.
508 5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	368 </para>
5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	369
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	370 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	371
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	372
1028 e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	373 <directive name="proxy_cache_purge">
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	374 <syntax>string ...</syntax>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	375 <default/>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	376 <context>http</context>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	377 <context>server</context>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	378 <context>location</context>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	379 <appeared-in>1.5.7</appeared-in>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	380
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	381 <para>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	382 Defines conditions under which the request will be considered a cache
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	383 purge request.
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	384 If at least one value of the string parameters is not empty and is not equal
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	385 to “0” then the cache entry with a corresponding
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	386 <link id="proxy_cache_key">cache key</link> is removed.
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	387 The result of successful operation is indicated by returning
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	388 the <http-status code="204" text="No Content"/> response.
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	389 </para>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	390
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	391 <para>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	392 If the <link id="proxy_cache_key">cache key</link> of a purge request ends
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	393 with an asterisk (“<literal>*</literal>”), all cache entries matching the
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	394 wildcard key will be removed from the cache.
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	395 </para>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	396
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	397 <para>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	398 Example configuration:
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	399 <example>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	400 proxy_cache_path /data/nginx/cache keys_zone=cache_zone:10m;
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	401
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	402 map $request_method $purge_method {
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	403 PURGE 1;
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	404 default 0;
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	405 }
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	406
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	407 server {
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	408 ...
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	409 location / {
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	410 proxy_pass http://backend;
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	411 proxy_cache cache_zone;
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	412 proxy_cache_key $uri;
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	413 proxy_cache_purge $purge_method;
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	414 }
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	415 }
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	416 </example>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	417 <note>
1128 1594ed379f1f De-i18n'ed <commercial_version/>. Ruslan Ermilov <ru@nginx.com> parents: 1088 diff changeset	418 This functionality is available as part of our
1594ed379f1f De-i18n'ed <commercial_version/>. Ruslan Ermilov <ru@nginx.com> parents: 1088 diff changeset	419 <commercial_version>commercial subscription</commercial_version>.
1028 e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	420 </note>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	421 </para>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	422
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	423 </directive>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	424
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	425
1011 2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	426 <directive name="proxy_cache_revalidate">
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	427 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	428 <default>off</default>
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	429 <context>http</context>
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	430 <context>server</context>
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	431 <context>location</context>
1015 af77dd40abeb Documented the appearance of "fastcgi_" and "proxy_cache_revalidate". Vladimir Homutov <vl@nginx.com> parents: 1011 diff changeset	432 <appeared-in>1.5.7</appeared-in>
1011 2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	433
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	434 <para>
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	435 Enables revalidation of expired cache items using conditional requests with
1246 5be7716a5684 Documented If-None-Match in proxy_cache_revalidate and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1190 diff changeset	436 the <header>If-Modified-Since</header> and <header>If-None-Match</header>
5be7716a5684 Documented If-None-Match in proxy_cache_revalidate and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1190 diff changeset	437 header fields.
1011 2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	438 </para>
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	439
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	440 </directive>
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	441
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	442
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	443 <directive name="proxy_cache_use_stale">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	444 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	445 <literal>error</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	446 <literal>timeout</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	447 <literal>invalid_header</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	448 <literal>updating</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	449 <literal>http_500</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	450 <literal>http_502</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	451 <literal>http_503</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	452 <literal>http_504</literal> \|
917 e26a18eb5ccd Documented http_403 in proxy_next_upstream and friends. Maxim Dounin <mdounin@mdounin.ru> parents: 907 diff changeset	453 <literal>http_403</literal> \|
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	454 <literal>http_404</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	455 <literal>off</literal>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	456 ...</syntax>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	457 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	458 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	459 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	460 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	461
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	462 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	463 Determines in which cases a stale cached response can be used
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	464 when an error occurs during communication with the proxied server.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	465 The directive’s parameters match the parameters of the
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	466 <link id="proxy_next_upstream"/> directive.
504 695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	467 </para>
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	468
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	469 <para>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	470 Additionally, the <literal>updating</literal> parameter permits
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	471 using a stale cached response if it is currently being updated.
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	472 This allows minimizing the number of accesses to proxied servers
504 695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	473 when updating cached data.
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	474 </para>
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	475
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	476 <para>
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	477 To minimize the number of accesses to proxied servers when
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	478 populating a new cache element, the <link id="proxy_cache_lock"/>
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	479 directive can be used.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	480 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	481
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	482 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	483
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	484
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	485 <directive name="proxy_cache_valid">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	486 <syntax>[<value>code</value> ...] <value>time</value></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	487 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	488 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	489 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	490 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	491
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	492 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	493 Sets caching time for different response codes.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	494 For example, the following directives
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	495 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	496 proxy_cache_valid 200 302 10m;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	497 proxy_cache_valid 404 1m;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	498 </example>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	499 set 10 minutes of caching for responses with codes 200 and 302
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	500 and 1 minute for responses with code 404.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	501 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	502
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	503 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	504 If only caching <value>time</value> is specified
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	505 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	506 proxy_cache_valid 5m;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	507 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	508 then only 200, 301, and 302 responses are cached.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	509 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	510
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	511 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	512 In addition, the <literal>any</literal> parameter can be specified
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	513 to cache any responses:
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	514 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	515 proxy_cache_valid 200 302 10m;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	516 proxy_cache_valid 301 1h;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	517 proxy_cache_valid any 1m;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	518 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	519 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	520
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	521 <para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	522 Parameters of caching can also be set directly
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	523 in the response header.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	524 This has higher priority than setting of caching time using the directive.
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	525 The <header>X-Accel-Expires</header> header field sets caching time of a
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	526 response in seconds.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	527 The zero value disables caching for a response.
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	528 If the value starts with the <literal>@</literal> prefix, it sets an absolute
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	529 time in seconds since Epoch, up to which the response may be cached.
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	530 If the header does not include the <header>X-Accel-Expires</header> field,
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	531 parameters of caching may be set in the header fields
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	532 <header>Expires</header> or <header>Cache-Control</header>.
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	533 If the header includes the <header>Set-Cookie</header> field, such a
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	534 response will not be cached.
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	535 Processing of one or more of these response header fields can be disabled
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	536 using the <link id="proxy_ignore_headers"/> directive.
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	537 </para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	538
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	539 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	540
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	541
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	542 <directive name="proxy_connect_timeout">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	543 <syntax><value>time</value></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	544 <default>60s</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	545 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	546 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	547 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	548
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	549 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	550 Defines a timeout for establishing a connection with a proxied server.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	551 It should be noted that this timeout cannot usually exceed 75 seconds.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	552 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	553
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	554 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	555
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	556
417 cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	557 <directive name="proxy_cookie_domain">
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	558 <syntax><literal>off</literal></syntax>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	559 <syntax><value>domain</value> <value>replacement</value></syntax>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	560 <default>off</default>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	561 <context>http</context>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	562 <context>server</context>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	563 <context>location</context>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	564 <appeared-in>1.1.15</appeared-in>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	565
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	566 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	567 Sets a text that should be changed in the <literal>domain</literal>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	568 attribute of the <header>Set-Cookie</header> header fields of a
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	569 proxied server response.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	570 Suppose a proxied server returned the <header>Set-Cookie</header>
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	571 header field with the attribute
417 cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	572 “<literal>domain=localhost</literal>”.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	573 The directive
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	574 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	575 proxy_cookie_domain localhost example.org;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	576 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	577 will rewrite this attribute to
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	578 “<literal>domain=example.org</literal>”.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	579 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	580
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	581 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	582 A dot at the beginning of the <value>domain</value> and
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	583 <value>replacement</value> strings and the <literal>domain</literal>
417 cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	584 attribute is ignored.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	585 Matching is case-insensitive.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	586 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	587
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	588 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	589 The <value>domain</value> and <value>replacement</value> strings
417 cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	590 can contain variables:
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	591 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	592 proxy_cookie_domain www.$host $host;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	593 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	594 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	595
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	596 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	597 The directive can also be specified using regular expressions.
417 cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	598 In this case, <value>domain</value> should start from
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	599 the “<literal>~</literal>” symbol.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	600 A regular expression can contain named and positional captures,
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	601 and <value>replacement</value> can reference them:
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	602 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	603 proxy_cookie_domain ~\.(?P<sl_domain>[-0-9a-z]+\.[a-z]+)$ $sl_domain;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	604 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	605 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	606
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	607 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	608 There could be several <literal>proxy_cookie_domain</literal> directives:
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	609 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	610 proxy_cookie_domain localhost example.org;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	611 proxy_cookie_domain ~\.([a-z]+\.[a-z]+)$ $1;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	612 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	613 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	614
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	615 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	616 The <literal>off</literal> parameter cancels the effect of all
417 cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	617 <literal>proxy_cookie_domain</literal> directives on the current level:
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	618 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	619 proxy_cookie_domain off;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	620 proxy_cookie_domain localhost example.org;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	621 proxy_cookie_domain www.example.org example.org;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	622 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	623 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	624
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	625 </directive>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	626
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	627
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	628 <directive name="proxy_cookie_path">
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	629 <syntax><literal>off</literal></syntax>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	630 <syntax><value>path</value> <value>replacement</value></syntax>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	631 <default>off</default>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	632 <context>http</context>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	633 <context>server</context>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	634 <context>location</context>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	635 <appeared-in>1.1.15</appeared-in>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	636
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	637 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	638 Sets a text that should be changed in the <literal>path</literal>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	639 attribute of the <header>Set-Cookie</header> header fields of a
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	640 proxied server response.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	641 Suppose a proxied server returned the <header>Set-Cookie</header>
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	642 header field with the attribute
417 cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	643 “<literal>path=/two/some/uri/</literal>”.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	644 The directive
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	645 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	646 proxy_cookie_path /two/ /;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	647 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	648 will rewrite this attribute to
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	649 “<literal>path=/some/uri/</literal>”.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	650 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	651
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	652 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	653 The <value>path</value> and <value>replacement</value> strings
417 cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	654 can contain variables:
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	655 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	656 proxy_cookie_path $uri /some$uri;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	657 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	658 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	659
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	660 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	661 The directive can also be specified using regular expressions.
417 cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	662 In this case, <value>path</value> should either start from
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	663 the “<literal>~</literal>” symbol for a case-sensitive matching,
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	664 or from the “<literal>~*</literal>” symbols for case-insensitive
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	665 matching.
1149 1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1146 diff changeset	666 The regular expression can contain named and positional captures,
417 cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	667 and <value>replacement</value> can reference them:
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	668 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	669 proxy_cookie_path ~*^/user/([^/]+) /u/$1;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	670 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	671 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	672
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	673 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	674 There could be several <literal>proxy_cookie_path</literal> directives:
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	675 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	676 proxy_cookie_path /one/ /;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	677 proxy_cookie_path / /two/;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	678 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	679 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	680
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	681 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	682 The <literal>off</literal> parameter cancels the effect of all
417 cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	683 <literal>proxy_cookie_path</literal> directives on the current level:
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	684 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	685 proxy_cookie_path off;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	686 proxy_cookie_path /two/ /;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	687 proxy_cookie_path ~*^/user/([^/]+) /u/$1;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	688 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	689 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	690
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	691 </directive>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	692
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	693
1337 91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	694 <directive name="proxy_force_ranges">
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	695 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	696 <default>off</default>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	697 <context>http</context>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	698 <context>server</context>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	699 <context>location</context>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	700 <appeared-in>1.7.7</appeared-in>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	701
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	702 <para>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	703 Enables byte-range support
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	704 for both cached and uncached responses from the proxied server
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	705 regardless of the <header>Accept-Ranges</header> field in these responses.
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	706 </para>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	707
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	708 </directive>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	709
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	710
799 9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	711 <directive name="proxy_headers_hash_bucket_size">
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	712 <syntax><value>size</value></syntax>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	713 <default>64</default>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	714 <context>http</context>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	715 <context>server</context>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	716 <context>location</context>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	717
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	718 <para>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	719 Sets the bucket <value>size</value> for hash tables
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	720 used by the <link id="proxy_hide_header"/> and <link id="proxy_set_header"/>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	721 directives.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	722 The details of setting up hash tables are provided in a separate
799 9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	723 <link doc="../hash.xml">document</link>.
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	724 </para>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	725
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	726 </directive>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	727
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	728
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	729 <directive name="proxy_headers_hash_max_size">
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	730 <syntax><value>size</value></syntax>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	731 <default>512</default>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	732 <context>http</context>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	733 <context>server</context>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	734 <context>location</context>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	735
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	736 <para>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	737 Sets the maximum <value>size</value> of hash tables
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	738 used by the <link id="proxy_hide_header"/> and <link id="proxy_set_header"/>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	739 directives.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	740 The details of setting up hash tables are provided in a separate
799 9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	741 <link doc="../hash.xml">document</link>.
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	742 </para>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	743
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	744 </directive>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	745
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	746
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	747 <directive name="proxy_hide_header">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	748 <syntax><value>field</value></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	749 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	750 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	751 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	752 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	753
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	754 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	755 By default,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	756 nginx does not pass the header fields <header>Date</header>,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	757 <header>Server</header>, <header>X-Pad</header>, and
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	758 <header>X-Accel-...</header> from the response of a proxied
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	759 server to a client.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	760 The <literal>proxy_hide_header</literal> directive sets additional fields
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	761 that will not be passed.
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	762 If, on the contrary, the passing of fields needs to be permitted,
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	763 the <link id="proxy_pass_header"/> directive can be used.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	764 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	765
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	766 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	767
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	768
316 1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	769 <directive name="proxy_http_version">
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	770 <syntax><literal>1.0</literal> \| <literal>1.1</literal></syntax>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	771 <default>1.0</default>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	772 <context>http</context>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	773 <context>server</context>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	774 <context>location</context>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	775 <appeared-in>1.1.4</appeared-in>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	776
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	777 <para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	778 Sets the HTTP protocol version for proxying.
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	779 By default, version 1.0 is used.
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	780 Version 1.1 is recommended for use with
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	781 <link doc="ngx_http_upstream_module.xml" id="keepalive"/>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	782 connections.
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	783 </para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	784
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	785 </directive>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	786
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	787
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	788 <directive name="proxy_ignore_client_abort">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	789 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	790 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	791 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	792 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	793 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	794
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	795 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	796 Determines whether the connection with a proxied server should be
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	797 closed when a client closes the connection without waiting
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	798 for a response.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	799 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	800
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	801 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	802
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	803
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	804 <directive name="proxy_ignore_headers">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	805 <syntax><value>field</value> ...</syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	806 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	807 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	808 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	809 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	810
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	811 <para>
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	812 Disables processing of certain response header fields from the proxied server.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	813 The following fields can be ignored: <header>X-Accel-Redirect</header>,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	814 <header>X-Accel-Expires</header>, <header>X-Accel-Limit-Rate</header> (1.1.6),
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	815 <header>X-Accel-Buffering</header> (1.1.6),
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	816 <header>X-Accel-Charset</header> (1.1.6), <header>Expires</header>,
1345 da296387cdac Documented the Vary support in proxy_ignore_headers and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1343 diff changeset	817 <header>Cache-Control</header>, <header>Set-Cookie</header> (0.8.44),
da296387cdac Documented the Vary support in proxy_ignore_headers and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1343 diff changeset	818 and <header>Vary</header> (1.7.7).
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	819 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	820
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	821 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	822 If not disabled, processing of these header fields has the following
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	823 effect:
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	824 <list type="bullet" compact="no">
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	825
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	826 <listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	827 <header>X-Accel-Expires</header>, <header>Expires</header>,
1345 da296387cdac Documented the Vary support in proxy_ignore_headers and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1343 diff changeset	828 <header>Cache-Control</header>, <header>Set-Cookie</header>,
da296387cdac Documented the Vary support in proxy_ignore_headers and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1343 diff changeset	829 and <header>Vary</header>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	830 set the parameters of response <link id="proxy_cache_valid">caching</link>;
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	831 </listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	832
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	833 <listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	834 <header>X-Accel-Redirect</header> performs an
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	835 <link doc="ngx_http_core_module.xml" id="internal">internal
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	836 redirect</link> to the specified URI;
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	837 </listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	838
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	839 <listitem>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	840 <header>X-Accel-Limit-Rate</header> sets the
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	841 <link doc="ngx_http_core_module.xml" id="limit_rate">rate
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	842 limit</link> for transmission of a response to a client;
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	843 </listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	844
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	845 <listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	846 <header>X-Accel-Buffering</header> enables or disables
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	847 <link id="proxy_buffering">buffering</link> of a response;
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	848 </listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	849
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	850 <listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	851 <header>X-Accel-Charset</header> sets the desired
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	852 <link doc="ngx_http_charset_module.xml" id="charset"/>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	853 of a response.
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	854 </listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	855
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	856 </list>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	857 </para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	858
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	859 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	860
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	861
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	862 <directive name="proxy_intercept_errors">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	863 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	864 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	865 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	866 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	867 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	868
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	869 <para>
297 94c8df379088 Added missing word. Ruslan Ermilov <ru@nginx.com> parents: 294 diff changeset	870 Determines whether proxied responses with codes greater than or equal
907 43887f41bb17 Corrected the descriptions of {proxy,fastcgi}_intercept_errors. Ruslan Ermilov <ru@nginx.com> parents: 849 diff changeset	871 to 300 should be passed to a client or be redirected to nginx for processing
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	872 with the <link doc="ngx_http_core_module.xml" id="error_page"/> directive.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	873 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	874
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	875 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	876
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	877
1342 758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	878 <directive name="proxy_limit_rate">
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	879 <syntax><value>rate</value></syntax>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	880 <default>0</default>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	881 <context>http</context>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	882 <context>server</context>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	883 <context>location</context>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	884 <appeared-in>1.7.7</appeared-in>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	885
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	886 <para>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	887 Limits the speed of reading the response from the proxied server.
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	888 The <value>rate</value> is specified in bytes per second.
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	889 The zero value disables rate limiting.
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	890 The limit is set per a request, and so if nginx simultaneously opens
1343 1bdde28e359b Fixed fallouts from the previous change. Ruslan Ermilov <ru@nginx.com> parents: 1342 diff changeset	891 two connections to the proxied server,
1bdde28e359b Fixed fallouts from the previous change. Ruslan Ermilov <ru@nginx.com> parents: 1342 diff changeset	892 the overall rate will be twice as much as the specified limit.
1342 758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	893 The limitation works only if
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	894 <link id="proxy_buffering">buffering</link> of responses from the proxied
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	895 server is enabled.
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	896 </para>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	897
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	898 </directive>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	899
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	900
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	901 <directive name="proxy_max_temp_file_size">
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	902 <syntax><value>size</value></syntax>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	903 <default>1024m</default>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	904 <context>http</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	905 <context>server</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	906 <context>location</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	907
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	908 <para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	909 When <link id="proxy_buffering">buffering</link> of responses from the proxied
1153 4e20e4f8f49b Finished truncation of "memory buffers" to just "buffers". Ruslan Ermilov <ru@nginx.com> parents: 1151 diff changeset	910 server is enabled, and the whole response does not fit into the buffers
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	911 set by the <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	912 directives, a part of the response can be saved to a temporary file.
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	913 This directive sets the maximum <value>size</value> of the temporary file.
4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	914 The size of data written to the temporary file at a time is set
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	915 by the <link id="proxy_temp_file_write_size"/> directive.
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	916 </para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	917
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	918 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	919 The zero value disables buffering of responses to temporary files.
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	920 </para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	921
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	922 </directive>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	923
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	924
787 180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	925 <directive name="proxy_method">
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	926 <syntax><value>method</value></syntax>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	927 <default/>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	928 <context>http</context>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	929 <context>server</context>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	930 <context>location</context>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	931
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	932 <para>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	933 Specifies the HTTP <value>method</value> to use in requests forwarded
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	934 to the proxied server instead of the method from the client request.
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	935 </para>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	936
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	937 </directive>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	938
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	939
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	940 <directive name="proxy_next_upstream">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	941 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	942 <literal>error</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	943 <literal>timeout</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	944 <literal>invalid_header</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	945 <literal>http_500</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	946 <literal>http_502</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	947 <literal>http_503</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	948 <literal>http_504</literal> \|
917 e26a18eb5ccd Documented http_403 in proxy_next_upstream and friends. Maxim Dounin <mdounin@mdounin.ru> parents: 907 diff changeset	949 <literal>http_403</literal> \|
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	950 <literal>http_404</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	951 <literal>off</literal>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	952 ...</syntax>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	953 <default>error timeout</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	954 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	955 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	956 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	957
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	958 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	959 Specifies in which cases a request should be passed to the next server:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	960 <list type="tag">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	961
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	962 <tag-name><literal>error</literal></tag-name>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	963 <tag-desc>an error occurred while establishing a connection with the
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	964 server, passing a request to it, or reading the response header;</tag-desc>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	965
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	966 <tag-name><literal>timeout</literal></tag-name>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	967 <tag-desc>a timeout has occurred while establishing a connection with the
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	968 server, passing a request to it, or reading the response header;</tag-desc>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	969
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	970 <tag-name><literal>invalid_header</literal></tag-name>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	971 <tag-desc>a server returned an empty or invalid response;</tag-desc>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	972
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	973 <tag-name><literal>http_500</literal></tag-name>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	974 <tag-desc>a server returned a response with the code 500;</tag-desc>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	975
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	976 <tag-name><literal>http_502</literal></tag-name>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	977 <tag-desc>a server returned a response with the code 502;</tag-desc>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	978
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	979 <tag-name><literal>http_503</literal></tag-name>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	980 <tag-desc>a server returned a response with the code 503;</tag-desc>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	981
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	982 <tag-name><literal>http_504</literal></tag-name>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	983 <tag-desc>a server returned a response with the code 504;</tag-desc>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	984
917 e26a18eb5ccd Documented http_403 in proxy_next_upstream and friends. Maxim Dounin <mdounin@mdounin.ru> parents: 907 diff changeset	985 <tag-name><literal>http_403</literal></tag-name>
e26a18eb5ccd Documented http_403 in proxy_next_upstream and friends. Maxim Dounin <mdounin@mdounin.ru> parents: 907 diff changeset	986 <tag-desc>a server returned a response with the code 403;</tag-desc>
e26a18eb5ccd Documented http_403 in proxy_next_upstream and friends. Maxim Dounin <mdounin@mdounin.ru> parents: 907 diff changeset	987
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	988 <tag-name><literal>http_404</literal></tag-name>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	989 <tag-desc>a server returned a response with the code 404;</tag-desc>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	990
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	991 <tag-name><literal>off</literal></tag-name>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	992 <tag-desc>disables passing a request to the next server.</tag-desc>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	993
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	994 </list>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	995 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	996
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	997 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	998 One should bear in mind that passing a request to the next server is
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	999 only possible if nothing has been sent to a client yet.
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1000 That is, if an error or timeout occurs in the middle of the
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1001 transferring of a response, fixing this is impossible.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1002 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1003
942 ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	1004 <para>
1289 57fc39924d42 Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 1246 diff changeset	1005 The directive also defines what is considered an
57fc39924d42 Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 1246 diff changeset	1006 <link doc="ngx_http_upstream_module.xml" id="max_fails">unsuccessful
57fc39924d42 Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 1246 diff changeset	1007 attempt</link> of communication with a server.
942 ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	1008 The cases of <literal>error</literal>, <literal>timeout</literal> and
ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	1009 <literal>invalid_header</literal> are always considered unsuccessful attempts,
ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	1010 even if they are not specified in the directive.
ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	1011 The cases of <literal>http_500</literal>, <literal>http_502</literal>,
ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	1012 <literal>http_503</literal> and <literal>http_504</literal> are
ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	1013 considered unsuccessful attempts only if they are specified in the directive.
ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	1014 The cases of <literal>http_403</literal> and <literal>http_404</literal>
ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	1015 are never considered unsuccessful attempts.
ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	1016 </para>
ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	1017
1290 f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1018 <para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1019 Passing a request to the next server can be limited by
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1020 <link id="proxy_next_upstream_tries">the number of tries</link>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1021 and by <link id="proxy_next_upstream_timeout">time</link>.
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1022 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1023
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1024 </directive>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1025
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1026
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1027 <directive name="proxy_next_upstream_timeout">
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1028 <syntax><value>time</value></syntax>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1029 <default>0</default>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1030 <context>http</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1031 <context>server</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1032 <context>location</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1033 <appeared-in>1.7.5</appeared-in>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1034
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1035 <para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1036 Limits the time allowed to pass a request to the
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1037 <link id="proxy_next_upstream">next server</link>.
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1038 The <literal>0</literal> value turns off this limitation.
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1039 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1040
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1041 </directive>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1042
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1043
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1044 <directive name="proxy_next_upstream_tries">
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1045 <syntax><value>number</value></syntax>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1046 <default>0</default>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1047 <context>http</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1048 <context>server</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1049 <context>location</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1050 <appeared-in>1.7.5</appeared-in>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1051
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1052 <para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1053 Limits the number of possible tries for passing a request to the
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1054 <link id="proxy_next_upstream">next server</link>.
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1055 The <literal>0</literal> value turns off this limitation.
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1056 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1057
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1058 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1059
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1060
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1061 <directive name="proxy_no_cache">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1062 <syntax><value>string</value> ...</syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1063 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1064 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1065 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1066 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1067
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1068 <para>
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	1069 Defines conditions under which the response will not be saved to a cache.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1070 If at least one value of the string parameters is not empty and is not
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	1071 equal to “0” then the response will not be saved:
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1072 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1073 proxy_no_cache $cookie_nocache $arg_nocache$arg_comment;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1074 proxy_no_cache $http_pragma $http_authorization;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1075 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1076 Can be used along with the <link id="proxy_cache_bypass"/> directive.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1077 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1078
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1079 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1080
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1081
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1082 <directive name="proxy_pass">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1083 <syntax><value>URL</value></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1084 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1085 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1086 <context>if in location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1087 <context>limit_except</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1088
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1089 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1090 Sets the protocol and address of a proxied server and an optional URI
535 f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1091 to which a location should be mapped.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1092 As a protocol, “<literal>http</literal>” or “<literal>https</literal>”
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1093 can be specified.
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1094 The address can be specified as a domain name or IP address,
535 f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1095 and an optional port:
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1096 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1097 proxy_pass http://localhost:8000/uri/;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1098 </example>
535 f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1099 or as a UNIX-domain socket path specified after the word
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1100 “<literal>unix</literal>” and enclosed in colons:
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1101 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1102 proxy_pass http://unix:/tmp/backend.socket:/uri/;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1103 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1104 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1105
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1106 <para>
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	1107 If a domain name resolves to several addresses, all of them will be
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1108 used in a round-robin fashion.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1109 In addition, an address can be specified as a
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1110 <link doc="ngx_http_upstream_module.xml">server group</link>.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1111 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1112
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1113 <para>
535 f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1114 A request URI is passed to the server as follows:
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1115 <list type="bullet" compact="no">
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1116
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1117 <listitem>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1118 If the <literal>proxy_pass</literal> directive is specified with a URI,
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1119 then when a request is passed to the server, the part of a
535 f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1120 <link doc="ngx_http_core_module.xml" id="location">normalized</link>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1121 request URI matching the location is replaced by a URI
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1122 specified in the directive:
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1123 <example>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1124 location /name/ {
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1125 proxy_pass http://127.0.0.1/remote/;
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1126 }
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1127 </example>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1128 </listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1129
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1130 <listitem>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1131 If <literal>proxy_pass</literal> is specified without a URI,
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1132 the request URI is passed to the server in the same form
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1133 as sent by a client when the original request is processed,
535 f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1134 or the full normalized request URI is passed
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1135 when processing the changed URI:
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1136 <example>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1137 location /some/path/ {
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1138 proxy_pass http://127.0.0.1;
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1139 }
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1140 </example>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1141 <note>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1142 Before version 1.1.12,
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1143 if <literal>proxy_pass</literal> is specified without a URI,
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1144 the original request URI might be passed
535 f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1145 instead of the changed URI in some cases.
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1146 </note>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1147 </listitem>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1148 </list>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1149 </para>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1150
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1151 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1152 In some cases, the part of a request URI to be replaced cannot be determined:
535 f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1153 <list type="bullet" compact="no">
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1154
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1155 <listitem>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1156 When location is specified using a regular expression.
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1157 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1158 In this case, the directive should be specified without a URI.
535 f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1159 </para>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1160 </listitem>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1161
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1162 <listitem>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1163 When the URI is changed inside a proxied location using the
535 f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1164 <link doc="ngx_http_rewrite_module.xml" id="rewrite"/> directive,
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1165 and this same configuration will be used to process a request
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1166 (<literal>break</literal>):
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1167 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1168 location /name/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1169 rewrite /name/([^/]+) /users?name=$1 break;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1170 proxy_pass http://127.0.0.1;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1171 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1172 </example>
535 f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1173 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1174 In this case, the URI specified in the directive is ignored and
535 f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1175 the full changed request URI is passed to the server.
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1176 </para>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1177 </listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1178 </list>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1179 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1180
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1181 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1182 A server name, its port and the passed URI can also be specified using
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1183 variables:
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1184 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1185 proxy_pass http://$host$uri;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1186 </example>
535 f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1187 or even like this:
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1188 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1189 proxy_pass $request;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1190 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1191 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1192
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1193 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1194 In this case, the server name is searched among the described
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1195 <link doc="ngx_http_upstream_module.xml">server groups</link>,
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1196 and, if not found, is determined using a
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1197 <link doc="ngx_http_core_module.xml" id="resolver"/>.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1198 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1199
849 0ed4c093c026 WebSocket proxying howto. Homutov Vladimir <vl@nginx.com> parents: 815 diff changeset	1200 <para>
0ed4c093c026 WebSocket proxying howto. Homutov Vladimir <vl@nginx.com> parents: 815 diff changeset	1201 <link doc="websocket.xml">WebSocket</link> proxying requires special
0ed4c093c026 WebSocket proxying howto. Homutov Vladimir <vl@nginx.com> parents: 815 diff changeset	1202 configuration and is supported since version 1.3.13.
0ed4c093c026 WebSocket proxying howto. Homutov Vladimir <vl@nginx.com> parents: 815 diff changeset	1203 </para>
0ed4c093c026 WebSocket proxying howto. Homutov Vladimir <vl@nginx.com> parents: 815 diff changeset	1204
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1205 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1206
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1207
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1208 <directive name="proxy_pass_header">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1209 <syntax><value>field</value></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1210 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1211 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1212 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1213 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1214
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1215 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1216 Permits passing <link id="proxy_hide_header">otherwise disabled</link> header
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1217 fields from a proxied server to a client.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1218 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1219
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1220 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1221
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1222
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1223 <directive name="proxy_read_timeout">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1224 <syntax><value>time</value></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1225 <default>60s</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1226 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1227 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1228 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1229
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1230 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1231 Defines a timeout for reading a response from the proxied server.
1149 1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1146 diff changeset	1232 The timeout is set only between two successive read operations,
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1233 not for the transmission of the whole response.
1149 1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1146 diff changeset	1234 If the proxied server does not transmit anything within this time,
1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1146 diff changeset	1235 the connection is closed.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1236 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1237
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1238 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1239
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1240
789 1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1241 <directive name="proxy_pass_request_body">
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1242 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1243 <default>on</default>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1244 <context>http</context>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1245 <context>server</context>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1246 <context>location</context>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1247
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1248 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	1249 Indicates whether the original request body is passed
789 1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1250 to the proxied server.
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1251 <example>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1252 location /x-accel-redirect-here/ {
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1253 proxy_method GET;
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1254 proxy_pass_request_body off;
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1255 proxy_set_header Content-Length "";
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1256
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1257 proxy_pass ...
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1258 }
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1259 </example>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1260 See also the <link id="proxy_set_header"/> and
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1261 <link id="proxy_pass_request_headers"/> directives.
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1262 </para>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1263
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1264 </directive>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1265
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1266
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1267 <directive name="proxy_pass_request_headers">
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1268 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1269 <default>on</default>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1270 <context>http</context>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1271 <context>server</context>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1272 <context>location</context>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1273
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1274 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	1275 Indicates whether the header fields of the original request are passed
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1276 to the proxied server.
789 1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1277 <example>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1278 location /x-accel-redirect-here/ {
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1279 proxy_method GET;
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1280 proxy_pass_request_headers off;
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1281 proxy_pass_request_body off;
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1282
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1283 proxy_pass ...
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1284 }
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1285 </example>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1286 See also the <link id="proxy_set_header"/> and
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1287 <link id="proxy_pass_request_body"/> directives.
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1288 </para>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1289
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1290 </directive>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1291
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1292
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1293 <directive name="proxy_redirect">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1294 <syntax><literal>default</literal></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1295 <syntax><literal>off</literal></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1296 <syntax><value>redirect</value> <value>replacement</value></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1297 <default>default</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1298 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1299 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1300 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1301
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1302 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1303 Sets the text that should be changed in the <header>Location</header>
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1304 and <header>Refresh</header> header fields of a proxied server response.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1305 Suppose a proxied server returned the header field
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1306 “<literal>Location: http://localhost:8000/two/some/uri/</literal>”.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1307 The directive
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1308 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1309 proxy_redirect http://localhost:8000/two/ http://frontend/one/;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1310 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1311 will rewrite this string to
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1312 “<literal>Location: http://frontend/one/some/uri/</literal>”.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1313 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1314
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1315 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1316 A server name may be omitted in the <value>replacement</value> string:
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1317 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1318 proxy_redirect http://localhost:8000/two/ /;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1319 </example>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1320 then the primary server’s name and port, if different from 80,
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1321 will be inserted.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1322 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1323
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1324 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1325 The default replacement specified by the <literal>default</literal> parameter
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1326 uses the parameters of the
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1327 <link doc="ngx_http_core_module.xml" id="location"/> and
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1328 <link id="proxy_pass"/> directives.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1329 Hence, the two configurations below are equivalent:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1330 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1331 location /one/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1332 proxy_pass http://upstream:port/two/;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1333 proxy_redirect default;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1334 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1335
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1336 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1337 location /one/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1338 proxy_pass http://upstream:port/two/;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1339 proxy_redirect http://upstream:port/two/ /one/;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1340 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1341 The <literal>default</literal> parameter is not permitted if
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1342 <link id="proxy_pass"/> is specified using variables.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1343 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1344
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1345 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1346 A <value>replacement</value> string can contain variables:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1347 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1348 proxy_redirect http://localhost:8000/ http://$host:$server_port/;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1349 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1350 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1351
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1352 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1353 A <value>redirect</value> can also contain (1.1.11) variables:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1354 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1355 proxy_redirect http://$proxy_host:8000/ /;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1356 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1357 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1358
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1359 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1360 The directive can be specified (1.1.11) using regular expressions.
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1361 In this case, <value>redirect</value> should either start with
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1362 the “<literal>~</literal>” symbol for a case-sensitive matching,
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1363 or with the “<literal>~*</literal>” symbols for case-insensitive
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1364 matching.
1149 1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1146 diff changeset	1365 The regular expression can contain named and positional captures,
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1366 and <value>replacement</value> can reference them:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1367 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1368 proxy_redirect ~^(http://[^:]+):\d+(/.+)$ $1$2;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1369 proxy_redirect ~*/user/([^/]+)/(.+)$ http://$1.example.com/$2;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1370 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1371 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1372
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1373 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1374 There could be several <literal>proxy_redirect</literal> directives:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1375 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1376 proxy_redirect default;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1377 proxy_redirect http://localhost:8000/ /;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1378 proxy_redirect http://www.example.com/ /;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1379 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1380 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1381
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1382 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1383 The <literal>off</literal> parameter cancels the effect of all
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1384 <literal>proxy_redirect</literal> directives on the current level:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1385 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1386 proxy_redirect off;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1387 proxy_redirect default;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1388 proxy_redirect http://localhost:8000/ /;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1389 proxy_redirect http://www.example.com/ /;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1390 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1391 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1392
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1393 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1394 Using this directive, it is also possible to add host names to relative
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1395 redirects issued by a proxied server:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1396 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1397 proxy_redirect / /;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1398 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1399 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1400
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1401 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1402
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1403
773 24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1404 <directive name="proxy_send_lowat">
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1405 <syntax><value>size</value></syntax>
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1406 <default>0</default>
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1407 <context>http</context>
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1408 <context>server</context>
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1409 <context>location</context>
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1410
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1411 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1412 If the directive is set to a non-zero value, nginx will try to
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1413 minimize the number
773 24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1414 of send operations on outgoing connections to a proxied server by using either
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1415 <c-def>NOTE_LOWAT</c-def> flag of the
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1416 <link doc="../events.xml" id="kqueue"/> method,
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1417 or the <c-def>SO_SNDLOWAT</c-def> socket option,
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1418 with the specified <value>size</value>.
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1419 </para>
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1420
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1421 <para>
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1422 This directive is ignored on Linux, Solaris, and Windows.
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1423 </para>
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1424
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1425 </directive>
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1426
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1427
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1428 <directive name="proxy_send_timeout">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1429 <syntax><value>time</value></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1430 <default>60s</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1431 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1432 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1433 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1434
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1435 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1436 Sets a timeout for transmitting a request to the proxied server.
1149 1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1146 diff changeset	1437 The timeout is set only between two successive write operations,
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1438 not for the transmission of the whole request.
1149 1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1146 diff changeset	1439 If the proxied server does not receive anything within this time,
1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1146 diff changeset	1440 the connection is closed.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1441 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1442
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1443 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1444
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1445
787 180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1446 <directive name="proxy_set_body">
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1447 <syntax><value>value</value></syntax>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1448 <default/>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1449 <context>http</context>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1450 <context>server</context>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1451 <context>location</context>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1452
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1453 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1454 Allows redefining the request body passed to the proxied server.
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	1455 The <value>value</value> can contain text, variables, and their combination.
787 180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1456 </para>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1457
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1458 </directive>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1459
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1460
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1461 <directive name="proxy_set_header">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1462 <syntax><value>field</value> <value>value</value></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1463 <default>Host $proxy_host</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1464 <default>Connection close</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1465 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1466 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1467 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1468
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1469 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1470 Allows redefining or appending fields to the request header
789 1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1471 <link id="proxy_pass_request_headers">passed</link> to the proxied server.
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	1472 The <value>value</value> can contain text, variables, and their combinations.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1473 These directives are inherited from the previous level if and
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1474 only if there are no
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1475 <literal>proxy_set_header</literal>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1476 directives defined on the current level.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1477 By default, only two fields are redefined:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1478 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1479 proxy_set_header Host $proxy_host;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1480 proxy_set_header Connection close;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1481 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1482 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1483
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1484 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1485 An unchanged <header>Host</header> request header field can be passed like this:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1486 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1487 proxy_set_header Host $http_host;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1488 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1489 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1490
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1491 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1492 However, if this field is not present in a client request header then
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1493 nothing will be passed.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1494 In such a case it is better to use the <var>$host</var> variable—its
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1495 value equals the server name in the <header>Host</header> request header
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1496 field or the primary server name if this field is not present:
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1497 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1498 proxy_set_header Host $host;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1499 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1500 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1501
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1502 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1503 In addition, the server name can be passed together with the port of the
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1504 proxied server:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1505 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1506 proxy_set_header Host $host:$proxy_port;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1507 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1508 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1509
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1510 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1511 If the value of a header field is an empty string then this
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1512 field will not be passed to a proxied server:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1513 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1514 proxy_set_header Accept-Encoding "";
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1515 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1516 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1517
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1518 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1519
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1520
993 a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1521 <directive name="proxy_ssl_ciphers">
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1522 <syntax><value>ciphers</value></syntax>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1523 <default>DEFAULT</default>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1524 <context>http</context>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1525 <context>server</context>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1526 <context>location</context>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1527 <appeared-in>1.5.6</appeared-in>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1528
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1529 <para>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1530 Specifies the enabled ciphers for requests to a proxied HTTPS server.
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1531 The ciphers are specified in the format understood by the OpenSSL library.
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1532 </para>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1533
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1534 <para>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1535 The full list can be viewed using the
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1536 “<command>openssl ciphers</command>” command.
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1537 </para>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1538
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1539 </directive>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1540
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1541
1166 1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1542 <directive name="proxy_ssl_crl">
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1543 <syntax><value>file</value></syntax>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1544 <default/>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1545 <context>http</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1546 <context>server</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1547 <context>location</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1548 <appeared-in>1.7.0</appeared-in>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1549
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1550 <para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1551 Specifies a <value>file</value> with revoked certificates (CRL)
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1552 in the PEM format used to <link id="proxy_ssl_verify">verify</link>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1553 the certificate of the proxied HTTPS server.
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1554 </para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1555
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1556 </directive>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1557
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1558
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1559 <directive name="proxy_ssl_name">
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1560 <syntax><value>name</value></syntax>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1561 <default>$proxy_host</default>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1562 <context>http</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1563 <context>server</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1564 <context>location</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1565 <appeared-in>1.7.0</appeared-in>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1566
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1567 <para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1568 Allows to override the server name used to
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1569 <link id="proxy_ssl_verify">verify</link>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1570 the certificate of the proxied HTTPS server and to be
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1571 <link id="proxy_ssl_server_name">passed through SNI</link>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1572 when establishing a connection with the proxied HTTPS server.
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1573 </para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1574
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1575 <para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1576 By default, the host part of the <link id="proxy_pass"/> URL is used.
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1577 </para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1578
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1579 </directive>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1580
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1581
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1582 <directive name="proxy_ssl_server_name">
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1583 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1584 <default>off</default>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1585 <context>http</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1586 <context>server</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1587 <context>location</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1588 <appeared-in>1.7.0</appeared-in>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1589
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1590 <para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1591 Enables or disables passing of the server name through
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1592 <link url="http://en.wikipedia.org/wiki/Server_Name_Indication">TLS
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1593 Server Name Indication extension</link> (SNI, RFC 6066)
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1594 when establishing a connection with the proxied HTTPS server.
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1595 </para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1596
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1597 </directive>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1598
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1599
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1600 <directive name="proxy_ssl_session_reuse">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1601 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1602 <default>on</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1603 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1604 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1605 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1606
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1607 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1608 Determines whether SSL sessions can be reused when working with
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1609 the proxied server.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1610 If the errors
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1611 “<literal>SSL3_GET_FINISHED:digest check failed</literal>”
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1612 appear in the logs, try disabling session reuse.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1613 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1614
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1615 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1616
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1617
985 e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1618 <directive name="proxy_ssl_protocols">
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1619 <syntax>
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1620 [<literal>SSLv2</literal>]
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1621 [<literal>SSLv3</literal>]
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1622 [<literal>TLSv1</literal>]
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1623 [<literal>TLSv1.1</literal>]
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1624 [<literal>TLSv1.2</literal>]</syntax>
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1625 <default>SSLv3 TLSv1 TLSv1.1 TLSv1.2</default>
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1626 <context>http</context>
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1627 <context>server</context>
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1628 <context>location</context>
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1629 <appeared-in>1.5.6</appeared-in>
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1630
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1631 <para>
993 a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1632 Enables the specified protocols for requests to a proxied HTTPS server.
985 e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1633 </para>
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1634
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1635 </directive>
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1636
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1637
1166 1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1638 <directive name="proxy_ssl_trusted_certificate">
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1639 <syntax><value>file</value></syntax>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1640 <default/>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1641 <context>http</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1642 <context>server</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1643 <context>location</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1644 <appeared-in>1.7.0</appeared-in>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1645
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1646 <para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1647 Specifies a <value>file</value> with trusted CA certificates in the PEM format
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1648 used to <link id="proxy_ssl_verify">verify</link>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1649 the certificate of the proxied HTTPS server.
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1650 </para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1651
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1652 </directive>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1653
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1654
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1655 <directive name="proxy_ssl_verify">
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1656 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1657 <default>off</default>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1658 <context>http</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1659 <context>server</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1660 <context>location</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1661 <appeared-in>1.7.0</appeared-in>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1662
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1663 <para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1664 Enables or disables verification of the proxied HTTPS server certificate.
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1665 </para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1666
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1667 </directive>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1668
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1669
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1670 <directive name="proxy_ssl_verify_depth">
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1671 <syntax><value>number</value></syntax>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1672 <default>1</default>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1673 <context>http</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1674 <context>server</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1675 <context>location</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1676 <appeared-in>1.7.0</appeared-in>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1677
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1678 <para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1679 Sets the verification depth in the proxied HTTPS server certificates chain.
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1680 </para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1681
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1682 </directive>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1683
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1684
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1685 <directive name="proxy_store">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1686 <syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1687 <literal>on</literal> \|
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1688 <literal>off</literal> \|
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1689 <value>string</value></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1690 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1691 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1692 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1693 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1694
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1695 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1696 Enables saving of files to a disk.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1697 The <literal>on</literal> parameter saves files with paths
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1698 corresponding to the directives
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1699 <link doc="ngx_http_core_module.xml" id="alias"/> or
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1700 <link doc="ngx_http_core_module.xml" id="root"/>.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1701 The <literal>off</literal> parameter disables saving of files.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1702 In addition, the file name can be set explicitly using the
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1703 <value>string</value> with variables:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1704 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1705 proxy_store /data/www$original_uri;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1706 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1707 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1708
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1709 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1710 The modification time of files is set according to the received
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1711 <header>Last-Modified</header> response header field.
1149 1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1146 diff changeset	1712 The response is first written to a temporary file,
1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1146 diff changeset	1713 and then the file is renamed.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1714 Starting from version 0.8.9, temporary files and the persistent store
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	1715 can be put on different file systems.
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	1716 However, be aware that in this case a file is copied
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	1717 across two file systems instead of the cheap renaming operation.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1718 It is thus recommended that for any given location both saved files and a
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	1719 directory holding temporary files, set by the <link id="proxy_temp_path"/>
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	1720 directive, are put on the same file system.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1721 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1722
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1723 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1724 This directive can be used to create local copies of static unchangeable
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1725 files, e.g.:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1726 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1727 location /images/ {
1005 2275611970dd Removed open_file_cache_errors from proxy_store examples. Maxim Dounin <mdounin@mdounin.ru> parents: 993 diff changeset	1728 root /data/www;
2275611970dd Removed open_file_cache_errors from proxy_store examples. Maxim Dounin <mdounin@mdounin.ru> parents: 993 diff changeset	1729 error_page 404 = /fetch$uri;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1730 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1731
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1732 location /fetch/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1733 internal;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1734
1005 2275611970dd Removed open_file_cache_errors from proxy_store examples. Maxim Dounin <mdounin@mdounin.ru> parents: 993 diff changeset	1735 proxy_pass http://backend/;
2275611970dd Removed open_file_cache_errors from proxy_store examples. Maxim Dounin <mdounin@mdounin.ru> parents: 993 diff changeset	1736 proxy_store on;
2275611970dd Removed open_file_cache_errors from proxy_store examples. Maxim Dounin <mdounin@mdounin.ru> parents: 993 diff changeset	1737 proxy_store_access user:rw group:rw all:r;
2275611970dd Removed open_file_cache_errors from proxy_store examples. Maxim Dounin <mdounin@mdounin.ru> parents: 993 diff changeset	1738 proxy_temp_path /data/temp;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1739
1005 2275611970dd Removed open_file_cache_errors from proxy_store examples. Maxim Dounin <mdounin@mdounin.ru> parents: 993 diff changeset	1740 alias /data/www/;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1741 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1742 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1743 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1744
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1745 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1746 or like this:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1747 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1748 location /images/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1749 root /data/www;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1750 error_page 404 = @fetch;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1751 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1752
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1753 location @fetch {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1754 internal;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1755
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1756 proxy_pass http://backend;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1757 proxy_store on;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1758 proxy_store_access user:rw group:rw all:r;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1759 proxy_temp_path /data/temp;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1760
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1761 root /data/www;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1762 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1763 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1764 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1765
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1766 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1767
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1768
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1769 <directive name="proxy_store_access">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1770 <syntax><value>users</value>:<value>permissions</value> ...</syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1771 <default>user:rw</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1772 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1773 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1774 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1775
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1776 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1777 Sets access permissions for newly created files and directories, e.g.:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1778 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1779 proxy_store_access user:rw group:rw all:r;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1780 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1781 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1782
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1783 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1784 If any <literal>group</literal> or <literal>all</literal> access permissions
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1785 are specified then <literal>user</literal> permissions may be omitted:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1786 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1787 proxy_store_access group:rw all:r;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1788 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1789 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1790
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1791 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1792
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1793
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1794 <directive name="proxy_temp_file_write_size">
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1795 <syntax><value>size</value></syntax>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1796 <default>8k\|16k</default>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1797 <context>http</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1798 <context>server</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1799 <context>location</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1800
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1801 <para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1802 Limits the <value>size</value> of data written to a temporary file
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1803 at a time, when buffering of responses from the proxied server
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1804 to temporary files is enabled.
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1805 By default, <value>size</value> is limited by two buffers set by the
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1806 <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/> directives.
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1807 The maximum size of a temporary file is set by the
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1808 <link id="proxy_max_temp_file_size"/> directive.
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1809 </para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1810
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1811 </directive>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1812
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1813
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1814 <directive name="proxy_temp_path">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1815 <syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1816 <value>path</value>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1817 [<value>level1</value>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1818 [<value>level2</value>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1819 [<value>level3</value>]]]</syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1820 <default>proxy_temp</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1821 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1822 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1823 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1824
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1825 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1826 Defines a directory for storing temporary files
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1827 with data received from proxied servers.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1828 Up to three-level subdirectory hierarchy can be used underneath the specified
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1829 directory.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1830 For example, in the following configuration
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1831 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1832 proxy_temp_path /spool/nginx/proxy_temp 1 2;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1833 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1834 a temporary file might look like this:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1835 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1836 /spool/nginx/proxy_temp/<emphasis>7</emphasis>/<emphasis>45</emphasis>/00000123<emphasis>457</emphasis>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1837 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1838 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1839
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1840 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1841
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1842 </section>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1843
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1844
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1845 <section id="variables" name="Embedded Variables">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1846
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1847 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1848 The <literal>ngx_http_proxy_module</literal> module supports embedded variables
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1849 that can be used to compose headers using the
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1850 <link id="proxy_set_header"/> directive:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1851 <list type="tag">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1852
1155 07402a11fd8d Assigned IDs to tags describing variables. Vladimir Homutov <vl@nginx.com> parents: 1153 diff changeset	1853 <tag-name id="var_proxy_host"><var>$proxy_host</var></tag-name>
1298 c459ca97c14d Updated description of $proxy_host and $proxy_port variables. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	1854 <tag-desc>name and port of a proxied server as specified in the
c459ca97c14d Updated description of $proxy_host and $proxy_port variables. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	1855 <link id="proxy_pass"/> directive;</tag-desc>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1856
1155 07402a11fd8d Assigned IDs to tags describing variables. Vladimir Homutov <vl@nginx.com> parents: 1153 diff changeset	1857 <tag-name id="var_proxy_port"><var>$proxy_port</var></tag-name>
1298 c459ca97c14d Updated description of $proxy_host and $proxy_port variables. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	1858 <tag-desc>port of a proxied server as specified in the
c459ca97c14d Updated description of $proxy_host and $proxy_port variables. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	1859 <link id="proxy_pass"/> directive, or the protocol’s default port;</tag-desc>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1860
1155 07402a11fd8d Assigned IDs to tags describing variables. Vladimir Homutov <vl@nginx.com> parents: 1153 diff changeset	1861 <tag-name id="var_proxy_add_x_forwarded_for">
07402a11fd8d Assigned IDs to tags describing variables. Vladimir Homutov <vl@nginx.com> parents: 1153 diff changeset	1862 <var>$proxy_add_x_forwarded_for</var></tag-name>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1863 <tag-desc>the <header>X-Forwarded-For</header> client request header field
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1864 with the <var>$remote_addr</var> variable appended to it, separated by a comma.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1865 If the <header>X-Forwarded-For</header> field is not present in the client
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1866 request header, the <var>$proxy_add_x_forwarded_for</var> variable is equal
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1867 to the <var>$remote_addr</var> variable.</tag-desc>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1868 </list>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1869 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1870
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1871 </section>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1872
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1873 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_proxy_module.xml @ 1345:da296387cdac