.. include:: ../Includes.txt


.. _installation:


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

You can install t3oodle with or without Composer. It's recommended to use composer.


With Composer
-------------

Just perform the following command on CLI:

::

    $ composer req 'fgtclb/t3oodle':'^3.0@dev'

When composer is done, the extension is active. If the database schema has not been updated
automatically, run ``typo3 extension:setup`` and update the database schema in
:guilabel:`Admin Tools > Maintenance > Analyze Database Structure`.



Without Composer
----------------

You can also fetch t3oodle from TER and install it the old-fashioned way.


.. _installation-updating:

Updating
--------

TYPO3 compiles its dependency injection container once and caches it, by
default in :file:`typo3temp/var/cache/code/di/`. A release of t3oodle may change the
dependencies of its classes, so the container has to be rebuilt after an update.

With Composer this happens on its own: the cache identifier of the container is
derived from :file:`composer.lock`, so installing another release changes it.

Without Composer it does not. The identifier is derived from the TYPO3 version
and the modification time of :file:`typo3conf/PackageStates.php`, and replacing
the files of an extension that is already active, by upload, FTP or the
Extension Manager, changes neither. The "Flush all caches" button of the backend
toolbar removes the container only in the Development context.

.. important::
   After every update of t3oodle in a non-composer installation, flush the
   container in :guilabel:`Admin Tools > Maintenance > Flush TYPO3 and PHP Cache`.
   This also resets the PHP opcache of the web server. On the command line,
   :bash:`typo3/sysext/core/bin/typo3 cache:flush` run from the document root
   removes the container as well.

   Otherwise the frontend can fail with an error like
   ``Too few arguments to function FGTCLB\T3oodle\Service\UserService::__construct()``
   (`#47 <https://github.com/fgtclb/t3oodle/issues/47>`__), raised from a
   cached container that was compiled for the previous release.


Extension settings
------------------

t3oodle does not provide any extensions settings. Configuration is made in TypoScript setup.


Including the TypoScript
------------------------

There are two ways to include the TypoScript of t3oodle. Use **one** of them.

.. _installation-site-set:

Site Set (recommended)
~~~~~~~~~~~~~~~~~~~~~~

Add the following site set to the dependencies of your site, in :guilabel:`Sites > Edit site > Sets`
or in the :file:`config.yaml` of your site:

.. code-block:: yaml

   dependencies:
     - fgtclb/t3oodle


.. image:: Images/site-configuration-include-site-set.png
   :alt: Include site sets (from extensions) in site configuration

The optional Bootstrap styles are provided by a separate set (see :ref:`below <installation-bootstrap>`).

.. _installation-static-template:

Static template
~~~~~~~~~~~~~~~

Make sure to include the TypoScript **t3oodle Main (required)** in your template.
This way remains available for existing installations.

.. image:: Images/sys-template-include-static-file.png
   :alt: Include static (from extensions) in sys_template record

In :ref:`configuration` chapter, you see all TypoScript settings and its defaults.

.. _installation-bootstrap:

Bootstrap styles
~~~~~~~~~~~~~~~~

Because t3oodle is based on **Bootstrap CSS framework v4**, there is an optional set for this:

* Site set: **fgtclb/t3oodle-bootstrap**
* Static template: **t3oodle Custom Bootstrap Styles (optional)**

You do not need it, when you already use Bootstrap in your frontend.

.. note::
   All javascripts included in frontend are written in vanilla JS and run in parallel
   with any other framework (like Vue.js).