| <?xml version="1.0" encoding="ISO-8859-1"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!-- |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| This file is generated from xml source: DO NOT EDIT |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| --> |
| <title>mod_usertrack - Apache HTTP Server</title> |
| <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> |
| <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> |
| <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /> |
| <link href="../images/favicon.ico" rel="shortcut icon" /></head> |
| <body> |
| <div id="page-header"> |
| <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p> |
| <p class="apache">Apache HTTP Server Version 2.3</p> |
| <img alt="" src="../images/feather.gif" /></div> |
| <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> |
| <div id="path"> |
| <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.3</a> > <a href="./">Modules</a></div> |
| <div id="page-content"> |
| <div id="preamble"><h1>Apache Module mod_usertrack</h1> |
| <div class="toplang"> |
| <p><span>Available Languages: </span><a href="../en/mod/mod_usertrack.html" title="English"> en </a></p> |
| </div> |
| <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td> |
| <em>Clickstream</em> logging of user activity on a site |
| </td></tr> |
| <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr> |
| <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>usertrack_module</td></tr> |
| <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_usertrack.c</td></tr></table> |
| <h3>Summary</h3> |
| |
| <p>Provides tracking of a user through your website via browser |
| cookies.</p> |
| </div> |
| <div id="quickview"><h3 class="directives">Directives</h3> |
| <ul id="toc"> |
| <li><img alt="" src="../images/down.gif" /> <a href="#cookiedomain">CookieDomain</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#cookieexpires">CookieExpires</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#cookiename">CookieName</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#cookiestyle">CookieStyle</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#cookietracking">CookieTracking</a></li> |
| </ul> |
| <h3>Topics</h3> |
| <ul id="topics"> |
| <li><img alt="" src="../images/down.gif" /> <a href="#logging">Logging</a></li> |
| </ul></div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="logging" id="logging">Logging</a></h2> |
| |
| |
| <p><code class="module"><a href="../mod/mod_usertrack.html">mod_usertrack</a></code> sets a cookie which can be logged |
| via <code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code> configurable logging formats:</p> |
| |
| <div class="example"><p><code> |
| LogFormat "%{Apache}n %r %t" usertrack<br /> |
| CustomLog logs/clickstream.log usertrack |
| </code></p></div> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="CookieDomain" id="CookieDomain">CookieDomain</a> <a name="cookiedomain" id="cookiedomain">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The domain to which the tracking cookie applies</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieDomain <em>domain</em></code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr> |
| </table> |
| |
| <p>This 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.</p> |
| |
| <p>The domain string <strong>must</strong> begin with a dot, and |
| <strong>must</strong> include at least one embedded dot. That is, |
| <code>.example.com</code> is legal, but <code>www.example.com</code> and |
| <code>.com</code> are not.</p> |
| |
| <div class="note">Most browsers in use today will not allow cookies to be set |
| for a two-part top level domain, such as <code>.co.uk</code>, |
| although such a domain ostensibly fulfills the requirements |
| above.<br /> |
| |
| These domains are equivalent to top level domains such as |
| <code>.com</code>, and allowing such cookies may be a security |
| risk. Thus, if you are under a two-part top level domain, you |
| should still use your actual domain, as you would with any other top |
| level domain (for example <code>.example.co.uk</code>). |
| </div> |
| |
| <div class="example"><p><code> |
| CookieDomain .example.com |
| </code></p></div> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="CookieExpires" id="CookieExpires">CookieExpires</a> <a name="cookieexpires" id="cookieexpires">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Expiry time for the tracking cookie</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieExpires <em>expiry-period</em></code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr> |
| </table> |
| <p>When used, this directive sets an expiry time on the cookie |
| generated by the usertrack module. The <em>expiry-period</em> |
| can be given either as a number of seconds, or in the format |
| such as "2 weeks 3 days 7 hours". Valid denominations are: |
| years, months, weeks, days, hours, minutes and seconds. If the expiry |
| time is in any format other than one number indicating the |
| number of seconds, it must be enclosed by double quotes.</p> |
| |
| <p>If this directive is not used, cookies last only for the |
| current browser session.</p> |
| |
| <div class="example"><p><code> |
| CookieExpires "3 weeks" |
| </code></p></div> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="CookieName" id="CookieName">CookieName</a> <a name="cookiename" id="cookiename">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Name of the tracking cookie</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieName <em>token</em></code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CookieName Apache</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr> |
| </table> |
| <p>This directive allows you to change the name of the cookie |
| this module uses for its tracking purposes. By default the |
| cookie is named "<code>Apache</code>".</p> |
| |
| <p>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> |
| |
| <div class="example"><p><code> |
| CookieName clicktrack |
| </code></p></div> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="CookieStyle" id="CookieStyle">CookieStyle</a> <a name="cookiestyle" id="cookiestyle">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Format of the cookie header field</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieStyle |
| <em>Netscape|Cookie|Cookie2|RFC2109|RFC2965</em></code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CookieStyle Netscape</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr> |
| </table> |
| <p>This directive controls the format of the cookie header |
| field. The three formats allowed are:</p> |
| |
| <ul> |
| <li><strong>Netscape</strong>, which is the original but now deprecated |
| syntax. This is the default, and the syntax Apache has |
| historically used.</li> |
| |
| <li><strong>Cookie</strong> or <strong>RFC2109</strong>, which is the syntax that |
| superseded the Netscape syntax.</li> |
| |
| <li><strong>Cookie2</strong> or <strong>RFC2965</strong>, which is the most |
| current cookie syntax.</li> |
| </ul> |
| |
| <p>Not all clients can understand all of these formats, but you |
| should use the newest one that is generally acceptable to your |
| users' browsers. At the time of writing, most browsers support all |
| three of these formats, with <code>Cookie2</code> being the |
| preferred format.</p> |
| |
| <div class="example"><p><code> |
| CookieStyle Cookie2 |
| </code></p></div> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="CookieTracking" id="CookieTracking">CookieTracking</a> <a name="cookietracking" id="cookietracking">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables tracking cookie</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieTracking on|off</code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CookieTracking off</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr> |
| </table> |
| <p>When <code class="module"><a href="../mod/mod_usertrack.html">mod_usertrack</a></code> is loaded, and |
| <code>CookieTracking on</code> is set, Apache will 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. By default, enabling |
| <code class="module"><a href="../mod/mod_usertrack.html">mod_usertrack</a></code> will <strong>not</strong> |
| activate cookies. </p> |
| |
| <div class="example"><p><code> |
| CookieTracking on |
| </code></p></div> |
| |
| |
| </div> |
| </div> |
| <div class="bottomlang"> |
| <p><span>Available Languages: </span><a href="../en/mod/mod_usertrack.html" title="English"> en </a></p> |
| </div><div id="footer"> |
| <p class="apache">Copyright 2011 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p> |
| <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div> |
| </body></html> |