The Cookie Consent Plugin is for Grav CMS. This grav plugin is to alert users about the use of cookies on your website. The plugin integrates the popular js lib cookie consent by Osano - previously known as Silktide Cookie Consent and Cookie Consent by Insites.
Installing the Cookieconsent plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.
The simplest way to install this plugin is via the Grav Package Manager (GPM) through your system's terminal (also called the command line). From the root of your Grav install type:
bin/gpm install cookieconsent
This will install the Cookieconsent plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/cookieconsent.
To install this plugin, just download the zip version of this repository and unzip it under /your/site/grav/user/plugins. Then, rename the folder to cookieconsent. You can find these files on GitHub or via GetGrav.org.
You should now have all the plugin files under
/your/site/grav/user/plugins/cookieconsent
NOTE: This plugin is a modular component for Grav which requires Grav and the Error and Problems to operate.
Before configuring this plugin, you should copy the user/plugins/cookieconsent/cookieconsent.yaml to user/config/plugins/cookieconsent.yaml and only edit that copy.
Here is the default configuration:
enabled: trueYou can customize texts, shape and color with the following available options:
# Include JavaScript and CSS files from official CDN or local
cdn: true
# Message on the banner (overwrite translation)
content_message: 'This website uses cookies to ensure you get the best experience on our website.'
# Dismiss button text (overwrite translation)
content_dismiss: 'Got it!'
# Policy link text (overwrite translation)
content_link: 'Learn more'
# Link to policy (overwrite translation)
content_href: 'https://cookiesandyou.com'
# Color of banner background
popup_background_color: '#000'
# Color of banner text
popup_text_color: '#fff'
# Color of button background
button_background_color: '#f1d600'
# Color of button text
button_text_color: '#000'
# Color of button border
button_border_color: '#f1d600'
# Position on the website, where the banner will be displayed.
# top = Top
# top-pushdown: Top (Pushdown)
# bottom: Bottom
# bottom-left: Bottom Left
# bottom-right: Bottom Right
position: bottom
# Button layout
# block: Block (angled corners)
# classic: Classic (round corners)
# edgeless: Edgeless
theme: block
# Type of Cookie Compliance, see https://cookieconsent.osano.com/documentation/compliance/
# info: Informational, just tell users that we use cookies, only dismiss button
# opt-in: Let users deny or allow cookies (Advanced, callback needed), buttons: deny, allow
compliance_type: 'info'With compliance type "info" you only inform the user that your site uses cookies. But with "opt-in" you give the user the option to accept or deny cookies respectively tracking. In this case you will need to provide a function to disable or enable cookies on your site.
This plugin supports two ways to disable tracking cookies:
- Define a function to enable or disable tracking under "callback_onStatusChange". See below and https://cookieconsent.osano.com/documentation/disabling-cookies/
- Read the consent status of this plugin in your tracking code and enable or disable tracking there accordingly. The consent status is saved in the cookie "cookieconsent_status" and may have the values "allow" or "deny".
With compliance type "opt-in" additionally a small floating revoke button is shown for the user to change his/her cookie settings.
You can customize texts and define callback functions for cookie control with the following options:
# Allow button text (overwrite translation)
content_allow: 'Allow Cookies' # only for compliance type opt-in
# Deny button text (overwrite translation)
content_deny: 'Deny Cookies' # only for compliance type opt-in
# Change/Revoke Consent button text (overwrite translation)
content_revoke: 'Change Cookie Consent' # only for compliance type opt-in
# Show/Hide floating button to change/revoke cookie consent
show_revoke: true
# Callback function to disable or enable cookies on your site. Example to only log a status change:
callback_onStatusChange: "function(status) {
console.log(this.hasConsented() ? 'enable cookies': 'disable cookies');
}"The Google Analytics Plugin https://github.com/escopecz/grav-ganalytics Version 1.5 supports both ways:
- tracking opt-in by cookie: see ganalytics readme
- tracking opt-out by JavaScript callback function
I consider to block tracking, if a consent-cookie is missing, is needed to be GDPR compliant.
Even the first page the user sees must not be tracked unless the user agrees (opt-in). Or the other way round: track a page only if the consent-cookie is set to allow tracking.
The appropriate setting in the Google Analytics Plugin Version 1.5 would be:
blockingCookie: "cookieconsent_status"
blockingCookieAllowValue: "allow"If your tracking code is not inserted into your pages until the tracking is activated then reloading the page is needed to track the actual page.
The callback function to reload the page when tracking is activated is:
callback_onStatusChange: "function(status) {
if(this.hasConsented()) location.replace(location);
}"The callback function to enable/disable tracking using the Google Analytics Plugin Version 1.5 is:
function(status) {
setGaTracking(this.hasConsented());
}See also the documentation https://cookieconsent.osano.com/documentation/about-cookie-consent/, but only a subset of these functions is available here.
Translations are defined in the languages.yaml file.
Translations will be used if no content_message, content_dismiss, content_link, content_href, content_allow, content_deny or content_revoke are defined in cookieconsent.yaml.
The plugin hooks into the grav asset manager (https://learn.getgrav.org/themes/asset-manager). Some themes haven't (properbly) integrated the assets manager and therefore do not work.
Have a look at the following required elements in the base theme. Without them the plugin will not work.
{{ assets.css() }}
{{ assets.js() }}
The MIT License (MIT)
Copyright (c) 2015 Sven Sanzenbacher
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.