Skip to content

docs: Added section for WSL installation and verification #22825

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jun 23, 2025
Merged

docs: Added section for WSL installation and verification #22825

Changes from 6 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
27b2476
Added instructions for WSL installation
chaomonica Jun 11, 2025
1286b7c
Updated after linter feedback
chaomonica Jun 11, 2025
1e02e03
Updated after linter feedback
chaomonica Jun 11, 2025
a9d0db1
Added note on installer flag
chaomonica Jun 12, 2025
7032351
Fix linter feedback
chaomonica Jun 12, 2025
7395a76
Add s
chaomonica Jun 12, 2025
1e590f0
Add new section after feedback
chaomonica Jun 13, 2025
4ae3ec0
Change order of sections to prevent confusion
chaomonica Jun 13, 2025
e29e731
Respond to linter feedback
chaomonica Jun 13, 2025
4a706b9
Respond to linter feedback
chaomonica Jun 13, 2025
bf6a27d
Fix installer flag quotes
chaomonica Jun 13, 2025
4e416a3
Fix link
chaomonica Jun 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions content/manuals/desktop/setup/install/windows-install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,41 @@

{{< /accordion >}}

## Verifying system requirements

### WSL: Verification and Setup

Check warning on line 163 in content/manuals/desktop/setup/install/windows-install.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Docker.HeadingSentenceCase] Use sentence case for headings: 'WSL: Verification and Setup'.

Raw Output:
{"message": "[Docker.HeadingSentenceCase] Use sentence case for headings: 'WSL: Verification and Setup'.", "location": {"path": "content/manuals/desktop/setup/install/windows-install.md", "range": {"start": {"line": 163, "column": 5}}}, "severity": "WARNING"}

If you have chosen to use WSL, first verify that your installed version meets system requirements by running the following command in your terminal:

```console
wsl --version
```

If version details do not appear, you are likely using the inbox version of WSL. This version does not support modern capabilities and must be updated.

You can update or install WSL using one of the following methods:

#### Option 1: Install or update WSL via the terminal

Check warning on line 175 in content/manuals/desktop/setup/install/windows-install.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Docker.HeadingLength] Try to keep headings short (< 8 words).

Raw Output:
{"message": "[Docker.HeadingLength] Try to keep headings short (\u003c 8 words).", "location": {"path": "content/manuals/desktop/setup/install/windows-install.md", "range": {"start": {"line": 175, "column": 6}}}, "severity": "INFO"}

1. Open PowerShell or Windows Command Prompt in administrator mode.
2. Run either the install or update command. You may be prompted to restart your machine. For more information, refer to [Install WSL](https://learn.microsoft.com/en-us/windows/wsl/install).
```console
wsl --install

wsl --update
```

#### Option 2: Install WSL via the MSI package

If Microsoft Store access is blocked due to security policies:
1. Go to the official WSL GitHub Releases page: https://github.com/microsoft/WSL/releases
2. Download the `.msi` installer from the latest stable release (under the Assets drop-down).
3. Run the downloaded installer and follow the setup instructions.

### Adjust installation based on user's administrator access
Copy link
Contributor

@chelnak chelnak Jun 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not quite sure about this one.

When in WSL mode, you only activate the Windows Service if you select "Add the *.docker.internal names to the host's /etc/hosts file (Requires password)" from settings.

Copy link
Contributor Author

@chaomonica chaomonica Jun 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Craig, I'll double check this on a VM.

Copy link
Contributor Author

@chaomonica chaomonica Jun 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see that UAC prompt appears in the scenario you mentioned and oops, I missed the part on "com.docker.service is required by Windows containers and Hyper-V backend".

I'll run through installation again tomorrow and fix this. Thanks again @chelnak!

Copy link
Contributor

@karman-docker karman-docker Jun 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chaomonica / @chelnak we can word it something like this:

Title can be "Administrator Privileges and Installation Requirements", since this is generic, it can be outside the "WSL: Verification and Setup" section.

Installing Docker Desktop requires administrator privileges. However, once installed, it can be used without administrative access. Some actions, though, still need elevated permissions. For details, see [Understand permission requirements for Windows].

If your users do not have administrator rights and plan to perform operations that require elevated privileges, be sure to install Docker Desktop using the --always-run-service installer flag. This ensures those actions can still be executed without prompting for UAC elevation.

Copy link
Contributor Author

@chaomonica chaomonica Jun 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chelnak I've updated the "Administrator Privileges and Installation Requirements" with @karman-docker 's section above and additionally moved this section ahead of the WSL sections to avoid confusion.

Copy link
Contributor

@karman-docker karman-docker Jun 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you.


Note down if Docker Desktop will be used by non-administrator users. If so, consider using the `--always-run-service` installer flag. This will prevent the `com.docker.service` service from prompting non-administrator users with a User Account Control (UAC) elevation prompt when using Docker Desktop. See [Installer Flags](#installer-flags) for more details.

## Install Docker Desktop on Windows

> [!TIP]
Expand Down
Loading