WIP: Updates for more detailed information.

pull/148/head
Austin Best 4 years ago committed by TRaSH
parent b7ba86ace2
commit 51da5accd8

4
.gitignore vendored

@ -1,2 +1,4 @@
venv/ venv/
mkdocs-dev-server.bat mkdocs-dev-server.bat
/docs/Notifiarr/preview.bat
/docs/Notifiarr/Integrations/_TEMPLATE.md

@ -0,0 +1,34 @@
# Permissions
This can be a struggle depending on how you have your server setup. If you want to do a simple test and see if you have permission issues, set the role your bot is included in to have admin permission and test. If everything works, this means you simply need to adjust permissions for the role so you do not need to make it an admin role if you dont want to.
---
I will work on the assumption you have created a role called **Bots** already with this and assigned the Notifiarr bot to it. With that said, right click on your server name at the top and pick `Server Settings > Roles`. Click on the Bots role so the permissions list loads.
> Yes I am aware that adding the bot automatically creates a **Notifiarr** role but most will rather leave that one hidden and use an existing role. If you want to use that one, make sure all the same permissions are applied to it.
**Required permissions**
1. `View Channels`
- The bot needs this role to generate a channel list so you can assign which notifications go to which channels on your server. If the channel is a private channel, you may also need to adjust channel specific permissions.
1. `Send Messages`
- This one is obvious, without it the bot role can not add messages to channels
1. `Embed Links`
- Many notifications have links (such as TMDb, TVDb, IMDb, Website links, etc)
1. `Add Reactions`
- *arr and Plex notifications add reactions to notifications to signify things such as the indexer, manual or rss grab, imported, failed, unpacked, subtitles, etc
1. `Use External Emojis`
- Only required if the reactions you use are from another server
1. `Mention @everyone, @here and All Roles`
- Needed if you have alerts setup with Snapshots or Media Request integrations so the proper user/role can be @mentioned
1. `Manage Messages`
- This is used for the Media Request integration so the bot can remove all the back and forth posts when adding new things to leave a clean channel history
1. `Read Message History`
- This is used for the Media Request integration so the bot can get the user interactions and is also used to place reactions on existing messages
---
If you manage your channels with individual permissions **plus** bot permissions, you will need to adjust them accordingly so the bot can do its job. If you have permissions mis-configured then the site will auto disable the integration after 25 Discord API errors. If you are using reactions and get API errors, the site will auto remove the reaction. If you are using the bot and have cleanup history enabled and get API errors, the site will auto disable that.
You will know when the site does this with a big red notice on top of the setup page that explains the error that Discord reported and what action was taken. All you have to do is fix the issue and re-enable what the site disabled from that point.

@ -1 +1,41 @@
# Bazarr # Bazarr Integration
> This integration allows for notifications from Bazarr and will also add reactions to notifications if a subtitle was found for it and you are using reactions.
Reaction example:
![!reaction](images/Bazarr/reaction.png "Reaction")
---
## Trigger options
![!triggers-channels](images/Bazarr/triggers-channels.png "Triggers and Channels")
1. Triggers
- `Info` - Currently all notifications use this type
- `Warning` - To date, Bazarr doesn't use this type
- `Success` - To date, Bazarr doesn't use this type
- `Failure` - To date, Bazarr doesn't use this type
1. Channel
- Bazarr 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/Bazarr/open-configuration.png "Open Configuration Window")
Click the **cog icon** to open the configuration options for Bazarr.
![!configuration](images/Bazarr/configuration.png "Configuration Window")
1. Open integration specific instructions
1. Choose the notification format
1. Enable reactions for *arr notifications when a subtitle is found if the associated *arr notification can be found
### Instructions
![!instructions](images/Bazarr/instructions.png "Instructions Window")
1. How to enable notifications from within Bazarr
1. How to enable notifications of a 2nd instance from within Bazarr
3. Test the notification from Notifiarr to Discord
- This will ensure your server, channel and permissions are set properly in Discord.

@ -1 +1,30 @@
# Better Uptime # Better Uptime Integration
> This integration allows for notifications from Better Uptime utilizng their webhook system
---
## Trigger options
![!triggers-channels](images/Better-Uptime/triggers-channels.png "Triggers and Channels")
1. Triggers
- `Started` - Sent when Better Uptime detects an issue with a site you are monitoring
- `Ack` (Acknowledged) - Sent when you mark the issue as acknowledged through Better Uptime
- `Resoled` - Sent when the site you are monitoring returns a successful response
1. Channel
- Pick a channel from your server to send these notifications
---
## Configuration
![!open-configuration](images/Better-Uptime/open-configuration.png "Open Configuration Window")
Click the **cog icon** to open the configuration options for Better Uptime.
![!configuration](images/Better-Uptime/configuration.png "Configuration Window")
1. Notification colors for each trigger type
1. Notification content options that you can turn on/off to show in the notifications
1. Better Uptime team id that is used to link the Incident in the notification
**NOTE:** This integration sends a single notification for all triggers. After the first one is sent, the rest will update the existing notification in the chain.

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Loading…
Cancel
Save