mirror/Sonarr
1
0
Fork 0
mirror of https://github.com/Sonarr/Sonarr synced 2024-12-22 07:43:01 +00:00
Code Issues Releases Wiki Activity

Updated Custom Post Processing Scripts (markdown)

bobbintb 2017-07-05 17:09:06 +00:00
parent edcddfeb3f
commit 96d4579470
1 changed files with 33 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

64
Custom-Post-Processing-Scripts.md

@ -29,47 +29,49 @@ Sonarr can execute a custom script when new episodes are imported or a series is
| sonarr_release_quality | Quality name from Sonarr | | 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_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 | | sonarr_release_releasegroup | Release Group, will not be set if it is unknown |
| sonarr_download_id | The hash of the torrent/NZB file downloaded used to uniquely identify the download in the download client |
##### On Download/On Upgrade ##### ##### On Download/On Upgrade #####
| Environment Variable | Details | | Environment Variable | Details |
|---|---| |---|---|
| eventtype | Download | | sonarr_eventtype | Download |
| isupgrade | `True` when an an existing file is upgraded, otherwise `False` | | sonarr_isupgrade | `True` when an an existing file is upgraded, otherwise `False` |
| series_id | Internal ID of the series | | sonarr_series_id | Internal ID of the series |
| series_title | Title of the series | | sonarr_series_title | Title of the series |
| series_path | Full path to the series | | sonarr_series_path | Full path to the series |
| series_tvdbid | TVDB ID for the series | | sonarr_series_tvdbid | TVDB ID for the series |
| series_tvmazeid | TVMaze ID for the series | | sonarr_series_tvmazeid | TVMaze ID for the series |
| series_imdb | IMDB ID for the series | | sonarr_series_imdb | IMDB ID for the series |
| series_type | Type of the series, Anime, Daily or Standard | | sonarr_series_type | Type of the series, Anime, Daily or Standard |
| episodefile_id | Internal ID of the episode file | | sonarr_episodefile_id | Internal ID of the episode file |
| episodefile_relativepath | Path to the episode file relative to the series' path | | sonarr_episodefile_relativepath | Path to the episode file relative to the series' path |
| episodefile_path | Full path to the episode file | | sonarr_episodefile_path | Full path to the episode file |
| episodefile_episodecount | Number of episodes in the episode file | | sonarr_episodefile_episodecount | Number of episodes in the episode file |
| episodefile_seasonnumber | Season number of episode file | | sonarr_episodefile_seasonnumber | Season number of episode file |
| episodefile_episodenumbers | Comma separated list of episode numbers | | sonarr_episodefile_episodenumbers | Comma separated list of episode numbers |
| episodefile_episodeairdates | Air date from original network | | sonarr_episodefile_episodeairdates | Air date from original network |
| episodefile_episodeairdatesutc | Air Date with Time in UTC | | sonarr_episodefile_episodeairdatesutc | Air Date with Time in UTC |
| episodefile_episodetitles | Pipe (`\|`) separated list of episode titles | | sonarr_episodefile_episodetitles | Pipe (`\|`) separated list of episode titles |
| episodefile_quality | Quality name from Sonarr | | sonarr_episodefile_quality | Quality name from Sonarr |
| episodefile_qualityversion | 1 is the default, 2 for proper, 3+ could be used for anime versions | | 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 | | sonarr_episodefile_releasegroup | Release group, will not be set if it is unknown |
| episodefile_scenename | Original release name | | sonarr_episodefile_scenename | Original release name |
| episodefile_sourcepath | Full path to the episode file that was imported | | sonarr_episodefile_sourcepath | Full path to the episode file that was imported |
| episodefile_sourcefolder | Full path to the folder the episode file was imported from | | sonarr_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 | | sonarr_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 | | sonarr_deletedpaths| Pipe (`\|`) separated list of full paths for files that were deleted to import this file |
| sonarr_download_id | The hash of the torrent/NZB file downloaded used to uniquely identify the download in the download client |
##### On Rename ##### ##### On Rename #####
| Environment Variable | Details | | Environment Variable | Details |
|---|---| |---|---|
| eventtype | Rename | | sonarr_eventtype | Rename |
| series_id | Internal ID of the series | | sonarr_series_id | Internal ID of the series |
| series_title | Title of the series | | sonarr_series_title | Title of the series |
| series_path | Full path to the series | | sonarr_series_path | Full path to the series |
| series_tvdbid | TVDB ID for the series | | sonarr_series_tvdbid | TVDB ID for the series |
### Arguments ### ### Arguments ###