Skip to main content

JupyterHub proxy implementation with traefik

Project description

JupyterHub Traefik Proxy

Documentation build status GitHub Workflow 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:

  • TraefikFileProviderProxy

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.

Source Distribution

jupyterhub-traefik-proxy-1.0.0b1.tar.gz (49.4 kB view details)

Uploaded Source

Built Distribution

jupyterhub_traefik_proxy-1.0.0b1-py3-none-any.whl (37.4 kB view details)

Uploaded Python 3

File details

Details for the file jupyterhub-traefik-proxy-1.0.0b1.tar.gz.

File metadata

File hashes

Hashes for jupyterhub-traefik-proxy-1.0.0b1.tar.gz
Algorithm Hash digest
SHA256 c3285d784c65c8069151717d0a7e2a2ad1f61d4f2ba72cce6af982d3f1a5f8b5
MD5 e20af62bea13afc80655e03476760de4
BLAKE2b-256 c28a3872c06be59cfe66e046ac67b98553ff4fc0e03c81c40c9401ba6dd40d97

See more details on using hashes here.

Provenance

File details

Details for the file jupyterhub_traefik_proxy-1.0.0b1-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterhub_traefik_proxy-1.0.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 1c5a7139687c8144af36cbff626279418f57a9f2f692da6d6d8d2441faf0d25f
MD5 cc635d3f01010f902f85a2bf1148f151
BLAKE2b-256 dd011398bf7a7f267c2a084d4f2ede610905801712e8844d48555feb09a5c06d

See more details on using hashes here.

Provenance

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