How do I install a new plugin?

You can extend and customise Matomo with free plugins and premium features available on the Matomo Marketplace. 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.

There are a few ways to install a plugin in Matomo.

  1. To get started installing a plugin, log in to Matomo as a Super User.

  2. In the top menu bar, click the Admin cog icon Settings Cog Icon and navigate to Plugins.

  3. If you have purchased the plugin already, make sure the licence key is added in your Matomo instance before installing.

  • Install a new plugin using the in-app Marketplace: In Matomo, you can browse existing plugins on the Marketplace page. To install a plugin, click the green Install button on the plugin tile.

  • 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.

  • 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.

  • 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/.

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.

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
Previous FAQ: List of Matomo plugins