mediengarage/piwik-consent-manager

0.2.4 2023-02-09 16:05 UTC

This package is auto-updated.

Last update: 2024-07-09 19:02:24 UTC


README

Mediengarage Logo

PIWIK Consent Manager TYPO3 extension

PIWIK Consent Manager integration in order to make TYPO3 content elements GDPR compliant.

You can click on the images in this readme to see a larger version.

  1. What does it do?
  2. Installation
  3. Quick Start
  4. TypoScript Condition
  5. Roadmap

🤔 What does it do?

Instead of privacy harming content a placeholder will be displayed to the user.

Bildschirmfoto 2022-06-09 um 21 56 47

Only when the user gives its consent on the PIWIK Consent Manager the page is reloaded and the actual content will be shown.

Bildschirmfoto 2022-06-09 um 21 57 13

📦 Installation

  1. Install extension

    • Composer

      composer req mediengarage/piwik-consent-manager:~0.1
    • Non Composer

      If you want to install into a non composer TYPO3, using the TER is recommended. You can download and install it directly from the Extension Manager of your TYPO3 instance.

  2. Include static template into your root TypoScript template and click save:

    include_static_template
  3. Navigate to Configure extensions from the Settings module under Admin Tools:

    configure_extensions
  4. Enter your PIWIK Pro credentials. Check step 5 to see from where to retrieve those values from. Keep them secret!

    extensions settings
  5. Login to your PIWIK Pro account and navigate to Menu -> Administration. Choose your website and click the Installation tab.

    piwik_installation

🚀 Quick Start

Quickstart shows how to embed a YouTube video which is only displayed when a user gives its consent. A placeholder will be shown if no consent was set or it was declined.

In order to have a basic website for presentation purposes the quick start guide uses https://github.com/benjaminkott/bootstrap_package.

  1. Create a new content element anywhere on the page and choose YouTube from the new privacy tab:

    new_content_element
  2. Paste the embed markup into text area and choose a consent type to which the element should react. React means it will be displayed when the user gives its consent on that type. The default placeholder image can be overwritten on a per content element basis in the image tab.

    yt_content_element
  3. Login to your PIWIK Pro account and navigate to Menu -> Tag Manager. Create an asynchronous tag for the chosen consent type (Custom Consent in this example) in order to reload the page when a consent was sent. Don't forget to save and publish (or debug to test on production system).

    <script>
        location.reload();
    </script>
    piwik_tag

🤓 Custom TypoScript Condition

In order to e.g. embed JavaScript based on whether a consent is set or not a custom TypoScript condition can be used.

[ConsentAspect('custom_consent')]
page.includeJSFooter {
  foo = EXT:bar/Resources/Public/JavaScript/script.js
}
[GLOBAL]

🛣 Roadmap

  • We're currently working on a solution that works using ajax instead reloading the complete page.
  • The readme is clearly under construction 🙂