User guide

Short, actionable guides that cover specific topics with repo2docker. Select from the pages listed below to get started.

Information about configuring your repository to work with repo2docker, and controlling elements of the built environment using configuration files.

Image building basics

• Four ways to use repo2docker images in a JupyterHub
• Configuration files supported by repo2docker
• Using source repositories
• Command-line usage and API

Customize your environment

• Configure the user interface
• Choose languages for your environment
• Share JupyterLab Workspaces with a repository
• Run scripts, commands, and actions as part of environment building
• Export your environment to an environment.yml that works with repo2docker
• Change the base image used by Docker

Deploy images into production

• Using repo2docker as part of your Continuous Integration
• Use a community-maintained image in a JupyterHub
• Extend a community image with your own packages
• Build JupyterHub-ready images
• Use GitHub Actions to build environment images
• Deal with breaking changes in repo2docker

Learn about repo2docker

• Frequently Asked Questions (FAQ)
  • Is rootless container runtime supported?
  • Why is my repository failing to build with ResolvePackageNotFound ?
  • Can I add executable files to the user’s PATH?
  • Can I use repo2docker to bootstrap my own Dockerfile to edit by hand?
  • Can I use repo2docker to edit a local host repository within a Docker environment?
  • Why is my R shiny app not launching?
  • Why does repo2docker need to exist? Why not use tool like source2image?
• The Reproducible Execution Environment Specification