docs: Update Authentik example (#9950)

* Update * npm run format:fix * more npm run format:fix
immich-app · Jun 3, 2024 · 15474e8 · 15474e8
1 parent bb9e182
commit 15474e8
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 3 deletions.
diff --git a/docs/docs/administration/img/authentik-redirect-uris-example.webp b/docs/docs/administration/img/authentik-redirect-uris-example.webp
diff --git a/...cs/administration/img/google-example.webp → ...ion/img/google-redirect-uris-example.webp b/...cs/administration/img/google-example.webp → ...ion/img/google-redirect-uris-example.webp
diff --git a/docs/docs/administration/img/immich-google-example.webp b/docs/docs/administration/img/immich-google-example.webp
diff --git a/docs/docs/administration/img/oauth-settings.png b/docs/docs/administration/img/oauth-settings.png
diff --git a/docs/docs/administration/oauth.md b/docs/docs/administration/oauth.md
@@ -117,7 +117,27 @@ Immich has a route (`/api/oauth/mobile-redirect`) that is already configured to
 
 Here's an example of OAuth configured for Authentik:
 
-<img src={require('./img/oauth-settings.png').default} title="OAuth settings" />
+Configuration of Authorised redirect URIs (Authentik OAuth2/OpenID Provider)
+
+<img src={require('./img/authentik-redirect-uris-example.webp').default} width='70%' title="Authentik authorised redirect URIs" />
+
+Configuration of OAuth in Immich System Settings
+
+| Setting                      | Value                                                                              |
+| ---------------------------- | ---------------------------------------------------------------------------------- |
+| Issuer URL                   | `https://example.immich.app/application/o/immich/.well-known/openid-configuration` |
+| Client ID                    | AFCj2rM1f4rps**\*\*\*\***\***\*\*\*\***lCLEum6hH9...                               |
+| Client Secret                | 0v89FXkQOWO\***\*\*\*\*\***\*\*\***\*\*\*\*\***mprbvXD549HH6s1iw...                |
+| 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 Authentik (optional)                                                  |
+| Auto Register                | Enabled (optional)                                                                 |
+| Auto Launch                  | Enabled (optional)                                                                 |
+| Mobile Redirect URI Override | Disable                                                                            |
+| Mobile Redirect URI          |                                                                                    |
 
 </details>
 
@@ -126,11 +146,13 @@ Here's an example of OAuth configured for Authentik:
 
 ### Google Example
 
+Here's an example of OAuth configured for Google:
+
 Configuration of Authorised redirect URIs (Google Console)
 
-<img src={require('./img/google-example.webp').default} width='50%' title="Authorised redirect URIs" />
+<img src={require('./img/google-redirect-uris-example.webp').default} width='50%' title="Google authorised redirect URIs" />
 
-Configuration of OAuth in System Settings
+Configuration of OAuth in Immich System Settings
 
 | Setting                      | Value                                                                                                  |
 | ---------------------------- | ------------------------------------------------------------------------------------------------------ |

diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css
@@ -15,6 +15,10 @@ button {
   font-family: 'Overpass', sans-serif;
 }
 
+img {
+  border-radius: 15px;
+}
+
 /* You can override the default Infima variables here. */
 :root {
   --ifm-color-primary: #4250af;