-
Notifications
You must be signed in to change notification settings - Fork 5
feat: add ComfyUI launcher docs #155
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
d4e5dbe
feat: add ComfyUI launcher docs
cal-weng 89d3a09
update wording for ComfyUI launcher
cal-weng c507e27
batch update images for en
cal-weng 4d74d88
update Comfyui related content in tutorial
cal-weng ed4bc35
update wording and image
cal-weng fe7d93c
resolve comments
cal-weng File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,188 @@ | ||
--- | ||
description: Administrators' guide on how to manage ComfyUI on Olares using ComfyUI Launcher, covering controling the service, managing models, plugins, and python environments, troubleshooting and maintenance. | ||
--- | ||
|
||
# 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. | ||
|
||
::: tip 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 | ||
|
||
:::tip Note | ||
Before installing models, ensure your host can access GitHub and HuggingFace. For details, refer to [Configure network](#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. | ||
|
||
1. 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**. | ||
|
||
2. 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. | ||
|
||
<Tabs> | ||
<template #Download-from-builtin-library> | ||
Follow these steps to download a model the built-in HuggingFace library: | ||
|
||
1. Navigate to **Model management**. | ||
2. Scroll down to the **Available models** section, and find the desired model by category or keyword. | ||
3. Click the <i class="material-symbols-outlined">download</i> button to download the model. | ||
|
||
 | ||
|
||
</template> | ||
<template #Custom-download-via-link> | ||
If you can't find a specific model in the built-in library, you can still download it via the model URL on Hugging Face: | ||
|
||
1. Navigate to **Model management** > **Custom Download**. | ||
2. Fill in the model URL and select the destination path. | ||
3. Click **DOWNLOAD MODEL**. | ||
|
||
 | ||
</template> | ||
</Tabs> | ||
|
||
:::tip 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: | ||
|
||
1. Navigate to **Model management** > **Model library**. | ||
2. Under the **Installed models** section, find the model you want to delete, and click the <i class="material-symbols-outlined">delete</i> 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: | ||
|
||
1. Navigate to **Plugin management** > **Plugin Library**. | ||
2. Under **Available plugins**, select the target plugin: | ||
* Click the <i class="material-symbols-outlined">pause</i> button to disable the currently running plugin, and click the <i class="material-symbols-outlined">play_circle</i> button to resume running. | ||
* Click the <i class="material-symbols-outlined">delete</i> button to delete the plugin. | ||
* Click the <i class="material-symbols-outlined">download</i> button to download the plugin. | ||
* Click the <i class="material-symbols-outlined">visibility</i> 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: | ||
|
||
1. Navigate to **Plugin management** > **Custom Install**. | ||
2. Enter the URL of the repository. | ||
3. Specify the branch (optional). Use the default (usually 'main' or 'master') if not specified. | ||
4. 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: | ||
|
||
1. Navigate to **Python dependencies**. | ||
2. click **INSTALL NEW PACKAGE**. | ||
3. In the pop-up window, enter the library name and version number (optional), and then click **INSTALL**. | ||
|
||
### Manage installed dependency libraries | ||
|
||
1. Under **Installed Python packages**, find the Python library you want to manage. | ||
2. Click the <i class="material-symbols-outlined">arrow_upward</i> button on the right to update the library, or the <i class="material-symbols-outlined">delete</i> button to remove it. | ||
|
||
### Analyze dependency installation status | ||
|
||
1. Under the **Dependency analysis** tab, click **ANALYZE NOW** to start analyzing. | ||
2. From the plugins list on the left, find the problematic plugin highlighted in red, and click on it. | ||
3. 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: | ||
|
||
1. Navigate to the **Network configuration**. | ||
2. Switch the provided URLs for GitHub. | ||
3. 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: | ||
|
||
 | ||
|
||
1. In the upper-right corner of the Launcher homepage, click <i class="material-symbols-outlined">more_vert</i>, then click **View logs** to view the current running log. | ||
2. Click the <i class="material-symbols-outlined">refresh</i> button to refresh the log, and the <i class="material-symbols-outlined">download</i> button to download the log. | ||
|
||
### Reset ComfyUI configuration | ||
|
||
To reset ComfyUI to its initial state: | ||
|
||
 | ||
|
||
1. In the upper-right corner of the Launcher's homepage, click <i class="material-symbols-outlined">more_vert</i>, and select **Wipe and restore**. After a second confirmation, the Launcher will begin the wiping and restoration process. | ||
|
||
2. After the restoration operation is complete, restart ComfyUI for the changes to take effect. | ||
|
||
:::warning 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](civit.ai). | ||
|
||
::: tip Note | ||
Please ensure your network can properly access [civit.ai](civit.ai). | ||
::: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
BIN
+236 KB
docs/public/images/manual/use-cases/comfyui-model-library-download.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
BIN
+178 KB
docs/public/images/zh/manual/use-cases/comfyui-custom-model-download.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Binary file added
BIN
+288 KB
docs/public/images/zh/manual/use-cases/comfyui-model-library-download.png
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.