Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RomainPierre7/jellyfin-plugin-TelegramNotifier
⚠️ This project is still in development and is not functional yet. 👷
https://github.com/RomainPierre7/jellyfin-plugin-TelegramNotifier
Last synced: 6 days ago
JSON representation
⚠️ This project is still in development and is not functional yet. 👷
- Host: GitHub
- URL: https://github.com/RomainPierre7/jellyfin-plugin-TelegramNotifier
- Owner: RomainPierre7
- License: gpl-3.0
- Created: 2024-04-13T12:08:26.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-04-22T12:58:29.000Z (7 months ago)
- Last Synced: 2024-04-22T14:20:22.714Z (7 months ago)
- Language: C#
- Homepage:
- Size: 66.4 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jellyfin - jellyfin-plugin-TelegramNotifier - Receive notifications of Jellyfin server events via Telegram. (🧩 Plugins)
README
# Jellyfin Plugin Telegram Notifier
This [Jellyfin](https://github.com/jellyfin) plugin provides notification functionalities via Telegram for various events occurring within your Jellyfin server. Stay informed about playback activities, user management, plugin operations, and more right from your Telegram account. You can personalize the configuration for each user.
> If you encounter a problem, a bug or have an idea for a new feature, submit an issue [here](https://github.com/RomainPierre7/jellyfin-plugin-TelegramNotifier/issues). Please, submit only one feature or bug per issue.
> If you're finding value in this project and it's been helpful to you, consider giving it a star ⭐️ on GitHub ! Your support means a lot and helps others discover the project too.
## Table of contents
- [Install the plugin](#install-the-plugin)
- [Use the plugin](#use-the-plugin)
- [Install the project (for developers)](#install-the-project-for-developers)
## Install the plugin
To install the plugin on your Jellyfin server, you need to follow these steps:
1. Go to the Jellyfin dashboard
2. Go to the **Plugins** section
3. Go to the **Repository** tab
4. Add the depot URL:
Repository Name: ```Telegram Notifier```
Repository URL:
```
https://raw.githubusercontent.com/RomainPierre7/jellyfin-plugin-TelegramNotifier/main/manifest.json
```
5. Go to the **Catalog** tab
6. Search for the plugin: ```Telegram Notifier```
7. Click on the **Install** button
8. Restart the Jellyfin server
> **Note:** You can also install the plugin manually by downloading the latest release from the [releases page](https://github.com/RomainPierre7/jellyfin-plugin-TelegramNotifier/releases).
## Use the plugin
To use the plugin, you need to follow these steps:
1. Go to the Jellyfin dashboard
2. Go to the **Plugins** section
3. Go to the **Installed** tab
4. Click on the **Telegram Notifier** plugin
5. Configure the plugin
### Configuration
1. Select the user you want to configure
2. Enter the Telegram bot token
> **Note:** You can create a Telegram bot by sending the command ```/newbot``` to the [BotFather](https://t.me/botfather) and collect the token.
3. Enter the chat ID
> **Note:** You can get the collect the chat ID by sending a message to the bot and then go to the URL: ```https://api.telegram.org/bot/getUpdates```
4. Click on the **Test** button to test the configuration
5. Enable the notifications for the user
6. Select the events you want to be notified about
Available events:
- Item added
- Playback start
- Playback progress
- Playback stop
- Subtitle download failure *(soon...)*
- Authentication failure *(soon...)*
- Authentication success *(soon...)*
- Session start
- Pending restart *(soon...)*
- Task completed *(soon...)*
- Plugin installation cancelled
- Plugin installation failed
- Plugin installed
- Plugin installing
- Plugin uninstalled
- Plugin updated
- User created
- User deleted
- User locked out
- User password changed
- User updated *(soon...)*
- User data saved *(soon...)*
7. Click on the **Save** button
**Example of the configuration page:**
## Install the project (for developers)
To install the project, you need to follow these steps:
> **Note:** You need to have the [.NET 8.0 SDK](https://dotnet.microsoft.com/download) installed on your machine.
1. Clone the repository
2. Install the dependencies
3. Compile the plugin
4. Install the plugin
### 1. Clone the repository
```bash
git clone https://github.com/RomainPierre7/jellyfin_telegram_notifier.git
```
### 2. Install the dependencies
```bash
dotnet add package Jellyfin.Model
dotnet add package Jellyfin.Controller
```
### 3. Compile the plugin
```bash
dotnet build
```
or use the **Makefile**:
This command will only build the dll file in the ```plugin``` directory.
```bash
make dev
```
Other commands are available in the **Makefile**:
- ```make build``` - Build the project
- ```make publish``` - Publish the project
- ```make clean``` - Clean the project
- ```make dev``` - Build the project and copy the `dll` file in the ```plugin``` directory
- ```make plugin``` - Publish the project and copy the `dll` file in the ```plugin``` directory
### 4. Install the plugin
To install the plugin, you have to find the Jellyfin plugin directory. It depends on your installation but the most common paths are:
- **Linux**: ```/var/lib/jellyfin/plugins```
- **Windows**: ```C:\ProgramData\Jellyfin\Server\plugins```
- **Docker**: ```/config/plugins``` or ```/config/data/plugins```
Then, you have to copy the ```Jellyfin.Plugin.TelegramNotifier.dll``` file in a folder in the plugin directory.
Example:
```
Plugin
│
└── TelegramNotifier
│
└── Jellyfin.Plugin.TelegramNotifier.dll
```
Finally, you have to restart the Jellyfin server.