Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,26 @@
"installation/desktop/linux"
]
},
{
"group": "Desktop 2.0 (Beta)",
"pages": [
"installation/desktop-2/overview",
"installation/desktop-2/windows",
"installation/desktop-2/macos",
"installation/desktop-2/linux",
"installation/desktop-2/usage"
]
},
{
"group": "Desktop 2.0 (Beta)",
"pages": [
"installation/desktop-2/overview",
"installation/desktop-2/windows",
"installation/desktop-2/macos",
"installation/desktop-2/linux",
"installation/desktop-2/usage"
]
},
"installation/comfyui_portable_windows",
"installation/manual_install",
"installation/update_comfyui"
Expand Down
120 changes: 120 additions & 0 deletions installation/desktop-2/linux.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
---
title: "Linux — ComfyUI Desktop 2.0"
description: "Install and set up ComfyUI Desktop 2.0 on Linux"
icon: "linux"
sidebarTitle: "Linux"
---

import TroubleshootingGpt from "/snippets/install/troubleshooting-gpt.mdx"
import TroubleshootingFeedback from "/snippets/install/troubleshooting-feedback.mdx"

**ComfyUI Desktop 2.0** is a multi-installation manager that lets you run multiple ComfyUI instances from a single launcher. This guide walks you through installing and using Desktop 2.0 on Linux.

ComfyUI Desktop 2.0 is an open source project. View the source code on [GitHub](https://github.com/Comfy-Org/ComfyUI-Desktop-2.0-Beta).

<Note>ComfyUI Desktop 2.0 is currently in **Beta**. The installation process and features may change.</Note>

## System Requirements

- **OS:** Debian-based distribution (Ubuntu 22.04+ recommended)
- **GPU:** NVIDIA GPU with CUDA support (recommended)
- **Disk Space:** At least 15 GB recommended per installation
- **AppArmor:** Required for `.deb` installations

## Download

Desktop 2.0 is available as a `.deb` package or AppImage:

<a className="prose" href="https://dl.todesktop.com/241130tqe9q3y/linux/appimage/x64" style={{ display: 'inline-block', backgroundColor: '#0078D6', color: '#ffffff', padding: '10px 20px', borderRadius: '8px', borderColor: "transparent", textDecoration: 'none', fontWeight: 'bold', marginRight: '12px' }}>
Download AppImage
</a>

For the `.deb` package, download the latest release from the [GitHub Releases](https://github.com/Comfy-Org/ComfyUI-Desktop-2.0-Beta/releases) page.

## Installation

### Option 1: .deb Package (Debian/Ubuntu)

```bash
sudo apt install ./ComfyUI-Desktop-2.0-*.deb
```

Then launch from your application menu.

### Option 2: AppImage

```bash
chmod +x ComfyUI-Desktop-2.0-*.AppImage
./ComfyUI-Desktop-2.0-*.AppImage --no-sandbox
```

You may want to move the AppImage to a permanent location, such as `~/Applications/` or `/opt/`.

## First Launch

The first time you launch, you'll see the **Welcome to ComfyUI Desktop** screen. Click **Get Started** to begin.

### Choose How to Install

<AccordionGroup>
<Accordion title="Quick Install (Recommended for New Users)">
Select **Quick Install** — this creates a fresh standalone ComfyUI installation:

1. Choose your **GPU**: Select **NVIDIA GPU (Recommended)**
2. Choose an **installation directory** (a separate empty folder)
3. Configure optional settings:
- **Automatic Updates**: Enable to auto-update ComfyUI when available
- **Usage Metrics**: Send anonymous usage data
- **Mirror Settings**: Configure mirrors if GitHub access is slow
4. Click **Install** — Desktop 2.0 downloads Python, sets up the environment, installs ComfyUI, and launches it
</Accordion>
<Accordion title="Track an Existing Installation">
If you already have a ComfyUI installation, select **Track Existing Install** to point Desktop 2.0 to an existing git clone or other installation.
</Accordion>
</AccordionGroup>

## Using Desktop 2.0 on Linux

All the core features work the same as on Windows/macOS — see the [Windows guide](/installation/desktop-2/windows) for details on:
- The Chooser View and managing installations
- Snapshots and updates
- Model downloads
- Global settings and proxy mirrors

## Data Locations

Desktop 2.0 follows the [XDG Base Directory Specification](https://wiki.archlinux.org/title/XDG_Base_Directory) on Linux:

| Data | Linux Path |
|------|-----------|
| Config (`settings.json`) | `~/.config/comfyui-desktop-2` |
| Data (`installations.json`) | `~/.local/share/comfyui-desktop-2` |
| Cache (`download-cache/`) | `~/.cache/comfyui-desktop-2` |
| State (`port-locks/`) | `~/.local/state/comfyui-desktop-2` |
| Default install directory | `~/ComfyUI-Installs` |

## Updating Desktop 2.0

- **AppImage:** Download the latest AppImage and replace the existing one
- **`.deb`:** Use `sudo apt upgrade` or download the latest `.deb` and reinstall
- **From the app:** Desktop 2.0 checks for updates automatically; look for notifications in the app

## Troubleshooting

### AppImage sandbox warning

If you see a sandbox warning when running the AppImage, use `--no-sandbox`:

```bash
./ComfyUI-Desktop-2.0-*.AppImage --no-sandbox
```

### Installation fails with mirror errors

Expand the mirror settings during installation and configure working mirrors for Python, PyPI, and Torch packages.

<TroubleshootingGpt/>
<TroubleshootingFeedback
log_path="~/.local/state/comfyui-desktop-2/logs"
config_path="~/.config/comfyui-desktop-2"
/>
144 changes: 144 additions & 0 deletions installation/desktop-2/macos.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
---
title: "macOS — ComfyUI Desktop 2.0"
description: "Install and set up ComfyUI Desktop 2.0 on macOS"
icon: "apple"
sidebarTitle: "macOS"
---

import TroubleshootingGpt from "/snippets/install/troubleshooting-gpt.mdx"
import TroubleshootingFeedback from "/snippets/install/troubleshooting-feedback.mdx"

**ComfyUI Desktop 2.0** is a multi-installation manager that lets you run multiple ComfyUI instances from a single launcher. This guide walks you through installing and using Desktop 2.0 on macOS.

ComfyUI Desktop 2.0 is an open source project. View the source code on [GitHub](https://github.com/Comfy-Org/ComfyUI-Desktop-2.0-Beta).

<Note>ComfyUI Desktop 2.0 is currently in **Beta**. The installation process and features may change.</Note>

## System Requirements

- **OS:** macOS 13 (Ventura) or later
- **Hardware:** Apple Silicon (M1 or later)
- **Disk Space:** At least 15 GB recommended per installation

## Download

<a className="prose" href="https://dl.todesktop.com/241130tqe9q3y/mac/dmg/arm64" style={{ display: 'inline-block', backgroundColor: '#000000', color: '#ffffff', padding: '10px 20px', borderRadius: '8px', borderColor: "transparent", textDecoration: 'none', fontWeight: 'bold' }}>
Download for macOS (Apple Silicon)
</a>

## Installation

### Step 1 — Install the App

1. Open the downloaded `.dmg` file
2. Drag **ComfyUI Desktop 2.0** into the **Applications** folder
3. Launch it from Launchpad or Spotlight

### Step 2 — First Launch

The first time you launch, macOS may show a security warning since the app is not notarized. Go to **System Settings → Privacy & Security** and click **Open Anyway** to allow it.

After launching, you'll see the **Welcome to ComfyUI Desktop** screen. Click **Get Started** to begin.

### Step 3 — Choose How to Install

You have two main paths:

<AccordionGroup>
<Accordion title="Quick Install (Recommended for New Users)">
Select **Quick Install** — this creates a fresh standalone ComfyUI installation:

1. Choose your **GPU**: Select **MPS (Recommended)** for Apple Silicon
2. Choose an **installation directory** (a separate empty folder)
3. Configure optional settings:
- **Automatic Updates**: Enable to auto-update ComfyUI when available
- **Usage Metrics**: Send anonymous usage data
- **Mirror Settings**: Configure mirrors if GitHub access is slow in your region
4. Click **Install** — Desktop 2.0 downloads Python, sets up the environment, installs ComfyUI, and launches it
</Accordion>
<Accordion title="Track an Existing Installation">
If you already have a ComfyUI installation, select **Track Existing Install**:

- **Git Clone** — Point to an existing ComfyUI git repository folder
- **Legacy Desktop** — Desktop 2.0 will detect existing Desktop 1.0 installations
</Accordion>
</AccordionGroup>

## First Launch

After installation, Desktop 2.0 opens the **Chooser** view — a grid of all your ComfyUI installations. Click any installation card to launch it.

Each card shows:
- Installation name and type (Standalone, Cloud, Git, etc.)
- Last launched timestamp
- Status indicators (running, error, update available)

## Managing Installations

### The Chooser View

The main screen shows all your installations in a tile grid. Use the filter chips at the top to narrow by source category.

### Installation Actions

Right-click any installation card (or click the ⋮ icon) to access:

- **Launch** — Start the ComfyUI backend and open the editor
- **Manage** — Open the per-installation settings panel
- **Update** — Update ComfyUI to the latest version
- **Restore Snapshot** — Revert to a saved snapshot
- **Open Folder** — Open the installation directory in Finder
- **Delete** — Remove the installation

### Snapshots

Desktop 2.0 automatically captures a **snapshot** before every update, recording the current ComfyUI version, installed custom nodes, and Python packages. You can restore any snapshot at any time.

### In-App Terminal

Access the ComfyUI Python environment directly from the app:
1. Click the terminal icon in the menu bar to open the bottom panel
2. Click **Terminal** to open the terminal
3. Run Python commands in the correct environment without needing to activate the virtual environment manually

### Model Downloads

Desktop 2.0 includes a built-in model download manager. Track download progress from the Downloads panel accessible from the title bar.

## Data Locations

| Data | macOS Path |
|------|-----------|
| App data (settings, installations list) | `~/Library/Application Support/ComfyUI Desktop 2.0` |
| Logs | `~/Library/Application Support/ComfyUI Desktop 2.0/logs` |
| Default install directory | User-chosen during setup |

## Updating Desktop 2.0

Desktop 2.0 checks for updates automatically. When an update is available, a notification will appear. You can also check manually from Global Settings.

You can also download the latest version directly:
- [macOS Apple Silicon](https://dl.todesktop.com/241130tqe9q3y/mac/dmg/arm64)

## Uninstalling

To uninstall Desktop 2.0:
1. Delete **ComfyUI Desktop 2.0** from your Applications folder
2. To remove all data, delete `~/Library/Application Support/ComfyUI Desktop 2.0`
3. Delete any installation directories you created during setup

## Troubleshooting

### macOS security warning

If macOS blocks the app, go to **System Settings → Privacy & Security**, scroll to the bottom, and click **Open Anyway** next to the ComfyUI entry.

### Installation fails with mirror errors

If mirrors fail during installation, expand the mirror settings and configure working mirrors for Python, PyPI, and Torch packages.

<TroubleshootingGpt/>
<TroubleshootingFeedback
log_path="~/Library/Application Support/ComfyUI Desktop 2.0/logs"
config_path="~/Library/Application Support/ComfyUI Desktop 2.0"
/>
92 changes: 92 additions & 0 deletions installation/desktop-2/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
---
title: "ComfyUI Desktop 2.0 Overview"
description: "Learn about ComfyUI Desktop 2.0 — a modern desktop app for managing multiple ComfyUI installations"
icon: "desktop"
sidebarTitle: "Overview"
---

**ComfyUI Desktop 2.0** is a next-generation desktop application that lets you install, manage, and launch multiple ComfyUI instances from a single place. Unlike the original Desktop (single-install), Desktop 2.0 is a multi-installation manager — think of it as a launcher for all your ComfyUI environments.

## Key Features

### Multi-Installation Management

Desktop 2.0 supports several types of ComfyUI installations:

| Source Type | Description |
|-------------|-------------|
| **Standalone** | A self-contained install with its own bundled Python and dependencies — clean, isolated, and easy to manage |
| **Cloud** | Connect to Comfy Cloud for remote GPU-powered workflows |
| **Git Clone** | Track an existing ComfyUI git clone with a Python venv — ideal for developers |
| **Portable** | Import existing ComfyUI portable installations (Windows) |
| **Legacy Desktop** | Detect and migrate existing Desktop 1.0 installations |
| **Remote Connection** | Connect to a running ComfyUI instance on another machine |

### What You Can Do

- **Quick Install** — Install a fresh standalone ComfyUI with one click, with automatic Python environment setup
- **Run Multiple Instances** — Launch and switch between different ComfyUI versions side by side
- **Snapshots** — Automatic snapshots capture your custom nodes, models, and settings before every update; restore to any previous snapshot at any time
- **One-Click Updates** — Update ComfyUI installations with a single click
- **Model Downloads** — Built-in model download manager with progress tracking
- **In-App Terminal** — Access the ComfyUI Python environment directly from the app
- **Global Settings** — Configure themes, proxy mirrors for China users, and anonymous usage metrics

## How It Works

Desktop 2.0 separates the **launcher** from the **workflow editor**. The app manages your installations; each installation runs its own ComfyUI backend (with its own Python environment). When you launch an installation, it opens in a separate window with the full ComfyUI workflow editor.

```mermaid
flowchart LR
A[Desktop 2.0 Launcher] --> B[Installation 1<br/>v0.3.2]
A --> C[Installation 2<br/>v0.2.4]
A --> D[Cloud Instance]
A --> E[Remote Server]
B --> F[ComfyUI Editor Window]
C --> G[ComfyUI Editor Window]
D --> H[Browser Tab]
```

## System Requirements

### Windows
- **OS:** Windows 10 or later
- **GPU:** NVIDIA GPU with CUDA support
- **Architecture:** x64 or ARM64

### macOS
- **OS:** macOS 13 (Ventura) or later
- **Hardware:** Apple Silicon (M1 or later)

### Linux
- **OS:** Ubuntu 22.04+ (Debian-based distributions)
- **GPU:** NVIDIA GPU with CUDA support (recommended)

### General
- **Disk Space:** At least 15 GB for each standalone installation
- **RAM:** 8 GB minimum, 16 GB recommended
- **Internet:** Required for installation and updates

## Desktop 2.0 vs Desktop 1.0

| Feature | Desktop 1.0 | Desktop 2.0 |
|---------|-------------|-------------|
| Installation type | Single ComfyUI instance | Multi-installation manager |
| Python management | Bundled single env | Per-instance isolated Python environments |
| Snapshots | Not available | Automatic snapshots before updates |
| Cloud support | No | Native Comfy Cloud integration |
| Multiple versions | No | Run different versions side by side |
| Git clone support | No | Yes |
| Remote connection | No | Yes |

## Open Source

ComfyUI Desktop 2.0 is fully open source. View the source code on [GitHub](https://github.com/Comfy-Org/ComfyUI-Desktop-2.0-Beta).

## Getting Started

Ready to get started? Choose your platform:

- [Windows Installation](/installation/desktop-2/windows)
- [macOS Installation](/installation/desktop-2/macos)
- [Linux Installation](/installation/desktop-2/linux)
Loading
Loading