Mirrors/Sonarr
1
0
Fork 0
mirror of https://github.com/Sonarr/Sonarr.git synced 2024-11-22 02:32:51 +01:00
Code Issues Releases Wiki Activity

Updated Custom Post Processing Scripts (markdown)

bobbintb 2017-07-05 16:59:41 +00:00
parent 042f138a54
commit edcddfeb3f
1 changed files with 51 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

102
Custom-Post-Processing-Scripts.md

@ -2,7 +2,7 @@ If you're looking to trigger a custom script in your download client to tell Son
### Overview ###
Sonarr can execute a custom script when new episodes are imported or a series is renamed, depending on the 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 Sonarr sends will be prefixed with `Sonarr_` and converted to lowercase, the `Series_Id` environment variable will appear as `sonarr_series_id`.
Sonarr can execute a custom script when new episodes are imported or a series is renamed, depending on the 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).
### Environment Variables ###
@ -10,66 +10,66 @@ Sonarr can execute a custom script when new episodes are imported or a series is
| Environment Variable | Details |
|---|---|
| EventType | Grab |
| Series_Id | Internal ID of the series |
| Series_Title | Title of the series |
| Series_TvdbId | TVDB ID for the series |
| Series_TvMazeId | TVMaze ID for the series |
| Series_Imdb | IMDB ID for the series |
| Series_Type | Type of the series, Anime, Daily or Standard |
| Release_EpisodeCount | Number of episodes in the release |
| Release_SeasonNumber | Season number from release |
| Release_EpisodeNumbers | Comma separated list of episode numbers |
| Release_EpisodeAirDates | Air date from original network |
| Release_EpisodeAirDatesUtc | Air Date with Time in UTC |
| Release_EpisodeTitles | Pipe (`\|`) separated list of episode titles |
| Release_Title | NZB/Torrent title |
| Release_Indexer | Indexer where the release was grabbed |
| Release_Size | Size of the release reported by the indexer |
| Release_Quality | Quality name from Sonarr |
| Release_QualityVersion | 1 is the default, 2 for proper, 3+ could be used for anime versions |
| Release_ReleaseGroup | Release Group, will not be set if it is unknown |
| sonarr_eventtype | Grab |
| sonarr_series_id | Internal ID of the series |
| sonarr_series_title | Title of the series |
| sonarr_series_tvdbid | TVDB ID for the series |
| sonarr_series_tvmazeid | TVMaze ID for the series |
| sonarr_series_imdb | IMDB ID for the series |
| sonarr_series_type | Type of the series, Anime, Daily or Standard |
| sonarr_release_episodecount | Number of episodes in the release |
| sonarr_release_seasonnumber | Season number from release |
| sonarr_release_episodenumbers | Comma separated list of episode numbers |
| sonarr_release_episodeairdates | Air date from original network |
| sonarr_release_episodeairdatesutc | Air Date with Time in UTC |
| sonarr_release_episodetitles | Pipe (`\|`) separated list of episode titles |
| sonarr_release_title | NZB/Torrent title |
| sonarr_release_indexer | Indexer where the release was grabbed |
| sonarr_release_size | Size of the release reported by the indexer |
| sonarr_release_quality | Quality name from Sonarr |
| sonarr_release_qualityversion | 1 is the default, 2 for proper, 3+ could be used for anime versions |
| sonarr_release_releasegroup | Release Group, will not be set if it is unknown |
##### On Download/On Upgrade #####
| Environment Variable | Details |
|---|---|
| EventType | Download |
| IsUpgrade | `True` when an an existing file is upgraded, otherwise `False` |
| Series_Id | Internal ID of the series |
| Series_Title | Title of the series |
| Series_Path | Full path to the series |
| Series_TvdbId | TVDB ID for the series |
| Series_TvMazeId | TVMaze ID for the series |
| Series_Imdb | IMDB ID for the series |
| Series_Type | Type of the series, Anime, Daily or Standard |
| EpisodeFile_Id | Internal ID of the episode file |
| EpisodeFile_RelativePath | Path to the episode file relative to the series' path |
| EpisodeFile_Path | Full path to the episode file |
| EpisodeFile_EpisodeCount | Number of episodes in the episode file |
| EpisodeFile_SeasonNumber | Season number of episode file |
| EpisodeFile_EpisodeNumbers | Comma separated list of episode numbers |
| EpisodeFile_EpisodeAirDates | Air date from original network |
| EpisodeFile_EpisodeAirDatesUtc | Air Date with Time in UTC |
| EpisodeFile_EpisodeTitles | Pipe (`\|`) separated list of episode titles |
| EpisodeFile_Quality | Quality name from Sonarr |
| EpisodeFile_QualityVersion | 1 is the default, 2 for proper, 3+ could be used for anime versions |
| EpisodeFile_ReleaseGroup | Release group, will not be set if it is unknown |
| EpisodeFile_SceneName | Original release name |
| EpisodeFile_SourcePath | Full path to the episode file that was imported |
| EpisodeFile_SourceFolder | Full path to the folder the episode file was imported from |
| DeletedRelativePaths | Pipe (`\|`) separated list of files that were deleted to import this file |
| DeletedPaths| Pipe (`\|`) separated list of full paths for files that were deleted to import this file |
| eventtype | Download |
| isupgrade | `True` when an an existing file is upgraded, otherwise `False` |
| series_id | Internal ID of the series |
| series_title | Title of the series |
| series_path | Full path to the series |
| series_tvdbid | TVDB ID for the series |
| series_tvmazeid | TVMaze ID for the series |
| series_imdb | IMDB ID for the series |
| series_type | Type of the series, Anime, Daily or Standard |
| episodefile_id | Internal ID of the episode file |
| episodefile_relativepath | Path to the episode file relative to the series' path |
| episodefile_path | Full path to the episode file |
| episodefile_episodecount | Number of episodes in the episode file |
| episodefile_seasonnumber | Season number of episode file |
| episodefile_episodenumbers | Comma separated list of episode numbers |
| episodefile_episodeairdates | Air date from original network |
| episodefile_episodeairdatesutc | Air Date with Time in UTC |
| episodefile_episodetitles | Pipe (`\|`) separated list of episode titles |
| episodefile_quality | Quality name from Sonarr |
| episodefile_qualityversion | 1 is the default, 2 for proper, 3+ could be used for anime versions |
| episodefile_releasegroup | Release group, will not be set if it is unknown |
| episodefile_scenename | Original release name |
| episodefile_sourcepath | Full path to the episode file that was imported |
| episodefile_sourcefolder | Full path to the folder the episode file was imported from |
| deletedrelativepaths | Pipe (`\|`) separated list of files that were deleted to import this file |
| deletedpaths| Pipe (`\|`) separated list of full paths for files that were deleted to import this file |
##### On Rename #####
| Environment Variable | Details |
|---|---|
| EventType | Rename |
| Series_Id | Internal ID of the series |
| Series_Title | Title of the series |
| Series_Path | Full path to the series |
| Series_TvdbId | TVDB ID for the series |
| eventtype | Rename |
| series_id | Internal ID of the series |
| series_title | Title of the series |
| series_path | Full path to the series |
| series_tvdbid | TVDB ID for the series |
### Arguments ###