mirror of
https://github.com/immich-app/immich.git
synced 2024-12-29 15:11:58 +00:00
docs: Add Google OAuth example (#9778)
* Add Google OAuth example * npm run format:fix * fix * PR feedback * Fix
This commit is contained in:
parent
38f4a02a14
commit
e3d39837d0
3 changed files with 37 additions and 1 deletions
BIN
docs/docs/administration/img/google-example.webp
Normal file
BIN
docs/docs/administration/img/google-example.webp
Normal file
Binary file not shown.
After Width: | Height: | Size: 11 KiB |
BIN
docs/docs/administration/img/immich-google-example.webp
Normal file
BIN
docs/docs/administration/img/immich-google-example.webp
Normal file
Binary file not shown.
After Width: | Height: | Size: 113 KiB |
|
@ -110,8 +110,44 @@ Immich has a route (`/api/oauth/mobile-redirect`) that is already configured to
|
||||||
|
|
||||||
## Example Configuration
|
## Example Configuration
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Authentik Example</summary>
|
||||||
|
|
||||||
|
### Authentik Example
|
||||||
|
|
||||||
Here's an example of OAuth configured for Authentik:
|
Here's an example of OAuth configured for Authentik:
|
||||||
|
|
||||||
![OAuth Settings](./img/oauth-settings.png)
|
<img src={require('./img/oauth-settings.png').default} title="OAuth settings" />
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Google Example</summary>
|
||||||
|
|
||||||
|
### Google Example
|
||||||
|
|
||||||
|
Configuration of Authorised redirect URIs (Google Console)
|
||||||
|
|
||||||
|
<img src={require('./img/google-example.webp').default} width='50%' title="Authorised redirect URIs" />
|
||||||
|
|
||||||
|
Configuration of OAuth in System Settings
|
||||||
|
|
||||||
|
| Setting | Value |
|
||||||
|
| ---------------------------- | ------------------------------------------------------------------------------------------------------ |
|
||||||
|
| Issuer URL | [https://accounts.google.com](https://accounts.google.com) |
|
||||||
|
| Client ID | 7\***\*\*\*\*\*\*\***\*\*\***\*\*\*\*\*\*\***vuls.apps.googleusercontent.com |
|
||||||
|
| Client Secret | G\***\*\*\*\*\*\*\***\*\*\***\*\*\*\*\*\*\***OO |
|
||||||
|
| Scope | openid email profile |
|
||||||
|
| Signing Algorithm | RS256 |
|
||||||
|
| Storage Label Claim | preferred_username |
|
||||||
|
| Storage Quota Claim | immich_quota |
|
||||||
|
| Default Storage Quota (GiB) | 0 (0 for unlimited quota) |
|
||||||
|
| Button Text | Sign in with Google (optional) |
|
||||||
|
| Auto Register | Enabled (optional) |
|
||||||
|
| Auto Launch | Enabled |
|
||||||
|
| Mobile Redirect URI Override | Enabled (required) |
|
||||||
|
| Mobile Redirect URI | [https://demo.immich.app/api/oauth/mobile-redirect](https://demo.immich.app/api/oauth/mobile-redirect) |
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
[oidc]: https://openid.net/connect/
|
[oidc]: https://openid.net/connect/
|
||||||
|
|
Loading…
Reference in a new issue