From b7c06d446f552214b5f41b19ed7274c8793bbacc Mon Sep 17 00:00:00 2001 From: YuviPanda Date: Sat, 14 Jan 2023 12:07:41 -0800 Subject: [PATCH] Add installation instructions --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index c85b2223..b60b0f47 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,36 @@ When this extension is launched it will run a Linux desktop on the Jupyter singl 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. +## Installation + +1. Install this package itself, with `pip` from `PyPI`: + + ```bash + pip install jupyter-remote-desktop-server + ``` + +2. Install the [websockify](https://github.com/novnc/websockify) dependency. Unfortunately, + the PyPI `websockify` package is broken, so you need to install it either + 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: + + ``` + dbus-x11 + libgl1-mesa-glx + xfce4 + xfce4-panel + xfce4-session + xfce4-settings + xorg + xubuntu-icon-theme + ``` + + The recommended way to install these is from your Linux system package manager + of choice (such as apt). ## Docker