Skip to content

Add Download Client configuration docs#91

Merged
enoch85 merged 7 commits into
mainfrom
copilot/add-download-client-docs
Jun 6, 2026
Merged

Add Download Client configuration docs#91
enoch85 merged 7 commits into
mainfrom
copilot/add-download-client-docs

Conversation

Copilot AI commented Jun 6, 2026

Copy link
Copy Markdown
Contributor

This updates the Configuration docs to cover the new Download Client integration for qBittorrent. The page now documents when cleanup runs, which settings are available, the qBittorrent prerequisites for matching downloads, and the Sonarr-specific delete scope while preserving the required #download-client anchor used by the app.

  • Configuration docs

    • Added a new top-level ## Download Client section to docs/Configuration.md immediately after ## Sonarr
    • Kept the heading text exact so Docusaurus continues to generate #download-client
  • User-facing behavior

    • Documented that the Download Client settings page only appears after Radarr or Sonarr is configured
    • Explained that cleanup is matched via Radarr/Sonarr download history and only applies to media removed through those integrations
    • Added a prerequisite note that Maintainerr must target the same qBittorrent instance used by Radarr/Sonarr, with Web UI enabled on qBittorrent 4.1+
    • Clarified which collection actions trigger cleanup and which do not
    • Called out qBittorrent as the currently supported client
  • Settings reference

    • Added a settings table for:
      • URL
      • Username / Password
      • Delete downloaded data
      • Fallback seeding ratio
  • Operational constraints

    • Documented Sonarr’s whole-show-only cleanup behavior
    • Clarified that failures talking to the download client do not block Radarr/Sonarr deletions
    • Noted that Test Connection validates qBittorrent Web UI connectivity and credentials before saving
## Download Client

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

Copilot AI linked an issue Jun 6, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Add 'Download Client' section to documentation Add Download Client configuration docs Jun 6, 2026
Copilot AI requested a review from enoch85 June 6, 2026 17:30
@Maintainerr Maintainerr deleted a comment from Copilot AI Jun 6, 2026
Clarified the removal process and added a note about advanced usage.
@enoch85 enoch85 marked this pull request as ready for review June 6, 2026 19:06
@enoch85 enoch85 merged commit 75f8f3e into main Jun 6, 2026
3 checks passed
@enoch85 enoch85 deleted the copilot/add-download-client-docs branch June 6, 2026 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Download client

2 participants