Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,15 @@
"Serilog",
"smartctl",
"Sonarr",
"Sportarr",
"sportarr",
"Syno",
"synonas",
"Tautulli",
"Telegraf",
"TMDB",
"Tracearr",
"tracearr",
"TVDB",
"unban",
"Unban",
Expand All @@ -98,6 +102,8 @@
"utmp",
"venv",
"webdl",
"Watchsync",
"watchsync",
"Webhook",
"webhooks",
"whisparr",
Expand Down
20 changes: 11 additions & 9 deletions docs/pages/client/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ bunzip2 /path/to/notifiarr.conf.bz

## Clearing Logs

- To `clear` logs to make troubleshooting easier - stop the client
- To `clear` logs to make troubleshooting easier: stop the client
and rename/remove the log file(s), then restart the client.
- If you have not previously enabled debug logs you do not need to clear anything.

Expand Down Expand Up @@ -106,14 +106,16 @@ See [Set a password](afterInstall.md#set-a-password) for more detail.

The Notifiarr client binary accepts several command-line flags useful for debugging:

- `--ps` - Print the system process list. Helpful when creating Process health checks to see exact process names.
- `--curl <url>` - GET a URL and display response headers and payload. Useful for testing connectivity to app instances. Use `--header "Key: Value"` to add request headers.
- `--version` - Print the full version string and exit.
- `-v` - Print the short version string and exit.
- `--write <path>` / `-w <path>` - Write a config file to the specified path. Pass `example` or `---` to write a fresh default-template config to `<config path>.new` next to your existing config. The client never overwrites an existing config file.
- `--config <path>` / `-c <path>` - Specify the config file path. Can also be set with the `DN_CONFIG_FILE` environment variable.
- `--extraconfig <path>` / `-e <path>` - Load additional config files. Can be specified multiple times.
- `--prefix <prefix>` / `-p <prefix>` - Change the environment variable prefix (default: `DN`).
- `--ps`: Print the system process list. Helpful when creating Process health checks to see exact process names.
- `--curl <url>`: GET a URL and display response headers and payload. Useful for testing connectivity to app instances. Use `--header "Key: Value"` to add request headers.
- `--fortune`: Print a random fortune and exit. It does not read your config file.
- `--version`: Print the full version string and exit.
- `-v`: Print the short version string and exit.
- `--write <path>` / `-w <path>`: Write a config file to the specified path. Pass `example` or `---` to write a fresh default-template config to `<config path>.new` next to your existing config. The client never overwrites an existing config file.
- `--config <path>` / `-c <path>`: Specify the config file path. Can also be set with the `DN_CONFIG_FILE` environment variable.
- `--extraconfig <path>` / `-e <path>`: Load additional config files. Can be specified multiple times.
- `--prefix <prefix>` / `-p <prefix>`: Change the environment variable prefix (default: `DN`).
- `--apthook`: Process a payload from a dpkg pre-install hook (Linux only). The deb package installs an apt hook that calls this flag; it does nothing unless `apt = true` is set in the config file. You do not run it by hand.

## Config File Compression

Expand Down
7 changes: 4 additions & 3 deletions docs/pages/integrations/packagemanager.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Package Manager

!!! info
This integration provides notifications for package updates on Linux (APT) and Unraid systems. The Notifiarr client monitors for available package updates and sends notifications to Discord.
This integration provides notifications for package updates on Linux (APT) and Unraid systems. The Notifiarr client relays APT install and update hooks, and the website sends notifications to Discord. Unraid notifications come from the [Notifiarr agent script](https://github.com/Notifiarr/notifiarr/blob/main/userscripts/unraid-notifiarr.sh).

---

## Trigger Options

### Triggers

- `APT` - Receive a notification when APT package updates are available (Linux)
- `APT` - Receive a notification when APT installs or updates packages (Linux). The client relays dpkg install hooks; it does not poll for available updates
- `Unraid` - Receive a notification for Unraid package updates
- `Unraid normal` - Normal priority Unraid notifications
- `Unraid warning` - Warning priority Unraid notifications
Expand Down Expand Up @@ -42,4 +42,5 @@ Click the **cog icon** to open the configuration options for Package Manager.
1. Ensure the Notifiarr client is installed and running on your system
2. Enable the Package Manager integration on the Notifiarr website
3. Enable the triggers for your operating system (APT for Linux, Unraid for Unraid)
4. The client will automatically check for package updates and send notifications
4. For APT, set `apt = true` in the client config file and restart the client. The deb package installs the dpkg hook that the client relays to the website
5. For Unraid, install the [Notifiarr agent script](https://github.com/Notifiarr/notifiarr/blob/main/userscripts/unraid-notifiarr.sh) as described at the top of that script
66 changes: 66 additions & 0 deletions docs/pages/integrations/sportarr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Sportarr

!!! info
This integration allows for notifications from [Sportarr](https://sportarr.net/), a sports PVR for Usenet and torrents. It works like Sonarr and Radarr, but for sports events.

---

## Trigger Options

### Triggers

- `Grab` - Receive a notification for a `Grab` event, when something is sent to the download client
- Optional notification fields: Instance, Indexer, Quality, Size, Poster, Banner, Status, Venue, City, Country, Description, League, Sport, Timestamp, Home team, Away team, Home score, Away score
- `Imported` - Receive a notification for a `Download` event that is not an upgrade, when media is imported to its root folder
- Optional notification fields: Instance, Indexer, Quality, Size, Filename, plus the same event fields as `Grab`
- `Upgrade` - Receive a notification for a `Download` event that Sportarr flags as an upgrade, when existing media is replaced with a better quality. If no Upgrade channel is set, the Imported channel is used
- Optional notification fields: same as `Imported`
- `Series Added` - Receive a notification for a `SeriesAdd` event, when a series or event is added
- Optional notification fields: Instance, plus the event fields from `Grab` (Poster through Away score)
- `Series Deleted` - Receive a notification for a `SeriesDelete` or `EpisodeFileDelete` event, when a series, event, or episode file is deleted
- Optional notification fields: Instance, Quality, Size, Filename, plus the event fields from `Grab` (Poster through Away score)
- `Rename` - Receive a notification for a `Rename` event, when files are renamed
- Optional notification fields: Instance, Path, Poster, Banner
- `Updates` - Receive a notification for an `ApplicationUpdate` event
- `Health Check` - Receive a notification for a `Health` event with a health type. The color follows the health level: Ok green, Notice blue, Warning yellow, Error red
- `Health Restored` - Receive a notification for a `Health` event with no health type, which the site treats as a restored health issue
- `Manual Interaction` - Receive a notification for a `ManualInteractionRequired` event, when a download needs a manual import
- Optional notification fields: Instance, Filename, Size, Confidence, Poster, Banner
- `Recording Started`, `Recording Completed`, and `Recording Failed` - Receive a notification for the `RecordingStarted`, `RecordingCompleted`, and `RecordingFailed` events
- Optional notification fields: Instance, Poster, Banner, Status, Venue, City, Country, Description, League, Sport, Timestamp, Home team, Away team, Home score, Away score. The same field selection applies to all three triggers.

### Channels

- Sportarr channel picker for each trigger

---

## Configuration

Click the **cog icon** to open the configuration options for Sportarr.

Most triggers have the following options:

1. Notification color
2. Notification pings
3. Notification layout
4. Toggle which optional fields to include in notifications

`Series Deleted` has separate ping and layout settings for series deletes and episode file deletes. `Health Check` has pings and layout only. `Health Restored` has no options.

The **Remove forced `Sportarr` from instance name** setting strips the forced `Sportarr` prefix from the instance name shown in notifications.

!!! note
Poster, rating, and link fields from the metadata database are not available yet, because Sportarr payloads do not include external IDs.

---

## Instructions

1. In Sportarr go to Settings → Notifications → Webhook and add a **Webhook** notification
1. Paste the webhook URL shown on the Sportarr integration page on the Notifiarr website into the URL field
1. Enable the triggers you want sent to Notifiarr
1. Enable the integration on the Notifiarr website and pick a Discord channel for each trigger
1. Customize the optional notification fields for each trigger

It is highly recommended you add an API key specific to this integration in your profile since Sportarr is a third-party app. The integration-specific webhook URL uses that key.
51 changes: 51 additions & 0 deletions docs/pages/integrations/tracearr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Tracearr

!!! info
This integration allows for notifications from [Tracearr](https://tracearr.com/), a real-time monitor for Plex, Jellyfin, and Emby servers that tracks streams, analyzes playback, and detects account sharing.

---

## Trigger Options

### Triggers

- `Violations` - Receive a notification when a rule violation is detected
- Optional notification fields: User, Rule, Severity, Minutes
- `New device` - Receive a notification when a new device is seen
- Optional notification fields: User, Device, Platform, Location
- `Started` - Receive a notification when a stream starts
- Optional notification fields: User, Stream type, Quality, Device, Location, Poster, Background
- `Stopped` - Receive a notification when a stream stops
- Optional notification fields: User, Poster, Background
- `Server offline` - Receive a notification when a media server goes down
- Optional notification fields: Server name, Server type
- `Server online` - Receive a notification when a media server comes back up
- Optional notification fields: Server name, Server type

### Channels

- Tracearr channel picker for each trigger

---

## Configuration

Click the **cog icon** to open the configuration options for Tracearr.

Each trigger has the following options:

1. Notification color
2. Notification pings
3. Notification layout
4. Toggle which optional fields to include in notifications

---

## Instructions

1. In Tracearr go to Settings → Notifications
1. Add a notification destination using the **JSON Webhook** format
1. Paste the webhook URL shown on the Tracearr integration page on the Notifiarr website
1. Enable the triggers you want on the Notifiarr website and pick a Discord channel for each

It is highly recommended you add an API key specific to this integration in your profile since Tracearr is a third-party app. The integration-specific webhook URL uses that key.
4 changes: 4 additions & 0 deletions docs/pages/integrations/trash.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,12 @@ Here we can manage existing profiles or add new profiles
- Clone: Copy the profile as is to another profile or instance
- Delete: Delete the sync (THIS DOES NOT DELETE THE PROFILE IN THE STARR APP)
1. New profile sync
- Profile code: Enter a profile code shared by another user and click **Verify**. Name the new profile and click **Clone profile** to add a copy of their profile sync to this instance
1. Groups of pre-made profiles

!!! info "Sharing a profile"
Each profile sync row shows a 10-digit profile code. Click the code to copy it and give it to another user. The code is only valid for the app it was made for, so a Radarr code is rejected on a Sonarr instance. Use the clone icon, not a code, to copy your own profiles. A cloned profile is created in the Starr app on the next sync. A profile cloned from another user is marked with an asterisk that shows who shared it and when.

![profiles-add.png](../../assets/screenshots/integrations/trash/profiles-add.png)

1. New profile to sync
Expand Down
50 changes: 50 additions & 0 deletions docs/pages/integrations/watchsync.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Watchsync

!!! info
This integration allows for notifications from [Watchsync](https://github.com/Notifiarr/watchsync), a tool that keeps users, libraries, and watch history in sync across multiple media apps. It is also used for disaster recovery of that history, to populate a new database.

---

## Trigger Options

### Triggers

- `User login` - Receive a notification for a `userLogin` event. The notification shows the username when Watchsync sends one
- `User update` - Receive a notification for a `userUpdate` event. The notification shows the username when Watchsync sends one
- `Connection error` - Receive a notification for a `connectionError` event
- Optional notification fields: Media app, Message
- `Sync webhook` - Receive a notification for a `syncWebhook` event. Fields come from the payload: ID, type, mode, libraries, users, source and destination apps, progress, scan, and library counts (movies, series, episodes). Title, poster, and banner come from the website's metadata lookup
- Optional notification fields: Id, Type, Mode, Libraries, User, Media app, Progress, Scan, Library stats, Poster, Banner, Title, Season, Episode, Name, Overview, Year, Rated, Network, Links
- `Sync overview` - Receive a notification for a `syncOverview` event, with per-app counts of created, linked, removed, added, updated, finished, and in-progress items. The site skips the notification when the payload has no changes, unless the status is `error` or `cancelled`. The color is red for `error` and yellow for `cancelled`
- Optional notification fields: Id, Type, Trigger, Mode, Status, Runtime, Libraries, Users, Media apps
- `Backup` - Receive a notification for a `backup` event. The color is red when the status is `failed`
- Optional notification fields: Type, Status, Runtime, Size

### Channels

- Watchsync channel picker for each trigger

---

## Configuration

Click the **cog icon** to open the configuration options for Watchsync.

Each trigger has the following options:

1. Notification color
2. Notification pings
3. Notification layout
4. Toggle which optional fields to include in notifications (`User login` and `User update` have no optional fields)

`Sync overview` also has a **Disabled types** filter. Sync types selected there do not send an overview notification.

---

## Instructions

1. In Watchsync go to Notifications and add Notifiarr
1. Use the webhook URL shown on the Watchsync integration page on the Notifiarr website
1. Enable the triggers you want on the Notifiarr website and pick a Discord channel for each

It is highly recommended you add an API key specific to this integration in your profile since Watchsync is a third-party app. The integration-specific webhook URL uses that key.
4 changes: 2 additions & 2 deletions docs/pages/integrations/whisparr.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
- `Grab` - Notifications for grabs that occur
- `Import` - Notifications for when media is imported
- `Upgrade` - Notifications for media upgrades
- `Added` - Notifications for new media added
- `Deleted` - Notifications for when media is deleted
- `Site added` - Notifications for when something new is added to the database that was not there before, so it can be searched for and grabbed
- `Site deleted` - Notifications for when media is deleted
- `Updates` - Notifications for system updates
- `Health Check` - Notifications for health checks
- `Health Restored` - Notifications for health restored to normal
Expand Down
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,14 @@ nav:
- Snapshots: pages/integrations/snapshots.md
- Seerr: pages/integrations/seerr.md
- Sonarr: pages/integrations/sonarr.md
- Sportarr: pages/integrations/sportarr.md
- Starr Proxy: pages/integrations/starrproxy.md
- Synology: pages/integrations/synology.md
- Tracearr: pages/integrations/tracearr.md
- TRaSH: pages/integrations/trash.md
- Unpackerr: pages/integrations/unpackerr.md
- Uptime-Kuma: pages/integrations/uptimekuma.md
- Watchsync: pages/integrations/watchsync.md
- Watchtower: pages/integrations/watchtower.md
- Website Status: pages/integrations/websitestatus.md
- Whisparr: pages/integrations/whisparr.md
Expand Down
Loading