Skip to main content

SSH Spawner: A custom spawner for Jupyterhub to spawn notebooks over SSH

Project description

The sshspawner enables JupyterHub to spawn single-user notebook servers on remote hosts over SSH.

Features

  • Supports SSH key-based authentication

  • Pool of remote hosts for spawning notebook servers

  • Extensible custom load-balacing for remote host pool

  • Remote-side scripting to return IP and port

Requirements

Installation

The sshspawner is installed with the following command:

pip3 install .

Install [scripts/get_port.py](scripts/get_port.py) on remote host and set correct path for c.SSHSpawner.remote_port_command in [jupyterhub_config.py](jupyterhub_config.py)

Configuration

See [jupyterhub_config.py](jupyterhub_config.py) for a sample configuration. Adjust values for your installation.

License

All code is licensed under the terms of the revised BSD license.

Credit

Based on the reference implementation by the NERSC [SSHSpawner](https://github.com/NERSC/sshspawner)

Resources

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

sshspawner-0.0.0a0-py3-none-any.whl (7.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page