runpod-worker-comfy

ComfyUI 作为 RunPod 上的无服务器API

![RunPod]([***]

![]([]

---

• 快速开始
• 核心功能
• 配置
  • 上传图像至AWS S3
• 在RunPod上使用Docker镜像
  • 创建模板（可选）
  • 创建端点
  • GPU推荐
• API规范
  • JSON请求体
  • 字段说明
    • "input.images"
• 与RunPod API交互
  • 健康状态检查
  • 生成图像
    • SDXL的cURL请求示例
• 如何从ComfyUI获取工作流？
• 自定义模型和节点
  • 网络卷
  • 自定义Docker镜像
    • 添加自定义模型
    • 添加自定义节点
    • 构建镜像
• 本地测试
  • 环境设置
    • Windows环境设置
  • 测试RunPod处理器
  • 本地API
    • 访问本地Worker API
    • 访问本地ComfyUI
• 通过GitHub Actions自动部署到Docker Hub
• 致谢

---

快速开始

• 🐳 为无服务器端点选择以下五种可用镜像之一：
  • timpietruskyblibla/runpod-worker-comfy:3.6.0-base: 基础镜像，仅包含干净的ComfyUI
  • timpietruskyblibla/runpod-worker-comfy:3.6.0-flux1-schnell: 包含FLUX.1 schnell的检查点、文本编码器和VAE
  • timpietruskyblibla/runpod-worker-comfy:3.6.0-flux1-dev: 包含FLUX.1 dev的检查点、文本编码器和VAE
  • timpietruskyblibla/runpod-worker-comfy:3.6.0-sdxl: 包含Stable Diffusion XL的检查点和VAE
  • timpietruskyblibla/runpod-worker-comfy:3.6.0-sd3: 包含Stable Diffusion 3 medium的检查点
• ℹ️ 在RunPod上使用Docker镜像
• 🧪 选择示例工作流并发送到已部署的端点

核心功能

• 运行任何ComfyUI工作流生成图像
• 支持以base64编码字符串提供输入图像
• 生成的图像支持两种输出方式：
  • 默认：返回base64编码字符串
  • 配置后：上传至AWS S3（需配置AWS S3）
• 提供多种预配置Docker镜像：
  • timpietruskyblibla/runpod-worker-comfy:3.6.0-flux1-schnell: 包含FLUX.1-schnell的检查点、文本编码器（clip_l.safetensors和t5xxl_fp8_e4m3fn.safetensors）和VAE（ae.safetensors）
  • timpietruskyblibla/runpod-worker-comfy:3.6.0-flux1-dev: 包含FLUX.1-dev的检查点、文本编码器和VAE
  • timpietruskyblibla/runpod-worker-comfy:3.6.0-sdxl: 包含Stable Diffusion XL的检查点和VAE（sdxl_vae.safetensors和sdxl-vae-fp16-fix）
  • timpietruskyblibla/runpod-worker-comfy:3.6.0-sd3: 包含Stable Diffusion 3 medium的检查点（sd3_medium_incl_clips_t5xxlfp8.safetensors）
• 支持自定义模型
• 基于Ubuntu + NVIDIA CUDA构建

配置

上传图像至AWS S3

仅当需要将生成的图像上传至AWS S3时配置。未配置时图像将以base64编码字符串返回。

• 在AWS S3创建存储桶（BUCKET_ENDPOINT_URL）
• 创建具有S3访问权限的IAM用户
• 为该IAM用户创建访问密钥（BUCKET_ACCESS_KEY_ID和BUCKET_SECRET_ACCESS_KEY）
• 为RunPod worker配置以下环境变量：

在RunPod上使用Docker镜像

创建模板（可选）

• 通过点击新建模板创建新模板
• 在对话框中配置：
  • 模板名称：runpod-worker-comfy（可自定义）
  • 模板类型：无服务器（将模板类型改为"serverless"）
  • 容器镜像：<dockerhub_username>/<repository_name>:tag，例如timpietruskyblibla/runpod-worker-comfy:3.6.0-sd3（或-base为干净镜像，-sdxl为Stable Diffusion XL，-flux1-schnell为FLUX.1 schnell）
  • 容器仓库凭证：保持默认（公共仓库无需配置）
  • 容器磁盘：20 GB
  • （可选）环境变量：配置S3
• 点击保存模板

创建端点

• 导航至无服务器 > 端点并点击新建端点

• 在对话框中配置：

  • 端点名称：comfy
  • Worker配置：选择能运行所选模型的GPU（详见GPU推荐）
  • 活跃Worker数：0（根据需求调整）
  • 最大Worker数：3（根据需求调整）
  • 每Worker GPU数：1
  • 空闲超时：5（默认值）
  • 快速启动：启用（不增加成本，加快worker启动速度）
  • 选择模板：runpod-worker-comfy（或自定义模板名称）
  • （可选）高级选项：如需使用网络卷，在高级 > 选择网络卷中选择

• 点击部署

• 端点创建后，点击进入查看仪表板

GPU推荐

API规范

以下描述API请求中所需的字段。仅说明input中的字段，这些是worker必需的。完整字段列表详见官方文档。

JSON请求体

{
  "input": {
    "workflow": {},
    "images": [
      {
        "name": "example_image_name.png",
        "image": "base64_encoded_string"
      }
    ]
  }
}

字段说明

"input.images"

图像数组，每张图像需有唯一名称。

🚨 RunPod端点的请求体大小限制：/run为10 MB，/runsync为20 MB，因此输入图像不宜过大（详见官方文档）

与RunPod API交互

1. 生成API密钥：

   • 在用户设置中，点击API密钥，然后点击生成API密钥按钮。
   • 将生成的密钥保存到安全位置，离开页面后无法再次查看。

2. 使用API密钥：

   • 使用cURL或其他工具通过API密钥和端点ID访问API：
     • 将<api_key>替换为你的密钥。

3. 使用端点：

   • 将<endpoint_id>替换为端点ID（点击端点后，ID显示在顶部名称下方，也包含在底部URL中）。

!如何查找EndpointID

健康状态检查

curl -H "Authorization: Bearer <api_key>" [***]<endpoint_id>/health

生成图像

可使用/run（异步）或/runsync（同步）创建任务。以下示例使用同步任务，等待响应返回。

API期望的JSON格式中，workflow为从ComfyUI导出的JSON工作流，images为可选。

详见test_input.json了解API输入格式。

SDXL的cURL请求示例

curl -X POST -H "Authorization: Bearer <api_key>" -H "Content-Type: application/json" -d '{"input":{"workflow":{"3":{"inputs":{"seed":1337,"steps":20,"cfg":8,"sampler_name":"euler","scheduler":"normal","denoise":1,"model":["4",0],"positive":["6",0],"negative":["7",0],"latent_image":["5",0]},"class_type":"KSampler"},"4":{"inputs":{"ckpt_name":"sd_xl_base_1.0.safetensors"},"class_type":"CheckpointLoaderSimple"},"5":{"inputs":{"width":512,"height":512,"batch_size":1},"class_type":"EmptyLatentImage"},"6":{"inputs":{"text":"beautiful scenery nature glass bottle landscape, purple galaxy bottle,","clip":["4",1]},"class_type":"CLIPTextEncode"},"7":{"inputs":{"text":"text, watermark","clip":["4",1]},"class_type":"CLIPTextEncode"},"8":{"inputs":{"samples":["3",0],"vae":["4",2]},"class_type":"VAEDecode"},"9":{"inputs":{"filename_prefix":"ComfyUI","images":["8",0]},"class_type":"SaveImage"}}}}' [***]<endpoint_id>/runsync

AWS S3配置下的响应示例

{
  "delayTime": 2188,
  "executionTime": 2297,
  "id": "sync-c0cd1eb2-068f-4ecf-a99a-55770fc77391-e1",
  "output": {
    "message": "[***]",
    "status": "success"
  },
  "status": "COMPLETED"
}

base64编码图像的响应示例

{
  "delayTime": 2188,
  "executionTime": 2297,
  "id": "sync-c0cd1eb2-068f-4ecf-a99a-55770fc77391-e1",
  "output": { "message": "base64encodedimage", "status": "success" },
  "status": "COMPLETED"
}

如何从ComfyUI获取工作流？

• 在浏览器中打开ComfyUI
• 打开设置（菜单右上角的齿轮图标）
• 在弹出的对话框中配置：
  • 启用Enable Dev mode Options
  • 关闭设置
• 在菜单中点击Save (API Format)按钮，下载名为workflow_api.json的文件

将该文件内容放入API请求的workflow字段中即可。

自定义模型和节点

网络卷

使用网络卷可存储和访问自定义模型：

1. 创建网络卷：

   • 按照RunPod网络卷指南创建卷。

2. 填充卷内容：

   • 创建临时GPU实例：
     • 导航至管理 > 存储，点击卷下的部署，部署任意GPU或CPU实例。
     • 导航至管理 > Pods，在新Pod下点击连接打开终端（Jupyter notebook或SSH）。
   • 填充模型：