Manage ComfyUI using ComfyUI Launcher
ComfyUI Launcher is the core management tool of ComfyUI for administrator users. You can use it to control the running status of the ComfyUI service within the cluster, while easily managing models, plugins, runtime environment, and network configurations.
This document guides you on how to use ComfyUI Launcher for ComfyUI service management and routine maintenance.
Start and stop the ComfyUI service
As the administrator, you must start the ComfyUI service before you and other members can access it using the client interface.
Start the ComfyUI Service: Click the START button in the upper-right corner to start the ComfyUI service.
Notes on first run
- Initial startup of ComfyUI Launcher typically takes 10-20 seconds for environment initialization.
- If the system prompts that essential models are missing, you can click the START ANYWAY button to launch the service. However, note that workflows may not run correctly if basic models are missing. It is recommended to download the essential model package before starting the service.
Stop the ComfyUI Service: If you are not using ComfyUI for the moment, click the STOP button to stop the service. This releases the VRAM and memory resources occupied by ComfyUI.
Manage models
Note
Before installing models, ensure your host can access GitHub and HuggingFace. For details, refer to Configure network.
ComfyUI Launcher provides flexible ways to install models. You can install the essential models with one click, manually install from Hugging Face, or copy from external sources.
Install essential models
Essential models are basic models required for ComfyUI to run, including SD large models, VAE, preview decoders, and auxiliary tools models. It is recommended to install the essential package when running ComfyUI for the first time.
Access the essential model package page in either of the following methods:
- In the Missing essential models prompt window that appears when starting the service for the first time, click INSTALL MODELS.
- In the Package installation section on the homepage, find Essential model package, and click VIEW.
On the essential model installation page, click GET ALL RESOURCES to start the automatic installation. You can view the installation status via the progress bar below.
Manually download models
In addition to the essential models, ComfyUI Launcher also supports downloading models from the HuggingFace model library, allowing you to easily get the models you need.
Upload external models
If you can't find the desired model on Hugging Face, you can use Files to upload external models to the following directory:
External Devices/ai/model
Delete a model
To delete a model:
- Navigate to Model management > Model library.
- Under the Installed models section, find the model you want to delete, and click the delete button on the right to delete it permanently.
Manage plugins
You can manage plugins through ComfyUI's built-in ComfyUI-Manager or use Plugin management in the Launcher.
Manage available plugins
To manage available plugins registered in ComfyUI Manager:
- Navigate to Plugin management > Plugin Library.
- Under Available plugins, select the target plugin:
- Click the pause button to disable the currently running plugin, and click the play_circle button to resume running.
- Click the delete button to delete the plugin.
- Click the download button to download the plugin.
- Click the visibility button to view plugin details.
- Click the UPDATE ALL PLUGINS button to update all installed plugins.
- Click the REFRESH button to refresh the plugin status.
Download plugin from GitHub
To install plugins directly from GitHub repositories:
- Navigate to Plugin management > Custom Install.
- Enter the URL of the repository.
- Specify the branch (optional). Use the default (usually 'main' or 'master') if not specified.
- Click INSTALL PLUGIN.
Manage Python environment
ComfyUI's operation relies on a set of complex Python dependency libraries. You can manage these libraries easily on the Python dependency management page.
Install new dependency libraries
To install a new dependency library:
- Navigate to Python dependencies.
- click INSTALL NEW PACKAGE.
- In the pop-up window, enter the library name and version number (optional), and then click INSTALL.
Manage installed dependency libraries
- Under Installed Python packages, find the Python library you want to manage.
- Click the arrow_upward button on the right to update the library, or the delete button to remove it.
Analyze dependency installation status
- Under the Dependency analysis tab, click ANALYZE NOW to start analyzing.
- From the plugins list on the left, find the problematic plugin highlighted in red, and click on it.
- From Dependency list, find the missing library for the plugin, and click the Install button on the right. You can also click FIX ALL to automatically install all missing libraries.
Troubleshooting and maintenance
ComfyUI Launcher provides tools to help diagnose and maintain the ComfyUI service.
Configure network
Network connection issues can affect the download of models and plugins. Before using ComfyUI, it's recommended to check the connection status to GitHub, PyPI, and HuggingFace on the Launcher homepage.
For example, if GitHub is inaccessible:
- Navigate to the Network configuration.
- Switch the provided URLs for GitHub.
- Click the CHECK button on the right to refresh the connection status.
Repeat steps 2 and 3 until the network becomes "Accessible".
Export ComfyUI logs
You can export logs to diagnose the current running status of ComfyUI:
- In the upper-right corner of the Launcher homepage, click more_vert, then click View logs to view the current running log.
- Click the refresh button to refresh the log, and the download button to download the log.
Reset ComfyUI configuration
To reset ComfyUI to its initial state:
In the upper-right corner of the Launcher's homepage, click more_vert, and select Wipe and restore. After a second confirmation, the Launcher will begin the wiping and restoration process.
After the restoration operation is complete, restart ComfyUI for the changes to take effect.
Exercise caution
Restoring ComfyUI is an irreversible operation. Please operate carefully.
Discover inspirations
Enter the Discover page from the left sidebar to view the latest and most trending ComfyUI models and workflows on civit.ai.
Note
Please ensure your network can properly access civit.ai.