Skip to content

Commit 44a2291

Browse files
committed
DOC-3226: Change readonly to disabled. Add new messages.
1 parent ad0860d commit 44a2291

File tree

1 file changed

+34
-13
lines changed

1 file changed

+34
-13
lines changed

modules/ROOT/pages/license-key.adoc

Lines changed: 34 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
====
1111
{productname} is licensed under the GNU General Public License Version 2 or later. A configuration option called `+'license_key'+` introduced in {productname} 7 requires developers to make a conscious decision to use {productname} with the GPLv2+ license or with a commercial license.
1212
13-
When using {productname} 8 in a self-hosted environment, a license key must be provided and it must be valid. Otherwise, the editor will be set to readonly. A license key is not required when loading {productname} from {cloudname}, as it is already under a commercial license.
13+
When using {productname} 8 in a self-hosted environment, a license key must be provided and it must be valid. Otherwise, the editor will be disabled. A license key is not required when loading {productname} from {cloudname}, as it is already under a commercial license.
1414
1515
In addition, when using {productname} 8 in a self-hosted environment for commercial use, a commercial license key manager addon is required in order for the editor to operate.
1616
====
@@ -134,12 +134,12 @@ a|
134134

135135
| Expired
136136
a|
137-
* Editor is set to readonly
137+
* Editor is disabled
138138
* Must obtain a new license key to continue using {productname}
139139
| Time-based keys only
140140
| Invalid
141141
a|
142-
* Editor is set to readonly
142+
* Editor is disabled
143143
* Editor notifications notifying that the license key is not valid
144144
| All license types
145145
|===
@@ -162,7 +162,7 @@ Anyone who intends to self-host {productname} will need to obtain a T8LK-prefixe
162162

163163
=== How will I know if this change affects me?
164164

165-
If {productname} detects that the `license_key` configuration is missing or invalid, it will display a console log warning message and/or editor notification and set the editor to readonly. These warnings and restrictions are designed to ensure compliance and provide transparency during evaluation periods.
165+
If {productname} detects that the `license_key` configuration is missing or invalid, it will display a console log warning message and/or editor notification and set the editor to disabled. These warnings and restrictions are designed to ensure compliance and provide transparency during evaluation periods.
166166

167167
[TIP]
168168
If you have actively suppressed or hidden these messages, please remove those overrides to maintain proper license validation. If no notification appears, you are not affected.
@@ -184,7 +184,7 @@ If using a cloud or hybrid deployment configuration, the license key may be chec
184184

185185
=== What happens if I don't provide a valid license key?
186186

187-
In addition to the editor being readonly, a console log warning message and/or editor notification will persist until a valid license key or 'gpl' is provided.
187+
In addition to the editor being disabled, a console log warning message and/or editor notification will persist until a valid license key or 'gpl' is provided.
188188

189189
=== Why is a license key required?
190190

@@ -248,14 +248,27 @@ a| * Verify that the license key is correctly copied from your link:https://www.
248248
* Ensure there are no extra spaces or characters in the key
249249
* Check if the key matches your deployment type (Cloud vs Self-hosted)
250250

251-
| xref:hard-expired[Hard expired]
251+
| xref:load-error[Load error (Cloud)]
252+
| The editor is disabled because the TinyMCE API key could not be validated. The TinyMCE Commercial License Key Manager plugin is required for the provided API key to be validated but could not be loaded.
253+
| The editor is disabled because the TinyMCE API key could not be validated.
254+
a| * Verify that your API key is valid
255+
* Check if your subscription is active
256+
* Visit the link:https://support.tiny.cloud[Support Portal] if the issue persists
257+
258+
| xref:load-error[Load error (Self-Hosted)]
259+
| The editor is disabled because the license key provided is invalid. The TinyMCE Commercial License Key Manager plugin is required for the provided license key to be validated but could not be loaded.
260+
| The editor is disabled because the TinyMCE license key could not be validated.
261+
a| * Check if the license key matches your deployment type: GPL or commercial, Cloud or Self-hosted
262+
* Ensure the license key manager is set up correctly: <<Setting up the Commercial License Key Manager>>
263+
264+
| xref:expired[Expired]
252265
| The editor is disabled because the license key has expired and is no longer valid
253266
| The editor is disabled because the license key has expired and is no longer valid.
254267
a| * Visit link:https://www.tiny.cloud/my-account[Tiny Cloud Account] to obtain a new license key
255268
* Update your configuration with the new key
256269
* Visit the link:https://support.tiny.cloud[Support Portal] if you believe your license should still be valid
257270

258-
| xref:soft-expired[Soft expired]
271+
| xref:grace-period[Grace period]
259272
| The editor will be disabled in the near future because the license key has expired
260273
| The editor will be disabled in the near future because the license key has expired.
261274
a| * Visit link:https://www.tiny.cloud/my-account[Tiny Cloud Account] to obtain a new license key
@@ -270,7 +283,7 @@ a| * Verify that your {productname} version matches the license key version
270283
* For version-locked keys, ensure you're using the correct patch version
271284

272285
| xref:no-license-key[No license key]
273-
| The editor is disabled because a {productname} license key has not been provided. Provide a valid license key or add license_key: 'gpl' to the init config to agree to the open source license terms.
286+
| The editor is disabled because a {productname} license key has not been provided. Make sure to provide a valid license key or add license_key: 'gpl' to the init config to agree to the open source license terms.
274287
| The editor is disabled because a {productname} license key has not been provided.
275288
a| * Add the `license_key` parameter to your {productname} configuration
276289
* For GPL usage, set `license_key: 'gpl'`
@@ -285,7 +298,7 @@ a| * Verify that your license includes access to the premium plugin
285298

286299
| xref:online-api-key-error-fallback[Online API Key Error (5xx - Fallback)]
287300
| The API key could not be validated by the API key validation server [type: +${errorType}${statusMsg}+]. Attempting fallback to provided license key.
288-
| The editor is disabled because the API key could not be validated by the API key validation server.
301+
|
289302
a| * Check your internet connection
290303
* Verify your firewall settings allow access to the validation server
291304
* The editor will attempt to use the provided license key as fallback
@@ -304,12 +317,20 @@ a| * Verify that your API key is valid
304317
==== Invalid license key (General)
305318
The provided license key is not recognized as a valid {productname} license key. This can occur if the key is malformed, expired, or doesn't match your deployment type. For self-hosted installations, ensure you're using a valid T8LK-prefixed license key. Visit the link:https://www.tiny.cloud/my-account[Tiny Cloud Account] to verify your license key.
306319

307-
[[hard-expired]]
308-
==== Hard expired
320+
[[load-error-cloud]]
321+
==== Load error (Cloud)
322+
The TinyMCE Commercial License Key Manager plugin is automatically loaded from the Tiny Cloud CDN for cloud deployments. If it cannot be loaded, the editor will be disabled. Review your subscription details in your link:https://www.tiny.cloud/my-account[Tiny Cloud Account] to check its status.
323+
324+
[[load-error-selfhosted]]
325+
==== Load error (Self-hosted)
326+
For self-hosted installations, the TinyMCE Commercial License Key Manager plugin is required for commercial license keys otherwise the editor will be disabled. If it cannot be loaded, see the <<Setting up the Commercial License Key Manager>> section for implementation details
327+
328+
[[expired]]
329+
==== Expired
309330
The license key has reached its expiration date and is no longer valid for use. The editor will be disabled until a new valid license key is provided. For time-based keys, refer to the <<License Key Types>> section. To renew your license, visit link:https://www.tiny.cloud/pricing[Tiny Cloud Pricing] or contact your account manager.
310331

311-
[[soft-expired]]
312-
==== Soft expired
332+
[[grace-period]]
333+
==== Grace period
313334
The license key has reached its initial expiration date but is still within the grace period. The editor will continue to function but will be disabled when the grace period ends. See the <<License States>> section for more information about grace periods. Contact your account manager or visit link:https://www.tiny.cloud/my-account[Tiny Cloud Account] to renew your license before the grace period expires.
314335

315336
[[invalid-editor-version]]

0 commit comments

Comments
 (0)