From 087e391397a825aa21d9f81755d4b201ff5c4c06 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Wed, 8 Apr 2020 15:53:56 +0200 Subject: [PATCH] desktop: use relative markdown links Unfortunately, the only reliable way to create internal links is to use relative links to other Markdown files. This does match the way links on GitHub work, but makes it harder to create these links. Signed-off-by: Sebastiaan van Stijn --- docker-for-mac/dashboard.md | 4 ++-- docker-for-mac/docker-toolbox.md | 4 ++-- docker-for-mac/edge-release-notes.md | 6 +++--- docker-for-mac/faqs.md | 12 ++++++------ docker-for-mac/index.md | 14 +++++++------- docker-for-mac/install.md | 4 ++-- docker-for-mac/networking.md | 2 +- docker-for-mac/osxfs-caching.md | 11 +++++------ docker-for-mac/osxfs.md | 4 ++-- docker-for-mac/release-notes.md | 4 ++-- docker-for-mac/troubleshoot.md | 9 ++++----- docker-for-windows/dashboard.md | 4 ++-- docker-for-windows/faqs.md | 24 ++++++++++++------------ docker-for-windows/index.md | 20 ++++++++++---------- docker-for-windows/install.md | 10 +++++----- docker-for-windows/networking.md | 2 +- docker-for-windows/release-notes.md | 2 +- docker-for-windows/troubleshoot.md | 20 ++++++++++---------- 18 files changed, 77 insertions(+), 79 deletions(-) diff --git a/docker-for-mac/dashboard.md b/docker-for-mac/dashboard.md index c41fb71976..b0dac69c63 100644 --- a/docker-for-mac/dashboard.md +++ b/docker-for-mac/dashboard.md @@ -16,9 +16,9 @@ The Docker Desktop Dashboard offers the following benefits: In addition, the Dashboard UI allows you to: -- Navigate to the [Settings](/docker-for-mac/index/#preferences) menu to configure Docker Desktop preferences +- Navigate to the [Settings](index.md#preferences) menu to configure Docker Desktop preferences - Access the [Troubleshoot](troubleshoot.md) menu to debug and perform restart operations -- Sign into [Docker Hub](/docker-for-mac/index/#docker-hub) using your Docker ID +- Sign into [Docker Hub](index.md#docker-hub) using your Docker ID To access the Docker Desktop Dashboard, from the Docker menu, select **Dashboard**. The Dashboard provides a runtime view of all your containers and applications. diff --git a/docker-for-mac/docker-toolbox.md b/docker-for-mac/docker-toolbox.md index 55aade80f6..241bb4dabb 100644 --- a/docker-for-mac/docker-toolbox.md +++ b/docker-for-mac/docker-toolbox.md @@ -103,7 +103,7 @@ continue to use Docker Machine, which operates outside the scope of Docker Deskt > `/usr/local/bin` with symlinks to its own versions. {:.warning} -See also [Unset environment variables in the current shell](/machine/get-started.md#unset-environment-variables-in-the-current-shell) +See also [Unset environment variables in the current shell](../machine/get-started.md#unset-environment-variables-in-the-current-shell) in the Docker Machine topics. ## Docker Toolbox and Docker Desktop coexistence @@ -221,5 +221,5 @@ it](https://docs.docker.com/toolbox/toolbox_install_mac/#how-to-uninstall-toolbo You might decide that you do not need Toolbox now that you have Docker Desktop, and want to uninstall it. For details on how to perform a clean uninstall of -Toolbox on Mac, see [How to uninstall Toolbox](/toolbox/toolbox_install_mac.md#how-to-uninstall-toolbox) +Toolbox on Mac, see [How to uninstall Toolbox](../toolbox/toolbox_install_mac.md#how-to-uninstall-toolbox) in the Toolbox Mac topics. diff --git a/docker-for-mac/edge-release-notes.md b/docker-for-mac/edge-release-notes.md index 3b7626516e..349d3f2904 100644 --- a/docker-for-mac/edge-release-notes.md +++ b/docker-for-mac/edge-release-notes.md @@ -664,7 +664,7 @@ This release contains a Kubernetes upgrade. Note that your local Kubernetes clus - [Docker 17.12.0-ce](https://github.com/docker/docker-ce/releases/tag/v17.12.0-ce) * New - - Experimental Kubernetes Support. You can now run a single-node Kubernetes cluster from the "Kubernetes" Pane in Docker For Mac Preferences and use kubectl commands as well as docker commands. See https://docs.docker.com/docker-for-mac/kubernetes/ + - Experimental Kubernetes Support. You can now run a single-node Kubernetes cluster from the "Kubernetes" Pane in Docker For Mac Preferences and use kubectl commands as well as docker commands. See [https://docs.docker.com/docker-for-mac/kubernetes/](kubernetes.md) - DNS name `docker.for.mac.host.internal` should be used instead of `docker.for.mac.localhost` (still valid) for host resolution from containers, since since there is an RFC banning the use of subdomains of localhost (See https://tools.ietf.org/html/draft-west-let-localhost-be-localhost-06). * Bug fixes and minor changes @@ -871,7 +871,7 @@ TCP connection is idle for more than five minutes (related to - Add daemon options validation - Diagnose can be cancelled & Improved help information. Fixes [docker/for-mac#1134](https://github.com/docker/for-mac/issues/1134), [docker/for-mac#1474](https://github.com/docker/for-mac/issues/1474) -- Support paging of Docker Cloud [repositories](/docker-cloud/builds/repos.md) and [organizations](/docker-cloud/orgs.md). Fixes [docker/for-mac#1538](https://github.com/docker/for-mac/issues/1538) +- Support paging of Docker Cloud [repositories](../docker-hub/repos.md) and [organizations](../docker-hub/orgs.md). Fixes [docker/for-mac#1538](https://github.com/docker/for-mac/issues/1538) ### Docker Community Edition 17.06.1-ce-mac20, 2017-07-18 @@ -1724,7 +1724,7 @@ events or unexpected unmounts. **Bug fixes and minor changes** -* Documentation moved to [https://docs.docker.com/docker-for-mac/](/docker-for-mac/) +* Documentation moved to [https://docs.docker.com/docker-for-mac/](index.md) * Allow non-admin users to launch the app for the first time (using admin creds) * Prompt non-admin users for admin password when needed in Preferences * Fixed download links, documentation links diff --git a/docker-for-mac/faqs.md b/docker-for-mac/faqs.md index 46911c28a2..0186b3704f 100644 --- a/docker-for-mac/faqs.md +++ b/docker-for-mac/faqs.md @@ -25,7 +25,7 @@ The **Edge channel** provides an installer with new features we are working on, ### Can I switch between Stable and Edge versions of Docker Desktop? -Yes, you can switch between Stable and Edge versions. You can try out the Edge releases to see what's new, then go back to Stable for other work. However, **you can only have one version of Docker Desktop installed at a time**. For more information, see [Switch between Stable and Edge versions](/docker-for-mac/install/#switch-between-stable-and-edge-versions). +Yes, you can switch between Stable and Edge versions. You can try out the Edge releases to see what's new, then go back to Stable for other work. However, **you can only have one version of Docker Desktop installed at a time**. For more information, see [Switch between Stable and Edge versions](install.md#switch-between-stable-and-edge-versions). ### What is Docker.app? @@ -49,7 +49,7 @@ development tools. On Docker Desktop, clients can connect to the Docker Engine through a Unix socket: `unix:///var/run/docker.sock`. -See also [Docker Engine API](/engine/api.md) and Docker Desktop for Mac forums topic +See also [Docker Engine API](../engine/api/index.md) and Docker Desktop for Mac forums topic [Using pycharm Docker plugin..](https://forums.docker.com/t/using-pycharm-docker-plugin-with-docker-beta/8617){: target="_blank" class="_"}. If you are working with applications like [Apache Maven](https://maven.apache.org/){: target="_blank" class="_"} @@ -67,7 +67,7 @@ Mac has a changing IP address (or none if you have no network access). We recomm Mac so that containers can connect to this address. For more information and examples, see -[I want to connect from a container to a service on the host](networking.md#i-want-to-connect-from-a-container-to-a-service-on-the-host) in the [Networking](/docker-for-mac/networking/) topic. +[I want to connect from a container to a service on the host](networking.md#i-want-to-connect-from-a-container-to-a-service-on-the-host) in the [Networking](networking.md) topic. ### How do I connect to a container from Mac? @@ -78,17 +78,17 @@ For more information and examples, see ### Can I use an SSH agent inside a container? -Yes, you can use the host’s SSH agent inside a container. For more information, see [SSH agent forwarding](/docker-for-mac/osxfs/#ssh-agent-forwarding). +Yes, you can use the host’s SSH agent inside a container. For more information, see [SSH agent forwarding](osxfs.md#ssh-agent-forwarding). ### How do I add custom CA certificates? Docker Desktop supports all trusted certificate authorities (CAs) (root or intermediate). For more information on adding server and client side certs, see -[Add TLS certificates](/docker-for-mac/#add-tls-certificates) in the Getting Started topic. +[Add TLS certificates](index.md#add-tls-certificates) in the Getting Started topic. ### How do I add client certificates? For information on adding client certificates, see -[Add client certificates](/docker-for-mac/index/#adding-client-certificates) in the Getting Started topic. +[Add client certificates](index.md#add-client-certificates) in the Getting Started topic. ### Can I pass through a USB device to a container? diff --git a/docker-for-mac/index.md b/docker-for-mac/index.md index 6f7d43da14..6ef1c8c6a6 100644 --- a/docker-for-mac/index.md +++ b/docker-for-mac/index.md @@ -205,7 +205,7 @@ You can configure Docker Desktop networking to work on a virtual private network The Docker Engine page allows you to configure the Docker daemon to determine how your containers run. Type a JSON configuration file in the box to configure the daemon settings. For a full list of options, see the Docker Engine -[dockerd commandline reference](/engine/reference/commandline/dockerd.md){:target="_blank" +[dockerd commandline reference](/engine/reference/commandline/dockerd/){:target="_blank" class="_"}. Click **Apply & Restart** to save your settings and restart Docker Desktop. @@ -274,7 +274,7 @@ experience conflicts, remove `/usr/local/bin/kubectl`. - To enable Kubernetes support and install a standalone instance of Kubernetes running as a Docker container, select **Enable Kubernetes**. To set Kubernetes as the - [default orchestrator](/docker-for-mac/kubernetes/#override-the-default-orchestrator), select **Deploy Docker Stacks to Kubernetes by default**. + [default orchestrator](kubernetes.md#override-the-default-orchestrator), select **Deploy Docker Stacks to Kubernetes by default**. Click **Apply & Restart** to save the settings. This instantiates images required to run the Kubernetes server as containers, and installs the `/usr/local/bin/kubectl` command on your Mac. @@ -411,7 +411,7 @@ also in your keychain. To learn more about how to install a CA root certificate for the registry and how to set the client TLS certificate for verification, see -[Verify repository client with certificates](/engine/security/certificates.md) +[Verify repository client with certificates](../engine/security/certificates.md) in the Docker Engine topics. ## Install shell completion @@ -479,11 +479,11 @@ For information about providing feedback on the documentation or update it yours Select **Sign in /Create Docker ID** from the Docker Desktop menu to access your [Docker Hub](https://hub.docker.com/){: target="_blank" class="_" } account. Once logged in, you can access your Docker Hub repositories and organizations directly from the Docker Desktop menu. -For more information, refer to the following [Docker Hub topics](/docker-hub/index.md){:target="_blank" +For more information, refer to the following [Docker Hub topics](../docker-hub/index.md){:target="_blank" class="_"}: -* [Organizations and Teams in Docker Hub](/docker-hub/orgs.md){:target="_blank" class="_"} -* [Builds](/docker-hub/builds/index.md){:target="_blank" class="_"} +* [Organizations and Teams in Docker Hub](../docker-hub/orgs.md){:target="_blank" class="_"} +* [Builds](../docker-hub/builds/index.md){:target="_blank" class="_"} ### Two-factor authentication @@ -512,7 +512,7 @@ After you have successfully authenticated, you can access your organizations and walkthroughs and source code. * For a summary of Docker command line interface (CLI) commands, see - [Docker CLI Reference Guide](/engine/api/index.md){: target="_blank" class="_"}. + [Docker CLI Reference Guide](../engine/api/index.md){: target="_blank" class="_"}. * Check out the blog post, [What’s New in Docker 17.06 Community Edition (CE)](https://blog.docker.com/2017/07/whats-new-docker-17-06-community-edition-ce/){: diff --git a/docker-for-mac/install.md b/docker-for-mac/install.md index 5c8a2c58b7..0afb3dfc09 100644 --- a/docker-for-mac/install.md +++ b/docker-for-mac/install.md @@ -48,8 +48,8 @@ Your Mac must meet the following requirements to successfully install Docker Des ## What's included in the installer The Docker Desktop installation includes - [Docker Engine](/engine/index.md), Docker CLI client, - [Docker Compose](/compose/index.md), [Notary](/notary/getting_started/), [Kubernetes](https://github.com/kubernetes/kubernetes/), and [Credential Helper](https://github.com/docker/docker-credential-helpers/). + [Docker Engine](../engine/index.md), Docker CLI client, + [Docker Compose](../compose/index.md), [Notary](../notary/getting_started.md), [Kubernetes](https://github.com/kubernetes/kubernetes/), and [Credential Helper](https://github.com/docker/docker-credential-helpers/). ## Install and run Docker Desktop on Mac diff --git a/docker-for-mac/networking.md b/docker-for-mac/networking.md index b030955694..1f77790d4d 100644 --- a/docker-for-mac/networking.md +++ b/docker-for-mac/networking.md @@ -109,5 +109,5 @@ container to random ports on the host. $ docker run -d -P --name webserver nginx ``` -See the [run command](/engine/reference/commandline/run.md) for more details on +See the [run command](../engine/reference/commandline/run.md) for more details on publish options used with `docker run`. diff --git a/docker-for-mac/osxfs-caching.md b/docker-for-mac/osxfs-caching.md index 00b41d5026..bdae01909f 100644 --- a/docker-for-mac/osxfs-caching.md +++ b/docker-for-mac/osxfs-caching.md @@ -4,9 +4,8 @@ keywords: mac, osxfs, volumes title: Performance tuning for volume mounts (shared filesystems) --- -[Docker 17.04 CE Edge](/edge/index.md#docker-ce-edge-new-features) adds support -for two new flags to the [docker run `-v`, -`--volume`](/engine/reference/run/#volume-shared-filesystems) +[Docker 17.04 CE Edge](https://github.com/docker/docker.github.io/blob/v17.03/edge/index.md#docker-ce-edge-new-features) adds support +for two new flags to the [docker run `-v`, `--volume`](../engine/reference/run.md#volume-shared-filesystems) option, `cached` and `delegated`, that can significantly improve the performance of mounted volume access on Docker Desktop for Mac. These options begin to solve some of the challenges discussed in @@ -25,7 +24,7 @@ Performance](https://stories.amazee.io/docker-on-mac-performance-docker-machine- gives a nice, quick summary. For information on how to configure these options in a Compose file, see -[Caching options for volume mounts](/compose/compose-file/index.md#caching-options-for-volume-mounts-docker-desktop-for-mac) +[Caching options for volume mounts](../compose/compose-file/index.md#caching-options-for-volume-mounts-docker-desktop-for-mac) the Docker Compose topics. ## Performance implications of host-container file system consistency @@ -96,8 +95,8 @@ temporary discrepancies are allowed between container and host. Each of these configurations (`consistent`, `cached`, `delegated`) can be specified as a suffix to the -[`-v`](/engine/reference/run/#volume-shared-filesystems) -option of [`docker run`](/engine/reference/run.md). For +[`-v`](../engine/reference/run.md#volume-shared-filesystems) +option of [`docker run`](../engine/reference/commandline/run.md). For example, to bind-mount `/Users/yallop/project` in a container under the path `/project`, you might run the following command: diff --git a/docker-for-mac/osxfs.md b/docker-for-mac/osxfs.md index 11e433991c..a7749bca7a 100644 --- a/docker-for-mac/osxfs.md +++ b/docker-for-mac/osxfs.md @@ -63,7 +63,7 @@ By default, you can share files in `/Users/`, `/Volumes/`, `/private/`, and `/tmp` directly. To add or remove directory trees that are exported to Docker, use the **File sharing** tab in Docker preferences ![whale menu](images/whale-x.png){: .inline} -> **Preferences** -> -**File sharing**. (See [Preferences](/docker-for-mac/index.md#preferences-menu).) +**File sharing**. (See [Preferences](index.md#file-sharing).) All other paths used in `-v` bind mounts are sourced from the Moby Linux VM running the Docker @@ -117,7 +117,7 @@ The following are **unsupported file system events**: * Open * Access * Close events -* Unmount events (see Mounts) +* Unmount events (see [Mounts](#mounts)) Some events may be delivered multiple times. These limitations do not apply to events between containers, only to those events originating in macOS. diff --git a/docker-for-mac/release-notes.md b/docker-for-mac/release-notes.md index 4a9096dc96..3ed18c603b 100644 --- a/docker-for-mac/release-notes.md +++ b/docker-for-mac/release-notes.md @@ -290,7 +290,7 @@ Docker Desktop Community 2.1.0.0 contains the following experimental features. - Linux Kernel 4.9.93 with CEPH, DRBD, RBD, MPLS_ROUTING and MPLS_IPTUNNEL enabled * New - - Kubernetes Support. You can now run a single-node Kubernetes cluster from the "Kubernetes" Pane in Docker For Mac Preferences and use kubectl commands as well as docker commands. See https://docs.docker.com/docker-for-mac/kubernetes/ + - Kubernetes Support. You can now run a single-node Kubernetes cluster from the "Kubernetes" Pane in Docker For Mac Preferences and use kubectl commands as well as docker commands. See [https://docs.docker.com/docker-for-mac/kubernetes/](kubernetes.md) - Add an experimental SOCKS server to allow access to container networks, see [docker/for-mac#2670](https://github.com/docker/for-mac/issues/2670#issuecomment-372365274). Also see [docker/for-mac#2721](https://github.com/docker/for-mac/issues/2721) - Re-enable raw as the default disk format for users running macOS 10.13.4 and higher. Note this change only takes effect after a "reset to factory defaults" or "remove all data" (from the Whale menu -> Preferences -> Reset). Related to [docker/for-mac#2625](https://github.com/docker/for-mac/issues/2625) @@ -366,7 +366,7 @@ Docker Desktop Community 2.1.0.0 contains the following experimental features. - Clearer error message when incompatible hardware is detected. - Fix some cases where selecting "Reset" after an error did not reset properly. - Fix incorrect NTP config. Fixes [docker/for-mac#2529](https://github.com/docker/for-mac/issues/2529) - - Migration of Docker Toolbox images is not proposed anymore in Docker For Mac installer (still possible to [migrate Toolbox images manually](https://docs.docker.com/docker-for-mac/docker-toolbox/#migrating-from-docker-toolbox-to-docker-for-mac) ). + - Migration of Docker Toolbox images is not proposed anymore in Docker For Mac installer (still possible to [migrate Toolbox images manually](docker-toolbox.md#migrating-from-docker-toolbox-to-docker-desktop-on-mac) ). ### Docker Community Edition 17.12.0-ce-mac55 2018-02-27 diff --git a/docker-for-mac/troubleshoot.md b/docker-for-mac/troubleshoot.md index afa12b8d69..df76dc89ff 100644 --- a/docker-for-mac/troubleshoot.md +++ b/docker-for-mac/troubleshoot.md @@ -62,8 +62,7 @@ Choose ![whale menu](images/whale-x.png){: .inline} > **Troubleshoot** > **Run D Once the diagnostics are available, you can upload them and obtain a **Diagnostic ID**, which must be provided when communicating with the Docker team. For more information on our policy regarding personal data, see -[how is personal data handled in Docker -Desktop](https://docs.docker.com/docker-for-mac/faqs/#how-is-personal-data-handled-in-docker-desktop). +[how is personal data handled in Docker Desktop](faqs.md#how-is-personal-data-handled-in-docker-desktop). ![Diagnostics & Feedback with ID](images/diagnose-feedback-id.png){:width="600px"} @@ -109,8 +108,8 @@ $ open /tmp/BE9AFAAF-F68B-41D0-9D12-84760E6B8740/20190905152051.zip In addition to using the diagnose and feedback option to submit logs, you can browse the logs yourself. The following documentation is about macOS 10.12 -onwards; for older versions, see [older -documentation](v17.12/docker-for-mac/troubleshoot/#logs). +onwards; for older versions, see +[older documentation](https://github.com/docker/docker.github.io/blob/v17.12/docker-for-mac/troubleshoot.md#check-the-logs). #### In a terminal @@ -176,7 +175,7 @@ in the FAQs. 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), +cannot start, such as when using [Docker Compose](../compose/gettingstarted.md), you might need to enable [file sharing](index.md#file-sharing). Volume mounting requires shared drives for projects that live outside of the diff --git a/docker-for-windows/dashboard.md b/docker-for-windows/dashboard.md index fb87571554..f498ee24c9 100644 --- a/docker-for-windows/dashboard.md +++ b/docker-for-windows/dashboard.md @@ -16,9 +16,9 @@ The Docker Desktop Dashboard offers the following benefits: In addition, the Dashboard UI allows you to: -- Navigate to the [Settings](/docker-for-windows/index/#docker-settings-dialog) menu to configure Docker Desktop preferences +- Navigate to the [Settings](index.md#docker-settings-dialog) menu to configure Docker Desktop preferences - Access the [Troubleshoot](troubleshoot.md) menu to debug and perform restart operations -- Sign into [Docker Hub](/docker-for-windows/index/#docker-hub) using your Docker ID +- Sign into [Docker Hub](index.md#docker-hub) using your Docker ID To access the Docker Desktop Dashboard, from the Docker menu, select **Dashboard**. The Dashboard provides a runtime view of all your containers and applications. diff --git a/docker-for-windows/faqs.md b/docker-for-windows/faqs.md index 4fc40671dd..1384886c82 100644 --- a/docker-for-windows/faqs.md +++ b/docker-for-windows/faqs.md @@ -26,11 +26,11 @@ Docker Engine. Bugs, crashes, and issues can occur when using the Edge version, ### Can I switch between Stable and Edge versions of Docker Desktop? -Yes, you can switch between Stable and Edge versions. You can try out the Edge releases to see what's new, then go back to Stable for other work. However, **you can only have one version of Docker Desktop installed at a time**. For more information, see [Switch between Stable and Edge versions](/docker-for-windows/install/#switch-between-stable-and-edge-versions). +Yes, you can switch between Stable and Edge versions. You can try out the Edge releases to see what's new, then go back to Stable for other work. However, **you can only have one version of Docker Desktop installed at a time**. For more information, see [Switch between Stable and Edge versions](install.md#switch-between-stable-and-edge-versions). ## What are the system requirements for Docker Desktop? -For information about system requirements, see [Docker Desktop Windows system requirements](install/#system-requirements). +For information about system requirements, see [Docker Desktop Windows system requirements](install.md#system-requirements). ## What is an experimental feature? @@ -49,7 +49,7 @@ On Docker Desktop, clients can connect to the Docker Engine through a This sets `DOCKER_HOST` and `DOCKER_CERT_PATH` environment variables to the given values (for the named pipe or TCP socket, whichever you use). -See also [Docker Engine API](/engine/api.md) and the Docker Desktop for Windows forums topic [How to find the remote API](https://forums.docker.com/t/how-to-find-the-remote-api/20988){: target="_blank" class="_"}. +See also [Docker Engine API](../engine/api/index.md) and the Docker Desktop for Windows forums topic [How to find the remote API](https://forums.docker.com/t/how-to-find-the-remote-api/20988){: target="_blank" class="_"}. ### How do I connect from a container to a service on the host? @@ -58,28 +58,28 @@ Windows has a changing IP address (or none if you have no network access). We re The gateway is also reachable as `gateway.docker.internal`. For more information about the networking features in Docker Desktop for Windows, see -[Networking](/docker-for-windows/networking/). +[Networking](networking.md). ### How do I connect to a container from Windows? We recommend that you publish a port, or connect from another container. You can use the same method on Linux if the container is on an overlay network and not a bridge network, as these are not routed. For more information and examples, see -[I want to connect to a container from Windows](networking.md#i-want-to-connect-to-a-container-from-windows) in the [Networking](/docker-for-windows/networking/) topic. +[I want to connect to a container from Windows](networking.md#i-want-to-connect-to-a-container-from-windows) in the [Networking](networking.md) topic. ## Volumes ### Can I change permissions on shared volumes for container-specific deployment requirements? No, at this point, Docker Desktop does not enable you to control (`chmod`) -the Unix-style permissions on [shared volumes](/docker-for-windows#shared-drives) for +the Unix-style permissions on [shared volumes](index.md#file-sharing) for deployed containers, but rather sets permissions to a default value of [0777](http://permissions-calculator.org/decode/0777/){: target="_blank" class="_"} (`read`, `write`, `execute` permissions for `user` and for `group`) which is not configurable. For workarounds and to learn more, see -[Permissions errors on data directories for shared volumes](troubleshoot#permissions-errors-on-data-directories-for-shared-volumes). +[Permissions errors on data directories for shared volumes](troubleshoot.md#permissions-errors-on-data-directories-for-shared-volumes). ### How do symlinks work on Windows? @@ -96,11 +96,11 @@ Docker Desktop supports all trusted Certificate Authorities (CAs) (root or intermediate). Docker recognizes certs stored under Trust Root Certification Authorities or Intermediate Certification Authorities. - For more information on adding server and client side certs, see [Add TLS certificates](/docker-for-windows/index/#add-tls-certificates) in the Getting Started topic. + For more information on adding server and client side certs, see [Adding TLS certificates](index.md#adding-tls-certificates) in the Getting Started topic. ### How do I add client certificates? -For information on adding client certificates, see [Add TLS certificates](/docker-for-windows/index/#add-tls-certificates) in the Getting Started topic. +For information on adding client certificates, see [Adding TLS certificates](index.md#adding-tls-certificates) in the Getting Started topic. ### Can I pass through a USB device to a container? @@ -125,7 +125,7 @@ You can find a tutorial about running Windows containers on Windows Server in ### Can I install Docker Desktop on Windows 10 Home? -Windows 10 Insider Preview (Windows 10 Home) users can now install [Docker Desktop Edge 2.2.2.0](https://download.docker.com/win/edge/43066/Docker%20Desktop%20Installer.exe) or a later release with the [experimental WSL 2 support](/docker-for-windows/wsl-tech-preview/). This requires Windows Insider Preview Build 19018 or later. +Windows 10 Insider Preview (Windows 10 Home) users can now install [Docker Desktop Edge 2.2.2.0](https://download.docker.com/win/edge/43066/Docker%20Desktop%20Installer.exe) or a later release with the [experimental WSL 2 support](wsl-tech-preview.md). This requires Windows Insider Preview Build 19018 or later. Docker Desktop Stable releases require the Hyper-V feature which is not available in the Windows 10 Home edition. @@ -136,7 +136,7 @@ Docker Desktop uses the Windows Hyper-V features. While older Windows versions h ### 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](/docker-for-windows/troubleshoot/#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.md#docker-desktop-fails-to-start-when-anti-virus-software-is-installed) in [Troubleshooting](troubleshoot.md). ## Feedback @@ -150,7 +150,7 @@ functionality you'd like to see added. ### What if I have problems or questions? -You can find information about diagnosing and troubleshooting common issues in the [Logs and Troubleshooting](troubleshoot) topic. +You can find information about diagnosing and troubleshooting common issues in the [Logs and Troubleshooting](troubleshoot.md) topic. If you do not find a solution in Troubleshooting, browse issues on [Docker Desktop for Windows issues on GitHub](https://github.com/docker/for-win/issues){: target="_blank" class="_"} diff --git a/docker-for-windows/index.md b/docker-for-windows/index.md index 9d9b4ff4f3..4a25ec59d0 100644 --- a/docker-for-windows/index.md +++ b/docker-for-windows/index.md @@ -240,8 +240,8 @@ Note that configuring file sharing is not necessary for Windows containers, only > * Shared drives are designed to allow application code to be edited on the host while being executed in containers. For non-code items such as cache directories or databases, the performance will be much better if they are stored in - the Linux VM, using a [data volume](/engine/tutorials/dockervolumes.md#data-volumes) - (named volume) or [data container](/engine/tutorials/dockervolumes.md#creating-and-mounting-a-data-volume-container). + the Linux VM, using a [data volume](../storage/volumes.md) + (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](troubleshoot.md#permissions-errors-on-data-directories-for-shared-volumes). @@ -308,7 +308,7 @@ Updating these settings requires a reconfiguration and reboot of the Linux VM. The Docker Engine page allows you to configure the Docker daemon to determine how your containers run. Type a JSON configuration file in the box to configure the daemon settings. For a full list of options, see the Docker Engine -[dockerd commandline reference](/engine/reference/commandline/dockerd.md){:target="_blank" +[dockerd commandline reference](/engine/reference/commandline/dockerd/){:target="_blank" class="_"}. Click **Apply & Restart** to save your settings and restart Docker Desktop. @@ -465,10 +465,10 @@ The Docker Desktop Dashboard enables you to interact with containers and applica Select **Sign in /Create Docker ID** from the Docker Desktop menu to access your [Docker Hub](https://hub.docker.com/){: target="_blank" class="_" } account. Once logged in, you can access your Docker Hub repositories directly from the Docker Desktop menu. -For more information, refer to the following [Docker Hub topics](/docker-hub/index.md){: target="_blank" class="_" }: +For more information, refer to the following [Docker Hub topics](../docker-hub/index.md){: target="_blank" class="_" }: -* [Organizations and Teams in Docker Hub](/docker-hub/orgs.md){: target="_blank" class="_" } -* [Builds and Images](/docker-cloud/builds/index.md){: target="_blank" class="_" } +* [Organizations and Teams in Docker Hub](../docker-hub/orgs.md){: target="_blank" class="_" } +* [Builds and Images](../docker-hub/builds/index.md){: target="_blank" class="_" } ### Two-factor authentication @@ -522,19 +522,19 @@ You need to restart Docker Desktop after making any changes to the keychain or to the `~/.docker/certs.d` directory in order for the changes to take effect. The registry cannot be listed as an _insecure registry_ (see -[Docker Daemon](/docker-for-windows#daemon)). Docker Desktop ignores +[Docker Daemon](#docker-engine)). Docker Desktop ignores certificates listed under insecure registries, and does not send client certificates. Commands like `docker run` that attempt to pull from the registry produce error messages on the command line, as well as on the registry. To learn more about how to set the client TLS certificate for verification, see -[Verify repository client with certificates](/engine/security/certificates) +[Verify repository client with certificates](../engine/security/certificates.md) in the Docker Engine topics. ## Where to go next -* Try out the walkthrough at [Get Started](/get-started/){: target="_blank" class="_"}. +* Try out the walkthrough at [Get Started](../get-started/index.md){: target="_blank" class="_"}. * Dig in deeper with [Docker Labs](https://github.com/docker/labs/) example walkthroughs and source code. -* Refer to the [Docker CLI Reference Guide](/engine/api.md){: target="_blank" class="_"}. +* Refer to the [Docker CLI Reference Guide](/engine/reference/commandline/cli/){: target="_blank" class="_"}. diff --git a/docker-for-windows/install.md b/docker-for-windows/install.md index cb24abc240..e0444afb20 100644 --- a/docker-for-windows/install.md +++ b/docker-for-windows/install.md @@ -39,9 +39,9 @@ used side-by-side with Docker Desktop. However, you can still use ### What's included in the installer -The Docker Desktop installation includes [Docker Engine](/engine/index.md), -Docker CLI client, [Docker Compose](/compose/index.md), -[Notary](/notary/getting_started.md), +The Docker Desktop installation includes [Docker Engine](../engine/index.md), +Docker CLI client, [Docker Compose](../compose/index.md), +[Notary](../notary/getting_started.md), [Kubernetes](https://github.com/kubernetes/kubernetes/), and [Credential Helper](https://github.com/docker/docker-credential-helpers/). @@ -59,7 +59,7 @@ more information, see [Running Docker Desktop in nested virtualization scenarios Looking for information on using Windows containers? -* [Switch between Windows and Linux containers](/docker-for-windows/index.md#switch-between-windows-and-linux-containers) +* [Switch between Windows and Linux containers](index.md#switch-between-windows-and-linux-containers) describes how you can toggle between Linux and Windows containers in Docker Desktop and points you to the tutorial mentioned above. * [Getting Started with Windows Containers (Lab)](https://github.com/docker/labs/blob/master/windows/windows-containers/README.md) provides a tutorial on how to set up and run Windows containers on Windows 10, Windows Server 2016 and Windows Server 2019. It shows you how to use a MusicStore application @@ -95,7 +95,7 @@ When the whale icon in the status bar stays steady, Docker Desktop is up-and-run ![whale on taskbar](images/whale-icon-systray.png) If the whale icon is hidden in the Notifications area, click the up arrow on the -taskbar to show it. To learn more, see [Docker Settings](/docker-for-windows/index.md#docker-settings-dialog). +taskbar to show it. To learn more, see [Docker Settings](index.md#docker-settings-dialog). After installing the Docker Desktop app, you also get a pop-up success message with suggested next steps, and a link to this documentation. diff --git a/docker-for-windows/networking.md b/docker-for-windows/networking.md index ec8789f012..fb2f1b2247 100644 --- a/docker-for-windows/networking.md +++ b/docker-for-windows/networking.md @@ -108,5 +108,5 @@ container to random ports on the host. $ docker run -d -P --name webserver nginx ``` -See the [run command](/engine/reference/commandline/run.md) for more details on +See the [run command](../engine/reference/commandline/run.md) for more details on publish options used with `docker run`. diff --git a/docker-for-windows/release-notes.md b/docker-for-windows/release-notes.md index 50f53034e0..bf936050ed 100644 --- a/docker-for-windows/release-notes.md +++ b/docker-for-windows/release-notes.md @@ -86,7 +86,7 @@ For information about Edge releases, see the [Edge release notes](edge-release-n - Fixed a race condition when starting the WSL engine which caused Docker Desktop to incorrectly report that the containers have exited. Fixes [docker/for-win#5607](https://github.com/docker/for-win/issues/5607). - Fixed an issue where editing code inside a container resulted in an error. Fixes [docker/for-win#5528](https://github.com/docker/for-win/issues/5528). - Fixed a bug where running the command `DockerCli.exe -SharedDrives` failed to display a list of drives that are shared. Fixes [docker/for-win#5625](https://github.com/docker/for-win/issues/5625). -- Starting with Docker Desktop 2.2.0.3, you must access all shared files using their original case. For example, if you have created a file called `test`, you must open it as `test`. Attempts to open the file as `Test` will fail with the error `No such file or directory`. For more information, see _Tips on shared drives, permissions, and volume mounts_ in [File sharing](/docker-for-windows/index/#file-sharing). +- Starting with Docker Desktop 2.2.0.3, you must access all shared files using their original case. For example, if you have created a file called `test`, you must open it as `test`. Attempts to open the file as `Test` will fail with the error `No such file or directory`. For more information, see _Tips on shared drives, permissions, and volume mounts_ in [File sharing](index.md#file-sharing). ### Known issues diff --git a/docker-for-windows/troubleshoot.md b/docker-for-windows/troubleshoot.md index 98af93129f..9be6b85786 100644 --- a/docker-for-windows/troubleshoot.md +++ b/docker-for-windows/troubleshoot.md @@ -22,7 +22,7 @@ The Troubleshoot page contains the following options: * **Run Diagnostics**: Select this option to diagnose any issues on Docker Desktop. For detailed information about diagnostics, see [Diagnose problems, send feedback, and create GitHub issues](#diagnose-problems-send-feedback-and-create-github-issues). -* **Reset Kubernetes cluster**: Select this option to delete all stacks and Kubernetes resources. For more information, see [Kubernetes](/docker-for-windows/index/#kubernetes). +* **Reset Kubernetes cluster**: Select this option to delete all stacks and Kubernetes resources. For more information, see [Kubernetes](index.md#kubernetes). * **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. @@ -125,7 +125,7 @@ in the FAQs. 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), +cannot start, such as when using [Docker Compose](../compose/gettingstarted.md), you might need to enable [shared drives](index.md#shared-drives). Volume mounting requires shared drives for Linux containers (not for Windows @@ -183,15 +183,15 @@ In the subsequent screen, verify that Hyper-V is enabled: The Docker Desktop installation includes the legacy tool Docker Machine which uses the old [`boot2docker.iso`](https://github.com/boot2docker/boot2docker){:target="_blank" class="_"}, -and the [Microsoft Hyper-V driver](/machine/drivers/hyper-v.md) to create local +and the [Microsoft Hyper-V driver](../machine/drivers/hyper-v.md) to create local virtual machines. _This is tangential to using Docker Desktop_, but if you want to use Docker Machine to create multiple local Virtual Machines (VMs), or to provision remote machines, see the -[Docker Machine](/machine/index.md) topics. This is documented only for users looking for information about Docker Machine on Windows, which requires that Hyper-V is enabled, an external network switch is active, and referenced in the flags for the `docker-machine create` command -as described in the [Docker Machine driver example](/machine/drivers/hyper-v.md#example). +[Docker Machine](../machine/index.md) topics. This is documented only for users looking for information about Docker Machine on Windows, which requires that Hyper-V is enabled, an external network switch is active, and referenced in the flags for the `docker-machine create` command +as described in the [Docker Machine driver example](../machine/drivers/hyper-v.md#example). #### Virtualization must be enabled -In addition to [Hyper-V](#hyper-v) or [WSL 2](/docker-for-windows/wsl-tech-preview.md), virtualization must be enabled. Check the +In addition to [Hyper-V](#hyper-v) or [WSL 2](wsl-tech-preview.md), virtualization must be enabled. Check the Performance tab on the Task Manager: ![Task Manager](images/virtualization-enabled.png){:width="700px"} @@ -224,9 +224,9 @@ Here are some steps to take if you experience similar problems: ![Hyper-V manager](images/hyperv-manager.png) 4. Set up an external network switch. If you plan at any point to use - [Docker Machine](/machine/overview.md) to set up multiple local VMs, you + [Docker Machine](../machine/overview.md) to set up multiple local VMs, you need this anyway, as described in the topic on the - [Hyper-V driver for Docker Machine](/machine/drivers/hyper-v.md#example). + [Hyper-V driver for Docker Machine](../machine/drivers/hyper-v.md#example). You can replace `DockerNAT` with this switch. 5. If previous steps fail to solve the problems, follow steps on the @@ -241,7 +241,7 @@ Here are some steps to take if you experience similar problems: ### Windows containers and Windows Server Docker Desktop is not supported on Windows Server. Instead, you can use -[Docker Enterprise Basic](/ee/index.md) at no additional cost. +Docker Enterprise Basic at no additional cost. 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). @@ -284,7 +284,7 @@ Linux containers). To reach a Windows container from the local host, you need to specify the IP address and port for the container that is running the service. -You can get the container IP address by using [`docker inspect`](/engine/reference/commandline/inspect.md) with some `--format` options +You can get the container IP address by using [`docker inspect`](../engine/reference/commandline/inspect.md) with some `--format` options and the ID or name of the container. For the example above, the command would look like this, using the name we gave to the container (`webserver`) instead of the container ID: