Gaps

Gaps searches through your Plex Server or local folders for all movies, then queries for known movies in the same collection. If those movies don't exist in your library, Gaps will recommend getting those movies, legally of course.

Setup

Docker

Gaps runs in Docker, so you'll need a basic ability to download and run a container. If you already have Docker, skip to installing and running.

Underneath the covers, Gaps runs as a Spring Boot app. Don't worry about it though. The container will pull down Java for you and automatically run the jar.

Docker has a good write up on installing Docker CE. Check it out here. Once you get docker up and running

Installing and Running

With Docker installed, you'll need to now pull down the latest Gaps image. The Gaps image is hosted here.

To pull the image, run the following command in a terminal

docker pull housewrecker/gaps

You now have the Gaps image and you need to do a little configuration. The command to run Gaps follows

docker run -p 8080:8080 --name mygaps --expose 32400 housewrecker/gaps:latest

Important Notes

1. -p or publish exposes maps ports from the container to the outside world. Docker has a great write up here.

   Note: If 8080 is in us on your system, change the publish command to -p :8080

2. --name mygaps sets the name of the local running container. You can change it to whatever you want, just don't forget the name in the future!

3. --expose 32400 is there to commucate with Plex. By default, Plex is set to 32400 by default. If you've changed the port, change that here.

Once all those values are updated correctly for your system, you can run the command and Gaps will start up.

To track the logs from Gaps, use the following command. Again, change the container, if you changed the name.

 docker logs -f mygaps

Usage

To see Gaps, open up your browser and navigate over to the ip address and port you set for Gaps.

If your browser is on the same machine running Docker and you did not change the port, then you can navigate to

http://localhost:8080

Or

http://127.0.0.1:8080 

You should be presented with this screen

Landing Page

On this screen, you need to enter your Movie Database Api Key. The page has information on getting the key. The basics are that you'll need navigate over to The Movie DB, create an account, and make an API Key. Then you would copy that key into the Api Key field.

Note: Right now only searching via Plex is working. In time, I'll add back in searching by folder.

Click the Search via Plex button and move on to the next page.

Plex Configuration

With your Movie DB key added, now we need to configure the information to connect to Plex.

On this page, you'll need to configure how you connect to Plex. This includes three main things: the host/ip address of Plex, the port Plex uses, and your personal Plex Token.

The host/ip address and port are the same ones you use to connect to Plex via the web. It could look something like this

http://localhost:32400/web/index.html

Or

http://127.0.0.1:32400/web/index.html

So, in the first case the host is localhost and the port 32400. In the second case, the host is 127.0.0.1 with the same port.

Lastly, you'll need to get your personal Plex Token. If you do not know already it's easy to find. Plex has a great write up here about how to find your token.

Once you have those three, click next.

Note: In the title bar, if you ever need to jump back a bit, you can click any of the sections to make an edit.

Libraries

Here is the test if Gaps could connect to Plex.

Properties

Plex

You need to find your plex movie all URL. Plex has a great write up on to get the URL. But first you'll need to get your token. The write ups are below.

https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/ https://support.plex.tv/articles/201638786-plex-media-server-url-commands/

It will look something like this.

http://127.0.0.1:32400/library/sections/1/all/?X-Plex-Token={My-Plex-Token}

Gaps supports a single movie URL or multiple. You can adjust to your needs. Then you need to go make an account on https://www.themoviedb.org and generate an API Key. Add that key to the application.yaml file under the movieDbApiKey property.

Folder

You need to list out the folders you want to read from. Review the file types for video and make sure every type you have is covered. Make sure you enable recursive search if needed. If your files aren't in the format as specified below, be sure to update the regex to match your file name structure.

gaps:
 #Put your Plex Movie All URLs here
 #Gaps supports a single movie URL or multiple.
 #Single
 #movieUrls:
 #  - http://127.0.0.1:32400/library/sections/1/all/?X-Plex-Token={My-Plex-Token}

 #Go to https://www.themoviedb.org and make an API Key, place that key here
 #movieDbApiKey: {key}
 movieDbApiKey:

 # Optional
 # Go to https://www.themoviedb.org and make a custom list for GAPS https://www.themoviedb.org/list/<id number>
 # enter the <id number> below if you want GAPS to populate the list
 movieDbListId:

 #Should Gaps write out to a file as well as console
 writeToFile: true


 #######################################
 #
 #Can read from a folder, Plex, or both
 #At least, one of the two property groups needs to be filled in though
 #
 #######################################

 #List of folders where movies can be pulled from
 folder:
   #Required
   searchFromFolder: true

   #Required if searching from folders
   #List of folders to search in
   folders:
     - /Users/jhouse/Movies

   #Required if searching from folders
   #If the subfolder should be searched in
   recursive: true

   #Required if searching from folders
   #Add any movie formats as needed
   movieFormats:
     - avi
     - mkv
     - mp4
     - mov
     - webm
     - vob
     - flv
     - mts
     - m2ts
     - m4p
     - m4v
     - 3gp
     - 3g2

   #Movie Regex
   #Expected format is Movie Name (Year)
   #Example: The Fast and the Furious (2001)
   yearRegex: \(([1-2][0-9][0-9][0-9])\)

 #Plex connection timeouts when querying for all movies in the Plex section. Time is in seconds. Default is 180 seconds
 plex:
   searchFromPlex: false
   connectTimeout: 180
   writeTimeout: 180
   readTimeout: 180

   #Mulitple
   #movieUrls:
   #  - http://127.0.0.1:32400/library/sections/1/all/?X-Plex-Token={My-Plex-Token}
   #  - http://127.0.0.1:32400/library/sections/2/all/?X-Plex-Token={My-Plex-Token}
   #  - http://127.0.0.1:32400/library/sections/3/all/?X-Plex-Token={My-Plex-Token}
   movieUrls:

movieDbListId: <list id>

https://www.themoviedb.org/list/<list_id>
https://www.themoviedb.org/list/123456

This property will populate a list for you in your TheMovieDB account. This list can then be imported into radarr using the "add from list" feature, or other media managment software.

Enabling this feature will require user input in the terminal.

Running

Jar

You can run it with the run.bat or run.sh scripts. If you want to run command line you can run with.

java -jar Gaps.{version-number}.jar

The output will come either to a file or the console. By default the output comes to a file. Gaps will print out information about duplicate movies and movies not found in the terminal. The program takes time but in the end you will get a list of movies missing from collections you have. If you have any questions, hit me up. Feel free to put up PRs to improve this as well.

Docker

First, the container must be built:

docker build -t gaps .

Next, run the container with the environment variables:

docker run -t -e DBAPIKEY= -e PLEXADDRESS= -e WRITETOFILE= [-e TMDBLISTID= ] gaps  

In example:

docker run -t -e DBAPIKEY=myapikey -e PLEXADDRESS=http://192.168.0.10:32400/library/sections/1/all/?X-Plex-Token=plextoken -e WRITETOFILE=true [-e TMDBLISTID=id] gaps 

Multiple URL:
docker run -t -e DBAPIKEY=myapikey -e PLEXADDRESS=http://192.168.0.10:32400/library/sections/1/all/?X-Plex-Token=plextoken,http://192.168.0.10:32400/library/sections/2/all/?X-Plex-Token=plextoken  -e WRITETOFILE=true gaps

Option Properties in Docker

CONNECT_TIMEOUT

WRITE_TIMEOUT

READ_TIMEOUT

These are optional properties to help with Plex Sections that are very large. Timeouts can be set longer to help when parsing the big XML returned by Plex. They are not required and will default to 180 seconds.

docker run -t -e DBAPIKEY=myapikey -e PLEXADDRESS=http://192.168.0.10:32400/library/sections/1/all/?X-Plex-Token=plextoken -e WRITETOFILE=true -e CONNECT_TIMEOUT=180 -e WRITE_TIMEOUT=180 -e READ_TIMEOUT=180 gaps

License

Copyright 2019 Jason H House

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.