85 lines
4.1 KiB
Markdown
85 lines
4.1 KiB
Markdown
# Jellyfin.Xtream
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The Jellyfin.Xtream plugin can be used to integrate the content provided by an [Xtream-compatible API](https://xtream-ui.org/api-xtreamui-xtreamcode/) in your [Jellyfin](https://jellyfin.org/) instance.
|
|
|
|
## Installation
|
|
|
|
The plugin can be installed using a custom plugin repository.
|
|
To add the repository, follow these steps:
|
|
|
|
1. Open your admin dashboard and navigate to `Plugins`.
|
|
1. Select the `Repositories` tab on the top of the page.
|
|
1. Click the `+` symbol to add a repository.
|
|
1. Enter `Jellyfin.Xtream` as the repository name.
|
|
1. Enter [`https://kevinjil.github.io/Jellyfin.Xtream/repository.json`](https://kevinjil.github.io/Jellyfin.Xtream/repository.json) as the repository url.
|
|
1. Click save.
|
|
|
|
To install or update the plugin, follow these steps:
|
|
|
|
1. Open your admin dashboard and navigate to `Plugins`.
|
|
1. Select the `Catalog` tab on the top of the page.
|
|
1. Under `Live TV`, select `Jellyfin Xtream`.
|
|
1. (Optional) Select the desired plugin version.
|
|
1. Click `Install`.
|
|
1. Restart your Jellyfin server to complete the installation.
|
|
|
|
## Configuration
|
|
|
|
The plugin requires connection information for an [Xtream-compatible API](https://xtream-ui.org/api-xtreamui-xtreamcode/).
|
|
The following credentials should be set correctly in the `Credentials` plugin configuration tab on the admin dashboard.
|
|
|
|
| Property | Description |
|
|
| -------- | ----------------------------------------------------------------------------------------- |
|
|
| Base URL | The URL of the API endpoint excluding the trailing slash, including protocol (http/https) |
|
|
| Username | The username used to authenticate to the API |
|
|
| Password | The password used to authenticate to the API |
|
|
|
|
### Live TV
|
|
|
|
1. Open the `Live TV` configuration tab.
|
|
1. Select the categories, or individual channels within categories, you want to be available.
|
|
1. Click `Save` on the bottom of the page.
|
|
1. Open the `TV Overrides` configuration tab.
|
|
1. Modify the channel numbers, names, and icons if desired.
|
|
1. Click `Save` on the bottom of the page.
|
|
|
|
### Video On-Demand
|
|
|
|
1. Open the `Video On-Demand` configuration tab.
|
|
1. Enable `Show this channel to users`.
|
|
1. Select the categories, or individual videos within categories, you want to be available.
|
|
1. Click `Save` on the bottom of the page.
|
|
|
|
### Series
|
|
|
|
1. Open the `Series` configuration tab.
|
|
1. Enable `Show this channel to users`.
|
|
1. Select the categories, or individual series within categories, you want to be available.
|
|
1. Click `Save` on the bottom of the page.
|
|
|
|
### TV Catchup
|
|
1. Open the `Live TV` configuration tab.
|
|
1. Enable `Show the catch-up channel to users`.
|
|
1. Click `Save` on the bottom of the page.
|
|
|
|
## Known problems
|
|
|
|
### Loss of confidentiality
|
|
|
|
Jellyfin publishes the remote paths in the API and in the default user interface.
|
|
As the Xtream format for remote paths includes the username and password, anyone that can access the library will have access to your credentials.
|
|
Use this plugin with caution on shared servers.
|
|
|
|
## Troubleshooting
|
|
|
|
Make sure you have correctly configured your [Jellyfin networking](https://jellyfin.org/docs/general/networking/):
|
|
|
|
1. Open your admin dashboard and navigate to `Networking`.
|
|
2. Correctly configure your `Published server URIs`.
|
|
For example: `all=https://jellyfin.example.com`
|