Files
xiaodoudou-ComfyUI-RigShare/docs/install.md
T
Doudou d7b96ecd4d ComfyUI RigShare 1.0.0
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
2026-09-25 13:24:09 +00:00

2.2 KiB

Installing

As a custom node

cd ComfyUI/custom_nodes
git clone https://github.com/xiaodoudou/ComfyUI-RigShare.git

Restart ComfyUI. The console prints:

[RigShare] No accounts yet: open ComfyUI in a browser to create the admin account.
[RigShare] ready, data in /path/to/ComfyUI/rigshare

First run

Open ComfyUI in a browser. While no account exists, the login page shows Create admin account. Pick a username and a password of at least 8 characters, and you are signed in as the administrator. The server accepts this only while there are no accounts, so once the first admin exists, the form is gone for good.

Do this right after installing. Until an admin exists, whoever reaches the page first gets to create one.

For scripted installs you can skip the form by setting these before the first start:

RIGSHARE_ADMIN_USER=admin
RIGSHARE_ADMIN_PASSWORD=a-long-password

They are only read when there are no accounts, so remove them afterwards.

Docker / compose

Mount the node and a data folder:

services:
  comfyui:
    volumes:
      - ./custom_nodes/ComfyUI-RigShare:/app/custom_nodes/ComfyUI-RigShare
      - ./rigshare:/app/rigshare

The data folder is <ComfyUI base path>/rigshare; point it elsewhere with RIGSHARE_DATA_DIR. It holds:

File What it is
users.json Accounts: password hashes, permissions, API key hashes
sessions.json Active logins (session ids, not tokens)
secret.key Key that signs session tokens. Keep it private
config.json Server settings, see Settings
rooms/ Current state of every shared workflow
snapshots/ Workflow history
chat.json Recent chat

Back up the folder to keep accounts and history. Deleting secret.key signs everyone out.

Upgrading from ComfyUI-Nexus

Remove or disable custom_nodes/ComfyUI-Nexus and install RigShare. Nexus kept plaintext passwords in nexus/admins.json, so nothing is imported: create the admin on first run, then delete the old nexus folder.

Removing

Delete custom_nodes/ComfyUI-RigShare and restart. ComfyUI goes back to having no login. The rigshare data folder can be deleted too.