Skip to content
This repository has been archived by the owner on Jul 12, 2023. It is now read-only.

Commit

Permalink
Add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
yuvipanda committed Jan 14, 2023
1 parent 5e5fcc8 commit b7c06d4
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit b7c06d4

Please sign in to comment.