Skip to content

fdarveau/plex-auto-genres-docker

 
 

Repository files navigation

Plex Auto Genres

This is a third-party docker container to run the plex-auto-genres script (https://github.com/ShaneIsrael/plex-auto-genres) every day at 1AM UTC.

The script adds genre collection tags to your media making it much easier to search for genre specific content. It has been modified to run without any input and log fetch results to a specific folder (that can be mounted) instead of the working directory.

DockerHub

Getting started

  • Create the container. You can use the docker-compose.yml file as a template.
    • There are 2 ways to connect to your server : using your credentials and server name, or using an existing token and your server's URL.
      Variable Authentication method Value
      PLEX_USERNAME Username and password Your Plex Username
      PLEX_PASSWORD Username and password Your Plex Password
      PLEX_SERVER_NAME Username and password Your Plex Server Name
      PLEX_BASE_URL Token Your Plex Server base URL
      PLEX_TOKEN Token Your Plex Token
      PLEX_COLLECTION_PREFIX (Optional) Prefix for the created Plex collections. For example, with a value of "*", a collection named "Adventure", the name would instead be "*Adventure".

      Default value : ""
      TMDB_API_KEY Your the movie database api key (not required for anime library tagging)
  • Volume mount the /config folder that will contain the libraries for which you want the collections generated.
  • (Optional) Volume mount the /posters folder that contains the posters for the generated collections. See ShaneIsrael's repository for details about posters.
  • (Optional) Volume mount the /logs folder that will contain the log files. The files can still be accessed by connecting to the container if it is not mounted.
    • Titles in the log files will not be re-processed. You must delete the log files to start a fresh run.
  • Run the container once to generate the initial config file.
  • Edit the generated config file (libraries.txt).
    • Supported types :
      • standard-tv
      • standard-movie
      • anime
  • Run manully (see Manual run) to check if it works or wait for the next automatic run.

Manual run

You can start a manual run by connecting to the container's terminal and running the command

/generate-collections.sh

Troubleshooting

  1. If you are not seeing any new collections close your plex client and re-open it.
  2. Delete the generated plex-*-finished.txt and plex-*-failures.txt files if you want the script to generate collections from the beginning. You may want to do this if you delete your collections and need them re-created.
  3. Having the release year in the title of a tv show or movie can cause the lookup to fail in some instances. For example Battlestar Galactica (2003) will fail, but Battlestar Galactica will not.

About

Docker container for the plex-auto-genres script (https://github.com/ShaneIsrael/plex-auto-genres)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 87.8%
  • Shell 8.3%
  • Dockerfile 3.9%