mirror of
https://github.com/thelegendtubaguy/ArrQueueCleaner.git
synced 2025-12-16 18:14:44 -06:00
3509a36b3fbcd8c7e0a91d491cdf9f79ef45d788
* Added new rule for series mismatch * Update tests * Update version number for new release
ArrQueueCleaner
Automated queue cleaner for Sonarr that removes stuck downloads based on configurable rules. Please suggest rules you want to see added by opening an issue!
Features
- Monitors Sonarr download queue for stuck items
- Removes items blocked due to quality issues
- Optional blocklist functionality
- Docker containerized
- Configurable via environment variables
- Scheduled execution via cron
Environment Variables
| Variable | Default | Description |
|---|---|---|
SONARR_HOST |
http://localhost:8989 |
Sonarr instance URL |
SONARR_API_KEY |
required | Sonarr API key |
REMOVE_QUALITY_BLOCKED |
false |
Remove items blocked by quality rules |
BLOCK_REMOVED_QUALITY_RELEASES |
false |
Add quality-blocked items to blocklist |
REMOVE_ARCHIVE_BLOCKED |
false |
Remove items stuck due to archive files |
BLOCK_REMOVED_ARCHIVE_RELEASES |
false |
Add archive-blocked items to blocklist |
REMOVE_NO_FILES_RELEASES |
false |
Remove items with no eligible files |
BLOCK_REMOVED_NO_FILES_RELEASES |
false |
Add no-files items to blocklist |
REMOVE_SERIES_ID_MISMATCH |
false |
Remove items with series ID matching conflicts |
BLOCK_REMOVED_SERIES_ID_MISMATCH_RELEASES |
false |
Add series ID mismatch items to blocklist |
DRY_RUN |
false |
Log actions without actually removing/blocking items |
SCHEDULE |
*/5 * * * * |
Cron schedule (every 5 minutes) |
LOG_LEVEL |
info |
Logging level |
Note: No rules are configured by default for safety, you must opt in to using them.
Quick Start
- Copy
.env.exampleto.envand configure - Run with Docker Compose (see example below)
Manual Installation
pnpm install
pnpm build
pnpm start
Docker Compose Example
version: '3.8'
services:
arr-queue-cleaner:
image: ghcr.io/thelegendtubaguy/arrqueuecleaner:latest
environment:
- SONARR_HOST=http://sonarr:8989
- SONARR_API_KEY=your_api_key_here
- REMOVE_QUALITY_BLOCKED=false
- BLOCK_REMOVED_QUALITY_RELEASES=false
- REMOVE_ARCHIVE_BLOCKED=false
- BLOCK_REMOVED_ARCHIVE_RELEASES=false
- REMOVE_NO_FILES_RELEASES=false
- BLOCK_REMOVED_NO_FILES_RELEASES=false
- REMOVE_SERIES_ID_MISMATCH=false
- BLOCK_REMOVED_SERIES_ID_MISMATCH_RELEASES=false
- DRY_RUN=false
- SCHEDULE=*/5 * * * *
- LOG_LEVEL=info
restart: unless-stopped
Docker
docker build -t arr-queue-cleaner .
docker run -d --env-file .env arr-queue-cleaner
Releases
9
Languages
TypeScript
94%
JavaScript
4.6%
Dockerfile
1.4%