BinderHub

What is BinderHub?

BinderHub allows you to BUILD and REGISTER a Docker image from a Git repository, then CONNECT with JupyterHub, allowing you to create a public IP address that allows users to interact with the code and environment within a live JupyterHub instance. You can select a specific branch name, commit, or tag to serve.

BinderHub ties together:

• JupyterHub to provide a scalable system for authenticating users and spawning single user Jupyter Notebook servers, and
• Repo2Docker which generates a Docker image using a Git repository hosted online.

BinderHub is built with Python, kubernetes, tornado, npm, webpack, and sphinx.

Documentation

For more information about the architecture, use, and setup of BinderHub, see the BinderHub documentation.

Contributing

To contribute to the BinderHub project you can work on:

• answering questions others have,
• writing documentation,
• designing the user interface, or
• writing code.

To see how to build the documentation, edit the user interface or modify the code see the contribution guide.

Installation

BinderHub is based on Python 3, it's currently only kept updated on GitHub. However, it can be installed using pip:

pip install git+https://github.com/jupyterhub/binderhub

See the BinderHub documentation for a detailed guide on setting up your own BinderHub server.

Why BinderHub?

Collections of Jupyter notebooks are becoming more common in scientific research and data science. The ability to serve these collections on demand enhances the usefulness of these notebooks.

Who is BinderHub for?

• Users who want to easily interact with computational environments that others have created.
• Authors who want to create links that allow users to immediately interact with a computational enviroment that you specify.
• Deployers who want to create their own BinderHub to run on whatever hardware they choose.

License

See LICENSE file in this repository.