diff --git a/api-reference/50 Common/Object Structures/GlobalConfig/licenseKey.md b/api-reference/50 Common/Object Structures/GlobalConfig/licenseKey.md index 1d339e1492..4f193ef372 100644 --- a/api-reference/50 Common/Object Structures/GlobalConfig/licenseKey.md +++ b/api-reference/50 Common/Object Structures/GlobalConfig/licenseKey.md @@ -7,4 +7,4 @@ type: String A license key. --- -For instructions on how to obtain a license key, refer to the following help topic: [Obtain Your License Key](/concepts/Common/Licensing/09%20Obtain%20Your%20License%20Key.md '/Documentation/Guide/Common/Licensing/#Obtain_Your_License_Key'). \ No newline at end of file +For instructions on how to obtain and register a license key, refer to the following help topic: [Obtain and Register Your License Key](/concepts/Common/Licensing/09%20Obtain%20and%20Register%20Your%20License%20Key.md '/Documentation/Guide/Common/Licensing/#Obtain_and_Register_Your_License_Key'). \ No newline at end of file diff --git a/concepts/Common/Licensing/00 Licensing.md b/concepts/Common/Licensing/00 Licensing.md index 9ab20844a2..11bbfc667e 100644 --- a/concepts/Common/Licensing/00 Licensing.md +++ b/concepts/Common/Licensing/00 Licensing.md @@ -1,34 +1,12 @@ -### Table of Contents - -- [Evaluation (Trial)](/concepts/Common/Licensing/05%20Evaluation%20(Trial).md '/Documentation/Guide/Common/Licensing/#Evaluation_Trial') - -- [Obtain Your License Key](/concepts/Common/Licensing/09%20Obtain%20Your%20License%20Key.md '/Documentation/Guide/Common/Licensing/#Obtain_Your_License_Key') - -- [Validate Your License Key](/concepts/Common/Licensing/10%20Validate%20Your%20License%20Key/00%20Validate%20Your%20License%20Key.md '/Documentation/Guide/Common/Licensing/#Validate_Your_License_Key') - -- [Deployment and Continuous Integration (CI)](/concepts/Common/Licensing/13%20Deployment%20and%20Continuous%20Integration%20(CI).md '/Documentation/Guide/Common/Licensing/#Deployment_and_Continuous_Integration_CI') - -- [Updating License Keys](/concepts/Common/Licensing/15%20Updating%20License%20Keys.md '/Documentation/Guide/Common/Licensing/#Updating_License_Keys') - -- [Information Security](/concepts/Common/Licensing/20%20Information%20Security.md '/Documentation/Guide/Common/Licensing/#Information_Security') - -- [Validation](/concepts/Common/Licensing/25%20Validation.md '/Documentation/Guide/Common/Licensing/#Validation') - -- [Redistribution](/concepts/Common/Licensing/27%20Redistribution.md '/Documentation/Guide/Common/Licensing/#Redistribution') - ---- - You must purchase a license to use DevExtreme UI components/libraries within a software project. If you are ready to incorporate DevExtreme UI components/libraries in your project, please visit the [DevExtreme Purchase](https://js.devexpress.com/Buy/) page for pricing options. -[note] For more information on product licensing and the terms that govern use of DevExtreme UI component/libraries, visit the following webpage: [DevExtreme Licensing](https://js.devexpress.com/Licensing/). - -Please remember that Developer Express Inc licenses DevExtreme on a per developer basis. Each developer using DevExtreme must purchase/acquire a license. If your organization owns multiple licenses, you can assign individual licenses to different developers. By assigning available licenses to developers within your organization, each developer will have access to their own personal license key within the DevExpress Download Manager (under their personal DevExpress account). +[note] For more information about product licensing and the terms that govern the use of DevExtreme UI components and libraries, see [DevExtreme Licensing](https://js.devexpress.com/Licensing/). -If a developer leaves or stops using DevExtreme, you can revoke their license and re-assign it to another individual. +Developer Express Inc. licenses DevExtreme on a per-developer basis. Each developer who uses DevExtreme must purchase or obtain a license. If your organization owns multiple licenses, you can assign them to individual developers. After a license is assigned, the developer can access a personal license key in the DevExpress Download Manager through their DevExpress account. -### v23.2+ +If a developer leaves or stops using DevExtreme, you can revoke their license and reassign it. -With the release of v23.2, DevExpress checks the license status to determine whether a valid DevExtreme license exists. If you do not have a valid DevExtreme license, an error message is displayed on-screen. To complete the license verification process, you must [supply a valid license key](/concepts/Common/Licensing/10%20Validate%20Your%20License%20Key/00%20Validate%20Your%20License%20Key.md '/Documentation/Guide/Common/Licensing/#Validate_Your_License_Key'). +DevExpress checks the license status to determine whether a valid DevExtreme license is available. If you do not have a valid DevExtreme license, an error message is displayed. To complete the license verification process, you must [supply a valid license key](/concepts/Common/Licensing/10%20Validate%20Your%20License%20Key.md '/Documentation/Guide/Common/Licensing/#Validate_Your_License_Key'). The process involves two steps: @@ -41,6 +19,4 @@ Regardless of the distribution channel you use — NuGet, npm, yarn, CDN — you [/note] -For complete setup instructions, refer to: [License Key for DevExpress Products](https://docs.devexpress.com/GeneralInformation/405494/trial-register/set-up-your-dev-express-license-key#manual-registration-additional-step-for-jsts-developers-devextreme) - -Should you require purchase assistance or more information on our license verification process, please contact a member of the DevExpress Client Services Team. \ No newline at end of file +For complete setup instructions, refer to: [License Key for DevExpress Products](https://docs.devexpress.com/GeneralInformation/405494/trial-register/set-up-your-dev-express-license-key#manual-registration-additional-step-for-jsts-developers-devextreme) \ No newline at end of file diff --git a/concepts/Common/Licensing/05 Evaluation (Trial).md b/concepts/Common/Licensing/05 Evaluation (Trial).md index 9f83cf2be4..eab0f63059 100644 --- a/concepts/Common/Licensing/05 Evaluation (Trial).md +++ b/concepts/Common/Licensing/05 Evaluation (Trial).md @@ -1,3 +1,3 @@ Per the terms of the End User License Agreement (EULA), you are permitted to evaluate DevExtreme components [for 30-days](https://js.devexpress.com/Download/). -During the 30-day trial period, an on-screen message and [console warning](/concepts/Common/Licensing/25%20Validation.md '/Documentation/Guide/Common/Licensing/#Validation') indicate that you are using an unlicensed version of DevExtreme. To remove these messages and use DevExtreme components in production projects, purchase a commercial license. To purchase a license and obtain your DevExpress license key, contact the DevExpress Client Services Team for assistance or visit the [DevExtreme Purchase](https://js.devexpress.com/Buy/) page. After you register the DevExpress license key, generate a DevExtreme-compatible runtime key with the `devextreme-license` CLI. \ No newline at end of file +During the 30-day trial period, an on-screen message and [console warning](/concepts/Common/Licensing/25%20Validation.md '/Documentation/Guide/Common/Licensing/#Validation') indicate that you are using an unlicensed version of DevExtreme. To remove these messages and use DevExtreme components in production projects, purchase a commercial license. To purchase a license, visit the [DevExtreme Purchase](https://js.devexpress.com/Buy/) page. For assistance, you can contact the DevExpress Client Services Team. \ No newline at end of file diff --git a/concepts/Common/Licensing/09 Obtain Your License Key.md b/concepts/Common/Licensing/09 Obtain Your License Key.md deleted file mode 100644 index 515fbc4125..0000000000 --- a/concepts/Common/Licensing/09 Obtain Your License Key.md +++ /dev/null @@ -1,5 +0,0 @@ -Log in to the [DevExpress Download Manager](https://www.devexpress.com/ClientCenter/DownloadManager/) to obtain your DevExpress license key. For full step-by-step instructions (including how to register the key on your machine and configure DevExtreme to use it), refer to the following article: - -[License Key for DevExpress Products](https://docs.devexpress.com/GeneralInformation/405494/trial-register/set-up-your-dev-express-license-key#manual-registration-obtain-and-register-your-key) - -[note] Every developer on your team must obtain and use their own key. Your DevExpress account manager should [Assign Licenses](https://www.devexpress.com/ClientCenter/LicenseManager) to developers. \ No newline at end of file diff --git a/concepts/Common/Licensing/09 Obtain and Register Your License Key.md b/concepts/Common/Licensing/09 Obtain and Register Your License Key.md new file mode 100644 index 0000000000..c42f0e7c1b --- /dev/null +++ b/concepts/Common/Licensing/09 Obtain and Register Your License Key.md @@ -0,0 +1,7 @@ +Log in to the [DevExpress Download Manager](https://www.devexpress.com/ClientCenter/DownloadManager/) to obtain your DevExpress license key. + +![Download Your DevExpress License Key](/images/Common/download-your-license-key.png) + +Register the key on your machine using one of the methods described in the [License Key for DevExpress Products](https://docs.devexpress.com/GeneralInformation/405494/trial-register/set-up-your-dev-express-license-key#manual-registration-obtain-and-register-your-key) article. + +[note] Every developer on your team must obtain and use their own key. Your DevExpress account manager should [Assign Licenses](https://www.devexpress.com/ClientCenter/LicenseManager) to developers. \ No newline at end of file diff --git a/concepts/Common/Licensing/10 Validate Your License Key/00 Validate Your License Key.md b/concepts/Common/Licensing/10 Validate Your License Key.md similarity index 71% rename from concepts/Common/Licensing/10 Validate Your License Key/00 Validate Your License Key.md rename to concepts/Common/Licensing/10 Validate Your License Key.md index a25f5eafcc..eb47143575 100644 --- a/concepts/Common/Licensing/10 Validate Your License Key/00 Validate Your License Key.md +++ b/concepts/Common/Licensing/10 Validate Your License Key.md @@ -1,6 +1,6 @@ To use DevExtreme in a licensed project, register a valid license key in your application. The process involves two steps: -1. [Obtain your DevExpress license key](/concepts/Common/Licensing/09%20Obtain%20Your%20License%20Key.md '/Documentation/Guide/Common/Licensing/#Obtain_Your_License_Key') from the DevExpress Download Manager and register it on your machine. +1. [Obtain and register your DevExpress license key](/concepts/Common/Licensing/09%20Obtain%20and%20Register%20Your%20License%20Key.md '/Documentation/Guide/Common/Licensing/#Obtain_and_Register_Your_License_Key') from the DevExpress Download Manager. 2. Use the `devextreme-license` CLI tool to generate a DevExtreme-compatible runtime key and register it in your application. For complete instructions for all supported frameworks and environments, refer to the following article: diff --git a/concepts/Common/Licensing/10 Validate Your License Key/10 Manual Configuration.md b/concepts/Common/Licensing/10 Validate Your License Key/10 Manual Configuration.md deleted file mode 100644 index 23998cda33..0000000000 --- a/concepts/Common/Licensing/10 Validate Your License Key/10 Manual Configuration.md +++ /dev/null @@ -1,4 +0,0 @@ -After you obtain your DevExpress license key and register it on your machine, use the `devextreme-license` CLI tool to generate a DevExtreme-compatible runtime key and register it in your application. The configuration differs depending on whether your project is modular (files added with `import` or `require`) or non-modular (files referenced with ` + +### Step 3: Verify Your Application + +In most cases, no application code changes are required. Verify that the runtime key is read from the correct file in the location where you pass it to [DevExpress.config(GlobalConfig)](/api-reference/50%20Common/utils/config().md '/Documentation/ApiReference/Common/Utils/#config'). + +If you previously used your license key from a custom file, use the `--out` parameter to specify a custom file path, or run `devextreme-license` without parameters (it outputs the key directly to the CLI). + +### Step 4: Configure CI/CD + +For CI/CD environments, the `prebuild` script added in Step 2 is sufficient on the build side, but you must also set your DevExpress license key in an environment variable on the build server. For complete instructions, see [Deployment and Continuous Integration (CI)](/concepts/Common/Licensing/13%20Deployment%20and%20Continuous%20Integration%20(CI).md '/Documentation/Guide/Common/Licensing/#Deployment_and_Continuous_Integration_CI'). diff --git a/concepts/Common/Licensing/13 Deployment and Continuous Integration (CI).md b/concepts/Common/Licensing/13 Deployment and Continuous Integration (CI).md index f6bdbda1c3..746f31417b 100644 --- a/concepts/Common/Licensing/13 Deployment and Continuous Integration (CI).md +++ b/concepts/Common/Licensing/13 Deployment and Continuous Integration (CI).md @@ -1,3 +1,5 @@ +You must have a valid license to distribute applications that use DevExtreme components. Our [End User License Agreement](https://www.devexpress.com/Support/EULAs/devextreme.xml) (EULA) lists the resources and files that can be redistributed to your application users. + To add DevExtreme license verification to your CI/CD processes, run the `devextreme-license` CLI tool in a pre-build step. The tool reads your DevExpress license key from an environment variable and generates a DevExtreme-compatible runtime key file. For full instructions, including an example for GitHub Actions and Secrets, refer to the following article: diff --git a/concepts/Common/Licensing/15 Updating License Keys.md b/concepts/Common/Licensing/15 Updating License Keys.md index 31aa58ddf2..8f4de67e79 100644 --- a/concepts/Common/Licensing/15 Updating License Keys.md +++ b/concepts/Common/Licensing/15 Updating License Keys.md @@ -1,13 +1,3 @@ -A license key is linked to each major version of DevExtreme. If you update a project to a new version of DevExtreme, the license key used must be updated to one linked to this new major version. +For information on version-specific license key requirements and how to update your key when upgrading DevExtreme, refer to: -A license key will work for all minor versions released within a given major release cycle - regardless of publication date. When you upgrade to a new major version, the license key must also be updated. For example: - -- v23.1.3 and v23.1.5 are two minors within the v23.1 major release cycle. If you upgrade from v23.1.3 to v23.1.5, you will not need to update license key info. - -- v23.1 and v23.2 are two different major versions. If you upgrade from v23.1.x to v23.2.x, you will need to update license key info. - -DevExtreme license keys do not expire. While license keys never expire, please remember, they are linked to major versions (v23.2, v24.1, ...). If you do not have a valid license for a given major version, you will not be authorized to use DevExtreme UI components/libraries for production projects. Visit [Renewals](https://www.devexpress.com/buy/renew/) to renew your license. - -License keys issued for newer versions of DevExtreme (such as v23.2) can be used for older versions (such as v23.1). - -[note] We do not provide license keys for early access previews (EAP), community tech previews (CTP), and betas. These pre-release versions may contain deficiencies and as such, should not be considered for production use or integrated into any mission critical application. \ No newline at end of file +[License Key for DevExpress Products — Version Errors](https://docs.devexpress.com/GeneralInformation/405494/trial-register/set-up-your-dev-express-license-key#version-errors---registered-license-key-is-outdated) \ No newline at end of file diff --git a/concepts/Common/Licensing/25 Validation.md b/concepts/Common/Licensing/25 Validation.md index c329988bb6..238a80ae86 100644 --- a/concepts/Common/Licensing/25 Validation.md +++ b/concepts/Common/Licensing/25 Validation.md @@ -2,34 +2,6 @@ When creating the first component, DevExtreme checks the license key specified in the `config()` method. If license key verification is successful, additional license-related messages are not shown within the browser console or on-screen. -If license key validation fails, DevExtreme will display one of the following messages within the browser console. +If license key validation fails, DevExtreme displays warning messages in the browser console at runtime. If the `devextreme-license` CLI cannot generate a runtime key, it reports errors directly in the CLI output. For a full list of error codes and their descriptions, refer to: - - - - - - - - - - - - - - - - - -
CaseMessage
Valid license key not found. - W0019 - DevExtreme: Unable to Locate a Valid License Key

- If you are using a 30-day trial version of DevExtreme, you must uninstall all copies of DevExtreme once your 30-day trial period expires. For terms and conditions that govern use of DevExtreme UI components/libraries, please refer to the DevExtreme End User License Agreement.

- To use DevExtreme in a commercial project, you must purchase a license. For pricing/licensing options, please visit DevExtreme Purchase page.

- If you have licensing-related questions or need help with a purchase, please email clientservices@devexpress.com. For additional information on this error message, see: W0019.
The license key has expired.W0020 - DevExtreme: License Key Has Expired

A mismatch exists between the license key used and the DevExtreme version referenced in this project.

To proceed, you can: -
    -
  • use a version of DevExtreme linked to your license key (visit the DevExpress Download Manager to validate license/version information)
    • -
  • renew your DevExpress Subscription (once you renew your subscription, you will be entitled to product updates and support services as defined in the DevExtreme End User License Agreement)
- If you have licensing-related questions or need help with a renewal, please email clientservices@devexpress.com. For additional information on this error message, see: W0020.
License key verification failed.W0021 - DevExtreme: License Key Verification Has Failed

- To verify your DevExtreme license, specify a correct key in the GlobalConfig. If you continue to encounter this error, please visit DevExpress Download Manager to obtain a valid license key.

If you have a valid license key and this problem persists, please submit a support ticket with the DevExpress Support Center. We will be happy to follow-up.

- For additional information on this error message, see: W0021. -
\ No newline at end of file +[License Key for DevExpress Products — Error Code Reference](https://docs.devexpress.com/GeneralInformation/405494/trial-register/set-up-your-dev-express-license-key#error-code-reference) \ No newline at end of file diff --git a/concepts/Common/Licensing/27 Redistribution.md b/concepts/Common/Licensing/27 Redistribution.md deleted file mode 100644 index 4cc01556c5..0000000000 --- a/concepts/Common/Licensing/27 Redistribution.md +++ /dev/null @@ -1 +0,0 @@ -Our [End User License Agreement](https://www.devexpress.com/Support/EULAs/devextreme.xml) (EULA) lists the resources and files that can be redistributed to your application users. You must have a valid license to distribute applications that use DevExtreme components. \ No newline at end of file diff --git a/images/Common/download-your-license-key.png b/images/Common/download-your-license-key.png new file mode 100644 index 0000000000..22805b0abb Binary files /dev/null and b/images/Common/download-your-license-key.png differ diff --git a/images/Common/licensing-key@2x.png b/images/Common/licensing-key@2x.png deleted file mode 100644 index ee177b6d56..0000000000 Binary files a/images/Common/licensing-key@2x.png and /dev/null differ