diff --git a/docs/install/docker.md b/docs/install/docker.md index de9799ef21..1025e072e7 100644 --- a/docs/install/docker.md +++ b/docs/install/docker.md @@ -13,6 +13,38 @@ You can install and run Coder using the official Docker images published on - 2 CPU cores and 4 GB memory free on your machine. +
+ +## Install Coder via `docker compose` + +Coder publishes a +[docker compose example](https://github.com/coder/coder/blob/main/compose.yaml) +which includes a PostgreSQL container and volume. + +1. Make sure you have [Docker Compose](https://docs.docker.com/compose/install/) + installed. + +1. Download the + [`docker-compose.yaml`](https://github.com/coder/coder/blob/main/compose.yaml) + file. + +1. Update `group_add:` in `docker-compose.yaml` with the `gid` of `docker` + group. You can get the `docker` group `gid` by running the below command: + + ```shell + getent group docker | cut -d: -f3 + ``` + +1. Start Coder with `docker compose up` + +1. Visit the web UI via the configured url. + +1. Follow the on-screen instructions log in and create your first template and + workspace + +Coder configuration is defined via environment variables. Learn more about +Coder's [configuration options](../admin/setup/index.md). + ## Install Coder via `docker run` ### Built-in database (quick) @@ -47,35 +79,7 @@ docker run --rm -it \ ghcr.io/coder/coder:latest ``` -## Install Coder via `docker compose` - -Coder's publishes a -[docker compose example](https://github.com/coder/coder/blob/main/compose.yaml) -which includes an PostgreSQL container and volume. - -1. Make sure you have [Docker Compose](https://docs.docker.com/compose/install/) - installed. - -1. Download the - [`docker-compose.yaml`](https://github.com/coder/coder/blob/main/compose.yaml) - file. - -1. Update `group_add:` in `docker-compose.yaml` with the `gid` of `docker` - group. You can get the `docker` group `gid` by running the below command: - - ```shell - getent group docker | cut -d: -f3 - ``` - -1. Start Coder with `docker compose up` - -1. Visit the web UI via the configured url. - -1. Follow the on-screen instructions log in and create your first template and - workspace - -Coder configuration is defined via environment variables. Learn more about -Coder's [configuration options](../admin/setup/index.md). +
## Install the preview release