Cache Warmup config (SchemaStore) JSON Schema

Type	object
File match	`cache-warmup.json` `cache-warmup.yaml` `cache-warmup.yml`
Schema URL	https://catalog.lintel.tools/schemas/schemastore/cache-warmup-config/latest.json
Source	https://raw.githubusercontent.com/eliashaeussler/cache-warmup/main/res/cache-warmup-config.schema.json

Validate with Lintel

npx @lintel/lintel check

Type: object

$schema string

sitemaps string[]

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

urls string[]

Additional URLs to be warmed up.

excludePatterns string[]

Patterns of URLs to be excluded from cache warmup.

limit integer

Limit the number of URLs to be processed.

min=0

progress boolean

Show a progress bar during cache warmup.

crawler string

FQCN of the crawler to use for cache warmup.

crawlerOptions object

Additional options for configurable crawlers.

strategy string

Optional crawling strategy to prepare URLs before crawling them.

Values: "sort-by-changefreq" "sort-by-lastmod" "sort-by-priority"

format string

The formatter used to print the cache warmup result.

Values: "json" "text"

logFile string

A file where to log crawling results.

logLevel string

The log level used to determine which crawling results to log.

Values: "emergency" "alert" "critical" "error" "warning" "notice" "info" "debug"

allowFailures boolean

Allow failures during URL crawling and exit with zero.

stopOnFailure boolean

Cancel further cache warmup requests on failure.

repeatAfter integer

Run cache warmup in endless loop and repeat x seconds after each run.

min=0