Mirrors/Plex-Meta-Manager
2
0
Fork 0
mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-11-14 00:37:22 +00:00
Code Issues Projects Releases Packages Wiki Activity
Plex-Meta-Manager/docs/home/guides/unraid.md
meisnate12 2d597021b8 bump to 1.18.2
2023-01-03 17:07:05 -05:00

3.6 KiB
Raw Blame History

unRAID Walkthrough

Thankfully, getting Plex Meta Manager working on unRAID is a fairly simple task. unRAID works mostly with docker containers, so the pre-built container available on docker hub works perfectly with a little configuration. To install a container from docker hub, you will need community applications - a very popular plugin for unRAID servers. If you don't already have this installed, you can install it here

Basic Installation

  1. Head to the Apps tab of unRAID (Community Applications), and search plex meta manager in the upper right search box. There will be a couple of results shown, but you should ignore them (Why?) and use the official image.

  2. Click the Install button on the Template from Sohjiro's Repository Tools.

  3. Choose which branch you want to run latest, develop, or nightly.

  4. Click Show more settings... to set any Environmental Variables you wish to use. None are required for PMM to work.

    • For example if you wish to have the container perform a run immediately and then shut down set Run Immediately (--run) to true.

  5. Hit Apply, and allow unRAID to download the docker container.

  6. Navigate to the Docker tab in unRAID, and stop the plex-meta-manager container if it has auto-started.

  7. Create config.yml and library.yml files as-per the documentation in the Host Path you set (/mnt/user/appdata/plex-meta-manager by default)

  8. Once finished, run the container. Voila! Logs are located in yourhostpath/logs.

Advanced Installation (Authenticating Trakt or MyAnimeList)

Due to how unRAID handles docker containers, it can be a little confusing at first to enable Trakt, MyAnimeList, and other sources. At this time, these sources require you to follow through to a URL, and provide a code or link to Plex Meta Manager. unRAID doesn't have a built-in way to interact with the terminals of docker containers, so a workaround must be used:

  1. Stop the Plex Meta Manager docker container if it's currently running.

  2. Follow the instructions for either Trakt or MyAnimeList, and add the relevant values to your config.yml

  3. Edit the Time to Run variable to reflect a time that is NOT the current time. We don't want the script to be running right now. Set Run to false if you've chosen to add that variable. Then, start the container.

  4. Click the Terminal button in the upper right corner of the unRAID WebUI (>_)

  5. Run docker exec -it plex-meta-manager /bin/bash

    Note: this name is case-sensitive. If this gives you an error like "Error: No such container: plex-meta-manager"; check the container config to see if you've named it something like "Plex-Meta-Manager", If that's the case, change the name in the command to match your container.

  6. Run ls to make sure you're in the same directory as plex_meta_manager.py. If you don't see the script, run cd /

  7. Run python plex_meta_manager.py -r, and watch as the script comes to life.

  8. You'll now notice, as per the configuration documentation on these sources, the script will ask you to click a URL and return an input. Go ahead and do so in this terminal window.

  9. Once finished, and the script succeeds in connecting to your source, press Ctrl + C to cancel the script - and close out of the terminal window. Go ahead and stop the docker container, restore your container settings to your original preferences (restore Time to Run), and start the container.