Awesome

This is the unified client for Notifiarr.com. The client enables content requests from Media Bot in your Discord Server and also provides reports for Plex usage and system health among many other features.

Installation

Linux

Linux repository hosting provided by

This works on any system with apt or yum. If your system does not use APT or YUM, then download a binary from the Releases page.

On Linux, Notifiarr runs as user:group of notifiarr:notifiarr.

Install the Go Lift package repo and Notifiarr with this command:

curl -s https://golift.io/repo.sh | sudo bash -s - notifiarr

After install, edit the config and start the service:

sudo nano /etc/notifiarr/notifiarr.conf
sudo systemctl restart notifiarr

Arch Linux

• Download a zst package from the Releases page.
• Install it: pacman -U *.zst
• Edit config: nano /etc/notifiarr/notifiarr.conf
• Restart it: systemctl start notifiarr

Example of the above in shell form:

curl https://raw.githubusercontent.com/Notifiarr/notifiarr/main/userscripts/install.sh | sudo bash

nano /etc/notifiarr/notifiarr.conf
systemctl start notifiarr

FreeBSD

• Download a txz package from the Releases page.
• Install it, edit config, start it.

Example of the above in shell form:

wget -qO- https://raw.githubusercontent.com/Notifiarr/notifiarr/main/userscripts/install.sh | sudo bash

vi /usr/local/etc/notifiarr/notifiarr.conf
service notifiarr start

On FreeBSD, Notifiarr runs as user:group of notifiarr:notifiarr.

macOS Install

Homebrew

Homebrew is no longer a supported installation method. Download the DMG and put Notifiarr.app in /Applications instead.

macOS App

• You can use the Apple-signed app on the Releases page.
• When you open it for the first time it will create a config file and log file:
  • ~/.notifiarr/notifiarr.conf
  • ~/.notifiarr/notifiarr.log
• Edit the config file and reload or restart the app.

Windows

• Extract a .exe.zip file from the Releases page.
• Run the notifiarr.amd64.exe binary. This starts the app in the system tray.
• When you open it for the first time it will create a config file and log file:
  • C:\ProgramData\notifiarr\notifiarr.conf
  • <your home folder>\.notifiarr\notifiarr.log
• Edit the new config file suit your environment then reload or restart the app.

Docker

This project builds automatically in Docker Cloud and creates ready-to-use multi-architecture images. The latest tag is always a tagged release in GitHub. The main tag corresponds to the main branch in GitHub and may be broken.

A sample docker compose file is found in Examples in this repo.

Unraid Users - You must configure a Notifiarr API Key in the Unraid Template. If you wish to use Plex then you'll also need to set the Plex Token and Plex URL in the template as well.

Docker Users - Note that Docker Environmental Variables - and thus the Unraid Template - override the Config file.

Docker Config File

• Copy the example config file from this repo.
• Then grab the image from docker hub and run it using an overlay for the config file.
• You must set privileged to use smartctl (monitor_drives) and/or MegaCli (monitor_raid).
• Map the /var/run/utmp volume if you want to count users.
• Mount any volumes you want to report storage space for. Where does not matter, "where" is the "name".
• You MUST set a static hostname. Each client is identified by hostname.
• You should mount /config - notifiarr will create the config file on first run.

docker pull golift/notifiarr
docker run --hostname=$(hostname) -d \
-v /your/appdata/notifiarr/:/config \
-v /var/run/utmp:/var/run/utmp \
golift/notifiarr
docker logs <container id from docker run>

Docker Environment Variables

See below for a list of which environment variables are available. You must set --privileged when monitor drives is enabled on the website.

docker pull golift/notifiarr
docker run --hostname $(hostname) -d --privileged \
  -v /var/run/utmp:/var/run/utmp \
  -e "DN_API_KEY=abcdef-12345-bcfead-43312-bbbaaa-123" \
  -e "DN_SONARR_0_URL=http://localhost:8989" \
  -e "DN_SONARR_0_API_KEY=kjsdkasjdaksdj" \
  golift/notifiarr
docker logs <container id from docker run>

Configuration Information

WebUI

To enable the webui, add this parameter to your config file, toward the top next to quiet, and restart the client:

ui_password = "username:9CharacterPassword"

Use a password that is at least 9 characters long. Once you log into the web interface, you can change the password and it will be saved encrypted (so no one can snoop it).

You may also set ui_password to the value of "webauth" to enable proxy authentication support. You must also add your auth proxy IP or CIDR to the upstreams setting for this to work. The proxy must pass x-webauth-user: username as a header, and you will be automatically logged in.

Config Settings

• Instead of, or in addition to a config file, you may configure a docker container with environment variables.
• Any variable not provided takes the default.
• Must provide an API key from notifiarr.com.
  • The Notifiarr application uses the API key for bi-directional authorization.
• You may provide multiple sonarr, radarr or readarr instances using DN_SONARR_1_URL, DN_SONARR_2_URL, etc or by duplicating the starr block in the conf file.

All applications below (starr, downloaders, tautulli, plex) have a timeout setting. If the configuration for an application is missing the timeout, the global timeout (above) is used.

Secret Settings

Recommend not messing with these unless instructed to do so.

Note: You may disable the GUI (menu item) on Windows by setting the env variable USEGUI to false.

System Snapshot

This application can take a snapshot of your system at an interval and send you a notification. Snapshot means system health like cpu, memory, disk, raid, users, etc. Other data available in the snapshot: mysql health, iotop, iostat and top data. Some of this may only be available on Linux, but other platforms have similar abilities.

If you monitor drive health you must have smartmontools (smartctl) installed. If you use smartctl on Linux, you must enable sudo. Add the sudoers entry below to /etc/sudoers and fix the path to smartctl if yours differs. If you monitor raid and use MegaCli (LSI card), add the appropriate sudoers entry for that too.

Usage of smartctl on Windows requires running this application as an administrator. Not entirely sure why, but the elevated privileges allow smartctl to gather drive data.

To monitor application disk I/O you may install iotop and add the sudoers entry for it, shown below. This feature is enabled on the website.

Snapshot Sudoers

The following sudoers entries are used by various snapshot features. Add them if you use the respective feature. You can usually just put the following content into /etc/sudoers or /etc/sudoers.d/00-notifiarr.

# Allows drive health monitoring on macOS, Linux/Docker and FreeBSD.
notifiarr ALL=(root) NOPASSWD:/usr/sbin/smartctl *

# Allows disk utilization monitoring on Linux (non-Docker).
notifiarr ALL=(root) NOPASSWD:/usr/sbin/iotop *

# Allows monitoring megaraid volumes on macOS, Linux/Docker and FreeBSD.
# Rarely needed, and you'll know if you need this.
notifiarr ALL=(root) NOPASSWD:/usr/sbin/MegaCli64 -LDInfo -Lall -aALL

These paths may not be the same on all systems. Adjust the username for macOS.

Snapshot Packages

• Windows: smartmontools - get it here https://sourceforge.net/projects/smartmontools/
• macOS: brew install smartmontools
• Linux:
  • Debian/Ubuntu: apt install smartmontools
  • RedHat/CentOS: yum install smartmontools
• Docker: It's already in the container. Lucky you! Just run the container in --privileged mode.
• Synology: opkg install smartmontools, but first get Entware:
  • Entware (synology): https://github.com/Entware/Entware-ng/wiki/Install-on-Synology-NAS
  • Entware Package List: https://github.com/Entware/Entware-ng/wiki/Install-on-Synology-NAS

Snapshot Configuration

There is no client configuration for snapshots (except Nvidia and MySQL, below). Snapshot configuration is found on the website.

MySQL Snapshots

You may add mysql credentials to your notifiarr configuration to snapshot mysql service health. This feature snapshots SHOW PROCESSLIST and SHOW STATUS data.

Access to a database is not required. Example Grant:

GRANT PROCESS ON *.* to 'notifiarr'@'localhost'

Nvidia Snapshots

You may report your GPU and memory Utilization for Nvidia cards. Automatic if nvidia-smi is found in PATH.

Lidarr

• BCC = Backup Corruption Check

Prowlarr

Radarr

Readarr

Sonarr

Downloaders

You can add supported downloaders so they show up on the dashboard integration. You may easily add service checks to these downloaders by adding a name. Any number of downloaders of any type may be configured.

All application instances also have interval and timeout inputs represented as a Go Duration. Setting interval to -1s disables service checks for that application. Setting timeout to -1s disables that instance entirely. Useful if an instacne is down temporarily. Example Go Durations: 1m, 1m30s, 3m15s, 1h5m. Valid units are s, m, and h`. Combining units is additive.

QbitTorrent

rTorrent

SABnzbd

Deluge

NZBGet

Plex

This application can also send Plex sessions to Notifiarr so you can receive notifications when users interact with your server. This has three different features:

• Notify all sessions on a longer interval (30+ minutes).
• Notify on session nearing completion (percent complete).
• Notify on session change (Plex Webhook) ie. pause/resume.

You must provide Plex Token for this to work. You may also need to add a webhook to Plex so it sends notices to this application.

• In Plex Media Server, add this URL to webhooks:
  • http://localhost:5454/plex?token=plex-token-here
• Replace localhost with the IP or host of the notifiarr application.
• Replace plex-token-here with your plex token.
• The Notifiarr application uses the Plex token to authorize incoming webhooks.

Tautulli

Only 1 Tautulli instance may be configured per client. Providing Tautulli allows Notifiarr to use the "Friendly Name" for your Plex users and it allows you to easily enable a service check.

Service Checks

The Notifiarr client can also check URLs for health. If you set names on your Starr apps they will be automatically checked and reports sent to Notifiarr. If you provide a log file for service checks, those logs will no longer write to the app log nor to console stdout.

You can also create ad-hoc service checks for things like Bazarr.

Ping and ICMP Service Checks

When type is set to ping a UDP ping check is performed, and when type is icmp an ICMP ping check is performed. With both settings, the expect parameter must be three integers separated by colons. ie. 3:2:500. This example means send 3 packets every 500 milliseconds, and expect at least 2 in return.

To enable unprivileged UDP pings on Linux you must run this command:

sudo sysctl -w net.ipv4.ping_group_range="0 2147483647"

To give the notifiarr binary access to send ICMP pings on Linux, run this command:

sudo setcap cap_net_raw=+ep /usr/bin/notifiarr

Process Service Checks

When type is set to process, the expect parameter becomes a special variable. You may set it to restart to send a notification when the process restarts. You may set it to running to alert if the process is found running (negative check). You may set it to count:min:max. ie count:1:2 means alert if process count is below 1 or above 2. You may combine these with commas. ie restart,count:1:3.

By default check is the value to find in the process list. It uses a simple string match. Unless you wrap the value in slashes, then it becomes a regex. ie. use this expect = "/^/usr/bin/smtpd$/" to match an exact string.

Run notifiarr --ps to view the process list from Notifiarr's point of view.

Reverse Proxy

You'll need to expose this application to the Internet, so Notifiarr.com can make connections to it. While you can certainly poke a hole your firewall and send the traffic directly to this app, it is recommended that you put it behind a reverse proxy. It's pretty easy.

You'll want to tune the upstreams and urlbase settings for your environment. If your reverse proxy IP is 192.168.3.45 then set upstreams = ["192.168.3.45/32"]. The urlbase can be left at /, but change it if you serve this app from a subfolder. We'll assume you want to serve the app from /notifiarr/ and it's running on 192.168.3.33 - here's a sample nginx config to do that:

location /notifiarr {
  proxy_set_header X-Forwarded-For $remote_addr;
  set $notifiarr http://192.168.3.33:5454;
  proxy_pass $notifiarr$request_uri;
}

Make sure the Nginx location path matches the urlbase Notifiarr setting. That's all there is to it.

Using an auth proxy? Be sure to set ui_password to the string "webauth". Also see the WebUI section above. The Nginx config looks more like this:

location /notifiarr/api {
  proxy_set_header X-Forwarded-For $remote_addr;
  set $notifiarr http://192.168.3.33:5454;
  proxy_pass $notifiarr$request_uri;
}

location /notifiarr {
  proxy_set_header X-Forwarded-For $remote_addr;
  proxy_set_header X-WebAuth-User $_username;
  set $notifiarr http://192.168.3.33:5454;
  proxy_pass $notifiarr$request_uri;
}

Here are two more example Nginx configs:

• TRaSH-'s Swag - A drop-in for Swag users.
• Captain's Custom - Fits into Captain's Go Lift setup. Not for everyone.

Troubleshooting

• Find help on Notifiarr's Discord.
• And/or on the GoLift Discord.

Log files

You can set a log file in the config. You should do that. Otherwise, find your logs here:

• Linux: /var/log/notifiarr/app.log (daemon), or ~/.notifiarr/Notifiarr.log (desktop)
• FreeBSD: /usr/local/var/log/notifiarr/app.log (service), or ~/.notifiarr/Notifiarr.log (desktop)
• macOS: ~/.notifiarr/Notifiarr.log
• Windows: C:\Users\YOURNAME\.notifiarr\Notifiarr.log

Still having problems? Let us know!

Integrations

The following fine folks are providing their services, completely free! These service integrations are used for things like storage, building, compiling, distribution and documentation support. This project succeeds because of them. Thank you!

Contributing

Join us on Discord and we can discuss.

License

MIT - Copyright (c) 2020-2024 Go Lift