jellyfin-youtube-metadata-plugin
jellyfin-youtube-metadata-plugin copied to clipboard
Youtube Metadata Plugin for Jellyfin
Jellyfin Youtube Metadata Plugin
Overview
Plugin for Jellyfin that retrieves metadata for content from Youtube.
Features
- Local provider uses the
info.jsonfiles provided from yt-dlp or similar programs. - Remote provider uses yt-dlp to download
info.jsonfiles. - Supports thumbnails of
jpgorwebpformat for both channel and videos - Supports the following library types
- Movies
- Music Videos
- Shows
- Supports ExternalID providing quick links to source of metadata.
Requirements
- yt-dlp is required if you are using the remote provider.
Installation
Prerequirements
You are required to have yt-dlp available on the system or container Jellyfin is running on. The following are examples of how you could do this depending on your setup and are not to be considered an exhaustive list.
Installing from package manager
sudo apt-get install yt-dlp
Installing in a container
$ docker exec -it -u root jellyfin bash
$ curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /bin/yt-dlp
$ chmod a+rx /bin/yt-dlp
$ apt update && apt install --no-install-recommends --no-install-suggests python3
Building a docker image depending on YT-DLP
FROM linuxserver/jellyfin:nightly
RUN apt-get update && apt-get install -y \
python3-pip
RUN python3 -m pip install -U yt-dlp
Installing From Repository (Recommended)
- Go to the
Admin Dashboard. - In the left navigation menu, click on
Plugins. - In the top menu, click
Repositories. - Click the
+icon to add a new repository. Repository Namecan be anything.URLmust behttps://raw.githubusercontent.com/ankenyr/jellyfin-plugin-repo/master/manifest.json- If done correctly you should see a new repository on the page.
- In the top menu, navigate to
Catalog. - Under the
Metadatasection click onYoutubeMetadata. - Click
Install. - Restart Jellyfin.
- On the left navigation menu, click on Plugins.
- If successful, you will see
YoutubeMetadatawith status asActive
Manual Installation (Hard)
- Navigate to the releases page.
- Download the latest zip file.
- Unzip contents into
<jellyfin data directory>/plugins/YoutubeMetadata. - Restart Jellyfin.
- On the left navigation menu, click on Plugins.
- If successful, you will see
YoutubeMetadatawith status asActive
Usage
File Naming Requirements
All media needs to have the ID embeded in the file name within square brackets. The following are valid examples of a channel and video.
3Blue1Brown - NA - 3Blue1Brown_-_Videos [UCYO_jab_esuFRV4b17AJtAw].info.json3Blue1Brown - 20211023 - A_few_of_the_best_math_explainers_from_this_summer [F3Qixy-r_rQ].mkv
info.json and image files need to have the same file name as the media file. As an example, this would cause a breakage
3Blue1Brown - 20211023 - A_few_of_the_best_math_explainers_from_this_summer [F3Qixy-r_rQ].mkv3Blue1Brown - 20211023 [F3Qixy-r_rQ].info.json
The proper naming format is the default when using yt-dlp and is also enforced in TheFrenchGhosty's Ultimate YouTube-DL Scripts Collection which I highly recommend.
Enabling Provider
- Navigate to your
Admin Dashboard. - On the left navigation menu, click
Libraries. - Click on
for a supported library type. - Click
Manage library. - Click the checkbox next to
YoutubeMetadatafor each downloader or fetcher you wish to enable. In the image below you can see two enabled.
- Click
OK. - Click
Scan All Libraries.
Providing Cookies to YT-DLP
Warning your cookie grants access to accounts the cookie is granted for. Please protect this file if you decide to use it.
Placing a file named cookies.txt into the <jellyfin data directory>/plugins/YoutubeMetadata plugin directory will enable YT-DLP to start using your cookie.
Build and Installing from source
- Clone or download this repository.
- Ensure you have .NET Core SDK setup and installed.
- Build plugin with following command.
dotnet publish --configuration Release --output bin - Create folder named
YoutubeMetadatain thepluginsdirectory inside your Jellyfin data directory. You can find your directory by going to Dashboard, and noticing the Paths section. Mine is the root folder of the default Metadata directory.# mkdir <Jellyfin Data Directory>/plugins/YoutubeMetadata/ - Place the resulting files from step 3 in the
plugins/YoutubeMetadatafolder created in step 4.# cp -r bin/*.dll <Jellyfin Data Directory>/plugins/YoutubeMetadata/` - Be sure that the plugin files are owned by your
jellyfinuser:# chown -R jellyfin:jellyfin /var/lib/jellyfin/plugins/YoutubeMetadata/ - If performed correctly you will see a plugin named YoutubeMetadata in
Admin -> Dashboard -> Advanced -> Plugins.
Donations
If this plugin helps you, please consider a donation! You can use my ko-fi link. If you would rather donate in some way not supported yet, let me know how you would like to donate.