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.0b3.tar.gz (34.0 kB view details)

Uploaded Source

Built Distribution

jupyterhub_traefik_proxy-1.0.0b3-py3-none-any.whl (32.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for jupyterhub-traefik-proxy-1.0.0b3.tar.gz
Algorithm Hash digest
SHA256 ebd97dcca7c80f334e93401d4085e5b3baa049d98115d1c3525a99f3ec4f0860
MD5 840d10101e7fbafd9b6347d104390090
BLAKE2b-256 32cd6c910651e8dc65652fda07b5949a1b1413a43c2f44141fe5c11710273f8b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for jupyterhub_traefik_proxy-1.0.0b3-py3-none-any.whl
Algorithm Hash digest
SHA256 b8145c5e6a15ba7713856abd057467d62533553b318f8aec4dae999587307231
MD5 c7edd53f2532786f1101b2d806b05925
BLAKE2b-256 b0dffa14e8e3c9bb9f9aa04c801dd3bb96a151e064f683e4d851fbf10fddb5cc

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