How do I install a new plugin?
You can extend and customise Matomo On Premises with free plugins and premium features available on the Matomo Marketplace. (If you are using Matomo Cloud, most of the plugins will already be installed. In a few cases, more can be added if you contact our support team.) Whether you are installing a plugin or premium feature, the installation steps are the same. This FAQ provides an overview of installing a plugin. For detailed instructions, follow the guide on how to install a Matomo Premium Feature.
Pre-requisites
- It may help to be logged in to Matomo as a Super User.
- If the plugin requires a paid subscription key, like these you should enter the subscription key in the Matomo interface: Interface >> Admin(gear icon) >> Plugins.
Option One
In Matomo, you can browse existing plugins in the interface. This may be in the marketplace button, from the main interface, or in the Admin screen: Interface >> Admin(gear icon) >> Plugins.
Option Two
Install a new plugin using the web Marketplace: On the Marketplace website, click on the plugin you want to install and use the download links to download the zip file.
Option Three
Upload a Plugin ZIP file to Matomo: If you have the ZIP file of a plugin, you will need to upload it to Matomo. As a Super User with access to the admin settings, open Marketplace and 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.
Option Four
Install a new plugin manually: This method only works if you have direct access to the Matomo server. Uncompress the plugin zip file that you want 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/.
Easy to forget this last step
You have not activated the plugin yet! By default, when you install a plugin it is not activated. To activate a plugin, click on the Admin cog icon > Plugins > License key and paste the key in the field and click Activate.
Activation can also be executed at the CLI. 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
Download Links
In some cases, these links may be handy to remember for getting files of the plugins and of Matomo itself:
The plugin files portal
The core files portal