Skip to content

Commit dc0a918

Browse files
docs: document HEADLESS_BROWSER_SCREENSHOT_TIMEOUT_MS env var (#979)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
1 parent 8c23af2 commit dc0a918

1 file changed

Lines changed: 12 additions & 7 deletions

File tree

self-host/customize-deployment/environment-variables.mdx

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,13 +89,18 @@ Variables that control the scheduler worker and background cleanup jobs.
8989

9090
Configure the headless browser used for screenshots and PDF exports.
9191

92-
| Variable | Description |
93-
| :---------------------------------------- | :----------------------------------------------------------------------------------------------- |
94-
| `HEADLESS_BROWSER_HOST` | Hostname for the headless browser |
95-
| `HEADLESS_BROWSER_PORT` | Port for the headless browser (default=3001) |
96-
| `HEADLESS_BROWSER_MAX_SCREENSHOT_RETRIES` | Maximum number of times the scheduler retries a failed screenshot before giving up. (default=5) |
97-
| `HEADLESS_BROWSER_RETRY_BASE_DELAY_MS` | Base delay in milliseconds for exponential-backoff retries on failed screenshots. (default=3000) |
98-
| `USE_SECURE_BROWSER` | Use secure WebSocket connections for headless browser (default=false) |
92+
| Variable | Description |
93+
| :---------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
94+
| `HEADLESS_BROWSER_HOST` | Hostname for the headless browser |
95+
| `HEADLESS_BROWSER_PORT` | Port for the headless browser (default=3001) |
96+
| `HEADLESS_BROWSER_MAX_SCREENSHOT_RETRIES` | Maximum number of times the scheduler retries a failed screenshot before giving up. (default=5) |
97+
| `HEADLESS_BROWSER_RETRY_BASE_DELAY_MS` | Base delay in milliseconds for exponential-backoff retries on failed screenshots. (default=3000) |
98+
| `HEADLESS_BROWSER_SCREENSHOT_TIMEOUT_MS` | Maximum time in milliseconds Lightdash waits for a dashboard's tiles and charts to report ready before taking a screenshot. Also applies to per-element operations during capture. (default=180000). See note below if you raise this above the browser session limit. |
99+
| `USE_SECURE_BROWSER` | Use secure WebSocket connections for headless browser (default=false) |
100+
101+
<Note>
102+
The headless-browser container has its own session timeout (for example, browserless v2's `TIMEOUT`, which defaults to 30 seconds). That value must be greater than or equal to `HEADLESS_BROWSER_SCREENSHOT_TIMEOUT_MS`, otherwise the browser will terminate the session before Lightdash's readiness wait expires and the screenshot will fail. If you raise `HEADLESS_BROWSER_SCREENSHOT_TIMEOUT_MS` for dashboards that legitimately take longer than three minutes to render, raise the browser container's session timeout to match.
103+
</Note>
99104

100105
## Personal access tokens
101106

0 commit comments

Comments
 (0)