118 lines
4.5 KiB
Markdown
118 lines
4.5 KiB
Markdown
|
|
|
|
# ComfyUI-Nexus
|
|
|
|
 
|
|
|
|
A ComfyUI node designed to enable seamless multiuser workflow collaboration. This innovative tool allows teams to work together both locally and remotely, making collaboration a breeze.
|
|
|
|
### Key Features:
|
|
|
|
- **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 a old backup. the node save 5 workflow 60 seconds apart.
|
|
<br>
|
|
|
|
### Key Binds:
|
|
|
|
- **Activate Chat**: press **`t`**
|
|
- **Show/Hide Users** press **`LAlt + p`**
|
|
- **Show/Hide Backups** press **`LAlt + o`** (for editors only)
|
|
|
|
<br>
|
|
|
|
## Installation
|
|
|
|
#### Using `comfy-cli` (https://github.com/yoland68/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```
|
|
- Then go inside ComfyUI-Nexus with cmd or open new.
|
|
- type ```pip install -r requirements.txt``` to install the dependencies
|
|
|
|
#### Automatic Method with [Comfy Manager](https://github.com/ltdrdata/ComfyUI-Manager)
|
|
- Inside ComfyUI > Click Manager Button on Side.
|
|
- Click `Custom Nodes Manager` and Search for `Nexus` and Install this node:
|
|
|
|
#### Restart ComfyUI and it should be good to go
|
|
|
|
<br>
|
|
|
|
## One Time Setup
|
|
|
|
> **Note**: Only for someone hosting the comfy server.
|
|
|
|
<br>
|
|
|
|
### Setting admin password
|
|
- Go to comfyui folder > **nexus** folder > admins.json
|
|
|
|
|
|
|
|
- Write any account name and password but make sure to not have spaces.
|
|
|
|
|
|
|
|
|
|
#### Restart ComfyUI and it should be good to go
|
|
<br>
|
|
|
|
### Using Ngrok to host server
|
|
|
|
- Go to this link: https://dashboard.ngrok.com/signup?ref=home-hero
|
|
- After signup and login go to this link: https://dashboard.ngrok.com/get-started/setup/windows
|
|
- After installing and setup of ngrok just run this command: `ngrok http <your_comfy_url_port>`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- Share this with your brother or friends in colloboration.
|
|
- I will attach a setup video soon.
|
|
<br>
|
|
|
|
### Using your ip address to host server
|
|
|
|
- Open a cmd and write `ipconfig`
|
|
|
|
|
|
|
|
- Now copy this address like in my case its `http://192.168.1.45:<comfy_port>` so final url will be: `http://192.168.1.45:5000`
|
|
- Share this with your brother or friends in colloboration.
|
|
|
|
#### Ngrok and WiFi address will change if you restart the machine or application itself.
|
|
|
|
<br>
|
|
|
|
## Real time chat window
|
|
|
|
When you join the comfy for the first time you will see this chat windows on to left corner like this.
|
|
|
|
|
|
|
|
To chat you have to press `t`. then you write the message and press 'Enter'.
|
|
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
## Permissions in ComfyUI-Nexus
|
|
|
|
- **Viewer**: Default permission given to person joining.
|
|
- **Editor**: Person having permission to edit the workflow
|
|
- **Queue Prompt**: Person having permission to queue the workflow
|
|
|
|
|
|
|