Skip to content

Commit 766ffb0

Browse files
committed
update readme
1 parent 7ee822e commit 766ffb0

File tree

1 file changed

+66
-1
lines changed

1 file changed

+66
-1
lines changed

README.md

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,67 @@
11
# jupyter-xprahtml5-server
2-
Run a Xpra Session on a JupyterHub
2+
--------------------------
3+
Integrate Xpra in your Jupyter environment for an fast, feature-rich and easy to use remote desktop in the browser.
4+
5+
## Requirements
6+
---------------
7+
8+
- Python 3.6+
9+
- Jupyter Notebook 6.0+
10+
- JupyterLab 2.1+
11+
12+
This package executes the `xpra` command. This command assumes the `xpra` command is available in the environment's PATH.
13+
14+
15+
### Xpra
16+
[Xpra](https://xpra.org/) is an open-source multi-platform persistent *remote display* solution for forwarding applications and desktop screens. It allows you to run X11 programs, usually on a remote host, and direct their display to your local machine.
17+
Best of it. It is fast, fast, fast and comes with a build-in html5 client to allow remote.
18+
19+
### Jupyter-Server-Proxy
20+
[Jupyter-Server-Proxy](https://jupyter-server-proxy.readthedocs.io) lets you run arbitrary external processes (such as Xpra-HTML5) alongside your notebook, and provide authenticated web access to them.
21+
22+
## Install
23+
----------
24+
25+
#### Create and Activate Environment
26+
27+
```
28+
virtualenv -p python3 venv
29+
source venv/bin/activate
30+
```
31+
32+
#### Install jupyter-xprahtml5-proxy
33+
34+
```
35+
pip install git+https://github.com/FZJ-JSC/jupyter-xprahtml5-server.git
36+
```
37+
38+
#### Enable jupyter-xprahtml5-proxy Extensions
39+
40+
For Jupyter Classic, activate the jupyter-server-proxy extension:
41+
```
42+
jupyter serverextension enable --sys-prefix jupyter_server_proxy
43+
```
44+
45+
For Jupyter Lab, install the @jupyterlab/server-proxy extension:
46+
```
47+
jupyter labextension install @jupyterlab/server-proxy
48+
jupyter lab build
49+
```
50+
51+
#### Start Jupyter Classic or Jupyter Lab
52+
53+
Click on the Xpra icon from the Jupyter Lab Launcher or the Xpra item from the New dropdown in Jupyter Classic.
54+
Connect to your database as instructed in the Quickstart section.
55+
56+
## Configuration
57+
----------------
58+
59+
This package calls `xpra` with a bunch of settings. Please read the [Xpra manual](https://xpra.org/manual.html) if you want to now the details.
60+
You have to modify `setup_xprahtml5()` in `jupyter_xprahtml5/__init__.py` for change.
61+
62+
## Credits
63+
- Xpra
64+
- jupyter-server-proxy
65+
66+
## License
67+
BSD 3-Clause

0 commit comments

Comments
 (0)