everware

Welcome #MozFesters, let us know you stopped by: Greetings from MozFest.

Everware is an add-on for JupyterHub. It allows users to launch Jupyter Notebooks into a docker container simply by specifying the url of a git repository. Everware clones the repository, builds a docker image from a contained Dockerfile and launches the user into a running notebook instance inside the container.

Everware is designed to be a tool for Open Science. If a researcher provides an everware-compatible public git repository, it's possible to verify their research by simply launching the repository inside everware.

See this blog post for more information about what everware is and how it can be useful.

The idea for everware originated at the CERN Webfest 2015. The original everware team consists of @OmeGak, @ibab, @ndawe, @betatim, @uzzielperez, @anaderi, and @AxelVoitier.

Documentation

Documentation on the different ways to use everware and getting started.

Testing

In order to test everware, you have to:

• Install the newest git version of jupyterhub: https://github.com/jupyter/jupyterhub. Double check with their README.md

    sudo apt-get install npm nodejs-legacy
    sudo npm install -g configurable-http-proxy
    git clone https://github.com/jupyter/jupyterhub.git
    cd jupyterhub
    pip3 install -r dev-requirements.txt -e .

• Install the newest git version of dockerspawner: https://github.com/jupyter/dockerspawner. Double check with their README.md

    git clone https://github.com/jupyter/dockerspawner.git
    cd dockerspawner
    pip3 install -e .

• Clone this repo

    git clone https://github.com/everware/everware
    cd everware

• Create a Github OAuth application with URL http://localhost:8000/ and callback URL http://localhost:8000/hub/oauth_callback
• Enter you OAuth information into env.sh and source env.sh
• Install everware

    pip3 install -e .

• If you are not using boot2docker, but run directly on Linux, edit jupyterhub_config.py as indicated in the file.
• Run

    jupyterhub