Skip to content

Commit 01b578b

Browse files
committed
Licensing docs continued
1 parent f7804e3 commit 01b578b

File tree

7 files changed

+80
-25
lines changed

7 files changed

+80
-25
lines changed

_contentTemplates/common/get-started.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,3 +179,9 @@ You can learn more about the [`TelerikRootComponent` purpose and usage](slug://r
179179
}
180180
</style>
181181
#end
182+
183+
#license-key-version
184+
185+
@[template](/_contentTemplates/common/get-started.md#license-key-version)
186+
187+
#end

_contentTemplates/common/issues-and-warnings.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,7 @@ Open the Client `.csproj` file and ensure that the following switch is present.
2727
You may find useful the following Microsoft articles on securing your NuGet feed setup and supply chain as general best practices:
2828

2929
* <a href="https://devblogs.microsoft.com/nuget/lock-down-your-dependencies-using-configurable-trust-policies/" target="_blank">Lock down your dependencies using configurable trust policies - Blog Post</a>
30-
3130
* <a href="https://devblogs.microsoft.com/nuget/how-to-scan-nuget-packages-for-security-vulnerabilities/" target="_blank">How to Scan NuGet Packages for Security Vulnerabilities - Blog Post</a>
32-
3331
* <a href="https://docs.microsoft.com/en-us/nuget/concepts/security-best-practices" target="_blank">Best practices for a secure software supply chain - MSDN docs</a>
3432

3533
Telerik provides signed NuGet packages that you can verify.

deployment/ci-cd-build-server.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ position: 5
1212

1313
This article explains some concepts and how to troubleshoot the most common errors related to setting up the Telerik NuGet packages for automated builds, CI and CD.
1414

15+
> Telerik license keys are outside the scope of this article. Refer to article [Telerik License Key in CI/CD](slug://deployment-license-key)
16+
1517
Sections in this article:
1618

1719
* [Basics](#basics)
@@ -38,25 +40,19 @@ You must protect your credentials and/or the Telerik packages and ensure they ar
3840
When using Azure pipelines, we encourage you to review the following resources on setting things up:
3941

4042
* Blog post: [Azure DevOps and Telerik NuGet Packages](https://www.telerik.com/blogs/azure-devops-and-telerik-nuget-packages)
41-
4243
* Sample Repo and Video Tutorial: [Telerik DevOpsExamples by Lance McCarthy](https://github.com/LanceMcCarthy/DevOpsExamples)
4344

44-
>caption There are a couple of common questions and issues:
45+
There are a couple of common questions and issues:
4546

4647
* Obtaining credentials - see the points above for either using your own credentials, or using a shared package source.
47-
4848
* Telerik feed not being found - the most common reason for a problem is that the path to the `NuGet.Config` file is wrong (it should, by default, be at the root level).
49-
5049
* An `index.json not found` error can occur from many root causes. If you have successfully authenticated, this error usually means that the feed wasn't able to be searched or connected to. A common reason is an incorrect feed URL, such as including a trailing slash - Correct: `https://nuget.telerik.com/v3/index.json` and Incorrect: `https://nuget.telerik.com/v3/index.json/`.
5150

52-
>caption A few things to double check to ensure correct setup:
51+
A few things to double check to ensure correct setup:
5352

5453
* The Service connection is using Basic Authentication and the URL is correct (`https://nuget.telerik.com/v3/index.json` exactly, no trailing slash).
55-
5654
* That Service Connection is selected as the credentials source.
57-
5855
* The credentials being used have a UI for Blazor license.
59-
6056
* Make sure that you use `dotnet restore` and not `nuget restore` in your pipeline step.
6157

6258

@@ -74,8 +70,8 @@ jobs:
7470
runs-on: windows-latest
7571
7672
env:
77-
TELERIK_USERNAME: ${ { secrets.MyTelerikAccountUsername } } # remove the space between the brackets
78-
TELERIK_PASSWORD: ${ { secrets.MyTelerikAccountPassword } } # remove the space between the brackets
73+
TELERIK_USERNAME: ${ { secrets.MyTelerikAccountUsername } } # remove the spaces between the brackets
74+
TELERIK_PASSWORD: ${ { secrets.MyTelerikAccountPassword } } # remove the spaces between the brackets
7975
8076
````
8177

@@ -139,6 +135,11 @@ RUN dotnet build "./MyBlazorApp.csproj" -c Release -o /app/build
139135
````
140136

141137

138+
## Next Steps
139+
140+
* [Set Up Telerik License Key in CI/CD Environment](slug://deployment-license-key)
141+
142+
142143
## Further Reading
143144

144145
@[template](/_contentTemplates/common/issues-and-warnings.md#nuget-security-links)

deployment/ci-cd-license-key.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,46 @@ 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 CI/CD services by using environment variables.
14+
15+
@[template](/_contentTemplates/common/get-started.md#license-key-version)
16+
17+
## Basics
18+
19+
When working with CI/CD platforms, always add the [`Telerik.Licensing` NuGet package](slug://getting-started/what-you-need#nuget-packages) as a project dependency. This package activates the Telerik Blazor components at build time by using the provided license key.
20+
21+
The license activation process in a CI/CD environment involves the following steps:
22+
23+
1. Add the `Telerik.Licensing` NuGet package as a dependency to all projects that reference Telerik UI for Blazor or Telerik Document Processing:
24+
````XML.skip-repl
25+
<PackageReference Include="Telerik.Licensing" Version="1.*" />
26+
````
27+
1. Go to the <a href="https://www.telerik.com/account/your-licenses/license-keys" target="_blank">License Keys page</a> in your Telerik account and get your license key.
28+
1. Set your license key value as an environment variable with a name `TELERIK_LICENSE`.
29+
30+
## Creating Environment Variables
31+
32+
The recommended way to provide your license key to the `Telerik.Licensing` NuGet package in CI/CD environment is to use environment variables. Each CI/CD platform has a different process for setting environment variables. This article lists only some of the most popular examples.
33+
34+
### Azure Pipelines (YAML)
35+
36+
1. Create a new <a href="https://docs.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch" target="_blank">user-defined variable</a> named `TELERIK_LICENSE`.
37+
1. Paste the contents of the license key file as a value.
38+
39+
### Azure Pipelines (Classic)
40+
41+
1. Create a new <a href="https://docs.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=classic%2Cbatch" target="_blank">user-defined variable</a> named `TELERIK_LICENSE`.
42+
1. Paste the contents of the license key file as a value.
43+
44+
### GitHub Actions
45+
46+
1. Create a new <a href="https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository" target="_blank">Repository Secret</a> or an <a href="https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-an-organization" target="_blank">Organization Secret</a>.
47+
1. Set the name of the secret to `TELERIK_LICENSE` and paste the contents of the license file as a value.
48+
1. After running `npm install` or `yarn`, add a build step to activate the license:
49+
````YAML
50+
env:
51+
TELERIK_LICENSE: ${ { secrets.TELERIK_LICENSE } } # remove the spaces between the brackets
52+
````
1353
1454
## Next Steps
1555

deployment/overview.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ position: 1
1414
This article explains the basics of deploying a Telerik-enabled Blazor web application. It consists of the following sections:
1515

1616
* [Prerequisites](#prerequisites)
17+
* [License Key](#license-key)
1718
* [Telerik Components](#telerik-components)
1819
* [Next Steps and Troubleshooting](#next-steps-and-troubleshooting)
1920

@@ -27,6 +28,9 @@ Refer to the Microsoft Blazor deployment documentation and make sure you can dep
2728
* [Host and deploy Blazor Server apps](https://learn.microsoft.com/en-us/aspnet/core/blazor/host-and-deploy/server)
2829
* [Host and deploy Blazor WebAssembly apps](https://learn.microsoft.com/en-us/aspnet/core/blazor/host-and-deploy/webassembly)
2930

31+
## License Key
32+
33+
Before building a Telerik Blazor app in a CI/CD environment, [set up a Telerik license key in CI/CD](slug://deployment-license-key). The process is different than in a [local development environment](slug://installation-license-key).
3034

3135
## Telerik Components
3236

installation/license-key.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ position: 1
1212

1313
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.
1414

15-
>tip This article applies to Telerik UI for Blazor version **7.2.0** and above.
15+
@[template](/_contentTemplates/common/get-started.md#license-key-version)
1616

1717
## Basics
1818

@@ -36,7 +36,7 @@ To download and install the license key automatically, use one of the following
3636

3737
Any of the above two tools will install a license key for you and make it available for all projects that you develop on your local machine.
3838

39-
>tip Update the license key [whenever necessary](#updates).
39+
>tip Update the license key [whenever necessary](#license-key-updates).
4040
4141
## Manual Installation
4242

@@ -50,13 +50,13 @@ To download and install a license key file manually:
5050

5151
The above step will make the license key available to all projects that you develop on your local machine. If you need to activate Telerik UI for Blazor only in a specific app, then save `telerik-license.txt` to the root folder of your project or solution.
5252

53-
>tip Update the license key [whenever necessary](#updates).
53+
>tip Update the license key [whenever necessary](#license-key-updates).
5454
5555
>warning The license key file is personal and confidential. Do not commit this file to source control!
5656
57-
## Updates
57+
## License Key Updates
5858

59-
Whenever you renew or purchase a new Telerik product, always download and install a new license key. The new license key includes information about all previous purchases. This process is referred to as a *license key update*.
59+
Whenever you renew or purchase a new Telerik license, always install a new license key. The new license key includes information about all previous purchases. This process is referred to as a *license key update*.
6060

6161
* If you used [automatic license key installation](#automatic-installation), then open the tool that you used to download and install the license key file. You can also update the license key file by using the [manual steps above](#manual-installation).
6262
* If you used the [manual license key installation](#manual-installation), then repeat the same steps.
@@ -68,5 +68,6 @@ Whenever you renew or purchase a new Telerik product, always download and instal
6868

6969
## See Also
7070

71+
* [Troubleshoot License Key Errors](slug://troubleshooting-license-key-errors)
7172
* [Get Started with a Blazor Web App](slug://getting-started/web-app)
7273
* [Workflow Details for Telerik UI for Blazor](slug://getting-started/what-you-need)

troubleshooting/license-key-errors.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,20 @@ position: 3
1212

1313
This page provides solutions for license key errors that you may encounter while building Telerik Blazor apps.
1414

15+
@[template](/_contentTemplates/common/get-started.md#license-key-version)
16+
1517
## Basics
1618

1719
A Telerik license key error may occur in the following scenarios:
1820

19-
* Using a perpetual license with a product version that was released outside the validity period of your license.
21+
* Missing license key.
2022
* Using an expired subscription license after the end of the subscription term.
23+
* Using a perpetual license with a product version that was released outside the validity period of your license.
2124
* Using an expired trial license.
22-
* Missing license key. [Install a license key file](slug://installation-license-key). If you already downloaded it, make sure it's [saved at the right place](slug://installation-license-key#manual-installation).
23-
* Using an outdated license key. Always [update your license key](slug://installation-license-key#updates) after renewing your licenses or purchasing additional Telerik products.
24-
* Using a license key that doesn't include Telerik UI for Blazor. If you already have a commercial or trial Telerik UI for Blazor license, then [update your license key](slug://installation-license-key#updates). Otherwise, purchase or renew Telerik UI for Blazor, or start a trial to evaluate the product.
25+
* Using an outdated license key after making renewals or purchases.
26+
* Using a license key that doesn't include Telerik UI for Blazor.
27+
28+
Refer to the error messages below for specific tips.
2529

2630
## Error Messages
2731

@@ -42,13 +46,13 @@ Follow the [automatic](slug://installation-license-key#automatic-installation) o
4246

4347
### Your subscription license has expired
4448

45-
<a href="https://www.telerik.com/account/your-licenses" target="_blank">Renew your subscribtion</a>. Then, [update your license key](slug://installation-license-key).
49+
<a href="https://www.telerik.com/account/your-licenses" target="_blank">Renew your subscribtion</a>. Then, [update your license key](slug://installation-license-key#license-key-updates).
4650

4751
### Your perpetual license is invalid
4852

4953
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:
5054

51-
* <a href="https://www.telerik.com/account/your-licenses" target="_blank">Renew your subscribtion</a>. Then, [download and install a new license key](slug://installation-license-key).
55+
* <a href="https://www.telerik.com/account/your-licenses" target="_blank">Renew your subscribtion</a>. Then, [update your license key](slug://installation-license-key#license-key-updates).
5256
* Downgrade your app to a Telerik UI for Blazor version that was released within the subscription period of your perpetual license.
5357

5458
### Your trial license has expired
@@ -57,8 +61,9 @@ You are using a product version released outside the validity period of your per
5761

5862
### Your license is not valid for the detected product(s)
5963

60-
<a href="https://www.telerik.com/purchase/blazor-ui" target="_blank">Review the purchase options for Telerik UI for Blazor</a>. Then, [update your license key](slug://installation-license-key).
64+
<a href="https://www.telerik.com/purchase/blazor-ui" target="_blank">Review the purchase options for Telerik UI for Blazor</a>. Then, [update your license key](slug://installation-license-key#license-key-updates).
6165

6266
## See Also
6367

64-
* [Prevent browser caching during version upgrades](slug://common-kb-browser-cache-buster)
68+
* [Download and Install License Key](slug://installation-license-key)
69+
* [Use License Keys in CI/CD](slug://deployment-license-key)

0 commit comments

Comments
 (0)