Mercurial > hg > nginx-site

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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_userid_module"
6 link="/ru/docs/http/ngx_http_userid_module.html"
7 lang="ru">
8
9 <section name="" id="summary">
10
11 <para>
12 Модуль ngx_http_userid_module выдаёт сookies для идентификации клиентов.
13 Для записи в лог можно использовать переменные $uid_got и $uid_set.
14 Модуль совместим с модулем
15 <link url="http://www.lexa.ru/programs/mod-uid.html">mod_uid</link>
16 для Apache.
17 </para>
18
19 </section>
20
21
22 <section name="Пример конфигурации" id="example">
23
24 <para>
25 <example>
26 userid on;
27 userid_name uid;
28 userid_domain example.com;
29 userid_path /;
30 userid_expires 365d;
31 userid_p3p 'policyref="/w3c/p3p.xml", CP="CUR ADM OUR NOR STA NID"';
32 </example>
33 </para>
34
35 </section>
36
37
38 <section name="Директивы" id="directives">
39
40 <directive name="userid">
41 <syntax>userid <value>[on|v1|log||off]</value></syntax>
42 <default>userid off</default>
43 <context>http, server, location</context>
44
45 <para>
46 Разрешает или запрещает выдавать cookie и записывать приходящие cookie в лог:
47 <list type="bullet">
48
49 <listitem>
50 on — разрешает выдавать сookie версии 2
51 и записывать приходящие cookie в лог;
52 </listitem>
53
54 <listitem>
55 v1 — разрешает выдавать сookie версии 1
56 и записывать приходящие cookie в лог;
57 </listitem>
58
59 <listitem>
60 log — запрещает выдавать cookie,
61 но разрешает записывать приходящие cookie в лог;
62 </listitem>
63
64 <listitem>
65 off — запрещает выдавать cookie и записывать приходящие cookie в лог;
66 </listitem>
67
68 </list>
69 </para>
70
71 </directive>
72
73
74 <directive name="userid_domain">
75 <syntax>userid_domain <value>[имя|none]</value></syntax>
76 <default>userid_domain none</default>
77 <context>http, server, location</context>
78
79 <para>
80 Директива задаёт домен, для которого устанавливается cookie.
81 Параметр "none" запрещает выдавать домен для cookie.
82 </para>
83
84 </directive>
85
86
87 <directive name="userid_expires">
88 <syntax>userid_expires <value>[время|max]</value></syntax>
89 <default>нет</default>
90 <context>http, server, location</context>
91
92 <para>
93 Директива задаёт время, в течение которого браузер должен хранить cookie.
94 Параметр "max" задаёт время 31 декабря 2037 года 23:55:55 GMT.
95 Это максимальное время, которое понимают старые браузеры.
96 </para>
97
98 </directive>
99
100
101 <directive name="userid_name">
102 <syntax>userid_name <value>имя</value></syntax>
103 <default>userid_name uid</default>
104 <context>http, server, location</context>
105
106 <para>
107 Директива задаёт имя cookie.
108 </para>
109
110 </directive>
111
112
113 <directive name="userid_p3p">
114 <syntax>userid_p3p <value>строка</value></syntax>
115 <default>нет</default>
116 <context>http, server, location</context>
117
118 <para>
119 Директива задаёт значение для строки заголовка P3P, который будет
120 выдваться вместе с cookie.
121 </para>
122
123 </directive>
124
125
126 <directive name="userid_path">
127 <syntax>userid_path <value>путь</value></syntax>
128 <default>userid_path /</default>
129 <context>http, server, location</context>
130
131 <para>
132 Директива задаёт путь, для которого устанавливается cookie.
133 </para>
134
135 </directive>
136
137
138 <directive name="userid_service">
139 <syntax>userid_service <value>число</value></syntax>
140 <default>userid_service IP-адрес сервера</default>
141 <context>http, server, location</context>
142
143 <para>
144 Директива задаёт номер сервиса, выдавшего cookie.
145 По умолчанию для cookie первой версии используется ноль,
146 а для второй — IP-адрес сервера.
147 </para>
148
149 </directive>
150
151 </section>
152
153 </module>