django-server-side-matomo 2.1.0

Send analytics data to Matomo using celery

Let your Django app perform server side analytics with Matomo. Server side analytics is a great way to get some analytics while respecting user privacy (only you see the data, no internet wide tracking) and performance (no js tracker needed!)

Quickstart

You'll need to have celery set up because making the Matomo request in your Django request would be really slow. This project will collect some data from a request using middleware, serialize it, and send it to celery. Works fine with the default celery json serializer. Running celery will not be described here.

1. Install via pip django-server-side-matomo
2. Add to INSTALLED_APPS 'server_side_matomo',
3. Add to MIDDLEWARE 'server_side_matomo.middleware.MatomoMiddleware'
4. Set the following in settings.py

• MATOMO_SITE_ID = '1' # Your site's Matomo ID
• MATOMO_API_URL = 'https://your.site.com/piwik.php'
• MATOMO_TOKEN_AUTH = 'your auth token'
• MATOMO_TRACK_USER_ID = False # Set to True to track user ID. See https://matomo.org/docs/user-id/

Testing and Development

Only merge requests with unit tests will be accepted. Please open an issue first if you'd like to propose a feature. I don't plan to add many features to this project myself. Unless other people are interested in doing the work - I have no plans to support things like Google Analytics.

Testing

A Docker Compose file is provided to quickly try out the project. Just run in a web container:

./manage.py test

Tested with Django 3.0 and Python 3.7.