.. include:: ../Includes.txt

.. _installation:

============
Installation
============

To use the CodingFreaks cookie plugin in Typo3, you must first install it in your Typo3 system.
This can be done by using Composer.


.. code-block:: bash

   composer require codingfreaks/cf-cookiemanager


Include TypoScript template
________________________

To properly use the plugin, it is necessary to include the basic TypoScript provided by the extension.
To do this, go to the :guilabel:`Web > Template` module in the Typo3 backend, select the root page, and switch to the
:guilabel:`Info/Modify` view.

From there, click on :guilabel:`Edit the whole template record`  and switch to the Includes tab.
Next, add the :guilabel:`CodingFreaks Cookie Manager (cf_cookiemanager)` template from the list on the right.



Backend Installation / Dataset Import
________________________

This extension provides an external API to automatically create cookie assignments to individual services in various languages.

To install the preconfigured data sets, go to the Typo3 backend and select the  :guilabel:`Cookie Settings` module in the Web tab.
Click on Start Configuration and follow the instructions.

.. figure:: ../Images/Installation/installation_screen.png
   :class: with-shadow
   :alt: Introduction Package
   :width: 100%

   Installation Screen

.. Tip::

    The extension automatically configures itself and creates the corresponding data set and Language overlays from site config.yaml.
    The Locals in the site config.yaml are used for the right language.


You can now Configure the Extension in the :guilabel:`Cookie Settings` module.


.. Tip::
    If the import is unsuccessful:

    Disable the extension via Composer :guilabel:`composer rem codingfreaks/cf-cookiemanager`.

    Remove Mysql-Table fia Typo3 :guilabel:`Database Analyzer`.

    Install Extension again with :guilabel:`composer require codingfreaks/cf-cookiemanager`.