docs: add macOS Internet Sharing and Parallels Desktop conflicts for Boundary Client Agent #5496
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…Boundary Client Agent Updated the "Conflicting Software" section in the Boundary Client Agent documentation to include issues caused by macOS Internet Sharing and Parallels Desktop (macOS VM with shared networking). These configurations cause the system's DNS resolver to bind to port 53, preventing the Client Agent from starting.
johanbrandhorst
requested changes
Feb 3, 2025
| @@ -537,6 +537,12 @@ Docker Desktop sometimes creates a local DNS listener that prevents the Client A | |||
| If you run Docker Desktop 4.26 or later, you must clear the `Use kernel networking for UDP` option. | |||
| Otherwise, the Client Agent refuses to start. | |||
|
|
|||
| ### Internet Sharing (macOS) | |||
There was a problem hiding this comment.
Whichever casing is correct, we should be consistent. We use MacOS elsewhere in this document, so please us MacOS when describing this OS.
| Enabling Internet Sharing on macOS causes the system's DNS resolver (`mDNSResponder`) to bind to all interfaces on port 53, preventing the Client Agent from starting. Disable Internet Sharing before running the Client Agent. | ||
|
|
||
| ### Parallels Desktop (macOS VM on macOS Host) | ||
| Running a macOS VM in Parallels Desktop with shared networking causes the system's DNS resolver (`mDNSResponder`) to bind to all interfaces, blocking port 53 and preventing the Client Agent from starting. |
There was a problem hiding this comment.
Could we add a short workaround here too? "Configure Parallels Desktop with direct network" or whatever the workaround is, I can't remember 😁.
There was a problem hiding this comment.
Added a workaround.
…ls macOS VM conflict
johanbrandhorst
approved these changes
Feb 12, 2025
Dan-Heath
requested changes
Feb 18, 2025
There was a problem hiding this comment.
Thank you for this update @Mohit0233 ! I suggested a couple minor changes. Please let me know if you have any questions.
Comment on lines
+546
to
+547
| **Workaround:** Configure Parallels Desktop to use a different network mode. | ||
| Go to **Hardware > Network > Source**, and select an alternative network configuration such as **Host-Only, Default Adapter, or Wi-Fi** instead of Shared Network. |
There was a problem hiding this comment.
Suggested change
| **Workaround:** Configure Parallels Desktop to use a different network mode. | |
| Go to **Hardware > Network > Source**, and select an alternative network configuration such as **Host-Only, Default Adapter, or Wi-Fi** instead of Shared Network. | |
| As a workaround, you can configure Parallels Desktop to use a different network mode. | |
| Select an alternative network configuration such as **Host-Only**, **Default Adapter**, or **Wi-Fi** instead of **Shared Network**. | |
| Refer to the Parallels Desktop documentation for more information. |
There was a problem hiding this comment.
I'd suggest that we refer users to the Parallels documentation instead of providing explicit steps for configuring this, in case they change it in a future version.
| @@ -537,6 +537,15 @@ Docker Desktop sometimes creates a local DNS listener that prevents the Client A | |||
| If you run Docker Desktop 4.26 or later, you must clear the `Use kernel networking for UDP` option. | |||
| Otherwise, the Client Agent refuses to start. | |||
|
|
|||
| ### Internet Sharing (MacOS) | |||
| Enabling Internet Sharing on MacOS causes the system's DNS resolver (`mDNSResponder`) to bind to all interfaces on port 53, preventing the Client Agent from starting. Disable Internet Sharing before running the Client Agent. | |||
There was a problem hiding this comment.
Suggested change
| Enabling Internet Sharing on MacOS causes the system's DNS resolver (`mDNSResponder`) to bind to all interfaces on port 53, preventing the Client Agent from starting. Disable Internet Sharing before running the Client Agent. | |
| Enabling **Internet Sharing** on MacOS causes the system's DNS resolver (`mDNSResponder`) to bind to all interfaces on port 53, preventing the Client Agent from starting. Disable **Internet Sharing** before you run the Client Agent. |
There was a problem hiding this comment.
I think we can bold this, since it's the actual name of the setting in the UI.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated the "Conflicting Software" section in the Boundary Client Agent documentation to include issues caused by macOS Internet Sharing and Parallels Desktop (macOS VM with shared networking). These configurations cause the system's DNS resolver to bind to port 53, preventing the Client Agent from starting.