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

annotate xml/en/docs/http/ngx_http_proxy_module.xml @ 506:657848837328

Documented how nginx processes proxied server's response header fields (X-Accel-*, Expires, Cache-Control, Set-Cookie) that can be ignored.

author	Ruslan Ermilov <ru@nginx.com>
date	Tue, 24 Apr 2012 07:32:41 +0000
parents	695f83494c19
children	5e332fafd228

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
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3 <!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	4
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	5 <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	6 link="/en/docs/http/ngx_http_proxy_module.html"
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	7 lang="en">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	8
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	9 <section id="summary">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	10
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	11 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	12 The <literal>ngx_http_proxy_module</literal> module allows to pass
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	13 requests to another server.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	14 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	15
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	16 </section>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	17
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	18
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	19 <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	20
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	21 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	22 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	23 location / {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	24 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	25 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	26 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	27 }
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 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	30
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	31 </section>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	32
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 <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	35
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	36 <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	37 <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	38 <default>4k\|8k</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	39 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	40 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	41 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	42
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	43 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	44 Sets <value>size</value> of the buffer used for reading the first part
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	45 of a response received from the proxied server.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	46 This part usually contains a small response header.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	47 By default, the buffer size is equal to the size of one
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	48 buffer set by the <link id="proxy_buffers"/> directive.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	49 It can be made smaller however.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	50 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	51
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	52 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	53
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	54
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	55 <directive name="proxy_buffering">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	56 <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	57 <default>on</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	58 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	59 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	60 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	61
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	62 <para>
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	63 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	64 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	65
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	66 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	67 When buffering is enabled, nginx receives 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	68 as soon as possible, saving it into buffers set by the
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	69 <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/> directives.
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	70 If the whole response does not fit into memory, part of it can be saved
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	71 to a <link id="proxy_temp_path">temporary file</link> on disk.
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	72 Writes to temporary files are controlled by the
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	73 <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	74 <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	75 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	76
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 When buffering is disabled, a response is passed to a client synchronously,
362 db6774c4c699 Fixed translation. Ruslan Ermilov <ru@nginx.com> parents: 351 diff changeset	79 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	80 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	81 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	82 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	83 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	84
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	85 <para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	86 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	87 “<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	88 <header>X-Accel-Buffering</header> response header field.
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	89 This ability can be disabled using the
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	90 <link doc="ngx_http_proxy_module.xml" 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	91 </para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	92
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	93 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	94
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	95
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	96 <directive name="proxy_buffers">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	97 <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	98 <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	99 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	100 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	101 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	102
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	103 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	104 Sets the <value>number</value> and <value>size</value> of
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	105 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	106 for a single connection.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	107 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	108 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	109 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	110
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	111 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	112
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	113
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	114 <directive name="proxy_busy_buffers_size">
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	115 <syntax><value>size</value></syntax>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	116 <default>8k\|16k</default>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	117 <context>http</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	118 <context>server</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	119 <context>location</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	120
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	121 <para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	122 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	123 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	124 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	125 yet fully read.
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	126 In the mean time, the rest of the buffers can be used for reading a response
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	127 and, if needed, buffering part of a response to a temporary file.
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	128 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	129 <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	130 </para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	131
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	132 </directive>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	133
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	134
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	135 <directive name="proxy_cache">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	136 <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	137 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	138 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	139 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	140 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	141
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	142 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	143 Defines a zone used for caching.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	144 The same zone can be used in several places.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	145 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	146 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	147 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	148
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	149 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	150
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	151
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	152 <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	153 <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	154 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	155 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	156 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	157 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	158
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	159 <para>
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	160 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	161 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	162 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	163 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	164 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	165 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	166 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	167 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	168 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	169
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	170 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	171
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	172
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	173 <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	174 <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	175 <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	176 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	177 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	178 <context>location</context>
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 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	181 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	182 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	183 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	184 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	185 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	186 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	187 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	188 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	189 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	190
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	191 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	192
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	193
302 df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	194 <directive name="proxy_cache_lock">
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	195 <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	196 <default>off</default>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	197 <context>http</context>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	198 <context>server</context>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	199 <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	200 <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	201
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	202 <para>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	203 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	204 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	205 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	206 Other requests of the same cache element will either wait
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	207 for a response to appear in the cache, or the cache lock for
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	208 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	209 <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	210 </para>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	211
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	212 </directive>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	213
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	214
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	215 <directive name="proxy_cache_lock_timeout">
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	216 <syntax><value>time</value></syntax>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	217 <default>5s</default>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	218 <context>http</context>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	219 <context>server</context>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	220 <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	221 <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	222
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	223 <para>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	224 Sets a timeout for <link id="proxy_cache_lock"/>.
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	225 </para>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	226
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	227 </directive>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	228
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	229
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	230 <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	231 <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	232 <default>1</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	233 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	234 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	235 <context>location</context>
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 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	238 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	239 will be cached.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	240 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	241
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	242 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	243
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	244
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	245 <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	246 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	247 <value>path</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	248 [<literal>levels</literal>=<value>levels</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	249 <literal>keys_zone</literal>=<value>name</value>:<value>size</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	250 [<literal>inactive</literal>=<value>time</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	251 [<literal>max_size</literal>=<value>size</value>]</syntax>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	252 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	253 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	254
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	255 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	256 Sets path and other parameters of a cache.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	257 Cache data are stored in files.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	258 Both the key and file name in a cache are a result of
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	259 applying the MD5 function to the proxied URL.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	260
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	261 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	262 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	263 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	264 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	265 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	266 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	267 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	268 /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	269 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	270 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	271
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	272 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	273 A cached response is first written to a temporary file, then a file is renamed.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	274 Starting from version 0.8.9 temporary files and the cache can be put on
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	275 different file systems but be aware that in this case a file is copied
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	276 across two file systems instead of the cheap rename operation.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	277 It is thus recommended that for any given location both cache and a directory
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	278 holding temporary files set by the <link id="proxy_temp_path"/> directive
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	279 are put on the same file system.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	280 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	281
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	282 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	283 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	284 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	285 are configured by the <literal>keys_zone</literal> parameter.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	286 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	287 <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	288 regardless of their freshness.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	289 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	290 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	291
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	292 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	293 The special process “cache manager” monitors the maximum cache size set
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	294 by the <literal>max_size</literal> parameter;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	295 when this size is exceeded it removes the least recently used data.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	296 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	297
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	298 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	299
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	300
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	301 <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	302 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	303 <literal>error</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	304 <literal>timeout</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	305 <literal>invalid_header</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	306 <literal>updating</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	307 <literal>http_500</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	308 <literal>http_502</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	309 <literal>http_503</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	310 <literal>http_504</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	311 <literal>http_404</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	312 <literal>off</literal>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	313 ...</syntax>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	314 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	315 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	316 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	317 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	318
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	319 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	320 If an error occurs while working with the proxied server it is possible
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	321 to use a stale cached response.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	322 This directives determines in which cases it is permitted.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	323 The directive’s parameters match those of the
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	324 <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	325 </para>
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	326
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	327 <para>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	328 Additionally, the <literal>updating</literal> parameter permits
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	329 to use a stale cached response if it is currently being updated.
504 695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	330 This allows to minimize the number of accesses to proxied servers
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	331 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	332 </para>
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	333
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	334 <para>
695f83494c19 Emphasized on what the "updating" parameter of the "proxy_cache_use_stale" Ruslan Ermilov <ru@nginx.com> parents: 417 diff changeset	335 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	336 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	337 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	338 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	339
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	340 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	341
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	342
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	343 <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	344 <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	345 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	346 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	347 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	348 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	349
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	350 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	351 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	352 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	353 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	354 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	355 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	356 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	357 set 10 minutes of caching for responses with codes 200 and 302,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	358 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	359 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	360
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	361 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	362 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	363 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	364 proxy_cache_valid 5m;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	365 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	366 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	367 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	368
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	369 <para>
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	370 In addition, it can be specified to cache any responses using the
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	371 <literal>any</literal> parameter:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	372 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	373 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	374 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	375 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	376 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	377 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	378
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	379 <para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	380 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	381 in the response header.
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	382 This has a higher precedence than setting of caching time using the directive.
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	383 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	384 response in seconds.
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	385 The value 0 disables to cache a response.
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	386 If a value starts with the prefix <literal>@</literal>, it sets an absolute
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	387 time in seconds since Epoch, up to which the response may be cached.
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	388 If header does not include the <header>X-Accel-Expires</header> field,
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	389 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	390 <header>Expires</header> or <header>Cache-Control</header>.
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	391 If a header includes the <header>Set-Cookie</header> field, such a
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	392 response will not be cached.
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	393 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	394 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	395 </para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	396
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	397 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	398
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	399
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	400 <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	401 <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	402 <default>60s</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	403 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	404 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	405 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	406
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	407 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	408 Defines a timeout for establishing a connection with the proxied server.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	409 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	410 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	411
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	412 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	413
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	414
417 cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	415 <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	416 <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	417 <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	418 <default>off</default>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	419 <context>http</context>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	420 <context>server</context>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	421 <context>location</context>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	422 <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	423
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	424 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	425 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	426 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	427 proxied server response.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	428 Suppose a proxied server returned the header field
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	429 <header>Set-Cookie</header> with the attribute
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	430 “<literal>domain=localhost</literal>”.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	431 The directive
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	432 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	433 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	434 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	435 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	436 “<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	437 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	438
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	439 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	440 A dot at the beginning of the <value>domain</value> and
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	441 <value>replacement</value> strings, and the <literal>domain</literal>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	442 attribute is ignored.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	443 Matching is case-insensitive.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	444 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	445
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	446 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	447 The strings <value>domain</value> and <value>replacement</value>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	448 can contain variables:
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	449 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	450 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	451 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	452 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	453
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	454 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	455 A directive can also be specified using regular expressions.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	456 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	457 the “<literal>~</literal>” symbol.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	458 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	459 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	460 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	461 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	462 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	463 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	464
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	465 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	466 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	467 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	468 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	469 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	470 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	471 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	472
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	473 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	474 The <literal>off</literal> parameter cancels all
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	475 <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	476 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	477 proxy_cookie_domain off;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	478 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	479 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	480 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	481 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	482
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	483 </directive>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	484
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	485
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	486 <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	487 <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	488 <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	489 <default>off</default>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	490 <context>http</context>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	491 <context>server</context>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	492 <context>location</context>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	493 <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	494
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	495 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	496 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	497 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	498 proxied server response.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	499 Suppose a proxied server returned the header field
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	500 <header>Set-Cookie</header> with the attribute
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	501 “<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	502 The directive
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	503 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	504 proxy_cookie_path /two/ /;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	505 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	506 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	507 “<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	508 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	509
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	510 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	511 The strings <value>path</value> and <value>replacement</value>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	512 can contain variables:
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	513 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	514 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	515 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	516 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	517
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	518 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	519 A directive can also be specified using regular expressions.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	520 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	521 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	522 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	523 matching.
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	524 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	525 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	526 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	527 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	528 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	529 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	530
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	531 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	532 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	533 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	534 proxy_cookie_path /one/ /;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	535 proxy_cookie_path / /two/;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	536 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	537 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	538
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	539 <para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	540 The <literal>off</literal> parameter cancels all
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	541 <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	542 <example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	543 proxy_cookie_path off;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	544 proxy_cookie_path /two/ /;
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	545 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	546 </example>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	547 </para>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	548
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	549 </directive>
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	550
cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 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_hide_header">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	553 <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	554 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	555 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	556 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	557 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	558
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	559 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	560 By default,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	561 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	562 <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	563 <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	564 server to a client.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	565 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	566 that will not be passed.
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	567 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	568 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	569 </para>
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 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	572
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	573
316 1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	574 <directive name="proxy_http_version">
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	575 <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	576 <default>1.0</default>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	577 <context>http</context>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	578 <context>server</context>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	579 <context>location</context>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	580 <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	581
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	582 <para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	583 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	584 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	585 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	586 <link doc="ngx_http_upstream_module.xml" id="keepalive"/>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	587 connections.
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	588 </para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	589
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	590 </directive>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	591
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	592
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	593 <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	594 <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	595 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	596 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	597 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	598 <context>location</context>
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 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	601 Determines should the connection with a proxied server be
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	602 closed if a client closes a connection without waiting
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	603 for a response.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	604 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	605
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	606 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	607
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	608
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	609 <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	610 <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	611 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	612 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	613 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	614 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	615
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	616 <para>
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	617 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	618 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	619 <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	620 <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	621 <header>X-Accel-Charset</header> (1.1.6), <header>Expires</header>,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	622 <header>Cache-Control</header>, and <header>Set-Cookie</header> (0.8.44).
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	623 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	624
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	625 <para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	626 If not disabled, processing of these header fields has the following effect:
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	627 <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	628
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	629 <listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	630 <header>X-Accel-Expires</header>, <header>Expires</header>,
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	631 <header>Cache-Control</header>, and <header>Set-Cookie</header>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	632 set parameters of response <link id="proxy_cache_valid">caching</link>;
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	633 </listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	634
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	635 <listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	636 <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	637 <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	638 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	639 </listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	640
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	641 <listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	642 <header>X-Accel-Limit-Rate</header> sets a
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	643 <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	644 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	645 </listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	646
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	647 <listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	648 <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	649 <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	650 </listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	651
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	652 <listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	653 <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	654 <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	655 of a response.
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	656 </listitem>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	657
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	658 </list>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	659 </para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 504 diff changeset	660
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	661 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	662
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	663
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	664 <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	665 <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	666 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	667 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	668 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	669 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	670
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	671 <para>
297 94c8df379088 Added missing word. Ruslan Ermilov <ru@nginx.com> parents: 294 diff changeset	672 Determines whether proxied responses with codes greater than or equal
94c8df379088 Added missing word. Ruslan Ermilov <ru@nginx.com> parents: 294 diff changeset	673 to 400 should be passed to a client or be redirected to nginx for processing
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	674 using the <link doc="ngx_http_core_module.xml" id="error_page"/> directive.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	675 </para>
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 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	678
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	679
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	680 <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	681 <syntax><value>size</value></syntax>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	682 <default>1024m</default>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	683 <context>http</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	684 <context>server</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	685 <context>location</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	686
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	687 <para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	688 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	689 server is enabled, and the whole response does not fit into memory buffers
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	690 set by the <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	691 directives, part of a response can be saved to a temporary file.
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	692 This directive sets the maximum <value>size</value> of a temporary file.
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	693 The size of data written to a temporary file at a time is set
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	694 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	695 </para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	696
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	697 <para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	698 Value of zero disables buffering of responses to temporary files.
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	699 </para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	700
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	701 </directive>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	702
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	703
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	704 <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	705 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	706 <literal>error</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	707 <literal>timeout</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	708 <literal>invalid_header</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	709 <literal>http_500</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	710 <literal>http_502</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	711 <literal>http_503</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	712 <literal>http_504</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	713 <literal>http_404</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	714 <literal>off</literal>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	715 ...</syntax>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	716 <default>error timeout</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	717 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	718 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	719 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	720
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	721 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	722 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	723 <list type="tag">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	724
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	725 <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	726 <tag-desc>an error occurred while establishing a connection with the
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	727 server, passing it a request, or reading the response header;</tag-desc>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	728
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	729 <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	730 <tag-desc>a timeout has occurred while establishing a connection with the
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	731 server, passing it a request, or reading the response header;</tag-desc>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	732
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	733 <tag-name><literal>invalid_header</literal></tag-name>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	734 <tag-desc>a server returned empty or invalid response;</tag-desc>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	735
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	736 <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	737 <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	738
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	739 <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	740 <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	741
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	742 <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	743 <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	744
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	745 <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	746 <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	747
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	748 <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	749 <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	750
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	751 <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	752 <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	753
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	754 </list>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	755 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	756
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	757 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	758 It should be understood that passing a request to the next server is
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	759 only possible if a client was not sent anything yet.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	760 That is, if an error or a timeout occurs in the middle of
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	761 transferring a response, fixing this is impossible.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	762 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	763
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	764 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	765
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	766
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	767 <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	768 <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	769 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	770 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	771 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	772 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	773
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	774 <para>
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	775 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	776 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	777 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	778 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	779 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	780 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	781 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	782 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	783 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	784
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	785 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	786
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	787
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	788 <directive name="proxy_pass">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	789 <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	790 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	791 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	792 <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	793 <context>limit_except</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	794
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	795 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	796 Sets an address of the proxied server and a URI that maps a location.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	797 An address can be specified as a domain name or an address, and a port,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	798 for example,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	799 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	800 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	801 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	802 or as a UNIX-domain socket path:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	803 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	804 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	805 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	806 here a path is specified after the word “<literal>unix</literal>”
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	807 and enclosed in two colons.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	808 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	809
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	810 <para>
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	811 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	812 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	813 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	814 <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	815 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	816
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	817 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	818 When passing a request to the server, part of a URI matching the location
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	819 is replaced by a URI specified in the <literal>proxy_pass</literal> directive.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	820 This rule has two exceptions where a replacement location cannot be
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	821 defined:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	822 <list type="bullet">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	823
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	824 <listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	825 when a location is specified using a regular expression;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	826 </listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	827
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	828 <listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	829 if a URI is changed using the
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	830 <link doc="ngx_http_rewrite_module.xml" id="rewrite"/> directive
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	831 inside a proxied location, and this same configuration will be
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	832 used to process a request (<literal>break</literal>):
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	833 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	834 location /name/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	835 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	836 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	837 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	838 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	839 In these cases a URI is passed without mapping.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	840 </listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	841
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	842 </list>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	843 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	844
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	845 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	846 It can also be specified that a request URI should be passed unchanged,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	847 in the same form it was sent by the client, not the processed form.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	848 During a processing
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	849 <list type="bullet">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	850
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	851 <listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	852 two or more adjacent slashes are replaced by one: “//” — “/”;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	853 </listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	854
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	855 <listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	856 links to the current directory get removed: “/./” — “/”;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	857 </listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	858
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	859 <listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	860 links to the parent directory get removed: “/dir/../” — “/”.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	861 </listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	862
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	863 </list>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	864 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	865
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	866 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	867 If a URI should be passed unchanged then the server URL should be specified
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	868 without a URI in the <literal>proxy_pass</literal> directive:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	869 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	870 location /some/path/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	871 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	872 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	873 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	874 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	875
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	876 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	877 Server name, its port, and passed URI can be specified using variables:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	878 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	879 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	880 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	881 or like this:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	882 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	883 proxy_pass $request;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	884 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	885 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	886
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	887 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	888 In this case the server name is searched among the described
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	889 <link doc="ngx_http_upstream_module.xml">server groups</link>,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	890 and if not found is determined using a
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	891 <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	892 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	893
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	894 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	895
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	896
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	897 <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	898 <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	899 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	900 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	901 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	902 <context>location</context>
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 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	905 Permits to pass <link id="proxy_hide_header">otherwise disabled</link> header
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	906 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	907 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	908
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	909 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	910
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	911
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	912 <directive name="proxy_read_timeout">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	913 <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	914 <default>60s</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	915 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	916 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	917 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	918
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	919 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	920 Defines a timeout 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	921 A timeout is only set between two successive read operations,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	922 not for the transmission of the whole response.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	923 If a proxied server does not transmit anything within this time,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	924 a connection is closed.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	925 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	926
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	927 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	928
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	929
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	930 <directive name="proxy_redirect">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	931 <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	932 <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	933 <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	934 <default>default</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	935 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	936 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	937 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	938
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	939 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	940 Sets a text that should be changed in the header fields
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	941 <header>Location</header> and <header>Refresh</header> of a response
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	942 from the proxied server.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	943 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	944 “<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	945 The directive
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	946 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	947 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	948 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	949 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	950 “<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	951 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	952
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	953 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	954 A server name may be omitted from the <value>replacement</value> string:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	955 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	956 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	957 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	958 then the primary server’s name and a port, if different from 80,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	959 will be substituted.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	960 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	961
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	962 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	963 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	964 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	965 <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	966 <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	967 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	968 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	969 location /one/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	970 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	971 proxy_redirect default;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	972 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	973
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	974 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	975 location /one/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	976 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	977 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	978 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	979 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	980 <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	981 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	982
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	983 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	984 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	985 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	986 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	987 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	988 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	989
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	990 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	991 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	992 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	993 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	994 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	995 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	996
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	997 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	998 A directive can be specified (1.1.11) using regular expressions.
417 cbc2d1b51cb6 Documented the proxy_cookie_domain and proxy_cookie_path directives. Ruslan Ermilov <ru@nginx.com> parents: 405 diff changeset	999 In this case, <value>redirect</value> should either start from
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1000 the “<literal>~</literal>” symbol for a case-sensitive matching,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1001 or from the “<literal>~*</literal>” symbols for case-insensitive
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1002 matching.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1003 A regular expression can contain named and positional captures,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1004 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	1005 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1006 proxy_redirect ~^(http://[^:]+):\d+(/.+)$ $1$2;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1007 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	1008 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1009 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1010
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1011 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1012 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	1013 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1014 proxy_redirect default;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1015 proxy_redirect http://localhost:8000/ /;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1016 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	1017 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1018 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1019
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1020 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1021 The <literal>off</literal> parameter cancels all
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1022 <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	1023 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1024 proxy_redirect off;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1025 proxy_redirect default;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1026 proxy_redirect http://localhost:8000/ /;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1027 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	1028 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1029 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1030
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1031 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1032 Using this directive it is also possible to add host names to relative
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1033 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	1034 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	1035 proxy_redirect / /;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1036 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1037 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1038
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1039 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1040
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1041
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1042 <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	1043 <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	1044 <default>60s</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1045 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1046 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1047 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1048
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1049 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1050 Sets a timeout for transmitting a request to the proxied server.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1051 A timeout is only set between two successive write operations,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1052 not for the transmission of the whole request.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1053 If a proxied server does not receive anything within this time,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1054 a connection is closed.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1055 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1056
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1057 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1058
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1059
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1060 <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	1061 <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	1062 <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	1063 <default>Connection close</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1064 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1065 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1066 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1067
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1068 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1069 Allows to redefine or append fields to the request header
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1070 passed to the proxied server.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1071 A <value>value</value> can contain text, variables, and their combination.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1072 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	1073 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	1074 <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	1075 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	1076 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	1077 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1078 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	1079 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	1080 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1081 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1082
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1083 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1084 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	1085 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1086 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	1087 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1088 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1089
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1090 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1091 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	1092 nothing will be passed.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1093 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	1094 value equals the server name in the <header>Host</header> request header
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1095 field, or the primary server name if this field is not present:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1096 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1097 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	1098 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1099 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1100
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1101 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1102 In addition, a server name can be passed together with a port of the
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1103 proxied server:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1104 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1105 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	1106 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1107 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1108
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1109 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1110 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	1111 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	1112 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1113 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	1114 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1115 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1116
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1117 </directive>
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
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1120 <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	1121 <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	1122 <default>on</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1123 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1124 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1125 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1126
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1127 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1128 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	1129 the proxied server.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1130 If the errors
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1131 “<literal>SSL3_GET_FINISHED:digest check failed</literal>”
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1132 appear in the logs, try to disable session reuse.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1133 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1134
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1135 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1136
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1137
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1138 <directive name="proxy_store">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1139 <syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1140 <literal>on</literal> \|
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1141 <literal>off</literal> \|
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1142 <value>string</value></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1143 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1144 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1145 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1146 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1147
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1148 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1149 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	1150 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	1151 corresponding to the directives
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1152 <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	1153 <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	1154 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	1155 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	1156 <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	1157 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1158 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	1159 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1160 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1161
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1162 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1163 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	1164 <header>Last-Modified</header> response header field.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1165 A response is first written to a temporary file, then a file is renamed.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1166 Starting from version 0.8.9 temporary files and the persistent store
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1167 can be put on different file systems but be aware that in this case
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1168 a file is copied across two file systems instead of the cheap rename operation.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1169 It is thus recommended that for any given location both saved files and a
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1170 directory holding temporary files set by the <link id="proxy_temp_path"/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1171 directive are put on the same file system.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1172 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1173
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1174 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1175 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	1176 files, e.g.:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1177 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1178 location /images/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1179 root /data/www;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1180 open_file_cache_errors off;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1181 error_page 404 = /fetch$uri;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1182 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1183
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1184 location /fetch/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1185 internal;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1186
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1187 proxy_pass http://backend/;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1188 proxy_store on;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1189 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	1190 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	1191
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1192 alias /data/www/;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1193 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1194 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1195 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1196
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1197 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1198 or like this:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1199 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1200 location /images/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1201 root /data/www;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1202 error_page 404 = @fetch;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1203 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1204
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1205 location @fetch {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1206 internal;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1207
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1208 proxy_pass http://backend;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1209 proxy_store on;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1210 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	1211 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	1212
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1213 root /data/www;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1214 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1215 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1216 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1217
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1218 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1219
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1220
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1221 <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	1222 <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	1223 <default>user:rw</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1224 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1225 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1226 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1227
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1228 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1229 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	1230 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1231 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	1232 </example>
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 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1236 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	1237 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	1238 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1239 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	1240 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1241 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1242
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1243 </directive>
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
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1246 <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	1247 <syntax><value>size</value></syntax>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1248 <default>8k\|16k</default>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1249 <context>http</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1250 <context>server</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1251 <context>location</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1252
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1253 <para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1254 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	1255 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	1256 to temporary files is enabled.
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1257 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	1258 <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	1259 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	1260 <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	1261 </para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1262
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1263 </directive>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1264
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1265
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1266 <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	1267 <syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1268 <value>path</value>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1269 [<value>level1</value>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1270 [<value>level2</value>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1271 [<value>level3</value>]]]</syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1272 <default>proxy_temp</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1273 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1274 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1275 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1276
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1277 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1278 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	1279 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	1280 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	1281 directory.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1282 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	1283 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1284 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	1285 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1286 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	1287 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1288 /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	1289 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1290 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1291
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1292 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1293
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1294 </section>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1295
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1296
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1297 <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	1298
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1299 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1300 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	1301 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	1302 <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	1303 <list type="tag">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1304
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1305 <tag-name><var>$proxy_host</var></tag-name>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1306 <tag-desc>name and port of a proxied server;</tag-desc>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1307
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1308 <tag-name><var>$proxy_port</var></tag-name>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1309 <tag-desc>port of a proxied server;</tag-desc>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1310
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1311 <tag-name><var>$proxy_add_x_forwarded_for</var></tag-name>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1312 <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	1313 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	1314 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	1315 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	1316 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	1317 </list>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1318 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1319
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1320 </section>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1321
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1322 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_proxy_module.xml @ 506:657848837328