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”Media servers get notified when Sublarr writes a new subtitle so they can pick it up without a manual library scan. Click Add Server, pick the type, and fill the row. You can add several servers, also of the same type.
| Type | Fields |
|---|---|
| Plex | Server URL (default http://localhost:32400), X-Plex-Token (Plex Settings → Troubleshooting → View XML, the X-Plex-Token parameter). |
| Jellyfin / Emby | Server URL (default http://localhost:8096), API Key (Jellyfin Dashboard → API Keys, or Emby Server → API Keys), Server Type jellyfin or emby — both use the same API. |
| Kodi | Server URL of the Kodi web interface (default http://localhost:8080; enable Allow remote control via HTTP in Kodi), optional Username / Password for HTTP Basic Auth. |
| Shoko Server | Server URL (default http://localhost:8111), API Key, or Username / Password when no API key is set. |
Every row also has a Name, Path Mapping, an Enabled toggle and Test Connection, which checks that the server answers and accepts the credentials.
How each server is notified:
- Plex gets a partial scan of the episode’s or film’s folder in the library that contains it. Only when no Plex library contains that folder — usually a path mapping that does not match Plex’s view — are the libraries of the matching type (TV for an episode, movies for a film) scanned in full.
- Jellyfin / Emby look the item up by its path and refresh only that item; if no item has that path, the whole library is refreshed.
Media server path mapping
Section titled “Media server path mapping”Use Path Mapping when the media server sees your files under a different path than Sublarr does — without it, the server is asked about a path it does not have and falls back to a full scan.
- The format is
from:to, wherefromis the path as Sublarr sees it andtothe path as the media server sees it:/media:/data. - Several pairs are separated by
;, for a server that mounts each library under its own root:/media/tv:/data/tv;/media/movies:/data/films. - The pair with the longest matching
fromwins, whatever order you write them in. - A trailing slash on either side is fine.
- Pairs match whole folders only:
/media/movies:/data/filmsdoes not touch/media/movies-4k/…. - A path no pair matches is passed on unchanged.
This mapping is separate from the Sonarr/Radarr path mapping, which translates between the *arr’s view and Sublarr’s; each media server row has its own.
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/webhook/sonarr and /api/v1/webhook/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.