We use a chrome headless browser to generate images from your charts and dashboards so we can send them via email or Slack.
Slack unfurl
or using our Scheduler
If you are running Lightdash on self-hosting, you will also have to run this headless browser on your infrastructure.
ws://HEADLESS_BROWSER_HOST:HEADLESS_BROWSER_PORT
Then using playwright
we will browse the chart/dashboard on lightdash on SITE_URL
We load the chart/dashboard on the browser and then a screenshot when it finishes loading
Then we store that image in S3 (if enabled) or locally and then return the image URL.
If the image was requested by Slack unfurl, we will unfurl the image using the Slack API. If the image was requested by Scheduler, we will send the image to the destination(s) (email or Slack)
HEADLESS_BROWSER_HOST
: If you’re running docker, this could be headless-browser
, or localhost
if you’re running it locally (or with network:host)HEADLESS_BROWSER_PORT
: Optional port for headless browser, defaults to 3001SITE_URL
: The URL for your Lightdash instance.network:host