Skip to content

Commit 391ee25

Browse files
Admin9705Admin9705
committed
Swaparr Docs Update
1 parent b3c6a40 commit 391ee25

File tree

4 files changed

+401
-2
lines changed

4 files changed

+401
-2
lines changed

‎docs/apps/swaparr.html‎

Lines changed: 158 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,139 @@ <h3 id="sleep-duration"><i class="fas fa-moon" style="margin-right: 8px; color:
160160
</ul>
161161
<p><strong>Consider your setup:</strong> If you have many active downloads, shorter intervals help. If you have a slower system or fewer downloads, longer intervals are fine.</p>
162162

163+
<h2 id="security-features">Security Features</h2>
164+
165+
<p>Swaparr includes advanced security features to protect your system from malicious downloads and suspicious content by analyzing download names and titles. Detection is based on filename patterns, not file contents.</p>
166+
167+
<h3 id="malicious-file-detection"><i class="fas fa-shield-alt" style="margin-right: 8px; color: #e74c3c;"></i>Malicious File Detection</h3>
168+
<p><strong>What it does:</strong> Automatically detect and immediately remove downloads with malicious file types.</p>
169+
<p><strong>How it works:</strong> Scans download names for dangerous file extensions and suspicious patterns. Unlike the strike system, malicious content is removed immediately without warnings.</p>
170+
<p><strong>When to enable:</strong> Highly recommended for all users, especially those using public trackers where malicious content is more common.</p>
171+
172+
<div class="alert alert-warning" style="margin: 15px 0; padding: 15px; background: rgba(255, 193, 7, 0.1); border-left: 4px solid #ffc107;">
173+
<strong><i class="fas fa-exclamation-triangle" style="margin-right: 8px;"></i>Important:</strong>
174+
This feature analyzes filename patterns only, not actual file contents. It's designed to catch obviously malicious downloads based on their names.
175+
</div>
176+
177+
<h3 id="malicious-extensions"><i class="fas fa-file-code" style="margin-right: 8px; color: #e67e22;"></i>Malicious File Extensions</h3>
178+
<p><strong>What it does:</strong> File extensions to consider malicious and block immediately.</p>
179+
<p><strong>Default blocked extensions:</strong></p>
180+
<ul>
181+
<li><strong>Executable files:</strong> .exe, .bat, .cmd, .com, .scr, .pif</li>
182+
<li><strong>Script files:</strong> .vbs, .js, .jse, .wsf, .wsh</li>
183+
<li><strong>Archive formats:</strong> .zipx (suspicious variant)</li>
184+
<li><strong>Link files:</strong> .lnk (Windows shortcuts)</li>
185+
<li><strong>Java archives:</strong> .jar (can contain malware)</li>
186+
</ul>
187+
<p><strong>Customization:</strong> 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.</p>
188+
189+
<h3 id="suspicious-patterns"><i class="fas fa-search" style="margin-right: 8px; color: #f39c12;"></i>Suspicious Patterns</h3>
190+
<p><strong>What it does:</strong> Filename patterns that indicate potentially malicious or unwanted content.</p>
191+
<p><strong>Default blocked patterns:</strong></p>
192+
<ul>
193+
<li><strong>Common malware indicators:</strong> keygen, crack, patch.exe, activator</li>
194+
<li><strong>Suspicious files:</strong> password.txt, readme.txt, install.exe, setup.exe</li>
195+
</ul>
196+
<p><strong>Examples of what gets blocked:</strong></p>
197+
<ul>
198+
<li>"Movie.Name.2024.1080p.KEYGEN.mkv" - Contains "keygen"</li>
199+
<li>"Software.Name.v1.2.Crack.Only.zip" - Contains "crack"</li>
200+
<li>"Game.Install.Password.txt.exe" - Contains suspicious pattern</li>
201+
</ul>
202+
<p><strong>Customization:</strong> Add patterns that are common in your region or specific to content you want to avoid.</p>
203+
204+
<h2 id="age-based-cleanup">Age-Based Cleanup</h2>
205+
206+
<p>Age-based cleanup automatically removes downloads that have been stuck for too long, regardless of strike count. This provides a safety net for downloads that might slip through the normal strike system.</p>
207+
208+
<h3 id="age-based-removal"><i class="fas fa-calendar-times" style="margin-right: 8px; color: #e74c3c;"></i>Enable Age-Based Removal</h3>
209+
<p><strong>What it does:</strong> Remove downloads that have been stuck longer than the specified age limit.</p>
210+
<p><strong>How it works:</strong> Tracks when Swaparr first noticed each download and removes it after the specified number of days, even if it hasn't reached the maximum strike count.</p>
211+
<p><strong>When to use:</strong> Enable this to prevent downloads from sitting in queues indefinitely. Particularly useful for handling edge cases where the normal strike system might not catch problematic downloads.</p>
212+
213+
<h3 id="max-age-days"><i class="fas fa-hourglass-end" style="margin-right: 8px; color: #f39c12;"></i>Maximum Age (Days)</h3>
214+
<p><strong>What it does:</strong> Remove downloads older than this many days (default: 7 days).</p>
215+
<p><strong>Recommended values:</strong></p>
216+
<ul>
217+
<li><strong>3-5 days:</strong> Aggressive cleanup, good for users with reliable download sources</li>
218+
<li><strong>7-10 days:</strong> Balanced approach, gives enough time for slow downloads (recommended)</li>
219+
<li><strong>14+ days:</strong> Conservative, for users with very slow connections or unreliable trackers</li>
220+
</ul>
221+
<p><strong>Consider your setup:</strong> Private trackers with limited seeders might need longer age limits. Public trackers with many alternatives can use shorter limits.</p>
222+
223+
<div class="alert alert-info" style="margin: 15px 0; padding: 15px; background: rgba(13, 202, 240, 0.1); border-left: 4px solid #0dcaf0;">
224+
<strong><i class="fas fa-info-circle" style="margin-right: 8px;"></i>Age Tracking:</strong>
225+
The age timer starts when Swaparr first sees a download in the queue, not when the download actually started. This ensures accurate tracking across Swaparr restarts.
226+
</div>
227+
228+
<h2 id="quality-based-filtering">Quality-Based Filtering</h2>
229+
230+
<p>Quality-based filtering automatically removes downloads with poor or undesirable quality indicators in their names. This helps maintain high standards for your media library.</p>
231+
232+
<h3 id="quality-based-removal"><i class="fas fa-filter" style="margin-right: 8px; color: #9b59b6;"></i>Enable Quality-Based Filtering</h3>
233+
<p><strong>What it does:</strong> Automatically remove downloads with blocked quality patterns in their names.</p>
234+
<p><strong>How it works:</strong> Scans download names for quality indicators that suggest poor viewing/listening experience. Like malicious file detection, quality-blocked content is removed immediately without strikes.</p>
235+
<p><strong>When to use:</strong> Enable if you want to maintain high quality standards and automatically reject low-quality releases.</p>
236+
237+
<h3 id="blocked-quality-patterns"><i class="fas fa-ban" style="margin-right: 8px; color: #e74c3c;"></i>Blocked Quality Patterns</h3>
238+
<p><strong>What it does:</strong> Quality patterns to block based on their indicators in filenames.</p>
239+
<p><strong>Default blocked qualities:</strong></p>
240+
<ul>
241+
<li><strong>Camera recordings:</strong> cam, camrip, hdcam - Recorded in theaters with handheld cameras</li>
242+
<li><strong>Telesyncs:</strong> ts, telesync, tc, telecine - Audio/video from different sources, poor sync</li>
243+
<li><strong>Pre-retail:</strong> r6, dvdscr, dvdscreener - Pre-release screeners, often watermarked</li>
244+
<li><strong>Workprints:</strong> workprint, wp - Unfinished cuts, missing effects or audio</li>
245+
</ul>
246+
247+
<p><strong>Examples of what gets blocked:</strong></p>
248+
<ul>
249+
<li>"Movie.Name.2024.CAM.XviD.avi" - CAM recording</li>
250+
<li>"Show.S01E01.TS.HDTV.x264.mkv" - Telesync quality</li>
251+
<li>"Movie.2024.R6.DVDScr.XviD.avi" - DVD screener</li>
252+
<li>"New.Movie.2024.WORKPRINT.x264.mp4" - Work print</li>
253+
</ul>
254+
255+
<p><strong>Quality standards comparison:</strong></p>
256+
<table>
257+
<tr>
258+
<th>Quality Type</th>
259+
<th>Video Quality</th>
260+
<th>Audio Quality</th>
261+
<th>Recommendation</th>
262+
</tr>
263+
<tr>
264+
<td><strong>CAM/TS</strong></td>
265+
<td>Very Poor</td>
266+
<td>Very Poor</td>
267+
<td style="color: #e74c3c;">Block (Default)</td>
268+
</tr>
269+
<tr>
270+
<td><strong>DVDScr/R6</strong></td>
271+
<td>Poor</td>
272+
<td>Fair</td>
273+
<td style="color: #e74c3c;">Block (Default)</td>
274+
</tr>
275+
<tr>
276+
<td><strong>HDTV/WEB-DL</strong></td>
277+
<td>Good</td>
278+
<td>Good</td>
279+
<td style="color: #2ecc71;">Allow</td>
280+
</tr>
281+
<tr>
282+
<td><strong>BluRay/Remux</strong></td>
283+
<td>Excellent</td>
284+
<td>Excellent</td>
285+
<td style="color: #2ecc71;">Allow</td>
286+
</tr>
287+
</table>
288+
289+
<p><strong>Customization:</strong> Use the tag input system to add quality patterns specific to your preferences. For example, you might want to block "720p" if you only accept 1080p or higher.</p>
290+
291+
<div class="alert alert-warning" style="margin: 15px 0; padding: 15px; background: rgba(255, 193, 7, 0.1); border-left: 4px solid #ffc107;">
292+
<strong><i class="fas fa-exclamation-triangle" style="margin-right: 8px;"></i>Be Careful:</strong>
293+
Adding too many quality patterns might block legitimate releases. Start with the defaults and add patterns gradually based on your specific needs.
294+
</div>
295+
163296
<h2 id="*arr-instance-setup">*arr Instance Setup</h2>
164297

165298
<p>Swaparr uses your existing *arr configurations from Huntarr. In the Swaparr configuration, you'll see checkboxes for each of your configured instances:</p>
@@ -240,9 +373,24 @@ <h3 id="statistics">Statistics Tracking</h3>
240373
</tr>
241374
<tr>
242375
<td><strong>Removals</strong></td>
243-
<td>Downloads actually removed</td>
376+
<td>Downloads removed via strike system</td>
244377
<td>When a download reaches max strikes and gets removed</td>
245378
</tr>
379+
<tr>
380+
<td><strong>Malicious Removals</strong></td>
381+
<td>Downloads removed for malicious content</td>
382+
<td>When malicious file detection blocks a download</td>
383+
</tr>
384+
<tr>
385+
<td><strong>Quality Removals</strong></td>
386+
<td>Downloads removed for poor quality</td>
387+
<td>When quality-based filtering blocks a download</td>
388+
</tr>
389+
<tr>
390+
<td><strong>Age Removals</strong></td>
391+
<td>Downloads removed for being too old</td>
392+
<td>When age-based cleanup removes stale downloads</td>
393+
</tr>
246394
<tr>
247395
<td><strong>Ignored</strong></td>
248396
<td>Downloads skipped due to rules</td>
@@ -285,6 +433,9 @@ <h3><i class="fas fa-rocket" style="margin-right: 8px; color: #e67e22;"></i>Aggr
285433
<li><strong>Ignore Above Size:</strong> 50GB</li>
286434
<li><strong>Sleep Duration:</strong> 600 seconds (10 minutes)</li>
287435
<li><strong>Remove from Client:</strong> Enabled</li>
436+
<li><strong>Malicious File Detection:</strong> Enabled</li>
437+
<li><strong>Age-Based Removal:</strong> Enabled (5 days)</li>
438+
<li><strong>Quality-Based Filtering:</strong> Enabled (default patterns)</li>
288439
</ul>
289440

290441
<h3><i class="fas fa-balance-scale" style="margin-right: 8px; color: #2ecc71;"></i>Balanced Setup (Most Users)</h3>
@@ -294,6 +445,9 @@ <h3><i class="fas fa-balance-scale" style="margin-right: 8px; color: #2ecc71;"><
294445
<li><strong>Ignore Above Size:</strong> 25GB</li>
295446
<li><strong>Sleep Duration:</strong> 900 seconds (15 minutes)</li>
296447
<li><strong>Remove from Client:</strong> Enabled</li>
448+
<li><strong>Malicious File Detection:</strong> Enabled</li>
449+
<li><strong>Age-Based Removal:</strong> Enabled (7 days)</li>
450+
<li><strong>Quality-Based Filtering:</strong> Optional (based on preferences)</li>
297451
</ul>
298452

299453
<h3><i class="fas fa-shield-alt" style="margin-right: 8px; color: #3498db;"></i>Conservative Setup (Slower Connection, Private Trackers)</h3>
@@ -303,6 +457,9 @@ <h3><i class="fas fa-shield-alt" style="margin-right: 8px; color: #3498db;"></i>
303457
<li><strong>Ignore Above Size:</strong> 15GB</li>
304458
<li><strong>Sleep Duration:</strong> 1800 seconds (30 minutes)</li>
305459
<li><strong>Remove from Client:</strong> Enabled</li>
460+
<li><strong>Malicious File Detection:</strong> Enabled</li>
461+
<li><strong>Age-Based Removal:</strong> Enabled (14 days)</li>
462+
<li><strong>Quality-Based Filtering:</strong> Disabled (manual quality control)</li>
306463
</ul>
307464

308465
<h2 id="troubleshooting">Troubleshooting</h2>

0 commit comments

Comments
 (0)