https://cleanuparr.github.io/assets/js/502d32c4.3111cffd.js

1"use strict";(globalThis.webpackChunkdocs||=[]).push([[3768],{411(e,r,s){s.r(r),s.d(r,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>l,metadata:()=>n,toc:()=>h});const n=JSON.parse('{"id":"faq","title":"Frequently Asked Questions","description":"Common questions and answers about Cleanuparr.","source":"@site/docs/6_faq.mdx","sourceDirName":".","slug":"/faq","permalink":"/docs/faq","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":7,"frontMatter":{"sidebar_position":7},"sidebar":"configurationSidebar","previous":{"title":"Stats API","permalink":"/docs/configuration/stats/"}}');var i=s(4848),t=s(8453),a=s(4783),o=s(3105);s(547);const l={sidebar_position:7},d="Frequently Asked Questions",c={},h=[];function u(e){const r={a:"a",code:"code",h1:"h1",header:"header",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.header,{children:(0,i.jsx)(r.h1,{id:"frequently-asked-questions",children:"Frequently Asked Questions"})}),"\n",(0,i.jsx)(r.p,{children:"Common questions and answers about Cleanuparr."}),"\n",(0,i.jsx)(o.uQ,{}),"\n",(0,i.jsxs)("div",{className:o.R7.documentationPage,children:[(0,i.jsxs)("div",{className:o.R7.section,children:[(0,i.jsxs)(o.AQ,{id:"why-cleanuparr-name",title:"Why is it called Cleanuparr and not X or Y?",badge:"General",children:[(0,i.jsxs)(r.p,{children:["The name ",(0,i.jsx)(r.code,{children:"Cleanuparr"})," reflects its purpose: to clean up your *arr applications. The ",(0,i.jsx)(r.code,{children:"arr"})," suffix is a nod to the ",(0,i.jsx)(r.a,{href:"https://wiki.servarr.com/",children:"Servarr"})," ecosystem that it supports.\nOther names were already taken or I just didn't like them."]}),(0,i.jsxs)(r.p,{children:['It\'s pronounced like "cleanuper", someone who does the cleanup, in the same way a driver is someone who drives. The correct spelling is ',(0,i.jsx)(r.code,{children:"Cleanuparr"}),", not ",(0,i.jsx)(r.code,{children:"CleanupArr"})," or ",(0,i.jsx)(r.code,{children:"CleanUpArr"}),"."]})]}),(0,i.jsxs)(o.AQ,{id:"private-trackers",title:"Can I use Cleanuparr with private torrents/trackers?",badge:"General",children:[(0,i.jsx)(r.p,{children:"Yes, Cleanuparr works with private torrents and trackers just like public ones. Depending on the availability, some private trackers can also have slow or stalled torrents."}),(0,i.jsx)(r.p,{children:"Configurations such as never removing private torrents are available, but a direct connection to your download client is required for that, otherwise it can't know which ones are private."}),(0,i.jsx)(r.p,{children:"However, you should still be cautious with aggressive strike rules and make sure your configuration is appropriate for your use case."}),(0,i.jsx)(o.tk,{children:(0,i.jsx)(r.p,{children:"Always test your configuration in dry run mode first, especially when setting up strike rules or malware blocking patterns."})})]}),(0,i.jsxs)(o.AQ,{id:"usenet-support",title:"Is Usenet supported? Will it be supported in the future?",badge:"General",children:[(0,i.jsx)(r.p,{children:"Failed imports are handled regardless of the download client, so Usenet users can benefit from using it."}),(0,i.jsxs)(r.p,{children:["But on a broader spectrum, Cleanuparr ",(0,i.jsx)("b",{children:(0,i.jsx)("i",{children:"will not"})})," be adding native Usenet support, mainly because:"]}),(0,i.jsxs)(r.ul,{children:["\n",(0,i.jsx)(r.li,{children:"I am not using Usenet myself, so I can't properly test or maintain it."}),"\n",(0,i.jsxs)(r.li,{children:["People asking for Usenet support offered no help with development or testing, as seen ",(0,i.jsx)(r.a,{href:"https://github.com/Cleanuparr/Cleanuparr/issues/137",children:"here"})," and ",(0,i.jsx)(r.a,{href:"https://github.com/Cleanuparr/Cleanuparr/issues/226",children:"here"}),"."]}),"\n"]})]}),(0,i.jsx)(o.AQ,{id:"debrid-support",title:"Will debrid services be officially supported?",badge:"General",children:(0,i.jsx)(r.p,{children:"Probably not."})}),(0,i.jsx)(o.AQ,{id:"linux-docker-flavors",title:"Will X flavor of Linux or the Y flavor of Docker be supported?",badge:"General",children:(0,i.jsx)(r.p,{children:"No. Executables and Docker containers for every major platform are already provided, which should work on any modern Linux distribution or Docker environment."})}),(0,i.jsx)(o.AQ,{id:"linux-docker-flavors",title:"Does it have an Unraid template?",badge:"General",children:(0,i.jsxs)(r.p,{children:["Read the ",(0,i.jsx)(r.a,{href:"/docs/installation/detailed?unraid",children:"Installation Guide"}),"!"]})}),(0,i.jsxs)(o.AQ,{id:"linux-docker-flavors",title:"What does Cleanuparr do differently compared to X or Y similar tool?",badge:"General",children:[(0,i.jsx)(r.p,{children:"You be the judge."}),(0,i.jsxs)(r.p,{children:["There's a list of ",(0,i.jsx)(r.a,{href:"/docs/features",children:"features"})," that you can compare against other tools, ",(0,i.jsx)(r.a,{href:"/docs/category/configuration",children:"configuration docs"})," to explore the available customizations, or just install it and try it out."]})]})]}),(0,i.jsxs)("div",{className:o.R7.section,children:[(0,i.jsx)(o.AQ,{id:"not-blocking",title:"The same release keeps comming back even after Cleanuparr blocked it. Why?",badge:"Features",children:(0,i.jsxs)(r.p,{children:["Read the ",(0,i.jsx)(r.a,{href:"/docs/installation",children:"Prerequisites"}),"!"]})}),(0,i.jsxs)(o.AQ,{id:"strike-system",title:"What is the strike system and how does it work?",badge:"Features",children:[(0,i.jsx)(r.p,{children:"The strike system prevents false positives by requiring multiple violations before taking action:"}),(0,i.jsxs)(r.ol,{children:["\n",(0,i.jsxs)(r.li,{children:[(0,i.jsx)(r.strong,{children:"Detection"}),": Cleanuparr detects a problem (stalled, slow, failed import)"]}),"\n",(0,i.jsxs)(r.li,{children:[(0,i.jsx)(r.strong,{children:"Strike Issued"}

1),": The download receives a strike (logged and tracked)"]}),"\n",(0,i.jsxs)(r.li,{children:[(0,i.jsx)(r.strong,{children:"Accumulation"}),": Each time the job runs and the problem persists, another strike is added"]}),"\n",(0,i.jsxs)(r.li,{children:[(0,i.jsx)(r.strong,{children:"Action"}),": When strikes reach the configured maximum (default: 3), the download is removed and blocked"]}),"\n"]}),(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.strong,{children:"Why it matters"}),": A temporarily slow download due to network issues won't be removed immediately. Only consistently problematic downloads are removed."]}),(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.strong,{children:"Configuration"}),": You can adjust the maximum strikes per rule type in the ",(0,i.jsx)(a.A,{to:"/docs/configuration/queue-cleaner",children:"Queue Cleaner settings"}),"."]})]}),(0,i.jsxs)(o.AQ,{id:"dry-run-mode",title:"What is dry run mode and should I use it?",badge:"Features",children:[(0,i.jsxs)(r.p,{children:["Dry run mode simulates what Cleanuparr would do ",(0,i.jsx)(r.strong,{children:"without actually doing it"}),":"]}),(0,i.jsxs)(r.ul,{children:["\n",(0,i.jsx)(r.li,{children:"Downloads are NOT removed"}),"\n",(0,i.jsx)(r.li,{children:"Strikes are NOT issued"}),"\n",(0,i.jsx)(r.li,{children:"Searches are NOT triggered"}),"\n",(0,i.jsxs)(r.li,{children:["Actions are logged as ",(0,i.jsx)(r.code,{children:"[DRY RUN]"})]}),"\n"]}),(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.strong,{children:"When to use it"}),":"]}),(0,i.jsxs)(r.ul,{children:["\n",(0,i.jsx)(r.li,{children:"Testing new configuration"}),"\n",(0,i.jsx)(r.li,{children:"Validating strike rules"}),"\n",(0,i.jsx)(r.li,{children:"Checking what would be affected by changes"}),"\n",(0,i.jsx)(r.li,{children:"Learning how Cleanuparr works"}),"\n",(0,i.jsx)(r.li,{children:"Before going live with aggressive rules"}),"\n"]}),(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.strong,{children:"How to enable"}),": Go to Settings \u2192 General \u2192 Enable Dry Run"]}),(0,i.jsx)(o.L7,{children:(0,i.jsx)(r.p,{children:"Always test configuration changes in dry run mode first, especially for critical production systems."})})]})]})]})]})}function p(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}}}]);