Difference between revisions of "Radarr Tips and Tricks"
(Fix quotes in script. Add more details to script creation. Force script to run with high privileges.) |
Bakerboy448 (talk | contribs) (various updates) |
||
Line 3: | Line 3: | ||
== Rename Movie Folders == | == Rename Movie Folders == | ||
− | * If you've recently changed your movie folder name template ( | + | * If you've recently changed your movie folder name template ([[Radarr_Settings#Standard Movie Folder Format|Settings -> Movie Folder Format]]) and want to rename your existing movie folders, you need to use a trick. |
[[File:original-movie-folder-nameing.png|frameless|none|750px|alt=original name]] | [[File:original-movie-folder-nameing.png|frameless|none|750px|alt=original name]] | ||
* You'll first need to go to the main library page (Movies) and select Mass Edit: | * You'll first need to go to the main library page (Movies) and select Mass Edit: | ||
Line 104: | Line 104: | ||
== Custom Post Processing Scripts == | == Custom Post Processing Scripts == | ||
− | If you’re looking to trigger a custom script in your download client to tell Radarr when to update, you can find more details | + | If you’re looking to trigger a custom script in your download client to tell Radarr when to update, you can find more details below. Scripts are added to Radarr via the [[Radarr Settings#Connections|Connect Settings]] page. |
=== Overview === | === Overview === |
Revision as of 17:10, 6 February 2021
TRaSH's Custom Formats
Rename Movie Folders
- If you've recently changed your movie folder name template (Settings -> Movie Folder Format) and want to rename your existing movie folders, you need to use a trick.
- You'll first need to go to the main library page (Movies) and select Mass Edit:
- Select the Movies you'll want to edit (1) or click Select all (2)
- Next you'll want to select which root folder this(these) movies need to be placed in (your root folders might look different than shown here)
- When the move files propt is displayed select select: Yes, Move the files (even if the though the files aren't being moved this will in a sense move the files from the old folder to the new folder renamed)
- Depending on how large your library is it may take a while for all folders to be renamed once completed check your movies to see if everything worked properly.
Importing IMDb lists into TMDb
This is a guide for importing a list from IMDb into The Movie Database. This can be useful for large lists, due to IMDb’s RSS feeds not supporting the entire list.
- Log into your IMDb account.
- Open the list you would like to import into TMDb.
- Scroll to the bottom, just before the comments, and click the “Export this list” button, as shown below:
- Log into your TMDb account.
- Go to your account page on TMDb (by clicking your username).
- Click the “Import List” button on the left side-bar as shown below:
- Click “Select Files…” and navigate to the downloaded CSV file from IMDb:
Choose the destination list as shown in the image above.
Click import, and wait to be notified of the import completion.
Create a Folder for Each Movie
Windows & Linux
Filebot
Filebot is a fantastic utility for getting your movies organized in a way that Radarr can successfully parse. Version 4.7.9’s 64 bit and 32 bit can still be downloaded free from a SourceForge mirror, but there are also paid versions in the Windows and Apple stores. On Linux, your distribution of choice may have a package for it, like in Arch’s AUR package or .deb
files for Debian/Ubuntu from their download page. It has both a GUI and a CLI, so should satisfy almost everyone.
There is great help available, including their format expressions page. My personal suggestion is to use something like {ny}\{fn}
if your files include useful details like quality, edition and/or group or {ny}/{ny} [{dim[0] >= 1280 ? 'Bluray' : 'DVD'}-{vf}]
if they don’t, which would yield Movie (Year)/Movie (Year) [Bluray-1080p]
or Movie (Year)/Movie (Year) [DVD-480p]
for example. Instead of Bluray
, you could also use WEBDL
if you’d rather your collection be considered that.
To keep this pattern for future movies, you should set:
Settings -> Media Management (Advanced Settings Shown) -> Movie Naming * File: {Movie CleanTitle} {(Release Year)} {Edition Tags} {[Quality Title]}
* Folder: {Movie CleanTitle} {(Release Year)}
Note: You can replace the spaces above with .
or _
if you prefer that naming format.
Windows
Files 2 Folder
I used a program called Files 2 Folder to make my movie library visible for import into Radarr, extract the zip to your computer and run the .exe as administrator, then click yes to add it to your right click menu.
- Browse to your movie folder
- Select all files and right click to bring up the menu
- Press the files 2 folder option in the menu
- Wait for the box to appear, ONLY CLICK THE SECOND OPTION
- Each movie will be in its’ own folder.
Linux
cd /path/to/your/movies/files/ find . -maxdepth 1 -type f -iname "*.mkv" -exec sh -c 'mkdir "${1%.*}" ; mv "${1%}" "${1%.*}" ' _ {} \;
Windows & Linux
This script will place movies and TV episodes on folders
Files are not modifed or renamed only moved to folders.
Usage:: ./movie&TV2folder.py /path/movies/ (Movie 1 (year) , Movie)
Usage:: ./movie&TV2folder.py /path/tv/ ( tv folders: Tile 1, Title 2 )
Type of files:
Movies: (scans 1 folder deep - i.e. not recursive)
All files bellow would be moved to folder: ./Movie Title (2017)
Movie Title (2017) 1080p.mkv
Movie Title (2017) anything else.*
Movie Title (2017).*
Movie Title.mkv –> would not be moved, since missing (year)
Series: (scans 2 folders deep)
All files bellow would be moved to folder: ./Season 04/
Farscape - S04E01.mkv
Farscape - S04E01-E02.mkv
Farscape - S04E01
S04E01 - Farscape - group.mkv
Daily Show S2014E20 - would be moved to ./Season 2014/
Additional rules:
On OS error: retry operation 3 times with 1 second delay between attempts.
If move fails it continue with other files.
https://github.com/ajkis/scripts/blob/master/other/movie-tv2folder.py
Custom Post Processing Scripts
If you’re looking to trigger a custom script in your download client to tell Radarr when to update, you can find more details below. Scripts are added to Radarr via the Connect Settings page.
Overview
Radarr can execute a custom script when new movies are imported or a movie is renamed and depending on which action occurred, the parameters will be different. They are passed to the script through environment variables which allows for more flexibility in what is sent to the script and in no particular order.
Environment Variables
On Grab
Environment Variable | Details |
---|---|
radarr_eventtype | Grab |
radarr_download_client | NZB/Torrent downloader client, empty if missing |
radarr_download_id | The hash of the torrent/NZB file downloaded (used to uniquely identify the download in the download client), empty if missing |
radarr_movie_id | Internal ID of the movie |
radarr_movie_imdbid | IMDb ID for the movie, empty if missing |
radarr_movie_in_cinemas_date | Cinema release date, empty if missing |
radarr_movie_physical_release_date | Physical release date, empty if missing |
radarr_movie_title | Title of the movie |
radarr_movie_tmdbid | TMDb ID for the movie |
radarr_movie_year | Release year of the movie |
radarr_release_indexer | Indexer where the release was grabbed, empty if missing |
radarr_release_quality | Quality name from Radarr |
radarr_release_qualityversion | 1 is the default, 2 for proper, 3+ could be used for anime versions |
radarr_release_releasegroup | Release Group, empty if missing |
radarr_release_size | Size of the release reported by the indexer |
radarr_release_title | NZB/Torrent title |
On Download/On Upgrade
Environment Variable | Details |
---|---|
radarr_eventtype | Download |
radarr_download_id | The hash of the torrent/NZB file downloaded (used to uniquely identify the download in the download client), empty if missing |
radarr_download_client | NZB/Torrent downloader client, empty if missing |
radarr_isupgrade | True when an existing file is upgraded, otherwise False
|
radarr_movie_id | Internal ID of the movie |
radarr_movie_imdbid | IMDb ID for the movie |
radarr_movie_in_cinemas_date | Cinema release date, empty if missing |
radarr_movie_physical_release_date | Physical release date, empty if missing |
radarr_movie_path | Full path to the movie |
radarr_movie_title | Title of the movie |
radarr_movie_tmdbid | TMDb ID for the movie |
radarr_movie_year | Release year of the movie |
radarr_moviefile_id | Internal ID of the movie file |
radarr_moviefile_relativepath | Path to the movie file relative to the movie’ path |
radarr_moviefile_path | Full path to the movie file |
radarr_moviefile_quality | Quality name from Radarr |
radarr_moviefile_qualityversion | 1 is the default, 2 for proper, 3+ could be used for anime versions |
radarr_moviefile_releasegroup | Release group, empty if missing |
radarr_moviefile_scenename | Original release name, empty if missing |
radarr_moviefile_sourcepath | Full path to the movie file that was imported |
radarr_moviefile_sourcefolder | Full path to the folder the movie file was imported from |
On Rename
Environment Variable | Details |
---|---|
radarr_eventtype | Rename |
radarr_movie_id | Internal ID of the movie |
radarr_movie_imdbid | IMDb ID for the movie, empty if missing |
radarr_movie_in_cinemas_date | Cinema release date, empty if missing |
radarr_movie_path | Full path to the movie |
radarr_movie_physical_release_date | Physical release date, empty if missing |
radarr_movie_title | Title of the movie |
radarr_movie_tmdbid | TMDb ID for the movie |
radarr_movie_year | Release year of the movie |
On Health Check
Environment Variable | Details |
---|---|
radarr_eventype | HealthIssue |
radarr_health_issue_level | the type of health issue: Ok, Notice, Warning, Error |
radarr_health_issue_message | the message from the health issue |
radarr_health_issue_type | the area that failed and triggered the health issue |
radarr_health_issue_wiki | the wiki url, empty if does not exist |
On Test
When adding the script to Radarr and run ‘Test’ the script will be invoked with the following parameters. The script should be able to gracefully ignore any other eventtype
Environment Variable | Details |
---|---|
radarr_eventtype | Test |
Specific usage tips
LINUX / UNIX Scripts
Remember to always add a shebang and make your scripts executable with chmod.
PHP
The information from Radarr will not be added to <math display="inline">_ENV as one might expect but should be included in the [</math>_SERVER variable](https://secure.php.net/manual/en/reserved.variables.server.php). A sample script to use this information to convert a file can be found here. #### PowerShell #### Sample script using the Radarr environment variables to create EDL files for all episodes is here.
Sample script to have Plex scan destination folder only and “analyze deeply” the file. PSQLite needed to query the plex DB. Adjust folder locations to match your setup.
This script will add the movie to plex and scan the destination folder (it will not scan the entire library)
Reverse Symlinking
When using private trackers, it is imperative to continue seeding. By using this script on Download
and on Upgrade
moves the media to your root movie folder as set in Radarr, and will create a symlink in the original download location so you can continue to seed.
Symlinking is preferable over hardlinking in some cases as the root movie folder can be on a seperate drive or nfs mount, where hardlinks are impossible.
A quick way to test scripts is to create a testing environment using the movie “Test (2013)”.
mkdir -p ~/test && cd ~/test && touch "Test (2013).nfo" "Test (2013).por.srt" "Test (2013).por.forced.srt" "Test (2013).eng.srt" "Test (2013).mkv" && cp -R ~/test /path/to/folder/to/import
or in bash:
mkdir -p ~/test && cd ~/test && touch "Test (2013)."{nfo,por.srt,por.forced.srt,eng.srt,mkv} && cp -R ~/test /path/to/folder/to/import
This way you can manually import this movie and trigger the script. You can just run it again to repopulate the files.
Installing multiple Radarrs on Windows
This guide will show you how to run multiple instances of Radarr on Windows using only one base installation. This guide was put together using Windows 10; if you are using a previous version of Windows (7, 8, etc.) you may need to adjust some things. This guide also assumes that you have installed Radarr to the default directory, and your second instance of Radarr will be called Radarr-4K. Feel free to change things to fit your own installations, though.
Prerequisites
- You must have Radarr already installed. It is highly recommended that you use the latest installer.exe file.
- You must have NSSM (Non-Sucking Service Manager) installed. To install, download the latest release (2.24 at the time of writing) and copy either the 32-bit or 64-bit nssm.exe file to C:/windows/system32. (If you aren’t sure if you have a 32-bit or 64-bit system, check Settings > System > About > System type.)
Configuring Radarr
Open a Command Prompt administrator window. (To run as an admin, right click on the Command Prompt icon and choose “Run as administrator.”)
If Radarr is running, stop the service by running
nssm stop Radarr
in Command Prompt.Now we have to edit the existing Radarr instance to explicitly point to its data directory. The default command is as follows:
sc config Radarr binpath= "C:\ProgramData\Radarr\bin\Radarr.exe -data=C:\ProgramData\Radarr"
This command tells the original instance of Radarr to explicitly use C:\ProgramData\Radarr for its data directory. If you didn't use the default Radarr install, or if your data folder is somewhere else, you may have to change your paths here.
Creating Radarr-4K
- Create a new folder where you’d like Radarr-4K to live. I prefer all my instances in the same place, so my new folder is C:\ProgramData\Radarr-4K .
- Back in Command Prompt, create the new Radarr-4K service using
nssm install Radarr-4K
. A popup window will open where you can type your parameters for the new instance. For this example, we will use the following:- Path: C:\ProgramData\Radarr\bin\Radarr.exe
- Startup directory: C:\ProgramData\Radarr\bin
- Arguments: -data=C:\ProgramData\Radarr-4K
Note that Arguments points to the new folder created in step 4. This is crucial, as it keeps all the data files from both instances in separate locations.
- Click Install service. The window should close and the service will now be available to run.
Alternate Installation for running as user instead of service (enables UNC path mapping)
- Shut down and disable the current service if it is running
- Start Menu, type services.msc
- Right click on Radarr-4K and Disable
- Right click on Radarr-4K and click Properties and choose Disabled
- Navigate to the Startup Folder for the current user (usually Users/username/AppData/Roaming/Microsoft/Start Menu/Startup)
- Right click and Create New Shortcut
- Path: C:\ProgramData\Radarr\bin\Radarr.exe -data=C:\ProgramData\Radarr-4K
- Give the shortcut a unique name such as Radarr-4K and finish the wizard.
- Double click the new shortcut to run and test.
Configuring Radarr-4K
Next we’ll need to configure the new service to use its own port, the entry for which is in a config.xml file. This file is created when you first run the service, so start up Radarr-4K with
nssm start Radarr-4K
in Command Prompt.Navigate to your new data directory (C:\ProgramData\Radarr-4K in this case) to see if the config.xml file is there. If it is, go ahead and stop Radarr-4K with
nssm stop Radarr-4K
. (Don’t worry, we’ll be starting it back up in a second.)Open the config.xml file using your preferred text editor. There should only be a handful of lines, but the important one is
<Port>7878</Port>
.
Since the first Radarr instance will occupy port 7878, the second instance must use another available port, like 7879 or 17878. I prefer the latter, so I changed the line to <Port>17878</Port>
. Don’t change anything else.
- After you’ve set a new port, save the file and close your text editor.
- With both services fully installed and properly configured, you can now start them:
nssm start Radarr
(accessible via http://ip_address:7878)nssm start Radarr-4K
(accessible via http://ip_address:17878)
Notes
- Though this tutorial was tested using Command Prompt, it should work with Windows Terminal/Powershell as well. But, if you’re feeling cautious, just go with Command Prompt.
- A previous version of this installation guide encouraged users to copy Radarr’s config.xml file to Radarr-4K’s data directory. However, you’ll run into trouble with this method, especially if you have authentication enabled. I’d recommend starting with a clean config.xml file, created when you start the service for the first time (Step 7).
- If one Radarr instance is updated, both instances will shutdown and only the updated one will start again. To fix this, you will have to manually start the other instance, or you may want to look into using the below powershell script to address the problem until an official solution is found.
- If you’re correcting a problematic installation, you may need to restore from one of Radarr’s many backups.
Port Checker and Restarter PowerShell Script
When you use two Radarr instances and one of it is updating, it will kill both instances ( by killing all running radarr.console.exe ). Only the one which is updating will come back online.
To keep both online i made a powershell script which i run as a scheduled task.
It checks the ports and if one is not online, it will (re-)start the scheduled task to launch radarr.
Create a new File and name it RadarrInstancesChecker.ps1
with the below code.
Edit the script with your actual service names, IP, and ports.
Create a scheduled task to run the script on a repeating schedule.
- Security Options: check Run with highest privileges (otherwise the script will be unable to manipulate services)
- Trigger: On launch
- Repeat task every: 5 or 10 minutes
- Action: Start a Program
- Program/script:
powershell
- Argument (with path to your script's location):
-File D:\RadarrInstancesChecker.ps1
- Program/script: