Skip to content

Commit

Permalink
fix(docs): Immich quota claim note (#8151)
Browse files Browse the repository at this point in the history
* Add a note about immich_quota_claim.

* Fix

* PR feedback

* npm run format:fix

* use ¹
  • Loading branch information
aviv926 authored Mar 21, 2024
1 parent dc3c329 commit fa0a510
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/docs/administration/oauth.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,20 @@ Once you have a new OAuth client application configured, Immich can be configure
| Client Secret | string | (required) | Required. Client Secret (previous step) |
| Scope | string | openid email profile | Full list of scopes to send with the request (space delimited) |
| Signing Algorithm | string | RS256 | The algorithm used to sign the id token (examples: RS256, HS256) |
| Storage Label Claim | string | preferred_username | Claim mapping for the user's storage label |
| Storage Quota Claim | string | immich_quota | Claim mapping for the user's storage |
| Storage Label Claim | string | preferred_username | Claim mapping for the user's storage label**¹** |
| Storage Quota Claim | string | immich_quota | Claim mapping for the user's storage**¹** |
| Default Storage Quota (GiB) | number | 0 | Default quota for user without storage quota claim (Enter 0 for unlimited quota) |
| Button Text | string | Login with OAuth | Text for the OAuth button on the web |
| Auto Register | boolean | true | When true, will automatically register a user the first time they sign in |
| [Auto Launch](#auto-launch) | boolean | false | When true, will skip the login page and automatically start the OAuth login process |
| [Mobile Redirect URI Override](#mobile-redirect-uri) | URL | (empty) | Http(s) alternative mobile redirect URI |

:::note Claim Options [1]

Claim is only used on user creation and not synchronized after that.

:::

:::info
The Issuer URL should look something like the following, and return a valid json document.

Expand Down

0 comments on commit fa0a510

Please sign in to comment.