Skip to content

document #fragment url usage #56

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

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

document #fragment url usage #56

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
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,20 @@ accessing a MicroPython REPL (interactive prompt) over WebSockets.

To start WebREPL terminal client, clone or download this repository
(in full) and open webrepl.html in a browser. Recent versions of
Firefox and Chrome (or Chromium) are supported.
Firefox, Chrome (or Chromium) and Edge are supported.

The latest version of the client is also hosted online at
http://micropython.org/webrepl (note: while it's hosted online,
all interaction with your boards still happen locally in your
own network).

It is possible to include the IP or FQDN of the device to connect as
part of the url as a fragment. Add `/#<address>:<port>` to the webrepl url. Do not include the initial 'ws://',
however the port needs to be specified.
- `http://micropython.org/webrepl/#<fqdn or ip>:<port>/`
- `http://micropython.org/webrepl/#192.168.4.123:8266/`
- `http://micropython.org/webrepl/#micropython.local:8266`

At this time, WebREPL client cannot be accessed over HTTPS connections.
This is due to not widely published policy that HTTPS pages may
access only WSS (WebSocket Secure) protocol. This is somewhat
Expand Down