Skip to content

Repository files navigation

Pericia.AspNetCore.Matomo

Build status

ASP.NET Core Tag helper for Matomo analytics service

Install

The library Pericia.AspNetCore.Matomo is available on Nuget : NuGet

You can install it with the following command line in your Package Manager Console :

Install-Package Pericia.AspNetCore.Matomo

Or with dotnet core :

 dotnet add package Pericia.AspNetCore.Matomo 

GDPR compliance

This library is built to help you to be compliant with the European General Data Protection Regulation (GDPR), and is based on the CNIL recommendations

In order to be fully compliant, you need to configure Matomo to anonymize data, and mask at leat 2 bytes of the visitors' IP. You also have to let the user opt-out, by addind the opt-out iframe in your privacy page (see below).

If you don't do this, you must ask for user consent before to add the tracking tag.

How to use

Configuration

Add a "Matomo" section in your settings file :

"Matomo": {
	"TrackerUrl": "https://stats.example.com",
	"SiteId": "1",
	"TrackerOptions": {
		"DisableCookieTimeoutExtension": true,
		"NoScriptTracking": true,
		"PrependDomainToTitle": false,
		"ClientDoNotTrackDetection": true
	},
	"OptoutOptions": {
		"Language": "fr"
	}
}

Required parameters :

  • TrackerUrl : the url of your matomo site
  • SiteId : the id of the website in matomo

Optional parameters :

  • TrackerOptions:DisableCookieTimeoutExtension : limit the cookie duration to 13 months - required for GDPR compliance (defaults true)
  • TrackerOptions:NoScriptTracking : tracks users with JavaScript disabled (defaults true)
  • TrackerOptions:PrependDomainToTitle : prepend the site domain to the page title when tracking (defaults false)
  • TrackerOptions:ClientDoNotTrackDetection : enable client side DoNotTrack detection (defaults true)
  • OptoutOptions:Language : the 2-letter code for the language used in the opt-out screen (defaults en)

Tag helpers

Reference the tag helpers :

@addTagHelper *, Pericia.AspNetCore.Matomo

Add the tracking script in your page before </head>

<matomo-tracking></matomo-tracking>

Add the opt-out iframe in your Privacy page

<matomo-opt-out></matomo-opt-out>

About

ASP.NET Core Tag helper for Matomo analytics service

Resources

Stars

2 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages