cleanuparr.md

title	Cleanuparr
description	A guide to deploying Cleanuparr via docker
published	true
date	2025-07-10 19:15:04 UTC
tags
editor	markdown
dateCreated	2025-06-28 12:56:06 UTC

{class="tab-icon"} What is Cleanuparr?

Automated Download Management. Automatically clean up unwanted, stalled, and malicious downloads from your *arr applications and download clients. Keep your queues clean and your media library safe.

1 · Deploy Cleanuparr

Read the official documentation {.is-success}

services:
  cleanuparr:
    image: ghcr.io/cleanuparr/cleanuparr:latest
    container_name: cleanuparr
    restart: unless-stopped
    ports:
      - 11011:11011
    volumes:
      - /mnt/tank/configs/cleanuparr:/config
      - /mnt/tank/media:/media
    environment:
      - PORT=11011
      - BASE_PATH=
      - PUID=568
      - PGID=568
      - UMASK=022
      - TZ=America/New_York

The BASE_PATH variable is for reverse proxy setups but can be left blank.

Permissions & Folder Structure

• PUID / PGID: Ensure you use a user/group with the correct permissions for accessing media folders. TrueNAS SCALE defaults to 568:568 for apps.
• Volumes: The container structure follows a common-sense naming convention, storing configurations under /mnt/tank/configs/radarr
• 📌 Refer to the Folder-Structure guide for more details.

2 · Cleanuparr Configuration

If at any time you do not know what a setting does, click the ⓘ symbol next to it to be taken to the official document page explaining it {.is-info}

2.1 Instances

1. Add your *arr instance by navigating to the correct tab on the left pane
2. Enter your instance name, URL and API key

2.2 Download Clients

1. Add your qbittorrent instance by navigating to the Download Clients tab on the left pane
2. Enter your instance name, client type, host (URL), username, and password

2.3 Cleanup

2.3.1 General Configuration

1. Uncheck the box for Display Support Banner for a cleaner dashboard
2. Change the Certificate Validation to Disabled for Local Addresses
3. If you are using Huntarr, leave the Enable Search box unchecked
4. Click Save

2.3.2 Queue Cleaner Configuration

1. Check the Enable Queue Cleaner box

2.3.2.1 Failed Import Settings

These settings are up to you, but the below values are what I use

1. Set Max Strikes to 3
2. Check the box for Ignore Private

2.3.2.2 Stalled Download Settings

These settings are up to you, but the below values are what I use

1. Set Max Strikes to 3
2. Check the box for Reset Strikes On Progress
3. Check the box for Ignore Private

2.3.3.3 Slow Download Settings

These settings are up to you, but the below values are what I use

1. Set Max Strikes to 3
2. Check the box for Ignore Private
3. Set Minimum Speed to 1 MB
4. Set Minimum Time to 0
5. Set ** Ignore Above Size** to 500 MB
6. Click Save

2.3.3 Content Blocker Configuration

I do not use this because I am also using Recyclarr (or Profilarr) to ensure my grabs are high quality. If you are not using one of those tools I would suggest enabling this feature.

2.3.4 Download Cleaner Configuration

1. Check the Download Queue Cleaner box
2. Set the Run Schedule to 1 Hour

2.3.4.1 Seeding Settings

These settings are up to you, but the below values are what I use

1. Check the box to Delete Private Torrents
2. Click the button to Add a Category
3. Set the Category Name to cleanuparr-unlinked
4. Set the Max Seed Time to 360

2.3.4.2 Unlinked Download Settings

These settings are up to you, but the below values are what I use

1. Check the box to Enable Unlinked Download Handling
2. Set the Target Category to cleanuparr-unlinked
3. Set the Ignored Root Directory to /media/downloads
4. Add radarr, tv-sonarr and cross-seed-link to Unlinked Categories
5. Click Save

2.4 Notifications

1. Select which service you use
2. If you use Apprise (most likely), enter you URL and API Key
3. Check all the categories you would like notifications for
4. Click Save

See the list of Apprise Services to get your URL {.is-info}

3 · Video