eliashaeussler/cache-warmup repository overview

👁 Screenshot

👁 PHAR downloads
👁 GHCR pulls
👁 Docker pulls
👁 Packagist downloads

⁠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 -O https://cache-warmup.dev/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)⁠.