Next

BinderHub

Note

BinderHub is under active development and subject to breaking changes.

Getting started

The primary goal of BinderHub is creating custom computing environments that can be used by many remote users. BinderHub enables an end user to easily specify a desired computing environment from a GitHub repo. BinderHub then serves the custom computing environment at a URL which users can access remotely.

This guide assists you, an administrator, through the process of setting up your BinderHub deployment.

To get started creating your own BinderHub, start with Create your cloud resources.

Extending JupyterHub

If you’d like to extend your JupyterHub setup, see Zero to JupyterHub.

BinderHub Deployments

Our directory of BinderHubs is published at BinderHub Deployments.

If your BinderHub deployment is not listed, please open an issue to discuss adding it.

Zero to BinderHub

A guide to help you create your own BinderHub from scratch.

• 1. Create your cloud resources
  • 1.1. Setting up Kubernetes on Google Cloud
  • 1.2. Install Helm
• 2. Set up the container registry
  • 2.1. Set up Google Container Registry
  • 2.2. Set up Docker Hub registry
  • 2.3. Next step
• 3. Set up BinderHub
  • 3.1. Preparing to install
  • 3.2. Create secret.yaml file
  • 3.3. Create config.yaml
  • 3.4. Install BinderHub
  • 3.5. Connect BinderHub and JupyterHub
  • 3.6. Try out your BinderHub Deployment
  • 3.7. Increase your GitHub API limit
• 4. Tear down your Binder deployment
  • 4.1. Contracting the size of your cluster
  • 4.2. Deleting the cluster

Customization and more information

• 1. The BinderHub Architecture
  • 1.1. Tools used by BinderHub
  • 1.2. What happens when a user clicks a Binder link?
  • 1.3. A diagram of the BinderHub architecture
• 2. Debugging BinderHub
  • 2.1. Changing the helm chart
• 3. Customizing your BinderHub deployment
• 4. BinderHub API Documentation
  • 4.1. Endpoint
  • 4.2. Provider
  • 4.3. Events
  • 4.4. Heartbeat
• 5. BinderHub Deployments
  • 5.1. GESIS - Leibniz-Institute for the Social Sciences
  • 5.2. Pangeo - A community platform for big data geoscience
• 6. Event Logging
  • 6.1. Events vs Metrics
  • 6.2. What events to emit?
• 7. Configuration and Source Code Reference
  • 7.1. app
  • 7.2. build
  • 7.3. builder
  • 7.4. main
  • 7.5. registry
  • 7.6. repoproviders

1. Create your cloud resources