Mercurial > hg > nginx-site
view xml/ru/docs/http/ngx_http_userid_module.xml @ 659:77a3314c74a7
Avoid the uses of second person.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Tue, 28 Aug 2012 09:23:40 +0000 |
parents | 764fbac1b8b4 |
children | 2ff9c3ea8c98 |
line wrap: on
line source
<?xml version="1.0"?> <!-- Copyright (C) Igor Sysoev Copyright (C) Nginx, Inc. --> <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> <module name="Модуль ngx_http_userid_module" link="/ru/docs/http/ngx_http_userid_module.html" lang="ru" rev="1"> <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>