• Introduction
• Requirements
• Installation
• Configuration
  • Example
  • Basics
  • Docker
  • Plex Media Server
  • Plex Autoscan Server
  • Google Drive Monitoring
  • Rclone Crypt Monitoring
  • Rclone Remote Control
• Setup
  • Sonarr
  • Radarr
  • Lidarr

Plex Autoscan is a python script that assists in the importing of Sonarr, Radarr, and Lidarr dowloads into Plex Media Server.

It does this by creating a webserver to accept webhook requests from these apps, and in turn, sends a scan request to Plex. Plex will then only scan the parent folder (i.e. season folder for TV shows, movie folder for movies, and album folders for music) of the media file (versus scanning the entire library folder).

In addition to the above, Plex Autoscan can also monitor Google Drive for updates. When a new file is detected, it is checked against the Plex database and if this file is missing, a new scan request is sent to Plex (see section below).

Plex Autoscan is installed on the same server as the Plex Media Server.

1. Ubuntu/Debian

2. Python 2.7 or higher (sudo apt install python python-pip).

3. requirements.txt modules (see below).

1. cd /opt

2. sudo git clone https://github.com/l3uddz/plex_autoscan

3. sudo chown -R user:group plex_autoscan - Run id to find your user / group.

4. cd plex_autoscan

5. sudo python -m pip install -r requirements.txt

6. python scan.py sections - Run once to generate a default config.json file.

7. /opt/plex_autoscan/config/config.json - Configure settings (do this before moving on).

8. sudo cp /opt/plex_autoscan/system/plex_autoscan.service /etc/systemd/system/

9. sudo systemctl daemon-reload

10. sudo systemctl enable plex_autoscan.service

11. sudo systemctl start plex_autoscan.service

Note: Changes to config file require a restart of the Plex Autoscan service: sudo systemctl restart plex_autoscan.service.

{
  "DOCKER_NAME": "plex",
  "GDRIVE": {
    "CLIENT_ID": "",
    "CLIENT_SECRET": "",
    "ENABLED": false,
    "TEAMDRIVE": false,
    "POLL_INTERVAL": 60,
    "IGNORE_PATHS": [],
    "ALLOW_PATHS": [],
    "SCAN_EXTENSIONS":[
      "webm","mkv","flv","vob","ogv","ogg","drc","gif",
      "gifv","mng","avi","mov","qt","wmv","yuv","rm",
      "rmvb","asf","amv","mp4","m4p","m4v","mpg","mp2",
      "mpeg","mpe","mpv","m2v","m4v","svi","3gp","3g2",
      "mxf","roq","nsv","f4v","f4p","f4a","f4b","mp3",
      "flac","ts"
    ],
  "SHOW_CACHE_MESSAGES": false
  },
  "PLEX_ANALYZE_DIRECTORY": true,
  "PLEX_ANALYZE_TYPE": "basic",
  "PLEX_DATABASE_PATH": "/var/lib/plexmediaserver/Library/Application Support/Plex Media Server/Plug-in Support/Databases/com.plexapp.plugins.library.db",
  "PLEX_EMPTY_TRASH": false,
  "PLEX_EMPTY_TRASH_CONTROL_FILES": [
    "/mnt/unionfs/mounted.bin"
  ],
  "PLEX_EMPTY_TRASH_MAX_FILES": 100,
  "PLEX_EMPTY_TRASH_ZERO_DELETED": false,
  "PLEX_LD_LIBRARY_PATH": "/usr/lib/plexmediaserver",
  "PLEX_LOCAL_URL": "http://localhost:32400",
  "PLEX_SCANNER": "/usr/lib/plexmediaserver/Plex\\ Media\\ Scanner",
  "PLEX_SECTION_PATH_MAPPINGS": {
    "1": [
      "/Movies/"
    ],
    "2": [
      "/TV/"
    ]
  },
  "PLEX_SUPPORT_DIR": "/var/lib/plexmediaserver/Library/Application\\ Support",
  "PLEX_TOKEN": "",
  "PLEX_USER": "plex",
  "PLEX_WAIT_FOR_EXTERNAL_SCANNERS": true,
  "RCLONE_RC_CACHE_EXPIRE": {
    "ENABLED": false,
    "MOUNT_FOLDER": "/mnt/rclone",
    "RC_URL": "http://localhost:5572"
  },
  "RCLONE_CRYPT": {
    "ENABLED": false,
    "CRYPT_FOLDER": "My Drive/crypt",
    "PATH": "/usr/bin/rclone",
    "CONFIG_FILE": "/home/thompsons/.config/rclone/rclone.conf",
    "CRYPT_REMOTE": "gdrive-crypt:"
  },
  "RUN_COMMAND_BEFORE_SCAN": "",
  "RUN_COMMAND_AFTER_SCAN": "",
  "SERVER_ALLOW_MANUAL_SCAN": false,
  "SERVER_FILE_EXIST_PATH_MAPPINGS": {
      "/mnt/unionfs/media/": [
          "/data/"
      ]
  },
  "SERVER_IGNORE_LIST": [
    "/.grab/",
    ".DS_Store",
    "Thumbs.db"
  ],
  "SERVER_IP": "0.0.0.0",
  "SERVER_MAX_FILE_CHECKS": 10,
  "SERVER_FILE_CHECK_DELAY": 60,
  "SERVER_PASS": "9c4b81fe234e4d6eb9011cefe514d915",
  "SERVER_PATH_MAPPINGS": {
      "/mnt/unionfs/": [
          "/home/seed/media/fused/"
      ]
  },
  "SERVER_PORT": 3468,
  "SERVER_SCAN_DELAY": 180,
  "SERVER_SCAN_FOLDER_ON_FILE_EXISTS_EXHAUSTION": false,
  "SERVER_SCAN_PRIORITIES": {
    "1": [
      "/Movies/"
    ],
    "2": [
      "/TV/"
    ]
  },
  "SERVER_USE_SQLITE": true,
  "USE_DOCKER": false,
  "USE_SUDO": false
}

"USE_SUDO": true

USE_SUDO - This option is typically used in conjunction with PLEX_USER (e.g. sudo -u plex).

• If the user that runs your Plex Autoscan server is able to run the Plex Media Scanner CLI command without sudo, or is installed with the same user account (e.g. plex), you can you can set this to false.

• The user that runs plex_autoscan needs to beable to sudo, without a password otherwise, it cannot execute the PLEX_SCANNER as plex. This can be disabled by config option USE_SUDO.

• Default is true.

Docker specific options.

Note: Docker examples used below are based on the image by plexinc/pms-docker, with /config/ in the container path mapped to /opt/plex/ on the host.

"USE_DOCKER": true,
"DOCKER_NAME": "plex",

USE_DOCKER - Set to true when Plex is in a Docker container. Default is false.

DOCKER_NAME - Name of the Plex docker container. Default is "plex".

Plex Media Server options.

"PLEX_USER": "plex",
"PLEX_WAIT_FOR_EXTERNAL_SCANNERS": true,
"PLEX_ANALYZE_TYPE": "basic",
"PLEX_ANALYZE_DIRECTORY": true,

PLEX_USER - User account that Plex runs as.

• Native Install: "plex"

• Docker Install: "plex" (user account within the container).

PLEX_WAIT_FOR_EXTERNAL_SCANNERS - When set to true, wait for other Plex Media Scanner processes to finish, before launching a new one.

• For hosts running a single Plex Docker instance, this can be left as true. For multiple Plex Docker instances on a host, set this as false.

PLEX_ANALYZE_TYPE - How Plex will analyze the media files that are scanned. Options are off, basic, deep. off will disable analyzing. Default is basic.

PLEX_ANALYZE_DIRECTORY - When set to true, Plex will analyze all the media files in the parent folder (e.g. movie folder, season folder) vs just the newly added file. Default is true.

Note: Verify the settings below by running the Plex Section IDs command (see below).

"PLEX_LD_LIBRARY_PATH": "/usr/lib/plexmediaserver",

"PLEX_SCANNER": "/usr/lib/plexmediaserver/Plex\\ Media\\ Scanner",

"PLEX_SUPPORT_DIR": "/var/lib/plexmediaserver/Library/Application\\ Support",

"PLEX_DATABASE_PATH": "/var/lib/plexmediaserver/Library/Application Support/Plex Media Server/Plug-in Support/Databases/com.plexapp.plugins.library.db",

PLEX_LD_LIBRARY_PATH

• Native Install: "/usr/lib/plexmediaserver"

• Docker Install: "/usr/lib/plexmediaserver" (path within the container).

PLEX_SCANNER - Location of Plex Media Scanner binary.

• Native Install: "/usr/lib/plexmediaserver/Plex\\ Media\\ Scanner"

• Docker Install: "/usr/lib/plexmediaserver/Plex\\ Media\\ Scanner" (path within the container).

PLEX_SUPPORT_DIR - Location of Plex "Application Support" path.

• Native Install: "/var/lib/plexmediaserver/Library/Application\\ Support"

• Docker Install: "/var/lib/plexmediaserver/Library/Application\\ Support" (path within the container).

PLEX_DATABASE_PATH - Location of Plex library database.

• Native Install: "/var/lib/plexmediaserver/Library/Application Support/Plex Media Server/Plug-in Support/Databases/com.plexapp.plugins.library.db"

• Docker Install: "/opt/plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases/com.plexapp.plugins.library.db" (path on the host)

Running the following command, will return a list of Plex Library Names and their corresponding Section IDs (sorted by alphabetically Library Name):

python scan.py sections

This will be in the format of:

SECTION ID #: LIBRARY NAME

Sample output:

 2018-06-23 08:28:26,910 -     INFO -    CONFIG [140425529542400]: Using default setting --loglevel=INFO
 2018-06-23 08:28:26,910 -     INFO -    CONFIG [140425529542400]: Using default setting --cachefile=cache.db
 2018-06-23 08:28:26,910 -     INFO -    CONFIG [140425529542400]: Using default setting --tokenfile=token.json
 2018-06-23 08:28:26,910 -     INFO -    CONFIG [140425529542400]: Using default setting --queuefile=queue.db
 2018-06-23 08:28:26,910 -     INFO -    CONFIG [140425529542400]: Using default setting --logfile=plex_autoscan.log
 2018-06-23 08:28:26,910 -     INFO -    CONFIG [140425529542400]: Using default setting --config=config/config.json
 2018-06-23 08:28:27,069 -     INFO -  AUTOSCAN [140425529542400]:
        _                         _
  _ __ | | _____  __   __ _ _   _| |_ ___  ___  ___ __ _ _ __
 | '_ \| |/ _ \ \/ /  / _` | | | | __/ _ \/ __|/ __/ _` | '_ \
 | |_) | |  __/>  <  | (_| | |_| | || (_) \__ \ (_| (_| | | | |
 | .__/|_|\___/_/\_\  \__,_|\__,_|\__\___/|___/\___\__,_|_| |_|
 |_|

#########################################################################
# Author:   l3uddz                                                      #
# URL:      https://github.com/l3uddz/plex_autoscan                     #
# --                                                                    #
# Part of the Cloudbox project: https://cloudbox.works                  #
#########################################################################
# GNU General Public License v3.0                                       #
#########################################################################

 2018-06-23 08:28:27,070 -     INFO -      PLEX [140425529542400]: Using Plex Scanner
  1: Movies
  2: TV

This tells Plex what library sections to map the media paths to when the Plex Scanner command is ran.

Format:

"PLEX_SECTION_PATH_MAPPINGS": {
  "SECTION ID #": [
    "/path/to/library/"
  ]
},

For example, if a request is sent to scan a filepath with /Movies/ in it, then to map it to Section ID 1, and to map filepath /TV to Section ID 2.

Example:

"PLEX_SECTION_PATH_MAPPINGS": {
  "1": [
    "/Movies/"
  ],
  "2": [
    "/TV/"
  ]
},

If you have a complex library setup, you will need to specfiy the child paths as well:

Example:

"PLEX_SECTION_PATH_MAPPINGS": {
  "1": [
    "/Movies/Movies/"
  ],
  "2": [
    "/Movies/Movies-4K/"
  ],
  "3": [
    "/Movies/Movies-Foreign/"
  ],
  "4": [
    "/TV/"
  ]
},

When media is upgraded by Sonarr/Radarr/Lidarr, the previous files are then deleted. When Plex gets the scan request after the upgrade, the new media is added in to the library, but the previous media files would still be listed there but labeled as "unavailable".

To remedy this, a trash emptying command needs to be sent to Plex to get rid of these missing files from the library. The options below enable that to happen.

"PLEX_TOKEN": "abcdefghijkl",
"PLEX_LOCAL_URL": "http://localhost:32400",
"PLEX_EMPTY_TRASH": true,
"PLEX_EMPTY_TRASH_CONTROL_FILES": [
  "/mnt/unionfs/mounted.bin"
],
"PLEX_EMPTY_TRASH_MAX_FILES": 100,
"PLEX_EMPTY_TRASH_ZERO_DELETED": true,

PLEX_TOKEN - Plex Access Token.

• Run the Plex Token script by Werner Beroux: /opt/plex_autoscan/scripts/plex_token.sh, or

• Visit https://support.plex.tv/hc/en-us/articles/204059436-Finding-an-authentication-token-X-Plex-Token

PLEX_LOCAL_URL - Local URL of the Plex Media Server.

• Native Install: "http://localhost:32400"

• Docker Install: "http://localhost:32400" (open port)

PLEX_EMPTY_TRASH - When set to true, empty trash of a section after a scan.

PLEX_EMPTY_TRASH_CONTROL_FILES - Only empty trash when this file exists. Useful when media files, located elsewhere, is mounted on the Plex Server host. Can be left blank if not needed.

PLEX_EMPTY_TRASH_MAX_FILES - The maximum amount of missing files to remove from Plex at one emptying trash request. If there are more missing files than the number listed, the emptying trash request is aborted. This is particularly useful when externally mounted media temporarily dismounts and a ton of files go "missing" in Plex. Default is 100.

PLEX_EMPTY_TRASH_ZERO_DELETED - When set to true, will always empty the trash on the scanned section, even if there are 0 missing files. If false, trash will only be emptied when the database returns more than 0 deleted items. Default is false.

"SERVER_IP": "0.0.0.0",
"SERVER_PASS": "9c4b81fe234e4d6eb9011cefe514d915",
"SERVER_PORT": 3468,
"SERVER_SCAN_DELAY": 180,

SERVER_IP - Server IP that Plex Autoscan will listen on. Default is 0.0.0.0.

• 0.0.0.0 - Allow remote access (e.g. Sonarr/Radarr/Lidarr running on another/remote server).

• 127.0.0.1 - Local access only.

SERVER_PORT - Port that Plex Autoscan will listen on.

SERVER_PASS - Plex Autoscan password. Used to authenticate requests from Sonarr/Radarr/Lidarr. Default is a random 32 character string generated during config build.

• Your webhook URL will look like: http://ipaddress:3468/server_pass (or http://localhost:3468/server_pass if local only).

SERVER_SCAN_DELAY - How long (in seconds) Plex Autoscan will wait before sending a scan request to Plex.

• This is useful, for example, when you want Plex Autoscan to wait for more episodes of the same TV show to come in before scanning the season folder, resulting in less work for Plex to do by not scannin the same folder multiple times. This works especially well with SERVER_USE_SQLITE enabled.

List of paths that will be remapped before being scanned by Plex.

This is particularly useful when receiving scan requests, from a remote Sonarr/Radarr/Lidarr installation, that has different paths for the media.

Format:

"SERVER_PATH_MAPPINGS": {
    "/path/on/local/plex/host/": [  <--- Plex Library path
        "/path/on/sonarr/host/"  <--- Sonarr root path
    ]
},

Note: This format is used regardless of whether Sonarr is on the same server as Plex or not.

Example:

"SERVER_PATH_MAPPINGS": {
    "/mnt/unionfs/": [
        "/home/seed/media/fused/"
    ]
},

Format:

"SERVER_PATH_MAPPINGS": {
    "/path/in/plex/container/": [  <--- Plex Library path
        "/path/from/sonarr/container/"  <--- Sonarr root path
    ]
},

Example:

"SERVER_PATH_MAPPINGS": {
  "/data/Movies/": [
    "/movies/"
  ]
}

If the filepath that was reported to Plex Autoscan by Radarr was /home/seed/media/fused/Movies/Die Hard/Die Hard.mkv then the path that would be scanned by Plex would be /mnt/unionfs/Movies/Die Hard/Die Hard.mkv.

You can also have more than one folder paths pointing to a single one.

Example:

"SERVER_PATH_MAPPINGS": {
  "/data/Movies/": [
    "/media/movies/",
    "/local/movies/"
  ]
}

After a SERVER_SCAN_DELAY, Plex Autoscan will check to see if file exists before sending a scan request to Plex.

"SERVER_MAX_FILE_CHECKS": 10,
"SERVER_FILE_CHECK_DELAY": 60,
"SERVER_SCAN_FOLDER_ON_FILE_EXISTS_EXHAUSTION": false,

SERVER_MAX_FILE_CHECKS - The number specifies how many times this check will occur, before giving up. If set to 0, this check will not occur, and Plex Autoscan will simply send the scan request after the SERVER_SCAN_DELAY. Default is 10.

SERVER_FILE_CHECK_DELAY - Delay in seconds between two file checks. Default is 60.

SERVER_SCAN_FOLDER_ON_FILE_EXISTS_EXHAUSTION - Plex Autoscan will scan the media folder when the file exist checks (as set above) are exhausted. Default is false.

List of paths that will be remapped before file exist checks are done.

This is particularly useful when using Docker, since the folder being scanned by the Plex container, may be different to the path on the host system running Plex Autoscan.

Format:

"SERVER_FILE_EXIST_PATH_MAPPINGS": {
    "/actual/path/on/host/": [
        "/path/from/plex/container/"
    ]
},

Example:

"SERVER_FILE_EXIST_PATH_MAPPINGS": {
    "/mnt/unionfs/media/": [
        "/data/"
    ]
},

You can leave this empty if it is not required:

"SERVER_FILE_EXIST_PATH_MAPPINGS": {
},

"SERVER_USE_SQLITE": true,

Plex Autoscan can use an optionally use a database to store queue requests. The benefits to using this are 1) Queue will be restored on Plex Autoscan restart, and 2) Multiple requests to the same folder can be merged into a single folder scan.

This would look like:

Already processing '/data/TV/TV-Anime/Persona 5 the Animation/Season 1/Persona 5 the Animation - s01e01 - I am thou, thou art I.mkv' from same folder, aborting adding an extra scan request to the queue.
Scan request from Sonarr for '/data/TV/TV-Anime/Persona 5 the Animation/Season 1/Persona 5 the Animation - s01e01 - I am thou, thou art I.mkv', sleeping for 180 seconds...

The 180 seconds in the example above are from the SERVER_SCAN_DELAY, if any more requests come in during this time, the scan request will be delayed by another 180 seconds.

"RUN_COMMAND_BEFORE_SCAN": "",
"RUN_COMMAND_AFTER_SCAN": "",
"SERVER_ALLOW_MANUAL_SCAN": false,
"SERVER_IGNORE_LIST": [
  "/.grab/",
  ".DS_Store",
  "Thumbs.db"
],
"SERVER_SCAN_PRIORITIES": {
  "1": [
    "/Movies/"
  ],
  "2": [
    "/TV/"
  ]
},

RUN_COMMAND_BEFORE_SCAN - If a command is supplied, it is executed before the Plex Media Scanner command.

RUN_COMMAND_AFTER_SCAN - If a command is supplied, it is executed after the Plex Media Scanner, Empty Trash and Analyze commands.

SERVER_ALLOW_MANUAL_SCAN - When enabled, allows GET requests to the webhook URL to allow manual scans on a specific filepath. Default is false.

• All path mappings and section ID mappings, of the server, apply.

• This is also a good way of testing your configuration, manually.

• To send a manual scan, you can either:

  • Visit your webhook url in a browser (e.g. http://ipaddress:3468/0c1fa3c9867e48b1bb3aa055cb86), and fill in the path to scan.

    

    or

  • Initiate a scan via HTTP (e.g. curl):

    curl -d "eventType=Manual&filepath=/mnt/unionfs/Media/Movies/Shut In (2016)/Shut In (2016) - Bluray-1080p.x264.DTS-GECKOS.mkv" http://ipaddress:3468/0c1fa3c9867e48b1bb3aa055cb86`

SERVER_IGNORE_LIST - List of paths or filenames to ignore when a requests is sent to Plex Autoscan manually (see above). Case senstive.

• For example, curl -d "eventType=Manual&filepath=/mnt/unionfs/Media/Movies/Thumbs.db" http://ipaddress:3468/0c1fa3c9867e48b1bb3aa055cb86 would be ignored if Thumbs.db was in the ignore list.

SERVER_SCAN_PRIORITIES - What paths are picked first when multiple scan requests are being processed.

• This section is similar to PLEX_SECTION_PATH_MAPPINGS mentioned earlier.

• Format:

  "SERVER_SCAN_PRIORITIES": {
    "PRIORITY LEVEL#": [
      "/path/to/library/in/Plex"
    ],
  },

As mentioned earlier, Plex Autoscan can monitor Google Drive for changes. It does this by utilizing a proactive cache (vs building a cache from start to end).

Once a change is detected, the file will be checked against the Plex database to make sure this is not already there. If this match comes back negative, a scan request for the parent folder is added into the process queue, and if that parent folder is already in the process queue, the duplicate request will be ignored.

Note: To use Google Drive Monitoring with rclone crypt encryption you must enable and configure the Rclone Crypt Monitoring.

"GDRIVE": {
  "CLIENT_ID": "",
  "CLIENT_SECRET": "",
  "ENABLED": false,
  "TEAMDRIVE": false,
  "POLL_INTERVAL": 60,
  "IGNORE_PATHS": [],
  "ALLOW_PATHS": [],
  "SCAN_EXTENSIONS":[
    "webm","mkv","flv","vob","ogv","ogg","drc","gif",
    "gifv","mng","avi","mov","qt","wmv","yuv","rm",
    "rmvb","asf","amv","mp4","m4p","m4v","mpg","mp2",
    "mpeg","mpe","mpv","m2v","m4v","svi","3gp","3g2",
    "mxf","roq","nsv","f4v","f4p","f4a","f4b","mp3",
    "flac","ts"
  ],
  "SHOW_CACHE_MESSAGES": false
},

ENABLED - Enable or Disable Google Drive Monitoring. Requires one time authorization, see below.

CLIENT_ID - Google Drive API Client ID.

CLIENT_SECRET - Google Drive API Client Secret.

POLL_INTERVAL - How often to check for Google Drive changes (in seconds).

SCAN_EXTENSIONS - File files to be monitored via their file extensions.

IGNORE_PATHS - List of paths to ignore changes from; don't send scan requests for any changes that start with these file paths.

• Examples:

  • My Drive:

    "IGNORE_PATHS": [
        "My Drive/Backups/",
        "My Drive/Crypt/",
        "My Drive/downloads/",
        "My Drive/home/"
    ],

  • Teamdrive:

    "IGNORE_PATHS": [
        "shared_movies/foreign/",
        "shared_movies/kids/"
    ],

ALLOW_PATHS - List of paths to allow changes from. When this is filled in, IGNORE_PATHS field above is ignored.

• Examples:

  • My Drive:

    "ALLOW_PATHS": [
      "My Drive/Media/"
    ],

  • Teamdrive:

    "ALLOW_PATHS": [
      "shared_movies/Media/"
    ],

TEAMDRIVE - Enable or Disable monitoring of changes inside Team Drives.

Note: For the TEAMDRIVE setting to take effect, you must generate the token and authorize, while this set to true.

SHOW_CACHE_MESSAGES - Show cache messages from Google Drive. Default is false.

To set this up:

1. Edit config.json file, to enable the Google Drive monitoring and fill in your Google Drive API Client ID and Secret.

   "CLIENT_ID": "yourclientid",
   "CLIENT_SECRET": "yourclientsecret",
   "ENABLED": true,

2. Next, you will need to authorize Google Drive.

   scan.py authorize

3. Visit the link shown to get the authorization code and paste that in and hit enter.

   2018-06-24 05:50:14,945 -     INFO -    CONFIG [140446220769088]: Using default setting --loglevel=INFO
   2018-06-24 05:50:14,945 -     INFO -    CONFIG [140446220769088]: Using default setting --cachefile=/opt/plex_autoscan/cache.db
   2018-06-24 05:50:14,945 -     INFO -    CONFIG [140446220769088]: Using default setting --tokenfile=/opt/plex_autoscan/token.json
   2018-06-24 05:50:14,946 -     INFO -    CONFIG [140446220769088]: Using default setting --queuefile=/opt/plex_autoscan/queue.db
   2018-06-24 05:50:14,946 -     INFO -    CONFIG [140446220769088]: Using default setting --logfile=/opt/plex_autoscan/plex_autoscan.log
   2018-06-24 05:50:14,946 -     INFO -    CONFIG [140446220769088]: Using default setting --config=/opt/plex_autoscan/config/config.json
   2018-06-24 05:50:15,222 -     INFO -  AUTOSCAN [140446220769088]:
         _                         _
   _ __ | | _____  __   __ _ _   _| |_ ___  ___  ___ __ _ _ __
   | '_ \| |/ _ \ \/ /  / _` | | | | __/ _ \/ __|/ __/ _` | '_ \
   | |_) | |  __/>  <  | (_| | |_| | || (_) \__ \ (_| (_| | | | |
   | .__/|_|\___/_/\_\  \__,_|\__,_|\__\___/|___/\___\__,_|_| |_|
   |_|
   
   #########################################################################
   # Author:   l3uddz                                                      #
   # URL:      https://github.com/l3uddz/plex_autoscan                     #
   # --                                                                    #
   # Part of the Cloudbox project: https://cloudbox.works                  #
   #########################################################################
   # GNU General Public License v3.0                                       #
   #########################################################################
   
   Visit https://accounts.google.com/o/oauth2/v2/auth?scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fdrive&redirect_uri=urn%3Aietf%3Awg%3Aoauth%3A2.0%3Aoob&response_type=code&client_id=&access_type=offline and authorize against the account you wish to use
   Enter authorization code:
   

4. When access token retrieval is successfull, you'll see this:

   2018-06-24 05:57:58,252 -     INFO -    GDRIVE [140007964366656]: Requesting access token for auth code '4/AAAfPHmX9H_kMkMasfdsdfE4r8ImXI_BddbLF-eoCOPsdfasdfHBBzffKto'
   2018-06-24 05:57:58,509 -     INFO -    GDRIVE [140007964366656]: Retrieved first access token!
   2018-06-24 05:57:58,511 -     INFO -  AUTOSCAN [140007964366656]: Access tokens were successfully retrieved!
   

   Note: Message stating Segmentation fault at the end can be ignored.

5. You will now need to add in your Google Drive paths into SERVER_PATH_MAPPINGS. This will tell Plex Autoscan to map Google Drive paths to their local counter part.

   i. Native install

   • Format:

     "SERVER_PATH_MAPPINGS": {
         "/path/on/local/host": [
             "/path/on/sonarr/host/",
             "path/on/google/drive/"
         ]
     },

     Note 1: The Google Drive path does not start with a forward slash (/). Paths in My Drive will start with just My Drive/. and paths in a Google Teamdrive will start with teamdrive_name/.

     Note 2: Foreign users of Google Drive might not see My Drive listed on their Google Drive. They can try using the My Drive/... path or see what the log shows and match it up to that. One example is Mon\u00A0Drive/ for French users.

   • For example, if you store your files under My Drive's Media folder (My Drive/Media/...), the server path mappings will look like this:

     "SERVER_PATH_MAPPINGS": {
       "/mnt/unionfs/Media/Movies/": [
         "/home/seed/media/fused/"
         "My Drive/Media/Movies/"
       ],
     },

   • For example, if you store your files under a Google Teamdrive called "shared_movies" and within a Media folder (shared_movies/Media/...), the server path mappings will look like this:

     "SERVER_PATH_MAPPINGS": {
       "/mnt/unionfs/Media/Movies/": [
         "/home/seed/media/fused/"
         "shared_movies/Media/Movies/"
       ],
     },
         ```
                 

   ii. Docker install

   • Format:

     "SERVER_PATH_MAPPINGS": {
         "/path/in/plex/container/": [
            "/path/from/sonarr/container/",
            "path/on/google/drive/"
         ]
     },

     Note 1: The Google Drive path does not start with a forward slash (/). Paths in My Drive will start with just My Drive/. and paths in a Google Teamdrive will start with teamdrive_name/.

     Note 2: Foreign users of Google Drive might not see My Drive listed on their Google Drive. They can try using the My Drive/... path or see what the log shows and match it up to that. One example is Mon\u00A0Drive/ for French users.

   • For example, if you store your files under Google Drive's My Drive Media folder (My Drive/Media/...) AND run Plex in a docker container, the server path mappings will look like this:

     "SERVER_PATH_MAPPINGS": {
       "/data/Movies/": [
         "/movies/",
         "My Drive/Media/Movies/"
       ]
     }

   • For example, if you store your files under Google Drive's Teamdrive called "shared_movies" and within a Media folder (shared_movies/Media/...) AND run Plex in a docker container, the server path mappings will look like this:

     "SERVER_PATH_MAPPINGS": {
       "/data/Movies/": [
         "/movies/",
         "shared_movies/Media/Movies/"
       ]
     }

6. Google Drive Monitoring is now setup.

As mentioned earlier, Plex Autoscan can monitor Google Drive for changes. If your mounted Google Drive is encrypted using rclone crypt, Plex Autoscan can also decrypt the filenames to process the unencrypted files.

Note: To use rclone crypt monitoring you must first enable and configure Google Drive Monitoring.

"RCLONE_CRYPT": {
    "ENABLED": false,
    "CRYPT_FOLDER": "My Drive/crypt",
    "RCLONE_PATH": "/usr/bin/rclone",
    "CONFIG_FILE": "/home/thompsons/.config/rclone/rclone.conf",
    "CRYPT_REMOTE": "gdrive-crypt:"
},

ENABLED - Enable or Disable rclone crypt monitoring.

CRYPT_FOLDER - Google Drive folder containing your rclone crypt encrypted remote.

PATH - Path to rclone binary.

CONFIG_FILE - Path to rclone config file containing crypt remote configuration.

CRYPT_REMOTE - Name of crypt remote as listed in rclone config.

1. You will now need to add in your rclone crypt paths on Google Drive into SERVER_PATH_MAPPINGS. This will tell Plex Autoscan to map rclone crypt paths on Google Drive to their local counter part.

   i. Native install

   • Format:

     "SERVER_PATH_MAPPINGS": {
         "/path/on/local/host": [
             "/path/on/sonarr/host/",
             "path/to/rclone/crypt/on/Google/Drive/"
         ]
     },

     Note 1: The rclone crypt Google Drive path does not start with a forward slash (/). Paths in My Drive will start with just My Drive/. and paths in a Google Teamdrive will start with teamdrive_name/.

     Note 2: Foreign users of Google Drive might not see My Drive listed on their Google Drive. They can try using the My Drive/... path or see what the log shows and match it up to that. One example is Mon\u00A0Drive/ for French users.

   • For example, if you store your rclone crypt encrypted files under My Drive's crypt folder (My Drive/crypt/...), the server path mappings will look like this:

     "SERVER_PATH_MAPPINGS": {
       "/mnt/unionfs/Media/Movies/": [
         "/home/seed/media/fused/"
         "My Drive/crypt/Movies/"
       ],
     },

   • For example, if you store your rclone crypt encrypted files under a Google Teamdrive called "shared_movies" and within a crypt folder (shared_movies/crypt/...), the server path mappings will look like this:

     "SERVER_PATH_MAPPINGS": {
       "/mnt/unionfs/Media/Movies/": [
         "/home/seed/media/fused/"
         "shared_movies/crypt/Movies/"
       ],
     },

   ii. Docker install

   • Format:

     "SERVER_PATH_MAPPINGS": {
         "/path/in/plex/container/": [
            "/path/from/sonarr/container/",
            "path/to/rclone/crypt/on/Google/Drive/"
         ]
     },

     Note 1: The Google Drive path does not start with a forward slash (/). Paths in My Drive will start with just My Drive/. and paths in a Google Teamdrive will start with teamdrive_name/.

     Note 2: Foreign users of Google Drive might not see My Drive listed on their Google Drive. They can try using the My Drive/... path or see what the log shows and match it up to that. One example is Mon\u00A0Drive/ for French users.

   • For example, if you store your rclone crypt encrypted files under Google Drive's My Drive crypt folder (My Drive/crypt/...) AND run Plex in a docker container, the server path mappings will look like this:

     "SERVER_PATH_MAPPINGS": {
       "/data/Movies/": [
         "/movies/",
         "My Drive/crypt/Movies/"
       ]
     }

   • For example, if you store your rclone crypt encrypted files under Google Drive's Teamdrive called "shared_movies" and within a crypt folder (shared_movies/crypt/...) AND run Plex in a docker container, the server path mappings will look like this:

     "SERVER_PATH_MAPPINGS": {
       "/data/Movies/": [
         "/movies/",
         "shared_movies/crypt/Movies/"
       ]
     }

2. Rclone crypt monitoring is now setup.

Note: This if for users of Rclone mounts using the "cache" backend.

When RCLONE_RC_CACHE_EXPIRE is enabled, if a file exist check fails (as set in SERVER_FILE_EXIST_PATH_MAPPINGS), Plex Autoscan will keep sending an Rclone cache clear request for that file's parent folder, on the Rclone remote, until the file check succeeds.

For example, if the file /mnt/unionfs/Media/A Good Movie (2000)/A Good Movie.mkv doesn't exist locally, then a clear cache request will be sent to the remote for A Good Movie (2000) folder, on the Rclone remote. But if a file exist checks fails again, it will move to the parent folder and try to clear that (eg Media), and keep doing this until a file check exists comes back positive or checks count reaches SERVER_MAX_FILE_CHECKS.

"RCLONE_RC_CACHE_EXPIRE": {
  "ENABLED": false,
  "FILE_EXISTS_TO_REMOTE_MAPPINGS": {
    "Media/": [
      "/mnt/unionfs/Media/"
    ]
  },
  "RC_URL": "http://localhost:5572"
},

RCLONE_RC_CACHE_EXPIRE - enable cache clearing.

MOUNT_FOLDER - Path on the host where Rclone cache is mounted.

FILE_EXISTS_TO_REMOTE_MAPPINGS - maps local mount path to Rclone remote one. Used during file exists checks.

• Format:

  "FILE_EXISTS_TO_REMOTE_MAPPINGS": {
    "folder_on_rclone_remote/": [
      "/path/to/locally/mounted/folder/"
    ]
  },

RC_URL - URL and Port Rclone RC is set to.

Setup instructions to connect Sonarr/Radarr/Lidarr to Plex Autoscan.

1. Sonarr -> "Settings" -> "Connect".

2. Add a new "Webhook".

3. Add the following:

   1. Name: Plex Autoscan

   2. On Grab: No

   3. On Download: Yes

   4. On Upgrade: Yes

   5. On Rename: Yes

   6. Filter Series Tags: Leave Blank

   7. URL: Your Plex Autoscan Webhook URL

   8. Method:POST

   9. Username: Leave Blank

   10. Password: Leave Blank

4. The settings will look like this:

   

5. Click "Save" to add Plex Autoscan.

1. Radarr -> "Settings" -> "Connect".

2. Add a new "Webhook".

3. Add the following:

   1. Name: Plex Autoscan

   2. On Grab: No

   3. On Download: Yes

   4. On Upgrade: Yes

   5. On Rename: Yes

   6. Filter Movie Tags: Leave Blank

   7. URL: Your Plex Autoscan Webhook URL

   8. Method:POST

   9. Username: Leave Blank

   10. PasswoUpgrade: Yes

   11. On Rename: Yes

   12. Tags: Leave Blank

   13. URL: Your Plex Autoscan Webhook URL

   14. Method:POST

   15. Username: Leave Blank

   16. Password: Leave Blank

4. The settings will look like this:

   

5. Click "Save" to add Plex Autoscan.

If you find this project helpful, feel free to make a small donation via Monzo (Credit Cards, Apple Pay, Google Pay, and others; no fees), Paypal (l3uddz@gmail.com), and Bitcoin (3CiHME1HZQsNNcDL6BArG7PbZLa8zUUgjL).

Hey dude! Help me out for a couple of 🍻!