https://github.com/kafonek/tljh-shared-directory

Plugin for The Littlest JupyterHub (TLJH) that creates a shared-directory and installs Voila
https://github.com/kafonek/tljh-shared-directory

Last synced: 2 months ago
JSON representation

Plugin for The Littlest JupyterHub (TLJH) that creates a shared-directory and installs Voila

• Host: GitHub
• URL: https://github.com/kafonek/tljh-shared-directory
• Owner: kafonek
• License: bsd-3-clause
• Created: 2019-06-04T14:24:01.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-06-05T10:53:20.000Z (over 5 years ago)
• Last Synced: 2024-08-02T12:44:33.682Z (6 months ago)
• Language: Python
• Size: 4.88 KB
• Stars: 5
• Watchers: 1
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - kafonek/tljh-shared-directory - Plugin for The Littlest JupyterHub (TLJH) that creates a shared-directory and installs Voila (others)

README

        
# tljh-shared-directory

`tljh-shared-directory` is a plugin for [The Littlest JupyterHub (TLJH)](https://tljh.jupyter.org) 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

```