Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for Matomo #4018

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

AndreaBarbasso
Copy link
Contributor

@AndreaBarbasso AndreaBarbasso commented Feb 21, 2025

Please note that this work has been funded by University of Maryland


References

Description

This PR adds an integration with Matomo, the most used alternative to Google Analytics. The code lies on top of the solutions previously adopted for Analytics. An Orejime cookie for tracking purposes with Matomo has been added.

Instructions for Reviewers

List of changes in this PR:

  • Integrated ngx-matomo-client in DSpace;
  • Added configuration options for Matomo;
  • Created a new Orejime cookie for Matomo.

In order to test this PR, a Matomo instance needs to be up and running. Follow the instructions on this PR to setup and integrate with DSpace a self hosted Matomo instance. You can also use a Matomo Cloud instance (a free demo of 30 days is available).
Two new attributes in settings are needed. trackerUrl is the endpoint of the Matomo instance, while siteId is used to distinguish different sites on the same Matomo instance - e.g. for communication with a self-hosted Matomo instance listening on the default port, this is the correct value of the matomo settings object:

matomo:
  siteId: 1
  trackerUrl: 'http://localhost:8081'

If there is no matomo.sideId or matomo.trackerUrl property, the Orejime cookie for Matomo will not show up.
Then, if the cookie is not accepted, the Matomo tracking will not start.

As soon as the Matomo cookie is accepted, user actions on DSpace should be logged onto Matomo.

Checklist

  • My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • My PR passes ESLint validation using npm run lint
  • My PR doesn't introduce circular dependencies (verified via npm run check-circ-deps)
  • My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • My PR aligns with Accessibility guidelines if it makes changes to the user interface.
  • My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
  • If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 👀 Under Review
Development

Successfully merging this pull request may close these issues.

Support for other Analytics service is required to be GDPR compliant
2 participants