From be809dd5ebb2ffbd721e8d09595da7c6c12646ca Mon Sep 17 00:00:00 2001 From: maxDorninger <97409287+maxDorninger@users.noreply.github.com> Date: Tue, 15 Jul 2025 20:24:54 +0200 Subject: [PATCH] add transmission to documentation --- Writerside/topics/Configuration.md | 2 +- .../topics/download-client-configuration.md | 46 ++++++++++++++++++- 2 files changed, 45 insertions(+), 3 deletions(-) diff --git a/Writerside/topics/Configuration.md b/Writerside/topics/Configuration.md index 4d33d5d..d06fa0d 100644 --- a/Writerside/topics/Configuration.md +++ b/Writerside/topics/Configuration.md @@ -25,7 +25,7 @@ The configuration is organized into the following sections: - `[database]` - Database settings - `[auth]` - Authentication settings - `[notifications]` - Notification settings (Email, Gotify, Ntfy, Pushover) -- `[torrents]` - Download client settings (qBittorrent, SABnzbd) +- `[torrents]` - Download client settings (qBittorrent, Transmission, SABnzbd) - `[indexers]` - Indexer settings (Prowlarr and Jackett ) - `[metadata]` - TMDB and TVDB settings diff --git a/Writerside/topics/download-client-configuration.md b/Writerside/topics/download-client-configuration.md index d954e86..1208419 100644 --- a/Writerside/topics/download-client-configuration.md +++ b/Writerside/topics/download-client-configuration.md @@ -26,6 +26,38 @@ Username for qBittorrent Web UI authentication. Default is `admin`. Password for qBittorrent Web UI authentication. Default is `admin`. +## Transmission Settings (`[torrents.transmission]`) + +Transmission is a BitTorrent client that MediaManager can integrate with for downloading torrents. + +- `enabled` + +Set to `true` to enable Transmission integration. Default is `false`. + +- `username` + +Username for Transmission RPC authentication. + +- `password` + +Password for Transmission RPC authentication. + +- `https_enabled` + +Set to `true` if your Transmission RPC endpoint uses HTTPS. Default is `true`. + +- `host` + +Hostname or IP of the Transmission server (without protocol). + +- `port` + +Port of the Transmission RPC endpoint. Default is `9091`. + +- `path` + +RPC request path target. Usually `/transmission/rpc`. + ## SABnzbd Settings (`[torrents.sabnzbd]`) SABnzbd is a Usenet newsreader that MediaManager can integrate with for downloading NZB files. @@ -60,6 +92,16 @@ Here's a complete example of the download clients section in your `config.toml`: username = "admin" password = "your_secure_password" + # Transmission configuration + [torrents.transmission] + enabled = false + username = "admin" + password = "your_secure_password" + https_enabled = true + host = "transmission" + port = 9091 + path = "/transmission/rpc" + # SABnzbd configuration [torrents.sabnzbd] enabled = false @@ -90,7 +132,7 @@ services: - ./data/torrents:/downloads # ... other configuration ... - # SABnzbd service (optional) + # SABnzbd service sabnzbd: image: lscr.io/linuxserver/sabnzbd:latest ports: @@ -101,7 +143,7 @@ services: ``` - You can enable both qBittorrent and SABnzbd simultaneously if you want to support both BitTorrent and Usenet downloads. + You can enable qBittorrent, Transmission, and SABnzbd simultaneously if you want to support both BitTorrent and Usenet downloads.