Download the PHP package rafafortes/cache-warmer without Composer
On this page you can find all versions of the php package rafafortes/cache-warmer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download rafafortes/cache-warmer
More information about rafafortes/cache-warmer
Files in rafafortes/cache-warmer
Package cache-warmer
Short Description A simple Magento 2 cache warmer tool.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package cache-warmer
Cache Warmer for Magento 2
Cache Warmer is a PHP tool designed to crawl and cache all internal URLs of a Magento 2 store to improve page load speeds by preloading content into Varnish cache.
Features
- Crawls all internal URLs starting from the homepage or URLs specified in the
urlsfile. - Extracts URLs from the store's
sitemap.xml. - Handles URL normalization and parameter variations.
- Skips unwanted file types (e.g., images, PDFs).
- Skips URLs based on a blacklist file with customizable patterns.
- Displays real-time processing details such as response codes and load times.
- Shows time in milliseconds for each URL loaded.
- Prevents duplicate URL processing.
- Multi-threading: Supports parallel processing of URLs to speed up the crawling process.
- Debug mode: Outputs all links found on each accessed page.
Installation
Using Composer
To install the package via Composer, run the following command:
Alternatively, add the package manually to your composer.json:
Then, run:
Usage
Once installed, you can run the script from the command line:
File-based URL Initialization
You can specify additional URLs to be crawled by creating a urls file in the root directory. This file should list one URL per line. The first URL in the file can also serve as the baseUrl if needed.
Example urls file:
Multi-threading
You can specify the number of threads to process URLs in parallel by adding the number as the last parameter.
Example with 5 threads:
If the number of threads is not specified, the default is 1 thread.
Debug Mode
You can enable debug mode by adding the --debug parameter to the command. This mode outputs all URLs found on each accessed page.
Example:
Blacklist Configuration
You can exclude specific URLs by adding patterns to a file named blacklist located in the same directory as the script. Each line of the file should contain a pattern to be ignored.
Example blacklist file:
The script will automatically load and apply the blacklist, skipping any URLs that contain the specified patterns.
Output
The script will output information about each processed URL, including:
- Loading time (in milliseconds)
- HTTP response code
- Total number of URLs processed
- Execution time
- Number of skipped duplicate URLs
- URLs skipped due to blacklist rules (if any)
Requirements
- PHP 8.0 or higher
- Composer
Configuration
Ensure your project follows the correct directory structure for autoloading:
Contributing
Contributions are welcome! Feel free to submit a pull request or open an issue to suggest improvements.
License
This project is licensed under the MIT License.
Author
Developed by Rafa Fortes.
