# 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).
2 maintainers
Metadata
2 maintainers
Release files for sqre-ghowlauth 0.0.10
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sqre-ghowlauth-0.0.10.tar.gz | 5.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sqre_ghowlauth-0.0.10-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 12.8 kB
Release files / sqre-ghowlauth-0.0.10.tar.gz
| Download URL | sqre-ghowlauth-0.0.10.tar.gz |
|---|---|
| Size | 5.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5b956a733e2179515f7181e82e803ad879408e909b980ec6a6d0c8c7b138b33f
|
|
BLAKE2b-256 checksum How to use checksums |
e1559146e1cf417471b1d712e01ee4caa3f3a5d514e58b93a99ef6ee8d6ba741
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / sqre_ghowlauth-0.0.10-py2.py3-none-any.whl
| Download URL | sqre_ghowlauth-0.0.10-py2.py3-none-any.whl |
|---|---|
| Size | 7.3 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
e446f6b95cbe923bcde1a9967d611a69d4637361fb0c32cbdd8af897f7edd72e
|
|
BLAKE2b-256 checksum How to use checksums |
e483aef6f6129b5be63504367dba4173e880d88364c3cc6c29b08d4825314f69
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
