coder/docs/admin/integrations/devcontainers/envbuilder/add-envbuilder.md at dc2176714365e1a10cb62d8f56bd4a05ad8c9680

mirror of https://github.com/coder/coder.git synced 2026-10-16 14:48:56 +08:00

Files

T

Nick Vigilante dc21767143 docs: expand abbreviations on their first use on each page

Spell out each abbreviation where it first appears on a page, in the
form "Expanded Form (ABBR)", so every page in docs/ passes the
Coder.AbbreviationFirstUse rule that the next commit enables.

Where the first use is a UI label in bold, the label stays as the UI
shows it and the expansion goes elsewhere in the same paragraph or list
item. Reversed forms such as "PKCE (Proof Key for Code Exchange)" are
flipped to the expanded-first form. A few sentences needed a small
rewording to take the expansion: glossary entries that said
"abbreviated CVA" and "abbreviated PAT", hyphenated compounds such as
"EKS-specific", and a parenthetical about SSDs that would otherwise nest
parentheses.

Other changes on touched lines: "IDES" becomes "IDEs", "DERP MAP"
becomes "DERP map", and an em dash in a table row that the table
formatter re-padded becomes a comma, because the em-dash check reads
changed lines.

Assisted-by: AI

2026-10-15 16:28:27 -04:00

5.7 KiB

Raw Blame History

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

In the Coder dashboard, select Templates > New Template. The template builder opens.
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.
Upload your .zip or .tar.gz file, enter the details, then select Create template.
Edit the template files to fit your deployment.

CLI

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

Go to the Coder registry and select a dev container-compatible template.
Copy the files to your local device, then edit them to fit your needs.
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:
4. Drag the .zip file into the Upload template section and fill out the details, then select Create template.

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 virtual machine (VM) inside the container to enable Docker inside the workspace.
AWS Elastic Compute Cloud (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 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

Envbuilder security and caching

5.7 KiB Raw Blame History