friendica-addons/piwik/README

50 lines
1.8 KiB
Plaintext
Raw Normal View History

## Piwik Plugin ##
by Tobias Diekershoff
2011-09-25 04:56:03 -04:00
tobias.diekershoff(at)gmx.net
This addon allows you to embed the code necessary for the FLOSS webanalytics
tool Piwik into the Friendica pages.
2011-09-25 04:56:03 -04:00
[Online version of this Document](http://ur1.ca/35m2x)
2011-09-25 04:56:03 -04:00
### Requirements ###
2011-09-25 04:56:03 -04:00
To use this plugin you need a [piwik](http://piwik.org/) installation.
2011-09-25 04:56:03 -04:00
### Where to find ###
2011-09-25 04:56:03 -04:00
In the Friendica git repository `/addon/piwik/piwik.php` and a CSS file for
2011-09-25 04:56:03 -04:00
styling the opt-out notice.
### Configuration ###
Open the .htconfig.php file and add "piwik" to the list of activated addons.
2011-09-25 04:56:03 -04:00
$a->config['system']['addon'] = "piwik, ..."
You have to add 4 more configuration variables for the addon:
$a->config['piwik']['baseurl'] = 'example.com/piwik/';
$a->config['piwik']['sideid'] = '1';
$a->config['piwik']['optout'] = true;
$a->config['piwik']['async'] = false;
2011-09-25 04:56:03 -04:00
The *baseurl* points to your Piwik installation. Use the absolute path,
2011-09-25 04:56:03 -04:00
remember trailing slashes but ignore the protocol (http/s) part of the URL.
Change the *sideid* parameter to whatever ID you want to use for tracking your
2012-01-31 06:08:46 -05:00
Friendica installation. The *optout* parameter (true|false) defines whether or
not a short notice about the utilization of Piwik will be displayed on every
2012-01-31 06:08:46 -05:00
page of your Friendica site (at the bottom of the page with some spacing to the
2011-09-25 04:56:03 -04:00
other content). Part of the note is a link that allows the visitor to set an
_opt-out_ cookie which will prevent visits from that user be tracked by piwik.
Currently the optional notice states the following:
This website is tracked using the Piwik analytics tool. If you do not want
that your visits are logged this way you can set a cookie to prevent Piwik
from tracking further visits of the site (opt-out).
The *async* parameter (true|false) defines whether or not to use asynchronous
tracking so pages load (or appear to load) faster.