You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _contentTemplates/common/issues-and-warnings.md
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,9 +27,7 @@ Open the Client `.csproj` file and ensure that the following switch is present.
27
27
You may find useful the following Microsoft articles on securing your NuGet feed setup and supply chain as general best practices:
28
28
29
29
* <ahref="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
-
31
30
* <ahref="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
-
33
31
* <ahref="https://docs.microsoft.com/en-us/nuget/concepts/security-best-practices"target="_blank">Best practices for a secure software supply chain - MSDN docs</a>
34
32
35
33
Telerik provides signed NuGet packages that you can verify.
Copy file name to clipboardExpand all lines: deployment/ci-cd-build-server.md
+11-10Lines changed: 11 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,8 @@ position: 5
12
12
13
13
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.
14
14
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
+
15
17
Sections in this article:
16
18
17
19
*[Basics](#basics)
@@ -38,25 +40,19 @@ You must protect your credentials and/or the Telerik packages and ensure they ar
38
40
When using Azure pipelines, we encourage you to review the following resources on setting things up:
39
41
40
42
* Blog post: [Azure DevOps and Telerik NuGet Packages](https://www.telerik.com/blogs/azure-devops-and-telerik-nuget-packages)
41
-
42
43
* Sample Repo and Video Tutorial: [Telerik DevOpsExamples by Lance McCarthy](https://github.com/LanceMcCarthy/DevOpsExamples)
43
44
44
-
>caption There are a couple of common questions and issues:
45
+
There are a couple of common questions and issues:
45
46
46
47
* Obtaining credentials - see the points above for either using your own credentials, or using a shared package source.
47
-
48
48
* 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
-
50
49
* 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/`.
51
50
52
-
>caption A few things to double check to ensure correct setup:
51
+
A few things to double check to ensure correct setup:
53
52
54
53
* The Service connection is using Basic Authentication and the URL is correct (`https://nuget.telerik.com/v3/index.json` exactly, no trailing slash).
55
-
56
54
* That Service Connection is selected as the credentials source.
57
-
58
55
* The credentials being used have a UI for Blazor license.
59
-
60
56
* Make sure that you use `dotnet restore` and not `nuget restore` in your pipeline step.
61
57
62
58
@@ -74,8 +70,8 @@ jobs:
74
70
runs-on: windows-latest
75
71
76
72
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
Copy file name to clipboardExpand all lines: deployment/ci-cd-license-key.md
+40Lines changed: 40 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,46 @@ position: 7
10
10
11
11
# Telerik License Key in CI/CD Environment
12
12
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.
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:
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
Copy file name to clipboardExpand all lines: deployment/overview.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,7 @@ position: 1
14
14
This article explains the basics of deploying a Telerik-enabled Blazor web application. It consists of the following sections:
15
15
16
16
*[Prerequisites](#prerequisites)
17
+
*[License Key](#license-key)
17
18
*[Telerik Components](#telerik-components)
18
19
*[Next Steps and Troubleshooting](#next-steps-and-troubleshooting)
19
20
@@ -27,6 +28,9 @@ Refer to the Microsoft Blazor deployment documentation and make sure you can dep
27
28
*[Host and deploy Blazor Server apps](https://learn.microsoft.com/en-us/aspnet/core/blazor/host-and-deploy/server)
28
29
*[Host and deploy Blazor WebAssembly apps](https://learn.microsoft.com/en-us/aspnet/core/blazor/host-and-deploy/webassembly)
29
30
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).
Copy file name to clipboardExpand all lines: installation/license-key.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ position: 1
12
12
13
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.
14
14
15
-
>tip This article applies to Telerik UI for Blazor version **7.2.0** and above.
@@ -36,7 +36,7 @@ To download and install the license key automatically, use one of the following
36
36
37
37
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.
38
38
39
-
>tip Update the license key [whenever necessary](#updates).
39
+
>tip Update the license key [whenever necessary](#license-key-updates).
40
40
41
41
## Manual Installation
42
42
@@ -50,13 +50,13 @@ To download and install a license key file manually:
50
50
51
51
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.
52
52
53
-
>tip Update the license key [whenever necessary](#updates).
53
+
>tip Update the license key [whenever necessary](#license-key-updates).
54
54
55
55
>warning The license key file is personal and confidential. Do not commit this file to source control!
56
56
57
-
## Updates
57
+
## License Key Updates
58
58
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*.
60
60
61
61
* 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).
62
62
* 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
A Telerik license key error may occur in the following scenarios:
18
20
19
-
*Using a perpetual license with a product version that was released outside the validity period of your license.
21
+
*Missing license key.
20
22
* 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.
21
24
* 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.
25
29
26
30
## Error Messages
27
31
@@ -42,13 +46,13 @@ Follow the [automatic](slug://installation-license-key#automatic-installation) o
42
46
43
47
### Your subscription license has expired
44
48
45
-
<ahref="https://www.telerik.com/account/your-licenses"target="_blank">Renew your subscribtion</a>. Then, [update your license key](slug://installation-license-key).
49
+
<ahref="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).
46
50
47
51
### Your perpetual license is invalid
48
52
49
53
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:
50
54
51
-
* <ahref="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
+
* <ahref="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).
52
56
* Downgrade your app to a Telerik UI for Blazor version that was released within the subscription period of your perpetual license.
53
57
54
58
### Your trial license has expired
@@ -57,8 +61,9 @@ You are using a product version released outside the validity period of your per
57
61
58
62
### Your license is not valid for the detected product(s)
59
63
60
-
<ahref="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
+
<ahref="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).
61
65
62
66
## See Also
63
67
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