History

Hypolite Petovan d836593a3b Replace x() by !empty() or defaults() - Remove extraneous parentheses around !empty()		2018-11-30 09:11:56 -05:00
..
config	[piwik] Update config file style/name	2018-11-25 02:15:18 -05:00
lang	NL translation THX JeroenED	2018-08-25 21:12:02 +02:00
templates	Piwik addon, baseurl as variable name has problems with Friendica	2016-07-28 16:32:05 +02:00
LICENSE	added LICENSE file	2013-06-01 17:35:06 +02:00
piwik.css	some files were executable, now they are not	2017-12-07 14:26:26 +01:00
piwik.php	Replace x() by !empty() or defaults()	2018-11-30 09:11:56 -05:00
README.md	[piwik] Update config file style/name	2018-11-25 02:15:18 -05:00

README.md

Piwik Addon

by Tobias Diekershoff and Klaus Weidenbach

This addon allows you to embed the code necessary for the FLOSS webanalytics tool Piwik into the Friendica pages.

Requirements

To use this addon you need a piwik installation.

Where to find

In the Friendica addon git repository /piwik/piwik.php and a CSS file for styling the opt-out notice.

Configuration

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 config/local.config.php file.

Open the config/local.config.php file and add "piwik" to the list of activated addons.

'system' => [
    ...
    'addon' => '...,piwik'
    ...
]

You can change 4 more configuration variables for the addon in the config/addon.config.php file:

'piwik' => [
    'baseurl' => 'example.com/piwik/',
    'sideid' => 1,
    'optout' => true,
    'async' => false,
],

Configuration fields

The baseurl points to your Piwik installation. Use the absolute path, 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 Friendica installation.
The optout parameter (true|false) defines whether or not a short notice about the utilization of Piwik will be displayed on every page of your Friendica site (at the bottom of the page with some spacing to the 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.
The async parameter (true|false) defines whether or not to use asynchronous tracking so pages load (or appear to load) faster.

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).

License

The Piwik addon is licensed under the 3-clause BSD license see the LICENSE file in the addons directory.