8000 chore: document `docker-compose` development workflow by dannykopping · Pull Request #16618 · coder/coder · GitHub
[go: up one dir, main page]

Skip to content

chore: document docker-compose development workflow #16618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 19, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Document docker-compose development workflow
Signed-off-by: Danny Kopping <danny@coder.com>
  • Loading branch information
dannykopping committed Feb 19, 2025
commit ce8bac2c3210033fc5d4c53688042a32598ef497
9 changes: 9 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
0