annotate xml/en/docs/http/ngx_http_userid_module.xml @ 840:9dab69f2b71d

Documented nginx 1.2.7 changes. - variables support in the "auth_basic" directive; - new generic variables $pipe, $request_length, $time_iso8601, and $time_local; - IPv6 support in ngx_http_geo_module and ngx_http_geoip_module; - "gzip" and "flush" parameters of the "access_log" directive.
author Ruslan Ermilov <ru@nginx.com>
date Tue, 12 Feb 2013 16:45:45 +0400
parents 2ff9c3ea8c98
children 17d0c825f098
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
2
580
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 360
diff changeset
3 <!--
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 360
diff changeset
4 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 360
diff changeset
5 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 360
diff changeset
6 -->
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 360
diff changeset
7
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
9
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
10 <module name="Module ngx_http_userid_module"
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 link="/en/docs/http/ngx_http_userid_module.html"
589
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
12 lang="en"
684
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
13 rev="2">
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15 <section id="summary">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
17 <para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
18 The <literal>ngx_http_userid_module</literal> module sets cookies
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
19 suitable for client identification.
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20 Received and set cookies can be logged using the embedded variables
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
21 <var>$uid_got</var> and <var>$uid_set</var>.
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22 This module is compatible with the
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
23 <link url="http://www.lexa.ru/programs/mod-uid-eng.html">mod_uid</link>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24 module for Apache.
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25 </para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27 </section>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30 <section id="example" name="Example Configuration">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32 <para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33 <example>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34 userid on;
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35 userid_name uid;
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
36 userid_domain example.com;
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
37 userid_path /;
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38 userid_expires 365d;
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39 userid_p3p 'policyref="/w3c/p3p.xml", CP="CUR ADM OUR NOR STA NID"';
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
40 </example>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
41 </para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43 </section>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46 <section id="directives" name="Directives">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48 <directive name="userid">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49 <syntax>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50 <literal>on</literal> |
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
51 <literal>v1</literal> |
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
52 <literal>log</literal> |
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53 <literal>off</literal></syntax>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
54 <default>off</default>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55 <context>http</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56 <context>server</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57 <context>location</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
59 <para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60 Allows or prohibits to set cookies and log the received cookies:
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61 <list type="tag">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
63 <tag-name><literal>on</literal></tag-name>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64 <tag-desc>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
65 allows to set version 2 cookies
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
66 and log the received cookies;
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
67 </tag-desc>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
68
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
69 <tag-name><literal>v1</literal></tag-name>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70 <tag-desc>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
71 allows to set version 1 cookies
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
72 and log the received cookies;
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
73 </tag-desc>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
75 <tag-name><literal>log</literal></tag-name>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
76 <tag-desc>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
77 prohibits to set cookies
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
78 but allows to log the received cookies;
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
79 </tag-desc>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81 <tag-name><literal>off</literal></tag-name>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
82 <tag-desc>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
83 prohibits to set cookies and log the received cookies.
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
84 </tag-desc>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
85
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
86 </list>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
87 </para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89 </directive>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
91
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92 <directive name="userid_domain">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
93 <syntax><value>name</value> | <literal>none</literal></syntax>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94 <default>none</default>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95 <context>http</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96 <context>server</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
97 <context>location</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
98
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
99 <para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
100 Defines a domain for which the cookie is set.
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
101 The parameter <literal>none</literal> disables setting a domain for a cookie.
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
102 </para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
103
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
104 </directive>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
105
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
106
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
107 <directive name="userid_expires">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
108 <syntax><value>time</value> | <literal>max</literal></syntax>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
109 <default/>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
110 <context>http</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
111 <context>server</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
112 <context>location</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
113
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
114 <para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
115 Sets a time during which a browser should keep the cookie.
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
116 The parameter <literal>max</literal> sets the time to
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117 “<literal>31 Dec 2037 23:55:55 GMT</literal>”.
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
118 This is the maximum time understood by old browsers.
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
119 </para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
121 </directive>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
122
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123
684
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
124 <directive name="userid_mark">
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
125 <syntax><value>off | letter | digit | =</value></syntax>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
126 <default>off</default>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
127 <context>http</context>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
128 <context>server</context>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
129 <context>location</context>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
130
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
131 <para>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
132 Sets the first symbol of the cookie’s representation base64 tail
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
133 (“<literal>==</literal>” by default) and resets all accepted cookies
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
134 with another tail.
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
135 It may be useful if it's required to add or change the P3P or the cookie expire
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
136 time and leave the internally encoded value unchanged.
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
137 </para>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
138
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
139 </directive>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
140
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
141
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
142 <directive name="userid_name">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
143 <syntax><value>name</value></syntax>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
144 <default>uid</default>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
145 <context>http</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
146 <context>server</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
147 <context>location</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
148
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
149 <para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
150 Sets a cookie name.
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
151 </para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
152
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
153 </directive>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
154
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
155
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
156 <directive name="userid_p3p">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
157 <syntax><value>string</value></syntax>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
158 <default/>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
159 <context>http</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
160 <context>server</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
161 <context>location</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
162
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
163 <para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
164 Sets a value for the <header>P3P</header> header field that will be
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
165 sent along with a cookie.
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
166 </para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
167
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
168 </directive>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
169
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
170
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
171 <directive name="userid_path">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
172 <syntax><value>path</value></syntax>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
173 <default>/</default>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
174 <context>http</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
175 <context>server</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
176 <context>location</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
177
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
178 <para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
179 Defines a path for which the cookie is set.
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
180 </para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
181
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
182 </directive>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
183
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
184
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
185 <directive name="userid_service">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
186 <syntax><value>number</value></syntax>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
187 <default>IP address of the server</default>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
188 <context>http</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
189 <context>server</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
190 <context>location</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
191
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
192 <para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
193 Identifies the service that set a cookie.
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
194 For version 1 cookies the default value is zero.
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
195 For version 2 cookies the default value is an IP address of the server.
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
196 </para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
197
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
198 </directive>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
199
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
200 </section>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
201
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
202 </module>