|
| 1 | +--- |
| 2 | +title: "Enterprise on-prem setup" |
| 3 | +description: "Guide for deploying Lightdash Enterprise Edition on your own infrastructure" |
| 4 | +--- |
| 5 | + |
| 6 | +This guide covers the setup requirements and best practices for deploying Lightdash Enterprise Edition on-premises. |
| 7 | + |
| 8 | +## Prerequisites |
| 9 | + |
| 10 | +- Postgres database with the `pgvector` extension installed |
| 11 | + |
| 12 | +## Accessing the Lightdash image |
| 13 | + |
| 14 | +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`. |
| 15 | + |
| 16 | +```bash |
| 17 | +docker pull lightdash/lightdash:0.2248.3 |
| 18 | +``` |
| 19 | + |
| 20 | +### Recommended version strategy |
| 21 | + |
| 22 | +We publish frequent releases, and we don't currently provide an LTS (long-term support) or "stable" tag for self-hosted deployments. |
| 23 | + |
| 24 | +**Our recommendation:** |
| 25 | + |
| 26 | +- **Use a pinned version in production** (e.g. `lightdash/lightdash:0.2248.3`) rather than `latest` |
| 27 | +- Pinning makes deployments repeatable and avoids unexpected changes |
| 28 | + |
| 29 | +**Treat upgrades as a controlled rollout:** |
| 30 | + |
| 31 | +1. Upgrade in **staging** first |
| 32 | +2. Run your normal validation (SSO, connections, dbt refreshes, scheduled jobs, embeds, critical dashboards) |
| 33 | +3. Roll out to **production** when you're comfortable |
| 34 | + |
| 35 | +## License key |
| 36 | + |
| 37 | +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. |
| 38 | + |
| 39 | +<Note> |
| 40 | +License validation requires outbound access to `https://api.keygen.sh`. |
| 41 | +</Note> |
| 42 | + |
| 43 | +For detailed configuration instructions, see [Enterprise License Keys](/self-host/customize-deployment/enterprise-license-keys). |
| 44 | + |
| 45 | +## Migration from OSS |
| 46 | + |
| 47 | +If you're migrating from the open-source version to Enterprise Edition: |
| 48 | + |
| 49 | +1. Migrate to a commercial version matching your current OSS version |
| 50 | +2. Once a single container is running the commercial version, the connected database will be upgraded to include the commercial schemas |
| 51 | +3. Any other OSS containers will fail on restart but can be run temporarily |
| 52 | +4. Roll out the commercial version to all containers as soon as the first container successfully migrates |
0 commit comments