diff --git a/docs/Notifiarr/Integrations-Setup/Lidarr.md b/docs/Notifiarr/Integrations-Setup/Lidarr.md new file mode 100644 index 000000000..f1ca299e6 --- /dev/null +++ b/docs/Notifiarr/Integrations-Setup/Lidarr.md @@ -0,0 +1,52 @@ +# Lidarr Integration + +> This integration allows for notifications from Lidarr using its built in Connection for **Discord Notifier** + +--- + +## Trigger options + +![!triggers-channels](images/Lidarr/triggers-channels.png "Triggers and Channels") + +1. Triggers + - `Grab` - Receive a notification when media is initially grabbed (RSS or manual) + - `Download` - Receive a notification when media **new** is successfully imported + - `Upgrade` - Receive a notification when **upgraded** media is successfully imported + - `Health` - Receive a notification when Lidarr reports an issue +1. Channel + - Lidarr shares the *arr channel unless Granular Setup is used, clicking the link on the site will move to the channel setup location. + +--- + +## Configuration + +![!open-configuration](images/Lidarr/open-configuration.png "Open Configuration Window") + +Click the **cog icon** to open the configuration options for Lidarr. + +![!configuration](images/Lidarr/configuration.png "Configuration Window") + +1. Open integration specific instructions +1. Notification colors for each trigger type +1. Unique notifications: Generate a new notification each time (By default notifications edit the previous one so there is a Grab and then the Download ot Upgrade will edit the Grab notification to eliviate the notification spam) + +![!configuration](images/Lidarr/configuration-2.png "Configuration Window") + +1. Open integration specific instructions +1. Notification content options that you can turn on/off to show in the notifications +1. Launch the integration layout editor (image below) + +![!layout-editor](images/Lidarr/layout-editor.png "Layout Editor") + +1. Drag and drop positioning of where you want to see each piece of information in the notification. Some fields are locked (red outline). Full width items can not be used in a multi-line layout. You can not have more than 3 items per line. +1. Test Layout - Will send a test notification with the current layout format +1. Save Layout - Will save the current layout format as the one you want to use +1. Reset Layout - Will set the layout back to default + +### Instructions + +![!instructions](images/Lidarr/instructions.png "Instructions Window") + +1. How to enable notifications from within Lidarr +1. Test the notification from Notifiarr to Discord + - This will ensure your server, channel and permissions are set properly in Discord. diff --git a/docs/Notifiarr/Integrations-Setup/Radarr.md b/docs/Notifiarr/Integrations-Setup/Radarr.md new file mode 100644 index 000000000..603f03620 --- /dev/null +++ b/docs/Notifiarr/Integrations-Setup/Radarr.md @@ -0,0 +1,54 @@ +# Radarr Integration + +> This integration allows for notifications from Radarr using its built in Connection for **Discord Notifier** + +--- + +## Trigger options + +![!triggers-channels](images/Radarr/triggers-channels.png "Triggers and Channels") + +1. Triggers + - `Grab` - Receive a notification when media is initially grabbed (RSS or manual) + - `Failed` - Custom notification type based on previous grabs. If the system detects a grab for the same media with the same quality or better before the previous one was imported then it will set the previous one as failed + - `Download` - Receive a notification when media **new** is successfully imported + - `Upgrade` - Receive a notification when **upgraded** media is successfully imported + - `Health` - Receive a notification when Radarr reports an issue +1. Channel + - Radarr shares the *arr channel unless Granular Setup is used, clicking the link on the site will move to the channel setup location. + +--- + +## Configuration + +![!open-configuration](images/Radarr/open-configuration.png "Open Configuration Window") + +Click the **cog icon** to open the configuration options for Radarr. + +![!configuration](images/Radarr/configuration.png "Configuration Window") + +1. Open integration specific instructions +1. Notification colors for each trigger type +1. Unique notifications: Generate a new notification each time (By default notifications edit the previous one so there is a Grab and then the Download ot Upgrade will edit the Grab notification to eliviate the notification spam) +1. Option to remove the grab once a successful import is done, only works with granular channels since messages in the same channel update + +![!configuration](images/Radarr/configuration-2.png "Configuration Window") + +1. Notification content options that you can turn on/off to show in the notifications +1. Launch the integration layout editor (image below) + +![!layout-editor](images/Radarr/layout-editor.png "Layout Editor") + +1. Drag and drop positioning of where you want to see each piece of information in the notification. Some fields are locked (red outline). Full width items can not be used in a multi-line layout. You can not have more than 3 items per line. +1. Test Layout - Will send a test notification with the current layout format +1. Save Layout - Will save the current layout format as the one you want to use +1. Reset Layout - Will set the layout back to default + +### Instructions + +![!instructions](images/Radarr/instructions.png "Instructions Window") + +1. How to enable notifications from within Radarr +1. Setting up multiple instance option +1. Test the notification from Notifiarr to Discord + - This will ensure your server, channel and permissions are set properly in Discord. diff --git a/docs/Notifiarr/Integrations-Setup/images/Lidarr/configuration-2.png b/docs/Notifiarr/Integrations-Setup/images/Lidarr/configuration-2.png new file mode 100644 index 000000000..2c70943a1 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Lidarr/configuration-2.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Lidarr/configuration.png b/docs/Notifiarr/Integrations-Setup/images/Lidarr/configuration.png new file mode 100644 index 000000000..368aade47 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Lidarr/configuration.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Lidarr/instructions.png b/docs/Notifiarr/Integrations-Setup/images/Lidarr/instructions.png new file mode 100644 index 000000000..6ad34a53b Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Lidarr/instructions.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Lidarr/layout-editor.png b/docs/Notifiarr/Integrations-Setup/images/Lidarr/layout-editor.png new file mode 100644 index 000000000..041540939 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Lidarr/layout-editor.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Lidarr/open-configuration.png b/docs/Notifiarr/Integrations-Setup/images/Lidarr/open-configuration.png new file mode 100644 index 000000000..98f0a6a05 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Lidarr/open-configuration.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Lidarr/triggers-channels.png b/docs/Notifiarr/Integrations-Setup/images/Lidarr/triggers-channels.png new file mode 100644 index 000000000..993522a2d Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Lidarr/triggers-channels.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Radarr/configuration-2.png b/docs/Notifiarr/Integrations-Setup/images/Radarr/configuration-2.png new file mode 100644 index 000000000..b24e53449 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Radarr/configuration-2.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Radarr/configuration.png b/docs/Notifiarr/Integrations-Setup/images/Radarr/configuration.png new file mode 100644 index 000000000..940cd5e7d Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Radarr/configuration.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Radarr/instructions.png b/docs/Notifiarr/Integrations-Setup/images/Radarr/instructions.png new file mode 100644 index 000000000..e0fe64e09 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Radarr/instructions.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Radarr/layout-editor.png b/docs/Notifiarr/Integrations-Setup/images/Radarr/layout-editor.png new file mode 100644 index 000000000..8fa04e891 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Radarr/layout-editor.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Radarr/open-configuration.png b/docs/Notifiarr/Integrations-Setup/images/Radarr/open-configuration.png new file mode 100644 index 000000000..6b846b094 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Radarr/open-configuration.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Radarr/triggers-channels.png b/docs/Notifiarr/Integrations-Setup/images/Radarr/triggers-channels.png new file mode 100644 index 000000000..1ed173b36 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Radarr/triggers-channels.png differ