From f882ca0485ac47abeb98abe013a8089c0132a2c5 Mon Sep 17 00:00:00 2001 From: TRaSH Date: Sun, 17 Jan 2021 14:39:24 +0100 Subject: [PATCH] Update Discord-Notifier-Basic-Setup.md - Changed: Discord Notifier to Discord Notifiarr - Added: option to make screenshots clickable ![ => ![! - Fixed: missing dicord-copid image --- docs/Misc/Discord-Notifier-Basic-Setup.md | 102 ++++++++++------------ 1 file changed, 48 insertions(+), 54 deletions(-) diff --git a/docs/Misc/Discord-Notifier-Basic-Setup.md b/docs/Misc/Discord-Notifier-Basic-Setup.md index 6255cdb29..27a82fa8c 100644 --- a/docs/Misc/Discord-Notifier-Basic-Setup.md +++ b/docs/Misc/Discord-Notifier-Basic-Setup.md @@ -1,13 +1,6 @@ - +# Discord Notifiarr Basic Setup -# Discord Notifier (Notifiarr) Basic Setup +Formerly aka Discord Notifier ------ @@ -15,7 +8,7 @@ First we're going to visit the [Notifiarr](https://discordnotifier.com/index.php){:target="_blank" rel="noopener noreferrer"} site, if you don't have an account yet, click the link to signup. - ![dn-login](images/dn-login.png) +![!dn-login](images/dn-login.png) 1. Your Email address you used during signup. 1. Your Password you created during signup. @@ -30,7 +23,7 @@ First we're going to visit the [Notifiarr](https://discordnotifier.com/index.php After you have logged in, you will be redirected to your profile screen. - ![dn-profile](images/dn-profile.png) +![!dn-profile](images/dn-profile.png) 1. Select your `Country`. 1. Select your `Timezone`. @@ -48,11 +41,11 @@ After you have logged in, you will be redirected to your profile screen. ### Integration Settings -![dn-manage-integration-open](images/dn-manage-integration-open.png) +![!dn-manage-integration-open](images/dn-manage-integration-open.png) First, click on `Manage Integrations` so you can enable what you want to receive notifications for. -![dn-manage-integration](images/dn-manage-integration.png) +![!dn-manage-integration](images/dn-manage-integration.png) A screen will popup and here you're able to select from which application/service you receive a notification. @@ -60,7 +53,7 @@ When you enabled the ones you want click on `Save` Setup which notifications you want to to receive from each option. - ![dn-notifcation-settings-radarr](images/dn-notifcation-settings-radarr.png) +![!dn-notifcation-settings-radarr](images/dn-notifcation-settings-radarr.png) 1. Cog wheel, this opens the integration settings 1. External link, this opens the website for the integration @@ -68,11 +61,11 @@ Setup which notifications you want to to receive from each option. 1. Trigger, this enables/disables a specific trigger for the integration 1. Channels, this sets the channel in your server to post to for the integration -??? example "Integration Settings (Cog wheel))" +??? example "Integration Settings (Cog wheel)" #### Notification Settings Configuration - ![dn-integration-settings](images/dn-integration-settings.png) + ![!!dn-integration-settings](images/dn-integration-settings.png) 1. [Instructions how to setup the integration](#integrations) 1. Enable/Disable notification trigger @@ -84,20 +77,16 @@ Setup which notifications you want to to receive from each option. ### Discord Settings -
Setup your discord server, shared channels, reactions and invite the bot into your server. -
#### Create the channels -
First thing to do is create a few channels (in your discord server) where you receive your notifications. -!!! note: +!!! note I won't be explaining how to setup a discord channel, that's up to you but google has plenty of references. You can do it all from one channel or separate the notifications (granular) for each trigger if you want. -
#### Simple channel setup @@ -113,11 +102,16 @@ First we need to get the server ID Open your User Settings -> Appearance -> Enable Developer Mode. - ![dn-discord-dev-mode](images/dn-discord-dev-mode.png) +![!dn-discord-dev-mode](images/dn-discord-dev-mode.png) Right click on the server name at the top of your discord and press "Copy ID" - ![dn-channel-paste](images/dn-channel-paste.png) +??? example "Example right click" + ![!dn-discord-copyid](images/dn-discord-copyid.png) + +Paste the channel ID in the corresponding boxes + +![!dn-channel-paste](images/dn-channel-paste.png) 1. Add your server ID 1. Select the channel ID for the `#media` channel. @@ -130,23 +124,23 @@ Open your User Settings -> Appearance -> Enable Developer Mode. ##### Granular arr setup - ![dn-granular-arr-setup](images/dn-granular-arr-setup.png) + ![!dn-granular-arr-setup](images/dn-granular-arr-setup.png) ??? example "Granular media setup" ##### Granular media setup - ![dn-granular-media-setup](images/dn-granular-media-setup.png) + ![!dn-granular-media-setup](images/dn-granular-media-setup.png) ### Invite the bot It's time to invite the bot in to your Server/Channels by clicking on the following link. - ![dn-invite-bot-here](images/dn-invite-bot-here.png) +![!dn-invite-bot-here](images/dn-invite-bot-here.png) You will get a screen that looks like the following screenshot. - ![dn-invite-bot-discord](images/dn-invite-bot-discord.png) +![!dn-invite-bot-discord](images/dn-invite-bot-discord.png) 1. Select the server the bot should join. 1. Click on `Authorize` to approve. @@ -169,7 +163,7 @@ You will get a screen that looks like the following screenshot. Here we will setup the Discord Notifier reactions(emoji's) that will be shown during a playback in plex, or during a download/import in Sonarr/Radarr. -![dn-reaction-1](images/dn-reaction-1.png) ![dn-reaction-2](images/dn-reaction-2.png) +![dn-reaction-1](images/dn-reaction-1.png)![dn-reaction-2](images/dn-reaction-2.png) This section exist of 2 parts. @@ -192,34 +186,34 @@ After you've added them to your Discord Server it's time to get the ID's from yo ``` ??? example "Example" - ![dn-emoji-example](images/dn-emoji-example.png) + ![!dn-emoji-example](images/dn-emoji-example.png) What results in to. - ![dn-emoji-result](images/dn-emoji-result.png) + ![!dn-emoji-result](images/dn-emoji-result.png) So your ID would be `:grab:706535455876710461`. Paste the ID results from your channel in to the corresponding boxes. - ![dn-reaction-paste](images/dn-reaction-paste.png) +![!dn-reaction-paste](images/dn-reaction-paste.png) Do this for all the other boxes also including your Trackers/Indexers. #### Trackers and Indexers - ![dn-reaction-indexers](images/dn-reaction-indexers.png) +![!dn-reaction-indexers](images/dn-reaction-indexers.png) 1. Paste here the the emoji ID. 1. The actual indexer name you're using in Sonarr/Radarr. ??? example "Example" - ![dn-indexer-torznab](images/dn-indexer-torznab.png) + ![!dn-indexer-torznab](images/dn-indexer-torznab.png) What will result in to. - ![dn-indexer-torznab-result](images/dn-indexer-torznab-result.png) + ![!dn-indexer-torznab-result](images/dn-indexer-torznab-result.png) If you use a different name in Sonarr and Radarr just add them with a comma `BeyondHD - Jackett,BHD`. @@ -234,22 +228,22 @@ Don't forget to click on `Save Changes` !!! Here we will explain how to we add all this to your *arr and Plex. - ![dn-integration-settings-link](images/dn-integration-settings-link.png) +![!dn-integration-settings-link](images/dn-integration-settings-link.png) ### Radarr, Readarr and Lidarr Radarr, Readarr and Lidarr supports Discord Notifier natively so that's an easy one to add. -`Settings` => `Connect` => click on ![dn-arr-add-plus.png](images/dn-arr-add-plus.png) and select `Discord Notifier` add your API key and you're done. +`Settings` => `Connect` => click on the ![dn-arr-add-plus.png](images/dn-arr-add-plus.png) `plus` icon and select `Discord Notifier` add your API key and you're done. ??? example "Radarr Example" - In Radarr go to `Settings` => `Connect` => Click on ![dn-arr-add-plus](images/dn-arr-add-plus.png) and select `DiscordNotifier.com`. + In Radarr go to `Settings` => `Connect` => Click on the ![dn-arr-add-plus](images/dn-arr-add-plus.png) `plus` icon and select `DiscordNotifier.com`. - ![dn-arr-add-notification](images/dn-arr-add-notification.png) + ![!dn-arr-add-notification](images/dn-arr-add-notification.png) Then add the following info. - ![dn-arr-settings-notification](images/dn-arr-settings-notification.png) + ![!dn-arr-settings-notification](images/dn-arr-settings-notification.png) 1. The name you want to use for the notification. 1. Enable `On Grab`, `On Import`, `On Upgrade`, `On Health Issue` & `Include Health Warnings`. @@ -262,9 +256,9 @@ Radarr, Readarr and Lidarr supports Discord Notifier natively so that's an easy Sonarr doesn't have native support & will not get one per their devs. That's why we're going to use the webhook method. - ![dn-sonarr-instruction](images/dn-sonarr-instructions.png) +![!dn-sonarr-instruction](images/dn-sonarr-instructions.png) -`Settings` => `Connect` > Click on ![dn-arr-add-plus](images/dn-arr-add-plus.png) and select `Webhook`. +`Settings` => `Connect` > Click on the ![dn-arr-add-plus](images/dn-arr-add-plus.png) `plus` icon and select `Webhook`. Add the following info: @@ -278,13 +272,13 @@ Click **Save** ??? example "Sonarr Example" - `Settings` => `Connect` > Click on ![dn-arr-add-plus.png](images/dn-arr-add-plus.png) and select `Webhook`. + `Settings` => `Connect` > Click on the ![dn-arr-add-plus.png](images/dn-arr-add-plus.png) `plus` icon and select `Webhook`. - ![dn-sonarr-add-webhook](images/dn-sonarr-add-webhook.png) + ![!dn-sonarr-add-webhook](images/dn-sonarr-add-webhook.png) Add the following info. - ![dn-sonarr-settings-webhook](images/dn-sonarr-settings-webhook.png) + ![!dn-sonarr-settings-webhook](images/dn-sonarr-settings-webhook.png) 1. The name you want to use for the notification. 1. Enable `On Grab`, `On Import`, `On Upgrade`, `On Health Issue` & `Include Health Warnings`. @@ -297,11 +291,11 @@ Click **Save** For Bazarr you need to make use of JSON method. - ![dn-bazarr-instruction](images/dn-bazarr-instruction.png) +![!dn-bazarr-instruction](images/dn-bazarr-instruction.png) `Settings` => `Notifications` => and select`JSON` -On the top click on ![dn-bazarr-edit-icon](images/dn-bazarr-edit-icon.png) icon and Enable the notification type. +On the top click on the ![dn-bazarr-edit-icon](images/dn-bazarr-edit-icon.png) `Edit` icon and Enable the notification type. Add the JSON URL that you copy/pasted from the integrations page. @@ -311,13 +305,13 @@ Scroll up and save `Settings` => `Notifications` => and select`JSON` - ![dn-bazarr-add-json](images/dn-bazarr-add-json.png) + ![!dn-bazarr-add-json](images/dn-bazarr-add-json.png) - On the top click on ![dn-bazarr-edit-icon](images/dn-bazarr-edit-icon.png) `Edit` icon and Enable the notification type. + On the top click on the ![dn-bazarr-edit-icon](images/dn-bazarr-edit-icon.png) `Edit` icon and Enable the notification type. Add the following info. - ![dn-bazarr-settings-json](images/dn-bazarr-settings-json.png) + ![!dn-bazarr-settings-json](images/dn-bazarr-settings-json.png) 1. Enable the JSON Notification. 1. Add the JSON URL that you copy/pasted from the integrations page. @@ -326,13 +320,13 @@ Scroll up and save Don't forget to click on Save on the top of the Bazarr screen. - ![dn-bazarr-save-json](images/dn-bazarr-save-json.png) + ![!dn-bazarr-save-json](images/dn-bazarr-save-json.png) ### Plex #### URL Webhook - ![dn-plex-instructions](images/dn-plex-instructions.png) +![!dn-plex-instructions](images/dn-plex-instructions.png) `Settings` => `Webhooks` => click on `ADD WEBHOOK` and add the URL that you can copy/paste from the integrations page and click on `SAVE CHANGES` @@ -343,7 +337,7 @@ Scroll up and save On the top right click on the ![dn-plex-settings-icon](images/dn-plex-settings-icon.png) `Settings` icon, and on the left sidebar select `Webhooks` Click on the middle of the screen on ![dn-plex-webhook-icon](images/dn-plex-webhook-icon.png) and add the following info. - ![dn-plex-settings-webhook](images/dn-plex-settings-webhook.png) + ![!dn-plex-settings-webhook](images/dn-plex-settings-webhook.png) 1. Add the URL that you can copy/paste from the integrations page. 2. Click on `SAVE CHANGES` @@ -352,7 +346,7 @@ Scroll up and save ### Advanced Plex Settings - ![dn-plex-advanced](images/dn-plex-advanced.png) + ![!dn-plex-advanced](images/dn-plex-advanced.png) #### Python Webhook @@ -392,7 +386,7 @@ Scroll up and save On the bottom of all the instruction you will now have the ability to test your settings. This only tests the connection between the notifier and your discord. You can use the Test in each *arr and that will test the everything (connection wise). - ![dn-test-icons-bar](images/dn-test-icons-bar.png) +![dn-test-icons-bar](images/dn-test-icons-bar.png) Click on the icons to test your notifications. After going through this tutorial and you still aren't getting notifications in your discord channel from the respective logos, then retry the steps outlined above. If there is still an issue, try asking in the Discord Notifier [discord channel](https://discord.gg/AURf8Yz){:target="_blank" rel="noopener noreferrer"} for additional support.