Extension configuration¶

The extension currently provides the following configuration options:

Crawler¶

crawler¶

Type: string (FQCN)
Default: EliasHaeussler\Typo3Warming\Crawler\ConcurrentUserAgentCrawler

Default crawler to be used for crawling the requested pages.

Note

Custom crawlers must implement EliasHaeussler\CacheWarmup\Crawler\CrawlerInterface.

crawlerOptions¶

Type: string (JSON)

JSON-encoded string of custom crawler options for the default crawler. Applies only to crawlers implementing the EliasHaeussler\CacheWarmup\Crawler\ConfigurableCrawlerInterface. For more information read Configurable crawlers.

Tip

If the XML sitemap is protected by HTTP authentication (basic auth), you can set the credentials as follows: {"client_config":{"auth":["<username>","<password>"]}}

In case the XML sitemap does not have a valid SSL certificate, it is possible to disable the SSL verification: {"client_config":{"verify":false}}

You can also combine both settings: {"client_config":{"verify":false,"auth":["<username>","<password>"]}}

verboseCrawler¶

Type: string (FQCN)
Default: EliasHaeussler\Typo3Warming\Crawler\OutputtingUserAgentCrawler

Verbose crawler to be used for cache warmup from the command-line.

Note

Custom verbose crawlers must implement EliasHaeussler\CacheWarmup\Crawler\VerboseCrawlerInterface.

verboseCrawlerOptions¶

Type: string (JSON)

JSON-encoded string of custom crawler options for the verbose crawler. Applies only to crawlers implementing the EliasHaeussler\CacheWarmup\Crawler\ConfigurableCrawlerInterface. For more information read Configurable crawlers.

Tip

If the XML sitemap is protected by HTTP authentication (basic auth), you can set the credentials as follows: {"client_config":{"auth":["<username>","<password>"]}}

In case the XML sitemap does not have a valid SSL certificate, it is possible to disable the SSL verification: {"client_config":{"verify":false}}

You can also combine both settings: {"client_config":{"verify":false,"auth":["<username>","<password>"]}}

parserClientOptions¶

Type: string (JSON)

New in version 1.2.0: Feature: #502 - Allow configuration of XML parser client options

JSON-encoded string of options for the client used within the XML parser to parse XML sitemaps. All available Guzzle client options are accepted and merged with TYPO3's global client configuration stored in $GLOBALS['TYPO3_CONF_VARS']['HTTP'].

Tip

If the XML sitemap is protected by HTTP authentication (basic auth), you can set the credentials as follows: {"auth":["<username>","<password>"]}

In case the XML sitemap does not have a valid SSL certificate, it is possible to disable the SSL verification: {"verify":false}

You can also combine both settings: {"verify":false,"auth":["<username>","<password>"]}

Options¶

limit¶

Type: integer
Default: 250

Allows to limit the number of crawled pages in one iteration.

Tip

Can be set to 0 to crawl all available pages in XML sitemaps.

exclude¶

Type: string (comma-separated list)

Comma-separated list of exclude patterns to exclude URLs from cache warmup. The following formats are currently supported:

Regular expressions with delimiter #, e.g. #(no_cache|no_warming)=1#
Any pattern processable by the native PHP function fnmatch, e.g. *no_cache=1*

strategy¶

Type: string

Name of an available crawling strategy to use for cache warmup. Crawling strategies are used to prepare URLs before actually crawling them. This can be helpful to prioritize crawling of important URLs.

Page tree¶

enablePageTree¶

Type: boolean
Default: 1

Enable cache warmup in the page tree context menu. This setting affects all users, including administrators.

supportedDoktypes¶

Type: string (comma-separated list)
Default: 1

Comma-separated list of doktypes to be supported for cache warmup in the page tree context menu. Defaults to default pages with doktype 1 only. If your project implements custom doktypes, you can add them here to support cache warmup from the context menu.

Extension configuration¶

Crawler¶

Options¶

Page tree¶

Toolbar¶