Doudou
d7b96ecd4d
Multi-user collaboration for the current ComfyUI frontend, continued from ComfyUI-Nexus by daxcay (MIT). - Login page before ComfyUI loads, first-run admin setup, JWT sessions - Personal API keys; server-side permission checks (edit, queue, manager, admin) - Every workflow shared as a live room, with snapshots and history - Per-workflow access lists (view / edit per person) - Conflict-free concurrent edits (id remapping, per-id link merges) - Presence: who is online, cursors, selections, follow mode - Chat with unread badge, blinking icon and sound - Server monitor (CPU, RAM, GPUs, queue) with a floating widget - Admin options to hide the Comfy.org login and API templates - Docs, changelog, screenshots and icon
120 lines
6.8 KiB
Markdown
120 lines
6.8 KiB
Markdown
<div align="center">
|
|
|
|
<img src="web/rigshare/assets/icon.svg" width="96" alt="RigShare icon">
|
|
|
|
# ComfyUI RigShare
|
|
|
|
> One ComfyUI rig, a whole team: accounts, live co-editing of every workflow, chat and a GPU monitor
|
|
|
|
[](https://github.com/xiaodoudou/ComfyUI-RigShare/releases/latest) [](https://github.com/xiaodoudou/ComfyUI-RigShare/stargazers) [](LICENSE) [](docs/install.md) [](docs/install.md) [](docs/install.md) [](docs/security.md)
|
|
|
|
A custom node that turns a single ComfyUI server into a shared workspace. Everyone signs in, opens any workflow, and edits it together in real time while seeing each other's cursors. Fork of
|
|
[daxcay/ComfyUI-Nexus](https://github.com/daxcay/ComfyUI-Nexus), rewritten for the current ComfyUI frontend.
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
## What it does
|
|
|
|
- asks everyone to sign in before ComfyUI loads, and creates the admin account on first run
|
|
- shares every workflow: people who open the same saved file edit it together, and unsaved tabs join as soon as you edit them
|
|
- lets you switch tabs freely, because only the tab on screen syncs
|
|
- shows who is online and which workflow they are on, plus live cursors and selections
|
|
- lets you follow someone, jumping to their tab and view
|
|
- keeps a chat with an unread badge, a blinking icon and a sound
|
|
- keeps per-workflow history: snapshots every few minutes, named snapshots, one-click restore
|
|
- gives each account permissions to edit, queue, use ComfyUI Manager or administer, enforced by the server and not just hidden in the UI
|
|
- lets you restrict a workflow to chosen people, each able to view or edit
|
|
- keeps simultaneous edits apart: two people adding or connecting nodes at the same moment both keep their work
|
|
- issues personal API keys, so scripts and other apps can call ComfyUI with their owner's permissions
|
|
- shows CPU, RAM, and for each GPU the load, VRAM, temperature and power, plus the queue, in a panel tab or a floating widget
|
|
- sends execution progress and previews to everyone, not only whoever queued
|
|
|
|
What this fork adds over Nexus:
|
|
|
|
- **Built for the new frontend.** It lives in a sidebar tab and works with workflow tabs and subgraphs. It needs no legacy menu and no litegraph patching.
|
|
- **Real accounts.** A login page, hashed passwords, JWT sessions and API keys replace the shared `/login account password` chat command and the plaintext `admins.json`.
|
|
- **The server is in charge.** It checks permissions and identity on every message, so a browser cannot impersonate someone or edit without the right to.
|
|
- **Every workflow is shared**, not a single canvas that everybody fights over.
|
|
|
|
## Screenshots
|
|
|
|
<table>
|
|
<tr>
|
|
<td align="center"><img src="docs/images/history.png" width="260" alt="Workflows tab: this tab, history and shared workflows"><br><sub>Shared workflows and history</sub></td>
|
|
<td align="center"><img src="docs/images/people.png" width="260" alt="People tab"><br><sub>Who is online, and on which workflow</sub></td>
|
|
<td align="center"><img src="docs/images/chat.png" width="260" alt="Chat tab"><br><sub>Chat</sub></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><img src="docs/images/server.png" width="260" alt="Server tab"><br><sub>Server monitor</sub></td>
|
|
<td align="center"><img src="docs/images/account.png" width="260" alt="Account and API keys"><br><sub>Account and API keys</sub></td>
|
|
<td align="center"><img src="docs/images/admin.png" width="260" alt="Admin tab"><br><sub>Accounts and server settings</sub></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><img src="docs/images/access.png" width="260" alt="Access list of a workflow"><br><sub>Who can open a workflow</sub></td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p align="center">
|
|
<img src="docs/images/floating.png" width="820" alt="Floating server monitor over the canvas"><br><sub>Floating server monitor</sub>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<img src="docs/images/login.png" width="560" alt="Login page"><br><sub>Login page</sub>
|
|
</p>
|
|
|
|
## Getting started
|
|
|
|
Clone into `ComfyUI/custom_nodes` and restart ComfyUI:
|
|
|
|
```bash
|
|
cd ComfyUI/custom_nodes
|
|
git clone https://github.com/xiaodoudou/ComfyUI-RigShare.git
|
|
```
|
|
|
|
Open ComfyUI in a browser. There are no accounts yet, so the login page asks you to create the administrator. Sign in, open the **RigShare** tab in the sidebar and add your team under **Admin → Accounts**. That is the whole setup.
|
|
|
|
Everyone then signs in at the same address. To use the API from a script, create a key under your avatar → **API keys**:
|
|
|
|
```bash
|
|
curl -H "Authorization: Bearer rs_yourkey" http://your-server:8188/api/queue
|
|
```
|
|
|
|
Behind a reverse proxy, turn on WebSocket support, or nothing will be live. See [Reverse proxy](docs/reverse-proxy.md).
|
|
|
|
## Documentation
|
|
|
|
| | |
|
|
|---|---|
|
|
| [Installing](docs/install.md) | Custom node, Docker/compose, first-run setup, upgrading from Nexus |
|
|
| [Sharing workflows](docs/sharing.md) | Rooms, saved vs unsaved tabs, stop sharing, snapshots, follow |
|
|
| [Accounts and permissions](docs/accounts.md) | Edit, Queue, Admin, renaming, what viewers can do |
|
|
| [API access](docs/api.md) | API keys, websockets, trusted IPs, other apps such as Open WebUI |
|
|
| [Settings](docs/settings.md) | Panel settings, ComfyUI settings, every key in `config.json` |
|
|
| [Reverse proxy](docs/reverse-proxy.md) | Nginx Proxy Manager, plain nginx, HTTPS |
|
|
| [Security](docs/security.md) | How passwords, sessions and keys are protected |
|
|
| [Changelog](CHANGELOG.md) | What changed, and when |
|
|
|
|
## Why this exists
|
|
|
|
I run one ComfyUI box for several people. [ComfyUI-Nexus](https://github.com/daxcay/ComfyUI-Nexus) had the right idea, but it was written for the old UI:
|
|
|
|
- it hid menus with CSS and monkeypatched litegraph internals that no longer exist
|
|
- anyone could become admin with a shared password typed into chat
|
|
- everybody worked on one canvas, and opening ComfyUI wiped your own workflow
|
|
|
|
## TODO
|
|
|
|
- [x] Login page, JWT sessions, first-run admin setup
|
|
- [x] Per-user API keys
|
|
- [x] Every workflow shared, per-workflow snapshots
|
|
- [x] Cursors, selections, follow mode
|
|
- [x] Chat with badge, blink and sound
|
|
- [x] Server monitor with floating widget
|
|
- [x] Conflict-free node ids when two people add nodes at the same instant
|
|
- [x] Per-workflow access lists (share with specific people)
|
|
- [ ] Publish to the Comfy registry
|