Module mod_usertrack

Module mod_usertrack supports directives for the IBM® HTTP Server for i Web server.

Summary

This module provides support for tracking users through the use of cookies.

Note: 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.

Directives

CookieDomain

Module: mod_usertrack
Syntax: CookieDomain domain
Default: none
Context: server config, virtual host, directory, .htaccess
Override: none
Origin: Apache
Example: CookieDomain .mydomain.com

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® and .com are not.

Parameter: domain
  • A domain 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).

CookieExpires

Module: mod_usertrack
Syntax: CookieExpires expiry-period
Default: none
Context: server config, virtual host, directory, .htaccess
Override: none
Origin: Apache
Example: CookieExpires 120

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.

Parameter: expiry-period
  • The expiry-period specifies the time, in seconds, the cookie should remain.

CookieName

Module: mod_usertrack
Syntax: CookieName token
Default: CookieName Apache
Context: server config, virtual host, directory, .htaccess
Override: FileInfo
Origin: Apache
Example: CookieName ABCDE19

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 '-'.

Parameter: token
  • The token parameter allows you to change the name of the cookie.

CookieStyle

Module: mod_usertrack
Syntax: CookieStyle Netscape | Cookie | Cookie2 | RFC2109 | RFC2965
Default: CookieStyle Netscape
Context: server config, virtual host, directory, .htaccess
Override: none
Origin: Apache
Example: CookieStyle Cookie

This CookieStyle directive controls the format of the cookie header field.

Parameter: Netscape | Cookie | Cookie2 | RFC2109 | RFC2965
  • Netscape is the original, but now deprecated, syntax. This is the default, and the syntax HTTP Server has historically used.
  • Cookie or RFC2109 is the syntax that superseded the Netscape syntax.
  • Cookie2 or RFC2965 is the most current cookie syntax.
Note: Not all clients can understand all of these formats. You should use the most current one that is generally acceptable to your users' browsers.

CookieTracking

Module: mod_usertrack
Syntax: CookieTracking on | off
Default: Compiling mod_usertrack will not activate cookies by default.
Context: server config, virtual host, directory, .htaccess
Override: FileInfo
Origin: Apache
Example: CookieTracking on

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.

Parameter: on | off
  • With CookieTracking on, the server starts sending a user-tracking cookie for all new requests.
  • With CookieTracking off, the server does not send a user-tracking cookie for all new requests.