Settings — Connections
This page configures every external service Sublarr talks to about your library. Pick *arr-driven, Standalone, or both — the connections you add here drive what appears in Library and Wanted.
Sonarr / Radarr
Section titled “Sonarr / Radarr”For each *arr instance you want to connect, click Add instance and fill the row:
| Field | Effect |
|---|---|
| Type | Sonarr or Radarr. |
| Label | Display name in dropdowns and logs. |
| URL | Base URL with scheme and port, no trailing slash. |
| API key | From Settings → General → API Key in the *arr UI. |
| Test | Calls the *arr’s system/status endpoint and reports auth + version. |
You can add multiple instances of each — useful when you split anime / western / documentaries across separate Sonarr databases. Sublarr deduplicates by media ID across all instances.
Standalone folders
Section titled “Standalone folders”Use Standalone when you don’t run Sonarr / Radarr or you want Sublarr to handle a folder outside their control. Each row is one folder Sublarr will scan recursively:
| Field | Effect |
|---|---|
| Path | Absolute path inside Sublarr’s container (e.g. /media/anime). |
| Label | Sidebar display name. |
| Scan now | One-shot scan; reports the count of items added. |
| Scan interval (h) | Per-folder override of the global standalone scan cadence. |
| Skip extras | Excludes files matching the configured “extras” patterns (trailers, behind-the-scenes). |
Standalone folders can co-exist with *arr instances. Items found via filesystem walk that don’t match any *arr entry are tagged “standalone” and behave like *arr items in every other respect.
Media servers
Section titled “Media servers”Plex, Jellyfin, and Emby get notified when Sublarr writes a new subtitle so they can refresh their library cache. Add a row per server:
| Field | Effect |
|---|---|
| Type | Plex / Jellyfin / Emby. |
| URL | Base URL with scheme and port. |
| Token / API key | From the server’s account settings. |
| Library scope | Which libraries to refresh (default: all). |
| Test | Round-trips to the server’s identity endpoint. |
Plex uses an X-Plex-Token; Jellyfin/Emby use an API key + user ID. The form switches fields based on the Type dropdown.
Inbound webhooks
Section titled “Inbound webhooks”Sonarr and Radarr can push events to Sublarr (e.g. “new episode imported”) so a search starts immediately rather than waiting for the next scan. Sublarr exposes a webhook receiver at /api/v1/webhooks/sonarr and /api/v1/webhooks/radarr:
| Field | Effect |
|---|---|
| Webhook URL | Read-only; copy this into Sonarr/Radarr’s connection settings. |
| Webhook secret | Required HMAC secret. Sonarr/Radarr sign payloads with it; Sublarr verifies before acting. |
| Auto-translate on import | If on, queue a translation job as soon as the inbound webhook fires. |
Path Mapping (jump-off)
Section titled “Path Mapping (jump-off)”Path Mapping translates between Sonarr/Radarr’s view of paths and Sublarr’s. It has its own page — see Path Mapping for the full reference. The button on this page jumps to the dedicated editor.
Connection health
Section titled “Connection health”The header strip at the top of the page shows aggregate connection health:
| State | Meaning |
|---|---|
| All green | Every instance and server reachable. |
| Amber | Auth-OK but slow (latency above the threshold). |
| Red | Auth failure, network error, or server returned 5xx. |
Click any status pill to open the relevant row + a fresh Test result, so you can debug without leaving the page.