mirror
/
Radarr
mirror of https://github.com/Radarr/Radarr
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Custom Post Processing Scripts (markdown)

Donald Webster 2018-06-12 22:10:32 -07:00
parent 34bb31770b
commit e0b22aec87
1 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
Custom-Post-Processing-Scripts.md

@ -2,7 +2,7 @@ If you're looking to trigger a custom script in your download client to tell Rad
### Overview ###
Radarr can execute a custom script when new movies are imported or renamed, depending on which action occurred the parameters will be different. Parameters are passed to the script through environment variables (allowing for more flexibility in what we send to the script and not having to worry about a particular order). In all cases the Environment Variables Radarr sends will be prefixed with `Radarr` and converted to lowercase, the `Movie_Id` will appear as `radarr_movie_id`.
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 ###
@ -10,44 +10,44 @@ Radarr can execute a custom script when new movies are imported or renamed, depe
| Environment Variable | Details |
|---|---|
| EventType | Grab|
| Movie_Id | Internal ID of the movie|
| Movie_Title| Title of the movie|
| Movie_ImdbId| imdb id for the movie |
| Release_Title | NZB/Torrent title |
| Release_Indexer | Indexer where the release was grabbed |
| Release_Size | Size of the release reported by the indexer |
| Release_ReleaseGroup | Release Group, will not be set if it is unknown |
| radarr_eventtype | Grab|
| radarr_movie_id | Internal ID of the movie|
| radarr_movie_title| Title of the movie|
| radarr_movie_imdbid| imdb id for the movie |
| radarr_release_title | NZB/Torrent title |
| radarr_release_indexer | Indexer where the release was grabbed |
| radarr_release_size | Size of the release reported by the indexer |
| radarr_release_releasegroup | Release Group, will not be set if it is unknown |
##### On Download/On Upgrade #####
| Environment Variable | Details |
|---|---|
| EventType | Download |
| Movie_Id | Internal ID of the movie |
| Movie_Title | Title of the movie |
| Movie_Path | Full path to the movie ( /Movie (Year)/ ) |
| Movie_ImdbId | IMDB ID for the movie |
| MovieFile_Id | Internal ID of the movie file |
| MovieFile_RelativePath | Path to the movie file relative to the movie' path |
| MovieFile_Path | Full path to the movie file ( /Movie (Year)/Movie (Year).mkv )|
| MovieFile_Quality | Quality name from Radarr |
| MovieFile_QualityVersion | 1 is the default, 2 for proper, 3+ could be used for anime versions |
| MovieFile_ReleaseGroup | Release group, will not be set if it is unknown |
| MovieFile_SceneName | Original release name |
| MovieFile_SourcePath | Full path to the episode file that was imported |
| MovieFile_SourceFolder | Full path to the folder the episode file was imported from |
| Download_Id | The hash of the torrent/NZB file downloaded (used to uniquely identify the download in the download client) |
| radarr_eventtype | Download |
| radarr_movie_id | Internal ID of the movie |
| radarr_movie_title | Title of the movie |
| radarr_movie_path | Full path to the movie ( /Movie (Year)/ ) |
| radarr_movie_imdbid | IMDB ID for 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 ( /Movie (Year)/Movie (Year).mkv )|
| 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, will not be set if it is unknown |
| radarr_moviefile_scenename | Original release name |
| radarr_moviefile_sourcepath | Full path to the episode file that was imported |
| radarr_moviefile_sourcefolder | Full path to the folder the episode file was imported from |
| radarr_download_id | The hash of the torrent/NZB file downloaded (used to uniquely identify the download in the download client) |
##### On Rename #####
| Environment Variable | Details |
|---|---|
| EventType | Rename |
| Movie_Id | Internal ID of the movie |
| Movie_Title | Title of the movie |
| Movie_Path | Full path to the movie |
| Movie_TvdbId | TVDB ID for the movie |
| radarr_eventtype | Rename |
| radarr_movie_id | Internal ID of the movie |
| radarr_movie_title | Title of the movie |
| radarr_movie_path | Full path to the movie |
| radarr_movie_tvdbid | TVDB ID for the movie |
### Specific usage tips ###
#### LINUX / UNIX Scripts ####