INDEX.md

Documentation Index

English | 简体中文

Start with the goal that matches what you are trying to do.

I want to use WebCodex normally

• README — what WebCodex does and the difference between full use and a temporary trial
• Desktop installation — recommended Windows/macOS entry: Desktop + official OpenAI Secure Tunnel
• Full Setup — CLI, existing Server, Linux, and advanced regular Server + Runner setup
• AI-assisted setup — have an AI agent configure WebCodex using ordinary user language
• MCP — ChatGPT, Claude, and other MCP clients

I only want to try it for a few minutes

• Quick Trial — temporarily try one repository with one webcodex share command

I need production deployment or deep troubleshooting

• Deployment — systemd/Docker, multi-user self-hosting, and long-lived operations
• Windows + OpenAI Secure MCP Tunnel deep dive — independent Windows Server/Runner, Tunnel setup, and real troubleshooting notes
• Runner — Runner operations reference
• CLI — full command, configuration, and credential reference

I need authentication or network options

• MCP — Bearer, query-token fallback, OAuth, private tunnel, and MCP protocol reference
• Authentication — detailed credential and authority boundaries
• Deployment — stable HTTPS origins, self-hosting, and production networking
• GPT Actions — optional OpenAPI-based Custom GPT integration

I need help

• Troubleshooting — installation, connection, runtime, and Runner problems
• Security — safe operating guidance and security model

I want to understand or extend WebCodex

• Architecture — how the major components fit together
• Coding Workflow — task bootstrap, guidance, validation, and closeout
• Native Tool Plugins — add Runner-local tools with any executable language and no MCP SDK
• Computer Use roadmap — semantic-first desktop automation direction and validation priorities
• Browser/CDP runtime architecture — first-class Browser domain, authority, lifecycle, stale fencing, and Phase 1 limits

I want to contribute or release WebCodex

The docs/agent/ pages below are maintainer/internal contracts. They intentionally contain protocol fields, compatibility names, and implementation invariants that ordinary users should not need to learn.

• AGENTS.md — repository instructions for coding/AI agents
• Maintenance — maintenance queue, dependency cadence, PR/CI expectations, and bilingual-doc policy
• Testing — testing strategy
• Release checklist — release readiness
• Architecture decisions
• Runtime host context — Runner-configured planning context and runtime diagnostics
• Job reliability and Runner concurrency — restart recovery, observation semantics, shared Job capacity, and tool-description requirements
• Tool request tracing — maintainer forensic payload/correlation contract
• Authority model
• Session model
• Manual multi-window collaboration
• OpenAPI guidelines
• Release process