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