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

annotate xml/en/docs/http/ngx_http_proxy_module.xml @ 405:781b23ba3b0a

Documented the following directives: proxy_busy_buffers_size, proxy_max_temp_file_size, and proxy_temp_file_write_size.

author	Ruslan Ermilov <ru@nginx.com>
date	Fri, 10 Feb 2012 13:27:50 +0000
parents	bb51d3e17dd0
children	cbc2d1b51cb6

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
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	85 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	86
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	87
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	88 <directive name="proxy_buffers">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	89 <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	90 <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	91 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	92 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	93 <context>location</context>
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 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	96 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	97 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	98 for a single connection.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	99 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	100 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	101 </para>
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 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	104
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	105
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	106 <directive name="proxy_busy_buffers_size">
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	107 <syntax><value>size</value></syntax>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	108 <default>8k\|16k</default>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	109 <context>http</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	110 <context>server</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	111 <context>location</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	112
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	113 <para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	114 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	115 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	116 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	117 yet fully read.
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	118 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	119 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	120 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	121 <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	122 </para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	123
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	124 </directive>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	125
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	126
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	127 <directive name="proxy_cache">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	128 <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	129 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	130 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	131 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	132 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	133
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	134 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	135 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	136 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	137 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	138 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	139 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	140
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	141 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	142
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	143
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	144 <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	145 <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	146 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	147 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	148 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	149 <context>location</context>
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 <para>
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	152 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	153 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	154 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	155 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	156 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	157 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	158 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	159 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	160 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	161
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	162 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	163
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	164
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	165 <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	166 <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	167 <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	168 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	169 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	170 <context>location</context>
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 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	173 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	174 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	175 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	176 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	177 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	178 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	179 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	180 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	181 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	182
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	183 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	184
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	185
302 df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	186 <directive name="proxy_cache_lock">
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	187 <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	188 <default>off</default>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	189 <context>http</context>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	190 <context>server</context>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	191 <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	192 <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	193
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	194 <para>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	195 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	196 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	197 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	198 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	199 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	200 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	201 <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	202 </para>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	203
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	204 </directive>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	205
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	206
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	207 <directive name="proxy_cache_lock_timeout">
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	208 <syntax><value>time</value></syntax>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	209 <default>5s</default>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	210 <context>http</context>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	211 <context>server</context>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	212 <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	213 <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	214
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	215 <para>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	216 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	217 </para>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	218
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	219 </directive>
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	220
df728215db07 Documented "proxy_cache_lock", "proxy_cache_lock_timeout", Ruslan Ermilov <ru@nginx.com> parents: 297 diff changeset	221
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	222 <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	223 <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	224 <default>1</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	225 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	226 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	227 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	228
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	229 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	230 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	231 will be cached.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	232 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	233
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	234 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	235
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	236
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	237 <directive name="proxy_cache_path">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	238 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	239 <value>path</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	240 [<literal>levels</literal>=<value>levels</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	241 <literal>keys_zone</literal>=<value>name</value>:<value>size</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	242 [<literal>inactive</literal>=<value>time</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	243 [<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	244 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	245 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	246
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	247 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	248 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	249 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	250 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	251 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	252
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	253 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	254 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	255 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	256 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	257 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	258 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	259 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	260 /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	261 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	262 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	263
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	264 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	265 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	266 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	267 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	268 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	269 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	270 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	271 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	272 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	273
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	274 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	275 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	276 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	277 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	278 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	279 <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	280 regardless of their freshness.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	281 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	282 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	283
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	284 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	285 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	286 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	287 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	288 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	289
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	290 </directive>
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
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	293 <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	294 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	295 <literal>error</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	296 <literal>timeout</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	297 <literal>invalid_header</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	298 <literal>updating</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	299 <literal>http_500</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	300 <literal>http_502</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	301 <literal>http_503</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	302 <literal>http_504</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	303 <literal>http_404</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	304 <literal>off</literal>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	305 ...</syntax>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	306 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	307 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	308 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	309 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	310
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	311 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	312 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	313 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	314 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	315 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	316 <link id="proxy_next_upstream"/> directive.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	317 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	318 to use a stale cached response if it is currently being updated.
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
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	321 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	322
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	323
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	324 <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	325 <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	326 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	327 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	328 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	329 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	330
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	331 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	332 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	333 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	334 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	335 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	336 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	337 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	338 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	339 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	340 </para>
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 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	343 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	344 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	345 proxy_cache_valid 5m;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	346 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	347 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	348 </para>
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>
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	351 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	352 <literal>any</literal> parameter:
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 301 1h;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	356 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	357 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	358 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	359
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	360 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	361
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	362
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	363 <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	364 <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	365 <default>60s</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	366 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	367 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	368 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	369
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	370 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	371 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	372 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	373 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	374
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	375 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	376
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	377
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	378 <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	379 <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	380 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	381 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	382 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	383 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	384
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	385 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	386 By default,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	387 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	388 <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	389 <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	390 server to a client.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	391 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	392 that will not be passed.
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	393 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	394 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	395 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	396
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
316 1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	400 <directive name="proxy_http_version">
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	401 <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	402 <default>1.0</default>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	403 <context>http</context>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	404 <context>server</context>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	405 <context>location</context>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	406 <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	407
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	408 <para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	409 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	410 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	411 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	412 <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	413 connections.
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	414 </para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	415
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	416 </directive>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	417
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 310 diff changeset	418
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	419 <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	420 <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	421 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	422 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	423 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	424 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	425
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	426 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	427 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	428 closed if a client closes a connection without waiting
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	429 for a response.
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	430 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	431
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	432 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	433
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	434
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	435 <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	436 <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	437 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	438 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	439 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	440 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	441
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	442 <para>
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	443 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	444 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	445 <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	446 <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	447 <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	448 <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	449 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	450
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	451 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	452
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	453
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	454 <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	455 <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	456 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	457 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	458 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	459 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	460
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	461 <para>
297 94c8df379088 Added missing word. Ruslan Ermilov <ru@nginx.com> parents: 294 diff changeset	462 Determines whether proxied responses with codes greater than or equal
94c8df379088 Added missing word. Ruslan Ermilov <ru@nginx.com> parents: 294 diff changeset	463 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	464 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	465 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	466
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	467 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	468
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	469
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	470 <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	471 <syntax><value>size</value></syntax>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	472 <default>1024m</default>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	473 <context>http</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	474 <context>server</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	475 <context>location</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	476
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	477 <para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	478 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	479 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	480 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	481 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	482 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	483 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	484 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	485 </para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	486
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	487 <para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	488 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	489 </para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	490
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	491 </directive>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	492
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	493
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	494 <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	495 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	496 <literal>error</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	497 <literal>timeout</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	498 <literal>invalid_header</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	499 <literal>http_500</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	500 <literal>http_502</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	501 <literal>http_503</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	502 <literal>http_504</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	503 <literal>http_404</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	504 <literal>off</literal>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 362 diff changeset	505 ...</syntax>
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	506 <default>error timeout</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	507 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	508 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	509 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	510
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	511 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	512 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	513 <list type="tag">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	514
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	515 <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	516 <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	517 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	518
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	519 <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	520 <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	521 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	522
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	523 <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	524 <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	525
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	526 <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	527 <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	528
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	529 <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	530 <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	531
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	532 <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	533 <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	534
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	535 <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	536 <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	537
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	538 <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	539 <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	540
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	541 <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	542 <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	543
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	544 </list>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	545 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	546
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	547 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	548 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	549 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	550 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	551 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	552 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	553
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	554 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	555
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	556
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	557 <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	558 <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	559 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	560 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	561 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	562 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	563
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	564 <para>
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	565 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	566 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	567 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	568 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	569 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	570 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	571 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	572 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	573 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	574
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	575 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	576
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	577
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	578 <directive name="proxy_pass">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	579 <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	580 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	581 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	582 <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	583 <context>limit_except</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	584
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	585 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	586 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	587 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	588 for example,
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	589 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	590 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	591 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	592 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	593 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	594 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	595 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	596 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	597 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	598 </para>
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>
294 9f5ee1c6fca5 Use consistent wording. Ruslan Ermilov <ru@nginx.com> parents: 281 diff changeset	601 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	602 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	603 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	604 <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	605 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	606
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	607 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	608 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	609 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	610 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	611 defined:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	612 <list type="bullet">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	613
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	614 <listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	615 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	616 </listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	617
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	618 <listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	619 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	620 <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	621 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	622 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	623 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	624 location /name/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	625 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	626 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	627 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	628 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	629 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	630 </listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	631
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	632 </list>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	633 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	634
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	635 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	636 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	637 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	638 During a processing
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	639 <list type="bullet">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	640
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	641 <listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	642 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	643 </listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	644
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	645 <listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	646 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	647 </listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	648
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	649 <listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	650 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	651 </listitem>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	652
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	653 </list>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	654 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	655
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	656 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	657 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	658 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	659 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	660 location /some/path/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	661 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	662 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	663 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	664 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	665
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	666 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	667 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	668 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	669 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	670 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	671 or like this:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	672 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	673 proxy_pass $request;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	674 </example>
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 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	678 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	679 <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	680 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	681 <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	682 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	683
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	684 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	685
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	686
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	687 <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	688 <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	689 <default/>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	690 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	691 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	692 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	693
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	694 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	695 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	696 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	697 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	698
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	699 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	700
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	701
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	702 <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	703 <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	704 <default>60s</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	705 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	706 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	707 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	708
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	709 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	710 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	711 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	712 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	713 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	714 a connection is closed.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	715 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	716
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	717 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	718
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	719
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	720 <directive name="proxy_redirect">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	721 <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	722 <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	723 <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	724 <default>default</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	725 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	726 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	727 <context>location</context>
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 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	730 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	731 <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	732 from the proxied server.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	733 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	734 “<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	735 The directive
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	736 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	737 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	738 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	739 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	740 “<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	741 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	742
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	743 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	744 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	745 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	746 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	747 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	748 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	749 will be substituted.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	750 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	751
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	752 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	753 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	754 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	755 <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	756 <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	757 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	758 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	759 location /one/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	760 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	761 proxy_redirect default;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	762 </example>
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 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	765 location /one/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	766 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	767 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	768 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	769 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	770 <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	771 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	772
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	773 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	774 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	775 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	776 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	777 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	778 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	779
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	780 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	781 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	782 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	783 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	784 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	785 </para>
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 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	788 A directive can be specified (1.1.11) using regular expressions.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	789 In this case, <value>replacement</value> should either start from
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	790 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	791 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	792 matching.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	793 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	794 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	795 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	796 proxy_redirect ~^(http://[^:]+):\d+(/.+)$ $1$2;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	797 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	798 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	799 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	800
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	801 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	802 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	803 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	804 proxy_redirect default;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	805 proxy_redirect http://localhost:8000/ /;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	806 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	807 </example>
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>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	811 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	812 <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	813 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	814 proxy_redirect off;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	815 proxy_redirect default;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	816 proxy_redirect http://localhost:8000/ /;
a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	817 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	818 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	819 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	820
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	821 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	822 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	823 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	824 <example>
351 a4fa80755eab Consistently strip initial offset in examples. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	825 proxy_redirect / /;
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	826 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	827 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	828
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	829 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	830
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	831
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	832 <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	833 <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	834 <default>60s</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	835 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	836 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	837 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	838
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	839 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	840 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	841 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	842 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	843 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	844 a connection is closed.
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
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	847 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	848
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	849
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	850 <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	851 <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	852 <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	853 <default>Connection close</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	854 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	855 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	856 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	857
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	858 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	859 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	860 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	861 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	862 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	863 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	864 <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	865 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	866 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	867 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	868 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	869 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	870 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	871 </para>
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 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	874 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	875 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	876 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	877 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	878 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	879
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	880 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	881 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	882 nothing will be passed.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	883 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	884 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	885 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	886 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	887 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	888 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	889 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	890
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	891 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	892 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	893 proxied server:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	894 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	895 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	896 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	897 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	898
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	899 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	900 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	901 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	902 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	903 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	904 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	905 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	906
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	907 </directive>
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
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	910 <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	911 <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	912 <default>on</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	913 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	914 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	915 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	916
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	917 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	918 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	919 the proxied server.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	920 If the errors
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	921 “<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	922 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	923 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	924
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	925 </directive>
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
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	928 <directive name="proxy_store">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	929 <syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	930 <literal>on</literal> \|
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	931 <literal>off</literal> \|
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	932 <value>string</value></syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	933 <default>off</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	934 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	935 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	936 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	937
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	938 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	939 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	940 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	941 corresponding to the directives
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	942 <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	943 <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	944 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	945 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	946 <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	947 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	948 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	949 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	950 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	951
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	952 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	953 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	954 <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	955 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	956 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	957 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	958 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	959 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	960 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	961 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	962 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	963
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	964 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	965 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	966 files, e.g.:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	967 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	968 location /images/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	969 root /data/www;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	970 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	971 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	972 }
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 location /fetch/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	975 internal;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	976
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	977 proxy_pass http://backend/;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	978 proxy_store on;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	979 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	980 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	981
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	982 alias /data/www/;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	983 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	984 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	985 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	986
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	987 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	988 or like this:
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	989 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	990 location /images/ {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	991 root /data/www;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	992 error_page 404 = @fetch;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	993 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	994
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	995 location @fetch {
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	996 internal;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	997
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	998 proxy_pass http://backend;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	999 proxy_store on;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1000 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	1001 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	1002
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1003 root /data/www;
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1004 }
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1005 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1006 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1007
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1008 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1009
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 <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	1012 <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	1013 <default>user:rw</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1014 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1015 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1016 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1017
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 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	1020 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1021 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	1022 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1023 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1024
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1025 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1026 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	1027 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	1028 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1029 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	1030 </example>
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
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1033 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1034
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1035
405 781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1036 <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	1037 <syntax><value>size</value></syntax>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1038 <default>8k\|16k</default>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1039 <context>http</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1040 <context>server</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1041 <context>location</context>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1042
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1043 <para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1044 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	1045 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	1046 to temporary files is enabled.
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1047 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	1048 <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	1049 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	1050 <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	1051 </para>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1052
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1053 </directive>
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1054
781b23ba3b0a Documented the following directives: proxy_busy_buffers_size, Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1055
281 7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1056 <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	1057 <syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1058 <value>path</value>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1059 [<value>level1</value>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1060 [<value>level2</value>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1061 [<value>level3</value>]]]</syntax>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1062 <default>proxy_temp</default>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1063 <context>http</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1064 <context>server</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1065 <context>location</context>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1066
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1067 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1068 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	1069 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	1070 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	1071 directory.
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1072 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	1073 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1074 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	1075 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1076 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	1077 <example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1078 /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	1079 </example>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1080 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1081
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1082 </directive>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1083
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1084 </section>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1085
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1086
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1087 <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	1088
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1089 <para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1090 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	1091 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	1092 <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	1093 <list type="tag">
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1094
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1095 <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	1096 <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	1097
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1098 <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	1099 <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	1100
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1101 <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	1102 <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	1103 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	1104 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	1105 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	1106 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	1107 </list>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1108 </para>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1109
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1110 </section>
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1111
7142ddd2764c Translated current version of ngx_http_proxy_module documentation into English. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1112 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_proxy_module.xml @ 405:781b23ba3b0a