Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

website/integrations: add Immich #7829

Merged
merged 6 commits into from
Dec 15, 2023
Merged

website/integrations: add Immich #7829

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
67fa2fe
Create Immich integration documentation
ZuluWhiskey Dec 8, 2023
8934788
Add in 'title:'
ZuluWhiskey Dec 9, 2023
286bce9
Move Immich so the list is alphabetical
ZuluWhiskey Dec 12, 2023
5bf39c8
- Remove reference to local IPs for Redirect URIs/Origins (RegEx). Ex…
ZuluWhiskey Dec 12, 2023
eb0d6e0
Changes made following "make website"
ZuluWhiskey Dec 13, 2023
07febfa
Fixing grammar and typos
ZuluWhiskey Dec 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions website/integrations/services/immich/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: Immich
---

<span class="badge badge--secondary">Support level: Community</span>

## What is Immich

> Immich is a self-hosted backup solution for photos and videos on mobile devices
>
> -- https://immich.app/

## Preparation

The following placeholders will be used:

- `https://immich.company` is the URL used to access the Immich instance.
- `authentik.company` is the FQDN of the authentik install.

## authentik Configuration

1. Create a new OAuth2/OpenID Provider
- **Name**: Immich
- **Authentication flow**: default-authentication-flow
- **Authorization flow**: default-provider-authorization-explicit-consent
- **Client type**: Confidential
- **Client ID**: Either create your own Client ID or make a note of the auto-populated one
- **Client Secret**: Either create your own Client Secret or make a note of the auto-populated one
- **Redirect URIs/Origins (RegEx)**:
_Please note that the following URIs are just examples. Ensure to include all of the domains / URLs you will be using to access Immich._
- app.immich:/
- https://immich.company/auth/login
- https://immich.company/user-settings
- **Signing Key**: authentik Self-signed Certificate
- Leave everything else as default
2. Open the new provider you've just created
3. Make a note of the **OpenID Configuration Issuer**

## Service Configuration

Immich documentation can be found here: https://immich.app/docs/administration/oauth

1. Go to Administration > Settings > OAuth Authentication
2. Configure Immich as follows:
- **Issuer URL**: Populate this field with the `OpenID Configuration Issuer`
- **Client ID**: Enter yout Client ID from authentik here
- **Client Secret**: Enter yout Client Secret from authentik here
- **Scope**: `openid email profile`
1 change: 1 addition & 0 deletions website/sidebarsIntegrations.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ module.exports = {
"services/freshrss/index",
"services/gravitee/index",
"services/home-assistant/index",
"services/immich/index",
"services/jellyfin/index",
"services/node-red/index",
"services/sonar-qube/index",
Expand Down