From d1e6a4bac695b4fcf04cdf944bad2cd77e207e14 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Thu, 28 Nov 2024 22:59:39 +0100 Subject: [PATCH] Improved various aspects of that guide. * I moved the code block for better readability. When after the list, it made things below invisible. * I added notion of UBB. * I elaborated a bit more regarding the 3 options. Especially about the CDN users. --- docs/updating/update-to-44.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/updating/update-to-44.md b/docs/updating/update-to-44.md index 4bba234ad3c..d1bb62d7f32 100644 --- a/docs/updating/update-to-44.md +++ b/docs/updating/update-to-44.md @@ -26,22 +26,25 @@ Below are the most important changes that require your attention when upgrading Version 44.0.0 introduced a change in the license configuration. The `config.licenseKey` is now a required property in the editor configuration. Whether you are using CKEditor 5 commercially or under open-source terms, you will need to specify this property in your configuration. -* **Commercial licenses**: For current users with a commercial license, you must retrieve your license key from the [Customer Portal](https://portal.ckeditor.com/) and add it to your editor configuration. [Format of the key has changed](#new-license-key-format) in this release. -* **Open-Source installations**: If you are self-hosting CKEditor 5 under the GPL terms, you will need to set `config.licenseKey` to `'GPL'` in your configuration. -* **Cloud CDN setups**: If you are using cloud-distributed CKEditor 5 delivered via our CDN, you need a license key. You can create a [free account](https://portal.ckeditor.com/checkout?plan=free). All accounts are granted a 14-day trial for Premium Features (no credit card required). - ```js ClassicEditor - .create( document.querySelector( '#editor' ), { - licenseKey: '' // Or 'GPL'. + .create( document.querySelector( '#editor' ), { + licenseKey: '' // Or 'GPL'. // ... Other configuration options ... - } ) + } ) .then( /* ... */ ) - .catch( /* ... */ ); + .catch( /* ... */ ); ``` +* **Commercial licenses**: When upgrading to version 44.0.0 or later, users with a commercial license must update their license key to the [new format](#new-license-key-format). To update your license key, log in to the [Customer Portal](https://portal.ckeditor.com/) and copy the key associated with your subscription into your editor's configuration. +* **Open-source installations**: + * **Self-hosted (npm/ZIP) installations**: If you are self-hosting CKEditor 5 under the {@link getting-started/licensing/license-and-legal GPL 2+ terms}, you need to set `config.licenseKey` to `'GPL'` in your configuration. + * **Cloud (CDN) installations**: For cloud-distributed CKEditor 5 served via [our CDN](https://cdn.ckeditor.com), you must obtain a license key from the Customer Portal. Create a [free account](https://portal.ckeditor.com/checkout?plan=free) and add the provided license key to your editor configuration. + + During the 14-day trial (automatically activated upon signup), you can explore all Premium Features. After the trial ends, usage metering and editor load limits specific to your chosen plan will apply. Learn more about [available plans](https://ckeditor.com/pricing/) and {@link getting-started/licensing/usage-based-billing usage-based billing}. + Read more in our guides about {@link getting-started/licensing/license-key-and-activation license keys} and {@link getting-started/licensing/usage-based-billing usage-based billing}. ### New license key format