diff --git a/deployment/ci-cd-license-key.md b/deployment/ci-cd-license-key.md index 09dcda6e2c..6a8421d7cf 100644 --- a/deployment/ci-cd-license-key.md +++ b/deployment/ci-cd-license-key.md @@ -10,13 +10,15 @@ position: 7 # Telerik License Key in CI/CD Environment -This article describes how to set up and activate your [Telerik UI for Blazor license key](slug:installation-license-key) across a few popular cloud build CI/CD services. You can find guidance and examples on how to set environment variables for some of the most popular CI/CD platforms. +This article describes how to set up and activate your [Telerik UI for Blazor license key](slug:installation-license-key) across a few popular cloud build and deployment services. You can find guidance and examples on how to set environment variables for some of the most popular CI/CD platforms. @[template](/_contentTemplates/common/get-started.md#license-key-version) ## Basics -The Telerik license activation process in CI/CD environments involves the following steps: +Provide a Telerik license key during the `build` and `publish` steps of the application deployment process. [A license key is not required on the web server that hosts the already deployed web application](slug:installation-license-key#where-do-i-need-to-install-a-license-key). + +The Telerik license activation process in CI/CD test, build, staging, and production environments involves the following steps: 1. Go to the [License Keys page](https://www.telerik.com/account/your-licenses/license-keys) in your Telerik account and download your license key. 1. Set an environment variable with either of the following names: @@ -24,7 +26,7 @@ The Telerik license activation process in CI/CD environments involves the follow * `TELERIK_LICENSE_PATH`—the value must be the full path to the license key file, including the license file name itself. `TELERIK_LICENSE_PATH` requires `Telerik.Licensing` version `1.4.9` and above. You can use it with Telerik UI for Blazor `8.1.0` and above. 1. (optional) [Fail the build and deployment](#abort-deployment-on-license-key-error) if there is an issue with the license key. -In most cases, the recommended way to provide your license key to the `Telerik.Licensing` NuGet package in CI/CD environments is to use the `TELERIK_LICENSE` environment variable. +In most cases, the recommended way to provide your license key to the `Telerik.Licensing` NuGet package in CI/CD environments is to use one of the available environment variables. Use `TELERIK_LICENSE_PATH` or [only a license file](slug:installation-license-key#manual-installation) on Windows and Windows Server machines, which are managed directly through the operating system's user interface. Do not use the `TELERIK_LICENSE` environment variable in this case, due to the large variable value length. diff --git a/installation/license-key.md b/installation/license-key.md index 9dd11fe1d6..aadc791333 100644 --- a/installation/license-key.md +++ b/installation/license-key.md @@ -10,22 +10,22 @@ position: 1 # Telerik License Key -Telerik UI for Blazor requires activation through a license key for both trial and commercial licenses. This article describes how to download your personal license key and use it to activate the Telerik Blazor components. +Telerik UI for Blazor requires activation through a license key during application build and publish. A license key is required for both trial and commercial licenses. This article describes how to download your personal license key and use it to activate the Telerik Blazor components. @[template](/_contentTemplates/common/get-started.md#license-key-version) ## Basics -To install a license key, you must have a developer or trial license for: +To install a license key, you must have a commercial or trial license for: * Telerik UI for Blazor * Any product bundle that includes Telerik UI for Blazor, such as DevCraft. -If you are new to Telerik UI for Blazor, sign up for a free trial. +If you are new to Telerik UI for Blazor, [sign up for a free trial](https://www.telerik.com/blazor-ui). -The `Telerik.UI.for.Blazor` NuGet package [depends on the `Telerik.Licensing` NuGet package](slug:getting-started/what-you-need#nuget-packages). During project build, the `Telerik.Licensing` package automatically verifies the license key and activates Telerik UI for Blazor in that project. +The `Telerik.UI.for.Blazor` NuGet package [depends on the `Telerik.Licensing` NuGet package](slug:getting-started/what-you-need#nuget-packages). During project build and publish, the `Telerik.Licensing` package automatically verifies the license key and activates Telerik UI for Blazor in that project. -Follow the steps below for [automatic](#automatic-installation) or [manual](#manual-installation) license key installation in your local development environment. To build Telerik Blazor apps in a CI/CD environment, [set up a Telerik license key in CI/CD](slug:deployment-license-key). +Follow the steps below for [automatic](#automatic-installation) or [manual](#manual-installation) license key installation in your local development environment. Then, find out [how to use a Telerik license key during application deployment](slug:deployment-license-key). An [invalid or missing license key results in app build warnings](slug:troubleshooting-license-key-errors) and watermarks in the application UI. @@ -35,7 +35,7 @@ An [invalid or missing license key results in app build warnings](slug:troublesh To download and install your Telerik license key automatically, use either of the following Telerik productivity tools: -* Telerik Control Panel—this tool downloads and installs different Telerik products on your machine. +* [Telerik Control Panel](https://docs.telerik.com/controlpanel/introduction)—this tool downloads and installs different Telerik products on your machine. * [Telerik UI for Blazor Visual Studio extension](slug:getting-started-vs-integration-overview)—this tool adds or upgrades Telerik UI for Blazor in new or existing apps. The above tools download and install a license key for you and make it available for all projects that you develop on your local machine. The license key file and location is specified in the [Manual Installation](#manual-installation) section below. @@ -85,6 +85,15 @@ Refer to the [Troubleshooting License Key Errors](slug:troubleshooting-license-k ## Frequently Asked Questions +### Where do I need to install a license key? + +A Telerik license key is required on all environments that build or publish Telerik Blazor apps. This includes: + +* Local development environments. See [Automatic Installation](#automatic-installation) and [Manual Installation](#manual-installation) above. +* Environments that perform [deployment, continuous integration or continuous delivery](slug:deployment-license-key) (CI/CD) to run your apps on a test, staging or production environment. Such environments include Azure Pipelines, GitHub Actions, GitLab, Docker, Jenkins, and others. + +>tip A license key is not required on the web server that hosts the already deployed web application. + ### Does the license key expire? Yes, the license key expires at the end of your subscription: @@ -161,8 +170,8 @@ No, versions up to **7.1.0** released prior to February 2025 do not require a li ## Next Steps -* [Set Up the Telerik NuGet Feed](slug:installation/nuget) * [Install License Key in CI/CD Environment](slug:deployment-license-key) +* [Set Up the Telerik NuGet Feed](slug:installation/nuget) ## See Also