Skip to content

Repository files navigation

corpus

builds.sr.ht status

A self-hosted ListenBrainz and Last.fm listening-history dashboard. Corpus stores scrobbles in DuckDB, enriches release metadata, caches cover art, and serves an Elm web interface.

Documentation

  • Architecture — components, routing, data flows, configuration, and operations.
  • DuckDB — schema and analytical queries.

Quick start

With Nix:

just shell
just nix build
just nix run

Or build locally with pnpm:

pnpm install
pnpm spago install
pnpm run build
pnpm test
pnpm spago run

Scrobbling API

Corpus accepts ListenBrainz-compatible submissions at POST /1/submit-listens. Send Authorization: Token <token> and a standard ListenBrainz payload. Clients may first validate a token with GET /1/validate-token using the same header.

Tokens are shown once when a user is created, reset, or approved through self-registration. Store them securely.

Configuration

users.json defines each static user's slug, source usernames, DuckDB filename, and cover/backup settings. Shared secrets and integrations are supplied by environment variables.

Variable Purpose
CORPUS_USERS_FILE Static user configuration (default: users.json)
DATABASE_PATH Directory containing user databases
LASTFM_API_KEY, DISCOGS_TOKEN Last.fm sync and metadata/cover fallbacks
S3_BUCKET and AWS_* Cover cache and optional database backups
COSINE_API_KEY Similar-track lookup
PORT, HOST HTTP listener (defaults: 8000, 127.0.0.1)
METRICS_ENABLED Enable Prometheus metrics at /metrics

Set REGISTRATION_ENABLED=true to allow public registration at /register; ADMIN_TOKEN enables approval at /admin. See the architecture guide for every setting and the full registration workflow.

About

self-hosted listenbrainz and last.fm proxy

Topics

Resources

Stars

29 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages