mod_usertrack

mod_usertrack overview

mod_usertrack module allows to track and log user activity on the site using cookies.

 

mod_usertrack directives

CookieDomain

Description: Specifies domain name to which the tracking cookie is applied
Syntax: CookieDomain domain
Context: server config, virtual host, directory, .htaccess
Module: mod_usertrack

CookieDomain directive defines the domain to which tracking cookie will be applied. If not specified, no domain will be included into the cookie header field.

The domain string must begin with a dot and include at least one embedded dot.

Example:

CookieDomain .example.com

CookieExpires

Description: Sets expiry time for the tracking cookie
Syntax: CookieExpires expiry-time
Context: server config, virtual host, directory, .htaccess
Module: mod_usertrack

CookieExpires directive sets expiry time for the cookie generated by mod_usertrack. The expiry-time may be set either in seconds

Example:

CookieExpires 3600

or using the following denominations: years, months, weeks, days, hours, minutes and seconds. In this case the expiry-time shall be put in quotes.

Example:

CookieExpires "5 weeks 6 days 7 hours"

If this directive is not used, cookies last only for the current browser session.

CookieName

Description: Sets the name of tracking cookie
Syntax: CookieName name
Default: CookieName Ape
Context: server config, virtual host, directory, .htaccess
Module: mod_usertrack

CookieName directive allows to specify custom name for the tracking cookie. The default name is Ape.

Valid characters for the cookie name are: A-Z, a-z, 0-9, "_", and "-".

Example:

CookieName Ape_Tracking_Cookie

CookieStyle

Description: Defines the format of the cookie header field
Syntax: CookieStyle Netscape|Cookie|Cookie2|RFC2109|RFC2965
Default: CookieStyle Netscape
Context: server config, virtual host, directory, .htaccess
Module: mod_usertrack

CookieStyle directive defines the format of cookie header field. Three formats are possible:

  • Netscape (default) - original but now obsolete syntax;
  • Cookie or RFC2109 - the syntax that superseded Netscape syntax;
  • Cookie2 or RFC2965 - the most up-to-date cookie syntax.

Valid characters for the cookie name are: A-Z, a-z, 0-9, "_", and "-".

Example:

CookieStyle Cookie

CookieTracking

Description: Enables tracking cookie
Syntax: CookieTracking On|Off
Default: CookieTracking Off
Context: server config, virtual host, directory, .htaccess
Module: mod_usertrack

CookieTracking directive enables mod_usertrack operation and forces it to send a user-tracking cookie for all new requests. This directive may be used to enable/disable user tracking for specific sites/directories.

Example:

CookieTracking On