Extension configuration
The extension currently provides the following configuration options:
Crawler
crawler
-
- Type
- string (FQCN)
- Default
\EliasHaeussler\ Typo3Warming\ Crawler\ Concurrent User Agent Crawler
Default crawler to be used for crawling the requested pages.
Note
Custom crawlers must implement the \EliasHaeussler\CacheWarmup\Crawler\Crawler interface.
crawlerOptions
-
- Type
- string (JSON)
JSON-encoded string of custom crawler options for the default crawler. Applies only to crawlers implementing the \EliasHaeussler\CacheWarmup\Crawler\ConfigurableCrawler interface. For more information read Configurable crawlers.
Changed in version 4.0.0
Client-related configuration was moved to clientOptions in version 4.0.0.
verboseCrawler
-
- Type
- string (FQCN)
- Default
\EliasHaeussler\ Typo3Warming\ Crawler\ Outputting User Agent Crawler
Verbose crawler to be used for cache warmup from the command-line.
Note
Custom verbose crawlers must implement the \EliasHaeussler\CacheWarmup\Crawler\VerboseCrawler interface.
verboseCrawlerOptions
-
- Type
- string (JSON)
JSON-encoded string of custom crawler options for the verbose crawler. Applies only to crawlers implementing the \EliasHaeussler\CacheWarmup\Crawler\ConfigurableCrawler interface. For more information read Configurable crawlers.
Changed in version 4.0.0
Client-related configuration was moved to clientOptions in version 4.0.0.
Parser
parserOptions
-
- Type
- string (JSON)
New in version 1.2.0
Feature: #502 - Allow configuration of XML parser client options
Changed in version 4.0.0
This configuration was renamed from
parsertoClient Options parserin version 4.0.0. Migrate existing configuration to clientOptions.Options JSON-encoded string of parser options used within the XML parser to parse XML sitemaps. For more information read Parser configuration.
Client
clientOptions
-
- Type
- string (JSON)
New in version 4.0.0
Feature: #844 - Introduce client options extension configuration
JSON-encoded string of options for the client used within the crawler and XML parser to parse and crawl 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:
{"auth":["<username>", "<password>"], "verify": false}
Options
limit
-
- Type
- integer
- Default
- 250
Allows to limit the number of crawled pages in one iteration.
Tip
Can be set to
0to 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.
See also
Read more at Crawling strategies.
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
1only. If your project implements custom doktypes, you can add them here to support cache warmup from the context menu.
Toolbar
enableToolbar
-
- Type
- boolean
- Default
- 1
Enable cache warmup in the backend toolbar. This setting affects all users, including administrators.