piwik/README

   1 ## Piwik Plugin ##
   2
   3 by Tobias Diekershoff
   4    tobias.diekershoff(at)gmx.net
   5
   6 This addon allows you to embed the code necessary for the FLOSS webanalytics
   7 tool Piwik into the Friendica pages.
   8
   9 [Online version of this Document](http://ur1.ca/35m2x)
  10
  11 ### Requirements ###
  12
  13 To use this plugin you need a [piwik](http://piwik.org/) installation.
  14
  15 ### Where to find ###
  16
  17 In the Friendica git repository `/addon/piwik/piwik.php` and a CSS file for
  18 styling the opt-out notice.
  19
  20 ### Configuration ###
  21
  22 Open the .htconfig.php file and add "piwik" to the list of activated addons.
  23
  24     $a->config['system']['addon'] = "piwik, ..."
  25
  26 You have to add 4 more configuration variables for the addon:
  27
  28     $a->config['piwik']['baseurl'] = 'example.com/piwik/';
  29     $a->config['piwik']['sideid'] = '1';
  30     $a->config['piwik']['optout'] = true;
  31     $a->config['piwik']['async'] = false;
  32
  33 The *baseurl* points to your Piwik installation. Use the absolute path,
  34 remember trailing slashes but ignore the protocol (http/s) part of the URL.
  35 Change the *sideid* parameter to whatever ID you want to use for tracking your
  36 Friendica installation. The *optout* parameter (true|false) defines whether or
  37 not a short notice about the utilization of Piwik will be displayed on every
  38 page of your Friendica site (at the bottom of the page with some spacing to the
  39 other content). Part of the note is a link that allows the visitor to set an
  40 _opt-out_ cookie which will prevent visits from that user be tracked by piwik.
  41
  42 Currently the optional notice states the following:
  43
  44     This website is tracked using the Piwik analytics tool. If you do not want
  45     that your visits are logged this way you can set a cookie to prevent Piwik
  46     from tracking further visits of the site (opt-out).
  47
  48 The *async* parameter (true|false) defines whether or not to use asynchronous
  49 tracking so pages load (or appear to load) faster.