shoko config - shyonae/selfhosted-anime GitHub Wiki

Initial configuration

Before you set up Shoko Server, let's install Shoko Desktop, you can download it here (Download either Daily or Stable based on what version of Shoko Server you chose to use). Don't open it for now, we'll configure it later.

  • Shoko Desktop is a native Windows application, but there is a way to run it on Linux. Join their discord and check this message.
    • The people on the discord are very active and they will help, but be sure to read the pins and search in the support channel if your topic has been asked before.

NOTE: Shoko Desktop can also run on a different machine, as long as it can connect to Shoko Server, it will work.

Follow the steps on the Shoko website to run the first setup and STOP when you arrive at the Import Folders.

  • For the Community Sites I suggest turning off anything related to The TvDB and The Movie DB. Also, these are the options I use:

Now let's create some important folders:

  • You will have this kind of folder for both movies-anime and tv-anime

  • Then you will create drop folders for movies-anime and tv-anime

In the end, it will look like this:

  • Now, why did we have to create these drop folders? Well, you want them as a place to put the hardlinks from the torrent client. You want an intermediate folder because watching your entire anime folder for changes is really resource heavy and there are also kernel limits (RAM / I/O)

NOTE: If you changed the folders' Name, write them somewhere as we'll use them in a bit.

Internal Shoko Server config

# Follow the next couple of steps ONLY if you're using the daily tag.

Now that you have Shoko opened, head into the Settings and change the Other Options > Update Channel to Unstable and then click on the button above close to the WebUI Version that says Update available.

  • CLOSE the page, open a new one and connect to the server again, you should now have the new UI.

Go to the top right and click the gear icon to go into the Options, then go to the Import section and tick everything there so everything is enabled.

Under the AniDB submenu, put the UDP API Key found here (under Account) in the AVDump Key slot on Shoko, you will use this key to do AVDumps of unrecognized files. There's more info on the discord and on AniDB itself, I would advise you read it before doing anything with unrecognized files.

Before moving to Shoko Desktop, you need to install the LuaRenamer plugin. Just follow the installation steps on the page.

Make sure this plugin is present otherwise your files won't get renamed and moved to the right directories.

Shoko Desktop configuration

Once you open the application, you will need to connect to your Shoko Server instance.

Go to the Utilities tab, then on the left go to File Renaming.

In the script section, put the code found in the renamer.lua file, present in the wiki's repo (thanks to the lovely people on the Shoko Discord server):

  • This is where the name you've modified before matters, modify the -- CUSTOM CONDITION HERE -- with the relevant names, same as the ones in Shoko.

Click on Run this script when importing files into collection, make sure you've selected LuaRenamer from the drop-down menu and DONT'T FORGET to click Save. It should look like this:

And you should be set! Only Jellyfin is missing, at this point you could already try to download an anime and test if everything works thus far (with Autobrr too if you're lucky to catch a release).

  • Don't forget to check if hardlinks are working.
⚠️ **GitHub.com Fallback** ⚠️