Radarr/README.md

83 lines
4.8 KiB
Markdown
Raw Normal View History

2020-05-14 03:37:58 +00:00
# Radarr
2017-01-15 12:50:45 +00:00
2020-07-18 05:50:02 +00:00
[![Build Status](https://dev.azure.com/Radarr/Radarr/_apis/build/status/Radarr.Radarr?branchName=develop)](https://dev.azure.com/Radarr/Radarr/_build/latest?definitionId=1&branchName=develop)
2021-11-28 21:52:58 +00:00
[![Translated](https://translate.servarr.com/widgets/servarr/-/radarr/svg-badge.svg)](https://translate.servarr.com/engage/radarr/?utm_source=widget)
2021-06-05 19:26:09 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/radarr.svg)](https://wiki.servarr.com/radarr/installation#docker)
2020-07-18 05:50:02 +00:00
![Github Downloads](https://img.shields.io/github/downloads/Radarr/Radarr/total.svg)
2021-11-28 21:52:58 +00:00
[![Backers on Open Collective](https://opencollective.com/Radarr/backers/badge.svg)](#backers)
2020-11-25 01:10:07 +00:00
[![Sponsors on Open Collective](https://opencollective.com/Radarr/sponsors/badge.svg)](#sponsors)
2021-11-28 21:52:58 +00:00
[![Mega Sponsors on Open Collective](https://opencollective.com/Radarr/megasponsors/badge.svg)](#mega-sponsors)
2018-12-24 13:30:37 +00:00
2020-11-25 01:10:07 +00:00
Radarr is a movie collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new movies and will interface with clients and indexers to grab, sort, and rename them. It can also be configured to automatically upgrade the quality of existing files in the library when a better quality format becomes available.
2021-11-28 21:52:58 +00:00
Note that only one type of a given movie is supported. If you want both an 4k version and 1080p version of a given movie you will need multiple instances.
2017-01-08 19:23:24 +00:00
2021-11-28 21:52:58 +00:00
## Major Features Include
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.
2021-11-28 21:52:58 +00:00
* Can watch for better quality of the movies you have and do an automatic upgrade. *e.g. from DVD to Blu-Ray*
2017-01-21 09:47:11 +00:00
* 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
2021-11-28 21:52:58 +00:00
* Identifying releases with AKA movie names
* SABnzbd, NZBGet, QBittorrent, Deluge, rTorrent, Transmission, uTorrent, and other download clients are supported and integrated
* Full integration with Kodi and Plex (notifications, library updates)
2018-03-12 18:37:32 +00:00
* Importing Metadata such as trailers or subtitles
* Adding metadata such as posters and information for Kodi and others to use
2018-08-12 17:48:24 +00:00
* Advanced customization for profiles, such that Radarr will always download the copy you want
2021-11-28 21:52:58 +00:00
* A beautiful UI
2020-11-25 01:10:07 +00:00
## Support
2021-11-28 21:52:58 +00:00
[![Wiki](https://img.shields.io/badge/servarr-wiki-181717.svg?maxAge=60)](https://wiki.servarr.com/radarr)
2021-02-25 02:55:58 +00:00
[![Discord](https://img.shields.io/badge/discord-chat-7289DA.svg?maxAge=60)](https://radarr.video/discord)
2020-11-25 01:10:07 +00:00
[![Reddit](https://img.shields.io/badge/reddit-discussion-FF4500.svg?maxAge=60)](https://www.reddit.com/r/Radarr)
2021-11-28 21:52:58 +00:00
Note: GitHub Issues are for Bugs and Feature Requests Only
2020-11-25 01:10:07 +00:00
[![GitHub - Bugs and Feature Requests Only](https://img.shields.io/badge/github-issues-red.svg?maxAge=60)](https://github.com/Radarr/Radarr/issues)
2020-11-29 21:05:10 +00:00
## Contributors & Developers
2021-11-28 21:52:58 +00:00
2020-11-29 21:05:10 +00:00
[API Documentation](https://radarr.video/docs/api/)
2013-03-29 16:44:41 +00:00
2021-11-28 21:52:58 +00:00
This project exists thanks to all the people who contribute.
- [Contribute (GitHub)](CONTRIBUTING.md)
- [Contribution (Wiki Article)](https://wiki.servarr.com/radarr/contributing)
2012-03-04 18:02:06 +00:00
2021-11-28 21:52:58 +00:00
[![Contributors List](https://opencollective.com/Radarr/contributors.svg?width=890&button=false)](https://github.com/Radarr/Radarr/graphs/contributors)
2018-03-19 17:19:31 +00:00
2020-11-25 01:10:07 +00:00
## Backers
2018-03-19 17:19:31 +00:00
2020-11-25 01:10:07 +00:00
Thank you to all our backers! 🙏 [Become a backer](https://opencollective.com/Radarr#backer)
2018-08-12 17:48:24 +00:00
2021-11-28 21:52:58 +00:00
[![Backers List](https://opencollective.com/Radarr/backers.svg?width=890)](https://opencollective.com/Radarr#backer)
2018-08-12 17:48:24 +00:00
2020-11-25 01:10:07 +00:00
## Sponsors
2018-08-12 17:48:24 +00:00
2020-11-25 01:10:07 +00:00
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor](https://opencollective.com/Radarr#sponsor)
2018-03-19 17:19:31 +00:00
2021-11-28 21:52:58 +00:00
[![Sponsors List](https://opencollective.com/Radarr/sponsors.svg?width=890)](https://opencollective.com/Radarr#sponsor)
2018-03-19 17:19:31 +00:00
2020-11-25 01:10:07 +00:00
## Mega Sponsors
2018-03-19 22:37:24 +00:00
2021-11-28 21:52:58 +00:00
[![Mega Sponsors List](https://opencollective.com/Radarr/tiers/mega-sponsor.svg?width=890)](https://opencollective.com/Radarr#mega-sponsor)
2018-03-19 22:37:24 +00:00
2020-11-25 01:10:07 +00:00
## JetBrains
2021-11-28 21:52:58 +00:00
2020-11-25 01:10:07 +00:00
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.
2018-08-12 17:48:24 +00:00
* [<img src="/Logo/resharper.svg" alt="ReSharper" width="32"> ReSharper](http://www.jetbrains.com/resharper/)
2021-11-28 21:52:58 +00:00
* [<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/)
2018-08-12 17:48:24 +00:00
* [<img src="/Logo/dottrace.svg" alt="dotTrace" width="32"> dotTrace](http://www.jetbrains.com/dottrace/)
2018-03-19 17:19:31 +00:00
2020-11-25 01:10:07 +00:00
### License
2017-06-12 17:11:11 +00:00
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
2021-11-28 21:52:58 +00:00
* Copyright 2010-2022