<?xml version="1.0"?>

<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">

<module name="Модуль ngx_http_userid_module"
        link="/ru/docs/http/ngx_http_userid_module.html"
        lang="ru">

<section id="summary">

<para>
Модуль <literal>ngx_http_userid_module</literal> выдаёт куки
для идентификации клиентов.
Для записи в лог полученных и выданных куки можно использовать встроенные
переменные <var>$uid_got</var> и <var>$uid_set</var>.
Модуль совместим с модулем
<link url="http://www.lexa.ru/programs/mod-uid.html">mod_uid</link>
для Apache.
</para>

</section>


<section id="example" name="Пример конфигурации">

<para>
<example>
userid         on;
userid_name    uid;
userid_domain  example.com;
userid_path    /;
userid_expires 365d;
userid_p3p     'policyref="/w3c/p3p.xml", CP="CUR ADM OUR NOR STA NID"';
</example>
</para>

</section>


<section id="directives" name="Директивы">

<directive name="userid">
<syntax>
    <literal>on</literal> |
    <literal>v1</literal> |
    <literal>log</literal> |
    <literal>off</literal></syntax>
<default>off</default>
<context>http</context>
<context>server</context>
<context>location</context>

<para>
Разрешает или запрещает выдавать куки и записывать приходящие куки в лог:
<list type="tag">

<tag-name><literal>on</literal></tag-name>
<tag-desc>
разрешает выдавать куки версии 2
и записывать приходящие куки в лог;
</tag-desc>

<tag-name><literal>v1</literal></tag-name>
<tag-desc>
разрешает выдавать куки версии 1
и записывать приходящие куки в лог;
</tag-desc>

<tag-name><literal>log</literal></tag-name>
<tag-desc>
запрещает выдавать куки,
но разрешает записывать приходящие куки в лог;
</tag-desc>

<tag-name><literal>off</literal></tag-name>
<tag-desc>
запрещает выдавать куки и записывать приходящие куки в лог.
</tag-desc>

</list>
</para>

</directive>


<directive name="userid_domain">
<syntax><value>имя</value> | <literal>none</literal></syntax>
<default>none</default>
<context>http</context>
<context>server</context>
<context>location</context>

<para>
Задаёт домен, для которого устанавливается куки.
Параметр <literal>none</literal> запрещает выдавать домен для куки.
</para>

</directive>


<directive name="userid_expires">
<syntax><value>время</value> | <literal>max</literal></syntax>
<default/>
<context>http</context>
<context>server</context>
<context>location</context>

<para>
Задаёт время, в течение которого браузер должен хранить куки.
Параметр <literal>max</literal> задаёт время 31 декабря 2037 года 23:55:55 GMT.
Это максимальное время, которое понимают старые браузеры.
</para>

</directive>


<directive name="userid_name">
<syntax><value>имя</value></syntax>
<default>uid</default>
<context>http</context>
<context>server</context>
<context>location</context>

<para>
Задаёт имя куки.
</para>

</directive>


<directive name="userid_p3p">
<syntax><value>строка</value></syntax>
<default/>
<context>http</context>
<context>server</context>
<context>location</context>

<para>
Задаёт значение для поля заголовка <header>P3P</header>, который будет
выдаваться вместе с куки.
</para>

</directive>


<directive name="userid_path">
<syntax><value>путь</value></syntax>
<default>/</default>
<context>http</context>
<context>server</context>
<context>location</context>

<para>
Задаёт путь, для которого устанавливается куки.
</para>

</directive>


<directive name="userid_service">
<syntax><value>число</value></syntax>
<default>IP-адрес сервера</default>
<context>http</context>
<context>server</context>
<context>location</context>

<para>
Задаёт номер сервиса, выдавшего куки.
По умолчанию для куки первой версии используется ноль,
а для второй — IP-адрес сервера.
</para>

</directive>

</section>

</module>