Skip to content

docs: add TRaSH sync requirements and Sonarr v5 status #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
bakerboy448 wants to merge 1 commit into from
Closed

docs: add TRaSH sync requirements and Sonarr v5 status #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 21 additions & 0 deletions docs/pages/client/afterInstall.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,27 @@ Set the credentials either way:

The same keys apply to the `[[sonarr]]`, `[[lidarr]]`, `[[readarr]]`, and `[[prowlarr]]` blocks.

### TRaSH Sync Requirements

The [TRaSH](../integrations/trash.md) sync is a Patron and Subscriber feature. The client reads your profiles,
custom formats, quality definitions, and naming from each synced app and sends them to the website.
The website compares them to the TRaSH guide and sends any changes back through the client.

| Item | Current behavior |
| --- | --- |
| Apps | Radarr and Sonarr. The website TRaSH card has no Lidarr sync, and the client API returns `501` for a Lidarr sync trigger |
| Sonarr version | Sonarr v4. The website skips custom formats on Sonarr v3 |
| Sonarr v5 | Needs the unstable client for now. Unstable `0.9.8` reads and writes through `/api/v5`. Released stable clients use the `v3` API path |
| Instance state | The app needs a URL, an API key, and a Time Out that is not `-1s` (disabled). Disabled instances are skipped |
| Schedule | Set the interval in the TRaSH **Client Settings** on the website. The client adds up to 5 seconds of random delay per instance. With no interval there is no timer |
| Timer runs | A timer run skips the app when the TRaSH guide is unchanged ("repo hash match") |
| Manual runs | The **Sync** button on the website and a client-triggered sync run a full pass |
| Results | Discord only. Turn on the Format, Profile, Score, Quality, and Naming toggles in the TRaSH **Settings** tab, per app |

- A failed write is reported only when its toggle is on. With the toggles off, failures are silent.
- The last sync time on the **Settings** tab means a sync ran. It does not mean every write worked.
- If the app URL points at [Starr Proxy](../integrations/starrproxy.md), the proxy key must allow write methods. See the proxy page.

### Health Checks

Set the health check intervals on all your apps if you want notifications when an app goes down.
Expand Down
3 changes: 3 additions & 0 deletions docs/pages/integrations/sonarr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
![Current Master/Stable](https://img.shields.io/badge/dynamic/json?color=526cfe&style=for-the-badge&label=Main&query=%24%5B%27v4-stable%27%5D.version&url=https%3A%2F%2Fservices.sonarr.tv%2Fv1%2Freleases){ .off-glb }
![Current Develop/Nightly](https://img.shields.io/badge/dynamic/json?color=526cfe&style=for-the-badge&label=Develop&query=%24%5B%27v4-nightly%27%5D.version&url=https%3A%2F%2Fservices.sonarr.tv%2Fv1%2Freleases){ .off-glb }

!!! note "TRaSH sync"
TRaSH sync supports Sonarr v4. Sonarr v5 needs the unstable Notifiarr client for now. See [TRaSH Sync Requirements](../client/afterInstall.md#trash-sync-requirements).

## Trigger options

![triggers-channels.png](../../assets/screenshots/integrations/sonarr/triggers-channels.png)
Expand Down
8 changes: 8 additions & 0 deletions docs/pages/integrations/starrproxy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,11 @@ Click the **cog icon** to open the configuration options for Starr Proxy.
2. Configure the Blocked trigger and select a notification channel
3. Set up your notification color and pings as desired
4. Test the notification to ensure it is working

---

## TRaSH Sync Through the Proxy

If a Starr app in the Notifiarr client uses a Starr Proxy URL and key, the [TRaSH sync](../client/afterInstall.md#trash-sync-requirements) needs more than read access.
Sync creates and updates custom formats, quality profiles, quality definitions, and naming (`POST` and `PUT`, plus `DELETE` for custom formats and quality profiles).
On Sonarr v5 that includes the bulk `PUT /api/v5/qualitydefinition` and `PUT /api/v5/settings/naming`. Use the **Notifiarr** key template for the app, or enable those methods yourself. A key with `GET` only lets the sync read the app and returns `405` on every write.
Loading