ComfyUI

modules/comfyui/default.nix

@@ -0,0 +1,172 @@
+{ withSystem, ... }:
+{
+  flake.modules.nixos.comfyui =
+    {
+      pkgs,
+      config,
+      lib,
+      ...
+    }:
+    let
+      cfg = config.services.comfyui;
+      package = withSystem pkgs.stdenv.hostPlatform.system (
+        { config, ... }: config.packages.comfyui.override ({ inherit (cfg) basePath; })
+      );
+    in
+    {
+      options.services.pyroscope =
+        with lib;
+        {
+          enable = mkEnableOption (lib.mdDoc "ComfyUI");
+          basePath = mkOption {
+            type = types.path;
+            default = "/var/lib/comfyui";
+            description = "Base path for ComfyUI data.";
+          };
+          nodes = mkOption {
+            type = types.listOf types.package;
+            default = [ ];
+            description = "List of custom nodes to install. (Some are defined in comfyui.nodes)";
+          };
+          models = mkOption {
+            type = types.attrsOf types.listOf (
+              types.either types.package (
+                types.submodule {
+                  options = {
+                    url = mkOption {
+                      type = types.str;
+                      description = "URL to the model.";
+                    };
+                    hash = mkOption {
+                      type = types.str;
+                      description = "Hash of the model.";
+                    };
+                    name = mkOption {
+                      type = types.str;
+                      default = null;
+                      description = "Filename of the model.";
+                    };
+                  };
+                }
+              )
+            );
+            default = {
+              checkpoints = [ ];
+              clip = [ ];
+              clip_vision = [ ];
+              configs = [ ];
+              controlnet = [ ];
+              diffusion_models = [ ];
+              embeddings = [ ];
+              loras = [ ];
+              style_models = [ ];
+              text_encoders = [ ];
+              upscale_models = [ ];
+              vae = [ ];
+              vae_approx = [ ];
+            };
+            description = "List of models to install. (Either derivations or sets of urls, hashes and optionally filenames)";
+          };
+          port = mkOption {
+            type = types.port;
+            default = 8188;
+            description = "Port for ComfyUI.";
+          };
+          listen = mkOption {
+            type = types.str;
+            default = null;
+            description = "Specify the IP address to listen on (default: 127.0.0.1). You can give a list of ip addresses by separating them with a comma like: 127.2.2.2,127.3.3.3 If --listen is provided without an argument, it defaults to 0.0.0.0,:: (listens on all ipv4 and ipv6)";
+          };
+          cudaDevice = mkOption {
+            type = types.str;
+            default = null;
+            description = "Set the id of the cuda device this instance will use.";
+          };
+          tlsKeyFile = mkOption {
+            type = types.path;
+            default = null;
+            description = "Path to the TLS key file. If set, ComfyUI will use TLS. (Requires tlsCertFile)";
+          };
+          tlsCertFile = mkOption {
+            type = types.path;
+            default = null;
+            description = "Path to the TLS certificate file. If set, ComfyUI will use TLS. (Requires tlsKeyFile)";
+          };
+          enableCorsHeader = mkOption {
+            type = types.either types.str types.bool;
+            default = false;
+            description = "Enable CORS (Cross-Origin Resource Sharing) with optional origin or allow all with default '*'.";
+          };
+          maxUploadSize = mkOption {
+            type = types.int;
+            default = 0;
+            description = "Maximum upload size in MB. 0 means no limit.";
+          };
+          cudaMAlloc = mkOption {
+            type = types.bool;
+            default = true;
+            description = "Enable cudaMallocAsync (enabled by default for torch 2.0 and up).";
+          };
+          deterministic = mkOption {
+            type = types.bool;
+            default = false;
+            description = "Enable deterministic mode (default: false).";
+          };
+        }
+        // builtins.listToAttrs (
+          map
+            (x: {
+              name = "${x}Path";
+              value = mkOption {
+                type = types.path;
+                default = "${cfg.basePath}/${x}";
+                description = "Path for ComfyUI ${x} data.";
+              };
+            })
+            [
+              "models"
+              "input"
+              "output"
+              "temp"
+              "user"
+            ]
+        );
+      config =
+        with lib;
+        with builtins;
+        {
+          assertions = [
+            {
+              assertion = (isNull cfg.tlsKeyFile) != (isNull cfg.tlsCertFile);
+              message = "If tlsKeyFile is set, tlsCertFile must also be set and vice versa.";
+            }
+          ];
+          systemd.services.pyroscope = lib.mkIf cfg.enable {
+            description = "comfyui";
+            wantedBy = [ "multi-user.target" ];
+            serviceConfig = {
+              ExecStart =
+                "${getExe package} --multi-user --port ${toString cfg.port}"
+                + (optionalString (!isNull cfg.listen) " --listen ${cfg.listen}")
+                + (optionalString (!isNull cfg.cudaDevice) " --cuda-device ${cfg.cudaDevice}")
+                + (optionalString (!isNull cfg.tlsKeyFile) " --tls-keyfile ${toString cfg.tlsKeyFile}")
+                + (optionalString (!isNull cfg.tlsCertFile) " --tls-certfile ${toString cfg.tlsCertFile}")
+                + (optionalString (cfg.enableCorsHeader != false) (
+                  " --enable-cors-header"
+                  + (
+                    if isString cfg.enableCorsHeader then
+                      cfg.enableCorsHeader
+                    else if cfg.enableCorsHeader == true then
+                      "*"
+                    else
+                      ""
+                  )
+                ))
+                + (optionalString (cfg.maxUploadSize != 0) " --max-upload-size ${toString cfg.maxUploadSize}")
+                + (if cfg.cudaMAlloc then " --cuda-malloc" else " --disable-cuda-malloc")
+                + (optionalString cfg.deterministic " --deterministic");
+            };
+          };
+        };
+    };
+}

modules/default.nix

@@ -7,5 +7,6 @@
     ./random-alerts
     ./host-info.nix
     ./secrets.nix
+    ./comfyui
   ];
 }

packages/comfyui/base.nix

@@ -0,0 +1,56 @@
+{
+  version,
+  modelPathsFile,
+  modelsPath,
+  inputPath,
+  outputPath,
+  tempPath,
+  userPath,
+  stdenv,
+  fetchFromGitHub,
+}:
+stdenv.mkDerivation {
+  pname = "comfyui-base";
+  inherit version;
+
+  src = fetchFromGitHub {
+    owner = "comfyanonymous";
+    repo = "ComfyUI";
+    rev = "b685b8a4e098237919adae580eb29e8d861b738f";
+    hash = "sha256-OtTvyqiz2Ba7HViW2MxC1hFulSWPuQaCADeQflr80Ik=";
+  };
+
+  installPhase = ''
+    runHook preInstall
+    echo "Preparing bin folder"
+    mkdir -p $out/bin/
+    echo "Copying comfyui files"
+    # These copies everything over but test/ci/github directories.  But it's not
+    # very future-proof.  This can lead to errors such as "ModuleNotFoundError:
+    # No module named 'app'" when new directories get added (which has happened
+    # at least once).  Investigate if we can just copy everything.
+    cp -r $src/app $out/
+    cp -r $src/api_server $out/
+    cp -r $src/comfy $out/
+    cp -r $src/comfy_api_nodes $out/
+    cp -r $src/comfy_extras $out/
+    cp -r $src/comfy_execution $out/
+    cp -r $src/utils $out/
+    cp $src/*.py $out/
+    cp --remove-destination $src/folder_paths.py $out/
+    cp  $src/requirements.txt $out/
+    mv $out/main.py $out/comfyui
+    echo "Copying ${modelPathsFile} to $out"
+    cp ${modelPathsFile} $out/extra_model_paths.yaml
+    echo "Setting up input and output folders"
+    ln -s ${inputPath} $out/input
+    ln -s ${outputPath} $out/output
+    echo "Setting up node folders"
+    ln -s ${modelsPath}/wildcards $out/wildcards
+    mkdir -p $out/${tempPath}
+    echo "Patching python code..."
+    substituteInPlace $out/folder_paths.py --replace 'os.path.join(base_path, "temp")' '"${tempPath}"'
+    substituteInPlace $out/folder_paths.py --replace 'os.path.join(base_path, "user")' '"${userPath}"'
+    runHook postInstall
+  '';
+}

packages/comfyui/default.nix

@@ -0,0 +1,141 @@
+{
+  lib,
+  runCommand,
+  callPyPackage,
+  writers,
+  writeTextFile,
+  pkgs,
+  basePath ? "/var/lib/comfyui",
+  modelsPath ? "${basePath}/models",
+  inputPath ? "${basePath}/input",
+  outputPath ? "${basePath}/output",
+  tempPath ? "${basePath}/temp",
+  userPath ? "${basePath}/user",
+  customNodes ? [ ],
+  models ? {
+    checkpoints = [ ];
+    clip = [ ];
+    clip_vision = [ ];
+    configs = [ ];
+    controlnet = [ ];
+    embeddings = [ ];
+    upscale_modules = [ ];
+    vae = [ ];
+    vae_approx = [ ];
+    gligen = [ ];
+  },
+}:
+
+let
+  version = "unstable-2025-04-26";
+
+  config-data = {
+    comfyui = {
+      base_path = modelsPath;
+      checkpoints = "${modelsPath}/checkpoints";
+      clip = "${modelsPath}/clip";
+      clip_vision = "${modelsPath}/clip_vision";
+      configs = "${modelsPath}/configs";
+      controlnet = "${modelsPath}/controlnet";
+      diffusion_models = "${modelsPath}/diffusion_models";
+      embeddings = "${modelsPath}/embeddings";
+      loras = "${modelsPath}/loras";
+      style_models = "${modelsPath}/style_models";
+      text_encoders = "${modelsPath}/text_encoders";
+      upscale_models = "${modelsPath}/upscale_models";
+      vae = "${modelsPath}/vae";
+      vae_approx = "${modelsPath}/vae_approx";
+    };
+  };
+
+  modelPathsFile = writeTextFile {
+    name = "extra_model_paths.yaml";
+    text = (lib.generators.toYAML { } config-data);
+  };
+
+  pythonEnv = callPyPackage ./python-env.nix {
+    inherit customNodes;
+  };
+
+  installedModels =
+    let
+      # Helper function to process a single category
+      processCategory =
+        category: urls:
+        map (
+          model:
+          if lib.isDerivation model then
+            model
+          else
+            pkgs.fetchurl rec {
+              url = model.url;
+              name = if model.name != null then model.name else builtins.baseNameOf model.url;
+              hash = model.hash;
+              downloadToTemp = true;
+              recursiveHash = true;
+              postFetch = ''
+                echo mkdir -p "$out"/${category}
+                mkdir -p "$out"/${category}
+                cp "$downloadedFile" "$out"/${category}/${name}
+              '';
+            }
+        ) urls;
+    in
+    builtins.concatLists (builtins.attrValues (builtins.mapAttrs processCategory models));
+
+  comfyui-base = callPyPackage ./base.nix {
+    inherit
+      version
+      modelsPath
+      modelPathsFile
+      inputPath
+      outputPath
+      tempPath
+      userPath
+      ;
+  };
+
+  wrapperScript = writers.writeBashBin "comfyui" ''
+    cd $out
+    export WAS_CONFIG_DIR="${userPath}"
+    ${pythonEnv}/bin/python comfyui \
+      --input-directory ${inputPath} \
+      --output-directory ${outputPath} \
+      --extra-model-paths-config ${modelPathsFile} \
+      --temp-directory ${tempPath} \
+      "$@"
+  '';
+
+in
+(runCommand "comfyui"
+  {
+    inherit version;
+
+    meta = {
+      homepage = "https://github.com/comfyanonymous/ComfyUI";
+      description = "The most powerful and modular stable diffusion GUI with a graph/nodes interface.";
+      license = lib.licenses.gpl3;
+      platforms = lib.platforms.all;
+    };
+    passthru.nodes = import ./nodes { inherit callPyPackage; };
+  }
+  (
+    ''
+      mkdir -p $out/{bin,custom_nodes,models}
+    ''
+    + (lib.concatMapStrings (dir: ''
+      [[ ${dir.pname} == "was-node-suite" ]] && mkdir -p $out/custom_nodes/was-node-suite
+      cp -r ${dir}/* $out/
+    '') ([ comfyui-base ] ++ customNodes))
+    + (lib.concatMapStrings (model: ''
+      cd ${model}
+      find . -mindepth 1 -type d -exec mkdir -p $out/models/{} \;
+      cp -rs ${model}/* $out/models/
+    '') installedModels)
+    + ''
+      cp ${wrapperScript}/bin/comfyui $out/bin/comfyui
+      chmod +x $out/bin/comfyui
+      substituteInPlace $out/bin/comfyui --replace "\$out" "$out"
+    ''
+  )
+)

packages/comfyui/nodes/default.nix

@@ -0,0 +1,11 @@
+{ callPyPackage }:
+{
+  wildcards = callPyPackage ./wildcards.nix { };
+  impact-pack = callPyPackage ./impact-pack.nix { };
+  # impact-subpack = callPyPackage ./impact-subpack.nix { }; # can't find ultralytics
+  rgthree-comfy = callPyPackage ./rgthree-comfy.nix { };
+  essentials = callPyPackage ./essentials.nix { };
+  inspire-pack = callPyPackage ./inspire-pack.nix { };
+  ljnodes = callPyPackage ./ljnodes.nix { };
+  was-node-suite = callPyPackage ./was-node-suite.nix { }; # needs directory to be writeable, and opencv with ffmpeg
+}