Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aeksco/hackathon_jupyterhub
A hackathon-friendly JupyterHub deployment with Docker & NGINX.
https://github.com/aeksco/hackathon_jupyterhub
jupyter-notebook jupyterhub jupyterhub-hackathon nginx open-data pandas python2 python3 r-notebook tensorflow
Last synced: 14 days ago
JSON representation
A hackathon-friendly JupyterHub deployment with Docker & NGINX.
- Host: GitHub
- URL: https://github.com/aeksco/hackathon_jupyterhub
- Owner: aeksco
- License: mit
- Created: 2018-02-27T03:38:31.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-05T23:58:55.000Z (over 4 years ago)
- Last Synced: 2024-11-22T16:42:16.754Z (3 months ago)
- Topics: jupyter-notebook, jupyterhub, jupyterhub-hackathon, nginx, open-data, pandas, python2, python3, r-notebook, tensorflow
- Language: Shell
- Size: 31.3 KB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jupyterhub_hackathon
A hackathon-friendly JupyterHub deployment with Docker & NGINX.
Includes example Jupyter notebook to push data to MongoDB, and a [mongo-express](https://github.com/mongo-express) admin interface. Runs the [Jupyter Data Science Notebook](https://hub.docker.com/r/jupyter/datascience-notebook/) container with an installation of [Zipline](https://github.com/quantopian/zipline).
## Instructions
1. Clone this repository and `cd` into the directory:
`git clone https://github.com/aeksco/hackathon_jupyterhub.git`
`cd hackathon_jupyterhub`
2. Create GitHub OAuth Application:
Go to [github.com/settings/developers](https://github.com/settings/developers) and create a new OAuth application.
3. Create the `jupyterhub_config.py` file:
Copy the `jupyterhub/jupyterhub_config.example.py` file to `jupyterhub/jupyterhub_config.py`
Change the following fields to match your GitHub OAuth Application:
- `c.GitHubOAuthenticator.oauth_callback_url`
- `c.GitHubOAuthenticator.client_id`
- `c.GitHubOAuthenticator.client_secret`
- `c.Authenticator.whitelist = {'torvalds', 'aeksco'}`
- `c.Authenticator.admin_users = {'torvalds'}`
- `c.JupyterHub.base_url = '/jupyterhub'`
4. Create the `jupyterhub/internals/users.txt` file:
Copy the `jupyterhub/internals/users.example.txt` file to `jupyterhub/internals/users.txt`
This file should contain the GitHub usernames of all users who will be using the system. Every user defined in `jupyterhub_config.py` must be listed here for the server to work properly. Please ensure that there is no trailing whitespace or newlines in this file!
5. Start the docker containers:
`docker-compose up`
## Usage
- Jupyter server running at [http://localhost:8888](http://localhost:8888)
## Notes
- You may run a command inside the `hackathon_jupyterhub` docker container as the root user with the following command:
`docker-compose run --user="root" hackathon_jupyterhub pip install pandas`
- Installation instructions for Python 2.7 Jupyter kernel were found [here](https://github.com/ozancaglayan/jupyterhub-installation).
## Optional NGINX Configuration
- Run the following to setup an NGINX reverse-proxy to the Jupyter Notebook server
```
sudo apt-get update
sudo apt-get install nginx
```
- Copy the contents of `NGINX_EXAMPLE` into `/etc/nginx/sites-available/my_site`
- Simlink the file from `sites-available` to `sites-enabled`
`ln -s /etc/nginx/sites-available/my_site /etc/nginx/sites-enabled/my_site`
- Control NGINX with the following system commands:
```
sudo systemctl start nginx
sudo systemctl stop nginx
sudo systemctl restart nginx
```
## Misc. Notes
- Use [RSYNC](https://www.digitalocean.com/community/tutorials/how-to-use-rsync-to-sync-local-and-remote-directories-on-a-vps) to sync files into shared directory?
- TODO - Preload examples, traning sets, datasets, images.