diff --git a/docs.json b/docs.json index 033c821e..da76b1df 100644 --- a/docs.json +++ b/docs.json @@ -45,9 +45,7 @@ { "group": "Cloud Features", "icon": "cloud", - "pages": [ - "cloud/import-models" - ] + "pages": ["cloud/import-models"] }, "installation/install_custom_node", "get_started/first_generation" @@ -93,6 +91,23 @@ "interface/settings/about", "interface/settings/server-config" ] + }, + { + "group": "ComfyUI-Manager", + "icon": "puzzle-piece", + "pages": [ + "manager/overview", + "manager/install", + { + "group": "Node Management", + "pages": [ + "manager/pack-management", + "manager/legacy-ui" + ] + }, + "manager/configuration", + "manager/troubleshooting" + ] } ] }, @@ -745,6 +760,23 @@ "zh-CN/interface/settings/about", "zh-CN/interface/settings/server-config" ] + }, + { + "group": "ComfyUI-Manager", + "icon": "puzzle-piece", + "pages": [ + "zh-CN/manager/overview", + "zh-CN/manager/install", + { + "group": "自定义节点管理", + "pages": [ + "zh-CN/manager/pack-management", + "zh-CN/manager/legacy-ui" + ] + }, + "zh-CN/manager/configuration", + "zh-CN/manager/troubleshooting" + ] } ] }, diff --git a/images/manager/manager_button.jpg b/images/manager/manager_button.jpg new file mode 100644 index 00000000..fd162ba6 Binary files /dev/null and b/images/manager/manager_button.jpg differ diff --git a/images/manager/manager_entry.jpg b/images/manager/manager_entry.jpg new file mode 100644 index 00000000..a17f838d Binary files /dev/null and b/images/manager/manager_entry.jpg differ diff --git a/images/manager/manager_install_node.jpg b/images/manager/manager_install_node.jpg new file mode 100644 index 00000000..42191f81 Binary files /dev/null and b/images/manager/manager_install_node.jpg differ diff --git a/images/manager/manager_list.jpg b/images/manager/manager_list.jpg new file mode 100644 index 00000000..a7a0e801 Binary files /dev/null and b/images/manager/manager_list.jpg differ diff --git a/images/manager/manager_use_legacy_manager_ui.png b/images/manager/manager_use_legacy_manager_ui.png new file mode 100644 index 00000000..32f7888b Binary files /dev/null and b/images/manager/manager_use_legacy_manager_ui.png differ diff --git a/images/manager/manger_missing_nodes-1.jpg b/images/manager/manger_missing_nodes-1.jpg new file mode 100644 index 00000000..c688b79d Binary files /dev/null and b/images/manager/manger_missing_nodes-1.jpg differ diff --git a/images/manager/manger_missing_nodes-2.jpg b/images/manager/manger_missing_nodes-2.jpg new file mode 100644 index 00000000..4faa12ae Binary files /dev/null and b/images/manager/manger_missing_nodes-2.jpg differ diff --git a/images/manager/manger_missing_nodes-3.jpg b/images/manager/manger_missing_nodes-3.jpg new file mode 100644 index 00000000..65cbb80b Binary files /dev/null and b/images/manager/manger_missing_nodes-3.jpg differ diff --git a/images/manager/manger_node_version.jpg b/images/manager/manger_node_version.jpg new file mode 100644 index 00000000..6fe12936 Binary files /dev/null and b/images/manager/manger_node_version.jpg differ diff --git a/images/manager/manger_remove_nodes.jpg b/images/manager/manger_remove_nodes.jpg new file mode 100644 index 00000000..cd1d5cb1 Binary files /dev/null and b/images/manager/manger_remove_nodes.jpg differ diff --git a/images/manager/new_ui_filter.jpg b/images/manager/new_ui_filter.jpg new file mode 100644 index 00000000..56b4a44c Binary files /dev/null and b/images/manager/new_ui_filter.jpg differ diff --git a/images/manager/new_ui_install_pack.jpg b/images/manager/new_ui_install_pack.jpg new file mode 100644 index 00000000..60b70292 Binary files /dev/null and b/images/manager/new_ui_install_pack.jpg differ diff --git a/images/manager/new_ui_labeled.jpg b/images/manager/new_ui_labeled.jpg new file mode 100644 index 00000000..3ccf2a18 Binary files /dev/null and b/images/manager/new_ui_labeled.jpg differ diff --git a/images/manager/new_ui_missing_pack.jpg b/images/manager/new_ui_missing_pack.jpg new file mode 100644 index 00000000..6e36d87b Binary files /dev/null and b/images/manager/new_ui_missing_pack.jpg differ diff --git a/images/manager/new_ui_missing_packs_prompt.jpg b/images/manager/new_ui_missing_packs_prompt.jpg new file mode 100644 index 00000000..04433168 Binary files /dev/null and b/images/manager/new_ui_missing_packs_prompt.jpg differ diff --git a/images/manager/new_ui_uninstall_pack.jpg b/images/manager/new_ui_uninstall_pack.jpg new file mode 100644 index 00000000..0f6a9ad8 Binary files /dev/null and b/images/manager/new_ui_uninstall_pack.jpg differ diff --git a/images/manager/new_ui_update_pack.jpg b/images/manager/new_ui_update_pack.jpg new file mode 100644 index 00000000..4428c874 Binary files /dev/null and b/images/manager/new_ui_update_pack.jpg differ diff --git a/manager/configuration.mdx b/manager/configuration.mdx new file mode 100644 index 00000000..cdea63a8 --- /dev/null +++ b/manager/configuration.mdx @@ -0,0 +1,138 @@ +--- +title: Configuration +sidebarTitle: Config +description: Configure ComfyUI-Manager settings +--- + +## Configuration paths + +Starting from V3.38, Manager uses a protected system path for enhanced security. + +| ComfyUI Version | Manager Path | +|-----------------|--------------| +| v0.3.76+ (with System User API) | `/__manager/` | +| Older versions | `/default/ComfyUI-Manager/` | + + +If executed without any options, the `` path defaults to `ComfyUI/user`. It can be set using `--user-directory `. + + +### Configuration files + +| File | Description | +|------|-------------| +| `config.ini` | Basic configuration | +| `channels.list` | Configurable channel lists | +| `pip_overrides.json` | Custom pip package mappings | +| `pip_blacklist.list` | Packages to prevent installation | +| `pip_auto_fix.list` | Packages to auto-restore | +| `snapshots/` | Saved snapshot files | +| `startup-scripts/` | Startup script files | +| `components/` | Component files | + +## Config.ini options + +Modify the `config.ini` file to apply settings. The path is displayed in startup log messages. + +```ini +[default] +git_exe = +use_uv = +default_cache_as_channel_url = +bypass_ssl = +file_logging = +windows_selector_event_loop_policy = +model_download_by_agent = +downgrade_blacklist = +security_level = +always_lazy_install = +network_mode = +``` + +### Network modes + +| Mode | Description | +|------|-------------| +| `public` | Standard public network environment | +| `private` | Closed network with private node DB configured via `channel_url` (uses cache if available) | +| `offline` | No external connections (uses cache if available) | + +### Security levels + +| Level | Description | +|-------|-------------| +| `strong` | Doesn't allow high and middle level risky features | +| `normal` | Doesn't allow high level risky features; middle level features available | +| `normal-` | Doesn't allow high level risky features if `--listen` is specified and not starts with `127.`; middle level features available | +| `weak` | All features available | + +#### Risk levels for features + +| Risk Level | Features | +|------------|----------| +| **High** | Install via git url, pip install, installation of custom nodes not in default channel, fix custom nodes | +| **Middle** | Uninstall/Update, installation of custom nodes in default channel, restore/remove snapshot, restart | +| **Low** | Update ComfyUI | + +## Environment variables + +| Variable | Description | +|----------|-------------| +| `COMFYUI_PATH` | Installation path of ComfyUI | +| `GITHUB_ENDPOINT` | Reverse proxy for GitHub access | +| `HF_ENDPOINT` | Reverse proxy for Hugging Face access | + +### Examples + +Redirecting GitHub requests through a proxy: +```bash +GITHUB_ENDPOINT=https://mirror.ghproxy.com/https://github.com +``` + +Changing Hugging Face endpoint: +```bash +HF_ENDPOINT=https://some-hf-mirror.com +``` + +## Advanced configuration + +### Prevent downgrade of specific packages + +List package names in the `downgrade_blacklist` section of `config.ini`, separated by commas: + +```ini +downgrade_blacklist = diffusers, kornia +``` + +### Custom pip mapping + +Create a `pip_overrides.json` file to change the installation of specific pip packages to user-defined installations. Refer to `pip_overrides.json.template` for the format. + +### Prevent installation of specific pip packages + +List package names one per line in the `pip_blacklist.list` file. + +### Automatically restore pip installation + +List pip spec requirements in `pip_auto_fix.list` (similar to `requirements.txt`). It will automatically restore specified versions when starting ComfyUI or when versions get mismatched during custom node installations. `--index-url` can be used. + +### Use aria2 as downloader + +For faster downloads, you can configure ComfyUI-Manager to use aria2. See the [aria2 setup guide](https://github.com/ltdrdata/ComfyUI-Manager/blob/main/docs/en/use_aria2.md). + +## extra_model_paths.yaml configuration + +The following settings are applied based on the section marked as `is_default`: + +- `custom_nodes`: Path for installing custom nodes +- `download_model_base`: Path for downloading models + +## CLI tools + +ComfyUI-Manager provides `cm-cli`, a command line tool that allows you to use Manager features without running ComfyUI. This is useful for automating custom node installation and managing installations in headless environments. + +For detailed cm-cli documentation, see the [official cm-cli guide](https://github.com/ltdrdata/ComfyUI-Manager/blob/main/docs/en/cm-cli.md). + +For a more comprehensive CLI experience, consider using [comfy-cli](/comfy-cli/getting-started). + + diff --git a/manager/install.mdx b/manager/install.mdx new file mode 100644 index 00000000..303cb8f4 --- /dev/null +++ b/manager/install.mdx @@ -0,0 +1,145 @@ +--- +title: ComfyUI-Manager Installation +sidebarTitle: Install +description: How to install ComfyUI-Manager for different setups +--- + +## Desktop users + +If you're using [ComfyUI Desktop](/installation/desktop/windows), ComfyUI-Manager is already included and enabled by default. No additional installation is required. + +## Portable users + +For users running the [Windows Portable](/installation/comfyui_portable_windows) version, the new ComfyUI-Manager is built into ComfyUI core but needs to be enabled. + +1. Install the manager dependencies: + ```bash + .\python_embeded\python.exe -m pip install -r ComfyUI\manager_requirements.txt + ``` + +2. Launch ComfyUI with the manager enabled: + ```bash + .\python_embeded\python.exe -s ComfyUI\main.py --windows-standalone-build --enable-manager + pause + ``` + +## Manual install users + +For users with a [manual installation](/installation/manual_install), the new ComfyUI-Manager is built into ComfyUI core but needs to be enabled. + +1. Activate your virtual environment: + ```bash + # Windows + venv\Scripts\activate + + # Linux/macOS + source venv/bin/activate + ``` + +2. Install the manager dependencies: + ```bash + pip install -r manager_requirements.txt + ``` + +3. Enable the manager with the `--enable-manager` flag when running ComfyUI: + ```bash + python main.py --enable-manager + ``` + +### Command line options + +| Flag | Description | +|------|-------------| +| `--enable-manager` | Enable ComfyUI-Manager | +| `--enable-manager-legacy-ui` | Use the legacy manager UI instead of the new UI (requires `--enable-manager`) | +| `--disable-manager-ui` | Disable the manager UI and endpoints while keeping background features (requires `--enable-manager`) | + +### Switch between new and legacy UI + +The following version updates only support pip installations. Versions installed via custom nodes do not support switching to the new UI. + + + +To use the new UI: +```bash +python main.py --enable-manager +``` + +To use the legacy UI: +```bash +python main.py --enable-manager --enable-manager-legacy-ui +``` + + + +Desktop users can switch to the legacy UI in **Server Settings → UI Settings → Use legacy manager interface** +![Switch to legacy UI](/images/manager/manager_use_legacy_manager_ui.png) + + + +## Legacy installation methods + + +To install ComfyUI-Manager in addition to an existing installation of ComfyUI: + +1. Navigate to `ComfyUI/custom_nodes` directory in terminal +2. Clone the repository: + ```bash + git clone https://github.com/ltdrdata/ComfyUI-Manager comfyui-manager + ``` +3. Install the manager dependencies: + ```bash + cd comfyui-manager + pip install -r requirements.txt + ``` +4. Restart ComfyUI + + + +1. Install [Git for Windows](https://git-scm.com/download/win) (standalone version, select "use windows default console window") +2. Download [install-manager-for-portable-version.bat](https://github.com/ltdrdata/ComfyUI-Manager/raw/main/scripts/install-manager-for-portable-version.bat) into your `ComfyUI_windows_portable` directory +3. Double-click the batch file to install + + + +comfy-cli provides various features to manage ComfyUI from the CLI. + +**Prerequisites**: Python 3, Git + +**Windows:** +```bash +python -m venv venv +venv\Scripts\activate +pip install comfy-cli +comfy install +``` + +**Linux/macOS:** +```bash +python -m venv venv +. venv/bin/activate +pip install comfy-cli +comfy install +``` + +See also: [comfy-cli documentation](/comfy-cli/getting-started) + + + +**Prerequisites**: python-is-python3, python3-venv, git + +1. Download [install-comfyui-venv-linux.sh](https://github.com/comfy-org/ComfyUI-Manager/raw/main/scripts/install-comfyui-venv-linux.sh) into an empty install directory +2. Run: + ```bash + chmod +x install-comfyui-venv-linux.sh + ./install-comfyui-venv-linux.sh + ``` +3. Execute ComfyUI with `./run_gpu.sh` or `./run_cpu.sh` + + + +**Installation precautions:** +- ComfyUI-Manager files must be accurately located in the path `ComfyUI/custom_nodes/comfyui-manager` +- Do not decompress directly into `ComfyUI/custom_nodes` (files like `__init__.py` should not be in that directory) +- Do not install in paths like `ComfyUI/custom_nodes/ComfyUI-Manager/ComfyUI-Manager` or `ComfyUI/custom_nodes/ComfyUI-Manager-main` + diff --git a/manager/legacy-ui.mdx b/manager/legacy-ui.mdx new file mode 100644 index 00000000..3d64a583 --- /dev/null +++ b/manager/legacy-ui.mdx @@ -0,0 +1,104 @@ +--- +title: Managing custom nodes with ComfyUI-Manager (legacy UI) +sidebarTitle: legacy UI +description: Install, update, and manage custom nodes with ComfyUI-Manager using the legacy interface +--- + +## ComfyUI custom node management +Learn how to install custom nodes through Manager + +### Install nodes + + + + Click the **Manager** button on the main menu (top bar). + ![Manager button](/images/manager/manager_button.jpg) + + + ![Manager entry](/images/manager/manager_entry.jpg) + + + ![Manager list](/images/manager/manager_list.jpg) + + + ![Node install dialog](/images/manager/manager_install_node.jpg) + 1. Prefer **latest** version if available + 2. Click **Select** to install the node + + - Version numbers with digits are versions published by authors to [registry](https://registry.comfy.org/), equivalent to stable releases + - nightly is the latest version updated by authors to github, equivalent to development version, usually not security scanned, with unstable factors + + ComfyUI's default security settings do not allow direct installation of **nightly** versions. You can refer to [Security Policy](/manager/troubleshooting#security-policy) for details + + + + After clicking install, Manager will automatically complete dependency installation and prompt you to restart ComfyUI after installation is complete + ![Restart ComfyUI and refresh browser after installation](/images/installation/custom_nodes/install-custom-nodes-by-manager-7.jpg) + ![Restart ComfyUI and refresh browser after installation](/images/installation/custom_nodes/install-custom-nodes-by-manager-8.jpg) + + + After restarting, check in ComfyUI Manager whether the corresponding plugin was installed successfully, and whether there are `import failed` error messages + ![Check if plugin was installed successfully](/images/installation/custom_nodes/install-custom-nodes-by-manager-9.jpg) + + + +### Install missing nodes + +Missing nodes are a common situation when loading workflows. There are usually two types of missing nodes: +1. Core node missing: ComfyUI version is not the latest version, please refer to [Update ComfyUI](/installation/update_comfyui) to update ComfyUI +2. Custom node missing: Third-party custom nodes are missing, you can refer to this guide for installation + +After ComfyUI-Manager is installed, if there are missing custom nodes when importing workflows, you will be alerted about the missing node information + +![Missing nodes prompt](/images/manager/manger_missing_nodes-1.jpg) +1. Click **Open Manager** to activate the corresponding option + +![Missing nodes prompt](/images/manager/manger_missing_nodes-2.jpg) +2. Click **Install Missing Custom Nodes** in the Manager menu to enter the missing nodes list interface + +![Missing nodes prompt](/images/manager/manger_missing_nodes-3.jpg) +3. View and install the corresponding nodes in the node list + + +If you find that the missing nodes list cannot find the corresponding node, there are usually several situations: +1. The corresponding node author has not submitted and registered the custom node to [registry](/registry/overview) +2. The corresponding node is not open source, it may be a restricted node from certain authors or limited platforms +3. The original author changed the version and deleted the corresponding node + + +### Update nodes +![Node version](/images/manager/manger_node_version.jpg) +1. Switch the filter to **Update** filter to filter nodes that can be updated in the current node list +2. Click the **Update** button to update the node + +### Uninstall nodes + +![Uninstall nodes](/images/manager/manger_remove_nodes.jpg) +1. Select the "Installed" filter in the node list to filter installed nodes in the current node list +2. Right-click the corresponding node and select **Uninstall** to uninstall + +> Uninstalling the corresponding node will not remove the corresponding dependency installation + +For other methods of installing plugins, please refer to the article below + + + Learn how to manually install custom nodes + + +## Snapshot manager + +Snapshots save your current installation status, allowing you to restore to a previous state. + +![Snapshot manager](https://raw.githubusercontent.com/ltdrdata/ComfyUI-extension-tutorials/Main/ComfyUI-Manager/images/snapshot.jpg) + +Snapshots are automatically saved when you press **Save snapshot** or use **Update All**. Snapshot files are stored in: `/default/ComfyUI-Manager/snapshots` + +To restore: Open the Snapshot Manager, select a snapshot, and press **Restore**. + + +Restoration takes effect on the next ComfyUI startup. For custom nodes not managed by Git, snapshot support is incomplete. + diff --git a/manager/overview.mdx b/manager/overview.mdx new file mode 100644 index 00000000..839aafe8 --- /dev/null +++ b/manager/overview.mdx @@ -0,0 +1,36 @@ +--- +title: Overview +sidebarTitle: Overview +description: An extension to manage custom nodes, models, and more in ComfyUI +--- + +**ComfyUI-Manager** is an extension designed to enhance the usability of [ComfyUI](https://github.com/comfyanonymous/ComfyUI). It offers management functions to **install, remove, disable, and enable** various custom nodes of ComfyUI. Furthermore, this extension provides a hub feature and convenience functions to access a wide range of information within ComfyUI. + +![ComfyUI-Manager dialog](https://raw.githubusercontent.com/ltdrdata/ComfyUI-extension-tutorials/refs/heads/Main/ComfyUI-Manager/images/dialog.jpg) + +## Key features + +- **Custom node management**: Install, update, remove, and disable custom nodes +- **Model management**: Download and manage models from various sources +- **Snapshot management**: Save and restore installation states +- **Missing node detection**: Automatically detect and install missing nodes from workflows + +## Next steps + + + + Install ComfyUI-Manager for your setup + + + Manage custom nodes and models with the new UI + + + Manage custom nodes and models with the legacy UI + + + Configure settings and options + + + Resolve common issues + + \ No newline at end of file diff --git a/manager/pack-management.mdx b/manager/pack-management.mdx new file mode 100644 index 00000000..48407da4 --- /dev/null +++ b/manager/pack-management.mdx @@ -0,0 +1,63 @@ +--- +title: Custom nodes (new UI) +sidebarTitle: New UI +description: Install, update, and manage custom nodes with ComfyUI-Manager using the new interface +--- + + +If you're not using the new UI, refer to the [Switch between new and legacy UI](/manager/install) section to learn how to switch. + + +## New UI overview + +![New UI](/images/manager/new_ui_labeled.jpg) + +1. **Left sidebar (Filters)**: Filter installed nodes, nodes in workflow, missing nodes, updatable nodes, etc. +2. **Top search bar**: Search node packs (Node Pack) or individual nodes (Node), switch search type using the Filter dropdown +3. **Right detail panel**: Click a node to display detailed information including description, enable status, version information, etc. The Description tab contains repository information, and the Nodes tab previews all nodes + +## Node management + +Learn how to use the new ComfyUI Manager to manage custom nodes + +### Search nodes +![Filter](/images/manager/new_ui_filter.jpg) + +The Manager supports searching for node packs and individual nodes separately. As shown above, you can switch search types by toggling the filter. +- Node Pack: A complete custom node pack +- Individual Node: Search for individual nodes within node packs + +### Install nodes + +![Install nodes](/images/manager/new_ui_install_pack.jpg) +1. Select the corresponding node card +2. Click **Install** in the expanded node information +3. Or select a specific version in **Version** to install + +### Update nodes +Under the **Update available** filter, you can filter nodes that have updates available in the current node list +![Update nodes](/images/manager/new_ui_update_pack.jpg) +1. Updatable nodes will display an update arrow indicator +2. Select a specific version in **Version** +3. Click the **Update** button after selecting a version to update + +### Find missing nodes + +![Find missing nodes](/images/manager/new_ui_missing_packs_prompt.jpg) +If your ComfyUI Manager is properly installed, a prompt will appear when loading a workflow with missing nodes +1. You can choose **Install All** to install all nodes at once +2. Or choose **Open Manager** to open the manager and browse details before installing + +![Find missing nodes](/images/manager/new_ui_missing_pack.jpg) +To find missing nodes in a workflow, select the corresponding node, then click the **Missing** button in the preview panel to find missing nodes + +### Uninstall nodes +![Uninstall nodes](/images/manager/new_ui_uninstall_pack.jpg) +To uninstall an installed node, select the corresponding node, then click the **Uninstall** button in the preview panel to uninstall + +## Common questions +1. Why can't I find the node I need? +The new Manager only supports installing nodes from the [registry](/registry/overview). If your node is not registered in the registry, please register it in the Manager first. + +2. Why can't I find the option to install via git? +For security and stability of the ComfyUI user system, the new UI does not support installing nodes via git. Please refer to [Manually install custom nodes](/installation/install_custom_node) to learn how to manually install custom nodes. diff --git a/manager/troubleshooting.mdx b/manager/troubleshooting.mdx new file mode 100644 index 00000000..740cac17 --- /dev/null +++ b/manager/troubleshooting.mdx @@ -0,0 +1,146 @@ +--- +title: Troubleshooting +sidebarTitle: Troubleshooting +description: Resolve common ComfyUI-Manager issues +--- + +## Common issues + +### Custom git executable path + +If your `git.exe` is installed in a specific location other than the system default: + +1. Install ComfyUI-Manager and run ComfyUI once +2. Open `/default/ComfyUI-Manager/config.ini` +3. Specify the full path including the file name in `git_exe =` + +```ini +git_exe = C:\Program Files\Git\bin\git.exe +``` + +### ComfyUI-Manager update fails + +If updating ComfyUI-Manager itself fails, go to the ComfyUI-Manager directory and run: + +```bash +git update-ref refs/remotes/origin/main a361cc1 && git fetch --all && git pull +``` + +### Windows: Overlapped Object error + +If you encounter `Overlapped Object has pending operation at deallocation on ComfyUI Manager load`: + +Edit `config.ini` and add: + +```ini +windows_selector_event_loop_policy = True +``` + +### SSL certificate verification failed + +If you encounter `SSL: CERTIFICATE_VERIFY_FAILED` error: + +Edit `config.ini` and add: + +```ini +bypass_ssl = True +``` + +## Installation issues + +### Incorrect installation path + +ComfyUI-Manager files must be located in `ComfyUI/custom_nodes/comfyui-manager`. + +**Common mistakes to avoid:** + +| Issue | Problem | +|-------|---------| +| Files in wrong location | Manager files like `__init__.py` placed directly in `custom_nodes` directory | +| Double nested folder | Installed as `custom_nodes/ComfyUI-Manager/ComfyUI-Manager` | +| Wrong folder name | Installed as `custom_nodes/ComfyUI-Manager-main` | +| Compressed format | Installing from a compressed file without proper extraction | + + +If installed incorrectly, ComfyUI-Manager may appear to work but won't be recognized for updates and may cause duplicate installations. Remove it and reinstall properly via `git clone`. + + +## Network issues + +### GitHub access problems + +If you have limited access to GitHub, set the `GITHUB_ENDPOINT` environment variable: + +```bash +GITHUB_ENDPOINT=https://mirror.ghproxy.com/https://github.com +``` + +### Hugging Face access problems + +If you have limited access to Hugging Face, set the `HF_ENDPOINT` environment variable: + +```bash +HF_ENDPOINT=https://some-hf-mirror.com +``` + +## Scanner troubleshooting + +When running the `scan.sh` script: + +- It updates `extension-node-map.json` by pulling or cloning custom nodes listed in `custom-node-list.json` into `~/.tmp/default` +- It updates `github-stats.json` using the GitHub API + +| Option | Description | +|--------|-------------| +| `--skip-update` | Skip updating extension-node-map.json | +| `--skip-stat-update` | Skip updating github-stats.json | +| `--skip-all` | Skip both update steps | + + +To avoid GitHub API rate limits, set your token: `export GITHUB_TOKEN=your_token_here` + + +If you want to specify a different path instead of `~/.tmp/default`, run `python scanner.py [path]` directly instead of `scan.sh`. + +## Security policy + +If you encounter the error `This action is not allowed with this security level configuration` when installing custom nodes via git URL or using the nightly version, you need to adjust the security level in your `config.ini` file. + +The `config.ini` file is located at: +- **ComfyUI v0.3.76+**: `/__manager/config.ini` +- **Older versions**: `/default/ComfyUI-Manager/config.ini` + +Where `` defaults to `ComfyUI/user`. See [Configuration](/manager/configuration) for more details. + +Configure security levels in `config.ini`: + +```ini +security_level = normal +``` + +| Level | Description | +|-------|-------------| +| `strong` | Doesn't allow high and middle level risky features | +| `normal` | Doesn't allow high level risky features; middle level features available | +| `normal-` | Doesn't allow high level risky features if `--listen` is specified and not starts with `127.`; middle level features available | +| `weak` | All features available | + +### Risk levels for features + +| Risk Level | Features | +|------------|----------| +| **High** | Install via git url, pip install, installation of custom nodes not in default channel, fix custom nodes | +| **Middle** | Uninstall/Update, installation of custom nodes in default channel, restore/remove snapshot, restart | +| **Low** | Update ComfyUI | + + +To install custom nodes via git URL or nightly versions, set `security_level = weak` in your `config.ini`. + + +## Getting help + +If you're still experiencing issues: + +1. Check the [ComfyUI-Manager GitHub issues](https://github.com/ltdrdata/ComfyUI-Manager/issues) for similar problems +2. Review the startup log messages for error details +3. Join the [ComfyUI Discord](https://discord.com/invite/comfyorg) for community support diff --git a/zh-CN/installation/install_custom_node.mdx b/zh-CN/installation/install_custom_node.mdx index bcea908b..9dbefa75 100644 --- a/zh-CN/installation/install_custom_node.mdx +++ b/zh-CN/installation/install_custom_node.mdx @@ -35,51 +35,17 @@ icon: "puzzle-piece" ### 方法一:ComfyUI Manager（推荐） - - - ![点击 ComfyUI Manager](/images/installation/custom_nodes/install-custom-nodes-by-manager-1.jpg) - - - ![选择 Install Custom Nodes](/images/installation/custom_nodes/install-custom-nodes-by-manager-2.jpg) - - - - 使用 ComfyUI Manager 安装自定义节点时，在列表中的自定义节点并不代表其是安全的，请在安装前了解其功能和作用，确保只安装可信插件和热门作者的自定义节点，否则将会给你的设备带来潜在风险 - - - ![在搜索框中输入节点名称](/images/installation/custom_nodes/install-custom-nodes-by-manager-3.jpg) - ![在搜索框中输入节点名称](/images/installation/custom_nodes/install-custom-nodes-by-manager-4.jpg) - 1. 如果有标记`⚠️`的节点，代表其可能与其它一些插件存在依赖冲突 - 2. 作者名称标注为`✅`的节点，代表对应作者在 Github 的活跃度 - 3. 对于插件可能存在的风险行为，会在列表中使用红色字段提醒，请在确保插件安全后再进行安装 - - - ![点击对应节点的 `Install` 按钮](/images/installation/custom_nodes/install-custom-nodes-by-manager-5.jpg) - 找到需要安装的节点，点击`Install`按钮 - ![点击对应节点的 `Install` 按钮](/images/installation/custom_nodes/install-custom-nodes-by-manager-6.jpg) - - 在弹出的窗口中会要求选择版本： - - `nightly` 版本: 直接从 Github 下载最新源码，但在 `security_level` 为 `normal` 时，会提示当前的安全等级设置不允许下载该插件 - - `latest` 或带数字的稳定版本（推荐）: 从 https://registry.comfy.org/ 下载经过审查的代码，不会触发安全检查 - - `nightly` 版本通常是最新的版本，但因为它直接从 github 下载没有经过审查的版本，存在一定的代码风险，如果你一定需要安装`nightly`版本，请将 Manager 的 `security_level` 设置为 `weak` - 对应配置文件路径为 `ComfyUI/user/default/ComfyUI-Manager/config.ini`,但请注意这并不是我们推荐的配置，请只临时使用这个配置 - - - - 点击安装后 Manager 会自动完成依赖的安装，并会在安装完成后提示你重启 ComfyUI - ![安装完成后重启ComfyUI并刷新浏览器](/images/installation/custom_nodes/install-custom-nodes-by-manager-7.jpg) - ![安装完成后重启ComfyUI并刷新浏览器](/images/installation/custom_nodes/install-custom-nodes-by-manager-8.jpg) - - - 重启后在 ComfyUI Manager 中检查对应的插件是否安装成功, 是否出现`import failed`的错误提示 - ![安装完成后重启ComfyUI并刷新浏览器](/images/installation/custom_nodes/install-custom-nodes-by-manager-9.jpg) - - + + 查看如何使用管理器进行节点安装 + ### 方法二:使用 Git 进行安装手动安装 -适用于Manager中找不到的新节点或需要特定版本时， 需要你的系统中已经安装好了 [Git](https://git-scm.com/) +适用于 Manager 中找不到的新节点或需要特定版本时， 需要你的系统中已经安装好了 [Git](https://git-scm.com/) @@ -118,11 +84,11 @@ icon: "puzzle-piece" -### 方法三:ZIP下载安装 +### 方法三:ZIP下载安装（不推荐） 适用于无法使用 Git 或 Manager 安装的用户 -我们不是非常推荐使用这种方式来进行安装，因为这种安装方式会丢失 +我们不是非常推荐使用这种方式来进行安装，因为这种安装方式会丢失 Git 版本控制能力，导致你无法进行后续的版本管理 diff --git a/zh-CN/manager/configuration.mdx b/zh-CN/manager/configuration.mdx new file mode 100644 index 00000000..fde92cad --- /dev/null +++ b/zh-CN/manager/configuration.mdx @@ -0,0 +1,136 @@ +--- +title: ComfyUI Manager 配置配置 +sidebarTitle: 配置 +description: 配置 ComfyUI-Manager 设置 +--- + +## 配置路径 + +从 V3.38 开始，Manager 使用受保护的系统路径以增强安全性。 + +| ComfyUI 版本 | Manager 路径 | +|-------------|-------------| +| v0.3.76+ | `/__manager/` | +| 旧版本 | `/default/ComfyUI-Manager/` | + + +如果不带任何选项执行，`` 路径默认为 `ComfyUI/user`。可以使用 `--user-directory ` 设置。 + + +### 配置文件 + +| 文件 | 描述 | +|------|------| +| `config.ini` | 基本配置 | +| `channels.list` | 可配置的频道列表 | +| `pip_overrides.json` | 自定义 pip 包映射 | +| `pip_blacklist.list` | 阻止安装的包 | +| `pip_auto_fix.list` | 自动恢复的包 | +| `snapshots/` | 保存的快照文件 | +| `startup-scripts/` | 启动脚本文件 | +| `components/` | 组件文件 | + +## Config.ini 选项 + +修改 `config.ini` 文件以应用设置。路径显示在启动日志消息中。 + +```ini +[default] +git_exe = +use_uv = +default_cache_as_channel_url = +bypass_ssl = +file_logging = +windows_selector_event_loop_policy = +model_download_by_agent = +downgrade_blacklist = <逗号分隔的阻止降级的包列表> +security_level = +always_lazy_install = +network_mode = +``` + +### 网络模式 + +| 模式 | 描述 | +|------|------| +| `public` | 标准公共网络环境 | +| `private` | 通过 `channel_url` 配置私有节点数据库的封闭网络（如果可用则使用缓存） | +| `offline` | 无外部连接（如果可用则使用缓存） | + +### 安全级别 + +| 级别 | 描述 | +|------|------| +| `strong` | 不允许高风险和中风险功能 | +| `normal` | 不允许高风险功能；中风险功能可用 | +| `normal-` | 如果指定了 `--listen` 且不以 `127.` 开头，则不允许高风险功能；中风险功能可用 | +| `weak` | 所有功能可用 | + +#### 功能风险级别 + +| 风险级别 | 功能 | +|---------|------| +| **高** | 通过 git url 安装、pip install、安装不在默认频道中的自定义节点、修复自定义节点 | +| **中** | 卸载/更新、安装默认频道中的自定义节点、恢复/删除快照、重启 | +| **低** | 更新 ComfyUI | + +## 环境变量 + +| 变量 | 描述 | +|------|------| +| `COMFYUI_PATH` | ComfyUI 的安装路径 | +| `GITHUB_ENDPOINT` | GitHub 访问的反向代理 | +| `HF_ENDPOINT` | Hugging Face 访问的反向代理 | + +### 示例 + +通过代理重定向 GitHub 请求： +```bash +GITHUB_ENDPOINT=https://mirror.ghproxy.com/https://github.com +``` + +更改 Hugging Face 端点： +```bash +HF_ENDPOINT=https://some-hf-mirror.com +``` + +## 高级配置 + +### 阻止特定包降级 + +在 `config.ini` 的 `downgrade_blacklist` 部分列出包名，用逗号分隔： + +```ini +downgrade_blacklist = diffusers, kornia +``` + +### 自定义 pip 映射 + +创建 `pip_overrides.json` 文件，将特定 pip 包的安装更改为用户定义的安装。格式请参考 `pip_overrides.json.template`。 + +### 阻止安装特定 pip 包 + +在 `pip_blacklist.list` 文件中每行列出一个包名。 + +### 自动恢复 pip 安装 + +在 `pip_auto_fix.list` 中列出 pip 规范要求（类似于 `requirements.txt`）。当启动 ComfyUI 或在自定义节点安装期间版本不匹配时，它将自动恢复指定版本。可以使用 `--index-url`。 + +### 使用 aria2 作为下载器 + +为了更快的下载速度，您可以配置 ComfyUI-Manager 使用 aria2。请参阅 [aria2 设置指南](https://github.com/comfy-org/ComfyUI-Manager/blob/main/docs/en/use_aria2.md)。 + +## extra_model_paths.yaml 配置 + +以下设置基于标记为 `is_default` 的部分应用： + +- `custom_nodes`：安装自定义节点的路径 +- `download_model_base`：下载模型的路径 + +## CLI 工具 + +ComfyUI-Manager 提供 `cm-cli`，这是一个命令行工具，允许您在不运行 ComfyUI 的情况下使用 Manager 功能。这对于自动化自定义节点安装和在无头环境中管理安装很有用。 + +有关详细的 cm-cli 文档，请参阅[官方 cm-cli 指南](https://github.com/ltdrdata/ComfyUI-Manager/blob/main/docs/en/cm-cli.md)。 + +如需更全面的 CLI 体验，请考虑使用 [comfy-cli](/zh-CN/comfy-cli/getting-started)。 diff --git a/zh-CN/manager/install.mdx b/zh-CN/manager/install.mdx new file mode 100644 index 00000000..a9a326d7 --- /dev/null +++ b/zh-CN/manager/install.mdx @@ -0,0 +1,145 @@ +--- +title: ComfyUI-Manager 安装 +sidebarTitle: 安装 +description: 如何为不同环境安装 ComfyUI-Manager +--- + +## 桌面版用户 + +如果您使用的是 [ComfyUI 桌面版](/zh-CN/installation/desktop/windows)，ComfyUI-Manager 已默认包含并启用。无需额外安装。 + +## 便携版用户 + +对于使用 [Windows 便携版](/zh-CN/installation/comfyui_portable_windows) 的用户，新版 ComfyUI-Manager 已内置于 ComfyUI 核心中，但需要启用。 + +1. 安装管理器依赖： + ```bash + .\python_embeded\python.exe -m pip install -r ComfyUI\manager_requirements.txt + ``` + +2. 启用管理器启动 ComfyUI： + ```bash + .\python_embeded\python.exe -s ComfyUI\main.py --windows-standalone-build --enable-manager + pause + ``` + +## 手动安装用户 + +对于[手动安装](/zh-CN/installation/manual_install)的用户，新版 ComfyUI-Manager 已内置于 ComfyUI 核心中，但需要启用。 + +1. 激活虚拟环境： + ```bash + # Windows + venv\Scripts\activate + + # Linux/macOS + source venv/bin/activate + ``` + +2. 安装管理器依赖： + ```bash + pip install -r manager_requirements.txt + ``` + +3. 运行 ComfyUI 时使用 `--enable-manager` 标志启用管理器： + ```bash + python main.py --enable-manager + ``` + +### 命令行选项 + +| 标志 | 描述 | +|------|------| +| `--enable-manager` | 启用 ComfyUI-Manager | +| `--enable-manager-legacy-ui` | 使用旧版管理器 UI 而非新版 UI（需要 `--enable-manager`） | +| `--disable-manager-ui` | 禁用管理器 UI 和端点，同时保留后台功能（需要 `--enable-manager`） | + +### 切换新旧版UI + +以下版本更新仅支持 pip 版本， 通过自定义节点方式安装的版本不支持切换到新版 UI + + + +使用新版本 UI +```bash +python main.py --enable-manager +``` + +使用旧版UI +```bash +python main.py --enable-manager --enable-manager-legacy-ui +``` + + + +桌面版请在 服务器设置 -> UI 设置 -> 使用旧版管理器界面 切换到旧版 UI +![切换旧版 UI ](/images/manager/manager_use_legacy_manager_ui.png) + + + +## 自定义节点版本安装方法 + + +在现有 ComfyUI 安装基础上安装 ComfyUI-Manager： + +1. 在终端中导航到 `ComfyUI/custom_nodes` 目录 +2. 克隆仓库： + ```bash + git clone https://github.com/ltdrdata/ComfyUI-Manager comfyui-manager + ``` +3. 安装管理器依赖： + ```bash + cd comfyui-manager + pip install -r requirements.txt + ``` +4. 重启 ComfyUI + + + +1. 安装 [Git for Windows](https://git-scm.com/download/win)（独立版本，选择"使用 Windows 默认控制台窗口"） +2. 将 [install-manager-for-portable-version.bat](https://github.com/ltdrdata/ComfyUI-Manager/raw/main/scripts/install-manager-for-portable-version.bat) 下载到您的 `ComfyUI_windows_portable` 目录 +3. 双击批处理文件进行安装 + + + +comfy-cli 提供各种功能，可从命令行管理 ComfyUI。 + +**前提条件**：Python 3、Git + +**Windows：** +```bash +python -m venv venv +venv\Scripts\activate +pip install comfy-cli +comfy install +``` + +**Linux/macOS：** +```bash +python -m venv venv +. venv/bin/activate +pip install comfy-cli +comfy install +``` + +另请参阅：[comfy-cli 文档](/zh-CN/comfy-cli/getting-started) + + + +**前提条件**：python-is-python3、python3-venv、git + +1. 将 [install-comfyui-venv-linux.sh](https://github.com/comfy-org/ComfyUI-Manager/raw/main/scripts/install-comfyui-venv-linux.sh) 下载到空的安装目录 +2. 运行： + ```bash + chmod +x install-comfyui-venv-linux.sh + ./install-comfyui-venv-linux.sh + ``` +3. 使用 `./run_gpu.sh` 或 `./run_cpu.sh` 执行 ComfyUI + + + +**安装注意事项：** +- ComfyUI-Manager 文件必须准确位于路径 `ComfyUI/custom_nodes/comfyui-manager` +- 不要直接解压到 `ComfyUI/custom_nodes`（`__init__.py` 等文件不应在该目录中） +- 不要安装在 `ComfyUI/custom_nodes/ComfyUI-Manager/ComfyUI-Manager` 或 `ComfyUI/custom_nodes/ComfyUI-Manager-main` 等路径 + diff --git a/zh-CN/manager/legacy-ui.mdx b/zh-CN/manager/legacy-ui.mdx new file mode 100644 index 00000000..f8ab0746 --- /dev/null +++ b/zh-CN/manager/legacy-ui.mdx @@ -0,0 +1,104 @@ +--- +title: 使用 ComfyUI-Manager 进行自定义节点管理（旧版 UI） +sidebarTitle: 旧版 UI +description: 使用 ComfyUI-Manager 旧版界面安装、更新和管理自定义节点 +--- + +## ComfyUI 自定义节点管理 +了解如果通过 Manager 安装管理自定义节点 + +### 安装节点 + + + + 点击主菜单（顶部栏）上的 **Manager** 按钮。 + ![Manager 按钮](/images/manager/manager_button.jpg) + + + ![管理器入口](/images/manager/manager_entry.jpg) + + + ![管理器入口](/images/manager/manager_list.jpg) + + + ![节点安装对话框](/images/manager/manager_install_node.jpg) + 1. 如果有 **latest(最新版)** 的情况下首选最新版 + 2. 点击 **Select** 进行节点安装 + + - 带有数字的版本号为作者发布到 [registry](https://registry.comfy.org/) 的版本，相当于稳定发布版 + - nightly 为作者更新到 github 的最新版本，相当于开发版，通常未经安全扫描，存在不稳定因素 + + ComfyUI 默认的安全设置并不允许直接安装 **nightly** 版本，你可以参考 [安全策略](/zh-CN/manager/troubleshooting#安全策略) 了解 + + + + 点击安装后 Manager 会自动完成依赖的安装，并会在安装完成后提示你重启 ComfyUI + ![安装完成后重启ComfyUI并刷新浏览器](/images/installation/custom_nodes/install-custom-nodes-by-manager-7.jpg) + ![安装完成后重启ComfyUI并刷新浏览器](/images/installation/custom_nodes/install-custom-nodes-by-manager-8.jpg) + + + 重启后在 ComfyUI Manager 中检查对应的插件是否安装成功, 是否出现`import failed`的错误提示 + ![安装完成后重启ComfyUI并刷新浏览器](/images/installation/custom_nodes/install-custom-nodes-by-manager-9.jpg) + + + +### 安装缺失节点 + +当加载工作流时，节点缺失是常见的的一种情况，通常节点缺失存在两种情况 +1. 核心节点缺失： ComfyUI 版本不是最新版本，请参考 [更新ComfyUI](/zh-CN/installation/update_comfyui) 更新ComfyUI +2. 自定义节点缺失： 第三方的自定义节点缺失，可以参考文本指南进行安装 + +当安装完成 ComfyUI-Manager 之后，对于导入的工作流如果存在自定义节点缺失，将会提醒对应缺失节点信息 + +![节点缺失提示](/images/manager/manger_missing_nodes-1.jpg) +1. 点击 **打开管理器（Open Manager）** 激活对应选项 + +![节点缺失提示](/images/manager/manger_missing_nodes-2.jpg) +2. 在 Manager 菜单点击 **Install Missing Custom Nodes** 进入缺失节点列表界面 + +![节点缺失提示](/images/manager/manger_missing_nodes-3.jpg) +3. 在对应节点列表查看对应的节点并安装 + + +如果你发现缺失节点列表找不到对应的节点，通常有几种情况 +1. 对应节点作者没有将自定义节点提交注册到 [registry](/zh-CN/registry/overview) +2. 对应节点不是开源节点，可能是某些作者或者限定平台的限定节点 +3. 原始作者版本变更删除了对应节点 + + +### 更新节点 +![节点版本](/images/manager/manger_node_version.jpg) +1. 切换筛选器（filter）到 **update** 筛选器，即可筛选出当前节点列表中可更新的节点 +2. 点击 **Update** 按钮进行节点更新 + +### 删除节点 + +![删除节点](/images/manager/manger_remove_nodes.jpg) +1. 在节点列表选择 "已安装（installed）" 筛选器，即可筛选出当前节点列表中已安装的节点 +2. 点击对应节点右键选择 **Uninstall** 进行节点卸载 + +> 删除对应节点，并不会移除对应的依赖安装 + +其它安装 插件方法请参看下面的文章 + + + 了解如何手动安装自定义节点 + + +## 快照管理器 + +快照保存您当前的安装状态，允许您恢复到之前的状态。 + +![快照管理器](https://raw.githubusercontent.com/ltdrdata/ComfyUI-extension-tutorials/Main/ComfyUI-Manager/images/snapshot.jpg) + +当您按下 **Save snapshot** 或使用 **Update All** 时，快照会自动保存。快照文件存储在：`/default/ComfyUI-Manager/snapshots` + +要恢复：打开快照管理器，选择一个快照，然后按 **Restore**。 + + +恢复在下次 ComfyUI 启动时生效。对于不由 Git 管理的自定义节点，快照支持不完整。 + diff --git a/zh-CN/manager/overview.mdx b/zh-CN/manager/overview.mdx new file mode 100644 index 00000000..791965b0 --- /dev/null +++ b/zh-CN/manager/overview.mdx @@ -0,0 +1,36 @@ +--- +title: ComfyUI Manager 简介 +sidebarTitle: 概述 +description: 用于管理 ComfyUI 中自定义节点、模型等的扩展 +--- + +**ComfyUI-Manager** 是一个旨在增强 [ComfyUI](https://github.com/comfyanonymous/ComfyUI) 可用性的扩展。它提供管理功能来**安装、删除、禁用和启用** ComfyUI 的各种自定义节点。此外，该扩展还提供了一个中心功能和便捷功能，可以访问 ComfyUI 中的各种信息。 + +![ComfyUI-Manager 对话框](https://raw.githubusercontent.com/ltdrdata/ComfyUI-extension-tutorials/refs/heads/Main/ComfyUI-Manager/images/dialog.jpg) + +## 主要功能 + +- **自定义节点管理**：安装、更新、删除和禁用自定义节点 +- **模型管理**：从各种来源下载和管理模型 +- **快照管理**：保存和恢复安装状态 +- **缺失节点检测**：自动检测并安装工作流中缺失的节点 + +## 下一步 + + + + 为您的环境安装 ComfyUI-Manager + + + 使用新版 UI 管理自定义节点和模型 + + + 使用传统 UI 管理自定义节点和模型 + + + 配置设置和选项 + + + 解决常见问题 + + \ No newline at end of file diff --git a/zh-CN/manager/pack-management.mdx b/zh-CN/manager/pack-management.mdx new file mode 100644 index 00000000..9c1be295 --- /dev/null +++ b/zh-CN/manager/pack-management.mdx @@ -0,0 +1,64 @@ +--- +title: ComfyUI Manager 自定义节点（新版 UI）管理 +sidebarTitle: 新版 UI +description: 使用 ComfyUI-Manager 新界面安装、更新和管理自定义节点 +--- + + +如果你不是新版 UI 请参考 [切换新旧版UI](/zh-CN/manager/install) 部分了解如何进行切换 + + +你可以通过一下方式 +## 新版界面说明 + +![新版本 UI ](/images/manager/new_ui_labeled.jpg) + +1. **左侧筛选器**：筛选已安装、工作流中的节点、缺失节点、可更新节点等 +2. **顶部搜索栏**：搜索节点包（Node Pack）或单个节点（Node），Filter 可切换搜索类型 +3. **右侧详情面板**：点击节点后显示详情信息，包括介绍、启用状态、版本信息等。Description 标签页包含仓库信息，Nodes 标签页预览所有节点 + + +## 节点管理 + +了解如何使用新版本 ComfyUI Manager 进行自定义节点的管理 +### 搜索节点 +![筛选器](/images/manager/new_ui_filter.jpg) + +在 Manager 中支持单独搜索节点包和单个节点，如上图，通过切换筛选器（filter）可以切换搜索类型 +- 节点包：一个完整的自定义节点包 +- 单个节点： 搜索节点内的单个节点 + +### 安装节点 + +![安装节点](/images/manager/new_ui_install_pack.jpg) +1. 选中对应节点卡片 +2. 在展开的节点信息点击 **安装（install）** +3. 或者在**版本（version）** 选择特定版本进行安装 + +### 更新节点 +在 **Update available** 筛选器下，可以筛选出当前节点列表中可更新的节点 +![更新节点](/images/manager/new_ui_update_pack.jpg) +1. 对应可更新节点会显示一个可更新的箭头标志 +2. 在 **version** 选择特定版本 +3. 选择版本后点击 **Update** 按钮进行更新 + +### 查找缺失节点 + +![查找缺失节点](/images/manager/new_ui_missing_packs_prompt.jpg) +如果你的 ComfyUI Manager 正确安装，那么在加载工作流出现节点缺失的时候则会出现弹窗提示安装缺失节点信息 +1. 你可选择 **安装全部（Install All）** 一次性安装全部节点 +2. 也可以选择 **打开管理器（Open Manager）** 打开管理器后浏览详情后进行安装 + +![查找缺失节点](/images/manager/new_ui_missing_pack.jpg) +如果想要查找工作流缺失节点，则选中对应节点后，在预览界面点击**查找缺失节点（Missing）**按钮即可进行查找缺失节点 + +### 卸载节点 +![卸载节点](/images/manager/new_ui_uninstall_pack.jpg) +如果想要卸载已安装的节点，则选中对应节点后，在预览界面点击**卸载（Uninstall）**按钮即可进行卸载 + +## 常见问题 +1. 为什搜索不到我需要的节点？ +目前新版 Manager 仅支持从 [registry](/zh-CN/registry/overview) 上安装节点，如果你的节点未在 registry 注册请先在 Manager 进行注册 + +2. 为什么找不到通过 git 安装的选项了？ +考虑 ComfyUI 用户系统的安全性和稳定性，新版本 UI 不支持通过 git 安装节点，请参考 [手动安装自定义节点](/zh-CN/installation/install_custom_node) 了解如何手动安装自定义节点 \ No newline at end of file diff --git a/zh-CN/manager/troubleshooting.mdx b/zh-CN/manager/troubleshooting.mdx new file mode 100644 index 00000000..d611d7e8 --- /dev/null +++ b/zh-CN/manager/troubleshooting.mdx @@ -0,0 +1,146 @@ +--- +title: 故障排除 +sidebarTitle: 故障排除 +description: 解决常见的 ComfyUI-Manager 问题 +--- + +## 常见问题 + +### 自定义 git 可执行文件路径 + +如果您的 `git.exe` 安装在系统默认位置以外的特定位置： + +1. 安装 ComfyUI-Manager 并运行一次 ComfyUI +2. 打开 `/default/ComfyUI-Manager/config.ini` +3. 在 `git_exe =` 中指定包含文件名的完整路径 + +```ini +git_exe = C:\Program Files\Git\bin\git.exe +``` + +### ComfyUI-Manager 更新失败 + +如果更新 ComfyUI-Manager 本身失败，请进入 ComfyUI-Manager 目录并运行： + +```bash +git update-ref refs/remotes/origin/main a361cc1 && git fetch --all && git pull +``` + +### Windows：Overlapped Object 错误 + +如果遇到 `Overlapped Object has pending operation at deallocation on ComfyUI Manager load`： + +编辑 `config.ini` 并添加： + +```ini +windows_selector_event_loop_policy = True +``` + +### SSL 证书验证失败 + +如果遇到 `SSL: CERTIFICATE_VERIFY_FAILED` 错误： + +编辑 `config.ini` 并添加： + +```ini +bypass_ssl = True +``` + +## 安装问题 + +### 安装路径不正确 + +ComfyUI-Manager 文件必须位于 `ComfyUI/custom_nodes/comfyui-manager`。 + +**需要避免的常见错误：** + +| 问题 | 说明 | +|------|------| +| 文件位置错误 | Manager 文件如 `__init__.py` 直接放在 `custom_nodes` 目录中 | +| 双重嵌套文件夹 | 安装为 `custom_nodes/ComfyUI-Manager/ComfyUI-Manager` | +| 文件夹名称错误 | 安装为 `custom_nodes/ComfyUI-Manager-main` | +| 压缩格式 | 从压缩文件安装但未正确解压 | + + +如果安装不正确，ComfyUI-Manager 可能看起来可以工作，但不会被识别为可更新，并可能导致重复安装。请删除它并通过 `git clone` 正确重新安装。 + + +## 网络问题 + +### GitHub 访问问题 + +如果您对 GitHub 的访问受限，请设置 `GITHUB_ENDPOINT` 环境变量： + +```bash +GITHUB_ENDPOINT=https://mirror.ghproxy.com/https://github.com +``` + +### Hugging Face 访问问题 + +如果您对 Hugging Face 的访问受限，请设置 `HF_ENDPOINT` 环境变量： + +```bash +HF_ENDPOINT=https://some-hf-mirror.com +``` + +## 扫描器故障排除 + +运行 `scan.sh` 脚本时： + +- 它通过拉取或克隆 `custom-node-list.json` 中列出的自定义节点到 `~/.tmp/default` 来更新 `extension-node-map.json` +- 它使用 GitHub API 更新 `github-stats.json` + +| 选项 | 描述 | +|------|------| +| `--skip-update` | 跳过更新 extension-node-map.json | +| `--skip-stat-update` | 跳过更新 github-stats.json | +| `--skip-all` | 跳过两个更新步骤 | + + +为避免 GitHub API 速率限制，请设置您的令牌：`export GITHUB_TOKEN=your_token_here` + + +如果您想指定 `~/.tmp/default` 以外的不同路径，请直接运行 `python scanner.py [path]` 而不是 `scan.sh`。 + +## 安全策略 + +如果您在通过 git URL 安装自定义节点或使用 nightly 版本时遇到错误 `This action is not allowed with this security level configuration`，您需要在 `config.ini` 文件中调整安全级别。 + +`config.ini` 文件位于： +- **ComfyUI v0.3.76+**：`/__manager/config.ini` +- **旧版本**：`/default/ComfyUI-Manager/config.ini` + +其中 `` 默认为 `ComfyUI/user`。详情请参阅[配置](/zh-CN/manager/configuration)。 + +在 `config.ini` 中配置安全级别： + +```ini +security_level = normal +``` + +| 级别 | 描述 | +|------|------| +| `strong` | 不允许高风险和中风险功能 | +| `normal` | 不允许高风险功能；中风险功能可用 | +| `normal-` | 如果指定了 `--listen` 且不以 `127.` 开头，则不允许高风险功能；中风险功能可用 | +| `weak` | 所有功能可用 | + +### 功能风险级别 + +| 风险级别 | 功能 | +|---------|------| +| **高** | 通过 git url 安装、pip install、安装不在默认频道中的自定义节点、修复自定义节点 | +| **中** | 卸载/更新、安装默认频道中的自定义节点、恢复/删除快照、重启 | +| **低** | 更新 ComfyUI | + + +要通过 git URL 或 nightly 版本安装自定义节点，请在 `config.ini` 中设置 `security_level = weak`。 + + +## 获取帮助 + +如果您仍然遇到问题： + +1. 查看 [ComfyUI-Manager GitHub issues](https://github.com/ltdrdata/ComfyUI-Manager/issues) 寻找类似问题 +2. 查看启动日志消息以获取错误详情 +3. 加入 [ComfyUI Discord](https://discord.com/invite/comfyorg) 获取社区支持