ARR Integration

Since: 0.18.0

User-facing guide to integrating Sonarr, Radarr, and Bazarr with Phlix for automated media management.

---

Overview

ARR applications (Sonarr, Radarr, Prowlarr, Bazarr) monitor download clients and automatically add new content to your library. Phlix acts as a client for these applications, serving the media they manage.

Application	Manages	Connects to Phlix as
Sonarr	TV series	Media server (movie library or TV library)
Radarr	Movies	Media server
Bazarr	Subtitles for Sonarr/Radarr	Subtitle provider
Prowlarr	Indexer management	Indexer source for Sonarr/Radarr

Phlix does not download or manage downloads — it only serves the media that the ARR applications have already downloaded through their own download client integration.

---

Setting up the connection

1. Create a Phlix API key

1. Open the Phlix web UI as an admin user.
2. Go to Admin → Server Settings → API Keys.
3. Create a new API key with a descriptive name (e.g. Sonarr).

2. Add Phlix as a client in Sonarr / Radarr

Sonarr

1. Settings → Connect → + → Generic
2. Fill in:
   • Name: Phlix
   • URL: http://your-phlix-host:8096
   • API Key: your Phlix API key from step 1
3. Test the connection and save.

Radarr

1. Settings → Connect → + → Custom Script
2. Fill in:
   • Name: Phlix
   • URL: http://your-phlix-host:8096
   • API Key: your Phlix API key from step 1
3. Radarr does not have a native Generic import — use the Custom Script connector pointing at Phlix's import endpoint.

3. Create the library in Phlix

Create a library in Phlix (e.g. /mnt/media/movies for Radarr, /mnt/media/tv for Sonarr) and scan it so Phlix is aware of the content.

---

ARR configuration reference

Default ports

Application	Default port	URL
Sonarr	8989	http://localhost:8989
Radarr	7878	http://localhost:7878
Prowlarr	9696	http://localhost:9696
Bazarr	6767	http://localhost:6767

Phlix API endpoints used by ARRs

ARR applications interact with Phlix through the standard media library API:

Action	Method	Endpoint
List library items	GET	/api/v1/libraries/{libraryId}/items
Get media item	GET	/api/v1/media/{id}
Get download health	GET	/api/v1/system/status
Trigger rescan	POST	/api/v1/admin/library/rescan

---

Troubleshooting

ARR shows "No items found" in Phlix

1. Verify the library in Phlix has been scanned and contains items.
2. Check the ARR log for the specific error — the most common cause is the media path in the ARR not matching the path Phlix serves.
3. Make sure the media directory is accessible to the phlix system user.

Import fails with a path mismatch

ARR applications import media by copying or hard-linking from the download location to the library folder. If Phlix and the ARR run as different users, ensure both can read/write the relevant directories:

# Allow both phlix and the download client's user access to the media directory
sudo chgrp -R media-group /mnt/media
sudo chmod -R 2775 /mnt/media

Bazarr subtitles not syncing

Bazarr manages subtitles separately from Sonarr/Radarr. Verify Bazarr is pointed at the same library root as Phlix:

1. Bazarr → Settings → Sonarr / Radarr — confirm the series/movie root folder matches what Phlix has scanned.
2. Run a manual scan in Bazarr: Settings → History → Rescan.

---

More detail

Developer documentation for the underlying ARR API client library (which runs in the detain/phlix-shared package) is at /dev/arr-clients. This covers the Sonarr/Radarr/Prowlarr/Bazarr API wrappers, their configuration options, and how to extend them.