Skip to content
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.

Sign up for GitHub

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

Add section clarifying WebSocket usage to README #212

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add section clarifying WebSocket usage to README #212

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,22 @@ Congrats, you can now share the presented link to the world.

For more information head over to [docs](https://loophole.cloud/docs/).

## Having issues with WebSocket?
Because Loophole will always start connections to clients with HTTPS, it is not possible to establish plain
**ws://** connections, only **wss://** (WebSocket Secure) will work. In fact, establishing a **ws://**
connection from HTTPS would even be considered a security issue, which means that e.g. browsers block this
by default. This is not something we at Loophole can change.

If you use **wss://** and have checked that it works locally but are still experiencing issues, try the following:
### Desktop version:
- Make sure the box named "The server is already using HTTPS." is ticked.
### CLI version:
- Make sure you use the --https flag.

If your problem still persists, feel free to open a new
[Issue](https://github.com/loophole/cli/issues/new?assignees=&labels=bug&template=bug_report.md&title=) and tell us
about it!


## Development

Expand Down