jelhe32/embycleanup repository overview

⁠Emby Cleaner & Sonarr Integration

This Docker image provides an automated system to identify and clean up inactive TV series from your Emby library, optionally unmonitoring them in Sonarr. It also provides a small Flask web UI to view logs and trigger various test scripts.

---

⁠Features

• Emby Integration: Connects to your Emby server to find inactive series, manage symlinks in a “to be deleted” library, and delete them when no user shows interest.
• Sonarr Integration: If you have Sonarr, the script can unmonitor a series before deleting it from Emby.
• User Interest Checks: Checks whether a series or its episodes appear in user favorites or playlists, or if the series has been active recently.
• Automated Final Deletions: If a series remains unplayed and no interest is detected, it gets scheduled for final deletion (configurable days).
• Three-Day Notice: Sends an email 3 days before final deletion, prompting users to show interest if they want to keep the series.
• Flask Web App: Provides a dashboard to run test scripts, run cleanup manually, and view logs.

---

⁠Environment Variables

⁠Additional Configuration

• CRON: By default, a cron job is installed to run main.py daily at midnight, appending output to /var/log/emby_cleanup/cron.log.
• Log Files:
  • Main log: logs/emby_cleanup.log
  • Cron log: /var/log/emby_cleanup/cron.log
  • Email log: logs/email_delivery.log
  • Test scripts log: /var/log/emby_cleanup/test_scripts.log

---

⁠Usage

⁠Docker Run Example

docker run -d
--name emby_cleanup
-e EMBY_URL="http://192.168.1.10:8096⁠"
-e EMBY_API_KEY="abc123"
-e USER_ID="999999"
-e SONARR_URL="http://192.168.1.10:8989⁠"
-e SONARR_API_KEY="sonarr_api_key"
-e ADMIN_EMAIL="[email protected]⁠"
-e USER_EMAILS="[email protected]⁠,[email protected]⁠"
-p 9999:9999
jelhe32/emby_cleaner:latest

⁠Accessing the Web UI

1. Open http://localhost:9999⁠ (or your mapped IP and port) in a browser.
2. You’ll see a dashboard with buttons to:
   • Run Cleanup Program (manually run the main.py script)
   • Run Test Scripts (for Emby or Sonarr test scripts)
   • View Logs (main logs, cron logs, test scripts logs)
   • Download Main Logs

---

⁠Cron Execution

By default, a line is added to crontab:

0 0 * * * root CRON_JOB=1 /usr/local/bin/python /app/main.py >> /var/log/emby_cleanup/cron.log 2>&1

This calls main.py nightly at 00:00 to perform the automated cleanup.

---

⁠Build & Contribute

1. Clone the repository.

2. Edit or customize environment variables in .env.

3. Build your local image:

   docker build -t emby_cleaner:local .
   

   Copy

4. Run as described in Docker usage examples.

⁠License

This project is provided under the MIT License (or the license you prefer). Feel free to open issues or submit PRs for improvements.

⁠Enjoy an automated Emby & Sonarr experience with the Emby Cleaner Docker image!