Skip to content

Commit b226633

Browse files
Mossakaclaude
andcommitted
docs: trim README how-it-works to three concise lines
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 136ac39 commit b226633

1 file changed

Lines changed: 5 additions & 7 deletions

File tree

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
11
# Agentic Workflow Firewall
22

3-
A network firewall for agentic workflows. `awf` wraps any command in a Docker-based sandbox that enforces L7 (HTTP/HTTPS) domain whitelisting via [Squid proxy](https://www.squid-cache.org/), while giving the agent access to the host workspace, system binaries, and whitelisted home directories via selective bind mounts.
3+
A network firewall for agentic workflows that restricts outbound HTTP/HTTPS to an allowlist of domains.
44

55
> [!TIP]
66
> This project is a part of GitHub's explorations of [Agentic Workflows](https://github.com/github/gh-aw). For more background, check out the [project page](https://github.github.io/gh-aw/)! ✨
77
88
## How it works
99

10-
`awf` runs three Docker containers for each invocation:
10+
`awf` runs your command inside a Docker sandbox with three containers:
1111

12-
- **Squid proxy** — enforces domain allowlist filtering; the agent's `HTTPS_PROXY`/`HTTP_PROXY` env vars route traffic through it, and iptables DNAT rules redirect any port 80/443 traffic that bypasses those env vars to Squid anyway
13-
- **Agent** — runs your command inside a chroot of the host filesystem, with network egress restricted to allowed domains only
14-
- **API proxy sidecar** *(optional, `--enable-api-proxy`)* — keeps LLM API keys (OpenAI, Anthropic, Copilot) outside the agent; the agent calls the sidecar without credentials and the sidecar injects the real key before forwarding through Squid
15-
16-
The Squid proxy and agent containers are always required and start together. The API proxy sidecar is only started when explicitly enabled.
12+
- **Squid proxy** — filters outbound traffic by domain allowlist
13+
- **Agent** — runs your command; all HTTP/HTTPS is routed through Squid
14+
- **API proxy sidecar** *(optional)* — holds LLM API keys so they never reach the agent process
1715

1816
## Requirements
1917

0 commit comments

Comments
 (0)