refactor: Simplify Docker configuration by using .env file and streamline user/group settings

This commit refactors the `docker-compose.yml` and `Dockerfile` to simplify the management of environment variables and user/group configurations. The following changes were made:

1. **Environment Variables via `.env` File:**
   - Added `env_file: .env` in the base service configuration within `docker-compose.yml`. This allows for centralized management of environment variables, making it easier to configure different environments without modifying Docker files directly.

2. **User/Group Configuration Simplification:**
   - Removed hardcoded user and group settings (`USE_UID`, `USE_GID`, `USE_USER`, `USE_GROUP`) from the `docker-compose.yml` file.
   - Updated the `Dockerfile` to use default values of `0` for `USE_UID` and `USE_GID`, and `root` for `USE_USER` and `USE_GROUP`. This aligns with common practices where root is often used in containerized environments unless specified otherwise.

3. **Conditional Dependency Handling:**
   - Introduced conditional logic to enable dependencies like Krita based on the value of `USE_KRITA`.
   - Simplified the environment variable assignments within the Dockerfile, ensuring that only necessary variables are set.

4. **Entrypoint Script Enhancements:**
   - Added a feature in the `entrypoint.sh` script to update custom nodes by pulling the latest changes from their respective repositories if `UPDATE_CUSTOM_NODES` is set to `true`.

These changes improve the maintainability and flexibility of the Docker setup, making it easier to adapt to different deployment scenarios.

docker-compose.yml

@@ -6,6 +6,7 @@ x-base_service: &base_service
       - &v2 ./output:/output
     stop_signal: SIGKILL
     tty: true
+    env_file: .env
     deploy:
       resources:
         reservations:
@@ -30,6 +31,7 @@ services:
     image: sd-auto:78
     environment:
       - CLI_ARGS=--allow-code --medvram --xformers --enable-insecure-extension-access --api
+    env_file: .env
 
   auto-cpu:
     <<: *automatic
@@ -37,6 +39,7 @@ services:
     deploy: {}
     environment:
       - CLI_ARGS=--no-half --precision full --allow-code --enable-insecure-extension-access --api
+    env_file: .env
 
   comfy: &comfy
     <<: *base_service
@@ -45,6 +48,7 @@ services:
     image: sd-comfy:7
     environment:
       - CLI_ARGS=
+    env_file: .env
 
 
   comfy-cpu:
@@ -53,3 +57,4 @@ services:
     deploy: {}
     environment:
       - CLI_ARGS=--cpu
+    env_file: .env

services/comfy/Dockerfile

@@ -1,19 +1,115 @@
-FROM pytorch/pytorch:2.3.0-cuda12.1-cudnn8-runtime
+FROM pytorch/pytorch:2.5.1-cuda12.4-cudnn9-runtime
 
-ENV DEBIAN_FRONTEND=noninteractive PIP_PREFER_BINARY=1
+# Limited system user UID
+ARG USE_UID=0
+# Limited system user GID
+ARG USE_GID=0
+# System user name
+ARG USE_USER=root
+# System group name
+ARG USE_GROUP=root
+# Latest tag or bleeding edge commit
+ARG USE_EDGE=false
+# ComfyUI-GGUF
+ARG USE_GGUF=false
+# x-flux-comfyui
+ARG USE_XFLUX=false
+# comfyui_controlnet_aux
+ARG USE_CNAUX=false
+# krita-ai-diffusion
+ARG USE_KRITA=false
+# ComfyUI_IPAdapter_plus
+ARG USE_IPAPLUS=false
+# comfyui-inpaint-nodes
+ARG USE_INPAINT=false
+# comfyui-tooling-nodes
+ARG USE_TOOLING=false
 
-RUN apt-get update && apt-get install -y git && apt-get clean
+# Support both root and non-root
+ARG SET_USER=$USE_USER SET_GROUP=$USE_GROUP
+RUN if [ ${USE_UID} -eq 0 ]; then SET_USER=root; fi; \
+  if [ ${USE_GID} -eq 0 ]; then SET_GROUP=root; fi
 
-ENV ROOT=/stable-diffusion
+# Enable required dependencies for Krita
-RUN --mount=type=cache,target=/root/.cache/pip \
+ARG SET_CNAUX=$USE_CNAUX SET_IPAPLUS=$USE_IPAPLUS
+ARG SET_INPAINT=$USE_INPAINT SET_TOOLING=$USE_TOOLING
+RUN if [ ${USE_KRITA} = "true" ]; then SET_CNAUX="true"; SET_IPAPLUS="true"; \
+    SET_INPAINT="true"; SET_TOOLING="true"; fi
+
+ENV USE_USER=$SET_USER USE_GROUP=$SET_GROUP USE_CNAUX=$SET_CNAUX
+ENV USE_IPAPLUS=$SET_IPAPLUS USE_INPAINT=$SET_INPAINT USE_TOOLING=$SET_TOOLING
+ENV DEBIAN_FRONTEND=noninteractive PIP_PREFER_BINARY=1 USE_EDGE=$USE_EDGE
+ENV USE_GGUF=$USE_GGUF USE_XFLUX=$USE_XFLUX ROOT=/stable-diffusion
+ENV CACHE=/home/$USE_USER/.cache USE_KRITA=$USE_KRITA
+
+# User/Group
+RUN if [ ${USE_GID} -ne 0 ]; then \
+    groupadd -r ${USE_GROUP} -g ${USE_GID}; \
+  fi; \
+  if [ ${USE_GID} -ne 0 ]; then \
+    useradd --no-log-init -m -r -g ${USE_GROUP} ${USE_USER} -u ${USE_UID}; \
+  fi; \
+  mkdir -p ${ROOT} && chown ${USE_UID}:${USE_GID} ${ROOT} && mkdir -p ${CACHE}/pip && chown -R ${USE_UID}:${USE_GID} ${CACHE}
+RUN --mount=type=cache,uid=${USE_UID},gid=${USE_GID},target=${CACHE} chown -R ${USE_UID}:${USE_UID} ${CACHE}
+
+RUN apt-get update && apt-get install -y git
+RUN if [ "${USE_XFLUX}" = "true" ] || [ "${USE_KRITA}" = "true" ] || [ "${USE_CNAUX}" = "true" ]; then \
+    apt-get install -y libgl1-mesa-glx python3-opencv; \
+  fi
+RUN apt-get clean
+
+USER ${USE_USER}:${USE_GROUP}
+ENV PATH="${PATH}:/home/${USE_USER}/.local/bin"
+
+RUN --mount=type=cache,uid=${USE_UID},gid=${USE_GID},target=${CACHE} pip --cache-dir=${CACHE}/pip install -U pip
+
+RUN --mount=type=cache,uid=${USE_UID},gid=${USE_GID},target=${CACHE} \
   git clone https://github.com/comfyanonymous/ComfyUI.git ${ROOT} && \
   cd ${ROOT} && \
   git checkout master && \
-  git reset --hard 276f8fce9f5a80b500947fb5745a4dde9e84622d && \
+  bash -c 'VERSION=$(git describe --tags --abbrev=0) && \
-  pip install -r requirements.txt
+  if [ "${USE_EDGE}" = "true" ]; then VERSION=$(git describe --abbrev=7); fi && \
+  git reset --hard ${VERSION}' && \
+  pip --cache-dir=${CACHE}/pip install -r requirements.txt && \
+  if [ "${USE_KRITA}" = "true" ]; then \
+    pip --cache-dir=${CACHE}/pip install aiohttp tqdm && \
+    git clone https://github.com/Acly/krita-ai-diffusion.git && \
+    cd krita-ai-diffusion && git checkout main && \
+    git submodule update --init && cd ..; \
+  fi; \
+  if [ "${USE_GGUF}" = "true" ]; then \
+    git clone https://github.com/city96/ComfyUI-GGUF.git && \
+    cd ComfyUI-GGUF && git checkout main && \
+    pip --cache-dir=${CACHE}/pip install -r requirements.txt && cd ..; \
+  fi; \
+  if [ "${USE_XFLUX}" = "true" ]; then \
+    git clone https://github.com/XLabs-AI/x-flux-comfyui.git && \
+    cd x-flux-comfyui && git checkout main && \
+    pip --cache-dir=${CACHE}/pip install -r requirements.txt && cd ..; \
+  fi; \
+  if [ "${USE_CNAUX}" = "true" ]; then \
+    git clone https://github.com/Fannovel16/comfyui_controlnet_aux.git && \
+    cd comfyui_controlnet_aux && git checkout main && \
+    pip --cache-dir=${CACHE}/pip install -r requirements.txt && \
+    # This extra step to separate onnxruntime installation is required to restore onnx cuda support \
+    pip --cache-dir=${CACHE}/pip install onnxruntime && pip --cache-dir=${CACHE}/pip install onnxruntime-gpu && cd ..; \
+  fi; \
+  if [ "${USE_IPAPLUS}" = "true" ]; then \
+    git clone https://github.com/cubiq/ComfyUI_IPAdapter_plus.git && \
+    cd ComfyUI_IPAdapter_plus && git checkout main && cd ..; \
+  fi; \
+  if [ "${USE_INPAINT}" = "true" ]; then \
+    git clone https://github.com/Acly/comfyui-inpaint-nodes.git && \
+    cd comfyui-inpaint-nodes && git checkout main && \
+    pip --cache-dir=${CACHE}/pip install opencv-python && cd ..; \
+  fi; \
+  if [ "${USE_TOOLING}" = "true" ]; then \
+    git clone https://github.com/Acly/comfyui-tooling-nodes.git && \
+    cd comfyui-tooling-nodes && git checkout main && cd ..; \
+  fi
 
 WORKDIR ${ROOT}
-COPY . /docker/
+COPY --chown=${USE_UID}:${USE_GID} . /docker/
 RUN chmod u+x /docker/entrypoint.sh && cp /docker/extra_model_paths.yaml ${ROOT}
 
 ENV NVIDIA_VISIBLE_DEVICES=all PYTHONPATH="${PYTHONPATH}:${PWD}" CLI_ARGS=""

services/comfy/entrypoint.sh

@@ -2,11 +2,12 @@
 
 set -Eeuo pipefail
 
-mkdir -vp /data/config/comfy/custom_nodes
+CUSTOM_NODES="/data/config/comfy/custom_nodes"
+mkdir -vp "${CUSTOM_NODES}"
 
 declare -A MOUNTS
 
-MOUNTS["/root/.cache"]="/data/.cache"
+MOUNTS["${CACHE}"]="/data/.cache"
 MOUNTS["${ROOT}/input"]="/data/config/comfy/input"
 MOUNTS["${ROOT}/output"]="/output/comfy"
 
@@ -22,6 +23,53 @@ for to_path in "${!MOUNTS[@]}"; do
   echo Mounted $(basename "${from_path}")
 done
 
+if [ "${UPDATE_CUSTOM_NODES:-false}" = "true" ]; then
+  find /data/config/comfy/custom_nodes/ -mindepth 1 -maxdepth 1 -type d | while read NODE
+    do echo "---- ${NODE##*/} ----"
+    cd $NODE && git pull; cd ..
+  done
+fi
+
+if [ "${USE_KRITA}" = "true" ]; then
+  if [ "${KRITA_DOWNLOAD_MODELS:-false}" = "true" ]; then
+    cd "${ROOT}/krita-ai-diffusion/scripts" && python download_models.py --verbose --retry-attempts 10 --continue-on-error --recommended /data && cd ..
+  fi
+  [ -d "${ROOT}/models/upscale_models" ] && mv -v "${ROOT}/models/upscale_models" "${ROOT}/models/upscale_models.stock"
+  if [ ! -L "${ROOT}/models/upscale_models" ]; then
+    cd "${ROOT}/models"
+    ln -sfT /data/models/upscale_models upscale_models
+  fi
+  export USE_CNAUX="true" USE_IPAPLUS="true" USE_INPAINT="true"; USE_TOOLING="true"
+fi
+if [ "${USE_GGUF}" = "true" ]; then
+  [ ! -e "${CUSTOM_NODES}/ComfyUI-GGUF" ] && mv "${ROOT}/ComfyUI-GGUF" "${CUSTOM_NODES}"/
+fi
+if [ "${USE_XFLUX}" = "true" ]; then
+  [ ! -e "${CUSTOM_NODES}/x-flux-comfyui" ] && mv "${ROOT}/x-flux-comfyui" "${CUSTOM_NODES}"/
+  [ ! -e "/data/models/clip_vision" ] && mkdir -p /data/models/clip_vision
+  [ ! -e "/data/models/clip_vision/model.safetensors" ] && cd /data/models/clip_vision && \
+    python -c 'import sys; from urllib.request import urlopen; from pathlib import Path; Path(sys.argv[2]).write_bytes(urlopen(sys.argv[1]).read())' \
+      "https://huggingface.co/openai/clip-vit-large-patch14/resolve/main/model.safetensors" "model.safetensors"
+  [ ! -e "/data/models/xlabs" ] && mkdir -p /data/models/xlabs/{ipadapters,loras,controlnets}
+  [ ! -e "/data/models/xlabs/ipadapters/flux-ip-adapter.safetensors" ] && cd /data/models/xlabs/ipadapters && \
+    python -c 'import sys; from urllib.request import urlopen; from pathlib import Path; Path(sys.argv[2]).write_bytes(urlopen(sys.argv[1]).read())' \
+      "https://huggingface.co/XLabs-AI/flux-ip-adapter/resolve/main/ip_adapter.safetensors" "flux-ip-adapter.safetensors"
+  [ -d "${ROOT}/models/xlabs" ] && rm -rf "${ROOT}/models/xlabs"
+  [ ! -e "${ROOT}/models/xlabs" ] && cd "${ROOT}/models" && ln -sT /data/models/xlabs xlabs && cd ..
+fi
+if [ "${USE_CNAUX}" = "true" ]; then
+  [ ! -e "${CUSTOM_NODES}/comfyui_controlnet_aux" ] && mv "${ROOT}/comfyui_controlnet_aux" "${CUSTOM_NODES}"/
+fi
+if [ "${USE_IPAPLUS}" = "true" ]; then
+  [ ! -e "${CUSTOM_NODES}/ComfyUI_IPAdapter_plus" ] && mv "${ROOT}/ComfyUI_IPAdapter_plus" "${CUSTOM_NODES}"/
+fi
+if [ "${USE_INPAINT}" = "true" ]; then
+  [ ! -e "${CUSTOM_NODES}/comfyui-inpaint-nodes" ] && mv "${ROOT}/comfyui-inpaint-nodes" "${CUSTOM_NODES}"/
+fi
+if [ "${USE_TOOLING}" = "true" ]; then
+  [ ! -e "${CUSTOM_NODES}/comfyui-tooling-nodes" ] && mv "${ROOT}/comfyui-tooling-nodes" "${CUSTOM_NODES}"/
+fi
+
 if [ -f "/data/config/comfy/startup.sh" ]; then
   pushd ${ROOT}
   . /data/config/comfy/startup.sh

services/comfy/extra_model_paths.yaml

@@ -15,11 +15,15 @@ a111:
   gligen: models/GLIGEN
   clip: models/CLIPEncoder
   embeddings: embeddings
+  unet: models/unet
+  clip_vision: models/clip_vision
+  xlabs: models/xlabs
+  inpaint: models/inpaint
+  ipadapter: models/ipadapter
 
   custom_nodes: config/comfy/custom_nodes
 
   # TODO: I am unsure about these, need more testing
   # style_models: config/comfy/style_models
   # t2i_adapter: config/comfy/t2i_adapter
-  # clip_vision: config/comfy/clip_vision
   # diffusers: config/comfy/diffusers