Mercurial > hg > nginx-site
comparison xml/ru/docs/mail/ngx_mail_core_module.xml @ 630:a235ce0f8eef
Initial mail proxy server documentation in Russian.
Obtained from Anton Yuzhaninov.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Wed, 15 Aug 2012 07:56:36 +0000 |
parents | |
children | 07f009b59a28 |
comparison
equal
deleted
inserted
replaced
629:7e4805858796 | 630:a235ce0f8eef |
---|---|
1 <?xml version="1.0"?> | |
2 | |
3 <!-- | |
4 Copyright (C) Anton Yuzhaninov 2006,2007 | |
5 Copyright (C) Nginx, Inc. | |
6 --> | |
7 | |
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> | |
9 | |
10 <module name="Модуль ngx_mail_core_module" | |
11 link="/ru/docs/mail/ngx_mail_core_module.html" | |
12 lang="ru" | |
13 rev="1"> | |
14 | |
15 <section id="summary"> | |
16 | |
17 <para> | |
18 По умолчанию этот модуль не собирается, его сборку необходимо | |
19 разрешить с помощью конфигурационного параметра | |
20 <literal>--with-mail</literal>. | |
21 </para> | |
22 | |
23 </section> | |
24 | |
25 | |
26 <section id="example" name="Пример конфигурации"> | |
27 | |
28 <para> | |
29 <example> | |
30 worker_processes 1; | |
31 | |
32 error_log /var/log/nginx/error.log info; | |
33 | |
34 mail { | |
35 server_name mail.example.com; | |
36 auth_http localhost:9000/cgi-bin/nginxauth.cgi; | |
37 | |
38 imap_capabilities IMAP4rev1 UIDPLUS IDLE LITERAL+ QUOTA; | |
39 | |
40 pop3_auth plain apop cram-md5; | |
41 pop3_capabilities LAST TOP USER PIPELINING UIDL; | |
42 | |
43 smtp_auth login plain cram-md5; | |
44 smtp_capabilities "SIZE 10485760" ENHANCEDSTATUSCODES 8BITMIME DSN; | |
45 xclient off; | |
46 | |
47 server { | |
48 listen 25; | |
49 protocol smtp; | |
50 # По RFC 2821 таймаут должен быть 300 секунд | |
51 timeout 300s; | |
52 } | |
53 server { | |
54 listen 110; | |
55 protocol pop3; | |
56 proxy on; | |
57 proxy_pass_error_message on; | |
58 } | |
59 server { | |
60 listen 143; | |
61 protocol imap; | |
62 proxy on; | |
63 } | |
64 server { | |
65 listen 587; | |
66 protocol smtp; | |
67 timeout 300s; | |
68 } | |
69 } | |
70 </example> | |
71 </para> | |
72 | |
73 </section> | |
74 | |
75 | |
76 <section id="directives" name="Директивы"> | |
77 | |
78 <directive name="imap_capabilities"> | |
79 <syntax><value>расширение</value> ...</syntax> | |
80 <default>IMAP4 IMAP4rev1 UIDPLUS</default> | |
81 <context>mail</context> | |
82 <context>server</context> | |
83 | |
84 <para> | |
85 Позволяет указать список расширений | |
86 <link url="http://tools.ietf.org/html/rfc3501">протокола IMAP</link>, | |
87 выдаваемый клиенту по команде | |
88 <literal>CAPABILITY</literal>. | |
89 К этому списку автоматически добавляется | |
90 <link url="http://tools.ietf.org/html/rfc2595">STARTTLS</link>, | |
91 если включена директива <link doc="ngx_mail_ssl_module.xml" id="starttls"/>. | |
92 </para> | |
93 | |
94 <para> | |
95 В данной директиве имеет смысл указать расширения, | |
96 поддерживаемые IMAP-бэкендами, | |
97 на которые проксируются клиенты (если эти расширения относятся к командам, | |
98 используемым после авторизации, когда nginx прозрачно проксирует подключение | |
99 клиента на бэкенд). | |
100 </para> | |
101 | |
102 <para> | |
103 Текущий список стандартизованных расширений опубликован на | |
104 <link url="http://www.iana.org/assignments/imap4-capabilities">www.iana.org</link>. | |
105 </para> | |
106 | |
107 </directive> | |
108 | |
109 | |
110 <directive name="imap_client_buffer"> | |
111 <syntax><value>размер</value></syntax> | |
112 <default>4k|8k</default> | |
113 <context>mail</context> | |
114 <context>server</context> | |
115 | |
116 <para> | |
117 Задаёт размер буфера для чтения IMAP-команд. | |
118 По умолчанию размер одного буфера равен размеру страницы. | |
119 В зависимости от платформы это или 4K, или 8K. | |
120 </para> | |
121 | |
122 </directive> | |
123 | |
124 | |
125 <directive name="listen"> | |
126 <syntax> | |
127 <value>адрес</value>:<value>порт</value> | |
128 [<literal>bind</literal>]</syntax> | |
129 <default/> | |
130 <context>server</context> | |
131 | |
132 <para> | |
133 Задаёт <value>адрес</value> и <value>порт</value> сокета, на котором сервер | |
134 будет принимать запросы. | |
135 Можно указать только порт. | |
136 Кроме того, адрес может быть именем сервера, например: | |
137 <example> | |
138 listen 127.0.0.1:110; | |
139 listen *:110; | |
140 listen 110; # то же, что и *:110 | |
141 listen localhost:110; | |
142 </example> | |
143 </para> | |
144 | |
145 <para> | |
146 Необязательный параметр <literal>bind</literal> | |
147 указывает, что для данной пары | |
148 <value>адрес</value>:<value>порт</value> нужно делать | |
149 <c-func>bind</c-func> отдельно. | |
150 Дело в том, что если описаны несколько директив <literal>listen</literal> | |
151 с одинаковым портом, но разными адресами и одна из директив | |
152 <literal>listen</literal> слушает на всех адресах для данного порта | |
153 (<literal>*:</literal><value>порт</value>, то nginx сделает | |
154 <c-func>bind</c-func> только на <literal>*:</literal><value>порт</value>. | |
155 Необходимо заметить, что в этом случае для определения адреса, на которой | |
156 пришло соединение, делается системный вызов <c-func>getsockname</c-func>. | |
157 </para> | |
158 | |
159 <para> | |
160 Разные виртуальные серверы должны слушать на разных парах | |
161 <value>адрес</value>:<value>порт</value>. | |
162 </para> | |
163 | |
164 </directive> | |
165 | |
166 | |
167 <directive name="pop3_auth"> | |
168 <syntax><value>метод</value> ...</syntax> | |
169 <default>plain</default> | |
170 <context>mail</context> | |
171 <context>server</context> | |
172 | |
173 <para> | |
174 Задаёт разрешённые методы аутентификации POP3-клиентов. | |
175 Поддерживаемые методы: | |
176 <list type="tag"> | |
177 | |
178 <tag-name><literal>plain</literal></tag-name> | |
179 <tag-desc> | |
180 <link url="http://tools.ietf.org/html/rfc1939">USER/PASS</link>, | |
181 <link url="http://tools.ietf.org/html/rfc2595">AUTH PLAIN</link>, | |
182 <link url="http://tools.ietf.org/html/draft-murchison-sasl-login-00">AUTH LOGIN</link>. | |
183 Данные методы отключить нельзя. | |
184 </tag-desc> | |
185 | |
186 <tag-name><literal>apop</literal></tag-name> | |
187 <tag-desc> | |
188 <link url="http://tools.ietf.org/html/rfc1939">APOP</link>. | |
189 Для работы этого метода пароль должен храниться в незашифрованном виде. | |
190 </tag-desc> | |
191 | |
192 <tag-name><literal>cram-md5</literal></tag-name> | |
193 <tag-desc> | |
194 <link url="http://tools.ietf.org/html/rfc2195">AUTH CRAM-MD5</link>. | |
195 Для работы этого метода пароль должен храниться в незашифрованном виде. | |
196 </tag-desc> | |
197 | |
198 </list> | |
199 </para> | |
200 | |
201 </directive> | |
202 | |
203 | |
204 <directive name="pop3_capabilities"> | |
205 <syntax><value>расширение</value> ...</syntax> | |
206 <default>TOP USER UIDL</default> | |
207 <context>mail</context> | |
208 <context>server</context> | |
209 | |
210 <para> | |
211 Позволяет указать список расширений | |
212 <link url="http://tools.ietf.org/html/rfc2449">протокола POP3</link>, | |
213 выдаваемый клиенту по команде | |
214 <literal>CAPA</literal>. | |
215 К этому списку автоматически добавляются | |
216 методы авторизации, указанные в директиве <link id="pop3_auth"/> | |
217 (расширение <link url="http://tools.ietf.org/html/rfc2449">SASL</link>) и | |
218 <link url="http://tools.ietf.org/html/rfc2595">STLS</link>, | |
219 если включена директива <link doc="ngx_mail_ssl_module.xml" id="starttls"/>. | |
220 </para> | |
221 | |
222 <para> | |
223 В данной директиве имеет смысл указать расширения, | |
224 поддерживаемые POP3-бэкендами, | |
225 на которые проксируются клиенты (если эти расширения относятся к командам, | |
226 используемым после авторизации, когда nginx прозрачно проксирует подключение | |
227 клиента на бэкенд). | |
228 </para> | |
229 | |
230 <para> | |
231 Текущий список стандартизованных расширений опубликован на | |
232 <link url="http://www.iana.org/assignments/pop3-extension-mechanism">www.iana.org</link>. | |
233 </para> | |
234 | |
235 </directive> | |
236 | |
237 | |
238 <directive name="protocol"> | |
239 <syntax> | |
240 <literal>imap</literal> | | |
241 <literal>pop3</literal> | | |
242 <literal>smtp</literal></syntax> | |
243 <default/> | |
244 <context>server</context> | |
245 | |
246 <para> | |
247 </para> | |
248 | |
249 </directive> | |
250 | |
251 | |
252 <directive name="server"> | |
253 <syntax block="yes"/> | |
254 <default/> | |
255 <context>mail</context> | |
256 | |
257 <para> | |
258 Задаёт конфигурацию для виртуального сервера. | |
259 </para> | |
260 | |
261 </directive> | |
262 | |
263 | |
264 <directive name="server_name"> | |
265 <syntax><value>имя</value></syntax> | |
266 <default>имя хоста</default> | |
267 <context>mail</context> | |
268 <context>server</context> | |
269 | |
270 <para> | |
271 Задаёт имя сервера, используемое: | |
272 | |
273 <list type="bullet"> | |
274 | |
275 <listitem> | |
276 в начальном приветствии POP3/SMTP-сервера; | |
277 </listitem> | |
278 | |
279 <listitem> | |
280 в salt при авторизации SASL-методом CRAM-MD5; | |
281 </listitem> | |
282 | |
283 <listitem> | |
284 в команде <literal>EHLO</literal> при подключении к SMTP-бэкенду, | |
285 если включена команда <link doc="ngx_mail_proxy_module.xml" id="xclient"/>. | |
286 </listitem> | |
287 | |
288 </list> | |
289 | |
290 </para> | |
291 | |
292 </directive> | |
293 | |
294 | |
295 <directive name="smtp_auth"> | |
296 <syntax><value>метод</value> ...</syntax> | |
297 <default>login plain</default> | |
298 <context>mail</context> | |
299 <context>server</context> | |
300 | |
301 <para> | |
302 Задаёт разрешённые методы | |
303 <link url="http://tools.ietf.org/html/rfc2554">SASL-аутентификации</link> | |
304 SMTP-клиентов. | |
305 Поддерживаемые методы: | |
306 <list type="tag"> | |
307 | |
308 <tag-name><literal>login</literal></tag-name> | |
309 <tag-desc> | |
310 <link url="http://tools.ietf.org/html/draft-murchison-sasl-login-00">AUTH LOGIN</link> | |
311 </tag-desc> | |
312 | |
313 <tag-name><literal>plain</literal></tag-name> | |
314 <tag-desc> | |
315 <link url="http://tools.ietf.org/html/rfc2595">AUTH PLAIN</link> | |
316 </tag-desc> | |
317 | |
318 <tag-name><literal>cram-md5</literal></tag-name> | |
319 <tag-desc> | |
320 <link url="http://tools.ietf.org/html/rfc2195">AUTH CRAM-MD5</link>. | |
321 Для работы этого метода пароль должен храниться в незашифрованном виде. | |
322 </tag-desc> | |
323 | |
324 </list> | |
325 </para> | |
326 | |
327 </directive> | |
328 | |
329 | |
330 <directive name="smtp_capabilities"> | |
331 <syntax><value>расширение</value> ...</syntax> | |
332 <default/> | |
333 <context>mail</context> | |
334 <context>server</context> | |
335 | |
336 <para> | |
337 Позволяет указать список расширений протокола SMTP, | |
338 выдаваемый клиенту в ответе на команду | |
339 <literal>EHLO</literal>. | |
340 К этому списку автоматически добавляются | |
341 методы авторизации, указанные в директиве <link id="smtp_auth"/>. | |
342 </para> | |
343 | |
344 <para> | |
345 В данной директиве имеет смысл указать расширения, | |
346 поддерживаемые MTA, | |
347 на который проксируются клиенты (если эти расширения относятся к командам, | |
348 используемым после авторизации, когда nginx прозрачно проксирует подключение | |
349 клиента на бэкенд). | |
350 </para> | |
351 | |
352 <para> | |
353 Текущий список стандартизованных расширений опубликован на | |
354 <link url="http://www.iana.org/assignments/mail-parameters">www.iana.org</link>. | |
355 </para> | |
356 | |
357 </directive> | |
358 | |
359 | |
360 <directive name="so_keepalive"> | |
361 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
362 <default>off</default> | |
363 <context>mail</context> | |
364 <context>server</context> | |
365 | |
366 <para> | |
367 При подключении к IMAP/POP3-бэкенду определяет для сокета поведение | |
368 “TCP keepalive”. | |
369 Если директива не указана, то для сокета будут действовать | |
370 настройки операционной системы. | |
371 Если включено, то для сокета | |
372 включается параметр <c-def>SO_KEEPALIVE</c-def>. | |
373 Если выключено, то для сокета | |
374 параметр <c-def>SO_KEEPALIVE</c-def> выключается. | |
375 </para> | |
376 | |
377 </directive> | |
378 | |
379 | |
380 <directive name="timeout"> | |
381 <syntax><value>время</value></syntax> | |
382 <default>60s</default> | |
383 <context>mail</context> | |
384 <context>server</context> | |
385 | |
386 <para> | |
387 Задаёт таймаут, который используется до начала проксирования на бэкенд. | |
388 </para> | |
389 | |
390 </directive> | |
391 | |
392 </section> | |
393 | |
394 </module> |