Track visits of your Neos site with

1.5.1 2021-08-29 18:41 UTC

This package is auto-updated.

Last update: 2021-11-18 09:25:04 UTC


Latest stable version Total downloads License GitHub forks GitHub stars GitHub watchers

Carbon.Plausible Package for Neos CMS

Easily integrate Plausible Analytics into your Neos site.


Plausible is a lightweight and open-source website analytics tool. It doesn't use cookies and is fully compliant with GDPR, CCPA, and PECR. This plugin is meant to remove all friction from adding the Plausible Analytics tracking script code to your Neos site. All you need to do is define your Plausible domain in your Neos Settings.yaml file.


  • Multi-site compatibility
  • Backend module
  • Check if the requested domain matches the defined domain to track
  • Enabled per default only on Production environment
  • Embed stats directly into the Neos Backend
  • Proxies the needed JS files (cached for 6 hours) and API from Plausible

Multi-site compatibility

If you run a multi-site setup, we got you covered! You can set different trackings for the sites based on the root node name.

Backend module

This package adds a backend module to your Neos instance, which helps check your configuration and opt-out your browser for tracking.

screenshot of backend module as administrator

If a backend user is not an administrator, he'll get a different view:

screenshot of backend module as editor

It also checks if the resulting javascript path doesn't return a 404 error:

error in the backend module

NodeType mixins for disable tracking on a document or set custom events

This package contains two mixins:

set options in the inspector

Opt out and exclude your visits from the analytics

By default, Plausible Analytics tracks every visitor to your website. When you're working on your site, you might not want to record your own visits and page views. To prevent counting your visits, you can set a special localStorage flag in the browser. Here's how.

  • Go to your-domain.tld/~/disable-tracking. This sets the flag and redirects the visitor to the homepage. Great for people without access to the Neos Backend.
  • As an Editor, you can enable/disable the flag also in the Plausible management module: your-domain.tld/neos/management/plausible
  • Add the component Carbon.Plausible:Component.Toggle to a document and click the button.
  • You can do this also by yourself by following the excluding guide on

Tracking custom event goals with data-analytics

To use this feature, you have to enable the dataAnalyticsTracking setting. Register events in the HTML with the use of an attribute tag data-analytics.

Note: Watch your quotes! Especially in the props as we want to be able to create an object.

<!-- Tracking a form -->
  <button type="submit" data-analytics='"Contact"'>Send Message...</button>

<!-- Tracking a link -->
  data-analytics='"Register", {"props":{"plan":"Navigation"}}'


Run the following command in your site package

composer require --no-update carbon/plausible

Then run composer update in your project root.


Single-site setup

If you have a single site setup, you can adjust the configuration under the key Carbon.Plausible.default in your Settings.yaml:

Key Default Description
domain null Set here the plausible domain. This setting is required
reverseProxy true Proxies the needed Javascript (cached for 6 hours) and API calls from Plausible. If set, the settings host has no effect
host null If you have set a custom domain, you can set it here. Example: For new instances you cannot set up a custom domain, as it is depreciated. To enable this setting, you have to set reverseProxy to false.
hashBasedRouting false Automatically follow frontend navigation when using hash-based routing
exclusions false Exclude certain pages from being tracked
outboundLinks false Automatically track clicks on outbound links from your website
compat false Compatibility mode for tracking users on Internet Explorer
local false Allow analytics to track on localhost too which is useful in hybrid apps
customEvents false If you want to set custom events in your javascript, set this to true or a string. If set to a string, this whole string gets included on every document. If you set custom events via Fusion or the Carbon.Plausible:Mixin.CustomEvent mixin, you don't have to set it to true. The snippet gets activated automatically if needed. The inline javascript get's minified with JShrink
dataAnalyticsTracking false If you want to enable data-analytics for tracking links and form submits set this to true
sharedLink null If you have opened up your [website stats to the public] or created a [private and secure link], enter it to enable the embedded view of the stats in the backend

Multi-site setup

If you run multiple sites on one Neos installation, you can set this under the key Carbon.Plausible.sites in your Settings.yaml. Be aware that if you set one value in Carbon.Plausible.default, these are set as the new fallback value. For example, if you set Carbon.Plausible.default.outboundLinks to true, is outboundLinks set to true per default for all sites. Of course, you can disable this again if you set this to false on your site setting.


        outboundLinks: true
        hashBasedRouting: true
        exclusions: "/blog4, /rule/*, /how-to-*, /*/admin"
        customEvent: "plausible('Download', {props: {method: 'HTTP'}})"
          - /blog4
          - /rule/*
          - /how-to-*
          - /*/admin

The key of the site (e.g. myfirstsite) is the root node name found under Administration » Sites Management.

Fusion Components


The main Fusion component is Carbon.Plausible:Component.TrackingCode. This component gets included into Neos.Neos:Page under the path plausibleTrackingCode. So if you want to add a custom event to a ceratin document, you can do it like this:

prototype(Vendor.Site:Document.NotFound) < prototype(Neos.Neos:Page) {
    plausibleTrackingCode.customEvents = 'plausible("404",{ props: { path: document.location.pathname } });'


Carbon.Plausible:Component.Toggle is a small component to let the user if he wants to opt-out from tracking.