Skip to content
πŸΏπŸ“Ό Sensorr - A movie release radar like CouchPotato, Radarr and Watcher3
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
config
db Implement CLI Nov 5, 2018
doc
shared Fix XZNAB HTTP errors Apr 8, 2019
src Fix Entity update unsubscribe Apr 6, 2019
.babelrc Improve documentation Mar 17, 2019
.dockerignore Debug Docker Automated Build Dec 2, 2018
.gitignore Add documentation Mar 15, 2019
Dockerfile Refactor job trigger Dec 4, 2018
README.md Add Plex sync job πŸ”— Apr 6, 2019
bump.sh Add bump and publish scripts Nov 25, 2018
config.default.json Add Plex sync job πŸ”— Apr 6, 2019
config.docker.json Add Plex sync job πŸ”— Apr 6, 2019
doczrc.js Improve documentation Mar 17, 2019
ecosystem.config.js Add Plex sync job πŸ”— Apr 6, 2019
index.js Fix pm2 jobs boot Apr 6, 2019
package-lock.json Connect your Plex server ! πŸŽ‰ Apr 5, 2019
package.json Fix pm2 jobs boot Apr 6, 2019
publish.sh Add bump and publish scripts Nov 25, 2018
webpack.config.js Implement Docker image Nov 19, 2018
webpack.dev.js Implement WebSocket for Status and History Jan 17, 2019
webpack.prod.js Fix miscellaneous issues Nov 18, 2018

README.md

πŸΏπŸ“Ό Sensorr

A simple movie release radar like CouchPotato, Radarr and Watcher3, written in Javascript with React

Warning

🚨 This is early experimental, currently will only support Cardigann and Jackett.

Features

Screenshot Description
Trending
  • Trending
  • Discover (Popular)
  • Discover (Random year)
  • Discover (Random genre)
Movies / Collection
  • Manage your movies collection (wished and archived)
Movies / Search
  • Search for a movie by it's title
Movies / Details
  • See movie details
  • Consider movie as, πŸ”• ignored, 🍿 wished or πŸ“Ό archived
  • Look for results on sources (torznab / newznab) - requested with title (localized) and original_title
  • Grab a result
Stars / Upcoming
  • Track upcoming movies from followed stars !
Stars / Following
  • Manage stars you're following
Stars / Search
  • Search for stars
Stars / Details
  • See star details
  • Follow star πŸ”• ignored, πŸ”” followed
Configure
  • Simple configuration
  • Secured WebUI (with basic-auth)
  • Language aware, by default search on TMDB with first window.navigator.languages
  • Plex synchronization, never inadvertently download a movie you already own !
Logs
  • See logs details
  • Every wished movie processed

Scripts

  • dev: launch development server for React frontend
  • express: launch Sensorr web server without serving frontend
  • build: build frontend to dist folder
  • prod: run pm2 apps, Sensorr (web server) and Sensorr (record cron)
  • start: launch build and prod scripts
  • doc: launch docz documentation server

Docker

Checkout Sensorr Docker image, it let you skip every complex environment configuration and just run a clean installation, just open a terminal with docker installed and run:

# `/home/user/.sensorr` will be your config path
# `/home/user/downloads` will be your blackhole path
docker run -p 5070:5070 -v /home/user/.sensorr:/app/sensorr/config -v /home/user/downloads:/app/sensorr/blackhole --name="sensorr" thcolin/sensorr

Tips: Docker image is based on alpine, so you can add TZ env variable with -e TZ=Europe/Paris

Configure

  • Edit default configuration in config/config.json or http://localhost:5070/configure

CLI

Currently CLI tool is mainly designed to work with pm2 and ecosystem.config.js which launch ./bin/sensorr record -a everyday at 17:00 / 5:00PM and ./bin/sensorr stalk everyday at 00:00

🚨 Warning: CLI tool need to communicate with Sensorr web server at http://localhost:5070 to sync databases ! Be sure Sensorr web server is launched before launching record command.


     _________  __________  ___  ___
    / __/ __/ |/ / __/ __ \/ _ \/ _ \
   _\ \/ _//    /\ \/ /_/ / , _/ , _/
  /___/___/_/|_/___/\____/_/|_/_/|_|


🍿 πŸ“Ό - Movie release radar (CouchPotato, Radarr and Watcher3 alternative)

Usage: sensorr [command] [options]

Commands:
  πŸ“° stalk               Stalk stars and update movie credits
  πŸ“Ό record              Try to "record" (aka download best release) every wished movies
  πŸ”— sync                Consider all movies from your Plex server as "archived"

Options:
  -p, --port             Specify localhost <port> [default: 5070]
  -h, --help             Output usage information
  -v, --version          Output the version number
  # record
  -b, --blackhole <dir>  Download releases .torrent and .nzb to <dir> [default: /tmp]
  -f, --filter <regexp>  Filter releases returned by configured XZNAB
  -s, --sort <key>       Sort releases by <key> (among: seeders, peers or size) [default: seeders]
  -D, --descending       Sort releases in descending order
  -a, --auto             Automatically select first release according to --filter, --sort and --descending options


Tips: Sensorr will use your `config.js` and fallback on default

Roadmap

  • WebUI
    • Fix
      • Handle TMDB errors (like "Invalid API key: You must be granted a valid key.") on components
    • Features
      • Filter adult content (like /star/1412545) - optional
      • Display role on Star.Row (crew) tooltip
      • Improve filter ("I prefer MULTI, else I want TRUEFRENCH, else FRENCH is good, finally I'm ok with VOSTFR")
      • Export/Import database
      • Sync with Plex
        • More features ?
          • Plex manage all medias, so we can get release (source, language, resolution, ...) and download better if available, like CouchPotato
      • Filter movie.release_dates (only Premiere, Theatrical (limited), Theatrical, Digital or Physical - cf. /movie/{movie_id}/release_dates) on Upcoming page
      • Display Persona director on Movie
      • Trending studios
      • Responsive design / mobile UI-UX
  • CLI
    • Download "grouped" by title and not xznab (should reduce timeout error on some xznab)
    • Summary command result
      • stalk:
          ${stars} Stars stalked with ${total} movie credits ! πŸŽ‰
        
      • record:
          ${found} Movies archived to ${sensorr.config.blackhole} ! πŸŽ‰
            * ${movie.title} (${movie.year}) with release ${release.generated}
          But ${notfound} still not found.. 😢
            * ${movie.title} (${movie.year}) : 0 releases found including 0 filtered
        
  • App (Phone / TV)
    • Features
      • Connect to server with QR code
      • Streaming

Inspiration

Family

You can’t perform that action at this time.