2c75cfe0ea
* dhcp uses on, not true (because iocage syntax) * Documentation updates * Add gh-pages wiki generator using mkdocs * Update shellcheck.yml * Update wiki.yml * Add filecheck * readme case correction1 * readme case correction2 * Update filecheck.yml
171 lines
12 KiB
Markdown
Executable File
171 lines
12 KiB
Markdown
Executable File
# Radarr
|
|
|
|
## Original README from the radarr github:
|
|
|
|
https://github.com/Radarr/Radarr
|
|
|
|
# Radarr
|
|
|
|
<p align="center">
|
|
<img src="/Logo/text256.png" alt="Radarr">
|
|
</p>
|
|
|
|
**New UI Development:** For an overview of the new UI development see [DEVELOPMENT.md](https://github.com/Radarr/Radarr/blob/aphrodite/DEVELOPMENT.md).
|
|
|
|
Radarr is an __independent__ fork of [Sonarr](https://github.com/Sonarr/Sonarr) reworked for automatically downloading movies via Usenet and BitTorrent.
|
|
|
|
The project was inspired by other Usenet/BitTorrent movie downloaders such as CouchPotato.
|
|
|
|
See the [Roadmap blogpost](https://blog.radarr.video/development/update/2018/11/11/roadmap-update.html) for an overview of planned features.
|
|
|
|
## Getting Started
|
|
|
|
[](https://github.com/Radarr/Radarr/wiki/Installation)
|
|
[](https://github.com/Radarr/Radarr/wiki/Docker)
|
|
[](https://github.com/Radarr/Radarr/wiki/Setup-Guide)
|
|
[](https://github.com/Radarr/Radarr/wiki/FAQ)
|
|
|
|
* [Install Radarr for your desired OS](https://github.com/Radarr/Radarr/wiki/Installation) *or* use [Docker](https://github.com/Radarr/Radarr/wiki/Docker)
|
|
* *For Linux users*, run `radarr` and *optionally* have [Radarr start automatically](https://github.com/Radarr/Radarr/wiki/Autostart-on-Linux)
|
|
* Connect to the UI through <http://localhost:7878> or <http://your-ip:7878> in your web browser
|
|
* See the [Setup Guide](https://github.com/Radarr/Radarr/wiki/Setup-Guide) for further configuration
|
|
|
|
## Downloads
|
|
|
|
| Release Type | Branch: develop (stable) | Branch: nightly (semi-unstable) | Branch: aphrodite (very-unstable) |
|
|
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| Binary Releases | [](https://github.com/Radarr/Radarr/releases) | [](https://ci.appveyor.com/project/galli-leo/radarr-usby1/branch/develop/artifacts) | |
|
|
| Docker | [](https://hub.docker.com/r/linuxserver/radarr) | [](https://hub.docker.com/r/linuxserver/radarr) | [](https://hub.docker.com/r/linuxserver/radarr) |
|
|
| Docker | [](https://hub.docker.com/r/hotio/radarr) | [](https://hub.docker.com/r/hotio/radarr) | [](https://hub.docker.com/r/hotio/radarr) |
|
|
|
|
## Support
|
|
|
|
[](#backers)
|
|
[](#flexible-sponsors)
|
|
[](#sponsors)
|
|
|
|
[](https://discord.gg/AD3UP37)
|
|
[](https://www.reddit.com/r/radarr)
|
|
[](http://feathub.com/Radarr/Radarr)
|
|
[](https://github.com/Radarr/Radarr/issues)
|
|
[](https://github.com/Radarr/Radarr/wiki)
|
|
|
|
## Status
|
|
|
|
[](https://github.com/Radarr/Radarr/issues)
|
|
[](https://github.com/Radarr/Radarr/pulls)
|
|
[](http://www.gnu.org/licenses/gpl.html)
|
|
[](https://github.com/Radarr/Radarr)
|
|
[](https://github.com/Radarr/Radarr/releases/)
|
|
[](https://hub.docker.com/r/linuxserver/radarr/)
|
|
[](/CHANGELOG.md#unreleased)
|
|
|
|
| Service | Master | Develop |
|
|
|----------|:---------------------------:|:----------------------------:|
|
|
| AppVeyor | [](https://ci.appveyor.com/project/galli-leo/Radarr) | [](https://ci.appveyor.com/project/galli-leo/Radarr-usby1) |
|
|
| Travis | [](https://travis-ci.org/Radarr/Radarr) | [](https://travis-ci.org/Radarr/Radarr) |
|
|
|
|
### [Site and API Status](https://status.radarr.video)
|
|
|
|
| API | Updates | Sites |
|
|
|-------|:----:|:----:|
|
|
| [](https://api.radarr.video/v2/) | [](https://radarr.aeonlucid.com) | [](https://mappings.radarr.video/)
|
|
| [](https://staging.api.radarr.video/) | [](https://api.github.com/v3/) | [](https://radarr.video/)
|
|
|
|
Radarr is currently undergoing rapid development and pull requests are actively added into the repository.
|
|
|
|
## Features
|
|
|
|
### Current Features
|
|
|
|
* 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
|
|
* 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
|
|
* Torznab Indexer now supports Movies (Works well with [Jackett](https://github.com/Jackett/Jackett))
|
|
* Scanning PreDB to know when a new release is available
|
|
* Importing movies from various online sources, such as IMDb Watchlists (A complete list can be found [here](https://github.com/Radarr/Radarr/issues/114))
|
|
* Full integration with Kodi, Plex (notification, library update)
|
|
* And a beautiful UI
|
|
* Importing Metadata such as trailers or subtitles
|
|
* Adding metadata such as posters and information for Kodi and others to use
|
|
* Advanced customization for profiles, such that Radarr will always download the copy you want
|
|
|
|
### Planned Features
|
|
|
|
See the [Roadmap blogpost](https://blog.radarr.video/development/update/2018/11/11/roadmap-update.html) for an overview of planned features.
|
|
|
|
#### [Feature Requests](http://feathub.com/Radarr/Radarr)
|
|
|
|
## Configuring the Development Environment
|
|
|
|
### Requirements
|
|
|
|
* [Visual Studio Community 2019](https://www.visualstudio.com/vs/community/) or [Rider](http://www.jetbrains.com/rider/)
|
|
* [Git](https://git-scm.com/downloads)
|
|
* [Node.js](https://nodejs.org/en/download/)
|
|
* [Yarn](https://yarnpkg.com/)
|
|
|
|
### 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 `yarn install`
|
|
* Start gulp to monitor your dev environment for any changes that need post processing using `yarn start` command.
|
|
|
|
> **Notice**
|
|
> Gulp must be running at all times while you are working with Radarr client source files.
|
|
|
|
### Build
|
|
|
|
* To build run `sh build.sh`
|
|
|
|
**Note:** Windows users must have bash available to do this. If you installed git, you should have a git bash utility that works.
|
|
|
|
### Development
|
|
|
|
* Open `Radarr.sln` in Visual Studio 2017 or run the build.sh script, if Mono is installed. Alternatively you can use Jetbrains Rider, since it works on all Platforms.
|
|
* Make sure `NzbDrone.Console` is set as the startup project
|
|
* Run `build.sh` before running
|
|
|
|
## Supporters
|
|
|
|
This project would not be possible without the support by these amazing folks. [**Become a sponsor or backer**](https://opencollective.com/radarr) to help us out!
|
|
|
|
### Sponsors
|
|
|
|
[](https://opencollective.com/radarr/order/3851)
|
|
|
|
### Flexible Sponsors
|
|
|
|
[](https://opencollective.com/radarr/order/3856)
|
|
|
|
### Backers
|
|
|
|
[](https://opencollective.com/radarr/order/3850)
|
|
|
|
### JetBrains
|
|
|
|
Thank you to [<img src="/Logo/jetbrains.svg" alt="JetBrains" width="32"> JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools
|
|
|
|
* [<img src="/Logo/resharper.svg" alt="ReSharper" width="32"> ReSharper](http://www.jetbrains.com/resharper/)
|
|
* [<img src="/Logo/webstorm.svg" alt="WebStorm" width="32"> WebStorm](http://www.jetbrains.com/webstorm/)
|
|
* [<img src="/Logo/rider.svg" alt="Rider" width="32"> Rider](http://www.jetbrains.com/rider/)
|
|
* [<img src="/Logo/dottrace.svg" alt="dotTrace" width="32"> dotTrace](http://www.jetbrains.com/dottrace/)
|
|
|
|
## License
|
|
|
|
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
|
|
* Copyright 2010-2019
|