jcarr
/
noVNC
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document new behaviour of host/port/encrypt/path 

This changed in 96c76f7, but we forgot to adjust the documentation for
the parameters.
This commit is contained in:
Pierre Ossman 2025-04-28 09:55:49 +02:00
parent d7a37730e6
commit a22857c99c
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/EMBEDDING.md
View File

@ -37,13 +37,18 @@ query string. Currently the following options are available:
* `reconnect_delay` - How long to wait in milliseconds before attempting to
reconnect.
* `host` - The WebSocket host to connect to.
* `host` - The WebSocket host to connect to. This setting is deprecated
in favor of specifying a URL in `path`.
* `port` - The WebSocket port to connect to.
* `port` - The WebSocket port to connect to. This setting is deprecated
in favor of specifying a URL in `path`.
* `encrypt` - If TLS should be used for the WebSocket connection.
* `encrypt` - If TLS should be used for the WebSocket connection. This
setting is deprecated in favor of specifying a URL in `path`.
* `path` - The WebSocket path to use.
* `path` - The WebSocket URL to use. It can be either an absolute URL,
or a URL relative vnc.html. If `host` is specified, then `path` will
be interpreted as the path component in the URL instead.
* `password` - The password sent to the server, if required.