PHPackages                             digitalist-open-cloud/extratools - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI & Console](/categories/cli)
4. /
5. digitalist-open-cloud/extratools

ActiveMatomo-plugin[CLI & Console](/categories/cli)

digitalist-open-cloud/extratools
================================

Extra tools for Matomo

5.3.2(3w ago)29161↓56.3%12[3 issues](https://github.com/Digitalist-Open-Cloud/Matomo-Plugin-ExtraTools/issues)[1 PRs](https://github.com/Digitalist-Open-Cloud/Matomo-Plugin-ExtraTools/pulls)GPL-3.0-or-laterPHPPHP >=8.2CI passing

Since Feb 26Pushed 3w ago16 watchersCompare

[ Source](https://github.com/Digitalist-Open-Cloud/Matomo-Plugin-ExtraTools)[ Packagist](https://packagist.org/packages/digitalist-open-cloud/extratools)[ Docs](https://digitalist.cloud)[ RSS](/packages/digitalist-open-cloud-extratools/feed)WikiDiscussions 5.x-dev Synced 2w ago

READMEChangelog (10)Dependencies (13)Versions (79)Used By (0)

Extra Tools (for Matomo)
========================

[](#extra-tools-for-matomo)

[![PHPCS check](https://github.com/Digitalist-Open-Cloud/Matomo-Plugin-ExtraTools/actions/workflows/phpcs.yaml/badge.svg)](https://github.com/Digitalist-Open-Cloud/Matomo-Plugin-ExtraTools/actions/workflows/phpcs.yaml)[![Tests with Helm chart](https://github.com/Digitalist-Open-Cloud/Matomo-Plugin-ExtraTools/actions/workflows/kind-e2e.yaml/badge.svg)](https://github.com/Digitalist-Open-Cloud/Matomo-Plugin-ExtraTools/actions/workflows/kind-e2e.yaml)[![Semgrep OSS scan](https://github.com/Digitalist-Open-Cloud/Matomo-Plugin-ExtraTools/actions/workflows/semgrep.yaml/badge.svg)](https://github.com/Digitalist-Open-Cloud/Matomo-Plugin-ExtraTools/actions/workflows/semgrep.yaml)[![Test plugin with Matomo](https://github.com/Digitalist-Open-Cloud/Matomo-Plugin-ExtraTools/actions/workflows/matomo.yaml/badge.svg)](https://github.com/Digitalist-Open-Cloud/Matomo-Plugin-ExtraTools/actions/workflows/matomo.yaml)

Some extra cli commands to help with maintaining Matomo. Also providing an phpinfo page in the admin part. Introducing new console commands:

- `archive:list`
- `extra:bootstrap`
- `extra:clear-external-cache`
- `extra:config:get`
- `database:backup`
- `database:create`
- `database:drop`
- `database:import`
- `logger:delete`
- `logger:show`
- `matomo:install`
- `segment:admin`
- `segment:list`
- `site:add`
- `site:delete`
- `site:list`
- `site:url`
- `visits:get`
- `customdimensions:configure-new-dimension`

Background
----------

[](#background)

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.

Known bugs
----------

[](#known-bugs)

Adding a site as part of `matomo:install` is currently broken, but you could just after the command run the `site:add` command:

```
./console site:add --name=Foo --urls=https://foo.bar
```

Dependencies
------------

[](#dependencies)

Sine version 4.1.0-beta1 we are dependent on PHP 8.1

### On host

[](#on-host)

- mysql-client or mariadb-client (for database tasks)
- PHP json extension

### In composer.json (Matomo root)

[](#in-composerjson-matomo-root)

From version 5.1.0:

- `composer require symfony/yaml:~2.6.0` (moves it from dev)

From version 4.1.0-beta1:

- `composer require symfony/yaml:~2.6.0` (moves it from dev)
- `composer require symfony/process:^5.4`

Earlier versions:

- `composer require symfony/yaml:~2.6.0` (moves it from dev)
- `composer require symfony/process:^3.4`

Install
-------

[](#install)

Git clone the plugin into your plugins folder:

```
git clone https://github.com/digitalist-se/extratools.git ExtraTools
```

Config
------

[](#config)

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"
```

### Database SSL/TLS

[](#database-ssltls)

The database commands (`database:backup`, `database:create`, `database:drop`, `database:import`) shell out to the `mysql`/`mysqldump`/`mysqladmin` clients. To connect over SSL/TLS they read the same SSL keys Matomo uses in the `[database]`section of `config.ini.php`:

```
[database]
enable_ssl = 1
ssl_ca = "/etc/ssl/certs/ca-certificates.crt"
ssl_cert = "/path/to/client-cert.pem"
ssl_key = "/path/to/client-key.pem"
ssl_ca_path = "/etc/ssl/certs"
ssl_cipher = ""
ssl_no_verify = 1
```

Only `enable_ssl` is required to turn SSL on; the remaining keys are optional. Set `ssl_no_verify = 1` to require encryption without verifying the server certificate. The settings are written to a temporary client option file, and client specific options use the `loose-` prefix so they work with both the MySQL and MariaDB command line clients.

For `matomo:install`, the same keys can be supplied via command line options (`--db-enable-ssl`, `--db-ssl-ca`, `--db-ssl-cert`, `--db-ssl-key`, `--db-ssl-ca-path`, `--db-ssl-cipher`, `--db-ssl-no-verify`), environment variables, or the `database` section of an install file.

Commands
--------

[](#commands)

### `archive:list`

[](#archivelist)

Gets al list of ongoing or scheduled core archivers, if such exist.

### `extra:bootstrap`

[](#extrabootstrap)

Bootstraps Matomo (config, DI container, plugins) and warms the tracker cache (general plus per-site attributes). Use `--idsite` to warm specific sites, or `--skip-sites` to only warm the general cache.

### `extra:clear-external-cache`

[](#extraclear-external-cache)

Clears Matomo's cache entries from the configured external (Redis) cache backend using `SCAN`/`DEL` instead of `FLUSHDB`. Use this when the regular `cache:clear` appears to not clear the cache — this happens when Redis is shared with other applications or the hosting provider disables/restricts `FLUSHDB`/`FLUSHALL`. Because it only deletes Matomo's own `matomocache_*`and `eagercache-*` keys, it is safe to run even if QueuedTracking's Redis queue (`trackingQueueV1*`/`QueuedTrackingLock*` keys) shares the same `database` as the cache — unlike `cache:clear` or a manual `redis-cli flushdb`, which would wipe the queue too. Does nothing (and exits successfully) if Redis is not the configured cache backend.

### `extra:config:get`

[](#extraconfigget)

Gets a section config. @todo - make this more like config:set - so you have more options.

### `database:backup`

[](#databasebackup)

Backups the db.

### `database:create`

[](#databasecreate)

Creates the db defined i config.ini.php. Adding the --force flag stops the command for asking questions.

### `database:drop`

[](#databasedrop)

Drops the db defined i config.ini.php - backup first if needed. Adding the --force flag stops the command for asking questions.

### `database:import`

[](#databaseimport)

Imports database dump to database defined in config.ini.php, so if you already have a installation - it overwrites it.

### `logger:delete`

[](#loggerdelete)

Removes logging entries from the DB, that is the internal logging in Matomo, not visits on sites.

### `logger:show`

[](#loggershow)

Show logging and query entries of logs from the database, output could be exported to CSV.

### `matomo:install`

[](#matomoinstall)

To use matomo:install, you need ExtraTools to always be enabled, add `always_load_commands_from_plugin=ExtraTools` to `common.config.ini.php`.

Here is how we do it in ad docker image build:

```
    echo "[General]" > /var/www/html/config/common.config.ini.php; \
    echo "always_load_commands_from_plugin=ExtraTools" >> /var/www/html/config/common.config.ini.php; \
```

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.

### `segment:admin`

[](#segmentadmin)

Administration of segments, only options right now is to delete or activate a segment, a deleted segment could later be activated again.

### `segment:list`

[](#segmentlist)

List all segments, with ID, definition, date created and latest updated.

### `site:add`

[](#siteadd)

Adds a new site to track. If a site with the same name already exists, no site is added.

### `site:delete`

[](#sitedelete)

Deletes a site with ID provided.

### `site:list`

[](#sitelist)

List sites, with the optional format argument - supported output is text(default), json and yaml.

### `site:url`

[](#siteurl)

Adds one or more URLs to a site.

### `visits:get`

[](#visitsget)

Get all archived visits, for one site or all. For a segment or all segments, for today, or another day etc.

### `customdimensions:configure-new-dimension`

[](#customdimensionsconfigure-new-dimension)

Configure a new custom dimension. BETA.

### phpinfo page

[](#phpinfo-page)

Provides a phpinfo page in the admin section. Access it via: Administration → Extra Tools → Phpinfo.

This displays the PHP configuration information similar to `phpinfo()`.

### Invalidated Archives

[](#invalidated-archives)

Lists invalidated archive entries from the database. This helps you see which archives have been invalidated and need to be re-processed by the archiver. Access it via: Administration → Extra Tools → Invalidations.

Shows the archive name (or "All visits" for the default), period type, date, and when it was invalidated.

#### Requirements

[](#requirements)

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.

#### Environment variables

[](#environment-variables)

Supported default environment variables from the official Matomo docker container:

```
MATOMO_DATABASE_HOST
MATOMO_DATABASE_PORT
MATOMO_DATABASE_TABLES_PREFIX
MATOMO_DATABASE_USERNAME
MATOMO_DATABASE_PASSWORD
MATOMO_DATABASE_DBNAME
MATOMO_DATABASE_ADAPTER
```

Non-default:

```
MATOMO_DATABASE_COLLATION
MATOMO_DATABASE_CHARSET
MATOMO_DATABASE_ENABLE_SSL
MATOMO_DATABASE_SSL_CA
MATOMO_DATABASE_SSL_CERT
MATOMO_DATABASE_SSL_KEY
MATOMO_DATABASE_SSL_CA_PATH
MATOMO_DATABASE_SSL_CIPHER
MATOMO_DATABASE_SSL_NO_VERIFY
```

These could be overridden with (historical reasons):

```
MATOMO_DB_HOST
MATOMO_DB_PREFIX
MATOMO_DB_USERNAME
MATOMO_DB_PASSWORD
MATOMO_DB_NAME
MATOMO_DB_COLLATION
MATOMO_DB_CHARSET
```

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)
```

#### Installation preparation

[](#installation-preparation)

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.

#### Example install 1 (recommended)

[](#example-install-1-recommended)

```
console matomo:install --install-file=install.json
```

#### Example install 2

[](#example-install-2)

```
console matomo:install --db-username=myuser --db-pass=password \
  --db-host=localhost --db-port=3306 --db-name=matomo --first-site-name=Foo \
  --first-site-url=https//foo.bar --first-user='Mr Foo Bar' \
  --first-user-email=foo@bar.com --first-user-pass=secret
```

#### Example install 3

[](#example-install-3)

Using environment variables, docker-compose.yml example.

```
environment:
      - MATOMO_DB_USERNAME=myuser
      - MATOMO_DB_PASSWORD=secret
      - MATOMO_DB_HOST=mysql
      - MATOMO_DB_PORT=3306
      - MATOMO_DB_NAME=matomo
      - MATOMO_FIRST_USER_NAME=Mr Foo Bar
      - MATOMO_FIRST_USER_EMAIL=foo@bar.com
      - MATOMO_FIRST_USER_PASSWORD=secret
      - MATOMO_FIRST_SITE_NAME=Foo
      - MATOMO_FIRST_SITE_URL=https://foo.bar
```

#### Order of values

[](#order-of-values)

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)

CAUTION!
--------

[](#caution)

- `matamo:install` wipes 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!

Tested together with Matomo Helm chart
--------------------------------------

[](#tested-together-with-matomo-helm-chart)

As the ExtraTools plugin is important part of our [Matomo Helm chart](https://github.com/Digitalist-Open-Cloud/matomo-kubernetes), new versions of this plugin are tested together with the latest release of the Helm chart with Github actions.

Version supported
-----------------

[](#version-supported)

This plugin requires Matomo >= 5.1.0, < 6.0.0-b1.

Thank you!
----------

[](#thank-you)

This plugin is based on work done by [Ben Evans](https://github.com/nebev) in , and also reusing code in Matomo core.

License
-------

[](#license)

Copyright (C) Digitalist Open Cloud

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see .

###  Health Score

61

—

FairBetter than 99% of packages

Maintenance93

Actively maintained with recent releases

Popularity26

Limited adoption so far

Community21

Small or concentrated contributor base

Maturity89

Battle-tested with a long release history

 Bus Factor1

Top contributor holds 85.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~45 days

Recently: every ~91 days

Total

61

Last Release

22d ago

Major Versions

3.1.0-beta13 → 4.0.0-beta12020-11-21

3.1.0-beta14 → 4.0.0-beta22020-12-02

3.1.0-beta16 → 4.0.0-beta32020-12-22

4.1.0-beta2 → 5.0.0-beta12023-05-05

4.1.0-beta5 → 5.0.0-beta22023-05-15

PHP version history (5 changes)0.1-alpha5PHP >=7.1

4.0.0-beta1PHP >=7.2

4.0.0-beta7PHP >=7.4

4.1.0-beta1PHP >=8.0

5.2.0PHP >=8.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/ab5d6537b6884dea5af31eebe7d0a19554b2810a2f1e0034ba2f6349182152b8?d=identicon)[se.support](/maintainers/se.support)

---

Top Contributors

[![mikkeschiren](https://avatars.githubusercontent.com/u/712838?v=4)](https://github.com/mikkeschiren "mikkeschiren (90 commits)")[![mbrodala](https://avatars.githubusercontent.com/u/5037116?v=4)](https://github.com/mbrodala "mbrodala (11 commits)")[![chriscroome](https://avatars.githubusercontent.com/u/1788560?v=4)](https://github.com/chriscroome "chriscroome (1 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")[![trobiyo](https://avatars.githubusercontent.com/u/29449542?v=4)](https://github.com/trobiyo "trobiyo (1 commits)")[![web-flow](https://avatars.githubusercontent.com/u/19864447?v=4)](https://github.com/web-flow "web-flow (1 commits)")

---

Tags

matomomatomo-climatomo-plugincliinstall

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP\_CodeSniffer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/digitalist-open-cloud-extratools/health.svg)

```
[![Health](https://phpackages.com/badges/digitalist-open-cloud-extratools/health.svg)](https://phpackages.com/packages/digitalist-open-cloud-extratools)
```

###  Alternatives

[tempest/framework

The PHP framework that gets out of your way.

2.3k37.6k21](/packages/tempest-framework)[jolicode/castor

A lightweight and modern task runner. Automate everything. In PHP.

55344.7k5](/packages/jolicode-castor)[drupal/core

Drupal is an open source content management platform powering millions of websites and applications.

19467.3M1.9k](/packages/drupal-core)[kimai/kimai

Kimai - Time Tracking

4.8k9.4k1](/packages/kimai-kimai)[drupal/core-recommended

Locked core dependencies; require this project INSTEAD OF drupal/core.

6943.5M449](/packages/drupal-core-recommended)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

595.8M672](/packages/shopware-core)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)