ngx_http_userid_module
Module ngx_http_userid_module
- 示例配置
- 指令
- 用户名
- userid_domain
- userid_expires
- userid_mark
- userid_name
- userid_p3p
- userid_path
- userid_service
- 嵌入式变量
该ngx_http_userid_module模块设置适合客户端识别的Cookie。接收和设置的cookie可以使用嵌入式变量$ uid_got和$ uid_set进行记录。该模块与Apache 的mod_uid模块兼容。
示例配置
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"';
指令
| 句法： | 用户ID在|上 v1 | 日志| 关闭; |
|---|---|
| 默认： | userid off; |
| 语境： | http，服务器，位置 |
启用或禁用设置Cookie并记录收到的Cookie：
on可以设置版本2的cookies并记录收到的cookies; v1可以设置版本1的cookies并记录收到的cookies; log禁用cookies的设置，但启用收到的cookie的记录; off禁用cookies的设置和记录收到的cookie。
| 句法： | userid_domain name | 没有; |
|---|---|
| 默认： | userid_domain none; |
| 语境： | http，服务器，位置 |
定义设置cookie的域。该none参数禁用cookie的域设置。
| 句法： | userid_expires time | max | 关闭; |
|---|---|
| 默认： | userid_expires off; |
| 语境： | http，服务器，位置 |
设置浏览器保存cookie的时间。该参数max将导致cookie在“ 31 Dec 2037 23:55:55 GMT” 上过期。该参数off将导致cookie在浏览器会话结束时过期。
| 句法： | userid_mark字母| 数字| = | 关闭; |
|---|---|
| 默认： | userid_mark off; |
| 语境： | http，服务器，位置 |
如果参数不是off，则启用cookie标记机制并设置用作标记的字符。此机制用于在保留客户端标识符的同时添加或更改userid_p3p和/或cookie过期时间。标记可以是英文字母（区分大小写），数字或“ =”字符的任何字母。
如果标记已设置，则将其与在cookie中传递的客户机标识的base64表示形式中的第一个填充符号进行比较。如果它们不匹配，则Cookie会重新发送指定的标记，到期时间和“P3P”标题。
| 句法： | userid_name名称; |
|---|---|
| 默认： | userid_name uid; |
| 语境： | http，服务器，位置 |
设置cookie名称。
| 句法： | userid_p3p string | 没有; |
|---|---|
| 默认： | userid_p3p 无; |
| 语境： | http，服务器，位置 |
设置将与Cookie一起发送的“P3P”标题字段的值。如果指令设置为特殊值none，则“P3P”标题将不会在响应中发送。
| 句法： | userid_path路径; |
|---|---|
| 默认： | userid_path /; |
| 语境： | http，服务器，位置 |
定义设置cookie的路径。
| 句法： | userid_service号码; |
|---|---|
| 默认： | userid_service服务器的IP地址; |
| 语境： | http，服务器，位置 |
如果标识符是由多个服务器（服务）发布的，则应为每个服务分配自己的number标识以确保客户端标识符是唯一的。对于版本1 cookie，默认值为零。对于版本2 cookie，默认值是由服务器IP地址的最后四个字节组成的数字。
嵌入式变量
该ngx_http_userid_module模块支持以下嵌入式变量：
$uid_gotCookie名称和收到的客户端标识符。$uid_reset如果变量设置为非“ 0” 的非空字符串，则客户端标识符将被重置。特殊值“ log”还会导致将有关重置标识符的消息输出到error_log。$uid_setcookie名称和发送的客户端标识符。
