docs: polish rtorrent URL path documentation to exact specifications
Some checks failed
Build and Push Docker Image / build (push) Failing after 33s
CI / Tests & coverage (push) Failing after 37s
CI / Security audit (push) Failing after 44s
Docs Check / Markdown lint (push) Successful in 47s
Docs Check / Mermaid diagram parse check (push) Successful in 1m36s

- Update .env.sample RTORRENT_INSTANCES section with exact comment format
- Update README.md rTorrent table row with specific endpoint note
- Add explicit "No path is automatically appended" statement in README
- RTorrentClient.js already uses exact URL from config (no changes needed)
This commit is contained in:
2026-05-19 11:58:42 +01:00
parent 620f264861
commit bbcbf8d0f7
2 changed files with 11 additions and 19 deletions

View File

@@ -95,24 +95,15 @@ QBITTORRENT_INSTANCES=[{"name":"main","url":"https://qbittorrent.example.com","u
# QBITTORRENT_PASSWORD=your-password
# =============================================================================
# RTORRENT INSTANCES (JSON Array Format)
# Add one or more rTorrent instances as a single-line JSON array
# Uses username/password authentication (optional)
# Format: [{"name":"instance-name","url":"https://...","username":"...","password":"..."}]
# IMPORTANT: XML-RPC endpoint must be included in the url field (no automatic appending).
# Standard installs use /RPC2. Some providers (e.g. whatbox.ca) use /xmlrpc. Other
# installations may use a custom path. Always supply the complete RPC endpoint.
# Examples:
# Standard: http://rtorrent.local:8080/RPC2
# whatbox.ca: https://user.whatbox.ca/xmlrpc
# Custom: https://example.com/custom/rpc/path
# =============================================================================
# RTORRENT_INSTANCES=[{"name":"main","url":"http://rtorrent.example.com/RPC2","username":"rtorrent","password":"rtorrent"}]
# Legacy single-instance format (optional - still supported)
# RTORRENT_URL=http://rtorrent.example.com/RPC2
# RTORRENT_USERNAME=rtorrent
# RTORRENT_PASSWORD=rtorrent
# RTORRENT_INSTANCES (JSON Array)
# The url MUST include the full XML-RPC endpoint path.
# Standard/self-hosted installs: .../RPC2
# whatbox.ca users: .../xmlrpc
# Other installations may use different custom paths.
# Example:
RTORRENT_INSTANCES=[{"name":"main","url":"http://rtorrent.local:8080/RPC2","username":"rtorrent","password":"rtorrent"}]
# For whatbox.ca:
# RTORRENT_INSTANCES=[{"name":"whatbox","url":"https://user.whatbox.ca/xmlrpc","username":"user","password":"pass"}]
# =============================================================================
# SONARR INSTANCES (JSON Array Format)

View File

@@ -205,7 +205,7 @@ sofarr uses a **Pluggable Download Client Architecture (PDCA)** that provides a
| SABnzbd | REST API | API Key | Usenet downloads |
| qBittorrent | Sync API | Username/Password | BitTorrent with incremental updates |
| Transmission | JSON-RPC | Username/Password | BitTorrent with session management |
| rTorrent | XML-RPC | HTTP Basic Auth | BitTorrent, requires full endpoint path |
| rTorrent | XML-RPC | HTTP Basic Auth | BitTorrent, requires the full RPC endpoint in the url field (e.g. /RPC2 or /xmlrpc for whatbox.ca). No path is automatically appended. |
### Service Instances (JSON Array Format)
@@ -223,6 +223,7 @@ TRANSMISSION_INSTANCES=[{"name":"main","url":"http://transmission:9091/transmiss
# rTorrent Instances (uses username/password, URL must include full RPC endpoint)
# Standard installs use /RPC2. Some providers like whatbox.ca use /xmlrpc.
# No path is automatically appended - always include the full RPC endpoint.
RTORRENT_INSTANCES=[{"name":"main","url":"http://rtorrent:8080/RPC2","username":"rtorrent","password":"rtorrent"}]
# For whatbox.ca (example):