Skip to content

Commit 330fc4d

Browse files
authored
docs(Common): Explain better where to (not) install a license key (#3007)
1 parent 64d3b28 commit 330fc4d

File tree

2 files changed

+21
-10
lines changed

2 files changed

+21
-10
lines changed

deployment/ci-cd-license-key.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,23 @@ position: 7
1010

1111
# Telerik License Key in CI/CD Environment
1212

13-
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.
13+
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.
1414

1515
@[template](/_contentTemplates/common/get-started.md#license-key-version)
1616

1717
## Basics
1818

19-
The Telerik license activation process in CI/CD environments involves the following steps:
19+
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).
20+
21+
The Telerik license activation process in CI/CD test, build, staging, and production environments involves the following steps:
2022

2123
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.
2224
1. Set an environment variable with either of the following names:
2325
* `TELERIK_LICENSE`—the value must be the Telerik license key string.
2426
* `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.
2527
1. (optional) [Fail the build and deployment](#abort-deployment-on-license-key-error) if there is an issue with the license key.
2628

27-
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.
29+
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.
2830

2931
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.
3032

installation/license-key.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,22 @@ position: 1
1010

1111
# Telerik License Key
1212

13-
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.
13+
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.
1414

1515
@[template](/_contentTemplates/common/get-started.md#license-key-version)
1616

1717
## Basics
1818

19-
To install a license key, you must have a developer or trial license for:
19+
To install a license key, you must have a commercial or trial license for:
2020

2121
* Telerik UI for Blazor
2222
* Any product bundle that includes Telerik UI for Blazor, such as DevCraft.
2323

24-
If you are new to Telerik UI for Blazor, <a href="https://www.telerik.com/blazor-ui" target="_blank">sign up for a free trial</a>.
24+
If you are new to Telerik UI for Blazor, [sign up for a free trial](https://www.telerik.com/blazor-ui).
2525

26-
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.
26+
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.
2727

28-
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).
28+
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).
2929

3030
An [invalid or missing license key results in app build warnings](slug:troubleshooting-license-key-errors) and watermarks in the application UI.
3131

@@ -35,7 +35,7 @@ An [invalid or missing license key results in app build warnings](slug:troublesh
3535

3636
To download and install your Telerik license key automatically, use either of the following Telerik productivity tools:
3737

38-
* <a href="https://docs.telerik.com/controlpanel/introduction" target="_blank">Telerik Control Panel</a>&mdash;this tool downloads and installs different Telerik products on your machine.
38+
* [Telerik Control Panel](https://docs.telerik.com/controlpanel/introduction)&mdash;this tool downloads and installs different Telerik products on your machine.
3939
* [Telerik UI for Blazor Visual Studio extension](slug:getting-started-vs-integration-overview)&mdash;this tool adds or upgrades Telerik UI for Blazor in new or existing apps.
4040

4141
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
8585

8686
## Frequently Asked Questions
8787

88+
### Where do I need to install a license key?
89+
90+
A Telerik license key is required on all environments that build or publish Telerik Blazor apps. This includes:
91+
92+
* Local development environments. See [Automatic Installation](#automatic-installation) and [Manual Installation](#manual-installation) above.
93+
* 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.
94+
95+
>tip A license key is not required on the web server that hosts the already deployed web application.
96+
8897
### Does the license key expire?
8998

9099
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
161170

162171
## Next Steps
163172

164-
* [Set Up the Telerik NuGet Feed](slug:installation/nuget)
165173
* [Install License Key in CI/CD Environment](slug:deployment-license-key)
174+
* [Set Up the Telerik NuGet Feed](slug:installation/nuget)
166175

167176
## See Also
168177

0 commit comments

Comments
 (0)