2017-03-09 04:16:08 +01:00
< p align = "center" >
2017-04-05 20:44:05 +02:00
< img src = "/Logo/text256.png" alt = "Radarr" >
2017-03-09 04:16:08 +01:00
< / p >
2017-01-15 13:50:45 +01:00
2017-03-09 04:16:08 +01:00
Radarr is an __independent__ fork of [Sonarr ](https://github.com/Sonarr/Sonarr ) reworked for automatically downloading movies via Usenet and BitTorrent.
2017-01-08 20:23:24 +01:00
2017-03-09 04:16:08 +01:00
The project was inspired by other Usenet/BitTorrent movie downloaders such as CouchPotato.
2018-12-30 13:32:56 +01:00
See the [Roadmap blogpost ](https://blog.radarr.video/development/update/2018/11/11/roadmap-update.html ) for an overview of planned features.
2017-03-09 04:16:08 +01:00
## Getting Started
2011-08-03 18:29:03 +02:00
2017-03-09 04:16:08 +01:00
[![Installation ](https://img.shields.io/badge/wiki-installation-brightgreen.svg?maxAge=60&style=flat-square )](https://github.com/Radarr/Radarr/wiki/Installation)
[![Docker ](https://img.shields.io/badge/wiki-docker-1488C6.svg?maxAge=60&style=flat-square )](https://github.com/Radarr/Radarr/wiki/Docker)
[![Setup Guide ](https://img.shields.io/badge/wiki-setup_guide-orange.svg?maxAge=60&style=flat-square )](https://github.com/Radarr/Radarr/wiki/Setup-Guide)
[![FAQ ](https://img.shields.io/badge/wiki-FAQ-BF55EC.svg?maxAge=60&style=flat-square )](https://github.com/Radarr/Radarr/wiki/FAQ)
2017-01-21 10:47:11 +01:00
2017-03-09 04:16:08 +01:00
* [Install Radarr for your desired OS ](https://github.com/Radarr/Radarr/wiki/Installation ) *or* use [Docker ](https://github.com/Radarr/Radarr/wiki/Docker )
* *For Linux users*, run `radarr` and *optionally* have [Radarr start automatically ](https://github.com/Radarr/Radarr/wiki/Autostart-on-Linux )
* Connect to the UI through < http: // localhost:7878 > or < http: // your-ip:7878 > in your web browser
* See the [Setup Guide ](https://github.com/Radarr/Radarr/wiki/Setup-Guide ) for further configuration
2016-12-28 18:43:31 +01:00
2017-01-15 13:50:45 +01:00
## Downloads
2017-01-14 23:23:35 +01:00
2017-01-15 13:50:45 +01:00
[![GitHub Releases ](https://img.shields.io/badge/downloads-releases-brightgreen.svg?maxAge=60&style=flat-square )](https://github.com/Radarr/Radarr/releases)
2017-08-15 23:23:38 +02:00
[![AppVeyor Builds ](https://img.shields.io/badge/downloads-continuous-green.svg?maxAge=60&style=flat-square )](https://ci.appveyor.com/project/galli-leo/radarr-usby1/branch/develop/artifacts)
2017-01-14 23:48:04 +01:00
2017-03-08 21:58:12 +01:00
[![Docker release ](https://img.shields.io/badge/docker-release-blue.svg?colorB=1488C6&maxAge=60&style=flat-square )](https://store.docker.com/community/images/linuxserver/radarr)
2017-08-17 19:24:39 +02:00
[![Docker nightly ](https://img.shields.io/badge/docker-release/nightly-blue.svg?colorB=1488C6&maxAge=60&style=flat-square )](https://store.docker.com/community/images/hotio/suitarr)
2017-01-15 18:23:49 +01:00
[![Docker armhf ](https://img.shields.io/badge/docker-armhf-blue.svg?colorB=1488C6&maxAge=60&style=flat-square )](https://store.docker.com/community/images/lsioarmhf/radarr)
[![Docker aarch64 ](https://img.shields.io/badge/docker-aarch64-blue.svg?colorB=1488C6&maxAge=60&style=flat-square )](https://store.docker.com/community/images/lsioarmhf/radarr-aarch64)
2017-01-15 00:06:18 +01:00
2017-01-15 18:23:49 +01:00
## Support
2018-08-12 19:48:24 +02:00
[![OpenCollective ](https://opencollective.com/radarr/tiers/backer/badge.svg )](#backers)
2018-08-12 19:49:59 +02:00
[![OpenCollective ](https://opencollective.com/radarr/tiers/flexible-sponsor/badge.svg )](#flexible-sponsors)
2018-08-12 19:48:24 +02:00
[![OpenCollective ](https://opencollective.com/radarr/tiers/sponsor/badge.svg )](#sponsors)
2017-01-15 18:23:49 +01:00
[![Discord ](https://img.shields.io/badge/discord-chat-7289DA.svg?maxAge=60&style=flat-square )](https://discord.gg/AD3UP37)
[![Reddit ](https://img.shields.io/badge/reddit-discussion-FF4500.svg?maxAge=60&style=flat-square )](https://www.reddit.com/r/radarr)
2017-03-08 21:58:03 +01:00
[![Feathub ](https://img.shields.io/badge/feathub-requests-lightgrey.svg?maxAge=60&style=flat-square )](http://feathub.com/Radarr/Radarr)
[![GitHub ](https://img.shields.io/badge/github-issues-red.svg?maxAge=60&style=flat-square )](https://github.com/Radarr/Radarr/issues)
[![GitHub Wiki ](https://img.shields.io/badge/github-wiki-181717.svg?maxAge=60&style=flat-square )](https://github.com/Radarr/Radarr/wiki)
2017-01-15 18:23:49 +01:00
2017-03-09 04:16:08 +01:00
## Status
[![GitHub issues ](https://img.shields.io/github/issues/radarr/radarr.svg?maxAge=60&style=flat-square )](https://github.com/Radarr/Radarr/issues)
[![GitHub pull requests ](https://img.shields.io/github/issues-pr/radarr/radarr.svg?maxAge=60&style=flat-square )](https://github.com/Radarr/Radarr/pulls)
[![GNU GPL v3 ](https://img.shields.io/badge/license-GNU%20GPL%20v3-blue.svg?maxAge=60&style=flat-square )](http://www.gnu.org/licenses/gpl.html)
[![Copyright 2010-2017 ](https://img.shields.io/badge/copyright-2017-blue.svg?maxAge=60&style=flat-square )](https://github.com/Radarr/Radarr)
2018-08-12 19:48:24 +02:00
[![Github Releases ](https://img.shields.io/github/downloads/Radarr/Radarr/total.svg?maxAge=60&style=flat-square )](https://github.com/Radarr/Radarr/releases/)
2017-03-09 04:16:08 +01:00
[![Docker Pulls ](https://img.shields.io/docker/pulls/linuxserver/radarr.svg?maxAge=60&style=flat-square )](https://hub.docker.com/r/linuxserver/radarr/)
2018-08-12 19:49:59 +02:00
[![Changelog ](https://img.shields.io/github/commit-activity/w/radarr/radarr.svg?style=flat-square )](/CHANGELOG.md#unreleased)
2017-03-09 04:16:08 +01:00
| Service | Master | Develop |
|----------|:---------------------------:|:----------------------------:|
| AppVeyor | [![AppVeyor ](https://img.shields.io/appveyor/ci/galli-leo/Radarr/master.svg?maxAge=60&style=flat-square )](https://ci.appveyor.com/project/galli-leo/Radarr) | [![AppVeyor ](https://img.shields.io/appveyor/ci/galli-leo/Radarr-usby1/develop.svg?maxAge=60&style=flat-square )](https://ci.appveyor.com/project/galli-leo/Radarr-usby1) |
| Travis | [![Travis ](https://img.shields.io/travis/Radarr/Radarr/master.svg?maxAge=60&style=flat-square )](https://travis-ci.org/Radarr/Radarr) | [![Travis ](https://img.shields.io/travis/Radarr/Radarr/develop.svg?maxAge=60&style=flat-square )](https://travis-ci.org/Radarr/Radarr) |
2017-10-14 12:05:17 +02:00
### [Site and API Status](https://status.radarr.video)
2017-10-14 12:04:22 +02:00
| API | Updates | Sites |
|-------|:----:|:----:|
2018-03-07 19:30:13 +01:00
| [![API V2 (develop) ](http://status.radarr.video/component/1/shield?style=flat-square )](https://api.radarr.video/v2/) | [![Update Server ](http://status.radarr.video/component/4/shield?style=flat-square )](https://radarr.aeonlucid.com) | [![Radarr Mappings ](http://status.radarr.video/component/6/shield?style=flat-square )](https://mappings.radarr.video/)
| [![API Staging (nightly) ](http://status.radarr.video/component/2/shield?style=flat-square )](https://staging.api.radarr.video/) | [![Github Updates ](http://status.radarr.video/component/5/shield?style=flat-square )](https://api.github.com/v3/) | [![Main Site ](http://status.radarr.video/component/7/shield?style=flat-square )](https://radarr.video/)
2017-10-14 12:04:22 +02:00
2017-03-09 04:16:08 +01:00
Radarr is currently undergoing rapid development and pull requests are actively added into the repository.
2017-01-15 13:50:45 +01:00
## Features
2017-01-21 10:47:11 +01:00
### Current Features
2017-01-15 00:56:52 +01:00
2017-01-21 10:47:11 +01:00
* 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
2017-01-15 00:56:52 +01:00
* Automatically importing downloaded movies
* Recognizing Special Editions, Director's Cut, etc.
* Identifying releases with hardcoded subs
2017-01-21 10:47:11 +01:00
* All indexers supported by Sonarr also supported
* New PassThePopcorn Indexer
* QBittorrent, Deluge, rTorrent, Transmission and uTorrent download client (Other clients are coming)
2017-05-23 17:30:59 +02:00
* New TorrentPotato Indexer
* Torznab Indexer now supports Movies (Works well with [Jackett ](https://github.com/Jackett/Jackett ))
2017-04-10 13:15:06 +02:00
* 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 ](https://github.com/Radarr/Radarr/issues/114 ))
* Full integration with Kodi, Plex (notification, library update)
2017-01-21 10:47:11 +01:00
* And a beautiful UI
2018-03-12 19:37:32 +01:00
* Importing Metadata such as trailers or subtitles
* Adding metadata such as posters and information for Kodi and others to use
2018-08-12 19:48:24 +02:00
* Advanced customization for profiles, such that Radarr will always download the copy you want
2017-01-15 00:56:52 +01:00
2017-01-15 13:50:45 +01:00
### Planned Features
2017-01-15 00:56:52 +01:00
2018-12-30 13:32:56 +01:00
See the [Roadmap blogpost ](https://blog.radarr.video/development/update/2018/11/11/roadmap-update.html ) for an overview of planned features.
2017-01-21 10:47:11 +01:00
2017-03-09 04:16:08 +01:00
#### [Feature Requests](http://feathub.com/Radarr/Radarr)
2013-03-29 17:44:41 +01:00
2017-03-09 04:16:08 +01:00
## Configuring the Development Environment
2017-01-14 23:23:35 +01:00
### Requirements
2013-03-29 17:44:41 +01:00
2018-08-12 19:48:24 +02:00
* [Visual Studio Community 2017 ](https://www.visualstudio.com/vs/community/ ) or [Rider ](http://www.jetbrains.com/rider/ )
2017-01-14 23:23:35 +01:00
* [Git ](https://git-scm.com/downloads )
2017-01-15 00:56:52 +01:00
* [Node.js ](https://nodejs.org/en/download/ )
2013-03-29 17:44:41 +01:00
2017-01-14 23:23:35 +01:00
### Setup
2013-03-29 17:44:41 +01:00
2017-01-15 00:56:52 +01:00
* Make sure all the required software mentioned above are installed
2017-01-15 13:50:45 +01:00
* Clone the repository into your development machine ([*info*](https://help.github.com/desktop/guides/contributing/working-with-your-remote-repository-on-github-or-github-enterprise))
2017-01-14 23:23:35 +01:00
* Grab the submodules `git submodule init && git submodule update`
* Install the required Node Packages `npm install`
* Start gulp to monitor your dev environment for any changes that need post processing using `npm start` command.
2013-03-29 17:44:41 +01:00
2017-01-15 18:23:49 +01:00
> **Notice**
> Gulp must be running at all times while you are working with Radarr client source files.
2013-03-29 17:44:41 +01:00
2017-10-23 02:58:25 +02:00
### Build
* To build run `sh build.sh`
2018-08-05 16:28:05 +02:00
**Note:** Windows users must have bash available to do this. If you installed git, you should have a git bash utility that works.
2017-10-23 02:58:25 +02:00
2017-01-14 23:23:35 +01:00
### Development
2013-03-29 17:44:41 +01:00
2018-08-05 16:28:05 +02:00
* Open `NzbDrone.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.
2017-01-14 23:23:35 +01:00
* Make sure `NzbDrone.Console` is set as the startup project
2017-10-23 02:58:25 +02:00
* Run `build.sh` before running
2012-03-04 19:02:06 +01:00
2018-03-19 18:19:31 +01:00
## Supporters
This project would not be possible without the support by these amazing folks. [**Become a sponsor or backer** ](https://opencollective.com/radarr ) to help us out!
2018-08-12 19:48:24 +02:00
### Sponsors
[![Sponsors ](https://opencollective.com/radarr/tiers/sponsor.svg )](https://opencollective.com/radarr/order/3851)
### Flexible Sponsors
[![Flexible Sponsors ](https://opencollective.com/radarr/tiers/flexible-sponsor.svg?avatarHeight=54 )](https://opencollective.com/radarr/order/3856)
2018-03-19 18:19:31 +01:00
2018-08-12 19:48:24 +02:00
### Backers
2018-03-19 18:19:31 +01:00
2018-08-12 19:48:24 +02:00
[![Backers ](https://opencollective.com/radarr/tiers/backer.svg?avatarHeight=48 )](https://opencollective.com/radarr/order/3850)
2018-03-19 23:37:24 +01:00
2018-08-12 19:48:24 +02:00
### JetBrains
2018-03-19 23:37:24 +01:00
2018-08-12 19:48:24 +02:00
Thank you to [<img src="/Logo/jetbrains.svg" alt="JetBrains" width="32"> JetBrains ](http://www.jetbrains.com/ ) for providing us with free licenses to their great tools
* [<img src="/Logo/resharper.svg" alt="ReSharper" width="32"> ReSharper ](http://www.jetbrains.com/resharper/ )
* [<img src="/Logo/webstorm.svg" alt="WebStorm" width="32"> WebStorm ](http://www.jetbrains.com/webstorm/ )
* [<img src="/Logo/rider.svg" alt="Rider" width="32"> Rider ](http://www.jetbrains.com/rider/ )
* [<img src="/Logo/dottrace.svg" alt="dotTrace" width="32"> dotTrace ](http://www.jetbrains.com/dottrace/ )
2018-03-19 18:19:31 +01:00
## License
2017-06-12 19:11:11 +02:00
* [GNU GPL v3 ](http://www.gnu.org/licenses/gpl.html )
2018-08-12 19:48:24 +02:00
* Copyright 2010-2018