Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/webhood-io/webhood/llms.txt

Use this file to discover all available pages before exploring further.

Scanner settings are managed from the web UI under Settings → General. Because Webhood uses PocketBase’s realtime subscriptions, the scanner picks up configuration changes immediately — no container restart is needed. Settings are stored in the database and applied to every scan the scanner instance runs.

Browser Configuration

These settings control how the headless Chromium browser presents itself to scanned websites.
ua
string
The User-Agent string the browser sends with every HTTP request during a scan. Override this to impersonate a specific browser or platform when scanning sites that gate content by user agent.Example: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36
lang
string
The Accept-Language header and browser locale sent during scans. Useful for scanning sites that serve different content based on visitor locale.Examples: en-US, zh-CN, ja-JP

Bot Detection Evasion

useStealth
boolean
Enables puppeteer-extra-plugin-stealth, which patches the headless Chromium instance to remove signals commonly used by bot-detection systems (e.g. the webdriver property, missing plugins, inconsistent permissions). Toggled via a switch in the Settings UI.
Loads the I Don’t Care About Cookies browser extension inside the scan browser session. The extension automatically dismisses GDPR cookie consent banners, producing cleaner screenshots on sites that otherwise show a full-screen prompt before any content is visible.
Enabling both Stealth Mode and Skip Cookie Prompts together is highly effective against the bot-detection and interstitial patterns commonly used by phishing pages. Stealth mode prevents the page from identifying the scanner as a headless browser, while the cookie extension clears overlays that would otherwise obscure screenshots.

Performance

simultaneousScans
string
The maximum number of scans that can run in parallel on this scanner instance. Each scan launches a separate headless browser context, so higher values increase memory and CPU usage proportionally. Set this based on the available resources of the host running the scanner container.

Cloud Integration

useCloudCaptchaSolver
boolean
Connects the scanner to Webhood Cloud (https://api.cloud.webhood.io/api/beta) to enable CAPTCHA solving and other cloud-assisted features. Enabling this requires a valid cloud API token configured in the Settings UI.
The Webhood Cloud API integration is entirely optional. The scanner operates fully offline and without any external dependencies when this option is disabled. No data is sent to Webhood Cloud unless you explicitly enable this setting and provide an API token.

Per-Scan Options

In addition to the global scanner settings above, each individual scan submission accepts ScanOptions that override behavior for that scan only.
rate
string
default:"fast"
Controls how long the scanner waits for page resources to finish loading before capturing a screenshot. The trade-off is speed versus completeness.
ValuePage load timeoutWhen to use
fast5 secondsQuick triage of many URLs (default)
balanced10 secondsGeneral-purpose scanning
slow30 secondsSites with heavy JavaScript or lazy-loaded content
screenshotSize
string | object
Controls the dimensions of the captured screenshot.
  • "full" — captures the entire scrollable page height at the default viewport width (1920 × 1080).
  • { width: string, height: string } — captures a fixed viewport. Provide pixel values as strings (e.g. { "width": "1280", "height": "720" }).
When omitted, screenshots use the default 1920 × 1080 viewport.
scannerId
string
Targets a specific scanner instance by its ID. Useful in multi-scanner deployments when you want to route particular scans to a scanner with specific network access or browser configuration. When omitted, the backend assigns the scan to any available scanner.

Build docs developers (and LLMs) love