mirror of https://github.com/Radarr/Radarr
116 lines
7.6 KiB
Markdown
116 lines
7.6 KiB
Markdown
<p align="center">
|
|
<img src="/Logo/text256.png" alt="Radarr">
|
|
</p>
|
|
|
|
Radarr is an __independent__ fork of [Sonarr](https://github.com/Sonarr/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
|
|
|
|
[](https://github.com/Radarr/Radarr/wiki/Installation)
|
|
[](https://github.com/Radarr/Radarr/wiki/Docker)
|
|
[](https://github.com/Radarr/Radarr/wiki/Setup-Guide)
|
|
[](https://github.com/Radarr/Radarr/wiki/FAQ)
|
|
|
|
* [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
|
|
|
|
## Downloads
|
|
|
|
[](https://github.com/Radarr/Radarr/releases)
|
|
[](https://ci.appveyor.com/project/galli-leo/radarr-usby1/build/artifacts)
|
|
|
|
[](https://store.docker.com/community/images/linuxserver/radarr)
|
|
[](https://store.docker.com/community/images/hotio/radarr)
|
|
[](https://store.docker.com/community/images/lsioarmhf/radarr)
|
|
[](https://store.docker.com/community/images/lsioarmhf/radarr-aarch64)
|
|
|
|
## Support
|
|
|
|
[](https://discord.gg/AD3UP37)
|
|
[](https://www.reddit.com/r/radarr)
|
|
[](http://feathub.com/Radarr/Radarr)
|
|
[](https://github.com/Radarr/Radarr/issues)
|
|
[](https://github.com/Radarr/Radarr/wiki)
|
|
|
|
## Status
|
|
|
|
[](https://github.com/Radarr/Radarr/issues)
|
|
[](https://github.com/Radarr/Radarr/pulls)
|
|
[](http://www.gnu.org/licenses/gpl.html)
|
|
[](https://github.com/Radarr/Radarr)
|
|
[](https://github.com/Radar/Radarr/releases/latest)
|
|
[](https://hub.docker.com/r/linuxserver/radarr/)
|
|
|
|
| Service | Master | Develop |
|
|
|----------|:---------------------------:|:----------------------------:|
|
|
| AppVeyor | [](https://ci.appveyor.com/project/galli-leo/Radarr) | [](https://ci.appveyor.com/project/galli-leo/Radarr-usby1) |
|
|
| Travis | [](https://travis-ci.org/Radarr/Radarr) | [](https://travis-ci.org/Radarr/Radarr) |
|
|
|
|
**This project works independently of Sonarr and will not interfere with it.**
|
|
|
|
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 (Works well with [Jackett](https://github.com/Jackett/Jackett))
|
|
* And a beautiful UI
|
|
|
|
### Planned Features
|
|
|
|
* Scanning PreDB to know when a new release is available
|
|
* Fixing the other Indexers and download clients
|
|
* 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, metadata)
|
|
|
|
#### [Feature Requests](http://feathub.com/Radarr/Radarr)
|
|
|
|
## Configuring the Development Environment
|
|
|
|
### Requirements
|
|
|
|
* [Visual Studio Community](https://www.visualstudio.com/vs/community/) or [MonoDevelop](http://www.monodevelop.com)
|
|
* [Git](https://git-scm.com/downloads)
|
|
* [Node.js](https://nodejs.org/en/download/)
|
|
|
|
### Setup
|
|
|
|
* Make sure all the required software mentioned above are installed
|
|
* 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))
|
|
* 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.
|
|
|
|
> **Notice**
|
|
> Gulp must be running at all times while you are working with Radarr client source files.
|
|
|
|
### Development
|
|
|
|
* Open `NzbDrone.sln` in Visual Studio or run the build.sh script, if Mono is installed
|
|
* Make sure `NzbDrone.Console` is set as the startup project
|
|
|
|
## Sponsors
|
|
|
|
Thanks to [JetBrains](http://www.jetbrains.com) for providing us with free licenses to their great tools:
|
|
* [ReSharper](http://www.jetbrains.com/resharper)
|
|
* [WebStorm](http://www.jetbrains.com/webstorm)
|
|
* [TeamCity](http://www.jetbrains.com/teamcity)
|