gutow / tljh_grp_utils

Some utilities for managing shared directories for littlest jupyter hub users

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.

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 <grpname>. The group name should be one word. The group hub_<grpname> will be created and the shared space located at /opt/hubshare/<grpname>. The location was chosen so that you will not forget about the directories if you are removing tljh.
2. Populate the group with the appropriate hub users: sudo gpasswd -M jupyter-userA,jupyter-userB,jupyter-userC,... hub_<grpname>. Make sure there are no spaces after the commas separating the usernames.
3. Create a link in each group member's home directory to the shared directory: sudo ./lnhubgrp <grpname>. 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.
2. 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 [email protected] | June 2020 | license: GPLV3+

tljh_grp_utils's Issues

Error in lnhubgrp

After running the command
sudo ./lnhubgrp dev

I get the output
Creating links to: /opt/hubshare/dev

./lnhubgrp: line 21: members: command not found

Please let me know what went wrong for me and if there's a way to solve it?