-
+
- Note:
- This plug-in is free open-source software.
-
- A Telegram Bot is required to validate the Telegram login.
-
-
- You must have a Telegram username to use this login method.
-
-
- Here is the
-
-
- Link to the Login Page
-
-
- .
-
+ Note:
+ This plug-in is free open-source software. I do not accept any responsibilities.
+
+ Requirements:
+
@@ -31,12 +31,33 @@ Created from [jellyfin-plugin-template](https://github.com/jellyfin/jellyfin-plu
## Usage
-1. User clicks the "Sign In with Telegram" Disclaimer Link on the Jellyfin Login Page
-2. User lands on the page "/sso/Telegram/login"
-3. Plugin shows a Page with embedded "Telegram Login" button.
-4. When the button is clicked, the Plugin validates User credentials using custom Telegram logic.
-5. On Success -> Authenticate & User is redirected to Jellyfin Dashboard
-6. On Failure -> Show Error Message (e.g. Invalid Data, not Whitelisted)
+1. User clicks the `Sign in with Telegram` Disclaimer Link on the Jellyfin Login Page
+2. User lands on the page `/sso/Telegram`
+3. Plugin shows a Page with embedded Telegram Login Widget.
+4. When the button is clicked, Plugin validates User credentials using bot token.
+ - On Success -> Authenticate & redirect User to Jellyfin Dashboard
+ - On Failure -> Show Error Message (e.g. Invalid Data, not Whitelisted)
+
+## Features
+
+- SSO Login page (at `/sso/Telegram`)
+ - styled similar to the regular login page
+ - responsive / mobile capable
+ - shows a "Back to Normal Login" button
+ - shows the Telegram Login Widget
+ - checks the Telegram Auth data against the backend
+ - if data is invalid -> show error message
+ - if data is valid -> takes the Jellyfin Auth Response and authenticates the user
+ - loading animation
+ - supports Custom CSS
+
+- Config page (reachable via Jellyfin Plugin Page)
+ - requires setting the Telegram Bot Token
+ - allows setting a List of Administrator Telegram Usernames (get full Access)
+ - allows forcing an external Protocol Scheme (for reverse proxies like Traefik)
+ - allows Creating/Editing/Deleting a "virtual" management Group
+ - Grants access to all OR specific Libraries for non-Administrators.
+ - _Note: A user needs to be Admin OR part of at least ONE Group to Log-in._
## Requirements
@@ -44,16 +65,15 @@ Created from [jellyfin-plugin-template](https://github.com/jellyfin/jellyfin-plu
2. A valid, public SSL certificate is needed for the Login Widget to work (e.g. LetsEncrypt).
3. A Telegram Bot (token) is required to cryptograhpically validate the User Login credentials.
-## Install
-
-You can choose between three (3) options.
+## Installation
-### Option 1: (NEW) Plugin Repository
+You can choose between 3 options below.
-Note: _this is barely tested_
+### Option 1: Plugin Repository (easy way)
1. Add the repository:
- "Production"-usage is NOT recommended.
-
- Not everything will be working perfectly and I do not
- accept any responsibility for errors.
-
- A valid, public domain SSL certificate is required for the Login Widget to work.
-
- The Bot Token can be obtained from @BotFather.
-
- Once you have chosen a bot, use the /setdomain command to link your jellyfin domain to the bot.
-
-
- A Telegram User has to be Administrator OR part of at
- least one Group in order to login.
-
- You may also include this link in the "Branding" via
- Markdown.
-
- Here is an example:
-
-
- Please enable JavaScript.
-
-
-
+
+ Live "Production"-usage is NOT recommended unless you really know what you are doing.
+
+
+
+
+
+
-
-