Notifiarr Client Installation

Click your OS in the table of contents and follow the provided directions to get the client installed. Review the After Install page for next steps.

Linux

• Linux repository hosting provided by

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

Important

When you install from a deb or apt package, the logs folder /var/log/notifiarr and config folder /etc/notifiarr are automatically created. The notifiarr user and group are also created; the application runs as notifiarr:notifiarr. If you remove the package, these things will not be fully removed. If you do not install from a package, they will not be created automatically either.

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

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

2. 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 makepkg using the aur source

FreeBSD

1. Download a txz package from the Releases page.
2. Install it, edit config, start it.
3. On FreeBSD, Notifiarr runs as user:group of notifiarr: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

TrueNAS

If you figure out how to install Notifiarr on TrueNAS, please update these instructions. Notifiarr support and developers have very little experience with TrueNAS.

macOS

1. Download the signed dmg file from the Releases page.
2. Mount it and copy Notifiarr.app to /Applications then double-click it there.
3. When you open it for the first time it will create a config file and log file:
   1. ~/.notifiarr/notifiarr.conf
   2. ~/.notifiarr/Notifiarr.log
4. Use the menu bar icon to access the WebUI.
5. Head on over to After Install.

Windows

Info

Suggested location and structure based on experience with permissions.

Desired Outcome

• C:\ProgramData\notifiarr\notifiarr.amd64.exe - The Application.
• C:\ProgramData\notifiarr\notifiarr.conf - The config file. Just the add the API key.
• C:\ProgramData\notifiarr\logs - Folder for log files.

Create the folders

1. Open C:\ProgramData and create a folder notifiarr
2. Create a new folder named logs, so you now have C:\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.log
   • C:\ProgramData\notifiarr\logs\debug.log
   • C:\ProgramData\notifiarr\logs\http.log

New Install

1. Download notifiarr.amd64.exe.zip from the Releases page
2. Save it in C:\ProgramData\notifiarr
3. Open the folder that was created from extracting and copy the .exe + example .conf files up one directory so it is located at:
   • C:\ProgramData\notifiarr\notifiarr.amd64.exe
   • C:\ProgramData\notifiarr\notifiarr.conf.example
4. You can now delete the .zip file that was downloaded and the folder that was extracted
5. Rename notifiarr.conf.example to notifiarr.conf

Fix Existing Install

1. Stop the client
2. Copy the existing .exe to C:\ProgramData\notifiarr\notifiarr.amd64.exe
3. Copy the existing conf file to C:\ProgramData\notifiarr\notifiarr.conf
4. If the C:\users\<your home folder>\.notifiarr folder exists, delete it

Autostart & Password

• At this point, the structure should look like the Desired Outcome mentioned above.

• Right click on the .exe and create a 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.
• Double click on the shortcut and the client is now running
• If this is the first time you have ran it:
  1. Option A: Look at the notifiarr.log (or app.log) and you will see the password at the top of the file.
  2. Option B: Right click on the notifiarr icon and pick Logs -> View and get the login credentials from there.

Synology

1. 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. It also builds in a GitHub Action and publishes to GHCR (ghcr.io).

Compose

A sample docker compose file may be found in the Github repo here.

docker run

1. Mount an empty /config folder and the application will automatically write the config file there.
2. Pull the image from docker hub or ghcr and run it.
3. You must enable privileged to use smartctl (monitor_drives) and/or MegaCli (monitor_raid).
4. Map the /var/run/utmp volume if you want to count users.
5. Mount any volumes you want to report storage space for.
   1. Where you mount it sets the 'name'. e.g. /mnt/nas/data:/synonas

Static Hostname

Why -h notifiarr ? You MUST set a static hostname. Each client is identified by hostname.

docker pull golift/notifiarr
docker run --name Notifiarr -h notifiarr --restart unless-stopped \
    --privileged -p 5454:5454 -v /path/to/notifiarrconfig/:/config \
    -v /var/run/utmp:/var/run/utmp -v /etc/machine-id:/etc/machine-id golift/notifiarr
docker logs Notifiarr

Docker Environment Variables

You can find all the environment variables in the client's Web UI. You can run the app without a config file like this, but it's not recommended and only for advanced-needs.

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

Home Assistant OS Users

This is community provided. The Notifiarr developers have very little experience with Home Assistant OS.

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

Proxmox Users

This is community provided. The Notifiarr developers have very little experience with Proxmox.

• Proxmox Helper script

UltraCC Seedbox

UltraCC Seedbox Users

This is community provided. The Notifiarr developers have very little experience with UltraCC.

1. SSH into your Ultra Seedbox
2. On your landing directory type mkdir notifiarr
3. Type cd notifiarr
4. On Github find the latest release asset labelled notifiarr.amd64.linux.gz, right click on that and click copy link.
5. Back on your terminal type wget '<paste link>'
6. Type gzip -d notifiarr.*
7. Type mv notifiarr.* notifiarr
8. Type chmod +x notifiarr
9. In the notifiarr folder create notifiarr.conf from this: Github page
10. Type cd /home/$USER/.config/systemd/user
11. Type nano notifiarr.service
12. 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

1. Type systemctl --user enable notifiarr
2. Type systemctl --user start notifiarr
3. Type systemctl --user status notifiarr to check if there are any errors.
4. On your browser go to http://your-ultraseedbox-url:5454
5. Log into your Notifarr client and change the base url to /notifiarr and save changes
6. Go back to your ssh console
7. Type cd /home/$USER/.apps/nginx/proxy.d
8. Type nano notifiarr.conf
9. 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 {
    proxy_set_header X-Forwarded-For $remote_addr;
    set $notifiarr http://127.0.0.1:5454;
    proxy_pass $notifiarr$request_uri;
}

1. Type systemctl --user restart nginx
2. Now you should be able to browse to https://your-ultraseedbox-url/notifiarr