sonda/README.md
tgiachi 11077f40e1
All checks were successful
release / release (push) Successful in 36s
release / base (push) Has been skipped
release / image (amd64) (push) Has been skipped
release / image (arm64) (push) Has been skipped
release / manifest (push) Has been skipped
docs: split the README into pages under docs/
The README had grown to about 500 lines. It now holds the intro, a quick
start and an index, and the rest lives in docs/.

- docs: add docs/README.md as the index of all pages
- docs: move install, configuration, demo, providers, OpenSubsonic, API,
  security and backups, web app, Android app and development/releases
  to their own pages, text unchanged
- docs: split the feature list into five pages under docs/features/
- docs: rewrite internal anchors as links between the new pages
- chore: add docs to .dockerignore, next to README.md
2026-11-17 14:50:52 +01:00

2.9 KiB

Sonda

This repository has moved. Development continues at git.kmalloc.org/squid/sonda; this Codeberg mirror is archived and read-only.

Sonda is a privacy-first, self-hosted music server written in Go. It streams the music you already own, from your own disks, and keeps everything it knows about you on your own machine.

It is a single executable, one database (SQLite by default, PostgreSQL if you prefer) and the folders that hold your music. There is no Redis, no message broker and no cloud account.

Status: early. The local-playback part works end to end: accounts, libraries, scanning, search, and streaming with HTTP Range. Suggestions of new artists work too (Discover). Other apps can connect over OpenSubsonic (see Other apps), and the web client in web/, which sondad serves, is young (see What is not there yet and Web app). The API may still change.

Quick start

With Docker (the image is on the registry of git.kmalloc.org, for amd64 and arm64):

(umask 077; echo "SONDA_JWT_SECRET=$(openssl rand -hex 32)" > sonda.env)   # once: keep this file
docker run -d --name sonda --restart unless-stopped --stop-timeout 15 \
  -p 127.0.0.1:8080:8080 \
  --env-file sonda.env \
  -v sonda-data:/data \
  -v "$HOME/Music":/music:ro \
  git.kmalloc.org/squid/sonda:latest

Open http://127.0.0.1:8080, create the first account (it becomes the admin), then add a library with the path /music. To build from source, or for Compose, see Install.

Documentation

The full API is also described in OpenAPI and served by Sonda itself at /api/docs/.

Third-party code

Audio tags are read with go.senan.xyz/taglib, which embeds TagLib compiled to WebAssembly and is licensed under the LGPL 2.1. The Swagger UI assets come from github.com/swaggest/swgui (Apache-2.0), which embeds Swagger UI (Apache-2.0). The other dependencies are listed in go.mod. The Milkdrop pictures of the player are drawn by butterchurn and butterchurn-presets (both MIT), bundled in the web app. The shape of a song is found with github.com/hajimehoshi/go-mp3 (Apache-2.0) and github.com/eaburns/flac (MIT), two decoders written in Go.