Add ComfyUI-Manager Documentation

docs.json

@@ -89,6 +89,18 @@
                   }
                 ]
               },
+              {
+                "group": "ComfyUI-Manager",
+                "icon": "puzzle-piece",
+                "pages": [
+                  "manager/overview",
+                  "manager/installation",
+                  "manager/usage",
+                  "manager/configuration",
+                  "manager/cli",
+                  "manager/troubleshooting"
+                ]
+              },
               {
                 "group": "Tutorials",
                 "icon": "book",

manager/cli.mdx

@@ -0,0 +1,21 @@
+---
+title: CLI tools
+description: Command line tools for ComfyUI-Manager
+---
+
+## Overview
+
+ComfyUI-Manager provides `cm-cli`, a command line tool that allows you to use Manager features without running ComfyUI.
+
+This is useful for:
+- Automating custom node installation
+- Managing installations in headless environments
+- Scripting ComfyUI setup
+
+## Documentation
+
+For detailed cm-cli documentation, see the [official cm-cli guide](https://github.com/ltdrdata/ComfyUI-Manager/blob/main/docs/en/cm-cli.md).
+
+## Related tools
+
+For a more comprehensive CLI experience, consider using [comfy-cli](/comfy-cli/getting-started), which provides additional features for managing ComfyUI installations.

manager/configuration.mdx

@@ -0,0 +1,150 @@
+---
+title: Configuration
+description: Configure ComfyUI-Manager settings and paths
+---
+
+## Paths
+
+Starting from V3.38, Manager uses a protected system path for enhanced security.
+
+### User directory
+
+- Default path: `ComfyUI/user`
+- Can be set using `--user-directory <USER_DIRECTORY>`
+
+### Manager path
+
+| ComfyUI Version | Manager Path |
+|-----------------|--------------|
+| v0.3.76+ (with System User API) | `<USER_DIRECTORY>/__manager/` |
+| Older versions | `<USER_DIRECTORY>/default/ComfyUI-Manager/` |
+
+### Configuration files
+
+| File | Description |
+|------|-------------|
+| `config.ini` | Basic configuration |
+| `channels.list` | Configurable channel lists |
+| `pip_overrides.json` | Custom pip package mappings |
+| `pip_blacklist.list` | Packages to prevent installation |
+| `pip_auto_fix.list` | Packages to auto-restore |
+| `snapshots/` | Saved snapshot files |
+| `startup-scripts/` | Startup script files |
+| `components/` | Component files |
+
+## Config.ini options
+
+Modify the `config.ini` file to apply settings. The path is displayed in startup log messages.
+
+```ini
+[default]
+git_exe = <path to git executable>
+use_uv = <True/False - use uv instead of pip>
+default_cache_as_channel_url = <True/False>
+bypass_ssl = <True/False - disable SSL if errors occur>
+file_logging = <True/False - create log file>
+windows_selector_event_loop_policy = <True/False - fix event loop errors on Windows>
+model_download_by_agent = <True/False - use agent for model downloads>
+downgrade_blacklist = <comma-separated package list>
+security_level = <strong|normal|normal-|weak>
+always_lazy_install = <True/False>
+network_mode = <public|private|offline>
+```
+
+### Network modes
+
+| Mode | Description |
+|------|-------------|
+| `public` | Standard public network environment |
+| `private` | Closed network with private node DB configured via `channel_url` (uses cache if available) |
+| `offline` | No external connections (uses cache if available) |
+
+## Extra model paths
+
+Configure in `extra_model_paths.yaml`. Settings are applied based on the section marked as `is_default`:
+
+- `custom_nodes`: Path for installing custom nodes
+- `download_model_base`: Path for downloading models
+
+## Environment variables
+
+| Variable | Description |
+|----------|-------------|
+| `COMFYUI_PATH` | Installation path of ComfyUI |
+| `GITHUB_ENDPOINT` | Reverse proxy for GitHub access |
+| `HF_ENDPOINT` | Reverse proxy for Hugging Face access |
+
+### Examples
+
+**GitHub proxy:**
+```bash
+GITHUB_ENDPOINT=https://mirror.ghproxy.com/https://github.com
+```
+Redirects `https://github.com/ltdrdata/ComfyUI-Impact-Pack` to `https://mirror.ghproxy.com/https://github.com/ltdrdata/ComfyUI-Impact-Pack`
+
+**Hugging Face proxy:**
+```bash
+HF_ENDPOINT=https://some-hf-mirror.com
+```
+Changes `https://huggingface.co/path/to/somewhere` to `https://some-hf-mirror.com/path/to/somewhere`
+
+## Advanced configuration
+
+### Prevent package downgrades
+
+List package names in `downgrade_blacklist` in `config.ini`, separated by commas:
+
+```ini
+downgrade_blacklist = diffusers, kornia
+```
+
+### Custom pip mapping
+
+Create `pip_overrides.json` to change installation of specific pip packages. Refer to `pip_overrides.json.template` for format.
+
+### Prevent pip package installation
+
+List package names one per line in `pip_blacklist.list`.
+
+### Auto-restore pip packages
+
+List pip spec requirements in `pip_auto_fix.list` (similar to `requirements.txt`). Packages are automatically restored when starting ComfyUI or when versions get mismatched.
+
+`--index-url` can be used.
+
+### Use aria2 as downloader
+
+See the [aria2 setup guide](https://github.com/ltdrdata/ComfyUI-Manager/blob/main/docs/en/use_aria2.md) for configuration.
+
+## Security policy
+
+Set security level in `config.ini`:
+
+```ini
+security_level = <LEVEL>
+```
+
+### Security levels
+
+| Level | Description |
+|-------|-------------|
+| `strong` | Doesn't allow high and middle level risky features |
+| `normal` | Doesn't allow high level risky features; middle level available |
+| `normal-` | Doesn't allow high level risky features if `--listen` is specified and not starts with `127.`; middle level available |
+| `weak` | All features available |
+
+### Risk levels
+
+**High risk features:**
+- Install via git URL, pip install
+- Installation of custom nodes not in the default channel
+- Fix custom nodes
+
+**Middle risk features:**
+- Uninstall/Update
+- Installation of custom nodes in the default channel
+- Restore/Remove Snapshot
+- Restart
+
+**Low risk features:**
+- Update ComfyUI

manager/installation.mdx

@@ -0,0 +1,91 @@
+---
+title: Installation
+description: How to install ComfyUI-Manager
+---
+
+## Prerequisites
+
+- Python 3
+- Git
+
+## Installation methods
+
+### Method 1: General installation (recommended)
+
+To install ComfyUI-Manager in addition to an existing installation of ComfyUI:
+
+1. Navigate to `ComfyUI/custom_nodes` directory in terminal
+2. Clone the repository:
+   ```bash
+   git clone https://github.com/ltdrdata/ComfyUI-Manager comfyui-manager
+   ```
+3. Restart ComfyUI
+
+### Method 2: Portable ComfyUI version (Windows)
+
+1. Install [Git for Windows](https://git-scm.com/download/win)
+   - Use standalone version
+   - Select option: "use windows default console window"
+2. Download [install-manager-for-portable-version.bat](https://github.com/ltdrdata/ComfyUI-Manager/raw/main/scripts/install-manager-for-portable-version.bat) into your `ComfyUI_windows_portable` directory
+   - Right-click the link and choose "Save As..."
+3. Double-click `install-manager-for-portable-version.bat`
+
+### Method 3: Using comfy-cli (recommended)
+
+comfy-cli provides various features to manage ComfyUI from the CLI and installs both ComfyUI and ComfyUI-Manager at once.
+
+<Tabs>
+  <Tab title="Windows">
+    ```bash
+    python -m venv venv
+    venv\Scripts\activate
+    pip install comfy-cli
+    comfy install
+    ```
+  </Tab>
+  <Tab title="Linux/macOS">
+    ```bash
+    python -m venv venv
+    . venv/bin/activate
+    pip install comfy-cli
+    comfy install
+    ```
+  </Tab>
+</Tabs>
+
+See also: [comfy-cli documentation](/comfy-cli/getting-started)
+
+### Method 4: Linux with venv
+
+Prerequisites: `python-is-python3`, `python3-venv`, `git`
+
+1. Download [install-comfyui-venv-linux.sh](https://github.com/ltdrdata/ComfyUI-Manager/raw/main/scripts/install-comfyui-venv-linux.sh) into an empty install directory
+   - Right-click the link and choose "Save As..."
+2. Make executable and run:
+   ```bash
+   chmod +x install-comfyui-venv-linux.sh
+   ./install-comfyui-venv-linux.sh
+   ```
+
+You can execute ComfyUI by running either `./run_gpu.sh` or `./run_cpu.sh` depending on your system configuration.
+
+## Installation precautions
+
+<Warning>
+ComfyUI-Manager files must be accurately located in the path `ComfyUI/custom_nodes/comfyui-manager`
+</Warning>
+
+**Do not:**
+- Decompress directly into `ComfyUI/custom_nodes` location, resulting in Manager contents like `__init__.py` being placed directly in that directory
+- Install in a path like `ComfyUI/custom_nodes/ComfyUI-Manager/ComfyUI-Manager`
+- Install in a path like `ComfyUI/custom_nodes/ComfyUI-Manager-main`
+
+If installed incorrectly, ComfyUI-Manager may operate but won't be recognized for updates and poses the risk of duplicate installations. Remove it and install properly via `git clone` method.
+
+## Google Colab
+
+Use the [Colab notebook](https://colab.research.google.com/github/ltdrdata/ComfyUI-Manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb) to run ComfyUI with ComfyUI-Manager:
+
+- Supports installing ComfyUI
+- Supports basic installation of ComfyUI-Manager
+- Automatically installs dependencies of custom nodes upon restarting Colab notebooks

manager/overview.mdx

@@ -0,0 +1,37 @@
+---
+title: ComfyUI-Manager overview
+description: An extension to manage custom nodes, models, and more in ComfyUI
+---
+
+**ComfyUI-Manager** is an extension designed to enhance the usability of ComfyUI. It offers management functions to **install, remove, disable, and enable** various custom nodes of ComfyUI. Furthermore, this extension provides a hub feature and convenience functions to access a wide range of information within ComfyUI.
+
+## Key features
+
+- **Custom node management**: Install, update, remove, and disable custom nodes
+- **Model management**: Download and manage models from various sources
+- **Snapshot management**: Save and restore installation states
+- **Workflow sharing**: Share workflows to platforms like ComfyWorkflows, OpenArt, and YouML
+- **Missing node detection**: Automatically detect and install missing nodes from workflows
+- **Component sharing**: Share and import workflow components
+
+## Recent updates
+
+<Note>
+**V3.38 Security patch**: Manager data migrated to protected path. See [Migration guide](/manager/configuration#paths) for details.
+</Note>
+
+- **V3.16**: Support for `uv` package manager added. Set `use_uv` in `config.ini`.
+- **V3.3.2**: Officially supports the [Comfy Registry](https://registry.comfy.org/).
+
+## Quick links
+
+- [Installation guide](/manager/installation)
+- [How to use](/manager/usage)
+- [Configuration](/manager/configuration)
+- [CLI tools](/manager/cli)
+- [Troubleshooting](/manager/troubleshooting)
+
+## Resources
+
+- [ComfyUI Nodes Info](https://ltdrdata.github.io/) - Browse all available nodes
+- [Comfy Registry](https://registry.comfy.org/) - Official node registry