Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 1.9 KB

README.md

File metadata and controls

42 lines (27 loc) · 1.9 KB
Raw

tljh-neurodesk

Tells TLJH to use DockerSpawner to spin up vnmd/neurodesktop containers for each user.

System Requirements

TLJH and the neurodesk plugin require Ubuntu 20.04+ or Debian 11+

Install

Include --plugin tljh-neurodesk in your TLJH install script. For example, here user neurodesk with password password installs TLJH with tljh-neurodesk:

#!/bin/bash

curl https://raw.githubusercontent.com/jupyterhub/the-littlest-jupyterhub/master/bootstrap/bootstrap.py \
  | sudo python3 - \
    --admin neurodesk:password --plugin git+https://github.com/Neurodesk/tljh-neurodesk

Now you can reach jupyterlab on your server. If it doesn't work yet, repeat the above one more time. If it still doesn't work check that port 80 is open in the firewall.

Security

Note that this setup doesn't isolate users from each other and the desktop runs effectively with root permissions for everyone. Only use this setup in an environment where you can trust every user using the TLJH instance.

Update

git clone https://github.com/NeuroDesk/tljh-neurodesk
cd tljh-neurodesk/
wget https://raw.githubusercontent.com/jupyterhub/the-littlest-jupyterhub/master/bootstrap/bootstrap.py
sudo python3 bootstrap.py --plugin .

Attribution

This plugin was inspired by https://github.com/pennchildlanglab/tljh-datascience which was inspired by this Ideonate post and the Rxns stack plugin

To-do

  • figure out how to include jupyterlab plugins (probably just a docker image based on the neurodesk-notebook is the easiest)
  • we could prob do this without using subprocesses -- maybe require dockerspawner in the setup.py and then import it; and then just install docker.io via additional apt packages.