Skip to content

Commit b7c06d4

Browse files
committed
Add installation instructions
1 parent 5e5fcc8 commit b7c06d4

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,36 @@ When this extension is launched it will run a Linux desktop on the Jupyter singl
1010
If a `vncserver` executable is found in `PATH` it will be used, otherwise a bundled TightVNC server is run.
1111
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.
1212

13+
## Installation
14+
15+
1. Install this package itself, with `pip` from `PyPI`:
16+
17+
```bash
18+
pip install jupyter-remote-desktop-server
19+
```
20+
21+
2. Install the [websockify](https://github.com/novnc/websockify) dependency. Unfortunately,
22+
the PyPI `websockify` package is broken, so you need to install it either
23+
from [conda-forge](https://anaconda.org/conda-forge/websockify) or with
24+
[apt](https://packages.ubuntu.com/search?suite=all&searchon=names&keywords=websockify)
25+
26+
3. Install the packages needed to provide the actual Linux Desktop environment.
27+
You need to pick a desktop environment (there are many!) - here is the packages
28+
you would need for using the light-weight [XFCE4](https://www.xfce.org/) desktop environment:
29+
30+
```
31+
dbus-x11
32+
libgl1-mesa-glx
33+
xfce4
34+
xfce4-panel
35+
xfce4-session
36+
xfce4-settings
37+
xorg
38+
xubuntu-icon-theme
39+
```
40+
41+
The recommended way to install these is from your Linux system package manager
42+
of choice (such as apt).
1343

1444
## Docker
1545

0 commit comments

Comments
 (0)