mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-07-31 04:12:10 +03:00
448b65af2c
Squashes multiple in-flight changes pending release into release/v3.8.4 since the in-progress 3.8.5 has been consolidated back into 3.8.4. CRITICAL — oauth/codex (multi-account regression revert) Revert the proactive expired-flip that #2743 (multi-agent review) added to open-sse/executors/base.ts. The new behaviour marked accounts as testStatus:"expired" + isActive:false from inside the PROACTIVE refresh path whenever isUnrecoverableRefreshError() fired — including transient sentinels (refresh_token_reused that the rotation map can recover, generic invalid_request blips). On multi-account Codex it sequentially disabled working accounts in the DB before any upstream call confirmed the failure. Keep the classification — that part is legitimate (avoids spreading the sentinel into activeCredentials and sending a non-token upstream). Drop only the DB mutation: the REACTIVE path in chatCore.ts:~3912 still flips the account to expired after the upstream confirms the auth failure, which is the correct moment (by then the rotation map at tokenRefresh.ts:~1541 and the DB-staleness check have already had their chance to recover). Marked the block "SOURCE OF TRUTH — do not flip the proactive path back. Ask the operator first." with the regression history (ad3d4b696->0c94c397d-> this revert) so a future review does not re-introduce the regression on autopilot. oauth/kiro — centralize social-flow constants in KIRO_CONFIG social-authorize/route.ts and social-exchange/route.ts duplicated the AWS Kiro device-auth URL and the "kiro-cli" public client identifier. Move both to KIRO_CONFIG (alongside the existing AWS SSO OIDC + social auth fields) and add an env override on socialClientId so operators can pin a custom value via KIRO_OAUTH_CLIENT_ID. New KIRO_CONFIG fields: socialClientId (env-overridable), socialDeviceAuthorizeUrl, socialDevicePollUrl. tests/unit/oauth-kiro.test.ts locks the contract: routes must import KIRO_CONFIG and must not inline the AWS URL or "kiro-cli" literal. dashboard/providers — memoize ProviderCard lookup constants Move KIND_LABEL and DOT_COLORS into useMemo so they don't recreate on every render. Functional parity, slightly cheaper re-renders. test(authz) — lockdown Next.js 16 proxy.ts contract New tests/unit/authz/proxy-contract.test.ts asserts the file lives at src/proxy.ts (not src/middleware.ts), exports the proxy function, delegates to runAuthzPipeline with enforce:true, and the matcher covers every prefix mounted under /api so unauthenticated requests cannot bypass the centralized tier checks. version — roll back from 3.8.5 to 3.8.4 CHANGELOG.md consolidates the unreleased 3.8.5 entries into the 3.8.4 section. Mirror that in package.json, package-lock.json and docs/reference/openapi.yaml. .source/* picked up the regenerated fumadocs section ordering. docs — env contract additions Add KIRO_OAUTH_CLIENT_ID and OMNIROUTE_PROXY_FETCH_DEBUG to .env.example and docs/reference/ENVIRONMENT.md so the env-doc-sync check stays green.
title, version, lastUpdated
| title | version | lastUpdated |
|---|---|---|
| OmniRoute Documentation | 3.8.2 | 2026-05-13 |
OmniRoute Documentation
Navigable index of the OmniRoute documentation set. Topics are grouped by intent so you can find what you need quickly.
Looking for the project overview, install steps, or release notes? See the root README.md, CHANGELOG.md, and CONTRIBUTING.md.
architecture/
How the system is put together — read these to understand the runtime, code layout, and resilience model.
- ARCHITECTURE.md — high-level system architecture (request pipeline, layers, modules).
- CODEBASE_DOCUMENTATION.md — engineering reference for the codebase.
- REPOSITORY_MAP.md — directory-by-directory navigation guide.
- AUTHZ_GUIDE.md — authorization pipeline (route classifier + policy engine).
- RESILIENCE_GUIDE.md — provider circuit breaker, connection cooldown, and model lockout.
guides/
Task-focused walkthroughs for operators and end users.
- SETUP_GUIDE.md — first-time setup of OmniRoute.
- USER_GUIDE.md — daily usage of the dashboard and API.
- DOCKER_GUIDE.md — running OmniRoute under Docker.
- ELECTRON_GUIDE.md — desktop (Electron) builds.
- TERMUX_GUIDE.md — running on Android via Termux.
- PWA_GUIDE.md — installing the dashboard as a PWA.
- TROUBLESHOOTING.md — common issues and fixes.
- UNINSTALL.md — clean removal steps.
- I18N.md — translation and locale workflow.
- FEATURES.md — dashboard feature gallery.
reference/
Lookup material — API surface, environment variables, CLI flags, provider catalog.
- API_REFERENCE.md — REST API endpoints and shapes.
- PROVIDER_REFERENCE.md — auto-generated provider catalog.
- openapi.yaml — OpenAPI 3.1 spec for the public API.
- ENVIRONMENT.md — environment variables reference.
- CLI-TOOLS.md — bundled CLI commands.
- FREE_TIERS.md — free-tier LLM provider directory.
frameworks/
Pluggable subsystems exposed to clients, agents, and operators.
- MCP-SERVER.md — Model Context Protocol server.
- A2A-SERVER.md — Agent-to-Agent (A2A) JSON-RPC server.
- AGENT_PROTOCOLS_GUIDE.md — A2A / ACP / Cloud agent overview.
- CLOUD_AGENT.md — cloud agent runtime and providers.
- SKILLS.md — Skills framework (sandboxed extension).
- MEMORY.md — persistent memory (FTS5 + Qdrant).
- WEBHOOKS.md — webhook events and dispatch.
- EVALS.md — eval suites.
routing/
Combo routing, scoring, and replay.
- AUTO-COMBO.md — Auto-Combo (9-factor scoring, 14 strategies).
- REASONING_REPLAY.md — reasoning replay flow.
security/
Guardrails, compliance, stealth, and the mandatory patterns for handling public credentials and error messages.
- GUARDRAILS.md — PII, prompt injection, vision guardrails.
- COMPLIANCE.md — audit trails and compliance.
- STEALTH_GUIDE.md — TLS / fingerprint stealth.
- PUBLIC_CREDS.md — mandatory pattern for embedding public upstream OAuth client_id/secret + Firebase Web keys without tripping secret scanners.
- ERROR_SANITIZATION.md — mandatory pattern for routing every error response through
sanitizeErrorMessageto prevent stack-trace exposure.
compression/
Prompt compression engines, rules, and language packs.
- COMPRESSION_GUIDE.md — top-level compression overview.
- COMPRESSION_ENGINES.md — available compression engines.
- COMPRESSION_RULES_FORMAT.md — rule file format.
- COMPRESSION_LANGUAGE_PACKS.md — language packs.
- RTK_COMPRESSION.md — RTK engine deep dive.
ops/
Release, deployment, proxies, tunnels, coverage.
- RELEASE_CHECKLIST.md — release flow checklist.
- COVERAGE_PLAN.md — test coverage plan.
- FLY_IO_DEPLOYMENT_GUIDE.md — Fly.io deployment.
- VM_DEPLOYMENT_GUIDE.md — generic VM deployment.
- PROXY_GUIDE.md — upstream proxy configuration.
- TUNNELS_GUIDE.md — Cloudflare tunnel and friends.
diagrams/
Mermaid sources and exported SVG/PNG diagrams referenced from the docs above. Populated incrementally — see diagrams/README.md.
i18n/
Translated mirrors of the documentation in 40 locales. See i18n/README.md for the supported language list.
screenshots/
Static screenshots used by the dashboard and the README. Not part of the doc body.
Auto-generated artifacts
- reference/PROVIDER_REFERENCE.md is generated by
scripts/gen-provider-reference.tsfromsrc/shared/constants/providers.ts. Do not edit by hand. - The dashboard sidebar (
/docsUI) is generated byscripts/generate-docs-index.mjs, which walks the subfolders above.