Skip to content

Looks and smells like Overseerr, does the opposite. Maintenance tool for the Plex ecosystem

License

Notifications You must be signed in to change notification settings

jorenn92/Maintainerr

Repository files navigation

Maintainerr's custom image

Discord GitHub Actions Workflow Status GitHub Release GitHub commits since latest release GitHub Repo stars Docker Pulls GitHub commit activity GitHub Issues or Pull Requests GitHub Issues or Pull Requests GitHub Sponsors Static Badge Documentation GitHub License

Maintainerr makes managing your media easy.

  • Do you hate being the janitor of your server?
  • Do you have a lot of media that never gets watched?
  • Do your users constantly request media, and let it sit there afterward never to be touched again?

If you answered yes to any of those questions.. You NEED Maintainerr. It's a one-stop-shop for handling those outlying shows and movies that take up precious space on your server.

Features

  • Configure rules specific to your needs, based off of several available options from Plex, Overseerr, Radarr, Sonarr and Tautulli.
  • Manually add media to a collection, in case it's not included after rule execution. (one-off items that don't match a rule set)
  • Selectively exclude media from being added to a collection, even if it matches a rule.
  • Show a collection, containing rule matched media, on the Plex home screen for a specific duration before deletion. Think "Leaving soon".
  • Optionally, use a manual Plex collection, in case you don't want Maintainerr to add & remove Plex collections at will.
  • Manage media straight from the collection within Plex. Maintainerr will sync and add or exclude media to/from the internal collection.
  • Remove or unmonitor media from *arr
  • Clear requests from Overseerr
  • Delete files from disk

Currently, Maintainerr supports rule parameters from these apps :
  • Plex
  • Overseerr
  • Radarr
  • Sonarr
  • Tautulli

Preview

image image image image

Installation

Docker images for amd64 & arm64 are available under jorenn92/maintainerr and ghcr.io/jorenn92/maintainerr.

Data is saved within the container under /opt/data, it is recommended to tie a persistent volume to this location in your docker command/compose file. Make sure this directory is read/writeable by the user specified in the 'user' instruction. If no 'user' instruction is configured, the volume should be accessible by UID:GID 1000:1000.

For more information, visit the installation guide.

Docker run:

docker run -d \
--name maintainerr \
-e TZ=Europe/Brussels \
-v ./data:/opt/data \
-u 1000:1000 \
-p 6246:6246 \
--restart unless-stopped \
ghcr.io/jorenn92/maintainerr:latest

Docker-compose:

version: '3'

services:
    maintainerr:
        image: ghcr.io/jorenn92/maintainerr:latest # or jorenn92/maintainerr:latest
        container_name: maintainerr
        user: 1000:1000
        volumes:
          - type: bind
            source: ./data
            target: /opt/data
        environment:
          - TZ=Europe/Brussels
#      - DEBUG=true # uncomment to enable debug logs
#      - BASE_PATH=/maintainerr # uncomment if you're serving maintainerr from a subdirectory
#      - UI_HOSTNAME=:: # uncomment if you want to listen on IPv6 instead (default 0.0.0.0)
#      - UI_PORT=6247 # uncomment to change the UI port (default 6246). Useful if you're on a network where the port is already in use
#      - API_PORT=3002 # uncomment to change the API port (default 3001). Useful if you're on a network where the port is already in use
        ports:
          - 6246:6246
        restart: unless-stopped

Documentation

For more information, please consult the documentation

Features

To get an indication of which features are most desired, you can vote for them

Credits

Maintainerr is heavily inspired by Overseerr. Some parts of Maintainerr's code are plain copies. Big thanks to the Overseerr team for creating and maintaining such an amazing app!

Please support them at https://github.com/sct/overseerr