Skip to content

Commit 09effa1

Browse files
committed
edit add-devcontainer
1 parent 736202d commit 09effa1

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

docs/admin/templates/managing-templates/devcontainers/add-devcontainer.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
# Add a dev container template to Coder
1+
# Add an Envbuilder Dev Container Template
22

3-
A Coder administrator adds a dev container-compatible template to Coder
4-
(Envbuilder). This allows the template to prompt for the developer for their dev
5-
container repository's URL as a
6-
[parameter](../../extending-templates/parameters.md) when they create their
7-
workspace. Envbuilder clones the repo and builds a container from the
8-
`devcontainer.json` specified in the repo.
3+
This guide shows platform administrators how to add an Envbuilder dev container template to Coder.
94

10-
You can create template files through the Coder dashboard, CLI, or you can
11-
choose a template from the
5+
This allows the template to prompt for the developer for their dev container repository's URL as a
6+
[parameter](../../extending-templates/parameters.md) when they create their workspace.
7+
Envbuilder clones the repo and builds a container from the `devcontainer.json` specified in the repo.
8+
9+
This is a legacy implementation.
10+
11+
For the Docker-based Dev Containers integration, follow the [Configure a template for dev containers](../../extending-templates/devcontainers.md) documentation instead.
12+
13+
You can create template files through the Coder dashboard, CLI, or you can choose a template from the
1214
[Coder registry](https://registry.coder.com/templates):
1315

1416
<div class="tabs">
@@ -118,7 +120,7 @@ their development environments:
118120
#
119121
```
120122

121-
## Example templates
123+
## Example Templates
122124

123125
| Template | Description |
124126
|---------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -132,7 +134,7 @@ Your template can prompt the user for a repo URL with
132134

133135
![Dev container parameter screen](../../../../images/templates/devcontainers.png)
134136

135-
## Dev container lifecycle scripts
137+
## Dev container Lifecycle Scripts
136138

137139
The `onCreateCommand`, `updateContentCommand`, `postCreateCommand`, and
138140
`postStartCommand` lifecycle scripts are run each time the container is started.
@@ -141,6 +143,7 @@ a user begins using the workspace.
141143

142144
Lifecycle scripts are managed by project developers.
143145

144-
## Next steps
146+
## Next Steps
145147

148+
- [Choose an approach to Dev Containers](../../extending-templates/devcontainers.md)
146149
- [Dev container security and caching](./devcontainer-security-caching.md)

0 commit comments

Comments
 (0)