mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00

Files

T

Danielle Maywood 7fd9a450c1 docs: update dev containers documentation to reflect GA status (#20847 )

Updates the dev containers documentation to accurately reflect that the
feature is generally available and document all configuration options.

Closes https://github.com/coder/internal/issues/1138

---

🤖 PR was written by Claude Sonnet 4.5 Thinking using [Coder
Mux](https://github.com/coder/cmux) and reviewed by a human 👩

2025-11-25 11:29:11 +00:00

3.8 KiB

Raw Blame History

Dev Containers Integration

The Dev Containers integration enables seamless creation and management of Dev Containers in Coder workspaces. This feature leverages the @devcontainers/cli and Docker to provide a streamlined development experience.

This implementation is different from the existing Envbuilder-based Dev Containers offering.

Prerequisites

Coder version 2.24.0 or later
Coder CLI version 2.24.0 or later
Linux or macOS workspace, Dev Containers are not supported on Windows
A template with:
- Dev Containers integration enabled
- A Docker-compatible workspace image
Appropriate permissions to execute Docker commands inside your workspace

How It Works

The Dev Containers integration utilizes the devcontainer command from @devcontainers/cli to manage Dev Containers within your Coder workspace. This command provides comprehensive functionality for creating, starting, and managing Dev Containers.

Dev environments are configured through a standard devcontainer.json file, which allows for extensive customization of your development setup.

When a workspace with the Dev Containers integration starts:

The workspace initializes the Docker environment.
The integration detects repositories with a .devcontainer directory or a devcontainer.json file.
The integration builds and starts the Dev Container based on the configuration.
Your workspace automatically detects the running Dev Container.

Features

Available Now

Automatic Dev Container detection from repositories
Seamless Dev Container startup during workspace initialization
Dev Container change detection and dirty state indicators
On-demand Dev Container recreation via rebuild button
Integrated IDE experience in Dev Containers with VS Code
Direct service access in Dev Containers
SSH access to Dev Containers
Automatic port detection for container ports

Limitations

The Dev Containers integration has the following limitations:

Not supported on Windows
Changes to the devcontainer.json file require manual container recreation using the rebuild button
Some Dev Container features may not work as expected

Comparison with Envbuilder-based Dev Containers

Feature	Dev Containers Integration	Envbuilder Dev Containers
Implementation	Direct `@devcontainers/cli` and Docker	Coder's Envbuilder
Target users	Individual developers	Platform teams and administrators
Configuration	Standard `devcontainer.json`	Terraform templates with Envbuilder
Management	User-controlled	Admin-controlled
Requirements	Docker access in workspace	Compatible with more restricted environments

Choose the appropriate solution based on your team's needs and infrastructure constraints. For additional details on Envbuilder's Dev Container support, see the Envbuilder Dev Container spec support documentation.

Next Steps

Explore the Dev Container specification to learn more about advanced configuration options
Read about Dev Container features to enhance your development environment
Check the VS Code dev containers documentation for IDE-specific features

3.8 KiB Raw Blame History