README.md
August 20, 2026 ยท View on GitHub
Aurral is the Lidarr companion for self-hosted music discovery. Best-in-class recommendations, rotating flows, and playlist downloads, built on Lidarr instead of replacing it.
Quick Links
Features
- Discover: Best-in-class personalized recommendations, trends, tags, recent releases, discover playlists, and nearby shows.
- Search: Find artists and albums, preview tracks, and add to Lidarr with your defaults.
- Library: Browse and search artists already in Lidarr.
- Playlists: Run scheduled flows, adopt discover playlists like Release Radar, import Spotify, Last.fm, or ListenBrainz playlists, and convert flows to fixed tracklists.
- Activity: Queue and history for Lidarr requests, yt-dlp / slskd / Usenet downloads, plus Wanted actions for Aurral playlist jobs.
- Integrations: Lidarr, Last.fm, ListenBrainz, Koito, yt-dlp, slskd, SABnzbd/NZBGet, Navidrome, Plex, Ticketmaster, Gotify, and webhooks.
- Playback: Stream through API-synced Navidrome or Plex/Plexamp playlists from a dedicated download folder.
- Multi-user: Per-user profiles, discovery layout, permissions, local auth, LAN auto-login, reverse-proxy SSO, and native OIDC.
Screenshots
Quick Start
Create a docker-compose.yml:
services:
aurral:
image: ghcr.io/lklynet/aurral:latest
restart: unless-stopped
ports:
- "3001:3001"
environment:
- PUID=1000
- PGID=1000
volumes:
- ${MEDIA_ROOT:-/srv/media}:/data
- ./config:/config
Set MEDIA_ROOT to the same host media path that Lidarr already mounts. Keep /data as the container path and use that same mapping for your download clients and Navidrome or Plex. Then set Aurral's Downloads Folder to a container path such as /data/downloads/aurral. See Filesystem and mounts.
docker compose up -d
Open http://localhost:3001, create your admin account, and connect Lidarr.
Want the latest merged changes? Use ghcr.io/lklynet/aurral:nightly. Nightly
builds may be less stable than releases; see the Docker image channels.
For a stack with Lidarr, slskd, and Navidrome, see docker-compose.example.yml. For Plex, see the Plex setup guide.
Documentation
Full setup and usage guides live at docs.aurral.org.
Note
AI disclosure - Aurral is built with a hybrid approach to development. The foundation is hand-written code. For feature work, specifications are written by a developer, and any AI-generated code is thoroughly reviewed before being merged.
Support
Aurral builds on open metadata, listening data, and infrastructure from the projects below.
| Project | Contribution |
|---|---|
| BrainzMash | Hosted artist and album metadata for discovery and search |
| Honker | Durable SQLite queues and background workers across Aurral |
| MusicBrainz | Canonical release metadata and artist identifiers |
- Community: Discord
- Bugs and feature requests: GitHub Issues