mirror of
https://github.com/balkian/jupyterhub-oauth.git
synced 2024-12-22 12:08:14 +00:00
43 lines
835 B
Markdown
43 lines
835 B
Markdown
|
# OAuthenticator
|
||
|
|
|
||
|
|
Example of running [JupyterHub](https://github.com/jupyter/jupyterhub)
|
||
|
|
with [GitHub OAuth](https://developer.github.com/v3/oauth/) for authentication.
|
||
|
|
|
||
|
|
## setup
|
||
|
|
|
||
|
|
Edit the file called `userlist` to include one GitHub user name per line.
|
||
|
|
If that user should be an admin (you!), add `admin` after a space.
|
||
|
|
|
||
|
|
For example:
|
||
|
|
|
||
|
|
```
|
||
|
|
mal admin
|
||
|
|
zoe admin
|
||
|
|
wash
|
||
|
|
inara admin
|
||
|
|
kaylee
|
||
|
|
jayne
|
||
|
|
simon
|
||
|
|
river
|
||
|
|
```
|
||
|
|
|
||
|
|
## build
|
||
|
|
|
||
|
|
Build the container with:
|
||
|
|
|
||
|
|
docker build -t jupyter/oauthenticator .
|
||
|
|
|
||
|
|
### ssl
|
||
|
|
|
||
|
|
To run the server on HTTPS, put your ssl key and cert in ssl/ssl.key and
|
||
|
|
ssl/ssl.cert.
|
||
|
|
|
||
|
|
## run
|
||
|
|
|
||
|
|
Add your oauth client id, client secret, and callback URL to the `env file`.
|
||
|
|
Once you have built the container, you can run it with:
|
||
|
|
|
||
|
|
docker run -it -p 8000:8000 --env-file=env jupyter/oauthenticator
|
||
|
|
|
||
|
|
Which will run the Jupyter server.
|