f3router docs

English · 简体中文

Docs — English

Language-specific index for English documentation.

Domains

Domain Description
api/ API reference: chat completions, streaming, tool calling, vision, embeddings, response headers, Anthropic Messages surface.
architecture/ Architecture deep-dives: bandit routing & scoring, quota & cooldown engine, streaming, degraded mode & failover, catalog sync, observability. See also 00-high-level-index.md.
cli/ Setup CLI: setup-* generators, config-file merge layer.
clients/ Clients & coding agents: OpenAI-compatible clients, setup recipes, MCP, autocomplete.
compression/ Prompt compression: modes, safeguards, per-request controls, filters, statistics.
deployment/ Docker operations: image, Compose, networking, upgrades, backups.
desktop/ Desktop app: Electron shape, file logging, update delivery.
env/ Runtime configuration: .env variables, encryption keys, outbound proxies.
fallback/ Named fallback chains: lifecycle, auto:<name>, catalog-sync backfill.
glossary/ Glossary of recurring terms: headroom, RPD/TPD, pool key, auto:<name>, model-age gate.
install/ Installation: quick start, Docker Compose, local dev, desktop app, Termux.
logs/ Server logs viewer: live panel, two-tier store, polling API.
providers/ Provider integrations: supported-platform catalog, quota accounting, adding a provider.
proxy/ Outbound proxy transports: forward vs fetch-relay, system auto-detect.
testing/ Testing: local matrix, server suite, e2e compatibility suite.
troubleshooting/ Common issues: Docker, empty chain, fetch-relay, idempotency, quota, TRUST_PROXY.
i18n/ Translation workflow — see Translating for the cross-lang guide (outside per-language tree).

Other entry points

See also: 简体中文 — Chinese · Translating guide