Skip to content

Commit f6396fd

Browse files
docs: document --enable-opencode flag for gated OpenCode API proxy port
Port 10004 (OpenCode) in the API proxy sidecar is now gated behind an explicit --enable-opencode flag (requires --enable-api-proxy). Update docs to reflect this. - docs/usage.md: add --enable-opencode to flag reference - docs/api-proxy-sidecar.md: note port 10004 requires --enable-opencode - docs/awf-config-spec.md: add apiProxy.enableOpenCode CLI mapping Triggered by: bab8694 (fix: gate OpenCode listener on AWF_ENABLE_OPENCODE flag) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent bab8694 commit f6396fd

3 files changed

Lines changed: 5 additions & 1 deletion

File tree

docs/api-proxy-sidecar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ The sidecar container:
310310
- **Image**: `ghcr.io/github/gh-aw-firewall/api-proxy:latest`
311311
- **Base**: `node:22-alpine`
312312
- **Network**: `awf-net` at `172.30.0.30`
313-
- **Ports**: 10000 (OpenAI), 10001 (Anthropic), 10002 (GitHub Copilot), 10003 (Google Gemini), 10004 (OpenCode)
313+
- **Ports**: 10000 (OpenAI), 10001 (Anthropic), 10002 (GitHub Copilot), 10003 (Google Gemini), 10004 (OpenCode, requires `--enable-opencode`)
314314
- **Proxy**: Routes via Squid at `http://172.30.0.10:3128`
315315

316316
### Health check

docs/awf-config-spec.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ Tools generating AWF invocations (such as `gh-aw`) SHOULD use this mapping:
6767
- `network.dnsServers[]``--dns-servers <csv>`
6868
- `network.upstreamProxy``--upstream-proxy`
6969
- `apiProxy.enabled``--enable-api-proxy`
70+
- `apiProxy.enableOpenCode``--enable-opencode`
7071
- `apiProxy.targets.<provider>.host``--<provider>-api-target`
7172
- `apiProxy.targets.openai.basePath``--openai-api-base-path`
7273
- `apiProxy.targets.anthropic.basePath``--anthropic-api-base-path`

docs/usage.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,9 @@ Options:
9797
--gemini-api-target <host> Target hostname for Gemini API requests
9898
(default: generativelanguage.googleapis.com)
9999
--gemini-api-base-path <path> Base path prefix for Gemini API requests
100+
--enable-opencode Enable OpenCode API proxy listener on port 10004
101+
(requires --enable-api-proxy). Only start this when the
102+
workflow uses the OpenCode engine. (default: false)
100103
--rate-limit-rpm <n> Max requests per minute per provider (requires --enable-api-proxy)
101104
--rate-limit-rph <n> Max requests per hour per provider (requires --enable-api-proxy)
102105
--rate-limit-bytes-pm <n> Max request bytes per minute per provider (requires --enable-api-proxy)

0 commit comments

Comments
 (0)