scale-catalog/blueprints/sonarr/readme.md

# Sonarr

## Original README from the sonarr github:

https://github.com/Sonarr/Sonarr

# Sonarr


Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.

## Major Features Include:

* Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.
* Automatically detects new episodes
* Can scan your existing library and download any missing episodes
* Can watch for better quality of the episodes you already 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
* Fully configurable episode renaming
* Full integration with SABnzbd and NZBGet
* Full integration with Kodi, Plex (notification, library update, metadata)
* Full support for specials and multi-episode releases
* And a beautiful UI

## Configuring Development Environment:

### Requirements

* [Visual Studio 2017](https://www.visualstudio.com/vs/)
* [Git](https://git-scm.com/downloads)
* [NodeJS](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/en/articles/working-with-forks)
* Grab the submodules `git submodule init && git submodule update`
* Install the required Node Packages `yarn`

### Backend Development

* Run `yarn build` to build the UI
* Open `Sonarr.sln` in Visual Studio
* Make sure `NzbDrone.Console` is set as the startup project
* Build `NzbDrone.Windows` and `NzbDrone.Mono` projects
* Build Solution

### UI Development

* Run `yarn watch` to build UI and rebuild automatically when changes are detected
* Run Sonarr.Console.exe (or debug in Visual Studio)

### License


* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
* Copyright 2010-2019

### Sponsors

* [JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools
    * [ReSharper](http://www.jetbrains.com/resharper/)
    * [TeamCity](http://www.jetbrains.com/teamcity/)
Wiki replacement and CI update (#86) * 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 2020-04-26 14:00:47 +00:00			`# Sonarr`

			`## Original README from the sonarr github:`
Jailman v1.1.0 (#24) * set branch (+2 squashed commit) Squashed commit: [e322f24] remove placeholder [8647131] palceholder * Code cleanup and (primarily) consolidation (#21) * set branch * Exit 1 on iocage create failure * - Move jailcreate to global function - Remove Jailcreate.sh * Add dataset creation function * - add test script to test new global changes - also create folder in jail with createmount * fix * make test executable * more verbosity, fixing folder creation * moving global dataset create * move jails to new dataset-mount creation function * remove test jail and test branch-ref * Add Nextcloud (#22) * Basic working nextcloud integration * Enable persistent reinstall of Nextcloud * prepare for dev merge * Licence alert * Add external database and integrated jail * small improvements and update script * Add mariadb to dev (#31) * Working MariaDB config * - Set ZFS settings for DB on Nextcloud and MariaDB - Cleanup MariaDB * prepare for dev merge * Niceify Readme (#34) * put content from master into it * Some readme itteration * more niceification * [WIP} Wiki workflow test (#37) introduce automatic wiki generation * Add Bitwarden support (#35) * Nextcloud-Cleanup for v1.1.0 (#40) * Nextcloud cleanup - add db-type sanity check - remove some integrated db checks - Move ssl to /config/ssl - remove integrated databases * slight default tweaking * fix mariadb install bug * QA cycle 2020-03-13 22:59:05 +00:00
			`https://github.com/Sonarr/Sonarr`

			`# Sonarr`


			`Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.`

			`## Major Features Include:`

			`* Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.`
			`* Automatically detects new episodes`
			`* Can scan your existing library and download any missing episodes`
			`* Can watch for better quality of the episodes you already 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`
			`* Fully configurable episode renaming`
			`* Full integration with SABnzbd and NZBGet`
			`* Full integration with Kodi, Plex (notification, library update, metadata)`
			`* Full support for specials and multi-episode releases`
			`* And a beautiful UI`

			`## Configuring Development Environment:`

			`### Requirements`

			`* [Visual Studio 2017](https://www.visualstudio.com/vs/)`
			`* [Git](https://git-scm.com/downloads)`
			`* [NodeJS](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/en/articles/working-with-forks)`
			* Grab the submodules `git submodule init && git submodule update`
			* Install the required Node Packages `yarn`

			`### Backend Development`

			* Run `yarn build` to build the UI
			* Open `Sonarr.sln` in Visual Studio
			* Make sure `NzbDrone.Console` is set as the startup project
			* Build `NzbDrone.Windows` and `NzbDrone.Mono` projects
			`* Build Solution`

			`### UI Development`

			* Run `yarn watch` to build UI and rebuild automatically when changes are detected
			`* Run Sonarr.Console.exe (or debug in Visual Studio)`

			`### License`


			`* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)`
			`* Copyright 2010-2019`

			`### Sponsors`

			`* [JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools`
			`* [ReSharper](http://www.jetbrains.com/resharper/)`
			`* [TeamCity](http://www.jetbrains.com/teamcity/)`