..  include:: /Includes.rst.txt

..  _installation-composer:

========
Composer
========

To install this extension with Composer, you must first define the package as a composer requirement and then perform a database update.

Install the extension
=====================

In your command line interface, change to the root directory of your project (where the `composer.json` of your project is located) and enter the following command:

..  code-block:: bash

    composer require erhaweb/klaro-consent-manager

or with ddev:

..  code-block:: bash

    ddev composer require erhaweb/klaro-consent-manager

Apply database changes
======================

Follow the steps below to make all necessary database changes:

..  rst-class:: bignums

    1.  Open the TYPO3 backend.

    2.  Open the Maintenance module. See :ref:`compatibility` for the complete
        TYPO3 v13/v14 backend path overview.

        ..  list-table::
            :header-rows: 1

            *   - TYPO3 v13
                - TYPO3 v14
            *   - :guilabel:`Admin Tools` → :guilabel:`Maintenance`
                - :guilabel:`System` → :guilabel:`Maintenance`

    3.  In the card :guilabel:`Analyze Database Structure` click :guilabel:`Analyze database…`

        The following database changes are proposed:

        ..  figure:: /Images/Maintenance-AnalyzeDatabaseStructure.png
            :class: with-shadow
            :alt: Maintenance module with proposed database schema changes for the Klaro extension

    4.  Click the button :guilabel:`Apply selected changes`

..  tip::

    In Composer-based installations, you can also apply extension schema
    changes with the TYPO3 core command:

    ..  code-block:: bash

        vendor/bin/typo3 extension:setup

    or with ddev:

    ..  code-block:: bash

        ddev typo3 extension:setup

..  note::

    **Why a database update?**

    This extension uses the database and the TYPO3 :ref:`FormEngine <t3coreapi:FormEngine>` to let you create the Klaro configuration in a nice GUI in the backend.

    For this purpose, the tables `tx_klaroconsentmanager_configuration`, `tx_klaroconsentmanager_service` and `tx_klaroconsentmanager_cookie` must be created. In addition, a field must be added to the `tt_content` table in order to be able to implement the :ref:`contextual consent feature <features-contextual-consent>` at content level.

After installation and database setup, continue with :ref:`quickStart`.