bytebencher/cache-warmup

Composer package to warm up website caches, based on a given XML sitemap

1.0.0 2024-05-30 09:32 UTC

Requires

• php: ~8.1.0 || ~8.2.0 || ~8.3.0
• composer-runtime-api: ^2.1
• ext-filter: *
• ext-json: *
• ext-mbstring: *
• ext-zlib: *
• cuyz/valinor: ^1.3
• guzzlehttp/guzzle: ^7.0
• guzzlehttp/promises: ^1.0 || ^2.0
• guzzlehttp/psr7: ^2.0
• mtownsend/xml-to-array: ^2.0
• psr/http-message: ^1.0 || ^2.0
• symfony/console: ^5.4 || ^6.0 || ^7.0
• symfony/filesystem: ^5.4 || ^6.0 || ^7.0
• symfony/options-resolver: ^5.4 || ^6.0 || ^7.0
• symfony/yaml: ^5.4 || ^6.0 || ^7.0

Requires (Dev)

• armin/editorconfig-cli: ^1.8 || ^2.0
• eliashaeussler/php-cs-fixer-config: ^2.0
• eliashaeussler/phpstan-config: ^2.0
• eliashaeussler/rector-config: ^3.0
• eliashaeussler/transient-logger: ^1.0
• ergebnis/composer-normalize: ^2.28
• phpstan/extension-installer: ^1.2
• phpstan/phpstan-phpunit: ^1.1
• phpstan/phpstan-symfony: ^1.2.11
• phpunit/phpunit: ^10.1 || ^11.0

GPL-3.0-or-later

• Elias Häußler
• ByteBencher eCommerce

README

Sitemap Crawler & Cache Warmer

A PHP library to warm up website caches of URLs located in XML sitemaps.

Explore the docs »

Report Bug · Request Feature · Join Discussions · Latest Release · Sponsor

✨ Features

• Warm up caches of URLs located in XML sitemaps
• Console command and PHP API for cache warmup
• Out-of-the-box support for sitemap indexes
• Exclusion patterns for sitemaps and URLs
• Various crawling strategies to modify crawling behavior
• Support for gzipped XML sitemaps
• Interface for custom crawler implementations

🚀 Getting Started

# Download latest release
curl -LO https://github.com/eliashaeussler/cache-warmup/releases/latest/download/cache-warmup.phar
chmod +x cache-warmup.phar

# Run cache warmup
./cache-warmup.phar "https://www.example.com/sitemap.xml"

Find more installation methods in the official documentation.

📕 Documentation

Find all available installation methods, configuration options and customization opportunities in the official documentation.

🧑‍💻 Contributing

Please have a look at CONTRIBUTING.md.

⭐ License

This project is licensed under GNU General Public License 3.0 (or later).