Skip to content

[docs] auth: README: correct API proxy sidecar status to always-enabled - #8733

Merged
lpcox merged 2 commits into
mainfrom
docs/auth-readme-api-proxy-always-enabled-02350-a17ccbb2c6686112
Sep 19, 2026
Merged

lpcox merged 2 commits into
mainfrom
docs/auth-readme-api-proxy-always-enabled-02350-a17ccbb2c6686112

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Caution

Protected files were modified in this change.
This pull request is in request-review mode and requires explicit human scrutiny before merge.

Protected files: README.md

Summary

  • Scan window: since 2026-09-16 (repo: github/gh-aw-firewall).
  • Sources reviewed: README.md, docs/auth-matrix.md, docs/authentication-architecture.md, docs/api-proxy-sidecar.md, docs/environment.md, docs/awf-config-spec.md, docs/github_actions.md, and current implementation (src/cli-options.ts, src/services/agent-environment/excluded-vars.ts, containers/api-proxy/management.js, containers/api-proxy/startup.js, containers/agent/api-proxy-health-check.sh, src/constants/placeholders.ts).
  • Also confirmed fix: isolate Actions OIDC from agent container #6894 (isolate Actions OIDC from agent) and Ensure HTTP MCP GitHub OIDC bypasses the AWF agent credential boundary gh-aw#50053 (HTTP MCP GitHub OIDC boundary, resolved via Enforce runner→gateway OIDC path and prevent AWF agent exposure for HTTP MCP auth gh-aw#50054) remain resolved/merged — no doc changes needed there; a prior updater run (PR [docs] auth: Mark gh-aw#50053 MCP OIDC boundary work as resolved #7156) already reconciled that language.
  • Corrected authentication path: README.md's "How it works" list still described the API proxy sidecar as optional, while src/cli-options.ts shows --enable-api-proxy is a deprecated no-op and --no-enable-api-proxy is rejected at runtime — the sidecar cannot be disabled. This matches the already-correct wording in docs/api-proxy-sidecar.md ("The API proxy sidecar is always enabled") and docs/awf-config-spec.md ("The API proxy sidecar is always started; there is no disabled mode.").
  • No other stale, missing, or pending-vs-shipped claims were found in the reviewed files during this scan; Copilot fine-grained-PAT/GHEC auth-prefix behavior (PR Fix Copilot proxy auth and GHEC model discovery #8038) and OIDC exclusion behavior (excluded-vars.ts) both still match documented text and tests.

Documentation Changes

  • README.md: Changed the API proxy sidecar bullet in "How it works" from *(optional)* to *(always enabled)*, aligning it with docs/api-proxy-sidecar.md, docs/awf-config-spec.md, and the current CLI implementation.

Validation

  • Implementation checked: src/cli-options.ts (--enable-api-proxy deprecated/no-op, --no-enable-api-proxy rejected at runtime), src/services/agent-environment/excluded-vars.ts, containers/api-proxy/management.js, containers/api-proxy/startup.js, containers/agent/api-proxy-health-check.sh, src/constants/placeholders.ts, containers/api-proxy/copilot-auth.test.js, containers/api-proxy/copilot-adapter-enterprise.test.js, containers/api-proxy/copilot-byok.test.js.
  • Repository history/context checked: searched merged PRs and issues since 2026-09-16 (no auth/api-proxy/OIDC-relevant merges in that window; recent work was Cloud Hypervisor enclave preview, CI fixes, and dependency bumps), confirmed no open [docs] auth: PRs exist to deduplicate against, and re-verified fix: isolate Actions OIDC from agent container #6894 and Ensure HTTP MCP GitHub OIDC bypasses the AWF agent credential boundary gh-aw#50053 status directly via the GitHub API.
  • Markdown/link review: single-line prose change, no structural Markdown, links, tables, or code fences touched.
  • Credential-leakage diff review: git diff scanned for token/key/JWT patterns and credential-bearing URLs — none found; the only change is the word "optional" → "always enabled".

Sources

Generated by Auth Doctor Updater · copilot · auto · 138.3 AIC · ⊞ 10.8K ·

README.md's How-it-works list described the API proxy sidecar as
optional, but the CLI, awf-config-spec.md, api-proxy-sidecar.md, and
authentication-architecture.md all confirm the sidecar is always
enabled — --enable-api-proxy is a deprecated no-op and --no-enable-api-proxy
is rejected at runtime (src/cli-options.ts).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added ai-generated documentation Improvements or additions to documentation labels Sep 18, 2026

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Protected files were modified in this pull request and require manual scrutiny before merge.

Please verify that each protected-file change is intentional, policy-compliant, and safe:

  • Protected files: README.md

@github-actions

github-actions Bot commented Sep 18, 2026

Copy link
Copy Markdown
Contributor Author

Documentation Preview

Documentation has been built for this PR.

Download preview artifact

To view locally:

  1. Download the docs-preview-pr-8733 artifact from the workflow run
  2. Unzip and open index.html in your browser

Built from commit ec76bf3

@lpcox

lpcox commented Sep 18, 2026

Copy link
Copy Markdown
Collaborator

@copilot rebase main and resolve conflicts

…proxy-always-enabled-02350-a17ccbb2c6686112

Co-authored-by: lpcox <15877973+lpcox@users.noreply.github.com>

Copilot AI commented Sep 18, 2026

Copy link
Copy Markdown
Contributor

@copilot rebase main and resolve conflicts

Merged main into this branch instead of rebasing — a rebase would require a force push, which I can't do. The merge applied cleanly with no conflicts, and the README change is intact.

Copilot AI requested a review from lpcox September 18, 2026 23:55
@lpcox
lpcox merged commit a219b22 into main Sep 19, 2026
15 of 17 checks passed
@lpcox
lpcox deleted the docs/auth-readme-api-proxy-always-enabled-02350-a17ccbb2c6686112 branch September 19, 2026 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-generated documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants