Skip to content

Commit 7e1a0ee

Browse files
committed
DOC-3226: Enhance license key documentation for TinyMCE 8, clarifying T8LK prefix requirements and updating integration references across various frameworks.
1 parent 3ab1524 commit 7e1a0ee

File tree

10 files changed

+83
-72
lines changed

10 files changed

+83
-72
lines changed

modules/ROOT/pages/8.0-release-notes.adoc

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -124,11 +124,18 @@ For information on using Enhanced Skins & Icon Packs, see: xref:enhanced-skins-a
124124

125125
=== Enhanced license key system with T8LK prefix
126126

127-
The license key system in {productname} 8 has been enhanced to provide improved subscription access control and streamlined renewal processes. All commercial license keys for self-hosted deployments now require the `T8LK:` prefix to indicate version 8 compatibility.
127+
The license key system in {productname} 8 has been enhanced to provide improved subscription access control and streamlined renewal processes. This change primarily affects self-hosted deployments, as cloud users ({cloudname}) do not require a license key.
128128

129-
Key changes include:
129+
[IMPORTANT]
130+
====
131+
* If you use {cloudname}, no license key is required - your cloud subscription automatically includes the commercial license.
132+
* For self-hosted deployments, all commercial license keys must use the new `T8LK:` prefix format.
133+
* Existing TinyMCE 7 license keys cannot be made compatible with TinyMCE 8 by adding the T8LK prefix.
134+
====
130135

131-
* All commercial license keys must start with `"T8LK:"` prefix
136+
Key changes for self-hosted deployments:
137+
138+
* New `T8LK:` prefix requirement for all commercial license keys.
132139
* Enhanced JWT-based validation that runs entirely in the browser
133140
* No server communication or "phone home" checks required
134141
* Support for both date-based and version-locked keys
@@ -137,11 +144,23 @@ Key changes include:
137144

138145
[IMPORTANT]
139146
====
140-
* GPL usage still requires setting `license_key: 'gpl'` (case insensitive)
141-
* For open source projects using premium features, use the combined format: `license_key: 'GPL+T8LK:...'`
142-
* The license key is not required when using {cloudname} with an API key
147+
*Cloud Deployments:*
148+
149+
* When using {cloudname}, only an API key is required - no license key needed
150+
* Your cloud subscription automatically includes the commercial license
151+
152+
*Self-hosted Deployments:*
153+
154+
* Commercial use: Contact your account manager or visit link:https://www.tiny.cloud/my-account[Tiny Cloud Account] to obtain a T8LK-prefixed license key
155+
* GPL use: Set `license_key: 'gpl'` (case insensitive)
156+
* Open source projects using premium features: Use the combined format `license_key: 'GPL+T8LK:...'`
143157
====
144158

159+
=== Upgrading from TinyMCE 7
160+
161+
* *Cloud Users ({cloudname})*: No license key changes needed - simply update your {productname} version.
162+
* *Self-hosted Users*: Contact your account manager to obtain a new T8LK-prefixed license key.
163+
145164
For more information on the new license key system, see: xref:license-key.adoc[License Key].
146165

147166

modules/ROOT/pages/license-key.adoc

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ a|
8686
** Cloud services access
8787
** Premium plugin access
8888
** Automatic updates
89-
* No license key required (defaults to a commercial license)
89+
* No license key required as its automatically issued. (defaults to a commercial license)
9090
a|
9191
* Fully managed service:
9292
** No local deployment needed
@@ -190,6 +190,37 @@ In addition to the editor being readonly, a console log warning message and/or e
190190

191191
The license key ensures compliance with {productname} licensing terms. It's part of our efforts to refine the license key system and may have additional functionalities in the future.
192192

193+
=== How do I obtain a TinyMCE 8 license key?
194+
195+
To obtain a new TinyMCE 8 license key (T8LK-prefixed):
196+
197+
* *Existing customers*: Contact your account manager or visit link:https://www.tiny.cloud/my-account[Tiny Cloud Account] to upgrade your subscription.
198+
* *New customers*: Visit link:https://www.tiny.cloud/pricing[Tiny Cloud Pricing] to purchase a new license.
199+
200+
[IMPORTANT]
201+
====
202+
Existing TinyMCE 7 license keys cannot be modified to work with TinyMCE 8 by adding the T8LK prefix. A new TinyMCE 8 license must be obtained through the proper channels listed above.
203+
====
204+
205+
=== I'm upgrading from {productname} 7 - how do I get a {productname} 8 license key?
206+
207+
If you are using {cloudname} (cloud-hosted):
208+
209+
* No license key is required - simply update your {productname} version as your cloud subscription includes the commercial license.
210+
211+
If you are an existing {productname} 7 self-hosted customer upgrading to {productname} 8:
212+
213+
. *Active Subscription*:
214+
* Contact your account manager or visit link:https://www.tiny.cloud/my-account[Tiny Cloud Account] to obtain a new T8LK-prefixed license key.
215+
. *Expired Subscription*:
216+
* Contact your account manager or visit link:https://www.tiny.cloud/pricing[Tiny Cloud Pricing] to renew your subscription.
217+
* A new T8LK-prefixed license key will be provided as part of the renewal process.
218+
219+
[NOTE]
220+
====
221+
Your existing {productname} 7 license key will continue to work with TinyMCE 7 self-hosted installations. But, you will require a separate T8LK-prefixed license key for {productname} 8 editor instances for self-hosted installations.
222+
====
223+
193224
=== How can I get further assistance?
194225

195226
For any licensing or technical support questions, see our available options on the https://www.tiny.cloud/docs/tinymce/latest/support/[support page.]

modules/ROOT/partials/integrations/angular-tech-ref.adoc

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -130,18 +130,7 @@ include::partial$misc/get-an-api-key.adoc[]
130130
[[licensekey]]
131131
=== `+licenseKey+`
132132

133-
{cloudname} License key.
134-
135-
Use this when self-hosting {productname} instead of loading from {cloudname}. For more information, see: xref:license-key.adoc[License Key].
136-
137-
*Type:* `+String+`
138-
139-
*Default value:* `+undefined+`
140-
141-
*Possible values:*
142-
* `undefined` - Use this when loading from {cloudname} with an API key
143-
* `'gpl'` - For open source projects using GPL license
144-
* `'T8LK:...'` - For commercial {productname} installations
133+
include::partial$integrations/common/license-key-property.adoc[]
145134

146135
==== Example: Commercial license
147136
[source,html]

modules/ROOT/partials/integrations/blazor-tech-ref.adoc

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -188,16 +188,8 @@ In your component:
188188

189189
=== `LicenseKey`
190190

191-
Specifies the {productname} license key. Required for self-hosted deployments of {productname}. This property is not required for deployments using the {cloudname}.
192191

193-
License keys must start with the "T8LK:" prefix and use client-side JWT validation that runs entirely in the browser, requiring no server communication or "phone home" checks. For more information, see: xref:license-key.adoc[License Key].
194-
195-
*Type:* `+String+`
196-
197-
*Possible values:*
198-
* `null` - Use this when loading from {cloudname} with an API key
199-
* `"gpl"` - For open source projects using GPL license
200-
* `"T8LK:..."` - For commercial {productname} installations
192+
include::partial$integrations/common/license-key-property.adoc[]
201193

202194
==== Example: Commercial license (TinyMCE 8+)
203195
[source,cs]
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Specifies the {productname} license key. Required for self-hosted deployments of {productname}. This property is **not required** for cloud-only deployments using the {cloudname} as your cloud subscription automatically includes the commercial license. For more information, see: xref:license-key.adoc[License Key].
2+
3+
*Type:* `+String+`
4+
5+
*Default value:* `+undefined+`
6+
7+
*Possible values:*
8+
* `undefined` - Use this when loading from {cloudname} with an API key
9+
* `'gpl'` - For open source projects using GPL license
10+
* `'T8LK:...'` - For commercial {productname} installations (must use this prefix for version 8+)
11+
12+
[NOTE]
13+
====
14+
In hybrid deployments (using both cloud and self-hosted features):
15+
16+
* You can provide both an API key and a license key
17+
* The editor will use cloud services when available
18+
* It will automatically fall back to the local license key if cloud services are not contactable
19+
====

modules/ROOT/partials/integrations/react-tech-ref.adoc

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -187,18 +187,8 @@ include::partial$misc/get-an-api-key.adoc[]
187187
[[licenseKey]]
188188
=== `+licenseKey+`
189189

190-
{cloudname} License key.
191190

192-
Use this when self-hosting {productname} instead of loading from {cloudname}. License keys must start with the "T8LK:" prefix and use client-side JWT validation that runs entirely in the browser, requiring no server communication or "phone home" checks. For more information, see: xref:license-key.adoc[License Key].
193-
194-
*Type:* `+String+`
195-
196-
*Default value:* `+undefined+`
197-
198-
*Possible values:*
199-
* `undefined` - Use this when loading from {cloudname} with an API key
200-
* `'gpl'` - For open source projects using GPL license
201-
* `'T8LK:...'` - For commercial {productname} installations
191+
include::partial$integrations/common/license-key-property.adoc[]
202192

203193
==== Example: Commercial license
204194
[source,jsx]

modules/ROOT/partials/integrations/svelte-quick-start.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ export default defineConfig({
118118
----
119119
. Open `+src/App.svelte+` and replace the contents with:
120120
+
121-
[source,javascript]
121+
[source,svelte]
122122
----
123123
<script>
124124
import Editor from '@tinymce/tinymce-svelte';

modules/ROOT/partials/integrations/svelte-tech-ref.adoc

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -56,18 +56,8 @@ include::partial$misc/get-an-api-key.adoc[]
5656
[[licensekey]]
5757
=== `+licenseKey+`
5858

59-
{cloudname} License key.
6059

61-
Use this option when self-hosting {productname} instead of loading from {cloudname}. License keys must start with the "T8LK:" prefix and use client-side JWT validation that runs entirely in the browser, requiring no server communication or "phone home" checks. For more information, see: xref:license-key.adoc[License Key].
62-
63-
*Type:* `+String+`
64-
65-
*Default value:* `+undefined+`
66-
67-
*Possible values:*
68-
* `undefined` - Use this when loading from {cloudname} with an API key
69-
* `'gpl'` - For open source projects using GPL license
70-
* `'T8LK:...'` - For commercial {productname} installations
60+
include::partial$integrations/common/license-key-property.adoc[]
7161

7262
==== Example: Commercial license
7363
[source,jsx]

modules/ROOT/partials/integrations/vue-tech-ref.adoc

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -137,18 +137,8 @@ include::partial$misc/get-an-api-key.adoc[]
137137
[[license-key]]
138138
=== `+licenseKey+`
139139

140-
{cloudname} License key.
141140

142-
Use this when self-hosting {productname} instead of loading from {cloudname}. License keys must start with the "T8LK:" prefix and use client-side JWT validation that runs entirely in the browser, requiring no server communication or "phone home" checks. For more information, see: xref:license-key.adoc[License Key].
143-
144-
*Type:* `+String+`
145-
146-
*Default value:* `+undefined+`
147-
148-
*Possible values:*
149-
* `undefined` - Use this when loading from {cloudname} with an API key
150-
* `'gpl'` - For open source projects using GPL license
151-
* `'T8LK:...'` - For commercial {productname} installations
141+
include::partial$integrations/common/license-key-property.adoc[]
152142

153143
==== Example: Commercial license
154144
[source,html]

modules/ROOT/partials/integrations/webcomponent-tech-ref.adoc

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -79,16 +79,7 @@ To use {productname} from the {cloudname}, add the `+api-key+` attribute to the
7979
[[licensekey]]
8080
== Setting the license key
8181

82-
When self-hosting {productname}, specify a license key using the `+license-key+` attribute on the `+tinymce-editor+` element. License keys must start with the "T8LK:" prefix and use client-side JWT validation that runs entirely in the browser, requiring no server communication or "phone home" checks. Do not use both an API key and a license key - use API key for cloud deployments, and license key for self-hosted deployments. For more information, see: xref:license-key.adoc[License Key].
83-
84-
*Type:* `+String+`
85-
86-
*Default value:* `+undefined+`
87-
88-
*Possible values:*
89-
* `undefined` - Use this when loading from {cloudname} with an API key
90-
* `"gpl"` - For open source projects using GPL license
91-
* `"T8LK:..."` - For commercial {productname} installations
82+
include::partial$integrations/common/license-key-property.adoc[]
9283

9384
=== Example: Commercial license
9485
[source,html]

0 commit comments

Comments
 (0)