Ce guide est obsolète. Utilisez la nouvelle version sur le Help Desk Biapy:

Installer l'outil d'analyse Web AWStats sur Debian

Installation

Important: Ce guide est adapté à une installation d'Apache 2 réalisée à partir de mon guide Installer et configurer Apache 2 sur Debian 4.0 Etch (notamment la partie dédiée aux domaines virtuels). Si vous n'avez pas suivi mon guide pour installer Apache 2, soyez conscient qu'il vous faut une connaissance minimum de la configuration Apache et que vous devez faire l'effort de lire et comprendre les messages d'erreurs pour arriver au bout de ce guide. Sachez toutefois qu'en général, la modification consiste à remplacer la ou les lignes <VirtualHost *:80> par <VirtualHost *> (dur hein).

Installez Awstats, un outil de génération de mots de passe, et les dépendances des plugins :

command apt-get install awstats apg \
    libgeo-ipfree-perl libnet-ip-perl \
    libnet-dns-perl liburi-perl

Crééez un utilisateur système pour awstats :

command adduser --system --group --shell "/bin/sh" \
    --no-create-home --home "/var/lib/awstats" awstats
command adduser awstats adm

Modifiez les permissions pour prendre en compte ce nouvel utilisateur :

if [ -e "/var/lib/awstats" ]; then
  command chown awstats:www-data "/var/lib/awstats"
  command chown awstats:awstats /var/lib/awstats/*
fi
if [ -e "/var/cache/awstats" ]; then
  command chown awstats:www-data "/var/cache/awstats"
  command chown awstats:awstats /var/cache/awstats/*
fi

Remplacez la configuration cron fournie par Debian par une version capable de mettre à jour plusieurs sites :

command echo "# Awstats all sites update :
*/10 * * * * awstats [ -x '/usr/lib/cgi-bin/awstats.pl' -a -d '/etc/awstats' ] && command find '/etc/awstats' -type f -name 'awstats.*.conf' | command sed -e 's/.*awstats\.\(.*\)\.conf/\1/' | command xargs -ICONF /usr/lib/cgi-bin/awstats.pl -config=CONF -update

# Generate static reports:
#10 03 * * * awstats [ -x /usr/share/awstats/tools/buildstatic.sh ] && /usr/share/awstats/tools/buildstatic.sh" \
  > /etc/cron.d/awstats
/etc/init.d/cron reload

Important : Si vous utilisez la version "combined" des logs d'Apache 2, il faut configurer Awstats pour reconnaître ce format, sinon, les informations de référant et de navigateur ne sont pas prise en compte (et oui, je me suis fait piéger). Pour ce faire, utilisez la commande:

command sed -i -e 's/^LogFormat.*=.*/LogFormat=1/g' "/etc/awstats/awstats.conf"

Nous autorisons la vue de l'année complète via le navigateur :

command sed -i -e 's/^AllowFullYearView.*=.*/AllowFullYearView=3/g' "/etc/awstats/awstats.conf"

Nous copions le fichier de configuration par défaut d'AwStats afin de conserver un template "sûr":

command mv "/etc/awstats/awstats.conf" "/etc/awstats/awstats.conf.template"

Activez de manière globale les plugins intéressants de Awstats:

command echo 'LoadPlugin="tooltips"
LoadPlugin="decodeutfkeys"
LoadPlugin="ipv6"
LoadPlugin="geoipfree"' \
    >> /etc/awstats/awstats.conf.local

Sauvegardes

Pour sauvegarder votre installation, je vous propose d'utiliser Backup Manager. Pour l'installer, vous pouvez suivre mon guide:

Installer et configurer Backup Manager sur Debian

Une fois Backup Manager installé, configurer la sauvegarde des fichiers de l'application :

command update-bm-folders add "/etc/awstats"
command update-bm-folders add "/var/lib/awstats"

Configuration d'Apache avec belles URLs pour AWstats

Trois solutions s'offrent à vous pour utiliser AWStats. Ce guide en aborde 2 issues de mon esprit tordu, mais prolixe:

1. Mettre en place un domaine dédié aux statistiques AWstats.
2. Mettre en place un dossier /stats sur un domaine existant.
3. Pour information, la troisième solution consiste à utiliser AWStats depuis le dossier cgi-bin, mais sans les belles URLs.

En premier lieu, il vous faut mettre en place les éléments de configurations communs aux 2 méthodes expliquées dans ce guide.

ATTENTION: Soyez conscient que la configuration présentée dans ce guide est loin d'être parfaite. Le fait d'utiliser un seul et même domaine pour toutes les statistiques AWstats est problèmatique du point de vue de la confidentialité des données statistiques. En effet, malgré les quelques barrières posées par ce guide, un utilisateur ayant accès à une partie des statistiques AWstats peut voir toutes les autres moyennant quelques efforts. J'en suis conscient, et je fait avec car les données statistiques ne nécessitent pas une forte confidentialité pour moi. Pour vous cela peut être différent, aussi je tenais à vous prévenir.

Nous créons le dossier destiné à contenir le fichier des mots de passes :

/bin/mkdir --parent /etc/apache2/passwords

Nous créons un mot de passe pour le compte admin, autorisé à accéder à toutes les statistiques:

AWSTATS_PWD=$(/usr/bin/apg -q -a  0 -n 1 -M NCL)

Nous créons le fichier de mot de passe et nous y ajoutons le compte admin:

/usr/bin/htpasswd -cb /etc/apache2/passwords/awstats-users.pwd admin ${AWSTATS_PWD}

Affichez le mot de passe assigné à votre compte d' "administration" de AWStats (et retenez le !) :

/bin/echo "Le mot de passe pour l'utilisateur 'admin' est '${AWSTATS_PWD}'."

Nous nous assurons que le mod_rewrite d'Apache est actif:

a2enmod rewrite

AWStats sur un domaine dédié

Cette section décrit la mise en place d'un domaine dédié à AWStats. Le résultat obtenu est le suivant: Vous aurez accès aux statistiques des sites www.domaine.com et blog.domaine.com via les URL:

• http://stats.domaine.com/www.domaine.com
• http://stats.domaine.com/blog.domaine.com

Belles URL n'est-ce pas ? :) Pour obtenir ce résultat, nous allons mettre en place un domaine virtuel Apache utilisant une réécriture d'URL assez tordue :). Pour ce faire, commencez par renseigner le nom de domaine que vous souhaitez assigner à votre site de statistiques:

AWSTATS_DOMAIN=stats.domaine.com

Une fois ceci fait, nous téléchargeons le fichier modèle de notre hôte virtuel dédié à AWstats:

/usr/bin/wget http://howto.landure.fr/gnu-linux/debian-4-0-etch/installer-et-configurer-awstats-sur-debian-4-0-etch/awstats-virtual-host-template \
    --output-document=/etc/apache2/sites-available/${AWSTATS_DOMAIN}

Et nous le mettons à jour avec notre nom de domaine:

/bin/sed -i -e "s/AWSTATS_DOMAIN/${AWSTATS_DOMAIN}/" \
         /etc/apache2/sites-available/${AWSTATS_DOMAIN}

Remarque: Par défaut, le modèle d'hôte virtuel utilisé n'autorise que l'utilisateur "admin" à voir les sites. Cependant, si vous modifiez le fichier /etc/apache2/sites-available/AWSTATS_DOMAIN, vous trouverez la possibilité d'autoriser l'accès sans identification par mot de passe pour certaines adresse IP, ainsi qu'un exemple d'accès restreint aux statistiques d'un seul site pour un utilisateur donné.

Nous activons le nouveau site:

/usr/sbin/a2ensite ${AWSTATS_DOMAIN}

Une fois ceci fait, nous testons notre configuration pour vérifier qu'il n'y a aucun problème.

/usr/sbin/apache2ctl -t

Et nous rechargeons la configuration d'Apache:

/etc/init.d/apache2 force-reload

AWstats dans le dossier /stats d'un domaine existant

Cette configuration vous permet d'accéder à vos statistiques avec des URLs ressemblant à :

• http://www.mon-domaine.com/stats/www.un-site.com
• http://www.mon-domaine.com/stats/www.un-autre-site.com

Pour mettre en place une telle configuration, ajoutez simplement les lignes suivantes à la configuration du domaine choisi.

  <IfModule mod_rewrite.c>
    RewriteEngine On$

    #   
    # AWStats URL beautifier
    #   

    # AWStats images
    Alias /awstats-icon /usr/share/awstats/icon
    <Directory "/usr/share/awstats/icon">
      AllowOverride None
      Order allow,deny
      Allow from all
    </Directory>

    # In order to the anchor links to work, we do not rewrite
    # url with framename defined and not equal to "index":
    RewriteCond %{QUERY_STRING}  !^(.*&)?framename=index(&.*)?$
    RewriteCond %{QUERY_STRING}  ^(.*&)?framename=.*(&.*)?$
    RewriteRule /stats/(.*) /usr/lib/cgi-bin/awstats.pl [L] 

    # , we redirect all urls like /stats/awstats.pl?config=something&name=value
    # to /stats/something?name=value
    RewriteCond %{QUERY_STRING}  ^(.*&)?config=([^&]*)(&(.*))?$
    RewriteRule /stats.* /stats/%2?%1%4 [R,L]

    # We beautify the /stats and /stats/awstats.pl URLs:
    RewriteRule /stats(/awstats.pl)?$ /stats/ [R,L]

    # We take a URL like /stats/something?name=value and pass it to: 
    #   awstats.pl?config=something&name=value.
    #   
    # aka: It take a beautiful URL and fetch the awstats content that match it. 
    RewriteRule /stats/([^/]*)(/.*)? /usr/lib/cgi-bin/awstats.pl?config=$1 [QSA,L]

    ## Restrict access to awstats
    <Location /stats>
      SetHandler cgi-script

      # We enable auth based on login, or on IP address.
      Satisfy any

      # Auth configuration
      Order deny,allow
      Deny from all

      # We enable password authentication
      AuthType Basic
      AuthName "Advanced Web Statistics"
      AuthUserFile /etc/apache2/passwords/awstats-users.pwd
      Require valid-user

      # Uncomment these lines in order to allow access from this IP without password.
      #Allow from some.ip.address.here/32

    </Location>

    # By default, only the "admin" user can access all
    # statistics. Do not remove this, since it avoid
    # users restricted to only one site statistics to
    # access alls statistics on your server.
    <LocationMatch /stats/(?!awstats\.pl$)>
      Require user admin
    </LocationMatch>

    # We allow one (or more) user by site.
    # This configuration fits a multisite AWstats configuration quite well :)

    # Allow "some-user" to view "www.some-site.com" statistics.
    #<Location /stats/www.some-site.com>
    #  Require user some-user
    #</Location>

  </IfModule>

Une fois ceci fait, nous testons notre configuration pour vérifier qu'il n'y a aucun problème.

/usr/sbin/apache2ctl -t

Et nous rechargeons la configuration d'Apache:

/etc/init.d/apache2 reload

Configurer les statistiques AWstats d'un site

En premier lieu, je vous conseille de configurer votre serveur HTTP de façon à ce que chaque site que vous hébergez ai ses propres fichiers logs.

Par exemple, pour Apache 2, ajoutez les lignes suivantes dans votre VirtualHost:

    ErrorLog /var/log/apache2/howto.landure.fr-error.log
    LogLevel warn
    CustomLog /var/log/apache2/howto.landure.fr-access.log combined

Remarque: N'oublier pas de remplacer le nom d'hôte de mon site (en gras) par le nom d'hôte du votre.

Remarque 2: Si vous utilisez mon guide Installer et configurer Apache 2 sur Debian 4.0 Etch pour configurer votre serveur Apache 2, vous n'avez pas besoin de vous inquiéter de l'emplacement de vos fichiers logs :D.

Une fois ceci fait, nous allons créer notre fichier de configuration AwStats. En premier lieu, renseignez le nom d'hôte de votre site Internet:

SITE_HOSTNAME=howto.landure.fr

Et créez le fichier de configuration d'AwStats adéquat:

cp /etc/awstats/awstats.conf.template /etc/awstats/awstats.$SITE_HOSTNAME.conf

Et modifiez le pour utiliser vos fichiers logs:

/bin/sed -i -e "s/^\(LogFile=\).*/\1\"\/var\/log\/apache2\/$SITE_HOSTNAME-access.log\"/" \
            -e "s/^\(SiteDomain=\).*/\1\"$SITE_HOSTNAME\"/" \
            -e 's/^\(DefaultFile=\).*/\1"index.php index.html"/' \
            -e 's/^\(URLWithQuery=\).*/URLWithQuery=1/' \
         /etc/awstats/awstats.$SITE_HOSTNAME.conf

Si votre site récupère beaucoup de trafic depuis des forums, vous pouvez souhaitez voir les URL de provenance (cad. les "referrer") complètes. Pour ce faire, utilisez la ligne de commande suivante:

/bin/sed -i -e 's/^\(URLWithQuery=\).*/URLReferrerWithQuery=1/' \
         /etc/awstats/awstats.$SITE_HOSTNAME.conf

Remarque: Si votre site est un site Plone, vous pouvez ignorer les images en mettant à jour le paramètre SkipFiles. Ceci se fait avec la commande suivante:

/bin/sed -i -e 's|^\(SkipFiles=\).*|\1"REGEX[\\/image_thumb$] REGEX[\\/image_mini$] REGEX[\\/image_tile$] REGEX[\\/image_preview$] REGEX[\\/image_large$] REGEX[\\/portal_kss\\/] REGEX[\\/kupudrawers\\/]"|' \
         /etc/awstats/awstats.$SITE_HOSTNAME.conf

• http://stats.domaine.com/SITE_HOSTNAME
• http://www.un-domaine.com/stats/SITE_HOSTNAME

Ouvrir les statistiques à un utilisateur tiers

Si vous souhaitez donner l'accès à un utilisateur tiers aux statistisque de l'un des sites que vous hébergez, en premier lieu, renseignez l'identifiant que vous souhaitez mettre en place pour l'utilisateur:

AWS_USERNAME=un-identifiant

Une fois ceci fait, créez un mot de passe aléatoire pour cet utilisateur:

AWS_PASSWD=$(/usr/bin/apg -q -a  0 -n 1 -M NCL)

Affichez le mot de passe assigné à au compte de l'utilisateur (et retenez le !) :

/bin/echo "Le mot de passe pour l'utilisateur '${AWS_USERNAME}' est '${AWS_PASSWD}'."

Ajoutez l'utilisateur au fichier des mots de passes d'AWstats:

/usr/bin/htpasswd -b /etc/apache2/passwords/awstats-users.pwd ${AWS_USERNAME} ${AWS_PASSWD}

Une fois ceci fait, nous affichons les lignes à insérer dans le fichier de configuration Apache 2

• Dans le cas de l'hôte virtuel dédié AWstats:
  

  /bin/echo "Veuillez ajouter les lignes suivantes à votre hôte virtuel hébergeant AWStats:
      # Allow '${AWS_USERNAME}' to view '${SITE_HOSTNAME}' statistics.
      <Location /${SITE_HOSTNAME}>
        Require user ${AWS_USERNAME}
      </Location>"

• Dans le cas d'AWstats accessible depuis le dossier /stats d'un domaine existant:
  

  /bin/echo "Veuillez ajouter les lignes suivantes à votre hôte virtuel hébergeant AWStats:
      # Allow '${AWS_USERNAME}' to view '${SITE_HOSTNAME}' statistics.
      <Location /stats/${SITE_HOSTNAME}>
        Require user ${AWS_USERNAME}
      </Location>"

Important: Vous devez ajouter les lignes fournies par la commande qui correspond à votre configuration à la configuration du domaine virtuel Apache concerné.

Après avoir mis à jour la configuration d'Apache, vérifiez qu'il n'y a pas d'erreurs:

/usr/sbin/apache2ctl -t

Et chargez la nouvelle configuration:

/etc/init.d/apache2 reload

Remerciements

• Merci aux développeurs d'AWStats.
• Merci à l'auteur du post Rewrite for Awstats dans le forum htaccess Elite car il m'a mis sur la voie.
• Merci à Qtax sur irc.freenode.net#regex.