From 05b20f5e6eaeb1c190b0b44e1d2aef614af28209 Mon Sep 17 00:00:00 2001
From: daxcay <164315771+daxcay@users.noreply.github.com>
Date: Sat, 24 Aug 2024 23:03:03 +0530
Subject: [PATCH] Update README.md
---
README.md | 88 ++++++++++++++++++++++---------------------------------
1 file changed, 35 insertions(+), 53 deletions(-)
diff --git a/README.md b/README.md
index 4261844..146471e 100644
--- a/README.md
+++ b/README.md
@@ -1,55 +1,50 @@
+
# ComfyUI-Nexus
 
-A ComfyUI node designed to enable seamless multi-user workflow collaboration. This innovative tool allows teams to work together both locally and remotely, making collaboration a breeze.
-
-Install and setup this node on a server PC.
-Get Url, share and use.
-No Need to install comfyui on other PCs.
+A ComfyUI node designed to enable seamless multi-user workflow collaboration.
+This node allows teams to work together both locally and remotely, making collaboration a breeze.
+Install and setup this node on a server PC. Get Url, share and use. No Need to install comfyui on other PCs.
-
**Features Video**: https://www.youtube.com/watch?v=RnYIUG59oTM
-
## 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 an old backup. The node saves 5 workflows, each 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 an old backup. The node saves 5 workflows, each 60 seconds apart.
> Note: When Opening the Comfyui Workspace for the first time, It will be locked, Login as admin to enable editing.
## Key Binds
-- **activate chat**: press **`t`**
-- **show/hide users panel**: press **`LAlt + p`**
-- **show/hide backups panel**: press **`LAlt + o`** (for editors only)
+- **Activate chat**: press **`t`**
+- **Show/hide users panel**: press **`LAlt + p`**
+- **Show/hide backups panel**: press **`LAlt + o`** (for editors only)
## Chat Commands
- `/nick `: changes your nickname
- `/login account password`: this command is used to become admin.
- `/logout`: logout the admin.
-
# Installation
- This Node should be only installed/maintained on the Server Hosting PC.
- **No need** to install this node on Client Side Users.
-- Comfy UI is also **NOT NEEDED** to run this on Client Side Users. Only Url will be shared which will connect with the server to run/view comfy.
+- Comfy UI is also **NOT NEEDED** to run this on Client Side Users.
+- Only URL will be shared which will connect with the server to run/view comfy.
-
-### Using `comfy-cli`
+### Installing Using `comfy-cli`
- `comfy node registry-install ComfyUI-Nexus`
- [Node Registry](https://registry.comfy.org/publishers/daxcay/nodes/comfyui-nexus)
@@ -65,8 +60,7 @@ No Need to install comfyui on other PCs.
- Inside ComfyUI > Click the Manager Button on the side.
- Click `Custom Nodes Manager` and search for `Nexus`, then install this node.
-**Restart ComfyUI to make all the necessary first time file before making admin list**
-
+**Restart ComfyUI before proceeding to next step**
### Setting Admin and Password
@@ -77,7 +71,7 @@ No Need to install comfyui on other PCs.
- Write any and , but make sure not to use spaces.
-- DO NOT SHARE ACCOUNT AND PASSWORD IN PUBLIC.
+- **DO NOT SHARE ACCOUNT AND PASSWORD IN PUBLIC**
@@ -85,24 +79,24 @@ No Need to install comfyui on other PCs.
# Getting Shareable URL
-Use Ngrok or any other tunneling software supporting http/https to Host a Global Server. Also you can host locally over wifi/lan.
+- 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
-### Getting 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**
+The port for the above URL will be **8188**
-
-## Method 1) Remote Access - To Obtain Global Shareable Link
+## Method 1) To setup global remote access to server
### Ngrok Setup:
@@ -111,36 +105,32 @@ The port for the above url will be **8188**
- After installing and setting up ngrok,
- Run CMD and enter this command: `ngrok http `
- 
- 
+ 
+ 
+
- "Forwarding" is the Remote Url, Share this url with your peers.
+## Method 2) To setup local access to server
-## Method 2) Local Wifi/Lan Url:
-
-### Using Your IP Address to Host Server
+### Using Your Local IP Address to Host Server
- Open a cmd and write `ipconfig`.
- 
-
+ 
- Now copy this address. For example, if it's `http://192.168.1.45:`, the final URL will be: `http://192.168.1.45:5000`
-
-> Ngrok and WiFi address will change if you restart the machine. Follow above steps again to get the new url.
-
+> Ngrok and WiFi address will change if you restart the machine.
+> Follow above steps again to get the new URL.
## Permissions in ComfyUI-Nexus
- **viewer**: default permission given to a person joining.
- **editor**: person having permission to edit the workflow.
- **queue prompt**: person having permission to queue the workflow.
-
> Admin has all permissions by default.
-
## Real-Time Chat Window
@@ -151,14 +141,12 @@ When you join ComfyUI for the first time, you will see this chat window in the t
To chat, press `t`, then write the message and press 'Enter'.
-
### Chat Commands
- `/nick `: changes your nickname
- `/login `: this command is used to become admin.
- `/logout`: logout the admin.
-
## User Panel
@@ -175,7 +163,6 @@ 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:**
@@ -189,9 +176,6 @@ Admins can perform the following actions on a joined user:
- **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.
-
-
-
## Backup Panel (For Admins and Editors Only)
To show/hide the backup panel, press `LAlt + o`.
@@ -203,16 +187,13 @@ To show/hide the backup panel, press `LAlt + o`.
- **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.
-
## Future Updates
- Based on feedback, I will add/update features.
- Multi-room collaboration.
- Users can set their own color for names and mouse cursors.
-
-
-
+
### Daxton Caylor - ComfyUI Node Developer
@@ -224,3 +205,4 @@ To show/hide the backup panel, press `LAlt + o`.
- **Patreon**: https://patreon.com/daxtoncaylor
- **Buy me a coffee**: https://buymeacoffee.com/daxtoncaylor
+