mirror of
https://github.com/coder/coder.git
synced 2025-07-12 00:14:10 +00:00
a226a75b32
This change documents the early access dev containers integration and how to enable it, what features are available and what limitations exist at the time of writing. --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
98 lines
2.7 KiB
Markdown
98 lines
2.7 KiB
Markdown
# Working with Dev Containers
|
|
|
|
The dev container integration appears in your Coder dashboard, providing a
|
|
visual representation of the running environment:
|
|
|
|
|
|
|
|
## SSH Access
|
|
|
|
You can SSH into your dev container directly using the Coder CLI:
|
|
|
|
```console
|
|
coder ssh --container keen_dijkstra my-workspace
|
|
```
|
|
|
|
> [!NOTE]
|
|
>
|
|
> SSH access is not yet compatible with the `coder config-ssh` command for use
|
|
> with OpenSSH. You would need to manually modify your SSH config to include the
|
|
> `--container` flag in the `ProxyCommand`.
|
|
|
|
## Web Terminal Access
|
|
|
|
Once your workspace and dev container are running, you can use the web terminal
|
|
in the Coder interface to execute commands directly inside the dev container.
|
|
|
|
|
|
|
|
## IDE Integration (VS Code)
|
|
|
|
You can open your dev container directly in VS Code by:
|
|
|
|
1. Selecting "Open in VS Code Desktop" from the Coder web interface
|
|
2. Using the Coder CLI with the container flag:
|
|
|
|
```console
|
|
coder open vscode --container keen_dijkstra my-workspace
|
|
```
|
|
|
|
While optimized for VS Code, other IDEs with dev containers support may also
|
|
work.
|
|
|
|
## Port Forwarding
|
|
|
|
During the early access phase, port forwarding is limited to ports defined via
|
|
[`appPort`](https://containers.dev/implementors/json_reference/#image-specific)
|
|
in your `devcontainer.json` file.
|
|
|
|
> [!NOTE]
|
|
>
|
|
> Support for automatic port forwarding via the `forwardPorts` property in
|
|
> `devcontainer.json` is planned for a future release.
|
|
|
|
For example, with this `devcontainer.json` configuration:
|
|
|
|
```json
|
|
{
|
|
"appPort": ["8080:8080", "4000:3000"]
|
|
}
|
|
```
|
|
|
|
You can forward these ports to your local machine using:
|
|
|
|
```console
|
|
coder port-forward my-workspace --tcp 8080,4000
|
|
```
|
|
|
|
This forwards port 8080 (local) -> 8080 (agent) -> 8080 (dev container) and port
|
|
4000 (local) -> 4000 (agent) -> 3000 (dev container).
|
|
|
|
## Dev Container Features
|
|
|
|
You can use standard dev container features in your `devcontainer.json` file.
|
|
Coder also maintains a
|
|
[repository of features](https://github.com/coder/devcontainer-features) to
|
|
enhance your development experience.
|
|
|
|
Currently available features include [code-server](https://github.com/coder/devcontainer-features/blob/main/src/code-server).
|
|
|
|
To use the code-server feature, add the following to your `devcontainer.json`:
|
|
|
|
```json
|
|
{
|
|
"features": {
|
|
"ghcr.io/coder/devcontainer-features/code-server:1": {
|
|
"port": 13337,
|
|
"host": "0.0.0.0"
|
|
}
|
|
},
|
|
"appPort": ["13337:13337"]
|
|
}
|
|
```
|
|
|
|
> [!NOTE]
|
|
>
|
|
> Remember to include the port in the `appPort` section to ensure proper port
|
|
> forwarding.
|