Skip to content

[Tunnel] Add a hint for workers + websocket error #21076

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: production
Choose a base branch
from

Conversation

cicku
Copy link
Contributor

@cicku cicku commented Mar 23, 2025

Documentation checklist

@deadlypants1973
Copy link
Contributor

Hey @cicku , thank you for the PR. Is there context attached to this? Where did it come from?

@cicku
Copy link
Contributor Author

cicku commented Mar 29, 2025

From personal experience.

…roubleshoot-tunnels/common-errors.mdx

Co-authored-by: Kate Tungusova <[email protected]>
Copy link
Contributor

hyperlint-ai bot commented Apr 29, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Enhanced documentation for troubleshooting tunnels by adding a new hint regarding Workers routes and websocket errors.

  • Added a hint about overlapping Workers routes affecting tunnel hostname handling.
  • Clarified the impact of websocket errors on tunnel connections.

Modified Files

  • src/content/docs/cloudflare-one/connections/connect-networks/troubleshoot-tunnels/common-errors.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@@ -92,6 +92,8 @@ There are a few different possible root causes behind the `websocket: bad handsh

- Your SSH or RDP Access application has the [Binding Cookie](/cloudflare-one/identity/authorization-cookie/#binding-cookie) enabled. To disable the cookie, go to **Access** > **Applications** and edit the application settings.

- One or more [Workers routes](/workers/configuration/routing/routes/) are overlapping with the tunnel hostname, and the Workers do not properly handle the traffic. To resolve, check if the Workers routes or the Worker code can be adjusted accordingly.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- One or more [Workers routes](/workers/configuration/routing/routes/) are overlapping with the tunnel hostname, and the Workers do not properly handle the traffic. To resolve, check if the Workers routes or the Worker code can be adjusted accordingly.
- One or more [Workers routes](/workers/configuration/routing/routes/) are overlapping with the tunnel hostname, and the Workers do not properly handle the traffic. To resolve, you could either exclude your tunnel from the Worker route by not defining a route that includes the tunnel's hostname or update your Worker to only handle specific paths and forward all other requests to the origin, for example, by using `return fetch(req)`.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants