diff --git a/.env.sample b/.env.sample index b59ad0b..66f84c3 100644 --- a/.env.sample +++ b/.env.sample @@ -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) diff --git a/README.md b/README.md index f521386..739b366 100644 --- a/README.md +++ b/README.md @@ -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):