Skip to content

Commit 4dc2fae

Browse files
authored
Merge pull request docker#14867 from aevesdocker/ENGDOCS-727
rework of faqs page
1 parent 1c40dfb commit 4dc2fae

13 files changed

Lines changed: 283 additions & 287 deletions

File tree

_data/toc.yaml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1300,10 +1300,16 @@ manuals:
13001300
title: Multi-arch support
13011301
- path: /desktop/kubernetes/
13021302
title: Deploy on Kubernetes
1303-
- path: /desktop/faqs/
1304-
title: FAQs
13051303
- path: /desktop/backup-and-restore/
13061304
title: Back up and restore data
1305+
- sectiontitle: FAQs
1306+
section:
1307+
- path: /desktop/faqs/general/
1308+
title: General FAQs
1309+
- path: /desktop/faqs/macfaqs/
1310+
title: Mac FAQs
1311+
- path: /desktop/faqs/windowsfaqs/
1312+
title: Windows FAQs
13071313
- path: /desktop/release-notes/
13081314
title: Release notes
13091315
- sectiontitle: Previous versions

_layouts/landing.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ <h6>Getting Started with Docker</h6>
199199
</p>
200200
<h6>FAQs</h6>
201201
<p class="only-win">
202-
<a href="/desktop/faqs/#can-i-install-docker-desktop-on-windows-10-home">
202+
<a href="/desktop/faqs/windowsfaqs/#can-i-install-docker-desktop-on-windows-10-home">
203203
Can I install Docker Desktop on Windows 10 Home?
204204
</a>
205205
</p>
@@ -209,7 +209,7 @@ <h6>FAQs</h6>
209209
</a>
210210
</p>
211211
<p class="only-win">
212-
<a href="/desktop/faqs/#how-do-i-connect-from-a-container-to-a-service-on-the-host">
212+
<a href="/desktop/faqs/general">
213213
How do I connect from a container to a service?
214214
</a>
215215
</p>
@@ -219,12 +219,12 @@ <h6>FAQs</h6>
219219
</a>
220220
</p>
221221
<p class="only-mac">
222-
<a href="/desktop/faqs/#how-do-i-connect-to-a-container-from-mac-or-windows">
222+
<a href="/desktop/faqs/general/">
223223
How do I connect to a container from Mac?
224224
</a>
225225
</p>
226226
<p class="only-mac">
227-
<a href="/desktop/faqs/">
227+
<a href="/desktop/faqs/general/">
228228
View all
229229
</a>
230230
</p>

desktop/faqs.md

Lines changed: 0 additions & 270 deletions
This file was deleted.

desktop/faqs/general.md

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
---
2+
description: General Frequently asked questions
3+
keywords: desktop, mac, windows, faqs
4+
redirect_from:
5+
- /mackit/faqs/
6+
- /docker-for-mac/faqs/
7+
- /docker-for-windows/faqs/
8+
- /desktop/faqs/
9+
title: Frequently asked questions
10+
---
11+
12+
### What are the system requirements for Docker Desktop?
13+
14+
For information about Docker Desktop system requirements, see:
15+
- [Mac system requirements](../mac/install.md#system-requirements)
16+
- [Windows system requirements](../windows/install.md#system-requirements)
17+
- [Linux system requirements](../linux/install.md#system-requirements)
18+
19+
### Where does Docker Desktop get installed on my machine?
20+
21+
By default, Docker Desktop is installed at the following location:
22+
23+
- On Mac: `/Applications/Docker.app`
24+
- On Windows: `C:\Program Files\Docker\Docker`
25+
- On Linux: `/opt/docker-desktop`
26+
27+
### Do I need to pay to use Docker Desktop?
28+
29+
Docker Desktop remains free for small businesses (fewer than 250 employees AND less than $10 million in annual revenue), personal use, education, and non-commercial open-source projects. It requires a paid subscription for professional use in larger enterprises.
30+
The effective date of these terms is August 31, 2021. When downloading and installing Docker Desktop, you are asked to agree to the [Docker Subscription Service Agreement](https://www.docker.com/legal/docker-subscription-service-agreement){: target="_blank" rel="noopener" class="_"}.
31+
32+
Read the [Blog](https://www.docker.com/blog/updating-product-subscriptions/){: target="_blank" rel="noopener" class="_" id="dkr_docs_subscription_btl"} and [FAQs](https://www.docker.com/pricing/faq){: target="_blank" rel="noopener" class="_" id="dkr_docs_subscription_btl"} to learn how companies using Docker Desktop may be affected. For information about Docker Desktop licensing, see [Docker Desktop License Agreement](../../subscription/index.md#docker-desktop-license-agreement).
33+
34+
### Can I use Docker Desktop offline?
35+
36+
Yes, you can use Docker Desktop offline. However, you
37+
cannot access features that require an active internet
38+
connection. Additionally, any functionality that requires you to sign won't work while using Docker Desktop offline or in air-gapped environments.
39+
This includes:
40+
41+
- The in-app [Quick Start Guide](../mac/install.md#quick-start-guide)
42+
- Pulling or pushing an image to Docker Hub
43+
- [Image Access Management](../../docker-hub/image-access-management.md)
44+
- [Vulnerability scanning](../../docker-hub/vulnerability-scanning.md)
45+
- Viewing remote images in the [Docker Dashboard](../dashboard.md)
46+
- Settting up [Dev Environments](../dev-environments.md)
47+
- Docker build when using [Buildkit](../../develop/develop-images/build_enhancements.md). You can work around this by disabling
48+
BuildKit. Run `DOCKER_BUILDKIT=0 docker build .` to disable BuildKit.
49+
- Deploying an app to the cloud through Compose
50+
[ACI](../../cloud/aci-integration.md) and [ECS](../../cloud/ecs-integration.md)
51+
integrations
52+
- [Kubernetes](../kubernetes.md) (Images are download when you enable Kubernetes for the first time)
53+
- [Check for updates](../mac/install.md#updates) (manual and automatic)
54+
- [In-app diagnostics](../mac/troubleshoot.md#diagnose-and-feedback) (including the [Self-diagnose tool](../mac/troubleshoot.md#self-diagnose-tool))
55+
- Tip of the week
56+
- Sending usage statistics
57+
58+
### What is an experimental feature?
59+
60+
{% include experimental.md %}
61+
62+
### Where can I find information about diagnosing and troubleshooting Docker Desktop issues?
63+
64+
You can find information about diagnosing and troubleshooting common issues in the Troubleshooting topic. See:
65+
- [Mac logs and troubleshooting](../mac/troubleshoot.md)
66+
- [Windows logs and troubleshooting](../windows/troubleshoot.md)
67+
- [Linux logs and troubleshooting](../linux/troubleshoot.md)
68+
69+
If you do not find a solution in troubleshooting, browse the Github repositories or create a new issue:
70+
71+
- [docker/for-mac](https://github.com/docker/for-mac/issues){: target="_blank" rel="noopener" class="_"} - - [docker/for-win](https://github.com/docker/for-win/issues){: target="_blank" rel="noopener" class="_"}
72+
- [docker/for-linux](https://github.com/docker/for-linux/issues){: target="_blank" rel="noopener" class="_"}
73+
74+
### How do I connect to the remote Docker Engine API?
75+
76+
To connect to the remote Engine API, you might need to provide the location of the Engine API for Docker clients and development tools.
77+
78+
Mac and Windows WSL 2 users can connect to the Docker Engine through a Unix socket: `unix:///var/run/docker.sock`.
79+
80+
If you are working with applications like [Apache Maven](https://maven.apache.org/){: target="_blank" rel="noopener" class="_"}
81+
that expect settings for `DOCKER_HOST` and `DOCKER_CERT_PATH` environment
82+
variables, specify these to connect to Docker instances through Unix sockets.
83+
84+
For example:
85+
86+
```console
87+
$ export DOCKER_HOST=unix:///var/run/docker.sock
88+
```
89+
90+
Docker Desktop Windows users can connect to the Docker Engine through a **named pipe**: `npipe:////./pipe/docker_engine`, or **TCP socket** at this URL:
91+
`tcp://localhost:2375`.
92+
93+
For details, see [Docker Engine API](../../engine/api/index.md).
94+
95+
### How do I connect from a container to a service on the host?
96+
97+
Mac, Linux, and Windows have a changing IP address (or none if you have no network access). On both Mac and Windows, we recommend that you connect to the special DNS name `host.docker.internal`, which resolves to the internal IP address used by the host. This is for development purposes and does not work in a production environment outside of Docker Desktop.
98+
99+
For more information and examples, see how to connect from a container to a service on the host
100+
[on Mac](../mac/networking.md#i-want-to-connect-from-a-container-to-a-service-on-the-host) and [on Windows](../windows/networking.md#i-want-to-connect-from-a-container-to-a-service-on-the-host) or [on Linux](../linux/networking.md#i-want-to-connect-from-a-container-to-a-service-on-the-host).
101+
102+
### Can I pass through a USB device to a container?
103+
104+
Unfortunately, it is not possible to pass through a USB device (or a
105+
serial port) to a container as it requires support at the hypervisor level.
106+
107+
### Can I run Docker Desktop in nested virtualization scenarios?
108+
109+
Docker Desktop can run inside a Windows 10 VM running on apps like Parallels or
110+
VMware Fusion on a Mac provided that the VM is properly configured. However,
111+
problems and intermittent failures may still occur due to the way these apps
112+
virtualize the hardware. For these reasons, **Docker Desktop is not supported in
113+
nested virtualization scenarios**. It might work in some cases and not in others.
114+
115+
### Docker Desktop's UI appears green, distorted, or has visual artifacts. How do I fix this?
116+
117+
Docker Desktop uses hardware-accelerated graphics by default, which may cause problems for some GPUs. In such cases,
118+
Docker Desktop will launch successfully, but some screens may appear green, distorted,
119+
or have some visual artifacts.
120+
121+
To work around this issue, disable hardware acceleration by creating a `"disableHardwareAcceleration": true` entry in Docker Desktop's `settings.json` file. You can find this file at:
122+
123+
- **Mac**: `~/Library/Group Containers/group.com.docker/settings.json`
124+
- **Windows**: `C:\Users\[USERNAME]\AppData\Roaming\Docker\settings.json`
125+
126+
After updating the `settings.json` file, close and restart Docker Desktop to apply the changes.
127+
128+
### Can I run Docker Desktop on Virtualized hardware?
129+
130+
No, currently this is unsupported and against terms of use.
131+
132+
## Releases
133+
134+
### How do new users install Docker Desktop?
135+
136+
Each Docker Desktop release is also delivered as a full installer for new users. The same applies if you have skipped a version, although this doesn't normally happen as updates are applied automatically.
137+
138+
### How frequent will new releases be?
139+
140+
New releases are available roughly monthly, unless there are critical fixes that need to be released sooner.
141+
142+
### How do I ensure that all users on my team are using the same version?
143+
144+
Previously you had to manage this yourself. Now, it happens automatically as a side effect of all users being on the latest version.
145+
146+
### My colleague has got a new version but I haven’t got it yet.
147+
148+
Sometimes we may roll out a new version gradually over a few days. Therefore, if you wait, it will turn up soon. Alternatively, you can select **Check for Updates** from the Docker menu to jump the queue and get the latest version immediately.
149+
150+
### Where can I find information about Stable and Edge releases?
151+
152+
Starting with Docker Desktop 3.0.0, Stable and Edge releases are combined into a single, cumulative release stream for all users.

desktop/faqs/macfaqs.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
description: Frequently asked questions
3+
keywords: desktop, mac, faqs
4+
title: Frequently asked questions for Mac
5+
---
6+
7+
### What is Docker.app?
8+
9+
`Docker.app` is Docker Desktop on Mac. It bundles the Docker client and Docker Engine. `Docker.app` uses the macOS Hypervisor.framework to run containers.
10+
11+
### What is HyperKit?
12+
13+
HyperKit is a hypervisor built on top of the Hypervisor.framework in macOS. It runs entirely in userspace and has no other dependencies.
14+
15+
We use HyperKit to eliminate the need for other VM products, such as Oracle
16+
VirtualBox or VMWare Fusion.
17+
18+
### What is the benefit of HyperKit?
19+
20+
HyperKit is thinner than VirtualBox and VMWare fusion, and the version included is customized for Docker workloads on Mac.
21+
22+
### Why is com.docker.vmnetd still running after I quit the app?
23+
24+
The privileged helper process `com.docker.vmnetd` is started by `launchd` and
25+
runs in the background. The process does not consume any resources unless
26+
Docker.app connects to it, so it's safe to ignore.

desktop/faqs/windowsfaqs.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
description: Frequently asked questions
3+
keywords: desktop, windows, faqs
4+
title: Frequently asked questions for Windows
5+
---
6+
7+
### Can I use VirtualBox alongside Docker Desktop?
8+
9+
Yes, you can run VirtualBox along with Docker Desktop if you have enabled the [Windows Hypervisor Platform](https://docs.microsoft.com/en-us/virtualization/api/){: target="_blank" rel="noopener" class="_"} feature on your machine.
10+
11+
### Why is Windows 10 or Windows 11 required?
12+
13+
Docker Desktop uses the Windows Hyper-V features. While older Windows versions have Hyper-V, their Hyper-V implementations lack features critical for Docker Desktop to work.
14+
15+
### Can I install Docker Desktop on Windows 10 Home?
16+
17+
If you are running Windows 10 Home (starting with version 1903), you can install [Docker Desktop for Windows](https://hub.docker.com/editions/community/docker-ce-desktop-windows/){: target="_blank" rel="noopener" class="_"} with the [WSL 2 backend](../windows/wsl.md).
18+
19+
### Can I run Docker Desktop on Windows Server?
20+
21+
No, running Docker Desktop on Windows Server is not supported.
22+
23+
### How do I run Windows containers on Windows Server?
24+
25+
You can install a native Windows binary which allows you to develop and run
26+
Windows containers without Docker Desktop. For more information, see the tutorial about running Windows containers on Windows Server in
27+
[Getting Started with Windows Containers](https://github.com/docker/labs/blob/master/windows/windows-containers/README.md){: target="_blank" rel="noopener" class="_"}.
28+
29+
### Why do I see the `Docker Desktop Access Denied` error message when I try to start Docker Desktop?
30+
31+
Docker Desktop displays the **Docker Desktop - Access Denied** error if a Windows user is not part of the **docker-users** group.
32+
33+
If your admin account is different to your user account, add the **docker-users** group. Run **Computer Management** as an administrator and navigate to **Local Users* and Groups** > **Groups** > **docker-users**.
34+
35+
Right-click to add the user to the group. Log out and log back in for the changes to take effect.
36+
37+
### Why does Docker Desktop fail to start when anti-virus software is installed?
38+
39+
Some anti-virus software may be incompatible with Hyper-V and Windows 10 builds which impact Docker
40+
Desktop. For more information, see [Docker Desktop fails to start when anti-virus software is installed](../windows/troubleshoot.md#docker-desktop-fails-to-start-when-anti-virus-software-is-installed).
41+
42+
### Can I change permissions on shared volumes for container-specific deployment requirements?
43+
44+
Docker Desktop does not enable you to control (`chmod`)
45+
the Unix-style permissions on [shared volumes](../windows/index.md#file-sharing) for
46+
deployed containers, but rather sets permissions to a default value of
47+
[0777](http://permissions-calculator.org/decode/0777/){: target="_blank" rel="noopener" class="_"}
48+
(`read`, `write`, `execute` permissions for `user` and for
49+
`group`) which is not configurable.
50+
51+
For workarounds and to learn more, see
52+
[Permissions errors on data directories for shared volumes](../windows/troubleshoot.md#permissions-errors-on-data-directories-for-shared-volumes).
53+
54+
### How do symlinks work on Windows?
55+
56+
Docker Desktop supports two types of symlinks: Windows native symlinks and symlinks created inside a container.
57+
58+
The Windows native symlinks are visible within the containers as symlinks, whereas symlinks created inside a container are represented as [mfsymlinks](https://wiki.samba.org/index.php/UNIX_Extensions#Minshall.2BFrench_symlinks){:target="_blank" rel="noopener" class="_"}. These are regular Windows files with a special metadata. Therefore the symlinks created inside a container appear as symlinks inside the container, but not on the host.
59+
60+
### File sharing with Kubernetes and WSL 2
61+
62+
Docker Desktop mounts the Windows host filesystem under `/run/desktop` inside the container running Kubernetes.
63+
See the [Stack Overflow post](https://stackoverflow.com/questions/67746843/clear-persistent-volume-from-a-kubernetes-cluster-running-on-docker-desktop/69273405#69273){:target="_blank" rel="noopener" class="_"} for an example of how to configure a Kubernetes Persistent Volume to represent directories on the host.

desktop/linux/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ Docker Desktop for Linux runs a Virtual Machine (VM) for the following reasons:
279279
- [Getting started](index.md) provides an overview of Docker Desktop on Linux, basic Docker command examples, how to get help or give feedback, and links to other topics about Docker Desktop on Linux.
280280
- [Troubleshooting](troubleshoot.md) describes common problems, workarounds, how
281281
to run and submit diagnostics, and submit issues.
282-
- [FAQs](../faqs.md) provide answers to frequently asked questions.
282+
- [FAQs](../faqs/general.md) provide answers to frequently asked questions.
283283
- [Release notes](release-notes/index.md) lists component updates, new features, and improvements associated with Docker Desktop releases.
284284
- [Get started with Docker](../../get-started/index.md) provides a general Docker tutorial.
285285
* [Back up and restore data](../backup-and-restore.md) provides instructions

desktop/linux/troubleshoot.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,11 @@ Docker Desktop is available for Linux, Mac and Windows. The supported version in
240240
* [Mac system requirements](../mac/install.md#system-requirements)
241241
* [Windows system requirements](../windows/install.md#system-requirements)
242242

243-
### Can I run Docker Desktop on Virtualized hardware?
243+
### How is personal data handled in Docker Desktop?
244244

245-
No, currently this is unsupported and against the terms of use.
245+
When uploading diagnostics to help Docker with investigating issues, the uploaded diagnostics bundle may contain personal data such as usernames and IP addresses. The diagnostics bundles are only accessible to Docker, Inc.
246+
employees who are directly involved in diagnosing Docker Desktop issues.
247+
248+
By default, Docker, Inc. will delete uploaded diagnostics bundles after 30 days. You may also request the removal of a diagnostics bundle by either specifying the diagnostics ID or via your GitHub ID (if the diagnostics ID is mentioned in a GitHub issue). Docker, Inc. will only use the data in the diagnostics bundle to investigate specific user issues but may derive high-level (non personal) metrics such as the rate of issues from it.
249+
250+
For more information, see [Docker Data Processing Agreement](https://www.docker.com/legal/data-processing-agreement){: target="_blank" rel="noopener" class="_"}.

desktop/mac/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ To uninstall Docker Desktop from your Mac:
134134
- [Docker Desktop for Apple silicon](apple-silicon.md) for detailed information about Docker Desktop for Apple silicon.
135135
- [Troubleshooting](troubleshoot.md) describes common problems, workarounds, how
136136
to run and submit diagnostics, and submit issues.
137-
- [FAQs](../faqs.md) provide answers to frequently asked questions.
137+
- [FAQs](../faqs/general.md) provide answers to frequently asked questions.
138138
- [Release notes](release-notes/index.md) lists component updates, new features, and improvements associated with Docker Desktop releases.
139139
- [Get started with Docker](../../get-started/index.md) provides a general Docker tutorial.
140140
* [Back up and restore data](../backup-and-restore.md) provides instructions

desktop/mac/troubleshoot.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,13 @@ Docker Desktop is available for Mac and Windows. The supported version informati
410410

411411
* [Mac system requirements](install.md#system-requirements)
412412
* [Windows system requirements](../windows/install.md#system-requirements)
413+
* [Linux system requirements](../linux/install.md#system-requirements)
413414

414-
### Can I run Docker Desktop on Virtualized hardware?
415+
### How is personal data handled in Docker Desktop?
415416

416-
No, currently this is unsupported and against the terms of use.
417+
When uploading diagnostics to help Docker with investigating issues, the uploaded diagnostics bundle may contain personal data such as usernames and IP addresses. The diagnostics bundles are only accessible to Docker, Inc.
418+
employees who are directly involved in diagnosing Docker Desktop issues.
419+
420+
By default, Docker, Inc. will delete uploaded diagnostics bundles after 30 days. You may also request the removal of a diagnostics bundle by either specifying the diagnostics ID or via your GitHub ID (if the diagnostics ID is mentioned in a GitHub issue). Docker, Inc. will only use the data in the diagnostics bundle to investigate specific user issues but may derive high-level (non personal) metrics such as the rate of issues from it.
421+
422+
For more information, see [Docker Data Processing Agreement](https://www.docker.com/legal/data-processing-agreement){: target="_blank" rel="noopener" class="_"}.

0 commit comments

Comments
 (0)