diff --git a/docs/.vitepress/en.ts b/docs/.vitepress/en.ts index 46622103..daa67737 100644 --- a/docs/.vitepress/en.ts +++ b/docs/.vitepress/en.ts @@ -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", diff --git a/docs/.vitepress/zh.ts b/docs/.vitepress/zh.ts index 2d083f09..44ef1e98 100644 --- a/docs/.vitepress/zh.ts +++ b/docs/.vitepress/zh.ts @@ -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 下载开源模型", diff --git a/docs/manual/tutorials/comfyui-for-krita.md b/docs/manual/tutorials/comfyui-for-krita.md index d476947c..01a48be8 100644 --- a/docs/manual/tutorials/comfyui-for-krita.md +++ b/docs/manual/tutorials/comfyui-for-krita.md @@ -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`. diff --git a/docs/manual/use-cases/comfyui-launcher.md b/docs/manual/use-cases/comfyui-launcher.md new file mode 100644 index 00000000..a3419f35 --- /dev/null +++ b/docs/manual/use-cases/comfyui-launcher.md @@ -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. + + + + + + +:::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 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 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 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: + +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 arrow_upward button on the right to update the library, or the delete 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 more_vert, then click **View logs** to view the current running log. +2. 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: + +![Reset ComfyUI](/images/manual/use-cases/comfyui-reset.png#bordered) + +1. 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. + +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). +::: \ No newline at end of file diff --git a/docs/manual/use-cases/comfyui.md b/docs/manual/use-cases/comfyui.md index 54e7079f..6f8ab653 100644 --- a/docs/manual/use-cases/comfyui.md +++ b/docs/manual/use-cases/comfyui.md @@ -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. \ No newline at end of file + +* [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. \ No newline at end of file diff --git a/docs/public/images/manual/tutorials/install-comfyui.png b/docs/public/images/manual/tutorials/install-comfyui.png index 52aadb4a..84a87401 100644 Binary files a/docs/public/images/manual/tutorials/install-comfyui.png and b/docs/public/images/manual/tutorials/install-comfyui.png differ diff --git a/docs/public/images/manual/use-cases/comfyui-analyze-dependency.png b/docs/public/images/manual/use-cases/comfyui-analyze-dependency.png new file mode 100644 index 00000000..ffe3335b Binary files /dev/null and b/docs/public/images/manual/use-cases/comfyui-analyze-dependency.png differ diff --git a/docs/public/images/manual/use-cases/comfyui-change-network.png b/docs/public/images/manual/use-cases/comfyui-change-network.png new file mode 100644 index 00000000..d88eeeb9 Binary files /dev/null and b/docs/public/images/manual/use-cases/comfyui-change-network.png differ diff --git a/docs/public/images/manual/use-cases/comfyui-check-network.png b/docs/public/images/manual/use-cases/comfyui-check-network.png new file mode 100644 index 00000000..ab74b59a Binary files /dev/null and b/docs/public/images/manual/use-cases/comfyui-check-network.png differ diff --git a/docs/public/images/manual/use-cases/comfyui-custom-model-download.png b/docs/public/images/manual/use-cases/comfyui-custom-model-download.png new file mode 100644 index 00000000..a5827f12 Binary files /dev/null and b/docs/public/images/manual/use-cases/comfyui-custom-model-download.png differ diff --git a/docs/public/images/manual/use-cases/comfyui-install-essential.png b/docs/public/images/manual/use-cases/comfyui-install-essential.png new file mode 100644 index 00000000..037e6757 Binary files /dev/null and b/docs/public/images/manual/use-cases/comfyui-install-essential.png differ diff --git a/docs/public/images/manual/use-cases/comfyui-log.png b/docs/public/images/manual/use-cases/comfyui-log.png new file mode 100644 index 00000000..5843e3e1 Binary files /dev/null and b/docs/public/images/manual/use-cases/comfyui-log.png differ diff --git a/docs/public/images/manual/use-cases/comfyui-manage-plugin.png b/docs/public/images/manual/use-cases/comfyui-manage-plugin.png new file mode 100644 index 00000000..3c4fa064 Binary files /dev/null and b/docs/public/images/manual/use-cases/comfyui-manage-plugin.png differ diff --git a/docs/public/images/manual/use-cases/comfyui-manage-python.png b/docs/public/images/manual/use-cases/comfyui-manage-python.png new file mode 100644 index 00000000..fc850f1a Binary files /dev/null and b/docs/public/images/manual/use-cases/comfyui-manage-python.png differ diff --git a/docs/public/images/manual/use-cases/comfyui-model-library-download.png b/docs/public/images/manual/use-cases/comfyui-model-library-download.png new file mode 100644 index 00000000..abc0eb6c Binary files /dev/null and b/docs/public/images/manual/use-cases/comfyui-model-library-download.png differ diff --git a/docs/public/images/manual/use-cases/comfyui-reset.png b/docs/public/images/manual/use-cases/comfyui-reset.png new file mode 100644 index 00000000..aefe8706 Binary files /dev/null and b/docs/public/images/manual/use-cases/comfyui-reset.png differ diff --git a/docs/public/images/manual/use-cases/comfyui-start.png b/docs/public/images/manual/use-cases/comfyui-start.png new file mode 100644 index 00000000..7e176732 Binary files /dev/null and b/docs/public/images/manual/use-cases/comfyui-start.png differ diff --git a/docs/public/images/manual/use-cases/comfyui-view-network.png b/docs/public/images/manual/use-cases/comfyui-view-network.png new file mode 100644 index 00000000..ab74b59a Binary files /dev/null and b/docs/public/images/manual/use-cases/comfyui-view-network.png differ diff --git a/docs/public/images/manual/use-cases/install-comfyui.png b/docs/public/images/manual/use-cases/install-comfyui.png new file mode 100644 index 00000000..8b857c5d Binary files /dev/null and b/docs/public/images/manual/use-cases/install-comfyui.png differ diff --git a/docs/public/images/zh/manual/use-cases/comfyui-add-python-package.png b/docs/public/images/zh/manual/use-cases/comfyui-add-python-package.png new file mode 100644 index 00000000..b17c8ffb Binary files /dev/null and b/docs/public/images/zh/manual/use-cases/comfyui-add-python-package.png differ diff --git a/docs/public/images/zh/manual/use-cases/comfyui-analyze-dependency.png b/docs/public/images/zh/manual/use-cases/comfyui-analyze-dependency.png new file mode 100644 index 00000000..5264b02b Binary files /dev/null and b/docs/public/images/zh/manual/use-cases/comfyui-analyze-dependency.png differ diff --git a/docs/public/images/zh/manual/use-cases/comfyui-change-network.png b/docs/public/images/zh/manual/use-cases/comfyui-change-network.png new file mode 100644 index 00000000..c8c3e5bd Binary files /dev/null and b/docs/public/images/zh/manual/use-cases/comfyui-change-network.png differ diff --git a/docs/public/images/zh/manual/use-cases/comfyui-custom-model-download.png b/docs/public/images/zh/manual/use-cases/comfyui-custom-model-download.png new file mode 100644 index 00000000..5b88d912 Binary files /dev/null and b/docs/public/images/zh/manual/use-cases/comfyui-custom-model-download.png differ diff --git a/docs/public/images/zh/manual/use-cases/comfyui-download-model .png b/docs/public/images/zh/manual/use-cases/comfyui-download-model .png new file mode 100644 index 00000000..dab7945a Binary files /dev/null and b/docs/public/images/zh/manual/use-cases/comfyui-download-model .png differ diff --git a/docs/public/images/zh/manual/use-cases/comfyui-download-model.png b/docs/public/images/zh/manual/use-cases/comfyui-download-model.png new file mode 100644 index 00000000..b10ffc0a Binary files /dev/null and b/docs/public/images/zh/manual/use-cases/comfyui-download-model.png differ diff --git a/docs/public/images/zh/manual/use-cases/comfyui-install-model.png b/docs/public/images/zh/manual/use-cases/comfyui-install-model.png new file mode 100644 index 00000000..3331965e Binary files /dev/null and b/docs/public/images/zh/manual/use-cases/comfyui-install-model.png differ diff --git a/docs/public/images/zh/manual/use-cases/comfyui-log.png b/docs/public/images/zh/manual/use-cases/comfyui-log.png new file mode 100644 index 00000000..31c2633d Binary files /dev/null and b/docs/public/images/zh/manual/use-cases/comfyui-log.png differ diff --git a/docs/public/images/zh/manual/use-cases/comfyui-maintain.png b/docs/public/images/zh/manual/use-cases/comfyui-maintain.png new file mode 100644 index 00000000..b20a07d9 Binary files /dev/null and b/docs/public/images/zh/manual/use-cases/comfyui-maintain.png differ diff --git a/docs/public/images/zh/manual/use-cases/comfyui-manage-plugin.png b/docs/public/images/zh/manual/use-cases/comfyui-manage-plugin.png new file mode 100644 index 00000000..6eaa41fc Binary files /dev/null and b/docs/public/images/zh/manual/use-cases/comfyui-manage-plugin.png differ diff --git a/docs/public/images/zh/manual/use-cases/comfyui-manage-python.png b/docs/public/images/zh/manual/use-cases/comfyui-manage-python.png new file mode 100644 index 00000000..caaf79b4 Binary files /dev/null and b/docs/public/images/zh/manual/use-cases/comfyui-manage-python.png differ diff --git a/docs/public/images/zh/manual/use-cases/comfyui-missing-model.png b/docs/public/images/zh/manual/use-cases/comfyui-missing-model.png new file mode 100644 index 00000000..47b2c619 Binary files /dev/null and b/docs/public/images/zh/manual/use-cases/comfyui-missing-model.png differ diff --git a/docs/public/images/zh/manual/use-cases/comfyui-model-library-download.png b/docs/public/images/zh/manual/use-cases/comfyui-model-library-download.png new file mode 100644 index 00000000..2b610ba9 Binary files /dev/null and b/docs/public/images/zh/manual/use-cases/comfyui-model-library-download.png differ diff --git a/docs/public/images/zh/manual/use-cases/comfyui-reset.png b/docs/public/images/zh/manual/use-cases/comfyui-reset.png new file mode 100644 index 00000000..5ff5c94c Binary files /dev/null and b/docs/public/images/zh/manual/use-cases/comfyui-reset.png differ diff --git a/docs/public/images/zh/manual/use-cases/comfyui-start.png b/docs/public/images/zh/manual/use-cases/comfyui-start.png new file mode 100644 index 00000000..f0d2fb51 Binary files /dev/null and b/docs/public/images/zh/manual/use-cases/comfyui-start.png differ diff --git a/docs/public/images/zh/manual/use-cases/comfyui-view-network.png b/docs/public/images/zh/manual/use-cases/comfyui-view-network.png new file mode 100644 index 00000000..58f75349 Binary files /dev/null and b/docs/public/images/zh/manual/use-cases/comfyui-view-network.png differ diff --git a/docs/zh/manual/tutorials/comfyui-for-krita.md b/docs/zh/manual/tutorials/comfyui-for-krita.md index be97ffa6..2d281d93 100644 --- a/docs/zh/manual/tutorials/comfyui-for-krita.md +++ b/docs/zh/manual/tutorials/comfyui-for-krita.md @@ -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 处于同一网段，并且未启用外部网络代理服务。 diff --git a/docs/zh/manual/use-cases/comfyui-launcher.md b/docs/zh/manual/use-cases/comfyui-launcher.md new file mode 100644 index 00000000..b9a24100 --- /dev/null +++ b/docs/zh/manual/use-cases/comfyui-launcher.md @@ -0,0 +1,189 @@ +--- +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 启动器提供灵活、丰富的模型安装方式。你可以一键安装运行所需基础模型，也可根据需求从 Hugging Face 手动安装或从外部复制。 + +### 一键安装基础模型 + +基础模型即 ComfyUI 运行必要的基础模型，包括 SD 大模型、VAE、预览解码器和辅助工具模型。首次运行时建议先安装基础模型包。 + +1. 通过以下任一方式进入基础模型包安装页面。 + - 在首次启动服务时弹出的**缺少基础模型**提示窗口里，点击**安装模型**。 + - 在启动器首页的**资源包安装**区域，找到**基础模型包**，并点击**查看**。 + +2. 在基础模型安装页面，点击**获取所有资源**开始自动安装。可以通过下方进度条查看安装进度。 + ![安装基础资源包](/images/zh/manual/use-cases/comfyui-install-model.png#bordered) + +### 手动下载模型 +除了基础模型之外，启动器也支持从 HuggingFace 模型库下载，让你轻松获取所需模型： + + + + + + +:::tip 上传外部模型 +如在内置模型库无法找到所需模型，你也可以将外部下载的文件通过文件管理器上传至以下模型目录： + + `外部设备/ai/model`。 +::: + +### 删除模型 +要删除指定模型： + +1. 从启动器左侧导航栏进入**模型管理** > **模型库**。 +2. 在**已安装模型**列表下，找到待删除模型，并点击右侧 delete 按钮以删除。 + +## 管理插件 + +您可以通过 ComfyUI 内置的 ComfyUI-Manager 管理插件，也可以使用启动器的**插件管理**功能。 + +![管理插件](/images/zh/manual/use-cases/comfyui-manage-plugin.png#bordered) + +### 管理可用插件 + +要管理在 ComfyUI Manager 中已注册的可用插件： + +1. 进入**插件管理** > **插件库**。 +2. 在**可用插件**下，选择目标插件： + - 点击 pause 按钮禁用当前运行的插件，点击 play_circle 按钮恢复运行。 + - 点击 delete 按钮删除插件。 + - 点击 download 按钮下载插件。 + - 点击 visibility 按钮查看插件详情。 + - 点击**更新全部插件**按钮更新所有已安装插件。 + - 点击**刷新**按钮刷新插件安装状态。 + +### 从 GitHub 下载插件 + +要从 GitHub 仓库下载插件： + +1. 进入**插件管理** > **自定义安装**。 +2. 输入插件仓库的 URL。 +3. 选择目标分支，默认为 master 或 main 分支。 +4. 点击**安装插件**。 + +## 管理 Python 环境 + +ComfyUI 的运行依赖复杂的 Python 环境。你可以在 **Python 依赖管理**页中管理 ComfyUI 容器中的 Python 依赖库。 + +![管理 Python 环境](/images/zh/manual/use-cases/comfyui-manage-python.png#bordered) + +### 安装新依赖库 + +要安装新依赖库： + +1. 进入 **Python 依赖管理**。 +2. 点击**安装新库**按钮。 +3. 输入库的名称和版本号（可选），点击**安装**。 + +### 管理已安装依赖库 +1. 在 **Python 依赖库** > **已安装 Python 库**下，找到需要操作的 Python 库。 +2. 点击右侧 arrow_upward 按钮以升级库， delete 按钮以删除库。 + +### 分析依赖库安装 +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) + +例如, GitHub 无法正常访问： + +1. 进入**网络配置**页面。 +2. 切换提供的 GitHub 可访问地址。 +3. 点击**检测**按钮以刷新连接状态。 + +重复第 2、3 步直到网站连接变为"可访问"。 + +![切换网络](/images/zh/manual/use-cases/comfyui-change-network.png#bordered) + +### 查看运行日志 + +你可以导出日志来诊断 ComfyUI 当前的运行状态： + +![查看日志](/images/zh/manual/use-cases/comfyui-log.png#bordered) + + +1. 在启动器首页右上角点击more_vert，再点击**查看日志**以查看当前运行日志。 +2. 点击日志下方refresh以刷新日志，download以下载日志。 + +### 还原 ComfyUI 配置 + +如果你希望将 ComfyUI 还原到初始状态： + +![重置 ComfyUI](/images/zh/manual/use-cases/comfyui-reset.png#bordered) + +1. 在启动器首页右上角点击more_vert，选择**抹掉并还原**。二次确认后，将启动器将开始抹掉和还原程序。 + + +2. 还原操作完成后，重启 ComfyUI 以生效。 + +:::warning 谨慎操作 +还原 ComfyUI 是不可逆的操作，请谨慎选择。 +::: + +## 灵感发现 + +你可以从左侧导航栏进入**灵感发现**页面，查看 [civit.ai](civit.ai) 上最新、最热门的 ComfyUI 模型和工作流。 + +::: tip 注意 +请确认你的网络可以正常访问 [civit.ai](civit.ai)。 +::: + + + diff --git a/docs/zh/manual/use-cases/comfyui.md b/docs/zh/manual/use-cases/comfyui.md index b2f0bc34..cf8fcc19 100644 --- a/docs/zh/manual/use-cases/comfyui.md +++ b/docs/zh/manual/use-cases/comfyui.md @@ -9,7 +9,7 @@ ComfyUI 是一款基于节点的 Stable Diffusion 图形界面工具。它把 AI ## ComfyUI 能做什么？ 通过 ComfyUI，你可以实现以下功能： - + * 用可视化方式搭建和复用工作流 * 对绘图流程进行精细调优 * 自由组合不同模型和技术 @@ -17,17 +17,32 @@ ComfyUI 是一款基于节点的 Stable Diffusion 图形界面工具。它把 AI * 使用相同配置批量处理图片 * 添加高级图像后期效果 -## 安装 ComfyUI +## 安装 ComfyUI 共享版 +Olares 应用商店提供 ComfyUI 共享版，可允许同一 Olares 集群上的多个用户共享 ComfyUI 的模型、插件和工作流资源。它还提供了一个启动器（ComfyUI Launcher），帮助管理员用户管理 ComfyUI 资源和运行环境。 + +::: tip 注意 +自 1.11.6 版本起，Olares 会使用 ComfyUI 共享版取代之前的集群范围应用。如果安装过 ComfyUI For Cluster 和对应的 ComfyUI 客户端，请卸载后再安装共享版。 +::: + +要安装 ComfyUI 共享版： + +1. 打开 Olares 应用市场，找到 ComfyUI 共享版，并点击**获取**。 -根据你的角色安装相应应用： -* **管理员**：需要同时安装“ComfyUI For Cluster”和“ComfyUI”。 -* **团队成员**：仅需安装“ComfyUI”，同时确保管理员已安装“ComfyUI For Cluster”。 + - 管理员将会在 Olares 桌面看到两个图标：一个是 ComfyUI 客户端界面，另一个是 ComfyUI 启动器。 -![安装 ComfyUI](/images/manual/tutorials/install-comfyui.png){width=40%} + ![安装 ComfyUI 共享版](/images/manual/use-cases/install-comfyui.png){width=40%} -安装完成后，从桌面启动 ComfyUI。 + - 成员用户只会在桌面看到 ComfyUI 客户端界面。 -![ComfyUI](/images/manual/use-cases/comfyui.png#bordered) + :::tip 启动 ComfyUI 服务 + 管理员必须从启动器启动 ComfyUI 服务之后，集群中的所有用户才能从客户端入口访问服务。 + ::: + +2. 点击 ComfyUI 图标打开界面。管理员也可以从启动器进入 ComfyUI 界面。 + + ![ComfyUI](/images/manual/use-cases/comfyui.png#bordered) ## 了解更多 + +- [使用 ComfyUI 启动器管理 ComfyUI](comfyui-launcher.md) - [Krita + ComfyUI 实时绘画](../tutorials/comfyui-for-krita.md)：了解如何利用 ComfyUI 助力 Krita 中的创意工作流。 \ No newline at end of file