Skip to content

Commit

Permalink
Add folder structure / file locations to README. (#229)
Browse files Browse the repository at this point in the history
* Add folder structure / file locations to README.

* pretttier.
  • Loading branch information
robinjhuang authored Nov 12, 2024
1 parent b69db8a commit edf265c
Showing 1 changed file with 31 additions and 9 deletions.
40 changes: 31 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,44 @@ We publish updates in line with the stable releases of ComfyUI.

The app uses our electron update server hosted at https://updater.comfy.org.

## ComfyUI Files
## Application Files

ComfyUI files like models, inputs, outputs, custom_nodes and saved workflows are placed here:
### Electron

Windows: `%USERPROFILE%/ComfyUI/...`
The desktop application comes bundled with:

Mac: `~/Library/Application Support/ComfyUI`
- ComfyUI source code
- ComfyUI-Manager
- Electron, Chromium binaries, and node modules

## Logs
These are placed here by the installer:

We use electron-log to log everything to a local file.
On Windows: `%APPDATA%\Roaming\ComfyUI` and `%APPDATA%\Local\comfyui-electron-updater`

On macOS: `~/Library/Application Support/ComfyUI`

On Linux: `~/.config/ComfyUI`

### ComfyUI

You will also be asked to select a location to store ComfyUI files like models, inputs, outputs, custom_nodes and saved workflows.

An `extra_model_config.yaml` is created to store the paths to this directory. You can edit it to add additional model paths that you want to use.

On Windows: `%APPDATA%\Roaming\ComfyUI\extra_model_config.yaml`

On macOS: `~/Library/Application Support/ComfyUI/extra_model_config.yaml`

On Linux: `~/.config/ComfyUI/extra_model_config.yaml`

### Logs

We use electron-log to log everything. Electron main process logs are in `main.log`, and ComfyUI server logs are in `comfyui_<date>.log`.

```
on Linux: ~/.config/{app name}/logs/main.log
on macOS: ~/Library/Logs/{app name}/main.log
on Windows: %USERPROFILE%\AppData\Roaming\{app name}\logs\main.log
on Linux: ~/.config/{app name}/logs
on macOS: ~/Library/Logs/{app name}
on Windows: %AppData%\Roaming\{app name}\logs
```

# Development
Expand Down

0 comments on commit edf265c

Please sign in to comment.