mirror of https://github.com/Sonarr/Sonarr
2.7 KiB
2.7 KiB
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
- You can do this by running
- 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
andSonarr.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
- Copyright 2010-2020