.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../Includes.txt


.. _configuration:

Configuration
=============

Typoscript
----------

The constants are grouped in basic and advanced settings. Use the **TYPO3 Constant Editor** in the backend to
modify the values.

.. _config-basic-const:

Datamints Matomo: Basic Constants
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. container:: table-row

   Property
         enable

   Data type
         :ref:`t3tsref:data-type-boolean`

   Description
         This has to be enabled for tracking your website with Matomo

   Default
         1

.. container:: table-row

   Property
         idsite

   Data type
         :ref:`t3tsref:data-type-integer`

   Description
         Site ID inside your Matomo installation. To find out the Site ID for your website: go to Matomo, then click on
         *Administration* link in the top menu and go to the Websites page. In this page you will find the list of all
         websites with the ID below the website name.

   Default
         1

.. container:: table-row

   Property
         host

   Data type
         :ref:`t3tsref:data-type-string`

   Description
         The host / path to your Matomo installation with protocol information (e.g. "https:" or "http:").
         If the server you installed Matomo on is able to handle
         https requests, we recommand to always us "https:" in the specified url.

   Default
         https://example.org/matomo/

.. container:: table-row

   Property
         trackBackendUsers

   Data type
         :ref:`t3tsref:data-type-boolean`

   Description
         This has to be disabled for not inserting the tracking code if you are logged in as
         Backend User, which prevents Matomo from tracking TYPO3 editors previewing
         their changes in the Frontend.

   Default
         1

.. container:: table-row

   Property
         trackIndexedSearch

   Data type
         :ref:`t3tsref:data-type-boolean`

   Description
         Enable Tracking of Indexed Search (Extbase & Fluid based). Calling the Matomo function *trackSiteSearch*
         will record the search keyword and the count of results on the search result page.

   Default
         0

.. container:: table-row

   Property
         noScriptTag

   Data type
         :ref:`t3tsref:data-type-boolean`

   Description
         This has to be enabled for inserting the Tracking Tag <noscript>, which configures Matomo to also track
         website visitors with Javascript disabled.

   Default
         0

.. container:: table-row

   Property
         debugMatomoJs

   Data type
         :ref:`t3tsref:data-type-boolean`

   Description
         By default the tracking code uses "js/" instead of "piwik.js" to serve up the minified piwik.js,
         unless the compression is disabled using config.debugMatomoJs.

   Default
         0


Datamints Matomo: Advanced Constants
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. container:: table-row

   Property
         enable

   Data type
         :ref:`t3tsref:data-type-boolean`

   Description
         This has to be enabled for sending actions in TYPO3 BE to Matomo

   Default
         1

.. container:: table-row

   Property
         apikey

   Data type
         :ref:`t3tsref:data-type-string`

   Description
         The *token_auth* password to authenticate in Matomo API requests.
         **Security Notice**: The token_auth is secret and should be handled very carefully. Configuring Matomo so that all requests are made over SSL
         to ensure the token_auth is not sent in clear. See *host*-property in :ref:`config-basic-const`.

.. container:: table-row

   Property
         rootpid

   Data type
         :ref:`t3tsref:data-type-integer`

   Description
         An integer which should be the root-page to export from.

   Default
         1