Skip to content

Commit 53f420c

Browse files
committed
docs: update READMEs
1 parent 3619cef commit 53f420c

File tree

9 files changed

+309
-3
lines changed

9 files changed

+309
-3
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -659,6 +659,40 @@ You can customize ComfyUI-Doctor behavior via the ComfyUI Settings panel (Gear i
659659
- Models are automatically fetched from your selected provider's API when you change providers or click refresh.
660660
- For local LLMs (Ollama/LMStudio), the dropdown displays all locally available models.
661661

662+
### 10. Trust & Health
663+
664+
**Function**: View system health status and plugin trust report.
665+
**Usage**: Click the 🔄 refresh button to fetch `/doctor/health` endpoint data.
666+
667+
**Displays**:
668+
669+
- **Pipeline Status**: Current analysis pipeline state
670+
- **SSRF Blocked**: Count of blocked suspicious outbound requests
671+
- **Dropped Logs**: Count of log messages dropped due to backpressure
672+
- **Plugin Trust List**: Shows all detected plugins with trust status badges:
673+
- 🟢 **Trusted**: Allowlisted plugins with valid manifest
674+
- 🟡 **Unsigned**: Plugins without manifest (use with caution)
675+
- 🔴 **Blocked**: Plugins on blocklist
676+
677+
### 11. Anonymous Telemetry (Under Construction 🚧)
678+
679+
**Function**: Opt-in anonymous usage data collection to help improve Doctor.
680+
**Status**: **Under Construction** — Currently local-only, no network upload.
681+
682+
**Controls**:
683+
684+
- **Toggle**: Enable/disable telemetry recording (default: OFF)
685+
- **View Buffer**: Inspect buffered events before upload
686+
- **Clear All**: Delete all buffered telemetry data
687+
- **Export**: Download buffered data as JSON for review
688+
689+
**Privacy Guarantees**:
690+
691+
-**Opt-in only**: No data is recorded until explicitly enabled
692+
-**Local-only**: Currently stores data locally only (`Upload destination: None`)
693+
-**PII detection**: Automatically filters sensitive information
694+
-**Full transparency**: View/export all data before any future upload
695+
662696
---
663697

664698
## API Endpoints

readme/README.de.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -661,6 +661,40 @@ Sie können das Verhalten von ComfyUI-Doctor über das ComfyUI-Einstellungsfeld
661661
- Modelle werden automatisch von der API Ihres ausgewählten Anbieters abgerufen, wenn Sie den Anbieter ändern oder auf Aktualisieren klicken.
662662
- Für lokale LLMs (Ollama/LMStudio) zeigt das Dropdown alle lokal verfügbaren Modelle an.
663663

664+
### 10. Vertrauen & Gesundheit (Trust & Health)
665+
666+
**Funktion**: Systemstatus und Plugin-Vertrauensbericht anzeigen.
667+
**Verwendung**: Klicken Sie auf die Schaltfläche 🔄 Aktualisieren, um `/doctor/health` Daten abzurufen.
668+
669+
**Anzeigen**:
670+
671+
- **Pipeline Status**: Aktueller Status der Analysepipeline
672+
- **SSRF Blocked**: Anzahl blockierter verdächtiger ausgehender Anfragen
673+
- **Dropped Logs**: Anzahl der aufgrund von Backpressure verworfenen Log-Nachrichten
674+
- **Plugin Trust List**: Zeigt alle erkannten Plugins mit Vertrauensstatus-Badges:
675+
- 🟢 **Trusted**: Zugelassene Plugins mit gültigem Manifest
676+
- 🟡 **Unsigned**: Plugins ohne Manifest (mit Vorsicht verwenden)
677+
- 🔴 **Blocked**: Blockierte Plugins
678+
679+
### 11. Anonyme Telemetrie (Im Bau 🚧)
680+
681+
**Funktion**: Opt-in zur Sammlung anonymer Nutzungsdaten zur Verbesserung von Doctor.
682+
**Status**: **Im Bau** — Derzeit nur lokal, kein Netzwerk-Upload.
683+
684+
**Steuerung**:
685+
686+
- **Toggle**: Telemetrieaufzeichnung aktivieren/deaktivieren (Standard: AUS)
687+
- **View Buffer**: Gepufferte Ereignisse vor dem Upload prüfen
688+
- **Clear All**: Alle gepufferten Telemetriedaten löschen
689+
- **Export**: Gepufferte Daten als JSON zur Überprüfung herunterladen
690+
691+
**Datenschutzgarantien**:
692+
693+
-**Nur Opt-in**: Es werden keine Daten aufgezeichnet, bis dies explizit aktiviert wird
694+
-**Nur Lokal**: Speichert Daten derzeit nur lokal (`Upload destination: None`)
695+
-**PII-Erkennung**: Filtert sensible Daten automatisch
696+
-**Volle Transparenz**: Alle Daten vor jedem zukünftigen Upload anzeigen/exportieren
697+
664698
---
665699

666700
## API-Endpunkte

readme/README.es.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -659,7 +659,41 @@ Puede personalizar el comportamiento de ComfyUI-Doctor a través del panel de Co
659659
- **Modo Menú Desplegable** (predeterminado): Seleccione un modelo de la lista poblada automáticamente. Haga clic en el botón de actualización 🔄 para recargar los modelos disponibles.
660660
- **Modo Entrada Manual**: Marque "Ingresar nombre de modelo manualmente" para escribir un nombre de modelo personalizado (ej. `gpt-4o`, `deepseek-chat`, `llama3.1:8b`).
661661
- Los modelos se obtienen automáticamente de la API de su proveedor seleccionado cuando cambia de proveedor o hace clic en actualizar.
662-
- Para LLM locales (Ollama/LMStudio), el menú desplegable muestra todos los modelos disponibles localmente.
662+
- Para LLMs locales (Ollama/LMStudio), el desplegable muestra todos los modelos disponibles localmente.
663+
664+
### 10. Confianza y Salud (Trust & Health)
665+
666+
**Función**: Ver el estado de salud del sistema y el informe de confianza de los plugins.
667+
**Uso**: Haga clic en el botón de actualizar 🔄 para obtener datos de `/doctor/health`.
668+
669+
**Muestra**:
670+
671+
- **Pipeline Status**: Estado actual de la tubería de análisis
672+
- **SSRF Blocked**: Recuento de solicitudes salientes sospechosas bloqueadas
673+
- **Dropped Logs**: Recuento de mensajes de registro descartados debido a la contrapresión
674+
- **Plugin Trust List**: Muestra todos los plugins detectados con insignias de estado:
675+
- 🟢 **Trusted**: Plugins en lista blanca con manifiesto válido
676+
- 🟡 **Unsigned**: Plugins sin manifiesto (usar con precaución)
677+
- 🔴 **Blocked**: Plugins en lista negra
678+
679+
### 11. Telemetría Anónima (En Construcción 🚧)
680+
681+
**Función**: Optar por la recopilación de datos de uso anónimos para ayudar a mejorar Doctor.
682+
**Estado**: **En Construcción** — Actualmente solo local, sin carga de red.
683+
684+
**Controles**:
685+
686+
- **Toggle**: Activar/desactivar el registro de telemetría (predeterminado: OFF)
687+
- **View Buffer**: Inspeccionar eventos almacenados en búfer antes de cargar
688+
- **Clear All**: Eliminar todos los datos de telemetría almacenados en búfer
689+
- **Export**: Descargar datos almacenados en búfer como JSON para revisión
690+
691+
**Garantías de Privacidad**:
692+
693+
-**Solo Opt-in**: No se registran datos hasta que se activa explícitamente
694+
-**Solo Local**: Actualmente almacena datos solo localmente (`Upload destination: None`)
695+
-**Detección PII**: Filtra automáticamente información sensible
696+
-**Transparencia Total**: Ver/exportar todos los datos antes de cualquier carga futura
663697

664698
---
665699

readme/README.fr.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -661,6 +661,40 @@ Vous pouvez personnaliser le comportement de ComfyUI-Doctor via le panneau Param
661661
- Les modèles sont automatiquement récupérés depuis l'API de votre fournisseur sélectionné lorsque vous changez de fournisseur ou cliquez sur actualiser.
662662
- Pour les LLM locaux (Ollama/LMStudio), la liste déroulante affiche tous les modèles disponibles localement.
663663

664+
### 10. Confiance et Santé (Trust & Health)
665+
666+
**Fonction** : Voir l'état de santé du système et le rapport de confiance des plugins.
667+
**Utilisation** : Cliquez sur le bouton 🔄 d'actualisation pour récupérer les données `/doctor/health`.
668+
669+
**Affichages** :
670+
671+
- **Pipeline Status** : État actuel du pipeline d'analyse
672+
- **SSRF Blocked** : Nombre de requêtes sortantes suspectes bloquées
673+
- **Dropped Logs** : Nombre de messages de journal rejetés en raison de la contre-pression
674+
- **Plugin Trust List** : Affiche tous les plugins détectés avec des badges de statut :
675+
- 🟢 **Trusted** : Plugins sur liste blanche avec manifeste valide
676+
- 🟡 **Unsigned** : Plugins sans manifeste (utiliser avec prudence)
677+
- 🔴 **Blocked** : Plugins sur liste noire
678+
679+
### 11. Télémétrie Anonyme (En Construction 🚧)
680+
681+
**Fonction** : Participer à la collecte de données d'utilisation anonymes pour aider à améliorer Doctor.
682+
**Statut** : **En Construction** — Actuellement local uniquement, aucun téléchargement réseau.
683+
684+
**Commandes** :
685+
686+
- **Toggle** : Activer/désactiver l'enregistrement de la télémétrie (par défaut : OFF)
687+
- **View Buffer** : Inspecter les événements mis en mémoire tampon avant le téléchargement
688+
- **Clear All** : Supprimer toutes les données de télémétrie mises en mémoire tampon
689+
- **Export** : Télécharger les données mises en mémoire tampon au format JSON pour examen
690+
691+
**Garanties de Confidentialité** :
692+
693+
-**Opt-in uniquement** : Aucune donnée n'est enregistrée tant qu'elle n'est pas explicitement activée
694+
-**Local uniquement** : Stocke actuellement les données localement uniquement (`Upload destination: None`)
695+
-**Détection PII** : Filtre automatiquement les informations sensibles
696+
-**Transparence totale** : Voir/exporter toutes les données avant tout futur téléchargement
697+
664698
---
665699

666700
## Points de terminaison API

readme/README.it.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -659,7 +659,41 @@ Puoi personalizzare il comportamento di ComfyUI-Doctor tramite il pannello Impos
659659
- **Modalità Dropdown** (default): Seleziona un modello dalla lista popolata automaticamente. Clicca il pulsante di aggiornamento 🔄 per ricaricare i modelli disponibili.
660660
- **Modalità Input Manuale**: Spunta "Inserisci nome modello manualmente" per digitare un nome modello personalizzato (es. `gpt-4o`, `deepseek-chat`, `llama3.1:8b`).
661661
- I modelli vengono recuperati automaticamente dall'API del tuo provider selezionato quando cambi provider o clicchi aggiorna.
662-
- Per LLM locali (Ollama/LMStudio), il dropdown mostra tutti i modelli disponibili localmente.
662+
- Per gli LLM locali (Ollama/LMStudio), il menu a discesa mostra tutti i modelli disponibili localmente.
663+
664+
### 10. Fiducia e Salute (Trust & Health)
665+
666+
**Funzione**: Visualizza lo stato di salute del sistema e il rapporto di fiducia dei plugin.
667+
**Utilizzo**: Clicca sul pulsante di aggiornamento 🔄 per recuperare i dati di `/doctor/health`.
668+
669+
**Visualizza**:
670+
671+
- **Pipeline Status**: Stato attuale della pipeline di analisi
672+
- **SSRF Blocked**: Conteggio delle richieste in uscita sospette bloccate
673+
- **Dropped Logs**: Conteggio dei messaggi di log scartati a causa della contropressione
674+
- **Plugin Trust List**: Mostra tutti i plugin rilevati con badge di stato:
675+
- 🟢 **Trusted**: Plugin in whitelist con manifesto valido
676+
- 🟡 **Unsigned**: Plugin senza manifesto (usare con cautela)
677+
- 🔴 **Blocked**: Plugin in blacklist
678+
679+
### 11. Telemetria Anonima (In Costruzione 🚧)
680+
681+
**Funzione**: Adesione facoltativa alla raccolta di dati anonimi sull'utilizzo per aiutare a migliorare Doctor.
682+
**Stato**: **In Costruzione** — Attualmente solo locale, nessun caricamento in rete.
683+
684+
**Controlli**:
685+
686+
- **Toggle**: Abilita/disabilita la registrazione della telemetria (default: OFF)
687+
- **View Buffer**: Ispeziona gli eventi nel buffer prima del caricamento
688+
- **Clear All**: Elimina tutti i dati di telemetria nel buffer
689+
- **Export**: Scarica i dati nel buffer come JSON per la revisione
690+
691+
**Garanzie di Privacy**:
692+
693+
-**Solo Opt-in**: Nessun dato viene registrato fino all'attivazione esplicita
694+
-**Solo Locale**: Attualmente memorizza i dati solo localmente (`Upload destination: None`)
695+
-**Rilevamento PII**: Filtra automaticamente le informazioni sensibili
696+
-**Trasparenza Totale**: Visualizza/esporta tutti i dati prima di qualsiasi caricamento futuro
663697

664698
---
665699

readme/README.ja.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -661,6 +661,40 @@ ComfyUIの設定パネル(歯車アイコン)からComfyUI-Doctorの動作
661661
- プロバイダーを変更したり更新をクリックしたりすると、選択したプロバイダーのAPIからモデルが自動的に取得されます。
662662
- ローカルLLM(Ollama/LMStudio)の場合、ドロップダウンにはローカルで利用可能なすべてのモデルが表示されます。
663663

664+
### 10. 信頼性と健全性 (Trust & Health)
665+
666+
**機能**: システムの健全性ステータスとプラグイン信頼レポートを表示します。
667+
**使用法**: 🔄 更新ボタンをクリックして `/doctor/health` エンドポイントのデータを取得します。
668+
669+
**表示内容**:
670+
671+
- **Pipeline Status**: 現在の分析パイプラインの状態
672+
- **SSRF Blocked**: ブロックされた疑わしいアウトバウンドリクエストの数
673+
- **Dropped Logs**: バックプレッシャーによりドロップされたログメッセージの数
674+
- **Plugin Trust List**: 検出されたすべてのプラグインと信頼ステータスバッジを表示:
675+
- 🟢 **Trusted**: 有効なマニフェストを持つ許可リスト登録済みプラグイン
676+
- 🟡 **Unsigned**: マニフェストのないプラグイン (注意して使用してください)
677+
- 🔴 **Blocked**: ブロックリスト登録済みプラグイン
678+
679+
### 11. 匿名テレメトリ (建設中 🚧)
680+
681+
**機能**: Doctorの改善に役立つ匿名使用状況データの収集へのオプトイン。
682+
**ステータス**: **建設中** — 現在はローカル保存のみで、ネットワークアップロードはありません。
683+
684+
**コントロール**:
685+
686+
- **Toggle**: テレメトリ記録の有効化/無効化 (デフォルト: OFF)
687+
- **View Buffer**: アップロード前にバッファされたイベントを検査
688+
- **Clear All**: バッファされたすべてのテレメトリデータを削除
689+
- **Export**: レビュー用にバッファされたデータをJSONとしてダウンロード
690+
691+
**プライバシー保証**:
692+
693+
-**オプトインのみ**: 明示的に有効にするまでデータは記録されません
694+
-**ローカルのみ**: 現在はデータをローカルにのみ保存します (`Upload destination: None`)
695+
-**PII 検出**: 機密情報を自動的にフィルタリングします
696+
-**完全な透明性**: 将来のアップロードの前にすべてのデータを表示/エクスポート
697+
664698
---
665699

666700
## APIエンドポイント

readme/README.ko.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -659,7 +659,41 @@ ComfyUI 설정 패널(톱니바퀴 아이콘)을 통해 ComfyUI-Doctor 동작을
659659
- **드롭다운 모드** (기본값): 자동으로 채워진 드롭다운 목록에서 모델을 선택합니다. 🔄 새로 고침 버튼을 클릭하여 사용 가능한 모델을 다시 로드합니다.
660660
- **수동 입력 모드**: "Enter model name manually"를 체크하여 사용자 지정 모델 이름(예: `gpt-4o`, `deepseek-chat`, `llama3.1:8b`)을 입력합니다.
661661
- 공급자를 변경하거나 새로 고침을 클릭하면 선택한 공급자의 API에서 모델을 자동으로 가져옵니다.
662-
- 로컬 LLM(Ollama/LMStudio)의 경우 드롭다운에 로컬에서 사용 가능한 모든 모델이 표시됩니다.
662+
- 로컬 LLM(Ollama/LMStudio)의 경우, 드롭다운에 로컬에서 사용 가능한 모든 모델이 표시됩니다.
663+
664+
### 10. 신뢰 및 상태 (Trust & Health)
665+
666+
**기능**: 시스템 상태 및 플러그인 신뢰 보고서를 봅니다.
667+
**사용법**: 🔄 새로 고침 버튼을 클릭하여 `/doctor/health` 데이터를 가져옵니다.
668+
669+
**표시 내용**:
670+
671+
- **Pipeline Status**: 현재 분석 파이프라인 상태
672+
- **SSRF Blocked**: 차단된 의심스러운 아웃바운드 요청 수
673+
- **Dropped Logs**: 배압(backpressure)으로 인해 삭제된 로그 메시지 수
674+
- **Plugin Trust List**: 신뢰 상태 배지와 함께 감지된 모든 플러그인 표시:
675+
- 🟢 **Trusted**: 유효한 매니페스트가 있는 허용 목록 플러그인
676+
- 🟡 **Unsigned**: 매니페스트가 없는 플러그인 (주의해서 사용)
677+
- 🔴 **Blocked**: 차단 목록에 있는 플러그인
678+
679+
### 11. 익명 원격 측정 (공사 중 🚧)
680+
681+
**기능**: Doctor 개선을 돕기 위해 익명 사용 데이터 수집에 참여합니다.
682+
**상태**: **공사 중** — 현재 로컬 전용이며 네트워크 업로드 없음.
683+
684+
**제어**:
685+
686+
- **Toggle**: 원격 측정 기록 활성화/비활성화 (기본값: OFF)
687+
- **View Buffer**: 업로드 전 버퍼링된 이벤트 검사
688+
- **Clear All**: 버퍼링된 모든 원격 측정 데이터 삭제
689+
- **Export**: 검토를 위해 버퍼링된 데이터를 JSON으로 다운로드
690+
691+
**개인정보 보호 보장**:
692+
693+
-**수신 동의(Opt-in) 전용**: 명시적으로 활성화할 때까지 데이터가 기록되지 않음
694+
-**로컬 전용**: 현재 로컬에만 데이터 저장 (`Upload destination: None`)
695+
-**PII 감지**: 민감한 정보를 자동으로 필터링
696+
-**완전한 투명성**: 향후 업로드 전에 모든 데이터 보기/내보내기.
663697

664698
---
665699

readme/README.zh-CN.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -509,6 +509,40 @@ ComfyUI-Doctor 整合了主流 LLM 服务,提供智能化、上下文感知的
509509
- 当您变更提供商或点击重新整理时,模型会自动从所选提供商的 API 获取。
510510
- 对于本地 LLM(Ollama/LMStudio),下拉菜单会显示所有本地可用的模型。
511511

512+
### 10. 信任与健康状态 (Trust & Health)
513+
514+
**功能**:查看系统健康状态和插件信任报告。
515+
**用法**:点击 🔄 刷新按钮以获取 `/doctor/health` 端点数据。
516+
517+
**显示内容**
518+
519+
- **Pipeline Status**:当前的分析管线状态
520+
- **SSRF Blocked**:被拦截的可疑外连请求计数
521+
- **Dropped Logs**:因背压 (backpressure) 而丢弃的日志消息计数
522+
- **Plugin Trust List**:显示所有检测到的插件及其信任状态标记:
523+
- 🟢 **Trusted**:已列入白名单且具备有效清单的插件
524+
- 🟡 **Unsigned**:无清单的插件(请谨慎使用)
525+
- 🔴 **Blocked**:列入黑名单的插件
526+
527+
### 11. 匿名遥测 (建设中 🚧)
528+
529+
**功能**:选择性加入匿名使用数据收集,以协助改进 Doctor。
530+
**状态****建设中** — 目前仅本地存储,无网络上传。
531+
532+
**控制项**
533+
534+
- **Toggle**:启用/禁用遥测记录(默认:关闭)
535+
- **View Buffer**:在上传前检查缓冲的事件
536+
- **Clear All**:删除所有缓冲的遥测数据
537+
- **Export**:下载缓冲数据为 JSON 以供审查
538+
539+
**隐私保证**
540+
541+
-**仅限加入**:除非显式启用,否则不会记录任何数据
542+
-**仅限本地**:目前仅将数据存储在本地 (`Upload destination: None`)
543+
-**PII 检测**:自动过滤敏感信息
544+
-**完全透明**:在任何未来上传之前查看/导出所有数据
545+
512546
### 10. Privacy Mode (隐私模式)
513547

514548
**功能**:设定发送至云端 AI 服务时的 PII (个人识别信息) 净化等级。

readme/README.zh-TW.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -509,6 +509,40 @@ ComfyUI-Doctor 整合了主流 LLM 服務,提供智能化、上下文感知的
509509
- 當您變更提供商或點擊重新整理時,模型會自動從所選提供商的 API 取得。
510510
- 對於本地 LLM(Ollama/LMStudio),下拉選單會顯示所有本地可用的模型。
511511

512+
### 10. 信任與健康狀態 (Trust & Health)
513+
514+
**功能**:查看系統健康狀態和插件信任報告。
515+
**用法**:點擊 🔄 重新整理按鈕以獲取 `/doctor/health` 端點數據。
516+
517+
**顯示內容**
518+
519+
- **Pipeline Status**:目前的分析管線狀態
520+
- **SSRF Blocked**:被攔截的可疑外連請求計數
521+
- **Dropped Logs**:因背壓 (backpressure) 而丟棄的日誌訊息計數
522+
- **Plugin Trust List**:顯示所有檢測到的插件及其信任狀態標記:
523+
- 🟢 **Trusted**:已列入白名單且具備有效清單的插件
524+
- 🟡 **Unsigned**:無清單的插件(請謹慎使用)
525+
- 🔴 **Blocked**:列入黑名單的插件
526+
527+
### 11. 匿名遙測 (建設中 🚧)
528+
529+
**功能**:選擇性加入匿名使用數據收集,以協助改進 Doctor。
530+
**狀態****建設中** — 目前僅本地存儲,無網絡上傳。
531+
532+
**控制項**
533+
534+
- **Toggle**:啟用/禁用遙測記錄(預設:關閉)
535+
- **View Buffer**:在上傳前檢查緩衝的事件
536+
- **Clear All**:刪除所有緩衝的遙測數據
537+
- **Export**:下載緩衝數據為 JSON 以供審查
538+
539+
**隱私保證**
540+
541+
-**僅限加入**:除非顯式啟用,否則不會記錄任何數據
542+
-**僅限本地**:目前僅將數據存儲在本地 (`Upload destination: None`)
543+
-**PII 檢測**:自動過濾敏感信息
544+
-**完全透明**:在任何未來上傳之前查看/導出所有數據
545+
512546
### 10. Privacy Mode (隱私模式)
513547

514548
**功能**:設定發送至雲端 AI 服務時的 PII (個人識別資訊) 淨化等級。

0 commit comments

Comments
 (0)