Mercurial > hg > nginx-quic
comparison docs/html/ngx_core_module.html @ 4069:4dbdfd985863
Regenerate HTML for the previous revision.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Mon, 05 Sep 2011 09:40:50 +0000 |
parents | |
children | a1e1b348bfaf |
comparison
equal
deleted
inserted
replaced
4068:22364b1f61c9 | 4069:4dbdfd985863 |
---|---|
1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>Core Module</title></head><body><a name="example"></a><center><h4>Example Configuration</h4></center><p><blockquote><pre> | |
2 user www www; | |
3 worker_processes 2; | |
4 | |
5 error_log /var/log/nginx-error.log info; | |
6 | |
7 events { | |
8 use kqueue; | |
9 worker_connections 2048; | |
10 } | |
11 | |
12 ... | |
13 </pre></blockquote></p><a name="directives"></a><center><h4>Directives</h4></center><hr><a name="daemon"></a><strong>syntax</strong>: | |
14 <code>daemon <code>on</code> | <code>off</code></code><br><strong>default</strong>: | |
15 <code>daemon on</code><br><strong>context</strong>: | |
16 <code>main</code><br><p> | |
17 Determines whether nginx should become a daemon. | |
18 Mainly used during development. | |
19 </p><hr><a name="env"></a><strong>syntax</strong>: | |
20 <code>env <code><i>VAR</i></code>[=<code><i>VALUE</i></code>]</code><br><strong>default</strong>: | |
21 <code>env TZ</code><br><strong>context</strong>: | |
22 <code>main</code><br><p> | |
23 Allows to limit a set of environment variables, change their values, | |
24 or create new environment variables, for the following cases: | |
25 <ul><li> | |
26 variable inheritance during a | |
27 <u>live upgrade</u> | |
28 of an executable file; | |
29 </li><li> | |
30 use of variables by the | |
31 <u>http_perl</u> | |
32 module; | |
33 </li><li> | |
34 use of variables by worker processes. | |
35 Please bear in mind that controlling system libraries in this way | |
36 isn't always possible as it's not uncommon for libraries to check | |
37 variables only during initialization, well before they can be set | |
38 using this directive. | |
39 An exception from this is an above mentioned | |
40 <u>live upgrade</u> | |
41 of an executable file. | |
42 </li></ul></p><p> | |
43 The TZ variable is always inherited and made available to the | |
44 <u>http_perl</u> | |
45 module, unless configured explicitly. | |
46 </p><p> | |
47 Usage example: | |
48 <blockquote><pre> | |
49 env MALLOC_OPTIONS; | |
50 env PERL5LIB=/data/site/modules; | |
51 env OPENSSL_ALLOW_PROXY_CERTS=1; | |
52 </pre></blockquote></p><hr><a name="include"></a><strong>syntax</strong>: | |
53 <code>include <code><i>file</i></code> | <code><i>mask</i></code></code><br><strong>default</strong>: | |
54 <strong>none</strong><br><strong>context</strong>: | |
55 <strong>any</strong><br><p> | |
56 Includes another <code><i>file</i></code>, or files matching the | |
57 specified <code><i>mask</i></code>, into configuration. | |
58 Included files should consist of | |
59 syntactically correct directives and blocks. | |
60 </p><p> | |
61 Usage example: | |
62 <blockquote><pre> | |
63 include mime.types; | |
64 include vhosts/*.conf; | |
65 </pre></blockquote></p><hr><a name="master_process"></a><strong>syntax</strong>: | |
66 <code>master_process <code>on</code> | <code>off</code></code><br><strong>default</strong>: | |
67 <code>master_process on</code><br><strong>context</strong>: | |
68 <code>main</code><br><p> | |
69 Determines whether worker processes are started. | |
70 This directive is intended for nginx developers. | |
71 </p><hr><a name="pid"></a><strong>syntax</strong>: | |
72 <code>pid <code><i>file</i></code></code><br><strong>default</strong>: | |
73 <code>pid nginx.pid</code><br><strong>context</strong>: | |
74 <code>main</code><br><p> | |
75 Defines a <code><i>file</i></code> which will store the process ID of the main process. | |
76 </p><hr><a name="ssl_engine"></a><strong>syntax</strong>: | |
77 <code>ssl_engine <code><i>device</i></code></code><br><strong>default</strong>: | |
78 <strong>none</strong><br><strong>context</strong>: | |
79 <code>main</code><br><p> | |
80 Defines the name of the hardware SSL accelerator. | |
81 </p><hr><a name="user"></a><strong>syntax</strong>: | |
82 <code>user <code><i>user</i></code> [<code><i>group</i></code>]</code><br><strong>default</strong>: | |
83 <code>user nobody nobody</code><br><strong>context</strong>: | |
84 <code>main</code><br><p> | |
85 Defines <code><i>user</i></code> and <code><i>group</i></code> | |
86 credentials used by worker processes. | |
87 If <code><i>group</i></code> is omitted, a group whose name equals | |
88 that of <code><i>user</i></code> is used. | |
89 </p><hr><a name="timer_resolution"></a><strong>syntax</strong>: | |
90 <code>timer_resolution <code><i>interval</i></code></code><br><strong>default</strong>: | |
91 <strong>none</strong><br><strong>context</strong>: | |
92 <code>main</code><br><p> | |
93 Reduces timer resolution in worker processes, thus reducing the | |
94 number of <code>gettimeofday()</code> system calls made. | |
95 By default, <code>gettimeofday()</code> is called each time | |
96 on receiving a kernel event. | |
97 With reduced resolution, <code>gettimeofday()</code> is only | |
98 called once per specified <code><i>interval</i></code>. | |
99 </p><p> | |
100 Example: | |
101 <blockquote><pre> | |
102 timer_resolution 100ms; | |
103 </pre></blockquote></p><p> | |
104 An internal implementation of interval depends on the method used: | |
105 <ul><li> | |
106 an <code>EVFILT_TIMER</code> filter if <code>kqueue</code> is used; | |
107 </li><li><code>timer_create()</code> if <code>eventport</code> is used; | |
108 </li><li><code>setitimer()</code> otherwise. | |
109 </li></ul></p><hr><a name="worker_rlimit_core"></a><strong>syntax</strong>: | |
110 <code>worker_rlimit_core <code><i>size</i></code></code><br><strong>default</strong>: | |
111 <strong>none</strong><br><strong>context</strong>: | |
112 <code>main</code><br><p> | |
113 Changes the limit on the largest size of a core file | |
114 (<code>RLIMIT_CORE</code>) for worker processes. | |
115 Used to increase the limit without restarting the main process. | |
116 </p><hr><a name="worker_rlimit_nofile"></a><strong>syntax</strong>: | |
117 <code>worker_rlimit_nofile <code><i>number</i></code></code><br><strong>default</strong>: | |
118 <strong>none</strong><br><strong>context</strong>: | |
119 <code>main</code><br><p> | |
120 Changes the limit on the maximum number of open files | |
121 (<code>RLIMIT_NOFILE</code>) for worker processes. | |
122 Used to increase the limit without restarting the main process. | |
123 </p><hr><a name="worker_priority"></a><strong>syntax</strong>: | |
124 <code>worker_priority <code><i>number</i></code></code><br><strong>default</strong>: | |
125 <code>worker_priority 0</code><br><strong>context</strong>: | |
126 <code>main</code><br><p> | |
127 Defines a scheduling priority for worker processes like is | |
128 done by the <code>nice</code>: a negative | |
129 <code><i>number</i></code> | |
130 means higher priority. | |
131 Allowed range normally varies from -20 to 20. | |
132 </p><p> | |
133 Example: | |
134 <blockquote><pre> | |
135 worker_priority -10; | |
136 </pre></blockquote></p><hr><a name="worker_processes"></a><strong>syntax</strong>: | |
137 <code>worker_processes <code><i>number</i></code></code><br><strong>default</strong>: | |
138 <code>worker_processes 1</code><br><strong>context</strong>: | |
139 <code>main</code><br><p> | |
140 Defines the number of worker processes. | |
141 </p><hr><a name="working_directory"></a><strong>syntax</strong>: | |
142 <code>working_directory <code><i>directory</i></code></code><br><strong>default</strong>: | |
143 <strong>none</strong><br><strong>context</strong>: | |
144 <code>main</code><br><p> | |
145 Defines a current working directory for a worker process. | |
146 It's primarily used for writing a core-file, in which case | |
147 a working process should have write permission for the | |
148 specified directory. | |
149 </p></body></html> |