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.1.0.tar.gz (39.4 kB view details)

Uploaded Source

Built Distribution

jupyterhub_traefik_proxy-1.1.0-py3-none-any.whl (26.2 kB view details)

Uploaded Python 3

File details

Details for the file jupyterhub-traefik-proxy-1.1.0.tar.gz.

File metadata

File hashes

Hashes for jupyterhub-traefik-proxy-1.1.0.tar.gz
Algorithm Hash digest
SHA256 9e67eb354165b9400fb5a01c4272b4c2073dbd81fbbcd4e766ea7a62fac12cde
MD5 3e4bbf5269749f178024d36bcd6926c3
BLAKE2b-256 66ae4da951fac82b454cb3cd9e9dfdd64ca7253ecc348471865e7eca87aeddc0

See more details on using hashes here.

Provenance

File details

Details for the file jupyterhub_traefik_proxy-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterhub_traefik_proxy-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6972d8eb788274d1d541c11cc10764d94a6829843bdb15873b60e19519bd4d5c
MD5 43172ceeab2c2787ee3b70f2817b57ca
BLAKE2b-256 8b466ad7fad30599403df6395e8a56cae6a4a823d2a3ab4d489ecb7d2d1f839d

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