Skip to content

Commit 65b2453

Browse files
committed
docs(licensing): improve explanation of license file vs script key activation
1 parent f16c217 commit 65b2453

File tree

1 file changed

+46
-10
lines changed

1 file changed

+46
-10
lines changed

licensing/license-key.md

Lines changed: 46 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,29 +9,44 @@ position: 1
99

1010
# Setting Up Your Telerik UI for ASP.NET AJAX License Key
1111

12-
Starting with **2025 Q1**, Telerik UI for ASP.NET AJAX requires activation through a License Key. The `Telerik.Web.UI.dll` assembly now depends on `Telerik.Licensing.Runtime.dll` which can be obtained from NuGet ([https://www.nuget.org/packages/Telerik.Licensing](https://www.nuget.org/packages/Telerik.Licensing)) or from the Telerik UI for ASP.NET AJAX installations.
12+
Starting with **2025 Q1**, Telerik UI for ASP.NET AJAX requires activation through a License Key. The `Telerik.Web.UI.dll` assembly now depends on `Telerik.Licensing.Runtime.dll`, available via NuGet ([https://www.nuget.org/packages/Telerik.Licensing](https://www.nuget.org/packages/Telerik.Licensing)) or the Telerik UI for ASP.NET AJAX installations.
1313

14-
This article describes how to download your personal license key and use it to activate the Telerik UI for ASP.NET AJAX components.
14+
This article shows how to download your personal license key and activate Telerik UI for ASP.NET AJAX.
1515

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.
16+
If the license is missing or invalid, you will see [errors and warnings]({%slug licensing/license-errors-warnings%}) during build and run-time, such as watermarks and banners.
1717

18-
## Setup your License Key
18+
## Choose your licensing method
1919

20-
Due to the differences between `Web Application Project` and `Web Site Project`, the steps to activate the license will differ.
20+
Because Web Application and Web Site projects differ in structure, the activation steps also differ. Use the table below to quickly pick the correct method.
2121

22-
`Web Application Projects` have a `.csproj`/`.vbproj` file, whereas the `Web Site Projects` do not. For more details about the differences you can check out the following Microsoft documentation article: [Web Application Projects versus Web Site Projects in Visual Studio](https://learn.microsoft.com/en-us/previous-versions/aspnet/dd547590(v=vs.110)?redirectedfrom=MSDN).
22+
| Project type | Using NuGet | License method |
23+
|-----------------|-------------|--------------------------------------|
24+
| Web Application | Yes | License file (`telerik-license.txt`) |
25+
| Web Application | No | Script key in `AssemblyInfo` |
26+
| Web Site | No | Script key in `App_Code` |
27+
28+
> Quick check: If your project contains a `.csproj` or `.vbproj` file, it is a Web Application. Otherwise, it is a Web Site project. For additional background, see:
29+
> - [Microsoft guidance: Web Application vs Web Site](https://learn.microsoft.com/en-us/previous-versions/aspnet/dd547590(v=vs.110)?redirectedfrom=MSDN)
30+
> - [Web Site vs Web Application - Key Differences](https://www.youtube.com/watch?v=9gI6t57cDAc)
31+
32+
33+
Now follow the activation steps for your project type:
2334

2435
### Web Applications using NuGet
2536

26-
Only for Web Application projects that have the `Telerik.UI.for.AspNet.Ajax.Net462` and `Telerik.Licensing` packages installed from NuGet, can be activated using a License File. Otherwise, an assembly attribute is required, see [Web Applications without NuGet and Web Sites](#web-applications-without-nuget-and-web-sites) section.
37+
Only Web Application projects that have the `Telerik.Licensing` package installed from NuGet can be activated using a license file (`telerik-license.txt`). Otherwise, a Script key (assembly attribute) is required, see [Web Applications without NuGet and Web Sites](#web-applications-without-nuget-and-web-sites) section.
2738

2839
To download and install your Telerik license key file:
2940

3041
1. Go to the [License Keys](https://www.telerik.com/account/your-licenses/license-keys) page in your Telerik account.
3142
2. Click the **Download License Key** button.
3243
3. Save the `telerik-license.txt` file to your user profile directory `%AppData%\Telerik\telerik-license.txt`, for example, `C:\Users\...\AppData\Roaming\Telerik\telerik-license.txt`
3344

34-
>This will make the license key available to all Telerik applications that you develop on your local machine. If you need to activate Telerik UI for ASP.NET AJAX only in a specific application, save the `telerik-license.txt` to the root folder of this project or solution.
45+
> This makes the license available to all Telerik applications on the local machine.
46+
> To scope the license to a single project or solution, place `telerik-license.txt` in the root folder of that project or solution.
47+
> The telerik-license.txt is applied during build and does not need to be deployed to the production server.
48+
49+
3550

3651
### Web Applications without NuGet and Web Sites
3752

@@ -44,14 +59,35 @@ Web Applications projects that do not use NuGet and Web Site projects require an
4459
- **Web Application**: Paste the copied key to the `Properties > AssemblyInfo` (C# Apps) or `My Project > AssemblyInfo` (VB Apps)
4560
- **Web Site**: Add a C#/VB Class file to the `App_Code` directory of your project, e.g. `App_Code\TelerikLicense.cs` and paste the Script Key from your clipboard.
4661

47-
>To activate the license in other projects, repeat these steps.
62+
> To activate the license in other projects, repeat these steps.
63+
64+
### License file vs Script key
65+
- **License file** - supported for Web Application projects that use NuGet. It enables license validation during build and runtime.
66+
- **Script key** - required for Web Applications that do not use NuGet and for Web Site projects.
67+
68+
> The license file method does not work for Web Site projects or for Web Applications that do not use NuGet. Use the Script key in these cases.
69+
70+
### How the license is applied based on project type
71+
72+
| Project Type | How license is applied | File needed on production server |
73+
|--------------|------------------------|----------------------------------|
74+
| Web Application using NuGet | License file (telerik-license.txt) is resolved at build time and embedded by the licensing tooling | ❌ No |
75+
| Web Application without NuGet | Script key attribute is compiled into the assembly | ❌ No |
76+
| Web Site Project | Script key file in `App_Code` is evaluated at runtime | ✅ Yes |
77+
78+
79+
> **Explanation**
80+
> - NuGet Web Applications use the `telerik-license.txt` only on the development machine. The license is embedded during build.
81+
> - Web Applications without NuGet embed the license via an assembly attribute (e.g., in `AssemblyInfo.cs` or `TelerikLicense.cs`).
82+
> - Web Site projects cannot embed attributes into a compiled assembly, so the license file must remain in `App_Code` on the server.
83+
4884

4985
## See Also
5086

5187
* [License Activation Errors and Warnings]({%slug licensing/license-errors-warnings%})
5288
* [Adding the License Key to CI Services]({%slug licensing/add-license-to-ci-cd%})
5389
* [Frequently Asked Questions about Your Telerik UI for ASP.NET AJAX License Key]({%slug licensing/licensing-faq%})
54-
* [ASP.NET Web Forms Web Site vs Web Application in Visual Studio - Key Differences Explained](https://www.youtube.com/watch?v=9gI6t57cDAc&t=5s)
90+
* [ASP.NET Web Forms Web Site vs Web Application in Visual Studio - Key Differences Explained](https://www.youtube.com/watch?v=9gI6t57cDAc)
5591
* [Fix Telerik UI for ASP.NET AJAX License Error Banner & Watermarks (the NuGet approach)](https://www.youtube.com/watch?v=6qvHlqdgEg0)
5692
* [Fix Telerik UI License Error in ASP.NET Web Forms site via EvidenceAttribute (App_Code & Precompile)](https://www.youtube.com/watch?v=UFPV-gFozPE)
5793
* [Removing the Telerik AJAX license error and watermark in ASP.NET Web Forms application](https://www.youtube.com/watch?v=rKvQ3dpPEIw)

0 commit comments

Comments
 (0)