Skip to content

docs: Update self-hosted worker API key setup - #800

Draft
warp-agent-staging[bot] wants to merge 1 commit into
mainfrom
docs/self-hosted-worker-api-key-flow
Draft

warp-agent-staging[bot] wants to merge 1 commit into
mainfrom
docs/self-hosted-worker-api-key-flow

Conversation

@warp-agent-staging

Copy link
Copy Markdown
Contributor

Summary

Updates the managed self-hosted worker documentation to use the dedicated team-scoped API key flow shown in the product. The API key reference is now the canonical creation procedure, and each managed backend links to it instead of directing users to bind an Agent key.

Changes

  • Documented the Self-hosted worker key type and one-time copy flow in the API key reference.
  • Updated the Docker, Kubernetes, and Direct setup pages, quickstart, worker reference, and troubleshooting guidance.
  • Preserved published heading anchors and trimmed the quickstart to its compression budget.

Verification

  • npm run build — passed.
  • python3 .agents/skills/check_for_broken_links/check_links.py --internal-only — passed; 0 broken internal links.
  • python3 .agents/skills/doc_quality_policy/check_compression_contract.py src/content/docs/platform/self-hosting/quickstart.mdx --content-type quickstart — passed.
  • python3 .agents/skills/style_lint/style_lint.py --changed — completed with 6 pre-existing warnings in touched files and no newly introduced warnings.
  • Full external-link validation completed with 2 unrelated pre-existing 404s in src/content/docs/changelog/2026.mdx.
  • trunk check — unavailable because Trunk is not installed in this environment.

Unverified claims

None — all UI labels, key scope, expiration behavior, and one-time display behavior were verified against the Loom demonstration and warp-server source.

Documentation risk

Risk: engineering-review-required
Rationale: Updates self-hosted worker authentication behavior and user-interface labels.
Source files consulted: warp-server/client/packages/factory/src/pages/UserSettings/NewApiKeyModal.tsx@50a3365d2c685bd0f3014ddf296e185222740321, warp-server/client/packages/factory/src/pages/UserSettings/index.tsx@50a3365d2c685bd0f3014ddf296e185222740321
Engineering review status: pending
Docs override: none

Additional context

Co-Authored-By: Oz oz-agent@warp.dev

Co-Authored-By: Oz <oz-agent@warp.dev>
@warp-agent-staging warp-agent-staging Bot added warpy-factory Opened by the Warp factory agents factory:docs-factory Label associated to the "docs-factory" factory labels Sep 25, 2026
@vercel

vercel Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Sep 25, 2026 11:37pm UTC

Request Review

@cla-bot cla-bot Bot added the cla-signed label Sep 25, 2026
@warp-agent-staging

Copy link
Copy Markdown
Contributor Author

This PR was generated with Warp.

Comment @warp-staging-factory on this PR to send it follow-up work.

View run View conversation View origin

This branch was successfully deployed

1 active deployment
Preview — 0aad2ad8 Deployed Sep 25, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed factory:docs-factory Label associated to the "docs-factory" factory warpy-factory Opened by the Warp factory agents

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants