¶ Notifiarr Client Installation
Find directions below to install the client and dependencies.
¶ 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:groupofnotifiarr:notifiarr.
- On Linux, Notifiarr runs as
- 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
- This one is special; hope you know what you're doing.
- Build a package with
makepkgusing theaursource
¶ FreeBSD
- Download a
txzpackage from the Releases page. - Install it, edit config, start it.
- On FreeBSD, Notifiarr runs as
user:groupofnotifiarr:notifiarr.
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
¶ TrueCharts Scale
- Please refer to this Community User created guide
¶ macOS
¶ macOS App
- This is the recommend installation method for macOS.
- Download the signed
dmgfile from 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 from the menu bar.
¶ Homebrew
- Homebrew is not recommend, and may be discontinued in the future.
- Edit config file at
/usr/local/etc/notifiarr/notifiarr.conf - Start it.
- Like this:
brew install golift/mugs/notifiarr
vi /usr/local/etc/notifiarr/notifiarr.conf
brew services start notifiarr
¶ Windows
- Extract a
.exe.zipfile from the Releases page. - Run the
notifiarr.amd64.exebinary. 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 to suit your environment then reload or restart the app from the system tray.
¶ Windows Startup
To enable Notifiarr to auto start on system reboot:
- Create shortcut (right click on
notifiarr.exe=> Create Shortcut) - Windows logo key + R, type
shell:startup, then select OK. This opens the Startup folder. - Copy and paste the newly created shortcut from its current location to the opened Startup folder.
TODO: Add the conhost workaround to make the window dispear when using Windows Terminal.
¶ 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.
A sample docker compose file may be found in the Github repo here.
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 Notifiarr Client repo.
- Then grab the image from docker hub and run it using an overlay for the config file.
- You must enable
privilegedto usesmartctl(monitor_drives) and/orMegaCli(monitor_raid). - Map the
/var/run/utmpvolume 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.
docker pull golift/notifiarr
docker run --hostname=$(hostname) -d \
-v /your/config/notifiarr.conf:/config/notifiarr.conf \
-v /var/run/utmp:/var/run/utmp \
golift/notifiarr
docker logs <container id from docker run>
¶ Docker Environment Variables
See below for more information about 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>
¶ Snapshot Dependencies
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.
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
¶ Snapshot Packages
- Windows:
smartmontools- get it here https://sourceforge.net/projects/smartmontools/ - Linux:
- Debian/Ubuntu:
apt install smartmontools - RedHat/CentOS:
yum install smartmontools
- Debian/Ubuntu:
- Docker: It's already in the container. Lucky you! Just run the container in
--privilegedmode. - 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