The Cookies Policy Grav CMS plugin is built on top of Google CookiesChoice script and allows to display a banner or a dialog on page, to show the European Community Cookies Law Policy disclaimer.

Installation

Installing the Cookies Policy 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.

GPM Installation (Preferred)

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 cookiespolicy

This will install the Cookies Policy plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/cookiespolicy.

Manual Installation

To install this plugin, just download the zip version and unzip it under /your/site/grav/user/plugins. Then, rename the folder to cookiespolicy. You can find these files either on GitHub or via GetGrav.org.

You should now have all the plugin files under

/your/site/grav/user/plugins/cookiespolicy

Updating

As development for the Cookies Policy plugin continues, new versions may become available that add additional features and functionality, improve compatibility with newer Grav releases, and generally provide a better user experience. Updating Cookies Policy is easy, and can be done through Grav's GPM system, as well as manually.

GPM Update (Preferred)

The simplest way to update this plugin is via the Grav Package Manager (GPM). You can do this with this by navigating to the root directory of your Grav install using your system's Terminal (also called command line) and typing the following:

bin/gpm update cookiespolicy

This command will check your Grav install to see if your Cookies Policy plugin is due for an update. If a newer release is found, you will be asked whether or not you wish to update. To continue, type y and hit enter. The plugin will automatically update and clear Grav's cache.

Manual Update

Manually updating Cookies Policy is pretty simple. Here is what you will need to do to get this done:

  • Delete the your/site/user/plugins/cookiespolicy directory.
  • Downalod the new version of the Cookies Policy plugin from either GitHub or GetGrav.org.
  • Unzip the zip file in your/site/user/plugins and rename the resulting folder to cookiespolicy.
  • Clear the Grav cache. The simplest way to do this is by going to the root Grav directory in terminal and typing bin/grav clear-cache.

Note: Any changes you have made to any of the files listed under this directory will also be removed and replaced by the new set. Any files located elsewhere (for example a YAML settings file placed in user/config/plugins) will remain intact.

Usage

The cookiespolicy plugin comes with a template called cookiespolicy.html.twig, which is rendered when the plugin is initialized and it is assigned to the cookiespolicy_markup variable.

To have the script available in your page, just call that variable in your template as follows:

{{ cookiespolicy_markup }}

The best position to include the script is just before the body close tag.

If you are using a theme provided by the Grav community for your web site, be sure to inherit it, as well explaind in this Grav blog post, before adding this chunk of code to the theme itself.

In addition, you need to add a new page which will contain the full policy disclaimer. Next, you must configure the plugin to point that route.

Customization

To customize the plugin, you can copy the cookiespolicy.yaml file under the user/config/plugins folder. If that folder does not exist, you must create it by hand.