Skip to content

Commit 77a913d

Browse files
mintlify[bot]comfyui-wiki
mintlify[bot]
and
comfyui-wiki
authored
Add Account Management Documentation Section (#552)
* Update account/create-account.mdx * Update account/login.mdx * Update account/delete-account.mdx * Update docs.json * Update docs.json * Update zh-CN/account/create-account.mdx * Update zh-CN/account/login.mdx * Update zh-CN/account/delete-account.mdx * Update docs.json * Update account/create-account.mdx * Update account/login.mdx * Update zh-CN/account/create-account.mdx * Update zh-CN/account/login.mdx * Update account/create-account.mdx * Update account/login.mdx * Update zh-CN/account/create-account.mdx * Update zh-CN/account/login.mdx * Update account/create-account.mdx * Update account/login.mdx * Update zh-CN/account/create-account.mdx * Update zh-CN/account/login.mdx * Update account/create-account.mdx * Update account/login.mdx * Update zh-CN/account/create-account.mdx * Update zh-CN/account/login.mdx * Update account/create-account.mdx * Update account/login.mdx * Update zh-CN/account/create-account.mdx * Update zh-CN/account/login.mdx * Update account/login.mdx * Update interface/user.mdx * Update zh-CN/account/login.mdx * Update zh-CN/interface/user.mdx * Update account/login.mdx * Update zh-CN/account/login.mdx * Update zh-CN/account/login.mdx * Update image * Update account/delete-account.mdx * Update zh-CN/account/delete-account.mdx * Update account/delete-account.mdx * Update zh-CN/account/delete-account.mdx * Update account/login.mdx * Update account/delete-account.mdx * Update zh-CN/account/delete-account.mdx * Update account/create-account.mdx * Update account/login.mdx * Update account/delete-account.mdx * Update zh-CN/account/create-account.mdx * Update zh-CN/account/login.mdx * Update zh-CN/account/delete-account.mdx * Update account/create-account.mdx * Update account/create-account.mdx * Update account/create-account.mdx * Update account/login.mdx * Update account/login.mdx * Update account/delete-account.mdx * Update account/delete-account.mdx * Update zh-CN/account/create-account.mdx * Update zh-CN/account/create-account.mdx * Update zh-CN/account/create-account.mdx * Update zh-CN/account/login.mdx * Update zh-CN/account/login.mdx * Update zh-CN/account/delete-account.mdx * Update zh-CN/account/delete-account.mdx * fix link --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: ComfyUI Wiki <[email protected]>
1 parent 3c772eb commit 77a913d

File tree

10 files changed

+500
-135
lines changed

10 files changed

+500
-135
lines changed

‎account/create-account.mdx‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: Create a Comfy account
3+
sidebarTitle: Create account
4+
description: Learn how to create a new Comfy account for ComfyUI to access all features and services.
5+
---
6+
7+
Your Comfy account gives you access to [partner nodes (API node)](/tutorials/partner-nodes/overview) and [cloud subscriptions](https://www.comfy.org/cloud), enabling you to use premium features and services across the ComfyUI platform.
8+
9+
## Creating a Comfy account on Comfy Cloud
10+
11+
You can create a Comfy account for ComfyUI directly on Comfy Cloud:
12+
13+
1. Navigate to [Comfy Cloud](https://www.comfy.org)
14+
2. Click **Sign up** or **Create account**
15+
3. Choose one of the following login methods:
16+
- **Email**: Enter your email address and create a password
17+
- **Google**: Sign up with your Google account
18+
- **GitHub**: Sign up with your GitHub account
19+
4. Complete the registration process
20+
5. Verify your email if using email registration
21+
22+
## Creating a Comfy account locally
23+
24+
If you have ComfyUI installed locally, you can create a Comfy account through the application:
25+
26+
1. Open ComfyUI on your local machine
27+
2. Navigate to **Settings** in the interface
28+
3. Go to the **User** section (see [User settings](/interface/user) for details)
29+
4. Click **Create account** or **Sign up**
30+
5. Choose one of the following login methods:
31+
- **Email**: Enter your email address and create a password
32+
- **Google**: Sign up with your Google account
33+
- **GitHub**: Sign up with your GitHub account
34+
6. Complete the registration process
35+
36+
![User settings interface](/images/interface/setting/user.jpg)
37+
38+
## Next steps
39+
40+
Once your account is created and verified:
41+
- [Log in to your account](/account/login)
42+
- Set up your profile preferences
43+
- Start using ComfyUI features
44+
- Explore tutorials and documentation
45+
46+
## Troubleshooting
47+
48+
If you encounter issues during account creation:
49+
- Ensure your email address is valid and not already registered
50+
- Check that your password meets the minimum requirements
51+
- Clear your browser cache and try again
52+
- Contact [support](/support/contact-support) if problems persist

‎account/delete-account.mdx‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Delete your Comfy account
3+
sidebarTitle: Delete account
4+
description: Learn how to permanently delete your Comfy account for ComfyUI and associated data.
5+
---
6+
7+
<Warning>
8+
Account deletion is permanent and cannot be undone. All your data, workflows, and settings will be permanently removed.
9+
</Warning>
10+
11+
## Before you delete
12+
13+
Before proceeding with account deletion, consider:
14+
15+
- **Backup your data**: For Comfy Cloud users, your assets are stored under your account, so back up any data you want to keep. If you don't use Comfy Cloud, your API usage can be found at https://platform.comfy.org/
16+
- **Cancel subscriptions**: Ensure all active subscriptions are cancelled to avoid future charges
17+
- **Download invoices**: Save copies of any payment history or invoices you may need
18+
- **Alternative options**: Consider deactivating your account temporarily instead of permanent deletion
19+
20+
## Deleting your Comfy account
21+
22+
To permanently delete your Comfy account for ComfyUI:
23+
24+
1. Log in to your account
25+
2. Navigate to **Settings** > **Account**
26+
27+
<Frame>
28+
<img src="/images/interface/setting/menu-user-logged.jpg" alt="Account settings menu showing delete account option" />
29+
</Frame>
30+
31+
3. Scroll to the bottom of the page
32+
4. Click **Delete account**
33+
5. Read the warning message carefully
34+
6. Enter your password to confirm
35+
7. Type "DELETE" in the confirmation field
36+
8. Click **Permanently delete my account**
37+
38+
## What gets deleted
39+
40+
When you delete your account, the following data is permanently removed:
41+
42+
- Your user profile and account information
43+
- All saved workflows and projects
44+
- Generated images and outputs
45+
- Custom settings and preferences
46+
- Payment history and billing information
47+
- API keys and access tokens

‎account/login.mdx‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
---
2+
title: Log in to your Comfy account
3+
sidebarTitle: Login
4+
description: Access your Comfy account for ComfyUI to use all platform features and services.
5+
---
6+
7+
Your Comfy account gives you access to [partner nodes (API node)](/tutorials/partner-nodes/overview) and [cloud subscriptions](https://www.comfy.org/cloud), enabling you to use premium features and services across the ComfyUI platform.
8+
9+
## Supported login methods
10+
11+
ComfyUI supports the following login methods:
12+
- **Email**: Log in with your email address and password
13+
- **Google**: Log in with your Google account
14+
- **GitHub**: Log in with your GitHub account
15+
16+
## Logging in on Comfy Cloud
17+
18+
To access your Comfy account for ComfyUI on Comfy Cloud:
19+
20+
1. Navigate to [Comfy Cloud](https://www.comfy.org)
21+
2. Click **Log in** or **Sign in**
22+
3. Choose your login method:
23+
- **Email**: Enter your email address and password, then click **Log in**
24+
- **Google**: Click the Google login button and authenticate
25+
- **GitHub**: Click the GitHub login button and authenticate
26+
27+
## Logging in locally
28+
29+
If you have ComfyUI installed locally:
30+
31+
1. Open ComfyUI on your local machine
32+
2. Navigate to **Settings** in the interface
33+
3. Go to the **User** section (see [User settings](/interface/user) for details)
34+
4. Choose your login method:
35+
- **Email**: Enter your email address and password
36+
- **Google**: Click the Google login button and authenticate
37+
- **GitHub**: Click the GitHub login button and authenticate
38+
- **API Key**: Use an API Key for non-whitelisted deployments (see below)
39+
40+
![User settings interface](/images/interface/setting/user.jpg)
41+
42+
### Logging in with an API Key
43+
44+
Since not all ComfyUI deployments are on our domain authorization whitelist, we have provided API Key login in a recent update (2025-05-10) for logging in through non-whitelisted sites. Below are the steps for logging in with an API Key:
45+
46+
<video
47+
controls
48+
className="w-full aspect-video"
49+
src="/images/interface/setting/user/api_login.mp4"
50+
></video>
51+
52+
<Tabs>
53+
54+
<Tab title="Have an API Key">
55+
56+
<Steps>
57+
<Step title="Select Comfy API Key Login on the Login Screen">
58+
Select `Comfy API Key` login in the login popup
59+
![Select Comfy API Key Login](/images/interface/setting/user/user-login-api-1.jpg)
60+
</Step>
61+
62+
<Step title="Enter Your API Key">
63+
![Enter API Key](/images/interface/setting/user/user-login-api-2.jpg)
64+
1. Enter your API Key and save it
65+
2. If you don't have an API Key, click the `Get one here` link to go to https://platform.comfy.org/login and log in to obtain it.
66+
</Step>
67+
<Step title="Login Successful">
68+
After a successful login, you can see the corresponding API Key login information in the settings menu
69+
![Logged In](/images/interface/setting/user/user-api-logged.jpg)
70+
</Step>
71+
</Steps>
72+
73+
</Tab>
74+
<Tab title="No API Key, Apply for an API Key First">
75+
Please refer to the following steps to apply for and obtain an API Key:
76+
<Steps>
77+
<Step title="Visit https://platform.comfy.org/login and Log In">
78+
Please visit https://platform.comfy.org/login and log in with the corresponding account
79+
![Visit Platform Login Page](/images/interface/setting/user/user-login-api-key-1.jpg)
80+
</Step>
81+
<Step title="Click `+ New` in API Keys to Create an API Key">
82+
Click `+ New` in API Keys to create an API Key
83+
![Create API Key](/images/interface/setting/user/user-login-api-key-2.jpg)
84+
</Step>
85+
<Step title="Enter API Key Name">
86+
87+
![Enter API Key Name](/images/interface/setting/user/user-login-api-key-3.jpg)
88+
1. (Required) Enter the API Key name,
89+
2. Click `Generate` to create
90+
</Step>
91+
<Step title="Save the Obtained API Key">
92+
![Obtain API Key](/images/interface/setting/user/user-login-api-key-4.jpg)
93+
<Warning>
94+
Since the API Key is only visible upon first creation, please save it immediately after creation. It cannot be viewed later, so please keep it safe.
95+
Please note that you should not share your API Key with others.Once it leaked, you can delete it and create a new one.
96+
</Warning>
97+
</Step>
98+
<Step title="API Key Management">
99+
![API Key Management](/images/interface/setting/user/user-login-api-key-5.jpg)
100+
For unused API Keys or those at risk of being leaked, you can click `Delete` to remove them to prevent unnecessary losses.
101+
</Step>
102+
<Step title="(Optional) Log Out">
103+
![Log Out](/images/interface/setting/user/user-login-api-key-6.jpg)
104+
If you have obtained an API Key and are logged in on a public device, please log out promptly.
105+
</Step>
106+
</Steps>
107+
108+
</Tab>
109+
</Tabs>
110+
111+
## Forgot your password
112+
113+
If you can't remember your password (for email login):
114+
115+
1. Click the **Forgot password?** link on the login page
116+
2. Enter your registered email address
117+
3. Check your email for password reset instructions
118+
4. Click the reset link in the email
119+
5. Create a new password
120+
6. Log in with your new password
121+
122+
## Troubleshooting login issues
123+
124+
If you're having trouble logging in:
125+
126+
- Verify your email address is correct
127+
- Check that Caps Lock is not enabled when entering your password
128+
- Clear your browser cookies and cache
129+
- Try using a different browser or incognito mode
130+
- Ensure your account email has been verified
131+
- Contact [support](/support/contact-support) if issues persist
132+
133+
## Security tips
134+
135+
To keep your account secure:
136+
- Use a strong, unique password
137+
- Don't share your login credentials
138+
- Log out when using shared devices
139+
- Regularly update your password

‎docs.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -564,6 +564,15 @@
564564
"tab": "Support",
565565
"pages": [
566566
"support/contact-support",
567+
{
568+
"group": "Account Management",
569+
"icon": "user",
570+
"pages": [
571+
"account/create-account",
572+
"account/login",
573+
"account/delete-account"
574+
]
575+
},
567576
{
568577
"group": "Billing Support",
569578
"pages": [
@@ -1157,6 +1166,15 @@
11571166
"tab": "支持",
11581167
"pages": [
11591168
"zh-CN/support/contact-support",
1169+
{
1170+
"group": "账户管理",
1171+
"icon": "user",
1172+
"pages": [
1173+
"zh-CN/account/create-account",
1174+
"zh-CN/account/login",
1175+
"zh-CN/account/delete-account"
1176+
]
1177+
},
11601178
{
11611179
"group": "账单支持",
11621180
"pages": [

‎images/interface/setting/menu-user-logged.jpg‎

53.6 KB
Loading

‎interface/user.mdx‎

Lines changed: 3 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -48,74 +48,9 @@ Log in via `Settings` -> `User`:
4848

4949
If this is your first login, please create an account first.
5050

51-
## Logging in with an API Key
52-
53-
Since not all ComfyUI deployments are on our domain authorization whitelist, we have provided API Key login in a recent update (2025-05-10) for logging in through non-whitelisted sites. Below are the steps for logging in with an API Key:
54-
55-
<video
56-
controls
57-
className="w-full aspect-video"
58-
src="/images/interface/setting/user/api_login.mp4"
59-
></video>
60-
61-
<Tabs>
62-
63-
<Tab title="Have an API Key">
64-
65-
<Steps>
66-
<Step title="Select Comfy API Key Login on the Login Screen">
67-
Select `Comfy API Key` login in the login popup
68-
![Select Comfy API Key Login](/images/interface/setting/user/user-login-api-1.jpg)
69-
</Step>
70-
71-
<Step title="Enter Your API Key">
72-
![Enter API Key](/images/interface/setting/user/user-login-api-2.jpg)
73-
1. Enter your API Key and save it
74-
2. If you don't have an API Key, click the `Get one here` link to go to https://platform.comfy.org/login and log in to obtain it.
75-
</Step>
76-
<Step title="Login Successful">
77-
After a successful login, you can see the corresponding API Key login information in the settings menu
78-
![Logged In](/images/interface/setting/user/user-api-logged.jpg)
79-
</Step>
80-
</Steps>
81-
82-
</Tab>
83-
<Tab title="No API Key, Apply for an API Key First">
84-
Please refer to the following steps to apply for and obtain an API Key:
85-
<Steps>
86-
<Step title="Visit https://platform.comfy.org/login and Log In">
87-
Please visit https://platform.comfy.org/login and log in with the corresponding account
88-
![Visit Platform Login Page](/images/interface/setting/user/user-login-api-key-1.jpg)
89-
</Step>
90-
<Step title="Click `+ New` in API Keys to Create an API Key">
91-
Click `+ New` in API Keys to create an API Key
92-
![Create API Key](/images/interface/setting/user/user-login-api-key-2.jpg)
93-
</Step>
94-
<Step title="Enter API Key Name">
95-
96-
![Enter API Key Name](/images/interface/setting/user/user-login-api-key-3.jpg)
97-
1. (Required) Enter the API Key name,
98-
2. Click `Generate` to create
99-
</Step>
100-
<Step title="Save the Obtained API Key">
101-
![Obtain API Key](/images/interface/setting/user/user-login-api-key-4.jpg)
102-
<Warning>
103-
Since the API Key is only visible upon first creation, please save it immediately after creation. It cannot be viewed later, so please keep it safe.
104-
Please note that you should not share your API Key with others.Once it leaked, you can delete it and create a new one.
105-
</Warning>
106-
</Step>
107-
<Step title="API Key Management">
108-
![API Key Management](/images/interface/setting/user/user-login-api-key-5.jpg)
109-
For unused API Keys or those at risk of being leaked, you can click `Delete` to remove them to prevent unnecessary losses.
110-
</Step>
111-
<Step title="(Optional) Log Out">
112-
![Log Out](/images/interface/setting/user/user-login-api-key-6.jpg)
113-
If you have obtained an API Key and are logged in on a public device, please log out promptly.
114-
</Step>
115-
</Steps>
116-
117-
</Tab>
118-
</Tabs>
51+
<Card title="Logging in with an API Key" icon="key" href="/account/login#logging-in-with-an-api-key">
52+
For non-whitelisted sites or LAN environments, you can use API Key login. See the detailed guide in the account login documentation.
53+
</Card>
11954

12055
## Post-Login Status
12156

0 commit comments

Comments
 (0)