Compare commits
2 Commits
docs/glob-
...
docs/docs-
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f367d0b12d | ||
|
|
b7f60c8c26 |
41
docs/README.md
Normal file
41
docs/README.md
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
# ComfyUI-Manager: Documentation
|
||||||
|
|
||||||
|
This directory contains documentation for the ComfyUI-Manager, providing guides and tutorials for users in multiple languages.
|
||||||
|
|
||||||
|
## Directory Structure
|
||||||
|
|
||||||
|
The documentation is organized into language-specific directories:
|
||||||
|
|
||||||
|
- **en/**: English documentation
|
||||||
|
- **ko/**: Korean documentation
|
||||||
|
|
||||||
|
## Core Documentation Files
|
||||||
|
|
||||||
|
### Command-Line Interface
|
||||||
|
|
||||||
|
- **cm-cli.md**: Documentation for the ComfyUI-Manager Command Line Interface (CLI), which allows using manager functionality without the UI.
|
||||||
|
|
||||||
|
### Advanced Features
|
||||||
|
|
||||||
|
- **use_aria2.md**: Guide for using the aria2 download accelerator with ComfyUI-Manager for faster model downloads.
|
||||||
|
|
||||||
|
## Documentation Standards
|
||||||
|
|
||||||
|
The documentation follows these standards:
|
||||||
|
|
||||||
|
1. **Markdown Format**: All documentation is written in Markdown for easy rendering on GitHub and other platforms
|
||||||
|
2. **Language-specific Directories**: Content is separated by language to facilitate localization
|
||||||
|
3. **Feature-focused Documentation**: Each major feature has its own documentation file
|
||||||
|
4. **Updated with Releases**: Documentation is kept in sync with software releases
|
||||||
|
|
||||||
|
## Contributing to Documentation
|
||||||
|
|
||||||
|
When contributing new documentation:
|
||||||
|
|
||||||
|
1. Place files in the appropriate language directory
|
||||||
|
2. Use clear, concise language appropriate for the target audience
|
||||||
|
3. Include examples where helpful
|
||||||
|
4. Consider adding screenshots or diagrams for complex features
|
||||||
|
5. Maintain consistent formatting with existing documentation
|
||||||
|
|
||||||
|
This documentation directory will continue to grow to support the expanding feature set of ComfyUI-Manager.
|
||||||
@@ -1,53 +0,0 @@
|
|||||||
# 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
|
|
||||||
Reference in New Issue
Block a user