Skip to content

Commit 8452a10

Browse files
Show how to move Unpackerr from [[whisparr]] to [[radarr]].
Whisparr uses the Radarr API, so the docs should tell people to configure it as a named Radarr instance. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 2d65270 commit 8452a10

3 files changed

Lines changed: 11 additions & 5 deletions

File tree

‎docs/install/configuration.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,12 @@ UN_FOLDER_1_PATH=/data/downloads/games/
7979
Anything that [has a header](https://github.com/Unpackerr/unpackerr/blob/main/examples/unpackerr.conf.example#L99)
8080
with double brackets `[[..]]` can be repeated as many times as you'd like.
8181

82+
### Whisparr
83+
84+
Whisparr uses the Radarr API. Rename `[[whisparr]]` to `[[radarr]]` (and `UN_WHISPARR_*`
85+
to `UN_RADARR_*`). Set `name = "Whisparr"` if logs and hooks should keep that label.
86+
Existing `[[whisparr]]` blocks still load as Radarr for now.
87+
8288
{/* The Global content is generated from here: https://github.com/Unpackerr/unpackerr/tree/main/init/config */}
8389
<Global />
8490

‎docs/introduction.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Introduction and explanation of Unpackerr.
66

77
Unpackerr is an application that runs on Windows, macOS, Linux, FreeBSD and in Docker.
88
You can use it to watch a download folder and extract new items.
9-
The more common use is to watch Starr apps (Radarr, Sonarr, Readarr, Lidarr, Whisparr)
9+
The more common use is to watch Starr apps (Radarr, Sonarr, Readarr, Lidarr)
1010
and extract items they download. It can do both, at the same time even.
1111

1212
## Features
@@ -26,7 +26,7 @@ and extract items they download. It can do both, at the same time even.
2626
## Description
2727

2828
This application runs as a daemon on your download host. It checks for completed
29-
downloads and extracts them so Lidarr, Radarr, Readarr, Sonarr, and Whisparr may
29+
downloads and extracts them so Lidarr, Radarr, Readarr, and Sonarr may
3030
import them. There are a handful of options out there for extracting and deleting
3131
files after your client downloads them. I just didn't care for any of them, so I
3232
wrote my own. I wanted a small single-binary with reasonable logging that can extract
@@ -67,7 +67,7 @@ of these types:
6767

6868
## Starr Logic
6969

70-
The application polls Radarr, Readarr, Sonarr, Lidarr, and Whisparr at the `interval`
70+
The application polls Radarr, Readarr, Sonarr, and Lidarr at the `interval`
7171
configured. The queued items are inspected for completeness.
7272

7373
When Unpackerr finds an item in a Starr app, the download location is checked for an

‎docs/unpackerr/faq.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ Great question! It has two answers.
1919

2020
## 2. What is a Starr app?
2121

22-
Lidarr, Radarr, Readarr, Sonarr, Whisparr
22+
Lidarr, Radarr, Readarr, Sonarr
2323

2424
Unpackerr integrates with those apps. Prowlarr is also a Starr app, but Unpackerr does
25-
not talk to it.
25+
not talk to it. Whisparr uses the Radarr API; configure it as a Radarr instance.
2626

2727
## 3. Why does Unpackerr show things not in my Starr app?
2828

0 commit comments

Comments
 (0)