Skip to content

Commit

Permalink
Merge pull request #8 from willingc/cheatsheet
Browse files Browse the repository at this point in the history
Add cheatsheet and update docs index
  • Loading branch information
willingc committed Jul 21, 2016
2 parents 8660e5b + 87c8ecf commit 30d61a2
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 2 deletions.
16 changes: 14 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
Getting Started with JupyterHub Tutorial
========================================

Contents:
This tutorial is based on Min Ragan Kelly's PyData London talk
`(Video)<https://youtu.be/gSVvxOchT8Y>`_.

JupyterHub References
---------------------

.. toctree::
:maxdepth: 2

JupyterHub-Tutorial.ipynb
jhubcheatsheet.md
timeline.md

Tutorial notebooks
------------------

.. toctree::
:maxdepth: 2

JupyterHub-Tutorial.ipynb
authenticators.ipynb
spawners.ipynb
rest-api.ipynb
Expand Down
44 changes: 44 additions & 0 deletions docs/jhubcheatsheet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# JupyterHub Cheatsheet

## JupyterHub on GitHub
JupyterHub organization on GitHub [https://github.com/jupyterhub](https://github.com/jupyterhub)

### Project

JupyterHub
- [GitHub](https://github.com/jupyterhub/jupyterhub)
- [Documentation online](http://jupyterhub.readthedocs.io/en/latest/)
- [PDF download](https://media.readthedocs.org/pdf/jupyterhub/latest/jupyterhub.pdf)

### Tutorial

JupyterHub Tutorial - "Tutorial materials for deploying JupyterHub"
- [GitHub](https://github.com/jupyterhub/jupyterhub-tutorial)
- [Documentation online](http://jupyterhub-tutorial.readthedocs.io/)

### Authenticators

LDAPauthenticator - "Simple LDAP Authenticator Plugin for JupyterHub" [https://github.com/jupyterhub/ldapauthenticator](https://github.com/jupyterhub/ldapauthenticator)

OAuthenticator - "GitHub OAuth + JupyterHub Authenticator = OAuthenticator"
[https://github.com/jupyterhub/oauthenticator](https://github.com/jupyterhub/oauthenticator)

### Spawners

Batchspawner - "Custom Spawner for Jupyterhub to start servers in batch scheduled systems" [https://github.com/jupyterhub/batchspawner](https://github.com/jupyterhub/batchspawner)

Dockerspawner - "Enables JupyterHub to spawn user servers in docker containers." [https://github.com/jupyterhub/dockerspawner](https://github.com/jupyterhub/dockerspawner)

Sudospawner - "enables JupyterHub to spawn single-user servers without being root, by spawning an intermediate process via sudo, which takes actions on behalf of the user" [https://github.com/jupyterhub/sudospawner](https://github.com/jupyterhub/sudospawner)

### Proxy

[Configurable HTTP Proxy](https://github.com/jupyterhub/configurable-http-proxy) - "node-http-proxy plus a REST API"

### Deployment examples

[JupyterHub deployment using Ansible](https://github.com/jupyterhub/jupyterhub-deploy-teaching)

[JupyterHub deployment with Docker](https://github.com/jupyterhub/jupyterhub-deploy-docker)

[JupyterHub using Rackspace Carina](https://github.com/jupyterhub/jupyterhub-carina)

0 comments on commit 30d61a2

Please sign in to comment.