@@ -16,14 +16,21 @@ When this extension is launched it will run a Linux desktop on the Jupyter singl
16
16
17
17
## VNC Server
18
18
19
- This extension requires a [ VNC Server] ( https://en.wikipedia.org/wiki/Virtual_Network_Computing )
20
- to be installed on the system (likely, in the container image). The
21
- most tested VNC server is [ TigerVNC] ( https://tigervnc.org/ ) , while
22
- [ TurboVNC] ( https://www.turbovnc.org/ ) also works. Any VNC server available
23
- in ` $PATH ` as ` vncserver ` will be used, but no real testing outside of
24
- these servers has been performed.
25
-
26
- For an example, see the [ ` Dockerfile ` ] ( ./Dockerfile ) in this repository which installs TigerVNC and XFCE4.
19
+ This extension requires installing a [ VNC server] on the system (likely in a
20
+ container image). Compatibility with the latest version of [ TigerVNC] and
21
+ [ TurboVNC] is maintained and verified with tests, but other VNC servers
22
+ available in ` $PATH ` as ` vncserver ` could also work. The ` vncserver ` binary
23
+ needs to accept the [ flags seen passed here] , such as ` -rfbunixpath ` and a few
24
+ others.
25
+
26
+ For an example, see the [ ` Dockerfile ` ] ( ./Dockerfile ) in this repository which
27
+ installs either TigerVNC or TurboVNC together with XFCE4.
28
+
29
+ [ vnc server ] : https://en.wikipedia.org/wiki/Virtual_Network_Computing
30
+ [ tigervnc ] : https://tigervnc.org/
31
+ [ turbovnc ] : https://www.turbovnc.org/
32
+ [ flags seen passed here ] : https://github.com/jupyterhub/jupyter-remote-desktop-proxy/blob/main/jupyter_remote_desktop_proxy/setup_websockify.py
33
+ [ xfce4 ] : https://www.xfce.org/
27
34
28
35
## Installation
29
36
0 commit comments