granicus.if.org Git - apache/blob - docs/manual/mod/mod_usertrack.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_usertrack - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <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>
  16 <p class="apache">Apache HTTP Server Version 2.3</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.3</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_usertrack</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_usertrack.html" title="English">&nbsp;en&nbsp;</a></p>
  25 </div>
  26 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>
  27 <em>Clickstream</em> logging of user activity on a site
  28 </td></tr>
  29 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  30 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>usertrack_module</td></tr>
  31 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_usertrack.c</td></tr></table>
  32 <h3>Summary</h3>
  33
  34     <p>Provides tracking of a user through your website via browser
  35     cookies.</p>
  36 </div>
  37 <div id="quickview"><h3 class="directives">Directives</h3>
  38 <ul id="toc">
  39 <li><img alt="" src="../images/down.gif" /> <a href="#cookiedomain">CookieDomain</a></li>
  40 <li><img alt="" src="../images/down.gif" /> <a href="#cookieexpires">CookieExpires</a></li>
  41 <li><img alt="" src="../images/down.gif" /> <a href="#cookiename">CookieName</a></li>
  42 <li><img alt="" src="../images/down.gif" /> <a href="#cookiestyle">CookieStyle</a></li>
  43 <li><img alt="" src="../images/down.gif" /> <a href="#cookietracking">CookieTracking</a></li>
  44 </ul>
  45 <h3>Topics</h3>
  46 <ul id="topics">
  47 <li><img alt="" src="../images/down.gif" /> <a href="#logging">Logging</a></li>
  48 </ul></div>
  49 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  50 <div class="section">
  51 <h2><a name="logging" id="logging">Logging</a></h2>
  52
  53
  54     <p><code class="module"><a href="../mod/mod_usertrack.html">mod_usertrack</a></code> sets a cookie which can be logged
  55     via <code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code> configurable logging formats:</p>
  56
  57     <div class="example"><p><code>
  58     LogFormat "%{Apache}n %r %t" usertrack<br />
  59     CustomLog logs/clickstream.log usertrack
  60     </code></p></div>
  61
  62 </div>
  63 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  64 <div class="directive-section"><h2><a name="CookieDomain" id="CookieDomain">CookieDomain</a> <a name="cookiedomain" id="cookiedomain">Directive</a></h2>
  65 <table class="directive">
  66 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The domain to which the tracking cookie applies</td></tr>
  67 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieDomain <em>domain</em></code></td></tr>
  68 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  69 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
  70 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  71 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
  72 </table>
  73
  74     <p>This directive controls the setting of the domain to which
  75     the tracking cookie applies. If not present, no domain is
  76     included in the cookie header field.</p>
  77
  78     <p>The domain string <strong>must</strong> begin with a dot, and
  79     <strong>must</strong> include at least one embedded dot. That is,
  80     <code>.example.com</code> is legal, but <code>www.example.com</code> and
  81     <code>.com</code> are not.</p>
  82
  83     <div class="note">Most browsers in use today will not allow cookies to be set
  84     for a two-part top level domain, such as <code>.co.uk</code>,
  85     although such a domain ostensibly fulfills the requirements
  86     above.<br />
  87
  88     These domains are equivalent to top level domains such as
  89     <code>.com</code>, and allowing such cookies may be a security
  90     risk. Thus, if you are under a two-part top level domain, you
  91     should still use your actual domain, as you would with any other top
  92     level domain (for example <code>.example.co.uk</code>).
  93     </div>
  94
  95     <div class="example"><p><code>
  96     CookieDomain .example.com
  97     </code></p></div>
  98
  99 </div>
 100 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 101 <div class="directive-section"><h2><a name="CookieExpires" id="CookieExpires">CookieExpires</a> <a name="cookieexpires" id="cookieexpires">Directive</a></h2>
 102 <table class="directive">
 103 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Expiry time for the tracking cookie</td></tr>
 104 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieExpires <em>expiry-period</em></code></td></tr>
 105 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 106 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 107 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 108 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
 109 </table>
 110     <p>When used, this directive sets an expiry time on the cookie
 111     generated by the usertrack module. The <em>expiry-period</em>
 112     can be given either as a number of seconds, or in the format
 113     such as "2 weeks 3 days 7 hours". Valid denominations are:
 114     years, months, weeks, days, hours, minutes and seconds. If the expiry
 115     time is in any format other than one number indicating the
 116     number of seconds, it must be enclosed by double quotes.</p>
 117
 118     <p>If this directive is not used, cookies last only for the
 119     current browser session.</p>
 120
 121     <div class="example"><p><code>
 122     CookieExpires "3 weeks"
 123     </code></p></div>
 124
 125 </div>
 126 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 127 <div class="directive-section"><h2><a name="CookieName" id="CookieName">CookieName</a> <a name="cookiename" id="cookiename">Directive</a></h2>
 128 <table class="directive">
 129 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Name of the tracking cookie</td></tr>
 130 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieName <em>token</em></code></td></tr>
 131 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CookieName Apache</code></td></tr>
 132 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 133 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 134 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 135 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
 136 </table>
 137     <p>This directive allows you to change the name of the cookie
 138     this module uses for its tracking purposes. By default the
 139     cookie is named "<code>Apache</code>".</p>
 140
 141     <p>You must specify a valid cookie name; results are
 142     unpredictable if you use a name containing unusual characters.
 143     Valid characters include A-Z, a-z, 0-9, "_", and "-".</p>
 144
 145     <div class="example"><p><code>
 146     CookieName clicktrack
 147     </code></p></div>
 148
 149 </div>
 150 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 151 <div class="directive-section"><h2><a name="CookieStyle" id="CookieStyle">CookieStyle</a> <a name="cookiestyle" id="cookiestyle">Directive</a></h2>
 152 <table class="directive">
 153 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Format of the cookie header field</td></tr>
 154 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieStyle
 155     <em>Netscape|Cookie|Cookie2|RFC2109|RFC2965</em></code></td></tr>
 156 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CookieStyle Netscape</code></td></tr>
 157 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 158 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 159 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 160 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
 161 </table>
 162     <p>This directive controls the format of the cookie header
 163     field. The three formats allowed are:</p>
 164
 165     <ul>
 166       <li><strong>Netscape</strong>, which is the original but now deprecated
 167       syntax. This is the default, and the syntax Apache has
 168       historically used.</li>
 169
 170       <li><strong>Cookie</strong> or <strong>RFC2109</strong>, which is the syntax that
 171       superseded the Netscape syntax.</li>
 172
 173       <li><strong>Cookie2</strong> or <strong>RFC2965</strong>, which is the most
 174       current cookie syntax.</li>
 175     </ul>
 176
 177     <p>Not all clients can understand all of these formats, but you
 178     should use the newest one that is generally acceptable to your
 179     users' browsers. At the time of writing, most browsers support all
 180     three of these formats, with <code>Cookie2</code> being the
 181     preferred format.</p>
 182
 183     <div class="example"><p><code>
 184     CookieStyle Cookie2
 185     </code></p></div>
 186
 187 </div>
 188 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 189 <div class="directive-section"><h2><a name="CookieTracking" id="CookieTracking">CookieTracking</a> <a name="cookietracking" id="cookietracking">Directive</a></h2>
 190 <table class="directive">
 191 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables tracking cookie</td></tr>
 192 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieTracking on|off</code></td></tr>
 193 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CookieTracking off</code></td></tr>
 194 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 195 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 196 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 197 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
 198 </table>
 199     <p>When <code class="module"><a href="../mod/mod_usertrack.html">mod_usertrack</a></code> is loaded, and
 200     <code>CookieTracking on</code> is set, Apache will send a
 201     user-tracking cookie for all new requests. This directive can
 202     be used to turn this behavior on or off on a per-server or
 203     per-directory basis. By default, enabling
 204     <code class="module"><a href="../mod/mod_usertrack.html">mod_usertrack</a></code> will <strong>not</strong>
 205     activate cookies. </p>
 206
 207     <div class="example"><p><code>
 208     CookieTracking on
 209     </code></p></div>
 210
 211
 212 </div>
 213 </div>
 214 <div class="bottomlang">
 215 <p><span>Available Languages: </span><a href="../en/mod/mod_usertrack.html" title="English">&nbsp;en&nbsp;</a></p>
 216 </div><div id="footer">
 217 <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>
 218 <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>
 219 </body></html>