mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-08-18 21:22:28 +03:00
c164ed962b
* fix(providers): validate bailian-coding-plan against the Token Plan host The catalog entry is the personal Alibaba Token Plan, but the region map still resolved the retired Coding Plan hosts. #10290 moved only the open-sse registry (inference) to token-plan.ap-southeast-1.maas.aliyuncs.com, leaving the dashboard's key validation pointed at coding-intl.dashscope.aliyuncs.com. That host rejects Token Plan keys with 401, and validateBailianCodingPlanProvider maps 401/403 to "Invalid API key" — so adding a working key failed at the modal while the same key served inference fine. Verified live 2026-08-18 with a valid key: legacy host 401 invalid_api_key, Token Plan host 429 quota (auth OK). - point both regions of ALIBABA_PROVIDER_ENDPOINTS at the Token Plan hosts, matching what docs/providers/ALIBABA-QWEN-PROVIDER-FAMILIES.md already stated - keep the retired hosts recognized as presets, so connections saved with the old URL still follow the region selector instead of being pinned to a dead host - keep image/video generation on the DashScope AIGC hosts, which the Token Plan host does not serve - probe with a model this plan actually serves (qwen3-coder-plus was Coding Plan) * test(providers): compare parsed hostnames in the legacy-host guard CodeQL flags URL .includes() checks as js/incomplete-url-substring-sanitization. The guard is an assertion, not a sanitizer, but comparing new URL().hostname is strictly more precise anyway — same coverage, no substring pattern. --------- Co-authored-by: Xiangzhe <bakryun0718@proton.me>
title, version, lastUpdated
| title | version | lastUpdated |
|---|---|---|
| Dokumentacja OmniRoute | 3.8.40 | 2026-06-28 |
Dokumentacja OmniRoute
Nawigowalny indeks zestawu dokumentacji OmniRoute. Tematy są pogrupowane według celu, abyś szybko znalazł to, czego potrzebujesz.
Szukasz przeglądu projektu, kroków instalacji lub informacji o wydaniach? Zobacz główne pliki README.md, CHANGELOG.md oraz CONTRIBUTING.md.
Dla użytkowników nietechnicznych
Proste przewodniki po korzystaniu z OmniRoute — bez wymaganej wiedzy technicznej.
getting-started/
- QUICK-START.md — zainstaluj i uruchom OmniRoute w 3 minuty.
- AUTO-COMBO-GUIDE.md — pozwól OmniRoute wybrać dla Ciebie najlepsze AI.
- PROVIDERS-GUIDE.md — jak podłączyć dostawców AI.
- FREE-TIERS-GUIDE.md — darmowe AI bez karty kredytowej.
- TROUBLESHOOTING.md — rozwiązywanie typowych problemów.
guides/
- SETUP_GUIDE.md — pierwsza konfiguracja OmniRoute.
- USER_GUIDE.md — codzienne korzystanie z panelu i API.
- FEATURES.md — galeria funkcji panelu.
- TIERS.md — poziomy OmniRoute wyjaśnione (przewodnik użytkownika).
- USAGE_QUOTA_GUIDE.md — śledzenie użycia, limitów (quota) i wydatków.
- COST_TRACKING.md — śledzenie kosztów i wydatków.
- FREE_PROVIDER_RANKINGS.md — rankingi darmowych dostawców (Arena ELO).
- DOCKER_GUIDE.md — uruchamianie OmniRoute w Dockerze.
- ELECTRON_GUIDE.md — buildy desktopowe (Electron).
- TERMUX_GUIDE.md — uruchamianie na Androidzie przez Termux.
- PWA_GUIDE.md — instalacja panelu jako PWA.
- REMOTE-MODE.md — udostępnianie OmniRoute zdalnie + tokeny z zakresem (scoped tokens).
- CLI-INTEGRATIONS.md — główna tabela integracji CLI
setup-*. - CLAUDE-CODE-CONFIGURATION.md — Claude Code CLI z OmniRoute.
- CODEX-CLI-CONFIGURATION.md — Codex CLI z OmniRoute.
- KIRO_SETUP.md — konfiguracja Kiro.
- I18N.md — workflow tłumaczeń i locale.
- TROUBLESHOOTING.md — szczegółowa referencja rozwiązywania problemów.
- UNINSTALL.md — czyste usuwanie instalacji.
Dla użytkowników technicznych
Dokumentacja techniczna dla deweloperów i współtwórców.
architecture/
Jak zbudowany jest system — przeczytaj te materiały, aby zrozumieć runtime, układ kodu i model odporności.
- ARCHITECTURE.md — wysokopoziomowa architektura systemu (potok żądań, warstwy, moduły).
- CODEBASE_DOCUMENTATION.md — referencja inżynierska bazy kodu.
- REPOSITORY_MAP.md — przewodnik nawigacji katalog po katalogu.
- AUTHZ_GUIDE.md — potok autoryzacji (klasyfikator tras + silnik polityk).
- RESILIENCE_GUIDE.md — circuit breaker dostawcy, cooldown połączeń i lockout modeli.
- QUALITY_GATES.md — inwentarz skryptów bramek jakości i jobów CI.
- MONITORING_SECTIONS.md — nawigacja panelu monitoringu/kosztów.
- cluster-decisions.md — opcjonalne decyzje profili sidecar/klaster.
reference/
Materiały referencyjne — powierzchnia API, zmienne środowiskowe, flagi CLI, katalog dostawców.
- API_REFERENCE.md — endpointy REST API i kształty danych.
- PROVIDER_REFERENCE.md — automatycznie generowany katalog dostawców (nie edytuj ręcznie).
- PROVIDER_PLUGIN_MANIFEST.md — kontrakt wtyczki dostawcy bezpieczny dla sidecarów przy migracji Bifrost i CLIProxyAPI.
- openapi.yaml — specyfikacja OpenAPI publicznego API.
- ENVIRONMENT.md — referencja zmiennych środowiskowych.
- FEATURE_FLAGS.md — flagi funkcji i ich wartości domyślne.
- CLI-TOOLS.md — dołączone polecenia CLI.
- FREE_TIERS.md — katalog darmowych poziomów dostawców LLM.
frameworks/
Podsystemy wtykowe udostępniane klientom, agentom i operatorom.
- MCP-SERVER.md — serwer Model Context Protocol.
- A2A-SERVER.md — serwer Agent-to-Agent (A2A) JSON-RPC.
- ACP.md — Agent Client Protocol.
- AGENT_PROTOCOLS_GUIDE.md — przegląd agentów A2A / ACP / Cloud.
- AGENTBRIDGE.md — most agenta IDE.
- AGENT-SKILLS.md — katalog umiejętności agentów.
- CLOUD_AGENT.md — runtime i dostawcy cloud agent.
- SKILLS.md — framework Skills (piaskownicowe rozszerzenie).
- MEMORY.md — trwała pamięć (FTS5 + Qdrant).
- WEBHOOKS.md — zdarzenia webhook i dyspozycja.
- EVALS.md — zestawy ewaluacji.
- GAMIFICATION.md — system grywalizacji i rankingów.
- EMBEDDED-SERVICES.md — wbudowane usługi sidecar (9Router, CLIProxyAPI).
- NOTION_CONTEXT.md — źródło kontekstu Notion.
- OBSIDIAN_CONTEXT.md — źródło kontekstu Obsidian.
- OPENCODE.md — integracja OpenCode.
- OPEN_SSE_ARCHITECTURE.md — wnętrze silnika streamingu open-sse.
- PLAYGROUND_STUDIO.md — UI Playground Studio.
- SEARCH_TOOLS_STUDIO.md — UI Search Tools Studio.
- TRAFFIC_INSPECTOR.md — inspector ruchu (MITM).
- PLUGINS.md — przegląd systemu wtyczek CLI.
- PLUGIN_SDK.md — referencja SDK wtyczek.
- PLUGIN_MARKETPLACE.md — marketplace wtyczek.
routing/
Routing combo, scorowanie i replay.
- AUTO-COMBO.md — Auto-Combo (scorowanie 13-czynnikowe, 19 strategii publicznych).
- QUOTA_SHARE.md — silnik współdzielenia limitów (quota).
- REASONING_REPLAY.md — cache replay rozumowania (reasoning).
security/
Guardrails, zgodność (compliance), stealth oraz obowiązkowe wzorce obsługi publicznych poświadczeń i komunikatów błędów.
- GUARDRAILS.md — guardrails PII, prompt injection, vision.
- COMPLIANCE.md — ścieżki audytu i zgodność.
- STEALTH_GUIDE.md — stealth TLS / fingerprint.
- PUBLIC_CREDS.md — obowiązkowy wzorzec osadzania publicznych upstreamowych OAuth client_id/secret + kluczy Firebase Web bez uruchamiania skanerów sekretów.
- ERROR_SANITIZATION.md — obowiązkowy wzorzec kierowania każdej odpowiedzi błędu przez
sanitizeErrorMessage, aby zapobiec ujawnieniu stack-trace. - ROUTE_GUARD_TIERS.md — poziomy klasyfikacji route-guard.
- CLI_TOKEN.md — auth tokenu machine-ID CLI (HMAC + legacy SHA-256).
- EGRESS_POLICY.md — polityka rodziny IP egress (IPv4/IPv6).
- MITM-TPROXY-DECRYPT.md — przezroczyste deszyfrowanie MITM.
- SUPPLY_CHAIN.md — bramki łańcucha dostaw (SLSA, SBOM, Trivy, osv-scanner, Scorecard).
- SOCKET_DEV_FINDINGS.md — atestacje ustaleń łańcucha dostaw.
compression/
Silniki kompresji promptów, reguły i pakiety językowe.
- COMPRESSION_GUIDE.md — ogólny przegląd kompresji.
- COMPRESSION_ENGINES.md — dostępne silniki kompresji.
- COMPRESSION_RULES_FORMAT.md — format pliku reguł.
- COMPRESSION_LANGUAGE_PACKS.md — pakiety językowe.
- RTK_COMPRESSION.md — dogłębna analiza silnika RTK.
- CONTEXT_EDITING.md — delegowana edycja kontekstu (Anthropic).
- EXTENDING_COMPRESSION.md — dodawanie własnego silnika kompresji.
providers/
Przewodniki integracji specyficzne dla dostawców.
- CLAUDE_WEB.md — dostawca Claude Web (cookie-auth).
- AGENTROUTER.md — konfiguracja AgentRouter.
- ZED-DOCKER.md — integracja Zed IDE w Dockerze.
comparison/
- OMNIROUTE_VS_ALTERNATIVES.md — jak OmniRoute wypada na tle alternatyw.
ops/
Wydania, wdrożenia, proxy, tunele, pokrycie testami, baza danych, monitoring.
- RELEASE_CHECKLIST.md — checklista procesu wydania.
- RELEASE_GREEN.md — utrzymywanie kolejki PR i gałęzi wydania w stanie green.
- QUALITY_GATE_PLAYBOOK.md — playbook bramek jakości.
- BRANCH_PROTECTION_MAIN.md — ochrona gałęzi
main. - COVERAGE_PLAN.md — plan pokrycia testami.
- DATABASE_GUIDE.md — schemat DB i operacje.
- SQLITE_RUNTIME.md — łańcuch rozwiązywania sterownika SQLite.
- MONITORING_GUIDE.md — monitoring i obserwowalność.
- FLY_IO_DEPLOYMENT_GUIDE.md — wdrożenie na Fly.io.
- VM_DEPLOYMENT_GUIDE.md — generyczne wdrożenie na VM.
- PROXY_GUIDE.md — konfiguracja proxy upstream.
- TUNNELS_GUIDE.md — Cloudflare tunnel i pokrewne.
diagrams/
Źródła Mermaid oraz wyeksportowane diagramy SVG/PNG przywoływane w powyższej dokumentacji. Zobacz diagrams/README.md.
i18n/
Przetłumaczone lustrzane kopie dokumentacji w 43 locale. Listę obsługiwanych języków znajdziesz w i18n/README.md.
screenshots/
Statyczne zrzuty ekranu używane przez panel i README. Nie stanowią części treści dokumentacji.
Artefakty generowane automatycznie
- reference/PROVIDER_REFERENCE.md jest generowany przez
scripts/docs/gen-provider-reference.tszsrc/shared/constants/providers.ts. Nie edytuj ręcznie. - UI
/docsjest oparte na generowaniu źródeł Fumadocs MDX z powyższych podfolderów.