*arr and download clients
Connect Sonarr, Radarr, Lidarr, Prowlarr and a download client to the media widgets.
Five media widgets read the *arr stack and the download clients: what is coming, what is downloading, how fast, the indexers and the health of each app.
Connect the *arr
- Open Settings → Integrations → *arr and choose Sonarr, Radarr, Lidarr or Prowlarr.
- Enter its address (for example
http://sonarr.example.com:8989) and its API key (in the app: Settings → General → Security → API Key). - Save, then test the connection. Add as many as you run (two Sonarr, for example).
Connect a download client
| Client | Address (example) | Credentials |
|---|---|---|
| qBittorrent | http://qbittorrent.example.com:8080 | API key (qBittorrent 5.2 and later, Options → Web UI) or Web UI user name and password |
| Transmission | http://transmission.example.com:9091 | RPC user name and password, if set |
| Deluge | http://deluge.example.com:8112 | Web UI password |
| SABnzbd | http://sabnzbd.example.com:8080 | API key (Config → General) |
| NZBGet | http://nzbget.example.com:6789 | Control user name and password |
Keys and passwords stay on the NasDash server. SABnzbd only accepts its key in the address it calls: NasDash adds it on the server, never in the browser.
Administrators pause and resume a download, or the whole client, from the widget (the button beside each download and the one beside the client's name).
Widgets
| Widget | Shows | Settings |
|---|---|---|
| Coming soon | From the *arr: episodes (Sonarr), movies with their cinema, digital or physical release (Radarr) and albums (Lidarr), the next one large, the rest as posters, an agenda or a list; a quiet window shows the next release and the days until it. From My library: what comes next for the series of a media server | Source; days (1–60); kinds; show downloaded titles; columns |
| Download queue | What the *arr are downloading: progress coloured by state, the reason of a warning, size, time left, read live from the download client | Items shown; columns |
| Downloads | Each client's speeds large with a line of the last minutes, active, paused and waiting downloads, free space, and the busiest downloads | Downloads listed; speed line |
| Indexers | Prowlarr's searches, grabs and failures of the last day, then each indexer, failing ones first with their next try | Prowlarr; only failing indexers; columns |
| *arr status | Each app's version, health checks, queue, missing items and free space; for Prowlarr, its indexers | Sources |
Widgets reading several apps use all of them by default, or a selection (Sources). An app that does not answer is named in the widget's title (“1 unreachable”); the others still show.
Sources
Coming soon reads up to three sources, ticked and ordered in its settings (Sources and priority); a title found in several shows once, from the first. *arr: the calendars above. My library: with a Jellyfin, Emby or Plex server, the widget asks TVMaze (public, no account) for each series' next episode or season. Catalogues: titles you follow, found with the search in the widget's settings (series on TVMaze, anime on Kitsu and AniList, movies on TMDB), or Everything coming. Movies need a TMDB connection (Settings → Integrations → Media, a v3 API key or v4 read token). Two tabs split what is Out now from what is Announced, dated or not; Shown per page sets the page size. Only TVDB/IMDb or catalogue ids and your searches leave the server; the first read of a large library takes a minute or two.
Access
Viewers see these widgets only with the Media permission (Settings → Users and access). Links that open a title in an *arr are shown to administrators only. Posters pass through NasDash and are served only to a widget whose answer listed them. The public demo shows invented titles.