Skip to main content
127.8K
HomeAdministrationTemplatesManaging TemplatesDev containersAdd a dev container template

Add a dev container template

On this page

A Coder administrator adds a dev container-compatible template to Coder (Envbuilder). This allows the template to prompt for 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:

  1. In the Coder dashboard, select Templates then Create Template.

  2. Use a starter template or create a new template:

    • Starter template:

      1. Select Choose a starter template.
      2. Choose a template from the list or select Devcontainer from the sidebar to display only dev container-compatible templates.
      3. Select Use template, enter the details, then select Create template.

    • To create a new template, select From scratch and enter the templates details, then select Create template.

  3. Edit the template files to fit your deployment.

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

TemplateDescription
Docker dev containersDocker provisions a development container.
Kubernetes dev containersProvisions a development container on the Kubernetes cluster.
Google Compute Engine dev containerRuns 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 containerRuns 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