mirror of https://github.com/Sonarr/Sonarr.git synced 2024-11-30 09:07:14 +02:00

Smart PVR for newsgroup and bittorrent users.

Go to file

Mark McDowall 3a7b0cacb8 Upgrade del		2020-10-04 12:08:07 -07:00
.github	Update bug issue template	2018-05-21 12:43:07 -07:00
distribution	New: Replaced launcher on OSX Catalina so that individual permissions can be assigned (note, will ignore permissions previously assigned to sh)	2020-06-07 17:42:46 +02:00
docker/tests	Increased mono dependency from 5.4 to 5.18 for debian	2020-03-16 19:18:41 +01:00
frontend	Upgrade webpack loaders	2020-10-04 12:08:07 -07:00
Logo	Update Logos	2018-12-29 13:08:46 +01:00
schemas	add downloadvolumefactor and uploadvolumefactor torznab attributes (#1464 )	2016-09-23 21:08:50 +02:00
src	New: Pilot Episode monitoring option	2020-10-03 11:53:56 -07:00
tools	Support for VS2019 build environment	2020-02-07 21:16:53 +01:00
.editorconfig	Linting error.	2019-03-09 00:21:06 +01:00
.esprintrc	v3 UI	2018-12-29 13:08:43 +01:00
.gitattributes	New: Replaced launcher on OSX Catalina so that individual permissions can be assigned (note, will ignore permissions previously assigned to sh)	2020-06-07 17:42:46 +02:00
.gitignore	Split up _tests into windows and linux	2019-09-13 12:29:31 +02:00
.yarnrc	Downgrade event-stream	2019-02-22 16:27:47 -08:00
build.sh	New: Replaced launcher on OSX Catalina so that individual permissions can be assigned (note, will ignore permissions previously assigned to sh)	2020-06-07 17:42:46 +02:00
CLA.md	Cleaned up project root.	2015-08-02 22:22:22 -07:00
CONTRIBUTING.md	Update docs	2019-04-09 20:47:50 -07:00
COPYRIGHT.md	Added License and Copyright file for completeness.	2017-07-27 22:04:57 +02:00
gulpFile.js	Removed old UI	2018-12-29 13:08:45 +01:00
LICENSE.md	Added License and Copyright file for completeness.	2017-07-27 22:04:57 +02:00
package.json	Upgrade del	2020-10-04 12:08:07 -07:00
README.md	updated readme	2020-05-21 10:58:35 +02:00
test.sh	Converted all projects to the new csproj format.	2019-08-20 19:39:49 +02:00
version.sh	Fixed: Missing debian package dependency and made them optional.	2019-08-24 01:23:04 +02:00
yarn.lock	Upgrade del	2020-10-04 12:08:07 -07:00

README.md

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.

Getting Started

Download (Linux, MacOS, Windows, Docker, etc.)
Installation
FAQ
Wiki
API Documentation

Support

Features

Current Features

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

Setup

Make sure all the required software mentioned above are installed
Clone the repository recursively to get Sonarr and it's submodules
- You can do this by running git clone --recursive https://github.com/Sonarr/Sonarr.git
Install the required Node Packages using yarn

Backend Development

Run yarn build to build the UI
Open Sonarr.sln in Visual Studio
Make sure Sonarr.Console is set as the startup project
Build Sonarr.Windows and Sonarr.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)

Licenses

GNU GPL v3