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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_usertrack - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.png" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <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.5</a> &gt; <a href="./">Modules</a></div>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_usertrack</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_usertrack.html" title="English">&nbsp;en&nbsp;</a></p>
  30 </div>
  31 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>
  32 <em>Clickstream</em> logging of user activity on a site
  33 </td></tr>
  34 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  35 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>usertrack_module</td></tr>
  36 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_usertrack.c</td></tr></table>
  37 <h3>Summary</h3>
  38
  39     <p>Provides tracking of a user through your website via browser
  40     cookies.</p>
  41 </div>
  42 <div id="quickview"><h3>Topics</h3>
  43 <ul id="topics">
  44 <li><img alt="" src="../images/down.gif" /> <a href="#logging">Logging</a></li>
  45 </ul><h3 class="directives">Directives</h3>
  46 <ul id="toc">
  47 <li><img alt="" src="../images/down.gif" /> <a href="#cookiedomain">CookieDomain</a></li>
  48 <li><img alt="" src="../images/down.gif" /> <a href="#cookieexpires">CookieExpires</a></li>
  49 <li><img alt="" src="../images/down.gif" /> <a href="#cookiename">CookieName</a></li>
  50 <li><img alt="" src="../images/down.gif" /> <a href="#cookiestyle">CookieStyle</a></li>
  51 <li><img alt="" src="../images/down.gif" /> <a href="#cookietracking">CookieTracking</a></li>
  52 </ul>
  53 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_usertrack">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_usertrack">Report a bug</a></li></ul><h3>See also</h3>
  54 <ul class="seealso">
  55 <li><a href="#comments_section">Comments</a></li></ul></div>
  56 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  57 <div class="section">
  58 <h2><a name="logging" id="logging">Logging</a></h2>
  59
  60
  61     <p><code class="module"><a href="../mod/mod_usertrack.html">mod_usertrack</a></code> sets a cookie which can be logged
  62     via <code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code> configurable logging formats:</p>
  63
  64     <pre class="prettyprint lang-config">LogFormat "%{Apache}n %r %t" usertrack
  65 CustomLog "logs/clickstream.log" usertrack</pre>
  66
  67
  68 </div>
  69 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  70 <div class="directive-section"><h2><a name="CookieDomain" id="CookieDomain">CookieDomain</a> <a name="cookiedomain" id="cookiedomain">Directive</a></h2>
  71 <table class="directive">
  72 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The domain to which the tracking cookie applies</td></tr>
  73 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieDomain <em>domain</em></code></td></tr>
  74 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  75 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
  76 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  77 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
  78 </table>
  79
  80     <p>This directive controls the setting of the domain to which
  81     the tracking cookie applies. If not present, no domain is
  82     included in the cookie header field.</p>
  83
  84     <p>The domain string <strong>must</strong> begin with a dot, and
  85     <strong>must</strong> include at least one embedded dot. That is,
  86     <code>.example.com</code> is legal, but <code>www.example.com</code> and
  87     <code>.com</code> are not.</p>
  88
  89     <div class="note">Most browsers in use today will not allow cookies to be set
  90     for a two-part top level domain, such as <code>.co.uk</code>,
  91     although such a domain ostensibly fulfills the requirements
  92     above.<br />
  93
  94     These domains are equivalent to top level domains such as
  95     <code>.com</code>, and allowing such cookies may be a security
  96     risk. Thus, if you are under a two-part top level domain, you
  97     should still use your actual domain, as you would with any other top
  98     level domain (for example <code>.example.co.uk</code>).
  99     </div>
 100
 101     <pre class="prettyprint lang-config">CookieDomain .example.com</pre>
 102
 103
 104 </div>
 105 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 106 <div class="directive-section"><h2><a name="CookieExpires" id="CookieExpires">CookieExpires</a> <a name="cookieexpires" id="cookieexpires">Directive</a></h2>
 107 <table class="directive">
 108 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Expiry time for the tracking cookie</td></tr>
 109 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieExpires <em>expiry-period</em></code></td></tr>
 110 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 111 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 112 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 113 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
 114 </table>
 115     <p>When used, this directive sets an expiry time on the cookie
 116     generated by the usertrack module. The <em>expiry-period</em>
 117     can be given either as a number of seconds, or in the format
 118     such as "2 weeks 3 days 7 hours". Valid denominations are:
 119     years, months, weeks, days, hours, minutes and seconds. If the expiry
 120     time is in any format other than one number indicating the
 121     number of seconds, it must be enclosed by double quotes.</p>
 122
 123     <p>If this directive is not used, cookies last only for the
 124     current browser session.</p>
 125
 126     <pre class="prettyprint lang-config">CookieExpires "3 weeks"</pre>
 127
 128
 129 </div>
 130 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 131 <div class="directive-section"><h2><a name="CookieName" id="CookieName">CookieName</a> <a name="cookiename" id="cookiename">Directive</a></h2>
 132 <table class="directive">
 133 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Name of the tracking cookie</td></tr>
 134 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieName <em>token</em></code></td></tr>
 135 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CookieName Apache</code></td></tr>
 136 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 137 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 138 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 139 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
 140 </table>
 141     <p>This directive allows you to change the name of the cookie
 142     this module uses for its tracking purposes. By default the
 143     cookie is named "<code>Apache</code>".</p>
 144
 145     <p>You must specify a valid cookie name; results are
 146     unpredictable if you use a name containing unusual characters.
 147     Valid characters include A-Z, a-z, 0-9, "_", and "-".</p>
 148
 149     <pre class="prettyprint lang-config">CookieName clicktrack</pre>
 150
 151
 152 </div>
 153 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 154 <div class="directive-section"><h2><a name="CookieStyle" id="CookieStyle">CookieStyle</a> <a name="cookiestyle" id="cookiestyle">Directive</a></h2>
 155 <table class="directive">
 156 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Format of the cookie header field</td></tr>
 157 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieStyle
 158     <em>Netscape|Cookie|Cookie2|RFC2109|RFC2965</em></code></td></tr>
 159 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CookieStyle Netscape</code></td></tr>
 160 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 161 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 162 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 163 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
 164 </table>
 165     <p>This directive controls the format of the cookie header
 166     field. The three formats allowed are:</p>
 167
 168     <ul>
 169       <li><strong>Netscape</strong>, which is the original but now deprecated
 170       syntax. This is the default, and the syntax Apache has
 171       historically used.</li>
 172
 173       <li><strong>Cookie</strong> or <strong>RFC2109</strong>, which is the syntax that
 174       superseded the Netscape syntax.</li>
 175
 176       <li><strong>Cookie2</strong> or <strong>RFC2965</strong>, which is the most
 177       current cookie syntax.</li>
 178     </ul>
 179
 180     <p>Not all clients can understand all of these formats, but you
 181     should use the newest one that is generally acceptable to your
 182     users' browsers. At the time of writing, most browsers support all
 183     three of these formats, with <code>Cookie2</code> being the
 184     preferred format.</p>
 185
 186     <pre class="prettyprint lang-config">CookieStyle Cookie2</pre>
 187
 188
 189 </div>
 190 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 191 <div class="directive-section"><h2><a name="CookieTracking" id="CookieTracking">CookieTracking</a> <a name="cookietracking" id="cookietracking">Directive</a></h2>
 192 <table class="directive">
 193 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables tracking cookie</td></tr>
 194 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieTracking on|off</code></td></tr>
 195 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CookieTracking off</code></td></tr>
 196 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 197 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 198 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 199 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
 200 </table>
 201     <p>When <code class="module"><a href="../mod/mod_usertrack.html">mod_usertrack</a></code> is loaded, and
 202     <code>CookieTracking on</code> is set, Apache will send a
 203     user-tracking cookie for all new requests. This directive can
 204     be used to turn this behavior on or off on a per-server or
 205     per-directory basis. By default, enabling
 206     <code class="module"><a href="../mod/mod_usertrack.html">mod_usertrack</a></code> will <strong>not</strong>
 207     activate cookies. </p>
 208
 209     <pre class="prettyprint lang-config">CookieTracking on</pre>
 210
 211
 212
 213 </div>
 214 </div>
 215 <div class="bottomlang">
 216 <p><span>Available Languages: </span><a href="../en/mod/mod_usertrack.html" title="English">&nbsp;en&nbsp;</a></p>
 217 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 218 <script type="text/javascript"><!--//--><![CDATA[//><!--
 219 var comments_shortname = 'httpd';
 220 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_usertrack.html';
 221 (function(w, d) {
 222     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 223         d.write('<div id="comments_thread"><\/div>');
 224         var s = d.createElement('script');
 225         s.type = 'text/javascript';
 226         s.async = true;
 227         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 228         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 229     }
 230     else {
 231         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 232     }
 233 })(window, document);
 234 //--><!]]></script></div><div id="footer">
 235 <p class="apache">Copyright 2016 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>
 236 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 237 if (typeof(prettyPrint) !== 'undefined') {
 238     prettyPrint();
 239 }
 240 //--><!]]></script>
 241 </body></html>