# Magento 2 Full Page Cache Warmer

### <span style="color: blue;">Installation and User Guide for Magento 2 Full Page Cache Warmer Extension</span>

****Table Of Contents****

1. [**Installation**](#bkmrk-installation)
    - **Installation via app/code**
    - **Installation via Composer**
2. [**Configuration Settings for Optimiser Base**](#bkmrk-configuration-settin)
    - **General Settings**
3. [**Configuration Settings for Full Page Cache Warmer**](#bkmrk-configuration-settin-1)
    - **General Settings**
    - **Cron Settings**
4. [**Cache Warmer Grid**](#bkmrk-cache-warmer-grid)
    - **Regenerate**
5. [**Console Commands**](#bkmrk-console-commands)
    - **Category Page**
    - **Product Page**
    - **CMS Page**
6. [**Front-end Site View**](#bkmrk-front-end-site-view)
    - **Cache Hit for the Category Page After the Execution of Category Page Command**
    - **Cache Miss for the Category Page**

### <span style="color: blue;">Installation</span>

- ****Installation via app/code:****<span style="white-space: pre-wrap;"> Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.</span>

```
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy

```

- ****Installation via Composer:****<span style="white-space: pre-wrap;"> Please follow the guide provided in the below link to complete the installation via composer.</span>

<p class="callout success"><span style="white-space: pre-wrap;">[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)</span></p>

### <span style="color: blue;">Configuration Settings for Optimiser Base</span>

<span style="white-space: pre-wrap;">Go to </span>****Admin &gt; Stores &gt; Configuration &gt; Scommerce Configuration &gt; Optimiser Base****

#### <span style="color: orange;">General Settings</span>

- ****Enabled –****<span style="white-space: pre-wrap;"> Select “Yes” or “No” to enable or disable the module.</span>
- ****License Key –****<span style="white-space: pre-wrap;"> Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at </span><support@scommerce-mage.com>.

[![general_fullpage.png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/scaled-1680-/general-fullpage.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/general-fullpage.png)

### <span style="color: blue;">Configuration Settings for Full Page Cache Warmer</span>

<span style="white-space: pre-wrap;">Go to </span>****Admin &gt; Stores &gt; Configuration &gt; Scommerce Configuration &gt; Cache Warmer****

#### <span style="color: orange;">General Settings</span>

- ****Enabled -****<span style="white-space: pre-wrap;"> Select “Yes” or “No” to enable or disable the module.</span>
- ****Regenerate cache after page update -****<span style="white-space: pre-wrap;"> Please select "Yes" or "No" to regenerate cache for updated page.</span>
- ****Select Pages -****<span style="white-space: pre-wrap;"> Please select the page(s) from the multi-select option . This will regenerate the cache selected page(s) on page update.</span>
- ****Can Regenerate Cache Manually -****<span style="white-space: pre-wrap;"> Please select " Yes" or "No". If set to "Yes" then you can regenerate cache manually from cache warmer grid.</span>
- ****Generate Log -****<span style="white-space: pre-wrap;"> Select "Yes" to generate the log.</span>

<span style="white-space: pre-wrap;">[![image (89) (1).png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/scaled-1680-/image-89-1.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-89-1.png)</span>

- ****Generation order -****<span style="white-space: pre-wrap;"> Select which page will be generated first by adding the generation order alognside the page type. 1 is the highest priority.</span>
- ****Allow bestsellers products to be cached first -****<span style="white-space: pre-wrap;"> Select "Yes" to give best seller products the highest priority in cache generation.</span>
- ****Bestseller Frequency -****<span style="white-space: pre-wrap;"> Choose the range of bestleer products monthly/yearly. Based on your selection these products will be cached.</span>
- ****Website priority -****<span style="white-space: pre-wrap;"> In multi website structures change the website in order to prioritize which will be cached first. 1 is highest priority.</span>

<span style="white-space: pre-wrap;">[![image (82) (2).png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/scaled-1680-/image-82-2.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-82-2.png)</span>

#### <span style="color: orange;">Cron Settings</span>

- ****Cache Cron Schedule -****<span style="white-space: pre-wrap;"> Schedule cron job to regenerate the cache for all non cached page(s).</span>
- ****Number of Concurrent Regeneration request -****<span style="white-space: pre-wrap;"> Please define the number of concurrent request.</span>

<span style="white-space: pre-wrap;">[![image (7) (1) (1) (1) (1) (1).png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/scaled-1680-/image-7-1-1-1-1-1.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-7-1-1-1-1-1.png)</span>

### <span style="color: blue;">Cache Warmer Grid</span>

<span style="white-space: pre-wrap;">When you enable the module and set </span>****General Settings &gt; Can Regenerate Cache Manually &gt;****<span style="white-space: pre-wrap;"> to </span>****"Yes"****<span style="white-space: pre-wrap;"> then it adds an additional option "Regenerate" under the "</span>****Actions &gt; Select****<span style="white-space: pre-wrap;">" drop-down at </span>****Admin &gt; System &gt; Cache Warmer &gt; Actions.****<span style="white-space: pre-wrap;"> This grid will have Id, Reference Id, Processed Time, Request Path, Page URL, Last Cache - (Date, Time ), Status - (Cached/Un-cached), Page Type - (Home, Product, Category, CMS), Store View, and Action- (Regenerate, Delete).</span>

<span style="white-space: pre-wrap;">[![image (79) (2).png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/scaled-1680-/image-79-2.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-79-2.png)</span>

- ****Regenerate -****<span style="white-space: pre-wrap;"> It regenerates cache manually for Category/Product/CMS page(s). By clicking "Regenerate" action you can regenerate cache manually for a specific URL.</span>

<span style="white-space: pre-wrap;">[![4324324.png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/scaled-1680-/4324324.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/4324324.png)</span>

### <span style="color: blue;">Console Commands</span>

You can regenerate cache for Product/Category/CMS page(s) by running the following console commands:-

- ****Category Page -****<span style="white-space: pre-wrap;"> To regenerate cache for the category page, execute the below command.</span>

**`scommerce:cachewarmer:category`**

[![image.png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/scaled-1680-/image.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image.png)

- ****Product Page -****<span style="white-space: pre-wrap;"> To regenerate cache for the product page(s), execute the below command.</span>

**`scommerce:cachewarmer:product`**

[![image.png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/scaled-1680-/z8gimage.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/z8gimage.png)

- ****CMS Page -****<span style="white-space: pre-wrap;"> To regenerate cache for CMS page, run the below command.</span>

**`scommerce:cachewarmer:cmspage`**

[![image.png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/scaled-1680-/Aa3image.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/Aa3image.png)

### <span style="color: blue;">Front-end Site View</span>

- ****Cache Hit for the Category Page After the Execution of Category Page Command -****<span style="white-space: pre-wrap;"> When you execute the command for category page then it regenerates the cache and on the front-end you check the status "Hit" or "Miss" using browser tool (Inspect element) at </span>****Network &gt; Select Page URL &gt; Header &gt; X- Magento-Cache-Debug : HIT****

[![image.png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/scaled-1680-/rj9image.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/rj9image.png)

- ****Cache Miss for the Category Page -****<span style="white-space: pre-wrap;"> Flush the cache by executing the command, </span>****c:f****<span style="white-space: pre-wrap;"> and then check cache using browser tool at, </span>****Network &gt; Select Page URL &gt; Header &gt; X-Magento-Cache-Debug : MISS****

[![image.png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/scaled-1680-/457image.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/457image.png)

<span style="white-space: pre-wrap;">If you have a question related to this extension please check out our </span>[****FAQ Section****](https://www.scommerce-mage.com/magento-2-full-page-cache-warmer.html#customfaq)<span style="white-space: pre-wrap;"> first. If you can't find the answer you are looking for then please contact </span>[****support@scommerce-mage.com****](mailto:core@scommerce-mage.com)****.****