Sitemaps 0.1.0+

📝 Name: sitemaps · 🚨 Required · 📚 Multiple values allowed

URLs or local filenames of XML sitemaps to be warmed up.

URL

Provide the URL to an XML sitemap. Make sure to include the URL protocol, otherwise the URL cannot be resolved.

CLI

./cache-warmup.phar "https://www.example.org/sitemap.xml"

JSON

{
    "sitemaps": [
        "https://www.example.org/sitemap.xml"
    ]
}

PHP

use EliasHaeussler\CacheWarmup;

return static function (CacheWarmup\Config\CacheWarmupConfig $config) {
    $config->addSitemap(
        CacheWarmup\Sitemap\Sitemap::createFromString('https://www.example.org/sitemap.xml'),
    );

    return $config;
};

YAML

sitemaps:
  - https://www.example.org/sitemap.xml

.env

CACHE_WARMUP_SITEMAPS="https://www.example.org/sitemap.xml"

Local file

Provide the path to a local file which contains an XML sitemap. Make sure to either provide an absolute path or a path relative to the working directory.

CLI

# Absolute path
./cache-warmup.phar "/var/www/html/sitemap.xml"
# Relative path
./cache-warmup.phar "sitemap.xml"

JSON

{
    "sitemaps": [
        "/var/www/html/sitemap.xml",
        "sitemap.xml"
    ]
}

PHP

use EliasHaeussler\CacheWarmup;

return static function (CacheWarmup\Config\CacheWarmupConfig $config) {
    // Absolute path
    $config->addSitemap(
        CacheWarmup\Sitemap\Sitemap::createFromString('/var/www/html/sitemap.xml'),
    );
    // Relative path
    $config->addSitemap(
        CacheWarmup\Sitemap\Sitemap::createFromString('sitemap.xml'),
    );

    return $config;
};

YAML

sitemaps:
  # Absolute path
  - /var/www/html/sitemap.xml
  # Relative path
  - sitemap.xml

.env

# Absolute path
CACHE_WARMUP_SITEMAPS="/var/www/html/sitemap.xml"
# Relative path
CACHE_WARMUP_SITEMAPS="sitemap.xml"

Multiple sitemaps

The library also supports parsing of multiple XML sitemaps. You may then limit the number of URLs to be warmed up to avoid huge server load.

CLI

./cache-warmup.phar "https://www.example.org/sitemap.xml" "/var/www/html/sitemap.xml"

JSON

{
    "sitemaps": [
        "https://www.example.org/sitemap.xml",
        "/var/www/html/sitemap.xml"
    ]
}

PHP

use EliasHaeussler\CacheWarmup;

return static function (CacheWarmup\Config\CacheWarmupConfig $config) {
    $config->addSitemap(
        CacheWarmup\Sitemap\Sitemap::createFromString('https://www.example.org/sitemap.xml'),
    );
    $config->addSitemap(
        CacheWarmup\Sitemap\Sitemap::createFromString('/var/www/html/sitemap.xml'),
    );

    return $config;
};

YAML

sitemaps:
  - https://www.example.org/sitemap.xml
  - /var/www/html/sitemap.xml

.env

CACHE_WARMUP_SITEMAPS="https://www.example.org/sitemap.xml, /var/www/html/sitemap.xml"