Settings Connect
From Servarr
Revision as of 18:06, 21 November 2020 by Bakerboy448 (talk | contribs) (→Radarr: add custom script)
Connect
Connections
Radarr
Connections are how you want Radarr to communicate with the outside world.
- By pressing the
+button you'll be presented with a new window which will allow you to configure many different endpoints- There are many different endpoints
- Boxcar
- Custom scripts - This allows you to make a custom script for when a particular action happens this script will run
- Discord - By far one of the most common ways to push notifications of actions happening on your Radarr
- Discord Notifier - The brainchild of one of the Radarr developers allowing you to have beautiful discord notifications with very fine tuned control. Constantly being updated and a favorite amongst many of the Radarr team.
- Email - Simply send yourself or somebody you want to annoy with email. If you're using Gmail and have 2-factor authentication enabled you need to use an App Specific password: https://support.google.com/accounts/answer/185833
- Embry
- Growl
- Gotify
- Join
- Kodi - Kodi spawned from the love of media. It is an entertainment hub that brings all your digital media together into a beautiful and user friendly package. It is 100% free and open source, very customisable and runs on a wide variety of devices. It is supported by a dedicated team of volunteers and a huge community.
- By adding Kodi as a connection you can update Kodi's library when a new movie has been added to Radarr
- Plex Media Server - The server for your self hosted Plex system, Enabling this is much like Kodi will allow you to push an update to your plex server notifying it that a new/upgraded movie is available
- Prowl
- Pushbullet
- Pushover
- Sendgrid
- Slack
- Synology Indexer
- Telegram
- Trakt
- There are many different endpoints
- Connection Triggers
- On Grab - Be notified when movies are available for download and has been sent to a download client
- On Import - Be notified when movies are successfully imported
- On Upgrade - Be notified when movies are upgraded to a better quality
- On Rename - Be notified when movies are renamed
- On Delete - ?TBD?
- On Health Issue - Be notified on health check failures
- Include Health Warnings - Be notified on health warnings in addition to errors.
- Custom Script
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 |
| radarr_download_id | The hash of the torrent/NZB file downloaded (used to uniquely identify the download in the download client) |
| radarr_movie_id | Internal ID of the movie |
| radarr_movie_imdbid | IMDb ID for the movie |
| radarr_movie_in_cinemas_date | Cinema release date |
| radarr_movie_physical_release_date | Physical release date |
| 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 |
| 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, will not be set if it is unknown |
| 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) |
| 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 |
| radarr_movie_physical_release_date | Physical release date |
| radarr_movie_path | Full path to the movie ( /Movie (Year)/ ) |
| 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 ( /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 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 |
| radarr_movie_in_cinemas_date | Cinema release date |
| radarr_movie_path | Full path to the movie |
| radarr_movie_physical_release_date | Physical release date |
| radarr_movie_title | Title of the movie |
| radarr_movie_tmdbid | TMDb ID for the movie |
| radarr_movie_year | Release year of the movie |
Specific usage tips
LINUX / UNIX Scripts
Remember to always add a shebang and make your scripts executable with chmod.
Sonarr
Connections are how you want Sonarr to communicate with the outside world.
- By pressing the
+button you'll be presented with a new window which will allow you to configure many different endpoints- There are many different endpoints
- Boxcar
- Custom scripts - This allows you to make a custom script for when a particular action happens this script will run
- Discord - By far one of the most common ways to push notifications of actions happening on your Sonarr
- Email - Simply send yourself or somebody you want to annoy with emails. If you're using Gmail and have 2-factor authentication enabled you need to use an App Specific password: https://support.google.com/accounts/answer/185833
- Embry
- Gotify
- Join
- Kodi - Kodi spawned from the love of media. It is an entertainment hub that brings all your digital media together into a beautiful and user friendly package. It is 100% free and open source, very customisable and runs on a wide variety of devices. It is supported by a dedicated team of volunteers and a huge community.
- By adding Kodi as a connection you can update Kodi's library when a new episode has been added to Sonarr
- Plex Home Theater
- Plex Media Center
- Plex Media Server - The server for your self hosted Plex system, Enabling this is much like Kodi will allow you to push an update to your plex server notifying it that a new/upgraded episode is available
- Prowl
- Pushbullet
- Pushover
- Sendgrid
- Slack
- Synology Indexer
- Telegram
- Trakt
- There are many different endpoints
- Connection Triggers
- On Grab - Be notified when episodes are available for download and has been sent to a download client
- On Import - Be notified when episodes are successfully imported
- On Upgrade - Be notified when episodes are upgraded to a better quality
- On Rename - Be notified when episodes are renamed
- On Health Issue - Be notified on health check failures
- Include Health Warnings - Be notified on health warnings in addition to errors.
- Custom Scripts
Sonarr can execute a custom script when an episode is newly imported or renamed and depending on the action, different parameters are supplied. 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 |
|---|---|
| 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_imdbid | 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 | ) 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 |
| 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
| Environment Variable | Details |
|---|---|
| sonarr_eventtype | Download |
| sonarr_isupgrade | True when an an existing file is upgraded, otherwise False
|
| sonarr_series_id | Internal ID of the series |
| sonarr_series_title | Title of the series |
| sonarr_series_path | Full path to the series |
| sonarr_series_tvdbid | TVDB ID for the series |
| sonarr_series_tvmazeid | TVMaze ID for the series |
| sonarr_series_imdbid | IMDB ID for the series |
| sonarr_series_type | Type of the series, Anime, Daily or Standard |
| sonarr_episodefile_id | Internal ID of the episode file |
| sonarr_episodefile_relativepath | Path to the episode file relative to the series' path |
| sonarr_episodefile_path | Full path to the episode file |
| sonarr_episodefile_episodecount | Number of episodes in the episode file |
| sonarr_episodefile_seasonnumber | Season number of episode file |
| sonarr_episodefile_episodenumbers | Comma separated list of episode numbers |
| sonarr_episodefile_episodeairdates | Air date from original network |
| sonarr_episodefile_episodeairdatesutc | Air Date with Time in UTC |
| sonarr_episodefile_episodetitles | ) separated list of episode titles |
| sonarr_episodefile_quality | Quality name from Sonar |
Lidarr
Text
Readarr
Text
