Skip to content

Commit 4ff4989

Browse files
authored
Update extra model path config docs (#275)
1 parent 73f12fc commit 4ff4989

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

snippets/install/add-external-models.mdx

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,10 @@ my_custom_config:
8585
controlnet: controlnet
8686
```
8787

88+
<Warning>
89+
For the desktop version, please add the configuration to the existing configuration path without overwriting the path configuration generated during installation. Please back up the corresponding file before modification, so that you can restore it when you make a mistake.
90+
</Warning>
91+
8892
Or you can refer to the default [extra_model_paths.yaml.example](https://github.com/comfyanonymous/ComfyUI/blob/master/extra_model_paths.yaml.example) for more configuration options. After saving, you need to **restart ComfyUI** for the changes to take effect.
8993

9094
Below is the original config example:
@@ -158,3 +162,18 @@ a111:
158162
hypernetworks: models/hypernetworks
159163
controlnet: models/ControlNet
160164
```
165+
166+
### Add Extra Custom Nodes Path
167+
168+
Besides adding external models, you can also add custom nodes paths that are not in the default path of ComfyUI
169+
170+
<Tip>
171+
Please note that this will not change the default installation path of custom nodes, but will add an extra path search when starting ComfyUI. You still need to complete the installation of custom node dependencies in the corresponding environment to ensure the integrity of the running environment.
172+
</Tip>
173+
174+
Below is a simple configuration example (MacOS), please modify it according to your actual situation and add it to the corresponding configuration file, save it and restart ComfyUI for the changes to take effect:
175+
176+
```yaml
177+
my_custom_nodes:
178+
custom_nodes: /Users/your_username/Documents/extra_custom_nodes
179+
```

snippets/zh/install/add-external-models.mdx

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,10 @@ my_custom_config:
8383
controlnet: controlnet
8484
```
8585

86+
<Warning>
87+
对于桌面版,请在原有配置路径下新增配置,而不覆盖掉安装过程中自动生成的路径配置,请在修改前备份对应的文件,这样在你配置错误时可以及时恢复
88+
</Warning>
89+
8690
或者你也可以参考默认的 [extra_model_paths.yaml.example](https://github.com/comfyanonymous/ComfyUI/blob/master/extra_model_paths.yaml.example) 来配置,保存之后, 需要 **重启 ComfyUI** 才能生效。
8791

8892
下面是完整的原始的配置配置示例:
@@ -136,4 +140,19 @@ a111:
136140
# gligen: models/gligen
137141
# custom_nodes: path/custom_nodes
138142

143+
```
144+
145+
### 添加额外自定义节点路径
146+
147+
除了添加外部模型之外,你同样可以添加不在 ComfyUI 默认路径下的自定义节点路径
148+
149+
<Tip>
150+
请注意,这并不会改变自定义节点的默认安装路径,只是在启动 ComfyUI 时会增加额外的路径搜索,你仍旧需要在对应的环境中完成自定义节点的依赖的安装,来保证其运行环境的完整性。
151+
</Tip>
152+
153+
下面是一个简单的配置示例(Mac 系统),请根据你的实际情况进行修改,并新增到对应的配置文件中,保存后需要 **重启 ComfyUI** 才能生效:
154+
155+
```yaml
156+
my_custom_nodes:
157+
custom_nodes: /Users/your_username/Documents/extra_custom_nodes
139158
```

0 commit comments

Comments
 (0)