2026-08-27 12:34:13 -04:00
---
title : Add an Envbuilder template
---
2024-12-02 12:19:04 -05:00
2025-12-05 19:42:16 +02:00
A Coder administrator adds an Envbuilder-compatible template to Coder. This
allows the template to prompt the developer for their dev container repository's
2025-12-09 13:03:02 +02:00
URL as a [parameter ](../../../templates/extending-templates/parameters.md ) when they create
2025-12-05 19:42:16 +02:00
their workspace. Envbuilder clones the repo and builds a container from the
2024-12-02 12:19:04 -05:00
`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 ](https://registry.coder.com/templates ):
<div class="tabs">
## Dashboard
2026-07-06 11:15:59 -04:00
1. In the Coder dashboard, select **Templates** > **New Template** .
The template builder opens.
1. 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.
1. Upload your `.zip` or `.tar.gz` file, enter the details, then select **Create template** .
2024-12-02 12:19:04 -05:00
1. Edit the template files to fit your deployment.
## CLI
1. Use the `template init` command to initialize your choice of image:
2026-07-15 14:07:09 -04:00
```sh
2024-12-05 18:37:25 +01:00
coder template init --id kubernetes-devcontainer
2024-12-02 12:19:04 -05:00
` ``
A list of available templates is shown in the
[templates_init](../../../../reference/cli/templates.md) reference.
1. ` cd` into the directory and push the template to your Coder deployment:
2026-07-15 14:07:09 -04:00
` ``sh
2024-12-05 18:37:25 +01:00
cd kubernetes-devcontainer && coder templates push
2024-12-02 12:19:04 -05:00
` ``
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](https://registry.coder.com/templates) and select a
dev container-compatible template.
1. Copy the files to your local device, then edit them to fit your needs.
1. Upload them to Coder through the CLI or dashboard:
- CLI:
2026-07-15 14:07:09 -04:00
` ``sh
2024-12-02 12:19:04 -05:00
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:
2026-07-15 14:07:09 -04:00
` ``sh
2024-12-02 12:19:04 -05:00
zip templates.zip Dockerfile main.tf
` ``
1. Select **Templates**.
1. Select **Create Template**, then **Upload template**:

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

</div>
To set variables such as the namespace, go to the template in your Coder
dashboard and select **Settings** from the **⋮** (vertical ellipsis) menu:
2026-07-21 14:59:59 -05:00
<img height="255px" src="../../../../images/templates/template-menu-settings.png" alt="Choose Settings from the template's menu" align="center" />
2024-12-02 12:19:04 -05:00
## Envbuilder Terraform provider
When using the
[Envbuilder Terraform provider](https://registry.terraform.io/providers/coder/envbuilder/latest/docs),
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:
` ``json
# …
{
"features": {
"ghcr.io/devcontainers/features/common-utils:2": {}
}
}
# …
` ``
## Example templates
2026-06-22 11:39:12 -04:00
| Template | Description |
|-------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Docker dev containers](../../../../../examples/templates/docker-devcontainer) | Docker provisions a development container. |
| [Kubernetes dev containers](../../../../../examples/templates/kubernetes-devcontainer) | Provisions a development container on the Kubernetes cluster. |
| [Google Compute Engine dev container](../../../../../examples/templates/gcp-devcontainer) | 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](../../../../../examples/templates/aws-devcontainer) | 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. |
2024-12-02 12:19:04 -05:00
Your template can prompt the user for a repo URL with
2025-12-09 13:03:02 +02:00
[parameters](../../../templates/extending-templates/parameters.md):
2024-12-02 12:19:04 -05:00

## 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
2025-12-05 19:42:16 +02:00
- [Envbuilder security and caching ](./envbuilder-security-caching.md )