chore: add instructions for deploying with Docker Compose

coder · bpmct · May 23, 2022 · May 19, 2022 · May 19, 2022 · May 19, 2022
commit ed4a1cea27d9eed6f3b4ad0c2f74b6ae95d74969
diff --git a/docs/README.md b/docs/README.md
@@ -59,6 +59,8 @@ destroyed on exit):
 > Use `coder --help` to get a complete list of flags and environment
 variables.
 
+See the [installation guide](install.md) for additional ways to deploy Coder.
+
 ## Creating your first template and workspace
 
 In a new terminal window, run the following to copy a sample template:

diff --git a/docs/install.md b/docs/install.md
@@ -0,0 +1,42 @@
+# Install
+
+This article walks you through the various ways of installing and deploying Coder.
+
+## Docker Compose
+
+Before proceeding, please ensure that you have Docker installed.
+
+1. Clone the `coder` repository:
+
+    ```console
+    git clone git@github.com:coder/coder.git
+    ```
+
+1. Navigate into the `coder` folder. Coder requires a non-`localhost` access URL
+    for non-Docker-based examples; if you have a public IP or a domain/reverse
+    proxy, you can provide this value prior to running `docker-compose up` to
+    start the service:
+
+    ```console
+    cd coder
+    CODER_ACCESS_URL=https://coder.mydomain.com
+    docker-compose up
+    ```
+
+    Otherwise, you can simply start the service:
+
+    ```console
+    cd coder
+    docker-compose up
+    ```
+
+    Alternatively, if you would like to start a **temporary deployment**:
+
+    ```console
+    docker run --rm -it \
+    -e CODER_DEV_MODE=true \
+    -v /var/run/docker.sock:/var/run/docker.sock \
+    ghcr.io/coder/coder:v0.5.10
+    ```
+
+1. Follow the on-screen prompts to create your first user and workspace.