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

Document new JSON settings files 

This mechanism was added in 438e5b3, but we forgot to document it.
This commit is contained in:
Pierre Ossman 2025-04-28 09:56:52 +02:00
parent a22857c99c
commit 88749fc0f9
1 changed files with 21 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/EMBEDDING.md
View File

@ -25,8 +25,27 @@ server and setting up a WebSocket proxy to the VNC server.
## Parameters
The noVNC application can be controlled by including certain settings in the
query string. Currently the following options are available:
The noVNC application can be controlled via a number of settings. All of
them are available in the UI for the user to change, but they can also
be set via other means:
* Via the URL, either as a query parameter:
```
https://www.example.com/vnc.html?reconnect=0&shared=1
```
or as a fragment:
```
https://www.example.com/vnc.html#reconnect=0&shared=1
```
The latter might be preferred as it is not sent to the server.
* Via the files `defaults.json` and `mandatory.json`
Currently, the following options are available:
* `autoconnect` - Automatically connect as soon as the page has finished
loading.