Download the PHP package tms/consent without Composer
On this page you can find all versions of the php package tms/consent. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package consent
Short Description Simple, lightweight and customizable consent manager for Neos CMS based on Klaro!
License MIT
Informations about the package consent
Consent Manager for Neos CMS
Simple, lightweight and customizable consent manager for Neos CMS based on Klaro!
Let your users decide, which scripts should be loaded and executed while visiting your website.
IMPORTANT: We are developers, no lawyers. Using this package without further adaptation will most likely NOT result in GDPR, ePrivacy nor CCPA compliance!
Install
What's included?
- Klaro Script + opinionated Klaro Config (override or use your own anytime)
- Klaro Config editing via
Settings.yaml
& predefined services - Klaro default styles & themes
/Resources/Private/Styles/Theme
- Placeholder for blocked content elements (Fusion Component + JS)
- Consent settings button (Fusion Component + JS)
- Overrides for common Neos packages
/Resources/Private/Fusion/PresetPackages
Usage
Step 1: Service configuration via YAML
settings
This package includes default consent management settings for the following services. Enable them in your Settings.yaml
or add your own services.
- Cloudflare
- Matomo
- Google Analytics
- Google Maps
- Youtube
Extend your services
Simply extend the YAML
settings within your Neos package.
Think your service configuration is useful for others too?
Don't hesitate to submit a PR. All the service related configuration should be combined in one settings
file named like Settings.Consent.YourServiceName.yaml
.
Step 2: Modify HTML
In order to control your configured services (e.g. to stop loading and/or execution without consent) it is necessary to modify the resulting HTML of your webpages.
This can be achieved by simply replacing some attributes - see https://github.com/KIProtect/klaro#managing-third-party-appstrackers
We try to provide preconfigured solutions for some common Neos packages, please have a look at /Resources/Private/Fusion/PresetPackages
what we've already covered. Your package is missing? Submit a PR, if you think the service configuration could be useful for others.
Step 3: Verify
Check your site - have you blocked all your critical services?
- by using the dev tools of your favorite browser
- or simply run a check on https://webbkoll.dataskydd.net/
(Optional) Step 4: Better UX for blocked content elements
This is an example how to use the Fusion Component for a Youtube + Bootstrap markup.
Wishlist
- Add multi-site support
- Backend module with some basic statistics on acceptance rate
- User location based configurations
Any feedback, pull request or other contribution is very welcome!
Acknowledgments
Development sponsored by tms.development - Online Marketing and Neos CMS Agency
Webpack config inspired by https://github.com/neos/redirecthandler-ui