Mercurial > hg > nginx-site
comparison xml/ru/docs/ngx_core_module.xml @ 255:e2718c7f9040
Sync ngx_core_module documentation with English version.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Tue, 20 Dec 2011 07:59:33 +0000 |
parents | bfe3eff81d04 |
children | 945d7299c26c |
comparison
equal
deleted
inserted
replaced
254:6080b2b90d15 | 255:e2718c7f9040 |
---|---|
1 <?xml version="1.0"?> | 1 <?xml version="1.0"?> |
2 | 2 |
3 <!DOCTYPE module SYSTEM "../../../dtd/module.dtd"> | 3 <!DOCTYPE module SYSTEM "../../../dtd/module.dtd"> |
4 | 4 |
5 <module name="Глобальные директивы" | 5 <module name="Основная функциональность" |
6 link="/ru/docs/ngx_core_module.html" | 6 link="/ru/docs/ngx_core_module.html" |
7 lang="ru"> | 7 lang="ru"> |
8 | 8 |
9 | 9 <section id="example" name="Пример конфигурации"> |
10 <section name="Пример конфигурации" id="example"> | 10 |
11 | 11 <para> |
12 <para> | 12 <example> |
13 <example> | 13 user www www; |
14 | 14 worker_processes 2; |
15 user www www; | 15 |
16 worker_processes 2; | 16 error_log /var/log/nginx-error.log info; |
17 | |
18 error_log /var/log/nginx-error.log info; | |
19 | 17 |
20 events { | 18 events { |
21 use kqueue; | 19 use kqueue; |
22 worker_connections 2048; | 20 worker_connections 2048; |
23 } | 21 } |
24 | 22 |
25 ... | 23 ... |
26 </example> | 24 </example> |
27 </para> | 25 </para> |
28 | 26 |
29 </section> | 27 </section> |
30 | 28 |
31 | 29 |
32 <section name="Директивы" id="directives"> | 30 <section id="directives" name="Директивы"> |
33 | 31 |
34 <directive name="daemon"> | 32 <directive name="daemon"> |
35 <syntax><value>on|off</value></syntax> | 33 <syntax><value>on</value> | <value>off</value></syntax> |
36 <default>on</default> | 34 <default>on</default> |
37 <context>main</context> | 35 <context>main</context> |
38 | 36 |
39 <para> | 37 <para> |
40 Директива определяет, будет ли nginx запускаться в режиме демона. | 38 Определяет, будет ли nginx запускаться в режиме демона. |
41 Используется в основном для разработки. | 39 Используется в основном для разработки. |
42 </para> | 40 </para> |
43 | 41 |
44 </directive> | 42 </directive> |
45 | 43 |
46 | 44 |
45 <directive name="error_log"> | |
46 <syntax> | |
47 <argument>файл</argument> | |
48 [<value>debug</value> | | |
49 <value>info</value> | | |
50 <value>notice</value> | | |
51 <value>warn</value> | | |
52 <value>error</value> | | |
53 <value>crit</value> | | |
54 <value>alert</value> | | |
55 <value>emerg</value>] | |
56 </syntax> | |
57 <default>logs/error.log error</default> | |
58 <context>main</context> | |
59 <context>http</context> | |
60 <context>server</context> | |
61 <context>location</context> | |
62 | |
63 <para> | |
64 Конфигурирует запись в лог. | |
65 </para> | |
66 | |
67 <para> | |
68 Первый аргумент задаёт файл, который будет хранить лог. | |
69 <!-- | |
70 Если имя файла не абсолютное, к нему добавляется в начало путь префикса. | |
71 --> | |
72 </para> | |
73 | |
74 <para> | |
75 Второй аргумент определяет уровень лога. | |
76 Уровни лога, указанные выше, перечислены в порядке возрастания их серьёзности. | |
77 При установке определённого уровня в лог попадают все сообщения | |
78 указанного и более серьёзных уровней. | |
79 Например, при стандартном уровне <value>error</value> в лог попадают | |
80 сообщения уровней <value>error</value>, <value>crit</value>, | |
81 <value>alert</value> и <value>emerg</value>. | |
82 | |
83 <note> | |
84 Для работы уровня лога <value>debug</value> необходимо сконфигурировать | |
85 nginx с <code>--with-debug</code>. | |
86 </note> | |
87 </para> | |
88 | |
89 </directive> | |
90 | |
91 | |
47 <directive name="env"> | 92 <directive name="env"> |
48 <syntax><value>VAR|VAR=VALUE</value></syntax> | 93 <syntax><argument>переменная</argument>[=<argument>значение</argument>]</syntax> |
49 <default>TZ</default> | 94 <default>TZ</default> |
50 <context>main</context> | 95 <context>main</context> |
51 | 96 |
52 <para> | 97 <para> |
53 Директива позволяет ограничить набор переменных среды, поменять им значения | 98 Позволяет ограничить набор переменных окружения, поменять им значения |
54 или же создать новые переменные для следующих случаев: | 99 или же создать новые переменные окружения для следующих случаев: |
55 <list type="bullet"> | 100 <list type="bullet"> |
56 | 101 |
57 <listitem> | 102 <listitem> |
58 наследование переменных во время | 103 наследование переменных во время |
59 <link doc="control.xml" id="upgrade">обновления исполняемого файла на лету</link>; | 104 <link doc="control.xml" id="upgrade">обновления исполняемого файла на лету</link>; |
68 использование переменных рабочими процессами. | 113 использование переменных рабочими процессами. |
69 Однако нужно иметь в виду, что управление поведением системных библиотек | 114 Однако нужно иметь в виду, что управление поведением системных библиотек |
70 подобным образом возможно не всегда, поскольку зачастую библиотеки используют | 115 подобным образом возможно не всегда, поскольку зачастую библиотеки используют |
71 переменные только во время инициализации, то есть ещё до того, как их | 116 переменные только во время инициализации, то есть ещё до того, как их |
72 можно задать с помощью данной директивы. | 117 можно задать с помощью данной директивы. |
73 Исключением из этого является вышеописанное обновление исполняемого файла | 118 Исключением из этого является вышеописанное |
74 на лету. | 119 <link doc="control.xml" id="upgrade">обновление исполняемого файла на лету</link>. |
75 </listitem> | 120 </listitem> |
76 | 121 |
77 </list> | 122 </list> |
78 </para> | 123 </para> |
79 | 124 |
80 <para> | 125 <para> |
81 Если переменная TZ не описана явно, то она всегда наследуется | 126 Если переменная TZ не описана явно, то она всегда наследуется |
82 и всегда доступна модулю ngx_http_perl_module. | 127 и всегда доступна модулю |
128 <link doc="http/ngx_http_perl_module.xml">ngx_http_perl_module</link>. | |
83 </para> | 129 </para> |
84 | 130 |
85 <para> | 131 <para> |
86 Пример использования: | 132 Пример использования: |
87 <example> | 133 <example> |
88 env MALLOC_OPTIONS; | 134 env MALLOC_OPTIONS; |
89 env PERL5LIB=/data/site/modules; | 135 env PERL5LIB=/data/site/modules; |
90 env OPENSSL_ALLOW_PROXY_CERTS=1; | 136 env OPENSSL_ALLOW_PROXY_CERTS=1; |
91 </example> | 137 </example> |
92 </para> | 138 </para> |
93 | 139 |
94 </directive> | 140 </directive> |
95 | 141 |
96 | 142 |
97 <directive name="include"> | 143 <directive name="include"> |
98 <syntax><value>файл|маска</value></syntax> | 144 <syntax><argument>файл</argument> | <argument>маска</argument></syntax> |
99 <default/> | 145 <default/> |
100 <context/> | 146 <context/> |
101 | 147 |
102 <para> | 148 <para> |
103 Директива позволяет включить в конфигурацию другой файл. | 149 Включает в конфигурацию другой <argument>файл</argument> или файлы, |
104 Файл должен содержать синтаксически законченные директивы и блоки. | 150 подходящие под заданную маску. |
151 Включаемые файлы должны содержать синтаксически верные директивы и блоки. | |
105 </para> | 152 </para> |
106 | 153 |
107 <para> | 154 <para> |
108 Пример использования: | 155 Пример использования: |
109 <example> | 156 <example> |
110 include mime.types; | 157 include mime.types; |
111 include vhosts/*.conf; | 158 include vhosts/*.conf; |
112 </example> | 159 </example> |
113 </para> | 160 </para> |
114 | 161 |
115 </directive> | 162 </directive> |
116 | 163 |
117 | 164 |
118 <directive name="master_process"> | 165 <directive name="master_process"> |
119 <syntax><value>on|off</value></syntax> | 166 <syntax><value>on</value> | <value>off</value></syntax> |
120 <default>on</default> | 167 <default>on</default> |
121 <context>main</context> | 168 <context>main</context> |
122 | 169 |
123 <para> | 170 <para> |
124 Директива определяет, будут ли запускаться рабочие процессы. | 171 Определяет, будут ли запускаться рабочие процессы. |
125 Используется только для разработки. | 172 Эта директива предназначена для разработчиков nginx. |
126 </para> | 173 </para> |
127 | 174 |
128 </directive> | 175 </directive> |
129 | 176 |
130 | 177 |
131 <directive name="pid"> | 178 <directive name="pid"> |
132 <syntax><value>файл</value></syntax> | 179 <syntax><argument>файл</argument></syntax> |
133 <default>nginx.pid</default> | 180 <default>nginx.pid</default> |
134 <context>main</context> | 181 <context>main</context> |
135 | 182 |
136 <para> | 183 <para> |
137 Директива задаёт файл, в котором хранится номер основго процесса. | 184 Задаёт <argument>файл</argument>, в котором хранится номер (PID) основного процесса. |
138 </para> | 185 </para> |
139 | 186 |
140 </directive> | 187 </directive> |
141 | 188 |
142 | 189 |
143 <directive name="ssl_engine"> | 190 <directive name="ssl_engine"> |
144 <syntax><value>устройство</value></syntax> | 191 <syntax><argument>устройство</argument></syntax> |
145 <default/> | 192 <default/> |
146 <context>main</context> | 193 <context>main</context> |
147 | 194 |
148 <para> | 195 <para> |
149 Директива задаёт название аппартного SSL-акселератора. | 196 Задаёт название аппаратного SSL-акселератора. |
150 </para> | |
151 | |
152 </directive> | |
153 | |
154 | |
155 <directive name="user"> | |
156 <syntax><value>пользователь [группа]</value></syntax> | |
157 <default>nobody nobody</default> | |
158 <context>main</context> | |
159 | |
160 <para> | |
161 Директива задаёт пользователя и группу, с правами которого будут работать | |
162 рабочие процессы. Если группа не задана, то используется группа, имя | |
163 которой совпадает с именем пользователя. | |
164 </para> | 197 </para> |
165 | 198 |
166 </directive> | 199 </directive> |
167 | 200 |
168 | 201 |
169 <directive name="timer_resolution"> | 202 <directive name="timer_resolution"> |
170 <syntax><value>время</value></syntax> | 203 <syntax><argument>интервал</argument></syntax> |
171 <default/> | 204 <default/> |
172 <context>main</context> | 205 <context>main</context> |
173 | 206 |
174 <para> | 207 <para> |
175 Директива уменьшает разрешение времени в рабочих процессах, за счёт | 208 Уменьшает разрешение таймеров времени в рабочих процессах, за счёт |
176 чего уменьшается число системных вызовов gettimeofday(). | 209 чего уменьшается число системных вызовов <c-func>gettimeofday</c-func>. |
177 По умолчанию gettimeofday() вызывается после каждой операции получения | 210 По умолчанию <c-func>gettimeofday</c-func> вызывается после каждой |
178 событий из ядра. | 211 операции получения событий из ядра. |
179 C уменьшенным разрешением gettimeofday() вызывается только | 212 C уменьшенным разрешением <c-func>gettimeofday</c-func> вызывается только |
180 один раз за указанный интервал. | 213 один раз за указанный <argument>интервал</argument>. |
181 </para> | 214 </para> |
182 | 215 |
183 <para> | 216 <para> |
184 Пример использования: | 217 Пример использования: |
185 <example> | 218 <example> |
186 timer_resolution 100ms; | 219 timer_resolution 100ms; |
187 </example> | 220 </example> |
188 </para> | 221 </para> |
189 | 222 |
190 <para> | 223 <para> |
191 Внутренняя реализация интервала зависит от используемого метода: | 224 Внутренняя реализация интервала зависит от используемого метода: |
192 <list type="bullet"> | 225 <list type="bullet"> |
193 | 226 |
194 <listitem> | 227 <listitem> |
195 фильтр EVFILT_TIMER при использовании kqueue; | 228 фильтр <c-def>EVFILT_TIMER</c-def> при использовании <value>kqueue</value>; |
196 </listitem> | 229 </listitem> |
197 | 230 |
198 <listitem> | 231 <listitem> |
199 timer_create() при использовании eventport; | 232 <c-func>timer_create</c-func> при использовании <value>eventport</value>; |
200 </listitem> | 233 </listitem> |
201 | 234 |
202 <listitem> | 235 <listitem> |
203 и setitimer() во всех остальных случаяx. | 236 и <c-func>setitimer</c-func> во всех остальных случаях. |
204 </listitem> | 237 </listitem> |
205 | 238 |
206 </list> | 239 </list> |
207 </para> | 240 </para> |
208 | 241 |
209 </directive> | 242 </directive> |
210 | 243 |
211 | 244 |
245 <directive name="user"> | |
246 <syntax><argument>пользователь</argument> [<argument>группа</argument>]</syntax> | |
247 <default>nobody nobody</default> | |
248 <context>main</context> | |
249 | |
250 <para> | |
251 Задаёт пользователя и группу, с правами которого будут работать | |
252 рабочие процессы. | |
253 Если <argument>группа</argument> не задана, то используется группа, имя | |
254 которой совпадает с именем пользователя. | |
255 </para> | |
256 | |
257 </directive> | |
258 | |
259 | |
260 <directive name="worker_priority"> | |
261 <syntax><argument>число</argument></syntax> | |
262 <default>0</default> | |
263 <context>main</context> | |
264 | |
265 <para> | |
266 Задаёт приоритет планирования рабочих процессов подобно тому, | |
267 как это делается командой <command>nice</command>: отрицательное | |
268 <argument>число</argument> | |
269 означает более высокий приоритет. | |
270 Диапазон возможных значений, как правило, варьируется от -20 до 20. | |
271 </para> | |
272 | |
273 <para> | |
274 Пример использования: | |
275 <example> | |
276 worker_priority -10; | |
277 </example> | |
278 </para> | |
279 | |
280 </directive> | |
281 | |
282 | |
283 <directive name="worker_processes"> | |
284 <syntax><argument>число</argument></syntax> | |
285 <default>1</default> | |
286 <context>main</context> | |
287 | |
288 <para> | |
289 Задаёт число рабочих процессов. | |
290 </para> | |
291 | |
292 <para> | |
293 Оптимальное значение зависит от множества факторов, включая | |
294 (но не ограничиваясь ими) число процессорных ядер, число | |
295 жёстких дисков с данными и картину нагрузок. | |
296 Если затрудняетесь в выборе правильного значения, можно начать | |
297 с установки его равным числу процессорных ядер. | |
298 </para> | |
299 | |
300 </directive> | |
301 | |
302 | |
212 <directive name="worker_rlimit_core"> | 303 <directive name="worker_rlimit_core"> |
213 <syntax><value>размер</value></syntax> | 304 <syntax><argument>размер</argument></syntax> |
214 <default/> | 305 <default/> |
215 <context>main</context> | 306 <context>main</context> |
216 | 307 |
217 <para> | 308 <para> |
218 Директива изменяет ограничение на размер core-файла RLIMIT_CORE | 309 Изменяет ограничение на наибольший размер core-файла |
219 для рабочего процесса. | 310 (<c-def>RLIMIT_CORE</c-def>) для рабочих процессов. |
220 Используется для увеличения ограничения без перезапуска основного процесса. | 311 Используется для увеличения ограничения без перезапуска основного процесса. |
221 </para> | 312 </para> |
222 | 313 |
223 </directive> | 314 </directive> |
224 | 315 |
225 | 316 |
226 <directive name="worker_rlimit_nofile"> | 317 <directive name="worker_rlimit_nofile"> |
227 <syntax><value>число</value></syntax> | 318 <syntax><argument>число</argument></syntax> |
228 <default/> | 319 <default/> |
229 <context>main</context> | 320 <context>main</context> |
230 | 321 |
231 <para> | 322 <para> |
232 Директива изменяет ограничение на число используемых файлов RLIMIT_NOFILE | 323 Изменяет ограничение на максимальное число открытых файлов |
233 для рабочего процесса. | 324 (<c-def>RLIMIT_NOFILE</c-def>) для рабочих процессов. |
234 Используется для увеличения ограничения без перезапуска основного процесса. | 325 Используется для увеличения ограничения без перезапуска основного процесса. |
235 </para> | 326 </para> |
236 | 327 |
237 </directive> | 328 </directive> |
238 | 329 |
239 | 330 |
240 <directive name="worker_priority"> | |
241 <syntax><value>число</value></syntax> | |
242 <default>0</default> | |
243 <context>main</context> | |
244 | |
245 <para> | |
246 Директива задаёт приоритет рабочих процессов подобно тому, | |
247 как это делается командой <command>nice</command>: | |
248 отрицательное число означает более высокий приоритет. | |
249 Диапазон возможных значений, как правило, от -20 до 20. | |
250 </para> | |
251 | |
252 <para> | |
253 Пример использования: | |
254 <example> | |
255 worker_priority -10; | |
256 </example> | |
257 </para> | |
258 | |
259 </directive> | |
260 | |
261 | |
262 <directive name="worker_processes"> | |
263 <syntax><value>число</value></syntax> | |
264 <default>1</default> | |
265 <context>main</context> | |
266 | |
267 <para> | |
268 Директива задаёт число рабочих процессов. | |
269 </para> | |
270 | |
271 </directive> | |
272 | |
273 | |
274 <directive name="working_directory"> | 331 <directive name="working_directory"> |
275 <syntax><value>путь</value></syntax> | 332 <syntax><argument>каталог</argument></syntax> |
276 <default/> | 333 <default/> |
277 <context>main</context> | 334 <context>main</context> |
278 | 335 |
279 <para> | 336 <para> |
280 Директива задаёт каталог, который будет текущим для рабочего процесса. | 337 Задаёт каталог, который будет текущим для рабочего процесса. |
281 Основное применение — запись core-файла, в этом случае рабочий | 338 Основное применение — запись core-файла, в этом случае рабочий |
282 процесс должен иметь права на запись в этот каталог. | 339 процесс должен иметь права на запись в этот каталог. |
283 </para> | 340 </para> |
284 | 341 |
285 </directive> | 342 </directive> |