Skip to content

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/.vitepress/zh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,13 @@ const side = {
{
text: "ComfyUI",
link: "/zh/manual/use-cases/comfyui",
collapsed: true,
items: [
{
text: "管理 ComfyUI",
link: "/zh/manual/use-cases/comfyui-launcher",
},
],
},
{
text: "Ollama 下载开源模型",
Expand Down
151 changes: 151 additions & 0 deletions docs/manual/use-cases/comfyui-launcher.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
---
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, included with ComfyUI Shared, 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

Only after you start the ComfyUI service can you and other members access it using the ComfyUI client interface.

![Start/Stop ComfyUI service](/images/manual/use-cases/comfyui-start.png#bordered)

* **Start the ComfyUI Service**: Click the **Start** button in the upper-right corner to start the ComfyUI service.

::: tip First run
* Initial startup of the launcher requires environment initialization, which typically takes 10-20 seconds.
* If the system prompts that necessary basic models are missing, you can click **Start anyway** to continue. However, note that workflows may not run correctly if basic models are missing. It is recommended to download the necessary basic model package after the initial installation.
:::

* **Stop the ComfyUI Service**: If you are not using ComfyUI for the moment, click the **Stop** button to pause the service. This will release 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 [Check and set network](#check-and-set-network).
:::

ComfyUI Launcher provides flexible ways to install models. You can install the essential models with one click, manually install from the built-in model library, or copy from external sources.

### Install essential models with one click

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 for the first time.

1. Access the essential model package installation page using either of the following:
- 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 **Download**.

2. On the essential model installation page, click **Install models** to start the automatic installation. You can view the installation status via the progress bar below.
![Install Resource Package](/images/zh/manual/use-cases/comfyui-install-model.png#bordered)

### Manually download models

In addition to basic models, ComfyUI Launcher also includes a built-in HuggingFace model library, allowing you to easily find and download the models you need.

1. Navigate to **Model management** from the left sidebar.
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 and install the model.

![Manually download](/images/manual/use-cases/comfyui-download-model.png#bordered)

:::tip Upload external models
If you can't find the desired model in the built-in model library, you can also use **Files** to upload externally downloaded models to the following model directory:

`External Devices/ai/model`
:::

### Delete models

To delete a specific model:

1. Navigate to **Model management** from the left sidebar.
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 Plugins](/images/zh/manual/use-cases/comfyui-manage-plugin.png#bordered)

1. Navigate to **Plugin management** from the left sidebar.
2. Under **Plugin Library** > **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 plugins.

## Manage Python environment

ComfyUI's operation relies on a set of complex Python dependency libraries. You can manage these libraries easily on the **Environment Management** page, including installing new libraries, updating or removing installed libraries, analyzing plugin dependency status, and fixing installation errors.

![Manage Python Environment](/images/zh/manual/use-cases/comfyui-manage-python.png#bordered)

### Install new dependency libraries

1. Under the **Python dependency libraries** tab, click **Install new library**.
2. Enter the library name and version number (optional), and then click **Install**.

### Manage installed dependency libraries

1. Under **Python dependency libraries** > **Installed Python libraries**, 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, find the problematic plugin highlighted in red, and click on it.
3. From the **Dependency library 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.
![Analyze dependencies](/images/zh/manual/use-cases/comfyui-analyze-dependency.png#bordered)

## Troubleshooting and maintenance

ComfyUI Launcher also provides tools to help diagnose and maintain the ComfyUI service.

### Check and 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.

![Check network status](/images/zh/manual/use-cases/comfyui-view-network.png#bordered)

If a website, GitHub for example, is inaccessible:

1. Navigate to the **Network Configuration** page from the left sidebar.
2. In the list, switch the provided URLs for the website until the network status becomes "Accessible".

![Switch network](/images/zh/manual/use-cases/comfyui-change-network.png#bordered)

### Export ComfyUI logs

You can export logs to diagnose the current running status of ComfyUI:

![Export Logs](/images/zh/manual/use-cases/comfyui-log.png#bordered)

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 logs.
2. Below the logs, click the <i class="material-symbols-outlined">refresh</i> button to refresh the logs, and the <i class="material-symbols-outlined">download</i> button to download the logs.

### Reset ComfyUI configuration

To reset ComfyUI to its initial state:

![Reset ComfyUI](/images/zh/manual/use-cases/comfyui-reset.png#bordered)

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.

:::warning Exercise caution
Restoring ComfyUI is an irreversible operation. Please operate carefully.
:::

2. After the restoration operation is complete, restart ComfyUI for the changes to take effect.

## 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).
:::
34 changes: 26 additions & 8 deletions docs/manual/use-cases/comfyui.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,35 @@ ComfyUI puts advanced AI image generation capabilities at your fingertips:
* Batch process images with consistent settings
* Apply advanced post-processing effects

## Install ComfyUI
## Install ComfyUI Shared

Based on your role:
* **For admin**: Install both "ComfyUI For Cluster" and "ComfyUI".
* **For team members**: Ensure your admin has installed "ComfyUI For Cluster", and install "ComfyUI" only.
Olares provides ComfyUI Shared, an adapted version that allows multiple users to share models, plugins, and workflow resources across the cluster. It also features ComfyUI Launcher, providing administrator users with a simple way to manage ComfyUI resources and runtime environments.

![Install ComfyUI](/images/manual/tutorials/install-comfyui.png){width=40%}
::: tip Note
Starting from Olares 1.11.6, Shared Applications will replace previous cluster-scoped applications. If you have installed ComfyUI for Cluster and its client, please uninstall them before installing ComfyUI Shared.
:::

Once installed, launch ComfyUI from your desktop.
The installation of ComfyUI Shared Edition is divided into two phases: administrator installation and regular user installation.

![ComfyUI](/images/manual/use-cases/comfyui.png#bordered)
1. **Administrator installation**. Open Olares Market, find **ComfyUI Shared**, and click **Get**.

After the administrator installation is complete, two icons appear on the Olares desktop: one is the access point for ComfyUI, and the other is the access point for ComfyUI Launcher.

:::tip Start service
Only after the administrator configures and starts the service in the ComfyUI Launcher can cluster users access the ComfyUI interface and use workflows.
:::

2. **Member installation**. Open Olares Market, find ComfyUI Shared, and click **Get**.

After the installation is complete, the member user only sees the ComfyUI icon on the desktop.

![Install ComfyUI](/images/manual/tutorials/install-comfyui.png){width=40%}

3. After installation is complete, click the ComfyUI icon from the desktop to open it. Administrators can also enter the ComfyUI interface from the ComfyUI Launcher.

![ComfyUI Interface](/images/manual/use-cases/comfyui.png#bordered)

## Learn more
- [Use ComfyUI in Krita](../tutorials/comfyui-for-krita.md): Learn how to leverage ComfyUI to empower your creative workflows in Krita.

* [Manage ComfyUI using ComfyUI Launcher](comfyui-launcher.md)
* [Krita + ComfyUI Real-time Painting](../tutorials/comfyui-for-krita.md): Learn how to leverage ComfyUI to assist creative workflows in Krita.
Binary file modified docs/public/images/manual/tutorials/install-comfyui.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.
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.
148 changes: 148 additions & 0 deletions docs/zh/manual/use-cases/comfyui-launcher.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
---
description: 使用 ComfyUI 启动器轻松启动和管理 ComfyUI,包括模型管理、插件配置、环境设置与网络检查等。
---
# 使用 ComfyUI 启动器管理 ComfyUI

ComfyUI 启动器(ComfyUI Launcher)是 ComfyUI 共享版为**管理员用户**提供的核心管理工具。你可以通过启动器来控制 ComfyUI 后台服务的运行状态,并轻松管理模型、插件、运行环境和网络配置。

本章节将指导你如何使用 ComfyUI 启动器进行服务的管理和日常维护。

## 启动和停止 ComfyUI 服务

你可以使用启动器右上角的按钮控制 ComfyUI 后台服务的运行状态。

![启动停止服务](/images/zh/manual/use-cases/comfyui-start.png#bordered)

- **启动 ComfyUI 服务**:点击启动器右上角的**启动**按钮启动 ComfyUI 后台程序。
::: tip 首次运行
- 首次启动需要进行环境初始化,通常需要等待 10-20 秒。
- 如果系统提示缺少必要的基础模型,你可以点击**仍然启动**继续。但请注意,如果缺少基本模型,工作流可能无法正常运行。建议首次安装后先下载必要的基础模型包。
:::

- **停止 ComfyUI 服务**:如果暂时不使用 ComfyUI,可点击启动器右上角的**停止**按钮暂停服务。这会释放 ComfyUI 占用的显存和内存资源。

## 管理模型

:::tip 注意
在安装模型之前,请确保您的主机能够正确访问 Github 和 HuggingFace,详细请参考[检查和设置网络](#检查和设置网络环境)。
:::

ComfyUI 启动器提供灵活、丰富的模型安装方式。你可以一键安装运行所需基础模型,也可根据需求从内置模型库手动安装或从外部复制。

### 一键安装基础模型

基础模型即 ComfyUI 运行必要的基础模型,包括SD大模型、VAE、预览解码器和辅助工具模型。首次运行时建议先安装基础模型包。
1. 通过以下任一方式进入基础模型包安装页面。
- 在首次启动服务时弹出的"缺少基础模型"提示窗口里,点击**安装模型**。
- 在启动器首页的**资源包安装**区域,找到**基础模型包**,并点击**下载**。

2. 在基础模型安装页面,点击**安装资源包**开始自动安装。可以通过下方进度条查看安装进度。
![安装资源包](/images/zh/manual/use-cases/comfyui-install-model.png#bordered)

### 手动下载模型
除了基础模型之外,启动器也内置了 HuggingFace 模型库,让你轻松查找并下载所需模型:

1. 从启动器左侧导航栏进入**模型管理**。
2. 在**可用模型**部分按类别或关键词查找所需模型。
3. 点击 <i class="material-symbols-outlined">download</i> 按钮完成下载。

![手动下载](/images/zh/manual/use-cases/comfyui-download-model.png#bordered)

:::tip 上传外部模型
如在内置模型库无法找到所需模型,你也可以将外部下载的文件通过文件管理器上传至以下模型目录:

`外部设备/ai/model`。
:::

### 删除模型
要删除指定模型:

1. 从启动器左侧导航栏进入**模型管理**。
2. 在**已安装模型**单元下,找到待删除模型,并点击右侧 <i class="material-symbols-outlined">delete</i> 按钮以删除。

## 管理插件

您可以通过 ComfyUI 内置的 ComfyUI-Manager 管理插件,也可以使用启动器的**插件管理**页面进行安装、更新和卸载。

![管理插件](/images/zh/manual/use-cases/comfyui-manage-plugin.png#bordered)

1. 从启动器左侧导航栏进入**插件管理**。
2. 在**插件库** > **可用插件** 下,选择目标插件:
- 点击 <i class="material-symbols-outlined">pause</i> 按钮禁用当前运行的插件,点击 <i class="material-symbols-outlined">play_circle</i> 按钮恢复运行。
- 点击 <i class="material-symbols-outlined">delete</i> 按钮删除插件。
- 点击 <i class="material-symbols-outlined">download</i> 按钮下载插件。
- 点击 <i class="material-symbols-outlined">visibility</i> 按钮查看插件详情。
- 点击**更新全部插件**按钮更新插件。

## 管理 Python 环境

ComfyUI 的运行依赖复杂的 Python 环境。你可以在**环境管理**页中管理 ComfyUI 容器中的Python 依赖库,包括安装新依赖库、管理已安装依赖库、分析插件依赖状态并修复安装错误。

![管理 Python 环境](/images/zh/manual/use-cases/comfyui-manage-python.png#bordered)

### 安装新依赖库

1. 在 **Python 依赖库**页签下,点击**安装新库**按钮。
2. 输入库的名称和版本号(可选),点击**安装**。

### 管理已安装依赖库
1. 在 **Python 依赖库** > **已安装 Python 库**下,找到需要操作的 Python 库。
2. 点击右侧 <i class="material-symbols-outlined">arrow_upward</i> 按钮以升级库, <i class="material-symbols-outlined">delete</i> 按钮以删除库。

### 分析依赖库安装
1. 在**依赖分析**页签下,点击**立即分析**按钮。
2. 在插件栏,找到并点击红色高亮的问题插件。
3. 在**依赖库列表**里,找到缺失的库,并点击右侧**安装**按钮。你也可以点击**一键修复**自动安装所有缺失库。
![分析依赖](/images/zh/manual/use-cases/comfyui-analyze-dependency.png#bordered)

## 故障排除和维护

启动器还提供了一些工具帮助诊断和维护 ComfyUI 服务。

### 检查和设置网络环境

网络连接问题可能影响模型和插件的下载。使用 ComfyUI 前可在启动器主页查看对 Github、PyPI 和 HuggingFace 的连接状态。

![检查网络状态](/images/zh/manual/use-cases/comfyui-view-network.png#bordered)

如有网站无法访问:

1. 从启动器左侧导航栏进入**网络配置**页面。
2. 在列表里切换网站的可访问地址,直至网络状态变为"可访问"。

![切换网络](/images/zh/manual/use-cases/comfyui-change-network.png#bordered)

### 查看运行日志

你可以导出日志来诊断 ComfyUI 当前的运行状态:

![查看日志](/images/zh/manual/use-cases/comfyui-log.png#bordered)


1. 在启动器首页右上角点击<i class="material-symbols-outlined">more_vert</i>,再点击**查看日志**以查看当前运行日志。
2. 点击日志下方<i class="material-symbols-outlined">refresh</i>以刷新日志,<i class="material-symbols-outlined">download</i>以下载日志。

### 还原 ComfyUI 配置

如果你希望将 ComfyUI 还原到初始状态:

![重置 ComfyUI](/images/zh/manual/use-cases/comfyui-reset.png#bordered)

1. 在启动器首页右上角点击<i class="material-symbols-outlined">more_vert</i>,选择**抹掉并还原**。二次确认后,将启动器将开始抹掉和还原程序。

:::warning 谨慎操作
还原 ComfyUI 是不可逆的操作,请谨慎选择。
:::

2. 还原操作完成后,重启 ComfyUI 以生效。

## 灵感发现

你可以从左侧导航栏进入**灵感发现**页面,查看 [civit.ai](civit.ai) 上最新、最热门的 ComfyUI 模型和工作流。

::: tip 注意
请确认你的网络可以正常访问 [civit.ai](civit.ai)。
:::



Loading