https://github.com/gutow/tljh_grp_utils

Some utilities for managing shared directories for littlest jupyter hub users
https://github.com/gutow/tljh_grp_utils

administration hub-users jupyterhub sharing-data sharing-notebooks tljh

Last synced: 21 days ago
JSON representation

Some utilities for managing shared directories for littlest jupyter hub users

• Host: GitHub
• URL: https://github.com/gutow/tljh_grp_utils
• Owner: gutow
• License: gpl-3.0
• Created: 2020-06-21T01:26:46.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-06-27T01:36:56.000Z (over 2 years ago)
• Last Synced: 2024-04-15T15:02:37.665Z (9 months ago)
• Topics: administration, hub-users, jupyterhub, sharing-data, sharing-notebooks, tljh
• Language: Shell
• Size: 18.6 KB
• Stars: 15
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: license-GPLV3+.txt

Awesome Lists containing this project

README

        
# The littlest Jupyter Hub Group Utilities

This repository contains tools developed to facilitate creating groups

of hub users that can share files with each other both in a fixed

"published" form and a "shared" form that can be edited by anybody in

the group. These tools were developed primarily with the administration

of small groups (University Classes) in mind. The sharing mechanism is

based on the ideas discussed in this

[github issue](https://github.com/jupyterhub/jupyterhub/issues/394).

Using these tools presently requires a three step process (assuming

a working littlest jupyterhub installation with users):

1. Run the script to create the group and its shared space:

`sudo ./mkhubgrp `. The group name should be one word. The

group `hub_` will be created and the shared space located

at `/opt/hubshare/`. The location was chosen so that you will not

forget about the directories if you are removing tljh.

1. Populate the group with the appropriate hub users:

`sudo gpasswd -M jupyter-userA,jupyter-userB,jupyter-userC,... hub_`.

__Make sure there are no spaces after the commas separating the usernames.__

1. Create a link in each group member's home directory to the shared

directory: `sudo ./lnhubgrp `. The link does not reliably appear

until the user restarts their server.

There are two subfolders within the shared folder:

1. `shared` any documents created initially in this folder can be modified by

    all members of the group. Things copied to this folder will maintain their

    original permissions, which typically only allow reading by the group.

1. `published` documents created in subfolders of this folder can not be

    modified or deleted by other members of the group, only the owner.

    However, all members of the group can read and copy these documents.

    Documents should not be saved directly in the `published`

    folder because any member of the group can delete them, but not edit.

     

Hope this is useful to some. I encourage someone to integrate this into

the jupyterhub administrative web interface.

Jonathan Gutow  | 

June 2020 | 

license: GPLV3+