215 lines
14 KiB
HTML
215 lines
14 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html lang="en-us" xml:lang="en-us">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="security" content="public" />
|
|
<meta name="Robots" content="index,follow" />
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
|
<meta name="DC.Type" content="topic" />
|
|
<meta name="DC.Title" content="Module mod_usertrack" />
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 2002,2006" />
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2002,2006" />
|
|
<meta name="DC.Format" content="XHTML" />
|
|
<meta name="DC.Identifier" content="rzaiemod_usertrack" />
|
|
<meta name="DC.Language" content="en-us" />
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
|
<!-- US Government Users Restricted Rights -->
|
|
<!-- Use, duplication or disclosure restricted by -->
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
|
<title>Module mod_usertrack</title>
|
|
</head>
|
|
<body id="rzaiemod_usertrack"><a name="rzaiemod_usertrack"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<!--Java sync-link--><h1 class="topictitle1">Module mod_usertrack</h1>
|
|
<div><div class="important"><span class="importanttitle">Important:</span> Information
|
|
for this topic supports the latest PTF levels for HTTP Server for i5/OS .
|
|
It is recommended that you install the latest PTFs to upgrade to the latest
|
|
level of the HTTP Server for i5/OS. Some of the topics documented here are
|
|
not available prior to this update. See <a href="http://www-03.ibm.com/servers/eserver/iseries/software/http/services/service.html" target="_blank">http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm</a> <img src="www.gif" alt="Link outside Information Center" /> for more information. </div>
|
|
<p><strong>Summary</strong></p>
|
|
<p>This module provides support for tracking users through the use of cookies.
|
|
</p>
|
|
<div class="note"><span class="notetitle">Note:</span> Netscape 4.x (Communicator) and above can use two or four digit dates.
|
|
Netscape 3.x and below will only accept two digit dates. To ensure the expiration
|
|
date is legible to the client's browser use two digit dates. </div>
|
|
<p><strong>Directives</strong></p>
|
|
<ul><li><a href="#cookiedomain">CookieDomain</a></li>
|
|
<li><a href="#cookieexpires">CookieExpires</a></li>
|
|
<li><a href="#cookiename">CookieName</a></li>
|
|
<li><a href="#cookiestyle">CookieStyle</a></li>
|
|
<li><a href="#cookietracking">CookieTracking</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="hr" id="cookiedomain"><a name="cookiedomain"><!-- --></a><h2 class="topictitle2">CookieDomain</h2>
|
|
<div>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_usertrack</td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: CookieDomain <em>domain</em> </td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: none </td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="cookiedomain__cookiedomain_context"><a name="cookiedomain__cookiedomain_context"><!-- --></a>server config,
|
|
virtual host, directory, .htaccess</span></td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: none </td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="cookiedomain__cookiedomain_origin"><a name="cookiedomain__cookiedomain_origin"><!-- --></a>Apache </span></td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: CookieDomain .mydomain.com</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p>The CookieDomain directive controls the setting of the domain to which
|
|
the tracking cookie applies. If not present, no domain is included in the
|
|
cookie header field. The domain string must begin with a dot, and must include
|
|
at least one embedded dot. That is, .ibm.com is legal, but ibm.com<sup>®</sup> and
|
|
.com are not. </p>
|
|
<dl class="block"><dt class="dlterm"><strong>Parameter</strong>: <em>domain </em></dt>
|
|
<dd><ul><li>A <em>domain</em> is a partially qualified DNS domain name, preceded by
|
|
a period. It represents a group of hosts that logically belong to the same
|
|
DNS domain or zone (that is, the suffixes of the hostnames are all ending
|
|
in Domain).</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
<div class="hr" id="cookieexpires"><a name="cookieexpires"><!-- --></a><h2 class="topictitle2">CookieExpires</h2>
|
|
<div>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_usertrack </td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: CookieExpires <em>expiry-period</em> </td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: none </td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="cookieexpires__cookieexpires_context"><a name="cookieexpires__cookieexpires_context"><!-- --></a>server config,
|
|
virtual host, directory, .htaccess</span></td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: none </td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="cookieexpires__cookieexpires_origin"><a name="cookieexpires__cookieexpires_origin"><!-- --></a>Apache </span></td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: CookieExpires 120</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p>The CookieExpires directive sets an expiry time on the cookie generated
|
|
by the usertrack module. If this directive is not used, cookies last only
|
|
for the current browser session. </p>
|
|
<dl class="block"><dt class="dlterm"><strong>Parameter</strong>: <em>expiry-period</em></dt>
|
|
<dd><ul><li>The <em>expiry-period</em> specifies the time, in seconds, the cookie should
|
|
remain. </li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
<div class="hr" id="cookiename"><a name="cookiename"><!-- --></a><h2 class="topictitle2">CookieName</h2>
|
|
<div>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_usertrack </td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: CookieName <em>token</em> </td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: CookieName Apache</td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="cookiename__cookiename_context"><a name="cookiename__cookiename_context"><!-- --></a>server config,
|
|
virtual host, directory, .htaccess </span></td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: FileInfo </td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="cookiename__cookiename_origin"><a name="cookiename__cookiename_origin"><!-- --></a>Apache </span></td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: CookieName ABCDE19 </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p>The CookieName directive allows you to change the name of the cookie. The
|
|
cookie name is used for tracking purposes. You must specify a valid cookie
|
|
name; results are unpredictable if you use a name containing unusual characters.
|
|
Valid characters include A-Z, a-z, 0-9, '_' and '-'. </p>
|
|
<dl class="block"><dt class="dlterm"><strong>Parameter</strong>: <em>token </em></dt>
|
|
<dd><ul><li>The <em>token</em> parameter allows you to change the name of the cookie. </li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
<div class="hr" id="cookiestyle"><a name="cookiestyle"><!-- --></a><h2 class="topictitle2">CookieStyle</h2>
|
|
<div>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_usertrack </td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: CookieStyle <em>Netscape</em> | <em>Cookie</em> | <em>Cookie2</em> | <em>RFC2109</em> | <em>RFC2965</em> </td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: CookieStyle Netscape </td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="cookiestyle__cookiestyle_context"><a name="cookiestyle__cookiestyle_context"><!-- --></a>server config,
|
|
virtual host, directory, .htaccess </span></td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: none</td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="cookiestyle__cookiestyle_origin"><a name="cookiestyle__cookiestyle_origin"><!-- --></a>Apache </span></td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: CookieStyle Cookie </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p>This CookieStyle directive controls the format of the cookie header field. </p>
|
|
<dl class="block"><dt class="dlterm"><strong>Parameter</strong>: <em>Netscape | Cookie | Cookie2 | RFC2109 | RFC2965 </em></dt>
|
|
<dd><ul><li><em>Netscape</em> is the original, but now deprecated, syntax. This is the
|
|
default, and the syntax HTTP Server (powered by Apache) has historically used.
|
|
</li>
|
|
<li><em>Cookie</em> or <em>RFC2109</em> is the syntax that superseded the <em>Netscape</em> syntax.
|
|
</li>
|
|
<li><em>Cookie2</em> or <em>RFC2965</em> is the most current cookie syntax. </li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<div class="note"><span class="notetitle">Note:</span> Not all clients can understand all of these formats. You should use
|
|
the most current one that is generally acceptable to your users' browsers. </div>
|
|
</div>
|
|
</div>
|
|
<div class="hr" id="cookietracking"><a name="cookietracking"><!-- --></a><h2 class="topictitle2">CookieTracking</h2>
|
|
<div>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_usertrack </td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: CookieTracking <em>on | off </em></td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: Compiling mod_usertrack will not activate
|
|
cookies by default. </td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="cookietracking__cookietracking_context"><a name="cookietracking__cookietracking_context"><!-- --></a>server
|
|
config, virtual host, directory, .htaccess </span></td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: FileInfo </td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="cookietracking__cookietracking_origin"><a name="cookietracking__cookietracking_origin"><!-- --></a>Apache </span></td>
|
|
</tr>
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: CookieTracking on </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p>The CookieTracking directive allows you to send a user-tracking cookie
|
|
for all new requests. This directive can be used to turn this behavior on
|
|
or off on a per-server or per-directory basis. </p>
|
|
<dl class="block"><dt class="dlterm"><strong>Parameter</strong>: <em>on | off </em></dt>
|
|
<dd><ul><li>With CookieTracking <em>on</em>, the server starts sending a user-tracking
|
|
cookie for all new requests. </li>
|
|
<li>With CookieTracking <em>off</em>, the server does not send a user-tracking
|
|
cookie for all new requests. </li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
|
|
</body>
|
|
</html> |