Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
66 commits
Select commit Hold shift + click to select a range
1a47873
Update manager/overview.mdx
mintlify[bot] Dec 3, 2025
f2e56c2
Update manager/installation.mdx
mintlify[bot] Dec 3, 2025
9eca452
Update manager/usage.mdx
mintlify[bot] Dec 3, 2025
ecc815a
Update manager/configuration.mdx
mintlify[bot] Dec 3, 2025
4372af4
Update manager/cli.mdx
mintlify[bot] Dec 3, 2025
81aef99
Update manager/troubleshooting.mdx
mintlify[bot] Dec 3, 2025
337895b
Update docs.json
mintlify[bot] Dec 3, 2025
be39917
Update manager/overview.mdx
mintlify[bot] Dec 16, 2025
2b9ff1a
Update manager/usage.mdx
mintlify[bot] Dec 16, 2025
4d0cdb7
Update manager/troubleshooting.mdx
mintlify[bot] Dec 16, 2025
04204ad
Update manager/installation.mdx
mintlify[bot] Dec 16, 2025
4cb9155
Update manager/installation.mdx
mintlify[bot] Dec 16, 2025
5f5da0d
Update manager/installation.mdx
mintlify[bot] Dec 16, 2025
e4ee00b
Update manager/installation.mdx
mintlify[bot] Dec 16, 2025
99ed99d
Update manager/installation.mdx
mintlify[bot] Dec 16, 2025
fdab051
Update manager/installation.mdx
mintlify[bot] Dec 16, 2025
4422885
Update manager/installation.mdx
mintlify[bot] Dec 16, 2025
102e584
Update manager/overview.mdx
mintlify[bot] Dec 16, 2025
863f073
Update manager/configuration.mdx
mintlify[bot] Dec 16, 2025
7d17ca4
Delete manager/installation.mdx
mintlify[bot] Dec 16, 2025
2c81112
Delete manager/troubleshooting.mdx
mintlify[bot] Dec 16, 2025
3253f9b
Delete manager/usage.mdx
mintlify[bot] Dec 16, 2025
0c1c65c
Delete manager/cli.mdx
mintlify[bot] Dec 16, 2025
15288f7
Update docs.json
mintlify[bot] Dec 16, 2025
c852725
Update manager/overview.mdx
mintlify[bot] Dec 16, 2025
f1f7643
Update manager/configuration.mdx
mintlify[bot] Dec 16, 2025
35b615d
Update manager/install.mdx
mintlify[bot] Dec 16, 2025
b0c981c
Update manager/custom-nodes.mdx
mintlify[bot] Dec 16, 2025
01133fb
Update manager/overview.mdx
mintlify[bot] Dec 16, 2025
805d6a6
Update manager/configuration.mdx
mintlify[bot] Dec 16, 2025
84031f4
Update docs.json
mintlify[bot] Dec 16, 2025
30aac36
Update manager/install.mdx
mintlify[bot] Dec 16, 2025
f1968f2
Update manager/custom-nodes.mdx
mintlify[bot] Dec 16, 2025
712ebce
Update manager/overview.mdx
mintlify[bot] Dec 16, 2025
cd627c6
Update manager/overview.mdx
mintlify[bot] Dec 16, 2025
4c4bf5a
Update manager/overview.mdx
mintlify[bot] Dec 16, 2025
a973eab
Update manager/troubleshooting.mdx
mintlify[bot] Dec 16, 2025
ef6a669
Update docs.json
mintlify[bot] Dec 16, 2025
e3e0648
Update manager/configuration.mdx
mintlify[bot] Dec 16, 2025
ef3a962
Update manager/configuration.mdx
mintlify[bot] Dec 16, 2025
07c34c9
Update manager/overview.mdx
mintlify[bot] Dec 16, 2025
17cca93
Update manager/troubleshooting.mdx
mintlify[bot] Dec 16, 2025
39285ea
Update manager/custom-nodes-legacy.mdx
mintlify[bot] Dec 16, 2025
e5ac1e5
Update manager/custom-nodes.mdx
mintlify[bot] Dec 16, 2025
376834c
Update docs.json
mintlify[bot] Dec 16, 2025
5517b0e
Update docs.json
mintlify[bot] Dec 16, 2025
216aa3a
Update documentation for custom nodes and installation process
comfyui-wiki Dec 29, 2025
d3ca2bc
Rename file
comfyui-wiki Dec 29, 2025
b5196b0
Update zh-CN/manager/overview.mdx
mintlify[bot] Dec 29, 2025
ca9cbae
Update zh-CN/manager/install.mdx
mintlify[bot] Dec 29, 2025
0380e2d
Update zh-CN/manager/custom-nodes.mdx
mintlify[bot] Dec 29, 2025
30f1642
Update zh-CN/manager/legacy-ui.mdx
mintlify[bot] Dec 29, 2025
eaa031e
Update zh-CN/manager/configuration.mdx
mintlify[bot] Dec 29, 2025
ec3fd90
Update zh-CN/manager/troubleshooting.mdx
mintlify[bot] Dec 29, 2025
c3f162b
Update docs.json
mintlify[bot] Dec 29, 2025
b507f64
Update Chinese version
comfyui-wiki Dec 29, 2025
fe1a4fe
Merge b507f6436d6522594b0705209a477fda512596fd into b649102185a7cb257…
mintlify[bot] Dec 29, 2025
0159c7a
Fix link formatting issues
actions-user Dec 29, 2025
312d328
Rename files
comfyui-wiki Dec 29, 2025
8a74ef3
Merge branch 'mintlify/branch-89184' of https://github.com/Comfy-Org/…
comfyui-wiki Dec 29, 2025
52714a3
Update Chinese version
comfyui-wiki Dec 29, 2025
45eae9d
Update configuration and pack management documentation in Chinese
comfyui-wiki Dec 29, 2025
6ad7d1c
Update English version
comfyui-wiki Dec 29, 2025
ac92ccb
Refactor documentation structure and enhance UI instructions
comfyui-wiki Dec 29, 2025
e910cf9
Update navigation
comfyui-wiki Dec 29, 2025
f665ce6
Fix broken links
comfyui-wiki Dec 29, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 35 additions & 3 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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"
]
}
]
},
Expand Down Expand Up @@ -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"
]
}
]
},
Expand Down
Binary file added images/manager/manager_button.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manager/manager_entry.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manager/manager_install_node.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manager/manager_list.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manager/manager_use_legacy_manager_ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manager/manger_missing_nodes-1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manager/manger_missing_nodes-2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manager/manger_missing_nodes-3.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manager/manger_node_version.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manager/manger_remove_nodes.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manager/new_ui_filter.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manager/new_ui_install_pack.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manager/new_ui_labeled.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manager/new_ui_missing_pack.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manager/new_ui_missing_packs_prompt.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manager/new_ui_uninstall_pack.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manager/new_ui_update_pack.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
138 changes: 138 additions & 0 deletions manager/configuration.mdx
Original file line number Diff line number Diff line change
@@ -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) | `<USER_DIRECTORY>/__manager/` |
| Older versions | `<USER_DIRECTORY>/default/ComfyUI-Manager/` |

<Note>
If executed without any options, the `<USER_DIRECTORY>` path defaults to `ComfyUI/user`. It can be set using `--user-directory <USER_DIRECTORY>`.
</Note>

### 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 = <path to git executable>
use_uv = <True/False - use uv instead of pip>
default_cache_as_channel_url = <True/False - retrieve DB designated as channel_url at startup>
bypass_ssl = <True/False - disable SSL if errors occur>
file_logging = <True/False - create log file>
windows_selector_event_loop_policy = <True/False - fix event loop errors on Windows>
model_download_by_agent = <True/False - use agent for model downloads>
downgrade_blacklist = <comma-separated list of packages to prevent downgrades>
security_level = <strong|normal|normal-|weak>
always_lazy_install = <True/False - perform dependency installation on restart>
network_mode = <public|private|offline>
```

### 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).


145 changes: 145 additions & 0 deletions manager/install.mdx
Original file line number Diff line number Diff line change
@@ -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.

<Tabs>
<Tab title="Non-Desktop users">
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
```

</Tab>
<Tab title="Desktop users">
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)
</Tab>
</Tabs>

## Legacy installation methods

<Accordion title="Method 1: Git clone (general installation)">
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
</Accordion>

<Accordion title="Method 2: Portable version (Windows)">
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
</Accordion>

<Accordion title="Method 3: comfy-cli (recommended for new installations)">
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)
</Accordion>

<Accordion title="Method 4: Linux + venv">
**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`
</Accordion>

<Warning>
**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`
</Warning>
Loading
Loading