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

Merged
merged 6 commits into from
May 22, 2025
Merged
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/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,13 @@ const side = {
{
text: "ComfyUI",
link: "/manual/use-cases/comfyui",
collapsed: true,
items: [
{
text: "Manage ComfyUI",
link: "/manual/use-cases/comfyui-launcher",
},
]
},
{
text: "Ollama",
Expand Down
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
25 changes: 11 additions & 14 deletions docs/manual/tutorials/comfyui-for-krita.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,25 +26,22 @@ Before starting, ensure you have:

## Set up ComfyUI

1. Install ComfyUI from Market based on your role:
1. Install ComfyUI Shared from Market.
- For administrator users, this installs both ComfyUI Launcher (the management UI) and ComfyUI (the client UI).
- For member users, this only installs ComfyUI.

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

![Install ComfyUI](/images/manual/tutorials/install-comfyui.png){width=30%}
2. The administrator configures and launches the ComfyUI service from the ComfyUI Launcher.

- **For admin**: Install "ComfyUI For Cluster" to set up the shared backend service within the Olares cluster. Then, install "ComfyUI" to enable the client interface for personal use.
- **For team members**: Confirm that your admin has installed "ComfyUI For Cluster", then install "ComfyUI" to access the service via the client application.
3. Configure ComfyUI access policy.

:::info
**ComfyUI For Cluster** operates as a backend service and does not display a desktop icon. All interactions are done via the client application.
:::

2. Configure ComfyUI.

a. Open Settings, navigate to **Applications** > **ComfyUI** > **Entrances**.
a. Open Settings, navigate to **Applications** > **ComfyUI Shared** > **Entrances**.

b. Set the **Authentication level** to **Internal**.
b. Set the **Authentication level** for ComfyUI to **Internal**.
![ComfyUI authentication level](/images/manual/use-cases/comfyui-authentication-level.png#bordered){width=70%}
3. Launch ComfyUI from your desktop, and verify the installation by generating a sample image.
4. Copy the address of ComfyUI for next steps.
4. Launch ComfyUI from your desktop, and verify the installation by generating a sample image.
5. Copy the address of ComfyUI for next steps.
:::tip
For security, you should always run AI applications within your local network. When properly configured, your ComfyUI URL should contain `.local`.

Expand Down
188 changes: 188 additions & 0 deletions docs/manual/use-cases/comfyui-launcher.md
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/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 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.

![Install resource package](/images/manual/use-cases/comfyui-install-essential.png#bordered)

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

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

</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**.

![Custom download](/images/manual/use-cases/comfyui-custom-model-download.png#bordered)
</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 plugins](/images/manual/use-cases/comfyui-manage-plugin.png#bordered)

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

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

### 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.
![Analyze dependencies](/images/manual/use-cases/comfyui-analyze-dependency.png#bordered)

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

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

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".

![Switch network](/images/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/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 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:

![Reset ComfyUI](/images/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.

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).
:::
32 changes: 24 additions & 8 deletions docs/manual/use-cases/comfyui.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,33 @@ 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 to allow multiple users to share models, plugins, and workflow resources within 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.
To install ComfyUI Shared:

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

- The administrator will see two icons on the Olares desktop: one is the client interface for ComfyUI, and the other is ComfyUI Launcher.

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

- Member users will only see the ComfyUI client interface on the desktop.

:::tip Start the ComfyUI service
The administrator must start the ComfyUI service from the Launcher before all users in the cluster can access the service from the client interface.
:::

2. Click the ComfyUI icon to open the interface. Administrators can also enter the ComfyUI interface from the 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.
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.
22 changes: 10 additions & 12 deletions docs/zh/manual/tutorials/comfyui-for-krita.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,28 +26,26 @@ description: 将 ComfyUI 与 Krita 结合使用的教程,学习如何配置 AI

## 配置 ComfyUI

1. 根据你的角色安装 ComfyUI:
1. 从应用市场安装 ComfyUI 共享版。
- 管理员会同时安装 ComfyUI 启动器(管理界面)和 ComfyUI (客户端界面)。
- 成员仅会安装 ComfyUI。

![安装 ComfyUI](/images/manual/tutorials/install-comfyui.png){width=30%}
![安装 ComfyUI](/images/manual/use-cases/install-comfyui.png){width=40%}

- **管理员**:先安装“ComfyUI For Cluster”以在 Olares 集群中搭建共享实例,然后安装“ComfyUI”以启用个人使用的客户端界面。
- **团队成员**:确认管理员已安装“ComfyUI For Cluster”后,安装“ComfyUI”即可通过客户端访问该服务。
2. 管理员通过 ComfyUI 启动器配置并启动 ComfyUI 后端服务。

:::info
**ComfyUI For Cluster** 作为后端服务运行,不会在桌面显示图标。所有操作都通过客户端应用完成。
:::
2. 配置 ComfyUI 的认证级别。
3. 配置 ComfyUI 的认证级别。

a. 打开设置,导航至**应用** > **ComfyUI** > **入口**。
a. 打开设置,导航至**应用** > **ComfyUI Shared** > **入口**。

b. 将**认证级别**设置为**内部**。
b. 将 ComfyUI 的**认证级别**设置为**内部**。

![ComfyUI 认证应用](/images/zh/manual/use-cases/comfyui-authentication-level.png#bordered){width=80%}
:::info
将 ComfyUI 应用的认证级别设置为“**内部**”后,当你的电脑和 Olares 主机在同一局域网或者通过专用网络访问 Olares 时,你可以在不登录 Olares 的情况下使用 ComfyUI。
:::
3. 从桌面启动 ComfyUI,通过生成测试图像验证安装是否成功。
4. 复制 ComfyUI 地址,以备后续使用。
4. 从桌面启动 ComfyUI,通过生成测试图像验证安装是否成功。
5. 复制 ComfyUI 地址,以备后续使用。
:::tip
出于安全考虑,应始终在局域网中运行 AI 应用。正确配置后,ComfyUI 的 URL 中应包含“`.local`”字段。
如果缺少“`.local`”,请检查本地网络环境,确保当前设备和 Olares 处于同一网段,并且未启用外部网络代理服务。
Expand Down
Loading