Skip to content

Download client #90

@enoch85

Description

@enoch85

Handoff: add "Download Client" docs section (for an AI/maintainer to apply)

This file documents the new Download Client integration (qBittorrent) added
to Maintainerr, and tells you exactly how to fold it into this Docusaurus site.

Please make a PR.

What the feature does (context)

When media is removed through Radarr or Sonarr, Maintainerr can also remove the
matching completed download (and optionally its data) from the configured
download client. The download is matched via the Radarr/Sonarr download
history
(downloadId), so cleanup only runs for media removed through
Radarr/Sonarr. qBittorrent is the only supported client today. There is an
optional seeding-ratio gate and a "delete downloaded data" toggle. The settings
tab only appears once Radarr or Sonarr is configured. Sonarr cleanup is scoped
to whole-show deletes (a season-pack download can span episodes that are still
wanted).

Integration instructions (AI: do exactly this)

  1. File to edit: docs/Configuration.md (the current/unversioned docs).
    • Do NOT edit anything under versioned_docs/ or versioned_sidebars/
      those are frozen snapshots of already-released versions. This feature ships
      in a future release and will be captured automatically when the next
      version is cut.
  2. Where to insert: add the ## Download Client section below as a new
    top-level section. Recommended placement is immediately after the
    ## Sonarr section
    (it depends on Radarr/Sonarr), or at the end of the
    page — either is fine; sections are ordered by appearance.
  3. Heading must stay ## Download Client. The app's in-UI "Docs" button
    links to https://docs.maintainerr.info/configuration/#download-client, and
    Docusaurus derives that #download-client anchor from the heading text. If
    you rename the heading, update DocsButton usage in the app
    (apps/ui/src/components/Settings/DownloadClient/index.tsx,
    docsPage="Configuration/#download-client") to match.
  4. No sidebars.js change is needed — Configuration.md is a single page
    and these are in-page sections, not separate docs.
  5. Keep the existing table/admonition style (already matched below).
  6. After applying, run the site's normal build/preview to confirm the anchor
    resolves and the table renders.

Section content to insert (copy from the divider down)


Download Client

:::note
The separate Settings -> Download Client page only appears once Radarr or Sonarr is configured.
:::

When media is removed through Radarr or Sonarr, Maintainerr can remove the matching completed download (and optionally its data) from your download client. The download is matched using the Radarr/Sonarr download history, so media removed without Radarr/Sonarr is left untouched. qBittorrent is currently the only supported client.

Setting Description
URL The base URL of your qBittorrent WebUI, such as http://localhost:8080 or https://qbittorrent.example.com
Username The qBittorrent WebUI username. Leave blank if the WebUI bypasses authentication (e.g. Bypass authentication for clients on localhost).
Password The qBittorrent WebUI password. Leave blank if authentication is bypassed.
Delete downloaded data When enabled, removing a download also deletes its files from disk. Turn this off if you cross-seed, so other torrents that share the data keep working.
Only delete after a seeding ratio When enabled, a download is only removed once it reaches the configured ratio; otherwise it keeps seeding. Leave disabled to remove regardless of ratio.
Minimum ratio The share ratio a download must reach before Maintainerr removes it. Only shown when Only delete after a seeding ratio is enabled.

How it works:

  • Cleanup runs only for media that Radarr or Sonarr deletes. Maintainerr looks up the download that produced the files in the Radarr/Sonarr download history and removes that download from qBittorrent. Media removed directly from the media server (without Radarr/Sonarr), manually imported items, or items whose download history has been cleared are left untouched.
  • For Sonarr, cleanup runs only on whole-show deletions. Season- and episode-level deletions are skipped on purpose, because a season-pack download can contain episodes you still want.
  • Removal is best-effort: a failure to reach the download client never blocks the Radarr/Sonarr deletion itself.
  • Test Connection verifies the URL and credentials against the qBittorrent WebUI.

Metadata

Metadata

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions