pixelopen/kirby-cookie-consent

A plugin for Kirby CMS to handle RGPD and Cookie Gestion with the tarteaucitronjs script

dev-main 2023-10-30 14:58 UTC

Requires

• getkirby/cms: ^3.9 || ^4.0.0-beta.2
• getkirby/composer-installer: ^1.2

Requires (Dev)

• symplify/easy-coding-standard: ^12.0

MIT

• Pixel Open

• kirby
• kirby-plugin
• kirby-cms

README

A plugin for Kirby CMS to handle cookie consent for the GDPR

Commercial Usage

This plugin is free

Installation

Download

Download the files and place them inside site/plugins/kirby-cookie-consent.

Composer

composer require pixelopen/kirby-cookie-consent

Git Submodule

You can add the plugin as a Git submodule.

$ cd your/project/root
$ git submodule add https://github.com/Pixel-Open/kirby-cookie-consent.git site/plugins/kirby-cookie-consent
$ git submodule update --init --recursive
$ git commit -am "Add Kirby Cookie Consent plugin"

Run these commands to update the plugin:

$ cd your/project/root
$ git submodule foreach git checkout master
$ git submodule foreach git pull
$ git commit -am "Update submodules"
$ git submodule update --init --recursive

Initialization

Run your website. Add the tabs tabs/cookie-consent to your site.yml blueprint. You should see a new tab named Cookie Consent in the homepage of the panel. From this page you can edit the settings of the cookie consent module.

Add the snippet cookie-consent to your header snippet to activate the plugin in the frontend.

The plugin functionnalities work well with Kirby 3 and 4. The plugin only handle 5 services for the moment. If you want to add more service, add the specific by yourself in the file snippets/cookie-services.php. All available services and their script can be found on the official tarteaucitron website

Options

You can fix a parameter to a specific value by adding it in the config : pixelopen.kirby-cookie-consent.[parameterName]