DOCSEARCHbyAlgolia
Submit Docs

Servarr Wiki Documentation

repository·master·Indexed 20 days ago

https://github.com/servarr/wiki

Consolidated guides and documentation for the Servarr ecosystem of media automation apps, including Sonarr, Radarr, Lidarr, Readarr, and Prowlarr. Includes detailed instructions for Docker deployment, consistent path layouts for hardlinks and atomic moves, PUID/PGID configuration, and specific setup guides for ARM-based Synology NAS devices.

Tokens
266.1K
Snippets
368
Records
1.1K
Agent score
69%

What's inside Servarr Wiki

  1. Overview of Prowlarr

    master

    Prowlarr is an indexer manager and proxy designed to integrate with various PVR (Personal Video Recorder) applications. It acts as a central hub for managing both Torrent Trackers and Usenet Indexers, eliminating the need for per-app indexer configuration.

    Supported Integrations:

    • Radarr
    • Sonarr
    • Lidarr
    • LazyLibrarian
    • Mylar3

  2. Overview of the Tubifarry plugin

    master

    The TypNull/Tubifarry plugin is a multi-feature extension for Lidarr.

    Key Features

    • YouTube Music Downloader: Downloads from YouTube (requires cookies/trusted sessions). Supports optional FFmpeg extraction.
    • Soulseek Integration: Provides Slskd support as both indexer and download client.
    • Toolbox Additions:
      • Soundtrack Importer: Fetches soundtracks via *Arr-Soundtracks.
      • Queue Cleaner: Manages failed imports (blocklist/rename/retry).
      • Codec Tinker: Converts audio formats using FFmpeg (e.g., wav to flac).
      • Lyrics Fetcher: Adds .lrc or embedded lyrics.
      • Search Sniper: Automates batch searching.
      • MetaMix: Experimental metadata aggregation.

    Installation Note

    Some features require specific branches. To install a development version, use the specific branch URL (e.g., https://github.com/TypNull/Tubifarry/tree/develop).

  3. Overview of the *Arr ecosystem

    master

    The Servarr wiki serves as the consolidated documentation for the following applications, collectively known as "*Arr" or "*Arrs":

    • Sonarr: TV Show collection management.
    • Radarr: Movie collection management.
    • Lidarr: Music collection management.
    • Readarr: E-Book collection management.
    • Prowlarr: Indexer management and synchronization for the other applications.

    These tools are designed to automate the grabbing, sorting, organizing, and monitoring of media collections.

  4. Overview of Lidarr

    master
    Lidarr is a music collection manager designed for Usenet and BitTorrent users. It automates the process of monitoring RSS feeds for new tracks from specific artists, grabbing them, sorting them, and renaming them. Additionally, Lidarr can be configured to automatically upgrade the quality of existing music files when higher-quality formats become available.

  5. Overview of Whisparr

    master

    Whisparr is an adult video collection manager designed for Usenet and BitTorrent users. Its core functionality includes:

    • Monitoring: Tracks multiple RSS feeds for new sites and scenes.
    • Automation: Interfaces with clients and indexers to grab, sort, and rename media.
    • Quality Upgrades: Automatically upgrades existing library files to better quality formats when they become available.

  6. Overview of Servarr Applications

    master

    Servarr is a collection of applications (collectively referred to as "*Arr", "*Arrs", "Starr", or "Starrs") designed to automate the grabbing, sorting, organizing, and monitoring of media collections.

    Media Automation

    • Lidarr: Music automation.
    • Radarr: Movie automation.
    • Readarr: E-Book automation.
    • Sonarr: TV Show automation.
    • Whisparr: Adult Video automation.

    Indexer Management

    • Prowlarr: Manages indexers and keeps them in sync across the various *Arr applications.

  7. Determine if Lidarr is suitable for your library

    master

    Lidarr is optimized for curated libraries following the MusicBrainz Release model. It is not recommended for:

    • Uncurated collections: Loose files from multiple artists or releases sharing a single folder.
    • Classical music: Requires extensive manual tagging due to complex MusicBrainz metadata.
    • Singles-heavy libraries: Many singles lack proper Release metadata in third-party sources.
    • Mixes and Samples: DJ mixes, beat packs, or producer samples (e.g., Beatport content) are generally not recognized as Releases.

    Companion Tools: For libraries that fall outside these models, consider using Beets, MusicBrainz Picard, or MusicBee alongside or instead of Lidarr.

  8. Monitor Disk Space and System Status

    master

    The System section provides visibility into the environment:

    • Disk Space: Shows available disk space. Note: In Docker environments, this typically reflects the available space within the Docker image/container rather than the host system.
    • About: Displays information regarding the current Whisparr installation.
    • Queue: Displays running tasks, upcoming tasks, and a history of recently completed tasks including their duration.

  9. Monitor Whisparr system status and health

    master

    Whisparr provides system monitoring through several status categories to assist with administration and troubleshooting. You can monitor the following areas:

    • Health: Displays system-level warnings and component-specific issues.
    • Download Clients: Monitors the connectivity and configuration of integrated download clients.
    • Indexers: Tracks the availability and search capabilities of configured indexers.
    • Movie Folders: Monitors the status of root folders used for media storage.
    • Movies: Tracks metadata availability (e.g., TMDb) and list availability.
    • Disk Space: Monitors available storage capacity.
    • Tasks: Shows scheduled and queued background tasks.
    • Backup: Monitors the status of system backups.
    • Updates: Tracks the status of software updates.
    • Events: Provides a history of system events.
    • Log Files: Provides access to system logs for deep troubleshooting.

  10. Retirement of Readarr

    master

    The Readarr project has been officially retired. The primary reason for retirement is that the project's metadata has become unusable, and there is no longer active development to repair it or transition to Open Library.

    Key Information:

    • Support: A brief transition period is being provided to help troubleshoot non-metadata related issues.
    • Alternatives: Users are strongly encouraged to seek alternative solutions.
    • Third-party Mirrors: While third-party metadata mirrors exist (such as rreading-glasses), the Servarr team does not support them, and their use is entirely at the user's own risk.

  11. Monitor Prowlarr System Status and Health

    master

    Prowlarr provides a centralized System status view to monitor the health of the application and its integrated components. The status dashboard tracks the operational state of:

    • Health: General system stability and critical warnings.
    • Download Clients: Availability of configured download clients.
    • Indexers: Status of search indexers, including checks for obsolete definitions, enabled status, and availability.
    • Indexer Proxies: Connectivity and availability of proxies used for indexer access.
    • Applications: Connectivity to integrated applications (e.g., Sonarr, Radarr).
    • Notifications: Status of configured notification services.
    • Disk Space: Monitoring of available storage.

    Use this dashboard to identify failures in the automation pipeline before they impact scheduled tasks or searches.

  12. Status of Readarr: Retired

    master

    Readarr is an eBook and audiobook collection manager for Usenet and BitTorrent users. It monitors RSS feeds, interfaces with indexers and clients to grab/sort/rename files, and can automatically upgrade file quality.

    IMPORTANT: Readarr is retired and no longer in active development.

    Key status details:

    • Metadata Issues: The project's metadata has become unusable, and the transition to Open Library as a source has stalled.
    • Support: The Servarr team provides only a brief transition period for troubleshooting non-metadata related issues.
    • Third-party Mirrors: Users may use third-party metadata mirrors (such as rreading-glasses) at their own risk; the Readarr team does not support them.
    • Alternatives: Users are strongly encouraged to seek alternative solutions.