Matomo
Matomo is a real-time web analytics application. This module configures
php-fpm as backend for Matomo, optionally configuring an nginx vhost as well.
An automatic setup is not suported by Matomo, so you need to configure Matomo
itself in the browser-based Matomo setup.
Database Setup
You also need to configure a MariaDB or MySQL database and -user for Matomo
yourself, and enter those credentials in your browser. You can use
passwordless database authentication via the UNIX_SOCKET authentication
plugin with the following SQL commands:
# For MariaDB
INSTALL PLUGIN unix_socket SONAME 'auth_socket';
CREATE DATABASE matomo;
CREATE USER 'matomo'@'localhost' IDENTIFIED WITH unix_socket;
GRANT ALL PRIVILEGES ON matomo.* TO 'matomo'@'localhost';
# For MySQL
INSTALL PLUGIN auth_socket SONAME 'auth_socket.so';
CREATE DATABASE matomo;
CREATE USER 'matomo'@'localhost' IDENTIFIED WITH auth_socket;
GRANT ALL PRIVILEGES ON matomo.* TO 'matomo'@'localhost';
Then fill in matomo as database user and database name,
and leave the password field blank. This authentication works by allowing
only the matomo unix user to authenticate as the
matomo database user (without needing a password), but no
other users. For more information on passwordless login, see
.
Of course, you can use password based authentication as well, e.g. when the
database is not on the same host.
Archive Processing
This module comes with the systemd service matomo-archive-processing.service
and a timer that automatically triggers archive processing every hour.
This means that you can safely
disable browser triggers for Matomo archiving
at Administration > System > General Settings.
With automatic archive processing, you can now also enable to
delete old visitor logs
at Administration > System > Privacy,
but make sure that you run systemctl start matomo-archive-processing.service
at least once without errors if you have already collected data before,
so that the reports get archived before the source data gets deleted.
Backup
You only need to take backups of your MySQL database and the
/var/lib/matomo/config/config.ini.php file. Use a user
in the matomo group or root to access the file. For more
information, see
.
Issues
Matomo's file integrity check will warn you. This is due to the patches
necessary for NixOS, you can safely ignore this.
Matomo will warn you that the JavaScript tracker is not writable. This is
because it's located in the read-only nix store. You can safely ignore
this, unless you need a plugin that needs JavaScript tracker access.
Using other Web Servers than nginx
You can use other web servers by forwarding calls for
index.php and piwik.php to the
/run/phpfpm-matomo.sock fastcgi unix socket. You can use
the nginx configuration in the module code as a reference to what else
should be configured.