Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_userid_module.xml @ 360:43f379b12b76

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
English translation of ngx_http_userid_module.
author Ruslan Ermilov <ru@nginx.com>
date Thu, 26 Jan 2012 19:42:39 +0000
parents
children be54c443235a
comparison
equal deleted inserted replaced
359:f9f8b6e98ada 360:43f379b12b76
1 <?xml version="1.0"?>
2
3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
4
5 <module name="Module ngx_http_userid_module"
6 link="/en/docs/http/ngx_http_userid_module.html"
7 lang="en">
8
9 <section id="summary">
10
11 <para>
12 The <literal>ngx_http_userid_module</literal> module sets cookies
13 suitable for client identification.
14 Received and set cookies can be logged using the embedded variables
15 <var>$uid_got</var> and <var>$uid_set</var>.
16 This module is compatible with the
17 <link url="http://www.lexa.ru/programs/mod-uid-eng.html">mod_uid</link>
18 module for Apache.
19 </para>
20
21 </section>
22
23
24 <section id="example" name="Example Configuration">
25
26 <para>
27 <example>
28 userid on;
29 userid_name uid;
30 userid_domain example.com;
31 userid_path /;
32 userid_expires 365d;
33 userid_p3p 'policyref="/w3c/p3p.xml", CP="CUR ADM OUR NOR STA NID"';
34 </example>
35 </para>
36
37 </section>
38
39
40 <section id="directives" name="Directives">
41
42 <directive name="userid">
43 <syntax>
44 <literal>on</literal> |
45 <literal>v1</literal> |
46 <literal>log</literal> |
47 <literal>off</literal></syntax>
48 <default>off</default>
49 <context>http</context>
50 <context>server</context>
51 <context>location</context>
52
53 <para>
54 Allows or prohibits to set cookies and log the received cookies:
55 <list type="tag">
56
57 <tag-name><literal>on</literal></tag-name>
58 <tag-desc>
59 allows to set version 2 cookies
60 and log the received cookies;
61 </tag-desc>
62
63 <tag-name><literal>v1</literal></tag-name>
64 <tag-desc>
65 allows to set version 1 cookies
66 and log the received cookies;
67 </tag-desc>
68
69 <tag-name><literal>log</literal></tag-name>
70 <tag-desc>
71 prohibits to set cookies
72 but allows to log the received cookies;
73 </tag-desc>
74
75 <tag-name><literal>off</literal></tag-name>
76 <tag-desc>
77 prohibits to set cookies and log the received cookies.
78 </tag-desc>
79
80 </list>
81 </para>
82
83 </directive>
84
85
86 <directive name="userid_domain">
87 <syntax><value>name</value> | <literal>none</literal></syntax>
88 <default>none</default>
89 <context>http</context>
90 <context>server</context>
91 <context>location</context>
92
93 <para>
94 Defines a domain for which the cookie is set.
95 The parameter <literal>none</literal> disables setting a domain for a cookie.
96 </para>
97
98 </directive>
99
100
101 <directive name="userid_expires">
102 <syntax><value>time</value> | <literal>max</literal></syntax>
103 <default/>
104 <context>http</context>
105 <context>server</context>
106 <context>location</context>
107
108 <para>
109 Sets a time during which a browser should keep the cookie.
110 The parameter <literal>max</literal> sets the time to
111 “<literal>31 Dec 2037 23:55:55 GMT</literal>”.
112 This is the maximum time understood by old browsers.
113 </para>
114
115 </directive>
116
117
118 <directive name="userid_name">
119 <syntax><value>name</value></syntax>
120 <default>uid</default>
121 <context>http</context>
122 <context>server</context>
123 <context>location</context>
124
125 <para>
126 Sets a cookie name.
127 </para>
128
129 </directive>
130
131
132 <directive name="userid_p3p">
133 <syntax><value>string</value></syntax>
134 <default/>
135 <context>http</context>
136 <context>server</context>
137 <context>location</context>
138
139 <para>
140 Sets a value for the <header>P3P</header> header field that will be
141 sent along with a cookie.
142 </para>
143
144 </directive>
145
146
147 <directive name="userid_path">
148 <syntax><value>path</value></syntax>
149 <default>/</default>
150 <context>http</context>
151 <context>server</context>
152 <context>location</context>
153
154 <para>
155 Defines a path for which the cookie is set.
156 </para>
157
158 </directive>
159
160
161 <directive name="userid_service">
162 <syntax><value>number</value></syntax>
163 <default>IP address of the server</default>
164 <context>http</context>
165 <context>server</context>
166 <context>location</context>
167
168 <para>
169 Identifies the service that set a cookie.
170 For version 1 cookies the default value is zero.
171 For version 2 cookies the default value is an IP address of the server.
172 </para>
173
174 </directive>
175
176 </section>
177
178 </module>