Mercurial > hg > nginx-site

comparison xml/ru/docs/http/ngx_http_userid_module.xml @ 358:b8eb62f8c9ba

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