mirror of https://github.com/docker/docs.git
global troubleshoot section for DD (#15173)
* global troubleshoot section for DD * tidy up * fix links * fix links * tidy up * tidy up
This commit is contained in:
Allie Sadler
GitHub
parent
a80e60648c
commit
e29b9691ae
|
|
@ -1167,22 +1167,14 @@ manuals:
|
|||
title: Explore Volumes
|
||||
- sectiontitle: Mac
|
||||
section:
|
||||
- path: /desktop/mac/troubleshoot/
|
||||
title: Logs and troubleshooting
|
||||
- path: /desktop/mac/apple-silicon/
|
||||
title: Apple silicon
|
||||
- path: /desktop/mac/privileged-helper/
|
||||
title: Privileged Helper
|
||||
- sectiontitle: Windows
|
||||
section:
|
||||
- path: /desktop/windows/troubleshoot/
|
||||
title: Logs and troubleshooting
|
||||
- path: /desktop/windows/wsl/
|
||||
title: Docker Desktop WSL 2 backend
|
||||
- sectiontitle: Linux
|
||||
section:
|
||||
- path: /desktop/linux/troubleshoot/
|
||||
title: Logs and troubleshooting
|
||||
- sectiontitle: Change settings
|
||||
section:
|
||||
- path: /desktop/settings/mac/
|
||||
|
|
@ -1191,6 +1183,16 @@ manuals:
|
|||
title: On Windows
|
||||
- path: /desktop/settings/linux/
|
||||
title: On Linux
|
||||
- sectiontitle: Troubleshoot and diagnose
|
||||
section:
|
||||
- path: /desktop/troubleshoot/overview/
|
||||
title: Overview
|
||||
- path: /desktop/troubleshoot/topics/
|
||||
title: Troubleshoot topics
|
||||
- path: /desktop/troubleshoot/workarounds/
|
||||
title: Workarounds for common problems
|
||||
- path: /desktop/troubleshoot/known-issues/
|
||||
title: Known issues for Mac
|
||||
- path: /desktop/networking/
|
||||
title: Explore networking features
|
||||
- sectiontitle: Dev Environments (Beta)
|
||||
|
|
|
|||
|
|
@ -54,8 +54,8 @@ This includes:
|
|||
[ACI](../../cloud/aci-integration.md) and [ECS](../../cloud/ecs-integration.md)
|
||||
integrations
|
||||
- [Kubernetes](../kubernetes.md) (Images are download when you enable Kubernetes for the first time)
|
||||
- [Check for updates](../install/mac-install.md#updates) (manual and automatic)
|
||||
- [In-app diagnostics](../mac/troubleshoot.md#diagnose-and-feedback) (including the [Self-diagnose tool](../mac/troubleshoot.md#self-diagnose-tool))
|
||||
- Check for updates
|
||||
- [In-app diagnostics](../troubleshoot/overview.md#diagnose-from-the-app) (including the [Self-diagnose tool](../troubleshoot/overview.md#diagnose-from-the-app))
|
||||
- Tip of the week
|
||||
- Sending usage statistics
|
||||
|
||||
|
|
@ -65,10 +65,7 @@ This includes:
|
|||
|
||||
### Where can I find information about diagnosing and troubleshooting Docker Desktop issues?
|
||||
|
||||
You can find information about diagnosing and troubleshooting common issues in the Troubleshooting topic. See:
|
||||
- [Mac logs and troubleshooting](../mac/troubleshoot.md)
|
||||
- [Windows logs and troubleshooting](../windows/troubleshoot.md)
|
||||
- [Linux logs and troubleshooting](../linux/troubleshoot.md)
|
||||
You can find information about diagnosing and troubleshooting common issues in the [Troubleshooting topic](../troubleshoot/overview.md).
|
||||
|
||||
If you do not find a solution in troubleshooting, browse the Github repositories or create a new issue:
|
||||
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ Right-click to add the user to the group. Log out and log back in for the change
|
|||
### Why does Docker Desktop fail to start when anti-virus software is installed?
|
||||
|
||||
Some anti-virus software may be incompatible with Hyper-V and Windows 10 builds which impact Docker
|
||||
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).
|
||||
Desktop. For more information, see [Docker Desktop fails to start when anti-virus software is installed](../troubleshoot/workarounds.md#docker-desktop-fails-to-start-when-anti-virus-software-is-installed).
|
||||
|
||||
### Can I change permissions on shared volumes for container-specific deployment requirements?
|
||||
|
||||
|
|
@ -49,7 +49,7 @@ deployed containers, but rather sets permissions to a default value of
|
|||
`group`) which is not configurable.
|
||||
|
||||
For workarounds and to learn more, see
|
||||
[Permissions errors on data directories for shared volumes](../windows/troubleshoot.md#permissions-errors-on-data-directories-for-shared-volumes).
|
||||
[Permissions errors on data directories for shared volumes](../troubleshoot/topics.md#permissions-errors-on-data-directories-for-shared-volumes).
|
||||
|
||||
### How do symlinks work on Windows?
|
||||
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 341 KiB After Width: | Height: | Size: 341 KiB |
|
Before Width: | Height: | Size: 274 KiB After Width: | Height: | Size: 274 KiB |
|
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 47 KiB |
|
Before Width: | Height: | Size: 158 KiB After Width: | Height: | Size: 158 KiB |
|
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 102 KiB |
|
Before Width: | Height: | Size: 49 KiB After Width: | Height: | Size: 49 KiB |
|
|
@ -271,7 +271,7 @@ Docker Desktop for Linux runs a Virtual Machine (VM) for the following reasons:
|
|||
## Where to go next
|
||||
|
||||
- [Getting started](../linux/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.
|
||||
- [Troubleshooting](../linux/troubleshoot.md) describes common problems, workarounds, how
|
||||
- [Troubleshooting](../troubleshoot/overview.md) describes common problems, workarounds, how
|
||||
to run and submit diagnostics, and submit issues.
|
||||
- [FAQs](../faqs/general.md) provide answers to frequently asked questions.
|
||||
- [Release notes](../release-notes.md) lists component updates, new features, and improvements associated with Docker Desktop releases.
|
||||
|
|
|
|||
|
|
@ -114,6 +114,21 @@ To uninstall Docker Desktop from your Mac:
|
|||
1. From the Docker menu, select **Troubleshoot** and then select **Uninstall**.
|
||||
2. Click **Uninstall** to confirm your selection.
|
||||
|
||||
> Uninstall Docker Desktop from the command line
|
||||
>
|
||||
> To uninstall Docker Desktop from a terminal, run: `<DockerforMacPath>
|
||||
> --uninstall`. If your instance is installed in the default location, this
|
||||
> command provides a clean uninstall:
|
||||
>
|
||||
> ```console
|
||||
> $ /Applications/Docker.app/Contents/MacOS/Docker --uninstall
|
||||
> Docker is running, exiting...
|
||||
> Docker uninstalled successfully. You can move the Docker application to the trash.
|
||||
> ```
|
||||
>
|
||||
> You might want to use the command-line uninstall if, for example, you find that
|
||||
> the app is non-functional, and you cannot uninstall it from the menu.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Uninstalling Docker Desktop destroys Docker containers, images, volumes, and
|
||||
|
|
@ -125,7 +140,7 @@ To uninstall Docker Desktop from your Mac:
|
|||
|
||||
- [Getting started](../mac/index.md) provides an overview of Docker Desktop on Mac, basic Docker command examples, how to get help or give feedback, and links to other topics about Docker Desktop on Mac.
|
||||
- [Docker Desktop for Apple silicon](../mac/apple-silicon.md) for detailed information about Docker Desktop for Apple silicon.
|
||||
- [Troubleshooting](../mac/troubleshoot.md) describes common problems, workarounds, how
|
||||
- [Troubleshooting](../troubleshoot/overview.md) describes common problems, workarounds, how
|
||||
to run and submit diagnostics, and submit issues.
|
||||
- [FAQs](../faqs/general.md) provide answers to frequently asked questions.
|
||||
- [Release notes](../release-notes.md) lists component updates, new features, and improvements associated with Docker Desktop releases.
|
||||
|
|
|
|||
|
|
@ -52,7 +52,7 @@ WSL 2 on Windows 10 or Windows 11:
|
|||
- 4GB system RAM
|
||||
- BIOS-level hardware virtualization support must be enabled in the
|
||||
BIOS settings. For more information, see
|
||||
[Virtualization](../windows/troubleshoot.md#virtualization-must-be-enabled).
|
||||
[Virtualization](../troubleshoot/topics.md).
|
||||
- Download and install the [Linux kernel update package](https://docs.microsoft.com/windows/wsl/wsl2-kernel){: target="_blank" rel="noopener" class="_"}.
|
||||
|
||||
</div>
|
||||
|
|
@ -72,7 +72,7 @@ Hyper-V on Windows 10:
|
|||
- 4GB system RAM
|
||||
- BIOS-level hardware virtualization support must be enabled in the
|
||||
BIOS settings. For more information, see
|
||||
[Virtualization](../windows/troubleshoot.md#virtualization-must-be-enabled).
|
||||
[Virtualization](../troubleshoot/topics.md).
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -87,7 +87,7 @@ accounts use the same VM to build and run containers. Note that it is not possib
|
|||
|
||||
Nested virtualization scenarios, such as running Docker Desktop on a
|
||||
VMWare or Parallels instance might work, but there are no guarantees. For
|
||||
more information, see [Running Docker Desktop in nested virtualization scenarios](../windows/troubleshoot.md#running-docker-desktop-in-nested-virtualization-scenarios).
|
||||
more information, see [Running Docker Desktop in nested virtualization scenarios](../troubleshoot/topics.md#running-docker-desktop-in-nested-virtualization-scenarios).
|
||||
|
||||
### About Windows containers
|
||||
|
||||
|
|
@ -204,7 +204,7 @@ To uninstall Docker Desktop from your Windows machine:
|
|||
* [Getting started](../windows/index.md) introduces Docker Desktop for Windows.
|
||||
* [Get started with Docker](/get-started/) is a tutorial that teaches you how to
|
||||
deploy a multi-service stack.
|
||||
* [Troubleshooting](../windows/troubleshoot.md) describes common problems, workarounds, and
|
||||
* [Troubleshooting](../troubleshoot/overview.md) describes common problems, workarounds, and
|
||||
how to get support.
|
||||
* [FAQs](../faqs/general.md) provide answers to frequently asked questions.
|
||||
* [Release notes](../release-notes.md) lists component updates, new features, and improvements associated with Docker Desktop releases.
|
||||
|
|
|
|||
|
|
@ -1,174 +0,0 @@
|
|||
---
|
||||
description: Troubleshooting, logs, and known issues
|
||||
keywords: linux, troubleshooting, logs, issues
|
||||
title: Logs and troubleshooting
|
||||
---
|
||||
|
||||
{% include upgrade-cta.html
|
||||
body="Did you know that Docker Desktop offers support for developers on a paid Docker subscription (Pro, Team, or Business)? Upgrade now to benefit from Docker Support. Click [here](../../support/index.md) to learn more."
|
||||
target-url="https://www.docker.com/pricing?utm_source=docker&utm_medium=webreferral&utm_campaign=docs_driven_upgrade_desktop_support"
|
||||
%}
|
||||
|
||||
This page contains information on how to diagnose and troubleshoot Docker Desktop issues, request Docker Desktop support, send logs and communicate with the Docker Desktop team, use our forums and Success Center, browse and log issues on GitHub, and find workarounds for known problems.
|
||||
|
||||
## Troubleshoot
|
||||
|
||||
Choose {: .inline} > **Troubleshoot**
|
||||
from the menu bar to see the troubleshoot options.
|
||||
|
||||
{:width="600px"}
|
||||
|
||||
The Troubleshoot page contains the following options:
|
||||
|
||||
* **Restart Docker Desktop**: Select to restart Docker Desktop.
|
||||
|
||||
* **Support**: Users with a paid Docker subscription can use this option to send a support request. Other users can use this option to diagnose any issues in Docker Desktop. For more information, see [Diagnose and feedback](#diagnose-and-feedback) and [Support](../../support/index.md).
|
||||
|
||||
* **Reset Kubernetes cluster**: Select this option to delete all stacks and Kubernetes resources. For more information, see [Kubernetes](../settings/linux.md#kubernetes).
|
||||
|
||||
* **Clean / Purge data**: This option resets all Docker data _without_ a
|
||||
reset to factory defaults. Selecting this option results in the loss of existing settings.
|
||||
|
||||
* **Reset to factory defaults**: Choose this option to reset all options on
|
||||
Docker Desktop to their initial state, the same as when Docker Desktop was first installed.
|
||||
|
||||
|
||||
## Diagnose and feedback
|
||||
|
||||
### In-app diagnostics
|
||||
|
||||
If you encounter problems for which you do not find solutions in this
|
||||
documentation, on [Docker Desktop issues on
|
||||
GitHub](https://github.com/docker/desktop-linux/issues), we can help you troubleshoot
|
||||
the log data. Before reporting an issue, we recommend that you read the information provided on this page to fix some common known issues.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Docker Desktop offers support for users with a paid Docker subscription. If you are experiencing any issues with Docker Desktop, follow the instructions in this section to send a support request to Docker Support.
|
||||
|
||||
Before you get started, we recommend that you sign into your Docker Desktop application and your [Docker Hub](https://hub.docker.com/){:target="_blank" rel="noopener" class="_"} account.
|
||||
|
||||
1. Choose {: .inline} > **Troubleshoot**.
|
||||
2. Optional: Sign into Docker Desktop. In addition, ensure you are signed into your [Docker account](https://hub.docker.com/){:target="_blank" rel="noopener" class="_"}.
|
||||
3. Click **Get support**. This opens the in-app **Support** page and starts collecting the diagnostics.
|
||||
{:width="600px"}
|
||||
4. When the diagnostics collection process is complete, click **Upload to get a Diagnostic ID**.
|
||||
5. When the diagnostics have been uploaded, Docker Desktop prints a diagnostic ID. Copy this ID.
|
||||
6. If you have a paid Docker subscription, click **Contact Support**. This opens the [Docker Desktop support](https://hub.docker.com/support/desktop/){:target="_blank" rel="noopener" class="_"} form. Fill in the information required and add the ID you copied earlier to the Diagnostics ID field. Click **Submit** to request Docker Desktop support.
|
||||
> **Note**
|
||||
>
|
||||
> You must be signed in to Docker Desktop using your Pro, Team, or Business tier credentials to access the support form. For information on what's covered as part of Docker Desktop support, see [Support](../../support/index.md).
|
||||
7. If you don't have a paid Docker subscription, you can click **Upgrade to benefit from Docker Support** to upgrade your existing account.
|
||||
Alternatively, click **Report a Bug** to open a new Docker Desktop issue on GitHub. This opens Docker Desktop [for Linux](https://github.com/docker/desktop-linux/issues/) on GitHub in your web browser in a 'New issue' template. Complete the information required and ensure you add the diagnostic ID you copied earlier. Click **submit new issue** to create a new issue.
|
||||
|
||||
### Diagnosing from the terminal
|
||||
|
||||
In some cases, it is useful to run the diagnostics yourself, for instance, if
|
||||
Docker Desktop cannot start.
|
||||
|
||||
First, locate the `com.docker.diagnose` tool. If you have installed Docker Desktop in the Applications directory, then it is located at
|
||||
`/opt/docker-desktop/bin/com.docker.diagnose`.
|
||||
|
||||
To create *and upload* diagnostics, run:
|
||||
|
||||
```console
|
||||
$ /opt/docker-desktop/bin/com.docker.diagnose gather -upload
|
||||
```
|
||||
|
||||
After the diagnostics have finished, you should have the following output,
|
||||
containing your diagnostics ID:
|
||||
|
||||
```sh
|
||||
Diagnostics Bundle: /tmp/B8CF8400-47B3-4068-ADA4-3BBDCE3985D9/20190726143610.zip
|
||||
Diagnostics ID: B8CF8400-47B3-4068-ADA4-3BBDCE3985D9/20190726143610 (uploaded)
|
||||
Diagnostics Bundle: /tmp/BE9AFAAF-F68B-41D0-9D12-84760E6B8740/20190905152051.zip
|
||||
Diagnostics ID: BE9AFAAF-F68B-41D0-9D12-84760E6B8740/20190905152051 (uploaded)
|
||||
```
|
||||
|
||||
The diagnostics ID (here BE9AFAAF-F68B-41D0-9D12-84760E6B8740/20190905152051) is
|
||||
composed of your user ID (BE9AFAAF-F68B-41D0-9D12-84760E6B8740) and a timestamp
|
||||
(20190905152051). Ensure you provide the full diagnostics ID, and not just the user ID.
|
||||
|
||||
To view the contents of the diagnostic file, run:
|
||||
|
||||
```console
|
||||
$ unzip –l /tmp/BE9AFAAF-F68B-41D0-9D12-84760E6B8740/20190905152051.zip
|
||||
```
|
||||
|
||||
If you have a paid Docker subscription, open the [Docker Desktop support](https://hub.docker.com/support/desktop/){:target="_blank" rel="noopener" class="_"} form. Fill in the information required and add the ID to the Diagnostics ID field. Click **Submit** to request Docker Desktop support.
|
||||
|
||||
### Self-diagnose tool
|
||||
|
||||
Docker Desktop contains a self-diagnose tool which helps you to identify some common problems. Before you run the self-diagnose tool, locate `com.docker.diagnose`. If you have installed Docker Desktop
|
||||
in the Applications directory, then the self-diagnose tool will be located at
|
||||
`/opt/docker-desktop/bin/com.docker.diagnose`.
|
||||
|
||||
To run the self-diagnose tool, run:
|
||||
|
||||
```console
|
||||
$ /opt/docker-desktop/bin/com.docker.diagnose check
|
||||
```
|
||||
|
||||
The tool runs a suite of checks and displays **PASS** or **FAIL** next to each check. If there are any failures, it highlights the most relevant at the end of the report.
|
||||
|
||||
> **Feedback**
|
||||
>
|
||||
> Let us know your feedback on the self-diagnose tool by creating an issue in the [desktop-linux](https://github.com/docker/desktop-linux/issues) GitHub repository.
|
||||
|
||||
<a name="logs"></a>
|
||||
|
||||
## Check the logs
|
||||
|
||||
In addition to using the diagnose and feedback option to submit logs, you can
|
||||
browse the logs yourself.
|
||||
|
||||
#### In a terminal
|
||||
|
||||
If you prefer to investigate issues yourself, you can access Docker Desktop logs by running the following command:
|
||||
|
||||
```console
|
||||
$ journalctl --user --unit=docker-desktop
|
||||
```
|
||||
|
||||
You can also find the logs for the internal components included in Docker
|
||||
Desktop at `$HOME/.docker/desktop/log/`.
|
||||
|
||||
#### View the Docker Daemon logs
|
||||
|
||||
Refer to the [read the logs](../../config/daemon/index.md#read-the-logs) section
|
||||
to learn how to view the Docker Daemon logs.
|
||||
|
||||
<a name="troubleshoot"></a>
|
||||
## Troubleshooting
|
||||
|
||||
### Volume mounting requires file sharing for any project directories outside of `$HOME`
|
||||
|
||||
If you are using mounted volumes and get runtime errors indicating an
|
||||
application file is not found, access to a volume mount is denied, or a service
|
||||
cannot start, such as when using [Docker Compose](../../compose/gettingstarted.md),
|
||||
you might need to enable [file sharing](../settings/linux.md#file-sharing).
|
||||
|
||||
Volume mounting requires shared drives for projects that live outside of the
|
||||
`/home/<user>` directory. Go to {: .inline} >
|
||||
**Settings** > **Resources** > **File sharing** and share the drive that contains the Dockerfile and volume.
|
||||
|
||||
### Workarounds for common problems
|
||||
|
||||
* If `docker` commands aren't working properly or as expected, you may need to
|
||||
unset some environment variables, to make sure you are not using the deprecated Docker Machine environment in your shell or command window. Unset the
|
||||
`DOCKER_HOST` environment variable and related variables. If you use bash, use the following command: `unset ${!DOCKER_*}`
|
||||
|
||||
* For the `hello-world-nginx` example, Docker Desktop must be running to get to
|
||||
the web server on `http://localhost/`. Make sure that the Docker icon is
|
||||
displayed on the menu bar, and that you run the Docker commands in a shell that is connected to the Docker Desktop Engine.
|
||||
Otherwise, you might start the webserver container but get a "web page not
|
||||
available" error when you go to `localhost`.
|
||||
|
||||
* If you see errors like `Bind for 0.0.0.0:8080 failed: port is already
|
||||
allocated` or `listen tcp:0.0.0.0:8080: bind: address is already in use`:
|
||||
|
||||
|
||||
* Run `lsof -i tcp:8080` to discover the name and pid of the other process and
|
||||
decide whether to shut the other process down, or to use a different port in
|
||||
your docker app.
|
||||
|
||||
|
|
@ -1,345 +0,0 @@
|
|||
---
|
||||
description: Troubleshooting, logs, and known issues
|
||||
keywords: mac, troubleshooting, logs, issues
|
||||
redirect_from:
|
||||
- /docker-for-mac/troubleshoot/
|
||||
- /mackit/troubleshoot/
|
||||
title: Logs and troubleshooting
|
||||
---
|
||||
|
||||
{% include upgrade-cta.html
|
||||
body="Did you know that Docker Desktop offers support for developers on a paid Docker subscription (Pro, Team, or Business)? Upgrade now to benefit from Docker Support. Click [here](../../support/index.md) to learn more."
|
||||
target-url="https://www.docker.com/pricing?utm_source=docker&utm_medium=webreferral&utm_campaign=docs_driven_upgrade_desktop_support"
|
||||
%}
|
||||
|
||||
This page contains information on how to diagnose and troubleshoot Docker Desktop issues, request Docker Desktop support, send logs and communicate with the Docker Desktop team, use our forums and Success Center, browse and log issues on GitHub, and find workarounds for known problems.
|
||||
|
||||
## Troubleshoot
|
||||
|
||||
Choose {: .inline} > **Troubleshoot**
|
||||
from the menu bar to see the troubleshoot options.
|
||||
|
||||
{:width="600px"}
|
||||
|
||||
The Troubleshoot page contains the following options:
|
||||
|
||||
* **Restart Docker Desktop**: Select to restart Docker Desktop.
|
||||
|
||||
* **Support**: Users with a paid Docker subscription can use this option to send a support request. Other users can use this option to diagnose any issues in Docker Desktop. For more information, see [Diagnose and feedback](#diagnose-and-feedback) and [Support](../../support/index.md).
|
||||
|
||||
* **Reset Kubernetes cluster**: Select this option to delete all stacks and Kubernetes resources. For more information, see [Kubernetes](../settings/mac.md#kubernetes).
|
||||
|
||||
* **Clean / Purge data**: This option resets all Docker data _without_ a
|
||||
reset to factory defaults. Selecting this option results in the loss of existing settings.
|
||||
|
||||
* **Reset to factory defaults**: Choose this option to reset all options on
|
||||
Docker Desktop to their initial state, the same as when Docker Desktop was first installed.
|
||||
|
||||
* **Uninstall**: Choose this option to remove Docker Desktop from your
|
||||
system.
|
||||
|
||||
> Uninstall Docker Desktop from the command line
|
||||
>
|
||||
> To uninstall Docker Desktop from a terminal, run: `<DockerforMacPath>
|
||||
> --uninstall`. If your instance is installed in the default location, this
|
||||
> command provides a clean uninstall:
|
||||
>
|
||||
> ```console
|
||||
> $ /Applications/Docker.app/Contents/MacOS/Docker --uninstall
|
||||
> Docker is running, exiting...
|
||||
> Docker uninstalled successfully. You can move the Docker application to the trash.
|
||||
> ```
|
||||
>
|
||||
> You might want to use the command-line uninstall if, for example, you find that
|
||||
> the app is non-functional, and you cannot uninstall it from the menu.
|
||||
|
||||
## Diagnose and feedback
|
||||
|
||||
### In-app diagnostics
|
||||
|
||||
If you encounter problems for which you do not find solutions in this
|
||||
documentation, on [Docker Desktop issues on
|
||||
GitHub](https://github.com/docker/for-mac/issues), or the [Docker Desktop forum](https://forums.docker.com/c/docker-for-mac), we can help you troubleshoot
|
||||
the log data. Before reporting an issue, we recommend that you read the information provided on this page to fix some common known issues.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Docker Desktop offers support for users with a paid Docker subscription. If you are experiencing any issues with Docker Desktop, follow the instructions in this section to send a support request to Docker Support.
|
||||
|
||||
Before you get started, we recommend that you sign into your Docker Desktop application and your [Docker Hub](https://hub.docker.com/){:target="_blank" rel="noopener" class="_"} account.
|
||||
|
||||
1. Choose {: .inline} > **Troubleshoot**.
|
||||
2. Optional: Sign into Docker Desktop. In addition, ensure you are signed into your [Docker account](https://hub.docker.com/){:target="_blank" rel="noopener" class="_"}.
|
||||
3. Click **Get support**. This opens the in-app **Support** page and starts collecting the diagnostics.
|
||||
{:width="600px"}
|
||||
4. When the diagnostics collection process is complete, click **Upload to get a Diagnostic ID**.
|
||||
5. When the diagnostics have been uploaded, Docker Desktop prints a diagnostic ID. Copy this ID.
|
||||
6. If you have a paid Docker subscription, click **Contact Support**. This opens the [Docker Desktop support](https://hub.docker.com/support/desktop/){:target="_blank" rel="noopener" class="_"} form. Fill in the information required and add the ID you copied earlier to the Diagnostics ID field. Click **Submit** to request Docker Desktop support.
|
||||
> **Note**
|
||||
>
|
||||
> You must be signed in to Docker Desktop using your Pro, Team, or Business tier credentials to access the support form. For information on what's covered as part of Docker Desktop support, see [Support](../../support/index.md).
|
||||
7. If you don't have a paid Docker subscription, you can click **Upgrade to benefit from Docker Support** to upgrade your existing account.
|
||||
Alternatively, click **Report a Bug** to open a new Docker Desktop issue on GitHub. This opens Docker Desktop [for Mac](https://github.com/docker/for-mac/issues/) on GitHub in your web browser in a 'New issue' template. Complete the information required and ensure you add the diagnostic ID you copied earlier. Click **submit new issue** to create a new issue.
|
||||
|
||||
### Diagnosing from the terminal
|
||||
|
||||
In some cases, it is useful to run the diagnostics yourself, for instance, if
|
||||
Docker Desktop cannot start.
|
||||
|
||||
First, locate the `com.docker.diagnose` tool. If you have installed Docker Desktop in the Applications directory, then it is located at
|
||||
`/Applications/Docker.app/Contents/MacOS/com.docker.diagnose`.
|
||||
|
||||
To create *and upload* diagnostics, run:
|
||||
|
||||
```console
|
||||
$ /Applications/Docker.app/Contents/MacOS/com.docker.diagnose gather -upload
|
||||
```
|
||||
|
||||
After the diagnostics have finished, you should have the following output,
|
||||
containing your diagnostics ID:
|
||||
|
||||
```sh
|
||||
Diagnostics Bundle: /tmp/B8CF8400-47B3-4068-ADA4-3BBDCE3985D9/20190726143610.zip
|
||||
Diagnostics ID: B8CF8400-47B3-4068-ADA4-3BBDCE3985D9/20190726143610 (uploaded)
|
||||
Diagnostics Bundle: /tmp/BE9AFAAF-F68B-41D0-9D12-84760E6B8740/20190905152051.zip
|
||||
Diagnostics ID: BE9AFAAF-F68B-41D0-9D12-84760E6B8740/20190905152051 (uploaded)
|
||||
```
|
||||
|
||||
The diagnostics ID (here BE9AFAAF-F68B-41D0-9D12-84760E6B8740/20190905152051) is
|
||||
composed of your user ID (BE9AFAAF-F68B-41D0-9D12-84760E6B8740) and a timestamp
|
||||
(20190905152051). Ensure you provide the full diagnostics ID, and not just the user ID.
|
||||
|
||||
To view the contents of the diagnostic file, run:
|
||||
|
||||
```console
|
||||
$ open /tmp/BE9AFAAF-F68B-41D0-9D12-84760E6B8740/20190905152051.zip
|
||||
```
|
||||
|
||||
If you have a paid Docker subscription, open the [Docker Desktop support](https://hub.docker.com/support/desktop/){:target="_blank" rel="noopener" class="_"} form. Fill in the information required and add the ID to the Diagnostics ID field. Click **Submit** to request Docker Desktop support.
|
||||
|
||||
### Self-diagnose tool
|
||||
|
||||
Docker Desktop contains a self-diagnose tool which helps you to identify some common problems. Before you run the self-diagnose tool, locate `com.docker.diagnose`. If you have installed Docker Desktop
|
||||
in the Applications directory, then the self-diagnose tool will be located at
|
||||
`/Applications/Docker.app/Contents/MacOS/com.docker.diagnose`.
|
||||
|
||||
To run the self-diagnose tool, run:
|
||||
|
||||
```console
|
||||
$ /Applications/Docker.app/Contents/MacOS/com.docker.diagnose check
|
||||
```
|
||||
|
||||
The tool runs a suite of checks and displays **PASS** or **FAIL** next to each check. If there are any failures, it highlights the most relevant at the end of the report.
|
||||
|
||||
> **Feedback**
|
||||
>
|
||||
> Let us know your feedback on the self-diagnose tool by creating an issue in the [for-mac](https://github.com/docker/for-mac/issues) GitHub repository.
|
||||
|
||||
<a name="logs"></a>
|
||||
|
||||
## Check the logs
|
||||
|
||||
In addition to using the diagnose and feedback option to submit logs, you can
|
||||
browse the logs yourself.
|
||||
|
||||
#### In a terminal
|
||||
|
||||
To watch the live flow of Docker Desktop logs in the command line, run the following script from your favorite shell.
|
||||
|
||||
```console
|
||||
$ pred='process matches ".*(ocker|vpnkit).*" || (process in {"taskgated-helper", "launchservicesd", "kernel"} && eventMessage contains[c] "docker")'
|
||||
$ /usr/bin/log stream --style syslog --level=debug --color=always --predicate "$pred"
|
||||
```
|
||||
|
||||
Alternatively, to collect the last day of logs (`1d`) in a file, run:
|
||||
|
||||
```console
|
||||
$ /usr/bin/log show --debug --info --style syslog --last 1d --predicate "$pred" >/tmp/logs.txt
|
||||
```
|
||||
|
||||
#### In the Console app
|
||||
|
||||
Macs provide a built-in log viewer, named "Console", which you can use to check
|
||||
Docker logs.
|
||||
|
||||
The Console lives in `/Applications/Utilities`; you can search for it with
|
||||
Spotlight Search.
|
||||
|
||||
To read the Docker app log messages, type `docker` in the Console window search bar and press Enter. Then select `ANY` to expand the drop-down list next to your `docker` search entry, and select `Process`.
|
||||
|
||||
|
||||
|
||||
You can use the Console Log Query to search logs, filter the results in various
|
||||
ways, and create reports.
|
||||
|
||||
#### View the Docker Daemon logs
|
||||
|
||||
Refer to the [read the logs](../../config/daemon/index.md#read-the-logs) section
|
||||
to learn how to view the Docker Daemon logs.
|
||||
|
||||
<a name="troubleshoot"></a>
|
||||
## Troubleshooting
|
||||
|
||||
### Make sure certificates are set up correctly
|
||||
|
||||
Docker Desktop ignores certificates listed under insecure registries, and does
|
||||
not send client certificates to them. Commands like `docker run` that attempt to
|
||||
pull from the registry produces error messages on the command line, for example:
|
||||
|
||||
```
|
||||
Error response from daemon: Get http://192.168.203.139:5858/v2/: malformed HTTP response "\x15\x03\x01\x00\x02\x02"
|
||||
```
|
||||
|
||||
As well as on the registry. For example:
|
||||
|
||||
```
|
||||
2019/06/20 18:15:30 http: TLS handshake error from 192.168.203.139:52882: tls: client didn't provide a certificate
|
||||
2019/06/20 18:15:30 http: TLS handshake error from 192.168.203.139:52883: tls: first record does not look like a TLS handshake
|
||||
```
|
||||
|
||||
For more about using client and server side certificates, see
|
||||
[Adding TLS certificates](index.md#add-tls-certificates) in the Getting Started topic.
|
||||
|
||||
### Volume mounting requires file sharing for any project directories outside of `/Users`
|
||||
|
||||
If you are using mounted volumes and get runtime errors indicating an
|
||||
application file is not found, access to a volume mount is denied, or a service
|
||||
cannot start, such as when using [Docker Compose](../../compose/gettingstarted.md),
|
||||
you might need to enable [file sharing](../settings/mac.md#file-sharing).
|
||||
|
||||
Volume mounting requires shared drives for projects that live outside of the
|
||||
`/Users` directory. Go to {: .inline} >
|
||||
**Preferences** > **Resources** > **File sharing** and share the drive that contains the Dockerfile and volume.
|
||||
|
||||
### Incompatible CPU detected
|
||||
|
||||
Docker Desktop requires a processor (CPU) that supports virtualization and, more
|
||||
specifically, the [Apple Hypervisor
|
||||
framework](https://developer.apple.com/library/mac/documentation/DriversKernelHardware/Reference/Hypervisor/).
|
||||
Docker Desktop is only compatible with Mac systems that have a CPU that supports the Hypervisor framework. Most Macs built in 2010 and later support it,as described in the Apple Hypervisor Framework documentation about supported hardware:
|
||||
|
||||
*Generally, machines with an Intel VT-x feature set that includes Extended Page
|
||||
Tables (EPT) and Unrestricted Mode are supported.*
|
||||
|
||||
To check if your Mac supports the Hypervisor framework, run the following command in a terminal window.
|
||||
|
||||
```console
|
||||
$ sysctl kern.hv_support
|
||||
```
|
||||
|
||||
If your Mac supports the Hypervisor Framework, the command prints
|
||||
`kern.hv_support: 1`.
|
||||
|
||||
If not, the command prints `kern.hv_support: 0`.
|
||||
|
||||
See also, [Hypervisor Framework
|
||||
Reference](https://developer.apple.com/library/mac/documentation/DriversKernelHardware/Reference/Hypervisor/)
|
||||
in the Apple documentation, and Docker Desktop [Mac system requirements](../install/mac-install.md#system-requirements).
|
||||
|
||||
### Workarounds for common problems
|
||||
|
||||
* If Docker Desktop fails to install or start properly on Mac:
|
||||
|
||||
* Make sure you quit Docker Desktop before installing a new version of the
|
||||
application ({: .inline} > **Quit Docker Desktop**). Otherwise, you get an "application in use" error when you try to
|
||||
copy the new app from the `.dmg` to `/Applications`.
|
||||
|
||||
* Restart your Mac to stop / discard any vestige of the daemon running from
|
||||
the previously installed version.
|
||||
|
||||
* Run the uninstall commands from the menu.
|
||||
|
||||
* If `docker` commands aren't working properly or as expected, you may need to
|
||||
unset some environment variables, to make sure you are not using the deprecated Docker Machine environment in your shell or command window. Unset the
|
||||
`DOCKER_HOST` environment variable and related variables. If you use bash, use the following command: `unset ${!DOCKER_*}`
|
||||
|
||||
* For the `hello-world-nginx` example, Docker Desktop must be running to get to
|
||||
the web server on `http://localhost/`. Make sure that the Docker icon is
|
||||
displayed on the menu bar, and that you run the Docker commands in a shell that is connected to the Docker Desktop Engine.
|
||||
Otherwise, you might start the webserver container but get a "web page not
|
||||
available" error when you go to `localhost`.
|
||||
|
||||
* If you see errors like `Bind for 0.0.0.0:8080 failed: port is already
|
||||
allocated` or `listen tcp:0.0.0.0:8080: bind: address is already in use`:
|
||||
|
||||
* These errors are often caused by some other software on the Mac using those
|
||||
ports.
|
||||
|
||||
* Run `lsof -i tcp:8080` to discover the name and pid of the other process and
|
||||
decide whether to shut the other process down, or to use a different port in
|
||||
your docker app.
|
||||
|
||||
## Known issues
|
||||
|
||||
* The following issues are seen when using the `virtualization.framework` experimental feature:
|
||||
|
||||
* Some VPN clients can prevent the VM running Docker from communicating with the host, preventing Docker Desktop starting correctly. See [docker/for-mac#5208](https://github.com/docker/for-mac/issues/5208).
|
||||
|
||||
This is an interaction between `vmnet.framework` (as used by `virtualization.framework`) and the VPN clients.
|
||||
|
||||
* Some container disk I/O is much slower than expected. See [docker/for-mac#5389](https://github.com/docker/for-mac/issues/5389). Disk flushes are particularly slow due to the need to guarantee data is written to stable storage on the host. We have also observed specific performance problems when using the `virtualization.framework` on Intel chips on MacOS Monterey.
|
||||
|
||||
This is an artifact of the new `virtualization.framework`.
|
||||
|
||||
* The Linux Kernel may occasionally crash. Docker now detects this problem and pops up an error dialog offering the user the ability to quickly restart Linux.
|
||||
|
||||
We are still gathering data and testing alternate kernel versions.
|
||||
|
||||
* IPv6 is not (yet) supported on Docker Desktop.
|
||||
|
||||
* On Apple silicon in native `arm64` containers, older versions of `libssl` such as `debian:buster`, `ubuntu:20.04`, and `centos:8` will segfault when connected to some TLS servers, for example, `curl https://dl.yarnpkg.com`. The bug is fixed in newer versions of `libssl` in `debian:bullseye`, `ubuntu:21.04`, and `fedora:35`.
|
||||
|
||||
* You might encounter errors when using `docker-compose up` with Docker Desktop
|
||||
(`ValueError: Extra Data`). We've identified this is likely related to data
|
||||
and/or events being passed all at once rather than one by one, so sometimes
|
||||
the data comes back as 2+ objects concatenated and causes an error.
|
||||
|
||||
* Force-ejecting the `.dmg` after running `Docker.app` from it can cause the
|
||||
whale icon to become unresponsive, Docker tasks to show as not responding in
|
||||
the Activity Monitor, and for some processes to consume a large amount of CPU
|
||||
resources. Reboot and restart Docker to resolve these issues.
|
||||
|
||||
* Docker does not auto-start on login even when it is enabled in
|
||||
{: .inline} > **Preferences**. This is related to a
|
||||
set of issues with Docker helper, registration, and versioning.
|
||||
|
||||
* Docker Desktop uses the `HyperKit` hypervisor
|
||||
(https://github.com/docker/hyperkit) in macOS 10.10 Yosemite and higher. If
|
||||
you are developing with tools that have conflicts with `HyperKit`, such as
|
||||
[Intel Hardware Accelerated Execution Manager
|
||||
(HAXM)](https://software.intel.com/en-us/android/articles/intel-hardware-accelerated-execution-manager/),
|
||||
the current workaround is not to run them at the same time. You can pause
|
||||
`HyperKit` by quitting Docker Desktop temporarily while you work with HAXM.
|
||||
This allows you to continue work with the other tools and prevent `HyperKit`
|
||||
from interfering.
|
||||
|
||||
* If you are working with applications like [Apache
|
||||
Maven](https://maven.apache.org/) that expect settings for `DOCKER_HOST` and
|
||||
`DOCKER_CERT_PATH` environment variables, specify these to connect to Docker
|
||||
instances through Unix sockets. For example:
|
||||
|
||||
```console
|
||||
$ export DOCKER_HOST=unix:///var/run/docker.sock
|
||||
```
|
||||
|
||||
* <a name="bind-mounted-dirs"></a> There are a number of issues with the performance of directories bind-mounted
|
||||
into containers. In particular, writes of small blocks, and traversals of large
|
||||
directories are currently slow. Additionally, containers that perform large
|
||||
numbers of directory operations, such as repeated scans of large directory
|
||||
trees, may suffer from poor performance. Applications that behave in this way
|
||||
include:
|
||||
|
||||
- `rake`
|
||||
- `ember build`
|
||||
- Symfony
|
||||
- Magento
|
||||
- Zend Framework
|
||||
- PHP applications that use [Composer](https://getcomposer.org) to install
|
||||
dependencies in a `vendor` folder
|
||||
|
||||
As a workaround for this behavior, you can put vendor or third-party library
|
||||
directories in Docker volumes, perform temporary file system operations
|
||||
outside of bind mounts, and use third-party tools like Unison or `rsync` to
|
||||
synchronize between container directories and bind-mounted directories. We are
|
||||
actively working on performance improvements using a number of different
|
||||
techniques. To learn more, see the [topic on our roadmap](https://github.com/docker/roadmap/issues/7){: target="_blank" rel="noopener" class="_" }.
|
||||
|
|
@ -2026,7 +2026,7 @@ issue is being investigated. The workaround is to restart Docker.app.
|
|||
traversals of large directories are currently slow. Additionally, containers
|
||||
that perform large numbers of directory operations, such as repeated scans of
|
||||
large directory trees, may suffer from poor performance. More information is
|
||||
available in [Known Issues](../mac/troubleshoot.md#known-issues) in Troubleshooting.
|
||||
available in [Known Issues](../troubleshoot/known-issues.md) in Troubleshooting.
|
||||
|
||||
* Under some unhandled error conditions, `inotify` event delivery can fail and become permanently disabled. The workaround is to restart `Docker.app`.
|
||||
|
||||
|
|
@ -2056,7 +2056,7 @@ with `osxfs`. In particular, writes of small blocks and traversals of large
|
|||
directories are currently slow. Additionally, containers that perform large
|
||||
numbers of directory operations, such as repeated scans of large directory
|
||||
trees, may suffer from poor performance. More information is available in
|
||||
[Known Issues](../mac/troubleshoot.md#known-issues) in Troubleshooting.
|
||||
[Known Issues](../troubleshoot/known-issues.md) in Troubleshooting.
|
||||
|
||||
* Under some unhandled error conditions, `inotify` event delivery can fail and become permanently disabled. The workaround is to restart Docker.app.
|
||||
|
||||
|
|
@ -2090,7 +2090,7 @@ trees, may suffer from poor performance. More information is available in
|
|||
* There are a number of issues with the performance of directories bind-mounted with `osxfs`. In particular, writes of small blocks and traversals of large
|
||||
directories are currently slow. Additionally, containers that perform large
|
||||
numbers of directory operations, such as repeated scans of large directory
|
||||
trees, may suffer from poor performance. For more information and workarounds, see the bullet on performance of bind-mounted directories in [Known Issues](../mac/troubleshoot.md#known-issues) in Troubleshooting.
|
||||
trees, may suffer from poor performance. For more information and workarounds, see the bullet on performance of bind-mounted directories in [Known Issues](../troubleshoot/known-issues.md) in Troubleshooting.
|
||||
|
||||
* Under some unhandled error conditions, `inotify` event delivery can fail and become permanently disabled. The workaround is to restart `Docker.app`.
|
||||
|
||||
|
|
@ -2116,7 +2116,7 @@ trees, may suffer from poor performance. For more information and workarounds, s
|
|||
|
||||
* Docker.app sometimes uses 200% CPU after macOS wakes up from sleep mode. The issue is being investigated. The workaround is to restart Docker.app
|
||||
|
||||
* There are a number of issues with the performance of directories bind-mounted with `osxfs`. In particular, writes of small blocks and traversals of large directories are currently slow. Additionally, containers that perform large numbers of directory operations, such as repeated scans of large directory trees, may suffer from poor performance. For more information and workarounds, see the bullet on performance of bind-mounted directories in [Known Issues](../mac/troubleshoot.md#known-issues) in Troubleshooting.
|
||||
* There are a number of issues with the performance of directories bind-mounted with `osxfs`. In particular, writes of small blocks and traversals of large directories are currently slow. Additionally, containers that perform large numbers of directory operations, such as repeated scans of large directory trees, may suffer from poor performance. For more information and workarounds, see the bullet on performance of bind-mounted directories in [Known Issues](../troubleshoot/known-issues.md) in Troubleshooting.
|
||||
|
||||
* Under some unhandled error conditions, `inotify` event delivery can fail and become permanently disabled. The workaround is to restart Docker.app
|
||||
|
||||
|
|
@ -2139,7 +2139,7 @@ trees, may suffer from poor performance. For more information and workarounds, s
|
|||
|
||||
* Docker.app sometimes uses 200% CPU after macOS wakes up from sleep mode. The issue is being investigated. The workaround is to restart Docker.app
|
||||
|
||||
* There are a number of issues with the performance of directories bind-mounted with `osxfs`. In particular, writes of small blocks and traversals of large directories are currently slow. Additionally, containers that perform large numbers of directory operations, such as repeated scans of large directory trees, may suffer from poor performance. More information is available in [Known Issues](../mac/troubleshoot.md#known-issues) in [Troubleshooting](../mac/troubleshoot.md)
|
||||
* There are a number of issues with the performance of directories bind-mounted with `osxfs`. In particular, writes of small blocks and traversals of large directories are currently slow. Additionally, containers that perform large numbers of directory operations, such as repeated scans of large directory trees, may suffer from poor performance. More information is available in [Known Issues](../troubleshoot/known-issues.md).
|
||||
|
||||
* Under some unhandled error conditions, `inotify` event delivery can fail and become permanently disabled. The workaround is to restart Docker.app
|
||||
|
||||
|
|
@ -2186,7 +2186,7 @@ events or unexpected unmounts.
|
|||
|
||||
* Docker.app sometimes uses 200% CPU after macOS wakes up from sleep mode. The issue is being investigated. The workaround is to restart Docker.app
|
||||
|
||||
* There are a number of issues with the performance of directories bind-mounted with `osxfs`. In particular, writes of small blocks, and traversals of large directories are currently slow. Additionally, containers that perform large numbers of directory operations, such as repeated scans of large directory trees, may suffer from poor performance. For more information and workarounds, see [Known Issues](../mac/troubleshoot.md#known-issues) in [Logs and Troubleshooting](../mac/troubleshoot.md).
|
||||
* There are a number of issues with the performance of directories bind-mounted with `osxfs`. In particular, writes of small blocks, and traversals of large directories are currently slow. Additionally, containers that perform large numbers of directory operations, such as repeated scans of large directory trees, may suffer from poor performance. For more information and workarounds, see [Known Issues](../troubleshoot/known-issues.md) in [Logs and Troubleshooting](../troubleshoot/overview.md).
|
||||
|
||||
* Under some unhandled error conditions, `inotify` event delivery can fail and become permanently disabled. The workaround is to restart Docker.app
|
||||
|
||||
|
|
@ -2230,7 +2230,7 @@ events or unexpected unmounts.
|
|||
|
||||
**Known issues**
|
||||
|
||||
* See [Known Issues](../mac/troubleshoot.md#known-issues) in [Troubleshooting](../mac/troubleshoot.md)
|
||||
* See [Known Issues](../troubleshoot/known-issues.md).
|
||||
|
||||
### Beta 18.1 Release Notes (2016-07-07 1.12.0-rc3-beta18.1)
|
||||
|
||||
|
|
@ -2256,7 +2256,7 @@ events or unexpected unmounts.
|
|||
|
||||
**Known issues**
|
||||
|
||||
* See [Known Issues](../mac/troubleshoot.md#known-issues) in [Troubleshooting](../mac/troubleshoot.md)
|
||||
* See [Known Issues](../troubleshoot/known-issues.md).
|
||||
|
||||
### Beta 18 Release Notes (2016-07-06 1.12.0-rc3-beta18)
|
||||
|
||||
|
|
@ -2277,7 +2277,7 @@ events or unexpected unmounts.
|
|||
|
||||
**Known issues**
|
||||
|
||||
* See [Known Issues](../mac/troubleshoot.md#known-issues) in [Troubleshooting](../mac/troubleshoot.md)
|
||||
* See [Known Issues](../troubleshoot/known-issues.md).
|
||||
|
||||
### Beta 17 Release Notes (2016-06-29 1.12.0-rc2-beta17)
|
||||
|
||||
|
|
@ -2296,7 +2296,7 @@ events or unexpected unmounts.
|
|||
|
||||
**Known issues**
|
||||
|
||||
* See [Known Issues](../mac/troubleshoot.md#known-issues) in [Troubleshooting](../mac/troubleshoot.md)
|
||||
* See [Known Issues](../troubleshoot/known-issues.md).
|
||||
|
||||
### Beta 16 Release Notes (2016-06-17 1.12.0-rc2-beta16)
|
||||
|
||||
|
|
@ -2318,7 +2318,7 @@ events or unexpected unmounts.
|
|||
|
||||
**Known issues**
|
||||
|
||||
* See [Known Issues](../mac/troubleshoot.md#known-issues) in [Troubleshooting](../mac/troubleshoot.md)
|
||||
* See [Known Issues](../troubleshoot/known-issues.md).
|
||||
|
||||
### Beta 15 Release Notes (2016-06-10 1.11.2-beta15)
|
||||
|
||||
|
|
@ -2342,7 +2342,7 @@ events or unexpected unmounts.
|
|||
|
||||
**Known issues**
|
||||
|
||||
* See [Known Issues](../mac/troubleshoot.md#known-issues) in [Troubleshooting](../mac/troubleshoot.md)
|
||||
* See [Known Issues](../troubleshoot/known-issues.md).
|
||||
|
||||
### Beta 14 Release Notes (2016-06-02 1.11.1-beta14)
|
||||
|
||||
|
|
|
|||
|
|
@ -2333,7 +2333,7 @@ work. Some insider builds may not work.
|
|||
**Known issues**
|
||||
|
||||
* Only UTF-8 passwords are supported for host filesystem sharing
|
||||
* Docker automatically disables lingering net adapters. The only way to remove them is manually using `devmgmt.msc` as documented in [Troubleshooting](../windows/troubleshoot.md#networking-issues).
|
||||
* Docker automatically disables lingering net adapters. The only way to remove them is manually using `devmgmt.msc` as documented in [Troubleshooting](../troubleshoot/topics.md#networking-issues).
|
||||
|
||||
### Beta 22 Release (2016-08-11 1.12.0-beta22)
|
||||
|
||||
|
|
@ -2341,7 +2341,7 @@ Unreleased. See Beta 23 for changes.
|
|||
|
||||
**Known issues**
|
||||
|
||||
* Docker automatically disables lingering net adapters. The only way to remove them is manually using `devmgmt.msc` as documented in [Troubleshooting](../windows/troubleshoot.md#networking-issues).
|
||||
* Docker automatically disables lingering net adapters. The only way to remove them is manually using `devmgmt.msc` as documented in [Troubleshooting](../troubleshoot/topics.md#networking-issues).
|
||||
|
||||
### Beta 21 Release (2016-07-28 1.12.0-beta21)
|
||||
|
||||
|
|
@ -2616,7 +2616,7 @@ This Beta release includes some significant changes:
|
|||
* The GUI now runs in non-elevated mode and connects to an elevated Windows service
|
||||
* Allocate virtual machine memory by 256 MB increments, instead of 1 GB
|
||||
* Show a meaningful error when the user has an empty password
|
||||
* Improved [Troubleshooting](../windows/troubleshoot.md) page
|
||||
* Improved [Troubleshooting](../troubleshoot/overview.md) page
|
||||
|
||||
**Upgrades**
|
||||
|
||||
|
|
@ -2640,7 +2640,7 @@ This Beta release includes some significant changes:
|
|||
|
||||
**Known issues**
|
||||
|
||||
* Due to limitation in the Windows NAT implementation, co-existence with other NAT prefixes needs to be carefully managed. See [Troubleshooting](../windows/troubleshoot.md) for more details.
|
||||
* Due to limitation in the Windows NAT implementation, co-existence with other NAT prefixes needs to be carefully managed. See [Troubleshooting](../troubleshoot/known-issues.md) for more details.
|
||||
|
||||
* Logs for the windows service are not aggregated with logs from the GUI. This is expected to be fixed in future versions.
|
||||
|
||||
|
|
@ -2668,7 +2668,7 @@ This Beta release includes some significant changes:
|
|||
|
||||
**Known issues**
|
||||
|
||||
* Due to limitation in the Windows NAT implementation, co-existence with other NAT prefixes needs to be carefully managed. See [Troubleshooting](../windows/troubleshoot.md) for more details.
|
||||
* Due to limitation in the Windows NAT implementation, co-existence with other NAT prefixes needs to be carefully managed. See [Troubleshooting](../troubleshoot/overview.md) for more details.
|
||||
|
||||
|
||||
### Beta 9 Release (2016-04-26 1.11.0-beta9)
|
||||
|
|
|
|||
|
|
@ -110,7 +110,7 @@ File share settings are:
|
|||
> once a file called `test` is created, attempts to create a second file called
|
||||
> `Test` will fail.
|
||||
>
|
||||
> For more information, see [Volume mounting requires file sharing for any project directories outside of `/Users`](../mac/troubleshoot.md#volume-mounting-requires-file-sharing-for-any-project-directories-outside-of-users).)
|
||||
> For more information, see [Volume mounting requires file sharing for any project directories outside of `/Users`](../troubleshoot/topics.md)
|
||||
|
||||
### Proxies
|
||||
|
||||
|
|
|
|||
|
|
@ -92,7 +92,7 @@ the host while running and testing the code in a container.
|
|||
Note that configuring file sharing is not necessary for Windows containers,
|
||||
only [Linux containers](../windows/index.md#switch-between-windows-and-linux-containers).
|
||||
If a directory is not shared with a Linux container you may get `file not found`
|
||||
or `cannot start service` errors at runtime. See [Volume mounting requires shared folders for Linux containers](../windows/troubleshoot.md#volume-mounting-requires-shared-folders-for-linux-containers).
|
||||
or `cannot start service` errors at runtime. See [Volume mounting requires shared folders for Linux containers](../troubleshoot/topics.md).
|
||||
|
||||
File share settings are:
|
||||
|
||||
|
|
@ -116,7 +116,7 @@ File share settings are:
|
|||
> (named volume) or [data container](../../storage/volumes.md).
|
||||
> * Docker Desktop sets permissions to read/write/execute for users, groups and
|
||||
> others [0777 or a+rwx](http://permissions-calculator.org/decode/0777/).
|
||||
> This is not configurable. See [Permissions errors on data directories for shared volumes](../windows/troubleshoot.md#permissions-errors-on-data-directories-for-shared-volumes).
|
||||
> This is not configurable. See [Permissions errors on data directories for shared volumes](../troubleshoot/topics.md).
|
||||
> * Windows presents a case-insensitive view of the filesystem to applications while Linux is case-sensitive.
|
||||
> On Linux, it is possible to create two separate files: `test` and `Test`,
|
||||
> while on Windows these filenames would actually refer to the same underlying
|
||||
|
|
|
|||
|
|
@ -0,0 +1,79 @@
|
|||
---
|
||||
description: Known issues for Mac
|
||||
keywords: mac, troubleshooting, known issues
|
||||
title: Known issues for Docker Desktop on Mac
|
||||
---
|
||||
## Known issues
|
||||
|
||||
* The following issues are seen when using the `virtualization.framework` experimental feature:
|
||||
|
||||
* Some VPN clients can prevent the VM running Docker from communicating with the host, preventing Docker Desktop starting correctly. See [docker/for-mac#5208](https://github.com/docker/for-mac/issues/5208).
|
||||
|
||||
This is an interaction between `vmnet.framework` (as used by `virtualization.framework`) and the VPN clients.
|
||||
|
||||
* Some container disk I/O is much slower than expected. See [docker/for-mac#5389](https://github.com/docker/for-mac/issues/5389). Disk flushes are particularly slow due to the need to guarantee data is written to stable storage on the host. We have also observed specific performance problems when using the `virtualization.framework` on Intel chips on MacOS Monterey.
|
||||
|
||||
This is an artifact of the new `virtualization.framework`.
|
||||
|
||||
* The Linux Kernel may occasionally crash. Docker now detects this problem and pops up an error dialog offering the user the ability to quickly restart Linux.
|
||||
|
||||
We are still gathering data and testing alternate kernel versions.
|
||||
|
||||
* IPv6 is not (yet) supported on Docker Desktop.
|
||||
|
||||
* On Apple silicon in native `arm64` containers, older versions of `libssl` such as `debian:buster`, `ubuntu:20.04`, and `centos:8` will segfault when connected to some TLS servers, for example, `curl https://dl.yarnpkg.com`. The bug is fixed in newer versions of `libssl` in `debian:bullseye`, `ubuntu:21.04`, and `fedora:35`.
|
||||
|
||||
* You might encounter errors when using `docker-compose up` with Docker Desktop
|
||||
(`ValueError: Extra Data`). We've identified this is likely related to data
|
||||
and/or events being passed all at once rather than one by one, so sometimes
|
||||
the data comes back as 2+ objects concatenated and causes an error.
|
||||
|
||||
* Force-ejecting the `.dmg` after running `Docker.app` from it can cause the
|
||||
whale icon to become unresponsive, Docker tasks to show as not responding in
|
||||
the Activity Monitor, and for some processes to consume a large amount of CPU
|
||||
resources. Reboot and restart Docker to resolve these issues.
|
||||
|
||||
* Docker does not auto-start on login even when it is enabled in **Preferences**. This is related to a
|
||||
set of issues with Docker helper, registration, and versioning.
|
||||
|
||||
* Docker Desktop uses the `HyperKit` hypervisor
|
||||
(https://github.com/docker/hyperkit) in macOS 10.10 Yosemite and higher. If
|
||||
you are developing with tools that have conflicts with `HyperKit`, such as
|
||||
[Intel Hardware Accelerated Execution Manager
|
||||
(HAXM)](https://software.intel.com/en-us/android/articles/intel-hardware-accelerated-execution-manager/),
|
||||
the current workaround is not to run them at the same time. You can pause
|
||||
`HyperKit` by quitting Docker Desktop temporarily while you work with HAXM.
|
||||
This allows you to continue work with the other tools and prevent `HyperKit`
|
||||
from interfering.
|
||||
|
||||
* If you are working with applications like [Apache
|
||||
Maven](https://maven.apache.org/) that expect settings for `DOCKER_HOST` and
|
||||
`DOCKER_CERT_PATH` environment variables, specify these to connect to Docker
|
||||
instances through Unix sockets. For example:
|
||||
|
||||
```console
|
||||
$ export DOCKER_HOST=unix:///var/run/docker.sock
|
||||
```
|
||||
|
||||
* <a name="bind-mounted-dirs"></a> There are a number of issues with the performance of directories bind-mounted
|
||||
into containers. In particular, writes of small blocks, and traversals of large
|
||||
directories are currently slow. Additionally, containers that perform large
|
||||
numbers of directory operations, such as repeated scans of large directory
|
||||
trees, may suffer from poor performance. Applications that behave in this way
|
||||
include:
|
||||
|
||||
- `rake`
|
||||
- `ember build`
|
||||
- Symfony
|
||||
- Magento
|
||||
- Zend Framework
|
||||
- PHP applications that use [Composer](https://getcomposer.org) to install
|
||||
dependencies in a `vendor` folder
|
||||
|
||||
As a workaround for this behavior, you can put vendor or third-party library
|
||||
directories in Docker volumes, perform temporary file system operations
|
||||
outside of bind mounts, and use third-party tools like Unison or `rsync` to
|
||||
synchronize between container directories and bind-mounted directories. We are
|
||||
actively working on performance improvements using a number of different
|
||||
techniques. To learn more, see the [topic on our roadmap](https://github.com/docker/roadmap/issues/7){: target="_blank" rel="noopener" class="_" }.
|
||||
|
||||
|
|
@ -0,0 +1,261 @@
|
|||
---
|
||||
description: Troubleshooting, logs, and known issues
|
||||
keywords: linux, mac, windows, troubleshooting, logs, issues
|
||||
title: Overview
|
||||
redirect_from:
|
||||
- /desktop/linux/troubleshoot/
|
||||
- /desktop/mac/troubleshoot/
|
||||
- /desktop/windows/troubleshoot/
|
||||
- /docker-for-mac/troubleshoot/
|
||||
- /mackit/troubleshoot/
|
||||
- /windows/troubleshoot/
|
||||
- /docker-for-win/troubleshoot/
|
||||
- /docker-for-windows/troubleshoot/
|
||||
---
|
||||
|
||||
{% include upgrade-cta.html
|
||||
body="Did you know that Docker Desktop offers support for developers on a paid Docker subscription (Pro, Team, or Business)? Upgrade now to benefit from Docker Support. Click [here](../../support/index.md) to learn more."
|
||||
target-url="https://www.docker.com/pricing?utm_source=docker&utm_medium=webreferral&utm_campaign=docs_driven_upgrade_desktop_support"
|
||||
%}
|
||||
|
||||
This page contains information on:
|
||||
- How to diagnose and troubleshoot Docker Desktop issues
|
||||
- Check the logs
|
||||
- Find workarounds for common problems
|
||||
|
||||
## Troubleshoot menu
|
||||
|
||||
To navigate to **Troubleshoot** either:
|
||||
|
||||
- Select the Docker menu {: .inline} and then **Troubleshoot**
|
||||
- Select the **Troubleshoot** icon from the Docker Dashboard
|
||||
|
||||
{:width="600px"}
|
||||
|
||||
The Troubleshoot page contains the following options:
|
||||
|
||||
- **Restart Docker Desktop**. Select to restart Docker Desktop.
|
||||
|
||||
- **Support**. Users with a paid Docker subscription can use this option to send a support request. Other users can use this option to diagnose any issues in Docker Desktop. For more information, see [Diagnose and feedback](#diagnose) and [Support](../../support/index.md).
|
||||
|
||||
- **Reset Kubernetes cluster**. Select to delete all stacks and Kubernetes resources. For more information, see [Kubernetes](../settings/linux.md#kubernetes).
|
||||
|
||||
- **Clean / Purge data**. This option resets all Docker data _without_ a
|
||||
reset to factory defaults. Selecting this option results in the loss of existing settings.
|
||||
|
||||
- **Reset to factory defaults**: Choose this option to reset all options on
|
||||
Docker Desktop to their initial state, the same as when Docker Desktop was first installed.
|
||||
|
||||
If you are a Mac user, you also have the option to **Uninstall** Docker Desktop from your system.
|
||||
|
||||
## Diagnose
|
||||
|
||||
### Diagnose from the app
|
||||
|
||||
Make sure you are signed in to Docker Desktop and your [Docker Hub](https://hub.docker.com/){:target="_blank" rel="noopener" class="_"} account.
|
||||
|
||||
1. From **Troubleshoot**, select **Get support**.
|
||||
This opens the in-app **Support** page and starts collecting the diagnostics.
|
||||
{:width="600px"}
|
||||
2. When the diagnostics collection process is complete, click **Upload to get a Diagnostic ID**.
|
||||
3. When the diagnostics have been uploaded, Docker Desktop prints a diagnostic ID. Copy this ID.
|
||||
4. If you have a paid Docker subscription, click **Contact Support**. This opens the [Docker Desktop support](https://hub.docker.com/support/desktop/){:target="_blank" rel="noopener" class="_"} form. Fill in the information required and add the ID you copied in step four to the **Diagnostics ID** field.
|
||||
5. Click **Submit** to request Docker Desktop support.
|
||||
> **Note**
|
||||
>
|
||||
> You must be signed in to Docker Desktop using your Pro, Team, or Business tier credentials to access the support form. For information on what's covered as part of Docker Desktop support, see [Support](../../support/index.md).
|
||||
6. If you don't have a paid Docker subscription, click **Upgrade to benefit from Docker Support** to upgrade your existing account.
|
||||
Alternatively, click **Report a Bug** to open a new Docker Desktop issue on GitHub. Complete the information required and ensure you add the diagnostic ID you copied earlier.
|
||||
7. Click **submit new issue** to create a new issue.
|
||||
|
||||
### Diagnose from the terminal
|
||||
|
||||
In some cases, it is useful to run the diagnostics yourself, for instance, if
|
||||
Docker Desktop cannot start.
|
||||
|
||||
First, locate the `com.docker.diagnose` tool. It is located at:
|
||||
|
||||
<ul class="nav nav-tabs">
|
||||
<li class="active"><a data-toggle="tab" data-target="#windows1">Windows</a></li>
|
||||
<li><a data-toggle="tab" data-target="#mac1">Mac</a></li>
|
||||
<li class="active"><a data-toggle="tab" data-target="#linux1">Linux</a></li>
|
||||
</ul>
|
||||
<div class="tab-content">
|
||||
<div id="windows1" class="tab-pane fade in active" markdown="1">
|
||||
|
||||
```console
|
||||
$ C:\Program Files\Docker\Docker\resources\com.docker.diagnose.exe
|
||||
```
|
||||
|
||||
</div>
|
||||
<div id="mac1" class="tab-pane fade" markdown="1">
|
||||
|
||||
```console
|
||||
$ /Applications/Docker.app/Contents/MacOS/com.docker.diagnose
|
||||
```
|
||||
|
||||
</div>
|
||||
<div id="linux1" class="tab-pane fade" markdown="1">
|
||||
|
||||
```console
|
||||
$ /opt/docker-desktop/bin/com.docker.diagnose
|
||||
```
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
To create and upload diagnostics, run:
|
||||
|
||||
```console
|
||||
$ <tool location> gather -upload
|
||||
```
|
||||
|
||||
After the diagnostics have finished, the terminal displays your diagnostics ID. The diagnostics ID is
|
||||
composed of your user ID and a timestamp. Ensure you provide the full diagnostics ID, and not just the user ID.
|
||||
|
||||
To view the contents of the diagnostic file, run:
|
||||
|
||||
<ul class="nav nav-tabs">
|
||||
<li><a data-toggle="tab" data-target="#mac2">Mac</a></li>
|
||||
<li class="active"><a data-toggle="tab" data-target="#linux2">Linux</a></li>
|
||||
</ul>
|
||||
<div class="tab-content">
|
||||
<div id="mac2" class="tab-pane fade" markdown="1">
|
||||
|
||||
```console
|
||||
$ open /tmp/BE9AFAAF-F68B-41D0-9D12-84760E6B8740/20190905152051.zip
|
||||
```
|
||||
|
||||
</div>
|
||||
<div id="linux2" class="tab-pane fade" markdown="1">
|
||||
|
||||
```console
|
||||
$ unzip –l /tmp/BE9AFAAF-F68B-41D0-9D12-84760E6B8740/20190905152051.zip
|
||||
```
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
If you have a paid Docker subscription, open the [Docker Desktop support](https://hub.docker.com/support/desktop/){:target="_blank" rel="noopener" class="_"} form. Fill in the information required and add the ID to the Diagnostics ID field. Click **Submit** to request Docker Desktop support.
|
||||
|
||||
### Self-diagnose tool
|
||||
|
||||
Docker Desktop contains a self-diagnose tool which helps you to identify some common problems.
|
||||
|
||||
First, locate the `com.docker.diagnose` tool. It is located at:
|
||||
|
||||
<ul class="nav nav-tabs">
|
||||
<li class="active"><a data-toggle="tab" data-target="#windows3">Windows</a></li>
|
||||
<li><a data-toggle="tab" data-target="#mac3">Mac</a></li>
|
||||
<li class="active"><a data-toggle="tab" data-target="#linux3">Linux</a></li>
|
||||
</ul>
|
||||
<div class="tab-content">
|
||||
<div id="windows3" class="tab-pane fade in active" markdown="1">
|
||||
|
||||
```console
|
||||
$ C:\Program Files\Docker\Docker\resources\com.docker.diagnose.exe
|
||||
```
|
||||
|
||||
</div>
|
||||
<div id="mac3" class="tab-pane fade" markdown="1">
|
||||
|
||||
```console
|
||||
$ /Applications/Docker.app/Contents/MacOS/com.docker.diagnose
|
||||
```
|
||||
|
||||
</div>
|
||||
<div id="linux3" class="tab-pane fade" markdown="1">
|
||||
|
||||
```console
|
||||
$ /opt/docker-desktop/bin/com.docker.diagnose
|
||||
```
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
To run the self-diagnose tool, run:
|
||||
|
||||
```console
|
||||
$ <tool location> check
|
||||
```
|
||||
|
||||
The tool runs a suite of checks and displays **PASS** or **FAIL** next to each check. If there are any failures, it highlights the most relevant at the end of the report.
|
||||
|
||||
You can then create and issue on GitHub:
|
||||
- [For Linux](https://github.com/docker/desktop-linux/issues)
|
||||
- [For Mac](https://github.com/docker/for-mac/issues)
|
||||
- [For Windows](https://github.com/docker/for-win/issues)
|
||||
|
||||
## Check the logs
|
||||
|
||||
In addition to using the diagnose option to submit logs, you can browse the logs yourself.
|
||||
|
||||
<ul class="nav nav-tabs">
|
||||
<li><a data-toggle="tab" data-target="#mac4">Mac</a></li>
|
||||
<li class="active"><a data-toggle="tab" data-target="#linux4">Linux</a></li>
|
||||
</ul>
|
||||
<div class="tab-content">
|
||||
<div id="mac4" class="tab-pane fade" markdown="1">
|
||||
|
||||
### In a terminal
|
||||
|
||||
To watch the live flow of Docker Desktop logs in the command line, run the following script from your favorite shell.
|
||||
|
||||
```console
|
||||
$ pred='process matches ".*(ocker|vpnkit).*" || (process in {"taskgated-helper", "launchservicesd", "kernel"} && eventMessage contains[c] "docker")'
|
||||
$ /usr/bin/log stream --style syslog --level=debug --color=always --predicate "$pred"
|
||||
```
|
||||
|
||||
Alternatively, to collect the last day of logs (`1d`) in a file, run:
|
||||
|
||||
```console
|
||||
$ /usr/bin/log show --debug --info --style syslog --last 1d --predicate "$pred" >/tmp/logs.txt
|
||||
```
|
||||
|
||||
### In the Console app
|
||||
|
||||
Mac provides a built-in log viewer, named "Console", which you can use to check
|
||||
Docker logs.
|
||||
|
||||
The Console lives in `/Applications/Utilities`. You can search for it with
|
||||
Spotlight Search.
|
||||
|
||||
To read the Docker app log messages, type `docker` in the Console window search bar and press Enter. Then select `ANY` to expand the drop-down list next to your `docker` search entry, and select `Process`.
|
||||
|
||||
|
||||
|
||||
You can use the Console Log Query to search logs, filter the results in various
|
||||
ways, and create reports.
|
||||
|
||||
### View the Docker Daemon logs
|
||||
|
||||
Refer to the [read the logs](../../config/daemon/index.md#read-the-logs) section
|
||||
to learn how to view the Docker Daemon logs.
|
||||
|
||||
</div>
|
||||
<div id="linux4" class="tab-pane fade" markdown="1">
|
||||
|
||||
### In a terminal
|
||||
|
||||
You can access Docker Desktop logs by running the following command:
|
||||
|
||||
```console
|
||||
$ journalctl --user --unit=docker-desktop
|
||||
```
|
||||
|
||||
You can also find the logs for the internal components included in Docker
|
||||
Desktop at `$HOME/.docker/desktop/log/`.
|
||||
|
||||
### View the Docker Daemon logs
|
||||
|
||||
Refer to the [read the logs](../../config/daemon/index.md#read-the-logs) section
|
||||
to learn how to view the Docker Daemon logs.
|
||||
|
||||
</div></div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,334 @@
|
|||
---
|
||||
description: Troubleshooting topics
|
||||
keywords: linux, mac, windows, troubleshooting, topics
|
||||
title: Troubleshoot topics
|
||||
toc_max: 3
|
||||
---
|
||||
|
||||
## Topics for all platforms
|
||||
|
||||
### Make sure certificates are set up correctly
|
||||
|
||||
Docker Desktop ignores certificates listed under insecure registries, and
|
||||
does not send client certificates to them. Commands like `docker run` that
|
||||
attempt to pull from the registry produces error messages on the command line,
|
||||
like this:
|
||||
|
||||
```console
|
||||
Error response from daemon: Get http://192.168.203.139:5858/v2/: malformed HTTP response "\x15\x03\x01\x00\x02\x02"
|
||||
```
|
||||
|
||||
As well as on the registry. For example:
|
||||
|
||||
```console
|
||||
2017/06/20 18:15:30 http: TLS handshake error from 192.168.203.139:52882: tls: client didn't provide a certificate
|
||||
2017/06/20 18:15:30 http: TLS handshake error from 192.168.203.139:52883: tls: first record does not look like a TLS handshake
|
||||
```
|
||||
|
||||
## Topics for Linux and Mac
|
||||
|
||||
### Volume mounting requires file sharing for any project directories outside of `$HOME`
|
||||
|
||||
If you are using mounted volumes and get runtime errors indicating an
|
||||
application file is not found, access to a volume mount is denied, or a service
|
||||
cannot start, such as when using [Docker Compose](../../compose/gettingstarted.md),
|
||||
you might need to enable [file sharing](../settings/linux.md#file-sharing).
|
||||
|
||||
Volume mounting requires shared drives for projects that live outside of the
|
||||
`/home/<user>` directory. From **Settings**, select **Resources** and then **File sharing**. Share the drive that contains the Dockerfile and volume.
|
||||
|
||||
## Topics for Mac
|
||||
|
||||
### Incompatible CPU detected
|
||||
|
||||
Docker Desktop requires a processor (CPU) that supports virtualization and, more
|
||||
specifically, the [Apple Hypervisor
|
||||
framework](https://developer.apple.com/library/mac/documentation/DriversKernelHardware/Reference/Hypervisor/).
|
||||
Docker Desktop is only compatible with Mac systems that have a CPU that supports the Hypervisor framework. Most Macs built in 2010 and later support it,as described in the Apple Hypervisor Framework documentation about supported hardware:
|
||||
|
||||
*Generally, machines with an Intel VT-x feature set that includes Extended Page
|
||||
Tables (EPT) and Unrestricted Mode are supported.*
|
||||
|
||||
To check if your Mac supports the Hypervisor framework, run the following command in a terminal window.
|
||||
|
||||
```console
|
||||
$ sysctl kern.hv_support
|
||||
```
|
||||
|
||||
If your Mac supports the Hypervisor Framework, the command prints
|
||||
`kern.hv_support: 1`.
|
||||
|
||||
If not, the command prints `kern.hv_support: 0`.
|
||||
|
||||
See also, [Hypervisor Framework
|
||||
Reference](https://developer.apple.com/library/mac/documentation/DriversKernelHardware/Reference/Hypervisor/)
|
||||
in the Apple documentation, and Docker Desktop [Mac system requirements](../install/mac-install.md#system-requirements).
|
||||
|
||||
## Topics for Windows
|
||||
|
||||
### Volumes
|
||||
|
||||
#### Permissions errors on data directories for shared volumes
|
||||
|
||||
When sharing files from Windows, Docker Desktop sets permissions on [shared volumes](../settings/windows.md#file-sharing)
|
||||
to a default value of [0777](http://permissions-calculator.org/decode/0777/)
|
||||
(`read`, `write`, `execute` permissions for `user` and for `group`).
|
||||
|
||||
The default permissions on shared volumes are not configurable. If you are
|
||||
working with applications that require permissions different from the shared
|
||||
volume defaults at container runtime, you need to either use non-host-mounted
|
||||
volumes or find a way to make the applications work with the default file
|
||||
permissions.
|
||||
|
||||
See also,
|
||||
[Can I change permissions on shared volumes for container-specific deployment requirements?](../faqs/windowsfaqs.md#can-i-change-permissions-on-shared-volumes-for-container-specific-deployment-requirements)
|
||||
in the FAQs.
|
||||
|
||||
#### Volume mounting requires shared folders for Linux containers
|
||||
|
||||
If you are using mounted volumes and get runtime errors indicating an
|
||||
application file is not found, access is denied to a volume mount, or a service
|
||||
cannot start, such as when using [Docker Compose](../../compose/gettingstarted.md),
|
||||
you might need to enable [shared folders](../settings/windows.md#file-sharing).
|
||||
|
||||
With the Hyper-V backend, mounting files from Windows requires shared folders for Linux containers. From **Settings**, select **Shared Folders** and share the folder that contains the
|
||||
Dockerfile and volume.
|
||||
|
||||
#### Support for symlinks
|
||||
|
||||
Symlinks work within and across containers. To learn more, see [How do symlinks work on Windows?](../faqs/windowsfaqs.md#how-do-symlinks-work-on-windows).
|
||||
|
||||
#### Avoid unexpected syntax errors, use Unix style line endings for files in containers
|
||||
|
||||
Any file destined to run inside a container must use Unix style `\n` line
|
||||
endings. This includes files referenced at the command line for builds and in
|
||||
RUN commands in Docker files.
|
||||
|
||||
Docker containers and `docker build` run in a Unix environment, so files in
|
||||
containers must use Unix style line endings: `\n`, _not_ Windows style: `\r\n`.
|
||||
Keep this in mind when authoring files such as shell scripts using Windows
|
||||
tools, where the default is likely to be Windows style line endings. These
|
||||
commands ultimately get passed to Unix commands inside a Unix based container
|
||||
(for example, a shell script passed to `/bin/sh`). If Windows style line endings
|
||||
are used, `docker run` fails with syntax errors.
|
||||
|
||||
For an example of this issue and the resolution, see this issue on GitHub:
|
||||
[Docker RUN fails to execute shell
|
||||
script](https://github.com/moby/moby/issues/24388).
|
||||
|
||||
#### Path conversion on Windows
|
||||
|
||||
On Linux, the system takes care of mounting a path to another path. For example, when you run the following command on Linux:
|
||||
|
||||
```console
|
||||
$ docker run --rm -ti -v /home/user/work:/work alpine
|
||||
```
|
||||
|
||||
It adds a `/work` directory to the target container to mirror the specified path.
|
||||
|
||||
However, on Windows, you must update the source path. For example, if you are using
|
||||
the legacy Windows shell (`cmd.exe`), you can use the following command:
|
||||
|
||||
```console
|
||||
$ docker run --rm -ti -v C:\Users\user\work:/work alpine
|
||||
```
|
||||
|
||||
This starts the container and ensures the volume becomes usable. This is possible because Docker Desktop detects
|
||||
the Windows-style path and provides the appropriate conversion to mount the directory.
|
||||
|
||||
Docker Desktop also allows you to use Unix-style path to the appropriate format. For example:
|
||||
|
||||
```console
|
||||
$ docker run --rm -ti -v /c/Users/user/work:/work alpine ls /work
|
||||
```
|
||||
|
||||
#### Working with Git Bash
|
||||
|
||||
Git Bash (or MSYS) provides a Unix-like environment on Windows. These tools apply their own
|
||||
preprocessing on the command line. For example, if you run the following command in Git Bash, it gives an error:
|
||||
|
||||
```console
|
||||
$ docker run --rm -ti -v C:\Users\user\work:/work alpine
|
||||
docker: Error response from daemon: mkdir C:UsersUserwork: Access is denied.
|
||||
```
|
||||
|
||||
This is because the `\` character has a special meaning in Git Bash. If you are using Git Bash, you must neutralize it using `\\`:
|
||||
|
||||
```console
|
||||
$ docker run --rm -ti -v C:\\Users\\user\\work:/work alpine
|
||||
```
|
||||
|
||||
Also, in scripts, the `pwd` command is used to avoid hardcoding file system locations. Its output is a Unix-style path.
|
||||
|
||||
```console
|
||||
$ pwd
|
||||
/c/Users/user/work
|
||||
```
|
||||
|
||||
Combined with the `$()` syntax, the command below works on Linux, however, it fails on Git Bash.
|
||||
|
||||
```console
|
||||
$ docker run --rm -ti -v $(pwd):/work alpine
|
||||
docker: Error response from daemon: OCI runtime create failed: invalid mount {Destination:\Program Files\Git\work Type:bind Source:/run/desktop/mnt/host/c/Users/user/work;C Options:[rbind rprivate]}: mount destination \Program Files\Git\work not absolute: unknown.
|
||||
```
|
||||
|
||||
You can work around this issue by using an extra `/`
|
||||
|
||||
```console
|
||||
$ docker run --rm -ti -v /$(pwd):/work alpine
|
||||
```
|
||||
|
||||
Portability of the scripts is not affected as Linux treats multiple `/` as a single entry.
|
||||
Each occurence of paths on a single line must be neutralized.
|
||||
|
||||
```console
|
||||
$ docker run --rm -ti -v /$(pwd):/work alpine ls /work
|
||||
ls: C:/Program Files/Git/work: No such file or directory
|
||||
```
|
||||
|
||||
In this example, The `$(pwd)` is not converted because of the preceding '/'. However, the second '/work' is transformed by the
|
||||
POSIX layer before passing it to Docker Desktop. You can also work around this issue by using an extra `/`.
|
||||
|
||||
```console
|
||||
$ docker run --rm -ti -v /$(pwd):/work alpine ls //work
|
||||
```
|
||||
|
||||
To verify whether the errors are generated from your script, or from another source, you can use an environment variable. For example:
|
||||
|
||||
```console
|
||||
$ MSYS_NO_PATHCONV=1 docker run --rm -ti -v $(pwd):/work alpine ls /work
|
||||
```
|
||||
|
||||
It only expects the environment variable here. The value doesn't matter.
|
||||
|
||||
In some cases, MSYS also transforms colons to semicolon. Similar conversions can also occur
|
||||
when using `~` because the POSIX layer translates it to a DOS path. `MSYS_NO_PATHCONV` also works in this case.
|
||||
|
||||
### Virtualization
|
||||
|
||||
Your machine must have the following features for Docker Desktop to function correctly.
|
||||
|
||||
#### WSL 2 and Windows Home
|
||||
|
||||
1. Virtual Machine Platform
|
||||
2. [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10){:target="_blank" rel="noopener" class="_"}
|
||||
3. [Virtualization enabled in the BIOS](https://bce.berkeley.edu/enabling-virtualization-in-your-pc-bios.html){:target="_blank" rel="noopener" class="_"}
|
||||
4. Hypervisor enabled at Windows startup
|
||||
|
||||
{:width="600px"}
|
||||
|
||||
#### Hyper-V
|
||||
|
||||
On Windows 10 Pro or Enterprise, you can also use Hyper-V with the following features enabled:
|
||||
|
||||
1. [Hyper-V](https://docs.microsoft.com/en-us/windows-server/virtualization/hyper-v/hyper-v-technology-overview){:target="_blank" rel="noopener" class="_"}
|
||||
installed and working
|
||||
2. [Virtualization enabled in the BIOS](https://bce.berkeley.edu/enabling-virtualization-in-your-pc-bios.html){:target="_blank" rel="noopener" class="_"}
|
||||
3. Hypervisor enabled at Windows startup
|
||||
|
||||
{:width="600px"}
|
||||
|
||||
Docker Desktop requires Hyper-V as well as the Hyper-V Module for Windows
|
||||
Powershell to be installed and enabled. The Docker Desktop installer enables
|
||||
it for you.
|
||||
|
||||
Docker Desktop also needs two CPU hardware features to use Hyper-V: Virtualization and Second Level Address Translation (SLAT), which is also called Rapid Virtualization Indexing (RVI). On some systems, Virtualization must be enabled in the BIOS. The steps required are vendor-specific, but typically the BIOS option is called `Virtualization Technology (VTx)` or something similar. Run the command `systeminfo` to check all required Hyper-V features. See [Pre-requisites for Hyper-V on Windows 10](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/reference/hyper-v-requirements) for more details.
|
||||
|
||||
To install Hyper-V manually, see [Install Hyper-V on Windows 10](https://msdn.microsoft.com/en-us/virtualization/hyperv_on_windows/quick_start/walkthrough_install). A reboot is *required* after installation. If you install Hyper-V without rebooting, Docker Desktop does not work correctly.
|
||||
|
||||
From the start menu, type **Turn Windows features on or off** and press enter.
|
||||
In the subsequent screen, verify that Hyper-V is enabled.
|
||||
|
||||
#### Virtualization must be enabled
|
||||
|
||||
In addition to [Hyper-V](#hyper-v) or [WSL 2](../windows/wsl.md), virtualization must be enabled. Check the
|
||||
Performance tab on the Task Manager:
|
||||
|
||||
{:width="700px"}
|
||||
|
||||
If you manually uninstall Hyper-V, WSL 2 or disable virtualization,
|
||||
Docker Desktop cannot start. See [Unable to run Docker for Windows on
|
||||
Windows 10 Enterprise](https://github.com/docker/for-win/issues/74).
|
||||
|
||||
#### Hypervisor enabled at Windows startup
|
||||
|
||||
If you have completed the steps described above and are still experiencing
|
||||
Docker Desktop startup issues, this could be because the Hypervisor is installed,
|
||||
but not launched during Windows startup. Some tools (such as older versions of
|
||||
Virtual Box) and video game installers disable hypervisor on boot. To reenable it:
|
||||
|
||||
1. Open an administrative console prompt.
|
||||
2. Run `bcdedit /set hypervisorlaunchtype auto`.
|
||||
3. Restart Windows.
|
||||
|
||||
You can also refer to the [Microsoft TechNet article](https://social.technet.microsoft.com/Forums/en-US/ee5b1d6b-09e2-49f3-a52c-820aafc316f9/hyperv-doesnt-work-after-upgrade-to-windows-10-1809?forum=win10itprovirt){:target="_blank" rel="noopener" class="_"} on Code flow guard (CFG) settings.
|
||||
|
||||
### Windows containers and Windows Server
|
||||
|
||||
Docker Desktop is not supported on Windows Server. If you have questions about how to run Windows containers on Windows 10, see
|
||||
[Switch between Windows and Linux containers](../faqs/windowsfaqs.md#how-do-i-switch-between-windows-and-linux-containers).
|
||||
|
||||
A full tutorial is available in [docker/labs](https://github.com/docker/labs) on
|
||||
[Getting Started with Windows Containers](https://github.com/docker/labs/blob/master/windows/windows-containers/README.md).
|
||||
|
||||
You can install a native Windows binary which allows you to develop and run
|
||||
Windows containers without Docker Desktop. However, if you install Docker this way, you cannot develop or run Linux containers. If you try to run a Linux container on the native Docker daemon, an error occurs:
|
||||
|
||||
```none
|
||||
C:\Program Files\Docker\docker.exe:
|
||||
image operating system "linux" cannot be used on this platform.
|
||||
See 'C:\Program Files\Docker\docker.exe run --help'.
|
||||
```
|
||||
|
||||
### Running Docker Desktop in nested virtualization scenarios
|
||||
|
||||
Docker Desktop can run inside a Hyper-V VM, see
|
||||
[Microsoft's nested virtualization user guide](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/user-guide/nested-virtualization) for more information.
|
||||
Docker Desktop can also run inside a Windows 10 VM running on apps like Parallels or VMware Fusion on a Mac provided that the VM is properly configured.
|
||||
|
||||
However, problems and intermittent failures may still occur due to the way these apps virtualize the hardware. For these reasons, _**Docker Desktop is not supported in nested virtualization scenarios**_. It might work
|
||||
in some cases, and not in others.
|
||||
|
||||
For best results, we recommend you run Docker Desktop natively on a Windows system (to work with Windows or Linux containers), or on Mac or Linux to work with Linux containers.
|
||||
|
||||
#### If you still want to use nested virtualization
|
||||
|
||||
* If using Hyper-V, make sure nested virtualization support is enabled for the
|
||||
Windows VM by running the following powershell as Administrator:
|
||||
|
||||
```none
|
||||
Set-VMProcessor -VMName <Windows VM Name> -ExposeVirtualizationExtensions $true
|
||||
```
|
||||
|
||||
* If using VMware or Parallels, make sure nested virtualization support is enabled.
|
||||
Check the settings in **Hardware > CPU & Memory > Advanced Options > Enable
|
||||
nested virtualization** (the exact menu sequence might vary slightly).
|
||||
|
||||
* Configure your Windows VM with at least 2 CPUs and sufficient memory to run your
|
||||
workloads.
|
||||
|
||||
* Make sure your system is more or less idle.
|
||||
|
||||
* Make sure your Windows OS is up-to-date. There have been several issues with
|
||||
some insider builds.
|
||||
|
||||
* The processor you have may also be relevant. For example, Westmere based Mac
|
||||
Pros have some additional hardware virtualization features over Nehalem based
|
||||
Mac Pros and so do newer generations of Intel processors. For Hyper-V, check
|
||||
[Microsoft's nested virtualization user guide](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/user-guide/nested-virtualization)
|
||||
to verify the host OS version is supported on your hardware.
|
||||
|
||||
#### Typical failures we see with nested virtualization
|
||||
|
||||
* Sometimes the VM fails to boot when Linux tries to calibrate the time stamp
|
||||
counter (TSC). This process is quite timing sensitive and may fail when
|
||||
executed inside a VM which itself runs inside a VM. CPU utilization is also
|
||||
likely to be higher.
|
||||
|
||||
* Ensure "PMU Virtualization" is turned off in Parallels on Macs. Check the
|
||||
settings in **Hardware > CPU & Memory > Advanced Settings > PMU
|
||||
Virtualization**.
|
||||
|
||||
### Networking issues
|
||||
|
||||
IPv6 is not (yet) supported on Docker Desktop.
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
---
|
||||
description: Common workarounds
|
||||
keywords: linux, mac, windows, troubleshooting, workarounds
|
||||
title: Workarounds for common problems
|
||||
---
|
||||
|
||||
### Reboot
|
||||
|
||||
Restart your PC to stop / discard any vestige of the daemon running from the
|
||||
previously installed version.
|
||||
|
||||
### Unset `DOCKER_HOST`
|
||||
|
||||
The `DOCKER_HOST` environmental variable does not need to be set. If you use
|
||||
bash, use the command `unset ${!DOCKER_*}` to unset it. For other shells,
|
||||
consult the shell's documentation.
|
||||
|
||||
### Make sure Docker is running for webserver examples
|
||||
|
||||
For the `hello-world-nginx` example and others, Docker Desktop must be
|
||||
running to get to the webserver on `http://localhost/`. Make sure that the
|
||||
Docker whale is showing in the menu bar, and that you run the Docker commands in
|
||||
a shell that is connected to the Docker Desktop Engine. Otherwise, you might start the webserver container but get a "web page
|
||||
not available" error when you go to `docker`.
|
||||
|
||||
### How to solve `port already allocated` errors
|
||||
|
||||
If you see errors like `Bind for 0.0.0.0:8080 failed: port is already allocated`
|
||||
or `listen tcp:0.0.0.0:8080: bind: address is already in use` ...
|
||||
|
||||
These errors are often caused by some other software on Windows using those
|
||||
ports. To discover the identity of this software, either use the `resmon.exe`
|
||||
GUI and click "Network" and then "Listening Ports" or in a Powershell use
|
||||
`netstat -aon | find /i "listening "` to discover the PID of the process
|
||||
currently using the port (the PID is the number in the rightmost column). Decide
|
||||
whether to shut the other process down, or to use a different port in your
|
||||
docker app.
|
||||
|
||||
### Docker Desktop fails to start when anti-virus software is installed
|
||||
|
||||
Some anti-virus software may be incompatible with Hyper-V and Microsoft
|
||||
Windows 10 builds. The conflict
|
||||
typically occurs after a Windows update and
|
||||
manifests as an error response from the Docker daemon and a Docker Desktop start failure.
|
||||
|
||||
For a temporary workaround, uninstall the anti-virus software, or
|
||||
explore other workarounds suggested on Docker Desktop forums.
|
||||
|
|
@ -1,64 +1,3 @@
|
|||
---
|
||||
description: Troubleshooting, logs, and known issues
|
||||
keywords: windows, troubleshooting, logs, issues
|
||||
redirect_from:
|
||||
- /windows/troubleshoot/
|
||||
- /docker-for-win/troubleshoot/
|
||||
- /docker-for-windows/troubleshoot/
|
||||
title: Logs and troubleshooting
|
||||
---
|
||||
|
||||
{% include upgrade-cta.html
|
||||
body="Did you know that Docker Desktop offers support for developers on a paid Docker subscription (Pro, Team, or Business)? Upgrade now to benefit from Docker Support. Click [here](../../support/index.md) to learn more."
|
||||
target-url="https://www.docker.com/pricing?utm_source=docker&utm_medium=webreferral&utm_campaign=docs_driven_upgrade_desktop_support"
|
||||
%}
|
||||
|
||||
This page contains information on how to diagnose and troubleshoot Docker Desktop issues, request Docker Desktop support, send logs and communicate with the Docker Desktop team, use our forums and Success Center, browse and log issues on GitHub, and find workarounds for known problems.
|
||||
|
||||
## Troubleshoot
|
||||
|
||||
Choose {: .inline} > **Troubleshoot**
|
||||
from the menu bar to see the troubleshoot options.
|
||||
|
||||
{:width="600px"}
|
||||
|
||||
The Troubleshoot page contains the following options:
|
||||
|
||||
* **Restart Docker Desktop**: Select to restart Docker Desktop.
|
||||
|
||||
* **Support**: Users with a paid Docker subscription can use this option to send a support request. Other users can use this option to diagnose any issues in Docker Desktop. For more information, see [Diagnose and feedback](#diagnose-and-feedback) and [Support](../../support/index.md).
|
||||
|
||||
* **Reset Kubernetes cluster**: Select this option to delete all stacks and Kubernetes resources. For more information, see [Kubernetes](../settings/windows.md#kubernetes).
|
||||
|
||||
* **Clean / Purge data**: Select this option to delete container and image data. Choose whether you'd like to delete data from Hyper-V, WSL 2, or Windows Containers and then click **Delete** to confirm.
|
||||
|
||||
* **Reset to factory defaults**: Choose this option to reset all options on
|
||||
Docker Desktop to their initial state, the same as when Docker Desktop was first installed.
|
||||
|
||||
## Diagnose and feedback
|
||||
|
||||
### In-app diagnostics
|
||||
|
||||
If you experience issues for which you do not find solutions in this
|
||||
documentation, on [Docker Desktop for Windows issues on
|
||||
GitHub](https://github.com/docker/for-win/issues), or the [Docker Desktop for Windows
|
||||
forum](https://forums.docker.com/c/docker-for-windows), we can help you
|
||||
troubleshoot the log data. Before reporting an issue, we recommend that you read the information provided on this page to fix some common known issues.
|
||||
|
||||
1. Choose {: .inline} > **Troubleshoot**
|
||||
from the menu.
|
||||
2. Optional: Sign into Docker Desktop. In addition, ensure you are signed into your [Docker account](https://hub.docker.com/){:target="_blank" rel="noopener" class="_"}.
|
||||
3. Click **Get support**. This opens the in-app **Support** page and starts collecting the diagnostics.
|
||||
{:width="600px"}
|
||||
4. When the diagnostics collection process is complete, click **Upload to get a Diagnostic ID**.
|
||||
5. When the diagnostics have been uploaded, Docker Desktop prints a Diagnostic ID. Copy this ID.
|
||||
6. If you have a paid Docker subscription, click **Contact Support**. This opens the [Docker Desktop support](https://hub.docker.com/support/desktop/){:target="_blank" rel="noopener" class="_"} form. Fill in the information required and add the ID you copied earlier to the Diagnostics ID field. Click **Submit** to request Docker Desktop support.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> You must be signed in to Docker Desktop using your Pro or Team plan credentials to access the support form. For information on what's covered as part of Docker Desktop support, see [Support](../../support/index.md).
|
||||
7. If you don't have a paid Docker subscription, click **Upgrade to benefit from Docker Support** to upgrade your existing account.
|
||||
Alternatively, click **Report a Bug** to open a new Docker Desktop issue on GitHub. This opens Docker Desktop [for Windows](https://github.com/docker/for-win/issues/) on GitHub in your web browser in a 'New issue' template. Complete the information required and ensure you add the diagnostic ID you copied earlier. Click **submit new issue** to create a new issue.
|
||||
|
||||
### Diagnosing from the terminal
|
||||
|
||||
|
|
@ -102,340 +41,5 @@ The tool runs a suite of checks and displays **PASS** or **FAIL** next to each c
|
|||
>
|
||||
> Let us know your feedback on the self-diagnose tool by creating an issue in the [for-win](https://github.com/docker/for-win/issues) GitHub repository.
|
||||
|
||||
## Troubleshooting topics
|
||||
|
||||
### Make sure certificates are set up correctly
|
||||
|
||||
Docker Desktop ignores certificates listed under insecure registries, and
|
||||
does not send client certificates to them. Commands like `docker run` that
|
||||
attempt to pull from the registry produces error messages on the command line,
|
||||
like this:
|
||||
|
||||
```console
|
||||
Error response from daemon: Get http://192.168.203.139:5858/v2/: malformed HTTP response "\x15\x03\x01\x00\x02\x02"
|
||||
```
|
||||
|
||||
As well as on the registry. For example:
|
||||
|
||||
```console
|
||||
2017/06/20 18:15:30 http: TLS handshake error from 192.168.203.139:52882: tls: client didn't provide a certificate
|
||||
2017/06/20 18:15:30 http: TLS handshake error from 192.168.203.139:52883: tls: first record does not look like a TLS handshake
|
||||
```
|
||||
|
||||
For more about using client and server side certificates, see
|
||||
[How do I add custom CA certificates?](index.md#how-do-i-add-custom-ca-certificates)
|
||||
and [How do I add client certificates?](index.md#how-do-i-add-client-certificates) in the
|
||||
Getting Started topic.
|
||||
|
||||
### Volumes
|
||||
|
||||
#### Permissions errors on data directories for shared volumes
|
||||
|
||||
When sharing files from Windows, Docker Desktop sets permissions on [shared volumes](../settings/windows.md#file-sharing)
|
||||
to a default value of [0777](http://permissions-calculator.org/decode/0777/)
|
||||
(`read`, `write`, `execute` permissions for `user` and for `group`).
|
||||
|
||||
The default permissions on shared volumes are not configurable. If you are
|
||||
working with applications that require permissions different from the shared
|
||||
volume defaults at container runtime, you need to either use non-host-mounted
|
||||
volumes or find a way to make the applications work with the default file
|
||||
permissions.
|
||||
|
||||
See also,
|
||||
[Can I change permissions on shared volumes for container-specific deployment requirements?](../faqs/windowsfaqs.md#can-i-change-permissions-on-shared-volumes-for-container-specific-deployment-requirements)
|
||||
in the FAQs.
|
||||
|
||||
#### Volume mounting requires shared folders for Linux containers
|
||||
|
||||
If you are using mounted volumes and get runtime errors indicating an
|
||||
application file is not found, access is denied to a volume mount, or a service
|
||||
cannot start, such as when using [Docker Compose](../../compose/gettingstarted.md),
|
||||
you might need to enable [shared folders](../settings/windows.md#file-sharing).
|
||||
|
||||
With the Hyper-V backend, mounting files from Windows requires shared folders for Linux containers. Click {: .inline}
|
||||
and then **Settings** > **Shared Folders** and share the folder that contains the
|
||||
Dockerfile and volume.
|
||||
|
||||
#### Support for symlinks
|
||||
|
||||
Symlinks work within and across containers. To learn more, see [How do symlinks work on Windows?](../faqs/windowsfaqs.md#how-do-symlinks-work-on-windows) in the FAQs.
|
||||
|
||||
#### Avoid unexpected syntax errors, use Unix style line endings for files in containers
|
||||
|
||||
Any file destined to run inside a container must use Unix style `\n` line
|
||||
endings. This includes files referenced at the command line for builds and in
|
||||
RUN commands in Docker files.
|
||||
|
||||
Docker containers and `docker build` run in a Unix environment, so files in
|
||||
containers must use Unix style line endings: `\n`, _not_ Windows style: `\r\n`.
|
||||
Keep this in mind when authoring files such as shell scripts using Windows
|
||||
tools, where the default is likely to be Windows style line endings. These
|
||||
commands ultimately get passed to Unix commands inside a Unix based container
|
||||
(for example, a shell script passed to `/bin/sh`). If Windows style line endings
|
||||
are used, `docker run` fails with syntax errors.
|
||||
|
||||
For an example of this issue and the resolution, see this issue on GitHub:
|
||||
[Docker RUN fails to execute shell
|
||||
script](https://github.com/moby/moby/issues/24388).
|
||||
|
||||
#### Path conversion on Windows
|
||||
|
||||
On Linux, the system takes care of mounting a path to another path. For example, when you run the following command on Linux:
|
||||
|
||||
```console
|
||||
$ docker run --rm -ti -v /home/user/work:/work alpine
|
||||
```
|
||||
|
||||
It adds a `/work` directory to the target container to mirror the specified path.
|
||||
|
||||
However, on Windows, you must update the source path. For example, if you are using
|
||||
the legacy Windows shell (`cmd.exe`), you can use the following command:
|
||||
|
||||
```console
|
||||
$ docker run --rm -ti -v C:\Users\user\work:/work alpine
|
||||
```
|
||||
|
||||
This starts the container and ensures the volume becomes usable. This is possible because Docker Desktop detects
|
||||
the Windows-style path and provides the appropriate conversion to mount the directory.
|
||||
|
||||
Docker Desktop also allows you to use Unix-style path to the appropriate format. For example:
|
||||
|
||||
```console
|
||||
$ docker run --rm -ti -v /c/Users/user/work:/work alpine ls /work
|
||||
```
|
||||
|
||||
#### Working with Git Bash
|
||||
|
||||
Git Bash (or MSYS) provides Unix-like environment on Windows. These tools apply their own
|
||||
preprocessing on the command line. For example, if you run the following command in Git Bash, it gives an error:
|
||||
|
||||
```console
|
||||
$ docker run --rm -ti -v C:\Users\user\work:/work alpine
|
||||
docker: Error response from daemon: mkdir C:UsersUserwork: Access is denied.
|
||||
```
|
||||
|
||||
This is because the `\` character has a special meaning in Git Bash. If you are using Git Bash, you must neutralize it using `\\`:
|
||||
|
||||
```console
|
||||
$ docker run --rm -ti -v C:\\Users\\user\\work:/work alpine
|
||||
```
|
||||
|
||||
Also, in scripts, the `pwd` command is used to avoid hardcoding file system locations. Its output is a Unix-style path.
|
||||
|
||||
```console
|
||||
$ pwd
|
||||
/c/Users/user/work
|
||||
```
|
||||
|
||||
Combined with the `$()` syntax, the command below works on Linux, however, it fails on Git Bash.
|
||||
|
||||
```console
|
||||
$ docker run --rm -ti -v $(pwd):/work alpine
|
||||
docker: Error response from daemon: OCI runtime create failed: invalid mount {Destination:\Program Files\Git\work Type:bind Source:/run/desktop/mnt/host/c/Users/user/work;C Options:[rbind rprivate]}: mount destination \Program Files\Git\work not absolute: unknown.
|
||||
```
|
||||
|
||||
You can work around this issue by using an extra `/`
|
||||
|
||||
```console
|
||||
$ docker run --rm -ti -v /$(pwd):/work alpine
|
||||
```
|
||||
|
||||
Portability of the scripts is not affected as Linux treats multiple `/` as a single entry.
|
||||
Each occurence of paths on a single line must be neutralized.
|
||||
|
||||
```console
|
||||
$ docker run --rm -ti -v /$(pwd):/work alpine ls /work
|
||||
ls: C:/Program Files/Git/work: No such file or directory
|
||||
```
|
||||
|
||||
In this example, The `$(pwd)` is not converted because of the preceding '/'. However, the second '/work' is transformed by the
|
||||
POSIX layer before passing it to Docker Desktop. You can also work around this issue by using an extra `/`.
|
||||
|
||||
```console
|
||||
$ docker run --rm -ti -v /$(pwd):/work alpine ls //work
|
||||
```
|
||||
|
||||
To verify whether the errors are generated from your script, or from another source, you can use an environment variable. For example:
|
||||
|
||||
```console
|
||||
$ MSYS_NO_PATHCONV=1 docker run --rm -ti -v $(pwd):/work alpine ls /work
|
||||
```
|
||||
|
||||
It only expects the environment variable here. The value doesn't matter.
|
||||
|
||||
In some cases, MSYS also transforms colons to semicolon. Similar conversions can also occur
|
||||
when using `~` because the POSIX layer translates it to a DOS path. `MSYS_NO_PATHCONV` also works in this case.
|
||||
|
||||
### Virtualization
|
||||
|
||||
Your machine must have the following features for Docker Desktop to function correctly.
|
||||
|
||||
#### WSL 2 and Windows Home
|
||||
|
||||
1. Virtual Machine Platform
|
||||
2. [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10){:target="_blank" rel="noopener" class="_"}
|
||||
3. [Virtualization enabled in the BIOS](https://bce.berkeley.edu/enabling-virtualization-in-your-pc-bios.html){:target="_blank" rel="noopener" class="_"}
|
||||
4. Hypervisor enabled at Windows startup
|
||||
|
||||
{:width="600px"}
|
||||
|
||||
#### Hyper-V
|
||||
|
||||
On Windows 10 Pro or Enterprise, you can also use Hyper-V with the following features enabled:
|
||||
|
||||
1. [Hyper-V](https://docs.microsoft.com/en-us/windows-server/virtualization/hyper-v/hyper-v-technology-overview){:target="_blank" rel="noopener" class="_"}
|
||||
installed and working
|
||||
2. [Virtualization enabled in the BIOS](https://bce.berkeley.edu/enabling-virtualization-in-your-pc-bios.html){:target="_blank" rel="noopener" class="_"}
|
||||
3. Hypervisor enabled at Windows startup
|
||||
|
||||
{:width="600px"}
|
||||
|
||||
Docker Desktop requires Hyper-V as well as the Hyper-V Module for Windows
|
||||
Powershell to be installed and enabled. The Docker Desktop installer enables
|
||||
it for you.
|
||||
|
||||
Docker Desktop also needs two CPU hardware features to use Hyper-V: Virtualization and Second Level Address Translation (SLAT), which is also called Rapid Virtualization Indexing (RVI). On some systems, Virtualization must be enabled in the BIOS. The steps required are vendor-specific, but typically the BIOS option is called `Virtualization Technology (VTx)` or something similar. Run the command `systeminfo` to check all required Hyper-V features. See [Pre-requisites for Hyper-V on Windows 10](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/reference/hyper-v-requirements) for more details.
|
||||
|
||||
To install Hyper-V manually, see [Install Hyper-V on Windows 10](https://msdn.microsoft.com/en-us/virtualization/hyperv_on_windows/quick_start/walkthrough_install). A reboot is *required* after installation. If you install Hyper-V without rebooting, Docker Desktop does not work correctly.
|
||||
|
||||
From the start menu, type **Turn Windows features on or off** and press enter.
|
||||
In the subsequent screen, verify that Hyper-V is enabled.
|
||||
|
||||
#### Virtualization must be enabled
|
||||
|
||||
In addition to [Hyper-V](#hyper-v) or [WSL 2](wsl.md), virtualization must be enabled. Check the
|
||||
Performance tab on the Task Manager:
|
||||
|
||||
{:width="700px"}
|
||||
|
||||
If you manually uninstall Hyper-V, WSL 2 or disable virtualization,
|
||||
Docker Desktop cannot start. See [Unable to run Docker for Windows on
|
||||
Windows 10 Enterprise](https://github.com/docker/for-win/issues/74).
|
||||
|
||||
#### Hypervisor enabled at Windows startup
|
||||
|
||||
If you have completed the steps described above and are still experiencing
|
||||
Docker Desktop startup issues, this could be because the Hypervisor is installed,
|
||||
but not launched during Windows startup. Some tools (such as older versions of
|
||||
Virtual Box) and video game installers disable hypervisor on boot. To reenable it:
|
||||
|
||||
1. Open an administrative console prompt.
|
||||
2. Run `bcdedit /set hypervisorlaunchtype auto`.
|
||||
3. Restart Windows.
|
||||
|
||||
You can also refer to the [Microsoft TechNet article](https://social.technet.microsoft.com/Forums/en-US/ee5b1d6b-09e2-49f3-a52c-820aafc316f9/hyperv-doesnt-work-after-upgrade-to-windows-10-1809?forum=win10itprovirt){:target="_blank" rel="noopener" class="_"} on Code flow guard (CFG) settings.
|
||||
|
||||
### Windows containers and Windows Server
|
||||
|
||||
Docker Desktop is not supported on Windows Server. If you have questions about how to run Windows containers on Windows 10, see
|
||||
[Switch between Windows and Linux containers](index.md#switch-between-windows-and-linux-containers).
|
||||
|
||||
A full tutorial is available in [docker/labs](https://github.com/docker/labs) on
|
||||
[Getting Started with Windows Containers](https://github.com/docker/labs/blob/master/windows/windows-containers/README.md).
|
||||
|
||||
You can install a native Windows binary which allows you to develop and run
|
||||
Windows containers without Docker Desktop. However, if you install Docker this way, you cannot develop or run Linux containers. If you try to run a Linux container on the native Docker daemon, an error occurs:
|
||||
|
||||
```none
|
||||
C:\Program Files\Docker\docker.exe:
|
||||
image operating system "linux" cannot be used on this platform.
|
||||
See 'C:\Program Files\Docker\docker.exe run --help'.
|
||||
```
|
||||
|
||||
### Running Docker Desktop in nested virtualization scenarios
|
||||
|
||||
Docker Desktop can run inside a Hyper-V VM, see
|
||||
[Microsoft's nested virtualization user guide](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/user-guide/nested-virtualization) for more information.
|
||||
Docker Desktop can also run inside a Windows 10 VM running on apps like Parallels or VMware Fusion on a Mac provided that the VM is properly configured.
|
||||
|
||||
However, problems and intermittent failures may still occur due to the way these apps virtualize the hardware. For these reasons, _**Docker Desktop is not supported in nested virtualization scenarios**_. It might work
|
||||
in some cases, and not in others.
|
||||
|
||||
For best results, we recommend you run Docker Desktop natively on a Windows system (to work with Windows or Linux containers), or on Mac or Linux to work with Linux containers.
|
||||
|
||||
#### If you still want to use nested virtualization
|
||||
|
||||
* If using Hyper-V, make sure nested virtualization support is enabled for the
|
||||
Windows VM by running the following powershell as Administrator:
|
||||
|
||||
```none
|
||||
Set-VMProcessor -VMName <Windows VM Name> -ExposeVirtualizationExtensions $true
|
||||
```
|
||||
|
||||
* If using VMware or Parallels, make sure nested virtualization support is enabled.
|
||||
Check the settings in **Hardware > CPU & Memory > Advanced Options > Enable
|
||||
nested virtualization** (the exact menu sequence might vary slightly).
|
||||
|
||||
* Configure your Windows VM with at least 2 CPUs and sufficient memory to run your
|
||||
workloads.
|
||||
|
||||
* Make sure your system is more or less idle.
|
||||
|
||||
* Make sure your Windows OS is up-to-date. There have been several issues with
|
||||
some insider builds.
|
||||
|
||||
* The processor you have may also be relevant. For example, Westmere based Mac
|
||||
Pros have some additional hardware virtualization features over Nehalem based
|
||||
Mac Pros and so do newer generations of Intel processors. For Hyper-V, check
|
||||
[Microsoft's nested virtualization user guide](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/user-guide/nested-virtualization)
|
||||
to verify the host OS version is supported on your hardware.
|
||||
|
||||
#### Typical failures we see with nested virtualization
|
||||
|
||||
* Sometimes the VM fails to boot when Linux tries to calibrate the time stamp
|
||||
counter (TSC). This process is quite timing sensitive and may fail when
|
||||
executed inside a VM which itself runs inside a VM. CPU utilization is also
|
||||
likely to be higher.
|
||||
|
||||
* Ensure "PMU Virtualization" is turned off in Parallels on Macs. Check the
|
||||
settings in **Hardware > CPU & Memory > Advanced Settings > PMU
|
||||
Virtualization**.
|
||||
|
||||
### Networking issues
|
||||
|
||||
IPv6 is not (yet) supported on Docker Desktop.
|
||||
|
||||
## Workarounds
|
||||
|
||||
### Reboot
|
||||
|
||||
Restart your PC to stop / discard any vestige of the daemon running from the
|
||||
previously installed version.
|
||||
|
||||
### Unset `DOCKER_HOST`
|
||||
|
||||
The `DOCKER_HOST` environmental variable does not need to be set. If you use
|
||||
bash, use the command `unset ${!DOCKER_*}` to unset it. For other shells,
|
||||
consult the shell's documentation.
|
||||
|
||||
### Make sure Docker is running for webserver examples
|
||||
|
||||
For the `hello-world-nginx` example and others, Docker Desktop must be
|
||||
running to get to the webserver on `http://localhost/`. Make sure that the
|
||||
Docker whale is showing in the menu bar, and that you run the Docker commands in
|
||||
a shell that is connected to the Docker Desktop Engine. Otherwise, you might start the webserver container but get a "web page
|
||||
not available" error when you go to `docker`.
|
||||
|
||||
### How to solve `port already allocated` errors
|
||||
|
||||
If you see errors like `Bind for 0.0.0.0:8080 failed: port is already allocated`
|
||||
or `listen tcp:0.0.0.0:8080: bind: address is already in use` ...
|
||||
|
||||
These errors are often caused by some other software on Windows using those
|
||||
ports. To discover the identity of this software, either use the `resmon.exe`
|
||||
GUI and click "Network" and then "Listening Ports" or in a Powershell use
|
||||
`netstat -aon | find /i "listening "` to discover the PID of the process
|
||||
currently using the port (the PID is the number in the rightmost column). Decide
|
||||
whether to shut the other process down, or to use a different port in your
|
||||
docker app.
|
||||
|
||||
### Docker Desktop fails to start when anti-virus software is installed
|
||||
|
||||
Some anti-virus software may be incompatible with Hyper-V and Microsoft
|
||||
Windows 10 builds. The conflict
|
||||
typically occurs after a Windows update and
|
||||
manifests as an error response from the Docker daemon and a Docker Desktop start failure.
|
||||
|
||||
For a temporary workaround, uninstall the anti-virus software, or
|
||||
explore other workarounds suggested on Docker Desktop forums.
|
||||
|
||||
|
|
|
|||
|
|
@ -93,7 +93,7 @@ on your development host. Use the following command to bind-mount the `target/`
|
|||
directory into your container at `/app/`. Run the command from within the
|
||||
`source` directory. The `$(pwd)` sub-command expands to the current working
|
||||
directory on Linux or macOS hosts.
|
||||
If you're on Windows, see also [Path conversions on Windows](../desktop/windows/troubleshoot.md#path-conversion-on-windows).
|
||||
If you're on Windows, see also [Path conversions on Windows](../desktop/troubleshoot/topics.md).
|
||||
|
||||
The `--mount` and `-v` examples below produce the same result. You
|
||||
can't run them both unless you remove the `devtest` container after running the
|
||||
|
|
|
|||
|
|
@ -98,10 +98,7 @@ For more information, see [Docker Data Processing Agreement](https://www.docker.
|
|||
|
||||
## What can I do before seeking support?
|
||||
|
||||
Before seeking support, you can perform basic troubleshooting using the following troubleshooting topics:
|
||||
- [Docker Desktop for Linux](../desktop/linux/troubleshoot.md)
|
||||
- [Docker Desktop for Mac](../desktop/mac/troubleshoot.md)
|
||||
- [Docker Desktop for Windows](../desktop/windows/troubleshoot.md)
|
||||
Before seeking support, you can perform basic troubleshooting. See [Diagnose and Troubleshooting](../desktop/troubleshoot/overview.md) for more information.
|
||||
|
||||
You can also see if an answer already exists in the following FAQs:
|
||||
- [Docker Business or Team onboarding](../docker-hub/onboarding-faqs.md)
|
||||
|
|
|
|||
Loading…
Reference in New Issue