https://github.com/eliashaeussler/cache-warmup

🔥 PHP library to warm up caches of URLs located in XML sitemaps
https://github.com/eliashaeussler/cache-warmup

cache-warmup crawler php xml-sitemap

Last synced: 4 days ago
JSON representation

🔥 PHP library to warm up caches of URLs located in XML sitemaps

• Host: GitHub
• URL: https://github.com/eliashaeussler/cache-warmup
• Owner: eliashaeussler
• License: gpl-3.0
• Created: 2020-11-18T18:49:31.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-30T00:50:33.000Z (7 days ago)
• Last Synced: 2024-10-30T01:47:21.312Z (7 days ago)
• Topics: cache-warmup, crawler, php, xml-sitemap
• Language: PHP
• Homepage: https://cache-warmup.dev/
• Size: 3.9 MB
• Stars: 53
• Watchers: 4
• Forks: 10
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        


[![Header with logo](docs/img/header.png)](https://cache-warmup.dev/)

[![PHAR downloads](https://img.shields.io/github/downloads/eliashaeussler/cache-warmup/total?label=PHAR+downloads&logo=github&logoColor=white)](https://github.com/eliashaeussler/cache-warmup/releases)

[![GHCR pulls](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fipitio.github.io%2Fbackage%2Feliashaeussler%2Fcache-warmup%2Fcache-warmup.json&query=%24.downloads&logo=github&label=GHCR%20pulls)](https://github.com/eliashaeussler/cache-warmup/pkgs/container/cache-warmup)

[![Docker pulls](https://img.shields.io/docker/pulls/eliashaeussler/cache-warmup?label=Docker+pulls&logo=docker&logoColor=white)](https://hub.docker.com/r/eliashaeussler/cache-warmup)

[![Packagist downloads](https://img.shields.io/packagist/dt/eliashaeussler/cache-warmup?label=Packagist+downloads&logo=packagist&logoColor=white)](https://packagist.org/packages/eliashaeussler/cache-warmup)

# Sitemap Crawler & Cache Warmer

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

[**Explore the docs »**](https://cache-warmup.dev/)

[Report Bug](https://github.com/eliashaeussler/cache-warmup/issues/new?template=bug_report.yml&title=%5BBUG%5D) ·

[Request Feature](https://github.com/eliashaeussler/cache-warmup/issues/new?template=feature_request.yml&title=%5BFEATURE%5D) ·

[Join Discussions](https://github.com/eliashaeussler/cache-warmup/discussions) ·

[Latest Release](https://github.com/eliashaeussler/cache-warmup/releases/latest) ·

[Sponsor](https://cache-warmup.dev/sponsor.html)



## ✨ 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

```bash

# 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](https://cache-warmup.dev/installation.html)

in the official documentation.

## 📕 Documentation

Find all available installation methods, configuration options and customization

opportunities in the [official documentation](https://cache-warmup.dev/).

## 🧑‍💻 Contributing

Please have a look at [`CONTRIBUTING.md`](CONTRIBUTING.md).

## ⭐ License

This project is licensed under [GNU General Public License 3.0 (or later)](LICENSE.md).