You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Radarr/README.md

87 lines
3.9 KiB

7 years ago
# Radarr
| Service | Master | Develop |
|----------|:---------------------------:|:----------------------------:|
7 years ago
| 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) |
7 years ago
| 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) |
13 years ago
This fork of Sonarr aims to turn it into something like CouchPotato.
7 years ago
7 years ago
## Download
7 years ago
7 years ago
Release builds can be found on:
* [GitHub](https://github.com/Radarr/Radarr/releases)
7 years ago
Continuous builds can be found on:
* [AppVeyor](https://ci.appveyor.com/project/galli-leo/radarr-usby1/build/artifacts)
7 years ago
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
7 years ago
## Major Features
11 years ago
7 years ago
* 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*
10 years ago
* Automatic failed download handling will try another release if one fails
7 years ago
* 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)
10 years ago
* And a beautiful UI
11 years ago
## Configuring Development Environment
7 years ago
### Requirements
11 years ago
* [Visual Studio Community](https://www.visualstudio.com/vs/community/) or [MonoDevelop](http://www.monodevelop.com)
7 years ago
* [Git](https://git-scm.com/downloads)
* [Node.js](https://nodejs.org/en/download/)
11 years ago
7 years ago
### Setup
11 years ago
* 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/))
7 years ago
* 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.
11 years ago
*Please note: gulp must be running at all times while you are working with Radarr client source files.*
11 years ago
7 years ago
### Development
11 years ago
* Open `NzbDrone.sln` in Visual Studio or run the build.sh script, if Mono is installed
7 years ago
* Make sure `NzbDrone.Console` is set as the startup project
7 years ago
### License
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
7 years ago
* Copyright 2010-2016
10 years ago
7 years ago
### Sponsors
10 years ago
[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)