New to Kendo UI for Angular? Start a free 30-day trial

Setting Up Your Kendo UI for Angular License Key

This article describes how to activate the Kendo UI for Angular components by installing a personal license key.

Kendo UI for Angular is a professionally developed library distributed under a commercial license. As of December 2020, using any of the UI components from the Kendo UI for Angular library requires either a commercial license key or an active trial license key.

To follow the way modern web applications are developed, Kendo UI for Angular serves its packages through NPM. While this makes using it in Angular projects seamless, NPM hosting does not provide a way for commercial library providers to manage trial and licensed users.

Our community is very important to us and we want to make sure that licensing does not get in your way. So let us know if you experience any issues.

You can send us feedback through the Contact Us form or by opening a support ticket.

The license key installation process involves the following steps:

  1. Download a license key.
  2. Install or update your license key file in your project.
  3. Register the license key by running a CLI command.

Downloading the License Key

This section contains auto-generated content based on the license information for your account.

Please wait...To download a license key, you need to have an active developer license or trial for Kendo UI for Angular. If you already have an active license or trial, please log in here. If you are new to Kendo UI for Angular, sign up for a free trial.

Installing and Updating License Keys

  1. Copy the kendo-ui-license.txt license key file to the root folder of your application. This is the folder that contains the package.json file.

    Alternatively, copy the contents of the file to the KENDO_UI_LICENSE environment variable.

  2. Install @progress/kendo-licensing as a project dependency by running

    npm install --save @progress/kendo-licensing

    or

    yarn add @progress/kendo-licensing.

  3. Activate the license by running

    npx kendo-ui-license activate

    or

    yarn run kendo-ui-license activate.

Adding the License Key to CI Services

The license key must be present at build time. The recommended approach is to use an environment variable.

Each platform has a different process for setting environment variables. Some popular examples are listed below.

GitHub Actions

  1. Create a new Repository Secret or an Organization Secret. Set the name of the secret to KENDO_UI_LICENSE and paste the contents of the license file as a value.

  2. After running npm install or yarn, add a build step to activate the license:

    steps:
        # ... Install modules before activating the license.
        - name: Install NPM modules
          run: |
            npm install -g @angular/cli
            npm install
    
        - name: Activate Kendo UI License
          run: npx kendo-ui-license activate
          # Set a working directory if the application is not in the repository root folder:
          # working-directory: 'ClientApp'
          env:
            KENDO_UI_LICENSE: ${{ secrets.KENDO_UI_LICENSE }}
    
        # ... Run an application build after the activation of the license.
        - name: Build Application
          run: npm run build --configuration production

Azure Pipelines (YAML)

  1. Create a new User-defined Variable named KENDO_UI_LICENSE. Paste the contents of the license key file as a value.

  2. After running npm install or yarn, add a build step to activate the license.

    The following example provides the syntax for Windows build agents.

    pool:
      vmImage: 'windows-latest'
    
    steps:
    
    # ... Install modules before activating the license.
    - script: call npm install
      displayName: 'Install NPM modules'
    
    - script: call npx kendo-ui-license activate
      displayName: 'Activate Kendo UI License'
      # Set a working directory if the application is not in the repository root folder:
      # workingDirectory: 'ClientApp'
      env:
        KENDO_UI_LICENSE: $(KENDO_UI_LICENSE)
    
    # ... Run an application build after the activation of the license.
    - script: call npm run build --configuration production
      displayName: 'Build Application'

    The following example provides the syntax for Linux build agents.

    pool:
      vmImage: 'ubuntu-latest'
    
    steps:
    
    # ... Install modules before activating the license.
    - script: npm install
      displayName: 'Install NPM modules'
    
    - script: npx kendo-ui-license activate
      displayName: 'Activate Kendo UI License'
      # Set a working directory if the application is not in the repository root folder:
      # workingDirectory: 'ClientApp'
      env:
        KENDO_UI_LICENSE: $(KENDO_UI_LICENSE)
    
    # ... Run an application build after the activation of the license.
    - script: npm run build --configuration production
      displayName: 'Build Application'

Azure Pipelines (Classic)

  1. Create a new user-defined variable named KENDO_UI_LICENSE. Paste the contents of the license key file as a value.

  2. Before the NPM build task, add a new Bash task to the Agent job.

    screenshot

  3. Change the step to inline and use the following command:

    # Activate the license
    npx kendo-ui-license activate

    screenshot

Frequently Asked Questions

This section lists the answers to the most frequently asked questions (FAQs) about working with the Kendo UI for Angular license key.

Will the product function without a license key?

Yes, the product will continue to function normally without a license key. However, a warning message will appear in the browser console if a valid license key is not present.

Note that future updates of the library may restrict or disable some features when no valid license is present.

Does the license key expire?

Yes, the license key expires at the end of your support subscription:

  • For trial users, this is at the end of your 30-day trial.
  • For licensed developers, this is when your subscription expires.

You will need to obtain and install a new license key after starting a trial, renewing a license, or upgrading a license.

An expired license key is valid for all Kendo UI for Angular versions which are published before its expiration date.

Do I need an Internet connection to activate the license?

No, the license activation and validation are performed entirely offline.

No network requests are made at any point of the project lifecycle.

Do I have to add the license key to source control?

No, you do not have to add the kendo-ui-license.txt license key file or its contents to source control.

Build servers have to use the KENDO_UI_LICENSE environment variable as previously described.

Do not store the license key in plaintext, for example, in a GitHub Actions Workflow definition.

Is it possible to activate the license without executing commands?

Yes, if present, the license will be activated automatically during package installation. This applies to both the license key files and the environment variable. A diagnostic message will be printed in the npm install log.

Using the kendo-ui-license activate command is optional, but recommended in builds as it will return an error if the activation fails.

What happens if both the environment variable and the license key file are present?

If both the KENDO_UI_LICENSE environment variable and the kendo-ui-license.txt file are present, then the environment variable will be used.

To enforce the use of the license key file, unset the environment variable.

My team has more than one licensed developer. Which key do we have to use?

To activate Kendo UI for Angular you can use any of the keys associated with your subscriptions.

Are earlier versions of Kendo UI for Angular affected?

No, versions released prior to December 2020 do not require a license key.