Skip to content

Dashboard

Info

This integration allows for notifications to keep you updated with an overview of some commonly used apps.

The frequency of dashboard updates is controlled by the Notifiarr Client Configuration for the Dashboard for the specified client. All other Dashboard settings are noted below and within the Dashboard Integration.

Note

The bot needs Manage Messages permission for this to work properly.

Supported Apps

The Dashboard supports the following applications, organized by category:

Starr Apps

  • Lidarr
  • Radarr
  • Readarr
  • Sonarr

Download Clients

  • Deluge
  • NZBGet
  • qBittorrent
  • rTorrent
  • SABnzbd
  • Transmission

Media

  • Plex

Trigger options

trigger_channels_new.png

  1. List of apps that are posting updates
  2. Used to assign a discord channel to each of your apps to enable notifications

Discord Channel Setup

discord_channel_setup_new.png

  1. List of currently supported Apps
  2. Copies the first Discord channel to all channels below
  3. Discord channel drop-down selection list
  4. Discord bot permissions test. If the test passes the user will receive a notification from the bot in the specified channel. If no notification is received, please ensure you have assigned appropriate permissions to the Notifiarr bot.
  5. Displays all available Discord channels in the users Notifiarr instance

Configuration

open_configuration_new.png

Click the cog icon to open the configuration options for the Dashboard integration and the following window will open.

integration_settings.png

  1. Initial instructions on how to setup the Dashboard by using the Notifiarr UI.
  2. In this section you can define the active Apps and further configure them.
  3. Contains additional Settings and customizations
  4. Here you can set the update interval of the Dashboard
  5. Allows you to change the default icon (Subscriber feature).
  6. Some examples of the Dashboard output.

Per-App Settings

Each app has the following configurable options:

  1. Enabled - Toggle the app on or off in the Dashboard
  2. Newest - How many of the newest items to see in the message (0-5 for Starr apps, 0-5 for download clients)
  3. Upcoming - How many of the upcoming items to see in the message (0-10)
  4. Total Is (Starr apps only) - How the Dashboard should display your completion ratio:
    • In Database - Compares your downloaded items against what the App considers a complete list
    • On Disk - Compares your downloaded items to what you have on your disk
  5. Order - The display order of the app in the Dashboard (minimum 1)
  6. Template - Customize the notification layout

Note

Starr apps also allow selecting specific instances to include in the Dashboard.

Settings

  • Hostname in notifications - Include the client hostname in dashboard notifications
  • Notification behavior - Choose between Update existing (edits the existing message) or New messages (posts a new message each time)
  • Force repost - Marks all notifications to be deleted on the next update and reposts new ones
  • Reorder dashboard - Clears content hashes and allows all messages to update to fix the order

Warning

When you change the active status or the order, the next update will trigger a delete all and repost everything automatically, so they are in the correct order based on what you have turned on.

Examples

radarr example sonarr example
example-radarr.ping example-sonarr.png