https://github.com/Vansmak/OCDarr
Automates sending and deleting episodes or seasons to sonarr one at a time as played
https://github.com/Vansmak/OCDarr
Last synced: 2 months ago
JSON representation
Automates sending and deleting episodes or seasons to sonarr one at a time as played
- Host: GitHub
- URL: https://github.com/Vansmak/OCDarr
- Owner: Vansmak
- Created: 2024-03-18T23:56:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-28T22:58:28.000Z (10 months ago)
- Last Synced: 2024-08-28T23:51:45.675Z (10 months ago)
- Language: Python
- Homepage:
- Size: 947 KB
- Stars: 44
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-arr - OCDarr - Automates sending and deleting episodes or seasons to sonarr one at a time as played. (Complimenting Apps)
README
# 
******only in dev branch****
https://github.com/Vansmak/OCDarr/blob/dev/README.md
added a client only mode for just showing recent episodes and premiers without any episode management CLIENT_ONLY=true
-**added choice between poster or banner artwork USE_POSTERS=true or false
*****************************
Support This Project
If you find this project helpful, please consider supporting it. Your contributions help maintain and improve the project. Any support is greatly appreciated! ❤️ https://buymeacoffee.com/vansmak Thank you for your support!
OCDarr automates TV show maintenance in Sonarr based on Plex viewing activity via Tautulli. It ensures that the next episode is ready and cleans up watched episodes based on user-defined preferences. Ideal for keeping your media server tidy and your series up-to-date without manual intervention. Not useful for hoarders. For example, sometimes I start an old show and never finish it, or takes awhile before I really get into it. So This way I dont have full seasons sitting there. I also do not have other users outside my household and am not a rewatcher of tv so I like to delete after a show is watched. This will always have the next episode ready to go and the last episode watched saved just in case. If I need to protect a show because someone else is behind me then I can set certain shows to not delete. If someone prefers getting full season instead of one episode you can do that. For example, if you have a new shows pilot episode only, once its watched the script can then monitor the rest of the season. Keep or delete previous episodes.
## Features
- ** ADDED RULE_SETS, see below**
- **Dockerized**: Easy to deploy and manage as a Docker container.
https://hub.docker.com/r/vansmak/ocdarr
- **Automatic Episode Management**: Triggers searches for the next episode(s) or season in Sonarr based on viewing activity.
- **Space Management**: Optionally unmonitors and deletes watched episodes to save space.
- **Plex\Tautulli Integration**: Uses Tautulli webhook notifications to trigger actions automatically when episode is watched.
- **User Interface**: Simple HTML interface for viewing upcoming episodes and premieres and updatting settings.
- **Expandability**: Future features may include support for season packs, more selective retention rules, jellfin...
###Screen shots
for a different look using banners, better on mobile try the dev branch https://github.com/Vansmak/OCDarr/tree/dev
## Installation
Either:
### Clone the Repository
Start by cloning the repository and navigating into the directory:
```
git clone https://github.com/Vansmak/OCDarr.git
cd OCDarr
```
After cloning the repository, switch to the main branch:
```
cd OCDarr
git checkout main or dev(recommended)
```
Configuration
Environment Setup
Copy the provided .env.example to .env and update it with your Sonarr details:
```
cp .env.example .env
nano .env # use your preferred text editor
```
Fill in the environment variables:
```
SONARR_URL: URL to your Sonarr server.
SONARR_API_KEY: Your Sonarr API key.
USE_POSTERS=true
CLIENT_ONLY=true
```
Docker Compose
Edit the docker-compose.yml file to suit your setup. Make sure the .env file is referenced correctly, and ports are mapped to your preference:
```
version: '3.8'
services:
sonarr_script:
build:
context: .
dockerfile: Dockerfile
environment:
SONARR_URL: ${SONARR_URL?Variable not set}
SONARR_API_KEY: ${SONARR_API_KEY?Variable not set}
CONFIG_PATH: /app/config/config.json
env_file:
- .env
volumes:
- .:/app
- ./logs:/app/logs
- ./config:/app/config
- ./temp:/app/temp
ports:
- "5001:5001"
restart: unless-stopped
```
Build and Run with Docker Compose
```
docker-compose up -d --build
```
This command builds the Docker image and runs it in detached mode.
OR:
### Docker hub https://hub.docker.com/r/vansmak/ocdarr
(no dev branch on docker hub yet)
Docker Instructions
Pull the Docker Image
```
docker pull vansmak/ocdarr:arch64 or amd64
```
Set Environment Variables or
Create an .env file with the required environment variables:
```
SONARR_URL=http://sonarr.example.com
SONARR_API_KEY=your_sonarr_api_key
```
Run the Docker Container
```
docker run -d \
--env-file .env \
--env CONFIG_PATH=/app/config/config.json \
-p 5001:5001 \
-v ${PWD}/logs:/app/logs \
-v ${PWD}/config:/app/config \
-v ${PWD}/temp:/app/temp \
--restart unless-stopped \
vansmak/ocdarr:amd64,arm64
```
###Usage
****only for client_only=false
Once your Docker container is running, it will listen for webhook calls from Tautulli when an episode is deemed as watched. Configure Tautulli to send webhooks to http://:5001
json data exactly like:
```
{
"plex_title": "{show_name}",
"plex_season_num": "{season_num}",
"plex_ep_num": "{episode_num}"
}
```
View html to see progress, fine-tune behavior and set rules locally at http://dockerurl:port.
Each rule has these four options
get_option: '#' of episodes to get or 'season' for full seasons or 'all' for everything
action_option: 'search' to search episodes, 'monitor' to only monitor.
keep_watched: '#' of watched episodes to keep or 'season' to keep current seasons episodes only OR 'all' will keep everything (no deleting)
monitor_watched: true or false, keep watched episodes monitored or not
** Making and assigning rules
A show can only have one rule at a time. I no rule is assigned then it will use the default rule. Make sure you change the default rule to your preference. If you select a new rule for a show it will reassign it.
Name them however it makes sense to you.
!important: If you do not assign a show to a rule it will use the default rule.
Additional Notes
Set watched criteria in Tautulli general settings.
(consider % watched before webhook is sent)
****end client_only=false setup
Troubleshooting
If you encounter issues, check the Docker container logs and logs/app.log and ensure all environment variables are correctly set.