# Lightdash ## Docs - [Welcome to Lightdash](https://docs.lightdash.com/introduction.md): Enterprise-ready agentic analytics that turns questions into insights, dashboards, and data apps ## Get started - [Getting started](https://docs.lightdash.com/get-started.md): Set up your first Lightdash project and learn the fundamentals ## Quickstart - [Quickstart](https://docs.lightdash.com/get-started/quickstart.md): The golden path from an empty project to your first insight in Lightdash - [Prepare your dbt project](https://docs.lightdash.com/get-started/quickstart/prepare-your-dbt-project.md): Install the Lightdash CLI, generate your first Tables from your dbt models, and create your project - [Connect your warehouse and dbt project](https://docs.lightdash.com/get-started/quickstart/connect-project.md): Connection settings for every supported warehouse, plus every way to import a dbt project - [Connect through an SSH tunnel](https://docs.lightdash.com/get-started/quickstart/connect-through-ssh-tunnel.md): Reach a Postgres or Redshift database in a private VPC by tunnelling through a bastion host - [Invite your team](https://docs.lightdash.com/get-started/quickstart/invite-new-users.md): Invite people to your Lightdash project so you can share content with them ## Get started - [Agentic onboarding with Aurora](https://docs.lightdash.com/get-started/agentic-onboarding.md): Sign up, connect a warehouse, and chat with Aurora before any dbt models exist - [Explore your data](https://docs.lightdash.com/get-started/explore-your-data.md): Query Tables, build charts and dashboards, and share insights with your team - [Build your semantic layer](https://docs.lightdash.com/get-started/build-your-semantic-layer.md): Install the CLI, add Tables, and define the metrics and dimensions your whole team explores - [Migrating from another BI tool](https://docs.lightdash.com/get-started/migrate-from-another-bi-tool.md): Move reports, dashboards, and modeling logic out of an existing BI tool into Lightdash - [The Lightdash Way](https://docs.lightdash.com/get-started/lightdash-way.md): Giving everybody in your company the building blocks to answer their own questions ## Explore - [Explore your data](https://docs.lightdash.com/explore.md): Query, visualize, and share your data in Lightdash ## Chart types - [Chart types overview](https://docs.lightdash.com/explore/chart-types.md): Every visualization type available in Lightdash and when to reach for each one - [Bar chart](https://docs.lightdash.com/explore/chart-types/bar-chart.md): Use bar charts to compare things between different groups or track how a number changes over time - [Line chart](https://docs.lightdash.com/explore/chart-types/line-chart.md): Use line charts to show continuous changes in a number over time - [Area chart](https://docs.lightdash.com/explore/chart-types/area-chart.md): Use area charts to show how values develop over time when the total is as important as its parts - [Mixed chart](https://docs.lightdash.com/explore/chart-types/mixed-chart.md): Use mixed charts to combine bars, lines, and scatter charts on the same visualization - [Scatter chart](https://docs.lightdash.com/explore/chart-types/scatter-chart.md): Use scatter charts to look at the relationship or correlation between two variables - [Pie chart](https://docs.lightdash.com/explore/chart-types/pie-chart.md): Use pie charts to visualize data that adds up to a meaningful whole - [Funnel chart](https://docs.lightdash.com/explore/chart-types/funnel-chart.md): Show how values fall away across the discrete stages of a process - [Treemap chart](https://docs.lightdash.com/explore/chart-types/treemap-chart.md): Use treemap charts to show parts of a whole using nested rectangles - [Sankey chart](https://docs.lightdash.com/explore/chart-types/sankey.md): Visualize flows between categories, from sources through to targets - [Table](https://docs.lightdash.com/explore/chart-types/table.md): Use tables for looking at tabular data or lists of things like user IDs or transactions - [Big value](https://docs.lightdash.com/explore/chart-types/big-value.md): Use big value charts to display a single value prominently - [Gauge](https://docs.lightdash.com/explore/chart-types/gauge.md): Highlight a single value against a qualitative range, like performance against a target - [Map](https://docs.lightdash.com/explore/chart-types/map.md): Use maps to display geographic data on an interactive map - [Custom Vega charts](https://docs.lightdash.com/explore/chart-types/custom-vega-charts.md): One-off charts written as a Vega-Lite spec in a JSON editor, plus worked templates you can copy - [Custom project charts](https://docs.lightdash.com/explore/chart-types/custom-project-charts.md): Reusable chart types you build once for your project, then use like any built-in chart type ## Build charts - [Configure your charts](https://docs.lightdash.com/explore/configure-charts.md): Layout, series, axes, display, and data options shared by most chart types - [Custom tooltips](https://docs.lightdash.com/explore/configure-custom-tooltip.md): Show extra metrics, notes, links, and custom HTML in chart tooltips using field variables - [Using custom fields](https://docs.lightdash.com/explore/create-custom-fields.md): Create custom dimensions and metrics on the fly for quick calculations and binning - [Formatting your fields](https://docs.lightdash.com/explore/formatting-your-fields.md): Hide, group, relabel, and number-format your fields in YAML or in the UI - [Period-over-period comparisons](https://docs.lightdash.com/explore/period-over-period.md): Compare a metric against its previous period, and the ways Lightdash can calculate the shift - [SQL runner](https://docs.lightdash.com/explore/sql-runner.md): Build ad-hoc queries and charts with totally custom SQL ## Table calculations - [Table calculations](https://docs.lightdash.com/explore/table-calculations.md): Add calculations across your results table, like running totals and window aggregations - [Formula table calculations](https://docs.lightdash.com/explore/table-calculations/formulas.md): Build table calculations using a spreadsheet-style formula syntax instead of raw SQL - [Row functions](https://docs.lightdash.com/explore/table-calculations/functions/row-functions.md): Built-in functions for accessing values from other rows in your table calculations - [Pivot functions](https://docs.lightdash.com/explore/table-calculations/functions/pivot-functions.md): Built-in functions for accessing values across pivot columns in your table calculations - [Aggregate functions](https://docs.lightdash.com/explore/table-calculations/functions/aggregate-functions.md): Built-in functions for referencing column and row totals in your table calculations ## SQL templates - [SQL templates](https://docs.lightdash.com/explore/table-calculations/sql-templates.md): Copy-paste SQL patterns for common table calculations like running totals and rankings - [Percent change from previous](https://docs.lightdash.com/explore/table-calculations/sql-templates/percent-change-from-previous.md): Calculate the percent change between a value and the value in the row above it - [Percent of previous value](https://docs.lightdash.com/explore/table-calculations/sql-templates/percent-of-previous-value.md): Calculate a value as a percentage of the value in the row above it - [Percent of column total](https://docs.lightdash.com/explore/table-calculations/sql-templates/percent-of-total-column.md): Calculate each value as a percentage of its column total - [Percent of group/pivot total](https://docs.lightdash.com/explore/table-calculations/sql-templates/percent-of-group-pivot-total.md): Calculate each value as a percentage of its group or pivot total - [Rank in column](https://docs.lightdash.com/explore/table-calculations/sql-templates/rank-in-column.md): Rank every value in a column, from the lowest value up - [Running total](https://docs.lightdash.com/explore/table-calculations/sql-templates/running-total.md): Running totals give you the sum of a value + all of the previous values in that column. - [Rolling window](https://docs.lightdash.com/explore/table-calculations/sql-templates/rolling-window.md): Calculate rolling averages and lookbacks over the previous N rows ## Dashboards - [Dashboards](https://docs.lightdash.com/explore/dashboards.md): Arrange related charts, text, and video into one view your team can filter together - [Interacting with dashboards](https://docs.lightdash.com/explore/dashboards/interact.md): Filter, re-zoom, cross-filter, and drill into the charts on a dashboard without editing them - [Dashboard filters](https://docs.lightdash.com/explore/dashboards/filter.md): Filter every tile on a dashboard at once with temporary, saved, required, and URL filters - [Date zoom](https://docs.lightdash.com/explore/dashboards/date-zoom.md): Change the time granularity of charts on your dashboard without editing them ## Explore view - [The Explore view](https://docs.lightdash.com/explore/explore-view.md): Query a table, sort and chart the results, and save the chart - [Filtering in the Explore view](https://docs.lightdash.com/explore/explore-view/filter.md): Add filters from the Filters tab, the field sidebar, or the results table, and nest them into groups ## Explore - [Filters reference](https://docs.lightdash.com/explore/filters-reference.md): How filters combine, plus every filter type and operator and the SQL each one compiles to ## Metrics catalog - [Metrics catalog](https://docs.lightdash.com/explore/metrics-catalog.md): Browse and explore your metrics in the catalog, and map how they relate with Saved Trees - [Catalog](https://docs.lightdash.com/explore/metrics-catalog/curate-the-catalog.md): Browse, explore, and curate your metrics in the Metrics Catalog - [Saved Trees](https://docs.lightdash.com/explore/metrics-catalog/build-saved-trees.md): Build shareable diagrams that show how your metrics relate to each other - [Drivers](https://docs.lightdash.com/explore/metrics-catalog/drivers.md): Declare which metrics feed into another and see those relationships in Saved Trees ## Explore - [Search](https://docs.lightdash.com/explore/search.md): Find charts, dashboards, spaces, tables, and fields anywhere in your project ## Organize and share - [Spaces](https://docs.lightdash.com/explore/spaces.md): Organize saved charts and dashboards into spaces, and manage who can access each one - [Default user spaces](https://docs.lightdash.com/explore/default-user-spaces.md): Give every eligible user a personal space, provisioned on their next login - [Pinning content](https://docs.lightdash.com/explore/pinning.md): Pin spaces, dashboards, and charts to the homepage so your team sees them first - [How to promote content](https://docs.lightdash.com/explore/promote-content.md): Copy charts and dashboards from a development or preview project into production - [Verified charts and dashboards](https://docs.lightdash.com/explore/verified-content.md): Mark charts and dashboards as verified so your team can spot trusted content at a glance - [Version history](https://docs.lightdash.com/explore/version-history.md): Roll back to earlier versions of charts and dashboards in Lightdash - [Sharing charts](https://docs.lightdash.com/explore/share-charts.md): Share a work-in-progress exploration or a saved chart, and download results and chart images - [Scheduled deliveries](https://docs.lightdash.com/explore/create-scheduled-deliveries.md): Send a dashboard or chart and its results to people on a schedule via email or Slack - [Alerts](https://docs.lightdash.com/explore/create-alerts.md): Get notified in email or Slack when a saved chart's values meet conditions you set ## Semantic layer - [Lightdash semantic layer](https://docs.lightdash.com/semantic-layer.md): Define your metrics, dimensions, and tables once in YAML and use them consistently across Lightdash - [Tables reference](https://docs.lightdash.com/semantic-layer/tables.md): How dbt models become queryable Tables, and every option for configuring them - [Dimensions reference](https://docs.lightdash.com/semantic-layer/dimensions.md): The columns of your tables, and every option for defining and configuring them in YAML - [Metrics reference](https://docs.lightdash.com/semantic-layer/metrics.md): Every metric type, its configuration options, filters, formatting, and the SQL it compiles to - [Joins reference](https://docs.lightdash.com/semantic-layer/joins.md): Connect models to each other so people can query more than one table at a time - [Explores](https://docs.lightdash.com/semantic-layer/explores.md): Curate multiple ways to query the same table for different audiences - [How to use parameters](https://docs.lightdash.com/semantic-layer/parameters.md): Parameters are variables users set at runtime to build dynamic, reusable queries without writing SQL - [SQL variables](https://docs.lightdash.com/semantic-layer/sql-variables.md): Reference variables that template the SQL in your models and make it reusable - [Virtual views](https://docs.lightdash.com/semantic-layer/virtual-views.md): Turn a custom SQL query into a reusable table you can explore, join, and manage as code - [Lightdash YAML](https://docs.lightdash.com/semantic-layer/yaml.md): Use Lightdash without a dbt project by defining your semantic layer directly in YAML files - [Caching](https://docs.lightdash.com/semantic-layer/caching.md): Cut the number of queries Lightdash runs against your warehouse with results and warehouse caching ## Pre-aggregates - [Pre-aggregates](https://docs.lightdash.com/semantic-layer/pre-aggregates.md): Speed up dashboards and cut warehouse costs with pre-computed, materialized summaries - [External pre-aggregates](https://docs.lightdash.com/semantic-layer/pre-aggregates/external.md): Route pre-aggregate queries to a warehouse table you build and refresh yourself - [Monitoring and debugging pre-aggregates](https://docs.lightdash.com/semantic-layer/pre-aggregates/monitoring.md): Track materialization status, understand why queries miss pre-aggregates, and manage refreshes - [Auditing pre-aggregates from the CLI](https://docs.lightdash.com/semantic-layer/pre-aggregates/audit-with-cli.md): Inspect pre-aggregate coverage, find gaps in your YAML, and gate CI on hit rates ## Semantic layer - [lightdash.config.yml reference](https://docs.lightdash.com/semantic-layer/lightdash-config-yml.md): Configure project-wide settings like the Metrics Catalog, parameters, and defaults in one YAML file - [Writing useful descriptions in your semantic layer](https://docs.lightdash.com/semantic-layer/writing-descriptions.md): Write model, dimension, and metric descriptions that serve people and AI agents - [dbt modeling strategies for Lightdash](https://docs.lightdash.com/semantic-layer/modeling-strategies.md): How to structure your dbt models so they explore well in Lightdash ## Workflow - [Workflow](https://docs.lightdash.com/workflow.md): Version control, the CLI, preview projects, and CI/CD around your Lightdash project ## CLI - [Lightdash CLI](https://docs.lightdash.com/workflow/cli.md): Develop your semantic layer locally, preview it against real data, and deploy it - [How to install the Lightdash CLI](https://docs.lightdash.com/workflow/cli/install.md): Install the Lightdash CLI with Homebrew, NPM, WSL, or a direct binary download - [Authenticate the CLI](https://docs.lightdash.com/workflow/cli/authenticate.md): Log in with browser OAuth, a personal access token, or CI environment variables - [Generate semantic layer YAML](https://docs.lightdash.com/workflow/cli/generate.md): Auto-generate and sync schema.yml files so your dbt models appear as Tables in Lightdash - [Deploy changes to production](https://docs.lightdash.com/workflow/cli/deploy.md): Push your local dbt project to production, or refresh metadata from your connected git repository - [Validate content](https://docs.lightdash.com/workflow/cli/validate.md): Find the content in your project that is broken, and the details of each error - [Lint your code](https://docs.lightdash.com/workflow/cli/lint.md): Validate your Lightdash Code files against JSON schemas before deploying to catch errors early - [Compilation](https://docs.lightdash.com/workflow/cli/compile.md): How Lightdash compiles your dbt project into explores, and how to control compilation strictness - [Lightdash CLI reference](https://docs.lightdash.com/workflow/cli/reference.md): Every Lightdash CLI command, its flags, and what it does ## Workflow - [Preview projects](https://docs.lightdash.com/workflow/preview-projects.md): Temporary copies of a project where you can experiment without touching production - [Pull requests](https://docs.lightdash.com/workflow/pull-requests.md): Track the pull requests Lightdash opens in your dbt project, with live status, source, and author - [Automate with CI/CD](https://docs.lightdash.com/workflow/set-up-ci-cd.md): Automate the Lightdash CLI workflow with GitHub Actions or another CI/CD tool - [Validating your content](https://docs.lightdash.com/workflow/validating-your-content.md): Find and fix the charts, dashboards, and deliveries broken by changes to your project - [Content as code](https://docs.lightdash.com/workflow/content-as-code.md): Download charts, dashboards, spaces, agents, and roles as code, edit them, and upload them back - [Migrate dashboards between projects](https://docs.lightdash.com/workflow/migrate-dashboards-between-projects.md): Copy a dashboard and its charts between Lightdash projects or instances with the CLI - [Editing dashboards with agents](https://docs.lightdash.com/workflow/edit-dashboards-with-agents.md): Bulk edit dashboards and charts with AI coding agents through the download-edit-upload workflow - [Agent skills](https://docs.lightdash.com/workflow/install-agent-skills.md): Use AI coding agents like Cursor, Claude Code, Codex, and Antigravity to build your semantic layer - [Set up VS Code for Lightdash](https://docs.lightdash.com/workflow/set-up-vs-code.md): Configure YAML validation in VS Code so schema issues in your Lightdash files surface as you edit - [Renaming models, metrics, and dimensions](https://docs.lightdash.com/workflow/rename-models-and-fields.md): Rename a model, metric, or dimension and update every reference across your project - [Keyboard shortcuts](https://docs.lightdash.com/workflow/keyboard-shortcuts.md): Speed up your workflow with keyboard shortcuts in Lightdash ## Agents - [AI agents](https://docs.lightdash.com/agents.md): Ask questions in plain language and get governed answers, charts, and dashboards from your metrics ## Set up agents - [Set up AI agents](https://docs.lightdash.com/agents/set-up-agents.md): Enable AI features, create your first agent, scope its data, and connect it to Slack - [Agent visibility](https://docs.lightdash.com/agents/visibility.md): How admins see, control, and give feedback on what AI agents do with your data - [Data access control](https://docs.lightdash.com/agents/data-access.md): How agents reach your data, and how to scope them with tags and user attributes - [Thread retention](https://docs.lightdash.com/agents/thread-retention.md): Automatically delete AI agent threads after a period of inactivity - [Creating and editing content](https://docs.lightdash.com/agents/enable-content-tools.md): Let AI agents build and edit charts and dashboards in Lightdash - [AI Router](https://docs.lightdash.com/agents/enable-ai-router.md): Automatically route questions to the best-fit agent, so users don't have to pick one first - [Lightdash MCP server](https://docs.lightdash.com/agents/lightdash-mcp.md): Connect Claude, ChatGPT, and Codex to your Lightdash data over the Model Context Protocol - [Connect external MCP servers](https://docs.lightdash.com/agents/connect-external-mcp-servers.md): Give your Lightdash agents tools from external MCP servers like Notion, Linear, and Confluence - [AI agents as code](https://docs.lightdash.com/agents/agents-as-code.md): Download AI agents to YAML, review them in Git, and promote them between projects - [AI writeback (Beta)](https://docs.lightdash.com/agents/ai-writeback.md): Ask an AI agent to edit your dbt project in chat and open a pull request with the changes - [AI coding agent (Beta)](https://docs.lightdash.com/agents/ai-coding-agent.md): Ask an agent in chat to edit any connected repository and open a pull request ## Work with agents - [Using AI agents](https://docs.lightdash.com/agents/use-ai-agents.md): Ask questions, use SQL mode, mention charts, and schedule deliveries from an agent conversation - [Deep research](https://docs.lightdash.com/agents/deep-research.md): Run a multi-step AI investigation and get an evidence-backed report with verified charts and sources - [Agent memory](https://docs.lightdash.com/agents/agent-memory.md): Agents learn from your questions, corrections, and feedback automatically with no setup required - [Autopilot](https://docs.lightdash.com/agents/autopilot.md): Scheduled AI agent that fixes broken charts, flags stale content, and suggests new ones ## Improve answers - [Verified Answers](https://docs.lightdash.com/agents/verified-answers.md): Train your AI agent with high-quality examples for better, more consistent responses - [Create evaluation suites](https://docs.lightdash.com/agents/create-evaluation-suites.md): Test and validate your AI agent's performance with custom evaluation suites - [AI agent issues](https://docs.lightdash.com/agents/issues.md): Track AI-filed and human-filed data problems on one board, with one-click fixes - [Agent context](https://docs.lightdash.com/agents/agent-context.md): Give every agent in a project the same terminology, table choices, and business rules - [Effective analytics with agents](https://docs.lightdash.com/agents/effective-analytics-with-agents.md): How to configure, scope, and improve your AI agents so they give accurate, governed answers ## Data apps - [Data apps](https://docs.lightdash.com/data-apps.md): Build interactive, AI-generated apps on top of your Lightdash semantic layer - [Customize themes](https://docs.lightdash.com/data-apps/customize-themes.md): Create shared themes to give your data apps consistent styles, fonts, and instructions - [External connections](https://docs.lightdash.com/data-apps/external-connections.md): Let data apps fetch from third-party HTTP APIs through a credential-injecting proxy - [Download data apps as code](https://docs.lightdash.com/data-apps/download-data-apps-as-code.md): Download a data app's source, edit it locally, and publish new versions with the Lightdash CLI - [Scheduled deliveries and syncs](https://docs.lightdash.com/data-apps/deliveries-and-syncs.md): Send a data app's results on a schedule as files, or sync them to a Google Sheet - [Build maps and globes in a data app](https://docs.lightdash.com/data-apps/build-maps-and-globes.md): Build interactive d3 maps and globes in a data app from external shapes and your semantic layer ## Embed - [Embedding](https://docs.lightdash.com/embed.md): Embed Lightdash charts, dashboards, agents, and data apps in your own product - [Set up embedding](https://docs.lightdash.com/embed/set-up-embedding.md): Generate expirable URLs and tokens to serve Lightdash content to users in your own application - [How to Embed Dashboards](https://docs.lightdash.com/embed/embed-dashboards.md): Embed a dashboard with filters, exports, and interactive tiles via iframe or React SDK - [How to Embed Charts](https://docs.lightdash.com/embed/embed-charts.md): Embed a single saved Lightdash chart with a minimal, read-only UI using the React SDK - [How to embed AI agents](https://docs.lightdash.com/embed/embed-ai-agents.md): Embed a Lightdash AI agent so your users can chat with their data inside your product - [How to embed the metrics catalog](https://docs.lightdash.com/embed/embed-metrics-catalog.md): Let your users browse a project's metrics and dimensions without a Lightdash login - [How to embed data apps](https://docs.lightdash.com/embed/embed-data-apps.md): Embed a Lightdash data app as standalone content in an iframe using a JWT-scoped preview token - [Embedding reference](https://docs.lightdash.com/embed/reference.md): Complete API reference for embedding Lightdash content securely using JWTs - [Embedding with iframe](https://docs.lightdash.com/embed/iframe.md): Complete reference for embedding Lightdash content using iframes with JWTs in URL hash fragments - [Embedding with React SDK](https://docs.lightdash.com/embed/react-sdk.md): Components, props, and hooks for embedding Lightdash content in a React or Next.js app ## Integrations - [Integrations](https://docs.lightdash.com/integrations.md): Connect Lightdash to dbt, Slack, Google Sheets, SQL clients, and Snowflake Cortex ## dbt - [dbt](https://docs.lightdash.com/integrations/dbt.md): Connect a dbt project to Lightdash, keep it in sync, and use metrics defined in dbt - [dbt Projects](https://docs.lightdash.com/integrations/dbt/projects.md): Every way to sync your dbt project into Lightdash, and how to connect multiple dbt sources - [dbt write-back](https://docs.lightdash.com/integrations/dbt/write-back.md): Develop models and metrics in Lightdash and open a pull request against your dbt project - [dbt MetricFlow metrics](https://docs.lightdash.com/integrations/dbt/metricflow.md): Connect Lightdash to your dbt MetricFlow semantic layer metrics - [Upgrading dbt](https://docs.lightdash.com/integrations/dbt/upgrading.md): What changes in your Lightdash setup when you move between dbt versions ## Integrations - [Slack integration](https://docs.lightdash.com/integrations/slack.md): Unfurl chart links, deliver scheduled reports and alerts, and chat with your AI agents in Slack - [Google Sheets](https://docs.lightdash.com/integrations/google-sheets.md): Sync chart results to a Google Sheet on a schedule, or query Lightdash from the sidebar add-on - [Metrics SQL API](https://docs.lightdash.com/integrations/metrics-sql-api.md): Query your Lightdash semantic layer over the Postgres wire protocol from any SQL client or BI tool - [Snowflake Cortex](https://docs.lightdash.com/integrations/snowflake-cortex.md): Operate your BI layer agentically by pairing Lightdash with Snowflake's Cortex Code agent - [Apache Ossie](https://docs.lightdash.com/integrations/apache-ossie.md): Exchange semantic models with other tools using the Apache Ossie open specification ## Workspace admin - [Workspace admin](https://docs.lightdash.com/workspace-admin.md): Govern roles and access, single sign-on, service accounts, and organization-wide settings ## Access and permissions - [Roles and permissions](https://docs.lightdash.com/workspace-admin/roles.md): Organization, project, and space roles, how they stack, and every permission each grants - [Custom Roles](https://docs.lightdash.com/workspace-admin/custom-roles.md): Build granular permission sets by picking exactly which scopes a role grants - [Groups](https://docs.lightdash.com/workspace-admin/manage-groups.md): Manage access for many users at once by organizing them into groups - [User attributes](https://docs.lightdash.com/workspace-admin/user-attributes.md): Customize what charts and dashboards show based on attributes of the logged-in user - [Service accounts](https://docs.lightdash.com/workspace-admin/service-accounts.md): Userless, scoped credentials for CLI and API access that outlive their creator ## SSO - [SSO providers](https://docs.lightdash.com/workspace-admin/sso.md): Overview of supported Single Sign-On providers across Lightdash plans - [SSO setup](https://docs.lightdash.com/workspace-admin/sso/setup.md): Configure SSO providers from admin settings, with domain routing and account linking - [Verified domains](https://docs.lightdash.com/workspace-admin/sso/verified-domains.md): Prove ownership of your organization's domains to control SSO routing in Lightdash - [SCIM Integration](https://docs.lightdash.com/workspace-admin/sso/scim.md): Automate user and group provisioning from your identity provider with SCIM 2.0 ## Organization settings - [Managing your organization](https://docs.lightdash.com/workspace-admin/manage-your-organization.md): Leave or delete your Lightdash organization from the Danger zone in your settings - [Creating multiple projects](https://docs.lightdash.com/workspace-admin/manage-projects.md): Create, switch between, and delete the projects inside your Lightdash organization - [Customizing the appearance of your project](https://docs.lightdash.com/workspace-admin/appearance.md): Set the default chart colors for your organization so everything you build is on brand - [Custom email domain](https://docs.lightdash.com/workspace-admin/set-up-custom-email-domain.md): Send Lightdash report emails from your own domain instead of a Lightdash address - [Organization credentials](https://docs.lightdash.com/workspace-admin/organization-credentials.md): Share reusable warehouse credentials so users can create projects securely - [Set up timezones](https://docs.lightdash.com/workspace-admin/set-project-timezone.md): Model your warehouse data and configure your project so timezones behave predictably ## Monitoring and limits - [Usage analytics](https://docs.lightdash.com/workspace-admin/usage-analytics.md): Track who is accessing content and running queries in your Lightdash projects - [Project compilation history](https://docs.lightdash.com/workspace-admin/project-compilation-history.md): Review past project compilations to monitor deployments and troubleshoot failures - [Export limits](https://docs.lightdash.com/workspace-admin/export-limits.md): Override the instance-wide query row and CSV or Excel cell limits for your organization - [Instance health](https://docs.lightdash.com/workspace-admin/instance-health.md): How to keep a Lightdash deployment relevant, governed, and performant ## Personal settings - [Personal settings](https://docs.lightdash.com/personal-settings.md): Manage your own tokens, warehouse connections, and display preferences in Lightdash - [Personal access tokens](https://docs.lightdash.com/personal-settings/create-personal-tokens.md): Create a personal access token to authenticate with the Lightdash CLI and API - [Personal warehouse connections](https://docs.lightdash.com/personal-settings/personal-warehouse-connections.md): When and how your personal warehouse credentials are used in Lightdash projects - [Timezones](https://docs.lightdash.com/personal-settings/timezone.md): How timezones resolve across charts, dashboards, filters, and scheduled deliveries ## Self-host - [Self-hosting](https://docs.lightdash.com/self-host.md): Deploy, configure, and operate your own Lightdash instance on Kubernetes or Docker Compose - [Lightdash Cloud vs. Self-Hosted](https://docs.lightdash.com/self-host/lightdash-cloud-vs-self-hosted.md): What you get and what you take on when you choose Lightdash Cloud or self-hosting - [Enterprise on-prem setup](https://docs.lightdash.com/self-host/enterprise-on-prem.md): Deploy FedRAMP-ready Lightdash Enterprise Edition on premises on your own infrastructure - [Production deployment checklist](https://docs.lightdash.com/self-host/production-deployment-checklist.md): What to configure for an enterprise-grade self-hosted deployment with the official Helm chart - [Data flows and telemetry in self-hosted Lightdash](https://docs.lightdash.com/self-host/data-flows-and-telemetry.md): What data stays inside your infrastructure, what leaves it, where it goes, and how to control it - [Environment variables](https://docs.lightdash.com/self-host/customize-deployment/environment-variables.md): Complete reference of the environment variables that configure a Lightdash deployment ## Install - [Self-Host Lightdash](https://docs.lightdash.com/self-host/self-host-lightdash.md): Deploy Lightdash on Kubernetes with the official Helm chart, from minimum config to production - [Self-host Lightdash using docker compose](https://docs.lightdash.com/self-host/self-host-lightdash-docker-compose.md): Run a minimal Lightdash instance on your own machine with Docker Compose ## Upgrading - [Upgrading Lightdash](https://docs.lightdash.com/self-host/upgrading.md): How Lightdash versioning works and when to upgrade a self-hosted deployment - [Upgrade safety](https://docs.lightdash.com/self-host/upgrade-safety.md): Read the release-safety artifact, check an upgrade span, and pick the right deployment strategy - [Upgrade runbook](https://docs.lightdash.com/self-host/upgrade-runbook.md): Upgrade sequences for Kubernetes, docker compose, and automated deployments ## Connect services - [Configure a Github integration for self-hosted Lightdash](https://docs.lightdash.com/self-host/customize-deployment/configure-github-for-lightdash.md): Create a GitHub app and wire its credentials into your instance so Lightdash can write to dbt repos - [Configure a Slack integration for self-hosted Lightdash](https://docs.lightdash.com/self-host/customize-deployment/configure-a-slack-app-for-lightdash.md): Create a Slack app and wire its credentials into your instance for unfurls and deliveries - [Configure a Google Sheets integration for self-hosted Lightdash](https://docs.lightdash.com/self-host/customize-deployment/configure-google-sheets-integration.md): Enable Google Sheets uploads and scheduled deliveries on a self-hosted Lightdash instance ## Infrastructure - [Configure Lightdash to use an external database](https://docs.lightdash.com/self-host/customize-deployment/configure-lightdash-to-use-an-external-database.md): Point Lightdash at a managed PostgreSQL database with the settings it needs - [Configure Lightdash to use external storage](https://docs.lightdash.com/self-host/customize-deployment/configure-lightdash-to-use-external-object-storage.md): Set up the required S3-compatible bucket on GCP, AWS, Azure, or MinIO - [Run a dedicated scheduler worker](https://docs.lightdash.com/self-host/customize-deployment/scheduler.md): Run scheduled deliveries on a dedicated worker so heavy exports can't starve the API - [Add headless browser on self-hosting](https://docs.lightdash.com/self-host/customize-deployment/enable-headless-browser-for-lightdash.md): Run the headless browser that renders chart and dashboard images for email and Slack deliveries - [Sandboxes](https://docs.lightdash.com/self-host/customize-deployment/sandboxes.md): How Lightdash isolates LLM-generated code, and how to configure the sandbox provider - [Secure Lightdash with HTTPS](https://docs.lightdash.com/self-host/customize-deployment/secure-lightdash-with-https.md): Terminate HTTPS in front of a self-hosted Lightdash instance with a load balancer, ingress, or proxy - [Configure Prometheus metrics for self-hosted Lightdash](https://docs.lightdash.com/self-host/customize-deployment/configure-prometheus-metrics-for-self-hosted-lightdash.md): Expose Prometheus metrics for instance health, plus custom counters driven by application events ## Access and licensing - [Configure Lightdash to use passwords or SSO for authentication](https://docs.lightdash.com/self-host/customize-deployment/use-sso-login-for-self-hosted-lightdash.md): Enable password login and SSO with Okta, Google, Azure AD, OneLogin, or any OIDC provider - [Organization roadmap](https://docs.lightdash.com/self-host/customize-deployment/organization-roadmap.md): See the feature requests your organization has raised and where each one stands ## Enterprise features - [Enterprise features](https://docs.lightdash.com/self-host/enterprise-features.md): Enable Enterprise Edition features on a self-hosted Lightdash instance - [AI agents](https://docs.lightdash.com/self-host/enterprise-features/ai-agents.md): Enable AI Analyst and AI agents on a self-hosted Lightdash instance - [Data apps](https://docs.lightdash.com/self-host/enterprise-features/data-apps.md): Configure a self-hosted Lightdash instance to run data apps - [AI writeback](https://docs.lightdash.com/self-host/enterprise-features/ai-writeback.md): Enable AI writeback on a self-hosted Lightdash instance - [MCP](https://docs.lightdash.com/self-host/enterprise-features/mcp.md): Enable the Model Context Protocol server on a self-hosted Lightdash instance - [Pre-aggregates](https://docs.lightdash.com/self-host/enterprise-features/pre-aggregates.md): Enable pre-aggregate query routing on a self-hosted Lightdash instance ## NATS workers - [NATS workers](https://docs.lightdash.com/self-host/nats-workers.md): Scale Lightdash query processing with dedicated NATS worker pods using the Helm chart - [Warehouse workers](https://docs.lightdash.com/self-host/nats-workers/warehouse-workers.md): Configure and scale dedicated warehouse query worker pods - [Pre-aggregate workers](https://docs.lightdash.com/self-host/nats-workers/pre-aggregate-workers.md): Configure and scale pre-aggregate worker pods for materialization and DuckDB query serving ## Support - [Support](https://docs.lightdash.com/support.md): The fastest way to get help with Lightdash, depending on how you use it - [Generating a HAR file](https://docs.lightdash.com/support/generate-har-file.md): How to capture a HAR file from your browser to help the Lightdash support team troubleshoot issues - [AI thread debug dump](https://docs.lightdash.com/support/ai-thread-debug-dump.md): Enable and safely use the AI agent thread debug dump on a self-hosted instance - [Feature Maturity Levels](https://docs.lightdash.com/support/feature-maturity-levels.md): What each maturity level means for the stability and availability of a Lightdash feature - [Support access](https://docs.lightdash.com/support/support-access.md): Impersonate a user to reproduce an issue, and control who else can do the same - [API (683 pages)](https://docs.lightdash.com/_llms/api.md): Documentation for API. ## OpenAPI Specs - [swagger](https://raw.githubusercontent.com/lightdash/lightdash/refs/heads/main/packages/backend/src/generated/swagger.json) - [openapi](/api-reference/openapi.json) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [API (683 pages)](https://docs.lightdash.com/_llms/api.md): Documentation for API. - [API / Reference (680 pages)](https://docs.lightdash.com/_llms/api/reference.md): Documentation for API / Reference. - [API / Reference / API Reference (148 pages)](https://docs.lightdash.com/_llms/api/reference/api-reference.md): Documentation for API / Reference / API Reference.