Merge pull request #84 from manics/pr62

Remove bundled VNC server

.pre-commit-config.yaml

@@ -77,10 +77,6 @@ repos:
         types: [file]
         exclude: jupyter_remote_desktop_proxy/static/dist
 
-# Content here is mostly copied from other locations, so lets not make
-# formatting changes in it.
-exclude: share
-
 # pre-commit.ci config reference: https://pre-commit.ci/#configuration
 ci:
   autoupdate_schedule: monthly

README.md

@@ -12,8 +12,16 @@ This is based on https://github.com/ryanlovett/nbnovnc.
 
 When this extension is launched it will run a Linux desktop on the Jupyter single-user server, and proxy it to your browser using VNC via Jupyter.
 
-If a `vncserver` executable is found in `PATH` it will be used, otherwise a bundled TightVNC server is run.
-You can use this to install vncserver with support for other features, for example the [`Dockerfile`](./Dockerfile) in this repository installs TurboVNC for improved OpenGL support.
+## VNC Server
+
+This extension requires a [VNC Server](https://en.wikipedia.org/wiki/Virtual_Network_Computing)
+to be installed on the system (likely, in the container image). The
+most tested VNC server is [TigerVNC](https://tigervnc.org/), while
+[TurboVNC](https://www.turbovnc.org/) also works. Any VNC server available
+in `$PATH` as `vncserver` will be used, but no real testing outside of
+these servers has been performed.
+
+For an example, see the [`Dockerfile`](./Dockerfile) in this repository which installs TigerVNC and XFCE4.
 
 ## Installation
 
@@ -28,19 +36,20 @@ You can use this to install vncserver with support for other features, for examp
    from [conda-forge](https://anaconda.org/conda-forge/websockify) or with
    [apt](https://packages.ubuntu.com/search?suite=all&searchon=names&keywords=websockify)
 
-3. Install the packages needed to provide the actual Linux Desktop environment.
-   You need to pick a desktop environment (there are many!) - here is the packages
-   you would need for using the light-weight [XFCE4](https://www.xfce.org/) desktop environment:
+3. Install the packages needed to provide a VNC server and the actual Linux Desktop environment.
+   You need to pick a desktop environment (there are many!) - here are the packages
+   to use TigerVNC and the light-weight [XFCE4](https://www.xfce.org/) desktop environment on Ubuntu 22.04:
 
    ```
    dbus-x11
-   libgl1-mesa-glx
    xfce4
    xfce4-panel
    xfce4-session
    xfce4-settings
    xorg
    xubuntu-icon-theme
+   tigervnc-standalone-server
+   tigervnc-xorg-extension
    ```
 
    The recommended way to install these is from your Linux system package manager

jupyter_remote_desktop_proxy/setup_websockify.py

@@ -13,9 +13,10 @@ def setup_websockify():
     sockets_path = os.path.join(sockets_dir, 'vnc-socket')
     vncserver = which('vncserver')
 
-    if vncserver is None:
-        # Use bundled tigervnc
-        vncserver = os.path.join(HERE, 'share/tigervnc/bin/vncserver')
+    if not vncserver:
+        raise RuntimeError(
+            "vncserver executable not found, please install a VNC server"
+        )
 
     # TigerVNC provides the option to connect a Unix socket. TurboVNC does not.
     # TurboVNC and TigerVNC share the same origin and both use a Perl script