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> |
  30 <a href="../fr/mod/mod_usertrack.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
  31 </div>
  32 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>
  33 <em>Clickstream</em> logging of user activity on a site
  34 </td></tr>
  35 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  36 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>usertrack_module</td></tr>
  37 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_usertrack.c</td></tr></table>
  38 <h3>Summary</h3>
  39
  40     <p>Provides tracking of a user through your website via browser
  41     cookies.</p>
  42 </div>
  43 <div id="quickview"><h3>Topics</h3>
  44 <ul id="topics">
  45 <li><img alt="" src="../images/down.gif" /> <a href="#logging">Logging</a></li>
  46 </ul><h3 class="directives">Directives</h3>
  47 <ul id="toc">
  48 <li><img alt="" src="../images/down.gif" /> <a href="#cookiedomain">CookieDomain</a></li>
  49 <li><img alt="" src="../images/down.gif" /> <a href="#cookieexpires">CookieExpires</a></li>
  50 <li><img alt="" src="../images/down.gif" /> <a href="#cookiename">CookieName</a></li>
  51 <li><img alt="" src="../images/down.gif" /> <a href="#cookiestyle">CookieStyle</a></li>
  52 <li><img alt="" src="../images/down.gif" /> <a href="#cookietracking">CookieTracking</a></li>
  53 </ul>
  54 <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>
  55 <ul class="seealso">
  56 <li><a href="#comments_section">Comments</a></li></ul></div>
  57 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  58 <div class="section">
  59 <h2><a name="logging" id="logging">Logging</a><a title="Permanent link" href="#logging" class="permalink">&para;</a></h2>
  60
  61
  62     <p><code class="module"><a href="../mod/mod_usertrack.html">mod_usertrack</a></code> sets a cookie which can be logged
  63     via <code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code> configurable logging formats:</p>
  64
  65     <pre class="prettyprint lang-config">LogFormat "%{Apache}n %r %t" usertrack
  66 CustomLog "logs/clickstream.log" usertrack</pre>
  67
  68
  69 </div>
  70 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  71 <div class="directive-section"><h2><a name="CookieDomain" id="CookieDomain">CookieDomain</a> <a name="cookiedomain" id="cookiedomain">Directive</a><a title="Permanent link" href="#cookiedomain" class="permalink">&para;</a></h2>
  72 <table class="directive">
  73 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The domain to which the tracking cookie applies</td></tr>
  74 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieDomain <em>domain</em></code></td></tr>
  75 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  76 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
  77 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  78 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
  79 </table>
  80
  81     <p>This directive controls the setting of the domain to which
  82     the tracking cookie applies. If not present, no domain is
  83     included in the cookie header field.</p>
  84
  85     <p>The domain string <strong>must</strong> begin with a dot, and
  86     <strong>must</strong> include at least one embedded dot. That is,
  87     <code>.example.com</code> is legal, but <code>www.example.com</code> and
  88     <code>.com</code> are not.</p>
  89
  90     <div class="note">Most browsers in use today will not allow cookies to be set
  91     for a two-part top level domain, such as <code>.co.uk</code>,
  92     although such a domain ostensibly fulfills the requirements
  93     above.<br />
  94
  95     These domains are equivalent to top level domains such as
  96     <code>.com</code>, and allowing such cookies may be a security
  97     risk. Thus, if you are under a two-part top level domain, you
  98     should still use your actual domain, as you would with any other top
  99     level domain (for example <code>.example.co.uk</code>).
 100     </div>
 101
 102     <pre class="prettyprint lang-config">CookieDomain .example.com</pre>
 103
 104
 105 </div>
 106 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 107 <div class="directive-section"><h2><a name="CookieExpires" id="CookieExpires">CookieExpires</a> <a name="cookieexpires" id="cookieexpires">Directive</a><a title="Permanent link" href="#cookieexpires" class="permalink">&para;</a></h2>
 108 <table class="directive">
 109 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Expiry time for the tracking cookie</td></tr>
 110 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieExpires <em>expiry-period</em></code></td></tr>
 111 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 112 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 113 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 114 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
 115 </table>
 116     <p>When used, this directive sets an expiry time on the cookie
 117     generated by the usertrack module. The <em>expiry-period</em>
 118     can be given either as a number of seconds, or in the format
 119     such as "2 weeks 3 days 7 hours". Valid denominations are:
 120     years, months, weeks, days, hours, minutes and seconds. If the expiry
 121     time is in any format other than one number indicating the
 122     number of seconds, it must be enclosed by double quotes.</p>
 123
 124     <p>If this directive is not used, cookies last only for the
 125     current browser session.</p>
 126
 127     <pre class="prettyprint lang-config">CookieExpires "3 weeks"</pre>
 128
 129
 130 </div>
 131 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 132 <div class="directive-section"><h2><a name="CookieName" id="CookieName">CookieName</a> <a name="cookiename" id="cookiename">Directive</a><a title="Permanent link" href="#cookiename" class="permalink">&para;</a></h2>
 133 <table class="directive">
 134 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Name of the tracking cookie</td></tr>
 135 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieName <em>token</em></code></td></tr>
 136 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CookieName Apache</code></td></tr>
 137 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 138 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 139 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 140 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
 141 </table>
 142     <p>This directive allows you to change the name of the cookie
 143     this module uses for its tracking purposes. By default the
 144     cookie is named "<code>Apache</code>".</p>
 145
 146     <p>You must specify a valid cookie name; results are
 147     unpredictable if you use a name containing unusual characters.
 148     Valid characters include A-Z, a-z, 0-9, "_", and "-".</p>
 149
 150     <pre class="prettyprint lang-config">CookieName clicktrack</pre>
 151
 152
 153 </div>
 154 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 155 <div class="directive-section"><h2><a name="CookieStyle" id="CookieStyle">CookieStyle</a> <a name="cookiestyle" id="cookiestyle">Directive</a><a title="Permanent link" href="#cookiestyle" class="permalink">&para;</a></h2>
 156 <table class="directive">
 157 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Format of the cookie header field</td></tr>
 158 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieStyle
 159     Netscape|Cookie|Cookie2|RFC2109|RFC2965</code></td></tr>
 160 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CookieStyle Netscape</code></td></tr>
 161 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 162 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 163 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 164 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
 165 </table>
 166     <p>This directive controls the format of the cookie header
 167     field. The three formats allowed are:</p>
 168
 169     <ul>
 170       <li><strong>Netscape</strong>, which is the original but now deprecated
 171       syntax. This is the default, and the syntax Apache has
 172       historically used.</li>
 173
 174       <li><strong>Cookie</strong> or <strong>RFC2109</strong>, which is the syntax that
 175       superseded the Netscape syntax.</li>
 176
 177       <li><strong>Cookie2</strong> or <strong>RFC2965</strong>, which is the most
 178       current cookie syntax.</li>
 179     </ul>
 180
 181     <p>Not all clients can understand all of these formats, but you
 182     should use the newest one that is generally acceptable to your
 183     users' browsers. At the time of writing, most browsers support all
 184     three of these formats, with <code>Cookie2</code> being the
 185     preferred format.</p>
 186
 187     <pre class="prettyprint lang-config">CookieStyle Cookie2</pre>
 188
 189
 190 </div>
 191 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 192 <div class="directive-section"><h2><a name="CookieTracking" id="CookieTracking">CookieTracking</a> <a name="cookietracking" id="cookietracking">Directive</a><a title="Permanent link" href="#cookietracking" class="permalink">&para;</a></h2>
 193 <table class="directive">
 194 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables tracking cookie</td></tr>
 195 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieTracking on|off</code></td></tr>
 196 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CookieTracking off</code></td></tr>
 197 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 198 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 199 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 200 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
 201 </table>
 202     <p>When <code class="module"><a href="../mod/mod_usertrack.html">mod_usertrack</a></code> is loaded, and
 203     <code>CookieTracking on</code> is set, Apache will send a
 204     user-tracking cookie for all new requests. This directive can
 205     be used to turn this behavior on or off on a per-server or
 206     per-directory basis. By default, enabling
 207     <code class="module"><a href="../mod/mod_usertrack.html">mod_usertrack</a></code> will <strong>not</strong>
 208     activate cookies. </p>
 209
 210     <pre class="prettyprint lang-config">CookieTracking on</pre>
 211
 212
 213
 214 </div>
 215 </div>
 216 <div class="bottomlang">
 217 <p><span>Available Languages: </span><a href="../en/mod/mod_usertrack.html" title="English">&nbsp;en&nbsp;</a> |
 218 <a href="../fr/mod/mod_usertrack.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
 219 </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>
 220 <script type="text/javascript"><!--//--><![CDATA[//><!--
 221 var comments_shortname = 'httpd';
 222 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_usertrack.html';
 223 (function(w, d) {
 224     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 225         d.write('<div id="comments_thread"><\/div>');
 226         var s = d.createElement('script');
 227         s.type = 'text/javascript';
 228         s.async = true;
 229         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 230         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 231     }
 232     else {
 233         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 234     }
 235 })(window, document);
 236 //--><!]]></script></div><div id="footer">
 237 <p class="apache">Copyright 2018 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>
 238 <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[//><!--
 239 if (typeof(prettyPrint) !== 'undefined') {
 240     prettyPrint();
 241 }
 242 //--><!]]></script>
 243 </body></html>