¶ Notifiarr Client Installation
Find directions below to install the client and dependencies.
¶ Linux
Linux repository hosting provided by 
This works on any system with
aptoryum. If your system does not use APT or YUM, then download a binary from the Releases page and install it.
On Linux, Notifiarr runs as
user:groupofnotifiarr: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, set your apikey, and restart 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
¶ TrueNAS Scale
Please be aware none of us (Devs, Suppprt, etc.) use this but hopefully for those who do this is helpful.
- Consider moving away from TrueNAS Scale, and more specifically you must move away from TrueCharts for Notifiarr as Notifiarr v0.7.1 is broken / unsupported and TrueCharts will not upgrade the chart.
- The next TrueNAS Scale OS release will no longer support TrueCharts after their next OS release in 3 months (~10/2024)
- For additional information:
- No current TrueNAS Scale users have been able to to write documentation for Notifiarr.
- Heavy’s Guide is depreciated and will eventually be removed. It may stop working or be out of date at any time.
¶ 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.
- Install Notifiarr
- Edit config file at
/usr/local/etc/notifiarr/notifiarr.conf - Start it.
The above in shell form:
brew install golift/mugs/notifiarr
vi /usr/local/etc/notifiarr/notifiarr.conf
brew services start notifiarr
¶ Windows
Suggested location and structure based on expierence with permissions
¶ Desired Outcome
C:\ProgramData\notifiarr\notifiarr.amd64.exe- The ApplicationC:\ProgramData\notifiarr\notifiarr.conf- The config file. Should only be used to configure the apikey and enable the webui.C:\ProgramData\notifiarr\logs- Folder for log files
¶ Create the folders
- Open C:\ProgramData and create a folder
notifiarr - Create a new folder named
logs, so you now haveC:\ProgramData\notifiarr\logs- When you add the log paths in the client UI (later steps), make sure you point them to a file such as:
C:\ProgramData\notifiarr\logs\app.logC:\ProgramData\notifiarr\logs\debug.logC:\ProgramData\notifiarr\logs\http.log
- When you add the log paths in the client UI (later steps), make sure you point them to a file such as:
¶ If this is a new install
- Download
notifiarr.amd64.exe.zipfrom the Releases page - Save it in
C:\ProgramData\notifiarr - Open the folder that was created from extracting and copy the
.exe+ example.conffiles up one directory so it is located atC:\ProgramData\notifiarr\notifiarr.amd64.exeC:\ProgramData\notifiarr\notifiarr.conf.example
- You can now delete the
.zipfile that was downloaded and the folder that was extracted - Rename
notifiarr.conf.exampletonotifiarr.conf
¶ If this is an existing install being “fixed”
- Stop the client
- Copy the existing
.exetoC:\ProgramData\notifiarr\notifiarr.amd64.exe - Copy the existing conf file to
C:\ProgramData\notifiarr\notifiarr.conf - If the
C:\users\<your home folder>\.notifiarrfolder exists, delete it
¶ New and existing installs
- At this point, the structure should look like the Desired Outcome mentioned above.
- Right click on the
.exeand create a shortcut- Windows 11 users:
- Right click on the shortcut and pick properties
- Change the target path to
C:\Windows\System32\conhost.exe C:\ProgramData\notifiarr\notifiarr.amd64.exewhich will minimize the console to the tray when it is ran
- Windows 11 users:
- 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.
- Double click on the shortcut and the client is now running
- If this is the first time you have ran it:
- Option A: Look at the notifiarr.log (or app.log) and you will see a the credentials in the log
- Option B: Right click on the notifiarr icon and pick Logs -> View and get the login credentials from there
- Option C: Open the notifiarr.conf and look at the top for
ui_passwordto get the credentials
¶ Synology
-
Run the below command while ssh’d in to the NAS. It will run the Syno Install Script located on the Notifiarr Repository
curl -sSL https://raw.githubusercontent.com/Notifiarr/notifiarr/main/userscripts/install-synology.sh | sudo bash
¶ 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 Note
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
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.
```bash
docker pull golift/notifiarr
docker run --hostname=$(hostname) -d \
-v /your/config/folder:/config \
-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
--privilegedwhenmonitor drivesis 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>
¶ Home Assistant OS
Please be aware none of us (Devs, Support, etc.) use this but hopefully for those who do this is helpful.
Home Assistant Addon, the person to ask for help is @ZanY on the Notifiarr discord (if they are no longer a member, try their Github)
¶ Proxmox
Please be aware none of us (Devs, Suppprt, etc.) use this but hopefully for those who do this is helpful.
- Proxmox Helper script provided by the community
¶ 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.
Make sure the 00-notifiarr file has the proper permissions needed chmod 400 /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 - 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
¶ Other Installations
¶ UltraCC Seedbox
Please be aware none of us (Devs, Suppprt, etc.) use this but hopefully for those who do this is helpful.
-
SSH into your Ultra Seedbox
-
On your landing directory type
mkdir notifiarr -
Type
cd notifiarr -
On https://github.com/Notifiarr/notifiarr/releases find the latest release asset labelled notifiarr.amd64.linux.gz, right click on that and click copy link.
-
Back on your terminal type
wget '<paste link>' -
Type
gzip -d notifiarr.* -
Type
mv notifiarr.* notifiarr -
Type
chmod +x notifiarr -
In the notifiarr folder create notifiarr.conf from this: https://github.com/Notifiarr/notifiarr/blob/main/examples/notifiarr.conf.example
-
Type
cd /home/$USER/.config/systemd/user -
Type
nano notifiarr.service -
Paste the below
# Systemd service unit for notifiarr. [Unit] Description=notifiarr - Official chat integration client for Notifiarr.com [Service] ExecStart=/home/$USER/notifiarr/notifiarr \$DAEMON_OPTS Restart=always RestartSec=10 Type=simple WorkingDirectory=/home/$USER/notifiarr Environment=DN_LOG_FILE/home/$USER/notifiarr/app.log Environment=DN_HTTP_LOG=/home/$USER/notifiarr/http.log Environment=DN_DEBUG_LOG=/home/$USR/notifiarr/debug.log Environment=DN_SERVICES_LOG_FILE=/home/$USER/notifiarr/services.log Environment=DN_QUIET=true [Install] WantedBy=default.target -
Type
systemctl --user enable notifiarr -
Type
systemctl --user start notifiarr -
Type
systemctl --user status notifiarrto check if there are any errors. -
On your browser go to http://[ultraseedbox url]:5454
-
Log into your Notifarr client and change the base url to /notifiarr and save changes
-
Go back to your ssh console
-
Type
cd /home/$USER/.apps/nginx/proxy.d -
Type
nano notifiarr.conf -
Paste the below
location /notifiarr { # <put proxy auth directives here> Optional: # proxy_set_header X-WebAuth-User $auth_user; proxy_set_header X-Forwarded-For $remote_addr; set $notifiarr http://127.0.0.1:5454; proxy_pass $notifiarr$request_uri; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection $http_connection; proxy_set_header Host $host; } # Notifiarr Client location /notifiarr/api { deny all; # remove this line if you really want to expose the API. proxy_set_header X-Forwarded-For $remote_addr; set $notifiarr http://127.0.0.1:5454; proxy_pass $notifiarr$request_uri; } -
Type
systemctl --user restart nginx -
Now you should be able to browse to https://[ultraseedbox url]/notifiarr