Skip to content

install.md

Latest commit

 

History

History
299 lines (221 loc) · 12.5 KB

install.md

File metadata and controls

299 lines (221 loc) · 12.5 KB

Linux

Linux repository hosting provided by  packagecloud

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 On Linux, Notifiarr runs as user:group of notifiarr:notifiarr.

  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

!!! info See Configuration Instructions Here

Arch Linux

  • This one is special; hope you know what you're doing.
  • Build a package with makepkg using the aur source

!!! info See Configuration Instructions Here

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

!!! info See Configuration Instructions Here

TrueNAS Scale

!!! warning "TrueNAS" 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:

macOS

macOS App

!!! note This is the recommend installation method for macOS.

  1. Download the signed dmg file from the Releases page.
  2. 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
  3. Edit the config file and reload or restart the app from the menu bar.

!!! info See Configuration Instructions Here

Homebrew

!!! warning "Homebrew users" Homebrew is not recommend, and may be discontinued in the future.

  1. Install Notifiarr
  2. Edit config file at /usr/local/etc/notifiarr/notifiarr.conf
  3. Start it.

The above in shell form:

brew install golift/mugs/notifiarr
vi /usr/local/etc/notifiarr/notifiarr.conf
brew services start notifiarr

Windows

!!! info Suggested location and structure based on expierence with permissions

Desired Outcome

  • C:\ProgramData\notifiarr\notifiarr.amd64.exe - The Application
  • C:\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

  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

If this is a 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

If this is an existing install being "fixed"

  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

New and existing installs

  1. Right click on the .exe and 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.exe which will minimize the console to the tray when it is ran
  2. Windows logo key + R, type shell:startup, then select OK. This opens the Startup folder.
  3. Copy and paste the newly created shortcut from its current location to the opened Startup folder.
  4. Double click on the shortcut and the client is now running
  5. 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_password to get the credentials

!!! info See Configuration Instructions Here

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

!!! info See Configuration Instructions Here

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.

Compose

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

!!! warning "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.

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

Docker Config File

  1. Copy the example config file from Notifiarr Client repo.
  2. Then grab the image from docker hub 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. Where does not matter, "where" is the "name". e.g. /mnt/nas/data:/synonas

!!! warning 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

See below for more information about which environment variables are available.

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

!!! warning "Home Assistant OS Users" 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

!!! warning "Proxmox Users" Please be aware none of us (Devs, Support, etc.) use this but hopefully for those who do this is helpful.

UltraCC Seedbox

!!! warning "UltraCC Seedbox Users" Please be aware none of us (Devs, Support, etc.) use this but hopefully for those who do this is helpful.

  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 {
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;
}
  1. Type systemctl --user restart nginx
  2. Now you should be able to browse to https://your-ultraseedbox-url/notifiarr