Skip to content

docs(docs/tutorials/quickstart.md): recommend free container runtimes besides Docker Desktop#26106

Draft
nickvigilante wants to merge 1 commit into
mainfrom
vigilante/devrel-22-recommend-orbstackcolimarancher-desktoppodman-as-docker
Draft

docs(docs/tutorials/quickstart.md): recommend free container runtimes besides Docker Desktop#26106
nickvigilante wants to merge 1 commit into
mainfrom
vigilante/devrel-22-recommend-orbstackcolimarancher-desktoppodman-as-docker

Conversation

@nickvigilante
Copy link
Copy Markdown
Contributor

Replaces the quickstart's "Install Docker" step with a runtime-agnostic
"Install a container runtime" step, and switches the per-platform defaults
to free, lightweight options that avoid Docker Desktop's cost and overhead.

A callout above the OS tabs names Colima, Rancher Desktop, Podman, and
Docker Desktop as valid runtimes and tells readers to skip ahead if they
already have one running. The default install path per platform is now:

  • Linux: Docker Engine (unchanged from the previous doc)
  • macOS: Colima with the Docker CLI
  • Windows: Podman Desktop

The "Cannot connect to the Docker daemon" troubleshooting subsections are
updated to match the new defaults.

Closes DEVREL-22.

A follow-up Linear issue will track a deeper "Docker runtime alternatives"
reference page covering OrbStack (with its commercial-license caveat),
Rancher Desktop, and CLI Podman.

Implementation proposal and pre-mortem

DEVREL-22 proposal: Replace "Install Docker" with "Install a container runtime"

Linear: DEVREL-22
Repo: coder/coder
Branch: vigilante/devrel-22-recommend-orbstackcolimarancher-desktoppodman-as-docker
Primary file: docs/tutorials/quickstart.md

Summary

Rename Step 1 of the quickstart from "Install Docker and set up permissions" to "Install a container runtime", add a callout that any Docker-compatible runtime works, and switch the per-platform default to the lightest free path on each OS. Keep Docker Desktop, OrbStack, and Rancher Desktop as documented alternatives, but not as the primary recommendation. The deeper "alternatives" reference page is a follow-up.

Why

  • Docker Desktop is slow on macOS/Windows and requires a paid license for most commercial use.
  • The Coder Quickstart template only needs the Docker daemon, not Docker Desktop's GUI.
  • No single tool satisfies "curl install + cross-platform + free + minimal setup", so a per-platform recommendation is the honest answer.

Per-platform defaults

Platform Default in quickstart Why
Linux Docker Engine via curl -sSL https://get.docker.com | sh Already in the doc, already a curl one-liner, already free. No change.
macOS Colima Two commands (brew install colima docker, colima start), free for commercial use, exposes /var/run/docker.sock so the Coder template needs zero env vars.
Windows Podman Desktop Free, handles WSL2 prereq and podman machine setup through the GUI, sets up Docker socket compatibility. Lighter than Docker Desktop, simpler than CLI Podman + DOCKER_HOST.

Pre-mortem

  1. Coder Quickstart template assumes /var/run/docker.sock. Colima symlinks it on macOS. Podman Desktop on Windows enables Docker socket compatibility by default, so the template's Docker provider should reach the daemon without DOCKER_HOST gymnastics.
  2. External links into quickstart#step-1-install-docker-and-set-up-permissions. A grep of docs/ and site/ found no internal references to the old anchor. Blog posts or external links may land at the top of the page after the rename; acceptable for this scope.
  3. Brew assumption on macOS. Recommending brew install colima docker assumes Homebrew. The callout links to brew.sh so users without it can install Homebrew first.
  4. WSL2 on Windows. Podman Desktop's onboarding installs WSL2 if missing. Corporate-managed machines that block WSL2 can fall back to other runtimes named in the callout.
  5. Onboarding tone shift. "Container runtime" is more abstract than "Docker." The callout names Docker Desktop as a runtime first, so the unfamiliar phrase is anchored immediately.
  6. OrbStack license trap. OrbStack is intentionally not in the quickstart's default path because it is paid for commercial use. It will be mentioned on the future alternatives page with the license caveat called out explicitly.

Out of scope (follow-up issues)

  • New "Docker runtime alternatives" reference page covering OrbStack, Rancher Desktop, CLI Podman, with license and compatibility notes.
  • docs/install/docker.md updates. That page is about installing Coder server in a Docker container, which is a separate concern.
  • Updating the coder/skills setup skill if its install steps drift from the new quickstart.
  • Updating the Coder Quickstart template's description in coder/registry if it links to the renamed section.

This pull request was generated by a Coder agent on behalf of @nickvigilante.

… besides Docker Desktop

Replace the 'Install Docker' step with a runtime-agnostic
'Install a container runtime' step. Add a callout above the OS tabs
naming Colima, Rancher Desktop, Podman, and Docker Desktop as valid
runtimes. Switch the per-platform defaults to free, lightweight options:
Docker Engine on Linux, Colima on macOS, Podman Desktop on Windows.
Update the troubleshooting subsections to match the new defaults.

Linear: DEVREL-22

This commit was generated by a Coder agent on behalf of Nick Vigilante.
@linear-code
Copy link
Copy Markdown

linear-code Bot commented Jun 5, 2026

DEVREL-22

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 5, 2026

Docs preview

📖 View docs preview for docs/tutorials/quickstart.md

@bpmct
Copy link
Copy Markdown
Member

bpmct commented Jun 5, 2026

Approving given this has been tested!

@nickvigilante
Copy link
Copy Markdown
Contributor Author

@bpmct I'm going to set up and boot up my gaming PC running Windows this afternoon and check. Doing macOS now. I won't merge until I have confirmed it works on all operating systems.

@nickvigilante
Copy link
Copy Markdown
Contributor Author

I hit a snag installing Podman on Windows through WSL, but I confirmed it works end-to-end on Windows. I'm going to add a note to the Windows steps that users need to add a %USERPROFILE%\.wslconfig file with the following contents if they configured Podman to use WSL and not Hyper-V:

[wsl2]
kernelCommandLine=cgroup_no_v1=all

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants