From a22857c99c130b9a4d7dd647b42c086b56fe6cfd Mon Sep 17 00:00:00 2001 From: Pierre Ossman Date: Mon, 28 Apr 2025 09:55:49 +0200 Subject: [PATCH] Document new behaviour of host/port/encrypt/path This changed in 96c76f7, but we forgot to adjust the documentation for the parameters. --- docs/EMBEDDING.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/EMBEDDING.md b/docs/EMBEDDING.md index b411de82..73285993 100644 --- a/docs/EMBEDDING.md +++ b/docs/EMBEDDING.md @@ -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.