Skip to content

ImDarkTom/ComfyUIMini

Repository files navigation

ComfyUI Mini

A mobile-friendly WebUI to run ComfyUI workflows.

App Preview

Features

  • ⚡ Lightweight UI built for mobile devices
  • 💾 Workflows saved to device or PC
  • ⏳ Progress info when generating images
  • 🤖 Automatic workflow importing
  • 🖼️ Gallery of all generated images

Requirements

For PC (Hosting WebUI):

  • ComfyUI: Ensure ComfyUI is installed and functional (minimum v0.2.2-50-7183fd1 / Sep. 18th release).
  • NodeJS: Version 20.0.0 or higher.
  • Package manager: Perferrably NPM as Yarn has not been explicitly tested but should work nonetheless.

Mobile (Accessing WebUI):

  • Browser: Any modern browser with support for WebSocket.
  • Network: Connection to the same network as the hosting PC.

Installation

  1. Download

You can download the latest release from the releases page (more stable) or clone the repository (more up-to-date).

git clone https://github.com/ImDarkTom/ComfyUIMini.git
cd ./ComfyUIMini
  1. Setup (a) Install script

Windows:

.\scripts\install.bat

Linux/MacOS:

chmod +x ./scripts/install.sh
./scripts/install.sh

(b) Manually

npm install
npm run build
  1. Run the app
npm start

or

Windows:

.\scripts\start.bat

Linux/MacOS:

chmod +x ./scripts/start.sh
./scripts/start.sh

Note: You may experience a crash on first launch, this should be resolve by launching again.

You can change the ComfyUI url/port as well as the port the app runs on in the /config/default.json file.

After sucessfully running you should see text along the lines of Running on http://<local-ip>:<port> in the console, put this url into any device on your network and you should be able to access the UI.

For updating, you can run the update script in the ./scripts/ directory for your respective platform (.bat for Windows, .sh for Linux and MacOS).

FAQ

Q: I can't import my workflow.

  • A: You need to save your workflow in API Format to be able to import it as regular saving doesnt provide enough information to list all available inputs. For a guide on how to enable this option see video here.

Q: Can you access the WebUI outside of the local network?

  • A: Yes you can through the use of port forwarding, however this carries security risks as it will allow anyone to potentially connect to your WebUI. As the process of setting up port forwarding varies greatly depending on your internet service provider I am unable to give specific instructions, however you may be able to find help by seaching '[your ISP] enable port forwarding'.

Donating

If you find this WebUI to be useful and want to support development you can donate using the button below.

Buy Me A Coffee