Configure the Warmup service and plugins
Once you install and activate the Warmup module, you can run the service straight away.To modify the service configuration, you need to add the WarmupConfig.config file and locate it in the ~\App_Data\Sitefinity\Configuration folder.
The file should have a structure, similar to the following:
- List of all warmup plugins
- Optional user agent configurations
User agent configurations verify the OS, vendor, and browser that requests the page. If, for example, the browser you are opening a page from is not verified via the user agent configuration, the page URL is not initialized during warmup.
IMPORTANT: To activate pages warmup for all listed user agents, you need to add a varyByUserAgent parameter in the output cache settings profile. Otherwise, pages are warmed up with the user agent, listed first in the WarmupConfig.config file. For more information about the parameter, see Advanced settings of cache profiles.
NOTE: If you modify the service or plugin configuration in the backend, modifications are not always reflected on the file system. For example, if the site is configured to be in read-only mode.
The combination of the WarmupConfig.config file and the plugin configurations gives the total number of URLs the plugin produces.
For example, the configuration of the Warmup service with the default SitemapPlugin plugin looks in the following way:
In the example above, the configuration properties on plugin level include:
- Indicates whether the plugin is enabled or not.
NOTE: You can deactivate plugins only individually.
- Defines the priority of the plugin.
- Set the number of pages per site that are requested during warmup on Sitefinity CMS startup.
NOTE: In case your Sitefinity CMS instance has 5 sites running on it, this means that this number is multiplied by 5 to get the actual number of pages, initialized during warmup.
- Set the number of pages per site that are requested after warmup as a background task.
NOTE: In case your Sitefinity CMS instance has 5 sites running on it, this means that this number is multiplied by 5 to get the actual number of pages, initialized after warmup.