How do I install a new plugin?
Matomo (Piwik) is a platform which you can extend and customise to your needs with Plugins. To get started installing a plugin, login as a Super User. In the top menu, click « Administration ». In the left menu click « Plugins ».
If you have purchased the Premium Feature already, make sure the license key is added in your Matomo instance before installing the plugin: please follow this guide.
There are a few ways to install a plugin in Matomo:
-
Install a new plugin using the Marketplace: on the Marketplace page you can browse existing plugins, if you want to install one of those plugins, click on « Install » button.
-
Upload a Plugin ZIP file to Matomo: if you were given the ZIP file of a plugin, you will need to upload it to Matomo. To do so, login to Matomo as a Super User, click on Administration and then on the « Marketplace » page, click on « upload a zip file ». Note: the first time you want to upload a custom plugin you will activate this feature once by editing your config/config.ini.php file and below the category
[General]add:enable_plugin_upload=1. -
Install a new plugin manually: this last technique only works if you have direct access to the Matomo server. Uncompress the Plugin zip file that you wish to install in Matomo. This should create a directory with the name of the plugin. Copy this uncompressed folder into your server in the directory path/to/piwik/plugins/.
By default, when you install a plugin it is not activated. To activate a plugin, go to the « Plugins » page in Administration and click « Activate » next to the plugin name.
If you have access to the server, you can also run the following command to activate a plugin (in this example the CustomDimensions plugin):
cd path/to/matomo
php console plugin:activate CustomDimensions