From d39c46f0a3a6031c9242a67e5d6d0b38f31423ec Mon Sep 17 00:00:00 2001 From: bymyself Date: Tue, 20 May 2025 15:21:38 -0700 Subject: [PATCH] [docs] Add README for glob directory --- glob/README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 glob/README.md diff --git a/glob/README.md b/glob/README.md new file mode 100644 index 00000000..375b7fa7 --- /dev/null +++ b/glob/README.md @@ -0,0 +1,53 @@ +# ComfyUI-Manager: Core Backend (glob) + +This directory contains the Python backend modules that power ComfyUI-Manager, handling the core functionality of node management, downloading, security, and server operations. + +## Core Modules + +- **manager_core.py**: The central implementation of management functions, handling configuration, installation, updates, and node management. +- **manager_server.py**: Implements server functionality and API endpoints for the web interface to interact with the backend. +- **manager_downloader.py**: Handles downloading operations for models, extensions, and other resources. +- **manager_util.py**: Provides utility functions used throughout the system. + +## Specialized Modules + +- **cm_global.py**: Maintains global variables and state management across the system. +- **cnr_utils.py**: Helper utilities for interacting with the custom node registry (CNR). +- **git_utils.py**: Git-specific utilities for repository operations. +- **node_package.py**: Handles the packaging and installation of node extensions. +- **security_check.py**: Implements the multi-level security system for installation safety. +- **share_3rdparty.py**: Manages integration with third-party sharing platforms. + +## Architecture + +The backend follows a modular design pattern with clear separation of concerns: + +1. **Core Layer**: Manager modules provide the primary API and business logic +2. **Utility Layer**: Helper modules provide specialized functionality +3. **Integration Layer**: Modules that connect to external systems + +## Security Model + +The system implements a comprehensive security framework with multiple levels: + +- **Block**: Highest security - blocks most remote operations +- **High**: Allows only specific trusted operations +- **Middle**: Standard security for most users +- **Normal-**: More permissive for advanced users +- **Weak**: Lowest security for development environments + +## Implementation Details + +- The backend is designed to work seamlessly with ComfyUI +- Asynchronous task queuing is implemented for background operations +- The system supports multiple installation modes +- Error handling and risk assessment are integrated throughout the codebase + +## API Integration + +The backend exposes a REST API via `manager_server.py` that enables: +- Custom node management (install, update, disable, remove) +- Model downloading and organization +- System configuration +- Snapshot management +- Workflow component handling \ No newline at end of file