From 9456933542f3d578f4b9719058cc4655eec08ea6 Mon Sep 17 00:00:00 2001 From: j4nk Date: Wed, 7 Aug 2024 02:48:52 +0000 Subject: [PATCH] Create README --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..af504dc --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# qbittorrent-downloader +Downloads completed torrents from remote QBittorrent WebUI instance to configurable locations based on category + +## Setup +Create a config.conf file as below, filling in the details + +``` +[API] +api_url = API_URL_WITHOUT_HTTPS_PREFIX +api_user = USERNAME +api_pass = PASSWORD +ssh_url = SSH_URL_FOR_QBITTORRENT_MACHINE_NO_USERNAME + +[CATEGORIES] +category1 = WHERE_YOU_WANT_TORRENTS_WITH_CATEGORY_CATEGORY1_ON_MACHINE +category2 = WHERE_YOU_WANT_TORRENTS_WITH_CATEGORY_CATEGORY2_ON_MACHINE +``` + +## Requirements +`scp` must be installed on the computer running this. This script simply creates a session with the API, queries the torrent list, scp's completed torrents over to local directories specified in CATEGORIES of config.conf, deletes the torrent, and logs out. There is no looping behavior so run this with a cronjob periodically. Also, the machine running this must have its cert on the remote server, i.e. `ssh-copy-id` was run. This program depends on noninteractive scp'ing. \ No newline at end of file