diff --git a/docs.json b/docs.json index af7dfdd5..eff49d1a 100644 --- a/docs.json +++ b/docs.json @@ -252,6 +252,7 @@ "pages": [ "self-host/self-host-lightdash", "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", diff --git a/self-host/enterprise-on-prem.mdx b/self-host/enterprise-on-prem.mdx new file mode 100644 index 00000000..a8d11348 --- /dev/null +++ b/self-host/enterprise-on-prem.mdx @@ -0,0 +1,52 @@ +--- +title: "Enterprise on-prem setup" +description: "Guide for deploying Lightdash Enterprise Edition on your own infrastructure" +--- + +This guide covers the setup requirements and best practices for deploying Lightdash Enterprise Edition on-premises. + +## Prerequisites + +- Postgres database with the `pgvector` extension installed + +## Accessing the Lightdash image + +The Lightdash image is available on [DockerHub](https://hub.docker.com/repository/docker/lightdash/lightdash/tags). You can pull a specific version (recommended) or use `latest`. + +```bash +docker pull lightdash/lightdash:0.2248.3 +``` + +### Recommended version strategy + +We publish frequent releases, and we don't currently provide an LTS (long-term support) or "stable" tag for self-hosted deployments. + +**Our recommendation:** + +- **Use a pinned version in production** (e.g. `lightdash/lightdash:0.2248.3`) rather than `latest` +- Pinning makes deployments repeatable and avoids unexpected changes + +**Treat upgrades as a controlled rollout:** + +1. Upgrade in **staging** first +2. Run your normal validation (SSO, connections, dbt refreshes, scheduled jobs, embeds, critical dashboards) +3. Roll out to **production** when you're comfortable + +## License key + +A license key is required for Enterprise Edition features. Set it via the `LIGHTDASH_LICENSE_KEY` environment variable. Your license key will be shared by the Lightdash team via 1Password. + + +License validation requires outbound access to `https://api.keygen.sh`. + + +For detailed configuration instructions, see [Enterprise License Keys](/self-host/customize-deployment/enterprise-license-keys). + +## Migration from OSS + +If you're migrating from the open-source version to Enterprise Edition: + +1. Migrate to a commercial version matching your current OSS version +2. Once a single container is running the commercial version, the connected database will be upgraded to include the commercial schemas +3. Any other OSS containers will fail on restart but can be run temporarily +4. Roll out the commercial version to all containers as soon as the first container successfully migrates