Skip to main content
This is a reference to all environment variables that can be used to configure a Lightdash deployment. Lightdash also accepts all standard postgres environment variables

SMTP

This is a reference to all the SMTP environment variables that can be used to configure a Lightdash email client. [1] EMAIL_SMTP_PASSWORD or EMAIL_SMTP_ACCESS_TOKEN needs to be provided

SSO

These variables enable you to control Single Sign On (SSO) functionality.

S3

These variables allow you to configure S3 Object Storage.

Cache

Note that you will need an Enterprise License Key for this functionality.
These variables are deprecated; use the RESULTS_S3_* versions instead.

Logging

Prometheus

Security

Analytics & Event Tracking

AI Analyst

These variables enable you to configure the AI Analyst functionality. Note that you will need an Enterprise Licence Key for this functionality. The AI Analyst supports multiple providers for flexibility. Choose one of the provider configurations below based on your preferred AI service. OpenAI integration is the recommended option as it is the most tested and stable implementation.

OpenAI Configuration

Anthropic Configuration

Azure AI Configuration

OpenRouter Configuration

Slack Integration

These variables enable you to configure the Slack integration.

GitHub Integration

These variables enable you to configure Github integrations

Microsoft Teams Integration

These variables enable you to configure Microsoft Teams integration.

Google Cloud Platform

These variables enable you to configure Google Cloud Platform integration.

Embedding

Note that you will need an Enterprise Licence Key for this functionality.

Service account

Note that you will need an Enterprise Licence Key for this functionality.

SCIM

Note that you will need an Enterprise Licence Key for this functionality.

Sentry

These variables enable you to configure Sentry for error tracking.

Intercom & Pylon

These variables enable you to configure Intercom and Pylon for customer support and feedback.

Kubernetes

These variables enable you to configure Kubernetes integration.

Organization appearance

These variables allow you to customize the default appearance settings for your Lightdash instance’s organizations. This color palette will be set for all organizations in your instance. You can’t choose another one while these env vars are set.

Initialize instance

When a new Lightdash instance is created, and there are no orgs and projects. You can initialize a new org and project using ENV variables to simplify the deployment process.
Initialize instance is only available on Lightdash Enterprise plans.For more information on our plans, visit our pricing page.
Currently we only support Databricks project types and Github dbt configuration.
In order to login as the admin user using SSO, you must enable the following ENV variable too:
This will alow you to link your SSO account with the email provided without using an invitation code.
This email will be trusted, and any user with an OIDC account with that email will access the admin user.

Update instance

On server start, we will check the following variables, and update some configuration of the organization or project. Having more than one org or project can throw runtime errors and prevent the server from starting.
Initialize instance is only available on Lightdash Enterprise plans.For more information on our plans, visit our pricing page.