Mention mirrored networking mode for WSL #2586
Conversation
Mirrorred networking mode is great for Home Assistant because it allows (among other things) working mDNS device discovery. I think it is incredibly useful so wanted to highlight it. I think that means putting it in a "tip", but there are now 2 tips which is not great. And technically the existing Tip is not needed anymore when Mirrored networking mode is used. Not sure how to better organize it. Suggestions are welcome.
📝 WalkthroughWalkthroughThis update revises the development environment documentation to include a new tip regarding the default networking mode in Windows Subsystem for Linux (WSL). The documentation now explains that the default NAT mode can hinder device discovery and LAN access for Home Assistant, and it recommends the use of the "Mirrored" mode for enhanced functionality, such as multicast support via mDNS. A link to further documentation on enabling the Mirrored mode has also been provided. Changes
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🧰 Additional context used📓 Path-based instructions (6)`*/**(html|markdown|md)`: - For instructional content in doc...
`*/**(html|markdown|md)`: - Use bold to mark UI strings. - I...
`*/**(html|markdown|md)`: - Be brief in your replies and don...
`*/**(html|markdown|md)`: - Use sentence-style capitalizatio...
`*/**(html|markdown|md)`: do not comment on HTML used for ic...
`*/**(html|markdown|md)`: Avoid flagging inline HTML for emb...
🪛 LanguageTooldocs/development_environment.mdx[style] ~111-~111: To elevate your writing, try using a synonym here. (HARD_TO) Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/development_environment.mdx (1)
117-118: Remove redundant hyperlink line.
The standalone URL on these lines duplicates the link already provided in the tip block. Removing it will help avoid clutter and potential confusion.-https://learn.microsoft.com/en-us/windows/wsl/networking#mirrored-mode-networking
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/development_environment.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
`*/**(html|markdown|md)`: - For instructional content in doc...
*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
docs/development_environment.mdx
`*/**(html|markdown|md)`: - Use bold to mark UI strings. - I...
*/**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
docs/development_environment.mdx
`*/**(html|markdown|md)`: - Be brief in your replies and don...
*/**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
docs/development_environment.mdx
`*/**(html|markdown|md)`: - Use sentence-style capitalizatio...
*/**(html|markdown|md): - Use sentence-style capitalization also in headings.
docs/development_environment.mdx
`*/**(html|markdown|md)`: do not comment on HTML used for ic...
*/**(html|markdown|md): do not comment on HTML used for icons
docs/development_environment.mdx
`*/**(html|markdown|md)`: Avoid flagging inline HTML for emb...
*/**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
docs/development_environment.mdx
🪛 LanguageTool
docs/development_environment.mdx
[style] ~111-~111: To elevate your writing, try using a synonym here.
Context: ...over devices on the network and make it hard to access Home Assistant from the LAN. ...
(HARD_TO)
[typographical] ~111-~111: Consider adding a comma after this introductory phrase.
Context: ...cess Home Assistant from the LAN. As an alternative the networking mode can be set to "Mirr...
(AS_A_NN_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - developers-home-assistant
- GitHub Check: Header rules - developers-home-assistant
- GitHub Check: Pages changed - developers-home-assistant
docs/development_environment.mdx
Outdated
| :::tip | ||
| The default networking mode in WSL is NAT. This has some drawbacks like Home Assistant not being able to discover devices on the network and make it hard to access Home Assistant from the LAN. As an alternative the networking mode can be set to "Mirrrored" which will make WSL use the same network interfaces as on the host machine (they even have the same IP) and has benefits like Multicast support which enables device discovery with mDNS. | ||
|
|
||
| Check out the [Mirrored mode networking documentation](https://learn.microsoft.com/en-us/windows/wsl/networking#mirrored-mode-networking) for details on how to enable it. | ||
| ::: |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Refine networking tip wording for clarity and style.
The tip’s wording can be improved by using more authoritative language. Consider replacing phrases like "make it hard to access" with terms like "renders accessing" and adding a comma after the introductory phrase "Alternatively". This will align the tip with the documentation’s direct tone and the Microsoft Style Guide.
[typographical] [style]
-The default networking mode in WSL is NAT. This has some drawbacks like Home Assistant not being able to discover devices on the network and make it hard to access Home Assistant from the LAN. As an alternative the networking mode can be set to "Mirrored" which will make WSL use the same network interfaces as on the host machine (they even have the same IP) and has benefits like Multicast support which enables device discovery with mDNS.
+The default networking mode in WSL is NAT. This mode hinders device discovery and renders accessing Home Assistant from the LAN challenging. Alternatively, the networking mode can be set to **Mirrored**, which causes WSL to use the same network interfaces as the host machine (even sharing the same IP) and enables multicast support for device discovery via mDNS.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| :::tip | |
| The default networking mode in WSL is NAT. This has some drawbacks like Home Assistant not being able to discover devices on the network and make it hard to access Home Assistant from the LAN. As an alternative the networking mode can be set to "Mirrrored" which will make WSL use the same network interfaces as on the host machine (they even have the same IP) and has benefits like Multicast support which enables device discovery with mDNS. | |
| Check out the [Mirrored mode networking documentation](https://learn.microsoft.com/en-us/windows/wsl/networking#mirrored-mode-networking) for details on how to enable it. | |
| ::: | |
| :::tip | |
| The default networking mode in WSL is NAT. This mode hinders device discovery and renders accessing Home Assistant from the LAN challenging. Alternatively, the networking mode can be set to **Mirrored**, which causes WSL to use the same network interfaces as the host machine (even sharing the same IP) and enables multicast support for device discovery via mDNS. | |
| Check out the [Mirrored mode networking documentation](https://learn.microsoft.com/en-us/windows/wsl/networking#mirrored-mode-networking) for details on how to enable it. | |
| ::: |
🧰 Tools
🪛 LanguageTool
[style] ~111-~111: To elevate your writing, try using a synonym here.
Context: ...over devices on the network and make it hard to access Home Assistant from the LAN. ...
(HARD_TO)
[typographical] ~111-~111: Consider adding a comma after this introductory phrase.
Context: ...cess Home Assistant from the LAN. As an alternative the networking mode can be set to "Mirr...
(AS_A_NN_COMMA)
| @@ -107,6 +107,13 @@ When working in WSL make sure to keep all code/repos in the WSL environment to a | |||
| If you find that you cannot open the development instance via [http://localhost:8123](http://localhost:8123) when using WSL, instead, within a WSL terminal, find the `inet` address of the `eth0` adaptor by running `ip addr show eth0`. Then use this address, excluding the CIDR block, to access the development instance, i.e. if your `inet` is listed as `172.20.37.6/20`, use [http://172.20.37.6:8123](http://172.20.37.6:8123). | |||
| ::: | |||
|
|
|||
| :::tip | |||
| The default networking mode in WSL is NAT. This has some drawbacks like Home Assistant not being able to discover devices on the network and make it hard to access Home Assistant from the LAN. Alternatively, the networking mode can be set to "Mirrrored", which will make WSL use the same network interfaces as on the host machine (they even have the same IP) and has benefits like Multicast support which enables device discovery with mDNS. | |||
There was a problem hiding this comment.
Typo: Mirrrored -> Mirrored
Proposed change
Mirrorred networking mode in WSL is great for Home Assistant because it allows (among other things) working mDNS device discovery. Unfortunately it is not the default in WSL and not a lot a people seem to know about it.
I think it is incredibly useful so wanted to highlight it. I think that means putting it in a "tip", but there are now 2 tips which is not great. And technically the existing Tip is not needed anymore when Mirrored networking mode is used.
Not sure how to better organize it. Suggestions are welcome.
Type of change
I don't think any of the bullets match.
Additional information
Summary by CodeRabbit
Summary by CodeRabbit