1ad6a171cee261581034996877314cf29fc92227rbowen<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
e942c741056732f50da2074b36fe59805d370650slive<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
5f5d1b4cc970b7f06ff8ef6526128e9a27303d88nd<!-- $LastChangedRevision$ -->
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding Licensed to the Apache Software Foundation (ASF) under one or more
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding contributor license agreements. See the NOTICE file distributed with
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding this work for additional information regarding copyright ownership.
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding The ASF licenses this file to You under the Apache License, Version 2.0
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding (the "License"); you may not use this file except in compliance with
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding the License. You may obtain a copy of the License at
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd Unless required by applicable law or agreed to in writing, software
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd distributed under the License is distributed on an "AS IS" BASIS,
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd See the License for the specific language governing permissions and
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd limitations under the License.
1ad6a171cee261581034996877314cf29fc92227rbowen<description>
6eef889fc0b7cd42c4c8ca7e8e094dc2c0b030fcslive<em>Clickstream</em> logging of user activity on a site
1ad6a171cee261581034996877314cf29fc92227rbowen</description>
0d7cadfab793cd88b98342b4d34410ab6e773883rbowen <p>Provides tracking of a user through your website via browser
0d7cadfab793cd88b98342b4d34410ab6e773883rbowen cookies.</p>
0d7cadfab793cd88b98342b4d34410ab6e773883rbowen <p><module>mod_usertrack</module> sets a cookie which can be logged
0d7cadfab793cd88b98342b4d34410ab6e773883rbowen via <module>mod_log_config</module> configurable logging formats:</p>
2d94fe5813abab3b802f233b292b55acdf858a2chumbedoohLogFormat "%{Apache}n %r %t" usertrack
2d94fe5813abab3b802f233b292b55acdf858a2chumbedooh </highlight>
1ad6a171cee261581034996877314cf29fc92227rbowen<directivesynopsis>
6eef889fc0b7cd42c4c8ca7e8e094dc2c0b030fcslive<description>The domain to which the tracking cookie applies</description>
1ad6a171cee261581034996877314cf29fc92227rbowen<contextlist>
1ad6a171cee261581034996877314cf29fc92227rbowen</contextlist>
1ad6a171cee261581034996877314cf29fc92227rbowen <p>This directive controls the setting of the domain to which
1ad6a171cee261581034996877314cf29fc92227rbowen the tracking cookie applies. If not present, no domain is
1ad6a171cee261581034996877314cf29fc92227rbowen included in the cookie header field.</p>
a4bd20fca128fbe09c54d02d96fa92be3b402297patrikj <p>The domain string <strong>must</strong> begin with a dot, and
a4bd20fca128fbe09c54d02d96fa92be3b402297patrikj <strong>must</strong> include at least one embedded dot. That is,
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <code>.example.com</code> is legal, but <code>www.example.com</code> and
d8bce40c41601a29555b84b190abd516a37bc11anoirin <note>Most browsers in use today will not allow cookies to be set
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim for a two-part top level domain, such as <code>.co.uk</code>,
d8bce40c41601a29555b84b190abd516a37bc11anoirin although such a domain ostensibly fulfills the requirements
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim above.<br />
d8bce40c41601a29555b84b190abd516a37bc11anoirin These domains are equivalent to top level domains such as
d8bce40c41601a29555b84b190abd516a37bc11anoirin <code>.com</code>, and allowing such cookies may be a security
d8bce40c41601a29555b84b190abd516a37bc11anoirin risk. Thus, if you are under a two-part top level domain, you
d8bce40c41601a29555b84b190abd516a37bc11anoirin should still use your actual domain, as you would with any other top
0d7cadfab793cd88b98342b4d34410ab6e773883rbowen level domain (for example <code>.example.co.uk</code>).
2d94fe5813abab3b802f233b292b55acdf858a2chumbedooh </highlight>
1ad6a171cee261581034996877314cf29fc92227rbowen</directivesynopsis>
1ad6a171cee261581034996877314cf29fc92227rbowen<directivesynopsis>
6eef889fc0b7cd42c4c8ca7e8e094dc2c0b030fcslive<description>Expiry time for the tracking cookie</description>
1ad6a171cee261581034996877314cf29fc92227rbowen<contextlist>
1ad6a171cee261581034996877314cf29fc92227rbowen</contextlist>
1ad6a171cee261581034996877314cf29fc92227rbowen <p>When used, this directive sets an expiry time on the cookie
1ad6a171cee261581034996877314cf29fc92227rbowen generated by the usertrack module. The <em>expiry-period</em>
1ad6a171cee261581034996877314cf29fc92227rbowen can be given either as a number of seconds, or in the format
1ad6a171cee261581034996877314cf29fc92227rbowen such as "2 weeks 3 days 7 hours". Valid denominations are:
3e989ed8d4cf8733a743921e078f21021f4001a0kess years, months, weeks, days, hours, minutes and seconds. If the expiry
1ad6a171cee261581034996877314cf29fc92227rbowen time is in any format other than one number indicating the
1ad6a171cee261581034996877314cf29fc92227rbowen number of seconds, it must be enclosed by double quotes.</p>
1ad6a171cee261581034996877314cf29fc92227rbowen <p>If this directive is not used, cookies last only for the
1ad6a171cee261581034996877314cf29fc92227rbowen current browser session.</p>
82489978ef71322bce18e6f92d2a938b87fd434erbowen CookieExpires "3 weeks"
2d94fe5813abab3b802f233b292b55acdf858a2chumbedooh </highlight>
1ad6a171cee261581034996877314cf29fc92227rbowen</directivesynopsis>
1ad6a171cee261581034996877314cf29fc92227rbowen<directivesynopsis>
1ad6a171cee261581034996877314cf29fc92227rbowen<contextlist>
1ad6a171cee261581034996877314cf29fc92227rbowen</contextlist>
1ad6a171cee261581034996877314cf29fc92227rbowen <p>This directive allows you to change the name of the cookie
1ad6a171cee261581034996877314cf29fc92227rbowen this module uses for its tracking purposes. By default the
1ad6a171cee261581034996877314cf29fc92227rbowen <p>You must specify a valid cookie name; results are
1ad6a171cee261581034996877314cf29fc92227rbowen unpredictable if you use a name containing unusual characters.
1ad6a171cee261581034996877314cf29fc92227rbowen Valid characters include A-Z, a-z, 0-9, "_", and "-".</p>
82489978ef71322bce18e6f92d2a938b87fd434erbowen CookieName clicktrack
2d94fe5813abab3b802f233b292b55acdf858a2chumbedooh </highlight>
1ad6a171cee261581034996877314cf29fc92227rbowen</directivesynopsis>
1ad6a171cee261581034996877314cf29fc92227rbowen<directivesynopsis>
6eef889fc0b7cd42c4c8ca7e8e094dc2c0b030fcslive<description>Format of the cookie header field</description>
1ad6a171cee261581034996877314cf29fc92227rbowen<syntax>CookieStyle
a4bd20fca128fbe09c54d02d96fa92be3b402297patrikj <em>Netscape|Cookie|Cookie2|RFC2109|RFC2965</em></syntax>
1ad6a171cee261581034996877314cf29fc92227rbowen<contextlist>
1ad6a171cee261581034996877314cf29fc92227rbowen</contextlist>
1ad6a171cee261581034996877314cf29fc92227rbowen <p>This directive controls the format of the cookie header
1ad6a171cee261581034996877314cf29fc92227rbowen field. The three formats allowed are:</p>
a4bd20fca128fbe09c54d02d96fa92be3b402297patrikj <li><strong>Netscape</strong>, which is the original but now deprecated
1ad6a171cee261581034996877314cf29fc92227rbowen syntax. This is the default, and the syntax Apache has
1ad6a171cee261581034996877314cf29fc92227rbowen historically used.</li>
a4bd20fca128fbe09c54d02d96fa92be3b402297patrikj <li><strong>Cookie</strong> or <strong>RFC2109</strong>, which is the syntax that
1ad6a171cee261581034996877314cf29fc92227rbowen superseded the Netscape syntax.</li>
a4bd20fca128fbe09c54d02d96fa92be3b402297patrikj <li><strong>Cookie2</strong> or <strong>RFC2965</strong>, which is the most
1ad6a171cee261581034996877314cf29fc92227rbowen current cookie syntax.</li>
68d8a1ebaac9798aa0530060cc7f9be842e34171lgentis <p>Not all clients can understand all of these formats, but you
1ad6a171cee261581034996877314cf29fc92227rbowen should use the newest one that is generally acceptable to your
0d7cadfab793cd88b98342b4d34410ab6e773883rbowen users' browsers. At the time of writing, most browsers support all
0d7cadfab793cd88b98342b4d34410ab6e773883rbowen three of these formats, with <code>Cookie2</code> being the
0d7cadfab793cd88b98342b4d34410ab6e773883rbowen preferred format.</p>
82489978ef71322bce18e6f92d2a938b87fd434erbowen CookieStyle Cookie2
2d94fe5813abab3b802f233b292b55acdf858a2chumbedooh </highlight>
1ad6a171cee261581034996877314cf29fc92227rbowen</directivesynopsis>
1ad6a171cee261581034996877314cf29fc92227rbowen<directivesynopsis>
1ad6a171cee261581034996877314cf29fc92227rbowen<contextlist>
1ad6a171cee261581034996877314cf29fc92227rbowen</contextlist>
d8bce40c41601a29555b84b190abd516a37bc11anoirin <p>When <module>mod_usertrack</module> is loaded, and
d8bce40c41601a29555b84b190abd516a37bc11anoirin <code>CookieTracking on</code> is set, Apache will send a
1ad6a171cee261581034996877314cf29fc92227rbowen user-tracking cookie for all new requests. This directive can
1ad6a171cee261581034996877314cf29fc92227rbowen be used to turn this behavior on or off on a per-server or
d8bce40c41601a29555b84b190abd516a37bc11anoirin per-directory basis. By default, enabling
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <module>mod_usertrack</module> will <strong>not</strong>
d8bce40c41601a29555b84b190abd516a37bc11anoirin activate cookies. </p>
82489978ef71322bce18e6f92d2a938b87fd434erbowen CookieTracking on
2d94fe5813abab3b802f233b292b55acdf858a2chumbedooh </highlight>
1ad6a171cee261581034996877314cf29fc92227rbowen</directivesynopsis>
1ad6a171cee261581034996877314cf29fc92227rbowen</modulesynopsis>