mirror of
https://github.com/Radarr/Radarr.git
synced 2024-09-11 12:02:35 +02:00
86 lines
4.7 KiB
Markdown
86 lines
4.7 KiB
Markdown
## 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)
|
|
|
|
| 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) |
|
|
|
|
This fork of Sonarr aims to turn it into something like CouchPotato.
|
|
|
|
## Downloads
|
|
|
|
[![GitHub Releases](https://img.shields.io/badge/downloads-releases-brightgreen.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/releases)
|
|
|
|
[![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/build/artifacts)
|
|
|
|
[![Docker x64](https://img.shields.io/badge/docker-x64-blue.svg?maxAge=60&style=flat-square)](https://store.docker.com/community/images/linuxserver/radarr)
|
|
[![Docker armhf](https://img.shields.io/badge/docker-armhf-blue.svg?maxAge=60&style=flat-square)](https://store.docker.com/community/images/lsioarmhf/radarr)
|
|
[![Docker aarch64](https://img.shields.io/badge/docker-aarch64-blue.svg?maxAge=60&style=flat-square)](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>.
|
|
|
|
## Features
|
|
|
|
### 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
|
|
|
|
### Major Features
|
|
|
|
* 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
|
|
* Full integration with Kodi, Plex (notification, library update, metadata)
|
|
* And a beautiful UI
|
|
|
|
## Configuring 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.
|
|
|
|
*Please note: 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
|
|
|
|
[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)
|