piwik/README.md

   1 Piwik Plugin
   2 ============
   3
   4 by Tobias Diekershoff and Klaus Weidenbach
   5
   6 This addon allows you to embed the code necessary for the FLOSS webanalytics
   7 tool Piwik into the Friendica pages.
   8
   9 Requirements
  10 ------------
  11
  12 To use this plugin you need a [piwik](http://piwik.org/) installation.
  13
  14 Where to find
  15 -------------
  16
  17 In the Friendica addon git repository `/piwik/piwik.php` and a CSS file for
  18 styling the opt-out notice.
  19
  20 Configuration
  21 -------------
  22
  23 The easiest way to configure this addon is by activating the admin panels of
  24 your ~friendica server and then enter the needed details on the config page
  25 for the addon.
  26
  27 If you don't want to use the admin panel, you can configure the addon through
  28 the .htconfig file.
  29
  30 Open the .htconfig.php file and add "piwik" to the list of activated addons.
  31
  32     $a->config['system']['addon'] = "piwik, ..."
  33
  34 You have to add 4 more configuration variables for the addon:
  35
  36     $a->config['piwik']['baseurl'] = 'example.com/piwik/';
  37     $a->config['piwik']['sideid'] = '1';
  38     $a->config['piwik']['optout'] = true;
  39     $a->config['piwik']['async'] = false;
  40
  41 Configuration fields
  42 ---------------------
  43
  44 * The *baseurl* points to your Piwik installation. Use the absolute path,
  45 remember trailing slashes but ignore the protocol (http/s) part of the URL.
  46 * Change the *sideid* parameter to whatever ID you want to use for tracking your
  47 Friendica installation.
  48 * The *optout* parameter (true|false) defines whether or
  49 not a short notice about the utilization of Piwik will be displayed on every
  50 page of your Friendica site (at the bottom of the page with some spacing to the
  51 other content). Part of the note is a link that allows the visitor to set an
  52 _opt-out_ cookie which will prevent visits from that user be tracked by piwik.
  53 * The *async* parameter (true|false) defines whether or not to use asynchronous
  54 tracking so pages load (or appear to load) faster.
  55
  56 Currently the optional notice states the following:
  57
  58 >    This website is tracked using the Piwik analytics tool. If you do not want
  59 >    that your visits are logged this way you can set a cookie to prevent Piwik
  60 >    from tracking further visits of the site (opt-out).
  61
  62 License
  63 =======
  64
  65 The _Piwik addon_ is licensed under the [3-clause BSD license][3] see the
  66 LICENSE file in the addons directory.
  67
  68 [3]: http://opensource.org/licenses/BSD-3-Clause