Skip to content

Commit c460517

Browse files
authored
Merge branch 'chipmk:main' into support_lima_vms
2 parents 98cdc68 + 0374c3d commit c460517

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

+23
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
- **No bloat:** Everything is handled by a single binary. No external dependencies/tools are needed.
1212

1313
## Requirements
14+
1415
You must be using Docker Desktop v3.6.0 or higher to use this tool (see https://github.com/chipmk/docker-mac-net-connect/issues/10#issuecomment-1146662058).
1516

1617
## Installation
@@ -23,6 +24,16 @@ $ brew install chipmk/tap/docker-mac-net-connect
2324
$ sudo brew services start chipmk/tap/docker-mac-net-connect
2425
```
2526

27+
### `GOPROXY` support
28+
29+
This Homebrew formulae is built using `go`. When Homebrew installs a formulae, it strips away local environment variables and configuration, including configuration set using `go env`.
30+
31+
Some users require changing `GOPROXY` due to firewalls. This formulae adds special support for `GOPROXY` using `HOMEBREW_GOPROXY`:
32+
33+
```bash
34+
HOMEBREW_GOPROXY=https://my-proxy-url brew install chipmk/tap/docker-mac-net-connect
35+
```
36+
2637
## Usage
2738

2839
After installing, you will be able to do this:
@@ -177,6 +188,18 @@ Root permissions are required by the service to:
177188

178189
This app tries to minimize opportunity for privilege escalation by following the principle of least privilege (PoLP). With that said, macOS has no concept of fine-grained admin privileges (ie. capabilities), so running as `sudo` is required.
179190

191+
192+
## Troubleshooting
193+
194+
- If things stop working after upgrading Docker, you may need to do a clean uninstall / reinstall of Docker Desktop. See here for uninstall instructions: [Uninstall Docker](https://docs.docker.com/desktop/uninstall/)
195+
- For general troubleshooting, try running the command directly rather than as a service: (From e.g. /opt/homebrew/Cellar/docker-mac-net-connect/v{*.*}/bin/):
196+
```
197+
sudo brew services stop chipmk/tap/docker-mac-net-connect
198+
sudo docker-mac-net-connect
199+
```
200+
This will show any debug messages that may indicate what is causing your issue.
201+
202+
180203
## License
181204

182205
MIT

0 commit comments

Comments
 (0)