piwik/README.md

   1 Matomo / Piwik Addon
   2 ============
   3
   4 by Tobias Diekershoff and Klaus Weidenbach
   5
   6 This addon allows you to embed the code necessary for the FLOSS webanalytics tool Matomo (formerly known as Piwik) into the Friendica pages.
   7
   8 Requirements
   9 ------------
  10
  11 To use this addon you need a [Matomo](https://matomo.org/) installation.
  12
  13 Where to find
  14 -------------
  15
  16 In the Friendica addon git repository `/piwik/piwik.php` and a CSS file for styling the opt-out notice.
  17
  18 Configuration
  19 -------------
  20
  21 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.
  22
  23 If you don't want to use the admin panel, you can configure the addon through the `config/local.config.php` file.
  24
  25 Open the `config/node.config.php` file and add "piwik" to the list of activated addons.
  26
  27         'addons' => [
  28                 ...
  29                 'piwik' => [
  30                         admin => true,
  31                 ],
  32         ]
  33
  34 You can change 5 more configuration variables for the addon in the `config/piwik.config.php` file:
  35
  36         return [
  37                 'piwik' => [
  38                         'baseurl' => 'example.com/piwik/',
  39                         'sideid' => 1,
  40                         'optout' => true,
  41                         'async' => false,
  42                         'shortendpoint' => false,
  43                 ],
  44         ];
  45
  46 Configuration fields
  47 ---------------------
  48
  49 * The *baseurl* points to your Piwik installation. Use the absolute path, remember trailing slashes but ignore the protocol (http/s) part of the URL.
  50 * Change the *sideid* parameter to whatever ID you want to use for tracking your Friendica installation.
  51 * 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
  52 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.
  53 * The *async* parameter (true|false) defines whether or not to use asynchronous tracking so pages load (or appear to load) faster.
  54 * The *shortendpoint* parameter (true|false) defines whether or not to use a short path to the tracking script: "/js/" instead of "/piwik.js".
  55 Currently the optional notice states the following:
  56
  57 >    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).
  58
  59 License
  60 =======
  61
  62 The _Piwik addon_ is licensed under the [3-clause BSD license][3] see the LICENSE file in the addons directory.
  63
  64 [3]: http://opensource.org/licenses/BSD-3-Clause