blob: c7c5f0860616bd79110214da0944472be9263160 [file] [log] [blame]
<?xml version="1.0"?>
<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.fr.xsl"?>
<!-- English Revision : 1829394 -->
<!-- French translation : Lucien GENTIS -->
<!-- Reviewed by : Vincent Deffontaines -->
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<modulesynopsis metafile="mod_usertrack.xml.meta">
<name>mod_usertrack</name>
<description>
Journalisation <em>Clickstream</em> des liens parcourus par un
utilisateur sur un site
</description>
<status>Extension</status>
<sourcefile>mod_usertrack.c</sourcefile>
<identifier>usertrack_module</identifier>
<summary>
<p>Ce module permet de suivre le parcours d'un utilisateur &agrave; travers
votre site web en faisant appel aux cookies de navigateur.</p>
</summary>
<section id="logging">
<title>Journalisation</title>
<p><module>mod_usertrack</module> d&eacute;finit un cookie qui peut &ecirc;tre
journalis&eacute; via les formats configurables du module
<module>mod_log_config</module> :</p>
<highlight language="config">
LogFormat "%{Apache}n %r %t" usertrack
CustomLog "logs/clickstream.log" usertrack
</highlight>
</section>
<directivesynopsis>
<name>CookieDomain</name>
<description>Le domaine auquel le cookie traceur
s'applique</description>
<syntax>CookieDomain <em>domaine</em></syntax>
<contextlist>
<context>server config</context>
<context>virtual host</context>
<context>directory</context>
<context>.htaccess</context>
</contextlist>
<override>FileInfo</override>
<usage>
<p>Cette directive permet de d&eacute;finir le domaine auquel le cookie
traceur s'applique. Si elle n'est pas pr&eacute;sente, aucun domaine n'est
inclus dans le champ d'en-t&ecirc;te cookie.</p>
<p>La cha&icirc;ne dommaine <strong>doit</strong> commencer par un point,
et <strong>doit</strong> comporter au moins un point entour&eacute;
d'autres caract&egrave;res. Par exemple, <code>.example.com</code> est
une cha&icirc;ne valide, mais <code>www.example.com</code> et
<code>.com</code> ne le sont pas.</p>
<note>La plupart des navigateurs utilis&eacute;s actuellement n'autorisent
pas la d&eacute;finition de cookies pour un domaine racine de deux niveaux,
tel que <code>.co.uk</code>, bien qu'un tel domaine remplisse les
conditions de validit&eacute; d&eacute;crites ci-dessus.<br />
Ces domaines sont &eacute;quivalents &agrave; des domaines racines comme
<code>.com</code>, et autoriser de tels cookies peut constituer un
risque en mati&egrave;re de s&eacute;curit&eacute;. Ainsi, si vous vous situez sous un
domaine racine de deux niveaux, vous devez encore utiliser votre
domaine v&eacute;ritable, comme vous le feriez avec tout autre domaine
racine (par exemple <code>.example.co.uk</code>).
</note>
<highlight language="config">
CookieDomain .example.com
</highlight>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>CookieExpires</name>
<description>Dur&eacute;e avant expiration du cookie traceur</description>
<syntax>CookieExpires <em>dur&eacute;e</em></syntax>
<contextlist>
<context>server config</context>
<context>virtual host</context>
<context>directory</context>
<context>.htaccess</context>
</contextlist>
<override>FileInfo</override>
<usage>
<p>Lorsqu'elle est utilis&eacute;e, cette directive d&eacute;finit une dur&eacute;e avant
l'expiration du cookie g&eacute;n&eacute;r&eacute; par le module usertrack. La
<em>dur&eacute;e</em> peut &ecirc;tre sp&eacute;cifi&eacute;e sous la forme d'un nombre de
secondes, ou sous une forme du
style "2 weeks 3 days 7 hours". les termes valides sont : years,
months, weeks, days, hours, minutes et seconds. Si la dur&eacute;e est
sp&eacute;cifi&eacute;e dans un format autre qu'un nombre de secondes, elle doit
&ecirc;tre entour&eacute;e de guillemets.</p>
<p>Si cette directive est absente, la dur&eacute;e de vie des cookies est
limit&eacute;e &agrave; la session actuelle du navigateur.</p>
<highlight language="config">
CookieExpires "3 weeks"
</highlight>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>CookieName</name>
<description>Nom du cookie traceur</description>
<syntax>CookieName <em>symbole</em></syntax>
<default>CookieName Apache</default>
<contextlist>
<context>server config</context>
<context>virtual host</context>
<context>directory</context>
<context>.htaccess</context>
</contextlist>
<override>FileInfo</override>
<usage>
<p>Cette directive vous permet de modifier le nom du cookie que ce
module utilise pour sa journalisation. Le nom par d&eacute;faut du cookie
est "<code>Apache</code>".</p>
<p>Vous devez sp&eacute;cifier un nom de cookie valide ; les r&eacute;sultats sont
impr&eacute;visibles si vous utilisez un nom contenant des caract&egrave;res
inhabituels. Les caract&egrave;res valides font partie des intervales A-Z,
a-z, 0-9, "_", et "-".</p>
<highlight language="config">
CookieName clicktrack
</highlight>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>CookieStyle</name>
<description>Format du champ d'en-t&ecirc;te cookie</description>
<syntax>CookieStyle
Netscape|Cookie|Cookie2|RFC2109|RFC2965</syntax>
<default>CookieStyle Netscape</default>
<contextlist>
<context>server config</context>
<context>virtual host</context>
<context>directory</context>
<context>.htaccess</context>
</contextlist>
<override>FileInfo</override>
<usage>
<p>Cette directive permet de contr&ocirc;ler le format du champ d'en-t&ecirc;te
cookie. Les trois formats autoris&eacute;s sont :</p>
<ul>
<li><strong>Netscape</strong> : il s'agit du format original, mais
est d&eacute;sormais obsol&egrave;te. C'est le format par d&eacute;faut et il
correspond &agrave; la syntaxe historique utilis&eacute;e par Apache.</li>
<li><strong>Cookie</strong> ou <strong>RFC2109</strong> : c'est la
syntaxe qui remplace la syntaxe Netscape.</li>
<li><strong>Cookie2</strong> ou <strong>RFC2965</strong> : c'est
la syntaxe de cookie la plus actuelle.</li>
</ul>
<p>Tous les clients ne supportent pas l'ensemble de ces formats,
mais il est conseill&eacute; d'utiliser le plus r&eacute;cent qui sera en g&eacute;n&eacute;ral
support&eacute; par le navigateur utilis&eacute; par vos utilisateurs. A l'heure o&ugrave; ce
document est &eacute;crit, la plupart des navigateurs supportent ces trois
formats, <code>Cookie2</code> &eacute;tant le format recommand&eacute;.</p>
<highlight language="config">
CookieStyle Cookie2
</highlight>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>CookieTracking</name>
<description>Active le cookie traceur</description>
<syntax>CookieTracking on|off</syntax>
<default>CookieTracking off</default>
<contextlist>
<context>server config</context>
<context>virtual host</context>
<context>directory</context>
<context>.htaccess</context>
</contextlist>
<override>FileInfo</override>
<usage>
<p>Lorsque le module <module>mod_usertrack</module> est charg&eacute;, et
si <code>CookieTracking on</code> est d&eacute;finie, Apache enverra un
cookie traceur pour toute nouvelle requ&ecirc;te. Cette directive peut
&ecirc;tre utilis&eacute;e pour activer ou d&eacute;sactiver ce comportement pour un
serveur virtuel ou un r&eacute;pertoire. Par d&eacute;faut, l'activation de
<module>mod_usertrack</module> ne suffit <strong>pas</strong> pour
activer les cookies.</p>
<highlight language="config">
CookieTracking on
</highlight>
</usage>
</directivesynopsis>
</modulesynopsis>