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

annotate xml/en/docs/http/ngx_http_scgi_module.xml @ 2593:eeed494bba51

Unified phrases about configuration levels and inheritance.

author	Ruslan Ermilov <ru@nginx.com>
date	Mon, 21 Sep 2020 15:45:07 +0300
parents	a5bbfdf88bbd
children	4add6ae1296f

rev	line source
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1 <?xml version="1.0"?>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	2
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	3 <!--
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	4 Copyright (C) Igor Sysoev
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	5 Copyright (C) Nginx, Inc.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	6 -->
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	7
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	9
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	10 <module name="Module ngx_http_scgi_module"
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	11 link="/en/docs/http/ngx_http_scgi_module.html"
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	12 lang="en"
2593 eeed494bba51 Unified phrases about configuration levels and inheritance. Ruslan Ermilov <ru@nginx.com> parents: 2560 diff changeset	13 rev="41">
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	14
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	15 <section id="summary">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	16
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	17 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	18 The <literal>ngx_http_scgi_module</literal> module allows passing
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	19 requests to an SCGI server.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	20 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	21
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	22 </section>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	23
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	24
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	25 <section id="example" name="Example Configuration">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	26
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	27 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	28 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	29 location / {
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	30 include scgi_params;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	31 scgi_pass localhost:9000;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	32 }
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	33 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	34 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	35
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	36 </section>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	37
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	38
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	39 <section id="directives" name="Directives">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	40
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	41 <directive name="scgi_bind">
1885 6839c258c473 Added <literal> tag to proxy bind transparent. Yaroslav Zhuravlev <yar@nginx.com> parents: 1838 diff changeset	42 <syntax>
6839c258c473 Added <literal> tag to proxy bind transparent. Yaroslav Zhuravlev <yar@nginx.com> parents: 1838 diff changeset	43 <value>address</value>
6839c258c473 Added <literal> tag to proxy bind transparent. Yaroslav Zhuravlev <yar@nginx.com> parents: 1838 diff changeset	44 [<literal>transparent</literal>] \|
6839c258c473 Added <literal> tag to proxy bind transparent. Yaroslav Zhuravlev <yar@nginx.com> parents: 1838 diff changeset	45 <literal>off</literal></syntax>
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	46 <default/>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	47 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	48 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	49 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	50
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	51 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	52 Makes outgoing connections to an SCGI server originate
1748 be371be7a5c8 Documented optional port for proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1731 diff changeset	53 from the specified local IP address with an optional port (1.11.2).
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	54 Parameter value can contain variables (1.3.12).
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	55 The special value <literal>off</literal> (1.3.12) cancels the effect
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	56 of the <literal>scgi_bind</literal> directive
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	57 inherited from the previous configuration level, which allows the
1748 be371be7a5c8 Documented optional port for proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1731 diff changeset	58 system to auto-assign the local IP address and port.
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	59 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	60
1696 d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	61 <para id="scgi_bind_transparent">
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	62 The <literal>transparent</literal> parameter (1.11.0) allows
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	63 outgoing connections to an SCGI server originate
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	64 from a non-local IP address,
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	65 for example, from a real IP address of a client:
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	66 <example>
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	67 scgi_bind $remote_addr transparent;
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	68 </example>
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	69 In order for this parameter to work,
2090 a9a9a052b5bd Documented the "CAP_NET_RAW" capability for transparent proxying. Yaroslav Zhuravlev <yar@nginx.com> parents: 2083 diff changeset	70 it is usually necessary to run nginx worker processes with the
a9a9a052b5bd Documented the "CAP_NET_RAW" capability for transparent proxying. Yaroslav Zhuravlev <yar@nginx.com> parents: 2083 diff changeset	71 <link doc="../ngx_core_module.xml" id="user">superuser</link> privileges.
a9a9a052b5bd Documented the "CAP_NET_RAW" capability for transparent proxying. Yaroslav Zhuravlev <yar@nginx.com> parents: 2083 diff changeset	72 On Linux it is not required (1.13.8) as if
a9a9a052b5bd Documented the "CAP_NET_RAW" capability for transparent proxying. Yaroslav Zhuravlev <yar@nginx.com> parents: 2083 diff changeset	73 the <literal>transparent</literal> parameter is specified, worker processes
a9a9a052b5bd Documented the "CAP_NET_RAW" capability for transparent proxying. Yaroslav Zhuravlev <yar@nginx.com> parents: 2083 diff changeset	74 inherit the <literal>CAP_NET_RAW</literal> capability from the master process.
a9a9a052b5bd Documented the "CAP_NET_RAW" capability for transparent proxying. Yaroslav Zhuravlev <yar@nginx.com> parents: 2083 diff changeset	75 It is also necessary to configure kernel routing table
1696 d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	76 to intercept network traffic from the SCGI server.
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	77 </para>
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	78
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	79 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	80
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	81
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	82 <directive name="scgi_buffer_size">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	83 <syntax><value>size</value></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	84 <default>4k\|8k</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	85 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	86 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	87 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	88
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	89 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	90 Sets the <value>size</value> of the buffer used for reading the first part
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	91 of the response received from the SCGI server.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	92 This part usually contains a small response header.
1550 305f2c338181 Fixed description of default value of proxy_buffer_size and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1542 diff changeset	93 By default, the buffer size is equal to one memory page.
305f2c338181 Fixed description of default value of proxy_buffer_size and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1542 diff changeset	94 This is either 4K or 8K, depending on a platform.
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	95 It can be made smaller, however.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	96 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	97
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	98 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	99
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	100
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	101 <directive name="scgi_buffering">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	102 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	103 <default>on</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	104 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	105 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	106 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	107
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	108 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	109 Enables or disables buffering of responses from the SCGI server.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	110 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	111
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	112 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	113 When buffering is enabled, nginx receives a response from the SCGI server
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	114 as soon as possible, saving it into the buffers set by the
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	115 <link id="scgi_buffer_size"/> and <link id="scgi_buffers"/> directives.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	116 If the whole response does not fit into memory, a part of it can be saved
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	117 to a <link id="scgi_temp_path">temporary file</link> on the disk.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	118 Writing to temporary files is controlled by the
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	119 <link id="scgi_max_temp_file_size"/> and
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	120 <link id="scgi_temp_file_write_size"/> directives.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	121 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	122
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	123 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	124 When buffering is disabled, the response is passed to a client synchronously,
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	125 immediately as it is received.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	126 nginx will not try to read the whole response from the SCGI server.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	127 The maximum size of the data that nginx can receive from the server
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	128 at a time is set by the <link id="scgi_buffer_size"/> directive.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	129 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	130
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	131 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	132 Buffering can also be enabled or disabled by passing
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	133 “<literal>yes</literal>” or “<literal>no</literal>” in the
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	134 <header>X-Accel-Buffering</header> response header field.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	135 This capability can be disabled using the
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	136 <link id="scgi_ignore_headers"/> directive.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	137 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	138
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	139 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	140
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	141
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	142 <directive name="scgi_buffers">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	143 <syntax><value>number</value> <value>size</value></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	144 <default>8 4k\|8k</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	145 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	146 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	147 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	148
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	149 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	150 Sets the <value>number</value> and <value>size</value> of the
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	151 buffers used for reading a response from the SCGI server,
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	152 for a single connection.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	153 By default, the buffer size is equal to one memory page.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	154 This is either 4K or 8K, depending on a platform.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	155 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	156
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	157 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	158
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	159
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	160 <directive name="scgi_busy_buffers_size">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	161 <syntax><value>size</value></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	162 <default>8k\|16k</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	163 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	164 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	165 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	166
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	167 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	168 When <link id="scgi_buffering">buffering</link> of responses from the SCGI
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	169 server is enabled, limits the total <value>size</value> of buffers that
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	170 can be busy sending a response to the client while the response is not
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	171 yet fully read.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	172 In the meantime, the rest of the buffers can be used for reading the response
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	173 and, if needed, buffering part of the response to a temporary file.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	174 By default, <value>size</value> is limited by the size of two buffers set by the
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	175 <link id="scgi_buffer_size"/> and <link id="scgi_buffers"/> directives.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	176 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	177
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	178 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	179
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	180
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	181 <directive name="scgi_cache">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	182 <syntax><value>zone</value> \| <literal>off</literal></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	183 <default>off</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	184 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	185 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	186 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	187
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	188 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	189 Defines a shared memory zone used for caching.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	190 The same zone can be used in several places.
1382 94cac978bda3 Documented variables support in proxy_cache and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1379 diff changeset	191 Parameter value can contain variables (1.7.9).
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	192 The <literal>off</literal> parameter disables caching inherited
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	193 from the previous configuration level.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	194 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	195
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	196 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	197
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	198
1909 399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	199 <directive name="scgi_cache_background_update">
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	200 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	201 <default>off</default>
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	202 <context>http</context>
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	203 <context>server</context>
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	204 <context>location</context>
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	205 <appeared-in>1.11.10</appeared-in>
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	206
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	207 <para>
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	208 Allows starting a background subrequest
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	209 to update an expired cache item,
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	210 while a stale cached response is returned to the client.
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	211 Note that it is necessary to
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	212 <link id="scgi_cache_use_stale_updating">allow</link>
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	213 the usage of a stale cached response when it is being updated.
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	214 </para>
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	215
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	216 </directive>
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	217
399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	218
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	219 <directive name="scgi_cache_bypass">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	220 <syntax><value>string</value> ...</syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	221 <default/>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	222 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	223 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	224 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	225
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	226 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	227 Defines conditions under which the response will not be taken from a cache.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	228 If at least one value of the string parameters is not empty and is not
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	229 equal to “0” then the response will not be taken from the cache:
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	230 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	231 scgi_cache_bypass $cookie_nocache $arg_nocache$arg_comment;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	232 scgi_cache_bypass $http_pragma $http_authorization;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	233 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	234 Can be used along with the <link id="scgi_no_cache"/> directive.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	235 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	236
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	237 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	238
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	239
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	240 <directive name="scgi_cache_key">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	241 <syntax><value>string</value></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	242 <default/>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	243 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	244 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	245 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	246
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	247 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	248 Defines a key for caching, for example
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	249 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	250 scgi_cache_key localhost:9000$request_uri;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	251 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	252 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	253
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	254 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	255
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	256
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	257 <directive name="scgi_cache_lock">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	258 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	259 <default>off</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	260 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	261 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	262 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	263 <appeared-in>1.1.12</appeared-in>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	264
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	265 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	266 When enabled, only one request at a time will be allowed to populate
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	267 a new cache element identified according to the <link id="scgi_cache_key"/>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	268 directive by passing a request to an SCGI server.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	269 Other requests of the same cache element will either wait
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	270 for a response to appear in the cache or the cache lock for
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	271 this element to be released, up to the time set by the
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	272 <link id="scgi_cache_lock_timeout"/> directive.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	273 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	274
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	275 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	276
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	277
1379 91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	278 <directive name="scgi_cache_lock_age">
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	279 <syntax><value>time</value></syntax>
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	280 <default>5s</default>
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	281 <context>http</context>
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	282 <context>server</context>
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	283 <context>location</context>
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	284 <appeared-in>1.7.8</appeared-in>
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	285
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	286 <para>
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	287 If the last request passed to the SCGI server
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	288 for populating a new cache element
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	289 has not completed for the specified <value>time</value>,
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	290 one more request may be passed to the SCGI server.
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	291 </para>
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	292
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	293 </directive>
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	294
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	295
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	296 <directive name="scgi_cache_lock_timeout">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	297 <syntax><value>time</value></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	298 <default>5s</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	299 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	300 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	301 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	302 <appeared-in>1.1.12</appeared-in>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	303
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	304 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	305 Sets a timeout for <link id="scgi_cache_lock"/>.
1379 91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	306 When the <value>time</value> expires,
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	307 the request will be passed to the SCGI server,
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	308 however, the response will not be cached.
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	309 <note>
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	310 Before 1.7.8, the response could be cached.
91f5c089f4ca Documented fastcgi_cache_lock_age and look-alikes. Ruslan Ermilov <ru@nginx.com> parents: 1353 diff changeset	311 </note>
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	312 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	313
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	314 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	315
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	316
1838 0d6ac4838921 Documented proxy_cache_max_range_offset and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1812 diff changeset	317 <directive name="scgi_cache_max_range_offset">
0d6ac4838921 Documented proxy_cache_max_range_offset and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1812 diff changeset	318 <syntax><value>number</value></syntax>
0d6ac4838921 Documented proxy_cache_max_range_offset and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1812 diff changeset	319 <default/>
0d6ac4838921 Documented proxy_cache_max_range_offset and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1812 diff changeset	320 <context>http</context>
0d6ac4838921 Documented proxy_cache_max_range_offset and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1812 diff changeset	321 <context>server</context>
0d6ac4838921 Documented proxy_cache_max_range_offset and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1812 diff changeset	322 <context>location</context>
0d6ac4838921 Documented proxy_cache_max_range_offset and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1812 diff changeset	323 <appeared-in>1.11.6</appeared-in>
0d6ac4838921 Documented proxy_cache_max_range_offset and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1812 diff changeset	324
0d6ac4838921 Documented proxy_cache_max_range_offset and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1812 diff changeset	325 <para>
0d6ac4838921 Documented proxy_cache_max_range_offset and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1812 diff changeset	326 Sets an offset in bytes for byte-range requests.
0d6ac4838921 Documented proxy_cache_max_range_offset and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1812 diff changeset	327 If the range is beyond the offset,
0d6ac4838921 Documented proxy_cache_max_range_offset and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1812 diff changeset	328 the range request will be passed to the SCGI server
0d6ac4838921 Documented proxy_cache_max_range_offset and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1812 diff changeset	329 and the response will not be cached.
0d6ac4838921 Documented proxy_cache_max_range_offset and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1812 diff changeset	330 </para>
0d6ac4838921 Documented proxy_cache_max_range_offset and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1812 diff changeset	331
0d6ac4838921 Documented proxy_cache_max_range_offset and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1812 diff changeset	332 </directive>
0d6ac4838921 Documented proxy_cache_max_range_offset and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1812 diff changeset	333
0d6ac4838921 Documented proxy_cache_max_range_offset and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1812 diff changeset	334
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	335 <directive name="scgi_cache_methods">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	336 <syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	337 <literal>GET</literal> \|
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	338 <literal>HEAD</literal> \|
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	339 <literal>POST</literal>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	340 ...</syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	341 <default>GET HEAD</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	342 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	343 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	344 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	345
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	346 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	347 If the client request method is listed in this directive then
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	348 the response will be cached.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	349 “<literal>GET</literal>” and “<literal>HEAD</literal>” methods are always
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	350 added to the list, though it is recommended to specify them explicitly.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	351 See also the <link id="scgi_no_cache"/> directive.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	352 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	353
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	354 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	355
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	356
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	357 <directive name="scgi_cache_min_uses">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	358 <syntax><value>number</value></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	359 <default>1</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	360 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	361 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	362 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	363
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	364 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	365 Sets the <value>number</value> of requests after which the response
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	366 will be cached.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	367 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	368
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	369 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	370
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	371
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	372 <directive name="scgi_cache_path">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	373 <syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	374 <value>path</value>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	375 [<literal>levels</literal>=<value>levels</value>]
1384 66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	376 [<literal>use_temp_path</literal>=<literal>on</literal>\|<literal>off</literal>]
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	377 <literal>keys_zone</literal>=<value>name</value>:<value>size</value>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	378 [<literal>inactive</literal>=<value>time</value>]
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	379 [<literal>max_size</literal>=<value>size</value>]
2560 a5bbfdf88bbd Documented the "min_free" parameter of proxy_cache_path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2254 diff changeset	380 [<literal>min_free</literal>=<value>size</value>]
1810 bc6341aaa832 Added cache manager parameters to proxy_cache path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1803 diff changeset	381 [<literal>manager_files</literal>=<value>number</value>]
bc6341aaa832 Added cache manager parameters to proxy_cache path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1803 diff changeset	382 [<literal>manager_sleep</literal>=<value>time</value>]
bc6341aaa832 Added cache manager parameters to proxy_cache path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1803 diff changeset	383 [<literal>manager_threshold</literal>=<value>time</value>]
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	384 [<literal>loader_files</literal>=<value>number</value>]
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	385 [<literal>loader_sleep</literal>=<value>time</value>]
1582 8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	386 [<literal>loader_threshold</literal>=<value>time</value>]
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	387 [<literal>purger</literal>=<literal>on</literal>\|<literal>off</literal>]
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	388 [<literal>purger_files</literal>=<value>number</value>]
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	389 [<literal>purger_sleep</literal>=<value>time</value>]
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	390 [<literal>purger_threshold</literal>=<value>time</value>]</syntax>
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	391 <default/>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	392 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	393
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	394 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	395 Sets the path and other parameters of a cache.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	396 Cache data are stored in files.
1190 dd4cfc6ce770 Corrected description of _cache_path file names. Ruslan Ermilov <ru@nginx.com>* parents: 1189 diff changeset	397 The file name in a cache is a result of
dd4cfc6ce770 Corrected description of _cache_path file names. Ruslan Ermilov <ru@nginx.com>* parents: 1189 diff changeset	398 applying the MD5 function to the
dd4cfc6ce770 Corrected description of _cache_path file names. Ruslan Ermilov <ru@nginx.com>* parents: 1189 diff changeset	399 <link id="scgi_cache_key">cache key</link>.
1796 1d576e8d6ead Clarified the "levels" parameter of proxy_cache_path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1748 diff changeset	400 The <literal>levels</literal> parameter defines hierarchy levels of a cache:
1d576e8d6ead Clarified the "levels" parameter of proxy_cache_path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1748 diff changeset	401 from 1 to 3, each level accepts values 1 or 2.
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	402 For example, in the following configuration
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	403 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	404 scgi_cache_path /data/nginx/cache levels=1:2 keys_zone=one:10m;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	405 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	406 file names in a cache will look like this:
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	407 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	408 /data/nginx/cache/<emphasis>c</emphasis>/<emphasis>29</emphasis>/b7f54b2df7773722d382f4809d650<emphasis>29c</emphasis>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	409 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	410 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	411
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	412 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	413 A cached response is first written to a temporary file,
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	414 and then the file is renamed.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	415 Starting from version 0.8.9, temporary files and the cache can be put on
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	416 different file systems.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	417 However, be aware that in this case a file is copied
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	418 across two file systems instead of the cheap renaming operation.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	419 It is thus recommended that for any given location both cache and a directory
1384 66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	420 holding temporary files
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	421 are put on the same file system.
1384 66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	422 A directory for temporary files is set based on
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	423 the <literal>use_temp_path</literal> parameter (1.7.10).
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	424 If this parameter is omitted or set to the value <literal>on</literal>,
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	425 the directory set by the <link id="scgi_temp_path"/> directive
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	426 for the given location will be used.
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	427 If the value is set to <literal>off</literal>,
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	428 temporary files will be put directly in the cache directory.
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	429 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	430
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	431 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	432 In addition, all active keys and information about data are stored
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	433 in a shared memory zone, whose <value>name</value> and <value>size</value>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	434 are configured by the <literal>keys_zone</literal> parameter.
1189 f25d00109de0 Documented cache keys_zone memory estimates. Maxim Dounin <mdounin@mdounin.ru> parents: 1185 diff changeset	435 One megabyte zone can store about 8 thousand keys.
2069 fc3ba2e76974 Documented size of keys_zone for commercial version (trac #1286). Yaroslav Zhuravlev <yar@nginx.com> parents: 1991 diff changeset	436 <note>
fc3ba2e76974 Documented size of keys_zone for commercial version (trac #1286). Yaroslav Zhuravlev <yar@nginx.com> parents: 1991 diff changeset	437 As part of
fc3ba2e76974 Documented size of keys_zone for commercial version (trac #1286). Yaroslav Zhuravlev <yar@nginx.com> parents: 1991 diff changeset	438 <commercial_version>commercial subscription</commercial_version>,
fc3ba2e76974 Documented size of keys_zone for commercial version (trac #1286). Yaroslav Zhuravlev <yar@nginx.com> parents: 1991 diff changeset	439 the shared memory zone also stores extended
fc3ba2e76974 Documented size of keys_zone for commercial version (trac #1286). Yaroslav Zhuravlev <yar@nginx.com> parents: 1991 diff changeset	440 cache <link doc="ngx_http_api_module.xml" id="http_caches_">information</link>,
fc3ba2e76974 Documented size of keys_zone for commercial version (trac #1286). Yaroslav Zhuravlev <yar@nginx.com> parents: 1991 diff changeset	441 thus, it is required to specify a larger zone size for the same number of keys.
fc3ba2e76974 Documented size of keys_zone for commercial version (trac #1286). Yaroslav Zhuravlev <yar@nginx.com> parents: 1991 diff changeset	442 For example,
fc3ba2e76974 Documented size of keys_zone for commercial version (trac #1286). Yaroslav Zhuravlev <yar@nginx.com> parents: 1991 diff changeset	443 one megabyte zone can store about 4 thousand keys.
fc3ba2e76974 Documented size of keys_zone for commercial version (trac #1286). Yaroslav Zhuravlev <yar@nginx.com> parents: 1991 diff changeset	444 </note>
1189 f25d00109de0 Documented cache keys_zone memory estimates. Maxim Dounin <mdounin@mdounin.ru> parents: 1185 diff changeset	445 </para>
f25d00109de0 Documented cache keys_zone memory estimates. Maxim Dounin <mdounin@mdounin.ru> parents: 1185 diff changeset	446
f25d00109de0 Documented cache keys_zone memory estimates. Maxim Dounin <mdounin@mdounin.ru> parents: 1185 diff changeset	447 <para>
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	448 Cached data that are not accessed during the time specified by the
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	449 <literal>inactive</literal> parameter get removed from the cache
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	450 regardless of their freshness.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	451 By default, <literal>inactive</literal> is set to 10 minutes.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	452 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	453
2560 a5bbfdf88bbd Documented the "min_free" parameter of proxy_cache_path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2254 diff changeset	454 <para id="scgi_cache_path_max_size">
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	455 The special “cache manager” process monitors the maximum cache size set
2560 a5bbfdf88bbd Documented the "min_free" parameter of proxy_cache_path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2254 diff changeset	456 by the <literal>max_size</literal> parameter,
a5bbfdf88bbd Documented the "min_free" parameter of proxy_cache_path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2254 diff changeset	457 and the minimum amount of free space set
a5bbfdf88bbd Documented the "min_free" parameter of proxy_cache_path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2254 diff changeset	458 by the <literal>min_free</literal> (1.19.1) parameter
a5bbfdf88bbd Documented the "min_free" parameter of proxy_cache_path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2254 diff changeset	459 on the file system with cache.
a5bbfdf88bbd Documented the "min_free" parameter of proxy_cache_path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2254 diff changeset	460 When the size is exceeded or there is not enough free space,
a5bbfdf88bbd Documented the "min_free" parameter of proxy_cache_path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2254 diff changeset	461 it removes the least recently used data.
1810 bc6341aaa832 Added cache manager parameters to proxy_cache path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1803 diff changeset	462 The data is removed in iterations configured by
bc6341aaa832 Added cache manager parameters to proxy_cache path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1803 diff changeset	463 <literal>manager_files</literal>,
bc6341aaa832 Added cache manager parameters to proxy_cache path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1803 diff changeset	464 <literal>manager_threshold</literal>, and
bc6341aaa832 Added cache manager parameters to proxy_cache path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1803 diff changeset	465 <literal>manager_sleep</literal> parameters (1.11.5).
bc6341aaa832 Added cache manager parameters to proxy_cache path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1803 diff changeset	466 During one iteration no more than <literal>manager_files</literal> items
1812 35ec213c16cf Removed extraneous whitespace. Ruslan Ermilov <ru@nginx.com> parents: 1810 diff changeset	467 are deleted (by default, 100).
1810 bc6341aaa832 Added cache manager parameters to proxy_cache path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1803 diff changeset	468 The duration of one iteration is limited by the
bc6341aaa832 Added cache manager parameters to proxy_cache path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1803 diff changeset	469 <literal>manager_threshold</literal> parameter (by default, 200 milliseconds).
bc6341aaa832 Added cache manager parameters to proxy_cache path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1803 diff changeset	470 Between iterations, a pause configured by the <literal>manager_sleep</literal>
bc6341aaa832 Added cache manager parameters to proxy_cache path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1803 diff changeset	471 parameter (by default, 50 milliseconds) is made.
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	472 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	473
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	474 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	475 A minute after the start the special “cache loader” process is activated.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	476 It loads information about previously cached data stored on file system
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	477 into a cache zone.
1810 bc6341aaa832 Added cache manager parameters to proxy_cache path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1803 diff changeset	478 The loading is also done in iterations.
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	479 During one iteration no more than <literal>loader_files</literal> items
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	480 are loaded (by default, 100).
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	481 Besides, the duration of one iteration is limited by the
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	482 <literal>loader_threshold</literal> parameter (by default, 200 milliseconds).
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	483 Between iterations, a pause configured by the <literal>loader_sleep</literal>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	484 parameter (by default, 50 milliseconds) is made.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	485 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	486
1582 8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	487 <para>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	488 Additionally,
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	489 the following parameters are available as part of our
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	490 <commercial_version>commercial subscription</commercial_version>:
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	491 </para>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	492
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	493 <para>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	494 <list type="tag">
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	495
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	496 <tag-name id="purger">
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	497 <literal>purger</literal>=<literal>on</literal>\|<literal>off</literal>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	498 </tag-name>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	499 <tag-desc>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	500 Instructs whether cache entries that match a
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	501 <link id="scgi_cache_purge">wildcard key</link>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	502 will be removed from the disk by the cache purger (1.7.12).
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	503 Setting the parameter to <literal>on</literal>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	504 (default is <literal>off</literal>)
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	505 will activate the “cache purger” process that
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	506 permanently iterates through all cache entries
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	507 and deletes the entries that match the wildcard key.
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	508 </tag-desc>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	509
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	510 <tag-name id="purger_files">
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	511 <literal>purger_files</literal>=<value>number</value>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	512 </tag-name>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	513 <tag-desc>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	514 Sets the number of items that will be scanned during one iteration (1.7.12).
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	515 By default, <literal>purger_files</literal> is set to 10.
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	516 </tag-desc>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	517
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	518 <tag-name id="purger_threshold">
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	519 <literal>purger_threshold</literal>=<value>number</value>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	520 </tag-name>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	521 <tag-desc>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	522 Sets the duration of one iteration (1.7.12).
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	523 By default, <literal>purger_threshold</literal> is set to 50 milliseconds.
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	524 </tag-desc>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	525
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	526 <tag-name id="purger_sleep">
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	527 <literal>purger_sleep</literal>=<value>number</value>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	528 </tag-name>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	529 <tag-desc>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	530 Sets a pause between iterations (1.7.12).
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	531 By default, <literal>purger_sleep</literal> is set to 50 milliseconds.
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	532 </tag-desc>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	533
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	534 </list>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	535 </para>
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	536
1973 3460bd328287 Documented cache version change in proxy_cache_path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1956 diff changeset	537 <para>
3460bd328287 Documented cache version change in proxy_cache_path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1956 diff changeset	538 <note>
3460bd328287 Documented cache version change in proxy_cache_path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1956 diff changeset	539 In versions 1.7.3, 1.7.7, and 1.11.10 cache header format has been changed.
3460bd328287 Documented cache version change in proxy_cache_path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1956 diff changeset	540 Previously cached responses will be considered invalid
3460bd328287 Documented cache version change in proxy_cache_path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1956 diff changeset	541 after upgrading to a newer nginx version.
3460bd328287 Documented cache version change in proxy_cache_path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1956 diff changeset	542 </note>
3460bd328287 Documented cache version change in proxy_cache_path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1956 diff changeset	543 </para>
3460bd328287 Documented cache version change in proxy_cache_path and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1956 diff changeset	544
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	545 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	546
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	547
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	548 <directive name="scgi_cache_purge">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	549 <syntax>string ...</syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	550 <default/>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	551 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	552 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	553 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	554 <appeared-in>1.5.7</appeared-in>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	555
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	556 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	557 Defines conditions under which the request will be considered a cache
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	558 purge request.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	559 If at least one value of the string parameters is not empty and is not equal
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	560 to “0” then the cache entry with a corresponding
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	561 <link id="scgi_cache_key">cache key</link> is removed.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	562 The result of successful operation is indicated by returning
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	563 the <http-status code="204" text="No Content"/> response.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	564 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	565
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	566 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	567 If the <link id="scgi_cache_key">cache key</link> of a purge request ends
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	568 with an asterisk (“<literal>*</literal>”), all cache entries matching the
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	569 wildcard key will be removed from the cache.
1582 8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	570 However, these entries will remain on the disk until they are deleted
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	571 for either <link id="scgi_cache_path">inactivity</link>,
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	572 or processed by the <link id="purger">cache purger</link> (1.7.12),
8973c7b37854 Updated commercial docs. Yaroslav Zhuravlev <yar@nginx.com> parents: 1550 diff changeset	573 or a client attempts to access them.
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	574 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	575
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	576 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	577 Example configuration:
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	578 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	579 scgi_cache_path /data/nginx/cache keys_zone=cache_zone:10m;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	580
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	581 map $request_method $purge_method {
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	582 PURGE 1;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	583 default 0;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	584 }
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	585
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	586 server {
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	587 ...
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	588 location / {
1185 f9c8336fe43c Aligned configuration examples with fastcgi/scgi_cache_purge. Ruslan Ermilov <ru@nginx.com> parents: 1184 diff changeset	589 scgi_pass backend;
f9c8336fe43c Aligned configuration examples with fastcgi/scgi_cache_purge. Ruslan Ermilov <ru@nginx.com> parents: 1184 diff changeset	590 scgi_cache cache_zone;
f9c8336fe43c Aligned configuration examples with fastcgi/scgi_cache_purge. Ruslan Ermilov <ru@nginx.com> parents: 1184 diff changeset	591 scgi_cache_key $uri;
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	592 scgi_cache_purge $purge_method;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	593 }
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	594 }
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	595 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	596 <note>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	597 This functionality is available as part of our
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	598 <commercial_version>commercial subscription</commercial_version>.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	599 </note>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	600 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	601
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	602 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	603
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	604
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	605 <directive name="scgi_cache_revalidate">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	606 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	607 <default>off</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	608 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	609 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	610 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	611 <appeared-in>1.5.7</appeared-in>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	612
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	613 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	614 Enables revalidation of expired cache items using conditional requests with
1246 5be7716a5684 Documented If-None-Match in proxy_cache_revalidate and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1190 diff changeset	615 the <header>If-Modified-Since</header> and <header>If-None-Match</header>
5be7716a5684 Documented If-None-Match in proxy_cache_revalidate and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1190 diff changeset	616 header fields.
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	617 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	618
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	619 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	620
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	621
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	622 <directive name="scgi_cache_use_stale">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	623 <syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	624 <literal>error</literal> \|
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	625 <literal>timeout</literal> \|
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	626 <literal>invalid_header</literal> \|
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	627 <literal>updating</literal> \|
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	628 <literal>http_500</literal> \|
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	629 <literal>http_503</literal> \|
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	630 <literal>http_403</literal> \|
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	631 <literal>http_404</literal> \|
1956 dd96a09dd4f7 Documented support for "429 Too Many Requests" response. Yaroslav Zhuravlev <yar@nginx.com> parents: 1923 diff changeset	632 <literal>http_429</literal> \|
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	633 <literal>off</literal>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	634 ...</syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	635 <default>off</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	636 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	637 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	638 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	639
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	640 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	641 Determines in which cases a stale cached response can be used
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	642 when an error occurs during communication with the SCGI server.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	643 The directive’s parameters match the parameters of the
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	644 <link id="scgi_next_upstream"/> directive.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	645 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	646
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	647 <para>
1542 a13a99cf46ea Better documented "_cache_use_stale error". Ruslan Ermilov <ru@nginx.com>* parents: 1524 diff changeset	648 The <literal>error</literal> parameter also permits
a13a99cf46ea Better documented "_cache_use_stale error". Ruslan Ermilov <ru@nginx.com>* parents: 1524 diff changeset	649 using a stale cached response if an SCGI server to process a request
a13a99cf46ea Better documented "_cache_use_stale error". Ruslan Ermilov <ru@nginx.com>* parents: 1524 diff changeset	650 cannot be selected.
a13a99cf46ea Better documented "_cache_use_stale error". Ruslan Ermilov <ru@nginx.com>* parents: 1524 diff changeset	651 </para>
a13a99cf46ea Better documented "_cache_use_stale error". Ruslan Ermilov <ru@nginx.com>* parents: 1524 diff changeset	652
1909 399d0e188195 Documented proxy_cache_background_update and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1885 diff changeset	653 <para id="scgi_cache_use_stale_updating">
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	654 Additionally, the <literal>updating</literal> parameter permits
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	655 using a stale cached response if it is currently being updated.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	656 This allows minimizing the number of accesses to SCGI servers
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	657 when updating cached data.
1912 ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	658 </para>
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	659
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	660 <para>
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	661 Using a stale cached response
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	662 can also be enabled directly in the response header
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	663 for a specified number of seconds after the response became stale (1.11.10).
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	664 This has lower priority than using the directive parameters.
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	665 <list type="bullet" compact="no">
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	666
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	667 <listitem>
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	668 The
1910 41cf2c2d8c5c Cache: support for stale-while-revalidate and stale-if-error. Yaroslav Zhuravlev <yar@nginx.com> parents: 1909 diff changeset	669 “<link url="https://tools.ietf.org/html/rfc5861#section-3">stale-while-revalidate</link>”
1912 ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	670 extension of the <header>Cache-Control</header> header field permits
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	671 using a stale cached response if it is currently being updated.
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	672 </listitem>
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	673
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	674 <listitem>
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	675 The
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	676 “<link url="https://tools.ietf.org/html/rfc5861#section-4">stale-if-error</link>”
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	677 extension of the <header>Cache-Control</header> header field permits
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	678 using a stale cached response in case of an error.
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	679 </listitem>
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	680
ec4af97e4403 Split off header options from parameters in proxy_cache_use_stale and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1910 diff changeset	681 </list>
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	682 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	683
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	684 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	685 To minimize the number of accesses to SCGI servers when
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	686 populating a new cache element, the <link id="scgi_cache_lock"/>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	687 directive can be used.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	688 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	689
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	690 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	691
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	692
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	693 <directive name="scgi_cache_valid">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	694 <syntax>[<value>code</value> ...] <value>time</value></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	695 <default/>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	696 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	697 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	698 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	699
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	700 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	701 Sets caching time for different response codes.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	702 For example, the following directives
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	703 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	704 scgi_cache_valid 200 302 10m;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	705 scgi_cache_valid 404 1m;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	706 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	707 set 10 minutes of caching for responses with codes 200 and 302
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	708 and 1 minute for responses with code 404.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	709 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	710
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	711 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	712 If only caching <value>time</value> is specified
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	713 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	714 scgi_cache_valid 5m;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	715 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	716 then only 200, 301, and 302 responses are cached.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	717 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	718
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	719 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	720 In addition, the <literal>any</literal> parameter can be specified
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	721 to cache any responses:
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	722 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	723 scgi_cache_valid 200 302 10m;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	724 scgi_cache_valid 301 1h;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	725 scgi_cache_valid any 1m;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	726 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	727 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	728
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	729 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	730 Parameters of caching can also be set directly
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	731 in the response header.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	732 This has higher priority than setting of caching time using the directive.
1349 97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	733 <list type="bullet" compact="no">
97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	734
97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	735 <listitem>
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	736 The <header>X-Accel-Expires</header> header field sets caching time of a
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	737 response in seconds.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	738 The zero value disables caching for a response.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	739 If the value starts with the <literal>@</literal> prefix, it sets an absolute
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	740 time in seconds since Epoch, up to which the response may be cached.
1349 97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	741 </listitem>
97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	742
97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	743 <listitem>
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	744 If the header does not include the <header>X-Accel-Expires</header> field,
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	745 parameters of caching may be set in the header fields
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	746 <header>Expires</header> or <header>Cache-Control</header>.
1349 97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	747 </listitem>
97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	748
97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	749 <listitem>
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	750 If the header includes the <header>Set-Cookie</header> field, such a
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	751 response will not be cached.
1349 97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	752 </listitem>
97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	753
1353 25db29c8875e Documented how the "Vary" response header field affects caching. Ruslan Ermilov <ru@nginx.com> parents: 1352 diff changeset	754 <listitem>
25db29c8875e Documented how the "Vary" response header field affects caching. Ruslan Ermilov <ru@nginx.com> parents: 1352 diff changeset	755 If the header includes the <header>Vary</header> field
25db29c8875e Documented how the "Vary" response header field affects caching. Ruslan Ermilov <ru@nginx.com> parents: 1352 diff changeset	756 with the special value “<literal>*</literal>”, such a
25db29c8875e Documented how the "Vary" response header field affects caching. Ruslan Ermilov <ru@nginx.com> parents: 1352 diff changeset	757 response will not be cached (1.7.7).
25db29c8875e Documented how the "Vary" response header field affects caching. Ruslan Ermilov <ru@nginx.com> parents: 1352 diff changeset	758 If the header includes the <header>Vary</header> field
25db29c8875e Documented how the "Vary" response header field affects caching. Ruslan Ermilov <ru@nginx.com> parents: 1352 diff changeset	759 with another value, such a response will be cached
25db29c8875e Documented how the "Vary" response header field affects caching. Ruslan Ermilov <ru@nginx.com> parents: 1352 diff changeset	760 taking into account the corresponding request header fields (1.7.7).
25db29c8875e Documented how the "Vary" response header field affects caching. Ruslan Ermilov <ru@nginx.com> parents: 1352 diff changeset	761 </listitem>
25db29c8875e Documented how the "Vary" response header field affects caching. Ruslan Ermilov <ru@nginx.com> parents: 1352 diff changeset	762
1349 97c8b146cb0e Split the long paragraph about caching parameters into the list. Ruslan Ermilov <ru@nginx.com> parents: 1345 diff changeset	763 </list>
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	764 Processing of one or more of these response header fields can be disabled
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	765 using the <link id="scgi_ignore_headers"/> directive.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	766 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	767
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	768 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	769
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	770
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	771 <directive name="scgi_connect_timeout">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	772 <syntax><value>time</value></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	773 <default>60s</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	774 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	775 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	776 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	777
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	778 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	779 Defines a timeout for establishing a connection with an SCGI server.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	780 It should be noted that this timeout cannot usually exceed 75 seconds.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	781 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	782
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	783 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	784
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	785
1337 91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	786 <directive name="scgi_force_ranges">
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	787 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	788 <default>off</default>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	789 <context>http</context>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	790 <context>server</context>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	791 <context>location</context>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	792 <appeared-in>1.7.7</appeared-in>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	793
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	794 <para>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	795 Enables byte-range support
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	796 for both cached and uncached responses from the SCGI server
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	797 regardless of the <header>Accept-Ranges</header> field in these responses.
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	798 </para>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	799
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	800 </directive>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	801
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	802
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	803 <directive name="scgi_hide_header">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	804 <syntax><value>field</value></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	805 <default/>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	806 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	807 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	808 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	809
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	810 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	811 By default,
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	812 nginx does not pass the header fields <header>Status</header> and
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	813 <header>X-Accel-...</header> from the response of an SCGI
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	814 server to a client.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	815 The <literal>scgi_hide_header</literal> directive sets additional fields
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	816 that will not be passed.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	817 If, on the contrary, the passing of fields needs to be permitted,
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	818 the <link id="scgi_pass_header"/> directive can be used.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	819 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	820
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	821 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	822
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	823
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	824 <directive name="scgi_ignore_client_abort">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	825 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	826 <default>off</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	827 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	828 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	829 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	830
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	831 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	832 Determines whether the connection with an SCGI server should be
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	833 closed when a client closes the connection without waiting
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	834 for a response.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	835 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	836
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	837 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	838
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	839
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	840 <directive name="scgi_ignore_headers">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	841 <syntax><value>field</value> ...</syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	842 <default/>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	843 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	844 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	845 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	846
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	847 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	848 Disables processing of certain response header fields from the SCGI server.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	849 The following fields can be ignored: <header>X-Accel-Redirect</header>,
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	850 <header>X-Accel-Expires</header>, <header>X-Accel-Limit-Rate</header> (1.1.6),
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	851 <header>X-Accel-Buffering</header> (1.1.6),
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	852 <header>X-Accel-Charset</header> (1.1.6), <header>Expires</header>,
1345 da296387cdac Documented the Vary support in proxy_ignore_headers and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1343 diff changeset	853 <header>Cache-Control</header>, <header>Set-Cookie</header> (0.8.44),
da296387cdac Documented the Vary support in proxy_ignore_headers and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1343 diff changeset	854 and <header>Vary</header> (1.7.7).
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	855 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	856
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	857 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	858 If not disabled, processing of these header fields has the following
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	859 effect:
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	860 <list type="bullet" compact="no">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	861
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	862 <listitem>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	863 <header>X-Accel-Expires</header>, <header>Expires</header>,
1345 da296387cdac Documented the Vary support in proxy_ignore_headers and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1343 diff changeset	864 <header>Cache-Control</header>, <header>Set-Cookie</header>,
da296387cdac Documented the Vary support in proxy_ignore_headers and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1343 diff changeset	865 and <header>Vary</header>
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	866 set the parameters of response <link id="scgi_cache_valid">caching</link>;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	867 </listitem>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	868
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	869 <listitem>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	870 <header>X-Accel-Redirect</header> performs an
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	871 <link doc="ngx_http_core_module.xml" id="internal">internal
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	872 redirect</link> to the specified URI;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	873 </listitem>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	874
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	875 <listitem>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	876 <header>X-Accel-Limit-Rate</header> sets the
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	877 <link doc="ngx_http_core_module.xml" id="limit_rate">rate
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	878 limit</link> for transmission of a response to a client;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	879 </listitem>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	880
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	881 <listitem>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	882 <header>X-Accel-Buffering</header> enables or disables
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	883 <link id="scgi_buffering">buffering</link> of a response;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	884 </listitem>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	885
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	886 <listitem>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	887 <header>X-Accel-Charset</header> sets the desired
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	888 <link doc="ngx_http_charset_module.xml" id="charset"/>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	889 of a response.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	890 </listitem>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	891
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	892 </list>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	893 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	894
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	895 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	896
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	897
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	898 <directive name="scgi_intercept_errors">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	899 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	900 <default>off</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	901 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	902 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	903 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	904
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	905 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	906 Determines whether an SCGI server responses with codes greater than or equal
1803 621d0c682113 Clarified description of proxy_intercept_errors and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1796 diff changeset	907 to 300 should be passed to a client
621d0c682113 Clarified description of proxy_intercept_errors and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1796 diff changeset	908 or be intercepted and redirected to nginx for processing
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	909 with the <link doc="ngx_http_core_module.xml" id="error_page"/> directive.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	910 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	911
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	912 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	913
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	914
1342 758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	915 <directive name="scgi_limit_rate">
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	916 <syntax><value>rate</value></syntax>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	917 <default>0</default>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	918 <context>http</context>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	919 <context>server</context>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	920 <context>location</context>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	921 <appeared-in>1.7.7</appeared-in>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	922
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	923 <para>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	924 Limits the speed of reading the response from the SCGI server.
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	925 The <value>rate</value> is specified in bytes per second.
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	926 The zero value disables rate limiting.
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	927 The limit is set per a request, and so if nginx simultaneously opens
1343 1bdde28e359b Fixed fallouts from the previous change. Ruslan Ermilov <ru@nginx.com> parents: 1342 diff changeset	928 two connections to the SCGI server,
1bdde28e359b Fixed fallouts from the previous change. Ruslan Ermilov <ru@nginx.com> parents: 1342 diff changeset	929 the overall rate will be twice as much as the specified limit.
1342 758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	930 The limitation works only if
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	931 <link id="scgi_buffering">buffering</link> of responses from the SCGI
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	932 server is enabled.
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	933 </para>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	934
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	935 </directive>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	936
758fc0b02651 Documented the "proxy_limit_rate" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1337 diff changeset	937
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	938 <directive name="scgi_max_temp_file_size">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	939 <syntax><value>size</value></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	940 <default>1024m</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	941 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	942 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	943 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	944
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	945 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	946 When <link id="scgi_buffering">buffering</link> of responses from the SCGI
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	947 server is enabled, and the whole response does not fit into the buffers
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	948 set by the <link id="scgi_buffer_size"/> and <link id="scgi_buffers"/>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	949 directives, a part of the response can be saved to a temporary file.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	950 This directive sets the maximum <value>size</value> of the temporary file.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	951 The size of data written to the temporary file at a time is set
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	952 by the <link id="scgi_temp_file_write_size"/> directive.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	953 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	954
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	955 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	956 The zero value disables buffering of responses to temporary files.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	957 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	958
1352 dbb618f60a54 Elaborate on writing proxied responses to files. Ruslan Ermilov <ru@nginx.com> parents: 1349 diff changeset	959 <para>
dbb618f60a54 Elaborate on writing proxied responses to files. Ruslan Ermilov <ru@nginx.com> parents: 1349 diff changeset	960 <note>
dbb618f60a54 Elaborate on writing proxied responses to files. Ruslan Ermilov <ru@nginx.com> parents: 1349 diff changeset	961 This restriction does not apply to responses
dbb618f60a54 Elaborate on writing proxied responses to files. Ruslan Ermilov <ru@nginx.com> parents: 1349 diff changeset	962 that will be <link id="scgi_cache">cached</link>
dbb618f60a54 Elaborate on writing proxied responses to files. Ruslan Ermilov <ru@nginx.com> parents: 1349 diff changeset	963 or <link id="scgi_store">stored</link> on disk.
dbb618f60a54 Elaborate on writing proxied responses to files. Ruslan Ermilov <ru@nginx.com> parents: 1349 diff changeset	964 </note>
dbb618f60a54 Elaborate on writing proxied responses to files. Ruslan Ermilov <ru@nginx.com> parents: 1349 diff changeset	965 </para>
dbb618f60a54 Elaborate on writing proxied responses to files. Ruslan Ermilov <ru@nginx.com> parents: 1349 diff changeset	966
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	967 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	968
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	969
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	970 <directive name="scgi_next_upstream">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	971 <syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	972 <literal>error</literal> \|
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	973 <literal>timeout</literal> \|
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	974 <literal>invalid_header</literal> \|
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	975 <literal>http_500</literal> \|
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	976 <literal>http_503</literal> \|
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	977 <literal>http_403</literal> \|
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	978 <literal>http_404</literal> \|
1956 dd96a09dd4f7 Documented support for "429 Too Many Requests" response. Yaroslav Zhuravlev <yar@nginx.com> parents: 1923 diff changeset	979 <literal>http_429</literal> \|
1669 c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	980 <literal>non_idempotent</literal> \|
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	981 <literal>off</literal>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	982 ...</syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	983 <default>error timeout</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	984 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	985 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	986 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	987
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	988 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	989 Specifies in which cases a request should be passed to the next server:
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	990 <list type="tag">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	991
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	992 <tag-name><literal>error</literal></tag-name>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	993 <tag-desc>an error occurred while establishing a connection with the
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	994 server, passing a request to it, or reading the response header;</tag-desc>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	995
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	996 <tag-name><literal>timeout</literal></tag-name>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	997 <tag-desc>a timeout has occurred while establishing a connection with the
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	998 server, passing a request to it, or reading the response header;</tag-desc>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	999
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1000 <tag-name><literal>invalid_header</literal></tag-name>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1001 <tag-desc>a server returned an empty or invalid response;</tag-desc>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1002
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1003 <tag-name><literal>http_500</literal></tag-name>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1004 <tag-desc>a server returned a response with the code 500;</tag-desc>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1005
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1006 <tag-name><literal>http_503</literal></tag-name>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1007 <tag-desc>a server returned a response with the code 503;</tag-desc>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1008
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1009 <tag-name><literal>http_403</literal></tag-name>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1010 <tag-desc>a server returned a response with the code 403;</tag-desc>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1011
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1012 <tag-name><literal>http_404</literal></tag-name>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1013 <tag-desc>a server returned a response with the code 404;</tag-desc>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1014
1956 dd96a09dd4f7 Documented support for "429 Too Many Requests" response. Yaroslav Zhuravlev <yar@nginx.com> parents: 1923 diff changeset	1015 <tag-name><literal>http_429</literal></tag-name>
dd96a09dd4f7 Documented support for "429 Too Many Requests" response. Yaroslav Zhuravlev <yar@nginx.com> parents: 1923 diff changeset	1016 <tag-desc>a server returned a response with the code 429 (1.11.13);</tag-desc>
dd96a09dd4f7 Documented support for "429 Too Many Requests" response. Yaroslav Zhuravlev <yar@nginx.com> parents: 1923 diff changeset	1017
1669 c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1018 <tag-name id="non_idempotent"><literal>non_idempotent</literal></tag-name>
c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1019 <tag-desc>normally, requests with a
1923 66a30a380fba Fixed links to tools.ietf.org. Ruslan Ermilov <ru@nginx.com> parents: 1912 diff changeset	1020 <link url="https://tools.ietf.org/html/rfc7231#section-4.2.2">non-idempotent</link>
1669 c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1021 method
c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1022 (<literal>POST</literal>, <literal>LOCK</literal>, <literal>PATCH</literal>)
c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1023 are not passed to the next server
c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1024 if a request has been sent to an upstream server (1.9.13);
c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1025 enabling this option explicitly allows retrying such requests;
c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1026 </tag-desc>
c872b93682f4 Added "non_idempotent" for proxy_next_upstream and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	1027
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1028 <tag-name><literal>off</literal></tag-name>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1029 <tag-desc>disables passing a request to the next server.</tag-desc>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1030
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1031 </list>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1032 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1033
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1034 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1035 One should bear in mind that passing a request to the next server is
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1036 only possible if nothing has been sent to a client yet.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1037 That is, if an error or timeout occurs in the middle of the
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1038 transferring of a response, fixing this is impossible.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1039 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1040
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1041 <para>
1289 57fc39924d42 Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 1246 diff changeset	1042 The directive also defines what is considered an
57fc39924d42 Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 1246 diff changeset	1043 <link doc="ngx_http_upstream_module.xml" id="max_fails">unsuccessful
57fc39924d42 Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 1246 diff changeset	1044 attempt</link> of communication with a server.
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1045 The cases of <literal>error</literal>, <literal>timeout</literal> and
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1046 <literal>invalid_header</literal> are always considered unsuccessful attempts,
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1047 even if they are not specified in the directive.
1956 dd96a09dd4f7 Documented support for "429 Too Many Requests" response. Yaroslav Zhuravlev <yar@nginx.com> parents: 1923 diff changeset	1048 The cases of <literal>http_500</literal>, <literal>http_503</literal>,
dd96a09dd4f7 Documented support for "429 Too Many Requests" response. Yaroslav Zhuravlev <yar@nginx.com> parents: 1923 diff changeset	1049 and <literal>http_429</literal> are
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1050 considered unsuccessful attempts only if they are specified in the directive.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1051 The cases of <literal>http_403</literal> and <literal>http_404</literal>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1052 are never considered unsuccessful attempts.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1053 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1054
1290 f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1055 <para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1056 Passing a request to the next server can be limited by
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1057 <link id="scgi_next_upstream_tries">the number of tries</link>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1058 and by <link id="scgi_next_upstream_timeout">time</link>.
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1059 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1060
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1061 </directive>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1062
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1063
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1064 <directive name="scgi_next_upstream_timeout">
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1065 <syntax><value>time</value></syntax>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1066 <default>0</default>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1067 <context>http</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1068 <context>server</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1069 <context>location</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1070 <appeared-in>1.7.5</appeared-in>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1071
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1072 <para>
1672 9c98c4498f08 Rephrased the "proxy_next_upstream_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1669 diff changeset	1073 Limits the time during which a request can be passed to the
1290 f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1074 <link id="scgi_next_upstream">next server</link>.
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1075 The <literal>0</literal> value turns off this limitation.
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1076 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1077
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1078 </directive>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1079
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1080
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1081 <directive name="scgi_next_upstream_tries">
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1082 <syntax><value>number</value></syntax>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1083 <default>0</default>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1084 <context>http</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1085 <context>server</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1086 <context>location</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1087 <appeared-in>1.7.5</appeared-in>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1088
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1089 <para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1090 Limits the number of possible tries for passing a request to the
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1091 <link id="scgi_next_upstream">next server</link>.
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1092 The <literal>0</literal> value turns off this limitation.
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1093 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	1094
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1095 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1096
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1097
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1098 <directive name="scgi_no_cache">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1099 <syntax><value>string</value> ...</syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1100 <default/>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1101 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1102 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1103 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1104
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1105 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1106 Defines conditions under which the response will not be saved to a cache.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1107 If at least one value of the string parameters is not empty and is not
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1108 equal to “0” then the response will not be saved:
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1109 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1110 scgi_no_cache $cookie_nocache $arg_nocache$arg_comment;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1111 scgi_no_cache $http_pragma $http_authorization;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1112 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1113 Can be used along with the <link id="scgi_cache_bypass"/> directive.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1114 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1115
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1116 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1117
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1118
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1119 <directive name="scgi_param">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1120 <syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1121 <value>parameter</value> <value>value</value>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1122 [<literal>if_not_empty</literal>]</syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1123 <default/>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1124 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1125 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1126 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1127
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1128 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1129 Sets a <value>parameter</value> that should be passed to the SCGI server.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1130 The <value>value</value> can contain text, variables, and their combination.
2593 eeed494bba51 Unified phrases about configuration levels and inheritance. Ruslan Ermilov <ru@nginx.com> parents: 2560 diff changeset	1131 These directives are inherited from the previous configuration level
eeed494bba51 Unified phrases about configuration levels and inheritance. Ruslan Ermilov <ru@nginx.com> parents: 2560 diff changeset	1132 if and only if there are no <literal>scgi_param</literal> directives
eeed494bba51 Unified phrases about configuration levels and inheritance. Ruslan Ermilov <ru@nginx.com> parents: 2560 diff changeset	1133 defined on the current level.
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1134 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1135
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1136 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1137 Standard
1923 66a30a380fba Fixed links to tools.ietf.org. Ruslan Ermilov <ru@nginx.com> parents: 1912 diff changeset	1138 <link url="https://tools.ietf.org/html/rfc3875#section-4.1">CGI
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1139 environment variables</link>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1140 should be provided as SCGI headers, see the <path>scgi_params</path> file
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1141 provided in the distribution:
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1142 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1143 location / {
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1144 include scgi_params;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1145 ...
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1146 }
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1147 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1148 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1149
1182 ec1097156f81 Scgi: restored if_not_empty lost during conversion from fastcgi. Ruslan Ermilov <ru@nginx.com> parents: 1180 diff changeset	1150 <para>
1731 ae6bdb65ca7f Corrected article in fastcgi_param and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1696 diff changeset	1151 If the directive is specified with <literal>if_not_empty</literal> (1.1.11) then
2083 fb5eef3637a4 Avoid double negative in if_not_empty. Sergey Kandaurov <pluknet@nginx.com> parents: 2069 diff changeset	1152 such a parameter will be passed to the server only if its value is not empty:
1182 ec1097156f81 Scgi: restored if_not_empty lost during conversion from fastcgi. Ruslan Ermilov <ru@nginx.com> parents: 1180 diff changeset	1153 <example>
ec1097156f81 Scgi: restored if_not_empty lost during conversion from fastcgi. Ruslan Ermilov <ru@nginx.com> parents: 1180 diff changeset	1154 scgi_param HTTPS $https if_not_empty;
ec1097156f81 Scgi: restored if_not_empty lost during conversion from fastcgi. Ruslan Ermilov <ru@nginx.com> parents: 1180 diff changeset	1155 </example>
ec1097156f81 Scgi: restored if_not_empty lost during conversion from fastcgi. Ruslan Ermilov <ru@nginx.com> parents: 1180 diff changeset	1156 </para>
ec1097156f81 Scgi: restored if_not_empty lost during conversion from fastcgi. Ruslan Ermilov <ru@nginx.com> parents: 1180 diff changeset	1157
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1158 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1159
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1160
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1161 <directive name="scgi_pass">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1162 <syntax><value>address</value></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1163 <default/>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1164 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1165 <context>if in location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1166
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1167 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1168 Sets the address of an SCGI server.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1169 The address can be specified as a domain name or IP address,
1620 a225fa77389a Port in fastcgi_pass, scgi_pass, and uwsgi_pass is not optional. Ruslan Ermilov <ru@nginx.com> parents: 1582 diff changeset	1170 and a port:
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1171 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1172 scgi_pass localhost:9000;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1173 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1174 or as a UNIX-domain socket path:
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1175 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1176 scgi_pass unix:/tmp/scgi.socket;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1177 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1178 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1179
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1180 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1181 If a domain name resolves to several addresses, all of them will be
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1182 used in a round-robin fashion.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1183 In addition, an address can be specified as a
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1184 <link doc="ngx_http_upstream_module.xml">server group</link>.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1185 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1186
1991 4f3dd2f548cf Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass. Ruslan Ermilov <ru@nginx.com> parents: 1973 diff changeset	1187 <para>
4f3dd2f548cf Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass. Ruslan Ermilov <ru@nginx.com> parents: 1973 diff changeset	1188 Parameter value can contain variables.
4f3dd2f548cf Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass. Ruslan Ermilov <ru@nginx.com> parents: 1973 diff changeset	1189 In this case, if an address is specified as a domain name,
4f3dd2f548cf Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass. Ruslan Ermilov <ru@nginx.com> parents: 1973 diff changeset	1190 the name is searched among the described
4f3dd2f548cf Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass. Ruslan Ermilov <ru@nginx.com> parents: 1973 diff changeset	1191 <link doc="ngx_http_upstream_module.xml">server groups</link>,
4f3dd2f548cf Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass. Ruslan Ermilov <ru@nginx.com> parents: 1973 diff changeset	1192 and, if not found, is determined using a
4f3dd2f548cf Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass. Ruslan Ermilov <ru@nginx.com> parents: 1973 diff changeset	1193 <link doc="ngx_http_core_module.xml" id="resolver"/>.
4f3dd2f548cf Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass. Ruslan Ermilov <ru@nginx.com> parents: 1973 diff changeset	1194 </para>
4f3dd2f548cf Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass. Ruslan Ermilov <ru@nginx.com> parents: 1973 diff changeset	1195
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1196 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1197
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1198
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1199 <directive name="scgi_pass_header">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1200 <syntax><value>field</value></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1201 <default/>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1202 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1203 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1204 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1205
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1206 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1207 Permits passing <link id="scgi_hide_header">otherwise disabled</link> header
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1208 fields from an SCGI server to a client.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1209 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1210
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1211 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1212
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1213
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1214 <directive name="scgi_pass_request_body">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1215 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1216 <default>on</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1217 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1218 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1219 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1220
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1221 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1222 Indicates whether the original request body is passed
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1223 to the SCGI server.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1224 See also the <link id="scgi_pass_request_headers"/> directive.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1225 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1226
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1227 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1228
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1229
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1230 <directive name="scgi_pass_request_headers">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1231 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1232 <default>on</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1233 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1234 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1235 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1236
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1237 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1238 Indicates whether the header fields of the original request are passed
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1239 to the SCGI server.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1240 See also the <link id="scgi_pass_request_body"/> directive.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1241 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1242
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1243 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1244
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1245
1524 323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1443 diff changeset	1246 <directive name="scgi_read_timeout">
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1443 diff changeset	1247 <syntax><value>time</value></syntax>
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1443 diff changeset	1248 <default>60s</default>
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1443 diff changeset	1249 <context>http</context>
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1443 diff changeset	1250 <context>server</context>
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1443 diff changeset	1251 <context>location</context>
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1443 diff changeset	1252
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1443 diff changeset	1253 <para>
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1443 diff changeset	1254 Defines a timeout for reading a response from the SCGI server.
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1443 diff changeset	1255 The timeout is set only between two successive read operations,
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1443 diff changeset	1256 not for the transmission of the whole response.
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1443 diff changeset	1257 If the SCGI server does not transmit anything within this time,
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1443 diff changeset	1258 the connection is closed.
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1443 diff changeset	1259 </para>
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1443 diff changeset	1260
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1443 diff changeset	1261 </directive>
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1443 diff changeset	1262
323b0d071166 Relocated proxy_read_timeout and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1443 diff changeset	1263
1437 8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1264 <directive name="scgi_request_buffering">
1659 680cbf783efe Fixed some misuses of "value". Ruslan Ermilov <ru@nginx.com> parents: 1620 diff changeset	1265 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
1437 8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1266 <default>on</default>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1267 <context>http</context>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1268 <context>server</context>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1269 <context>location</context>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1270 <appeared-in>1.7.11</appeared-in>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1271
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1272 <para>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1273 Enables or disables buffering of a client request body.
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1274 </para>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1275
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1276 <para>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1277 When buffering is enabled, the entire request body is
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1278 <link doc="ngx_http_core_module.xml" id="client_body_buffer_size">read</link>
1440 657885fd2b96 Corrected description of proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1437 diff changeset	1279 from the client before sending the request to an SCGI server.
1437 8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1280 </para>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1281
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1282 <para>
1440 657885fd2b96 Corrected description of proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1437 diff changeset	1283 When buffering is disabled, the request body is sent to the SCGI server
1437 8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1284 immediately as it is received.
1440 657885fd2b96 Corrected description of proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1437 diff changeset	1285 In this case, the request cannot be passed to the
657885fd2b96 Corrected description of proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1437 diff changeset	1286 <link id="scgi_next_upstream">next server</link>
1437 8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1287 if nginx already started sending the request body.
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1288 </para>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1289
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1290 <para>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1291 When HTTP/1.1 chunked transfer encoding is used
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1292 to send the original request body,
1443 a55553729d63 Unified text of scgi and uwsgi request buffering with proxy. Yaroslav Zhuravlev <yar@nginx.com> parents: 1440 diff changeset	1293 the request body will be buffered regardless of the directive value.
1437 8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1294 </para>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1295
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1296 </directive>
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1297
8e7995bb8c6b Documented proxy_request_buffering and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1384 diff changeset	1298
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1299 <directive name="scgi_send_timeout">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1300 <syntax><value>time</value></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1301 <default>60s</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1302 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1303 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1304 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1305
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1306 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1307 Sets a timeout for transmitting a request to the SCGI server.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1308 The timeout is set only between two successive write operations,
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1309 not for the transmission of the whole request.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1310 If the SCGI server does not receive anything within this time,
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1311 the connection is closed.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1312 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1313
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1314 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1315
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1316
2254 d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1317 <directive name="scgi_socket_keepalive">
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1318 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1319 <default>off</default>
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1320 <context>http</context>
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1321 <context>server</context>
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1322 <context>location</context>
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1323 <appeared-in>1.15.6</appeared-in>
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1324
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1325 <para>
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1326 Configures the “TCP keepalive” behavior
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1327 for outgoing connections to an SCGI server.
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1328 By default, the operating system’s settings are in effect for the socket.
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1329 If the directive is set to the value “<literal>on</literal>”, the
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1330 <c-def>SO_KEEPALIVE</c-def> socket option is turned on for the socket.
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1331 </para>
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1332
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1333 </directive>
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1334
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	1335
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1336 <directive name="scgi_store">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1337 <syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1338 <literal>on</literal> \|
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1339 <literal>off</literal> \|
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1340 <value>string</value></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1341 <default>off</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1342 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1343 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1344 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1345
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1346 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1347 Enables saving of files to a disk.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1348 The <literal>on</literal> parameter saves files with paths
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1349 corresponding to the directives
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1350 <link doc="ngx_http_core_module.xml" id="alias"/> or
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1351 <link doc="ngx_http_core_module.xml" id="root"/>.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1352 The <literal>off</literal> parameter disables saving of files.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1353 In addition, the file name can be set explicitly using the
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1354 <value>string</value> with variables:
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1355 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1356 scgi_store /data/www$original_uri;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1357 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1358 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1359
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1360 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1361 The modification time of files is set according to the received
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1362 <header>Last-Modified</header> response header field.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1363 The response is first written to a temporary file,
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1364 and then the file is renamed.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1365 Starting from version 0.8.9, temporary files and the persistent store
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1366 can be put on different file systems.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1367 However, be aware that in this case a file is copied
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1368 across two file systems instead of the cheap renaming operation.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1369 It is thus recommended that for any given location both saved files and a
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1370 directory holding temporary files, set by the <link id="scgi_temp_path"/>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1371 directive, are put on the same file system.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1372 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1373
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1374 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1375 This directive can be used to create local copies of static unchangeable
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1376 files, e.g.:
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1377 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1378 location /images/ {
1184 55857cbf562d Fixed alignment issues after mechanical conversion from fastcgi. Ruslan Ermilov <ru@nginx.com> parents: 1182 diff changeset	1379 root /data/www;
55857cbf562d Fixed alignment issues after mechanical conversion from fastcgi. Ruslan Ermilov <ru@nginx.com> parents: 1182 diff changeset	1380 error_page 404 = /fetch$uri;
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1381 }
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1382
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1383 location /fetch/ {
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1384 internal;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1385
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1386 scgi_pass backend:9000;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1387 ...
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1388
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1389 scgi_store on;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1390 scgi_store_access user:rw group:rw all:r;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1391 scgi_temp_path /data/temp;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1392
1184 55857cbf562d Fixed alignment issues after mechanical conversion from fastcgi. Ruslan Ermilov <ru@nginx.com> parents: 1182 diff changeset	1393 alias /data/www/;
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1394 }
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1395 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1396 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1397
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1398 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1399
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1400
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1401 <directive name="scgi_store_access">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1402 <syntax><value>users</value>:<value>permissions</value> ...</syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1403 <default>user:rw</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1404 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1405 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1406 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1407
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1408 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1409 Sets access permissions for newly created files and directories, e.g.:
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1410 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1411 scgi_store_access user:rw group:rw all:r;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1412 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1413 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1414
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1415 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1416 If any <literal>group</literal> or <literal>all</literal> access permissions
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1417 are specified then <literal>user</literal> permissions may be omitted:
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1418 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1419 scgi_store_access group:rw all:r;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1420 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1421 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1422
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1423 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1424
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1425
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1426 <directive name="scgi_temp_file_write_size">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1427 <syntax><value>size</value></syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1428 <default>8k\|16k</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1429 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1430 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1431 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1432
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1433 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1434 Limits the <value>size</value> of data written to a temporary file
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1435 at a time, when buffering of responses from the SCGI server
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1436 to temporary files is enabled.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1437 By default, <value>size</value> is limited by two buffers set by the
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1438 <link id="scgi_buffer_size"/> and <link id="scgi_buffers"/> directives.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1439 The maximum size of a temporary file is set by the
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1440 <link id="scgi_max_temp_file_size"/> directive.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1441 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1442
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1443 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1444
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1445
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1446 <directive name="scgi_temp_path">
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1447 <syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1448 <value>path</value>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1449 [<value>level1</value>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1450 [<value>level2</value>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1451 [<value>level3</value>]]]</syntax>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1452 <default>scgi_temp</default>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1453 <context>http</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1454 <context>server</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1455 <context>location</context>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1456
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1457 <para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1458 Defines a directory for storing temporary files
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1459 with data received from SCGI servers.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1460 Up to three-level subdirectory hierarchy can be used underneath the specified
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1461 directory.
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1462 For example, in the following configuration
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1463 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1464 scgi_temp_path /spool/nginx/scgi_temp 1 2;
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1465 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1466 a temporary file might look like this:
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1467 <example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1468 /spool/nginx/scgi_temp/<emphasis>7</emphasis>/<emphasis>45</emphasis>/00000123<emphasis>457</emphasis>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1469 </example>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1470 </para>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1471
1384 66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	1472 <para>
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	1473 See also the <literal>use_temp_path</literal> parameter of the
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	1474 <link id="scgi_cache_path"/> directive.
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	1475 </para>
66ee77849563 Documented the use_temp_path parameter of the proxy_cache_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1382 diff changeset	1476
1180 9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1477 </directive>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1478
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1479 </section>
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1480
9d3beb5890eb Documented the scgi module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1481 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_scgi_module.xml @ 2593:eeed494bba51