Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: add DOCKER_HOST guidance for non-default Docker socket paths - #26807

Merged
nickvigilante merged 3 commits into
mainfrom
vigilante/docs-466-add-colima-docker_host-guidance-to-install-and
Jul 8, 2026
Merged

docs: add DOCKER_HOST guidance for non-default Docker socket paths#26807
nickvigilante merged 3 commits into
mainfrom
vigilante/docs-466-add-colima-docker_host-guidance-to-install-and

Conversation

@nickvigilante

@nickvigilante nickvigilante commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

What

Add DOCKER_HOST guidance for non-default Docker socket paths to two pages:

  • docs/install/docker.md: expands the Cannot connect to the Docker daemon
    troubleshooting section with the DOCKER_HOST fix and how to persist it to
    your shell startup file.
  • docs/admin/templates/troubleshooting.md: adds a concise Cannot connect to
    the Docker daemon
    entry that cross-references the install guide for the full
    steps.

Why

install/docker.md previously documented only the default socket path
(/var/run/docker.sock). When Docker runs through a tool that uses a per-user
socket, such as rootless Docker on Linux, or Colima, Podman, or Rancher Desktop
on macOS, the daemon exposes its socket at a non-default path, so the Coder
server cannot connect until DOCKER_HOST is set. The guidance frames Colima as
one example, notes that default socket paths vary by tool, and persists the
setting in a shell-agnostic way.

Generated by Coder Agents on behalf of @nickvigilante.

…ooting

When the Docker daemon exposes its socket at a non-default path (common with
Colima and other Docker Desktop alternatives on macOS), the Coder server cannot
connect until DOCKER_HOST points at the right socket. Add this guidance to the
"Cannot connect to the Docker daemon" section of the Docker install guide, and
add a concise cross-referenced entry in the template troubleshooting guide.

Refs: DOCS-466

Filed via Coder Agents on Nick's behalf.
@linear-code

linear-code Bot commented Jun 29, 2026

Copy link
Copy Markdown

DOCS-466

@github-actions

Copy link
Copy Markdown
Contributor

Docs preview

📖 View docs preview for docs/admin/templates/troubleshooting.md

Address review feedback on the DOCKER_HOST troubleshooting guidance:

- Frame the non-default socket case as cross-platform (rootless Docker on
  Linux, plus Colima, Podman, or Rancher Desktop on macOS) instead of
  "Docker Desktop alternatives on macOS".
- Present Colima as one example and add a caveat that tools use different
  default socket paths, with a rootless Docker sample alongside Colima.
- Make persistence shell-agnostic: give the export command, then point at
  the reader's shell startup file instead of assuming Bash or Zsh.
- Correct the Colima socket path to ~/.colima/default/docker.sock.

Filed via Coder Agents on Nick's behalf.

Refs: DOCS-466
@nickvigilante nickvigilante changed the title docs: add Colima DOCKER_HOST guidance to Docker install and troubleshooting docs: add DOCKER_HOST guidance for non-default Docker socket paths Jun 29, 2026
Apply docs/.style/style-guide conventions to the DOCKER_HOST
troubleshooting content added in this branch:

- One sentence per line (formatting.md) in both the install guide and
  the template-troubleshooting sections.
- Use "refer to" instead of "see" for the cross-reference in
  troubleshooting.md (word-choice.md).
- Reword the example caveat to state that default socket paths vary by
  tool and the reader should consult their tool's documentation.

Filed via Coder Agents on Nick's behalf.

Refs: DOCS-466
@nickvigilante
nickvigilante marked this pull request as ready for review June 29, 2026 14:51
@nickvigilante
nickvigilante requested a review from bpmct July 8, 2026 14:47
@nickvigilante
nickvigilante merged commit 83acdae into main Jul 8, 2026
36 of 37 checks passed
@nickvigilante
nickvigilante deleted the vigilante/docs-466-add-colima-docker_host-guidance-to-install-and branch July 8, 2026 15:33
@github-actions github-actions Bot locked and limited conversation to collaborators Jul 8, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants