diff --git a/README.md b/README.md index 99638c0..58b0eed 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,46 @@ # docker-comfyui -Build and run ComfyUI in a container. This build targets NVIDIA by basing it -on the CUDA PyTorch runtime image. The only extra dependencies needed are -`git`, to clone the official ComfyUI repository, and `build-essential` for -`gcc`, which Triton requires. The image pulls a specific, pinned ComfyUI -version via the `COMFYUI_VERSION` build arg. The build merely shallow-clones -the repo and installs its requirements with `pip`. Kept intentionally simple. +Build and run ComfyUI in a container. This build targets NVIDIA by basing it on +the CUDA PyTorch runtime image. The only extra dependencies needed are `git`, to +clone the official ComfyUI repository, and `build-essential` for `gcc`, which +Triton requires. The image pulls a specific, pinned ComfyUI version via the +`COMFYUI_VERSION` build arg. The build merely shallow-clones the repo and +installs its requirements with `pip`. Kept intentionally simple. + +### `.env` configuration + +- `IMAGE` + - Image name + - Default: `localhost/comfyui` +- `VERSION` + - Image tag + - Default: `latest` +- `NAME` + - Container name + - Default: `comfyui` +- `RESTART` + - Restart policy + - Default: `unless-stopped` +- `ENDPOINT` + - Host bind + - Default: `127.0.0.1:8188` +- `DATA` + - Host directory holding all persistent data + - Default: `./data` +- `GPU` + - CDI device + - Default: `nvidia.com/gpu=all` ### Quick start 1. Build - ``` - docker compose build - ``` + ``` + docker compose build + ``` 2. Run - ``` - docker compose up -d - ``` + ``` + docker compose up -d + ``` diff --git a/docker-compose.yml b/docker-compose.yml index 7349113..1d269ea 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -2,9 +2,9 @@ services: comfyui: build: context: . - image: localhost/comfyui:latest - restart: unless-stopped - container_name: comfyui + image: ${IMAGE:-localhost/comfyui}:${VERSION:-latest} + container_name: ${NAME:-comfyui} + restart: ${RESTART:-unless-stopped} ports: - "${ENDPOINT:-127.0.0.1:8188}:8188" volumes: @@ -15,4 +15,4 @@ services: - ${DATA:-./data}/custom_nodes:/app/custom_nodes - ${DATA:-./data}/triton-cache:/root/.triton devices: - - nvidia.com/gpu=all + - ${GPU:-nvidia.com/gpu=all}