From ce8bac2c3210033fc5d4c53688042a32598ef497 Mon Sep 17 00:00:00 2001 From: Danny Kopping Date: Wed, 19 Feb 2025 12:31:32 +0000 Subject: [PATCH 1/2] Document docker-compose development workflow Signed-off-by: Danny Kopping --- docs/CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 7be637cb8203c..a0b1698eb1358 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -106,6 +106,15 @@ Use the following `make` commands and scripts in development: - The default user is `admin@coder.com` and the default password is `SomeSecurePassword!` +### Running Coder using docker-compose + +This mode is useful for testing HA or validating more complex setups. + +- Generate a new image from your HEAD: `make build/coder_$(./scripts/version.sh)_$(go env GOOS)_$(go env GOARCH).tag` + - This will output the name of the new image, e.g.: `ghcr.io/coder/coder:v2.19.0-devel-22fa71d15-amd64` +- Inject this image into docker-compose: `CODER_VERSION=v2.19.0-devel-22fa71d15-amd64 docker-compose up` (_note the prefix `ghcr.io/coder/coder:` was removed_) +- To use Docker, determine your host's `docker` group ID with `getent group docker | cut -d: -f3`, then update the value of `group_add` and uncomment + ### Deploying a PR > You need to be a member or collaborator of the of From 685d37e8f8adbf96d68f8e4bb241fd52d4b6a8cf Mon Sep 17 00:00:00 2001 From: Danny Kopping Date: Wed, 19 Feb 2025 12:36:10 +0000 Subject: [PATCH 2/2] make lint Signed-off-by: Danny Kopping --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index a0b1698eb1358..fdc372c034903 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -112,7 +112,7 @@ This mode is useful for testing HA or validating more complex setups. - Generate a new image from your HEAD: `make build/coder_$(./scripts/version.sh)_$(go env GOOS)_$(go env GOARCH).tag` - This will output the name of the new image, e.g.: `ghcr.io/coder/coder:v2.19.0-devel-22fa71d15-amd64` -- Inject this image into docker-compose: `CODER_VERSION=v2.19.0-devel-22fa71d15-amd64 docker-compose up` (_note the prefix `ghcr.io/coder/coder:` was removed_) +- Inject this image into docker-compose: `CODER_VERSION=v2.19.0-devel-22fa71d15-amd64 docker-compose up` (*note the prefix `ghcr.io/coder/coder:` was removed*) - To use Docker, determine your host's `docker` group ID with `getent group docker | cut -d: -f3`, then update the value of `group_add` and uncomment ### Deploying a PR