Console commands

The extension provides the following console commands:

`warming:cachewarmup`

A command to trigger cache warmup of single pages and/or whole sites using their XML sitemaps.

Important

You must pass at least the --pages or --sites command option.

Tip

If you use warming:cachewarmup in your deployment process and the sitemap is protected with HTTP authentication (basic auth) or the website does not have a valid SSL certificate, you can configure this in the extension configuration with verboseCrawlerOptions and parserClientOptions.

vendor/bin/typo3 warming:cachewarmup

typo3/sysext/core/bin/typo3 warming:cachewarmup

The following command options are available:

-p|--pages

Type: integer
Required: false
Default: none
Multiple allowed: true

Use this option to provide IDs of pages whose Frontend caches should be warmed up. You can pass this option multiple times, either as single integer values or as a comma-separated list of integer values.

Example:

vendor/bin/typo3 warming:cachewarmup -p 1 -p 2 -p 3
vendor/bin/typo3 warming:cachewarmup -p 1,2,3

typo3/sysext/core/bin/typo3 warming:cachewarmup -p 1 -p 2 -p 3
typo3/sysext/core/bin/typo3 warming:cachewarmup -p 1,2,3

-s|--sites

Type: integer or string (site identifier or all)
Required: false
Default: none
Multiple allowed: true

Use this option to provide a list of sites to be warmed up. You can either pass the appropriate site identifiers or the site's root page IDs.

New in version 3.1.0

Feature: #720 - Allow warming up all available sites at once

You can also pass the special keyword all to warm up all available sites at once.

Example:

vendor/bin/typo3 warming:cachewarmup -s my-cool-site
vendor/bin/typo3 warming:cachewarmup -s 1
vendor/bin/typo3 warming:cachewarmup -s all

typo3/sysext/core/bin/typo3 warming:cachewarmup -s my-cool-site
typo3/sysext/core/bin/typo3 warming:cachewarmup -s 1
typo3/sysext/core/bin/typo3 warming:cachewarmup -s all

-l|--languages

Type: integer
Required: false
Default: -1 (all languages)
Multiple allowed: true

You can optionally limit the languages of sites to be warmed up to a given list of language IDs. If this option is omitted, all site languages will be included in the cache warmup.

Example:

vendor/bin/typo3 warming:cachewarmup -l 0 -l 1
vendor/bin/typo3 warming:cachewarmup -l 0,1

typo3/sysext/core/bin/typo3 warming:cachewarmup -l 0 -l 1
typo3/sysext/core/bin/typo3 warming:cachewarmup -l 0,1

-c|--config

Type: string
Required: false
Default: none
Multiple allowed: false

An external configuration file can be used to provide a more fine-grained configuration for cache warmup. The file path may contain references to extensions (see example below).

Note

Config file options will be merged with command options, whereas command options receive higher priority. It's even possible to use environment variables for configuration. Read more in the official documentation.

At the moment, the following file formats are supported:

JSON
PHP
YAML

Example:

vendor/bin/typo3 warming:cachewarmup --config cache-warmup.yaml
vendor/bin/typo3 warming:cachewarmup --config EXT:sitepackage/Configuration/cache-warmup.yaml

typo3/sysext/core/bin/typo3 warming:cachewarmup --config cache-warmup.yaml
typo3/sysext/core/bin/typo3 warming:cachewarmup --config EXT:sitepackage/Configuration/cache-warmup.yaml

--limit

Type: integer
Required: false
Default: limit value from extension configuration
Multiple allowed: false

Maximum number of pages to be crawled. Set to 0 to disable the limit. If this option is omitted, the limit value from extension configuration is used.

Example:

vendor/bin/typo3 warming:cachewarmup --limit 100

typo3/sysext/core/bin/typo3 warming:cachewarmup --limit 100

--strategy

Type: string
Required: false
Default: strategy value from extension configuration
Multiple allowed: false

Name of an available crawling strategy to use for cache warmup. If this option is omitted, the strategy value from extension configuration is used.

Example:

vendor/bin/typo3 warming:cachewarmup --strategy sort-by-priority

typo3/sysext/core/bin/typo3 warming:cachewarmup --strategy sort-by-priority

-x|--strict

Type: boolean
Required: false
Default: false
Multiple allowed: false

Exit with a non-zero status code in case cache warmup fails or errors occur during cache warmup.

Example:

vendor/bin/typo3 warming:cachewarmup --strict

typo3/sysext/core/bin/typo3 warming:cachewarmup --strict

`warming:showuseragent`

A command that shows the custom User-Agent header that is used for cache warmup requests by default crawlers.

Note

This command is not schedulable.

vendor/bin/typo3 warming:showuseragent

typo3/sysext/core/bin/typo3 warming:showuseragent