Binder Documentation

Binder allows you to create custom computing environments that can be shared and used by many remote users.

Get started

Our getting started section helps you create and launch your first repository on mybinder.org.

Learn more

Learn more

Our how-to guides have a collection of snippets and a short overview of useful ways to use Binder.

Learn more

Support Binder

The Binder Project is a non-profit project built, led, and supported by an open community. Click here for some ideas on how to support the project.

Learn more

Thanks to our supporters

What is Binder?

A Binder service is powered by BinderHub, an open-source tool that runs on Kubernetes. One such deployment lives at mybinder.org, and is free to use.

Other documentation in the Binder ecosystem

This documentation is for creators of Binder repositories, and those who wish to use and learn more about the service at mybinder.org. You may be interested in the following other documentation sites:

👉 the BinderHub documentation

Has information about deploying your own BinderHub in the cloud. It is meant for people that wish to replicate the mybinder.org service at a different location for their community.

👉 the mybinder.org site-reliability guide

Has information for the team running mybinder.org, including dev-ops best-practices and tips for running the BinderHubs behind mybinder.org.

👉 the JupyterHub team compass docs

Has team information, practices, and guides for the JupyterHub community. This is also a great resource if you’re looking for ways to get involved!

Get started

To learn more about Binder, check out our tutorials, which will help you get started and learn more about sharing reproducible environments with Binder.

• Tutorials
  • Get started with Binder
  • Common use-cases
  • Ensure reproducibility for your Binder repository
  • Use a Dockerfile for your Binder repository

How-To guides and Tutorials

The following sections discuss some more in-depth topics on preparing and sharing your Binder repository. How-To guides are shorter, actionable patterns that accomplish something specific. Tutorials are more high-level and thorough, and often cover more conceptual topics.

• How-to Guides
  • Choose languages for your environment
  • Configure the user interface
  • Share JupyterLab Workspaces with a repository
  • Use different repositories for content and environment
  • Speed up my repository launch time
  • Generate custom launch badges
  • Track repository data on mybinder.org
  • Automatically place a launch badge on pull requests

Reference information about Binder

• Reference
  • Configuration Files
  • Example repositories

Information about mybinder.org

Information about using and running the Binder service at mybinder.org.

• About mybinder.org
  • Usage guidelines
  • mybinder.org status
  • Support the project
  • Supporting organizations
  • Our team and tools
  • The BinderHub Federation
  • Cite Binder

See the Binder Examples GitHub organization for more Binder repositories demonstrating its functionality.

Cite Binder

For information on how to cite Binder, see Cite Binder.

next

Tutorials