Skip to content

Comments

Add macOS Colima support to setup and deployment docs#474

Open
akshithg wants to merge 2 commits intomainfrom
docs/colima-setup
Open

Add macOS Colima support to setup and deployment docs#474
akshithg wants to merge 2 commits intomainfrom
docs/colima-setup

Conversation

@akshithg
Copy link
Member

The local development setup only documented Docker Desktop, missing Colima users who need to install docker-buildx separately and set DOCKER_BUILDKIT=1.

  • Adds Colima instructions to deployment docs
  • list macOS as a supported platform
  • auto-install buildx in setup-local

macOS users using Colima instead of Docker Desktop were hitting
missing buildx errors and had no documentation to guide them.
Add Colima as a supported Docker runtime, document buildx
installation, and ensure setup-local installs buildx automatically.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Comment on lines +58 to +63
After starting Colima, ensure the buildx plugin is linked:
```bash
brew install docker-buildx
mkdir -p ~/.docker/cli-plugins
ln -sfn $(brew --prefix docker-buildx)/lib/docker/cli-plugins/docker-buildx ~/.docker/cli-plugins/docker-buildx
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

was this necessary instead? I think installing docker-buildx is enough?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this one is required. docker-buildx requires manual linking. Homebrew doesn't write to ~/.docker/
see: brew info docker-buildx (Caveats)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

==> Caveats
docker-buildx is a Docker plugin. For Docker to find the plugin, add "cliPluginsExtraDirs" to ~/.docker/config.json:
  "cliPluginsExtraDirs": [
      "/opt/homebrew/lib/docker/cli-plugins"
  ]

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this equivalent?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! It is. Do you have a preference on which method you want in the docs/or both? I can update it.

Comment on lines +822 to +825
brew install docker-buildx
mkdir -p ~/.docker/cli-plugins
ln -sfn "$(brew --prefix docker-buildx)/lib/docker/cli-plugins/docker-buildx" \
~/.docker/cli-plugins/docker-buildx
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

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