Skip to content

cloud-troubleshooting.adoc

Latest commit

 

History

History
203 lines (127 loc) · 10.6 KB

cloud-troubleshooting.adoc

File metadata and controls

203 lines (127 loc) · 10.6 KB

Cloud Troubleshooting

When {cloudname} detects a problem, it will show an editor notification containing information about the problem. This page describes the cause and solution for common {cloudname} error notifications.

Note
 The wording of the notifications shown here may differ from the actual notifications from {cloudname}.

Invalid API Key

"A valid API key is required to continue using {productname}. Please alert the admin to check the current API key. Click here to learn more."

Cause

This notification is shown when either:

  • An apiKey is not provided in the script tag,

  • An empty or missing apiKey is provided, or

  • The apiKey provided cannot be found on the {cloudname} server.

The apiKey must be:

  • An exact length,

  • comprised of certain characters, and

  • created with a {cloudname} account on the {accountpage} page.

For example:

<script src="https://cdn.tiny.cloud/1/abcd1234/tinymce/{productmajorversion}/tinymce.min.js" referrerpolicy="origin" crossorigin="anonymous"></script>

In this case, the editor will be in a read-only state, and a notification appears stating: "A valid API key is required to continue using {productname}. Please alert the admin to check the current API key. Click here to learn more."

Solution

To resolve this issue:

  1. Update the src URL to include your (website or application developer’s) {cloudname} API Key, by replacing the placeholder no-api-key with your actual API key.

    For example: if your API is abcd1234:

    <script src="https://cdn.tiny.cloud/1/abcd1234/tinymce/{productmajorversion}/tinymce.min.js" referrerpolicy="origin" crossorigin="anonymous"></script>

  2. Check the apiKey provided in the script tag:

    • Remove any leading or trailing spaces.

    • Remove any other characters that are not in your apiKey. If you are using variable substitution, ensure that the variable is substituting properly.

    • Ensure the apiKey+ matches the API key shown at {accountpageurl}.

  3. If you do not have an API key, or need to retrieve your existing key, visit: {cloudname}.

Note
 Visit our Invalid API key page for more information on how to fix an invalid API key issue with {productname}.

No API Key

"A valid API key is required to continue using {productname}." (Console message)

Cause

When no-api-key is set as the apiKey the editor will be in a read-only state, and the user will see a "Finish setting up" dialog prompting them to add a valid API key, configure their domain, and explore premium features.

onboarding finish setting up dialog

Solution

  1. Update the src URL to include your (website or application developer’s) {cloudname} API Key, by replacing the placeholder no-api-key with your actual API key.

For example: if your API is abcd1234:

<script src="https://cdn.tiny.cloud/1/abcd1234/tinymce/{productmajorversion}/tinymce.min.js" referrerpolicy="origin" crossorigin="anonymous"></script>

To retrieve your API key, or to sign up for an API key, visit: {cloudname}.

Domain Not Registered

"This domain is not registered in the {productname} Customer Portal. Please alert the admin to add it to the approved domains to continue using {productname}. Click here to learn more."

Cause

This notification is shown when the Referer of the page does not match the list of approved domains stored against your apiKey. {cloudname} verifies the domain {productname} is loading from by checking the domain portion of the Referer header in the network request. You can view a list of your approved domains on your {accountpage}.

Sometimes the domain 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.

  • Open the Network tab.

  • Find and select the request being made to load {productname} from {cloudname} with your API key.

  • Click on the Headers tab.

In the section called Request Headers there should be a field for Referer. This is the value that {productname} is checking against your approved domains. It must match one of your approved domains listed on your {accountpage}.

Solution

If the Referer is correct for the site, ensure that the domain is included in your list of approved domains on {accountpage}. If the Referer is not what you are expecting, you may need to adjust your application’s Referer header settings.

Referer Heading Missing

"We’re unable to check your domain because the referer header is missing. Please read the Guide on how to ensure your referer header is present, so we can then customize your editor experience."

Cause

  • This notification is shown if the Referer header is absent for the network request when loading {productname} from {cloudname}. {cloudname} verifies the domain {productname} is loading from by checking the domain of the Referer header in the network request.

  • Referer headers are sometimes removed by browser settings or browser extensions. {cloudname} only needs the domain in the Referer header, so for improved performance and privacy {companyname} recommends setting the referrerpolicy to origin when requesting {cloudname} resources.

Solution

Identify which browser setting or extension is responsible for blocking the Referer being sent. A common extension is Referer Control:

Once you have identified the setting or extension, modify it to allow just the Origin of the Referer to be sent. Alternatively, disable the extension or setting for any pages using {cloudname}.

Troubleshooting Premium Plugins

"The _ premium plugin is not enabled on your API key. Upgrade your account."

Cause

This notification is shown when your API key does not have access to the premium plugin being requested. This could be the result of a trial expiring, and your {productname} configuration attempting to load premium plugins you can no longer access.

You may also be seeing this notification if you are using the wrong API key. Ensure that you are using the API key that has the right entitlements.

Solution

Either remove the premium plugin from your {productname} configuration, or upgrade your subscription to provide access to that premium plugin.

Note
 Visit our Invalid API key page for more information on how to fix a invalid API key with {productname}.

Read-only mode - No API Key

“{productname} is in read-only mode. Please alert the admin that an API key is required for continued use. Learn more

Cause "No API Key (Read only mode)"

This message is sent when the developer has not supplied an API key, typically because they’ve copied a getting-started script and have not completed the official signup process to get an API key.

Solution

  • Please alert your Admin that an API key is required for continued use. Learn more, or

  • Sign up for a API key by visiting www.tiny.cloud/auth/signup, and

  • Update your {productname} configuration.

Note
 Visit our Invalid API key page for more information on how to fix a invalid API key with {productname}.

Read-only mode - Invalid API Key

“{productname} is in read-only mode. Please alert the admin to provide a valid API key to continue use. Learn more Your {productname} editor state has been set to read-only mode.”

Cause "Invalid API Key (Read only-mode)"

This message is shown when the API key is not correct, perhaps because of a typo.

Solution

Read-only mode - Invalid Origin

“{productname} is in read-only mode. Please request that the admin add this domain to the approved domains in the Customer Portal. For more information see Domain not registered”

Cause "Invalid Origin (Read only mode)"

This message is shown when {productname} is loaded from a domain that has not been added to the approved domains in our account portal.

Solution

Please request that your admin add this domain to the approved domains in the Customer Portal. For more information see Domain not registered

Note
 From {productname} 7.6.0 onwards, the editor uses disabled mode instead of read-only mode.