This plugin is compatible with Matomo 4 (see requirements below for more details).
Some extra cli commands to help with maintaining Matomo. Introducing new console commands:
matomo:requirements(does not work right now)
The main reason to doing this plugin was to get automatic installs to work with Matomo, including automatic updates - and version controlled deliveries with configuration in json or yaml.
composer require symfony/yaml:~2.6.0(moves it from dev)
composer require symfony/process:^3.4
Git clone the plugin into your plugins folder:
git clone https://github.com/nodeone/extratools.git ExtraTools
Activate ExtraTools - in UI, or better - in the console:
console plugin:activate ExtraTools
Set up a db backup path, use the console (use the path you desire):
./console config:set 'ExtraTools.db_backup_path="/var/www/html/tmp"'
Or add it manually to config.ini.php:
[ExtraTools] db_backup_path = "/var/www/html/tmp"
Gets a section config. @todo - make this more like config:set - so you have more options.
Backups the db.
Creates the db defined i config.ini.php. Adding the --force flag stops the command for asking questions.
Drops the db defined i config.ini.php - backup first if needed. Adding the --force flag stops the command for asking questions.
Imports database dump to database defined in config.ini.php, so if you already have a installation - it overwrites it.
Removes logging entries from the DB, that is the internal logging in Matomo, not visits on sites.
Show logging and query entries of logs from the database, output could be exported to CSV.
Installs Matamo. Wipes the current installation - as default it uses settings in your config.ini.php file - but all values could be overridden with arguments or environment variables.
If you have a license for Matomo Premium plugins, set the environment variable
MATOMO_LICENSE with the correct
license token. The environment variable is set as a normal environment variable, in shell using export, in a
docker-compose file, the environment array etc. If the variable is set, Matomo will have the license key set on install.
List all segments, with ID, definition, date created and latest updated.
Adds a new site to track.
Deletes a site with ID provided.
List sites, with the optional format argument - supported output is text(default), json and yaml.
Adds one or more URLs to a site.
Get all archived visits, for one site or all. For a segment or all segments, for today, or another day etc.
Matomo needs a MySQL/MariaDB host, with a user setup that is allowed to drop that db. The first user is created as a super user and it is need to have one to set up Matomo. If you do not add values in environment variables or options to matomo:install command, it will use the defaults for the user - so important that you change that users password after install. Matomo also creates a first site to track, this also has default values that you could override with environment variables or options.
You could also use a json-file for configuration - like all the above mentioned - and for installing plugins. An example json-file could be found in the docs folder for this plugin.
Supported default environment variables from the official Matomo docker container:
MATOMO_DATABASE_HOST MATOMO_DATABASE_TABLES_PREFIX MATOMO_DATABASE_USERNAME MATOMO_DATABASE_PASSWORD MATOMO_DATABASE_DBNAME
These could be overridden with (historical reasons):
MATOMO_DB_HOST MATOMO_DB_PREFIX MATOMO_DB_USERNAME MATOMO_DB_PASSWORD MATOMO_DB_NAME
Other environment variables:
MATOMO_FIRST_USER_NAME MATOMO_FIRST_USER_EMAIL MATOMO_FIRST_USER_PASSWORD MATOMO_FIRST_SITE_NAME MATOMO_FIRST_SITE_URL MATOMO_LOG_TIMESTAMP (1)
If you have a config.ini.php in the config dir - delete it. Run:
console plugin:activate ExtraTools
Then follow one of the Examples below.
console matomo:install --install-file=install.json
console matomo:install --db-username=myuser --db-pass=password \ --db-host=localhost --db-name=matomo --first-site-name=Foo \ --first-site-url=https//foo.bar --first-user='Mr Foo Bar' \ --firstname.lastname@example.org --first-user-pass=secret
Using environment variables, docker-compose.yml example.
environment: - MATOMO_DB_USERNAME=myuser - MATOMO_DB_PASSWORD=secret - MATOMO_DB_HOST=mysql - MATOMO_DB_NAME=matomo - MATOMO_FIRST_USER_NAME=Mr Foo Bar - MATOMO_FIRST_USER_EMAILemail@example.com - MATOMO_FIRST_USER_PASSWORD=secret - MATOMO_FIRST_SITE_NAME=Foo - MATOMO_FIRST_SITE_URL=https://foo.bar
Highest number = takes over. If you have you mysql server settings in environment variables and provide the option --db-username=myuser, the latter is used for the db username.
1) config.ini.php (created when you install the first time) 2) Environment variable 3) Option (matomo:install --db-username=myuser) 4) File overrides (matom-install --install-file=install.json)
Check that all requirements, mandatory and optional, are in place. Normally throws a notice for mod_pagespeed check. @todo: Look into what needs to be done in core for the mod_pagespeed check.
matamo:installwipes your current installation.
database:drop- as it says - drops the entire db, make a backup first if you want to save you data, and check if it's ok.
database:import- writes over your current database.
site:delete- really deletes a site you have setup in Matomo.
This plugin comes with no guarantees. But it's free and open source. So, let's make it better!
This is tested from version 3.8.1, and should work with the latest stable.
This plugin is based on work done by Ben Evans in https://github.com/nebev/piwik-cli-setup, and also reusing code in Matomo core.