From 77a3eece323e1354653f8eaa4f60565fe81ee4b4 Mon Sep 17 00:00:00 2001 From: diegosouzapw Date: Thu, 26 Feb 2026 03:09:09 -0300 Subject: [PATCH] docs: update README, README.pt-BR, TROUBLESHOOTING with v1.4.9-v1.4.11 features - Added proxy visibility + 3-level proxy config to feature tables - Added language selector and DATA_DIR env var entries - Added EACCES and routing strategy fix to troubleshooting quick fixes - Equivalent changes in both EN and PT-BR READMEs --- README.md | 42 ++++++++++++++++++++++------------------- README.pt-BR.md | 24 +++++++++++++---------- docs/TROUBLESHOOTING.md | 2 ++ 3 files changed, 39 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 2b91378385..ad5ea6208f 100644 --- a/README.md +++ b/README.md @@ -366,16 +366,18 @@ Access via: WhatsApp, Telegram, Slack, Discord, iMessage, Signal... ### 🛡️ Resilience & Security -| Feature | What It Does | -| ------------------------------- | ------------------------------------------------------------- | -| 🔌 **Circuit Breaker** | Auto-open/close per-provider with configurable thresholds | -| 🛡️ **Anti-Thundering Herd** | Mutex + semaphore rate-limit for API key providers | -| 🧠 **Semantic Cache** | Two-tier cache (signature + semantic) reduces cost & latency | -| ⚡ **Request Idempotency** | 5s dedup window for duplicate requests | -| 🔒 **TLS Fingerprint Spoofing** | Bypass TLS-based bot detection via wreq-js | -| 🌐 **IP Filtering** | Allowlist/blocklist for API access control | -| 📊 **Editable Rate Limits** | Configurable RPM, min gap, and max concurrent at system level | -| 🛡 **API Endpoint Protection** | Auth gating + provider blocking for the `/models` endpoint | +| Feature | What It Does | +| ------------------------------- | ----------------------------------------------------------------------------- | +| 🔌 **Circuit Breaker** | Auto-open/close per-provider with configurable thresholds | +| 🛡️ **Anti-Thundering Herd** | Mutex + semaphore rate-limit for API key providers | +| 🧠 **Semantic Cache** | Two-tier cache (signature + semantic) reduces cost & latency | +| ⚡ **Request Idempotency** | 5s dedup window for duplicate requests | +| 🔒 **TLS Fingerprint Spoofing** | Bypass TLS-based bot detection via wreq-js | +| 🌐 **IP Filtering** | Allowlist/blocklist for API access control | +| 📊 **Editable Rate Limits** | Configurable RPM, min gap, and max concurrent at system level | +| 🛡 **API Endpoint Protection** | Auth gating + provider blocking for the `/models` endpoint | +| 🔒 **Proxy Visibility** | Color-coded badges: 🟢 global, 🟡 provider, 🔵 per-connection with IP display | +| 🌐 **3-Level Proxy Config** | Configure proxies at global, per-provider, or per-connection level | ### 📊 Observability & Analytics @@ -395,15 +397,17 @@ Access via: WhatsApp, Telegram, Slack, Discord, iMessage, Signal... ### ☁️ Deployment & Sync -| Feature | What It Does | -| --------------------------- | --------------------------------------------------------------------- | -| 💾 **Cloud Sync** | Sync config across devices via Cloudflare Workers | -| 🌐 **Deploy Anywhere** | Localhost, VPS, Docker, Cloudflare Workers | -| 🔑 **API Key Management** | Generate, rotate, and scope API keys per provider | -| 🧙 **Onboarding Wizard** | 4-step guided setup for first-time users | -| 🔧 **CLI Tools Dashboard** | One-click configure Claude, Codex, Cline, OpenClaw, Kilo, Antigravity | -| 🔄 **DB Backups** | Automatic backup, restore, export & import for all settings | -| 🌐 **Internationalization** | Full i18n with next-intl — English + Portuguese (Brazil) support | +| Feature | What It Does | +| ---------------------------- | --------------------------------------------------------------------- | +| 💾 **Cloud Sync** | Sync config across devices via Cloudflare Workers | +| 🌐 **Deploy Anywhere** | Localhost, VPS, Docker, Cloudflare Workers | +| 🔑 **API Key Management** | Generate, rotate, and scope API keys per provider | +| 🧙 **Onboarding Wizard** | 4-step guided setup for first-time users | +| 🔧 **CLI Tools Dashboard** | One-click configure Claude, Codex, Cline, OpenClaw, Kilo, Antigravity | +| 🔄 **DB Backups** | Automatic backup, restore, export & import for all settings | +| 🌐 **Internationalization** | Full i18n with next-intl — English + Portuguese (Brazil) support | +| 🌍 **Language Selector** | Globe icon in header for real-time language switching (🇺🇸/🇧🇷) | +| 📂 **Custom Data Directory** | `DATA_DIR` env var to override default `~/.omniroute` storage path |
📖 Feature Details diff --git a/README.pt-BR.md b/README.pt-BR.md index 5ba25097f5..7737447e54 100644 --- a/README.pt-BR.md +++ b/README.pt-BR.md @@ -364,16 +364,18 @@ Acesso via: WhatsApp, Telegram, Slack, Discord, iMessage, Signal... ### 🛡️ Resiliência e Segurança -| Funcionalidade | O que Faz | -| ---------------------------------- | --------------------------------------------------------------------- | -| 🔌 **Circuit Breaker** | Auto-abertura/fechamento por provedor com limites configuráveis | -| 🛡️ **Anti-Thundering Herd** | Mutex + semáforo rate-limit para provedores com API key | -| 🧠 **Cache Semântico** | Cache de duas camadas (assinatura + semântico) reduz custo e latência | -| ⚡ **Idempotência de Requisição** | Janela de dedup de 5s para requisições duplicadas | -| 🔒 **Spoofing de Fingerprint TLS** | Bypass de detecção de bot via TLS com wreq-js | -| 🌐 **Filtragem de IP** | Allowlist/blocklist para controle de acesso à API | -| 📊 **Rate Limits Editáveis** | RPM, gap mínimo e concorrência máxima configuráveis | -| 🛡 **Proteção de Endpoint API** | Gateway de Auth + bloqueio de provedores para o endpoint `/models` | +| Funcionalidade | O que Faz | +| ---------------------------------- | --------------------------------------------------------------------------- | +| 🔌 **Circuit Breaker** | Auto-abertura/fechamento por provedor com limites configuráveis | +| 🛡️ **Anti-Thundering Herd** | Mutex + semáforo rate-limit para provedores com API key | +| 🧠 **Cache Semântico** | Cache de duas camadas (assinatura + semântico) reduz custo e latência | +| ⚡ **Idempotência de Requisição** | Janela de dedup de 5s para requisições duplicadas | +| 🔒 **Spoofing de Fingerprint TLS** | Bypass de detecção de bot via TLS com wreq-js | +| 🌐 **Filtragem de IP** | Allowlist/blocklist para controle de acesso à API | +| 📊 **Rate Limits Editáveis** | RPM, gap mínimo e concorrência máxima configuráveis | +| 🛡 **Proteção de Endpoint API** | Gateway de Auth + bloqueio de provedores para o endpoint `/models` | +| 🔒 **Visibilidade de Proxy** | Badges coloridos: 🟢 global, 🟡 provedor, 🔵 por-conexão com exibição de IP | +| 🌐 **Proxy em 3 Níveis** | Configure proxies em nível global, por provedor ou por conexão | ### 📊 Observabilidade e Analytics @@ -400,6 +402,8 @@ Acesso via: WhatsApp, Telegram, Slack, Discord, iMessage, Signal... | 🔧 **Dashboard CLI Tools** | Configuração em um clique para Claude, Codex, Cline, OpenClaw, Kilo, Antigravity | | 🔄 **Backups de DB** | Backup, restauração, exportação e importação automática de todas as configurações | | 🌐 **Internacionalização** | i18n completo com next-intl — suporte English + Português (Brasil) | +| 🌍 **Seletor de Idioma** | Ícone de globo no cabeçalho para troca de idioma em tempo real (🇺🇸/🇧🇷) | +| 📂 **Diretório de Dados Custom** | Variável `DATA_DIR` para sobrescrever o caminho padrão `~/.omniroute` |
📖 Detalhes das Funcionalidades diff --git a/docs/TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md index 612942e5d8..b0bf8a2d42 100644 --- a/docs/TROUBLESHOOTING.md +++ b/docs/TROUBLESHOOTING.md @@ -11,6 +11,8 @@ Common problems and solutions for OmniRoute. | First login not working | Check `INITIAL_PASSWORD` in `.env` (default: `123456`) | | Dashboard opens on wrong port | Set `PORT=20128` and `NEXT_PUBLIC_BASE_URL=http://localhost:20128` | | No request logs under `logs/` | Set `ENABLE_REQUEST_LOGS=true` | +| EACCES: permission denied | Set `DATA_DIR=/path/to/writable/dir` to override `~/.omniroute` | +| Routing strategy not saving | Update to v1.4.11+ (Zod schema fix for settings persistence) | ---