1
0
mirror of https://github.com/Radarr/Radarr.git synced 2024-11-09 04:22:30 +01:00
Radarr/README.md
2019-12-06 22:42:15 -05:00

12 KiB

Radarr

New UI Development: For an overview of the new UI development see DEVELOPMENT.md.

Radarr is an independent fork of Sonarr reworked for automatically downloading movies via Usenet and BitTorrent.

The project was inspired by other Usenet/BitTorrent movie downloaders such as CouchPotato.

See the Roadmap blogpost for an overview of planned features.

Getting Started

Installation Docker Setup Guide FAQ

Downloads

Release Type Branch: develop (stable) Branch: nightly (semi-unstable) Branch: aphrodite (very-unstable)
Binary Releases GitHub Releases AppVeyor Builds
Docker Docker release Docker nightly Docker aphrodite
Docker Docker release Docker nightly Docker aphrodite

Support

OpenCollective OpenCollective OpenCollective

Discord Reddit Feathub GitHub GitHub Wiki

Status

GitHub issues GitHub pull requests GNU GPL v3 Copyright 2010-2017 Github Releases Docker Pulls Changelog

Service Master Develop
AppVeyor AppVeyor AppVeyor
Travis Travis Travis

Site and API Status

API Updates Sites
API V2 (develop) Update Server Radarr Mappings
API Staging (nightly) Github Updates Main Site

Radarr is currently undergoing rapid development and pull requests are actively added into the repository.

Features

Current Features

  • Adding new movies with lots of information, such as trailers, ratings, etc.
  • Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.
  • Can watch for better quality of the movies you have and do an automatic upgrade. eg. from DVD to Blu-Ray
  • Automatic failed download handling will try another release if one fails
  • Manual search so you can pick any release or to see why a release was not downloaded automatically
  • Full integration with SABnzbd and NZBGet
  • Automatically searching for releases as well as RSS Sync
  • Automatically importing downloaded movies
  • Recognizing Special Editions, Director's Cut, etc.
  • Identifying releases with hardcoded subs
  • All indexers supported by Sonarr also supported
  • New PassThePopcorn Indexer
  • QBittorrent, Deluge, rTorrent, Transmission and uTorrent download client (Other clients are coming)
  • New TorrentPotato Indexer
  • Torznab Indexer now supports Movies (Works well with Jackett)
  • Scanning PreDB to know when a new release is available
  • Importing movies from various online sources, such as IMDb Watchlists (A complete list can be found here)
  • Full integration with Kodi, Plex (notification, library update)
  • And a beautiful UI
  • Importing Metadata such as trailers or subtitles
  • Adding metadata such as posters and information for Kodi and others to use
  • Advanced customization for profiles, such that Radarr will always download the copy you want

Planned Features

See the Roadmap blogpost for an overview of planned features.

Feature Requests

Configuring the Development Environment

Requirements

Setup

  • Make sure all the required software mentioned above are installed
  • Clone the repository into your development machine (info)
  • Grab the submodules git submodule init && git submodule update
  • Install the required Node Packages yarn install
  • Start gulp to monitor your dev environment for any changes that need post processing using yarn start command.

Notice
Gulp must be running at all times while you are working with Radarr client source files.

Build

  • To build run sh build.sh

Note: Windows users must have bash available to do this. If you installed git, you should have a git bash utility that works.

Development

  • Open Radarr.sln in Visual Studio 2017 or run the build.sh script, if Mono is installed. Alternatively you can use Jetbrains Rider, since it works on all Platforms.
  • Make sure NzbDrone.Console is set as the startup project
  • Run build.sh before running

Supporters

This project would not be possible without the support by these amazing folks. Become a sponsor or backer to help us out!

Sponsors

Sponsors

Flexible Sponsors

Flexible Sponsors

Backers

Backers

JetBrains

Thank you to JetBrains JetBrains for providing us with free licenses to their great tools

License