246 lines
8.1 KiB
Markdown
246 lines
8.1 KiB
Markdown
|
|
|
|
|
|
# ComfyUI-Nexus
|
|
|
|
 
|
|
|
|
A ComfyUI node designed to enable seamless multi-user workflow collaboration.
|
|
|
|
|
|
|
|
**Features Video**: Coming Soon
|
|
|
|
<br>
|
|
|
|
# Important Notes
|
|
|
|
- ### **This node should be only installed/maintained on the machine that will act as Server.**
|
|
- ### **No need to install this node on other users.**
|
|
- ### **ComfyUI is also not needed by other users.**
|
|
- ### **Only URL is needed by other users to connect to server Locally/Remotely**.
|
|
|
|
<br>
|
|
|
|
## Key Features
|
|
|
|
<br>
|
|
|
|
- **Multiuser collaboration**: enable multiple users to work on the same workflow simultaneously.
|
|
- **Local and Remote access**: use tools like ngrok or other tunneling software to facilitate remote collaboration. A local IP address on WiFi will also work 😎.
|
|
- **Enhanced teamwork**: streamline your team's workflow management and collaboration process.
|
|
- **Real-time chat**: communicate directly within the platform to ensure smooth and efficient collaboration.
|
|
- **Spectate mode**: allow team members to observe the workflow in real-time without interfering—perfect for training or monitoring progress.
|
|
- **Admin permissions**: admins can control who can edit the workflow and who can queue prompts, ensuring the right level of access for each team member.
|
|
- **Workflow backup**: in case of any mishap, you can reload an old backup. The node saves 5 workflows, each 60 seconds apart.
|
|
|
|
<br>
|
|
|
|
>[!WARNING]
|
|
>When Opening the Comfyui Workspace for the first time, It will be locked, Login as admin to enable editing.
|
|
|
|
<br>
|
|
|
|
## Key Binds
|
|
|
|
- **Activate chat**: press **`t`**
|
|
- **Show/hide users panel**: press **`LAlt + p`**
|
|
- **Show/hide backups panel**: press **`LAlt + o`** (for editors only)
|
|
|
|
<br>
|
|
|
|
## Chat Commands
|
|
|
|
- `/nick <name>`: changes your nickname
|
|
- `/login account password`: this command is used to become admin.
|
|
- `/logout`: logout the admin.
|
|
|
|
<br>
|
|
|
|
# Node Installation
|
|
|
|
- ### Installing Using `comfy-cli`
|
|
- `comfy node registry-install ComfyUI-Nexus`
|
|
- https://registry.comfy.org/publishers/daxcay/nodes/comfyui-nexus
|
|
|
|
- ### Manual Method
|
|
- Go to your ComfyUI > Custom Nodes folder path > Run CMD
|
|
- Copy and paste this command: `git clone https://github.com/daxcay/ComfyUI-Nexus.git`
|
|
|
|
- ### Automatic Method with [Comfy Manager](https://github.com/ltdrdata/ComfyUI-Manager)
|
|
- Inside ComfyUI > Click the Manager Button on the side.
|
|
- Click `Custom Nodes Manager` and search for `Nexus`, then install this node.
|
|
|
|
<br>
|
|
|
|
>[!IMPORTANT]
|
|
> #### **Restart ComfyUI before proceeding to next step**
|
|
|
|
## Server Setup
|
|
|
|
### Admin Account Setup
|
|
|
|
- Open the file `ComfyUI\nexus\admins.json` in notepad.
|
|
|
|
|
|
|
|
- **"epic"** is the account name and **"comfynexus"** is password
|
|
- Replace account and password with your own liking, but make sure not to use spaces.
|
|
|
|
<br>
|
|
|
|
>[!IMPORTANT]
|
|
>Don't leave the password as "comfynexus" as anyone can login.
|
|
|
|
>[!NOTE]
|
|
>**DO NOT SHARE ACCOUNT AND PASSWORD IN PUBLIC**
|
|
|
|
>[!IMPORTANT]
|
|
> #### Save file and **Restart ComfyUI before proceeding to next step**
|
|
|
|
<br>
|
|
|
|
# Getting Shareable URL
|
|
|
|
- One can use Ngrok or any other tunneling software supporting http/https to Host a Globally.
|
|
- Also you can host locally over WiFi/Lan.
|
|
|
|
### Getting Comfy URL Port
|
|
|
|
Open Comfyui in your browser:
|
|
|
|
|
|
|
|
In your url tab, Last digits after Colon is your port.
|
|
|
|
Example:
|
|
|
|
|
|
|
|
The port for the above URL will be **8188**
|
|
|
|
## Hosting Setup
|
|
|
|
### Ngrok:
|
|
|
|
- Go to this https://dashboard.ngrok.com/signup?ref=home-hero to sign up.
|
|
- After signing up and logging in, go to this https://dashboard.ngrok.com/get-started/setup/windows to set up ngrok.
|
|
- After installing and setting up ngrok,
|
|
- Run CMD and enter this command: `ngrok http <port>`
|
|
|
|
|
|
|
|
|
|
- "Forwarding" is the Remote Url, Share this url with your peers.
|
|
|
|
<br>
|
|
|
|
### Local
|
|
|
|
- Open a cmd and write `ipconfig`.
|
|
|
|
|
|
|
|
- Now copy this address. For example, if it's `http://192.168.1.45:<comfy_port>`, the final URL will be: `http://192.168.1.45:5000`
|
|
|
|
<br>
|
|
|
|
>[!NOTE]
|
|
> **Ngrok and WiFi address will change if you restart the machine. Follow above steps again to get the new URL.**
|
|
|
|
<br>
|
|
|
|
## Permissions in ComfyUI-Nexus
|
|
|
|
- **viewer**: default permission given to a person joining the server.
|
|
- **editor**: person having editor permission cad edit the workflow.
|
|
- **queue prompt**: person having queue permission can queue the workflow.
|
|
<br>
|
|
|
|
>[!NOTE]
|
|
> Admin has all permissions by default.
|
|
|
|
<br>
|
|
|
|
## Real-Time Chat Window
|
|
|
|
When you join ComfyUI for the first time, you will see this chat window in the top left corner:
|
|
|
|
|
|
|
|
To chat, press `t`, then write the message and press 'Enter'.
|
|
|
|
|
|
|
|
### Chat Commands
|
|
|
|
- `/nick <name>`: changes your nickname
|
|
- `/login <account> <password>`: this command is used to become admin. ( account name and password saved in `admins.json` above )
|
|
- `/logout`: logout the admin.
|
|
|
|
<br>
|
|
|
|
## User Panel
|
|
|
|
To show/hide the user panel, press `LAlt + p`.
|
|
|
|
**For users, the user panel will look like this:**
|
|
|
|
|
|
|
|
Users can perform the following actions on a joined user:
|
|
|
|
|
|
|
|
- **mouse**: show/hide the mouse of other players.
|
|
- **spectate**: enable/disable spectate mode. Main use case: when you want to see or learn something from another user.
|
|
|
|
**For admins, the user panel will look like this:**
|
|
|
|
|
|
|
|
Admins can perform the following actions on a joined user:
|
|
|
|
|
|
|
|
- **spectate**: enable/disable spectate mode. Main use case: when you want to see or learn something from another user.
|
|
- **editor**: give/revoke editor permission to/from that user. Anyone with this permission can edit the workflow.
|
|
- **queue**: give/revoke queue permission to/from that user. Anyone with this permission can queue the workflow.
|
|
- **mouse**: show/hide the mouse of other players.
|
|
|
|
<br>
|
|
|
|
## Backup Panel (For Admins and Editors Only)
|
|
|
|
To show/hide the backup panel, press `LAlt + o`.
|
|
|
|
**The backup panel looks like this:**
|
|
|
|
|
|
|
|
- **load**: load the backup on ComfyUI. If the admin presses it, it will load for all users.
|
|
|
|
> Backups are saved 60 seconds apart. To load a workflow dragged by an admin, the admin will have to wait 60 seconds to let the server make a backup, then load it for all users.
|
|
|
|
<br>
|
|
|
|
## Future Updates
|
|
|
|
- Based on feedback, I will add/update features.
|
|
- Multi-room collaboration.
|
|
- Users can set their own color for names and mouse cursors.
|
|
|
|
<br>
|
|
|
|
### Daxton Caylor - ComfyUI Node Developer
|
|
|
|
- ### Contact
|
|
- **Email** - daxtoncaylor+Github@gmail.com
|
|
- **Discord Server**: https://discord.gg/Z44Zjpurjp
|
|
|
|
- ### Support
|
|
- **Patreon**: https://patreon.com/daxtoncaylor
|
|
- **Buy me a coffee**: https://buymeacoffee.com/daxtoncaylor
|
|
|
|
|