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
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.js" type="text/javascript">
15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
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.5</p>
20 <img alt="" src="../images/feather.gif" /></div>
21 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
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.5</a> > <a href="./">Modules</a></div>
24 <div id="page-content">
25 <div id="preamble"><h1>Apache Module mod_usertrack</h1>
27 <p><span>Available Languages: </span><a href="../en/mod/mod_usertrack.html" title="English"> en </a></p>
29 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>
30 <em>Clickstream</em> logging of user activity on a site
32 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
33 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>usertrack_module</td></tr>
34 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_usertrack.c</td></tr></table>
37 <p>Provides tracking of a user through your website via browser
40 <div id="quickview"><h3 class="directives">Directives</h3>
42 <li><img alt="" src="../images/down.gif" /> <a href="#cookiedomain">CookieDomain</a></li>
43 <li><img alt="" src="../images/down.gif" /> <a href="#cookieexpires">CookieExpires</a></li>
44 <li><img alt="" src="../images/down.gif" /> <a href="#cookiename">CookieName</a></li>
45 <li><img alt="" src="../images/down.gif" /> <a href="#cookiestyle">CookieStyle</a></li>
46 <li><img alt="" src="../images/down.gif" /> <a href="#cookietracking">CookieTracking</a></li>
50 <li><img alt="" src="../images/down.gif" /> <a href="#logging">Logging</a></li>
51 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
52 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
54 <h2><a name="logging" id="logging">Logging</a></h2>
57 <p><code class="module"><a href="../mod/mod_usertrack.html">mod_usertrack</a></code> sets a cookie which can be logged
58 via <code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code> configurable logging formats:</p>
60 <pre class="prettyprint lang-config">
61 LogFormat "%{Apache}n %r %t" usertrack
62 CustomLog logs/clickstream.log usertrack
67 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
68 <div class="directive-section"><h2><a name="CookieDomain" id="CookieDomain">CookieDomain</a> <a name="cookiedomain" id="cookiedomain">Directive</a></h2>
69 <table class="directive">
70 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The domain to which the tracking cookie applies</td></tr>
71 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieDomain <em>domain</em></code></td></tr>
72 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
73 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
74 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
75 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
78 <p>This directive controls the setting of the domain to which
79 the tracking cookie applies. If not present, no domain is
80 included in the cookie header field.</p>
82 <p>The domain string <strong>must</strong> begin with a dot, and
83 <strong>must</strong> include at least one embedded dot. That is,
84 <code>.example.com</code> is legal, but <code>www.example.com</code> and
85 <code>.com</code> are not.</p>
87 <div class="note">Most browsers in use today will not allow cookies to be set
88 for a two-part top level domain, such as <code>.co.uk</code>,
89 although such a domain ostensibly fulfills the requirements
92 These domains are equivalent to top level domains such as
93 <code>.com</code>, and allowing such cookies may be a security
94 risk. Thus, if you are under a two-part top level domain, you
95 should still use your actual domain, as you would with any other top
96 level domain (for example <code>.example.co.uk</code>).
99 <pre class="prettyprint lang-config">
100 CookieDomain .example.com
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>
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>
123 <p>If this directive is not used, cookies last only for the
124 current browser session.</p>
126 <pre class="prettyprint lang-config">
127 CookieExpires "3 weeks"
132 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
133 <div class="directive-section"><h2><a name="CookieName" id="CookieName">CookieName</a> <a name="cookiename" id="cookiename">Directive</a></h2>
134 <table class="directive">
135 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Name of the tracking cookie</td></tr>
136 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieName <em>token</em></code></td></tr>
137 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CookieName Apache</code></td></tr>
138 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
139 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
140 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
141 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
143 <p>This directive allows you to change the name of the cookie
144 this module uses for its tracking purposes. By default the
145 cookie is named "<code>Apache</code>".</p>
147 <p>You must specify a valid cookie name; results are
148 unpredictable if you use a name containing unusual characters.
149 Valid characters include A-Z, a-z, 0-9, "_", and "-".</p>
151 <pre class="prettyprint lang-config">
152 CookieName clicktrack
157 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
158 <div class="directive-section"><h2><a name="CookieStyle" id="CookieStyle">CookieStyle</a> <a name="cookiestyle" id="cookiestyle">Directive</a></h2>
159 <table class="directive">
160 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Format of the cookie header field</td></tr>
161 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieStyle
162 <em>Netscape|Cookie|Cookie2|RFC2109|RFC2965</em></code></td></tr>
163 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CookieStyle Netscape</code></td></tr>
164 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
165 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
166 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
167 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
169 <p>This directive controls the format of the cookie header
170 field. The three formats allowed are:</p>
173 <li><strong>Netscape</strong>, which is the original but now deprecated
174 syntax. This is the default, and the syntax Apache has
175 historically used.</li>
177 <li><strong>Cookie</strong> or <strong>RFC2109</strong>, which is the syntax that
178 superseded the Netscape syntax.</li>
180 <li><strong>Cookie2</strong> or <strong>RFC2965</strong>, which is the most
181 current cookie syntax.</li>
184 <p>Not all clients can understand all of these formats, but you
185 should use the newest one that is generally acceptable to your
186 users' browsers. At the time of writing, most browsers support all
187 three of these formats, with <code>Cookie2</code> being the
188 preferred format.</p>
190 <pre class="prettyprint lang-config">
196 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
197 <div class="directive-section"><h2><a name="CookieTracking" id="CookieTracking">CookieTracking</a> <a name="cookietracking" id="cookietracking">Directive</a></h2>
198 <table class="directive">
199 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables tracking cookie</td></tr>
200 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CookieTracking on|off</code></td></tr>
201 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CookieTracking off</code></td></tr>
202 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
203 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
204 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
205 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_usertrack</td></tr>
207 <p>When <code class="module"><a href="../mod/mod_usertrack.html">mod_usertrack</a></code> is loaded, and
208 <code>CookieTracking on</code> is set, Apache will send a
209 user-tracking cookie for all new requests. This directive can
210 be used to turn this behavior on or off on a per-server or
211 per-directory basis. By default, enabling
212 <code class="module"><a href="../mod/mod_usertrack.html">mod_usertrack</a></code> will <strong>not</strong>
213 activate cookies. </p>
215 <pre class="prettyprint lang-config">
223 <div class="bottomlang">
224 <p><span>Available Languages: </span><a href="../en/mod/mod_usertrack.html" title="English"> en </a></p>
225 </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>
226 <script type="text/javascript"><!--//--><![CDATA[//><!--
227 var comments_shortname = 'httpd';
228 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_usertrack.html';
230 if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
231 d.write('<div id="comments_thread"><\/div>');
232 var s = d.createElement('script');
233 s.type = 'text/javascript';
235 s.src = 'https://c.apaste.info/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
236 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
239 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
241 })(window, document);
242 //--><!]]></script></div><div id="footer">
243 <p class="apache">Copyright 2012 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>
244 <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[//><!--
245 if (typeof(prettyPrint) !== 'undefined') {