Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rfsbraz/deleterr
Deleterr is a Python script designed to help you manage available disk space in your Plex media server.
https://github.com/rfsbraz/deleterr
overseerr plex plex-media-server plex-server python radarr radarr-api sonarr sonarr-api sonarr3 tautulli tautulli-api
Last synced: 4 months ago
JSON representation
Deleterr is a Python script designed to help you manage available disk space in your Plex media server.
- Host: GitHub
- URL: https://github.com/rfsbraz/deleterr
- Owner: rfsbraz
- License: mit
- Created: 2023-08-02T22:05:27.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2024-08-29T13:24:42.000Z (6 months ago)
- Last Synced: 2024-08-29T14:53:19.143Z (6 months ago)
- Topics: overseerr, plex, plex-media-server, plex-server, python, radarr, radarr-api, sonarr, sonarr-api, sonarr3, tautulli, tautulli-api
- Language: Python
- Homepage:
- Size: 274 KB
- Stars: 136
- Watchers: 5
- Forks: 6
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-arr - Deleterr - Automates deleting inactive and stale media from Plex/Sonarr/Radarr. (Complimenting Apps)
README
# Deleterr [](https://badge.fury.io/gh/rfsbraz%2Fdeleterr) [](https://sonarcloud.io/summary/new_code?id=rfsbraz_deleterr) [](https://sonarcloud.io/summary/new_code?id=rfsbraz_deleterr)
Deleterr uses Radarr, Sonarr, and Tautulli to identify and delete media files based on user-specified criteria. Deleterr is customizable, allowing you to specify metadata based rules for different libraries and sonarr/radarr instances.
Setup Deleterr to run on a schedule and it will automatically delete media files that meet your criteria. This allows to keep your library fresh and clean, without having to manually manage it to free up space.
## WARNING
* **DO NOT USE THIS WITH MEDIA CONTENT YOU CAN'T AFFORD TO LOSE**
* Turn on the recycle bin in your Sonarr/Radarr settings if you want to be able to recover deleted files (not recommended for remote mounts)
### Docker Compose
Adding deleterr to your docker-compose file is really easy and can be combined with ofelia to run at a schedule. Here's an example that runs deleterr weekly:
```yaml
version: "3.9"
services:
deleterr:
image: ghcr.io/rfsbraz/deleterr:latest
container_name: deleterr
environment:
LOG_LEVEL: INFO
volumes:
- ./config:/config
- ./logs:/config/logs
restart: no
scheduler:
image: mcuadros/ofelia:latest
container_name: scheduler
depends_on:
- deleterr
command: daemon --docker
volumes:
- /var/run/docker.sock:/var/run/docker.sock:ro
restart: unless-stopped
labels:
ofelia.job-run.deleterr.schedule: "@weekly"
ofelia.job-run.deleterr.container: "deleterr"
```
You can find more information about ofelia's scheduling options [here](https://github.com/mcuadros/ofelia#jobs).
### Docker
Set your settings file in `config/settings.yaml` and run the following command:
```bash
docker run -v ./config:/config -v ./logs:/config/logs ghcr.io/rfsbraz/deleterr:latest -e LOG_LEVEL=DEBUG
```
## Configuration
Deleterr is configured via a YAML file. An example configuration file, `settings.example.yaml`, is provided. Copy this file to `settings.yaml` and adjust the settings as needed.
Please refer to the [configuration guide](./docs/CONFIGURATION.md) for a full list of options and their descriptions.
## Image Availability
The image is available through:
* [GitHub Container Registry](https://github.com/rfsbraz/deleterr/pkgs/container/deleterr): `ghcr.io/rfsbraz/deleterr:`
* [Docker Hub](https://hub.docker.com/r/rfsbraz/deleterr): `rfsbraz/deleterr:`
### Tags
* `latest`: The latest stable release
* `nightly`: The latest development release
* `X.Y.Z`: A specific version
* `X.Y`: The latest release in the vX.Y series
* `X`: The latest release in the vX series