direct link to current page
[awstats-helper.git] / README
1 AWStats helper scripts
2 ======================
3
4 We use AWStats [1] to get statistics about the web sites hosted
5 on our server. Setting up AWStats for a single site is easy,
6 but for multiple domains it is really tedious work.
7 Further, the tools provided with AWStats that support multiple
8 configuration files do not support historic data.
9 There is i.e. no way to look at the detailled statistics of last month
10 or the stats for a site of two years ago.
11
12 These scripts provide the following functionality:
13 - Rendering of historical data
14 - Updating the current month's data and regenerating report files
15 - Regenerating last month's report files
16 - Index page generation linking to all this data
17
18 The scripts utilize awstats.pl and awstats_buildstaticpages.pl
19 from the AWStats distribution.
20
21 [1] http://awstats.sourceforge.net/
22
23
24
25 Installation
26 ------------
27 1. copy config.php.dist to config.php
28 2. Adjust config.php to your needs
29 3. Run update-sites.php to generate initial data collection
30 4. Run create-historic.php to create all historic files
31 5. Add update-sites.php to your crontab, let it run every hour
32 6. Add update-lastmonth.php to your crontab and let it run
33    on the first day every month
34
35
36 AWStats vhost host setup
37 ------------------------
38 AWStats needs a configuration file for each of the domains you want to analyze.
39
40 The file needs to be put in ``/etc/awstats/awstats.$domain.conf``,
41 e.g. ``/etc/awstats/awstats.cweiske.de.conf``.
42
43 Example::
44
45   Include "/etc/awstats/awstats.conf"
46   LogFile="/var/log/apache2/cweiske/cweiske.de-access.log"
47   SiteDomain="cweiske.de"
48   DefaultFile=""