Skip to content

A local-first personal finance app

Add ACTUAL_USER_CREATION_MODE documentation to oauth-auth.md (#6935)

Kenny McCormick1ad7b6f781cd
diff --git a/packages/docs/docs/config/oauth-auth.md b/packages/docs/docs/config/oauth-auth.md
index ab5defde60..77c2774b48 100644
--- a/packages/docs/docs/config/oauth-auth.md
+++ b/packages/docs/docs/config/oauth-auth.md
@@ -114,6 +114,10 @@ When setup is done, you will be redirected to the _login_ page:
![](/img/oauth/first-login.webp)
+:::warning
+The first user to log in with OpenID/OAuth2 will be granted admin permissions and become the server owner. The server owner cannot be changed from the UI once set.
+:::
+
### Environment Variables
#### `ACTUAL_OPENID_DISCOVERY_URL`
@@ -175,6 +179,12 @@ Use `oauth2` for providers like GitHub that don't fully support OpenID discovery
- `"openid-provider"` (tokens follow the expiration time from the OpenID provider)
- A numeric value in seconds (e.g., `3600` for 1 hour)
+#### `ACTUAL_USER_CREATION_MODE`
+
+- **Purpose:** In `manual` (default) users must be created manually with matching usernames in Actual before they are able to authenticate with OpenID/OAuth2. When set to `login`, users authenticating with OpenID/OAuth2 for the first time will be created in Actual automatically.
+
+ **Possible Values:** `manual` or `login` (default is `manual`)
+
:::tip
Configuring the OpenID provider from options supports discovery; otherwise, use [file configuration](oauth-auth#config-using-configuration-file)
:::