Shoko Docs

Appearance

Installing Shokofin ​

Shokofin is a plugin for Jellyfin that works in tandem with Shoko Server to provide metadata tailored to your personal anime collection. For information on what Shoko Server is and the benefits that can come from using it to identify and manage your collection, visit our Home page or explore these docs before you attempt to set up Shokofin.

Pre-Requirements

Before installing Shokofin it is required that you have already set up and are using Shoko Server and that the files you intend to display in Jellyfin are indexed (and optionally managed) by Shoko Server. Otherwise, the plugin won't be able to provide any metadata for your files, because there is simply no metadata to provide for them. You can use the Installing Shoko Server guide to properly install and configure Shoko Server before setting up Shokofin.

Taking the First Step ​

There are multiple ways to install this plugin, but the recommended way is to use our Official Jellyfin Repository.

Below lists the corresponding versions of Jellyfin and Shoko Server that are compatible with Shokofin. Be sure to install the correct version for your setup to guarantee functionality.

ShokofinJellyfinShoko Server

0.x.x

10.7

4.0.0 — 4.1.2

1.x.x

10.7

4.1.0 — 4.1.2

2.x.x

10.8

4.1.2

3.x.x

10.8

4.2.0

4.0.0 — 4.1.1

10.9

4.2.2

4.2.0 — 4.2.2

10.9

4.2.2 — 5.0.0

5.x.x

10.10

5.0.0

dev

10.10

daily

Official Repository ​

  1. Navigate to the Dashboard
  2. Under the Plugins section in the side-bar, go to Catalog.
  3. At the top of the catalog page, click the ⚙ Gear icon that's next to the help button.
  4. Add new repository by clicking on the + Plus icon and enter the following details;
    • Repository Name: Shokofin Stable
    • Repository URL: https://raw.githubusercontent.com/ShokoAnime/Shokofin/metadata/stable/manifest.json
  5. Click on Catalog under the Plugins section in the sidebar.
  6. Scroll down until you find Shoko under the Metadata section and click it.
  7. Click the blue Install button. You will get a pop-up warning you about using untrusted plugins. Click Ok.
  8. Restart Jellyfin to apply the changes.

Dev Builds

To install the development builds, use the following repository URL instead:

https://raw.githubusercontent.com/ShokoAnime/Shokofin/metadata/dev/manifest.json

Github Releases ​

  1. Download the shoko_*.zip file from the latest release from GitHub.
  2. Extract the contained *.dlls and meta.json, place the files in a folder named Shokofin, and copy this folder to the plugins folder inside the Jellyfin data directory. Refer to the "Data Directory" section on this page for where to find your Jellyfin install.
  3. Start or restart your server to apply the changes.

Next Steps ​

Congratulations! If everything went well, Shokofin should now be installed. Proceed to the next page for instructions on how to connect Shokofin to your Shoko Server instance along with any other configuration steps needed to properly setup Shokofin for recognizing your anime library.