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
File details
Details for the file sqre-ghowlauth-0.0.5.tar.gz
.
File metadata
- Download URL: sqre-ghowlauth-0.0.5.tar.gz
- Upload date:
- Size: 5.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0817a9b38758a6b8d6480084390dbb6891cd6fbbbaf835297af342255fe4381 |
|
MD5 | 891e8331ac08b24f3b1b189d527bcbeb |
|
BLAKE2b-256 | 8237b28f7242cf4c91c065798b25c40901ac96d588aedc34956c9219583b5678 |
File details
Details for the file sqre_ghowlauth-0.0.5-py2.py3-none-any.whl
.
File metadata
- Download URL: sqre_ghowlauth-0.0.5-py2.py3-none-any.whl
- Upload date:
- Size: 6.3 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0865c079039de9f6f57aa43586e341041254eb8fe632f2996674a2892e3ef299 |
|
MD5 | e7da49855261ad4e8a93087fb5b115c8 |
|
BLAKE2b-256 | b4f92339f29eaa5c8bf7ecf3891b7e43ca25d60d870875ecfd8dea32910c50fb |