Mercurial > hg > nginx-site
annotate xml/en/docs/ngx_core_module.xml @ 534:6761e05e5128
List of supported Debian and Ubuntu versions added.
author | Sergey Budnevitch <sb@waeme.net> |
---|---|
date | Wed, 13 Jun 2012 15:05:11 +0000 |
parents | a8daad8e83bb |
children | e97b46d1842d |
rev | line source |
---|---|
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1 <?xml version="1.0"?> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3 <!DOCTYPE module SYSTEM "../../../dtd/module.dtd"> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
4 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
5 <module name="Core functionality" |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
6 link="/en/docs/ngx_core_module.html" |
98 | 7 lang="en"> |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
8 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
9 <section id="example" name="Example Configuration"> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
10 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
11 <para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
12 <example> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
13 user www www; |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
14 worker_processes 2; |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
15 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
16 error_log /var/log/nginx-error.log info; |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
17 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
18 events { |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
19 use kqueue; |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
20 worker_connections 2048; |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
21 } |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
22 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
23 ... |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
24 </example> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
25 </para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
26 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
27 </section> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
28 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
29 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
30 <section id="directives" name="Directives"> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
31 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
32 <directive name="daemon"> |
271 | 33 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
102
c76a257f3fd4
The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents:
98
diff
changeset
|
34 <default>on</default> |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
35 <context>main</context> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
36 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
37 <para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
38 Determines whether nginx should become a daemon. |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
39 Mainly used during development. |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
40 </para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
41 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
42 </directive> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
43 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
44 |
516
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
45 <directive name="debug_connection"> |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
46 <syntax> |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
47 <value>address</value> | |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
48 <value>CIDR</value> | |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
49 <literal>unix:</literal></syntax> |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
50 <default/> |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
51 <context>events</context> |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
52 |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
53 <para> |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
54 Enables debugging log for selected client connections. |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
55 Other connections will use logging level set by the |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
56 <link id="error_log"/> directive. |
523 | 57 Debugged connections are specified by IPv4 or IPv6 (1.3.0, 1.2.1) |
58 address or network. | |
516
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
59 A connection may also be specified using a hostname, in which case the |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
60 first IPv4 address corresponding to a name is used. |
523 | 61 For connections using UNIX-domain sockets (1.3.0, 1.2.1), |
62 debugging log is enabled by the “<literal>unix:</literal>” parameter. | |
516
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
63 <example> |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
64 events { |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
65 debug_connection 127.0.0.1; |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
66 debug_connection localhost; |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
67 debug_connection 192.0.2.0/24; |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
68 debug_connection ::1; |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
69 debug_connection 2001:0db8::/32; |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
70 debug_connection unix:; |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
71 ... |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
72 } |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
73 </example> |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
74 <note> |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
75 For this directive to work, nginx needs to |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
76 be built with <literal>--with-debug</literal>. |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
77 </note> |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
78 </para> |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
79 |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
80 </directive> |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
81 |
8e1356bd281a
Documented the "debug_connection" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
469
diff
changeset
|
82 |
158
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
83 <directive name="error_log"> |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
84 <syntax> |
455
571b790ddf9e
error_log: documented the special value "stderr" and default logging level.
Ruslan Ermilov <ru@nginx.com>
parents:
444
diff
changeset
|
85 <value>file</value> | <literal>stderr</literal> |
271 | 86 [<literal>debug</literal> | |
87 <literal>info</literal> | | |
88 <literal>notice</literal> | | |
89 <literal>warn</literal> | | |
90 <literal>error</literal> | | |
91 <literal>crit</literal> | | |
92 <literal>alert</literal> | | |
93 <literal>emerg</literal>]</syntax> | |
158
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
94 <default>logs/error.log error</default> |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
95 <context>main</context> |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
96 <context>http</context> |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
97 <context>server</context> |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
98 <context>location</context> |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
99 |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
100 <para> |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
101 Configures logging. |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
102 </para> |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
103 |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
104 <para> |
271 | 105 The first parameter defines a file that will store the log. |
158
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
106 <!-- |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
107 If filename is not absolute, it is prefixed with the prefix path. |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
108 --> |
455
571b790ddf9e
error_log: documented the special value "stderr" and default logging level.
Ruslan Ermilov <ru@nginx.com>
parents:
444
diff
changeset
|
109 The special value <literal>stderr</literal> selects the standard error file. |
158
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
110 </para> |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
111 |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
112 <para> |
271 | 113 The second parameter determines the level of logging. |
158
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
114 Log levels above are listed in the order of increasing severity. |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
115 Setting a certain log level will cause all messages of |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
116 the specified and more severe log levels to be logged. |
271 | 117 For example, the default level <literal>error</literal> will |
118 cause <literal>error</literal>, <literal>crit</literal>, | |
119 <literal>alert</literal>, and <literal>emerg</literal> messages | |
158
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
120 to be logged. |
455
571b790ddf9e
error_log: documented the special value "stderr" and default logging level.
Ruslan Ermilov <ru@nginx.com>
parents:
444
diff
changeset
|
121 If this parameter is omitted then <literal>error</literal> is used. |
158
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
122 <note> |
271 | 123 For <literal>debug</literal> logging to work, nginx needs to |
124 be built with <literal>--with-debug</literal>. | |
158
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
125 </note> |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
126 </para> |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
127 |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
128 </directive> |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
129 |
05e58829de2e
Documented the "error_log" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
130 |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
131 <directive name="env"> |
271 | 132 <syntax><value>variable</value>[=<value>value</value>]</syntax> |
102
c76a257f3fd4
The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents:
98
diff
changeset
|
133 <default>TZ</default> |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
134 <context>main</context> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
135 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
136 <para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
137 Allows to limit a set of environment variables, change their values, |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
138 or create new environment variables, for the following cases: |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
139 <list type="bullet"> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
140 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
141 <listitem> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
142 variable inheritance during a |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
143 <link doc="control.xml" id="upgrade">live upgrade</link> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
144 of an executable file; |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
145 </listitem> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
146 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
147 <listitem> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
148 use of variables by the module |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
149 <link doc="http/ngx_http_perl_module.xml">ngx_http_perl_module</link>; |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
150 </listitem> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
151 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
152 <listitem> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
153 use of variables by worker processes. |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
154 Please bear in mind that controlling system libraries in this way |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
155 is not always possible as it is not uncommon for libraries to check |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
156 variables only during initialization, well before they can be set |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
157 using this directive. |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
158 An exception from this is an above mentioned |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
159 <link doc="control.xml" id="upgrade">live upgrade</link> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
160 of an executable file. |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
161 </listitem> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
162 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
163 </list> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
164 </para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
165 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
166 <para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
167 The TZ variable is always inherited and made available to the module |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
168 <link doc="http/ngx_http_perl_module.xml">ngx_http_perl_module</link>, |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
169 unless configured explicitly. |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
170 </para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
171 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
172 <para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
173 Usage example: |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
174 <example> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
175 env MALLOC_OPTIONS; |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
176 env PERL5LIB=/data/site/modules; |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
177 env OPENSSL_ALLOW_PROXY_CERTS=1; |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
178 </example> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
179 </para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
180 |
444
43c84d19bf92
Added a note about the NGINX environment variable.
Ruslan Ermilov <ru@nginx.com>
parents:
289
diff
changeset
|
181 <para> |
43c84d19bf92
Added a note about the NGINX environment variable.
Ruslan Ermilov <ru@nginx.com>
parents:
289
diff
changeset
|
182 <note> |
43c84d19bf92
Added a note about the NGINX environment variable.
Ruslan Ermilov <ru@nginx.com>
parents:
289
diff
changeset
|
183 The NGINX environment variable is used internally by nginx |
43c84d19bf92
Added a note about the NGINX environment variable.
Ruslan Ermilov <ru@nginx.com>
parents:
289
diff
changeset
|
184 and should not be set directly by the user. |
43c84d19bf92
Added a note about the NGINX environment variable.
Ruslan Ermilov <ru@nginx.com>
parents:
289
diff
changeset
|
185 </note> |
43c84d19bf92
Added a note about the NGINX environment variable.
Ruslan Ermilov <ru@nginx.com>
parents:
289
diff
changeset
|
186 </para> |
43c84d19bf92
Added a note about the NGINX environment variable.
Ruslan Ermilov <ru@nginx.com>
parents:
289
diff
changeset
|
187 |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
188 </directive> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
189 |
249 | 190 |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
191 <directive name="include"> |
271 | 192 <syntax><value>file</value> | <value>mask</value></syntax> |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
193 <default/> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
194 <context/> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
195 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
196 <para> |
271 | 197 Includes another <value>file</value>, or files matching the |
198 specified <value>mask</value>, into configuration. | |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
199 Included files should consist of |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
200 syntactically correct directives and blocks. |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
201 </para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
202 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
203 <para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
204 Usage example: |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
205 <example> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
206 include mime.types; |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
207 include vhosts/*.conf; |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
208 </example> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
209 </para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
210 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
211 </directive> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
212 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
213 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
214 <directive name="master_process"> |
271 | 215 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
102
c76a257f3fd4
The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents:
98
diff
changeset
|
216 <default>on</default> |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
217 <context>main</context> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
218 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
219 <para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
220 Determines whether worker processes are started. |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
221 This directive is intended for nginx developers. |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
222 </para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
223 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
224 </directive> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
225 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
226 |
289
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
227 <directive name="pcre_jit"> |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
228 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
229 <default>off</default> |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
230 <context>main</context> |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
231 <appeared-in>1.1.12</appeared-in> |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
232 |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
233 <para> |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
234 Enables or disables the use of “just-in-time compilation” (PCRE JIT) |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
235 for regular expressions known at configuration parse time. |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
236 </para> |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
237 |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
238 <para> |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
239 PCRE JIT can speed up processing of regular expressions significantly. |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
240 <note> |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
241 The JIT is available in PCRE libraries starting from version 8.20 |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
242 built with the <literal>--enable-jit</literal> configuration parameter. |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
243 When building the PCRE library with nginx (<literal>--with-pcre=</literal>), |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
244 the JIT support should be enabled with the |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
245 <literal>--with-pcre-jit</literal> configuration parameter. |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
246 </note> |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
247 </para> |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
248 |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
249 </directive> |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
250 |
df261b1ce71f
Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
251 |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
252 <directive name="pid"> |
271 | 253 <syntax><value>file</value></syntax> |
102
c76a257f3fd4
The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents:
98
diff
changeset
|
254 <default>nginx.pid</default> |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
255 <context>main</context> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
256 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
257 <para> |
271 | 258 Defines a <value>file</value> that will store the process ID of the main process. |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
259 </para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
260 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
261 </directive> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
262 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
263 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
264 <directive name="ssl_engine"> |
271 | 265 <syntax><value>device</value></syntax> |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
266 <default/> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
267 <context>main</context> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
268 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
269 <para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
270 Defines the name of the hardware SSL accelerator. |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
271 </para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
272 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
273 </directive> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
274 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
275 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
276 <directive name="timer_resolution"> |
271 | 277 <syntax><value>interval</value></syntax> |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
278 <default/> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
279 <context>main</context> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
280 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
281 <para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
282 Reduces timer resolution in worker processes, thus reducing the |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
283 number of <c-func>gettimeofday</c-func> system calls made. |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
284 By default, <c-func>gettimeofday</c-func> is called each time |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
285 on receiving a kernel event. |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
286 With reduced resolution, <c-func>gettimeofday</c-func> is only |
271 | 287 called once per specified <value>interval</value>. |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
288 </para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
289 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
290 <para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
291 Example: |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
292 <example> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
293 timer_resolution 100ms; |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
294 </example> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
295 </para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
296 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
297 <para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
298 An internal implementation of interval depends on the method used: |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
299 <list type="bullet"> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
300 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
301 <listitem> |
271 | 302 an <c-def>EVFILT_TIMER</c-def> filter if <literal>kqueue</literal> is used; |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
303 </listitem> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
304 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
305 <listitem> |
271 | 306 <c-func>timer_create</c-func> if <literal>eventport</literal> is used; |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
307 </listitem> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
308 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
309 <listitem> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
310 <c-func>setitimer</c-func> otherwise. |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
311 </listitem> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
312 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
313 </list> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
314 </para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
315 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
316 </directive> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
317 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
318 |
82
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
319 <directive name="user"> |
271 | 320 <syntax><value>user</value> [<value>group</value>]</syntax> |
102
c76a257f3fd4
The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents:
98
diff
changeset
|
321 <default>nobody nobody</default> |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
322 <context>main</context> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
323 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
324 <para> |
271 | 325 Defines <value>user</value> and <value>group</value> |
82
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
326 credentials used by worker processes. |
271 | 327 If <value>group</value> is omitted, a group whose name equals |
328 that of <value>user</value> is used. | |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
329 </para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
330 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
331 </directive> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
332 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
333 |
469
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
334 <directive name="worker_cpu_affinity"> |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
335 <syntax><value>cpumask</value> ...</syntax> |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
336 <default/> |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
337 <context>main</context> |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
338 |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
339 <para> |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
340 Binds worker processes to the sets of CPUs. |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
341 Each CPU set is represented by a bitmask of allowed to use CPUs. |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
342 There should be a separate set defined for each of the worker processes. |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
343 By default, worker processes are not bound to any specific CPUs. |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
344 </para> |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
345 |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
346 <para> |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
347 For example, |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
348 <example> |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
349 worker_processes 4; |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
350 worker_cpu_affinity 0001 0010 0100 1000; |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
351 </example> |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
352 binds each worker process to a separate CPU, while |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
353 <example> |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
354 worker_processes 2; |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
355 worker_cpu_affinity 0101 1010; |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
356 </example> |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
357 binds the first worker process to CPU0/CPU2, |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
358 and the second worker process to CPU1/CPU3. |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
359 The second example is suitable for hyper-threading. |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
360 </para> |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
361 |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
362 <para> |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
363 <note> |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
364 The directive is only available on FreeBSD and Linux. |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
365 </note> |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
366 </para> |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
367 |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
368 </directive> |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
369 |
8275e169f77b
Documented the "worker_cpu_affinity" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
455
diff
changeset
|
370 |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
371 <directive name="worker_priority"> |
271 | 372 <syntax><value>number</value></syntax> |
102
c76a257f3fd4
The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents:
98
diff
changeset
|
373 <default>0</default> |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
374 <context>main</context> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
375 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
376 <para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
377 Defines a scheduling priority for worker processes like is |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
378 done by the <command>nice</command> command: a negative |
271 | 379 <value>number</value> |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
380 means higher priority. |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
381 Allowed range normally varies from -20 to 20. |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
382 </para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
383 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
384 <para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
385 Example: |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
386 <example> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
387 worker_priority -10; |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
388 </example> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
389 </para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
390 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
391 </directive> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
392 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
393 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
394 <directive name="worker_processes"> |
271 | 395 <syntax><value>number</value></syntax> |
102
c76a257f3fd4
The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents:
98
diff
changeset
|
396 <default>1</default> |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
397 <context>main</context> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
398 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
399 <para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
400 Defines the number of worker processes. |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
401 </para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
402 |
226
c4b33b07dcfe
Added some basic hints on how to tune "worker_processes".
Ruslan Ermilov <ru@nginx.com>
parents:
158
diff
changeset
|
403 <para> |
c4b33b07dcfe
Added some basic hints on how to tune "worker_processes".
Ruslan Ermilov <ru@nginx.com>
parents:
158
diff
changeset
|
404 The optimal value depends on many factors including (but not |
c4b33b07dcfe
Added some basic hints on how to tune "worker_processes".
Ruslan Ermilov <ru@nginx.com>
parents:
158
diff
changeset
|
405 limited to) the number of CPU cores, the number of hard disk |
c4b33b07dcfe
Added some basic hints on how to tune "worker_processes".
Ruslan Ermilov <ru@nginx.com>
parents:
158
diff
changeset
|
406 drives that store data, and load pattern. |
c4b33b07dcfe
Added some basic hints on how to tune "worker_processes".
Ruslan Ermilov <ru@nginx.com>
parents:
158
diff
changeset
|
407 When in doubt, setting it to the number of available CPU cores |
c4b33b07dcfe
Added some basic hints on how to tune "worker_processes".
Ruslan Ermilov <ru@nginx.com>
parents:
158
diff
changeset
|
408 would be a good start. |
c4b33b07dcfe
Added some basic hints on how to tune "worker_processes".
Ruslan Ermilov <ru@nginx.com>
parents:
158
diff
changeset
|
409 </para> |
c4b33b07dcfe
Added some basic hints on how to tune "worker_processes".
Ruslan Ermilov <ru@nginx.com>
parents:
158
diff
changeset
|
410 |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
411 </directive> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
412 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
413 |
82
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
414 <directive name="worker_rlimit_core"> |
271 | 415 <syntax><value>size</value></syntax> |
82
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
416 <default/> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
417 <context>main</context> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
418 |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
419 <para> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
420 Changes the limit on the largest size of a core file |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
421 (<c-def>RLIMIT_CORE</c-def>) for worker processes. |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
422 Used to increase the limit without restarting the main process. |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
423 </para> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
424 |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
425 </directive> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
426 |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
427 |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
428 <directive name="worker_rlimit_nofile"> |
271 | 429 <syntax><value>number</value></syntax> |
82
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
430 <default/> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
431 <context>main</context> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
432 |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
433 <para> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
434 Changes the limit on the maximum number of open files |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
435 (<c-def>RLIMIT_NOFILE</c-def>) for worker processes. |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
436 Used to increase the limit without restarting the main process. |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
437 </para> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
438 |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
439 </directive> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
440 |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
63
diff
changeset
|
441 |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
442 <directive name="working_directory"> |
271 | 443 <syntax><value>directory</value></syntax> |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
444 <default/> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
445 <context>main</context> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
446 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
447 <para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
448 Defines a current working directory for a worker process. |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
449 It is primarily used when writing a core-file, in which case |
262
676abe405aba
Changed one instance of "working process" to "worker process".
Ruslan Ermilov <ru@nginx.com>
parents:
249
diff
changeset
|
450 a worker process should have write permission for the |
63
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
451 specified directory. |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
452 </para> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
453 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
454 </directive> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
455 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
456 </section> |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
457 |
6108fd3217e7
Initial English translation of ngx_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
458 </module> |