..  include:: /Includes.rst.txt

..  _start:

=============================================
Cache warmup of pages located in XML sitemaps
=============================================

..  rst-class:: horizbuttons-tip-m

-   :ref:`console-commands`
-   :ref:`backend-toolbar`
-   :ref:`using-the-api`
-   :ref:`Custom crawlers <implement-a-custom-crawler>`

:Extension key:
    `warming <https://extensions.typo3.org/extension/warming>`__

:Package name:
    `eliashaeussler/typo3-warming <https://packagist.org/packages/eliashaeussler/typo3-warming>`__

:Version:
    |release|

:Language:
    en

:Author:
    `Elias Häußler <https://haeussler.dev>`__ & contributors

:License:
    This extension documentation is published under the
    `CC BY-NC-SA 4.0 <https://creativecommons.org/licenses/by-nc-sa/4.0/>`__
    (Creative Commons) license.

----

An extension for TYPO3 CMS that warms up Frontend caches based on an XML
sitemap. Cache warmup can be triggered via TYPO3 backend or using a console
command. It supports multiple languages and custom crawler implementations.

----

..  container:: row m-0 p-0

    ..  container:: col-12 col-md-6 pl-0 pr-0 pr-md-3 pt-3 m-0

        ..  container:: card px-0 h-100

            ..  rst-class:: card-header h3

                ..  rubric:: :ref:`introduction`

            ..  container:: card-body

                A quick overview about the main features provided
                by this extension.

    ..  container:: col-12 col-md-6 pl-0 pr-0 pr-md-3 pt-3 m-0

        ..  container:: card px-0 h-100

            ..  rst-class:: card-header h3

                ..  rubric:: :ref:`installation`

            ..  container:: card-body

                Instructions on how to install this extension and
                which TYPO3 and PHP versions are currently supported.

    ..  container:: col-12 col-md-6 pl-0 pr-0 pr-md-3 pt-3 m-0

        ..  container:: card px-0 h-100

            ..  rst-class:: card-header h3

                ..  rubric:: :ref:`configuration`

            ..  container:: card-body

                Learn how to configure the extension in various ways.
                This includes extension configuration, site configuration
                and TypoScript configuration.

    ..  container:: col-12 col-md-6 pl-0 pr-0 pr-md-3 pt-3 m-0

        ..  container:: card px-0 h-100

            ..  rst-class:: card-header h3

                ..  rubric:: :ref:`usage`

            ..  container:: card-body

                This section describes all possible usages of this
                extension. Learn how to use it in the Backend, as
                console command or using the PHP API.

    ..  container:: col-12 col-md-6 pl-0 pr-0 pr-md-3 pt-3 m-0

        ..  container:: card px-0 h-100

            ..  rst-class:: card-header h3

                ..  rubric:: :ref:`developer-corner`

            ..  container:: card-body

                A quick overview about all relevant classes provided
                by this extension.

    ..  container:: col-12 col-md-6 pl-0 pr-0 pr-md-3 pt-3 m-0

        ..  container:: card px-0 h-100

            ..  rst-class:: card-header h3

                ..  rubric:: :ref:`migration`

            ..  container:: card-body

                Required migration steps when upgrading the extension
                to a new major version.

..  toctree::
    :hidden:

    Introduction/Index
    Installation/Index
    Configuration/Index
    Usage/Index
    DeveloperCorner/Index
    Migration/Index
    Contributing/Index

..  toctree::
    :hidden:

    Sitemap
    genindex