Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lardbit/nefarious

Web application for automatically downloading TV & Movies (w/ VPN)
https://github.com/lardbit/nefarious

angular django docker jackett python tmdb torrent torrent-downloader transmission

Last synced: about 2 months ago
JSON representation

Web application for automatically downloading TV & Movies (w/ VPN)

Awesome Lists containing this project

README 

        
# nefarious



**nefarious is a web application that automatically downloads Movies and TV Shows.**



[![Build Status](https://github.com/lardbit/nefarious/actions/workflows/build.yml/badge.svg)](https://github.com/lardbit/nefarious/actions/workflows/build.yml)

[![Docker Pulls](https://img.shields.io/docker/pulls/lardbit/nefarious.svg?maxAge=60&style=flat-square)](https://hub.docker.com/r/lardbit/nefarious)



It uses [Jackett](https://github.com/Jackett/Jackett/) and [Transmission](https://transmissionbt.com/) under the hood.  Jackett searches for torrents and Transmission handles the downloading.



Features:

- [x] Search and discover TV & Movies (by popularity, genres, year etc.)

- [x] Auto download TV & Movies

- [x] Find similar and recommended TV & Movies (via The Movie Database & Rotten Tomatoes)

- [x] Manually search and download Jackett's torrent results

- [x] Supports blacklisting torrent results (i.e. permanently avoid a bad/fake torrent)

- [X] Supports quality profiles (i.e. only download *1080p* Movies and *720p* TV)

- [x] Supports whether to download media with hardcoded subtitles or not

- [x] Supports user defined keywords to filter results (i.e. ignore "x265", "hevc" codecs)

- [x] Monitor transmission results & status from within the app

- [x] Self/auto updating application, so you're always up-to-date

- [x] Supports multiple users and permission groups (i.e. admin users and regular users)

- [x] Responsive Design (looks great on desktops, tablets and small devices like phones)

- [x] Includes movie trailers

- [x] Automatically renames media

- [x] Supports multiple languages (TMDB supports internationalized Titles, Descriptions and Poster artwork)

- [x] Notifications - supports all major notification services (via [Apprise](https://github.com/caronc/apprise/tree/v0.9.3))

- [x] Imports existing libraries

- [x] VPN integration (optional)

- [x] Auto download subtitles via [opensubtitles](https://www.opensubtitles.com/) [api](https://opensubtitles.stoplight.io/)

- [x] Autodetect & blacklist [spam/fake](https://github.com/lardbit/nefarious/pull/180) video content

- [x] Autodetect & blacklist "stuck" torrents that fail to complete after X days



### Contents



- [Demo](#demo)

- [Screenshots](#screenshots)

- [Dependencies](#dependencies)

- [Setup](#setup)

- [Usage](#usage)

- [Upgrading](#upgrading)

- [Troubleshooting](#troubleshooting)

- [Development](#development)



### Demo



![](screenshots/nefarious-demo.gif)



### Screenshots



#### Login

![](screenshots/login.png)

#### Search

![](screenshots/search-results.png)

#### TV Result

![](screenshots/media-tv-result.png)

#### Movie Result

![](screenshots/media-movie-result.png)

#### Download Status

![](screenshots/media-status.png)

#### Discover via TMDB

![](screenshots/discover-tmdb.png)

#### Discover via Rotten Tomatoes

![](screenshots/discover-rotten-tomatoes.png)

#### Wanted

![](screenshots/wanted.png)

#### Watching

![](screenshots/watching.png)

#### Settings

![](screenshots/settings.png)

#### Search Manual

![](screenshots/search-manual.png)

#### Mobile Friendly

![](screenshots/search-mobile.png)



### Dependencies



See [DEPENDENCIES.md](docs/DEPENDENCIES.md)



### Setup



You must have **docker** and **docker-compose** already installed.  See [dependencies](docs/DEPENDENCIES.md).



#### Part 1

    

Clone the nefarious repository:



    git clone https://github.com/lardbit/nefarious.git

    cd nefarious

    

Copy the default environment file to make changes:



    cp env.template .env

    

Edit `.env` as needed for your settings, at least defining *HOST_DOWNLOAD_PATH* to something like *HOST_DOWNLOAD_PATH=/path/to/downloads*.



**You should *never* need to edit the `docker-compose.yml` file since all settings are read from `.env`.**

    

Start all the containers:



    docker-compose up -d

    

**NOTE: the first time you start nefarious can take a few minutes.**



Your default local URLs for all the various services will be:



- nefarious: [http://localhost:8000](http://localhost:8000)

- Jackett: [http://localhost:9117](http://localhost:9117)

- Transmission: [http://localhost:9091](http://localhost:9091)



**See** [Part 2](#part-2) for finalizing the configuration.



##### Low powered systems



See [SBC.md](docs/SBC.md) for low powered / single board computers (sbc) like the raspberry pi, odroid, pine etc. 



##### VPN



See [VPN.md](docs/VPN.md) for VPN integration.



#### Part 2



The default nefarious user/password is `admin`/`admin`.  On first login you will be directed to the main nefarious settings and asked to configure your Jackett API token.

Jackett's **host** in the main settings should remain `jackett` and the port should remain `9117`.  Copy your API Token from [Jackett](http://localhost:9117) into the appropriate nefarious section.

Don't forget to also add some indexers in Jackett to track your preferred content, and be sure to test them to see that they're working.  Some popular examples are *The Pirate Bay*, *1337x*, *RARBG*.



Transmission's host should remain `transmission` and port should remain `9091`.  It's possible to configure it with a username and password, but it defaults to keeping them both blank.

Entering both username and password in the nefarious settings should only be done if the Transmission settings of `transmission-settings.json` were also configured for your desired user/pass.



Once all of your settings are updated, click `Save & Verify Settings` to save and verify they're valid.



##### Transmission Configuration



There is no default transmission user/pass, but feel free to edit the `transmission-settings.json` beforehand following the [official settings](https://github.com/transmission/transmission/wiki/Editing-Configuration-Files) to make any changes you'd like.



**NOTE** if you make any changes to `transmission-settings.json` you'll have to recreate the transmission container for the changes to take place:



    docker-compose up -d --force-recreate transmission

    

### Usage



See [USAGE.md](docs/USAGE.md).



### Upgrading



If you're running nefarious via the default `docker-compose.yml` file then nefarious will automatically update to the newest versions as they release.

However, occasionally the `docker-compose.yml` configuration file changes and you'll need to redo the steps in [Setup](#setup).

*You will not lose your nefarious settings due to persistent docker volumes.  It's a safe operation.*



### Troubleshooting



See [TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md).



### Development



See [DEVELOPMENT.md](docs/DEVELOPMENT.md).