App integrations

Stats, actions and alerts for Sonarr, qBittorrent, Pi-hole and more – and how to add any app.

App integrations show live stats, one-tap actions and alerts for the apps you run. Every app is described by a short YAML definition, so you can add any app with an HTTP API without waiting for a new release, and share definitions with others.

Supported apps

21 apps are built in:

Turn the feature on or off under Settings → Modules → App integrations.

Connecting your apps

Found on your servers

Containers whose image matches a definition are listed at the top of the page with a Connect button. The hub works out the address from the container's published port, or for host-networking containers, the host's address and the app's usual port. Stopped containers are shown but greyed out.

Connect all automatically

Many apps keep their API key in a config file inside their container. Sonarr, Radarr, Prowlarr, Lidarr and Readarr use config.xml, Bazarr uses config.yaml, Tautulli uses config.ini, and SABnzbd uses sabnzbd.ini. Others, like linuxserver's NZBGet image, take the password from an environment variable. Connect all automatically reads these for every running app it can fully set up by itself, then connects them in one go. It reports which ones still need you, and why (for example "needs username, password").

Connecting one by hand

1. Add an appOpen the Add an app tab (or press + Connect an app) and pick the app.
2. AddressUse the LAN address and port, e.g. http://192.168.1.20:8989. The hub talks to the app directly, not through your reverse proxy.
3. CredentialsFill in what the app needs. Each field has a hint saying where to find it in the app. Secret fields are stored encrypted. When editing, leave a saved secret blank to keep it.
4. OptionsCheck every (default 60 s), Verify the HTTPS certificate (off for self-signed), and Enabled.
5. ConnectThe hub checks it straight away and tells you if the app refused the credentials or didn't answer.

Using integrations

• Cards show the app's status and response time, its stats (queue, missing, speeds, streams…), when it was last checked, and any error.
• Actions are buttons such as Search missing, RSS sync, Pause downloads, Toggle speed limits or Pause protection 5 min. Actions that change a lot ask you to confirm first.
• ↻ checks now, ✎ edits, 🗑 disconnects (the app itself isn't touched).
• Alerts: integration.down when an app stops answering, integration.up when it's back, and integration.alert for anything its definition watches (e.g. "Sonarr reports 2 health issues").
• On the iPhone app: side menu (swipe from the left edge) → Integrations, with the same stats, actions and "Connect all automatically".

Adding any app: definitions

Open the Definitions tab:

• + New definition opens the editor with a template. It validates as you type and shows how many stats and actions it found.
• Import from a URL takes a raw .yaml link (a GitHub raw file or a gist). Import a file takes a .yaml from your computer.
• Edit on a built-in definition saves your own copy, which takes priority. Delete your copy to go back to the built-in one.
• Export downloads any definition, to share it or keep it in git.

A complete example

id: sonarr                      # a-z, 0-9 and dashes; unique
name: Sonarr
icon: sonarr                    # a dashboard-icons name, or an image URL
category: Media
description: TV series manager
match: { image: "sonarr" }      # regex on the container image → "Found on your servers"
port: 8989                      # the app's port inside the container
fields:                         # what you fill in when connecting
  - key: api_key
    label: API key
    secret: true                # stored encrypted, never shown again
    help: "Settings → General → API Key"
    autodetect: { file: /config/config.xml, regex: "<ApiKey>(.+)</ApiKey>" }
auth: { type: header, name: X-Api-Key, value: "{api_key}" }
health: { path: /api/v3/system/status }              # any 2xx answer = up
stats:
  - { label: Queue, path: "/api/v3/queue?pageSize=1", value: totalRecords }
  - { label: Missing, path: "/api/v3/wanted/missing?pageSize=1", value: totalRecords }
  - { label: Health issues, path: /api/v3/health, value: "length(@)" }
  - { label: Version, path: /api/v3/system/status, value: version }
actions:
  - { label: Search missing, method: POST, path: /api/v3/command,
      json: { name: MissingEpisodeSearch }, confirm: true, done: "Search started" }
alerts:
  - { stat: Health issues, op: ">", value: 0, severity: warning, message: "{name} reports {value} health issue(s)" }
  - { op: down, severity: warning, message: "{name} isn't answering" }

Reference

Tips for writing one

• Find the app's API docs, or open its web UI with your browser's developer tools on the Network tab. The calls the UI makes are usually the API.
• Start with just health and one stat, connect it, and add more once that works. Errors per stat are shown on hover.
• Apps behind a URL base (e.g. /prowlarr): either include it in the instance address (http://host:9696/prowlarr) or let the hub follow the app's redirect. Redirects are followed only while they stay on the same app.
• Share what you write: Export gives a single file anyone can import.

Safety

Troubleshooting integrations