Skip to content

Commit 88749fc

Browse files
committed
Document new JSON settings files
This mechanism was added in 438e5b3, but we forgot to document it.
1 parent a22857c commit 88749fc

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

docs/EMBEDDING.md

+21-2
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,27 @@ server and setting up a WebSocket proxy to the VNC server.
2525

2626
## Parameters
2727

28-
The noVNC application can be controlled by including certain settings in the
29-
query string. Currently the following options are available:
28+
The noVNC application can be controlled via a number of settings. All of
29+
them are available in the UI for the user to change, but they can also
30+
be set via other means:
31+
32+
* Via the URL, either as a query parameter:
33+
34+
```
35+
https://www.example.com/vnc.html?reconnect=0&shared=1
36+
```
37+
38+
or as a fragment:
39+
40+
```
41+
https://www.example.com/vnc.html#reconnect=0&shared=1
42+
```
43+
44+
The latter might be preferred as it is not sent to the server.
45+
46+
* Via the files `defaults.json` and `mandatory.json`
47+
48+
Currently, the following options are available:
3049

3150
* `autoconnect` - Automatically connect as soon as the page has finished
3251
loading.

0 commit comments

Comments
 (0)