Skip to main content

JupyterHub proxy implementation with traefik

Project description

JupyterHub Traefik Proxy

Build Status Documentation Status

An implementation of the JupyterHub proxy api with traefik: an extremely lightweight, portable reverse proxy implementation, that supports load balancing and can configure itself automatically and dynamically.

There are three versions for the proxy, depending on how traefik stores the routes:

  • for smaller, single-node deployments:
    • TraefikTomlProxy
  • for distributed setups:
    • TraefikEtcdProxy
    • TraefikConsulProxy

Instalation

You can find a complete installation guide here.

Documentation

The latest documentation is available at: https://jupyterhub-traefik-proxy.readthedocs.io/en/latest/.

Running the 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 with:

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

Example setups:

JupyterHub configuration examples

You can use the configuration examples in the examples directory in order to configure JupyterHub to run with TraefikProxy.

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.1.4
Filename, size File type Python version Upload date Hashes
Filename, size jupyterhub_traefik_proxy-0.1.4-py3-none-any.whl (33.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size jupyterhub-traefik-proxy-0.1.4.tar.gz (36.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page