diff --git a/docs/Notifiarr/Integrations-Setup/Network.md b/docs/Notifiarr/Integrations-Setup/Network.md new file mode 100644 index 000000000..bd4931c52 --- /dev/null +++ b/docs/Notifiarr/Integrations-Setup/Network.md @@ -0,0 +1,30 @@ +# Network Integration + +> This integration allows for notifications from the local Notifiarr client app to monitor network machines or services + +--- + +## Monitoring overview + +![!monitoring-overview](images/Network/overview.png "Monitoring overview") + +This will list everything you are monitoring with the Notifiarr client and show a green arrow if it is available or red arrow if it isn't + +--- + +## Configuration + +![!open-configuration](images/Network/open-configuration.png "Open Configuration Window") + +Click the **cog icon** to open the configuration options for the Network integration. + +![!configuration](images/Network/configuration.png "Configuration Window") + +1. Open integration specific instructions +1. List of everything being monitored and their status + +### Instructions + +![!instructions](images/Network/instructions.png "Instructions Window") + +An example of how to add services to be monitored in the Notifiarr client app diff --git a/docs/Notifiarr/Integrations-Setup/Reddit.md b/docs/Notifiarr/Integrations-Setup/Reddit.md new file mode 100644 index 000000000..1f0428820 --- /dev/null +++ b/docs/Notifiarr/Integrations-Setup/Reddit.md @@ -0,0 +1,27 @@ +# Reddit Integration + +> This integration allows for notifications from subreddits you can choose to watch + +--- + +## Monitoring overview + +![!monitoring-overview](images/Reddit/overview.png "Monitoring overview") + +This will list all subreddits you are monitoring + +--- + +## Configuration + +![!open-configuration](images/Reddit/open-configuration.png "Open Configuration Window") + +Click the **cog icon** to open the configuration options for Radarr. + +![!configuration](images/Reddit/configuration.png "Configuration Window") + +1. Pick a channel for the subreddit notification to go to +1. Copy and paste the URL to the subreddit +1. Add the subreddit to your account to monitor +1. Edit the channel of an existing monitored subreddit +1. Save the changed channel or remove the subreddit from being monitored diff --git a/docs/Notifiarr/Integrations-Setup/Sonarr.md b/docs/Notifiarr/Integrations-Setup/Sonarr.md new file mode 100644 index 000000000..12687f2a3 --- /dev/null +++ b/docs/Notifiarr/Integrations-Setup/Sonarr.md @@ -0,0 +1,55 @@ +# Sonarr Integration + +> This integration allows for notifications from Sonarr using its built in Connection for **Discord Notifier** + +--- + +## Trigger options + +![!triggers-channels](images/Sonarr/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 + - `Deleted` - Receive a notification when media is deleted + - `Health` - Receive a notification when Sonarr reports an issue +1. Channel + - Sonarr 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/Sonarr/open-configuration.png "Open Configuration Window") + +Click the **cog icon** to open the configuration options for Sonarr. + +![!configuration](images/Sonarr/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 alleviate 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/Sonarr/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/Sonarr/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/Sonarr/instructions.png "Instructions Window") + +1. How to enable notifications from within Sonarr +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/Network/configuration.png b/docs/Notifiarr/Integrations-Setup/images/Network/configuration.png new file mode 100644 index 000000000..30ac89744 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Network/configuration.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Network/instructions.png b/docs/Notifiarr/Integrations-Setup/images/Network/instructions.png new file mode 100644 index 000000000..49d92bdfc Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Network/instructions.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Network/open-configuration.png b/docs/Notifiarr/Integrations-Setup/images/Network/open-configuration.png new file mode 100644 index 000000000..2034e6fa5 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Network/open-configuration.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Network/overview.png b/docs/Notifiarr/Integrations-Setup/images/Network/overview.png new file mode 100644 index 000000000..a884edd08 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Network/overview.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Reddit/configuration.png b/docs/Notifiarr/Integrations-Setup/images/Reddit/configuration.png new file mode 100644 index 000000000..2cdae2ba8 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Reddit/configuration.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Reddit/open-configuration.png b/docs/Notifiarr/Integrations-Setup/images/Reddit/open-configuration.png new file mode 100644 index 000000000..603cc63f2 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Reddit/open-configuration.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Reddit/overview.png b/docs/Notifiarr/Integrations-Setup/images/Reddit/overview.png new file mode 100644 index 000000000..b2a37a007 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Reddit/overview.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Sonarr/configuration-2.png b/docs/Notifiarr/Integrations-Setup/images/Sonarr/configuration-2.png new file mode 100644 index 000000000..9723348e7 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Sonarr/configuration-2.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Sonarr/configuration.png b/docs/Notifiarr/Integrations-Setup/images/Sonarr/configuration.png new file mode 100644 index 000000000..71ad4f445 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Sonarr/configuration.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Sonarr/instructions.png b/docs/Notifiarr/Integrations-Setup/images/Sonarr/instructions.png new file mode 100644 index 000000000..a7355ba87 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Sonarr/instructions.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Sonarr/layout-editor.png b/docs/Notifiarr/Integrations-Setup/images/Sonarr/layout-editor.png new file mode 100644 index 000000000..bc7234ce2 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Sonarr/layout-editor.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Sonarr/open-configuration.png b/docs/Notifiarr/Integrations-Setup/images/Sonarr/open-configuration.png new file mode 100644 index 000000000..0fac4da36 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Sonarr/open-configuration.png differ diff --git a/docs/Notifiarr/Integrations-Setup/images/Sonarr/triggers-channels.png b/docs/Notifiarr/Integrations-Setup/images/Sonarr/triggers-channels.png new file mode 100644 index 000000000..4b1d78cc1 Binary files /dev/null and b/docs/Notifiarr/Integrations-Setup/images/Sonarr/triggers-channels.png differ diff --git a/docs/Notifiarr/Quick-Start.md b/docs/Notifiarr/Quick-Start.md index e2a96cdfa..31b49ca7e 100644 --- a/docs/Notifiarr/Quick-Start.md +++ b/docs/Notifiarr/Quick-Start.md @@ -1,6 +1,6 @@ # Quick Start -Here we're going to explain the basics setup for Notifiarr to get it working with Sonarr, Radarr, Bazarr and Plex. +Here we're going to explain the basic setup for Notifiarr to get it working with Sonarr, Radarr, Bazarr and Plex. If you want to make use of the other options I suggest to look at the advanced guide descriptions.