Skip to content

Commit 0047124

Browse files
authored
DOC-3521: Clarify license keys in AI on-premises credentials table (#4160)
* DOC-3521: Clarify license keys in AI on-premises credentials table Remove the TINYMCE_API_KEY row and CDN/API key references that do not apply to on-premises deployments, and distinguish the service license key from the TinyMCE editor license key. * DOC-3521: Address review feedback on credentials table Use consistent "required" wording in the Required column, make the editor license key requirement specific to premium AI features, and trim the note so it no longer repeats the introductory paragraph. * DOC-3521: Clarify when each license key is provided Note that LICENSE_KEY is passed to the AI service container as an environment variable, while license_key is added to the editor configuration, in the credentials table.
1 parent b9a4b10 commit 0047124

1 file changed

Lines changed: 10 additions & 15 deletions

File tree

modules/ROOT/pages/tinymceai-on-premises.adoc

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -90,29 +90,24 @@ The shared secret (API Secret) exists only in the application back end (token en
9090

9191
== Credentials
9292

93-
Three credentials are involved in an on-premises deployment. They are distinct and serve different purposes.
93+
Two license keys are involved in an on-premises deployment. They are distinct, come from different sources, and serve different purposes.
9494

9595
[cols="1,1,2,1",options="header"]
9696
|===
9797
|Credential |Where it lives |What it does |Required?
9898

99-
|`LICENSE_KEY`
100-
|AI service container (environment variable)
101-
|Activates the AI service. A long string provided by the Tiny account representative.
102-
|Yes — the service refuses to start without it.
99+
|Service license key (`LICENSE_KEY`)
100+
|Passed to the AI service container as an environment variable (for example, in the `docker run` command or Compose file)
101+
|Activates the on-premises AI service at runtime. A long string provisioned through the {companyname} customer portal.
102+
|Yes — required to run the service.
103103

104-
|`TINYMCE_API_KEY`
105-
|Editor page (CDN script URL) or build configuration
106-
|Authenticates against `cdn.tiny.cloud` when loading {productname} from the CDN. This is the short string from the tiny.cloud dashboard.
107-
|Only when loading {productname} from the CDN. Omit for self-hosted editor bundles.
108-
109-
|`license_key` (init option)
110-
|`tinymce.init({ license_key: 'T8LK:...' })`
111-
|Activates premium {productname} features when using a self-hosted editor bundle (not the CDN).
112-
|Only for self-hosted editor deployments. Provided by the Tiny account representative.
104+
|{productname} editor license key (`license_key`)
105+
|Added to the editor configuration: `tinymce.init({ license_key: 'T8LK:...' })`
106+
|Configures the license mode for the {productname} editor and activates premium {productname} features.
107+
|Yes — required for the premium {productname} AI features.
113108
|===
114109

115-
NOTE: `LICENSE_KEY` (the AI service license) and `TINYMCE_API_KEY` / `license_key` (the editor license) are different credentials from different sources. They are not interchangeable.
110+
NOTE: The service license key (`LICENSE_KEY`) and the {productname} editor license key (`license_key`) are not interchangeable. For more information, see xref:service-license-keys.adoc[Service license keys] and xref:license-key.adoc[License key].
116111

117112
== Prerequisites
118113

0 commit comments

Comments
 (0)