build2docker

build2docker fetches a git repository and builds a container image based on the configuration files found in the repository.

See the build2docker documentation for more information on using build2docker.

For support questions please search or post to https://discourse.jupyter.org/c/binder.

See the contributing guide for information on contributing to build2docker.

Please note that this repository is participating in a study into sustainability of open source projects. Data will be gathered about this repository for approximately the next 12 months, starting from 2021-06-11.

Data collected will include number of contributors, number of PRs, time taken to close/merge these PRs, and issues closed.

For more information, please visit our informational page or download our participant information sheet.

Using build2docker

Prerequisites

1. Docker to build & run the repositories. The community edition is recommended.
2. Python 3.6+.

Supported on Linux and macOS. See documentation note about Windows support.

Installation

This a quick guide to installing build2docker, see our documentation for a full guide.

To install from PyPI:

pip install jupyter-build2docker

To install from source:

git clone https://github.com/khulnasoft/build2docker.git
cd build2docker
pip install -e .

Usage

The core feature of build2docker is to fetch a git repository (from GitHub or locally), build a container image based on the specifications found in the repository & optionally launch the container that you can use to explore the repository.

Note that Docker needs to be running on your machine for this to work.

Example:

jupyter-build2docker https://github.com/norvig/pytudes

After building (it might take a while!), it should output in your terminal something like:

    Copy/paste this URL into your browser when you connect for the first time,
    to login with a token:
        http://0.0.0.0:36511/?token=f94f8fabb92e22f5bfab116c382b4707fc2cade56ad1ace0

If you copy paste that URL into your browser you will see a Jupyter Notebook with the contents of the repository you had just built!

For more information on how to use build2docker, see the usage guide.

Repository specifications

Build2Docker looks for configuration files in the source repository to determine how the Docker image should be built. For a list of the configuration files that build2docker can use, see the complete list of configuration files.

The philosophy of build2docker is inspired by Heroku Build Packs.

Docker Image

Build2Docker can be run inside a Docker container if access to the Docker Daemon is provided, for example see BinderHub. Docker images are published to quay.io. The old Docker Hub image is no longer supported.