Installation & Setup

Description

Speed up your customer’s experience with Brim’s Full Page Cache Warmer. Our cache warmer periodically crawls pages for your stores to prime the page cache. This process populates the full page cache, ensuring that customers get served pages as quickly as possible.

It is designed to supplement our Full Page Cache extension, however it can be used in conjunction with any full page cache.

0 people did not find this helpful

Back To Top

Installation

Download the latest version of Brim’s Full Page Cache Warmer from¬†ecommerce.brimllc.com. Log in with the user account used to purchase the extension and visit My Account > My Available Downloads.

  1. Unpack the contents of the extension in the root of your Magento installation root.
  2. Go to “System” > “Cache Management” and click “Flush Cache Storage”.
  3. Now go to “System” > “Configuration” > “Brim Extension’s tab”. If you see “Cache Warmer” under the Brim Extension’s tab, then the extension is in place.
  4. Select one of the options below to enable the crawler.

0 people did not find this helpful

Back To Top

Method 1: Magento Cron Job

In order to use the integrated Magento cron job set the “Enabled” configuration option to “Yes”.

0 people did not find this helpful

Back To Top

Method 2: Standalone Shell Script

In order to use the standalone Magento shell script set the “Enabled” configuration option to “No”. A new entry will need to be added into the crontab. Below is an example cron job, [magento root] should be replaced with your actual Magento root. Please note this script must be executed as a shell script and NOT a web request.

There are two common ways to setup the cron job. First is to run the crawler every five minutes, if there is another instance running, the most recent version will quit allowing the existing instance to finish. This ensures that your site is constantly being warmed. However if an instance dies and is unable to remove the lock file, the warmer will not warm the site until the lock file is removed.

*/5 * * * * php [magento root]/shell/cache-warmer.php

The second way is to space out each crawl instance with enough time to complete. The exact time is dependent on the set concurrency and the number of pages being crawled. The example below runs every two hours at 5 minutes past the hour. If there is an existing instance running, it will quit allowing the new instance to take over. With this method, you will never need to worry about removing a lock file, however you will want to give enough time for the instance to complete before the new instance started.

5 */2 * * * php [magento root]/shell/cache-warmer.php --force

0 people did not find this helpful

Back To Top

Configuration Settings

General Settings

Cache Warmer Configuration
Cache Warmer Configuration

Brim’s Full Page Cache Warmer has a handful of configurable settings to control how and when pages are crawled. All settings are located in “System” -> “Configuration” -> “Brim Extensions” -> “Cache Warmer”

Settings Explanation
Enabled Turn the Cache Warmer’s Magento cron job on and off. Setting to “Yes” will enable the Magento cron job, “No” will prevent it from running. When using the standalone shell script, this should be set to “No”.
Website Specify the websites to crawl. Defaults to “All Websites”.
Cron Schedule Sets the time and frequency to run the crawler via the built in Magento cron. Standard cron expressions are supported.Example: 5 */2 * * *

Runs 5 past the hour every 2 hours

Sources Specifies the sources to utilize when crawling. Allows multiple selections.
Concurrency Set the number of pages to crawl simultaneously. Setting this too high may affect your server load and site performance. It’s recommended to increase this gradually.
Flush Before Crawl Flushes the Full Page Cache if using Brim’s Full Page Cache otherwise it will flush the entire Magento cache. This is a bulk operation done before the crawling starts.
Enable Debug Mode Log urls crawled to [magento root]/var/log/brim-cache-warmer.log.

0 people did not find this helpful

Back To Top

Advanced – Crawler Locks

When the crawler is started a lock file is created in [magento root]/var/locks/brim_cachewarmer.lock. The crawler checks for the existence of a lock file before crawling any urls, if one is found the crawler will stop immediately. If the crawler unexpectedly quits the lock file will need to be manually removed before attempting to start a new instance.

0 people did not find this helpful

Back To Top

FAQ

How to do crawl a custom list of urls?

Just select “Custom Url Rewrites” from the sources field. Then put your custom list of urls (one per line) in the following location: var/cachewarmer/url.list.

0 people did not find this helpful

Back To Top

Change Log

Cache Warmer Version 2.0.0 (4/3/2014)

  • Modularized crawler sources / page types
  • Added support for sitemaps
  • Added support for custom url lists
  • Added website filter
  • Improve crawler efficiency
  • Dropped support for Magento 1.4x & 1.5x

0 people did not find this helpful

Back To Top

Cache Warmer Version 1.0.1 (10/03/2012)

  • Added option to crawl custom rewrite urls
  • Improved debugging

0 people did not find this helpful

Back To Top

Version 1.0.0 (6/11/2012)

  • Initial Version

0 people did not find this helpful

Back To Top