-
Notifications
You must be signed in to change notification settings - Fork 187
docs: add Workspaces documentation across Cloud, Interface, and Subscription pages #1001
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| --- | ||
| title: "Workspaces" | ||
| description: "Learn how to use workspaces in Comfy Cloud to collaborate with your team members" | ||
| sidebarTitle: "Workspaces" | ||
| icon: "users" | ||
| --- | ||
|
|
||
| import CloudFeature from '/snippets/cloud-feature.mdx' | ||
|
|
||
| <CloudFeature/> | ||
|
|
||
| <Note> | ||
| Workspaces are enabled by a server-side feature flag and may not be available to all Comfy Cloud users yet. If you do not see workspace features in your interface, they may not be enabled for your account yet. | ||
| </Note> | ||
|
|
||
| ## Overview | ||
|
|
||
| Workspaces in Comfy Cloud allow you to organize your work and collaborate with team members. Each user has a **Personal** workspace for individual use and can create or join **Team** workspaces to share Comfy Cloud resources with others. | ||
|
|
||
| ## Workspace types | ||
|
|
||
| There are two types of workspaces: | ||
|
|
||
| | Type | Description | | ||
| |------|-------------| | ||
| | **Personal** | Your private workspace. Automatically created for every user. Cannot be deleted. | | ||
| | **Team** | A shared workspace where you can invite members and collaborate. Created by users with a plan that supports multiple seats. | | ||
|
|
||
| ## Personal workspace | ||
|
|
||
| Your Personal workspace is your default workspace when you first use Comfy Cloud. It is a single-user space. Only you have access to it. You cannot invite others to your Personal workspace or leave it. | ||
|
|
||
| ## Team workspaces | ||
|
|
||
| Team workspaces let you work together with other Comfy Cloud users. Members of a team workspace share the workspace's subscription plan, credits, and billing. | ||
|
|
||
| ### Creating a team workspace | ||
|
|
||
| To create a new team workspace: | ||
|
|
||
| <Steps> | ||
| <Step title="Open workspace switcher"> | ||
| Click your workspace avatar or name in the top navigation bar to open the workspace switcher popover. | ||
| </Step> | ||
| <Step title="Create workspace"> | ||
| Click **Create workspace** at the bottom of the popover. Alternatively, navigate to the workspace settings panel and create one from there. | ||
| </Step> | ||
| <Step title="Name your workspace"> | ||
| Enter a workspace name (1-50 characters) and click **Create**. The name must start with a letter or number and can contain letters, numbers, spaces, and common punctuation (`- _ ' . , ( ) & +`). | ||
| </Step> | ||
| <Step title="Switch automatically"> | ||
| After creation, you will be automatically switched to the new workspace. | ||
| </Step> | ||
| </Steps> | ||
|
|
||
| <Note> | ||
| Each user can own up to **10 team workspaces**. You can be a member of additional workspaces owned by other users. | ||
| </Note> | ||
|
|
||
| ### Workspace roles | ||
|
|
||
| Each member of a team workspace has one of the following roles: | ||
|
|
||
| | Role | Permissions | | ||
| |------|-------------| | ||
| | **Owner** | Full control: manage members, invite/revoke invites, rename workspace, delete workspace, manage subscription, top up credits | | ||
| | **Member** | View other members, leave workspace. Cannot invite others, manage billing, or delete the workspace | | ||
|
|
||
| ### Managing members | ||
|
|
||
| As an owner of a team workspace, you can: | ||
|
|
||
| - **Invite members** by email. An invite link is generated and sent to the recipient. | ||
| - **Remove members** from the workspace | ||
| - **Revoke pending invites** that haven't been accepted yet | ||
|
|
||
| To access member management: | ||
|
|
||
| 1. Open the workspace settings panel (click your workspace avatar, then workspace name) | ||
| 2. Go to the **Members** tab | ||
| 3. Click the **+** button to invite a new member | ||
|
|
||
| #### Invite members | ||
|
|
||
| When you invite a member: | ||
|
|
||
| 1. Enter the recipient's email address | ||
| 2. A unique invite link is generated | ||
| 3. Share the invite link with the recipient | ||
| 4. The recipient accepts the invite by visiting the link (they must have or create a Comfy Cloud account) | ||
|
|
||
| <Note> | ||
| Invites have an expiration date. Pending invites show their expiry time in the members panel. You can revoke invites that haven't been accepted yet. | ||
| </Note> | ||
|
|
||
| #### Invite limits | ||
|
|
||
| - Each team workspace is limited to **30 members** including pending invitations | ||
| - If you're on a single-seat plan, you'll be prompted to upgrade before you can invite members | ||
|
|
||
| ### Workspace settings | ||
|
|
||
| As an owner, you can: | ||
|
|
||
| - **Rename** the workspace from the workspace menu | ||
| - **Delete** the workspace (not available if the workspace has an active subscription. Cancel the subscription first.) | ||
|
|
||
| As a member, you can: | ||
|
|
||
| - **Leave** the workspace from the workspace menu | ||
|
|
||
| ### Switching between workspaces | ||
|
|
||
| To switch between your workspaces: | ||
|
|
||
| 1. Click your workspace avatar or name in the top navigation bar | ||
| 2. Select the workspace you want to switch to from the list | ||
| 3. The page will reload and switch to the selected workspace | ||
|
|
||
| Your last active workspace is remembered across browser sessions. | ||
|
|
||
| ### Billing and subscription | ||
|
|
||
| Each workspace has its own billing and subscription: | ||
|
|
||
| - **Personal workspaces** use your personal subscription | ||
| - **Team workspaces** can have their own subscription plan | ||
| - As an owner, you can manage the workspace subscription, top up credits, and view billing status from the **Plan & Credits** tab in workspace settings | ||
| - Workspace members share the workspace's credits and resources | ||
|
|
||
| ## URL shortcuts | ||
|
|
||
| You can use URL parameters to access workspace features directly: | ||
|
|
||
| | URL | Action | | ||
| |-----|--------| | ||
| | `?create_workspace=1` | Opens the create workspace dialog | | ||
| | `?invite=TOKEN` | Accepts a workspace invite | | ||
|
|
||
| ## FAQ | ||
|
|
||
| ### Can I have multiple team workspaces? | ||
| Yes, you can own up to 10 team workspaces and be a member of additional workspaces owned by others. | ||
|
|
||
| ### Can I delete my Personal workspace? | ||
| No. Your Personal workspace is permanent and cannot be deleted. It serves as your default workspace. | ||
|
|
||
| ### What happens when I leave a team workspace? | ||
| The workspace will no longer appear in your workspace list. You'll lose access to the workspace's workflows and resources. | ||
|
|
||
| ### Can a workspace be recovered after deletion? | ||
| No. Deleting a workspace is permanent. You must cancel any active subscriptions before deleting a workspace. | ||
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -31,6 +31,10 @@ ComfyUI Cloud is the cloud version of ComfyUI with the same features as the loca | |||||||||||||
| <Card title="Access anywhere" icon="globe"> | ||||||||||||||
| Use ComfyUI from any device with an internet connection - no local installation needed | ||||||||||||||
| </Card> | ||||||||||||||
|
|
||||||||||||||
| <Card title="Team collaboration" icon="users"> | ||||||||||||||
| Create team workspaces to collaborate with your team members. Share subscription plans, credits, and workflows | ||||||||||||||
| </Card> | ||||||||||||||
|
Comment on lines
+35
to
+37
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win Describe the subscription as workspace-scoped. “Share subscription plans” can imply that members pool or share multiple plans. The workspace guide and Suggested wording- Create team workspaces to collaborate with your team members. Share subscription plans, credits, and workflows
+ Create team workspaces to collaborate with your team members. Use a shared workspace subscription, credits, and workflows📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||
| </CardGroup> | ||||||||||||||
|
|
||||||||||||||
| ## Cloud vs local | ||||||||||||||
|
|
@@ -45,7 +49,7 @@ ComfyUI offers both an official cloud version, [Comfy Cloud](https://comfy.org/c | |||||||||||||
| | **Technical Knowledge** | No technical knowledge required. | While desktop and portable give you easy ways to get started, you'll need to troubleshoot custom node installations and local installation issues. | | ||||||||||||||
| | **Custom Nodes** | Use pre-installed custom nodes and never worry about compatibility issues. | Install any custom node you want, but you'll need to manage it yourself. | | ||||||||||||||
| | **Models** | Use pre-installed models. Import LoRA models from Civitai. Import models from Hugging Face (coming soon). | Use any models you want, but you'll need to download them first. | | ||||||||||||||
| | **Notable Differences** | Easy to onboard your team | Works offline, infinitely customizable | | ||||||||||||||
| | **Notable Differences** | Easy to onboard your team with [Workspaces](/cloud/workspace) | Works offline, infinitely customizable | | ||||||||||||||
| | **Get started** | [Run ComfyUI Cloud](https://comfy.org/cloud) | [Install ComfyUI locally](/installation/system_requirements) | | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
|
|
@@ -55,6 +59,10 @@ ComfyUI offers both an official cloud version, [Comfy Cloud](https://comfy.org/c | |||||||||||||
| View pricing and subscription options for Comfy Cloud | ||||||||||||||
| </Card> | ||||||||||||||
|
|
||||||||||||||
| <Card title="Workspaces" icon="users" href="/cloud/workspace"> | ||||||||||||||
| Learn about Workspaces in Comfy Cloud: create team workspaces, manage members, and collaborate | ||||||||||||||
| </Card> | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
| ## How to use ComfyUI Cloud | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -17,3 +17,23 @@ To manage your Comfy Cloud subscription: | |||||||||||||||||||||||||
| 4. Click **Manage subscription** | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| This will take you to Stripe, where you can manage your subscription details. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| <Note> | ||||||||||||||||||||||||||
| The subscription management above applies to **Personal workspaces**. For Team workspaces, subscription management is done from the workspace settings panel. Only the workspace **Owner** can manage the subscription. See [Workspaces](/cloud/workspace) for more details. | ||||||||||||||||||||||||||
| </Note> | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Personal vs Team workspace subscriptions | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| Comfy Cloud subscriptions are tied to **workspaces**, not to individual user accounts: | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| | Aspect | Personal Workspace | Team Workspace | | ||||||||||||||||||||||||||
| |-------|-------------------|----------------| | ||||||||||||||||||||||||||
| | **Subscription owner** | You (the user) | Workspace Owner | | ||||||||||||||||||||||||||
| | **Credits** | Your personal credits | Shared across all members | | ||||||||||||||||||||||||||
| | **Multi-seat** | Single seat | Multiple seats (plan-dependent) | | ||||||||||||||||||||||||||
| | **Switching** | Switch to any team workspace | Switch back to personal anytime | | ||||||||||||||||||||||||||
|
Comment on lines
+29
to
+34
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win Limit switching to accessible workspaces. The workspace guide says users select from their own workspace list. “Switch to any team workspace” could incorrectly imply access to arbitrary team workspaces. Suggested wording-| **Switching** | Switch to any team workspace | Switch back to personal anytime |
+| **Switching** | Switch to any accessible team workspace | Switch back to Personal anytime |📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| - Your **Personal workspace** uses your personal subscription. Credits and seats are for your sole use. | ||||||||||||||||||||||||||
| - **Team workspaces** have their own subscription managed by the workspace Owner. Credits are shared among all members. | ||||||||||||||||||||||||||
| - When you switch to a team workspace, the workspace's credits and billing apply. | ||||||||||||||||||||||||||
| - Switching back to your Personal workspace restores your personal subscription context. | ||||||||||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Make the invitation flow consistent.
The page says the invite link is “sent to the recipient,” but the steps below require the owner to share it manually. Clarify whether Comfy Cloud emails the invite or only generates the link.
🧰 Tools
🪛 LanguageTool
[style] ~73-~73: The noun “invitation” is usually used instead of ‘invite’ in formal writing.
Context: ...can: - Invite members by email. An invite link is generated and sent to the recip...
(AN_INVITE)
🤖 Prompt for AI Agents