Radarr/README.md

87 lines
3.9 KiB
Markdown
Raw Normal View History

2017-01-08 19:23:24 +00:00
# Radarr
| Service | Master | Develop |
|----------|:---------------------------:|:----------------------------:|
2017-01-10 22:19:00 +00:00
| 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) |
2017-01-15 10:42:15 +00:00
| 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) |
2011-08-03 16:29:03 +00:00
This fork of Sonarr aims to turn it into something like CouchPotato.
2016-12-28 17:43:31 +00:00
2017-01-04 11:15:56 +00:00
## Download
2017-01-14 22:23:35 +00:00
2017-01-14 23:06:18 +00:00
Release builds can be found on:
* [GitHub](https://github.com/Radarr/Radarr/releases)
2017-01-04 11:15:56 +00:00
Continuous builds can be found on:
* [AppVeyor](https://ci.appveyor.com/project/galli-leo/radarr-usby1/build/artifacts)
2017-01-14 23:06:18 +00:00
Docker containers from [linuxserver.io](http://tools.linuxserver.io/dockers) can be found here:
* [x64](https://store.docker.com/community/images/linuxserver/radarr)
* [armhf](https://store.docker.com/community/images/lsioarmhf/radarr)
* [aarch64](https://store.docker.com/community/images/lsioarmhf/radarr-aarch64)
To connect to the UI, fire up your browser and open <http://localhost:7878> or <http://your-ip:7878>.
## Currently Working
* Adding new movies
* Manually searching for releases of movies
* Automatically searching for releases
* Automatically importing downloaded movies
* Recognizing Special Editions, Director's Cut, etc.
* Identifying releases with hardcoded subs
* Rarbg.to, Torznab and Newznab Indexer
* QBittorrent and Deluge download client (Other clients are coming)
* New TorrentPotato Indexer (Works well with [Jackett](https://github.com/Jackett/Jackett))
## Planned Features
* Scanning PreDB to know when a new release is available
* Fixing the other Indexers and download clients
* Importing of Sonarr config
2017-01-14 23:06:18 +00:00
## Major Features
2013-03-29 16:44:41 +00:00
2017-01-14 22:23:35 +00:00
* 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*
2014-12-05 05:53:28 +00:00
* Automatic failed download handling will try another release if one fails
2017-01-14 22:23:35 +00:00
* Manual search so you can pick any release or to see why a release was not downloaded automatically
* Full integration with SABnzbd and NZBGet
* Full integration with Kodi, Plex (notification, library update, metadata)
2014-12-05 05:53:28 +00:00
* And a beautiful UI
2013-03-29 16:44:41 +00:00
## Configuring Development Environment
2017-01-14 22:23:35 +00:00
### Requirements
2013-03-29 16:44:41 +00:00
* [Visual Studio Community](https://www.visualstudio.com/vs/community/) or [MonoDevelop](http://www.monodevelop.com)
2017-01-14 22:23:35 +00:00
* [Git](https://git-scm.com/downloads)
* [Node.js](https://nodejs.org/en/download/)
2013-03-29 16:44:41 +00:00
2017-01-14 22:23:35 +00:00
### Setup
2013-03-29 16:44:41 +00:00
* 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/))
2017-01-14 22:23:35 +00: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 16:44:41 +00:00
*Please note: gulp must be running at all times while you are working with Radarr client source files.*
2013-03-29 16:44:41 +00:00
2017-01-14 22:23:35 +00:00
### Development
2013-03-29 16:44:41 +00:00
* Open `NzbDrone.sln` in Visual Studio or run the build.sh script, if Mono is installed
2017-01-14 22:23:35 +00:00
* Make sure `NzbDrone.Console` is set as the startup project
2012-03-04 18:02:06 +00:00
2017-01-14 22:23:35 +00:00
### License
2012-03-04 18:02:06 +00:00
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
2017-01-14 22:23:35 +00:00
* Copyright 2010-2016
2014-01-24 22:03:39 +00:00
2017-01-14 22:23:35 +00:00
### Sponsors
2014-01-24 22:03:39 +00:00
[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)