Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_userid_module.xml @ 2597:c9545c331582

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added the userid_flags directive.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 29 Sep 2020 15:52:05 +0100
parents 726e8f47763c
children
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"
2597
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
13 rev="5">
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
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> and
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
22 <link id="var_uid_set">$uid_set</link>.
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
23 This module is compatible with the
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24 <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
25 module for Apache.
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26 </para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28 </section>
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
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31 <section id="example" name="Example Configuration">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33 <para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34 <example>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35 userid on;
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
36 userid_name uid;
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
37 userid_domain example.com;
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38 userid_path /;
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39 userid_expires 365d;
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
40 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
41 </example>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42 </para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44 </section>
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
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47 <section id="directives" name="Directives">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49 <directive name="userid">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50 <syntax>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
51 <literal>on</literal> |
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
52 <literal>v1</literal> |
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53 <literal>log</literal> |
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
54 <literal>off</literal></syntax>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55 <default>off</default>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56 <context>http</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57 <context>server</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58 <context>location</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
59
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
61 Enables or disables setting cookies and logging the received cookies:
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62 <list type="tag">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
63
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64 <tag-name><literal>on</literal></tag-name>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
65 <tag-desc>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
66 enables the setting of version 2 cookies
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
67 and logging of the received cookies;
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
68 </tag-desc>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
69
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70 <tag-name><literal>v1</literal></tag-name>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
71 <tag-desc>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
72 enables the setting of version 1 cookies
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
73 and logging of the received cookies;
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74 </tag-desc>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
75
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
76 <tag-name><literal>log</literal></tag-name>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
77 <tag-desc>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
78 disables the setting of cookies,
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
79 but enables logging of the received cookies;
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80 </tag-desc>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
82 <tag-name><literal>off</literal></tag-name>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
83 <tag-desc>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
84 disables the setting of cookies and logging of the received cookies.
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
85 </tag-desc>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
86
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
87 </list>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88 </para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 </directive>
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
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
93 <directive name="userid_domain">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94 <syntax><value>name</value> | <literal>none</literal></syntax>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95 <default>none</default>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96 <context>http</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
97 <context>server</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
98 <context>location</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
99
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
100 <para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
101 Defines a domain for which the cookie is set.
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
102 The <literal>none</literal> parameter disables setting of a domain for the
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
103 cookie.
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
104 </para>
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 </directive>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
107
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
108
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
109 <directive name="userid_expires">
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
110 <syntax><value>time</value> | <literal>max</literal> |
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
111 <literal>off</literal></syntax>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
112 <default>off</default>
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
113 <context>http</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
114 <context>server</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
115 <context>location</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
116
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117 <para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
118 Sets a time during which a browser should keep the cookie.
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
119 The parameter <literal>max</literal> will cause the cookie to expire on
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120 “<literal>31 Dec 2037 23:55:55 GMT</literal>”.
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
121 The parameter <literal>off</literal> will cause the cookie to expire at
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
122 the end of a browser session.
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123 </para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
125 </directive>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
126
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
127
2597
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
128 <directive name="userid_flags">
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
129 <syntax>
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
130 <literal>off</literal> |
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
131 <value>flag</value> ...</syntax>
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
132 <default>off</default>
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
133 <context>http</context>
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
134 <context>server</context>
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
135 <context>location</context>
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
136 <appeared-in>1.19.3</appeared-in>
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
137
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
138 <para>
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
139 If the parameter is not <literal>off</literal>,
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
140 defines one or more additional flags for the cookie:
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
141 <literal>secure</literal>,
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
142 <literal>httponly</literal>,
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
143 <literal>samesite=strict</literal>,
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
144 <literal>samesite=lax</literal>,
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
145 <literal>samesite=none</literal>.
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
146 </para>
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
147
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
148 </directive>
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
149
c9545c331582 Added the userid_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1233
diff changeset
150
684
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
151 <directive name="userid_mark">
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
152 <syntax>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
153 <value>letter</value> | <value>digit</value> |
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
154 <literal>=</literal> |
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
155 <literal>off</literal></syntax>
684
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
156 <default>off</default>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
157 <context>http</context>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
158 <context>server</context>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
159 <context>location</context>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
160
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
161 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
162 If the parameter is not <literal>off</literal>, enables the cookie marking
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
163 mechanism and sets the character used as a mark.
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
164 This mechanism is used to add or change
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
165 <link id="userid_p3p"/> and/or a cookie expiration time while
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
166 preserving the client identifier.
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
167 A mark can be any letter of the English alphabet (case-sensitive),
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
168 digit, or the “<literal>=</literal>” character.
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
169 </para>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
170
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
171 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
172 If the mark is set, it is compared with the first padding symbol
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
173 in the base64 representation of the client identifier passed in a cookie.
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
174 If they do not match, the cookie is resent with the specified mark,
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
175 expiration time, and <header>P3P</header> header.
684
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
176 </para>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
177
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
178 </directive>
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
179
2ff9c3ea8c98 Documented the userid_mark directive in the userid module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
180
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
181 <directive name="userid_name">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
182 <syntax><value>name</value></syntax>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
183 <default>uid</default>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
184 <context>http</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
185 <context>server</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
186 <context>location</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
187
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
188 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
189 Sets the cookie name.
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
190 </para>
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 </directive>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
193
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
194
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
195 <directive name="userid_p3p">
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
196 <syntax><value>string</value> | <literal>none</literal></syntax>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
197 <default>none</default>
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
198 <context>http</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
199 <context>server</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
200 <context>location</context>
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 <para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
203 Sets a value for the <header>P3P</header> header field that will be
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
204 sent along with the cookie.
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
205 If the directive is set to the special value <literal>none</literal>,
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
206 the <header>P3P</header> header will not be sent in a response.
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
207 </para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
208
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
209 </directive>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
210
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
211
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
212 <directive name="userid_path">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
213 <syntax><value>path</value></syntax>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
214 <default>/</default>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
215 <context>http</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
216 <context>server</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
217 <context>location</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
218
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
219 <para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
220 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
221 </para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
222
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
223 </directive>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
224
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
225
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
226 <directive name="userid_service">
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
227 <syntax><value>number</value></syntax>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
228 <default>IP address of the server</default>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
229 <context>http</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
230 <context>server</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
231 <context>location</context>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
232
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
233 <para>
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
234 If identifiers are issued by multiple servers (services),
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
235 each service should be assigned its own <value>number</value>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
236 to ensure that client identifiers are unique.
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
237 For version 1 cookies, the default value is zero.
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
238 For version 2 cookies, the default value is the number composed from the last
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
239 four octets of the server’s IP address.
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
240 </para>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
241
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
242 </directive>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
243
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
244 </section>
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
245
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
246
1154
b0e56cc57867 Fixed section names.
Ruslan Ermilov <ru@nginx.com>
parents: 966
diff changeset
247 <section id="variables" name="Embedded Variables">
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
248
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
249 <para>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
250 The <literal>ngx_http_userid_module</literal> module
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
251 supports the following embedded variables:
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
252 <list type="tag">
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
253
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
254 <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
255 <tag-desc>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
256 The cookie name and received client identifier.
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
257 </tag-desc>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
258
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
259 <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
260 <tag-desc>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
261 If the variable is set to a non-empty string that is not “<literal>0</literal>”,
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
262 the client identifiers are reset.
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
263 The special value “<literal>log</literal>” additionally leads to the output of
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 868
diff changeset
264 messages about the reset identifiers to the
868
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
265 <link doc="../ngx_core_module.xml" id="error_log"/>.
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
266 </tag-desc>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
267
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
268 <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
269 <tag-desc>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
270 The cookie name and sent client identifier.
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
271 </tag-desc>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
272
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
273 </list>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
274 </para>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
275
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
276 </section>
17d0c825f098 Revised the userid module documentation.
Homutov Vladimir <vl@nginx.com>
parents: 684
diff changeset
277
360
43f379b12b76 English translation of ngx_http_userid_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
278 </module>