Radarr/README.md

97 lines
5.9 KiB
Markdown
Raw Normal View History

2017-01-15 12:50:45 +00:00
## 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)
2017-01-15 23:10:30 +00:00
[![Github Releases](https://img.shields.io/github/downloads/Radarr/Radarr/total.svg?maxAge=60&style=flat-square)](https://github.com/Radar/Radarr/releases/latest)
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/radarr.svg?maxAge=60&style=flat-square)](https://hub.docker.com/r/linuxserver/radarr/)
2017-01-08 19:23:24 +00:00
| 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
2017-01-21 09:47:11 +00:00
A fork of [Sonarr](https://github.com/Sonarr/Sonarr) to work with movies à la Couchpotato.
**This fork works independently of Sonarr and will not interfere with it.**
2016-12-28 17:43:31 +00:00
2017-01-15 12:50:45 +00:00
## Downloads
2017-01-14 22:23:35 +00:00
2017-01-15 12:50:45 +00:00
[![GitHub Releases](https://img.shields.io/badge/downloads-releases-brightgreen.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/releases)
2017-01-04 11:15:56 +00:00
2017-01-15 12:50:45 +00:00
[![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?colorB=1488C6&maxAge=60&style=flat-square)](https://store.docker.com/community/images/linuxserver/radarr)
[![Docker armhf](https://img.shields.io/badge/docker-armhf-blue.svg?colorB=1488C6&maxAge=60&style=flat-square)](https://store.docker.com/community/images/lsioarmhf/radarr)
[![Docker aarch64](https://img.shields.io/badge/docker-aarch64-blue.svg?colorB=1488C6&maxAge=60&style=flat-square)](https://store.docker.com/community/images/lsioarmhf/radarr-aarch64)
2017-01-14 23:06:18 +00:00
To connect to the UI, fire up your browser and open <http://localhost:7878> or <http://your-ip:7878>.
## Support
[![Discord](https://img.shields.io/badge/discord-chat-7289DA.svg?maxAge=60&style=flat-square)](https://discord.gg/AD3UP37)
[![Reddit](https://img.shields.io/badge/reddit-discussion-FF4500.svg?maxAge=60&style=flat-square)](https://www.reddit.com/r/radarr)
[![GitHub](https://img.shields.io/badge/github-issues-181717.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/issues)
2017-01-15 12:50:45 +00:00
## Features
2017-01-21 09:47:11 +00:00
### Current Features
2017-01-21 09:47:11 +00:00
* 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
2017-01-21 09:47:11 +00:00
* 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))
2017-01-21 09:47:11 +00:00
* And a beautiful UI
2017-01-15 12:50:45 +00:00
### Planned Features
* Scanning PreDB to know when a new release is available
* Fixing the other Indexers and download clients
2017-01-21 09:47:11 +00:00
* Importing movies from various online sources, such as IMDb Watchlists (A complete list can be found [here](https://github.com/Radarr/Radarr/issues/114))
2017-01-14 22:23:35 +00:00
* Full integration with Kodi, Plex (notification, library update, metadata)
2017-01-21 09:47:11 +00:00
2017-01-24 20:30:24 +00:00
##Feature Requests
[![Feature Requests](http://feathub.com/Radarr/Radarr?format=svg)](http://feathub.com/Radarr/Radarr)
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
2017-01-15 12:50:45 +00:00
* 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
> **Notice**
> 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-15 12:50:45 +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)