Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eea/volto-matomo
Matomo integration for Volto
https://github.com/eea/volto-matomo
Last synced: about 2 months ago
JSON representation
Matomo integration for Volto
- Host: GitHub
- URL: https://github.com/eea/volto-matomo
- Owner: eea
- License: mit
- Created: 2020-10-21T13:08:33.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T17:55:08.000Z (5 months ago)
- Last Synced: 2024-06-18T23:02:11.762Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 184 KB
- Stars: 3
- Watchers: 37
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-volto - volto-matomo - Basic Matomo Tracker integration for Volto (Addons)
README
# volto-matomo
[](https://github.com/eea/volto-matomo/releases)
[](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-matomo/job/master/display/redirect)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-matomo-master)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-matomo-master)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-matomo-master)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-matomo-master)
[](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-matomo/job/develop/display/redirect)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-matomo-develop)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-matomo-develop)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-matomo-develop)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-matomo-develop)
[Volto](https://github.com/plone/volto) add-on that integrates [Matomo](https://matomo.org/) with [Volto](https://github.com/plone/volto) sites. At this moment there is a very basic integration that just pings Matomo on each router location change.
## How to
To configure it, either set the following variables:
- `settings.matomoSiteId` (if not available it uses: `1`)
- `settings.matomoUrlBase` (if not available it uses: `https://matomo.eea.europa.eu/`)
or `RAZZLE_MATOMO_SITE_ID` and `RAZZLE_MATOMO_URL` environment variables.
With version 4.0.0+, you have the possibility to use a second matomo in parallel:
- `settings.matomoSecondSiteId` (if not available it uses: `1`)
- `settings.matomoSecondUrlBase` (if not available it uses: `https://matomo.eea.europa.eu/`)
or `RAZZLE_MATOMO_SECOND_SITE_ID` and `RAZZLE_MATOMO_SECOND_URL` environment variables.
## API
There are four exports in `utils.js` (which can be imported from `volto-matomo/utils`, including from other Volto addons):
1. `trackPageView({ href, ...options }) : void` - takes an object with `href` and other options and sends to Matomo a page view track;
2. `trackEvent(options) : void` - takes an `options` object parameter and sends to Matomo an event track.
3. `trackSiteSearch(options) : void` - takes an `options` object parameter and sends to Matomo an site search track.
4. `pushInstruction(name, ...args): void` - takes a name and an arbitrary number of parameters, and pushes them to Matomo.
Note that the Matomo instance is behind the scenes lazy-loaded and cached.
The default behavior of volto-matomo is a call to `trackPageView` in `utils.js`, with the `href` and `documentTitle` options, on every URL change as recorded by the `AppExtras` component in Volto. The `href` is taken from `props.content['@id']` received by the `MatomoAppExtra.jsx` component. The `utils.js` file exposes just a part of the Matomo React API. If you wish to extend it or to understand it better, [this link](https://github.com/Amsterdam/matomo-tracker/tree/master/packages/react) might be helpful.
## Getting started
### Try volto-matomo with Docker
git clone https://github.com/eea/volto-matomo.git
cd volto-matomo
make
make start
Go to http://localhost:3000
### Add volto-matomo to your Volto project
1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
```Bash
docker compose up backend
```
1. Start Volto frontend
* If you already have a volto project, just update `package.json`:
```JSON
"addons": [
"@eeacms/volto-matomo"
],
"dependencies": {
"@eeacms/volto-matomo": "*"
}
```
* If not, create one:
```
npm install -g yo @plone/generator-volto
yo @plone/volto my-volto-project --canary --addon @eeacms/volto-matomo
cd my-volto-project
```
1. Install new add-ons and restart Volto:
```
yarn
yarn start
```
1. Go to http://localhost:3000
1. Happy editing!
## Release
See [RELEASE.md](https://github.com/eea/volto-matomo/blob/master/RELEASE.md).
## How to contribute
See [DEVELOP.md](https://github.com/eea/volto-matomo/blob/master/DEVELOP.md).
## Copyright and license
The Initial Owner of the Original Code is European Environment Agency (EEA).
All Rights Reserved.
See [LICENSE.md](https://github.com/eea/volto-matomo/blob/master/LICENSE.md) for details.
## Funding
[European Environment Agency (EU)](http://eea.europa.eu)