docs: add OpenID connect documentation

This commit is contained in:
Michael Thomas
2025-07-05 20:14:07 -04:00
parent 27292c02ea
commit 205aa5da92
7 changed files with 90 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 375 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 296 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 306 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 306 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 285 KiB

View File

@@ -22,6 +22,14 @@ When disabled, users will only be able to sign in using their email address. Use
This setting is **enabled** by default.
## Enable OpenID Connect Sign-In
When enabled, users will be able to sign in to Jellyseerr using their OpenID Connect credentials, provided they have linked their OpenID Connect accounts. Once enabled, the [OpenID Connect settings](./oidc.md) can be accessed using the settings cog to the right of this option, and OpenID Connect providers can be configured.
When disabled, users will only be able to sign in using their email address. Users without a password set will not be able to sign in to Jellyseerr.
This setting is **disabled** by default.
## Enable New Jellyfin/Emby/Plex Sign-In
When enabled, users with access to your media server will be able to sign in to Jellyseerr even if they have not yet been imported. Users will be automatically assigned the permissions configured in the [Default Permissions](#default-permissions) setting upon first sign-in.

View File

@@ -0,0 +1,82 @@
---
title: OpenID Connect
description: Configure OpenID Connect settings.
sidebar_position: 2.5
---
# OpenID Connect
Jellyseerr supports OpenID Connect (OIDC) for authentication and authorization. To begin setting up OpenID Connect, follow these steps:
1. First, enable OpenID Connect [on the User settings page](./index.md#enable-openid-connect-sign-in).
2. Once enabled, access OpenID Connect settings using the cog icon to the right.
3. Add a new provider by clicking the "Add Provider" button.
4. Configure the provider with the options described below.
5. Link your OpenID Connect account to your Jellyseerr account using the "Link Account" button on the Linked Accounts page in your user's settings.
6. Finally, you should be able to log in using your OpenID Connect account.
## Configuration Options
### Provider Name
Name of the provider which appears on the login screen.
Configuring this setting will automatically determine the [provider slug](#provider-slug), unless it is manually specified.
### Logo
The logo to display for the provider. Should be a URL or base64 encoded image.
:::tip
The search icon at the right of the logo field opens the [selfh.st/icons](https://selfh.st/icons) database. These icons include popular self-hosted OpenID Connect providers.
:::
### Issuer URL
The base URL of the identity provider's OpenID Connect endpoint
### Client ID
The Client ID assigned to Jellyseerr
### Client Secret
The Client Secret assigned to Jellyseerr
### Provider Slug
Unique identifier for the provider
### Scopes
Comma-separated list of scopes to request from the provider
### Required Claims
Comma-separated list of boolean claims that are required to log in
### Allow New Users
Create accounts for new users logging in with this provider
## Provider Guides
### Keycloak
To set up Keycloak, follow these steps:
1. First, create a new client in Keycloak.
![Keycloak Step 1](./assets/oidc_keycloak_1.png)
1. Set the client ID to `jellyseerr`, and set the name to "Jellyseerr" (or whatever you prefer).
![Keycloak Step 2](./assets/oidc_keycloak_2.png)
1. Next, be sure to enable "Client authentication" in the capabilities section. The remaining defaults should be fine.
![Keycloak Step 3](./assets/oidc_keycloak_3.png)
1. Finally, set the root url to your Jellyseerr instance's URL, and add the login page as a valid redirect URL.
![Keycloak Step 4](./assets/oidc_keycloak_4.png)
1. With all that set up, you should be able to configure Jellyseerr to use Keycloak for authentication. Be sure to copy the client secret from the credentials page, as shown above. The issuer URL can be obtained from the "Realm Settings" page, by copying the link titled "OpenID Endpoint Configuration".
![Keycloak Step 5](./assets/oidc_keycloak_5.png)