Skip to content

Commit a9a6c22

Browse files
Docs for Windows Home support and QSG (docker#10669)
* - Added a new topic to describe how to install Desktop on Windows Home machines. - Update installation instructions on Windows/Mac topics - Removed references to Toolbox from the Install topics - Updated the Install pages to add info on the new onboarding tutorial on startup * Update docker-for-windows/install-windows-home.md Co-authored-by: Stefan Scherer <stefan.scherer@docker.com> * Update docker-for-windows/install-windows-home.md Co-authored-by: Stefan Scherer <stefan.scherer@docker.com> * Update docker-for-windows/install-windows-home.md Co-authored-by: Stefan Scherer <stefan.scherer@docker.com> * Update docker-for-windows/install-windows-home.md Co-authored-by: Stefan Scherer <stefan.scherer@docker.com> * move WSL 2 req above Hyper-V reqs * Add info on purge container data Co-authored-by: Stefan Scherer <stefan.scherer@docker.com>
1 parent ccf78b9 commit a9a6c22

File tree

9 files changed

+166
-28
lines changed

9 files changed

+166
-28
lines changed

_data/toc.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1150,6 +1150,8 @@ manuals:
11501150
section:
11511151
- path: /docker-for-windows/install/
11521152
title: Install Docker Desktop for Windows
1153+
- path: /docker-for-windows/install-windows-home/
1154+
title: Install Docker Desktop on Windows Home
11531155
- path: /docker-for-windows/
11541156
title: Getting started
11551157
- path: /docker-for-windows/kubernetes/
478 KB
Loading

docker-for-mac/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,8 @@ On the **General** tab, you can configure when to start and update Docker:
117117
118118
- **Send usage statistics**: Docker Desktop sends diagnostics, crash reports, and usage data. This information helps Docker improve and troubleshoot the application. Clear the check box to opt out.
119119
120+
Click **Switch to the Edge version** to learn more about Docker Desktop Edge releases.
121+
120122
### Resources
121123
122124
The **Resources** tab allows you to configure CPU, memory, disk, proxies, network, and other resources.

docker-for-mac/install.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,19 +62,13 @@ The Docker Desktop installation includes
6262

6363
![Docker app in Hockeyapp](images/docker-app-in-apps.png)
6464

65-
You are prompted to authorize `Docker.app` with your system password after you launch it.
66-
Privileged access is needed to install networking components and links to the Docker apps.
67-
6865
The Docker menu in the top status bar indicates that Docker Desktop is running, and accessible from a terminal.
6966

7067
![Whale in menu bar](images/whale-in-menu-bar.png)
7168

72-
If you just installed the app, you also get a message with suggested
73-
next steps and a link to the documentation. Click the Docker menu (![whale
74-
menu](images/whale-x.png){: .inline}) in the status bar to
75-
dismiss this pop-up notification.
69+
If you've just installed the app, Docker Desktop launches the onboarding tutorial. The tutorial includes a simple exercise to build an example Docker image, run it as a container, push and save the image to Docker Hub.
7670

77-
![Startup information](images/mac-install-success.png)
71+
![Docker Quick Start tutorial](images/docker-tutorial-mac.png)
7872

7973
3. Click the Docker menu (![whale menu](images/whale-x.png){: .inline}) to see
8074
**Preferences** and other options.
Loading

docker-for-windows/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,8 @@ main Docker menu.
201201
crash reports, and usage data. This information helps Docker improve and
202202
troubleshoot the application. Clear the check box to opt out. Docker may periodically prompt you for more information.
203203
204+
Click **Switch to the Edge version** to learn more about Docker Desktop Edge releases.
205+
204206
### Resources
205207
206208
The **Resources** tab allows you to configure CPU, memory, disk, proxies, network, and other resources.
Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
---
2+
description: How to install Docker Desktop on Windows 10 Home
3+
keywords: Windows 10 Home, Home, Windows, install, download, run, Docker, local
4+
title: Install Docker Desktop on Windows Home
5+
---
6+
7+
You can now install Docker Desktop on Windows Home machines using the WSL 2 backend. Docker Desktop on Windows Home is a full version of Docker Desktop for Linux container development.
8+
9+
This page contains information on installing Docker Desktop on Windows 10 Home. If you are looking for information about installing Docker Desktop on Windows 10 Pro, Enterprise, or Education, see [Install Docker Desktop on Windows](/install.md).
10+
11+
[Download from Docker Hub](Add URL){:
12+
.button .outline-btn}
13+
14+
Docker Desktop on Windows Home offers the following benefits:
15+
16+
- Latest version of Docker on your Windows Home machine
17+
- Install Kubernetes in one click on Windows Home
18+
- Integrated UI to view and manage your running containers
19+
- Start Docker Desktop in less than ten seconds
20+
- Use Linux Workspaces
21+
- Dynamic resource and memory allocation
22+
- Networking stack, support for http proxy settings, and trusted CA synchronization
23+
24+
For detailed information about WSL 2, see [Docker Desktop WSL 2 backend](/wsl-tech-preview.md)
25+
26+
## What to know before you install
27+
28+
### System Requirements
29+
30+
Windows 10 Home machines must meet the following requirements to install Docker Desktop:
31+
32+
- Install Windows 10 Insider Preview build 19041 or higher.
33+
- Enable the WSL 2 feature on Windows. For detailed instructions, refer to the [Microsoft documentation](https://docs.microsoft.com/windows/wsl/wsl2-install).
34+
- The following hardware prerequisites are required to successfully run
35+
WSL 2 on Windows 10 Home:
36+
37+
- 64 bit processor with [Second Level Address Translation (SLAT)](http://en.wikipedia.org/wiki/Second_Level_Address_Translation)
38+
- 4GB system RAM
39+
- BIOS-level hardware virtualization support must be enabled in the
40+
BIOS settings. For more information, see
41+
[Virtualization](troubleshoot.md#virtualization-must-be-enabled).
42+
- Download and install the [Linux kernel update package](https://docs.microsoft.com/windows/wsl/wsl2-kernel).
43+
44+
> **Note**
45+
>
46+
> Docker supports Docker Desktop on Windows based on Microsoft’s support lifecycle for Windows 10 operating system. For more information, see the [Windows lifecycle fact sheet](https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet).
47+
48+
### What's included in the installer
49+
50+
The Docker Desktop installation includes [Docker Engine](/engine/index.md),
51+
Docker CLI client, [Docker Compose](/compose/index.md),
52+
[Notary](/notary/getting_started.md),
53+
[Kubernetes](https://github.com/kubernetes/kubernetes/),
54+
and [Credential Helper](https://github.com/docker/docker-credential-helpers/).
55+
56+
Nested virtualization scenarios, such as running Docker Desktop on a
57+
VMWare or Parallels instance might work, but there are no guarantees. For
58+
more information, see [Running Docker Desktop in nested virtualization scenarios](troubleshoot.md#running-docker-desktop-for-windows-in-nested-virtualization-scenarios).
59+
60+
## Install Docker Desktop on Windows 10 Home
61+
62+
1. Double-click **Docker Desktop Installer.exe** to run the installer.
63+
64+
If you haven't already downloaded the installer (`Docker Desktop Installer.exe`), you can get it from
65+
[**Docker Hub**](https://hub.docker.com/editions/community/docker-ce-desktop-windows/).
66+
It typically downloads to your `Downloads` folder, or you can run it from
67+
the recent downloads bar at the bottom of your web browser.
68+
69+
2. When prompted, ensure the **Enable WSL 2 Features** option is selected on the Configuration page.
70+
71+
3. Follow the instructions on the installation wizard authorize the installer and proceed with the install.
72+
73+
4. When the installation is successful, click **Close** to complete the installation process.
74+
75+
## Start Docker Desktop
76+
77+
Docker Desktop does not start automatically after installation. To start Docker Desktop, search for Docker, and select **Docker Desktop** in the search results.
78+
79+
![search for Docker app](images/docker-app-search.png){:width="300px"}
80+
81+
When the whale icon in the status bar stays steady, Docker Desktop is up-and-running, and is accessible from any terminal window.
82+
83+
![whale on taskbar](images/whale-icon-systray.png)
84+
85+
When the initialization is complete, Docker Desktop launches the onboarding tutorial. The tutorial includes a simple exercise to build an example Docker image, run it as a container, push and save the image to Docker Hub.
86+
87+
![Docker Quick Start tutorial](images/docker-tutorial-win.png){:width="450px"}
88+
89+
Congratulations! You are now successfully running Docker Desktop on Windows Home.
90+
91+
## Uninstall Docker Desktop
92+
93+
To uninstall Docker Desktop from your Windows Home machine:
94+
95+
1. From the Windows **Start** menu, select **Settings** > **Apps** > **Apps & features**.
96+
2. Select **Docker Desktop** from the **Apps & features** list and then select **Uninstall**.
97+
3. Click **Uninstall** to confirm your selection.
98+
99+
> **Note**
100+
>
101+
> Uninstalling Docker Desktop will destroy Docker containers and images local to the machine and remove the files generated by the application.
102+
103+
## Switch between Stable and Edge versions
104+
105+
Docker Desktop allows you to switch between Stable and Edge releases. However, **you can only have one version of Docker Desktop installed at a time**. Switching between Stable and Edge versions can destabilize your development environment, particularly in cases where you switch from a newer (Edge) channel to an older (Stable) channel.
106+
107+
For example, containers created with a newer Edge version of Docker Desktop may
108+
not work after you switch back to Stable because they may have been created
109+
using Edge features that aren't in Stable yet. Keep this in mind as
110+
you create and work with Edge containers, perhaps in the spirit of a playground
111+
space where you are prepared to troubleshoot or start over.
112+
113+
To safely switch between Edge and Stable versions, ensure you save images and export the containers you need, then uninstall the current version before installing another. For more information, see the section _Save and Restore data_ below.
114+
115+
### Save and restore data
116+
117+
You can use the following procedure to save and restore images and container data. For example, if you want to switch between Edge and Stable, or to reset your VM disk:
118+
119+
1. Use `docker save -o images.tar image1 [image2 ...]` to save any images you
120+
want to keep. See [save](/engine/reference/commandline/save) in the Docker
121+
Engine command line reference.
122+
123+
2. Use `docker export -o myContainner1.tar container1` to export containers you
124+
want to keep. See [export](/engine/reference/commandline/export) in the
125+
Docker Engine command line reference.
126+
127+
3. Uninstall the current version of Docker Desktop and install a different version (Stable or Edge), or reset your VM disk.
128+
129+
4. Use `docker load -i images.tar` to reload previously saved images. See
130+
[load](/engine/reference/commandline/load) in the Docker Engine.
131+
132+
5. Use `docker import -i myContainer1.tar` to create a file system image
133+
corresponding to the previously exported containers. See
134+
[import](/engine/reference/commandline/import) in the Docker Engine.
135+
136+
For information on how to back up and restore data volumes, see [Backup, restore, or migrate data volumes](/storage/volumes/#backup-restore-or-migrate-data-volumes).
137+
138+
## Where to go next
139+
140+
* [Getting started](index.md) introduces Docker Desktop for Windows.
141+
* [Get started with Docker](/get-started/) is a tutorial that teaches you how to
142+
deploy a multi-service stack.
143+
* [Troubleshooting](troubleshoot.md) describes common problems, workarounds, and
144+
how to get support.
145+
* [FAQs](faqs.md) provides answers to frequently asked questions.
146+
* [Stable Release Notes](release-notes.md) or [Edge Release Notes](edge-release-notes.md).

docker-for-windows/install.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ title: Install Docker Desktop on Windows
77
Docker Desktop for Windows is the [Community](https://www.docker.com/community-edition) version of Docker for Microsoft Windows.
88
You can download Docker Desktop for Windows from Docker Hub.
99

10+
This page contains information on installing Docker Desktop on Windows 10 Pro, Enterprise, and Education. If you are looking for information about installing Docker Desktop on Windows 10 Home, see [Install Docker Desktop on Windows Home](/install-windows-home.md).
11+
1012
[Download from Docker
1113
Hub](https://hub.docker.com/editions/community/docker-ce-desktop-windows/){:
1214
.button .outline-btn}
@@ -30,13 +32,6 @@ Hyper-V on Windows 10:
3032

3133
> **Note:** Docker supports Docker Desktop on Windows based on Microsoft’s support lifecycle for Windows 10 operating system. For more information, see the [Windows lifecycle fact sheet](https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet).
3234
33-
**README for Docker Toolbox and Docker Machine users**: Microsoft Hyper-V is required to run Docker Desktop. The Docker Desktop Windows installer enables Hyper-V if required, and restarts your machine. When Hyper-V is enabled, VirtualBox no longer works. However, any existing VirtualBox VM images are retained.
34-
35-
VirtualBox VMs created with `docker-machine` (including the `default` one
36-
typically created during Toolbox install) no longer start. These VMs cannot be
37-
used side-by-side with Docker Desktop. However, you can still use
38-
`docker-machine` to manage remote VMs.
39-
4035
### What's included in the installer
4136

4237
The Docker Desktop installation includes [Docker Engine](../engine/index.md),
@@ -47,7 +42,7 @@ and [Credential Helper](https://github.com/docker/docker-credential-helpers/).
4742

4843
Containers and images created with Docker Desktop are shared between all
4944
user accounts on machines where it is installed. This is because all Windows
50-
accounts use the same VM to build and run containers.
45+
accounts use the same VM to build and run containers. Note that it is not possible to share containers and images between user accounts when using the Docker Desktop WSL 2 backend.
5146

5247
Nested virtualization scenarios, such as running Docker Desktop on a
5348
VMWare or Parallels instance might work, but there are no guarantees. For
@@ -76,19 +71,17 @@ Looking for information on using Windows containers?
7671
It typically downloads to your `Downloads` folder, or you can run it from
7772
the recent downloads bar at the bottom of your web browser.
7873

79-
2. Follow the instructions on the installation wizard to accept the license, authorize the installer, and proceed with the install.
74+
2. When prompted, ensure the **Enable Hyper-V Windows Features** option is selected on the Configuration page.
8075

81-
When prompted, authorize the Docker Desktop Installer with your system password during the
82-
install process. Privileged access is needed to install networking
83-
components, links to the Docker apps, and manage the Hyper-V VMs.
76+
3. Follow the instructions on the installation wizard to authorize the installer and proceed with the install.
8477

85-
3. Click **Finish** on the setup complete dialog and launch the Docker Desktop application.
78+
4. When the installation is successful, click **Close** to complete the installation process.
8679

8780
## Start Docker Desktop
8881

8982
Docker Desktop does not start automatically after installation. To start Docker Desktop, search for Docker, and select **Docker Desktop** in the search results.
9083

91-
![search for Docker app](images/docker-app-search.png){:width="400px"}
84+
![search for Docker app](images/docker-app-search.png){:width="300px"}
9285

9386
When the whale icon in the status bar stays steady, Docker Desktop is up-and-running, and is accessible from any terminal window.
9487

@@ -97,14 +90,11 @@ When the whale icon in the status bar stays steady, Docker Desktop is up-and-run
9790
If the whale icon is hidden in the Notifications area, click the up arrow on the
9891
taskbar to show it. To learn more, see [Docker Settings](index.md#docker-settings-dialog).
9992

100-
After installing the Docker Desktop app, you also get a pop-up success message with
101-
suggested next steps, and a link to this documentation.
102-
103-
![Startup information](images/docker-app-welcome.png){:width="400px"}
93+
When the initialization is complete, Docker Desktop launches the onboarding tutorial. The tutorial includes a simple exercise to build an example Docker image, run it as a container, push and save the image to Docker Hub.
10494

105-
When initialization is complete, click the whale icon in the Notifications area and select **About Docker Desktop** to verify that you have the latest version.
95+
![Docker Quick Start tutorial](images/docker-tutorial-win.png){:width="450px"}
10696

107-
Congratulations! You are successfully running Docker Desktop on Windows.
97+
Congratulations! You are now successfully running Docker Desktop on Windows.
10898

10999
## Uninstall Docker Desktop
110100

docker-for-windows/troubleshoot.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ The Troubleshoot page contains the following options:
2222

2323
* **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).
2424

25+
* **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.
26+
2527
* **Reset Kubernetes cluster**: Select this option to delete all stacks and Kubernetes resources. For more information, see [Kubernetes](index.md#kubernetes).
2628

2729
* **Reset to factory defaults**: Choose this option to reset all options on

0 commit comments

Comments
 (0)