Skip to content

Update from code changes: document screenshot readiness timeout env var #979

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pimmey merged 1 commit into from
Jul 13, 2026
Merged

Update from code changes: document screenshot readiness timeout env var #979

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions self-host/customize-deployment/environment-variables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,18 @@ Variables that control the scheduler worker and background cleanup jobs.

Configure the headless browser used for screenshots and PDF exports.

| Variable | Description |
| :---------------------------------------- | :----------------------------------------------------------------------------------------------- |
| `HEADLESS_BROWSER_HOST` | Hostname for the headless browser |
| `HEADLESS_BROWSER_PORT` | Port for the headless browser (default=3001) |
| `HEADLESS_BROWSER_MAX_SCREENSHOT_RETRIES` | Maximum number of times the scheduler retries a failed screenshot before giving up. (default=5) |
| `HEADLESS_BROWSER_RETRY_BASE_DELAY_MS` | Base delay in milliseconds for exponential-backoff retries on failed screenshots. (default=3000) |
| `USE_SECURE_BROWSER` | Use secure WebSocket connections for headless browser (default=false) |
| Variable | Description |
| :---------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `HEADLESS_BROWSER_HOST` | Hostname for the headless browser |
| `HEADLESS_BROWSER_PORT` | Port for the headless browser (default=3001) |
| `HEADLESS_BROWSER_MAX_SCREENSHOT_RETRIES` | Maximum number of times the scheduler retries a failed screenshot before giving up. (default=5) |
| `HEADLESS_BROWSER_RETRY_BASE_DELAY_MS` | Base delay in milliseconds for exponential-backoff retries on failed screenshots. (default=3000) |
| `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. |
| `USE_SECURE_BROWSER` | Use secure WebSocket connections for headless browser (default=false) |

<Note>
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.
</Note>

## Personal access tokens

Expand Down
Loading