Skip to content

Commit 5e40243

Browse files
Mossakaclaude
andcommitted
docs: sync version references and add missing CLI flags
- Update Docker image examples from v0.13.0 to latest tag in usage.md - Add dedicated --enable-api-proxy section with examples and link to api-proxy-sidecar.md Note: --allow-full-filesystem-access flag referenced in #836 does not exist in the codebase and was not documented. quickstart.md version was already at 0.18.0 (newer than the 0.16.2 target), so no change needed. Closes #836 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 40e46d6 commit 5e40243

File tree

1 file changed

+38
-5
lines changed

1 file changed

+38
-5
lines changed

docs/usage.md

Lines changed: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -425,6 +425,35 @@ SSL Bump requires intercepting HTTPS traffic:
425425

426426
For more details, see [SSL Bump documentation](ssl-bump.md).
427427

428+
## API Proxy Sidecar
429+
430+
The `--enable-api-proxy` flag deploys a Node.js proxy sidecar that securely holds LLM API credentials and automatically injects authentication headers. This keeps API keys isolated from the agent container.
431+
432+
```bash
433+
# Enable the API proxy sidecar (reads keys from environment)
434+
sudo awf \
435+
--allow-domains api.openai.com,api.anthropic.com \
436+
--enable-api-proxy \
437+
-- your-agent-command
438+
```
439+
440+
When enabled, the proxy:
441+
- Isolates API keys from the agent container (keys never enter the agent environment)
442+
- Automatically injects Bearer tokens for OpenAI and Anthropic APIs
443+
- Routes all traffic through Squid to respect domain whitelisting
444+
445+
Rate limiting is available with the API proxy:
446+
```bash
447+
sudo awf \
448+
--allow-domains api.openai.com \
449+
--enable-api-proxy \
450+
--rate-limit-rpm 60 \
451+
--rate-limit-rph 1000 \
452+
-- your-agent-command
453+
```
454+
455+
For detailed architecture, credential flow, and configuration, see [API Proxy Sidecar](api-proxy-sidecar.md).
456+
428457
## Agent Image
429458

430459
The `--agent-image` flag controls which agent container image to use. It supports two presets for quick startup, or custom base images for advanced use cases.
@@ -602,12 +631,16 @@ sudo awf --skip-pull --allow-domains github.com -- your-command
602631
**Using Specific Versions:**
603632
```bash
604633
# Pre-download specific version
605-
docker pull ghcr.io/github/gh-aw-firewall/squid:v0.13.0
606-
docker pull ghcr.io/github/gh-aw-firewall/agent:v0.13.0
634+
docker pull ghcr.io/github/gh-aw-firewall/squid:latest
635+
docker pull ghcr.io/github/gh-aw-firewall/agent:latest
636+
637+
# Or pin to a specific version
638+
docker pull ghcr.io/github/gh-aw-firewall/squid:v0.16.2
639+
docker pull ghcr.io/github/gh-aw-firewall/agent:v0.16.2
607640

608-
# Tag as latest for awf to use
609-
docker tag ghcr.io/github/gh-aw-firewall/squid:v0.13.0 ghcr.io/github/gh-aw-firewall/squid:latest
610-
docker tag ghcr.io/github/gh-aw-firewall/agent:v0.13.0 ghcr.io/github/gh-aw-firewall/agent:latest
641+
# Tag a specific version as latest for awf to use
642+
docker tag ghcr.io/github/gh-aw-firewall/squid:v0.16.2 ghcr.io/github/gh-aw-firewall/squid:latest
643+
docker tag ghcr.io/github/gh-aw-firewall/agent:v0.16.2 ghcr.io/github/gh-aw-firewall/agent:latest
611644

612645
# Use with --skip-pull
613646
sudo awf --skip-pull --allow-domains github.com -- your-command

0 commit comments

Comments
 (0)