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

annotate xml/en/docs/http/ngx_http_proxy_module.xml @ 1669:c872b93682f4

Added "non_idempotent" for proxy_next_upstream and friends.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Tue, 29 Mar 2016 18:21:11 +0300
parents	680cbf783efe
children	9c98c4498f08

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"
1669 c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	13 rev="45">
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>
1547 c340ebfeeed6 Deleted duplicate word in proxy_buffer_size for http. Yaroslav Zhuravlev <yar@nginx.com> parents: 1542 diff changeset	71 Sets the <value>size</value> of the buffer used for reading the first part
1151 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.
1550 305f2c338181 Fixed description of default value of proxy_buffer_size and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1547 diff changeset	74 By default, the buffer size is equal to one memory page.
305f2c338181 Fixed description of default value of proxy_buffer_size and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1547 diff changeset	75 This is either 4K or 8K, depending on a platform.
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.
1382 94cac978bda3 Documented variables support in proxy_cache and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1376 diff changeset	172 Parameter value can contain variables (1.7.9).
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	173 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	174 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	175 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	176
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	177 </directive>
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
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	180 <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	181 <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	182 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	183 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	184 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	185 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	186
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	187 <para>
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	188 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	189 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	190 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	191 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	192 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	193 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	194 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	195 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	196 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	197
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	198 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	199
1599 12714bbf9230 Documented the "proxy_cache_convert_head" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	200 <directive name="proxy_cache_convert_head">
12714bbf9230 Documented the "proxy_cache_convert_head" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	201 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
12714bbf9230 Documented the "proxy_cache_convert_head" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	202 <default>on</default>
12714bbf9230 Documented the "proxy_cache_convert_head" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	203 <context>http</context>
12714bbf9230 Documented the "proxy_cache_convert_head" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	204 <context>server</context>
12714bbf9230 Documented the "proxy_cache_convert_head" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	205 <context>location</context>
12714bbf9230 Documented the "proxy_cache_convert_head" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	206 <appeared-in>1.9.7</appeared-in>
12714bbf9230 Documented the "proxy_cache_convert_head" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	207
12714bbf9230 Documented the "proxy_cache_convert_head" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	208 <para>
12714bbf9230 Documented the "proxy_cache_convert_head" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	209 Enables or disables the conversion of the “<literal>HEAD</literal>” method
12714bbf9230 Documented the "proxy_cache_convert_head" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	210 to “<literal>GET</literal>” for caching.
12714bbf9230 Documented the "proxy_cache_convert_head" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	211 When the conversion is disabled, the
12714bbf9230 Documented the "proxy_cache_convert_head" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	212 <link id="proxy_cache_key">cache key</link> should be configured
12714bbf9230 Documented the "proxy_cache_convert_head" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	213 to include the <var>$request_method</var>.
12714bbf9230 Documented the "proxy_cache_convert_head" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	214 </para>
12714bbf9230 Documented the "proxy_cache_convert_head" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	215
12714bbf9230 Documented the "proxy_cache_convert_head" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	216 </directive>
12714bbf9230 Documented the "proxy_cache_convert_head" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	217
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	218
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	219 <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	220 <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	221 <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	222 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	223 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	224 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	225
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	226 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	227 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	228 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	229 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	230 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	231 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	232 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	233 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	234 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	235 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	236
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	237 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	238
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	239
302 df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	240 <directive name="proxy_cache_lock">
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	241 <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	242 <default>off</default>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	243 <context>http</context>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	244 <context>server</context>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	245 <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	246 <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	247
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	248 <para>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	249 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	250 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	251 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	252 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	253 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	254 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	255 <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	256 </para>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	257
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	258 </directive>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	259
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	260
1376 6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	261 <directive name="proxy_cache_lock_age">
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	262 <syntax><value>time</value></syntax>
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	263 <default>5s</default>
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	264 <context>http</context>
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	265 <context>server</context>
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	266 <context>location</context>
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	267 <appeared-in>1.7.8</appeared-in>
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	268
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	269 <para>
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	270 If the last request passed to the proxied server
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	271 for populating a new cache element
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	272 has not completed for the specified <value>time</value>,
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	273 one more request may be passed to the proxied server.
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	274 </para>
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	275
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	276 </directive>
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	277
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	278
302 df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	279 <directive name="proxy_cache_lock_timeout">
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	280 <syntax><value>time</value></syntax>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	281 <default>5s</default>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	282 <context>http</context>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	283 <context>server</context>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	284 <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	285 <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	286
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	287 <para>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	288 Sets a timeout for <link id="proxy_cache_lock"/>.
1376 6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	289 When the <value>time</value> expires,
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	290 the request will be passed to the proxied server,
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	291 however, the response will not be cached.
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	292 <note>
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	293 Before 1.7.8, the response could be cached.
6e54b85dfb86 Documented the "proxy_cache_lock_age" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1372 diff changeset	294 </note>
302 df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	295 </para>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	296
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	297 </directive>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	298
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	299
790 ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	300 <directive name="proxy_cache_methods">
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	301 <syntax>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	302 <literal>GET</literal> \|
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	303 <literal>HEAD</literal> \|
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	304 <literal>POST</literal>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	305 ...</syntax>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	306 <default>GET HEAD</default>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	307 <context>http</context>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	308 <context>server</context>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	309 <context>location</context>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	310 <appeared-in>0.7.59</appeared-in>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	311
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	312 <para>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	313 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	314 the response will be cached.
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	315 “<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	316 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	317 See also the <link id="proxy_no_cache"/> directive.
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	318 </para>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	319
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	320 </directive>
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	321
ae776a353984 Documented "proxy_cache_methods" directive. Vladimir Homutov <vl@nginx.com> parents: 789 diff changeset	322
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	323 <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	324 <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	325 <default>1</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	326 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	327 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	328 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	329
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	330 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	331 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	332 will be cached.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	333 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	334
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	335 </directive>
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
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	338 <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	339 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	340 <value>path</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	341 [<literal>levels</literal>=<value>levels</value>]
1384 66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	342 [<literal>use_temp_path</literal>=<literal>on</literal>\|<literal>off</literal>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	343 <literal>keys_zone</literal>=<value>name</value>:<value>size</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	344 [<literal>inactive</literal>=<value>time</value>]
508 5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	345 [<literal>max_size</literal>=<value>size</value>]
5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	346 [<literal>loader_files</literal>=<value>number</value>]
5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	347 [<literal>loader_sleep</literal>=<value>time</value>]
1582 8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	348 [<literal>loader_threshold</literal>=<value>time</value>]
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	349 [<literal>purger</literal>=<literal>on</literal>\|<literal>off</literal>]
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	350 [<literal>purger_files</literal>=<value>number</value>]
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	351 [<literal>purger_sleep</literal>=<value>time</value>]
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	352 [<literal>purger_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	353 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	354 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	355
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	356 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	357 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	358 Cache data are stored in files.
1190 dd4cfc6ce770 Corrected description of _cache_path file names. Ruslan Ermilov <ru@nginx.com>* parents: 1189 diff changeset	359 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	360 applying the MD5 function to the
dd4cfc6ce770 Corrected description of _cache_path file names. Ruslan Ermilov <ru@nginx.com>* parents: 1189 diff changeset	361 <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	362 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	363 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	364 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	365 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	366 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	367 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	368 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	369 /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	370 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	371 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	372
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	373 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	374 A cached response is first written to a temporary file,
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	375 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	376 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	377 different file systems.
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	378 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	379 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	380 It is thus recommended that for any given location both cache and a directory
1384 66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	381 holding temporary files
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	382 are put on the same file system.
1414 5addfab7e171 Corrected article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	383 The directory for temporary files is set based on
1384 66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	384 the <literal>use_temp_path</literal> parameter (1.7.10).
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	385 If this parameter is omitted or set to the value <literal>on</literal>,
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	386 the directory set by the <link id="proxy_temp_path"/> directive
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	387 for the given location will be used.
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	388 If the value is set to <literal>off</literal>,
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	389 temporary files will be put directly in the cache directory.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	390 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	391
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	392 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	393 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	394 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	395 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	396 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	397 </para>
f25d00109de0 Documented cache keys_zone memory estimates. Maxim Dounin <mdounin@mdounin.ru> parents: 1166 diff changeset	398
f25d00109de0 Documented cache keys_zone memory estimates. Maxim Dounin <mdounin@mdounin.ru> parents: 1166 diff changeset	399 <para>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	400 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	401 <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	402 regardless of their freshness.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	403 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	404 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	405
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	406 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	407 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	408 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	409 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	410 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	411
508 5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	412 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	413 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	414 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	415 into a cache zone.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	416 The loading is done in iterations.
508 5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	417 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	418 are loaded (by default, 100).
5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	419 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	420 <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	421 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	422 parameter (by default, 50 milliseconds) is made.
508 5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	423 </para>
5e332fafd228 Documented "cache loader" and its parameters. Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	424
1582 8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	425 <para>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	426 Additionally,
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	427 the following parameters are available as part of our
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	428 <commercial_version>commercial subscription</commercial_version>:
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	429 </para>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	430
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	431 <para>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	432 <list type="tag">
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	433
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	434 <tag-name id="purger">
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	435 <literal>purger</literal>=<literal>on</literal>\|<literal>off</literal>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	436 </tag-name>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	437 <tag-desc>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	438 Instructs whether cache entries that match a
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	439 <link id="proxy_cache_purge">wildcard key</link>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	440 will be removed from the disk by the cache purger (1.7.12).
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	441 Setting the parameter to <literal>on</literal>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	442 (default is <literal>off</literal>)
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	443 will activate the “cache purger” process that
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	444 permanently iterates through all cache entries
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	445 and deletes the entries that match the wildcard key.
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	446 </tag-desc>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	447
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	448 <tag-name id="purger_files">
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	449 <literal>purger_files</literal>=<value>number</value>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	450 </tag-name>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	451 <tag-desc>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	452 Sets the number of items that will be scanned during one iteration (1.7.12).
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	453 By default, <literal>purger_files</literal> is set to 10.
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	454 </tag-desc>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	455
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	456 <tag-name id="purger_threshold">
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	457 <literal>purger_threshold</literal>=<value>number</value>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	458 </tag-name>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	459 <tag-desc>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	460 Sets the duration of one iteration (1.7.12).
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	461 By default, <literal>purger_threshold</literal> is set to 50 milliseconds.
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	462 </tag-desc>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	463
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	464 <tag-name id="purger_sleep">
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	465 <literal>purger_sleep</literal>=<value>number</value>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	466 </tag-name>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	467 <tag-desc>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	468 Sets a pause between iterations (1.7.12).
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	469 By default, <literal>purger_sleep</literal> is set to 50 milliseconds.
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	470 </tag-desc>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	471
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	472 </list>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	473 </para>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	474
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	475 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	476
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	477
1028 e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	478 <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	479 <syntax>string ...</syntax>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	480 <default/>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	481 <context>http</context>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	482 <context>server</context>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	483 <context>location</context>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	484 <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	485
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	486 <para>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	487 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	488 purge request.
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	489 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	490 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	491 <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	492 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	493 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	494 </para>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	495
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	496 <para>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	497 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	498 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	499 wildcard key will be removed from the cache.
1582 8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	500 However, these entries will remain on the disk until they are deleted
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	501 for either <link id="proxy_cache_path">inactivity</link>,
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	502 or processed by the <link id="purger">cache purger</link> (1.7.12),
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	503 or a client attempts to access them.
1028 e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	504 </para>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	505
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	506 <para>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	507 Example configuration:
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	508 <example>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	509 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	510
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	511 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	512 PURGE 1;
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	513 default 0;
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	514 }
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	515
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	516 server {
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	517 ...
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	518 location / {
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	519 proxy_pass http://backend;
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	520 proxy_cache cache_zone;
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	521 proxy_cache_key $uri;
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	522 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	523 }
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	524 }
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	525 </example>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	526 <note>
1128 1594ed379f1f De-i18n'ed <commercial_version/>. Ruslan Ermilov <ru@nginx.com> parents: 1088 diff changeset	527 This functionality is available as part of our
1594ed379f1f De-i18n'ed <commercial_version/>. Ruslan Ermilov <ru@nginx.com> parents: 1088 diff changeset	528 <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	529 </note>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	530 </para>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	531
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	532 </directive>
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	533
e582a10b1917 Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives. Vladimir Homutov <vl@nginx.com> parents: 1015 diff changeset	534
1011 2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	535 <directive name="proxy_cache_revalidate">
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	536 <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	537 <default>off</default>
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	538 <context>http</context>
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	539 <context>server</context>
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	540 <context>location</context>
1015 af77dd40abeb Documented the appearance of "fastcgi_" and "proxy_cache_revalidate". Vladimir Homutov <vl@nginx.com> parents: 1011 diff changeset	541 <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	542
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	543 <para>
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	544 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	545 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	546 header fields.
1011 2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	547 </para>
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	548
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	549 </directive>
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	550
2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1005 diff changeset	551
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	552 <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	553 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	554 <literal>error</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	555 <literal>timeout</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	556 <literal>invalid_header</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	557 <literal>updating</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	558 <literal>http_500</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	559 <literal>http_502</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	560 <literal>http_503</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	561 <literal>http_504</literal> \|
917 e26a18eb5ccd Documented http_403 in proxy_next_upstream and friends. Maxim Dounin <mdounin@mdounin.ru> parents: 907 diff changeset	562 <literal>http_403</literal> \|
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	563 <literal>http_404</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	564 <literal>off</literal>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	565 ...</syntax>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	566 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	567 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	568 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	569 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	570
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	571 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	572 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	573 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	574 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	575 <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	576 </para>
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	577
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	578 <para>
1542 a13a99cf46ea Better documented "_cache_use_stale error". Ruslan Ermilov <ru@nginx.com>* parents: 1524 diff changeset	579 The <literal>error</literal> parameter also permits
a13a99cf46ea Better documented "_cache_use_stale error". Ruslan Ermilov <ru@nginx.com>* parents: 1524 diff changeset	580 using a stale cached response if a proxied server to process a request
a13a99cf46ea Better documented "_cache_use_stale error". Ruslan Ermilov <ru@nginx.com>* parents: 1524 diff changeset	581 cannot be selected.
a13a99cf46ea Better documented "_cache_use_stale error". Ruslan Ermilov <ru@nginx.com>* parents: 1524 diff changeset	582 </para>
a13a99cf46ea Better documented "_cache_use_stale error". Ruslan Ermilov <ru@nginx.com>* parents: 1524 diff changeset	583
a13a99cf46ea Better documented "_cache_use_stale error". Ruslan Ermilov <ru@nginx.com>* parents: 1524 diff changeset	584 <para>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	585 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	586 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	587 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	588 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	589 </para>
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	590
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	591 <para>
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	592 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	593 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	594 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	595 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	596
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	597 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	598
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	599
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	600 <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	601 <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	602 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	603 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	604 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	605 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	606
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	607 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	608 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	609 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	610 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	611 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	612 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	613 </example>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	614 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	615 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	616 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	617
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	618 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	619 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	620 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	621 proxy_cache_valid 5m;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	622 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	623 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	624 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	625
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	626 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	627 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	628 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	629 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	630 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	631 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	632 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	633 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	634 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	635
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	636 <para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	637 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	638 in the response header.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	639 This has higher priority than setting of caching time using the directive.
1349 97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	640 <list type="bullet" compact="no">
97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	641
97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	642 <listitem>
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	643 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	644 response in seconds.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	645 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	646 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	647 time in seconds since Epoch, up to which the response may be cached.
1349 97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	648 </listitem>
97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	649
97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	650 <listitem>
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	651 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	652 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	653 <header>Expires</header> or <header>Cache-Control</header>.
1349 97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	654 </listitem>
97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	655
97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	656 <listitem>
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	657 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	658 response will not be cached.
1349 97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	659 </listitem>
97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	660
1353 25db29c8875e Documented how the "Vary" response header field affects caching. Ruslan Ermilov <ru@nginx.com> parents: 1352 diff changeset	661 <listitem>
25db29c8875e Documented how the "Vary" response header field affects caching. Ruslan Ermilov <ru@nginx.com> parents: 1352 diff changeset	662 If the header includes the <header>Vary</header> field
25db29c8875e Documented how the "Vary" response header field affects caching. Ruslan Ermilov <ru@nginx.com> parents: 1352 diff changeset	663 with the special value “<literal>*</literal>”, such a
25db29c8875e Documented how the "Vary" response header field affects caching. Ruslan Ermilov <ru@nginx.com> parents: 1352 diff changeset	664 response will not be cached (1.7.7).
25db29c8875e Documented how the "Vary" response header field affects caching. Ruslan Ermilov <ru@nginx.com> parents: 1352 diff changeset	665 If the header includes the <header>Vary</header> field
25db29c8875e Documented how the "Vary" response header field affects caching. Ruslan Ermilov <ru@nginx.com> parents: 1352 diff changeset	666 with another value, such a response will be cached
25db29c8875e Documented how the "Vary" response header field affects caching. Ruslan Ermilov <ru@nginx.com> parents: 1352 diff changeset	667 taking into account the corresponding request header fields (1.7.7).
25db29c8875e Documented how the "Vary" response header field affects caching. Ruslan Ermilov <ru@nginx.com> parents: 1352 diff changeset	668 </listitem>
25db29c8875e Documented how the "Vary" response header field affects caching. Ruslan Ermilov <ru@nginx.com> parents: 1352 diff changeset	669
1349 97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	670 </list>
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	671 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	672 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	673 </para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	674
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	675 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	676
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	677
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	678 <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	679 <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	680 <default>60s</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	681 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	682 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	683 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	684
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	685 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	686 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	687 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	688 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	689
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	690 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	691
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	692
417 cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	693 <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	694 <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	695 <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	696 <default>off</default>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	697 <context>http</context>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	698 <context>server</context>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	699 <context>location</context>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	700 <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	701
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	702 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	703 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	704 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	705 proxied server response.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	706 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	707 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	708 “<literal>domain=localhost</literal>”.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	709 The directive
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	710 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	711 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	712 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	713 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	714 “<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	715 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	716
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	717 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	718 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	719 <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	720 attribute is ignored.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	721 Matching is case-insensitive.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	722 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	723
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	724 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	725 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	726 can contain variables:
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	727 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	728 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	729 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	730 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	731
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	732 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	733 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	734 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	735 the “<literal>~</literal>” symbol.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	736 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	737 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	738 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	739 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	740 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	741 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	742
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	743 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	744 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	745 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	746 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	747 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	748 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	749 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	750
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	751 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	752 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	753 <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	754 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	755 proxy_cookie_domain off;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	756 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	757 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	758 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	759 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	760
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	761 </directive>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	762
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	763
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	764 <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	765 <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	766 <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	767 <default>off</default>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	768 <context>http</context>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	769 <context>server</context>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	770 <context>location</context>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	771 <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	772
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	773 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	774 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	775 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	776 proxied server response.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	777 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	778 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	779 “<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	780 The directive
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	781 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	782 proxy_cookie_path /two/ /;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	783 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	784 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	785 “<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	786 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	787
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	788 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	789 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	790 can contain variables:
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	791 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	792 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	793 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	794 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	795
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	796 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	797 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	798 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	799 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	800 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	801 matching.
1149 1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1146 diff changeset	802 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	803 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	804 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	805 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	806 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	807 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	808
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	809 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	810 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	811 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	812 proxy_cookie_path /one/ /;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	813 proxy_cookie_path / /two/;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	814 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	815 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	816
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	817 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	818 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	819 <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	820 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	821 proxy_cookie_path off;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	822 proxy_cookie_path /two/ /;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	823 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	824 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	825 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	826
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	827 </directive>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	828
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	829
1337 91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	830 <directive name="proxy_force_ranges">
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	831 <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	832 <default>off</default>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	833 <context>http</context>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	834 <context>server</context>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	835 <context>location</context>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	836 <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	837
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	838 <para>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	839 Enables byte-range support
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	840 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	841 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	842 </para>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	843
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	844 </directive>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	845
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1298 diff changeset	846
799 9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	847 <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	848 <syntax><value>size</value></syntax>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	849 <default>64</default>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	850 <context>http</context>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	851 <context>server</context>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	852 <context>location</context>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	853
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	854 <para>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	855 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	856 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	857 directives.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	858 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	859 <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	860 </para>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	861
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	862 </directive>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	863
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	864
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	865 <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	866 <syntax><value>size</value></syntax>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	867 <default>512</default>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	868 <context>http</context>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	869 <context>server</context>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	870 <context>location</context>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	871
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	872 <para>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	873 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	874 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	875 directives.
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	876 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	877 <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	878 </para>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	879
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	880 </directive>
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	881
9e5847af3b2d Documented the "proxy_headers_hash_bucket/max_size" directives. Vladimir Homutov <vl@nginx.com> parents: 790 diff changeset	882
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	883 <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	884 <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	885 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	886 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	887 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	888 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	889
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	890 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	891 By default,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	892 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	893 <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	894 <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	895 server to a client.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	896 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	897 that will not be passed.
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	898 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	899 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	900 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	901
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	902 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	903
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	904
316 1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	905 <directive name="proxy_http_version">
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	906 <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	907 <default>1.0</default>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	908 <context>http</context>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	909 <context>server</context>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	910 <context>location</context>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	911 <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	912
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	913 <para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	914 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	915 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	916 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	917 <link doc="ngx_http_upstream_module.xml" id="keepalive"/>
1587 c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1582 diff changeset	918 connections and
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1582 diff changeset	919 <link doc="ngx_http_upstream_module.xml" id="ntlm">NTLM authentication</link>.
316 1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	920 </para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	921
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	922 </directive>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	923
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	924
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	925 <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	926 <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	927 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	928 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	929 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	930 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	931
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	932 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	933 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	934 closed when a client closes the connection without waiting
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	935 for a response.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	936 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	937
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	938 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	939
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	940
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	941 <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	942 <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	943 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	944 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	945 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	946 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	947
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	948 <para>
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	949 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	950 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	951 <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	952 <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	953 <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	954 <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	955 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	956 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	957
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	958 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	959 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	960 effect:
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	961 <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	962
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	963 <listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	964 <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	965 <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	966 and <header>Vary</header>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	967 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	968 </listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	969
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	970 <listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	971 <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	972 <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	973 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	974 </listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	975
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	976 <listitem>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	977 <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	978 <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	979 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	980 </listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	981
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	982 <listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	983 <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	984 <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	985 </listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	986
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	987 <listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	988 <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	989 <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	990 of a response.
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	991 </listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	992
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	993 </list>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	994 </para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	995
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	996 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	997
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	998
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	999 <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	1000 <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	1001 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1002 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1003 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1004 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1005
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1006 <para>
297 94c8df379088 Added missing word. Ruslan Ermilov <ru@nginx.com> parents: 294 diff changeset	1007 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	1008 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	1009 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	1010 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1011
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1012 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1013
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1014
1342 758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	1015 <directive name="proxy_limit_rate">
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	1016 <syntax><value>rate</value></syntax>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	1017 <default>0</default>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	1018 <context>http</context>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	1019 <context>server</context>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	1020 <context>location</context>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	1021 <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	1022
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	1023 <para>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	1024 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	1025 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	1026 The zero value disables rate limiting.
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	1027 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	1028 two connections to the proxied server,
1bdde28e359b Fixed fallouts from the previous change. Ruslan Ermilov <ru@nginx.com> parents: 1342 diff changeset	1029 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	1030 The limitation works only if
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	1031 <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	1032 server is enabled.
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	1033 </para>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	1034
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	1035 </directive>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	1036
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	1037
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1038 <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	1039 <syntax><value>size</value></syntax>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1040 <default>1024m</default>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1041 <context>http</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1042 <context>server</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1043 <context>location</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1044
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1045 <para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1046 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	1047 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	1048 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	1049 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	1050 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	1051 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	1052 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	1053 </para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1054
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1055 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1056 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	1057 </para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1058
1352 dbb618f60a54 Elaborate on writing proxied responses to files. Ruslan Ermilov <ru@nginx.com> parents: 1349 diff changeset	1059 <para>
dbb618f60a54 Elaborate on writing proxied responses to files. Ruslan Ermilov <ru@nginx.com> parents: 1349 diff changeset	1060 <note>
dbb618f60a54 Elaborate on writing proxied responses to files. Ruslan Ermilov <ru@nginx.com> parents: 1349 diff changeset	1061 This restriction does not apply to responses
dbb618f60a54 Elaborate on writing proxied responses to files. Ruslan Ermilov <ru@nginx.com> parents: 1349 diff changeset	1062 that will be <link id="proxy_cache">cached</link>
dbb618f60a54 Elaborate on writing proxied responses to files. Ruslan Ermilov <ru@nginx.com> parents: 1349 diff changeset	1063 or <link id="proxy_store">stored</link> on disk.
dbb618f60a54 Elaborate on writing proxied responses to files. Ruslan Ermilov <ru@nginx.com> parents: 1349 diff changeset	1064 </note>
dbb618f60a54 Elaborate on writing proxied responses to files. Ruslan Ermilov <ru@nginx.com> parents: 1349 diff changeset	1065 </para>
dbb618f60a54 Elaborate on writing proxied responses to files. Ruslan Ermilov <ru@nginx.com> parents: 1349 diff changeset	1066
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1067 </directive>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1068
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1069
787 180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1070 <directive name="proxy_method">
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1071 <syntax><value>method</value></syntax>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1072 <default/>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1073 <context>http</context>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1074 <context>server</context>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1075 <context>location</context>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1076
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1077 <para>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1078 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	1079 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	1080 </para>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1081
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1082 </directive>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1083
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1084
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1085 <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	1086 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	1087 <literal>error</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	1088 <literal>timeout</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	1089 <literal>invalid_header</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	1090 <literal>http_500</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	1091 <literal>http_502</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	1092 <literal>http_503</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	1093 <literal>http_504</literal> \|
917 e26a18eb5ccd Documented http_403 in proxy_next_upstream and friends. Maxim Dounin <mdounin@mdounin.ru> parents: 907 diff changeset	1094 <literal>http_403</literal> \|
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	1095 <literal>http_404</literal> \|
1669 c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1096 <literal>non_idempotent</literal> \|
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	1097 <literal>off</literal>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	1098 ...</syntax>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1099 <default>error timeout</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1100 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1101 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1102 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1103
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 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	1106 <list type="tag">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1107
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1108 <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	1109 <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	1110 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	1111
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1112 <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	1113 <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	1114 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	1115
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1116 <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	1117 <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	1118
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1119 <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	1120 <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	1121
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1122 <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	1123 <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	1124
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1125 <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	1126 <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	1127
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1128 <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	1129 <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	1130
917 e26a18eb5ccd Documented http_403 in proxy_next_upstream and friends. Maxim Dounin <mdounin@mdounin.ru> parents: 907 diff changeset	1131 <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	1132 <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	1133
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1134 <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	1135 <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	1136
1669 c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1137 <tag-name id="non_idempotent"><literal>non_idempotent</literal></tag-name>
c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1138 <tag-desc>normally, requests with a
c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1139 <link url="http://tools.ietf.org/html/rfc7231#section-4.2.2">non-idempotent</link>
c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1140 method
c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1141 (<literal>POST</literal>, <literal>LOCK</literal>, <literal>PATCH</literal>)
c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1142 are not passed to the next server
c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1143 if a request has been sent to an upstream server (1.9.13);
c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1144 enabling this option explicitly allows retrying such requests;
c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1145 </tag-desc>
c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1146
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1147 <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	1148 <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	1149
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1150 </list>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1151 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1152
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1153 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1154 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	1155 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	1156 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	1157 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	1158 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1159
942 ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	1160 <para>
1289 57fc39924d42 Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 1246 diff changeset	1161 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	1162 <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	1163 attempt</link> of communication with a server.
942 ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	1164 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	1165 <literal>invalid_header</literal> are always considered unsuccessful attempts,
ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	1166 even if they are not specified in the directive.
ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	1167 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	1168 <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	1169 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	1170 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	1171 are never considered unsuccessful attempts.
ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	1172 </para>
ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	1173
1290 f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1174 <para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1175 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	1176 <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	1177 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	1178 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1179
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1180 </directive>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1181
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1182
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1183 <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	1184 <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	1185 <default>0</default>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1186 <context>http</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1187 <context>server</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1188 <context>location</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1189 <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	1190
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1191 <para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1192 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	1193 <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	1194 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	1195 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1196
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1197 </directive>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1198
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1199
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1200 <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	1201 <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	1202 <default>0</default>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1203 <context>http</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1204 <context>server</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1205 <context>location</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1206 <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	1207
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1208 <para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1209 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	1210 <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	1211 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	1212 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1213
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1214 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1215
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1216
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1217 <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	1218 <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	1219 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1220 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1221 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1222 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1223
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1224 <para>
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	1225 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	1226 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	1227 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	1228 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1229 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	1230 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	1231 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1232 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	1233 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1234
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1235 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1236
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 name="proxy_pass">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1239 <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	1240 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1241 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1242 <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	1243 <context>limit_except</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1244
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1245 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1246 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	1247 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	1248 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	1249 can be specified.
fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1250 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	1251 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	1252 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1253 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	1254 </example>
535 f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1255 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	1256 “<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	1257 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1258 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	1259 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1260 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1261
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1262 <para>
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	1263 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	1264 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	1265 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	1266 <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	1267 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1268
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1269 <para>
535 f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1270 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	1271 <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	1272
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1273 <listitem>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1274 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	1275 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	1276 <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	1277 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	1278 specified in the directive:
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1279 <example>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1280 location /name/ {
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1281 proxy_pass http://127.0.0.1/remote/;
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1282 }
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1283 </example>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1284 </listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1285
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1286 <listitem>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1287 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	1288 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	1289 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	1290 or the full normalized request URI is passed
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1291 when processing the changed URI:
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1292 <example>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1293 location /some/path/ {
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1294 proxy_pass http://127.0.0.1;
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1295 }
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1296 </example>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1297 <note>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1298 Before version 1.1.12,
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1299 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	1300 the original request URI might be passed
535 f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1301 instead of the changed URI in some cases.
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1302 </note>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1303 </listitem>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1304 </list>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1305 </para>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1306
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1307 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1308 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	1309 <list type="bullet" compact="no">
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1310
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1311 <listitem>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1312 When location is specified using a regular expression.
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1313 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1314 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	1315 </para>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1316 </listitem>
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1317
f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1318 <listitem>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1319 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	1320 <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	1321 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	1322 (<literal>break</literal>):
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1323 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1324 location /name/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1325 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	1326 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	1327 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1328 </example>
535 f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1329 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1330 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	1331 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	1332 </para>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1333 </listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1334 </list>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1335 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1336
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1337 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1338 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	1339 variables:
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1340 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1341 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	1342 </example>
535 f8652d663b62 Revised description of "proxy_pass". Ruslan Ermilov <ru@nginx.com> parents: 508 diff changeset	1343 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	1344 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1345 proxy_pass $request;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1346 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1347 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1348
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1349 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1350 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	1351 <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	1352 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	1353 <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	1354 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1355
849 0ed4c093c026 WebSocket proxying howto. Homutov Vladimir <vl@nginx.com> parents: 815 diff changeset	1356 <para>
0ed4c093c026 WebSocket proxying howto. Homutov Vladimir <vl@nginx.com> parents: 815 diff changeset	1357 <link doc="websocket.xml">WebSocket</link> proxying requires special
0ed4c093c026 WebSocket proxying howto. Homutov Vladimir <vl@nginx.com> parents: 815 diff changeset	1358 configuration and is supported since version 1.3.13.
0ed4c093c026 WebSocket proxying howto. Homutov Vladimir <vl@nginx.com> parents: 815 diff changeset	1359 </para>
0ed4c093c026 WebSocket proxying howto. Homutov Vladimir <vl@nginx.com> parents: 815 diff changeset	1360
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1361 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1362
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1363
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1364 <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	1365 <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	1366 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1367 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1368 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1369 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1370
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1371 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1372 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	1373 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	1374 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1375
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1376 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1377
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1378
789 1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1379 <directive name="proxy_pass_request_body">
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1380 <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	1381 <default>on</default>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1382 <context>http</context>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1383 <context>server</context>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1384 <context>location</context>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1385
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1386 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	1387 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	1388 to the proxied server.
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1389 <example>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1390 location /x-accel-redirect-here/ {
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1391 proxy_method GET;
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1392 proxy_pass_request_body off;
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1393 proxy_set_header Content-Length "";
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1394
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1395 proxy_pass ...
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1396 }
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1397 </example>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1398 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	1399 <link id="proxy_pass_request_headers"/> directives.
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1400 </para>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1401
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1402 </directive>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1403
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1404
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1405 <directive name="proxy_pass_request_headers">
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1406 <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	1407 <default>on</default>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1408 <context>http</context>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1409 <context>server</context>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1410 <context>location</context>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1411
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1412 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	1413 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	1414 to the proxied server.
789 1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1415 <example>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1416 location /x-accel-redirect-here/ {
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1417 proxy_method GET;
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1418 proxy_pass_request_headers off;
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1419 proxy_pass_request_body off;
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1420
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1421 proxy_pass ...
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1422 }
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1423 </example>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1424 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	1425 <link id="proxy_pass_request_body"/> directives.
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1426 </para>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1427
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1428 </directive>
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1429
1063836dacea Documented "proxy_pass_request_body/headers" directives. Vladimir Homutov <vl@nginx.com> parents: 787 diff changeset	1430
1524 323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	1431 <directive name="proxy_read_timeout">
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	1432 <syntax><value>time</value></syntax>
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	1433 <default>60s</default>
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	1434 <context>http</context>
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	1435 <context>server</context>
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	1436 <context>location</context>
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	1437
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	1438 <para>
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	1439 Defines a timeout for reading a response from the proxied server.
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	1440 The timeout is set only between two successive read operations,
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	1441 not for the transmission of the whole response.
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	1442 If the proxied server does not transmit anything within this time,
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	1443 the connection is closed.
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	1444 </para>
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	1445
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	1446 </directive>
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	1447
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	1448
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1449 <directive name="proxy_redirect">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1450 <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	1451 <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	1452 <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	1453 <default>default</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1454 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1455 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1456 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1457
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1458 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1459 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	1460 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	1461 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	1462 “<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	1463 The directive
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1464 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1465 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	1466 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1467 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	1468 “<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	1469 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1470
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1471 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1472 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	1473 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1474 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	1475 </example>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1476 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	1477 will be inserted.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1478 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1479
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1480 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1481 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	1482 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	1483 <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	1484 <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	1485 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	1486 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1487 location /one/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1488 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	1489 proxy_redirect default;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1490 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1491
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1492 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1493 location /one/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1494 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	1495 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	1496 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1497 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	1498 <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	1499 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1500
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1501 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1502 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	1503 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1504 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	1505 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1506 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1507
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 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	1510 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1511 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	1512 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1513 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1514
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1515 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1516 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	1517 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	1518 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	1519 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	1520 matching.
1149 1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1146 diff changeset	1521 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	1522 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	1523 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1524 proxy_redirect ~^(http://[^:]+):\d+(/.+)$ $1$2;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1525 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	1526 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1527 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1528
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1529 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1530 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	1531 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1532 proxy_redirect default;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1533 proxy_redirect http://localhost:8000/ /;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1534 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	1535 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1536 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1537
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1538 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1539 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	1540 <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	1541 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1542 proxy_redirect off;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1543 proxy_redirect default;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1544 proxy_redirect http://localhost:8000/ /;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1545 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	1546 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1547 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1548
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1549 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1550 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	1551 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	1552 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1553 proxy_redirect / /;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1554 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1555 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1556
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1557 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1558
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1559
1437 8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1560 <directive name="proxy_request_buffering">
1659 680cbf783efe Fixed some misuses of "value". Ruslan Ermilov <ru@nginx.com> parents: 1610 diff changeset	1561 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
1437 8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1562 <default>on</default>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1563 <context>http</context>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1564 <context>server</context>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1565 <context>location</context>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1566 <appeared-in>1.7.11</appeared-in>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1567
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1568 <para>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1569 Enables or disables buffering of a client request body.
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1570 </para>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1571
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1572 <para>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1573 When buffering is enabled, the entire request body is
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1574 <link doc="ngx_http_core_module.xml" id="client_body_buffer_size">read</link>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1575 from the client before sending the request to a proxied server.
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1576 </para>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1577
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1578 <para>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1579 When buffering is disabled, the request body is sent to the proxied server
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1580 immediately as it is received.
1440 657885fd2b96 Corrected description of proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1437 diff changeset	1581 In this case, the request cannot be passed to the
657885fd2b96 Corrected description of proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1437 diff changeset	1582 <link id="proxy_next_upstream">next server</link>
1437 8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1583 if nginx already started sending the request body.
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1584 </para>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1585
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1586 <para>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1587 When HTTP/1.1 chunked transfer encoding is used
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1588 to send the original request body,
1440 657885fd2b96 Corrected description of proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1437 diff changeset	1589 the request body will be buffered regardless of the directive value unless
657885fd2b96 Corrected description of proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1437 diff changeset	1590 HTTP/1.1 is <link id="proxy_http_version">enabled</link> for proxying.
1437 8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1591 </para>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1592
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1593 </directive>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1594
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1414 diff changeset	1595
773 24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1596 <directive name="proxy_send_lowat">
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1597 <syntax><value>size</value></syntax>
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1598 <default>0</default>
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1599 <context>http</context>
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1600 <context>server</context>
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1601 <context>location</context>
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1602
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1603 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1604 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	1605 minimize the number
773 24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1606 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	1607 <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	1608 <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	1609 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	1610 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	1611 </para>
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1612
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1613 <para>
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1614 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	1615 </para>
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1616
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1617 </directive>
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1618
24b1b0101250 Documented "send_lowat" directive in fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 772 diff changeset	1619
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1620 <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	1621 <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	1622 <default>60s</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1623 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1624 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1625 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1626
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1627 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1628 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	1629 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	1630 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	1631 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	1632 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	1633 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1634
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1635 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1636
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1637
787 180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1638 <directive name="proxy_set_body">
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1639 <syntax><value>value</value></syntax>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1640 <default/>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1641 <context>http</context>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1642 <context>server</context>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1643 <context>location</context>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1644
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1645 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1646 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	1647 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	1648 </para>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1649
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1650 </directive>
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1651
180a64c709d8 Documented "proxy_set_body" and "proxy_method" directives. Vladimir Homutov <vl@nginx.com> parents: 773 diff changeset	1652
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1653 <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	1654 <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	1655 <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	1656 <default>Connection close</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1657 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1658 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1659 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1660
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1661 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1662 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	1663 <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	1664 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	1665 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	1666 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	1667 <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	1668 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	1669 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	1670 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1671 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	1672 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	1673 </example>
1610 2d60caa1c1dd Documented headers that are stripped when caching is enabled. Ruslan Ermilov <ru@nginx.com> parents: 1599 diff changeset	1674 If caching is enabled, the header fields
2d60caa1c1dd Documented headers that are stripped when caching is enabled. Ruslan Ermilov <ru@nginx.com> parents: 1599 diff changeset	1675 <header>If-Modified-Since</header>,
2d60caa1c1dd Documented headers that are stripped when caching is enabled. Ruslan Ermilov <ru@nginx.com> parents: 1599 diff changeset	1676 <header>If-Unmodified-Since</header>,
2d60caa1c1dd Documented headers that are stripped when caching is enabled. Ruslan Ermilov <ru@nginx.com> parents: 1599 diff changeset	1677 <header>If-None-Match</header>,
2d60caa1c1dd Documented headers that are stripped when caching is enabled. Ruslan Ermilov <ru@nginx.com> parents: 1599 diff changeset	1678 <header>If-Match</header>,
2d60caa1c1dd Documented headers that are stripped when caching is enabled. Ruslan Ermilov <ru@nginx.com> parents: 1599 diff changeset	1679 <header>Range</header>,
2d60caa1c1dd Documented headers that are stripped when caching is enabled. Ruslan Ermilov <ru@nginx.com> parents: 1599 diff changeset	1680 and
2d60caa1c1dd Documented headers that are stripped when caching is enabled. Ruslan Ermilov <ru@nginx.com> parents: 1599 diff changeset	1681 <header>If-Range</header>
2d60caa1c1dd Documented headers that are stripped when caching is enabled. Ruslan Ermilov <ru@nginx.com> parents: 1599 diff changeset	1682 from the original request are not passed to the proxied server.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1683 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1684
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1685 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1686 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	1687 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1688 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	1689 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1690 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1691
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1692 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1693 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	1694 nothing will be passed.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1695 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	1696 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	1697 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	1698 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1699 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	1700 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1701 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1702
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1703 <para>
959 fbb4cc6f8c3d Text review of ngx_http_proxy_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	1704 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	1705 proxied server:
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 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	1708 </example>
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
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1711 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1712 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	1713 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	1714 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1715 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	1716 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1717 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1718
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1719 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1720
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1721
1372 e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1722 <directive name="proxy_ssl_certificate">
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1723 <syntax><value>file</value></syntax>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1724 <default/>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1725 <context>http</context>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1726 <context>server</context>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1727 <context>location</context>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1728 <appeared-in>1.7.8</appeared-in>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1729
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1730 <para>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1731 Specifies a <value>file</value> with the certificate in the PEM format
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1732 used for authentication to a proxied HTTPS server.
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1733 </para>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1734
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1735 </directive>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1736
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1737
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1738 <directive name="proxy_ssl_certificate_key">
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1739 <syntax><value>file</value></syntax>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1740 <default/>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1741 <context>http</context>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1742 <context>server</context>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1743 <context>location</context>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1744 <appeared-in>1.7.8</appeared-in>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1745
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1746 <para>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1747 Specifies a <value>file</value> with the secret key in the PEM format
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1748 used for authentication to a proxied HTTPS server.
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1749 </para>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1750
1456 acba294382d6 Documented engine support in ssl_certificate_key and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1440 diff changeset	1751 <para>
acba294382d6 Documented engine support in ssl_certificate_key and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1440 diff changeset	1752 The value
acba294382d6 Documented engine support in ssl_certificate_key and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1440 diff changeset	1753 <literal>engine</literal>:<value>name</value>:<value>id</value>
acba294382d6 Documented engine support in ssl_certificate_key and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1440 diff changeset	1754 can be specified instead of the <value>file</value> (1.7.9),
acba294382d6 Documented engine support in ssl_certificate_key and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1440 diff changeset	1755 which loads a secret key with a specified <value>id</value>
acba294382d6 Documented engine support in ssl_certificate_key and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1440 diff changeset	1756 from the OpenSSL engine <value>name</value>.
acba294382d6 Documented engine support in ssl_certificate_key and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1440 diff changeset	1757 </para>
acba294382d6 Documented engine support in ssl_certificate_key and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1440 diff changeset	1758
1372 e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1759 </directive>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1760
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1761
993 a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1762 <directive name="proxy_ssl_ciphers">
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1763 <syntax><value>ciphers</value></syntax>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1764 <default>DEFAULT</default>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1765 <context>http</context>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1766 <context>server</context>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1767 <context>location</context>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1768 <appeared-in>1.5.6</appeared-in>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1769
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1770 <para>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1771 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	1772 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	1773 </para>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1774
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1775 <para>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1776 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	1777 “<command>openssl ciphers</command>” command.
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1778 </para>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1779
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1780 </directive>
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1781
a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1782
1166 1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1783 <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	1784 <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	1785 <default/>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1786 <context>http</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1787 <context>server</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1788 <context>location</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1789 <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	1790
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1791 <para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1792 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	1793 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	1794 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	1795 </para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1796
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1797 </directive>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1798
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1799
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1800 <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	1801 <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	1802 <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	1803 <context>http</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1804 <context>server</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1805 <context>location</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1806 <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	1807
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1808 <para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1809 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	1810 <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	1811 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	1812 <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	1813 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	1814 </para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1815
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1816 <para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1817 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	1818 </para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1819
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1820 </directive>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1821
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1822
1372 e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1823 <directive name="proxy_ssl_password_file">
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1824 <syntax><value>file</value></syntax>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1825 <default/>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1826 <context>http</context>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1827 <context>server</context>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1828 <context>location</context>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1829 <appeared-in>1.7.8</appeared-in>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1830
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1831 <para>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1832 Specifies a <value>file</value> with passphrases for
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1833 <link id="proxy_ssl_certificate_key">secret keys</link>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1834 where each passphrase is specified on a separate line.
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1835 Passphrases are tried in turn when loading the key.
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1836 </para>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1837
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1838 </directive>
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1839
e0e1e5db06bb Documented the proxy_ssl_certificate directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1353 diff changeset	1840
1166 1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1841 <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	1842 <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	1843 <default>off</default>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1844 <context>http</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1845 <context>server</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1846 <context>location</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1847 <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	1848
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1849 <para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1850 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	1851 <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	1852 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	1853 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	1854 </para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1855
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1856 </directive>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1857
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1858
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1859 <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	1860 <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	1861 <default>on</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1862 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1863 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1864 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1865
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1866 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1867 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	1868 the proxied server.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1869 If the errors
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1870 “<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	1871 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	1872 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1873
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1874 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1875
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1876
985 e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1877 <directive name="proxy_ssl_protocols">
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1878 <syntax>
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1879 [<literal>SSLv2</literal>]
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1880 [<literal>SSLv3</literal>]
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1881 [<literal>TLSv1</literal>]
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1882 [<literal>TLSv1.1</literal>]
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1883 [<literal>TLSv1.2</literal>]</syntax>
1499 3687cc9a3592 Removed SSLv3 from the default value of ssl_protocols and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1456 diff changeset	1884 <default>TLSv1 TLSv1.1 TLSv1.2</default>
985 e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1885 <context>http</context>
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1886 <context>server</context>
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1887 <context>location</context>
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1888 <appeared-in>1.5.6</appeared-in>
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1889
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1890 <para>
993 a59aba3d4b67 Proxy: documented the "proxy_ssl_ciphers" directive. Andrei Belov <defan@nginx.com> parents: 992 diff changeset	1891 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	1892 </para>
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1893
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1894 </directive>
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1895
e4704604ed29 Proxy: documented the "proxy_ssl_protocols" directive. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	1896
1166 1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1897 <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	1898 <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	1899 <default/>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1900 <context>http</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1901 <context>server</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1902 <context>location</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1903 <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	1904
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1905 <para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1906 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	1907 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	1908 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	1909 </para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1910
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1911 </directive>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1912
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1913
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1914 <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	1915 <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	1916 <default>off</default>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1917 <context>http</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1918 <context>server</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1919 <context>location</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1920 <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	1921
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1922 <para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1923 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	1924 </para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1925
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1926 </directive>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1927
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1928
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1929 <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	1930 <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	1931 <default>1</default>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1932 <context>http</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1933 <context>server</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1934 <context>location</context>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1935 <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	1936
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1937 <para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1938 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	1939 </para>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1940
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1941 </directive>
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1942
1d299c6f7c49 The new directives "proxy_ssl_verify" and "proxy_ssl_server_name". Ruslan Ermilov <ru@nginx.com> parents: 1155 diff changeset	1943
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1944 <directive name="proxy_store">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1945 <syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1946 <literal>on</literal> \|
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1947 <literal>off</literal> \|
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1948 <value>string</value></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1949 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1950 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1951 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1952 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1953
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1954 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1955 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	1956 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	1957 corresponding to the directives
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1958 <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	1959 <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	1960 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	1961 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	1962 <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	1963 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1964 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	1965 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1966 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1967
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1968 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1969 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	1970 <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	1971 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	1972 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	1973 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	1974 can be put on different file systems.
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	1975 However, be aware that in this case a file is copied
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 959 diff changeset	1976 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	1977 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	1978 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	1979 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	1980 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1981
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1982 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1983 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	1984 files, e.g.:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1985 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1986 location /images/ {
1005 2275611970dd Removed open_file_cache_errors from proxy_store examples. Maxim Dounin <mdounin@mdounin.ru> parents: 993 diff changeset	1987 root /data/www;
2275611970dd Removed open_file_cache_errors from proxy_store examples. Maxim Dounin <mdounin@mdounin.ru> parents: 993 diff changeset	1988 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	1989 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1990
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1991 location /fetch/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1992 internal;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1993
1005 2275611970dd Removed open_file_cache_errors from proxy_store examples. Maxim Dounin <mdounin@mdounin.ru> parents: 993 diff changeset	1994 proxy_pass http://backend/;
2275611970dd Removed open_file_cache_errors from proxy_store examples. Maxim Dounin <mdounin@mdounin.ru> parents: 993 diff changeset	1995 proxy_store on;
2275611970dd Removed open_file_cache_errors from proxy_store examples. Maxim Dounin <mdounin@mdounin.ru> parents: 993 diff changeset	1996 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	1997 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	1998
1005 2275611970dd Removed open_file_cache_errors from proxy_store examples. Maxim Dounin <mdounin@mdounin.ru> parents: 993 diff changeset	1999 alias /data/www/;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2000 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2001 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2002 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2003
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2004 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2005 or like this:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2006 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2007 location /images/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2008 root /data/www;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2009 error_page 404 = @fetch;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2010 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2011
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2012 location @fetch {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2013 internal;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2014
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2015 proxy_pass http://backend;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2016 proxy_store on;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2017 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	2018 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	2019
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2020 root /data/www;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2021 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2022 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2023 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2024
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2025 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2026
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2027
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2028 <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	2029 <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	2030 <default>user:rw</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2031 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2032 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2033 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2034
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2035 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2036 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	2037 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2038 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	2039 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2040 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2041
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2042 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2043 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	2044 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	2045 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2046 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	2047 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2048 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2049
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2050 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2051
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2052
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	2053 <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	2054 <syntax><value>size</value></syntax>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	2055 <default>8k\|16k</default>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	2056 <context>http</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	2057 <context>server</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	2058 <context>location</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	2059
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	2060 <para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	2061 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	2062 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	2063 to temporary files is enabled.
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	2064 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	2065 <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	2066 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	2067 <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	2068 </para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	2069
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	2070 </directive>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	2071
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	2072
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2073 <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	2074 <syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2075 <value>path</value>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2076 [<value>level1</value>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2077 [<value>level2</value>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2078 [<value>level3</value>]]]</syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2079 <default>proxy_temp</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2080 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2081 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2082 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2083
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2084 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2085 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	2086 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	2087 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	2088 directory.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2089 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	2090 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2091 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	2092 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2093 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	2094 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2095 /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	2096 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2097 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2098
1384 66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	2099 <para>
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	2100 See also the <literal>use_temp_path</literal> parameter of the
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	2101 <link id="proxy_cache_path"/> directive.
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	2102 </para>
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	2103
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2104 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2105
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2106 </section>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2107
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2108
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2109 <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	2110
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2111 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2112 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	2113 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	2114 <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	2115 <list type="tag">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2116
1155 07402a11fd8d Assigned IDs to tags describing variables. Vladimir Homutov <vl@nginx.com> parents: 1153 diff changeset	2117 <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	2118 <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	2119 <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	2120
1155 07402a11fd8d Assigned IDs to tags describing variables. Vladimir Homutov <vl@nginx.com> parents: 1153 diff changeset	2121 <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	2122 <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	2123 <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	2124
1155 07402a11fd8d Assigned IDs to tags describing variables. Vladimir Homutov <vl@nginx.com> parents: 1153 diff changeset	2125 <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	2126 <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	2127 <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	2128 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	2129 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	2130 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	2131 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	2132 </list>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2133 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2134
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2135 </section>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2136
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2137 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_proxy_module.xml @ 1669:c872b93682f4