Skip to content

Commit fe125f0

Browse files
NeuralFaultNeuralFault
committed
docs: add Accounts settings documentation page
1 parent a0ad577 commit fe125f0

1 file changed

Lines changed: 192 additions & 0 deletions

File tree

‎docs/settings/accounts.md‎

Lines changed: 192 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,192 @@
1+
# Accounts
2+
3+
The Accounts settings page manages external service integrations. Connecting accounts allows Stability Matrix to download models that require authentication, access membership features, and use cloud-based image generation services.
4+
5+
[`Section Overview`](overview.md) | [`Home`](../README.md)
6+
7+
## Table of Contents
8+
9+
- [Membership and Lykos Account](#membership-and-lykos-account)
10+
- [CivitAI API Key](#civitai-api-key)
11+
- [HuggingFace Token](#huggingface-token)
12+
- [Image Generation APIs](#image-generation-apis)
13+
14+
---
15+
16+
## Membership and Lykos Account
17+
18+
A Lykos account is the central identity for Stability Matrix. Lykos is the team behind Stability Matrix, and signing in unlocks membership benefits and account-linked features across the application.
19+
20+
### Membership
21+
22+
Lykos offers a membership program that supports ongoing development, access to pre-release preview builds of Stability Matrix, and unlocks additional features on the [Lykos.ai](https://lykos.ai) website. Membership is managed entirely in-house by the Lykos team at [lykos.ai/membership](https://lykos.ai/membership?ref=a1).
23+
24+
| Tier | Description |
25+
|---|---|
26+
| **Visionary** | Highest monthly credits and vote power. Shout-out in both release and Preview/Dev changelog. Maximum support for development. |
27+
| **Pioneer** | Higher monthly credits and vote power. Shout-out in release changelog. |
28+
| **Insider** | Increased credits and vote power over Supporter. Accellerated Model Discovery |
29+
| **Supporter** | 1,000 monthly credits, 2× vote power. The entry-level tier that supports development and server costs. |
30+
31+
All support tiers receive special roles and dedicated supporter channel on the Stability Matrix Discord server and early access to new features through **Preview** and **Dev** update channels in [Update Settings](updates.md).
32+
33+
When you are an active subscriber, the Accounts page shows your tier, the date you started supporting, and a quick link to manage your membership. A thank-you message and community Discord link are also displayed.
34+
35+
If you are not subscribed, a membership card appears with a **Become a Supporter** button that opens the Lykos membership page in your browser.
36+
37+
### Connecting a Lykos Account
38+
39+
1. Navigate to **Settings → Accounts**.
40+
2. Under the Lykos section, click **Connect**.
41+
3. A device authentication dialog appears with a code.
42+
4. Open your browser and go to the URL shown in the dialog.
43+
5. Enter the code to authorize Stability Matrix.
44+
6. Once authorized, the dialog closes and your account appears on the Accounts page.
45+
46+
> [!NOTE]
47+
> The device code flow does not require entering your email or password into Stability Matrix itself. Authentication happens entirely in your browser on the Lykos website.
48+
49+
Your profile image is fetched from [Gravatar](https://gravatar.com/) using the email address associated with your Lykos account. You can update your avatar at any time through Gravatar, accessible from the profile image context menu.
50+
51+
### Managing Your Account
52+
53+
Once connected, clicking your profile image provides quick actions:
54+
55+
- **Manage Lykos Account** — opens the Lykos account management page in your browser, where you can update your subscription, email, and password
56+
- **Edit Gravatar** — opens gravatar.com to change your profile picture
57+
- **Copy User ID** — copies your Lykos user ID to the clipboard
58+
59+
### Disconnecting
60+
61+
To disconnect your Lykos account, click **Disconnect** under the Lykos section. This removes your stored tokens and signs you out. Your membership can be restored by reconnecting.
62+
63+
---
64+
65+
## CivitAI API Key
66+
67+
A CivitAI API key enables model downloads from CivitAI that require authentication and unlocks additional integrations.
68+
69+
### What the API Key Unlocks
70+
71+
- **Gated model downloads** — models behind an "early-access" paywall on CivitAI
72+
- **NSFW content browsing** — accessing NSFW-tagged models in the Model Browser (requires enabling the NSFW toggle in the Model Browser itself)
73+
74+
### How to Get an API Key
75+
76+
1. Log in to [civitai.com](https://civitai.com).
77+
2. Click on avatar in upper-right. Go to **Account Settings → API Keys**.
78+
3. Click **Create API Key** and give it a name (e.g., "Stability Matrix").
79+
4. Copy the generated key. Save this key somewhere safe (ie: text file, password/note manager, etc.) as CivitAI will only provide this key once.
80+
81+
### Connecting in Stability Matrix
82+
83+
1. Navigate to **Settings → Accounts**.
84+
2. Under the CivitAI section, click **Connect**.
85+
3. Paste your API key into the dialog and click **Connect**.
86+
87+
Stability Matrix validates the key by fetching your CivitAI profile. Once validated, your CivitAI username appears on the Accounts page.
88+
89+
### How the Key Is Used
90+
91+
The API key is sent as a `Bearer` token in the `Authorization` header for all requests to `civitai.com`, including model downloads and API calls. This allows Stability Matrix to download models that would otherwise return an authentication error.
92+
93+
### Security
94+
95+
API keys are stored encrypted at rest in the `user-secrets.data` file inside Stability Matrix's application data directory. The key is not stored in plain text, and the file is encrypted using a key derived from system-specific identifiers.
96+
97+
The `user-secrets.data` location depends on your operating system:
98+
99+
| Platform | Path |
100+
|---|---|
101+
| Windows | `%APPDATA%\StabilityMatrix\user-secrets.data` (`C:\Users\{username}\AppData\Roaming\StabilityMatrix`) |
102+
| Linux | `~/.config/StabilityMatrix/user-secrets.data` |
103+
| macOS | `~/Library/Application Support/StabilityMatrix/user-secrets.data` |
104+
105+
### Disconnecting
106+
107+
To remove your CivitAI API key, click **Disconnect** under the CivitAI section. This deletes the stored key and stops sending authentication headers on CivitAI requests.
108+
109+
---
110+
111+
## HuggingFace Token
112+
113+
A HuggingFace access token enables downloading gated models from the Hugging Face Hub.
114+
115+
### What the Token Unlocks
116+
117+
- **Gated models** — models that require accepting a license agreement before download (e.g., FLUX,)
118+
119+
### Important: Accept the Model License First
120+
121+
Even with a valid token, gated models require you to accept the model's license terms on the Hugging Face website before the download will succeed. Visit the model's page on [huggingface.co](https://huggingface.co) and click **Agree and access repository** before attempting to download through Stability Matrix.
122+
123+
### How to Get a Token
124+
125+
1. Log in to [huggingface.co](https://huggingface.co).
126+
2. Go to **Settings → Access Tokens**.
127+
3. Click **Create new token**.
128+
4. Select the **Read** permission type (sufficient for model downloads).
129+
5. Give the token a name (e.g., "Stability Matrix").
130+
6. Copy the generated token. Save this key somewhere safe (ie: text file, password/note manager, etc.) as HuggingFace will only provide this key once.
131+
132+
### Connecting in Stability Matrix
133+
134+
1. Navigate to **Settings → Accounts**.
135+
2. Under the HuggingFace section, click **Connect**.
136+
3. Paste your token into the dialog and click **Connect**.
137+
138+
Stability Matrix validates the token by calling the HuggingFace API. Once validated, your HuggingFace username appears on the Accounts page.
139+
140+
### How the Token Is Used
141+
142+
The token is used in two ways:
143+
144+
1. **Direct downloads** — when Stability Matrix downloads a model directly from `huggingface.co`, the token is sent as a `Bearer` token in the `Authorization` header
145+
2. **User-configurable environment variable** — you can inject the token into launched packages by setting `HF_TOKEN` in the [Environment Variables editor](../advanced/environment-variables.md). Stability Matrix does **not** automatically inject the token into package environments.
146+
147+
### Security
148+
149+
The token is stored encrypted at rest in the `user-secrets.data` file inside Stability Matrix's application data directory, using the same encryption mechanism as the CivitAI API key.
150+
151+
### Disconnecting
152+
153+
To remove your HuggingFace token, click **Disconnect** under the HuggingFace section. This deletes the stored token. Direct downloads from Hugging Face will no longer include authentication headers.
154+
155+
> [!IMPORTANT]
156+
> If you previously set `HF_TOKEN` manually in the Environment Variables editor, disconnecting here does **not** remove it from there. You must remove it from the Environment Variables editor separately.
157+
158+
---
159+
160+
## Image Generation APIs
161+
162+
The Image Generation APIs section contains keys for cloud-based image generation services used by the **Image Lab** feature.
163+
164+
### Gemini API Key
165+
166+
A Gemini API key enables the **Nano Banana** image generation provider in the Image Lab, which uses Google's Gemini models for AI-powered image generation.
167+
168+
> [!NOTE]
169+
> The Gemini API key requires a paid-tier Google AI account with billing enabled. Free-tier keys will not work for Image Lab generation.
170+
171+
#### How to Get an API Key
172+
173+
1. Go to [Google AI Studio](https://aistudio.google.com/api-keys).
174+
2. Sign in with your Google account.
175+
3. Click **Create API Key**.
176+
4. Copy the generated key.
177+
178+
#### Connecting in Stability Matrix
179+
180+
1. Navigate to **Settings → Accounts**.
181+
2. Under the **Image Generation APIs** section, click **Connect** next to Gemini API.
182+
3. Paste your API key into the dialog and click **Connect**.
183+
184+
Stability Matrix checks that a key is present. The key is validated at generation time when the Image Lab makes its first request.
185+
186+
#### Security
187+
188+
The API key is stored encrypted at rest in the `user-secrets.data` file inside Stability Matrix's application data directory, using the same encryption mechanism as other stored credentials.
189+
190+
#### Disconnecting
191+
192+
To remove your Gemini API key, click **Disconnect** under the Gemini API section. This deletes the stored key. The Nano Banana provider in the Image Lab will no longer be available until a new key is added.

0 commit comments

Comments
 (0)