Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_userid_module.xml @ 966:95c3c3bbf1ce

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Text review.
author Egor Nikitin <yegor.nikitin@gmail.com>
date Wed, 14 Aug 2013 12:03:41 +0400
parents 17d0c825f098
children b0e56cc57867
comparison
equal deleted inserted replaced
965:fadccc156188 966:95c3c3bbf1ce
56 <context>http</context> 56 <context>http</context>
57 <context>server</context> 57 <context>server</context>
58 <context>location</context> 58 <context>location</context>
59 59
60 <para> 60 <para>
61 Allows or prohibits to set cookies and log the received cookies: 61 Enables or disables setting cookies and logging the received cookies:
62 <list type="tag"> 62 <list type="tag">
63 63
64 <tag-name><literal>on</literal></tag-name> 64 <tag-name><literal>on</literal></tag-name>
65 <tag-desc> 65 <tag-desc>
66 allows to set version 2 cookies 66 enables the setting of version 2 cookies
67 and log the received cookies; 67 and logging of the received cookies;
68 </tag-desc> 68 </tag-desc>
69 69
70 <tag-name><literal>v1</literal></tag-name> 70 <tag-name><literal>v1</literal></tag-name>
71 <tag-desc> 71 <tag-desc>
72 allows to set version 1 cookies 72 enables the setting of version 1 cookies
73 and log the received cookies; 73 and logging of the received cookies;
74 </tag-desc> 74 </tag-desc>
75 75
76 <tag-name><literal>log</literal></tag-name> 76 <tag-name><literal>log</literal></tag-name>
77 <tag-desc> 77 <tag-desc>
78 prohibits to set cookies 78 disables the setting of cookies,
79 but allows to log the received cookies; 79 but enables logging of the received cookies;
80 </tag-desc> 80 </tag-desc>
81 81
82 <tag-name><literal>off</literal></tag-name> 82 <tag-name><literal>off</literal></tag-name>
83 <tag-desc> 83 <tag-desc>
84 prohibits to set cookies and log the received cookies. 84 disables the setting of cookies and logging of the received cookies.
85 </tag-desc> 85 </tag-desc>
86 86
87 </list> 87 </list>
88 </para> 88 </para>
89 89
97 <context>server</context> 97 <context>server</context>
98 <context>location</context> 98 <context>location</context>
99 99
100 <para> 100 <para>
101 Defines a domain for which the cookie is set. 101 Defines a domain for which the cookie is set.
102 The parameter <literal>none</literal> disables setting a domain for a cookie. 102 The <literal>none</literal> parameter disables setting of a domain for the
103 cookie.
103 </para> 104 </para>
104 105
105 </directive> 106 </directive>
106 107
107 108
134 <context>http</context> 135 <context>http</context>
135 <context>server</context> 136 <context>server</context>
136 <context>location</context> 137 <context>location</context>
137 138
138 <para> 139 <para>
139 If parameter is not <literal>off</literal>, enables the cookie marking 140 If the parameter is not <literal>off</literal>, enables the cookie marking
140 mechanism and sets a character used as a mark. 141 mechanism and sets the character used as a mark.
141 This mechanism allows to add or change 142 This mechanism is used to add or change
142 <link id="userid_p3p"/> and/or cookie expiration time while 143 <link id="userid_p3p"/> and/or a cookie expiration time while
143 preserving the client identifier. 144 preserving the client identifier.
144 The mark can be any letter of the English alphabet (case-sensitive), 145 A mark can be any letter of the English alphabet (case-sensitive),
145 digit, or the “<literal>=</literal>” character. 146 digit, or the “<literal>=</literal>” character.
146 </para> 147 </para>
147 148
148 <para> 149 <para>
149 If a mark is set, it is compared with the first padding symbol 150 If the mark is set, it is compared with the first padding symbol
150 in the base64 representation of client identifier passed in a cookie. 151 in the base64 representation of the client identifier passed in a cookie.
151 If they do not match, a cookie is resent with the specified mark, 152 If they do not match, the cookie is resent with the specified mark,
152 expiration time and a <header>P3P</header> header. 153 expiration time, and <header>P3P</header> header.
153 </para> 154 </para>
154 155
155 </directive> 156 </directive>
156 157
157 158
161 <context>http</context> 162 <context>http</context>
162 <context>server</context> 163 <context>server</context>
163 <context>location</context> 164 <context>location</context>
164 165
165 <para> 166 <para>
166 Sets a cookie name. 167 Sets the cookie name.
167 </para> 168 </para>
168 169
169 </directive> 170 </directive>
170 171
171 172
176 <context>server</context> 177 <context>server</context>
177 <context>location</context> 178 <context>location</context>
178 179
179 <para> 180 <para>
180 Sets a value for the <header>P3P</header> header field that will be 181 Sets a value for the <header>P3P</header> header field that will be
181 sent along with a cookie. 182 sent along with the cookie.
182 If set to the special value <literal>none</literal>, 183 If the directive is set to the special value <literal>none</literal>,
183 the <header>P3P</header> header will not be sent in a response. 184 the <header>P3P</header> header will not be sent in a response.
184 </para> 185 </para>
185 186
186 </directive> 187 </directive>
187 188
208 <context>location</context> 209 <context>location</context>
209 210
210 <para> 211 <para>
211 If identifiers are issued by multiple servers (services), 212 If identifiers are issued by multiple servers (services),
212 each service should be assigned its own <value>number</value> 213 each service should be assigned its own <value>number</value>
213 in order to ensure that client identifiers are unique. 214 to ensure that client identifiers are unique.
214 For version 1 cookies the default value is zero. 215 For version 1 cookies, the default value is zero.
215 For version 2 cookies this is the number composed from the last four 216 For version 2 cookies, the default value is the number composed from the last
216 octets of the server’s IP address. 217 four octets of the server’s IP address.
217 </para> 218 </para>
218 219
219 </directive> 220 </directive>
220 221
221 </section> 222 </section>
233 The cookie name and received client identifier. 234 The cookie name and received client identifier.
234 </tag-desc> 235 </tag-desc>
235 236
236 <tag-name id="var_uid_reset"><var>$uid_reset</var></tag-name> 237 <tag-name id="var_uid_reset"><var>$uid_reset</var></tag-name>
237 <tag-desc> 238 <tag-desc>
238 If set to a non-empty string, and it is not “<literal>0</literal>”, 239 If the variable is set to a non-empty string that is not “<literal>0</literal>”,
239 client identifiers are reset. 240 the client identifiers are reset.
240 The special value “<literal>log</literal>” additionally leads to the output of 241 The special value “<literal>log</literal>” additionally leads to the output of
241 messages about reset identifiers to the 242 messages about the reset identifiers to the
242 <link doc="../ngx_core_module.xml" id="error_log"/>. 243 <link doc="../ngx_core_module.xml" id="error_log"/>.
243 </tag-desc> 244 </tag-desc>
244 245
245 <tag-name id="var_uid_set"><var>$uid_set</var></tag-name> 246 <tag-name id="var_uid_set"><var>$uid_set</var></tag-name>
246 <tag-desc> 247 <tag-desc>