Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 17 additions & 7 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
"references/chart-types/pie-chart",
"references/chart-types/funnel-chart",
"references/chart-types/treemap-chart",
"references/chart-types/sankey",
"references/chart-types/table",
"references/chart-types/big-value",
"references/chart-types/gauge",
Expand Down Expand Up @@ -227,6 +228,7 @@
"references/workspace/roles",
"references/workspace/custom-roles",
"references/workspace/user-attributes",
"references/workspace/user-impersonation",
"references/workspace/how-to-create-multiple-projects",
"references/workspace/customizing-the-appearance-of-your-project",
"references/workspace/adding-slack-integration",
Expand All @@ -237,7 +239,8 @@
"references/workspace/sso-providers"
]
},
"references/workspace/feature-maturity-levels" ]
"references/workspace/feature-maturity-levels"
]
},
{
"group": "Integrations",
Expand All @@ -251,7 +254,9 @@
},
{
"group": "Lightdash SDK",
"pages": ["sdk/python-sdk"]
"pages": [
"sdk/python-sdk"
]
},
{
"group": "Embedding",
Expand Down Expand Up @@ -281,8 +286,9 @@
"self-host/lightdash-cloud-vs-self-hosted",
"self-host/enterprise-on-prem",
"self-host/self-host-lightdash-docker-compose",
"self-host/self-host-lightdash-restack",
"self-host/update-lightdash",
"self-host/pre-aggregates",
"self-host/nats-workers",
{
"group": "Customize deployment",
"pages": [
Expand All @@ -308,7 +314,10 @@
},
{
"group": "Contact",
"pages": ["contact/faqs", "contact/contact-info"]
"pages": [
"contact/faqs",
"contact/contact-info"
]
}
]
},
Expand All @@ -325,8 +334,10 @@
"groups": [
{
"group": "API",
"pages": ["api-reference/v1/introduction",
"api-reference/v1/recipes"]
"pages": [
"api-reference/v1/introduction",
"api-reference/v1/recipes"
]
},
{
"group": "Reference",
Expand Down Expand Up @@ -648,7 +659,6 @@
"source": "/guides/developer/agentic-coding",
"destination": "/guides/developer/agent-skills"
}

],
"api": {
"playground": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: "Configure a Slack integration for self-hosted Lightdash"
sidebarTitle: Slack Integration
---

<Note>
🛠 This page is for engineering teams self-hosting their own Lightdash instance. If you want to use the Slack integration, go to the [Slack integration](/references/integrations/slack-integration) guide.
</Note>

In this guide we will show you how you can enable [the Slack integration](/references/integrations/slack-integration) on your on self-hosted Lightdash server.

### Create a new Slack app on your organization
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: "Configure a Github integration for self-hosted Lightdash"
sidebarTitle: "Github Integration"
---

<Note>
🛠 This page is for engineering teams self-hosting their own Lightdash instance. If you want to use the GitHub integration, go to the [dbt projects](/references/integrations/dbt-projects) guide.
</Note>

In this guide we will show you how you can enable the Github integration on your on self-hosted Lightdash server.

### Create a new Github app
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: "Configure Lightdash to use an external database"
sidebarTitle: Use External Database
---

<Note>
🛠 This page is for engineering teams self-hosting their own Lightdash instance. If you want to connect your data warehouse, go to the [Connect a project](/get-started/setup-lightdash/connect-project) guide.
</Note>

<Info>
Lightdash requires a **PostgreSQL** database (version 12 or greater).
</Info>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: "Configure logging for Lightdash"
sidebarTitle: Logging
---

<Note>
🛠 This page is for engineering teams self-hosting their own Lightdash instance. If you want to monitor usage and analytics, go to the [Usage analytics](/references/workspace/usage-analytics) guide.
</Note>

By default Lightdash logs to the console in a human readable format. You can configure the logging behaviour, such as logging to a file or using a JSON format, by using the following environment variables:

| Variable | Description | Required? | Default |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: "Configure Prometheus metrics for self-hosted Lightdash"
sidebarTitle: Prometheus metrics
---

<Note>
🛠 This page is for engineering teams self-hosting their own Lightdash instance. If you want to monitor usage and analytics, go to the [Usage analytics](/references/workspace/usage-analytics) guide.
</Note>

Lightdash can expose Prometheus metrics to help you monitor the performance and health of your Lightdash instance. This guide explains how to enable and configure Prometheus metrics for your self-hosted Lightdash deployment.

## Enabling Prometheus metrics
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: "Configure SMTP for Lightdash email notifications"
sidebarTitle: SMTP for emails
---

<Note>
🛠 This page is for engineering teams self-hosting their own Lightdash instance. If you want to set up scheduled deliveries and alerts, go to the [Scheduled deliveries](/guides/how-to-create-scheduled-deliveries) guide.
</Note>

This is a reference to all the SMTP environment variables that can be used to configure a Lightdash email client.

| Variable | Description | Required? | Default |
Expand All @@ -16,5 +20,6 @@ This is a reference to all the SMTP environment variables that can be used to co
| EMAIL\_SMTP\_ALLOW\_INVALID\_CERT | Allow connection to TLS server with self-signed or invalid TLS certificate | false | |
| EMAIL\_SMTP\_SENDER\_EMAIL | The email address that sends emails | <Icon icon="square-check" iconType="solid"/> | |
| EMAIL\_SMTP\_SENDER\_NAME | The name of the email address that sends emails | Lightdash | |
| EMAIL\_SMTP\_IMAGE\_INLINE\_CID | Embed images directly into emails as CID attachments instead of referencing external URLs. Useful for deployments behind firewalls where email clients cannot reach internal image URLs. | false | |

\[1\] `EMAIL_SMTP_PASSWORD` or `EMAIL_SMTP_ACCESS_TOKEN` needs to be provided
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: "Configure a standalone scheduler worker for self-hosted Lightdash"
sidebarTitle: Standalone scheduler worker
---

<Note>
🛠 This page is for engineering teams self-hosting their own Lightdash instance. If you want to set up scheduled deliveries, go to the [Scheduled deliveries](/guides/how-to-create-scheduled-deliveries) guide.
</Note>

By default, the Lightdash server runs a scheduler worker. For more advanced infrastructure, we can run the scheduler worker separately from the main server.

### 1. Disable scheduler worker in the main server
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ sidebarTitle: Headless browser

---

<Note>
🛠 This page is for engineering teams self-hosting their own Lightdash instance. If you want to set up scheduled deliveries, go to the [Scheduled deliveries](/guides/how-to-create-scheduled-deliveries) guide.
</Note>

Images can be requested on `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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,8 @@ title: "Enable the scheduler in self-hosted Lightdash"
sidebarTitle: Scheduler
---

<Note>
🛠 This page is for engineering teams self-hosting their own Lightdash instance. If you want to set up scheduled deliveries, go to the [Scheduled deliveries](/guides/how-to-create-scheduled-deliveries) guide.
</Note>

Coming soon
4 changes: 4 additions & 0 deletions self-host/customize-deployment/enterprise-license-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: "Enterprise License Keys"
description: "Access enterprise features on self-hosted Lightdash instances"
---

<Note>
🛠 This page is for engineering teams self-hosting their own Lightdash instance. If you want to learn about enterprise features and pricing, go to [lightdash.com/pricing](https://lightdash.com/pricing).
</Note>

Enterprise License Keys enable access to advanced Lightdash Enterprise Edition features on self-hosted instances. These features include enhanced security, performance optimizations, and advanced collaboration tools designed for large organizations.

## Getting an Enterprise License Key
Expand Down
1 change: 1 addition & 0 deletions self-host/customize-deployment/environment-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ This is a reference to all the SMTP environment variables that can be used to co
| `EMAIL_SMTP_ALLOW_INVALID_CERT` | Allow connection to TLS server with self-signed or invalid TLS certificate (default=false) |
| `EMAIL_SMTP_SENDER_EMAIL` | **(Required)** The email address that sends emails |
| `EMAIL_SMTP_SENDER_NAME` | The name of the email address that sends emails (default=Lightdash) |
| `EMAIL_SMTP_IMAGE_INLINE_CID` | Embed images directly into emails as CID attachments instead of referencing external URLs. Useful for deployments behind firewalls where email clients cannot reach internal image URLs (default=false) |

[1] `EMAIL_SMTP_PASSWORD` or `EMAIL_SMTP_ACCESS_TOKEN` needs to be provided

Expand Down
4 changes: 4 additions & 0 deletions self-host/customize-deployment/google-sheets-integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ description: "In this guide we will show you how you can [upload to Google Sheet
sidebarTitle: Google sheets
---

<Note>
🛠 This page is for engineering teams self-hosting their own Lightdash instance. If you want to use the Google Sheets integration, go to the [Google Sheets](/references/integrations/google-sheets) guide.
</Note>

### Enable Google SSO

To authenticate Google users, first you need to enable [Google SSO](https://docs.lightdash.com/self-host/customize-deployment/use-sso-login-for-self-hosted-lightdash#google) on your server.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: "Configure Lightdash to use passwords or SSO for authentication"
sidebarTitle: SSO and auth
---

<Note>
🛠 This page is for engineering teams self-hosting their own Lightdash instance. If you want to configure SSO on Lightdash Cloud, go to the [SSO providers](/references/workspace/sso-providers) guide.
</Note>

## Multiple authentication methods

Lightdash supports configuring multiple authentication methods simultaneously on a single instance. You can enable any combination of sign-in options, including:
Expand Down
90 changes: 0 additions & 90 deletions self-host/self-host-lightdash-restack.mdx

This file was deleted.

Loading