Add native Pocket ID OIDC tutorials across the app guides

This commit is contained in:
Djeex
2026-09-02 19:28:29 +02:00
parent bb8581a535
commit dd95694492
5 changed files with 214 additions and 17 deletions
+36 -3
View File
@@ -88,7 +88,7 @@ In the SWAG folders, create a file named `immich.subdomain.conf`.
::tip{icon=""}
✨ __Tip:__ You can use [File Browser](/serveex/files/file-browser) to navigate and edit your files instead of using terminal commands.
✨ __Tip:__ You can use [File Browser Quantum](/serveex/files/file-browser-quantum) to navigate and edit your files instead of using terminal commands.
::
```bash [Terminal]
@@ -159,6 +159,39 @@ Press :kbd{value="Ctrl+O"}, then :kbd{value="Enter"} to save, and :kbd{value="Ct
That's it! Immich is now accessible from the internet. Dont forget to install the [iOS](https://apps.apple.com/us/app/immich/id1613945652) / [Android](https://play.google.com/store/apps/details?id=app.alextran.immich) apps to sync your devices.
::tip{icon=""}
__Tip:__ You can protect this app natively via OIDC with [Pocket ID](/serveex/security/pocket-id) (register it as an OIDC client), or with Authentik by [following these instructions](https://docs.goauthentik.io/integrations/services/immich/).
## Protecting Immich with Pocket ID
Immich supports OIDC natively, so you can require a Pocket ID login before letting anyone into your photos, instead of (or alongside) the app's own accounts.
::steps{level="3"}
### Register Immich as an OIDC client
[Register an OIDC client in Pocket ID](/serveex/security/pocket-id#registering-an-oidc-client) named `immich`, with these three callback URLs:
```text
https://immich.yourdomain.com/auth/login
https://immich.yourdomain.com/user-settings
app.immich:///oauth-callback
```
The third URL is what lets the mobile app log in too.
### Enable OAuth in Immich
In Immich, go to _Administration > Settings > Authentication Settings > OAuth_, enable it, and fill in:
| Field | Value |
|-------|-------|
| Issuer URL | Pocket ID's OIDC discovery URL |
| Client ID | The client ID copied from Pocket ID |
| Client Secret | The client secret copied from Pocket ID |
### Done !
::
::tip
✨ You can use [Authentik](/serveex/advanced/authentik) instead of Pocket ID:
1. In Authentik, create an application and an OAuth2/OpenID Connect provider named `immich`, with the same three redirect URIs as above (type `Strict`).
2. Note the provider's __Client ID__, __Client Secret__, and __Slug__.
3. In Immich's OAuth settings, set the Issuer URL to `https://authentik.yourdomain.com/application/o/<slug>/`, then fill in the Client ID and Client Secret.
::