Configuration Reference
The following pages list all available configuration options.
Each configuration option can only be used when running cache warmup from the command line. When using the library with PHP, only a limited set of configuration options is available.
TIP
Read Configuration to get a quick overview about how to pass configuration options to the library.
Legend
The configuration reference provides various attributes for each configuration option:
| Attribute | Description |
|---|---|
| 🐝 Default | Default value of the configuration option, used if no explicit value is configured |
| 📚 Multiple values allowed | Allows multiple values for the configuration options |
| 📝 Name | Internal name of the configuration option, especially necessary for JSON and YAML configuration files |
| 🖥️ Option | Name of the command parameters used to define the configuration option |
| 🚨 Required | Requires an explicit value for the configuration option |
| 🎨 Type | Expected type of a special configuration option value in PHP notation |
Input
Lists all configuration options used to determine a list of URLs to be warmed up.
Output
Defines how to format cache warmup progress and result.
Crawling
Describes options to modify and customize the crawling behavior.
Logging & Error Handling
Describes possibilities to handle and debug errors during cache warmup. process.