Details

Name: FileBot

Website: http://filebot.net/

Added on: 19th of July 2014

Version management

Latest release that supports Java7, is 4.2 at this time. This is also the last version that has no licence charges. Due to licensing structure that Filebot opted for (per user fee), we are unable to offer newer versions of Filebot created after introducing the licensing fee.

Changelog

14th of November 2019

Filebot is no longer the default app. Olaris-rename is now the default. If you deployed your box after the 1st of December 2019 then unless you installed Filebot manually this page is no longer relevant.

3rd of November 2019

Added a note about Filebot licensing.

14th of June 2016

Added note to run manual parsing of files script in home folder

30th of April 2015

Ask about extraction during client installation to forgo manually editing after the fact.

13th of February 2015

Disabled automatic extracting of content. Can be turned on again by changing skipExtract=y to skipExtract=n in the wrapper for either Deluge or rTorrent.

24th of July 2014

Enabled automatic English subtitle downloads.

Description

FileBot is the ultimate tool for organizing and renaming your movies, tv shows or anime, and music well as downloading subtitles and artwork. It's smart and just works.

What do we use it for?

We use FileBot as a way to make it easy for Plex to recognise your content so there is a higher chance Plex can play it.

When a download is finished Deluge will tell Filebot to work it’s magic on the download, FileBot will do try to achieve the following things.

• It will check if the content is compressed and try to uncompress it if that’s the case and the setting is enabled. Plex can’t read rar-ed files by default, this makes that work because it extracts the content to a path Plex is watching.
• Next it will try to find the content on one of the known databases thetvdb.com, themoviedb.org etc.
• Based on what it finds FileBot will now create a symlink to the file in ~/media and rename it in such a way that Plex is likely to identify the content correctly. For instance Friends.S06E03.mkv will be moved and renamed to ~/media/TV Shows/Friends/Seasons 06/Friends.S06E03.mkv or similar.

You can compare a symlink to a shortcut to an existing file in linux. Because it's a shortcut no extra space is being used even though the 'file' exists twice on your filesystem. And because it's just a shortcut you can name it anything you want without disturbing the seeding torrent.

This does mean however that when you delete the torrent via Deluge you still need to delete the version that Filebot made for you in your media folder. You can do this via PyDio or FTP, SSH.

Using Filebot as the Deluge postprocessing script

The default postprocessing script for Deluge is olaris-rename. If you want to use Filebot, use an editor to edit the filebot.py script in the ~/.config/deluge directory and in the call_filebot() function, change the cmd variable assignment to the following:

cmd = ("filebot -script fn:amc -non-strict --def ut_kind=multi --log all --log-file amc.log --def ut_dir=\"%s/%s\" " % (sys.argv[3], sys.argv[2]) + ' '.join(filebotOptions)).encode(u'utf-8')

You might also need to change the output file which is done in the filebotOptions list toward the top of the script. By default the output file is media which Filebot would look for in the current directly (which would be ~/torrents/data/media which is incorrect. Change the the output file to ~/media and it will work like normal.

Installing the license

We added Filebot as an app for quick fix of these issues which you can install via Install Application button. You will need to buy a license from Filebot which you can find in their home page.

Once you have the license in your "hands" you will need to copy paste the complete license in the license data empty space when you're installing Filebot.

That file should look like this:

You need to copy/paste the complete file and it needs to be in this format. If you copy paste only the half of it, filebot will not be activated. Also if you copy/paste it and all text is in one line, again Filebot won't accept it as a proper license.

To verify if the license is installed correctly run the following command:

cmd = filebot -script fn:sysinfo

the output should contain something like:

License: FileBot License XXXXXXX (Valid-Until: 2021-04-16)

Wrapper files

We build wrapper files to be used by Deluge and rTorrent, they can be found in the following locations.

Deluge

~/.config/deluge/filebot.py

rTorrent

~/.config/rtorrent/filebot

Tips and Tricks

Manually parse a folder or files

You can use the following command if you have Deluge installed to force content to be scanned, for instance if you uploaded it yourself. Run one of the following commands in your home folder:

Using automatic detection script

cd && filebotify ~/torrents/data/filepath

If that fails try the following options.

Using Deluge wrapper

python ~/.config/deluge/filebot.py nothing . ~/torrents/data/my-folder

Using Deluge wrapper when your DIR has spaces

python ~/.config/deluge/filebot.py nothing . ~/torrents/data/"Path To your DIR with Spaces - (Wrapped in qoutes)/"

Using rTorrent wrapper

bash ~/.config/rtorrent/filebot ~/path/to/containing/folder filename.mkv

Checking out what Filebot is doing

Sometimes symlinks are not created, I recommend you view the log files in this instance which can be found in.

~/.filebot/logs/amc.log

This will often tell you why this is happening.

Manually creating symlinks

Sometimes when Filebot misses a file you may want to manually create a symlink to the file yourself to try and get it to show in Plex. To do this you'll need to cd into the directory you want to put your symlink in, usually something like ~/media/Movies.

Once you're in your chosen directory you'll want to use this command to create a link to your file/folder. Note: you must use the format ../../ rather than an absolute link like /home/yourusername/, otherwise Plex won't be able to follow the link from the container it runs in.

ln -s ../../torrents/data/your-folder/your-file

Manually creating symlinks when your DIR has spaces

As with manually parsing a DIR with spaces, to create a symlink to a directory with spaces, you also need to wrap the DIR/Filename in qoutes. To do this you'll need to cd into the directory you want to put your symlink in, usually something like ~/media/Movies/Folder.

Note: and you must use the format ../../../ rather than an absolute link like /home/yourusername/folder, otherwise Plex won't be able to follow the link from the container it runs in.

ln -s ../../../torrents/data/"Name of your folder (with Spaces)/Name of the Movie or (TV Show) to link.mkv"

This also counts for changing to a DIR with spaces (using CD)

Change to directory with spaces...

cd ~/torrents/data/"Name of your folder (with Spaces)/"

Enabling small file size and short video recognition

Add these two options to your filebot configuration file:

--def minFileSize=0 

Only process video files larger than the given number (in bytes). Defaults to 50 MB.

--def minLengthMS=0 

Only process videos longer than the given number (in milliseconds). Defaults to 10 minutes.

Fixing the extractFolder

By default we setup Filebot to extract to $HOME/torrents/extracted instead of extracting into the folder of the compressed files. However a recent Filebot upgrade has changed the case sensitivity of this option, therefor it won't work without like this any longer.

To get extraction back to our defaults you can edit the filebot wrapper (see paths to these files at the top of this page) and change --def extractfolder to --def extractFolder. Running Filebot on new files will now use the correct folder again.

Turn-off subtitle / Download multiple subtitles

Edit your wrapper file, paths specified above, and look for the SUBLANG in rTorrent or subtitles change en to an other language or false if you don't want to download subtitles. In addtion; To download multiple languages, separate the language codes with a comma. (For example 'en,fr,nl')