nginx-quic: docs/html/http/ngx_http_core

annotate docs/html/http/ngx_http_core_module.html @ 4071:cf09c4826ab3

Regenerate after previous commit.

author	Ruslan Ermilov <ru@nginx.com>
date	Mon, 05 Sep 2011 09:58:31 +0000
parents	4dbdfd985863
children	a1e1b348bfaf

rev	line source
4069 4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>HTTP Core Module</title></head><body><a name="directives"></a><center><h4>Directives</h4></center><hr><a name="aio"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	2 <code>aio
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	3 <code>on</code> \|
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	4 <code>off</code> \|
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	5 <code>sendfile</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	6 <code>aio off</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	7 <code>http</code>, <code>server</code>, <code>location</code><br><strong>appeared in version</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	8 0.8.11<p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	9 Enables or disables the use of asynchronous file I/O (AIO)
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	10 on FreeBSD and Linux.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	11 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	12 On FreeBSD, AIO is usable used starting from FreeBSD 4.3.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	13 AIO can either be linked statically into a kernel:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	14 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	15 options VFS_AIO
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	16 </pre></blockquote>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	17 or loaded dynamically as a kernel loadable module:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	18 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	19 kldload aio
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	20 </pre></blockquote></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	21 In FreeBSD versions 5 and 6, enabling AIO statically, or dynamically
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	22 when booting the kernel, will cause the entire networking subsystem
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	23 to use the Giant lock that can impact overall performance negatively.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	24 This limitation has been removed in FreeBSD 6.4-STABLE in 2009, and in
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	25 FreeBSD 7.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	26 However, starting from FreeBSD 5.3, it's possible to enable AIO
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	27 without the penalty of running the networking subsystem under a
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	28 Giant lock - for this to work, the AIO module needs to be loaded
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	29 after the kernel has booted.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	30 In this case, the following message will appear in
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	31 <code>/var/log/messages</code><blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	32 WARNING: Network stack Giant-free, but aio requires Giant.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	33 Consider adding 'options NET_WITH_GIANT' or setting debug.mpsafenet=0
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	34 </pre></blockquote>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	35 and can safely be ignored.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	36
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	37 The requirement to use the Giant lock with AIO is related to the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	38 fact that FreeBSD supports asynchronous calls
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	39 <code>aio_read()</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	40 and
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	41 <code>aio_write()</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	42 when working with sockets.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	43 However, since nginx only uses AIO for disk I/O, no problems should arise.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	44 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	45 For AIO to work,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	46 <a href="#sendfile">sendfile</a>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	47 needs to be disabled:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	48 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	49 location /video/ {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	50 sendfile off;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	51 aio on;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	52 output_buffers 1 64k;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	53 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	54 </pre></blockquote></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	55 In addition, starting from FreeBSD 5.2.1 and nginx 0.8.12, AIO can
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	56 also be used to pre-load data for <code>sendfile()</code>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	57 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	58 location /video/ {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	59 sendfile on;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	60 tcp_nopush on;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	61 aio sendfile;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	62 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	63 </pre></blockquote>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	64 In this configuration, <code>sendfile()</code> is called with
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	65 the <code>SF_NODISKIO</code> flag which causes it not to
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	66 block on disk I/O and instead report back when the data are not in
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	67 memory; nginx then initiates an asynchronous data load by reading
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	68 one byte. The FreeBSD kernel then loads the first 128K bytes
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	69 of a file into memory, however next reads will only load data
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	70 in 16K chunks. This can be tuned using the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	71 <a href="#read_ahead">read_ahead</a>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	72 directive.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	73 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	74 On Linux, AIO is usable starting from kernel version 2.6.22;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	75 plus, it is also necessary to enable
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	76 <a href="#directio">directio</a>,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	77 otherwise reading will be blocking:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	78 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	79 location /video/ {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	80 aio on;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	81 directio 512;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	82 output_buffers 1 128k;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	83 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	84 </pre></blockquote></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	85 On Linux,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	86 <a href="#directio">directio</a>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	87 can only be used for reading blocks that are aligned on 512-byte
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	88 boundaries (or 4K for XFS).
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	89 Reading of unaligned file's tail is still made in blocking mode.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	90 The same holds true for byte range requests, and for FLV requests
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	91 not from the beginning of a file: reading of unaligned data at the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	92 beginning and end of a file will be blocking.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	93 There is no need to turn off
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	94 <a href="#sendfile">sendfile</a>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	95 explicitly as it is turned off automatically when
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	96 <a href="#directio">directio</a>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	97 is used.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	98 </p><hr><a name="alias"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	99 <code>alias <code><i>path</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	100 <strong>none</strong><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	101 <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	102 Defines a replacement for the specified location.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	103 For example, with the following configuration
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	104 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	105 location /i/ {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	106 alias /data/w3/images/;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	107 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	108 </pre></blockquote>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	109 the request of "/i/top.gif" will be responded
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	110 with the file "/data/w3/images/top.gif".
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	111 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	112 The <code><i>path</i></code> value can contain variables.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	113 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	114 If <code>alias</code> is used inside a location defined
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	115 with a regular expression then such regular expression should
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	116 contain captures and <code>alias</code> should refer to
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	117 these captures (0.7.40), for example:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	118 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	119 location ~ ^/users/(.+\.(?:gif\|jpe?g\|png))$ {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	120 alias /data/w3/images/$1;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	121 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	122 </pre></blockquote></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	123 When location matches the last part of the directive's value:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	124 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	125 location /images/ {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	126 alias /data/w3/images/;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	127 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	128 </pre></blockquote>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	129 it's better to use the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	130 <a href="#root">root</a>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	131 directive instead:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	132 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	133 location /images/ {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	134 root /data/w3;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	135 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	136 </pre></blockquote></p><hr><a name="client_body_in_file_only"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	137 <code>client_body_in_file_only
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	138 <code>on</code> \|
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	139 <code>clean</code> \|
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	140 <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	141 <code>client_body_in_file_only off</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	142 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	143 Determines whether nginx should save the entire client request body
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	144 into a file.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	145 This directive can be used during debugging, or when using the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	146 <code>$request_body_file</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	147 variable, or the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	148 <u>$r->request_body_file</u>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	149 method of the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	150 <u>http_perl</u> module.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	151 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	152 When set to the value <code>on</code>, temporary files are not
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	153 removed after request processing.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	154 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	155 The value <code>clean</code> will cause the temporary files
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	156 left after request processing to be removed.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	157 </p><hr><a name="client_body_in_single_buffer"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	158 <code>client_body_in_single_buffer <code>on</code> \| <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	159 <code>client_body_in_single_buffer off</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	160 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	161 Determines whether nginx should save the entire client request body
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	162 in a single buffer.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	163 The directive is recommended when using the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	164 <code>$request_body</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	165 variable, to save the number of copy operations involved.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	166 </p><hr><a name="client_body_buffer_size"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	167 <code>client_body_buffer_size <code><i>size</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	168 <code>client_body_buffer_size 8k/16k</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	169 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	170 Sets buffer size for reading client request body.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	171 In case request body is larger than the buffer,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	172 the whole body or only its part is written to a temporary file.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	173
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	174 By default, buffer size is equal to two memory pages.
3996 fc808f006ff4 skeleton for documentation processing Igor Sysoev <igor@sysoev.ru> parents: diff changeset	175 This is 8K on x86, other 32-bit platforms, and x86-64.
fc808f006ff4 skeleton for documentation processing Igor Sysoev <igor@sysoev.ru> parents: diff changeset	176 It is usually 16K on other 64-bit platforms.
4069 4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	177 </p><hr><a name="client_body_temp_path"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	178 <code>client_body_temp_path
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	179 <code><i>path</i></code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	180 [<code><i>level1</i></code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	181 [<code><i>level2</i></code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	182 [<code><i>level3</i></code>]]]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	183 </code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	184 <code>client_body_temp_path client_body_temp</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	185 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	186 Defines a directory for storing temporary files holding client request bodies.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	187 Up to three-level subdirectory hierarchy can be used underneath the specified
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	188 directory.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	189 For example, in the following configuration
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	190 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	191 client_body_temp_path /spool/nginx/client_temp 1 2;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	192 </pre></blockquote>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	193 a temporary file might look like this:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	194 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	195 /spool/nginx/client_temp/7/45/00000123457
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	196 </pre></blockquote></p><hr><a name="client_body_timeout"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	197 <code>client_body_timeout <code><i>time</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	198 <code>client_body_timeout 60</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	199 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	200 Defines a timeout for reading client request body.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	201 A timeout is only set between two successive read operations,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	202 not for the transmission of the whole request body.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	203 If a client does not transmit anything within this time,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	204 the error
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	205 <i>"Request time out"</i> (408)
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	206 is returned.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	207 </p><hr><a name="client_header_buffer_size"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	208 <code>client_header_buffer_size <code><i>size</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	209 <code>client_header_buffer_size 1k</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	210 <code>http</code>, <code>server</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	211 Sets buffer size for reading client request header.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	212 For most requests, a buffer of 1K bytes is enough.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	213 However, if a request includes long cookies, or comes from a WAP client,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	214 it may not fit into 1K.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	215 If a request line, or a request header line do not fit entirely into
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	216 this buffer then larger buffers are allocated, configured by the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	217 <a href="#large_client_header_buffers">large_client_header_buffers</a>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	218 directive.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	219 </p><hr><a name="client_header_timeout"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	220 <code>client_header_timeout <code><i>time</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	221 <code>client_header_timeout 60</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	222 <code>http</code>, <code>server</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	223 Defines a timeout for reading client request header.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	224 If a client does not transmit the entire header within this time,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	225 the error
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	226 <i>"Request time out"</i> (408)
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	227 is returned.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	228 </p><hr><a name="client_max_body_size"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	229 <code>client_max_body_size <code><i>size</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	230 <code>client_max_body_size 1m</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	231 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	232 Sets the maximum allowed size of the client request body,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	233 specified in the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	234 <code>Content-Length</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	235 request header line.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	236 If <code><i>size</i></code> is greater than the configured value, the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	237 <i>"Request Entity Too Large"</i> (413)
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	238 error is returned to a client.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	239 Please be aware that
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	240 <u>browsers cannot correctly display
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	241 this error</u>.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	242 </p><hr><a name="default_type"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	243 <code>default_type <code><i>mime-type</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	244 <code>default_type text/plain</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	245 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	246 Defines a default MIME-type of a response.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	247 </p><hr><a name="directio"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	248 <code>directio <code><i>size</i></code> \| <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	249 <code>directio off</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	250 <code>http</code>, <code>server</code>, <code>location</code><br><strong>appeared in version</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	251 0.7.7<p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	252 Enables the use of
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	253 the <code>O_DIRECT</code> flag (FreeBSD, Linux),
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	254 the <code>F_NOCACHE</code> flag (Mac OS X),
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	255 or the <code>directio()</code> function (Solaris),
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	256 when reading files that are larger than the specified <code><i>size</i></code>.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	257 It automatically disables (0.7.15) the use of
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	258 <a href="#sendfile">sendfile</a>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	259 for a given request.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	260 It could be useful for serving large files:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	261 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	262 directio 4m;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	263 </pre></blockquote>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	264 or when using <a href="#aio">aio</a> on Linux.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	265 </p><hr><a name="directio_alignment"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	266 <code>directio_alignment <code><i>size</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	267 <code>directio_alignment 512</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	268 <code>http</code>, <code>server</code>, <code>location</code><br><strong>appeared in version</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	269 0.8.11<p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	270 Sets an alignment for
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	271 <a href="#directio">directio</a>.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	272 In most cases, a 512-byte alignment is enough, however, when
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	273 using XFS under Linux, it needs to be increased to 4K.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	274 </p><hr><a name="error_page"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	275 <code>error_page
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	276 <code><i>code ...</i></code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	277 [<code>=</code>[<code><i>response</i></code>]]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	278 <code><i>uri</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	279 <strong>none</strong><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	280 <code>http</code>, <code>server</code>, <code>location</code>, <code>if in location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	281 Defines the URI that will be shown for the specified errors.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	282 These directives are inherited from the previous level if and
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	283 only if there are no <code>error_page</code> directives on
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	284 the current level.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	285 A URI value can contain variables.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	286 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	287 Example usage:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	288 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	289 error_page 404 /404.html;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	290 error_page 502 503 504 /50x.html;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	291 error_page 403 http://example.com/forbidden.html;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	292 </pre></blockquote></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	293 Furthermore, it is possible to change the response code to another, for example:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	294 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	295 error_page 404 =200 /empty.gif;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	296 </pre></blockquote></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	297 If an error response is processed by a proxied server, or a FastCGI-server,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	298 and the server may return different response codes (e.g., 200, 302, 401
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	299 or 404), it is possible to respond with a returned code:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	300 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	301 error_page 404 = /404.php;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	302 </pre></blockquote></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	303 If there is no need to change URI during redirection it is possible to redirect
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	304 error processing into a named location:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	305 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	306 location / {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	307 error_page 404 = @fallback;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	308 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	309
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	310 location @fallback {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	311 proxy_pass http://backend;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	312 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	313 </pre></blockquote></p><hr><a name="if_modified_since"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	314 <code>if_modified_since
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	315 <code>off</code> \|
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	316 <code>exact</code> \|
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	317 <code>before</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	318 <code>if_modified_since exact</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	319 <code>http</code>, <code>server</code>, <code>location</code><br><strong>appeared in version</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	320 0.7.24<p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	321 Specifies how to compare modification time of a response
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	322 with the time in the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	323 <code>If-Modified-Since</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	324 request header:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	325
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	326 <ul><li><code>off</code> - the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	327 <code>If-Modified-Since</code> request header is ignored (0.7.34);
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	328 </li><li><code>exact</code> - exact match;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	329 </li><li><code>before</code> - modification time of a response is
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	330 less than or equal to the time in the <code>If-Modified-Since</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	331 request header.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	332 </li></ul></p><hr><a name="internal"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	333 <code>internal</code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	334 <strong>none</strong><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	335 <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	336 Specifies that a given location can only be used for internal requests.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	337 For external requests, the <i>"Not found"</i> (404)
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	338 error is returned.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	339 Internal requests are the following:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	340
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	341 <ul><li>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	342 requests redirected by the <a href="#error_page">error_page</a> directive;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	343 </li><li>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	344 subrequests formed by the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	345 <code>include virtual</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	346 command of the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	347 <u>http_ssi</u> module;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	348 </li><li>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	349 requests changed by the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	350 <u>rewrite</u>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	351 directive of the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	352 <u>http_rewrite</u> module.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	353 </li></ul></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	354 Example usage:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	355 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	356 error_page 404 /404.html;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	357
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	358 location /404.html {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	359 internal;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	360 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	361 </pre></blockquote></p><hr><a name="keepalive_requests"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	362 <code>keepalive_requests <code><i>number</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	363 <code>keepalive_requests 100</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	364 <code>http</code>, <code>server</code>, <code>location</code><br><strong>appeared in version</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	365 0.8.0<p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	366 Sets the maximum number of requests that can be
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	367 made through one keep-alive connection.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	368 </p><hr><a name="keepalive_timeout"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	369 <code>keepalive_timeout
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	370 <code><i>time</i></code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	371 [<code><i>time</i></code>]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	372 </code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	373 <code>keepalive_timeout 75</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	374 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	375 The first argument sets a timeout during which a keep-alive
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	376 client connection will stay open on the server side.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	377 The optional second argument sets a value in the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	378 "<code>Keep-Alive: timeout=</code><code><i>time</i></code>"
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	379 response header.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	380 Two arguments may differ.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	381 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	382 The
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	383 "<code>Keep-Alive: timeout=</code>"
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	384 is understood by Mozilla and Konqueror.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	385 MSIE will close keep-alive connection in about 60 seconds.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	386 </p><hr><a name="large_client_header_buffers"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	387 <code>large_client_header_buffers <code><i>number size</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	388 <code>large_client_header_buffers 4 4k/8k</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	389 <code>http</code>, <code>server</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	390 Sets the maximum <code><i>number</i></code> and <code><i>size</i></code> of
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	391 buffers used when reading large client request headers.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	392 A request line cannot exceed the size of one buffer, or the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	393 <i>"Request URI too large"</i> (414)
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	394 error is returned.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	395 A request header line cannot exceed the size of one buffer as well, or the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	396 <i>"Bad request"</i> (400)
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	397 error is returned.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	398 Buffers are allocated only on demand.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	399 By default, the buffer size is equal to one memory page size.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	400 It is either 4K or 8K, platform dependent.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	401 If after the end of request processing a connection is transitioned
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	402 into the keep-alive state, these buffers are freed.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	403 </p><hr><a name="limit_except"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	404 <code>limit_except <code><i>method</i></code> ... { ... }</code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	405 <strong>none</strong><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	406 <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	407 Limits allowed HTTP methods inside a location.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	408 The GET method also implies the HEAD method.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	409 Access to other methods can be limited using the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	410 <u>http_access</u>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	411 and
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	412 <u>http_auth_basic</u>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	413 modules directives:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	414 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	415 limit_except GET {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	416 allow 192.168.1.0/32;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	417 deny all;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	418 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	419 </pre></blockquote>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	420 Please note that this will limit access to all methods
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	421 <strong>except</strong> GET and HEAD.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	422 </p><hr><a name="limit_rate"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	423 <code>limit_rate <code><i>rate</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	424 <strong>none</strong><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	425 <code>http</code>, <code>server</code>, <code>location</code>, <code>if in location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	426 Rate limits the transmission of a response to a client.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	427 The <code><i>rate</i></code> is specified in bytes per second.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	428
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	429 The limit is per connection, so if a single client opens 2 connections,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	430 an overall rate will be 2x more than specified.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	431 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	432 This directive is not applicable if one wants to rate limit
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	433 a group of clients on the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	434 <a href="#server">server</a>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	435 level.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	436 If that is the case, the desired limit can be specified in the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	437 <code>$limit_rate</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	438 variable:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	439 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	440 server {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	441
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	442 if ($slow) {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	443 set $limit_rate 4k;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	444 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	445
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	446 ...
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	447 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	448 </pre></blockquote></p><hr><a name="limit_rate_after"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	449 <code>limit_rate_after <code><i>size</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	450 <strong>none</strong><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	451 <code>http</code>, <code>server</code>, <code>location</code>, <code>if in location</code><br><strong>appeared in version</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	452 0.8.0<p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	453 Sets the initial amount after which the further transmission
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	454 of a response to a client will be rate limited.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	455 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	456 Example:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	457 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	458 location /flv/ {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	459 flv;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	460 limit_rate_after 500k;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	461 limit_rate 50k;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	462 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	463 </pre></blockquote></p><hr><a name="listen"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	464 <code>listen
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	465 <code><i>address</i></code>[:<code><i>port</i></code>]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	466 [<code>default</code> \| <code>default_server</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	467 [<code>backlog</code>=<code><i>number</i></code>]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	468 [<code>rcvbuf</code>=<code><i>size</i></code>]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	469 [<code>sndbuf</code>=<code><i>size</i></code>]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	470 [<code>accept_filter</code>=<code><i>filter</i></code>]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	471 [<code>deferred</code>]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	472 [<code>bind</code>]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	473 [<code>ipv6only</code>=<code>on</code>\|<code>off</code>]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	474 [<code>ssl</code>]]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	475 </code><br><code> </code><code>listen
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	476 <code><i>port</i></code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	477 [<code>default</code> \| <code>default_server</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	478 [<code>backlog</code>=<code><i>number</i></code>]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	479 [<code>rcvbuf</code>=<code><i>size</i></code>]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	480 [<code>sndbuf</code>=<code><i>size</i></code>]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	481 [<code>accept_filter</code>=<code><i>filter</i></code>]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	482 [<code>deferred</code>]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	483 [<code>bind</code>]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	484 [<code>ipv6only</code>=<code>on</code>\|<code>off</code>]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	485 [<code>ssl</code>]]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	486 </code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	487 <code>listen :80 \| :8000</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	488 <code>server</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	489 Sets an <code><i>address</i></code> and a <code><i>port</i></code>, on which
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	490 the server will accept requests.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	491 Only one of <code><i>address</i></code> or <code><i>port</i></code> can be
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	492 specified.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	493 An <code><i>address</i></code> may also be a hostname, for example:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	494 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	495 listen 127.0.0.1:8000;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	496 listen 127.0.0.1;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	497 listen 8000;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	498 listen *:8000;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	499 listen localhost:8000;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	500 </pre></blockquote>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	501 IPv6 addresses (0.7.36) are specified in square brackets:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	502 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	503 listen [::]:8000;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	504 listen [fe80::1];
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	505 </pre></blockquote></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	506 If only <code><i>address</i></code> is given, the port 80 is used.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	507 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	508 If directive is not present then either the <code>*:80</code> is used
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	509 if nginx runs with superuser privileges, or <code>*:8000</code> otherwise.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	510 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	511 The <code>default</code> parameter, if present,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	512 will cause the server to become the default server for the specified
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	513 <code><i>address</i></code>:<code><i>port</i></code> pair.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	514 If none of the directives have the <code>default</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	515 parameter then the first server with the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	516 <code><i>address</i></code>:<code><i>port</i></code> pair will be
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	517 the default server for this pair.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	518 Starting from version 0.8.21 it is possible to use the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	519 <code>default_server</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	520 parameter.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	521 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	522 A <code>listen</code> directive which has the <code>default</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	523 parameter can have several additional parameters specific to system calls
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	524 <code>listen()</code> and <code>bind()</code>.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	525 Starting from version 0.8.21, these parameters can be specified in any
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	526 <code>listen</code> directive, but only once for the given
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	527 <code><i>address</i></code>:<code><i>port</i></code> pair.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	528 <ul><li><code>backlog</code>=<code><i>number</i></code> -
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	529 sets the <code>backlog</code> parameter in the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	530 <code>listen()</code> call.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	531 By default, <code>backlog</code> equals -1 on FreeBSD
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	532 and 511 on other platforms.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	533 </li><li><code>rcvbuf</code>=<code><i>size</i></code> -
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	534 sets the <code>SO_RCVBUF</code> parameter for the listening socket.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	535 </li><li><code>sndbuf</code>=<code><i>size</i></code> -
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	536 sets the <code>SO_SNDBUF</code> parameter for the listening socket.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	537 </li><li><code>accept_filter</code>=<code><i>filter</i></code> -
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	538 sets the name of the accept filter.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	539 This works only on FreeBSD, acceptable values are <code>dataready</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	540 and <code>httpready</code>.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	541 On receiving <code>SIGHUP</code> signal, an accept filter can only be
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	542 changed in recent versions of FreeBSD, starting from 6.0, 5.4-STABLE
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	543 and 4.11-STABLE.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	544 </li><li><code>deferred</code> -
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	545 instructs to use a deferred <code>accept()</code> on Linux
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	546 using the <code>TCP_DEFER_ACCEPT</code> option.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	547 </li><li><code>bind</code> -
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	548 specifies to make a separate <code>bind()</code> call for a given
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	549 <code><i>address</i></code>:<code><i>port</i></code> pair.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	550 This is because nginx will only <code>bind()</code> to
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	551 <code>*</code>:<code><i>port</i></code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	552 if there are several <code>listen</code> directives with
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	553 the same port and different addresses, and one of the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	554 <code>listen</code> directives listens on all addresses
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	555 for the given port (<code>*</code>:<code><i>port</i></code>).
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	556 It should be noted that in this case a <code>getsockname()</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	557 system call will be made to determine an address that accepted a
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	558 connection.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	559 If parameters <code>backlog</code>, <code>rcvbuf</code>,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	560 <code>sndbuf</code>, <code>accept_filter</code>, or
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	561 <code>deferred</code> are used then for a given
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	562 <code><i>address</i></code>:<code><i>port</i></code> pair
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	563 a separate <code>bind()</code> call will always be made.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	564 </li><li><code>ipv6only</code>=<code>on</code>\|<code>off</code> -
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	565 this parameter (0.7.42) sets the value of the <code>IPV6_V6ONLY</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	566 parameter for the listening socket.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	567 This parameter can only be set once on start.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	568 </li><li><code>ssl</code> -
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	569 this parameter (0.7.14) does not relate to system calls
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	570 <code>listen()</code> and <code>bind()</code>, but allows to
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	571 specify that all connections accepted on this port should work in
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	572 the SSL mode.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	573 This allows for a more compact configuration for the server operating
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	574 in both HTTP and HTTPS modes simultaneously.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	575 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	576 listen 80;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	577 listen 443 default ssl;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	578 </pre></blockquote></li></ul></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	579 Example:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	580 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	581 listen 127.0.0.1 default accept_filter=dataready backlog=1024;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	582 </pre></blockquote></p><hr><a name="location"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	583 <code>location [
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	584 <code>=</code> \|
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	585 <code>~</code> \|
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	586 <code>~*</code> \|
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	587 <code>^~</code> \|
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	588 <code>@</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	589 ] <code><i>uri</i></code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	590 { ... }</code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	591 <strong>none</strong><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	592 <code>server</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	593 Sets a configuration based on a request URI.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	594 A location can either be defined by a prefix string, or by a regular expression.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	595 Regular expressions are specified by prepending them with the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	596 "<code>~*</code>" prefix (for case-insensitive matching), or with the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	597 "<code>~</code>" prefix (for case-sensitive matching).
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	598 To find a location matching a given request, nginx first checks
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	599 locations defined using the prefix strings (prefix locations).
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	600 Amongst them, the most specific one is searched.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	601 Then regular expressions are checked, in the order of their appearance
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	602 in a configuration file.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	603 A search terminates on the first match, and its corresponding
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	604 configuration is used.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	605 If no match with a regular expression location is found then a
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	606 configuration of the most specific prefix location is used.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	607 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	608 For case-insensitive operating systems such as Mac OS X and Cygwin,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	609 the string matching ignores a case (0.7.7).
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	610 However, comparison is limited to one-byte locales.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	611 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	612 Regular expressions can contain captures (0.7.40) that can later
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	613 be used in other directives.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	614 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	615 If the most specific prefix location has the "<code>^~</code>" prefix
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	616 then regular expressions are not checked.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	617 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	618 Also, using the "<code>=</code>" prefix it's possible to define
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	619 an exact match of URI and location.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	620 If an exact match is found, the search terminates.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	621 For example, if a "<code>/</code>" request happens frequently,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	622 defining "<code>location = /</code>" will speed up the processing
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	623 of these requests, as search terminates right after the first
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	624 comparison.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	625 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	626 In versions from 0.7.1 to 0.8.41, if a request matched the prefix
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	627 location without the "<code>=</code>" and "<code>^~</code>"
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	628 prefixes, the search also terminated and regular expressions were
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	629 not checked.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	630 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	631 Let's illustrate the above by an example:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	632 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	633 location = / {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	634 [ configuration A ]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	635 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	636
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	637 location / {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	638 [ configuration B ]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	639 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	640
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	641 location ^~ /images/ {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	642 [ configuration C ]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	643 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	644
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	645 location ~* \.(gif\|jpg\|jpeg)$ {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	646 [ configuration D ]
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	647 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	648 </pre></blockquote>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	649 The "<code>/</code>" request will match configuration A,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	650 the "<code>/documents/document.html</code>" request - configuration B,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	651 the "<code>/images/1.gif</code>" request - configuration C, and
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	652 the "<code>/documents/1.jpg</code>" request - configuration D.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	653 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	654 The "<code>@</code>" prefix defines a named location.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	655 Such a location isn't used for a regular request processing, but instead
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	656 used for request redirection.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	657 </p><hr><a name="log_not_found"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	658 <code>log_not_found <code>on</code> \| <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	659 <code>log_not_found on</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	660 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	661 Enables or disables logging of errors about not found files into the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	662 <u>error_log</u>.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	663 </p><hr><a name="log_subrequest"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	664 <code>log_subrequest <code>on</code> \| <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	665 <code>log_subrequest off</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	666 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	667 Enables or disables logging of subrequests into the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	668 <u>access_log</u>.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	669 </p><hr><a name="merge_slashes"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	670 <code>merge_slashes <code>on</code> \| <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	671 <code>merge_slashes on</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	672 <code>http</code>, <code>server</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	673 Enables or disables compression of two or more adjacent slashes
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	674 in a URI into a single slash.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	675 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	676 Note that compression is essential for the correct prefix string
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	677 and regular expressions location matching.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	678 Without it, the "<code>//scripts/one.php</code>" request would not match
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	679 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	680 location /scripts/ {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	681 ...
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	682 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	683 </pre></blockquote>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	684 and might be processed as a static file,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	685 so it gets converted to "<code>/scripts/one.php</code>".
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	686 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	687 Turning the compression <code>off</code> can become necessary if a URI
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	688 contains base64-encoded names, since base64 uses the "/" character internally.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	689 However, for security considerations, it's better to avoid turning off
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	690 the compression.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	691 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	692 If a directive is specified on the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	693 <a href="#server">server</a>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	694 level, which is also a default server, its value will cover
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	695 all virtual servers listening on the same address and port.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	696 </p><hr><a name="msie_padding"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	697 <code>msie_padding <code>on</code> \| <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	698 <code>msie_padding on</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	699 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	700 Enables or disables adding of comments to responses with status
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	701 greater than 400 for MSIE clients, to pad the response size to 512 bytes.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	702 </p><hr><a name="msie_refresh"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	703 <code>msie_refresh <code>on</code> \| <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	704 <code>msie_refresh off</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	705 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	706 Enables or disables issuing refreshes instead of redirects, for MSIE clients.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	707 </p><hr><a name="open_file_cache"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	708 <code>open_file_cache
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	709 <code>max</code>=<code><i>N</i></code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	710 [<code>inactive</code>=<code><i>time</i></code>] \|
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	711 <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	712 <code>open_file_cache off</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	713 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	714 Configures a cache that can store:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	715 <ul><li>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	716 open file descriptors, their sizes and modification times;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	717 </li><li>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	718 directory lookups;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	719 </li><li>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	720 file lookup errors, such as "file not found", "no read permission",
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	721 and so on.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	722 Caching of errors should be enabled separately by the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	723 <a href="#open_file_cache_errors">open_file_cache_errors</a>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	724 directive.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	725 </li></ul></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	726 The directive has the following parameters:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	727 <ul><li><code>max</code> -
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	728 sets the maximum number of elements in the cache;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	729 on cache overflow the least recently used (LRU) elements get removed;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	730 </li><li><code>inactive</code> -
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	731 defines a time, after which the element gets removed from the cache
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	732 if there were no accesses to it during this time;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	733 by default, it is 60 seconds;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	734 </li><li><code>off</code> - disables the cache.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	735 </li></ul></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	736 Example:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	737 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	738 open_file_cache max=1000 inactive=20s;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	739 open_file_cache_valid 30s;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	740 open_file_cache_min_uses 2;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	741 open_file_cache_errors on;</pre></blockquote></p><hr><a name="open_file_cache_errors"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	742 <code>open_file_cache_errors <code>on</code> \| <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	743 <code>open_file_cache_errors off</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	744 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	745 Enables or disables caching of file lookup errors by the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	746 <a href="#open_file_cache">open_file_cache</a>.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	747 </p><hr><a name="open_file_cache_min_uses"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	748 <code>open_file_cache_min_uses <code><i>number</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	749 <code>open_file_cache_min_uses 1</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	750 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	751 Sets the minimum <code><i>number</i></code> of file accesses during
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	752 the period configured by the <code>inactive</code> parameter
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	753 of the <a href="#open_file_cache">open_file_cache</a> directive,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	754 after which a file descriptor will remain open in the cache.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	755 </p><hr><a name="open_file_cache_valid"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	756 <code>open_file_cache_valid <code><i>time</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	757 <code>open_file_cache_valid 60</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	758 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	759 Sets a time after which
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	760 <a href="#open_file_cache">open_file_cache</a>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	761 elements should be validated.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	762 </p><hr><a name="optimize_server_names"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	763 <code>optimize_server_names <code>on</code> \| <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	764 <code>optimize_server_names on</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	765 <code>http</code>, <code>server</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	766 This directive is obsolete.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	767 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	768 Enables or disables optimization of hostname checking in name-based
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	769 virtual servers.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	770 In particular, the checking affects hostnames used in redirects.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	771 If optimization is enabled, and all name-based servers listening on
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	772 the same address:port pair have identical configuration, then
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	773 names are not checked during request processing, and the first
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	774 server name is used in redirects.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	775 In case redirects should use hostnames sent by clients,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	776 optimization needs to be disabled.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	777 </p><hr><a name="port_in_redirect"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	778 <code>port_in_redirect <code>on</code> \| <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	779 <code>port_in_redirect on</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	780 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	781 Enables or disables specifying the port in redirects issued by nginx.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	782 </p><hr><a name="read_ahead"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	783 <code>read_ahead <code><i>size</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	784 <code>read_ahead 0</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	785 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	786 Sets the amount of pre-reading when working with files, in the kernel.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	787 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	788 On Linux, the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	789 <code>posix_fadvise(0, 0, 0, POSIX_FADV_SEQUENTIAL)</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	790 system call is used, so the <code><i>size</i></code> argument is ignored.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	791 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	792 On FreeBSD, the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	793 <code>fcntl(O_READAHEAD,</code><code><i>size</i></code><code>)</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	794 system call is used, supported in FreeBSD 9.0-CURRENT.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	795 FreeBSD 7 needs to be
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	796 <u>patched</u>.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	797 </p><hr><a name="recursive_error_pages"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	798 <code>recursive_error_pages <code>on</code> \| <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	799 <code>recursive_error_pages off</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	800 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	801 Enables or disables doing several redirects using the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	802 <a href="#error_page">error_page</a>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	803 directive.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	804 </p><hr><a name="reset_timedout_connection"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	805 <code>reset_timedout_connection <code>on</code> \| <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	806 <code>reset_timedout_connection off</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	807 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	808 Enables or disables resetting of timed out connections.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	809 The reset is performed as follows: before closing a socket, the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	810 <code>SO_LINGER</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	811 option is set on it with a timeout value of 0.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	812 When the socket is closed, a client is sent TCP RST, and all memory
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	813 occupied by this socket is freed.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	814 This avoids keeping of an already closed socket with filled buffers
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	815 for a long time, in a FIN_WAIT1 state.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	816 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	817 It should be noted that timed out keep-alive connections are still
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	818 closed normally.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	819 </p><hr><a name="resolver"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	820 <code>resolver <code><i>address</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	821 <strong>none</strong><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	822 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	823 Sets the <code><i>address</i></code> of a name server, for example:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	824 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	825 resolver 127.0.0.1;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	826 </pre></blockquote></p><hr><a name="resolver_timeout"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	827 <code>resolver_timeout <code><i>time</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	828 <code>resolver_timeout 30s</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	829 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	830 Sets a timeout for name resolution, for example:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	831 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	832 resolver_timeout 5s;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	833 </pre></blockquote></p><hr><a name="root"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	834 <code>root <code><i>path</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	835 <code>root html</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	836 <code>http</code>, <code>server</code>, <code>location</code>, <code>if in location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	837 Sets the root directory for requests.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	838 For example, with the following configuration
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	839 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	840 location /i/ {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	841 root /data/w3;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	842 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	843 </pre></blockquote>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	844 the request of "/i/top.gif" will be responded
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	845 with the file "/data/w3/images/top.gif".
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	846 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	847 The <code><i>path</i></code> value can contain variables.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	848 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	849 A path to the file is constructed by merely adding a URI to the value
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	850 of the <code>root</code> directive.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	851 If a URI need to be modified, the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	852 <a href="#alias">alias</a> directive should be used.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	853 </p><hr><a name="satisfy"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	854 <code>satisfy <code>all</code> \| <code>any</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	855 <code>satisfy all</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	856 <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	857 Allows access if any of the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	858 <u>http_access</u>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	859 or <u>http_auth_basic</u>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	860 modules grant access.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	861 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	862 location / {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	863 satisfy any;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	864
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	865 allow 192.168.1.0/32;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	866 deny all;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	867
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	868 auth_basic "closed site";
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	869 auth_basic_user_file conf/htpasswd;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	870 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	871 </pre></blockquote></p><hr><a name="satisfy_any"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	872 <code>satisfy_any <code>on</code> \| <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	873 <code>satisfy_any off</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	874 <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	875 This directive was renamed to the <a href="#satisfy">satisfy</a> directive.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	876 </p><hr><a name="send_timeout"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	877 <code>send_timeout <code><i>time</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	878 <code>send_timeout 60</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	879 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	880 Sets a timeout for transmitting a response to the client.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	881 A timeout is only set between two successive write operations,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	882 not for the transmission of the whole response.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	883 If a client does not receive anything within this time,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	884 a connection is closed.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	885 </p><hr><a name="sendfile"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	886 <code>sendfile <code>on</code> \| <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	887 <code>sendfile off</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	888 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	889 Enables or disables the use of
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	890 <code>sendfile()</code>.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	891 </p><hr><a name="server"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	892 <code>server { ... }</code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	893 <strong>none</strong><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	894 <code>http</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	895 Sets a configuration for the virtual server.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	896 There is no clean separation between IP-based (based on the IP address)
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	897 and name-based (based on the <code>Host</code> header string)
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	898 virtual servers.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	899 Instead, the <a href="#listen">listen</a> directives describe all
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	900 addresses and ports that should accept connections for a server, and the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	901 <a href="#server_name">server_name</a> directive lists all server names.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	902 An example configuration is provided in the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	903 <u>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	904 Setting Up Virtual Servers</u> document.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	905 </p><hr><a name="server_name"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	906 <code>server_name <code><i>name ...</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	907 <code>server_name hostname</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	908 <code>server</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	909 Sets names of the virtual server, for example:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	910 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	911 server {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	912 server_name example.com www.example.com;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	913 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	914 </pre></blockquote></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	915 The first name becomes a primary server name.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	916 By default, the machine's hostname is used.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	917 Server names can include an asterisk ("<code>*</code>")
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	918 to replace the first or last part of a name:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	919 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	920 server {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	921 server_name example.com .example.com www.example.;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	922 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	923 </pre></blockquote></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	924 The first two of the above mentioned names can be combined:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	925 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	926 server {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	927 server_name .example.com;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	928 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	929 </pre></blockquote></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	930 It is also possible to use regular expressions in server names,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	931 prepending the name with a tilde ("<code>~</code>"):
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	932 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	933 server {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	934 server_name www.example.com ~^www\d+\.example\.com$;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	935 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	936 </pre></blockquote></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	937 Regular expressions can contain captures (0.7.40) that can later
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	938 be used in other directives:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	939 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	940 server {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	941 server_name ~^(www\.)?(.+)$;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	942
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	943 location / {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	944 root /sites/$2;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	945 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	946 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	947
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	948 server {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	949 server_name _;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	950
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	951 location / {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	952 root /sites/default;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	953 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	954 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	955 </pre></blockquote></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	956 Starting from version 0.8.25, named captures in regular expressions create
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	957 variables that can later be used in other directives:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	958 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	959 server {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	960 server_name ~^(www\.)?(?<domain>.+)$;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	961
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	962 location / {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	963 root /sites/$domain;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	964 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	965 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	966
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	967 server {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	968 server_name _;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	969
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	970 location / {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	971 root /sites/default;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	972 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	973 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	974 </pre></blockquote></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	975 Starting from version 0.7.11, it is possible to specify an empty name "":
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	976 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	977 server {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	978 server_name www.example.com "";
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	979 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	980 </pre></blockquote>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	981 It allows this server to process requests without the <code>Host</code>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	982 header, instead of the default server for the given address:port pair.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	983 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	984 The name checking order is as follows:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	985 <ol><li>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	986 full names
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	987 </li><li>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	988 names with the prefix mask - *.example.com
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	989 </li><li>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	990 names with the suffix mask - mail.*
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	991 </li><li>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	992 regular expressions
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	993 </li></ol></p><hr><a name="server_name_in_redirect"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	994 <code>server_name_in_redirect <code>on</code> \| <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	995 <code>server_name_in_redirect on</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	996 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	997 Enables or disables the use of the primary server name, specified by the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	998 <a href="#server_name">server_name</a>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	999 directive, in redirects issued by nginx.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1000 When disabled, the name from the <code>Host</code> request header string
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1001 is used.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1002 If there's no such a string, an IP address of the server is used.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1003 </p><hr><a name="server_names_hash_max_size"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1004 <code>server_names_hash_max_size <code><i>size</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1005 <code>server_names_hash_max_size 512</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1006 <code>http</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1007 Sets the maximum <code><i>size</i></code> of the server names hash tables.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1008 For more information, please refer to
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1009 <u>Setting Up Hashes</u>.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1010 </p><hr><a name="server_names_hash_bucket_size"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1011 <code>server_names_hash_bucket_size <code><i>size</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1012 <code>server_names_hash_bucket_size 32/64/128</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1013 <code>http</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1014 Sets the bucket size for the server names hash tables.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1015 Default value depends on the size of the processor's cache line.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1016 For more information, please refer to
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1017 <u>Setting Up Hashes</u>.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1018 </p><hr><a name="server_tokens"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1019 <code>server_tokens <code>on</code> \| <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1020 <code>server_tokens on</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1021 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1022 Enables or disables emitting of nginx version in error messages and in the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1023 <code>Server</code> response header string.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1024 </p><hr><a name="tcp_nodelay"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1025 <code>tcp_nodelay <code>on</code> \| <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1026 <code>tcp_nodelay on</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1027 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1028 Enables or disables the use of the <code>TCP_NODELAY</code> option.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1029 The option is enabled only when a connection is transitioned into the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1030 keep-alive state.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1031 </p><hr><a name="tcp_nopush"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1032 <code>tcp_nopush <code>on</code> \| <code>off</code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1033 <code>tcp_nopush off</code><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1034 <code>http</code>, <code>server</code>, <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1035 Enables or disables the use of
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1036 the <code>TCP_NOPUSH</code> socket option on FreeBSD
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1037 or the <code>TCP_CORK</code> socket option on Linux.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1038 Opitons are enables only when <a href="#sendfile">sendfile</a> is used.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1039 Enabling the option allows to
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1040 <ul><li>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1041 send the response header and the beginning of a file in one packet,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1042 on Linux and FreeBSD 4.*;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1043 </li><li>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1044 send a file in full packets.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1045 </li></ul></p><hr><a name="try_files"></a><strong>syntax</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1046 <code>try_files <code><i>file ... uri</i></code></code><br><code> </code><code>try_files <code><i>file ...</i></code> =<code><i>code</i></code></code><br><strong>default</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1047 <strong>none</strong><br><strong>context</strong>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1048 <code>location</code><br><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1049 Checks the existence of files in the specified order, and uses
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1050 the first found file for request processing; the processing
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1051 is performed in this location's context.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1052 It is possible to check the directory existence by specifying
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1053 the slash at the end of a name, e.g. "<code>$uri/</code>".
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1054 If none of the files were found, an internal redirect to the
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1055 <code><i>uri</i></code> specified by the last argument is made.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1056 As of version 0.7.51, the last argument can also be a
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1057 <code><i>code</i></code>:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1058 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1059 location / {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1060 try_files $uri $uri/index.html $uri.html =404;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1061 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1062 </pre></blockquote></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1063 Example when proxying Mongrel:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1064 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1065 location / {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1066 try_files /system/maintenance.html
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1067 $uri $uri/index.html $uri.html
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1068 @mongrel;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1069 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1070
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1071 location @mongrel {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1072 proxy_pass http://mongrel;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1073 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1074 </pre></blockquote></p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1075 Example for Drupal/FastCGI:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1076 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1077 location / {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1078 try_files $uri $uri/ @drupal;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1079 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1080
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1081 location ~ \.php$ {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1082 try_files $uri @drupal;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1083
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1084 fastcgi_pass ...;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1085
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1086 fastcgi_param SCRIPT_FILENAME /path/to$fastcgi_script_name;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1087 fastcgi_param SCRIPT_NAME $fastcgi_script_name;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1088 fastcgi_param QUERY_STRING $args;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1089
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1090 ... other fastcgi_param's
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1091 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1092
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1093 location @drupal {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1094 fastcgi_pass ...;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1095
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1096 fastcgi_param SCRIPT_FILENAME /path/to/index.php;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1097 fastcgi_param SCRIPT_NAME /index.php;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1098 fastcgi_param QUERY_STRING q=$uri&$args;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1099
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1100 ... other fastcgi_param's
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1101 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1102 </pre></blockquote>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1103 In the following example,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1104 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1105 location / {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1106 try_files $uri $uri/ @drupal;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1107 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1108 </pre></blockquote>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1109 the <code>try_files</code> directive is equivalent to
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1110 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1111 location / {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1112 error_page 404 = @drupal;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1113 log_not_found off;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1114 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1115 </pre></blockquote>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1116 And here,
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1117 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1118 location ~ \.php$ {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1119 try_files $uri @drupal;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1120
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1121 fastcgi_pass ...;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1122
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1123 fastcgi_param SCRIPT_FILENAME /path/to$fastcgi_script_name;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1124
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1125 ...
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1126 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1127 </pre></blockquote><code>try_files</code> checks the existence of the PHP file
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1128 before passing the request to the FastCGI server.
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1129 </p><p>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1130 Example for Wordpress and Joomla:
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1131 <blockquote><pre>
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1132 location / {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1133 try_files $uri $uri/ @wordpress;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1134 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1135
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1136 location ~ \.php$ {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1137 try_files $uri @wordpress;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1138
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1139 fastcgi_pass ...;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1140
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1141 fastcgi_param SCRIPT_FILENAME /path/to$fastcgi_script_name;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1142 ... other fastcgi_param's
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1143 }
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1144
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1145 location @wordpress {
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1146 fastcgi_pass ...;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1147
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1148 fastcgi_param SCRIPT_FILENAME /path/to/index.php;
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1149 ... other fastcgi_param's
4dbdfd985863 Regenerate HTML for the previous revision. Ruslan Ermilov <ru@nginx.com> parents: 3996 diff changeset	1150 }
4071 cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1151 </pre></blockquote></p><hr><a name="types"></a><strong>syntax</strong>:
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1152 <code>types { ... }</code><br><strong>default</strong>:
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1153 <code>see below</code><br><strong>context</strong>:
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1154 <code>http</code>, <code>server</code>, <code>location</code><br><p>
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1155 Maps file name extensions to MIME types of responses.
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1156 Several extensions can map to one type.
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1157 The following mappings are configured by default:
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1158 <blockquote><pre>
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1159 types {
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1160 text/html html;
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1161 image/gif gif;
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1162 image/jpeg jpg;
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1163 }
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1164 </pre></blockquote></p><p>
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1165 A sufficiently full mapping table is distributed with nginx in the
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1166 <code>conf/mime.types</code> file.
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1167 </p><p>
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1168 To make a particular location emit the "<code>application/octet-stream</code>"
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1169 MIME type for all requests, try the following:
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1170 <blockquote><pre>
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1171 location /download/ {
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1172 types { }
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1173 default_type application/octet-stream;
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1174 }
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1175 </pre></blockquote></p><hr><a name="underscores_in_headers"></a><strong>syntax</strong>:
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1176 <code>underscores_in_headers <code>on</code> \| <code>off</code></code><br><strong>default</strong>:
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1177 <code>underscores_in_headers off</code><br><strong>context</strong>:
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1178 <code>http</code>, <code>server</code><br><p>
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1179 Enables or disables the use of underscores in client request header strings.
cf09c4826ab3 Regenerate after previous commit. Ruslan Ermilov <ru@nginx.com> parents: 4069 diff changeset	1180 </p></body></html>

Mercurial > hg > nginx-quic

annotate docs/html/http/ngx_http_core_module.html @ 4071:cf09c4826ab3