Edouard Durand
69ad03e237
Runs are timed from ComfyUI's execution events and kept in runs.json (last 500), so ETAs survive restarts and a workflow's timings can be cleared. The Server tab shows the last 5 runs and a History window; the floating card is a bigger timer with a clear button, docked to the left of the Server card.
75 lines
2.9 KiB
Markdown
75 lines
2.9 KiB
Markdown
# Installing
|
|
|
|
## As a custom node
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
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:
|
|
|
|
```yaml
|
|
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](settings.md) |
|
|
| `folders.json` | Shared folders: owners and access lists |
|
|
| `rooms/` | Latest live state of each workflow |
|
|
| `snapshots/` | Workflow history |
|
|
| `chat.jsonl` | The whole chat history, one message per line |
|
|
| `runs.json` | Timings of the last 500 runs (Performance) |
|
|
|
|
Back up the folder to keep accounts and history. Deleting `secret.key` signs everyone out.
|
|
|
|
## Upgrading from RigShare 1.0
|
|
|
|
Update the folder (`git pull`, or ComfyUI Manager) and restart ComfyUI. Then:
|
|
|
|
- Workflows already at the top level become *common*: everyone can open them, and they are live while open. Move personal ones into each person's **My files**, and group shared ones in **Shared** folders. Admins can do this for everyone from **Files → All**.
|
|
- Access lists set on individual workflows are dropped. Restrict a shared folder instead.
|
|
- The chat history moves from `chat.json` to `chat.jsonl` on the first start, with nothing lost. From then on, all of it is kept.
|
|
|
|
## 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.
|