Files
coder/docs/user-guides/devcontainers/working-with-dev-containers.md
T
Nick Vigilante 7846490770 docs: reconcile H1/label mismatches into front-matter titles (Phase 3) (#28036)
## Summary

**Batch B of Phase 3** of the H1 → front-matter migration (`DOCS-484`;
parent `DOCS-477`), the editorial follow-up to Batch A (#28030). For the
**124** hand-authored pages whose leading body H1 differed from the
manifest nav label, this promotes the richer body H1 to the front-matter
**page title** and drops the duplicate H1, while keeping the short
manifest **label** as the sidebar entry.

Policy agreed with the docs owner:
- Short sidebar labels win. Duplicate sidebar labels are acceptable.
- Identical **page titles** across two pages are not. On a collision,
rename the non-generated page's title.

## Page-title collisions resolved

Promoting the H1 created 4 page-title collisions; each is disambiguated
by renaming the non-generated / secondary page (sidebar labels left
unchanged):

| page | sidebar label | body H1 | → page title |
|------|---------------|---------|--------------|
| `install/index.md` | Install | Installing Coder | **Install Coder in
your infrastructure** |
| `install/cli.md` | Coder CLI | Installing Coder | **Install the Coder
CLI** |
| `ai-gateway/clients/jetbrains.md` | JetBrains | JetBrains IDEs |
**JetBrains** |
| `workspace-access/web-ides.md` | Web IDEs and Coder Apps | Web IDEs |
Web IDEs *(kept — primary user guide)* |
| `extending-templates/web-ides.md` | Web IDEs and Coder Apps | Web IDEs
| **Web IDEs in templates** |
| `workspace-management.md` | Workspace Management | Workspaces |
**Manage workspaces** *(vs generated `api/workspaces.md`)* |

These titles are the only non-mechanical editorial calls in this PR.

## Deliberately excluded: generated pages

`admin/security/audit-logs.md` and
`admin/setup/configuration-reference.md` are `make gen` outputs
(`auditdocgen` / `configdocgen`) that Phase 2 did **not** update, so a
hand-added title would be reverted on the next generation. They're
excluded here and need their generators taught to emit front matter
first (Phase 2 pattern), tracked as `DOCS-631`. Batch A (#28030) had the
same issue for three other generated pages; it has been corrected there
too.

## Verification

AI was the primary author of this PR (see disclosure below); per the [AI
Contribution
Guidelines](https://coder.com/docs/about/contributing/AI_CONTRIBUTING)
here is the manual verification.

- Promote = set front-matter `title` to the body H1 (or the
disambiguated title above) and remove that one duplicate H1. No other
body prose is reflowed.
- Every added front-matter block parses as YAML; all files pass `pnpm
check-docs` (markdownlint-cli2 + table formatter): `Summary: 0
error(s)`.
- Removing the H1 orphaned one in-page fragment (`[MCP](#mcp)` in
`ai-gateway/mcp.md`), now repointed. A cross-file fragment audit into
the retitled pages found no real breakage.


Anchor-change note

Unlike Batch A (title unchanged, a rendered no-op), Batch B changes each
page's effective title from the manifest label to the body H1, so the
rendered H1 **anchor slug changes**. An audit of cross-file
`.md#fragment` links into these pages surfaced no links that break as a
result (the only hits were false positives against a still-present `##
TLS & Reverse Proxy` heading). Same-file fragments are enforced by
markdownlint MD051, which is green.

## Title casing (follow-up, DOCS-742)

A follow-up commit puts the promoted titles into sentence case and
removes leading gerunds (for example, `Managing workspace schedules` →
`Manage workspace schedules`): 57 of the 120 titles changed, the other
63 were already compliant. Proper nouns and branded names (Coder
Validated Architecture, JetBrains, File Browser, Dev Containers,
Island), acronyms (API, CLI, IDE, MCP, OIDC, URL, UI, CI/CD), the
Premium license tier, and maturity labels (Beta, Experimental) are
preserved. The four `Nk-users` pages become `Reference architecture: up
to N users` (lowercase, matching the CVA landing page's own usage); the
CVA landing page keeps its branded title. `pnpm check-docs`: `Summary: 0
error(s)`.

Linear: DOCS-484, DOCS-742

> This PR was created with AI assistance (Coder Agents).
2026-09-08 16:34:00 +00:00

4.7 KiB

title
title
Work with Dev Containers

The dev container integration appears in your Coder dashboard, providing a visual representation of the running environment:

Two dev containers running as sub-agents in a Coder workspaceDev containers appear as sub-agents with their own apps, SSH access, and port forwarding

SSH access

Each dev container has its own agent name, derived from the workspace folder (e.g., /home/coder/my-project becomes my-project). You can find agent names in your workspace dashboard, or see Agent naming for details on how names are generated.

Using the Coder CLI

The simplest way to SSH into a dev container is using coder ssh with the workspace and agent name:

coder ssh <workspace>.<agent>

For example, to connect to a dev container with agent name my-project in workspace my-workspace:

coder ssh my-workspace.my-project

To SSH into the main workspace agent instead of the dev container:

coder ssh my-workspace

Using OpenSSH (config-ssh)

You can also use standard OpenSSH tools after generating SSH config entries with coder config-ssh:

coder config-ssh

This creates a wildcard SSH host entry that matches all your workspaces and their agents, including dev container sub-agents. You can then connect using:

ssh my-project.my-workspace.me.coder

The default hostname suffix is .coder. If your organization uses a different suffix, adjust the hostname accordingly. The suffix can be configured via coder config-ssh --hostname-suffix or by your deployment administrator.

This method works with any SSH client, IDE remote extensions, rsync, scp, and other tools that use SSH.

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.

Coder web terminal with 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 dev container agent in the Coder web interface.

  2. Using the Coder CLI:

    coder open vscode <workspace>.<agent>
    

    For example:

    coder open vscode my-workspace.my-project
    

VS Code will automatically detect the dev container environment and connect appropriately.

While optimized for VS Code, other IDEs with dev container support may also work.

Port forwarding

Since dev containers run as sub-agents, you can forward ports directly to them using standard Coder port forwarding:

coder port-forward <workspace>.<agent> --tcp 8080

For example, to forward port 8080 from a dev container with agent name my-project:

coder port-forward my-workspace.my-project --tcp 8080

This forwards port 8080 on your local machine directly to port 8080 in the dev container. Coder also automatically detects ports opened inside the container.

Exposing ports on the parent workspace

If you need to expose dev container ports through the parent workspace agent (rather than the sub-agent), you can use the appPort property in your devcontainer.json:

{
  "appPort": ["8080:8080", "4000:3000"]
}

This maps container ports to the parent workspace, which can then be forwarded using the main workspace agent.

Dev container features

You can use standard dev container features in your devcontainer.json file. Coder also maintains a repository of features to enhance your development experience.

For example, the code-server feature from the Coder features repository:

{
  "features": {
    "ghcr.io/coder/devcontainer-features/code-server:1": {
      "port": 13337,
      "host": "0.0.0.0"
    }
  }
}

Rebuilding dev containers

When you modify your devcontainer.json, you need to rebuild the container for changes to take effect. Coder detects changes and shows an Outdated status next to the dev container.

Dev container showing Outdated status with rebuild optionThe Outdated indicator appears when changes to devcontainer.json are detected

Select Rebuild to recreate your dev container with the updated configuration.