JupyterHub authenticator that uses GH orgs as whitelists
Project description
# sqre-ghowlauth
GitHub Organization WhiteList Authentication
JupyterHub authentication that uses GitHub OAuth2 but additionally checks user org membership against a list defined in the environment variable GITHUB_ORGANIZATION_WHITELIST.
## Installation
sqre-ghowlauth runs on Python 3.3 or greater. You can install it with
`bash pip install sqre-ghowlauth `
This will also install dependencies: jupyterhub and tornado.
## Example usage
Your jupyterhub_config.py file should contain c.JupyterHub.authenticator_class = ‘ghowlauth.GHOWLAuthenticator’ (or you can use LocalGHOWLAuthenticator to handle both local and GitHub auth).
You also must have set the environment variable GITHUB_ORGANIZATION_WHITELIST to be a comma-separated list of organizations whose members you want to permit, e.g. GITHUB_ORGANIZATION_WHITELIST=lsst,lsst-sqre.
The rest of the instructions are the same as those found at https://github.com/jupyterhub/oauthenticator (that is, you still need a callback URL, a client ID, and a client secret).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sqre_ghowlauth-0.0.8-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4eecdb32dc14fe07a15ad6a97cca61ee07e1d7c3191a445a86db00978ae6263b |
|
MD5 | 4e2a6e11d69daf9bd460819d6483958e |
|
BLAKE2b-256 | 6f43127b32303f413a4c17eb32470d92df9265a7d410855661663c2af04dd796 |