Skip to content
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

faq: update to address potential need for Docker client configuration #1231

Merged
merged 1 commit into from
Dec 29, 2024
Merged
Changes from all commits
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
38 changes: 36 additions & 2 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
- [Listing Docker contexts](#listing-docker-contexts)
- [Changing the active Docker context](#changing-the-active-docker-context)
- [Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?](#cannot-connect-to-the-docker-daemon-at-unixvarrundockersock-is-the-docker-daemon-running)
- [How to customize Docker config e.g. add insecure registries?](#how-to-customize-docker-config-eg-add-insecure-registries)
- [How to customize Docker config (e.g., adding insecure registries or registry mirrors)?](#how-to-customize-docker-config-eg-adding-insecure-registries-or-registry-mirrors)
- [Docker buildx plugin is missing](#docker-buildx-plugin-is-missing)
- [Installing Buildx](#installing-buildx)
- [How does Colima compare to minikube, Kind, K3d?](#how-does-colima-compare-to-minikube-kind-k3d)
Expand Down Expand Up @@ -158,7 +158,7 @@ This can be fixed by any of the following approaches. Ensure the Docker socket p
```


### How to customize Docker config e.g. add insecure registries?
### How to customize Docker config (e.g., adding insecure registries or registry mirrors)?

* v0.3.4 or lower

Expand All @@ -182,6 +182,40 @@ This can be fixed by any of the following approaches. Ensure the Docker socket p
+ - myregistry.com:5000
+ - host.docker.internal:5000
```
**Note:** In order for the Docker client to respect (at least some) configuration value changes, modification of the host ~/.docker/daemon.json file may also be required.

For example, if adding registry mirrors, modifications are needed as follows:

First, colima:

```sh
colima start --edit
```

```diff
- docker: {}
+ docker:
+ registry-mirrors:
+ - https://my.dockerhub.mirror.something
+ - https://my.quayio.mirror.something
```

As an alternative approach to the **colima start --edit**, make the changes via the **template** command (affecting the configuration for any new instances):

```sh
colima template
```

Then, the Docker ~/.docker/daemon.json file (as compared to the default):

```diff
- "experimental": false,
+ "experimental": false,
+ "registry-mirrors": [
+ "https://my.dockerhub.mirror.something",
+ "https://my.quayio.mirror.something"
+ ]
```

### Docker buildx plugin is missing

Expand Down