comparison xml/ru/docs/http/ngx_http_auth_basic_module.xml @ 76:4a4caa566120

Russian documentation import. Changes in module.dtd: <example> now allowed to contain <value> and <emphasis> elements (we need this to show important parts in examples), less strict checking of <directive> syntax (we don't want to fully document some directives, notably deprecated ones). Known issues: 1. <syntax> elements are preserved as is, they will require manual conversion (likely to some not-yet-existed format a la DocBook cmdsynopsis, as currently used one seems to be incomplete); 2. <value> no longer corresponds to replaceable content, and it's use in examples isn't correct; 3. <link doc="document#fragment"> doesn't work with current xslt, either should be supported or changed to <link doc="document" id="fragment">. The following files are intentionally omitted: maillists.xml (support.xml should be used instead), experimental.xml (obsolete), faq.xml (conflicts with existing one, needs discussion). Not yet linked to site.
author Maxim Dounin <mdounin@mdounin.ru>
date Tue, 11 Oct 2011 12:57:50 +0000
parents
children 1d315ef37215
comparison
equal deleted inserted replaced
75:2bf4cd2787c5 76:4a4caa566120
1 <?xml version="1.0" encoding="utf-8"?>
2
3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
4
5 <module name="Директивы модуля ngx_http_auth_basic_module"
6 link="/ru/docs/http/ngx_http_auth_basic_module.html"
7 lang="ru">
8
9 <section name="" id="summary">
10
11 <para>
12 Модуль ngx_http_auth_basic_module позволяет закрыть доступ с проверкой
13 имени и пароля по протоколу HTTP Basic Authentication.
14 </para>
15
16 </section>
17
18
19 <section name="Пример конфигурации" id="example">
20
21 <para>
22 <example>
23 location / {
24 auth_basic "closed site";
25 auth_basic_user_file conf/htpasswd;
26 }
27 </example>
28 </para>
29
30 </section>
31
32
33 <section name="Директивы" id="directives">
34
35 <directive name="auth_basic">
36 <syntax>auth_basic <value>[строка|off]</value></syntax>
37 <default>auth_basic off</default>
38 <context>http, server, location, limit_except</context>
39
40 <para>
41 Директива включает проверку имени и пароля по протоколу
42 HTTP Basic Authentication.
43 Заданный параметр используется в качестве realm.
44 Параметр "off" позволяет отменить действие унаследованной с нижележащего
45 уровня директивы.
46 </para>
47
48 </directive>
49
50
51 <directive name="auth_basic_user_file">
52 <syntax>auth_basic_user_file <value>файл</value></syntax>
53 <default>нет</default>
54 <context>http, server, location, limit_except</context>
55
56 <para>
57 Директива задаёт файл, в котором хранятся имена и пароли
58 пользователей. Формат файла следующий:
59 <example>
60 # комментарий
61 имя1:пароль1
62 имя2:пароль2:комментарий
63 имя3:пароль3
64 </example>
65 </para>
66
67 <para>
68 Пароли должны быть зашифрованы функцией crypt(3).
69 Для создания файла с паролями можно воспользоваться программой
70 <command>htpasswd</command> из дистрибутива Apache.
71 </para>
72
73 </directive>
74
75 </section>
76
77 </module>