Update README.md - Add info about mac & troubleshooting#151
Update README.md - Add info about mac & troubleshooting#151m-Io-oI-m wants to merge 1 commit intolima-vm:masterfrom
Conversation
small update regarding mac Signed-off-by: m-Io-oI-m <devforkio@proton.me>
| - To enable verbose debug logs, set the environment variable `DEBUG=1`. | ||
| - When using launchd, logs are written to `/var/log/socket_vmnet/stderr`. | ||
| `/var/log/socket_vmnet/stdout` is not used and expected to be empty. | ||
| - On Mac, make sure that the IDE (ie: vscode) have privileges on the "local network" in "System Settings" -> "Privacy & Security" -> "Local Network". Symptom: Execute bash script from VSCODE terminal (or any IDE), `socket_vmnet` start correctly, VM can ping its gateway (host bridge interface), VM can ping internet, VM can ping host but host can NOT ping VM. |
There was a problem hiding this comment.
- "On Mac" isn't meaningful here as Mac is the only supported host platform
- The sentence should not assume that everybody is using IDE
- "ie: vscode" sounds like vscode is the only IDE in the world. Did you mean "e.g., "?
- vscode, VSCODE -> VS Code, or Visual Studio Code
- "Symptom: ..." is grammatically hard to read as it starts with an imperative mood. You can ask @copilot to improve the sentence
- What is the "bash script" here?
There was a problem hiding this comment.
Pull request overview
This PR updates the README troubleshooting section to document a macOS-specific networking issue when using socket_vmnet from IDE terminals.
Changes:
- Add a troubleshooting note explaining required “Local Network” permissions for IDEs on macOS.
- Describe the specific symptom pattern when the permission is missing (host cannot ping VM while VM connectivity appears normal).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - To enable verbose debug logs, set the environment variable `DEBUG=1`. | ||
| - When using launchd, logs are written to `/var/log/socket_vmnet/stderr`. | ||
| `/var/log/socket_vmnet/stdout` is not used and expected to be empty. | ||
| - On Mac, make sure that the IDE (ie: vscode) have privileges on the "local network" in "System Settings" -> "Privacy & Security" -> "Local Network". Symptom: Execute bash script from VSCODE terminal (or any IDE), `socket_vmnet` start correctly, VM can ping its gateway (host bridge interface), VM can ping internet, VM can ping host but host can NOT ping VM. |
There was a problem hiding this comment.
The new troubleshooting bullet has several grammatical and style issues (e.g., subject-verb agreement, "ie" vs. "i.e.", and IDE name capitalization), which makes the guidance harder to read; consider rephrasing to something like: "On macOS, make sure that your IDE (e.g., VS Code) has permission for the Local Network in System Settings → Privacy & Security → Local Network. Symptom: when executing the bash script from the IDE terminal, socket_vmnet starts correctly, the VM can ping its gateway and the internet and the host, but the host cannot ping the VM."
| - On Mac, make sure that the IDE (ie: vscode) have privileges on the "local network" in "System Settings" -> "Privacy & Security" -> "Local Network". Symptom: Execute bash script from VSCODE terminal (or any IDE), `socket_vmnet` start correctly, VM can ping its gateway (host bridge interface), VM can ping internet, VM can ping host but host can NOT ping VM. | |
| - On macOS, make sure that your IDE (e.g., VS Code) has permission for the Local Network in System Settings → Privacy & Security → Local Network. Symptom: when executing the bash script from the IDE terminal, `socket_vmnet` starts correctly, the VM can ping its gateway and the internet and the host, but the host cannot ping the VM. |
Just in case anyone get the same problem .. took me few hours to find the issue.