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

Uploaded Source

Built Distribution

jupyterhub_traefik_proxy-0.1.6-py3-none-any.whl (34.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyterhub-traefik-proxy-0.1.6.tar.gz
  • Upload date:
  • Size: 37.5 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.3.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.1

File hashes

Hashes for jupyterhub-traefik-proxy-0.1.6.tar.gz
Algorithm Hash digest
SHA256 afa534d1040adf931e627faecf2ba7a2d1ea2e5b601335c27921481e9ae18610
MD5 32c754471416c470343e044a811883fd
BLAKE2b-256 1e68167bc6ed50158f6e255a7aed4fc3bc11a29e1a338d0e0b2e9e04c3385999

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: jupyterhub_traefik_proxy-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 34.4 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.3.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.1

File hashes

Hashes for jupyterhub_traefik_proxy-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4f18649b9b9ef7410f6502ad0765751818861c093df95abe6839833dcf8f3641
MD5 ab955458570c100331246406ce5ef08c
BLAKE2b-256 f7bbc331a897ff69c78da118cd762e119f7233ae72fc714fe84ea19208e8df94

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