Skip to content
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

Config option "mirrored" networking mode need adequate documentation (23H2) #1934

Open
Boilerplate4u opened this issue Mar 12, 2024 · 1 comment
Assignees

Comments

@Boilerplate4u
Copy link

Boilerplate4u commented Mar 12, 2024

Documentation Issue

While the "mirrored" networking mode in WSL may offer several advantages over the old configuration options, it lacks in-depth documentation on how to set up more advanced configurations like a network bridge. This aspect of the documentation requires urgent improvement.

For example, a network bridge in the context of WSL allows the instance to appear as a separate device on the physical network, offering several benefits:

  • Direct external access: Devices on your network can communicate directly with the WSL instance using its own IP address.

  • Enhanced services: You can run services within WSL (e.g., web servers, databases) that are accessible from other devices on the network without complex port forwarding.

  • Flexible network scenarios: Bridging enables more advanced networking setups, potentially useful for development and testing.

Why the documentation needs improvement:

  • Focus on basic mirrored mode: Most documentation centers around enabling the base "mirrored" mode without going into the complexities of bridging like how the interfaces are interconneced, etc.

  • Lack of clear examples: There aren't enough practical, step-by-step guides on how to create a functional bridge for common use cases.

  • Assumption of internal expertise: The current resources expect users to have a deep understanding of WSL internals and Linux networking tools and bridging concepts.

Link to documentation page

https://learn.microsoft.com/en-us/windows/wsl/networking

Suggested Improvements

Why the documentation needs improvement:

  • Focus on basic mirrored mode: Most documentation centers around enabling the base "mirrored" mode without going into the complexities of bridging like how the interfaces are interconneced, etc.

  • Lack of clear examples: There aren't enough practical, step-by-step guides on how to create a functional bridge for common use cases.

  • Assumption of internal expertise: The current resources expect users to have a deep understanding of WSL internals and Linux networking tools and bridging concepts.

@Boilerplate4u Boilerplate4u changed the title Config option "mirrored" networking mode need adequate documentation. Config option "mirrored" networking mode need adequate documentation (23H2) Mar 12, 2024
@craigloewen-msft
Copy link
Collaborator

Tagging @chanpreetdhanjal for visibility

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants