kafonek / tljh-shared-directory

Plugin for The Littlest JupyterHub (TLJH) that creates a shared-directory and installs Voila
BSD 3-Clause "New" or "Revised" License
5 stars 6 forks source link

tljh-shared-directory

tljh-shared-directory is a plugin for The Littlest JupyterHub (TLJH) which sets up a 'shared directory' for the Hub in /srv/scratch. The /srv/scratch shared directory is used to 'publish' notebooks internally within the Hub. E.g. if there are three users, then User A may develop a Notebook in their /home/user_a directory and when it is complete copy it to /srv/scratch (symlinked in every user's home) so that User B and User C can see the Notebook. However, only User A is able to make further changes to it.

Shared directories go hand-in-hand with Dashboarding apps like Voila or Panel. User A copies a Notebook into the /srv/scratch directory, then other users can view that Notebook as a Dashboard.

Install

Include --plugin tljh-shared-directory in your TLJH install script. An example install with admin user kafonek would be:

#!/bin/bash
curl https://raw.githubusercontent.com/jupyterhub/the-littlest-jupyterhub/master/bootstrap/bootstrap.py \
  | sudo python3 - \
    --admin kafonek --plugin git+https://github.com/kafonek/tljh-shared-directory