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

docs: add macOS Internet Sharing and Parallels Desktop conflicts for Boundary Client Agent #5496

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Mohit0233
Copy link
Contributor

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.

…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.
@Mohit0233 Mohit0233 requested review from a team as code owners January 29, 2025 19:31
@Mohit0233 Mohit0233 self-assigned this Jan 29, 2025
Copy link
Collaborator

@johanbrandhorst johanbrandhorst left a comment

Choose a reason for hiding this comment

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

Thanks for this, some minor comments

@@ -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)
Copy link
Collaborator

Choose a reason for hiding this comment

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

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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Could we add a short workaround here too? "Configure Parallels Desktop with direct network" or whatever the workaround is, I can't remember 😁.

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

Successfully merging this pull request may close these issues.

2 participants