# Notifiarr

<p class="callout warning">
This unofficial app installation script is provided for your convenience. The script is provided as-is and may not be updated or maintained by Ultra.cc. Customers are welcome to use and customize unofficial app installers for their unique needs and requirements. Unofficial support may be offered via <a href="https://discord.ultra.cc">Discord</a> only and at the sole discretion of Ultra.cc staff. Use at your own risk and only proceed if you are comfortable managing the application on your own.
</p>

Notifiarr is a notification handler for Discord. It can manage media requests and allows for custom integrations with a wide variety of applications.

- Official documentation for Notifiarr can be found [here](https://notifiarr.wiki/).

## Prerequisites

- Registered account on [notifiarr.com](https://notifiarr.com/)
- [Discord](https://www.discord.com/) account and private server for the bot application

## Installation

- Connect to your Ultra.cc service via [SSH](https://docs.ultra.cc/books/secure-shell-%28ssh%29/page/how-to-connect-to-your-ultracc-slot-via-ssh)
- Once connected, execute the following command:

```sh
bash <(wget -qO- https://scripts.usbx.me/util/Notifiarr/main.sh)
```

- Next, to install Notifiarr, press `1` and `ENTER` to confirm.
  - To reset password, press `3` and `ENTER` to confirm.
  - To upgrade Notifiarr, press `4` and `ENTER` to confirm.
- Next, from the list of your unallocated ports, pick a port to use for Notifiarr.
  - Type the port that you want to use for Notifiarr, press `ENTER` to confirm.
  - To confirm your selection of port, type `confirm` and press `ENTER`.
- Next, paste your Notifiarr API key.
  - The API key can be found on your [Notifiarr profile page](https://notifiarr.com/user.php?page=profile).
- Next, choose a Notifiarr UI password and press `ENTER`.
- Wait for the installation to finish, then copy the URL to access the Notifiarr client in your web browser.
  - The URL should be in the format of: `https://username.hostname.usbx.me/notifiarr/`
- Once you have accessed the Notifiarr client in your web browser. Login with your Ultra service username and password that you chose earlier during the installation.

## Uninstallation

- Connect to your Ultra.cc service via [SSH](https://docs.ultra.cc/books/secure-shell-%28ssh%29/page/how-to-connect-to-your-ultracc-slot-via-ssh)
- Once connected, execute the following command:
 
```sh
bash <(wget -qO- https://scripts.usbx.me/util/Notifiarr/main.sh)
```

- Next, to uninstall Notifiarr, press `2` and `ENTER` to confirm.
- Done!