2013-06-01 15:30:44 +00:00
|
|
|
Piwik Plugin
|
|
|
|
|
============
|
2012-02-23 04:38:35 +00:00
|
|
|
|
2013-06-01 15:35:06 +00:00
|
|
|
by Tobias Diekershoff and Klaus Weidenbach
|
2011-09-25 08:56:03 +00:00
|
|
|
|
|
|
|
|
This addon allows you to embed the code necessary for the FLOSS webanalytics
|
2012-02-19 09:17:38 +00:00
|
|
|
tool Piwik into the Friendica pages.
|
2011-09-25 08:56:03 +00:00
|
|
|
|
2013-06-01 15:30:44 +00:00
|
|
|
Requirements
|
|
|
|
|
------------
|
2011-09-25 08:56:03 +00:00
|
|
|
|
2012-02-23 04:38:35 +00:00
|
|
|
To use this plugin you need a [piwik](http://piwik.org/) installation.
|
2011-09-25 08:56:03 +00:00
|
|
|
|
2013-06-01 15:30:44 +00:00
|
|
|
Where to find
|
|
|
|
|
-------------
|
2011-09-25 08:56:03 +00:00
|
|
|
|
2013-06-01 15:30:44 +00:00
|
|
|
In the Friendica addon git repository `/piwik/piwik.php` and a CSS file for
|
2011-09-25 08:56:03 +00:00
|
|
|
styling the opt-out notice.
|
|
|
|
|
|
2013-06-01 15:30:44 +00:00
|
|
|
Configuration
|
|
|
|
|
-------------
|
2012-02-23 04:38:35 +00:00
|
|
|
|
2012-04-07 07:21:49 +00:00
|
|
|
The easiest way to configure this addon is by activating the admin panels of
|
|
|
|
|
your ~friendica server and then enter the needed details on the config page
|
|
|
|
|
for the addon.
|
|
|
|
|
|
|
|
|
|
If you don't want to use the admin panel, you can configure the addon through
|
|
|
|
|
the .htconfig file.
|
|
|
|
|
|
2012-02-23 04:38:35 +00:00
|
|
|
Open the .htconfig.php file and add "piwik" to the list of activated addons.
|
2011-09-25 08:56:03 +00:00
|
|
|
|
|
|
|
|
$a->config['system']['addon'] = "piwik, ..."
|
|
|
|
|
|
2012-02-19 09:17:38 +00:00
|
|
|
You have to add 4 more configuration variables for the addon:
|
2012-02-23 04:38:35 +00:00
|
|
|
|
2012-02-19 09:17:38 +00:00
|
|
|
$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 08:56:03 +00:00
|
|
|
|
2013-06-01 15:30:44 +00:00
|
|
|
Configuration fields
|
|
|
|
|
---------------------
|
|
|
|
|
|
|
|
|
|
* The *baseurl* points to your Piwik installation. Use the absolute path,
|
2011-09-25 08:56:03 +00:00
|
|
|
remember trailing slashes but ignore the protocol (http/s) part of the URL.
|
2013-06-01 15:30:44 +00:00
|
|
|
* Change the *sideid* parameter to whatever ID you want to use for tracking your
|
|
|
|
|
Friendica installation.
|
|
|
|
|
* The *optout* parameter (true|false) defines whether or
|
2012-02-19 09:17:38 +00:00
|
|
|
not a short notice about the utilization of Piwik will be displayed on every
|
2012-01-31 11:08:46 +00:00
|
|
|
page of your Friendica site (at the bottom of the page with some spacing to the
|
2011-09-25 08:56:03 +00: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.
|
2013-06-01 15:30:44 +00:00
|
|
|
* The *async* parameter (true|false) defines whether or not to use asynchronous
|
|
|
|
|
tracking so pages load (or appear to load) faster.
|
2011-09-25 08:56:03 +00:00
|
|
|
|
|
|
|
|
Currently the optional notice states the following:
|
|
|
|
|
|
2013-06-01 15:30:44 +00:00
|
|
|
> 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).
|
2011-09-25 08:56:03 +00:00
|
|
|
|
2013-06-01 15:35:06 +00:00
|
|
|
License
|
|
|
|
|
=======
|
|
|
|
|
|
|
|
|
|
The _Piwik addon_ is licensed under the [3-clause BSD license][3] see the
|
|
|
|
|
LICENSE file in the addons directory.
|
|
|
|
|
|
|
|
|
|
[3]: http://opensource.org/licenses/BSD-3-Clause
|
