====== Cache Warm Up ======

//**Note:** The settings in this section will take effect when the next cron runs (the default setting is 10 minutes). As a result, there’s no need to flush LiteMage cache.//

===== Enable Cache Warm Up ===== 

{{:litespeed_wiki:cache:litemage:configuration:screen_shot_2016-07-21_at_5.20.53_pm.png?nolink|}}

Set on a per store basis. Allow LiteMage to automatically warm up the cache. Magento cron job must be enabled. Updating the cron.sh PHP_BIN setting to "PHP_BIN=/usr/local/lsws/fcgi-bin/lsphp5" will connect it to LSWS's PHP. For more information, you can check out the magento blog entry on [[http://devdocs.magento.com/guides/m1x/install/installing_install.html#install-cron|setting up the Magento cron job]].

  * This setting currently has 4 options:
    * **Store site map:** Crawl the list of pages generated directly from the database backend.
    * **Custom defined URL list:** Crawl different custom defined lists of URLs at different intervals and priorities.
    * **Auto collected (deep crawling) URL list:** Crawl a list of pages based on visitor frequency.
    * **Delta list after tag purge:** When a tag is purged, builds and crawls a list of the pages that were purged.
  * You can select and enable any combination of these options.
  * You can enable these types of warm up at the global level and disable them for certain stores; or you can disable them at global level and only enable the stores you want to crawl.

===== LiteMage Server IP =====
Global Setting. This setting tells the crawler where the LiteMage cache server is located so it can directly hit the server instead of having to go through DNS lookup.

  * This setting is useful if LiteMage is located behind a CDN or proxy server or if it is located on LiteSpeed Load Balancer in front of the crawler node.
===== Only Run When Load Is Less Than ===== 

Global setting. Warm up will only run when current server load is less than this limit.

  * The crawler will check the average server load from the last minute using the first value of [[http://php.net/manual/en/function.sys-getloadavg.php|sys_getloadavg]].
  * If server load is currently high, the crawler will skip this run. During a crawler run, it will also dynamically check this load limit and adjust the thread count, if only 1 thread is used and server load is still above this limit, the crawler will stop.
  * Load expresses how many processes are waiting in the queue to access the computer processor. This is calculated for a certain period of time, and the smaller the number the better. This should be set based on your server’s hardware. For example, if your server has a total of 4 cores, you can set the load limit to 4.

===== Maximum Crawler Threads ===== 

Global setting. Multi-threading the crawler will help crawl big sites faster. LiteMage will use multiple threads up to this limit and dynamically adjust it based on current server load. Valid range is 1 - 10.

  * If this number is higher than 1, the crawler will use multiple threads to crawl. The thread number is dynamically adjusted during crawling based on the current server load and the configured load limit, and won’t exceed this maximum number.
  * Since the thread number changes based on server load, you can safely set this number higher. The recommended value is the total number of your cpu cores.

===== Maximum Run Time ===== 

Global setting. Limit how long (in seconds) Cache Warm Up can run. Warm up cron job is set to run every 10 minutes. Set this value lower than the cron job time interval.

  * The crawler will be invoked every 10 minutes. You can adjust this value in the LiteMage config.xml file (crontab:jobs:litemage_warmup_cache:schedule).
  * When the crawler is invoked, it will continue crawling from where it’s left off during the last run. If it finds that any warm-up configuration has updated, it will restart crawling process.
  * For each cycle, the crawler will run for the amount of time set here, this is to avoid occupying your server by crawling all the time. If your server is busy, you can set this to a smaller value. If your URL list is huge, you can set this to a larger value. Make sure this is set to a value less than 10 minutes as the crawler is relaunched every 10 minutes.
  * If your server load is higher than the load limit, the crawler will skip one cycle or will exit earlier.

===== Warm Up Interval ===== 

Set on a per store basis. Specifies how often (in seconds) you want to crawl the full list. Crawler request will always be served by backend directly. If you make the interval less than the public TTL, you can [[litespeed_wiki:cache:litemage:troubleshooting:warmup#keeping_public_cache_warm_indefinitely|keep your cache always warm]].
===== Warm Up Priority ===== 

Set on a per store basis. Sets a custom warm up sequence at the store level. This value should be larger than 0, the lower the number, the higher the priority.

  * You can also define the sequence of stores that the crawler will crawl. Put lower numbers for your more important stores.
  * This priority setting is for the whole URL list of a store. You can set a different priority for your customized URL list.

===== Crawl Non-Default Currencies ===== 

Set on a per store basis. Warm up pages for non-default currencies. Set this to “ALL” to include all available currencies, or list only the most used currencies. Space, comma separated currency codes, like “USD,GBP,EUR”.

  * If your store supports multiple currencies, you can also warm up non-default currency views. You can turn this off by leaving this setting blank.
  * You can also list only the popular currencies in the order of priority. The default currency will be crawled first, then the crawler will follow the order of your supplied list.

===== Crawl on Behalf of Logged-in Users =====
//Available since LiteMage version 1.3.6.//

Warm up pages for logged-in user representatives. Space, comma separated list of user IDs from representative groups.
For example, the user with ID 135 is from the VIP group and "Separate Cache Copy Per Customer Group" is set for the VIP group. In this case, you can list user 135 to warm the VIP user version of the site. If user 138 is in the General group and only logged-in users can write reviews and the General group is not in separate cache copy group, you can add 138, like "135, 138".

===== Crawl for Mobile Views =====
//Available since LiteMage version 1.3.6.//

Warm up pages for a different mobile theme. Only use this setting if a different template theme is used for mobile view. "Mobile Theme" must also be set under LiteMage configuration - General Settings.

===== Custom Defined URL List Files ===== 
//Available since LiteMage version 1.2.0. Replaced Custom Defined URL List, Custom List Crawl Interval (seconds), and Custom List Priority settings.//

{{:litespeed_wiki:cache:litemage:configuration:screen_shot_2016-07-15_at_3.47.04_pm.png|}}

Set on a per store basis. You can supply a list of files containing customized URL lists with varying intervals and priorities. This can be set by going to the “Current Configuration Scope” box and selecting a store. The file name should an absolute path, which can be placed in magento var/litemage/, as long as the file is readable by magento php. For example, '' /home/$USER/public_html/var/litemage/cache_brand_list''. If absolute path not defined, you should see the following error:
{{ :litespeed_wiki:cache:litemage:configuration:litemage-user-define-url-list-files-path-error.png?600 |}}


Each line should contain the absolute path to a single file, followed by the interval for that file (in seconds) and the for that file priority. The interval must be a number greater than 600. The priority is a number greater than 0, where a lower number means a higher priority. Each file listed should contain a list of custom-defined URLs (one per line). This setting can be used to create a short list of important URLs to be warmed up first or refreshed more frequently.

  * Absolute paths of the files containing the list of custom-defined URLs. These should contain 1 URL per line. These URLs are relative to the store baseURL (without ''<nowiki>http://domain/storepath</nowiki>''). You can create a short list of the most important URLs, so they can be warmed up first and refreshed more frequently.
  * The file names here are an absolute path. Make sure you set the proper permissions on these files so they are readable by Magento.
  * These files can be updated whenever you want. When the crawler is invoked on each cycle, it will check if these files have changed. If they have, it will update its internal cache and restart crawling.
  * Custom Lists are set at the store level, and will follow the same rules you defined for the store, for example, what currencies to crawl.
  * These lists only contain the relative URLs. When the crawler runs, it will add the proper base URL for that store. For example, the base URL could be something like ''<nowiki>https://www.mystore.com/en/</nowiki>'' , but your lists should only contain the rest of the URL without its base like “accessories.html”. Use only one URL per line.

===== Auto Collect List Interval =====
//Available since LiteMage version 1.2.0//

Set on a per store basis. Specify how often (in seconds) the auto collect list is crawled. 

  * The minimum value this can be set to is half the value of the public TTL. Values that are lower than that will be ignored.
===== Auto Collect List Priority =====
//Available since LiteMage version 1.2.0//

Set on a per store basis. The priority used when crawling the Auto Collect list. This value should be larger than 0, the lower the number, the higher the priority.

===== Enable Auto Collect =====
//Available since LiteMage version 1.2.0//

//**Note:** This setting enables and disables the building and maintenance of the Auto Collect List. To enable the crawling of this list, you must also select "Auto collected (deep crawling) URL list" under the **Enable Cache Warm Up** setting.//

//**Note:** If this setting is set to “No”, the following set of settings will be hidden from your Magento Admin Panel: Add to Auto Collect List, Include Robots in Auto Collect Visitor Count, Auto Collect Depth, Remove from Auto Collect List, and Auto Collect Time Frame (hours).//

Enable automatically collecting additional URLs that are not currently being crawled. 
  * Once the list is fully collected, you can disable this collecting process and just crawl the collected URLs. 
  * This will also be disabled if Auto collected (deep crawling) URL list is not selected in the Enable Cache Warm Up setting.

===== Add to Auto Collect List =====
//Available since LiteMage version 1.2.0//

//**Note:** This setting is hidden unless the Enable Auto Collect setting is set to “Yes”//

Set on a per store basis. Automatically collect additional URLs that are not currently being crawled if visited more than this number of times (excluding crawler and robots) within the amount of time defined in the Auto Collect Time Frame (hours) setting. 
  * Set to 0 to disable auto collecting. 
  * Once the list is fully collected, you can disable this and just crawl the collected URLs. 
  * This will also be disabled if Auto collected (deep crawling) URL list is not selected in the Enable Cache Warm Up setting.
  * This should be set to a higher number than the Remove from Auto Collect List setting.

===== Include Robots in Auto Collect Visitor Count =====
//Available since LiteMage version 1.2.0//

//**Note:** This setting is hidden unless the Enable Auto Collect setting is set to “Yes”//

Set on a per store basis. The value of this setting will tell LiteMage to include or exclude robots such as GoogleBots when determining which pages to add or remove from the Auto Collect List.

===== Auto Collect Depth =====
//Available since LiteMage version 1.2.0//

//**Note:** This setting is hidden unless the Enable Auto Collect setting is set to “Yes”//

Set on a per store basis. The maximum number of GET parameters a URL can contain and still be auto collected. 
  * Valid range is 0 to 10.
  * This setting can be used to adjust how many layered navigation filters can be used simultaneously with the page still being cached. If your site has layered navigation enabled and Auto Collect (deep crawling) is enabled in LiteMage, LiteMage will cache versions of this page that have less than this number of filters selected.
  * Auto Collect can also cache additional results pages even if they are retrieved with AJAX.
===== Remove from Auto Collect List =====
//Available since LiteMage version 1.2.0//

//**Note:** This setting is hidden unless the Enable Auto Collect setting is set to “Yes”//

Set on a per store basis. Remove from Auto Collect List if a URL is visited less than this number of times (excluding LiteMage crawlers) within the amount of time defined in the Auto Collect Time Frame (hours). 
  * This will actively keep the Auto Collect List from growing too large. 
  * This should be set to a lower number than the Add to Auto Collect List setting.
  * If this is set to 0 and Auto Collect is enabled, only 404 pages will be removed from the Auto Collect List.

===== Auto Collect Time Frame =====
//Available since LiteMage version 1.2.0//

//**Note:** This setting is hidden unless the Enable Auto Collect setting is set to “Yes”//

Set on a per store basis. Auto collect counter will be reset after this time frame (in hours).

===== Delta Crawl Depth =====
//Available since LiteMage version 1.2.0//

Set on a per store basis. After a tag is purged, if delta crawl is enabled, a delta URL list will be created. This sets a limit on the number of GET parameters that a URL can have and still be included in the delta list. 
  * This value must be less than auto collect depth. 
  * Valid range is 0 to 3.
  * This setting can be used to adjust how many layered navigation filters can be used simultaneously with the page still being cached. If your site has layered navigation enabled and Auto Collect (deep crawling) is enabled in LiteMage, LiteMage will cache versions of this page that have less than this number of filters selected.