Welcome to Piwik Trac

Trac is the place to follow along with the development of Piwik. Piwik is an open source web analytics software (alternative to Google analytics).

You can track changes in the Timeline section of this site. There is also an RSS feed and a mailing list for those interested.

Bugs reports are also kept on Trac. If you are looking to submit a bug report, please register or login and head on over.

Developer documentation

• API Documentation
  Documentation about the REST API. Features, tutorial on how to build a query in 2 minutes, list of all the methods available, etc.
  • Tutorial How to get the top 10 keywords of yesterday in XML?
  • Reference Complete list of the modules and methods available in the API
  • How to call the API Internal call (in php using Piwik source code) or external call (http request over internet)

• Plugin development
  • Simple: How to write a plugin? Tutorial explaining how to build a simple plugin.
  • Helper Functions How to execute SQL queries, how to add entries in the Menu, get information about the user, the current website, the date selected, etc.
  • List of hooks Find out the list of growing hooks (events your plugin can listen to) available in Piwik
  • Advanced: How to write a plugin? Tutorial using the example of the GeoIp plugin, a plugin that gives the precise country and city of the visitors.

• Developers: more documentation
  • How to setup Eclipse + PHP + Debug
  • Coding standard
  • Security checklist Make your Piwik code secure by checking it against this security list
  • Database schema overview: tables, concepts, related classes

• Other ressources
  • Source code generated documentation The documentation auto generated from the phpdoc comments
  • Sequence diagram of a 'simple' request to a report in piwik (front controller -> plugin controller -> model -> api -> archiving if necessary / authentication -> view -> template, etc.)
  • How to test piwik user interface Checklist describing every features you need to test after modifying user interface code
  • Thoughts about the development process

General Documentation

• How to setup a crontab to automatically archive overnight?
• About Piwik mission statement and short / mid / long term objectives
• The people behind Piwik: the team is still small, but focused and growing. You can help and join the team!

Documentation to come

• Piwik packages description: global package schema, for each package quick description, link to the phpDoc
• Piwik file organization: how the project is structured, quick overview of the libraries used
• Code overview, concepts general description: Mvc, plugins, event listener, security, internationalization, api, etc.
• Sequence diagram for the processus that logs the visitor information from the JS tag to the log in the DB
• Sequence diagram for a call to the API
• [Difference between phpMyVisites and Piwik]
• [Download and outlink tracking]

Mailing lists

• piwik-svn Archives, Subscribe, Search the archives

This mailing list notifies all the comits to the SVN server

• piwik-trac Archives, Subscribe, Search the archives

This mailing list notifies all the changes to tickets in trac (new ticket, closed, modifications, new comments, etc.)

• piwik-hackers Archives, Subscribe, Search the archives

This mailing list is used to discuss Piwik internals, ask questions about the architecture, discuss new ideas, etc.

SVN Access

You can also browse the svn online using trac.

You can download the last version, built every hour from the svn trunk.

Check out the current development trunk with:

svn co http://dev.piwik.org/svn/trunk