piwik/README

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