Skip to main content

JupyterHub proxy implementation with traefik

Project description

JupyterHub Traefik Proxy

Documentation build status GitHub Workflow Status CircleCI build status Latest PyPI version GitHub Discourse Gitter

When JupyterHub starts a server for a user, it will dynamically configure a proxy server so that accessing jupyterhub.example.com/user/<user> routes to the individual Jupyter server. This project contains what JupyterHub need to dynamically configure the routes of a traefik proxy server! There are three implementations of the JupyterHub proxy API, depending on how traefik store its routing configuration.

For smaller, single-node deployments:

  • TraefikTomlProxy

For distributed setups:

  • TraefikEtcdProxy
  • TraefikConsulProxy

Installation

The documentation contains a complete installation guide with examples for the three different implementations.

Running tests

There are some tests that use etcdctl command line client for etcd. Make sure to set environment variable ETCDCTL_API=3 before running the tests, so that the v3 API to be used, e.g.:

$ export ETCDCTL_API=3

You can then run the all the test suite from the traefik-proxy directory with:

$ pytest -v ./tests

Or you can run a specific test file with:

$ pytest -v ./tests/<test-file-name>

Project details


Download files

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

Files for jupyterhub-traefik-proxy, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size jupyterhub_traefik_proxy-0.2.0-py3-none-any.whl (34.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size jupyterhub-traefik-proxy-0.2.0.tar.gz (38.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page