Skip to main content

Troubleshooting Tips

How do I find out what version I'm running?#

If you visit one of the following endpoints, Coral will return the version you're running and the hash for the latest commit.

  • /api/v1 (works for 4.x.x versions)
  • /api/version (works for 5.x.x versions)

I've installed Coral but I can't see the comment stream appear on my articles#

  • Make sure you've adding the correct domains to your Permitted Domains
  • Make sure you've correctly added the embed via your CMS to your article pages
  • Check the console for any errors and you can file a bug via support if you can't resolve the issue

My commenters are reporting they can't see the comment stream, but I'm able to#

  • If this seems to be isolated to one commenter, it could be related to 3rd party cookies
  • Post 4.x Talk doesn't require 3rd party cookies to be enabled. Check the version of Talk you're using and you might consider upgrading.
  • A quick fix in the meantime is to ask them to allow 3rd party cookies
  • You could also try asking them to clear their browser cache

My commenters are reporting that they cannot login to Coral#

This depends greatly on what version of Coral you are using and which authentication strategies you've enabled. Some things to check are:

  • If using SSO, ensure that your JWT token settings, especially expiry, is being set correctly. You can troubleshoot JWT related issues with the JWT Debugger.
  • See if you can isolate if it's a particular group of users that are experiencing this issue, e.g., mods, admins, subscribers? Confirm they have the appropriate permissions to comment.
  • Note if this is a new issue that happened after an upgrade - did you read the release notes and confirm that any required manual or automatic database migrations run?
  • If a user has been locked out due to too many failed login attempts, the user will have to wait 10 minutes before they will be allowed to login
  • Coral does not support changing a User's user.id. If you attempt to pass an SSO token with a new user.id but an existing user.email address, Coral will throw a DUPLICATE_USER error. To correct this, you need to "detach" the user's email address from their original user.id by sending an API request to Coral's updateUserEmail mutation, and set the user.email for the original user.id to some other value. After that you will be able to pass an SSO token with the new user.id and existing user.email combination. The user will lose access to their existing comment history, because according to Coral, they are a new and different user.
  • If you're still experiencing issues, log a support ticket so we can help diagnose the issue

An Admin user logged in via SSO is not automatically logged in to Coral Admin from comments MODERATE button#

Make sure you've enabled the option for “Coral Admin” under the "Configure" -> "Authentication" -> “Login with Single Sign On“ settings. This box must be checked to allow users with the MODERATOR or ADMIN roles to access the Moderation/Admin interface using the MODERATE button.

Comments are not loading when embedding the stream in a fixed position container#

Putting Coral inside a position: fixed element is not officially supported. If you do that, you can expect that users sometimes won't be able to load comments on stories which have about 30 or more comments. A workaround can be achieved if you attach a scroll event listener on the scrolling element inside the fixed container which will dispatch a resize event on the window whenever the user scrolls through the comments. This will force a re-rendering of the comment list and will therefore hide the bug, allowing your users to load all the comments on a story. In the following example, .coral-scroller is the scrolling/overflowing container of the coral comment stream:

document.querySelector('.coral-scroller').addEventListener(    'scroll',    () => window.dispatchEvent(new Event('resize')),    { passive: true });