updated README

README.md

@@ -15,13 +15,25 @@ Cleanuperr was created primarily to address malicious files, such as `*.lnk` or
 > - Remove and block downloads that have a low download speed or high estimated completion time.
 > - Remove downloads blocked by qBittorrent or by Cleanuperr's **content blocker**.
 > - Trigger a search for downloads removed from the *arrs.
-> - Remove downloads that have been seeding for a certain amount of time.
-> - Remove downloads that have no hardlinks (have been upgraded by the *arrs).
+> - Clean up downloads that have been seeding for a certain amount of time.
 > - Notify on strike or download removal.
 > - Ignore certain torrent hashes, categories, tags or trackers from being processed by Cleanuperr.
 
 Cleanuperr supports both qBittorrent's built-in exclusion features and its own blocklist-based system. Binaries for all platforms are provided, along with Docker images for easy deployment.
 
+## Quick Start
+
+> [!NOTE]
+>
+> 1. **Docker (Recommended)**  
+> Pull the Docker image from `ghcr.io/flmorg/cleanuperr:latest`.
+>
+> 2. **Unraid (for Unraid users)**  
+> Use the Unraid Community App.
+>
+> 3. **Manual Installation (if you're not using Docker)**  
+> Go to [Windows](#windows), [Linux](#linux) or [MacOS](#macos).
+
 # Docs
 
 Docs can be found [here](https://flmorg.github.io/cleanuperr/).

code/Executable/appsettings.json

@@ -21,7 +21,7 @@
     "IGNORED_DOWNLOADS_PATH": ""
   },
   "QueueCleaner": {
-    "Enabled": true,
+    "Enabled": false,
     "RunSequentially": true,
     "IGNORED_DOWNLOADS_PATH": "",
     "IMPORT_FAILED_MAX_STRIKES": 0,
@@ -32,7 +32,14 @@
     "STALLED_RESET_STRIKES_ON_PROGRESS": false,
     "STALLED_IGNORE_PRIVATE": false,
     "STALLED_DELETE_PRIVATE": false,
-    "DOWNLOADING_METADATA_MAX_STRIKES": 0
+    "DOWNLOADING_METADATA_MAX_STRIKES": 0,
+    "SLOW_MAX_STRIKES": 0,
+    "SLOW_RESET_STRIKES_ON_PROGRESS": true,
+    "SLOW_IGNORE_PRIVATE": false,
+    "SLOW_DELETE_PRIVATE": false,
+    "SLOW_MIN_SPEED": "",
+    "SLOW_MAX_TIME": 0,
+    "SLOW_IGNORE_ABOVE_SIZE": ""
   },
   "DownloadCleaner": {
     "Enabled": false,

docs/docs/configuration/download-cleaner/3_hardlinks.mdx

@@ -3,7 +3,7 @@ sidebar_position: 3
 ---
 
 import DownloadCleanerHardlinksSettings from '@site/src/components/configuration/download-cleaner/DownloadCleanerHardlinksSettings';
-import { Important } from '@site/src/components/Admonition';
+import { Important, Warning } from '@site/src/components/Admonition';
 
 # Hardlinks Settings
 
@@ -16,4 +16,8 @@ The Download Cleaner will change the category of a download that has no hardlink
     If your download client's download directory is `/downloads`, it should be the same for Cleanuperr.
 </Important>
 
+<Warning>
+    While it is not needed to configure the arrs for this feature, it is recommended you do. If the arrs are not configured, downloads that are waiting to be imported might be affected by it.
+</Warning>
+
 <DownloadCleanerHardlinksSettings/>

docs/docs/installation/1_quick-start.mdx

@@ -4,10 +4,13 @@ import { Note } from '@site/src/components/Admonition';
 
 1. **Docker (Recommended)**  
     Pull the Docker image from `ghcr.io/flmorg/cleanuperr:latest`.
+    [Configuration example here.](/docs/configuration/examples/docker)
 2. **Unraid (for Unraid users)**  
     Use the Unraid Community App.
+    [Configuration example here.](/docs/configuration/examples/docker)
 3. **Manual Installation (if you're not using Docker)**  
     Go to [Windows](/docs/installation/windows), [Linux](/docs/installation/linux) or [MacOS](/docs/installation/macos).
+    [Configuration example here.](/docs/configuration/examples/config-file)
 
 <Note>
     Refer to the [Configuration](/docs/category/configuration) section for detailed configuration instructions.

docs/src/components/configuration/queue-cleaner/QueueCleanerImportFailedSettings.tsx

@@ -11,8 +11,8 @@ const settings: EnvVarProps[] = [
     type: "positive integer number",
     defaultValue: "0",
     required: false,
-    examples: ["0", "3", "10"],
     notes: [
+      "`0` means to never remove failed imports.",
       "If not set to `0`, the minimum value is `3`."
     ]
   },

docs/src/components/configuration/queue-cleaner/QueueCleanerStalledSettings.tsx

@@ -11,8 +11,8 @@ const settings: EnvVarProps[] = [
     type: "positive integer number",
     defaultValue: "0",
     required: false,
-    examples: ["0", "3", "10"],
     notes: [
+      "`0` means to never remove stalled downloads.",
       "If not set to 0, the minimum value is `3`."
     ]
   },
@@ -59,6 +59,7 @@ const settings: EnvVarProps[] = [
     defaultValue: "0",
     required: false,
     notes: [
+      "`0` means to never remove downloads stuck while downloading metadata.",
       "If not set to `0`, the minimum value is `3`."
     ]
   }