Commit 8be35068 authored by Arthur Lutz's avatar Arthur Lutz
Browse files

documentation in README

parent 7bc909e5fb88
Summary
-------
cubicweb integrated awstats frontend
The awstats cube integrates statistics processed by awstats into
cubicweb for visualisation and integration.
It uses awstats processed files (`/var/lib/awstats/*`) to import stats
and visualize them. It has a simple html export of the processed data
and a visualisation of the imported stats (by document and for a time
period).
To establish a link with the entity you want to build stats for
you need to create a relationship Hits "stats_about" X.
......@@ -12,4 +19,35 @@ you need to create a relationship Hits "stats_about" X.
subject = 'Hits'
object = ('BlogEntry', 'MicroBlogEntry')
When the link is established, importing the statistics is done using
the `update-webstats` cubicweb-ctl command. For help on that command
type ::
cubicweb-ctl update-webstats -h
The process running cubicweb and cubicweb-ctl needs to have read
access to the configured location of the processed varnish files.
Configuration
-------------
:awstats-dir:
The directory where the processed awstats files are contained.
:awstats-domain:
If awstats processes multiple domains, which domain to use for
importing into cubicweb.
:awstats-periodicity:
Awstats by default processes per month, but you can configure it to
deal with day periods. (split by hours is not yet implemented)
Dependencies
------------
http://awstats.sourceforge.net/
or apt-get install awstats (for debian derived distributions)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment