docs: add Docker quickstart (#2875)

* Fix docker-compose file * Add docker quickstart
2026-09-24 15:04:27 +08:00 · 2022-07-11 12:05:05 -05:00
parent 5eecbaa534
commit 13d7466ebc
11 changed files with 187 additions and 61 deletions
@@ -0,0 +1,83 @@
+# Docker
+
+Coder with Docker has the following advantages:
+
+- Simple installation (everything is on a single box)
+- Workspace images are easily configured
+- Workspaces share resources for burst operations
+
+## Requirements
+
+- A single MacOS or Linux box
+- A running Docker daemon
+
+## Instructions
+
+1.  [Install and launch Coder](../install.md)
+
+    You may use `CODER_ACCESS_URL=http://localhost:7080` since we're using local
+    Docker workspaces exclusively. The rest of the guide will assume that this is your
+    access URL.
+
+    ```bash
+    coder server -a $CODER_ACCESS_URL
+    ```
+
+1.  Run `coder login http://localhost:7080` in a new terminal and follow the
+    interactive instructions to create your user.
+
+1.  Pull the example template:
+
+    ```bash
+    echo "docker" | coder templates init
+    cd docker
+    # You should see a `main.tf` file in this directory
+    ```
+
+1.  Open up `main.tf` in your preferred editor to edit the images
+
+    You can skip this step if you're fine with our default, generic OS images.
+
+    Search for the following section in `main.tf`:
+
+    ```hcl
+    ...
+    variable "docker_image" {
+     description = "Which Docker image would you like to use for your workspace?"
+     # The codercom/enterprise-* images are only built for amd64
+     default = "codercom/enterprise-base:ubuntu"
+     validation {
+         condition     = contains(["codercom/enterprise-base:ubuntu", "codercom/enterprise-node:ubuntu",
+                                 "codercom/enterprise-intellij:ubuntu", "codercom/enterprise-golang:ubuntu"], var.docker_image)
+         error_message = "Invalid Docker image!"
+     }
+    }
+    ...
+    ```
+
+    And edit the strings in `condition = contains([...])` and `default = ...`
+    with your preferred images.
+
+1.  Push up the template to Coder with `coder templates create`
+1.  Open the dashboard in your browser (http://localhost:7080) to create your
+    first workspace:
+
+    <img src="./images/quickstart/docker/login.png">
+
+    Then navigate to `Templates > docker > Create workspace`
+
+    <img src="./images/quickstart/docker/create-workspace.png">
+
+    Now wait a few moments for the workspace to build... After the first build
+    the image is cached and subsequent builds will take a few seconds.
+
+1.  All done!
+
+    <img src="./images/quickstart/docker/ides.png">
+
+    Open up a web application or [SSH in](../ides.md#ssh-configuration).
+
+## Next Steps
+
+- [Learn more about template configuration](../templates.md)
+- [Configure more IDEs](../ides/configuring-web-ides.md)