Introduction

These docs explain how Sonora works once it's installed. If you haven't installed it yet, the install steps are on the home page.

Something broken? Start with the FAQ

The FAQ covers the problems people run into most, like macOS saying the app is damaged, no sound on Linux or a Spotify account that won't sign in. Most answers are a line or two, so check there before digging through the docs.

What's in the docs

Using Sonora
ProvidersHow signing in works for each service, their quirks, and the audio quality you get.
Downloads and offlineSaving songs to play without a connection, offline mode, and the played-track cache.
SoundOutput device, sample rate and buffer, and the parametric equalizer.
SessionsListening with friends through Sonora Sessions and Spotify Jams.
ShortcutsEvery keyboard shortcut, including the ones that only exist on macOS.
Command lineControlling Sonora from a terminal, a script or a status bar.
ScrobblingLinking Last.fm, Libre.fm, ListenBrainz and Maloja, and when a play counts.
Opening linksOpening music links from search, your browser or another app.
Customizing
Settings fileWhere settings.json is, editing it by hand, and the Home Manager module.
ThemesInstalling community themes, and writing your own as a JSON file.
When something breaks
LogsWhere the log file is and how to get more detail for a bug report.
Getting helpWhere to ask questions and what a good bug report needs.
About
VisionWhat Sonora is for, and what it will never be.
RoadmapWhat's planned, and what has already shipped.

Press Ctrl K anywhere in the docs or the FAQ to search both. Results jump straight to the section that matches.