| Browser Language | If set, sets the language used by the browser, should beISO 639 language[-country] code, e.g. `en` or `en-GB` |
|---|
| Title | Custom title for ZIM. Defaults to title of main page |
|---|
| Description | Description for ZIM |
|---|
| Long description | Optional long description for your ZIM |
|---|
| Illustration | URL for Illustration. If unspecified, will attempt to use favicon from main page. |
|---|
| ZIM filename | ZIM file name (based on --name if not provided). |
|---|
| ZIM Tags | Single string with individual tags separated by a semicolon. |
|---|
| Content Creator | Name of content creator. |
|---|
| Content Source | Source name/URL of content |
|---|
| WaitUntil | Puppeteer page.goto() condition to wait for before continuing. One of load, domcontentloaded, networkidle0 or networkidle2, or a comma-separated combination of those. Default is load,networkidle2 |
|---|
| Depth | The depth of the crawl for all seeds. Default is -1 (infinite). |
|---|
| Extra Hops | Number of extra 'hops' to follow, beyond the current scope. Default is 0 |
|---|
| Scope Type | A predfined scope of the crawl. For more customization, use 'custom' and set scopeIncludeRx/scopeExcludeRx regexes. Default is custom if scopeIncludeRx is set, prefix otherwise. |
|---|
| Scope Include Regex | Regex of page URLs that should be included in the crawl (defaults to the immediate directory of seed) |
|---|
| Scope Exclude Regex | Regex of page URLs that should be excluded from the crawl |
|---|
| Allow Hashtag URLs | Allow Hashtag URLs, useful for single-page-application crawling or when different hashtags load dynamic content |
|---|
| As device | Device to crawl as. See Pupeeter's Device.ts for a list |
|---|
| User Agent | Override user-agent with specified |
|---|
| Sitemap URL | Use as sitemap to get additional URLs for the crawl (usually at /sitemap.xml) |
|---|
| Behaviors | Which background behaviors to enable on each page. Defaults to autoplay,autofetch,siteSpecific. |
|---|
| Behavior Timeout | If >0, timeout (in seconds) for in-page behavior will run on each page. If 0, a behavior can run until finish. Default is 90. |
|---|
| Size Hard Limit | If set, exit crawler and fail the scraper immediately if WARC size exceeds this value |
|---|
| Time Hard Limit | If set, exit crawler and fail the scraper immediately if WARC(s) creation takes longer than this value, in seconds |
|---|