Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sqre-ghowlauth, version 0.0.10
Filename, size File type Python version Upload date Hashes
Filename, size sqre_ghowlauth-0.0.10-py2.py3-none-any.whl (7.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size sqre-ghowlauth-0.0.10.tar.gz (5.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page