|
1 | 1 | # ayon-comfyui |
2 | 2 | An AYON Addon for launching ComfyUI locally via TrayLauncher. |
3 | 3 |
|
4 | | -Loads `ComfyUI` from offical GitHub repo and comes with `ComfyUI-Manager` preconfigured. |
| 4 | +Clones `ComfyUI` from offical GitHub repo and comes with `ComfyUI-Manager` preconfigured. |
| 5 | +`uv` is used for installing all required dependencies and environment solving in a separate terminal session. This session is used to launch a local `ComfyUI` server. |
5 | 6 |
|
6 | | -> ⚠️ **Warning:** This addon is Windows-only and depends on `uv` to be executable on your system. |
| 7 | +> ⚠️ This addon is Windows-only and depends on `uv` and `git` to be executable on your system. |
7 | 8 | > If `uv` is not found it will run the installation script from https://astral.sh/uv/install.ps1 for the current user. |
8 | 9 |
|
| 10 | +## Plugin and Dependency Management |
| 11 | +The addon automatically manages plugins and their dependencies to maintain a clean and reproducible ComfyUI environment. |
| 12 | +This is achieved by tracking the currently active venv against an additional temporary `.baseline-venv` containing only core ComfyUI dependencies. |
| 13 | +Any folder found in the `custom_nodes` directory that is not in the configured plugins list are automatically deleted. |
| 14 | + |
| 15 | +> ⚠️ The cleanup process is automatic and cannot be disabled. Ensure your plugin configuration is correct before launching to avoid unintended plugin removal. |
9 | 16 |
|
10 | | -It's Launcher Action uses `git` from AYON's dependency package to clone `ComfyUI` and any custom plugins that are configured. |
11 | | -`uv` is used for installing all required dependencies and environment solving in a separate terminal session. This session is used to launch a local `ComfyUI` server. |
| 17 | +## Setup |
| 18 | +This addon requires an "Additional Application" in AYON's application settings to be created. |
| 19 | +Its `name` and `host_name` must be `comfyui`. |
| 20 | +Use the variant names to specify an available ComfyUI branch or tag. Finally, set the windows executable path to `powershell.exe`. |
| 21 | +This is to launch beforementioned separate terminal session. I know, it's a bit hacky. |
| 22 | + |
| 23 | + |
| 24 | +### Settings |
| 25 | +Use Extra Flags to add any custom launch flags to the webserver, e.g. `--use-cpu`. |
12 | 26 |
|
13 | | -## Settings |
14 | | -> ✏️ All directory inputs support anatomy template strings and absolute paths. |
| 27 | +#### Virtual Environment Settings |
| 28 | +Configure the python version to use and whether to pull nightly PyTorch builds. |
| 29 | +You can also set a specific path to `uv` if it's not in `$PATH`. |
15 | 30 |
|
16 | | -### Repository Settings |
| 31 | +#### Repository Settings |
17 | 32 | Configure where to pull ComfyUI sources, its target directory and additional plugins. |
18 | 33 | You can specify extra dependencies to be installed as some custom nodes don't maintain a `requirements.txt`. All configured plugin dependencies will be collected and installed in a single `uv pip install`. |
19 | 34 |
|
20 | | - |
21 | | - |
22 | | -### General Settings |
23 | | -Toggle CPU-only mode and configure custom models. Toggle extra models to consider them during launch. You can add multiple directories per model type. They will be added to the ComfyUI repo directory's `extra_model_paths.yaml`. When using `copy_to_base` the directories won't be added to the config yaml but copied into the repo base's `models/{model_type}`. |
| 35 | +#### Extra Models |
| 36 | +Toggle to define a source directory to all your custom models to consider them during launch. |
| 37 | +All found folders will be added to the ComfyUI repo directory's `extra_model_paths.yaml`. When using `copy_to_base` the directories won't be added to the config yaml but copied into the repo base's `models/{model_type}`. |
24 | 38 |
|
25 | 39 | > ⚠️ `copy_to_base` currently just blindly copies every file found in the directory. No filtering for files yet. |
26 | 40 |
|
27 | | - |
28 | | - |
29 | | -### Caching Settings |
| 41 | +#### Caching Settings |
30 | 42 | Configure whether `uv` should use a specific cache location to read and write to. Currently only configures `UV_CACHE_DIR` during the launch script but it seems to do the job. |
31 | 43 | Could be used in air-gapped scenarios. |
32 | 44 |
|
33 | | - |
34 | | - |
35 | | - |
36 | | -### Plugin and Dependency Management |
37 | | -The addon automatically manages plugins and their dependencies to maintain a clean and reproducible ComfyUI environment. |
38 | | -This is achieved by tracking the currently active venv against an additional temporary `.baseline-venv` containing only core ComfyUI dependencies. |
39 | | -Any folder found in the `custom_nodes` directory that is not in the configured plugins list are automatically deleted. |
40 | | - |
41 | | -> ⚠️ **Note:** The cleanup process is automatic and cannot be disabled. Ensure your plugin configuration is correct before launching to avoid unintended plugin removal. |
|
0 commit comments