Repository files navigation

repo2docker fetches a git repository and builds a container image based onthe configuration files found in the repository.

See therepo2docker documentationfor more information on using repo2docker.

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

See thecontributing guide for information on contributing torepo2docker.

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

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

For more information, please visitour informational page or download ourparticipant information sheet.

1. Docker to build & run the repositories. Thecommunity editionis recommended.
2. Python 3.9+.

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

This a quick guide to installingrepo2docker, see our documentation fora full guide.

To install from PyPI:

pip install jupyter-repo2docker

To install from source:

git clone https://github.com/jupyterhub/repo2docker.gitcd repo2dockerpip install -e.

The core feature of repo2docker 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-repo2docker https://github.com/norvig/pytudes

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

    Copy/paste this URL into your browser when you connectfor 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 Notebookwith the contents of the repository you had just built!

For more information on how to userepo2docker, see theusage guide.

Repo2Docker looks for configuration files in the source repository todetermine how the Docker image should be built. For a list of the configurationfiles thatrepo2docker can use, see thecomplete list of configuration files.

The philosophy of repo2docker is inspired byHeroku Build Packs.

Repo2Docker can be run inside a Docker container if access to the Docker Daemon is provided, for example seeBinderHub. Docker images arepublished to quay.io. The oldDocker Hub image is no longer supported.