@@ -6,10 +6,12 @@ description: Learn how to write custom images for use with Coder.
6
6
Custom images allow you to define workspaces that include the dependencies,
7
7
scripts, and user preferences helpful for your project.
8
8
9
- > If you're unfamiliar with how to create, build, and push Docker Images, please
10
- > review [ this tutorial by
11
- > Docker] ( http://blog.shippable.com/build-a-docker-image-and-push-it-to-docker-hub )
12
- > before proceeding.
9
+ This guide assumes that you're familiar with:
10
+
11
+ - [ Dockerfiles] ( https://docs.docker.com/engine/reference/builder/ )
12
+ - [ docker login] ( https://docs.docker.com/engine/reference/commandline/login/ )
13
+ - [ docker build] ( https://docs.docker.com/engine/reference/commandline/build/ )
14
+ - [ docker push] ( https://docs.docker.com/engine/reference/commandline/push/ )
13
15
14
16
## Creating a custom image
15
17
@@ -32,11 +34,19 @@ Please note:
32
34
[ image minimum requirements] ( https://github.com/cdr/enterprise-images/#image-minimums )
33
35
to make sure that your image will work with all of Coder's features.
34
36
35
- - You can build images inside a Coder workspace using the
36
- [ Docker Sandbox] ( https://github.com/bpmct/cdr-images/tree/master/docker-sandbox ) .
37
- If, however, you're using [ CVMs] ( ../admin/workspace-management/cvms.md ) ,
38
- you'll need to have the [ sysbox runtime] ( https://github.com/nestybox/sysbox )
39
- on your machine.
37
+ - You can build images inside a
38
+ [ CVM] ( ../admin/workspace-management/cvms.md ) -enabled Coder workspace with
39
+ Docker installed (see our [ base
40
+ image] ( https://github.com/cdr/enterprise-images/tree/main/images/base ) for an
41
+ example of how you can do this).
42
+
43
+ - If you're using CVM-only features during an image's build time (e.g., you're
44
+ [ pre-loading
45
+ images] ( https://github.com/nestybox/sysbox/blob/master/docs/quickstart/images.md#building-a-system-container-that-includes-inner-container-images--v012- )
46
+ in workspaces), you will need to install the [ sysbox
47
+ runtime] ( https://github.com/nestybox/sysbox ) onto your local machine and build
48
+ images locally. Note that this isn't usually necessary, even if your image
49
+ installs and enables Docker.
40
50
41
51
## Example: Installing an IntelliJ IDE
42
52
0 commit comments