Files
coder/docs/admin/integrations/devcontainers/envbuilder/add-envbuilder.md
T
Nick Vigilante bc77c40296 docs: add front-matter titles to mechanical and no-H1 pages (Phase 3) (#28030)
## Summary

**Batch A of Phase 3** of the H1 → front-matter migration (`DOCS-484`;
parent `DOCS-477`). Adds a front-matter `title` to every navigable docs
page whose title can be migrated **mechanically**, with no editorial
judgment.

This is the content step that Phase 1 (renderers prefer front-matter
title, `DOCS-482`) and Phase 2 (tooling + generators front-matter-aware,
`DOCS-483`) unblocked. Both are merged; coder.com #964/#974 are merged
and live.

**Rendered no-op.** The renderers already resolve the page title from
the manifest and hide the leading body H1 (Phase 1), so no page changes
visually. This just moves the title into front matter where Fumadocs and
the migrated tooling can read it.

## What's in this batch

Dry-run on `main` (464 navigable pages) splits into:

| category | count | this PR |
|----------|-------|---------|
| already has front-matter title (Reference, from Phase 2 generators) |
196 | skipped (idempotent) |
| **mechanical** — leading body H1 equals the manifest label | 138 | ✅
add front-matter `title`, drop the duplicate H1 |
| **no body H1** — renders under the manifest label only | 4 | ✅ add
front-matter `title` only |
| **mismatch** — body H1 differs from the manifest label | 126 | ⏭️
deferred (needs an editorial decision, see below) |

142 files changed, all under `docs/`.

## Deliberately out of scope: the 126 mismatches

Pages where the body H1 is richer than the short sidebar label (e.g.
label **Modules** / H1 *Contributing modules*, label **Install** / H1
*Installing Coder*) need a canonical-title decision, not a script. A few
even look like the body H1 is the redundant one (`install/cli.md` and
`install/index.md` both carry the H1 *Installing Coder*). These will
land in follow-up batches **by nav section** once the policy is set, so
each gets real review.

## 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.

- Every added front-matter block parses as YAML and its `title`
round-trips to the manifest label (checked programmatically across all
142 files).
- Every removed line is a leading `# H1` that equalled the manifest
title; no body prose was reflowed. Front matter is correctly hoisted
above pre-existing `<!-- markdownlint-disable -->` comments on the two
pages that had them.
- `pnpm check-docs` (markdownlint-cli2 + table formatter) passes on the
changed set: `Summary: 0 error(s)`. `MD041` stays off (re-enabled in
Phase 4); `MD025` is not tripped because the duplicate body H1s are
removed.

```
$ pnpm exec markdownlint-cli2 $(git diff --name-only origin/main)
Linting: 142 file(s)
Summary: 0 error(s)
```

Linear: DOCS-484

> This PR was created with AI assistance (Coder Agents).
2026-08-27 12:34:13 -04:00

5.6 KiB

title
title
Add an Envbuilder template

A Coder administrator adds an Envbuilder-compatible template to Coder. This allows the template to prompt the developer for their dev container repository's URL as a parameter when they create their workspace. Envbuilder clones the repo and builds a container from the devcontainer.json specified in the repo.

You can create template files through the Coder dashboard, CLI, or you can choose a template from the Coder registry:

Dashboard

  1. In the Coder dashboard, select Templates > New Template. The template builder opens.
  2. The template builder does not currently include dev-container-compatible base templates. Select Upload an existing template at the bottom of the page to upload your Terraform files directly.
  3. Upload your .zip or .tar.gz file, enter the details, then select Create template.
  4. Edit the template files to fit your deployment.

CLI

  1. Use the template init command to initialize your choice of image:

    coder template init --id kubernetes-devcontainer
    

    A list of available templates is shown in the templates_init reference.

  2. cd into the directory and push the template to your Coder deployment:

    cd kubernetes-devcontainer && coder templates push
    

    You can also edit the files or make changes to the files before you push them to Coder.

Registry

  1. Go to the Coder registry and select a dev container-compatible template.

  2. Copy the files to your local device, then edit them to fit your needs.

  3. Upload them to Coder through the CLI or dashboard:

    • CLI:
    coder templates push <template-name> -d <path to folder containing main.tf>
    
    • Dashboard:
    1. Create a .zip of the template files:

      • On Mac or Windows, highlight the files and then right click. A "compress" option is available through the right-click context menu.

      • To zip the files through the command line:

        zip templates.zip Dockerfile main.tf
        
    2. Select Templates.

    3. Select Create Template, then Upload template:

      Upload template

    4. Drag the .zip file into the Upload template section and fill out the details, then select Create template.

      Upload the template files

To set variables such as the namespace, go to the template in your Coder dashboard and select Settings from the ⋮ (vertical ellipsis) menu:

Choose Settings from the template's menu

Envbuilder Terraform provider

When using the Envbuilder Terraform provider, a previously built and cached image can be reused directly, allowing dev containers to start instantaneously.

Developers can edit the devcontainer.json in their workspace to customize their development environments:

# …
{
  "features": {
      "ghcr.io/devcontainers/features/common-utils:2": {}
  }
}
# …

Example templates

Template Description
Docker dev containers Docker provisions a development container.
Kubernetes dev containers Provisions a development container on the Kubernetes cluster.
Google Compute Engine dev container Runs a development container inside a single GCP instance. It also mounts the Docker socket from the VM inside the container to enable Docker inside the workspace.
AWS EC2 dev container Runs a development container inside a single EC2 instance. It also mounts the Docker socket from the VM inside the container to enable Docker inside the workspace.

Your template can prompt the user for a repo URL with parameters:

Dev container parameter screen

Dev container lifecycle scripts

The onCreateCommand, updateContentCommand, postCreateCommand, and postStartCommand lifecycle scripts are run each time the container is started. This could be used, for example, to fetch or update project dependencies before a user begins using the workspace.

Lifecycle scripts are managed by project developers.

Next steps