Plausible Analytics Integration for TYPO3

Find a file

Marcel Kapfer 7d22f3569b Don't add script if logged into BE		2021-05-03 19:48:34 +02:00
Classes/Hooks	Don't add script if logged into BE	2021-05-03 19:48:34 +02:00
Configuration/SiteConfiguration/Overrides	Initial commit	2021-04-11 13:41:47 +02:00
Resources	Initial commit	2021-04-11 13:41:47 +02:00
.editorconfig	Initial commit	2021-04-11 13:41:47 +02:00
.gitignore	Initial commit	2021-04-11 13:41:47 +02:00
CHANGELOG.md	Release preparations for 1.0.0	2021-04-12 22:14:05 +02:00
composer.json	Add PHP version constraint to composer file	2021-04-12 10:28:30 +02:00
ext_emconf.php	Initial commit	2021-04-11 13:41:47 +02:00
ext_localconf.php	Initial commit	2021-04-11 13:41:47 +02:00
LICENSE	Initial commit	2021-04-11 13:41:47 +02:00
README.md	Initial commit	2021-04-11 13:41:47 +02:00

README.md

Plausible Analytics TYPO3 Integration

This plugins provides an integration of the Plausible analytics software to TYPO3. Currently this consists (only) in adding the script tag for loading the JavaScript tracker.

Installation

Install this plugin using one of the following possibilities.

Composer (see https://docs.typo3.org/m/typo3/guide-installation/master/en-us/ExtensionInstallation/Index.html#install-extension-with-composer)
Extension Manager (see https://docs.typo3.org/m/typo3/guide-installation/master/en-us/ExtensionInstallation/Index.html#install-an-extension-without-composer)
Download the zip-Archive from the Releases page and install it manually.

Setup

To enable the Plausible integration for a site you need to edit its site configuration in the "Sites" module. You will find a "Plausible Analytics" tab and there you can provide the following information.

Plausible URL

Enter here the URL to the Plausible instance you are using. If you registered your site on the main one (plausible.io) then put https://plausible.io in here.

For using the Plausible integration this is necessary.

Domain name for Plausible

You may provide the domain name with which you registered your site at Plausible here. This is the attribute data-domain that you can find in the site configuration in Plausible.

If you leave this empty the extension will try to use the value set in the "General" tab under "Entry Point" in the TYPO3 site configuration. If this is not a "real" URL but just a path and the "Domain name for Plausible" fields is left empty then the integration will not be added.

Check

You should probably check if the script tag for loading the JavaScript tracker is added successfully. To do so visit one of your pages in the frontend and open the page inspector of your browser. In the HTML code you should find a tag like <script async="async" defer="defer" data-domain="<your data-domain>" src="<your src>"></script> near the end of the code (but inside the <body> tag).