Koko Analytics

Note

This project is still in development. While functional, we can't guarantee not introducing any breaking chances until we release an official version 1.

Koko Analytics is a PHP application that you can self-host to provide you with simple, open-source, lightweight (< 1 KB) and privacy-friendly website analytics.

It aims to be an alternative to Google Analytics for a lot of websites, providing you with the most important metrics while respecting the privacy of your visitors. Nothing about individual visitors is tracked, only aggregated counts.

Screenshot of the Koko Analytics dashboard.

Features

• Compliance: GDPR and CCPA Compliant by design.
• Local: No external services.
• Anonymous: No personal information or anything visitor specific is tracked.
• No cookies: No cookies or other identifiers are used and/or stored.
• Fast: Handles thousands of daily visitors or sudden bursts of traffic without breaking a sweat.
• Lightweight: The tracking script is < 1 kB.
• Storage efficient: A year worth of data takes up less than 5 MB of database storage.
• Cached: Fully compatible with pages served from server or browser caches.
• Open-source: GNU AGPLv3 licensed.

Tip

There is a WordPress plugin which offers a lof of the same functionality as this project: https://github.com/ibericode/koko-analytics

Installation

To install Koko Analytics you will need a server with at least the following requirements:

Requirements

• PHP 8.2 or higher.
• SQLite or MySQL database.

Koko Analytics runs on a traditional LAMP stack. It aims to run alongside whatever software you already have running while consuming minimal resources. There is no need to spin-up an OLAP database just to provide you with some metrics.

Deployment

First, read through deploying a Symfony application for a general overview on what to expect in deploying Koko Analytics.

1. Upload the source code to the server on which you want to run Koko Analytics.
2. Use Composer to install dependencies: composer install --no-dev --optimize-autoloader
3. Create a local configuration file: cp .env .env.local
4. In .env.local, update APP_SECRET and the various DATABASE_ entries.
5. Run php bin/console app:database:migrate to initialize the database.
6. Configure your webserver to point all requests to public/index.php
7. Run php bin/console app:user:create <email> <password> to register a new user.

You can then create dashboards for each domain you want to track from the user interface.

Setting up the server cronjob

The Koko Analytics application needs a single cronjob for persisting collected statistics from the temporary buffer files (optimized for writing) to permanent storage (optimized for querying):

* * * * * cd /path/to/your/application && bin/console app:aggregate

Tracking snippet

To start collecting visitor statistics for any website, deploy this application to a suitable location and then add the following tracking snippet to your pages.

<script>
(function(o, c) {
  window[o] = c;
  var s = document.createElement('script');
  s.defer = true;
  s.src = [c.url, '/', o, '.js'].join('');
  document.body.appendChild(s);
})('ka', {
  url: 'http://localhost:8000',   /* the URL to your Koko Analytics application instance */
  domain: 'website.com'           /* name of the domain in your Koko Analytics dashboard */
})
</script>

License

Koko Analytics is open-source software using the GNU AGPLv3 license.