Update README.md

This commit is contained in:
daxcay
2024-08-24 11:16:00 +05:30
committed by GitHub
parent ca50f2d6a1
commit a7b8d3a283
+48 -19
View File
@@ -8,13 +8,21 @@ A ComfyUI node designed to enable seamless multiuser workflow collaboration. Thi
### 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**: I case of mishap you can reload a old backup. the node save 5 workflow 60 seconds apart.
- **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
@@ -37,52 +45,73 @@ A ComfyUI node designed to enable seamless multiuser workflow collaboration. Thi
<br>
## First Time Setup
## One Time Setup
> **Note**: Only for someone hosting the comfy server.
#### Setting admin password
<br>
### Setting admin password
- Go to comfyui folder > **nexus** folder > admins.json
![Account(no spaces)](https://github.com/user-attachments/assets/0159397d-bf1e-436e-a822-b02ca4dec3b1)
![Account(no spaces)](https://github.com/user-attachments/assets/0159397d-bf1e-436e-a822-b02ca4dec3b1)
- Write any account name and password but make sure to not have spaces.
![image](https://github.com/user-attachments/assets/7ef767b0-ffa0-4bde-8e87-8ab3fc2ba535)
#### Restart ComfyUI and it should be good to go
<br>
### Using Ngrok to host server
#### 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>`
![image](https://github.com/user-attachments/assets/c3b33d6c-5be5-4200-b9e3-df433b420e34)
![image](https://github.com/user-attachments/assets/c3b33d6c-5be5-4200-b9e3-df433b420e34)
![image](https://github.com/user-attachments/assets/66f9b4a4-1d63-4756-8d57-64420fdc151a)
![image](https://github.com/user-attachments/assets/66f9b4a4-1d63-4756-8d57-64420fdc151a)
![image](https://github.com/user-attachments/assets/075613e2-d3f0-4a9d-b844-dc06f3c4adf3)
![image](https://github.com/user-attachments/assets/075613e2-d3f0-4a9d-b844-dc06f3c4adf3)
- Share this with your brother or friends in colloboration.
- I will attach a setup video soon.
<br>
#### Using your local ip address
### Using your ip address to host server
- Open a cmd and write `ipconfig`
![image](https://github.com/user-attachments/assets/043f2d9b-eccd-46cb-a333-ec483222b6d4)
![image](https://github.com/user-attachments/assets/043f2d9b-eccd-46cb-a333-ec483222b6d4)
- 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.
![image](https://github.com/user-attachments/assets/9d8be82d-1e76-46e1-b902-ba8248ccbb26)
To chat you have to press `t`. then you write the message and press 'Enter'.
![Account(no spaces) (1)](https://github.com/user-attachments/assets/6b908ade-cd01-43d4-831c-6af2c6c461cf)
<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
## Chat Window