Configuration files supported by repo2docker

repo2docker looks for configuration files in the repository being built to determine how to build it. In general, repo2docker uses the same configuration files as other software installation tools, rather than creating new custom configuration files.

See also

The binder examples organization on GitHub contains a list of sample repositories for common configurations that repo2docker can build with various configuration files such as Python and R installation in a repository.

A list of supported configuration files (roughly in the order of build priority) can be found in the next sections.

• Configuration for research and data science workflows
  • environment.yml - Install a conda environment
  • install.R - Install R packages
  • DESCRIPTION - Install as an R package
  • Project.toml - Install a Julia environment
• Configuration files for software development workflows
  • Pipfile and/or Pipfile.lock - Install a Python environment
  • requirements.txt - Install a Python environment
  • pyproject.toml - Install Python packages
  • setup.py - Install Python packages
• System-wide configuration
  • apt.txt - Install packages with apt-get
  • runtime.txt - Specifying runtimes
  • default.nix - the nix package manager
  • Dockerfile - Advanced environments
• Configuration files for post-build actions
  • postBuild - Run code after installing the environment
  • start - Run code before the user sessions starts