Skip to main content

JupyterHub proxy implementation with traefik

Project description

JupyterHub Traefik Proxy

Documentation build status TravisCI (.org) build 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.

Source Distribution

jupyterhub-traefik-proxy-0.1.5.tar.gz (37.4 kB view details)

Uploaded Source

Built Distribution

jupyterhub_traefik_proxy-0.1.5-py3-none-any.whl (34.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyterhub-traefik-proxy-0.1.5.tar.gz
  • Upload date:
  • Size: 37.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.7.1

File hashes

Hashes for jupyterhub-traefik-proxy-0.1.5.tar.gz
Algorithm Hash digest
SHA256 8d239a59d8b55979d0509c6d7609f9415c5a7d60339536bc6eab56f65d99b669
MD5 54545cd9a9c127cf00e44c20181b422d
BLAKE2b-256 e9e821ec32a9ca2ed81c76eda9d498b85cd595d04686e162935c4481e8545eae

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: jupyterhub_traefik_proxy-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 34.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.7.1

File hashes

Hashes for jupyterhub_traefik_proxy-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c8aa089d0f95af20a9cb3b772e045f6996421ce100a13897d0dd18ff4b465717
MD5 0596bf8860c4847693ecab4b97b93761
BLAKE2b-256 c2fc4f9683f55a32bc2076e928a3e1900f116ed1519f76806c564f1b9c130ed4

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