You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: troubleshooting/custom-node-issues.mdx
+65-77Lines changed: 65 additions & 77 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,23 +10,71 @@ Here is the overall approach for troubleshooting custom node issues:
10
10
11
11
```mermaid
12
12
flowchart TD
13
-
A[Issue Encountered] --> B{Does the issue disappear after disabling all custom nodes?}
13
+
A[Issue Encountered] --> B{Does the issue disappear after <a href="#how-to-disable-all-custom-nodes%3F">disabling all custom nodes</a>?}
14
14
B -- Yes --> C[Issue caused by custom nodes]
15
15
B -- No --> D[Issue not caused by custom nodes, refer to other troubleshooting docs]
16
-
C --> E{Check frontend extensions first?}
17
-
E -- Yes --> F[Troubleshoot in ComfyUI frontend]
18
-
E -- No --> G[Use general binary search method]
16
+
C --> E{<a href="#1-troubleshooting-the-custom-nodes’-frontend-extensions">Check frontend extensions first</a>?}
17
+
E -- Yes --> F[<a href="#1-troubleshooting-the-custom-nodes’-frontend-extensions">Troubleshoot in ComfyUI frontend</a><br/><li>Only need reload the frontend</li>]
18
+
E -- No --> G[<a href="#2-general-custom-node-troubleshooting">Use general binary search method</a><li>Need to restart ComfyUI multiple times</li>]
19
19
F --> H[Use binary search to locate problematic node]
20
20
G --> H
21
-
H --> I[Fix, replace, report or remove problematic node]
21
+
H --> I[<a href="#how-to-fix-the-issue">Fix, replace, report or remove problematic node</a>]
22
22
I --> J[Issue solved]
23
23
```
24
24
25
-
## How to determine if custom nodes are causing the issue?
25
+
## How to disable all custom nodes?
26
26
27
-
If the problem disappears after disabling all custom nodes, we can determine that the issue is caused by custom nodes.
27
+
<Tabs>
28
+
<Tabtitle="Desktop Users">
29
+
Start ComfyUI Desktop with custom nodes disabled from the settings menu
30
+
31
+
or run the server manually:
32
+
```bash
33
+
cd path/to/your/comfyui
34
+
python main.py --disable-all-custom-nodes
35
+
```
36
+
</Tab>
37
+
<Tabtitle="Manual Install">
38
+
```bash
39
+
cd ComfyUI
40
+
python main.py --disable-all-custom-nodes
41
+
```
42
+
</Tab>
43
+
<Tabtitle="Portable">
44
+
<Tabs>
45
+
<Tabtitle="Modify `.bat` file">
46
+
Open the folder where the portable version is located, and find the `run_nvidia_gpu.bat` or `run_cpu.bat` file
1. Copy `run_nvidia_gpu.bat` or `run_cpu.bat` file and rename it to `run_nvidia_gpu_disable_custom_nodes.bat`
49
+
2. Open the copied file with Notepad
50
+
3. Add the `--disable-all-custom-nodes` parameter to the file, or copy the parameters below into a `.txt` file and rename the file to `run_nvidia_gpu_disable_custom_nodes.bat`
- ✅ **Issue disappears**: A custom node is causing the problem → Continue to Step 2
75
+
- ❌ **Issue persists**: Not a custom node issue → [Report the issue](#reporting-issues)
28
76
29
-
### Binary search troubleshooting approach
77
+
##What is Binary Search?
30
78
31
79
In this document, we will introduce the binary search approach for troubleshooting custom node issues, which involves checking half of the custom nodes at a time until we locate the problematic node.
32
80
@@ -50,7 +98,7 @@ flowchart TD
50
98
K --> B
51
99
L --> M[End]
52
100
```
53
-
## Different Troubleshooting Methods for Different Types of Custom Node Issues
101
+
## Two Troubleshooting Methods
54
102
55
103
In this document, we categorize custom nodes into two types for troubleshooting:
56
104
@@ -61,8 +109,8 @@ In this document, we categorize custom nodes into two types for troubleshooting:
61
109
Let's first understand the potential issues and causes for different types of custom nodes:
62
110
63
111
<Tabs>
64
-
<Tabtitle="Issues with Frontend Extension Custom Nodes">
65
-
For custom nodes, we need to prioritize troubleshooting those with frontend extensions, as they cause the most issues. Their main conflicts arise from incompatibilities with ComfyUI frontend version updates.
112
+
<Tabtitle="Custom Nodes with Frontend Extensions">
113
+
For custom nodes, we can prioritize troubleshooting those with frontend extensions, as they cause the most issues. Their main conflicts arise from incompatibilities with ComfyUI frontend version updates.
66
114
67
115
Common issues include:
68
116
- Workflows not executing
@@ -80,8 +128,8 @@ Let's first understand the potential issues and causes for different types of cu
80
128
- Authors stopping maintenance, leading to incompatibility between custom node extensions and the ComfyUI frontend
81
129
82
130
</Tab>
83
-
<Tabtitle="Regular Custom Node Issues">
84
-
If the problem isn't caused by frontend extensions, issues often relate to dependencies. Common problems include:
131
+
<Tabtitle="Regular Custom Nodes">
132
+
If the problem isn't caused by custom nodes' frontend extensions, issues often relate to dependencies. Common problems include:
85
133
- "Failed to import" errors in console/logs
86
134
- Missing nodes still showing as missing after installation and restart
87
135
- ComfyUI crashes or fails to start
@@ -100,10 +148,10 @@ Let's first understand the potential issues and causes for different types of cu
100
148
101
149
Among these two different types of custom node issues, conflicts between custom node frontend extensions and ComfyUI are more common. We'll prioritize troubleshooting these nodes first. Here's the overall troubleshooting approach:
102
150
103
-
### 1. Troubleshooting Custom Nodes with Frontend Extensions
151
+
### 1. Troubleshooting the Custom Nodes' Frontend Extensions
104
152
105
153
<Steps>
106
-
<Steptitle="Disable All Plugin Frontend Extensions">
154
+
<Steptitle="Disable All Third-Party Frontend Extensions">
107
155
108
156
After starting ComfyUI, find the `Extensions` menu in settings and follow the steps shown in the image to disable all third-party extensions
109
157
<Tip>
@@ -127,71 +175,11 @@ Among these two different types of custom node issues, conflicts between custom
127
175
128
176
Using this method, you don't need to restart ComfyUI multiple times - just reload ComfyUI after enabling/disabling custom node frontend extensions. Plus, your troubleshooting scope is limited to nodes with frontend extensions, which greatly narrows down the search range.
129
177
130
-
### 2. General Custom Node Troubleshooting Approach
178
+
### 2. General Custom Node Troubleshooting
131
179
132
180
133
181
<Steps>
134
-
<Steptitle="Test with all custom nodes disabled">
135
-
<Tabs>
136
-
<Tabtitle="Desktop Users">
137
-
Start ComfyUI Desktop with custom nodes disabled from the settings menu
138
-
139
-
140
-
141
-
or run the server manually:
142
-
143
-
```bash
144
-
cd path/to/your/comfyui
145
-
python main.py --disable-all-custom-nodes
146
-
```
147
-
</Tab>
148
-
<Tabtitle="Manual Install">
149
-
```bash
150
-
cd ComfyUI
151
-
python main.py --disable-all-custom-nodes
152
-
```
153
-
</Tab>
154
-
<Tabtitle="Portable">
155
-
<Tabs>
156
-
<Tabtitle="Modify `.bat` file">
157
-
Open the folder where the portable version is located, and find the `run_nvidia_gpu.bat` or `run_cpu.bat` file
1. Copy `run_nvidia_gpu.bat` or `run_cpu.bat` file and rename it to `run_nvidia_gpu_disable_custom_nodes.bat`
161
-
2. Open the copied file with Notepad
162
-
3. Add the `--disable-all-custom-nodes` parameter to the file, or copy the parameters below into a `.txt` file and rename the file to `run_nvidia_gpu_disable_custom_nodes.bat`
0 commit comments