Klaro Cookie Consent: Installation

Install and activate Klaro Cookie Consent for OXID eShop 7 via Composer, what activation creates, updating and uninstalling.

Deutsche Version

Back to overview

Live Demo: Try this and other plugins live — no installation, no risk: demo.markus-michalski.net

Requirements

Requirement	Note
OXID eShop	7.x (`oxid-esales/oxideshop-ce ^7.0`)
PHP	8.2 or higher
Access	Credentials for the private Composer repository (provided after purchasing the license)

Installation via Composer

The module is a Composer package of type oxideshop-module. It is installed to source/modules/mmd/klaro-consent.

1. Add the private repository

Add the repository to your shop's composer.json. You receive the credentials with your license, Composer asks for them during installation.

{
    "repositories": [
        {
            "type": "composer",
            "url": "https://packeton.markus-michalski.net"
        }
    ]
}

2. Install the package

composer require mmd/oxid7-klaro-consent

3. Activate the module

vendor/bin/oe-console oe:module:activate mmd_klaroconsent
vendor/bin/oe-console oe:cache:clear

Alternatively, activate the module in the admin under Extensions > Modules > Klaro Cookie Consent Manager.

What activation does

It creates the tables mmd_klaro_cookie_service and mmd_klaro_cookie_service_translation if they do not exist.
For the shop in which you activate, it creates the default service session (see Privacy). If it already exists, it stays unchanged.
Other shops (subshops) do not receive default services automatically. Create your services there yourself.

If creating the default service fails, activation does not abort and the error is not reported. After activation, check that an entry session exists under Customer Info > Cookie Consent.

After installation

In the admin under Extensions > Modules > Klaro Cookie Consent Manager, review the settings, above all the privacy policy URL.
Create your services under Customer Info > Cookie Consent.
Check whether your theme uses the template extension, see Storefront.

Update

composer update mmd/oxid7-klaro-consent
vendor/bin/oe-console oe:cache:clear

Deactivating and uninstalling

Deactivating keeps the tables and all services. The module contains no code that removes the tables on uninstall. If you want to get rid of the data, you have to drop the two tables yourself.