Piwik Plugin

Authors	David Jones
Jira	http://jira.codehaus.org/browse/SONARPLUGINS/component/14465
Last Version	N/A
License	LGPL v3
Sources	http://svn.codehaus.org/sonar-plugins/trunk/piwik
Download	N/A

Compatibility matrix

Plugin	0.1
Sonar	2.1
Piwik	0.6

Description / Features

Piwik is an open-source web analytics software that can be used as an alternative to Google Analytics, especially for internal websites. The Piwik Plugin submits web usage of a Sonar instance to a Piwik.

Usage & Installation

The Plugin is configured by an administrator with the details of a Piwik instance and from then on all
web pages will include a script at the end of each page that sends information regarding the visitor and the page to Piwik.

You already have an instance of Piwik 0.6 setup.
In Piwik you have defined a new website: Settings -> Websites -> Add new website

Install Piwik Plugin in Sonar through the normal mechanism of including the jar in the Sonar extensions/plugins directory and restarted
In Sonar as an administrator: Configuration -> Settings -> Piwik
- Use the Piwik website details to fill out the parameters
- The Website ID, for example 2, can be taken straight from the websites page of Piwik
- The Server host name is the domain name or IP of the Piwik instance, for example piwik.mycompany.com
- The Path on server is the relative location of the Piwik website on the domain. For example with the Piwik url of http://piwik.mycompany.com/piwik/index.php then this value would be "piwik".
Click Save Parameters

If you look at the source of a Sonar page afterwards you should now see a Piwik script near the bottom of the page.

Back in piwik you should start seeing page hits from Sonar being shown within a few seconds.

Known limitations

None known.

Changelog

None yet

Roadmap

Release 0.1

Configuration to set Piwik server instance
Including Piwik script on each page once enabled