Skip to content

Commit 6413415

Browse files
committed
docs(licensing): refactor and move new licensing files to a new location
1 parent 9f17375 commit 6413415

File tree

8 files changed

+174
-148
lines changed

8 files changed

+174
-148
lines changed

getting-started/activating-your-license/license-key-errors.md

-67
This file was deleted.

getting-started/activating-your-license/setting-up-your-license.md

-68
This file was deleted.

licensing/add-license-to-ci-cd.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: Adding Your License Key to CI Services
3+
page_title: Adding Your License Key to CI Services
4+
description: Learn how to activate the Telerik UI for ASP.NET AJAX components by downloading and setting up your Telerik components license key for use in CI/CD environments.
5+
slug: licensing/add-license-to-ci-cd
6+
tags: telerik,webforms,components,license,activate,download,ci,cd,environment
7+
position: 2
8+
---
9+
10+
# Adding Your License Key to CI/CD Services
11+
12+
This article describes how to set up and activate your Telerik UI for ASP.NET AJAX [license key]({%slug licensing/license-key%}) across a few popular CI/CD services by using environment variables.
13+
14+
When working with CI/CD platforms, always add the `Telerik.Licensing` NuGet package as a project dependency. This package activates the Telerik UI for ASP.NET AJAX components at build time by using the provided license key.
15+
16+
> If you cannot use NuGet packages in your project, see the workaround in the [Adding Your License Key to CI Platforms as a Code Snippet]({%slug licensing-add-license-as-snippet-ci-cd%}) KB article.
17+
The license activation process in a CI/CD environment involves the following steps:
18+
19+
1. [Download]({%slug licensing/license-key%}) a license key from your Telerik account.
20+
21+
1. Add the `Telerik.Licensing` NuGet package as a project dependency.
22+
23+
```
24+
<PackageReference Include="Telerik.Licensing" Version="1.*" />
25+
```
26+
1. [Create an environment variable](#creating-an-environment-variable) named `TELERIK_LICENSE` and add your Telerik UI for ASP.NET AJAX license key as a value.
27+
## Creating an Environment Variable
28+
The recommended approach for providing your license key to the `Telerik.Licensing` NuGet package is to use environment variables. Each CI/CD platform has a different process for setting environment variables and this article lists only some of the most popular examples.
29+
### Azure Pipelines (YAML)
30+
1. Create a new [user-defined variable](https://docs.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch) named `TELERIK_LICENSE`.
31+
1. Paste the contents of the license key file as a value.
32+
### Azure Pipelines (Classic)
33+
1. Create a new [user-defined variable](https://docs.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=classic%2Cbatch) named `TELERIK_LICENSE`.
34+
1. Paste the contents of the license key file as a value.
35+
### GitHub Actions
36+
1. Create a new [Repository Secret](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository) or an [Organization Secret](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-an-organization).
37+
1. Set the name of the secret to `TELERIK_LICENSE` and paste the contents of the license file as a value.
38+
1. After running npm install or yarn, add a build step to activate the license:
39+
```YAML
40+
env:
41+
TELERIK_LICENSE: ${{ secrets.TELERIK_LICENSE }}
42+
```
43+
44+
## See Also
45+
46+
* [Setting Up Your License Key]({%slug licensing/license-key%})
47+
* [License Activation Errors and Warnings]({%slug licensing/license-errors-warnings%})
48+
* [Frequently Asked Questions about Your Telerik UI forASP.NET AJAX License Key]({%slug licensing/licensing-faq%})
9.36 KB
Loading

licensing/images/view-script-key.png

5.48 KB
Loading

licensing/license-errors-warnings.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: License Activation Errors and Warnings
3+
page_title: Telerik License Activation Errors and Warnings
4+
description: Troubleshooting Telerik license key errors when using UI for ASP.NET AJAX.
5+
slug: licensing/license-errors-warnings
6+
tags: license, key, error, warning, troubleshooting
7+
position: 4
8+
---
9+
10+
# License Activation Errors and Warnings
11+
12+
Starting with the 2025 Q1 release, using Telerik UI for ASP.NET AJAX without a license or with an invalid license causes specific license warnings and errors. This article defines what an invalid license is, explains what is causing it, and describes the related license warnings and errors.
13+
14+
## Invalid License
15+
16+
An invalid license can be caused by any of the following:
17+
18+
* Using an expired subscription license—subscription licenses expire at the end of the subscription term.
19+
* Using a perpetual license for product versions released outside the validity period of your license.
20+
* Using an expired trial license.
21+
* A missing license for Telerik UI for ASP.NET AJAX.
22+
* Not installing a license key in your application.
23+
* Not updating the license key after renewing your Telerik UI for ASP.NET AJAX license.
24+
25+
## License Warnings and Errors
26+
27+
When using Telerik UI for ASP.NET AJAX in a project with an expired or missing license, the `Telerik.Licensing` build task will indicate the following errors:
28+
29+
30+
| Error or Condition | Solution |
31+
| --- | --- |
32+
| `No license key is detected` | [Set up a license key]({%slug licensing/license-key%}) to activate the UI controls and remove the error message. |
33+
| `Invalid license key` | [Download a new license key]({%slug licensing/license-key%}#downloading-the-license-key) and use it to activate the UI controls and remove the error message. |
34+
| `Your subscription license has expired.` | Renew your subscription and [download a new license key]({%slug licensing/license-key%}#downloading-the-license-key). |
35+
| `Your perpetual license is invalid.` | You are using a product version released outside the validity period of your perpetual license. To remove the error message, do either of the following: |
36+
| | - Renew your license, then download a new license key and use it to activate the controls. |
37+
| | - Downgrade to a product version included in your perpetual license as indicated in the message. |
38+
| `Your trial license has expired.` | Purchase a commercial license to continue using the product. |
39+
| `Your license is not valid for the detected product(s).` | Review the purchase options for the listed products. Alternatively, remove the references to the listed packages from `package.json`. |
40+
41+
## See Also
42+
43+
* [Setting Up Your License Key]({%slug licensing/license-key%})
44+
* [Adding the License Key to CI Services]({%slug licensing/add-license-to-ci-cd%})
45+
* [Frequently Asked Questions about Your Telerik UI for ASP.NET AJAX License Key]({%slug licensing/licensing-faq%})

licensing/license-key.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: Setting Up Your License Key
3+
page_title: Setting Up Your License Key File
4+
description: Learn how to install a Telerik license key file, which is required during application building and deployment.
5+
slug: licensing/license-key
6+
tags: installation, license, key
7+
position: 1
8+
---
9+
10+
# Setting Up Your Telerik UI for ASP.NET AJAX License Key
11+
12+
>Starting with the **2025 Q1** release, the UI components from the Telerik UI for ASP.NET AJAX library require activation through a license key (trial or commercial).
13+
14+
This article describes how to download your personal license key and use it to activate the Telerik UI for ASP.NET AJAX components.
15+
16+
A missing or invalid license results in [errors and warnings]({%slug licensing/license-errors-warnings%}) during build and run-time indicators such as watermarks and banners.
17+
18+
## Downloading the License Key
19+
20+
>warning The license key file is personal and confidential. Do not commit this file to source control and do not save it to a publicly accessible location!
21+
22+
To download a license key for Telerik UI for ASP.NET AJAX, you must have either a developer license or a trial license. If you are new to Telerik UI for ASP.NET AJAX, [sign up for a free trial](https://www.telerik.com/aspnet-ajax) first, and then follow the steps below:
23+
24+
1. Go to the [License Keys](https://www.telerik.com/account/your-licenses/license-keys?_gl=1*cgbz4c*_gcl_au*MTIyNTMyNzI1My4xNzMyMDI2NzU3*_ga*MjAyMTI5MTQ4MS4xNzMyMDI2NzU1*_ga_9JSNBCSF54*MTczOTM0ODI2NS4xNi4xLjE3MzkzNTkxMTcuNTMuMC4w) page in your Telerik account.
25+
2. Click the **Download License Key** button.
26+
!["Download License Key"](images/download-license-key.png "Download License Key")
27+
3. Next, [Activate your Telerik UI for ASP.NET AJAX components](#activating-the-telerik-ui-for-asp-net-ajax-components).
28+
29+
The [Progress Control Panel](https://docs.telerik.com/controlpanel/introduction), [automated installers]({%slug getting-started/installation/installing-the-telerik-controls-from-msi-file%}), and the [Visual Studio Extensions]({%slug introduction/radcontrols-for-asp.net-ajax-fundamentals/integration-with-visual-studio/visual-studio-extensions/overview%}) will automatically download and store your license key in your home directory. This makes it available for all projects that you develop on your local machine.
30+
31+
## Activating the Telerik UI for ASP.NET AJAX Components
32+
33+
>important If your project doesn’t use NuGet packages, or you have a Web Site project, follow the instructions from the [Installing a License Key in Projects without NuGet References](#installing-a-license-key-in-projects-without-nuget-references) section.
34+
35+
To activate the Telerik UI for ASP.NET AJAX controls:
36+
37+
- Copy the downloaded `telerik-license.txt` license key file to your home directory. This makes the license key available to all projects that you develop on your computer:
38+
- For Windows: `%AppData%\Telerik\telerik-icense.txt`
39+
- For Mac/Linux: `~/.telerik/telerik-license.txt`
40+
- Alternatively, copy the `telerik-license.txt` license key file to the root folder of your project. This makes the license key available only to this project. Do not commit the file to source control as this is your personal license key.
41+
42+
When you build the project, the `Telerik.Licensing` NuGet package automatically locates the license file and uses it to activate the WebForms controls.
43+
44+
## Installing a License Key in Projects without NuGet References
45+
46+
Telerik strongly recommends the use of NuGet packages whenever possible. Only include the license key as a code snippet when NuGet packages are not an option.
47+
48+
1. If you cannot use NuGet packages in your project, add the license as a code snippet:
49+
2. Go to the [License Keys](https://www.telerik.com/account/your-licenses/license-keys) page in your Telerik account.
50+
3. On the Telerik UI for ASP.NET AJAX row, click the **View key** link in the **SCRIPT KEY** column.
51+
!["Alt Text"](images/view-script-key.png "Alt Text")
52+
4. Copy the C# code snippet into a new file, for example, `TelerikLicense.cs`.
53+
5. Add the `TelerikLicense.cs` file to your project.
54+
- In case of Web Site project, add the file to the `App_Code` folder.
55+
56+
## See Also
57+
58+
* [License Activation Errors and Warnings]({%slug licensing/license-errors-warnings%})
59+
* [Adding the License Key to CI Services]({%slug licensing/add-license-to-ci-cd%})
60+
* [Frequently Asked Questions about Your Telerik UI for ASP.NET AJAX License Key]({%slug licensing/licensing-faq%})

0 commit comments

Comments
 (0)