Skip to content
This repository has been archived by the owner on Aug 1, 2021. It is now read-only.
/ simplespawner Public archive

A simple variant of LocalProcessSpawner for JupyterHub that doesn't require users exist on the system

License

Notifications You must be signed in to change notification settings

jupyterhub/simplespawner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

⚠️⚠️⚠️ DEPRECATED ⚠️⚠️⚠️

SimpleLocalProcessSpawner is now a part of JupyterHub core. You can migrate to it by setting:

c.JupyterHub.spawner_class = "simple"

The JupyterHub documentation has more information on how to setup a development environment

JupyterHub Simple Spawner

A very simple Spawner for JupyterHub that spawns local processes.

DO NOT USE THIS FOR PRODUCTION USE CASES! It is incredibly insecure, and offers no user isolation at all. This is intended only for testing purposes.

What?

It spawns new notebooks for users, but as the same user as jupyterhub. This has the following advantages: 1. No need to run JupyterHub as root 2. Users don't need to exist in the system.

However, it offers absolutely no isolation whatsoever, so users can very easily mess with each others' processes. So do not use this in a production environment of any sort.

Installation

You can install it from pip via:

pip install jupyterhub-simplespawner

You can set JupyterHub to use this spawner with the following line in your jupyterhub_config.py:

c.JupyterHub.spawner_class = 'simplespawner.SimpleLocalProcessSpawner'

Configuration

You can configure where the users have their homes with the home_path_template config parameter. You can use {userid} and {username} in the template and they will be expanded to appropriate values.

Use with...

This can be used to good effect with the DummyAuthenticator to provide simple testing environments.

About

A simple variant of LocalProcessSpawner for JupyterHub that doesn't require users exist on the system

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages