Skip to main content

FAQ/Troubleshooting

General Questions​

Q: What is the Tide Cloak SDK?

  • A: The Tide Cloak SDK allows you to integrate TideCloak to manage user authentication in a secure manner.

Q: What are the prerequisites for using these SDKs and guides?

  • A:
    • For TideCloak: Ensure Docker is installed, and you have basic knowledge of Docker and CLI.
    • For TideCloak SDK: Ensure you have a running TideCloak instance, a configured realm and client, basic knowledge of HTML and JavaScript, and Python installed.

Installation Issues​

Q: I followed the steps to install Docker, but I receive an "unsupported platform" error. What should I do?

  • A: This error typically occurs if Docker is being installed on an unsupported platform. Please ensure that your operating system matches the supported platforms mentioned in the Docker documentation.

Q: Docker installation on Linux is failing during the update step. What might be the problem?

  • A: The update step (sudo apt-get update) might fail if your package list is outdated or if there are connectivity issues. Try checking your internet connection and running the command again. If the issue persists, consult your Linux distribution's support resources.

Q: After installing Docker on Windows, it doesn't start. What should I do?

  • A: Ensure that Docker Desktop is set to start automatically. If it's not running, try starting it manually from the Start menu. If Docker still doesn't start, check if WSL 2 is enabled, as it's recommended for better performance.

Configuration Issues​

Q: How do I configure the Tide Cloak SDK for my project?

  • A:
    • Create an HTML file as described in the guide.
    • Make sure to include the TideCloak JavaScript library and customize the provided example code to match your project requirements.

Q: I'm getting an error when trying to connect TideCloak to my instance. What could be wrong?

  • A: Check that your TideCloak instance is running and accessible. Also, verify that the realm and client configurations in TideCloak match those in TideCloak.

Common Errors​

Q: The TideCloak login example isn't working as expected. How can I debug it?

  • A:
    • Ensure that the JavaScript and HTML files are correctly set up.
    • Open the browser's developer console (F12) to check for any error messages.
    • Make sure that the TideCloak server URL is correctly referenced in your project.

Q: I'm getting a CORS error when integrating TideCloak with my frontend. How can I resolve this?

  • A: CORS (Cross-Origin Resource Sharing) errors often occur when the frontend and TideCloak server are on different domains. Ensure that CORS is properly configured in your TideCloak settings to allow requests from your frontend domain.

Identity Provider (IdP) Questions​

Q: How do I set TideCloak as the default Identity Provider (IdP)?

  • A: To set TideCloak as the default IdP, navigate to the Flows section under Authentication in TideCloak. Edit the browser flow and configure the Identity Provider Redirector to use TideCloak as the default provider. Save the changes, and ensure that the alias and settings are correctly configured.

Q: I'm unable to see TideCloak in the list of Identity Providers. What should I do?

  • A: Ensure that the TideCloak integration is correctly installed and that your TideCloak instance is up to date. If TideCloak is still not visible, check for any integration issues or consult the documentation for installation verification steps.

Q: After setting up TideCloak as the IdP, users are not being redirected to the TideCloak login page. How can I resolve this?

  • A: Verify that TideCloak is set as the default Identity Provider in the TideCloak flows. Ensure that there are no misconfigurations in the redirect URIs and that the client setup in TideCloak correctly references TideCloak. Check the TideCloak logs for any error messages that might indicate what's causing the issue.

Best Practices​

Q: How can I optimize the performance of my Tide Cloak SDK integration?

  • A:
    • Use caching mechanisms for repeated API calls.
    • Regularly update the SDK to benefit from performance improvements.
    • Leverage built-in functions to avoid unnecessary data processing.

Q: What are some security best practices when using TideCloak?

  • A:
    • Ensure that all communication between your application and TideCloak is secured using HTTPS.
    • Regularly rotate API keys and client secrets.
    • Implement proper access control by defining roles and permissions within TideCloak.

Additional Troubleshooting Tips​

  • Community Support: If an issue persists, consider reaching out to community forums or support channels associated with TideCloak for help.
  • Submit a Ticket: If you're unable to resolve the issue through the available resources, you can submit a support ticket. Provide as much detail as possible, including error messages, steps to reproduce the issue, and relevant logs. This will help the support team assist you more effectively.