mirror of
https://github.com/Cleanuparr/Cleanuparr.git
synced 2026-06-10 14:55:34 -04:00
177 lines
4.5 KiB
Plaintext
177 lines
4.5 KiB
Plaintext
---
|
|
sidebar_position: 2
|
|
---
|
|
|
|
import Link from '@docusaurus/Link';
|
|
import {
|
|
ConfigSection,
|
|
styles
|
|
} from '@site/src/components/documentation';
|
|
|
|
# Features
|
|
|
|
Advanced download management and automation features for your *arr applications and download clients.
|
|
|
|
<div className={styles.documentationPage}>
|
|
|
|
<div className={styles.section}>
|
|
|
|
<ConfigSection
|
|
id="strike-system"
|
|
title="Strike System"
|
|
description="Mark and track problematic downloads with an intelligent strike system"
|
|
icon="bolt"
|
|
>
|
|
|
|
- Strike system to mark bad downloads.
|
|
- Remove and block downloads that reached a maximum number of strikes.
|
|
|
|
</ConfigSection>
|
|
|
|
<ConfigSection
|
|
id="failed-imports"
|
|
title="Failed Import Management"
|
|
description="Automatically handle downloads that fail to import into your *arr applications"
|
|
icon="x"
|
|
>
|
|
|
|
- Remove and block downloads that are **failing to be imported** by the arrs.
|
|
|
|
</ConfigSection>
|
|
|
|
<ConfigSection
|
|
id="stalled-downloads"
|
|
title="Stalled Download Detection"
|
|
description="Identify and remove downloads that have stopped making progress"
|
|
icon="player-pause"
|
|
>
|
|
|
|
- Remove and block downloads that are **stalled** or in **metadata downloading** state.
|
|
|
|
</ConfigSection>
|
|
|
|
<ConfigSection
|
|
id="slow-downloads"
|
|
title="Slow Download Management"
|
|
description="Handle downloads with poor performance or excessive completion times"
|
|
icon="gauge"
|
|
>
|
|
|
|
- Remove and block downloads that have a **low download speed** or **high estimated completion time**.
|
|
|
|
</ConfigSection>
|
|
|
|
<ConfigSection
|
|
id="content-blocking"
|
|
title="Content Blocking"
|
|
description="Filter and block unwanted content using customizable blocklists"
|
|
icon="ban"
|
|
>
|
|
|
|
- Remove and block downloads blocked by qBittorrent or by Cleanuparr's **Malware Blocker**.
|
|
|
|
</ConfigSection>
|
|
|
|
<ConfigSection
|
|
id="automatic-search"
|
|
title="Automatic Replacement Search"
|
|
description="Automatically trigger replacement searches when downloads are removed"
|
|
icon="search"
|
|
>
|
|
|
|
- Automatically trigger a search for downloads removed from the arrs.
|
|
|
|
</ConfigSection>
|
|
|
|
<ConfigSection
|
|
id="missing-search"
|
|
title="Missing Item Search"
|
|
description="Proactively search for missing items across your Radarr and Sonarr libraries"
|
|
icon="radar"
|
|
>
|
|
|
|
- Proactively search for missing items across your Radarr and Sonarr libraries on a configurable schedule.
|
|
|
|
</ConfigSection>
|
|
|
|
<ConfigSection
|
|
id="quality-upgrades"
|
|
title="Quality Upgrade Search"
|
|
description="Automatically search for items that haven't met their quality profile's cutoff"
|
|
icon="trending-up"
|
|
>
|
|
|
|
- Automatically search for quality upgrades for items that haven't met their quality profile's cutoff.
|
|
|
|
</ConfigSection>
|
|
|
|
<ConfigSection
|
|
id="cf-score-upgrades"
|
|
title="Custom Format Score Upgrades"
|
|
description="Track custom format scores and search for upgrades when scores are below the cutoff"
|
|
icon="target"
|
|
>
|
|
|
|
- Track custom format scores across your library and automatically search for upgrades when scores are below the cutoff.
|
|
|
|
</ConfigSection>
|
|
|
|
<ConfigSection
|
|
id="seeding-cleanup"
|
|
title="Seeding Management"
|
|
description="Clean up completed downloads based on seeding time and ratio requirements"
|
|
icon="seedling"
|
|
>
|
|
|
|
- Clean up downloads that have been **seeding** for a certain amount of time.
|
|
|
|
</ConfigSection>
|
|
|
|
<ConfigSection
|
|
id="orphaned-cleanup"
|
|
title="Orphaned Download Detection"
|
|
description="Remove downloads no longer referenced by your *arr applications"
|
|
icon="link-off"
|
|
>
|
|
|
|
- Remove downloads that are **orphaned**/have no **hardlinks**/are not referenced by the arrs anymore (with [cross-seed](https://www.cross-seed.org/) support).
|
|
|
|
</ConfigSection>
|
|
|
|
<ConfigSection
|
|
id="orphaned-files-scanner"
|
|
title="Orphaned Files Scanner"
|
|
description="Find files on disk that aren't claimed by any active torrent and move them aside"
|
|
icon="file-off"
|
|
>
|
|
|
|
- Scan configured directories for **files and folders not referenced by any active torrent** across all download clients.
|
|
- Move detected orphans to a dedicated **Orphaned Directory** for later review.
|
|
|
|
</ConfigSection>
|
|
|
|
<ConfigSection
|
|
id="notifications"
|
|
title="Notification System"
|
|
description="Get alerted when strikes are issued or downloads are removed"
|
|
icon="bell"
|
|
>
|
|
|
|
- Notify on strike or download removal.
|
|
|
|
</ConfigSection>
|
|
|
|
<ConfigSection
|
|
id="ignore-patterns"
|
|
title="Ignore Patterns"
|
|
description="Exclude specific content from processing using flexible pattern matching"
|
|
icon="filter-off"
|
|
>
|
|
|
|
- Ignore certain torrent hashes, categories, tags or trackers from being processed by Cleanuparr.
|
|
|
|
</ConfigSection>
|
|
|
|
</div>
|
|
|
|
</div> |