Skip to content

Commit 28bfa46

Browse files
CopilotMossaka
andauthored
docs: reorder env vars section per review feedback
Agent-Logs-Url: https://github.com/github/gh-aw-firewall/sessions/da39fcf1-28e6-429d-8d64-5101360dff71 Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
1 parent 3618a7d commit 28bfa46

1 file changed

Lines changed: 7 additions & 21 deletions

File tree

docs-site/src/content/docs/reference/cli-reference.md

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -893,18 +893,18 @@ Use `--log-level debug` to see which enterprise domains were auto-detected. Look
893893

894894
AWF reads several environment variables that influence its behavior. These are grouped by purpose.
895895

896-
### Auto-Detection
896+
### Credentials (API Proxy Sidecar)
897897

898-
These variables are read by AWF to automatically add required domains to the allowlist, particularly for GitHub Enterprise Cloud (GHEC) and GitHub Enterprise Server (GHES) deployments.
898+
These variables supply API credentials to the API proxy sidecar when `--enable-api-proxy` is active.
899899

900900
| Variable | Description |
901901
|----------|-------------|
902-
| `GITHUB_SERVER_URL` | GHEC tenant URL. When set to a `*.ghe.com` host, AWF auto-adds the tenant and API domains to the allowlist. |
903-
| `GITHUB_API_URL` | GHEC API URL. Auto-added to the allowlist when the host matches `*.ghe.com`. |
904-
| `ENGINE_API_TARGET` | GHES API URL. The hostname is extracted and GHES-related domains are added to the allowlist. |
902+
| `OPENAI_API_KEY` | OpenAI API key — held securely in the api-proxy sidecar |
903+
| `ANTHROPIC_API_KEY` | Anthropic API key — held securely in the api-proxy sidecar |
904+
| `COPILOT_GITHUB_TOKEN` | GitHub Copilot token — held securely in the api-proxy sidecar |
905905

906-
:::note
907-
These variables are typically set automatically by GitHub Actions runners. You do not need to configure them manually in most cases.
906+
:::danger[Credential Isolation]
907+
When `--enable-api-proxy` is active, these credentials are **never exposed to the agent container**. They are held exclusively in the api-proxy sidecar, which injects them into outbound requests on the agent's behalf.
908908
:::
909909

910910
### API Target Overrides
@@ -925,20 +925,6 @@ These variables provide an alternative to the corresponding CLI flags for config
925925
|----------|----------|-------------|
926926
| `AWF_AUDIT_DIR` | `--audit-dir` | Directory for audit artifacts |
927927

928-
### Credentials (API Proxy Sidecar)
929-
930-
These variables supply API credentials to the API proxy sidecar when `--enable-api-proxy` is active.
931-
932-
| Variable | Description |
933-
|----------|-------------|
934-
| `OPENAI_API_KEY` | OpenAI API key — held securely in the api-proxy sidecar |
935-
| `ANTHROPIC_API_KEY` | Anthropic API key — held securely in the api-proxy sidecar |
936-
| `COPILOT_GITHUB_TOKEN` | GitHub Copilot token — held securely in the api-proxy sidecar |
937-
938-
:::danger[Credential Isolation]
939-
When `--enable-api-proxy` is active, these credentials are **never exposed to the agent container**. They are held exclusively in the api-proxy sidecar, which injects them into outbound requests on the agent's behalf.
940-
:::
941-
942928
## Exit Codes
943929

944930
| Code | Description |

0 commit comments

Comments
 (0)