From e7ebda4b6172244301933e253150b0e191840dd9 Mon Sep 17 00:00:00 2001 From: "B. Bergeron" Date: Wed, 13 Aug 2025 10:36:35 -0400 Subject: [PATCH] Add instructions for Docker installation --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 6d09758c0..4bee8c258 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,12 @@ ComfyUI lets you design and execute advanced stable diffusion pipelines using a - Get the latest commits and completely portable. - Available on Windows. +#### [Docker Install](#running-with-docker) +- Run ComfyUI inside an isolated Docker container +- Most secure way to run ComfyUI and custom node packs +- Requires Docker and Docker Compose +- Supports NVIDIA GPUs (Not tested on other hardware.) + #### [Manual Install](#manual-install-windows-linux) Supports all operating systems and GPU types (NVIDIA, AMD, Intel, Apple Silicon, Ascend). @@ -350,6 +356,24 @@ For models compatible with Iluvatar Extension for PyTorch. Here's a step-by-step | `--enable-manager-legacy-ui` | Use the legacy manager UI instead of the new UI (requires `--enable-manager`) | | `--disable-manager-ui` | Disable the manager UI and endpoints while keeping background features like security checks and scheduled installation completion (requires `--enable-manager`) | +## Running with Docker + +Start by installing Docker and Docker Compose on your host. Next, edit +`docker-compose.yaml` and update the `UID` and `GID` variables to match your +user. Additional fields are documented in the file for further customization. + +Once ready, build and run the image locally: + +``` +docker compose build +docker compose up +``` + +To stop and remove the container along with its volumes, run: + +``` +docker compose down -v +``` # Running