diff --git a/docs/general/server/quick-connect.md b/docs/general/server/quick-connect.md index 3467e79f..cf356c86 100644 --- a/docs/general/server/quick-connect.md +++ b/docs/general/server/quick-connect.md @@ -5,24 +5,65 @@ title: Quick Connect # Quick Connect -Starting with Jellyfin server version 10.7.0 and supported clients, you can use Quick Connect to sign into your account without the need of a password. You need to previously be logged into a supported client, like the default Jellyfin Web Client. +**Quick Connect** is a feature that allows users to sign in to clients **without entering a username or password**. Instead, a temporary **Quick Connect code** is generated and used to authorize login from an already authenticated client. -## Enabling Quick Connect +This feature streamlines the sign-in process, especially on devices with limited input options (like TVs or set-top boxes). -To use Quick Connect, the Jellyfin server admin has to enable this feature in the server dashboard. +## Disabling Quick Connect (Server) -Settings > Dashboard > General > Enable Quick Connect on this server +By default, Quick Connect is enabled. +To disable it, follow these steps: + +1. Go to the **Admin Dashboard** on your Jellyfin server. + + `Settings` > `Dashboard` +2. Navigate to the **General** Tab +3. Uncheck the box: + ✅ **Enable Quick Connect on this server** + +## Supported Clients + +Quick Connect functionality is supported in two contexts: + +| Client | Log In | Authorize Others | +|----------------------|--------|------------------| +| JellyCon | ✅ | ❌ | +| Jellyfin Android | ✅ | ✅ | +| Jellyfin Android TV | ✅ | ❌ | +| Jellyfin Kodi | ❌ | ❌ | +| Jellyfin Media Player| ✅ | ✅ | +| Jellyfin Mobile (iOS)| ✅ | ✅ | +| Jellyfin MPV Shim | ❌ | ❌ | +| Jellyfin Roku | ✅ | ❌ | +| Jellyfin UWP | ✅ | ✅ | +| Jellyfin Vue | ❌ | ❌ | +| Jellyfin Web | ✅ | ✅ | +| Jellyfin WebOS | ✅ | ✅ | +| Swiftfin (iOS) | ✅ | ✅ | +| Swiftfin (tvOS) | ✅ | ❌ | ## Using Quick Connect -To sign in to a supported client, you have to enter the Quick Connect code in your user settings. +The Quick Connect process involves two devices: -Settings > Quick Connect +- **Device A**: A new client where you want to log in. +- **Device B**: An already authenticated client (such as your browser, phone, etc.). -![Quick Connect sign in](https://user-images.githubusercontent.com/12074633/115973526-aecc6000-a523-11eb-9ed6-59bee41bac7b.png) +### On Device A (New Device - the one you want to log into) -If the code is validated successfully, your new device will be signed in without entering your Jellyfin username or password on the new device. +1. Open the Jellyfin client and choose **Quick Connect** (usually found on the login screen). + On some clients, you will first need to press **Manual Login**; others may display the quick-connect code directly. +2. A **6-character code** will be displayed. Keep this screen open. -The client will generate a 6 digit code, which you have to enter in the already signed in client in your user settings. +![Quick Connect code example](/images/docs/server/quick-connect/quick-connect-code.png) -![Quick Connect error](https://user-images.githubusercontent.com/12074633/115973542-c99ed480-a523-11eb-9d61-17ccd628e123.png) +### On Device B (Already Logged-In Device) + +1. Open Jellyfin and go to: + `Settings` > `Quick Connect` +2. Enter the 6-character code from Device A and confirm. +3. If successful, Device A will be logged in automatically—no need to enter a username or password. + +![Quick Connect code entry screen](/images/docs/server/quick-connect/quick-connect-entry.png) + +> If the code is invalid or expired, you will see an error message and must try again. diff --git a/static/images/docs/server/quick-connect/quick-connect-code.png b/static/images/docs/server/quick-connect/quick-connect-code.png new file mode 100644 index 00000000..0922392f Binary files /dev/null and b/static/images/docs/server/quick-connect/quick-connect-code.png differ diff --git a/static/images/docs/server/quick-connect/quick-connect-entry.png b/static/images/docs/server/quick-connect/quick-connect-entry.png new file mode 100644 index 00000000..a1beef89 Binary files /dev/null and b/static/images/docs/server/quick-connect/quick-connect-entry.png differ