Skip to content

Commit f5c2cb9

Browse files
authored
docs: improve clarity of DOCKER_HOST comments per review feedback
Agent-Logs-Url: https://github.com/github/gh-aw-firewall/sessions/5c58cf57-cf73-4f3c-89b7-67261abd40d5
1 parent fc457b1 commit f5c2cb9

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

docs/environment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ This overrides the socket used for AWF's own operations without affecting the ag
241241

242242
### Limitation
243243

244-
The DinD TCP address (e.g., `tcp://localhost:2375`) typically refers to the runner's localhost from outside the container. From *inside* the agent container, `localhost` resolves to the container's own loopback interface, not the host's. To make docker commands inside the agent reach the DinD daemon you need one of:
244+
The DinD TCP address (e.g., `tcp://localhost:2375`) typically refers to the runner host's localhost interface. From *inside* the agent container, `localhost` resolves to the container's own loopback interface, not the host's. To make docker commands inside the agent reach the DinD daemon you need one of:
245245

246246
- **`--enable-host-access`** — allows the agent to reach `host.docker.internal` and set `DOCKER_HOST=tcp://host.docker.internal:2375` inside the agent.
247247
- **`--enable-dind`** — mounts the local Docker socket (`/var/run/docker.sock`) directly into the agent container (only works when using the local daemon, not a remote DinD TCP socket).

src/types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -575,8 +575,8 @@ export interface WrapperConfig {
575575
*
576576
* When not set, AWF auto-detects the Docker host:
577577
* - If `DOCKER_HOST` is a Unix socket, it is used as-is.
578-
* - If `DOCKER_HOST` is a TCP address (e.g. a DinD daemon), AWF clears it
579-
* and falls back to the system default socket.
578+
* - If `DOCKER_HOST` is a TCP address (e.g. a Docker-in-Docker (DinD) daemon),
579+
* AWF clears it and falls back to the system default socket.
580580
*
581581
* The original `DOCKER_HOST` value (if any) is always forwarded into the
582582
* agent container so the agent workload can still reach the DinD daemon.

0 commit comments

Comments
 (0)