|
113 | 113 | * Premium plugin access |
114 | 114 | a| |
115 | 115 | * Environments where regular license key rotation cannot be performed. |
| 116 | + |
| 117 | +| Trial Keys (ONLINE+) |
| 118 | +a| |
| 119 | +* Key format starts with `+ONLINE++` prefix |
| 120 | +* Expires at the end of the trial period |
| 121 | +* Requires a network connection to {cloudname} for validation |
| 122 | +* Optionally connects to cloud services via `+online_license_services_opt_in: true+` |
| 123 | +a| |
| 124 | +* Evaluating {productname} in a self-hosted environment. |
| 125 | +* See xref:self-hosted-trial.adoc[Self-hosted trial] for setup instructions. |
116 | 126 | |=== |
117 | 127 |
|
118 | 128 | === Deployment Types |
@@ -219,9 +229,11 @@ Only use both keys in properly configured hybrid deployments. Using both keys wi |
219 | 229 |
|
220 | 230 | === Will {productname} "phone home" to check the license key? |
221 | 231 |
|
222 | | -No, {productname} does not contact any server to validate the license key for self-hosted deployments. |
| 232 | +For standard self-hosted deployments using a Time-based or Version-locked commercial key, no: validation happens entirely offline and no network connection is made. |
223 | 233 |
|
224 | | -If using a cloud or hybrid deployment configuration, the license key may be checked by {cloudname}. |
| 234 | +For cloud and hybrid deployments, the license key may be checked by {cloudname}. |
| 235 | + |
| 236 | +For self-hosted trial deployments using a Trial (ONLINE+) key, yes: the editor contacts {cloudname} to complete key validation. This is required for trial keys and cannot be disabled. The optional `+online_license_services_opt_in+` setting controls whether cloud service URLs are also configured, but the validation network call happens regardless. See xref:self-hosted-trial.adoc[Self-hosted trial] for details. |
225 | 237 |
|
226 | 238 | === What happens if I don't provide a valid license key? |
227 | 239 |
|
@@ -353,10 +365,38 @@ a| * Verify that your API key is valid |
353 | 365 | * Visit the link:https://support.tiny.cloud[Support Portal] if the issue persists |
354 | 366 |
|
355 | 367 | | xref:resource-load-error[Resource Load Error] |
356 | | -| The editor is disabled because the {productname} license key could not be validated. |
357 | 368 | | The editor is disabled because the {productname} license key could not be validated. The {productname} Commercial License Key Manager plugin was unable to load additional required resources. |
| 369 | +| The editor is disabled because the {productname} license key could not be validated. |
358 | 370 | a| * If bundling, verify that you are using the `licensekeymanager/index.js` file that imports other required resources. |
359 | 371 | * If hosting, verify that a `js/commerciallicensekeymanager.js` file is also present in the `plugins/licensekeymanager` folder. |
| 372 | + |
| 373 | +| xref:online-plus-exchange-error[ONLINE+ Exchange Error] |
| 374 | +| The editor is disabled because the license key could not be validated by the cloud server [type: +${errorType}${statusMsg}+] |
| 375 | +| The editor is disabled because the license key could not be validated by the cloud server. |
| 376 | +a| * Verify that your ONLINE+ license key is valid |
| 377 | +* Ensure your deployment is self-hosted (ONLINE+ keys cannot be used with cloud or hybrid deployments) |
| 378 | +* Check that your server has network access to the cloud validation endpoint |
| 379 | +* Visit the link:https://support.tiny.cloud[Support Portal] if the issue persists |
| 380 | + |
| 381 | +| xref:online-plus-insecure-context[ONLINE+ Insecure Context] |
| 382 | +| The editor is disabled because the ONLINE+ license key requires a secure context (HTTPS or localhost) [type: online-insecure-context] |
| 383 | +| The editor is disabled because the ONLINE+ license key requires a secure context (HTTPS or localhost). |
| 384 | +a| * Serve the application over HTTPS |
| 385 | +* Use `localhost` for local development |
| 386 | +* ONLINE+ keys cannot be used over plain HTTP on non-localhost origins |
| 387 | + |
| 388 | +| xref:online-plus-config-conflict[ONLINE+ Config Conflict] |
| 389 | +| The editor is disabled because an ONLINE+ license key can only be configured for a self-hosted deployment. |
| 390 | +| The editor is disabled because an ONLINE+ license key can only be configured for a self-hosted deployment. |
| 391 | +a| * Trial (ONLINE+) keys are only valid for self-hosted deployments |
| 392 | +* If loading {productname} from {cloudname} or using a hybrid deployment, switch to a standard commercial license key |
| 393 | +* See the <<Deployment Types>> section for guidance on choosing the correct deployment type and key |
| 394 | + |
| 395 | +| xref:online-plus-services-not-configured[ONLINE+ Services Not Configured] |
| 396 | +| ONLINE+ license key detected without +online_license_services_opt_in: true+. Cloud-service premium plugins (e.g. linkchecker, spellchecker) will not be auto-configured. Set +online_license_services_opt_in: true+ to use the bundled cloud services, or configure each plugin's service URL manually. |
| 397 | +| |
| 398 | +a| * Add `online_license_services_opt_in: true` to your {productname} init configuration to enable automatic cloud service URL configuration |
| 399 | +* Alternatively, configure each cloud-service plugin's service URL manually |
360 | 400 | |=== |
361 | 401 |
|
362 | 402 | === Detailed Error Descriptions |
@@ -405,4 +445,28 @@ The API key validation failed due to an invalid key or inactive subscription. Th |
405 | 445 | ==== Resource Load Error |
406 | 446 | The TinyMCE Commercial License Key Manager plugin was unable to load additional required resources. This typically occurs when the `js/commerciallicensekeymanager.js` file is missing or not properly configured. For bundled applications, ensure you are using the `licensekeymanager/index.js` file that imports other required resources. For self-hosted installations, verify that a `js/commerciallicensekeymanager.js` file is present in the `plugins/licensekeymanager` folder. See the <<Setting up the Commercial License Key Manager>> section for implementation details. |
407 | 447 |
|
| 448 | +[[online-plus-exchange-error]] |
| 449 | +==== ONLINE+ Exchange Error |
| 450 | +This error applies to Trial (ONLINE+) license keys. See xref:self-hosted-trial.adoc[Self-hosted trial] for setup information. |
| 451 | + |
| 452 | +The trial license key could not be validated by the {cloudname} server. The editor will be disabled and will not recover until the configuration issue is resolved. Unlike the <<online-api-key-error-disable,Online API Key Error (4xx - Disable)>>, which applies to standard API key validation, this error is specific to the trial key exchange. Ensure your deployment is self-hosted, as trial keys are not supported in cloud or hybrid deployments. If the key and deployment type are correct, check that your server can reach the {cloudname} validation endpoint. Visit the link:https://support.tiny.cloud[Support Portal] if the issue persists. |
| 453 | + |
| 454 | +[[online-plus-insecure-context]] |
| 455 | +==== ONLINE+ Insecure Context |
| 456 | +This error applies to Trial (ONLINE+) license keys. See xref:self-hosted-trial.adoc[Self-hosted trial] for setup information. |
| 457 | + |
| 458 | +The trial license key requires a secure context to validate correctly, because validation involves a network call to {cloudname}. A secure context is a page served over HTTPS or accessed via `localhost`. Pages served over plain HTTP on a non-localhost domain will cause the editor to be disabled. Serve the application over HTTPS, or use `localhost` for local development. |
| 459 | + |
| 460 | +[[online-plus-config-conflict]] |
| 461 | +==== ONLINE+ Config Conflict |
| 462 | +This error applies to Trial (ONLINE+) license keys. See xref:self-hosted-trial.adoc[Self-hosted trial] for setup information. |
| 463 | + |
| 464 | +A trial license key was detected in a cloud or hybrid deployment configuration. Trial keys are only valid for self-hosted deployments. If you are loading {productname} from {cloudname} or using a hybrid deployment, switch to a standard commercial license key. If you intend to use a self-hosted deployment, ensure {productname} is not being loaded from {cloudname}, as doing so activates the cloud validation flow which is incompatible with trial keys. See the <<Deployment Types>> section for guidance on choosing the correct deployment type and key. |
| 465 | + |
| 466 | +[[online-plus-services-not-configured]] |
| 467 | +==== ONLINE+ Services Not Configured |
| 468 | +This advisory applies to Trial (ONLINE+) license keys. See xref:self-hosted-trial.adoc[Self-hosted trial] for setup information. |
| 469 | + |
| 470 | +A trial license key was accepted but `online_license_services_opt_in: true` was not set in the init configuration. Without this option, {productname} will not automatically configure the cloud service endpoints for premium plugins such as linkchecker and spellchecker. Those plugins will load but will display their own errors about missing service URLs. To enable automatic configuration, add `online_license_services_opt_in: true` to your `tinymce.init` configuration. Alternatively, configure each plugin's service URL manually. |
| 471 | + |
408 | 472 | For additional assistance, visit our link:https://support.tiny.cloud[Support Portal] or contact your link:https://www.tiny.cloud/my-account[Tiny Cloud Account] manager. |
0 commit comments