Difference between revisions of "Settings Connect"

From Servarr
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
== Connect ==
 
== Connect ==
=== Connections ===
+
 
==== Radarr ====
+
=== Radarr ===
 
<section begin=radarr_settings_connect_connections />
 
<section begin=radarr_settings_connect_connections />
 
Connections are how you want Radarr to communicate with the outside world.
 
Connections are how you want Radarr to communicate with the outside world.
 
* By pressing the <code>+</code> button you'll be presented with a new window which will allow you to configure many different endpoints
 
* By pressing the <code>+</code> button you'll be presented with a new window which will allow you to configure many different endpoints
 
** There are many different endpoints
 
** There are many different endpoints
*** [https://boxcar.io Boxcar]
+
***[https://boxcar.io Boxcar]
*** Custom scripts - This allows you to make a custom script for when a particular action happens this script will run
+
*** [[Radarr_Tips_and_Tricks#Custom_Post_Processing_Scripts|Custom Scripts]] - This allows you to make a custom script for when a particular action happens this script will run
 
*** [https://discord.com Discord] - By far one of the most common ways to push notifications of actions happening on your Radarr
 
*** [https://discord.com Discord] - By far one of the most common ways to push notifications of actions happening on your Radarr
*** [https://discordnotifier.com 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.
+
*** [https://notifiarr.com Notifiarr] - 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
+
*** Email - Simply send yourself or somebody you want to annoy with email. [https://support.google.com/accounts/answer/6010255?hl=en If you're using Gmail, you need to enable less secure apps.] If you're using Gmail and have 2-factor authentication enabled you need to [https://support.google.com/accounts/answer/185833 use an App Specific password.]
*** [https://emby.media Embry]
+
**** You can use a "pretty address" like <code>SomePrettyName  <email@example.org></code>
*** [http://growl.info Growl]
+
*** [https://emby.media Emby]
 
*** [https://gotify.net Gotify]
 
*** [https://gotify.net Gotify]
 
*** [https://joaoapps.com/join/ Join]
 
*** [https://joaoapps.com/join/ Join]
Line 27: Line 27:
 
*** [https://trakt.tv/dashboard Trakt]
 
*** [https://trakt.tv/dashboard Trakt]
 
*** [https://twitter.com Twitter]
 
*** [https://twitter.com Twitter]
 +
**** Create a Twitter application (if you haven’t already) at https://apps.twitter.com/
 +
**** Fill in the mandatory fields as well as the callback URL, set it to a publicly available URL (not localhost), it doesn’t need to exist, but it does need to be set, using <code>https://radarr.video/twitter</code> is sufficient.
 +
 
* Connection Triggers
 
* Connection Triggers
 
** On Grab - Be notified when movies are available for download and has been sent to a download client
 
** On Grab - Be notified when movies are available for download and has been sent to a download client
Line 32: Line 35:
 
** On Upgrade - Be notified when movies are upgraded to a better quality
 
** On Upgrade - Be notified when movies are upgraded to a better quality
 
** On Rename - Be notified when movies are renamed
 
** On Rename - Be notified when movies are renamed
** On Delete - ?TBD?
+
** On Movie Delete - Be notified when movies are deleted
 +
** On Movie File Delete - Be notified when movie files files are deleted
 +
** On Movie File Delete For Upgrade - Be notified when movie files are deleted for upgrades
 
** On Health Issue - Be notified on health check failures
 
** On Health Issue - Be notified on health check failures
 
** Include Health Warnings - Be notified on health warnings in addition to errors.
 
** 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
 
<center>On Grab
 
{| class="wikitable"
 
! 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
 
|}</center>
 
<center> On Download/On Upgrade
 
{| class="wikitable"
 
! 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
 
| <code>True</code> when an existing file is upgraded, otherwise <code>False</code>
 
|-
 
| 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
 
|}</center>
 
<center> On Rename
 
{| class="wikitable"
 
! 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
 
|} </center>
 
***: Specific usage tips
 
***: LINUX / UNIX Scripts
 
****: Remember to always add a [https://en.wikipedia.org/wiki/Shebang_(Unix) shebang] and make your scripts executable with [https://en.wikipedia.org/wiki/Chmod chmod].
 
 
<section end=radarr_settings_connect_connections />
 
<section end=radarr_settings_connect_connections />
  
==== Sonarr ====
+
=== Sonarr ===
 
<section begin=sonarr_settings_connect_connections />
 
<section begin=sonarr_settings_connect_connections />
 
Connections are how you want Sonarr to communicate with the outside world.
 
Connections are how you want Sonarr to communicate with the outside world.
 
* By pressing the <code>+</code> button you'll be presented with a new window which will allow you to configure many different endpoints
 
* By pressing the <code>+</code> button you'll be presented with a new window which will allow you to configure many different endpoints
 
** There are many different endpoints
 
** There are many different endpoints
*** [https://boxcar.io Boxcar]
+
***[https://boxcar.io Boxcar]
*** Custom scripts - This allows you to make a custom script for when a particular action happens this script will run
+
*** [[Sonarr_Tips_and_Tricks#Custom_Post_Processing_Scripts|Custom Scripts]] - This allows you to make a custom script for when a particular action happens this script will run
 
*** [https://discord.com Discord] - By far one of the most common ways to push notifications of actions happening on your Sonarr
 
*** [https://discord.com 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
+
*** Email - Simply send yourself or somebody you want to annoy with email. [https://support.google.com/accounts/answer/6010255?hl=en If you're using Gmail, you need to enable less secure apps.] If you're using Gmail and have 2-factor authentication enabled you need to [https://support.google.com/accounts/answer/185833 use an App Specific password.]
*** [https://emby.media Embry]
+
**** You can use a "pretty address" like <code>SomePrettyName  <email@example.org</code>
 +
*** [https://emby.media Emby]
 
*** [https://gotify.net Gotify]
 
*** [https://gotify.net Gotify]
 
*** [https://joaoapps.com/join/ Join]
 
*** [https://joaoapps.com/join/ Join]
Line 225: Line 75:
 
** On Upgrade - Be notified when episodes are upgraded to a better quality
 
** On Upgrade - Be notified when episodes are upgraded to a better quality
 
** On Rename - Be notified when episodes are renamed
 
** On Rename - Be notified when episodes are renamed
 +
** On Series Delete - Be notified when series are deleted
 +
** On Episode File Delete - Be notified when episodes files are deleted
 +
** On Episode File Delete For Upgrade - Be notified when episode files are deleted for upgrades
 
** On Health Issue - Be notified on health check failures
 
** On Health Issue - Be notified on health check failures
 
** Include Health Warnings - Be notified on health warnings in addition to errors.
 
** Include Health Warnings - Be notified on health warnings in addition to errors.
 
<section end=sonarr_settings_connect_connections />
 
<section end=sonarr_settings_connect_connections />
  
==== Lidarr ====
+
=== Lidarr ===
 
<section begin=lidarr_settings_connect_connections />
 
<section begin=lidarr_settings_connect_connections />
Text
+
Connections are how you want Lidarr to communicate with the outside world.
 +
* By pressing the <code>+</code> button you'll be presented with a new window which will allow you to configure many different endpoints
 +
** There are many different endpoints
 +
***[https://boxcar.io Boxcar]
 +
*** Custom scripts - This allows you to make a custom script for when a particular action happens this script will run
 +
*** [https://discord.com Discord] - By far one of the most common ways to push notifications of actions happening on your Lidarr
 +
*** [https://notifiarr.com Notifiarr] - The brainchild of one of the Lidarr developers allowing you to have beautiful discord notifications with very fine tuned control. Constantly being updated and a favorite amongst many of the Lidarr team.
 +
*** Email - Simply send yourself or somebody you want to annoy with email. [https://support.google.com/accounts/answer/6010255?hl=en If you're using Gmail, you need to enable less secure apps.] If you're using Gmail and have 2-factor authentication enabled you need to [https://support.google.com/accounts/answer/185833 use an App Specific password.]
 +
**** You can use a "pretty address" like <code>SomePrettyName  <email@example.org</code>
 +
*** [https://emby.media Emby]
 +
*** [https://gotify.net Gotify]
 +
*** [https://joaoapps.com/join/ Join]
 +
*** [https://kodi.tv 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 Lidarr
 +
*** [https://plex.tv 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
 +
*** [https://www.prowlapp.com Prowl]
 +
*** [https://www.pushbullet.com Pushbullet]
 +
*** [https://pushover.net Pushover]
 +
*** [https://sendgrid.com Sendgrid]
 +
*** [https://slack.com Slack]
 +
*** [http://www.subsonic.org Subsonic]
 +
*** [https://www.synology.com/en-global/knowledgebase/DSM/help/DSM/AdminCenter/application_indexservice_desc Synology Indexer]
 +
*** [https://telegram.org Telegram]
 +
*** [https://twitter.com Twitter]
 +
 
 +
* 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.
 
<section end=lidarr_settings_connect_connections />
 
<section end=lidarr_settings_connect_connections />
 
==== Readarr ====
 
==== Readarr ====
 
<section begin=readarr_settings_connect_connections />
 
<section begin=readarr_settings_connect_connections />
Text
+
Connections are how you want Readarr to communicate with the outside world.
 +
* By pressing the <code>+</code> button you'll be presented with a new window which will allow you to configure many different endpoints
 +
** There are many different endpoints
 +
***[https://boxcar.io Boxcar]
 +
*** Custom scripts - This allows you to make a custom script for when a particular action happens this script will run
 +
*** [https://discord.com Discord] - By far one of the most common ways to push notifications of actions happening on your Lidarr
 +
*** [https://notifiarr.com Notifiarr] - The brainchild of one of the Lidarr developers allowing you to have beautiful discord notifications with very fine tuned control. Constantly being updated and a favorite amongst many of the Lidarr team.
 +
*** Email - Simply send yourself or somebody you want to annoy with email. [https://support.google.com/accounts/answer/6010255?hl=en If you're using Gmail, you need to enable less secure apps.] If you're using Gmail and have 2-factor authentication enabled you need to [https://support.google.com/accounts/answer/185833 use an App Specific password.]
 +
**** You can use a "pretty address" like <code>SomePrettyName  <email@example.org</code>
 +
*** [https://emby.media Emby]
 +
*** [https://gotify.net Gotify]
 +
*** [https://joaoapps.com/join/ Join]
 +
*** [https://kodi.tv 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 Lidarr
 +
*** [https://plex.tv 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
 +
*** [https://www.prowlapp.com Prowl]
 +
*** [https://www.pushbullet.com Pushbullet]
 +
*** [https://pushover.net Pushover]
 +
*** [https://sendgrid.com Sendgrid]
 +
*** [https://slack.com Slack]
 +
*** [http://www.subsonic.org Subsonic]
 +
*** [https://www.synology.com/en-global/knowledgebase/DSM/help/DSM/AdminCenter/application_indexservice_desc Synology Indexer]
 +
*** [https://telegram.org Telegram]
 +
*** [https://twitter.com Twitter]
 
<section end=readarr_settings_connect_connections />
 
<section end=readarr_settings_connect_connections />
 
=== Templates ===
 

Latest revision as of 16:42, 2 May 2021

Connect

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
      • Notifiarr - 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, you need to enable less secure apps. If you're using Gmail and have 2-factor authentication enabled you need to use an App Specific password.
        • You can use a "pretty address" like SomePrettyName <email@example.org>
      • Emby
      • 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
      • Twitter
        • Create a Twitter application (if you haven’t already) at https://apps.twitter.com/
        • Fill in the mandatory fields as well as the callback URL, set it to a publicly available URL (not localhost), it doesn’t need to exist, but it does need to be set, using https://radarr.video/twitter is sufficient.
  • 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 Movie Delete - Be notified when movies are deleted
    • On Movie File Delete - Be notified when movie files files are deleted
    • On Movie File Delete For Upgrade - Be notified when movie files are deleted for upgrades
    • On Health Issue - Be notified on health check failures
    • Include Health Warnings - Be notified on health warnings in addition to errors.


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 email. If you're using Gmail, you need to enable less secure apps. If you're using Gmail and have 2-factor authentication enabled you need to use an App Specific password.
        • You can use a "pretty address" like SomePrettyName <email@example.org
      • Emby
      • 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
      • Twitter
  • 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 Series Delete - Be notified when series are deleted
    • On Episode File Delete - Be notified when episodes files are deleted
    • On Episode File Delete For Upgrade - Be notified when episode files are deleted for upgrades
    • On Health Issue - Be notified on health check failures
    • Include Health Warnings - Be notified on health warnings in addition to errors.


Lidarr

Connections are how you want Lidarr 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 Lidarr
      • Notifiarr - The brainchild of one of the Lidarr developers allowing you to have beautiful discord notifications with very fine tuned control. Constantly being updated and a favorite amongst many of the Lidarr team.
      • Email - Simply send yourself or somebody you want to annoy with email. If you're using Gmail, you need to enable less secure apps. If you're using Gmail and have 2-factor authentication enabled you need to use an App Specific password.
        • You can use a "pretty address" like SomePrettyName <email@example.org
      • Emby
      • 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 Lidarr
      • 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
      • Subsonic
      • Synology Indexer
      • Telegram
      • Twitter
  • 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.

Readarr

Connections are how you want Readarr 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 Lidarr
      • Notifiarr - The brainchild of one of the Lidarr developers allowing you to have beautiful discord notifications with very fine tuned control. Constantly being updated and a favorite amongst many of the Lidarr team.
      • Email - Simply send yourself or somebody you want to annoy with email. If you're using Gmail, you need to enable less secure apps. If you're using Gmail and have 2-factor authentication enabled you need to use an App Specific password.
        • You can use a "pretty address" like SomePrettyName <email@example.org
      • Emby
      • 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 Lidarr
      • 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
      • Subsonic
      • Synology Indexer
      • Telegram
      • Twitter