Définir des actions personnalisées dans JupyterHub (fonction hook)

Vous pouvez utiliser la fonction hook de JupyterHub pour créer automatiquement un répertoire pour chaque utilisateur lorsque vous vous connectez.

Définissez-le comme une fonction dans le fichier de configuration (jupyterhub_config.py). Il existe les types de crochets suivants.

• c.JupyterHub.user_redirect_hook
• c.Spawner.auth_state_hook
• c.Spawner.post_stop_hook
• c.Spawner.pre_spawn_hook
• c.Authenticator.post_auth_hook

• L'explication détaillée de chacun est omise (non étudiée)

Des exemples de scripts sont disponibles dans le référentiel officiel.

jupyterhub/examples/bootstrap-script at master · jupyterhub/jupyterhub

Par exemple, l'action de raccordement qui crée automatiquement un dossier utilisateur est la suivante.

# in jupyterhub_config.py  
import os
def create_dir_hook(spawner):
    username = spawner.user.name # get the username
    volume_path = os.path.join('/volumes/jupyterhub', username)
    if not os.path.exists(volume_path):
        # create a directory with umask 0755 
        # hub and container user must have the same UID to be writeable
        # still readable by other users on the system
        os.mkdir(volume_path, 0o755)
        # now do whatever you think your user needs
        # ...
        pass

# attach the hook function to the spawner
c.Spawner.pre_spawn_hook = create_dir_hook

• Puisqu'il appartiendra à l'utilisateur de démarrage, il semble préférable d'utiliser également chown / chmod.