Cloud deployment of editor & plugins
Tiny Cloud is the easiest way to integrate TinyMCE and upgrade to premium plugins.
Tiny Cloud can be used without an API key. Refer to the Introduction & getting started guide for more information. Sign up for an API key and update the script tag to use premium plugins or avoid the in-editor developer warning.
All Tiny Cloud accounts include a free, pre-configured Tiny Cloud image proxy service. This setup uses the Image tools plugin.
Integrating TinyMCE for the first time
Step 1: Insert the Tiny Cloud script tag into the webpage
Insert the TinyMCE editor code into the application to load TinyMCE for the first time. The code inserting is done by adding the following script tag into your app, or in the case of a web page the <head>
of the page:
The following example adds a script tag into the application that inserts the code. Use the <head>
of the page on a web page. Be sure to substitute 'no-api-key' with your api key.
<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/5/tinymce.min.js" referrerpolicy="origin"></script>
Value | Description | |
---|---|---|
1 |
no-api-key |
Replace with your api key |
2 |
origin= |
A |
Tiny Cloud verifies the domain TinyMCE is loading from by checking the Referer header in the network request. Sometimes the domains in the Referer header does not match with the URL in the browser’s address bar. To check the Referer header, open your browser’s Developer’s Tools and open the Network tab. From there, find the request being made to load TinyMCE with your API key, and click on the Headers tab. In the section called Request Headers there should be a field for Referer. If the value there is different from one of your registered URLs, you may need to adjust either your registered URLs, or your application’s Refer header settings. |
Step 2: Load, customize and interact with TinyMCE
There are more than 40 open source plugins that enhance the editing experience in addition to the advanced content create solutions on Tiny Cloud. A range of simple examples are available. Refer to the Quick start section for more information.
Step 3: Specifying purchased TinyMCE plugins and toolbar/menu items
Extend the TinyMCE configuration to include any additional purchased plugins and associated toolbar and menu items. Refer to the following enablement guides for more information:
spellchecker_rpc_url is not required when enabling this plugin via Tiny Cloud.
|
Configuration of the imagetools_cors_hosts and imagetools_proxy properties occurs automatically.
|
It may take up to 30 minutes for the purchased plugin to be available to TinyMCE. Clear the browser’s cache. |
Step 4: Forward proxy configuration
Ensure that the following URLs are accessible via this proxy if the network has a forward proxy that controls access to the internet.
-
All URLs where the editor is deployed.
-
All URLs where the plugins are deployed.
-
https://imageproxy.tiny.cloud
-
https://hyperlinking.tiny.cloud
-
https://spelling.tiny.cloud
Ensure the tiny-api-key
and tinymce-api-key
headers are retained while requesting the list of above URLs.
Step 5: Specifying a translation
To change the user interface language with a language pack, use the language configuration option.
Alternatively, download a language pack to enable a language other than English (US). Specify its location with the language_url
configuration option.
Migrating from a self-hosted environment to Tiny Cloud
Step 1: Replace existing reference to tinymce.min.js
Migrating from a self-hosted environment to Tiny Cloud is easy. Remove the existing script tag that loads TinyMCE’s JavaScript.
The script tag typically references tinymce.min.js hosted within the application or available at a legacy CDN.
|
Replace the script tag with the following:
<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/5/tinymce.min.js" referrerpolicy="origin"></script>
Step 2: Update custom plugin paths
Reference external_plugins to ensure custom plugins or modified plugins continue to function in the Tiny Cloud deployment.
Do not use the regular plugins configuration element. |
Step 3: Specify purchased TinyMCE plugins and toolbar buttons
Extend the TinyMCE configuration to include any additional purchased plugins and associated toolbar and menu items. Refer to the following enablement guides for more information:
spellchecker_rpc_url is not required when enabling this plugin via Tiny Cloud.
|
Configuration of the imagetools_cors_hosts and imagetools_proxy properties occurs automatically.
|