annotate xml/ru/docs/http/ngx_http_userid_module.xml @ 868:17d0c825f098

Revised the userid module documentation. - added the "embedded variables" section; - documented the "$uid_reset" variable; - documented default parameters of "userid_expires", "userid_mark" and "userid_p3p" directives; - improved descriptions of "userid_mark" and "userid_service" directives.
author Homutov Vladimir <vl@nginx.com>
date Mon, 18 Mar 2013 13:59:13 +0400
parents 2ff9c3ea8c98
children 95c3c3bbf1ce
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
222
bfe3eff81d04 Removed redundant encoding specification.
Ruslan Ermilov <ru@nginx.com>
parents: 110
diff changeset
1 <?xml version="1.0"?>
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
2
580
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 412
diff changeset
3 <!--
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 412
diff changeset
4 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 412
diff changeset
5 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 412
diff changeset
6 -->
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 412
diff changeset
7
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
9
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
10 <module name="Модуль ngx_http_userid_module"
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
11 link="/ru/docs/http/ngx_http_userid_module.html"
589
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
12 lang="ru"
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
13 rev="3">
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
14
110
40eec261c2a6 Added proper support for anonymous sections, notably for the summary.
Ruslan Ermilov <ru@nginx.com>
parents: 102
diff changeset
15 <section id="summary">
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
16
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
17 <para>
359
f9f8b6e98ada Translated "cookie" and clarified what the $uid_got and $uid_set are.
Ruslan Ermilov <ru@nginx.com>
parents: 358
diff changeset
18 Модуль <literal>ngx_http_userid_module</literal> выдаёт куки
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
19 для идентификации клиентов.
412
d85b74249e04 Use a declinable variant for "cookie".
Ruslan Ermilov <ru@nginx.com>
parents: 359
diff changeset
20 Для записи в лог полученных и выданных кук можно использовать встроенные
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
21 переменные <link id="var_uid_got">$uid_got</link> и
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
22 <link id="var_uid_set">$uid_set</link>.
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
23 Модуль совместим с модулем
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
24 <link url="http://www.lexa.ru/programs/mod-uid.html">mod_uid</link>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
25 для Apache.
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
26 </para>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
27
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
28 </section>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
29
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
30
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
31 <section id="example" name="Пример конфигурации">
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
32
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
33 <para>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
34 <example>
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
35 userid on;
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
36 userid_name uid;
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
37 userid_domain example.com;
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
38 userid_path /;
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
39 userid_expires 365d;
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
40 userid_p3p 'policyref="/w3c/p3p.xml", CP="CUR ADM OUR NOR STA NID"';
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
41 </example>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
42 </para>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
43
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
44 </section>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
45
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
46
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
47 <section id="directives" name="Директивы">
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
48
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
49 <directive name="userid">
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 222
diff changeset
50 <syntax>
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
51 <literal>on</literal> |
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
52 <literal>v1</literal> |
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
53 <literal>log</literal> |
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
54 <literal>off</literal></syntax>
102
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents: 99
diff changeset
55 <default>off</default>
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
56 <context>http</context>
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
57 <context>server</context>
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
58 <context>location</context>
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
59
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
60 <para>
412
d85b74249e04 Use a declinable variant for "cookie".
Ruslan Ermilov <ru@nginx.com>
parents: 359
diff changeset
61 Разрешает или запрещает выдачу кук и запись приходящих кук в лог:
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
62 <list type="tag">
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
63
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
64 <tag-name><literal>on</literal></tag-name>
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
65 <tag-desc>
412
d85b74249e04 Use a declinable variant for "cookie".
Ruslan Ermilov <ru@nginx.com>
parents: 359
diff changeset
66 разрешает выдачу кук версии 2
d85b74249e04 Use a declinable variant for "cookie".
Ruslan Ermilov <ru@nginx.com>
parents: 359
diff changeset
67 и запись приходящих кук в лог;
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
68 </tag-desc>
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
69
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
70 <tag-name><literal>v1</literal></tag-name>
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
71 <tag-desc>
412
d85b74249e04 Use a declinable variant for "cookie".
Ruslan Ermilov <ru@nginx.com>
parents: 359
diff changeset
72 разрешает выдачу кук версии 1
d85b74249e04 Use a declinable variant for "cookie".
Ruslan Ermilov <ru@nginx.com>
parents: 359
diff changeset
73 и запись приходящих кук в лог;
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
74 </tag-desc>
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
75
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
76 <tag-name><literal>log</literal></tag-name>
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
77 <tag-desc>
412
d85b74249e04 Use a declinable variant for "cookie".
Ruslan Ermilov <ru@nginx.com>
parents: 359
diff changeset
78 запрещает выдачу кук,
d85b74249e04 Use a declinable variant for "cookie".
Ruslan Ermilov <ru@nginx.com>
parents: 359
diff changeset
79 но разрешает запись приходящих кук в лог;
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
80 </tag-desc>
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
81
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
82 <tag-name><literal>off</literal></tag-name>
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
83 <tag-desc>
412
d85b74249e04 Use a declinable variant for "cookie".
Ruslan Ermilov <ru@nginx.com>
parents: 359
diff changeset
84 запрещает выдачу кук и запись приходящих кук в лог.
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
85 </tag-desc>
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
86
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
87 </list>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
88 </para>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
89
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
90 </directive>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
91
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
92
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
93 <directive name="userid_domain">
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 222
diff changeset
94 <syntax><value>имя</value> | <literal>none</literal></syntax>
102
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents: 99
diff changeset
95 <default>none</default>
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
96 <context>http</context>
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
97 <context>server</context>
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
98 <context>location</context>
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
99
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
100 <para>
412
d85b74249e04 Use a declinable variant for "cookie".
Ruslan Ermilov <ru@nginx.com>
parents: 359
diff changeset
101 Задаёт домен, для которого устанавливается кука.
359
f9f8b6e98ada Translated "cookie" and clarified what the $uid_got and $uid_set are.
Ruslan Ermilov <ru@nginx.com>
parents: 358
diff changeset
102 Параметр <literal>none</literal> запрещает выдавать домен для куки.
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
103 </para>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
104
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
105 </directive>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
106
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
107
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
108 <directive name="userid_expires">
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
109 <syntax><value>время</value> | <literal>max</literal> |
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
110 <literal>off</literal></syntax>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
111 <default>off</default>
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
112 <context>http</context>
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
113 <context>server</context>
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
114 <context>location</context>
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
115
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
116 <para>
412
d85b74249e04 Use a declinable variant for "cookie".
Ruslan Ermilov <ru@nginx.com>
parents: 359
diff changeset
117 Задаёт время, в течение которого браузер должен хранить куку.
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
118 Параметр <literal>max</literal> устанавливает срок хранения куки до
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
119 31 декабря 2037 года 23:55:55 GMT.
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
120 Это максимальное время, которое понимают старые браузеры.
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
121 Указание параметра <literal>off</literal> позволяет ограничить время
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
122 действия куки сессией браузера.
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
123 </para>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
124
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
125 </directive>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
126
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
127
684
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
128 <directive name="userid_mark">
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
129 <syntax>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
130 <value>буква</value> | <value>цифра</value> |
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
131 <literal>=</literal> |
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
132 <literal>off</literal></syntax>
684
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
133 <default>off</default>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
134 <context>http</context>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
135 <context>server</context>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
136 <context>location</context>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
137
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
138 <para>
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
139 Если параметр не <literal>off</literal>, включает механизм маркировки кук
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
140 и задаёт символ, используемый в качестве метки.
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
141 Этот механизм позволяет добавить или изменить
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
142 <link id="userid_p3p"/> и/или время хранения куки, но при этом оставить
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
143 неизменным идентификатор клиента.
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
144 Меткой может быть любая буква английского алфавита (с учётом регистра),
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
145 цифра или знак “<literal>=</literal>”.
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
146 </para>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
147
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
148 <para>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
149 Если метка задана, то она сравнивается с первым дополняющим символом
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
150 в base64 представлении идентификатора клиента, передаваемом в куке.
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
151 Если они не совпадают, то кука перепосылается с заданной меткой,
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
152 временем хранения и заголовком <header>P3P</header>.
684
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
153 </para>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
154
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
155 </directive>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
156
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
157
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
158 <directive name="userid_name">
102
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents: 99
diff changeset
159 <syntax><value>имя</value></syntax>
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents: 99
diff changeset
160 <default>uid</default>
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
161 <context>http</context>
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
162 <context>server</context>
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
163 <context>location</context>
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
164
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
165 <para>
359
f9f8b6e98ada Translated "cookie" and clarified what the $uid_got and $uid_set are.
Ruslan Ermilov <ru@nginx.com>
parents: 358
diff changeset
166 Задаёт имя куки.
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
167 </para>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
168
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
169 </directive>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
170
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
171
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
172 <directive name="userid_p3p">
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
173 <syntax><value>строка</value> | <literal>none</literal></syntax>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
174 <default>none</default>
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
175 <context>http</context>
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
176 <context>server</context>
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
177 <context>location</context>
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
178
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
179 <para>
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
180 Задаёт значение для поля заголовка <header>P3P</header>, которое будет
412
d85b74249e04 Use a declinable variant for "cookie".
Ruslan Ermilov <ru@nginx.com>
parents: 359
diff changeset
181 выдаваться вместе с кукой.
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
182 Если задано специальное значение <literal>none</literal>,
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
183 то в ответе не будет заголовка <header>P3P</header>.
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
184 </para>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
185
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
186 </directive>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
187
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
188
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
189 <directive name="userid_path">
102
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents: 99
diff changeset
190 <syntax><value>путь</value></syntax>
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents: 99
diff changeset
191 <default>/</default>
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
192 <context>http</context>
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
193 <context>server</context>
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
194 <context>location</context>
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
195
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
196 <para>
412
d85b74249e04 Use a declinable variant for "cookie".
Ruslan Ermilov <ru@nginx.com>
parents: 359
diff changeset
197 Задаёт путь, для которого устанавливается кука.
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
198 </para>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
199
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
200 </directive>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
201
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
202
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
203 <directive name="userid_service">
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
204 <syntax><value>номер</value></syntax>
102
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents: 99
diff changeset
205 <default>IP-адрес сервера</default>
358
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
206 <context>http</context>
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
207 <context>server</context>
b8eb62f8c9ba Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 285
diff changeset
208 <context>location</context>
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
209
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
210 <para>
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
211 Если идентификаторы выдаются несколькими серверами (сервисами),
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
212 то каждому сервису следует назначить свой собственный <value>номер</value>,
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
213 для обеспечения уникальности выдаваемых идентификаторов клиентов.
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
214 По умолчанию для кук первой версии используется ноль.
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
215 Для кук второй версии это число, составленное из последних четырёх
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
216 октетов IP-адреса сервера.
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
217 </para>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
218
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
219 </directive>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
220
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
221 </section>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
222
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
223
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
224 <section id="variables" name="Встроенные переменные">
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
225
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
226 <para>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
227 Модуль <literal>ngx_http_userid_module</literal>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
228 поддерживает следующие встроенные переменные:
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
229 <list type="tag">
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
230
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
231 <tag-name id="var_uid_got"><var>$uid_got</var></tag-name>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
232 <tag-desc>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
233 Имя куки и полученный идентификатор клиента.
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
234 </tag-desc>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
235
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
236 <tag-name id="var_uid_reset"><var>$uid_reset</var></tag-name>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
237 <tag-desc>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
238 Если значением является непустая строка не равная “<literal>0</literal>”,
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
239 то клиентские идентификаторы перевыдаются.
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
240 Специальное значение “<literal>log</literal>” дополнительно приводит к выдаче
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
241 сообщений о перевыданных идентификаторах в
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
242 <link doc="../ngx_core_module.xml" id="error_log"/>.
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
243 </tag-desc>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
244
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
245 <tag-name id="var_uid_set"><var>$uid_set</var></tag-name>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
246 <tag-desc>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
247 Имя куки и выданный идентификатор клиента.
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
248 </tag-desc>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
249
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
250 </list>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
251 </para>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
252
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
253 </section>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
254
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
255 </module>