1
0
mirror of https://github.com/Radarr/Radarr.git synced 2024-07-14 16:55:21 +02:00
Radarr/README.md

91 lines
4.2 KiB
Markdown
Raw Normal View History

2017-01-08 20:23:24 +01:00
# Radarr
| Service | Master | Develop |
|----------|:---------------------------:|:----------------------------:|
2017-01-10 23:19:00 +01: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-08 20:23:24 +01:00
| Travis | [![Travis](https://img.shields.io/travis/galli-leo/Radarr/master.svg?maxAge=60&style=flat-square)](https://travis-ci.org/galli-leo/Radarr) | [![Travis](https://img.shields.io/travis/galli-leo/Radarr/develop.svg?maxAge=60&style=flat-square)](https://travis-ci.org/galli-leo/Radarr) |
2011-08-03 18:29:03 +02:00
This fork of Sonarr aims to turn it into something like CouchPotato.
2016-12-28 18:43:31 +01:00
## Currently working:
2017-01-14 23:23:35 +01:00
2017-01-04 12:15:56 +01:00
* Adding new movies
2016-12-28 18:43:31 +01:00
* Manually searching for releases of movies.
* Automatically searching for releases.
2017-01-06 19:24:40 +01:00
* 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))
2016-12-28 18:43:31 +01:00
## Planned Features:
2017-01-14 23:23:35 +01:00
2016-12-28 18:43:31 +01:00
* Scanning PreDB to know when a new release is available.
2017-01-04 12:15:56 +01:00
* Fixing the other Indexers and download clients.
2016-12-28 18:43:31 +01:00
* Importing of Sonarr config.
2013-03-29 17:44:41 +01:00
2017-01-04 12:15:56 +01:00
## Download
2017-01-14 23:23:35 +01:00
The latest precompiled binary versions can be found here: https://github.com/Radarr/Radarr/releases.
2017-01-10 23:19:12 +01:00
2017-01-13 00:15:27 +01:00
To connect to the UI, fire up your browser and open localhost:7878 or your-ip:7878.
Docker containers from [linuxserver.io](https://linuxserver.io) can be found here:
2017-01-14 23:23:35 +01:00
* [Radarr (x64)](https://hub.docker.com/r/linuxserver/radarr/)
* [Radarr (armhf)](https://hub.docker.com/r/lsioarmhf/radarr/)
* [Radarr (aarch64)](https://hub.docker.com/r/lsioarmhf/radarr-aarch64/)
2017-01-04 12:15:56 +01:00
2017-01-05 17:50:22 +01:00
For more up to date versions (but also sometimes broken), daily builds can be found here:
* [OSX](https://leonardogalli.ch/radarr/builds/latest.php?os=osx)
* [Windows](https://leonardogalli.ch/radarr/builds/latest.php?os=windows)
* [Linux](https://leonardogalli.ch/radarr/builds/latest.php?os=mono)
2017-01-04 12:15:56 +01:00
Continuous builds can be found on:
* [AppVeyor](https://ci.appveyor.com/project/galli-leo/radarr-usby1/build/artifacts)
2017-01-14 23:23:35 +01:00
## Major Features Include:
2013-03-29 17:44:41 +01:00
2017-01-14 23:23:35 +01: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 06:53:28 +01:00
* Automatic failed download handling will try another release if one fails
2017-01-14 23:23:35 +01: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 06:53:28 +01:00
* And a beautiful UI
2013-03-29 17:44:41 +01:00
2017-01-14 23:23:35 +01:00
## Configuring Development Environment:
### Requirements
2013-03-29 17:44:41 +01:00
2017-01-14 23:23:35 +01:00
* Visual Studio 2015 [Free Community Edition](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx) or Mono
* [Git](https://git-scm.com/downloads)
* [NodeJS](https://nodejs.org/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-14 23:23:35 +01:00
* Make sure all the required software mentioned above are installed.
* Clone the repository into your development machine. [*info*](https://help.github.com/articles/working-with-repositories)
* 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-14 23:23:35 +01:00
*Please note 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-01-14 23:23:35 +01:00
### Development
2013-03-29 17:44:41 +01:00
2017-01-14 23:23:35 +01:00
* 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
2012-03-04 19:02:06 +01:00
2017-01-14 23:23:35 +01:00
### License
2012-03-04 19:02:06 +01:00
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
2017-01-14 23:23:35 +01:00
* Copyright 2010-2016
2014-01-24 23:03:39 +01:00
2017-01-14 23:23:35 +01:00
### Sponsors
2014-01-24 23:03:39 +01:00
2017-01-14 23:23:35 +01: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/)