Difference between revisions of "Awstats"

From ArchWiki
Jump to: navigation, search
(Added notice about AUR)
(20 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{i18n|Awstats}}
+
[[Category:Web Server]]
[[Category:Web Server (English)]]
+
{{DISPLAYTITLE:AWStats}}
  
{{stub}}
+
{{Out of date|Article still refers to the old AUR package, even though the package has been moved to [community]}}
  
'''I am planning to update this page to contain full installation and configuration of awstats for apache as I have time to. If you want to add something, go ahead.''' ''-th0th''
+
From [http://awstats.sourceforge.net/ AWStats - Free log file analyzer for advanced statistics]:
  
== Installing ==
+
:''AWStats is a free powerful and featureful tool that generates advanced web, streaming, ftp or mail server statistics, graphically. This log analyzer works as a CGI or from command line and shows you all possible information your log contains, in few graphical web pages. It uses a partial information file to be able to process large log files, often and quickly. It can analyze log files from all major server tools like Apache log files (NCSA combined/XLF/ELF log format or common/CLF log format), WebStar, IIS (W3C log format) and a lot of other web, proxy, wap, streaming servers, mail servers and some ftp servers.''
=== mod_perl ===
+
<tt>mod_perl</tt> is required to run awstats with apache. {{:ArchTrack/pkg|mod_perl}} package is available in repo extra. So you can install it using pacman.
+
  
# pacman -S mod_perl
+
== Installation ==
 +
=== mod_perl ===
 +
{{ic|mod_perl}} is required to run AWStats with Apache. The {{pkg|mod_perl}} package is available in the [extra] [[Official Repositories|repository]]; install it using [[pacman]].
  
 
=== Awstats ===
 
=== Awstats ===
[https://aur.archlinux.org/packages.php?ID=11674 Awstats package] is available in AUR. You can use yaourt to build it or you can obtain tarball from AUR and build it yourself.
+
The {{pkg|awstats}} package is available in the [community] repository.
  
  $ yaourt -S awstats
+
  {{bc|# pacman -S awstats}}
  
== Configuring ==
+
== Configuration ==
 
=== Enable mod_perl for Apache ===
 
=== Enable mod_perl for Apache ===
To enable <tt>mod_perl</tt> in apache, you should add following line to apache configuration (/etc/httpd/conf/httpd.conf).
+
To enable {{ic|mod_perl}} in Apache, you should add following line to Apache configuration ({{ic|/etc/httpd/conf/httpd.conf}}).
 
   LoadModule perl_module modules/mod_perl.so
 
   LoadModule perl_module modules/mod_perl.so
  
=== Configure Apache to log for Awstats ===
+
=== Configure Apache to log for AWStats ===
By default awstats requires Apache to record access logs as 'combined'. Unless you want a different behavior, you should set your access log format as 'combined'. To do so, your apache configuration should look like this:
+
By default AWStats requires Apache to record access logs as 'combined'. Unless you want a different behavior, you should set your access log format as 'combined'. To do so, your Apache configuration should look like this:
  
 
   <VirtualHost *:80>
 
   <VirtualHost *:80>
Line 36: Line 36:
 
   CustomLog "/var/log/httpd/returnfalse-access_log" combined
 
   CustomLog "/var/log/httpd/returnfalse-access_log" combined
  
{{Box RED|Warning:|At this point, if apache has started to log access with different format, awstats will complain about this because it can't read. So if you are changing apache's log format now, you probably should delete old log files not to confuse Awstats.}}
+
{{Warning|At this point, if apache has started to log access with different format, AWStats will complain about this because it cannot read. So if you are changing Apache's log format now, you probably should delete old log files not to confuse AWStats.}}
  
=== Including Awstats Configuration to Apache's Configuration ===
+
=== Including AWStats configuration in Apache's configuration ===
If you set the log format, then next step is including awstats config file to apache. The package in AUR has a default one, and it's working without any problem. But incase you want to create your own configuration, default one is this:
+
If you set the log format, then next step is including AWStats config file in Apache. The package in the AUR has a default one, and it's working without any problem. But in case you want to create your own configuration, default one is this:
  
 
   Alias /awstatsclasses "/srv/http/awstats/classes/"
 
   Alias /awstatsclasses "/srv/http/awstats/classes/"
Line 53: Line 53:
 
   </Directory>
 
   </Directory>
  
Include this file (in AUR case, the path is /etc/httpd/conf/extra/httpd-awstats.conf) to apache's main configuration:
+
Include this file (in AUR case, the path is {{ic|/etc/httpd/conf/extra/httpd-awstats.conf}}) to Apache's main configuration:
  
 
   Include conf/extra/httpd-awstats.conf
 
   Include conf/extra/httpd-awstats.conf
  
Now if you have done all steps correctly, you should be able to see awstats running on http://domaincomeshere.com/awstats/awstats.pl '''of course after restarting apache'''. One last thing, which is the actual aim, make awstats read logs and convert them to stats.
+
Now if you have done all steps correctly, you should be able to see AWStats running on http://localhost/awstats/awstats.pl '''of course after restarting Apache'''.
  
=== Awstats Configuration ===
+
  # /etc/rc.d/httpd restart
Package in AUR comes with a out of the box hourly cron to update stats shown on awstats. This cron script reads awstats configuration files in <tt>/etc/awstats</tt> and updates the stats for the sites that are defined in these configuration files. Instead of creating these configuration files, you can use awstats' configuration tool. Run:
+
 
 +
One last thing, which is the actual aim, make AWStats read logs and convert them to stats.
 +
 
 +
=== AWStats Configuration ===
 +
The AUR package comes with an hourly [[cron]] script to update stats shown on AWStats. This cron script reads AWStats configuration files in {{ic|/etc/awstats}} and updates the stats for the sites that are defined in these configuration files. Instead of creating these configuration files, you can use AWStats' configuration tool. Run:
  
 
   perl /usr/share/awstats/tools/awstats_configure.pl
 
   perl /usr/share/awstats/tools/awstats_configure.pl
  
and follow the instructions. If you are successfully created config file there is one thing that you should modify manually. Open the configuration file created by <tt>awstats_configure.pl</tt> with your favorite text editor. Then find the line on which <tt>LogFile</tt> variable is defined, and set it as the path that apache logs accesses (which you set to be logged as 'combined' format before):
+
and follow the instructions. If you successfully created config file there is one thing that you should modify manually. Open the configuration file created by {{ic|awstats_configure.pl}} with your favorite text editor. Then find the line on which {{ic|LogFile}} variable is defined, and set it as the path that Apache logs accesses (which you set to be logged as 'combined' format before):
  
   LogFile = /var/log/httpd/returnfalse-access_log
+
   LogFile=/var/log/httpd/returnfalse-access_log
  
 
You are done, now you can run hourly cron script to test the results.
 
You are done, now you can run hourly cron script to test the results.
 +
 +
{{Warning|With these settings anyone will be able to reach AWStats. Setting a authentication would help keeping these stats private.}}
 +
 +
== See also ==
 +
* [[mod_perl]] Apache + Perl

Revision as of 18:15, 9 September 2012


Tango-view-refresh-red.pngThis article or section is out of date.Tango-view-refresh-red.png

Reason: Article still refers to the old AUR package, even though the package has been moved to [community] (Discuss in Talk:Awstats#)

From AWStats - Free log file analyzer for advanced statistics:

AWStats is a free powerful and featureful tool that generates advanced web, streaming, ftp or mail server statistics, graphically. This log analyzer works as a CGI or from command line and shows you all possible information your log contains, in few graphical web pages. It uses a partial information file to be able to process large log files, often and quickly. It can analyze log files from all major server tools like Apache log files (NCSA combined/XLF/ELF log format or common/CLF log format), WebStar, IIS (W3C log format) and a lot of other web, proxy, wap, streaming servers, mail servers and some ftp servers.

Installation

mod_perl

mod_perl is required to run AWStats with Apache. The mod_perl package is available in the [extra] repository; install it using pacman.

Awstats

The awstats package is available in the [community] repository.

# pacman -S awstats

Configuration

Enable mod_perl for Apache

To enable mod_perl in Apache, you should add following line to Apache configuration (/etc/httpd/conf/httpd.conf).

 LoadModule perl_module modules/mod_perl.so

Configure Apache to log for AWStats

By default AWStats requires Apache to record access logs as 'combined'. Unless you want a different behavior, you should set your access log format as 'combined'. To do so, your Apache configuration should look like this:

 <VirtualHost *:80>
     ServerAdmin zxc@returnfalse.net
     DocumentRoot "/srv/http/xxx"
     ServerName www.returnfalse.net
     ErrorLog "/var/log/httpd/returnfalse-error_log"
     CustomLog "/var/log/httpd/returnfalse-access_log" combined
 </VirtualHost>

The important line here is:

 CustomLog "/var/log/httpd/returnfalse-access_log" combined
Warning: At this point, if apache has started to log access with different format, AWStats will complain about this because it cannot read. So if you are changing Apache's log format now, you probably should delete old log files not to confuse AWStats.

Including AWStats configuration in Apache's configuration

If you set the log format, then next step is including AWStats config file in Apache. The package in the AUR has a default one, and it's working without any problem. But in case you want to create your own configuration, default one is this:

 Alias /awstatsclasses "/srv/http/awstats/classes/"
 Alias /awstatscss "/srv/http/awstats/css/"
 Alias /awstatsicons "/srv/http/awstats/icon/"
 ScriptAlias /awstats/ "/srv/http/awstats/cgi-bin/"
 
 <Directory "/srv/http/awstats">
     Options None
     AllowOverride None
     Order allow,deny
     Allow from all
 </Directory>

Include this file (in AUR case, the path is /etc/httpd/conf/extra/httpd-awstats.conf) to Apache's main configuration:

 Include conf/extra/httpd-awstats.conf

Now if you have done all steps correctly, you should be able to see AWStats running on http://localhost/awstats/awstats.pl of course after restarting Apache.

 # /etc/rc.d/httpd restart

One last thing, which is the actual aim, make AWStats read logs and convert them to stats.

AWStats Configuration

The AUR package comes with an hourly cron script to update stats shown on AWStats. This cron script reads AWStats configuration files in /etc/awstats and updates the stats for the sites that are defined in these configuration files. Instead of creating these configuration files, you can use AWStats' configuration tool. Run:

 perl /usr/share/awstats/tools/awstats_configure.pl

and follow the instructions. If you successfully created config file there is one thing that you should modify manually. Open the configuration file created by awstats_configure.pl with your favorite text editor. Then find the line on which LogFile variable is defined, and set it as the path that Apache logs accesses (which you set to be logged as 'combined' format before):

 LogFile=/var/log/httpd/returnfalse-access_log

You are done, now you can run hourly cron script to test the results.

Warning: With these settings anyone will be able to reach AWStats. Setting a authentication would help keeping these stats private.

See also