https://github.com/hrenard/cleanarr
A small utility tasked to automatically clean radarr and sonarr files over time
https://github.com/hrenard/cleanarr
Last synced: 3 months ago
JSON representation
A small utility tasked to automatically clean radarr and sonarr files over time
- Host: GitHub
- URL: https://github.com/hrenard/cleanarr
- Owner: hrenard
- License: gpl-3.0
- Created: 2021-05-03T17:20:57.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-05T02:02:00.000Z (about 2 years ago)
- Last Synced: 2024-05-21T12:46:51.726Z (about 1 year ago)
- Language: Go
- Homepage:
- Size: 128 KB
- Stars: 17
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-arr - hrenard/Cleanarr - A small utility tasked to automatically clean radarr and sonarr files over time. (Complimenting Apps)
README
# Cleanarr
A small utility tasked to automatically clean radarr and sonarr files over time.
The idea is to have a "rolling" media library where old media is deleted either because the disk quota is exceeded or because it has been there too long.
## Usage
### Configuration
```yml
#config.yml
interval: 1 # optional, check every minutes
dryRun: false # optional, do not perform actions
radarr:
- name: "radarr4k" # requried
hostPath: "https://radarr.mydomain.com" # required
apiKey: "xxxxxxxxxxx" # required
maxDays: 90 # optional if maxSize
maxSize: "2TB" # optional if maxDays
includeTags: # optional, includes all by default
- rolling
excludeTags: [] # optional, excludes nothing by default
sonarr:
- name: "sonarr" # requried
hostPath: "https://sonarr.mydomain.com" # required
apiKey: "xxxxxxxxxxx" # required
maxDays: 90 # optional if maxSize
maxSize: "2TB" # optional if maxDays
includeTags: [] # optional, includes all by default
excludeTags: # optional, excludes nothing by default
- keep
```
### Docker
```shell
$ docker run -v $PWD/config.yml:/config.yml ghcr.io/hrenard/cleanarr
```
## Roadmap
- [ ] Radarr
- [x] Days policy
- [x] Size policy
- [x] Tag filter
- [ ] Quantity policy
- [ ] Sonarr
- [x] Days policy
- [x] Size policy
- [x] Tag filter
- [ ] Quantity policy
- [ ] Unmonitor season when all episodes are unmonitored ?
- [ ] Remove serie when all episodes are unmonitored ?