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.

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

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

chaomonica
Copy link
Contributor

@chaomonica chaomonica commented Jun 11, 2025

Description

Many customer escalations involving Docker Desktop on Windows involve WSL. While we have internal documentation for for troubleshooting/installation, these do not exist on our public facing docs.

Related issues or tickets

SEG-574 (Slack thread linked in ticket for context)

Reviews

Please do not merge until after technical review!

Copy link

netlify bot commented Jun 11, 2025

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 4e416a3
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/684c7066395a0f0008224880
😎 Deploy Preview https://deploy-preview-22825--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions bot added the area/desktop Issue affects a desktop edition of Docker. E.g docker for mac label Jun 11, 2025
@karman-docker
Copy link
Contributor

@chelnak could you also have a look please whenever you can ? Motivation here is, many customers get stuck in WSL install step or complain about non-admin users getting UAC prompts. Hence we thought a this brief section before the install section.

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

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

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

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

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

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

Choose a reason for hiding this comment

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

LGTM, thank you.

@chaomonica chaomonica requested a review from chelnak June 16, 2025 14:26
Copy link
Contributor

@chelnak chelnak left a comment

Choose a reason for hiding this comment

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

Thank you!

@chaomonica chaomonica marked this pull request as ready for review June 16, 2025 15:20
@chaomonica chaomonica requested a review from aevesdocker as a code owner June 16, 2025 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/desktop Issue affects a desktop edition of Docker. E.g docker for mac
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants