Skip to content

Commit ae9cc68

Browse files
committed
document DEBUG_HUB
1 parent a2fd8bb commit ae9cc68

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -160,20 +160,21 @@ Test your own registry caching and authentication the same way; you don't need `
160160

161161
## Developing/Debugging
162162

163-
Since `0.4.2` there is a separate `-debug` version of the image, which includes `nginx-debug`, and has `mitmproxy` (actually `mitmweb`) inserted after the CONNECT proxy but before the caching logic.
164-
This allows very in-depth debugging, but tends to be unstable with huge layers. Use sparingly, and definitely not in production.
163+
Since `0.4` there is a separate `-debug` version of the image, which includes `nginx-debug`, and (since 0.5.x) has a `mitmproxy` (actually `mitmweb`) inserted after the CONNECT proxy but before the caching logic, and a second `mitmweb` between the caching layer and DockerHub.
164+
This allows very in-depth debugging. Use sparingly, and definitely not in production.
165165

166166
```bash
167167
docker run --rm --name docker_registry_proxy -it
168-
-e DEBUG_NGINX=true -e DEBUG=true -p 0.0.0.0:8081:8081 \
168+
-e DEBUG_NGINX=true -e DEBUG=true -e DEBUG_HUB=true -p 0.0.0.0:8081:8081 -p 0.0.0.0:8082:8082 \
169169
-p 0.0.0.0:3128:3128 \
170170
-v $(pwd)/docker_mirror_cache:/docker_mirror_cache \
171171
-v $(pwd)/docker_mirror_certs:/ca \
172172
rpardini/docker-registry-proxy:0.4.2-debug
173173
```
174174

175-
- `DEBUG=true` enables the mitmweb proxy, accessible on port 8081
176-
- `DEBUG_NGINX=true` enables nginx-debug and debug logging, which probably is too much.
175+
- `DEBUG=true` enables the mitmweb proxy between Docker clients and the caching layer, accessible on port 8081
176+
- `DEBUG_HUB=true` enables the mitmweb proxy between the caching layer and DockerHub, accessible on port 8082 (since 0.5.x)
177+
- `DEBUG_NGINX=true` enables nginx-debug and debug logging, which probably is too much. Seriously.
177178

178179
## Gotchas
179180

0 commit comments

Comments
 (0)