1
0
mirror of https://github.com/Radarr/Radarr.git synced 2024-11-04 10:02:40 +01:00
Radarr/README.md
Edward Scroop cf08f483b2
Update README.md (#5307) [skip ci]
As development of features for Radarr v2 has stopped, ensure that new contributors can begin developing Radarr v3 by changing reference to NZbdrone.
2020-11-12 21:28:54 -05:00

11 KiB

Radarr

Build Status Translated Docker Pulls Github Downloads Backers on Open Collective Sponsors on Open Collective

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.

Getting Started

Installation Docker Setup Guide FAQ

If you are using Docker please ensure your Docker paths are setup correctly using this guide to facilitate hardlinks and minimize permissions issues.

Downloads

Please note that v0.2 will only have critical bugs resolved as of August 2020. Any additional development or features will be soley in V3.

Each push to the "develop" branch creates a build on "nightly" release channel (release channel is the "branch" within radarr's settings), once we push a build to Github it will show up on "develop" release channel.

Release Channel Type Branch: develop (stable) (v0.2) Branch: nightly (semi-unstable) (v3.0)
Binary Releases GitHub Releases Azure Build
Azure Build
Azure Build Azure Build
Azure Build
Docker - lsio Docker release Docker nightly
Docker - hotio Docker release Docker nightly

Support

Discord Reddit GitHub GitHub Wiki

Status

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

Site and API Status

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 or Trakt (v3) (A complete list can be found here)
  • Full integration with Kodi, Plex (notification, library update)
  • And a new beautiful UI (v3)
  • 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

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)
  • 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 2019 or run the build.sh script, if Mono is installed. Alternatively you can use Jetbrains Rider, since it works on all Platforms.
  • Make sure Radarr.Console is set as the startup project
  • Run build.sh before running, or build in VS

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