Skip to content
Open
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
25 changes: 22 additions & 3 deletions tutorials/pods/comfyui.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check warning on line 1 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L1

Try to keep the Flesch reading ease score (53.86) above 70.

Check warning on line 1 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L1

Try to keep the SMOG grade (11.02) below 10.

Check warning on line 1 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L1

Try to keep the LIX score (42.40) below 35.

Check warning on line 1 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L1

Try to keep the Automated Readability Index (8.96) below 8.

Check warning on line 1 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L1

Try to keep the Flesch–Kincaid grade level (9.23) below 8.

Check warning on line 1 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L1

Try to keep the Gunning-Fog index (10.15) below 10.

Check warning on line 1 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L1

Try to keep the Coleman–Liau Index grade (11.27) below 9.
title: "Generate images with ComfyUI"
sidebarTitle: "Generate images with ComfyUI"
description: "Deploy ComfyUI on Runpod to create AI-generated images. Follow implementation steps, configuration guidance, and examples in this Runpod tutorial."
Expand All @@ -10,7 +10,7 @@

[ComfyUI](https://comfy.org/) is a node-based graphical interface for creating AI image generation workflows. Instead of writing code, you connect different components visually to build custom image generation pipelines. This approach provides flexibility to experiment with various models and techniques while maintaining an intuitive interface.

This tutorial uses the [SDXL-Turbo](https://huggingface.co/stabilityai/sdxl-turbo) model and a matching <TemplateTooltip />, but you can adapt these instructions for any model/template combination you want to use.

Check warning on line 13 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L13

Spell out 'SDXL', if it's unfamiliar to the audience.

<Tip>
When you're just getting started with ComfyUI, it's important to use a workflow that was created for the specific model you intend to use. You usually can't just switch the "Load Checkpoint" node from one model to another and expect optimal performance or results.
Expand All @@ -26,7 +26,7 @@
- At least $10 in Runpod credits.
- A basic understanding of AI image generation.

## Step 1: Deploy a ComfyUI Pod

Check warning on line 29 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L29

'Step 1: Deploy a ComfyUI Pod' should use sentence-style capitalization.

First, you'll deploy a Pod using the official Runpod ComfyUI template, which pre-installs ComfyUI and the ComfyUI Manager plugin.

Expand Down Expand Up @@ -81,15 +81,34 @@
```

**Port configuration:**
- `8188/http`: ComfyUI web interface
- `22/tcp`: SSH access
- `8080/http`: File browser (optional)
- `8188/http`: ComfyUI web interface.
- `22/tcp`: SSH access. Set the `PUBLIC_KEY` environment variable, or check the Pod logs for a generated root password.
- `8080/http`: FileBrowser web file manager (optional). See [Access the FileBrowser and JupyterLab](#access-the-filebrowser-and-jupyterlab) for credentials.
- `8888/http`: JupyterLab (optional). See [Access the FileBrowser and JupyterLab](#access-the-filebrowser-and-jupyterlab) for credentials.

To also expose JupyterLab, add `"8888/http"` to the `ports` array.

For Blackwell GPUs (RTX 5090, B200), use `runpod/comfyui:cuda12.8` instead.

</Tab>
</Tabs>

### Access the FileBrowser and JupyterLab

Check warning on line 96 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L96

'Access the FileBrowser and JupyterLab' should use sentence-style capitalization.

The official ComfyUI templates expose two extra web services alongside ComfyUI:

- **FileBrowser** on port `8080`. Upload, download, and manage files in `/workspace` from a browser.
- **JupyterLab** on port `8888`. Open notebooks and a terminal rooted at `/workspace`.

Open them from the Runpod console by clicking **Connect** on your Pod and selecting the HTTP service for the port you want.

**Default credentials:**

- **FileBrowser:** username `admin`, password `adminadmin12`. To change the password, set the `FILEBROWSER_PASSWORD` environment variable on the Pod before it first starts.
- **JupyterLab:** the login token is the value of the `JUPYTER_PASSWORD` environment variable. If it isn't set, check the Pod logs for the generated token.

Change these defaults for any Pod you expose publicly.

## Step 2: Open the ComfyUI interface

Once your Pod has finished initializing, you can open the ComfyUI interface:
Expand Down Expand Up @@ -118,7 +137,7 @@

## Step 3: Load a workflow template

ComfyUI workflows consist of a series of nodes that are connected to each other to create a AI generation pipeline. Rather than creating our own workflow from scratch, we'll load a pre-configured workflow that was created for the specific model we intend to use:

Check warning on line 140 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L140

In general, use active voice instead of passive voice ('are connected').

Check warning on line 140 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L140

Try to avoid using first-person plural like 'our'.

Check warning on line 140 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L140

Try to avoid using first-person plural like 'we'.

Check warning on line 140 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L140

In general, use active voice instead of passive voice ('was created').

Check warning on line 140 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L140

Try to avoid using first-person plural like 'we'.

<Steps>
<Step title="Open the template browser">
Expand All @@ -130,11 +149,11 @@
</Step>
</Steps>

## Step 4: Install the SDXL-Turbo model

Check warning on line 152 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L152

Spell out 'SDXL', if it's unfamiliar to the audience.

As soon as you load the workflow, you'll see a popup labeled **Missing Models**. This happens because the Pod template we deployed doesn't come pre-installed with any models, so we'll need to install them now.

Check warning on line 154 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L154

Avoid time-based words like 'soon' in product documentation.

Check warning on line 154 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L154

Try to avoid using first-person plural like 'we'.

Check warning on line 154 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L154

Try to avoid using first-person plural like 'we'.

Rather than clicking the download button (which downloads the missing model to your local machine), use the ComfyUI Manager plugin to install the missing model directly onto the Pod:

Check warning on line 156 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L156

Use parentheses judiciously.

<Steps>
<Step title="Open the ComfyUI Manager">
Expand All @@ -158,7 +177,7 @@

## Step 5: Generate an image

Your workflow is now ready! Follow these steps to generate an image:

Check warning on line 180 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L180

Don't use exclamation points in text.

<Steps>
<Step title="Customize your prompt">
Expand Down Expand Up @@ -202,7 +221,7 @@

Here are some common issues you may encounter and possbile solutions:

- **Connection errors**: Wait for the Pod to fully initialize (up to 30 minutes for initial deployment).

Check warning on line 224 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L224

Use parentheses judiciously.
- **HTTP service not ready**: Wait at least 2 to 3 minutes after Pod deployment for the HTTP service to fully start. You can also check the Pod logs in the Runpod console to look for deployment errors.
- **Out of memory errors**: Reduce image resolution or batch size in your workflow.
- **Slow generation**: Make sure you're using an appropriate GPU for your selected model. See [Choose a Pod](/pods/choose-a-pod) for guidance.
Expand All @@ -229,7 +248,7 @@
2. Connecting node outputs to inputs by dragging between connection points.
3. Saving your custom workflow with <kbd>Ctrl</kbd>+<kbd>S</kbd> or by clicking **Workflow** and selecting **Save**.

### Manage your Pod

Check warning on line 251 in tutorials/pods/comfyui.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

tutorials/pods/comfyui.mdx#L251

'Manage your Pod' should use sentence-style capitalization.

While working with ComfyUI, you can monitor your usage by checking GPU/disk utilization in the [Pods page](https://console.runpod.io/pods) of the Runpod console.

Expand Down
Loading