From 86da4fa668ae2c993bc0dc45c20fa01d4c2c44fc Mon Sep 17 00:00:00 2001
From: Admin9705 <9705@duck.com>
Date: Sun, 15 Jun 2025 12:54:13 -0400
Subject: [PATCH] Update Swaparr documentation to clarify functionality and
enhance user warnings
- Revised the description of Swaparr to emphasize its role as a stalled download cleaning utility integrated with Huntarr.
- Added an important warning regarding the impact of Swaparr on all downloads initiated by *arr applications.
- Included a detailed timing example to illustrate the download monitoring process and removal timeline.
- Expanded the list of malicious file extensions to improve protection against potential threats, with a note on the significance of these additions.
---
docs/apps/swaparr.html | 29 ++++++++++++++++++++++++++---
1 file changed, 26 insertions(+), 3 deletions(-)
diff --git a/docs/apps/swaparr.html b/docs/apps/swaparr.html
index 64874df5..1a93534c 100644
--- a/docs/apps/swaparr.html
+++ b/docs/apps/swaparr.html
@@ -63,7 +63,12 @@
For Huntarr-related issues, use Huntarr's support channels.
- Swaparr is an automated download monitoring and cleanup utility that works with your *arr applications (Sonarr, Radarr, Lidarr, etc.). It monitors your download queues and automatically removes stalled, failed, or problematic downloads to keep your automation running smoothly.
+ Swaparr is a stalled download cleaning utility for the *arr applications built into Huntarr. It provides basic features and easier configuration when compared to Cleanuperr.
+
+
+ Important Warning:
+ Swaparr works on all downloads started via the *arr application, not only the ones scheduled by Huntarr. This results in stalled or otherwise flagged downloads being removed. If you want to keep these downloads, deactivate Swaparr for those downloads.
+
Project Credit:
@@ -152,6 +157,18 @@
Sleep Duration
What it does: Time to wait between Swaparr processing cycles (default: 900 seconds / 15 minutes).
+
+
+ Timing Example:
+ Assume a download is stalled right from the beginning. Using the default values of Sleep Duration of 15 minutes and 3 strikes:
+
+ After 0-15 minutes (whenever Swaparr runs) the download is monitored by Swaparr. 15 minutes later there is no progress: strike 1; 15 minutes later: strike 2; further 15 minutes: strike 3 and the download is removed.
+
+ In total it takes 45-60 minutes (depending on the first run of Swaparr) to remove bad downloads.
+
+ Note: Bad downloads as specified by Swaparr's security features are removed immediately with the next scan.
+
+
How it affects performance:
- Shorter intervals (5-10 min): Faster response to stalled downloads, more system load
@@ -178,12 +195,18 @@
What it does: File extensions to consider malicious and block immediately.
Default blocked extensions:
- - Executable files: .exe, .bat, .cmd, .com, .scr, .pif
+ - Executable files: .exe, .bat, .cmd, .com, .scr, .pif, .msi
- Script files: .vbs, .js, .jse, .wsf, .wsh
- - Archive formats: .zipx (suspicious variant)
+ - Archive formats: .zipx, .arj, .ace, .001, .rar, .zip (suspicious variants and password-protected archives)
+ - Disc image files: .iso, .mdf, .vob (often used to distribute malware)
- Link files: .lnk (Windows shortcuts)
- Java archives: .jar (can contain malware)
+
+
+ Enhanced Protection:
+ Adding extensions like .vob, .iso, .mdf, .msi, .arj, .ace, .001, .rar, and .zip to the Malicious File Extensions list helps cut down on failed imports significantly. These formats are commonly used on public anonymous trackers to distribute password-protected files and zip bombs, which can reduce failed imports from 30% to less than 5%.
+
Customization: Use the tag input system to add or remove extensions. Type the extension (with or without the dot) and press Enter or click the + button.
Suspicious Patterns