Skip to main content

Listenarr documentation

Listenarr is a self-hosted audiobook automation server built to streamline the path from discovery to a clean, organized library. This site covers installation, first-run setup, the main configuration screens, and the Listenarr API.

What you can do with Listenarr​

  • Search and grab audiobooks from multiple torrent and NZB sources.
  • Connect popular download clients such as qBittorrent, Transmission, SABnzbd, and NZBGet.
  • Enrich your library with metadata from Audimeta, Audnexus, and OpenLibrary-backed workflows.
  • Monitor activity in real time from a responsive web interface.
  • Organize files with customizable naming and folder rules.

Start here​

  • Installation covers Docker plus Windows, Linux, and macOS setups.
  • First run gives you the recommended setup order after the app is online.
  • Root folders explains how to choose and manage library locations.
  • Download clients covers qBittorrent, Transmission, SABnzbd, NZBGet, and remote path mappings.
  • Indexers covers manual indexers plus Prowlarr import.
  • Quality profiles explains codecs, upgrades, M4B preference, and filters.
  • Notifications covers Slack, Discord, Telegram, Pushover, Pushbullet, NTFY, and Zapier-compatible webhooks.
  • Discord bot walks through the built-in request bot setup.
  • General settings documents each section of the main Settings page.

API​

Open the API guide to review the bundled OpenAPI snapshot and see how to use Swagger on your own Listenarr instance.