mirror of https://github.com/comfyanonymous/ComfyUI.git synced 2026-04-15 21:12:30 +08:00

docs(readme): document baked-in SageAttention 2.2 and default enable via --use-sage-attention

Update README to reflect that SageAttention 2.2/2++ is compiled into the
image at build time and enabled automatically on launch using
--use-sage-attention. Clarifies NVIDIA GPU setup expectations and that no
extra steps are required to activate SageAttention in container runs.

Changes:
- Features: add “SageAttention 2.2 baked in” and “Auto-enabled at launch”.
- Getting Started: note that SageAttention is compiled during docker build
  and requires no manual install.
- Docker Compose: confirm the image launches with SageAttention enabled by default.
- Usage: add a SageAttention subsection with startup log verification notes.
- General cleanup and wording to align with current image behavior.

No functional code changes; documentation only.

2025-09-21 21:12:04 -06:00

4.4 KiB

Raw Blame History

ComfyUI-Docker

An automated Repo for ComfyUI Docker image builds, optimized for NVIDIA GPUs.

About • Features • Getting Started • Usage • License

About

This repository automates the creation of Docker images for ComfyUI, a powerful and modular stable diffusion GUI and backend. It syncs with the upstream ComfyUI repository, builds a Docker image on new releases, and pushes it to GitHub Container Registry (GHCR).

I created this repo for myself as a simple way to stay up to date with the latest ComfyUI versions while having an easy-to-use Docker image. It's particularly suited for setups with NVIDIA GPUs, leveraging CUDA for accelerated performance.

Built With

Docker
GitHub Actions for automation
PyTorch with CUDA support
Based on Python 3.12 slim image

Features

Automated Sync & Build: Daily checks for upstream releases, auto-merges changes, and builds/pushes Docker images.
NVIDIA GPU Ready: Pre-configured with CUDA-enabled PyTorch for seamless GPU acceleration.
Non-Root Runtime: Runs as a non-root user for better security.
Pre-Installed Manager: Includes ComfyUI-Manager for easy node/extensions management.
SageAttention 2.2 baked in: The image compiles SageAttention 2.2/2++ from the upstream repository during docker build, ensuring the latest kernels for modern NVIDIA GPUs are included by default.
Auto-enabled at launch: ComfyUI is started with the --use-sage-attention flag so SageAttention is activated automatically on startup (no extra steps required).

Getting Started

Prerequisites

Docker: Installed on your host (e.g., Docker Desktop or Engine).
NVIDIA GPU: For GPU support (ensure NVIDIA drivers and CUDA are installed on the host).
NVIDIA Container Toolkit: For GPU passthrough in Docker (install via the official guide).

Pulling the Image

The latest image is available on GHCR:

docker pull ghcr.io/clsferguson/comfyui-docker:latest

For a specific version (synced with upstream tags, starting at 0.3.57):

docker pull ghcr.io/clsferguson/comfyui-docker:vX.Y.Z

Docker Compose

For easier management, use this docker-compose.yml:

services:
  comfyui:
    image: ghcr.io/clsferguson/comfyui-docker:latest
    container_name: ComfyUI
    runtime: nvidia
    restart: unless-stopped
    ports:
      - 8188:8188
    environment:
      - TZ=America/Edmonton
      - PUID=1000
      - GUID=1000
    gpus: all
    volumes:
      - comfyui_data:/app/ComfyUI/user/default
      - comfyui_nodes:/app/ComfyUI/custom_nodes
      - /mnt/comfyui/models:/app/ComfyUI/models
      - /mnt/comfyui/input:/app/ComfyUI/input
      - /mnt/comfyui/output:/app/ComfyUI/output

Run with docker compose up -d.

Usage

Basic Usage

Access ComfyUI at http://localhost:8188 after starting the container using Docker Compose.

SageAttention

SageAttention 2.2 is built into the image and enabled automatically on startup via --use-sage-attention.
To verify, check the container logs on startup; ComfyUI will print a line indicating SageAttention is active.

Environment Variables

Set via .env file or -e flags in docker compose or docker run.

License

Distributed under the MIT License (same as upstream ComfyUI). See LICENSE for more information.

Contact

Creator: clsferguson - GitHub
Project Link: https://github.com/clsferguson/ComfyUI-Docker

Built with ❤️ for easy AI workflows.

4.4 KiB Raw Blame History