Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/microsoft/vscode-dev-containers

NOTE: Most of the contents of this repository have been migrated to the new devcontainers GitHub org (https://github.com/devcontainers). See https://github.com/devcontainers/template-starter and https://github.com/devcontainers/feature-starter for information on creating your own!
https://github.com/microsoft/vscode-dev-containers

codespaces containers dev-containers devcontainer devcontainers docker github github-codespaces remote remote-development visual-studio-code visual-studio-codespaces vs vscode

Last synced: 4 months ago
JSON representation

NOTE: Most of the contents of this repository have been migrated to the new devcontainers GitHub org (https://github.com/devcontainers). See https://github.com/devcontainers/template-starter and https://github.com/devcontainers/feature-starter for information on creating your own!

Awesome Lists containing this project

README 

        
**IMPORTANT NOTE: Dev containers have a new, expanded home in the [dev containers GitHub org](https://github.com/devcontainers)! We're so excited to connect with you there. To learn more, you can check out our [migration announcement](https://github.com/microsoft/vscode-dev-containers/issues/1762).**



**This repository is no longer active and was archived in November 2023. We've migrated most of the contents of this repo to the [devcontainers GitHub org](https://github.com/devcontainers), as part of the work on the [open Dev Container specification](https://containers.dev).**



- **Features managed by the Dev Container spec maintainers (such as the VS Code team) are now in [devcontainers/features](https://github.com/devcontainers/features).**

- **Definitions/Templates managed by the Dev Container spec maintainers are now in [devcontainers/templates](https://github.com/devcontainers/templates).**

- **`mcr.microsoft.com/devcontainers` and `mcr.microsoft.com/vscode/devcontainers` images are now published from [devcontainers/images](https://github.com/devcontainers/images).**



**For new Templates/Features, you can now self-publish and optionally make them visible in-tool by following the steps one of the quick start repositories: [Templates quick start](https://github.com/devcontainers/template-starter), [Features quick start](https://github.com/devcontainers/feature-starter). No need to submit a PR here anymore.**



**For more details, you can review the [announcement issue](https://github.com/microsoft/vscode-dev-containers/issues/1589) and latest [archiving announcement](https://github.com/microsoft/vscode-dev-containers/issues/1762).**



---



# [Deprecated] VS Code / GitHub Codespaces Dev Container Definitions



Visual Studio Code logo



Visual Studio Code Dev Containers and GitHub Codespaces


Open your code in the cloud, in a local container, on a remote machine, or in WSL and take advantage of VS Code's full feature set.




**IMPORTANT NOTE: As noted in the section above, this repository is no longer active and will be archived in November 2023.**



A **development container** is a running [Docker](https://www.docker.com) container with a well-defined tool/runtime stack and its prerequisites. The [VS Code Dev Containers](https://aka.ms/vscode-remote/download/containers) extension and [GitHub Codespaces](https://github.com/features/codespaces) allow you to open or clone code in a local or cloud-hosted Dev Container and take advantage of VS Code's full development feature set.



This repository contains a set of **Dev Container definition templates** to help get you up and running with a containerized environment. The definitions describe the appropriate container image, runtime arguments for starting the container, and VS Code extensions that should be installed. Each provides a container configuration file (`devcontainer.json`) and other needed files that you can drop into any existing folder as a starting point for containerizing your project. You can use the **Add Development Container Configuration Files...** command to add one to your project or codespace.



The [vscode-remote-try-*](https://github.com/search?q=org%3Amicrosoft+vscode-remote-try-&type=Repositories) repositories may also be of interest if you are looking for complete sample projects.



## Adding a definition to a project or codespace

  

  1. Either [create a codespace for your repository](https://aka.ms/ghcs-open-codespace) or [set up your local machine](https://aka.ms/vscode-remote/containers/getting-started) for use with the Dev Containers extension, start VS Code, and open your project folder.

  2. Press F1, and select the **Add Development Container Configuration Files...** command for **Dev Containers** or **Codespaces**.

  3. Pick one of the recommended definitions from the list or select **Show All Definitions...** to see all of them. You may need to choose the **From a predefined container configuration definition...** option if your project has an existing Dockerfile or Docker Compose file. Answer any questions that appear.

  4. See the definition's `README` for configuration options. A link is available in the `.devcontainer/devcontainer.json` file added to your folder.

  5. Run **Remote-Containers: Reopen in Container** to use it locally, or **Codespaces: Rebuild Container** from within a codespace.



### Adding a definition to a repository



You can share a customized Dev Container definitions for your project by adding the files under `.devcontainer` to source control.



Anyone who then opens a local copy of your repo in VS Code will be prompted to reopen the folder in a container, provided they have the [Dev Containers](https://aka.ms/vscode-remote/download/containers) extension installed. Additionally, this will be used whenever someone creates a codespace in [GitHub Codespaces](https://github.com/features/codespaces) for the repository.



Your team now has a consistent environment and tool-chain and new contributors or team members can be productive quickly. First-time contributors will require less guidance and there will be fewer issues related to environment setup.



## Sample projects



If you want to try a sample project which already has a Dev Container, check out one of the following repositories:



- [Node Sample](https://github.com/Microsoft/vscode-remote-try-node)

- [Python Sample](https://github.com/Microsoft/vscode-remote-try-python)

- [Go Sample](https://github.com/Microsoft/vscode-remote-try-go)

- [Java Sample](https://github.com/Microsoft/vscode-remote-try-java)

- [.NET Core Sample](https://github.com/Microsoft/vscode-remote-try-dotnetcore)

- [Rust Sample](https://github.com/microsoft/vscode-remote-try-rust)

- [C++ Sample](https://github.com/microsoft/vscode-remote-try-cpp)

- [PHP Sample](https://github.com/microsoft/vscode-remote-try-php)



## Contents



- [`containers`](containers) - Contains reusable Dev Container definitions.

- [`script-library`](script-library) - Includes scripts used in this repository to install things. Also useful in your own Dockerfiles.

- [`container-templates`](container-templates) - Contains templates for creating your own container definitions or to [contribute back](CONTRIBUTING.md#contributing-dev-container-definitions).



## Common Questions



### Can I just reuse an existing container image or Docker / Docker Compose configuration?



Yes! If you have a Dockerfile or Docker Compose file in your project/repository, follow the [same steps to add a definition](#adding) and you'll be prompted to select a Dockerfile or Docker Compose file and customize from there. If you then commit these files to a Git repository, you can use it with [GitHub Codespaces](https://github.com/features/codespaces) as well. If you prefer, you can also start up the container manually and [attach to it](https://aka.ms/vscode-remote/containers/attach). However, note that many images will be missing things like `git` that you will want to use. There are scripts in the [script-library](script-library) like the [common script](script-library/docs/common.md) that can help adding these to your existing Dockerfile or image.



### What is the goal of `devcontainer.json`?



A `devcontainer.json` file is similar to `launch.json` for debugging, but designed to launch (or attach to) a development container instead. At its simplest, all you need is a `.devcontainer/devcontainer.json` file in your project that references an image, `Dockerfile`, or `docker-compose.yml`, and a few properties. You can [adapt it for use](https://aka.ms/vscode-remote/containers/folder-setup) in a wide variety of situations.



## Contributing and feedback



Have a question or feedback?



 We've migrated most of the contents of this repo to the [devcontainers GitHub org](https://github.com/devcontainers), as part of the work on the [open Dev Container specification](https://containers.dev).



- Features managed by the Dev Container spec maintainers are now in [devcontainers/features](https://github.com/devcontainers/features).

- Definitions/Templates managed by the Dev Container spec maintainers are now in [devcontainers/templates](https://github.com/devcontainers/templates).

- `mcr.microsoft.com/devcontainers` and `mcr.microsoft.com/vscode/devcontainers` images are now published from [devcontainers/images](https://github.com/devcontainers/images).



As a result, this repository only used for community definitions that have not been migrated elsewhere by their owners. If you are a community owner and want us to remove an existing definition here, feel free to submit a PR to do so!



For new Templates/Features, you can now self-publish and optionally make them visible in-tool by following the steps one of the quick start repositories: [Templates quick start](https://github.com/devcontainers/template-starter), [Features quick start](https://github.com/devcontainers/feature-starter).



You can also:



- Provide feedback for the [VS Code Dev Containers](https://github.com/Microsoft/vscode-remote-release/blob/main/CONTRIBUTING.md) extension or [GitHub Codespaces](https://github.com/github/feedback/discussions/categories/codespaces).

- Discuss the [Dev Container spec](https://github.com/orgs/devcontainers/discussions) or [join the Slack channel](https://github.com/orgs/devcontainers/discussions/3)

- Make proposals for improvments to the [Dev Container spec repository](https://github.com/devcontainers/spec).

- Contribute to the [Dev Container CLI](https://github.com/devcontainers/cli).



This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).

For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or

contact [[email protected]](mailto:[email protected]) with any additional questions or comments.



## License



Copyright (c) Microsoft Corporation. All rights reserved. 


Licensed under the MIT License. See [LICENSE](LICENSE).



For images generated from this repository, see [LICENSE](https://github.com/microsoft/containerregistry/blob/main/legal/Container-Images-Legal-Notice.md) and [NOTICE.txt](NOTICE.txt).