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