cplieger/seadex-scout repository overview

⁠seadex-scout

seadex-scout keeps your Sonarr and Radarr anime library in sync with the best releases on SeaDex⁠, the community list of the best release for each show. It shows where a better release exists and leaves downloads to Sonarr and Radarr.

⁠What it does

seadex-scout helps you keep your anime library on SeaDex's recommended releases:

• Tells you when SeaDex lists a better release than yours, or a newer v2 or REPACK of it.
• Shows those upgrades, and how much of your library matches SeaDex, in Grafana.
• Writes an on-demand report comparing each season, film and special you have with SeaDex.
• Can offer SeaDex's picks to Sonarr and Radarr as an indexer, so they download them under your quality rules.

You can leave out remuxes, require dual audio, skip specials and add AnimeBytes releases.

⁠Who it is for

seadex-scout is built for people who keep an anime library in Sonarr or Radarr and want it on the releases SeaDex recommends. It compares the files you already have, one season, film or special at a time. Without it, you would open each show on releases.moe and compare its release groups with your files by hand.

You need a Sonarr instance, a Radarr instance or both, with anime in them. seadex-scout reports through its log, so its alerts come from your Loki and Alertmanager, and its dashboard from Grafana. The monitoring guide⁠ sets them up. The optional indexer needs a Prowlarr instance with its Nyaa or AnimeBytes indexer.

seadex-scout is free software under the GPL-3.0-or-later license.

⁠Pull

docker pull cplieger/seadex-scout:latest

Also published to ghcr.io/cplieger/seadex-scout with identical images and tags. Release versions are tagged vX.Y.Z alongside latest.

⁠Quick start

# Example compose for seadex-scout. See the README for all configuration options and hardening.
services:
  seadex-scout:
    image: ghcr.io/cplieger/seadex-scout:latest
    container_name: seadex-scout
    restart: unless-stopped
    # Create ./config and run "sudo chown 1000:1000 config" before the first start,
    # or the container restarts in a loop. If you set PUID and PGID in .env, use those numbers.
    user: "${PUID:-1000}:${PGID:-1000}"
    environment:
      - SONARR_URL  # from .env, the address you open Sonarr at, such as http://192.0.2.10:8989
      - SONARR_API_KEY  # from .env, found in Sonarr under Settings, General, API Key
      - RADARR_URL  # optional, set both RADARR_ lines in .env to add Radarr
      - RADARR_API_KEY
      - SEADEX_SCOUT_FEED_KEY  # these three are for the optional indexer, see docs/torznab-indexer.md
      - SEADEX_SCOUT_PROWLARR_KEY
      - SEADEX_SCOUT_AB_PASSKEY
    volumes:
      - "./config:/config"  # config.yaml, saved state and the reports folder

⁠Documentation

• Full documentation⁠ — configuration, behavior, security
• Configuration⁠
• Fixing a wrong or missing match⁠
• Security⁠
• How seadex-scout works⁠
• Monitoring and alerts⁠
• Torznab feed setup⁠
• Contributing⁠
• Releases and changelog⁠

⁠License

GPL-3.0-or-later. See LICENSE⁠. Its arrapi⁠ dependency is Apache-2.0. The image carries the license text of every bundled component under /usr/share/licenses/.

Third-party attributions are in THIRD_PARTY_NOTICES.md⁠.