Skip to content
This repository was archived by the owner on Jul 16, 2024. It is now read-only.

SwissDataScienceCenter/renku-jupyterlab-vnc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DEPRECATED

noVNC for Jupyterlab on RENKU has moved to renku-vnc

renku-jupyterlab-vnc

A JupyterLab extension for VNC.

  • This extension creates a menu, palette and a launcher for opening a VNC frame in a Jupyterlab tab.
  • This extension will not work as a standalone, it is meant to be used with jupyterlab.
  • This extension does not provide a VNC server, which must be started independently.

The extension should be used with the Docker image built from docker/Dockerfile, or equivalent.

Prerequisites

  • JupyterLab
  • Jupyterlab nbserverproxy
  • A web-based VNC server

Installation

jupyter labextension install @renku/jupyterlab-vnc

See ./docker/Dockerfile for an example.

TODO

This was quickly put together for a PoC and not meant to be production-ready.

It requires the minimal novnc, webproxy, openbox, x11vnc, xvfb combo in a docker container, but it should work with other VNC server and windows manager.

The VNC is started before Jupyterlab starts. It uses nbserverproxy to further proxy novnc's 6080 port through Jupyterlab's 8888, which requires some runtime adjustment to properly set the path parameter in the URL. This is currently done in the plugin's settings before starting jupyterlab, which could be better handled with a server extensions.

Opengl will not work with xvfb, you'll probably need xorg if that's what you want.

Ports numbers and screen resolution are hardcoded.

Development

For a development environment (requires npm version 4 or later), do the following in the repository directory:

npm install
npm run build
jupyter labextension link .

To rebuild the package and the JupyterLab app:

npm run build
jupyter lab build

About

Jupyterlab VNC extension for Renku

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •